LicenseAcknowledgementDao.php

Go to the documentation of this file.

<?php
/*
 SPDX-FileCopyrightText: © 2022 Siemens AG
 Author: Gaurav Mishra <mishra.gaurav@siemens.com>
 
 SPDX-License-Identifier: GPL-2.0-only
*/
namespace Fossology\Lib\Dao;
 
use Fossology\Lib\Auth\Auth;
use Fossology\Lib\Db\DbManager;
use Fossology\Lib\Util\StringOperation;
 
class LicenseAcknowledgementDao
{
  private $dbManager;
 
  function __construct(DbManager $dbManager)
  {
    $this->dbManager = $dbManager;
  }
 
  public function getAllAcknowledgements($skipNotSet = false)
  {
    $where = "";
    if ($skipNotSet) {
      $where = "WHERE name <> 'not-set' AND is_enabled = TRUE";
    }
    $sql = "SELECT la_pk, name, acknowledgement, is_enabled " .
      "FROM license_std_acknowledgement $where " .
      "ORDER BY la_pk ASC;";
    return $this->dbManager->getRows($sql);
  }
 
  function updateAcknowledgement($acknowledgementPk, $newName, $newAcknowledgement)
  {
    if (!Auth::isAdmin()) {
      // Only admins can update the acknowledgements.
      return false;
    }
    $this->isAcknowledgementIdValid($acknowledgementPk);
 
    $userFk = Auth::getUserId();
 
    $sql = "UPDATE license_std_acknowledgement " .
      "SET name = $2, acknowledgement = $3, updated = NOW(), user_fk = $4 " .
      "WHERE la_pk = $1 " .
      "RETURNING 1 AS updated;";
    $row = $this->dbManager->getSingleRow($sql,
      [$acknowledgementPk, $newName,
        StringOperation::replaceUnicodeControlChar($newAcknowledgement), $userFk]);
    return $row['updated'] == 1;
  }
 
  function insertAcknowledgement($name, $acknowledgement)
  {
    if (! Auth::isAdmin()) {
      // Only admins can add acknowledgements.
      return -1;
    }
 
    $name = trim($name);
    $acknowledgement = trim($acknowledgement);
 
    if (empty($name) || empty($acknowledgement)) {
      // Cannot insert empty fields.
      return -1;
    }
 
    $userFk = Auth::getUserId();
 
    $params = [
      'name' => $name,
      'acknowledgement' => StringOperation::replaceUnicodeControlChar($acknowledgement),
      'user_fk' => $userFk
    ];
    $statement = __METHOD__ . ".insertNewLicAcknowledgement";
    $returning = "la_pk";
    $returnVal = -1;
    try {
      $returnVal = $this->dbManager->insertTableRow("license_std_acknowledgement",
        $params, $statement, $returning);
    } catch (\Exception $e) {
      $returnVal = -2;
    }
    return $returnVal;
  }
 
  function updateAcknowledgementFromArray($acknowledgementArray)
  {
    if (!Auth::isAdmin()) {
      // Only admins can update the acknowledgements.
      return false;
    }
 
    $userFk = Auth::getUserId();
    $updated = 0;
 
    foreach ($acknowledgementArray as $acknowledgementPk => $acknowledgement) {
      if (count($acknowledgement) < 1 ||
        (! array_key_exists("name", $acknowledgement) &&
        ! array_key_exists("acknowledgement", $acknowledgement))) {
        throw new \UnexpectedValueException(
          "At least name or acknowledgement is " . "required for entry " . $acknowledgementPk);
      }
      $this->isAcknowledgementIdValid($acknowledgementPk);
      $statement = __METHOD__;
      $params = [$acknowledgementPk, $userFk];
      $updateStatement = [];
      if (array_key_exists("name", $acknowledgement)) {
        $params[] = $acknowledgement["name"];
        $updateStatement[] = "name = $" . count($params);
        $statement .= ".name";
      }
      if (array_key_exists("acknowledgement", $acknowledgement)) {
        $params[] = StringOperation::replaceUnicodeControlChar($acknowledgement["acknowledgement"]);
        $updateStatement[] = "acknowledgement = $" . count($params);
        $statement .= ".acknowledgement";
      }
      $sql = "UPDATE license_std_acknowledgement " .
        "SET updated = NOW(), user_fk = $2, " . join(",", $updateStatement) .
        "WHERE la_pk = $1 " .
        "RETURNING 1 AS updated;";
      $retVal = $this->dbManager->getSingleRow($sql, $params, $statement);
      $updated += intval($retVal);
    }
    return $updated;
  }
 
  function getAcknowledgement($acknowledgementPk)
  {
    $this->isAcknowledgementIdValid($acknowledgementPk);
    $sql = "SELECT acknowledgement FROM license_std_acknowledgement " . "WHERE la_pk = $1;";
    $statement = __METHOD__ . ".getAcknowledgement";
 
    $acknowledgement = $this->dbManager->getSingleRow($sql, [$acknowledgementPk], $statement);
    $acknowledgement = $acknowledgement['acknowledgement'];
    if (strcasecmp($acknowledgement, "null") === 0) {
      return null;
    }
    return $acknowledgement;
  }
 
  function toggleAcknowledgement($acknowledgementPk)
  {
    if (! Auth::isAdmin()) {
      // Only admins can update the acknowledgements.
      return false;
    }
    $this->isAcknowledgementIdValid($acknowledgementPk);
 
    $userFk = Auth::getUserId();
 
    $sql = "UPDATE license_std_acknowledgement " .
      "SET is_enabled = NOT is_enabled, user_fk = $2 " .
      "WHERE la_pk = $1;";
 
    $this->dbManager->getSingleRow($sql, [$acknowledgementPk, $userFk]);
    return true;
  }
 
  private function isAcknowledgementIdValid($acknowledgementPk)
  {
    if (! is_int($acknowledgementPk)) {
      throw new \UnexpectedValueException("Inavlid acknowledgement id");
    }
    $sql = "SELECT count(*) AS cnt FROM license_std_acknowledgement " .
      "WHERE la_pk = $1;";
 
    $acknowledgementCount = $this->dbManager->getSingleRow($sql, [$acknowledgementPk]);
    if ($acknowledgementCount['cnt'] < 1) {
      // Invalid acknowledgement id
      throw new \UnexpectedValueException("Inavlid acknowledgement id");
    }
  }
}