LicenseStdCommentDao.php

Go to the documentation of this file.

<?php
/***********************************************************
 * Copyright (C) 2019 Siemens AG
 * Author: Gaurav Mishra <mishra.gaurav@siemens.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 ***********************************************************/
namespace Fossology\Lib\Dao;

use Fossology\Lib\Auth\Auth;
use Fossology\Lib\Db\DbManager;

class LicenseStdCommentDao
{
  private $dbManager;

  function __construct(DbManager $dbManager)
  {
    $this->dbManager = $dbManager;
  }

  public function getAllComments($skipNotSet = false)
  {
    $where = "";
    if ($skipNotSet) {
      $where = "WHERE name <> 'not-set' AND is_enabled = TRUE";
    }
    $sql = "SELECT lsc_pk, name, comment, is_enabled " .
      "FROM license_std_comment $where " .
      "ORDER BY lsc_pk ASC;";
    return $this->dbManager->getRows($sql);
  }

  function updateComment($commentPk, $newName, $newComment)
  {
    if (!Auth::isAdmin()) {
      // Only admins can update the comments.
      return false;
    }
    $this->isCommentIdValid($commentPk);

    $userFk = Auth::getUserId();

    $sql = "UPDATE license_std_comment " .
      "SET name = $2, comment = $3, updated = NOW(), user_fk = $4 " .
      "WHERE lsc_pk = $1 " .
      "RETURNING 1 AS updated;";
    $row = $this->dbManager->getSingleRow($sql,
      [$commentPk, $newName, $newComment, $userFk]);
    return $row['updated'] == 1;
  }

  function insertComment($name, $comment)
  {
    if (! Auth::isAdmin()) {
      // Only admins can add comments.
      return -1;
    }

    $name = trim($name);
    $comment = trim($comment);

    if (empty($name) || empty($comment)) {
      // Cannot insert empty fields.
      return -1;
    }

    $userFk = Auth::getUserId();

    $params = [
      'name' => $name,
      'comment' => $comment,
      'user_fk' => $userFk
    ];
    $statement = __METHOD__ . ".insertNewLicStdComment";
    $returning = "lsc_pk";
    $returnVal = -1;
    try {
      $returnVal = $this->dbManager->insertTableRow("license_std_comment",
        $params, $statement, $returning);
    } catch (\Exception $e) {
      $returnVal = -2;
    }
    return $returnVal;
  }

  function updateCommentFromArray($commentArray)
  {
    if (!Auth::isAdmin()) {
      // Only admins can update the comments.
      return false;
    }

    $userFk = Auth::getUserId();
    $updated = 0;

    foreach ($commentArray as $commentPk => $comment) {
      if (count($comment) < 1 ||
        (! array_key_exists("name", $comment) &&
        ! array_key_exists("comment", $comment))) {
        throw new \UnexpectedValueException(
          "At least name or comment is " . "required for entry " . $commentPk);
      }
      $this->isCommentIdValid($commentPk);
      $statement = __METHOD__;
      $params = [$commentPk, $userFk];
      $updateStatement = [];
      if (array_key_exists("name", $comment)) {
        $params[] = $comment["name"];
        $updateStatement[] = "name = $" . count($params);
        $statement .= ".name";
      }
      if (array_key_exists("comment", $comment)) {
        $params[] = $comment["comment"];
        $updateStatement[] = "comment = $" . count($params);
        $statement .= ".comment";
      }
      $sql = "UPDATE license_std_comment " .
        "SET updated = NOW(), user_fk = $2, " . join(",", $updateStatement) .
        "WHERE lsc_pk = $1 " .
        "RETURNING 1 AS updated;";
      $retVal = $this->dbManager->getSingleRow($sql, $params, $statement);
      $updated += intval($retVal);
    }
    return $updated;
  }

  function getComment($commentPk)
  {
    $this->isCommentIdValid($commentPk);
    $sql = "SELECT comment FROM license_std_comment " . "WHERE lsc_pk = $1;";
    $statement = __METHOD__ . ".getComment";

    $comment = $this->dbManager->getSingleRow($sql, [$commentPk], $statement);
    $comment = $comment['comment'];
    if (strcasecmp($comment, "null") === 0) {
      return null;
    }
    return $comment;
  }

  function toggleComment($commentPk)
  {
    if (! Auth::isAdmin()) {
      // Only admins can update the comments.
      return false;
    }
    $this->isCommentIdValid($commentPk);

    $userFk = Auth::getUserId();

    $sql = "UPDATE license_std_comment " .
      "SET is_enabled = NOT is_enabled, user_fk = $2 " .
      "WHERE lsc_pk = $1;";

    $this->dbManager->getSingleRow($sql, [$commentPk, $userFk]);
    return true;
  }

  private function isCommentIdValid($commentPk)
  {
    if (! is_int($commentPk)) {
      throw new \UnexpectedValueException("Inavlid comment id");
    }
    $sql = "SELECT count(*) AS cnt FROM license_std_comment " .
      "WHERE lsc_pk = $1;";

    $commentCount = $this->dbManager->getSingleRow($sql, [$commentPk]);
    if ($commentCount['cnt'] < 1) {
      // Invalid comment id
      throw new \UnexpectedValueException("Inavlid comment id");
    }
  }
}