CopyrightController.php

Go to the documentation of this file.

<?php
/*
 Author: Soham Banerjee <sohambanerjee4abc@hotmail.com>
 SPDX-FileCopyrightText: © 2023 Soham Banerjee <sohambanerjee4abc@hotmail.com>
 SPDX-License-Identifier: GPL-2.0-only
*/
 
namespace Fossology\UI\Api\Controllers;
 
use Fossology\Lib\Dao\CopyrightDao;
use Fossology\UI\Api\Exceptions\HttpBadRequestException;
use Fossology\UI\Api\Exceptions\HttpErrorException;
use Fossology\UI\Api\Helper\ResponseHelper;
use Fossology\UI\Api\Models\Info;
use Fossology\UI\Api\Models\InfoType;
use Fossology\UI\Api\Models\ApiVersion;
use Psr\Http\Message\ServerRequestInterface;
 
 
class CopyrightController extends RestController
{
  const COPYRIGHT_PARAM = "status";
 
  const LIMIT_PARAM = "limit";
 
  const PAGE_PARAM = "page";
 
  const COPYRIGHT_FETCH_LIMIT = 100;
 
  private $copyrightHist;
 
  private $copyrightDao;
  const TYPE_COPYRIGHT = 1;
  const TYPE_EMAIL = 2;
  const TYPE_URL = 4;
  const TYPE_AUTHOR = 8;
  const TYPE_ECC = 16;
  const TYPE_KEYWORD = 32;
  const TYPE_IPRA = 64;
  const TYPE_COPYRIGHT_USERFINDINGS = 128;
  const TYPE_COPYRIGHT_SCANCODE = 256;
  const TYPE_EMAIL_SCANCODE = 512;
  const TYPE_URL_SCANCODE = 1024;
  const TYPE_AUTHOR_SCANCODE = 2048;
 
  public function __construct($container)
  {
    parent::__construct($container);
    $this->copyrightDao = $this->container->get('dao.copyright');
    $this->copyrightHist = $this->restHelper->getPlugin('ajax-copyright-hist');
  }
 
  public function getFileCopyrights($request, $response, $args)
  {
    return $this->getFileCX($request, $response, $args, self::TYPE_COPYRIGHT);
  }
 
  public function getFileUserCopyrights($request, $response, $args)
  {
    return $this->getFileCX($request, $response, $args, self::TYPE_COPYRIGHT_USERFINDINGS);
  }
 
  public function getFileScanCodeCopyrights($request, $response, $args)
  {
    return $this->getFileCX($request, $response, $args, self::TYPE_COPYRIGHT_SCANCODE);
  }
 
  public function getFileEmail($request, $response, $args)
  {
    return $this->getFileCX($request, $response, $args, self::TYPE_EMAIL);
  }
 
  public function getFileScanCodeEmail($request, $response, $args)
  {
    return $this->getFileCX($request, $response, $args, self::TYPE_EMAIL_SCANCODE);
  }
 
  public function getFileUrl($request, $response, $args)
  {
    return $this->getFileCX($request, $response, $args, self::TYPE_URL);
  }
 
  public function getFileScanCodeUrl($request, $response, $args)
  {
    return $this->getFileCX($request, $response, $args, self::TYPE_URL_SCANCODE);
  }
 
  public function getFileAuthor($request, $response, $args)
  {
    return $this->getFileCX($request, $response, $args, self::TYPE_AUTHOR);
  }
 
  public function getFileScanCodeAuthor($request, $response, $args)
  {
    return $this->getFileCX($request, $response, $args, self::TYPE_AUTHOR_SCANCODE);
  }
 
  public function getFileEcc($request, $response, $args)
  {
    return $this->getFileCX($request, $response, $args, self::TYPE_ECC);
  }
 
  public function getFileKeyword($request, $response, $args)
  {
    return $this->getFileCX($request, $response, $args, self::TYPE_KEYWORD);
  }
 
  public function getFileIpra($request, $response, $args)
  {
    return $this->getFileCX($request, $response, $args, self::TYPE_IPRA);
  }
 
  public function deleteFileCopyright($request, $response, $args)
  {
    return $this->deleteFileCX($args, $response, self::TYPE_COPYRIGHT);
  }
 
  public function deleteFileUserCopyright($request, $response, $args)
  {
    return $this->deleteFileCX($args, $response, self::TYPE_COPYRIGHT_USERFINDINGS);
  }
 
  public function deleteFileScanCodeCopyright($request, $response, $args)
  {
    return $this->deleteFileCX($args, $response, self::TYPE_COPYRIGHT_SCANCODE);
  }
 
  public function deleteFileEmail($request, $response, $args)
  {
    return $this->deleteFileCX($args, $response, self::TYPE_EMAIL);
  }
 
  public function deleteFileScanCodeEmail($request, $response, $args)
  {
    return $this->deleteFileCX($args, $response, self::TYPE_EMAIL_SCANCODE);
  }
  public function deleteFileUrl($request, $response, $args)
  {
    return $this->deleteFileCX($args, $response, self::TYPE_URL);
  }
 
  public function deleteFileScanCodeUrl($request, $response, $args)
  {
    return $this->deleteFileCX($args, $response, self::TYPE_URL_SCANCODE);
  }
 
  public function deleteFileAuthor($request, $response, $args)
  {
    return $this->deleteFileCX($args, $response, self::TYPE_AUTHOR);
  }
 
  public function deleteFileScanCodeAuthor($request, $response, $args)
  {
    return $this->deleteFileCX($args, $response, self::TYPE_AUTHOR_SCANCODE);
  }
 
  public function deleteFileEcc($request, $response, $args)
  {
    return $this->deleteFileCX($args, $response, self::TYPE_ECC);
  }
 
  public function deleteFileKeyword($request, $response, $args)
  {
    return $this->deleteFileCX($args, $response, self::TYPE_KEYWORD);
  }
 
  public function deleteFileIpra($request, $response, $args)
  {
    return $this->deleteFileCX($args, $response, self::TYPE_IPRA);
  }
 
  public function updateFileCopyright($request, $response, $args)
  {
    return $this->updateFileCx($request, $response, $args, self::TYPE_COPYRIGHT);
  }
 
  public function updateFileUserCopyright($request, $response, $args)
  {
    return $this->updateFileCx($request, $response, $args, self::TYPE_COPYRIGHT_USERFINDINGS);
  }
 
  public function updateFileScanCodeCopyright($request, $response, $args)
  {
    return $this->updateFileCx($request, $response, $args, self::TYPE_COPYRIGHT_SCANCODE);
  }
 
  public function updateFileEmail($request, $response, $args)
  {
    return $this->updateFileCx($request, $response, $args, self::TYPE_EMAIL);
  }
 
  public function updateFileScanCodeEmail($request, $response, $args)
  {
    return $this->updateFileCx($request, $response, $args, self::TYPE_EMAIL_SCANCODE);
  }
 
  public function updateFileUrl($request, $response, $args)
  {
    return $this->updateFileCx($request, $response, $args, self::TYPE_URL);
  }
 
  public function updateFileScanCodeUrl($request, $response, $args)
  {
    return $this->updateFileCx($request, $response, $args, self::TYPE_URL_SCANCODE);
  }
 
  public function updateFileAuthor($request, $response, $args)
  {
    return $this->updateFileCx($request, $response, $args, self::TYPE_AUTHOR);
  }
 
  public function updateFileScanCodeAuthor($request, $response, $args)
  {
    return $this->updateFileCx($request, $response, $args, self::TYPE_AUTHOR_SCANCODE);
  }
 
  public function updateFileEcc($request, $response, $args)
  {
    return $this->updateFileCx($request, $response, $args, self::TYPE_ECC);
  }
 
  public function updateFileKeyword($request, $response, $args)
  {
    return $this->updateFileCx($request, $response, $args, self::TYPE_KEYWORD);
  }
 
  public function updateFileIpra($request, $response, $args)
  {
    return $this->updateFileCx($request, $response, $args, self::TYPE_IPRA);
  }
 
  public function restoreFileCopyright($request, $response, $args)
  {
    return $this->restoreFileCx($args, $response, self::TYPE_COPYRIGHT);
  }
 
  public function restoreFileUserCopyright($request, $response, $args)
  {
    return $this->restoreFileCx($args, $response, self::TYPE_COPYRIGHT_USERFINDINGS);
  }
 
  public function restoreFileScanCodeCopyright($request, $response, $args)
  {
    return $this->restoreFileCx($args, $response, self::TYPE_COPYRIGHT_SCANCODE);
  }
 
  public function restoreFileEmail($request, $response, $args)
  {
    return $this->restoreFileCx($args, $response, self::TYPE_EMAIL);
  }
 
  public function restoreFileScanCodeEmail($request, $response, $args)
  {
    return $this->restoreFileCx($args, $response, self::TYPE_EMAIL_SCANCODE);
  }
 
  public function restoreFileUrl($request, $response, $args)
  {
    return $this->restoreFileCx($args, $response, self::TYPE_URL);
  }
 
  public function restoreFileScanCodeUrl($request, $response, $args)
  {
    return $this->restoreFileCx($args, $response, self::TYPE_URL_SCANCODE);
  }
 
  public function restoreFileAuthor($request, $response, $args)
  {
    return $this->restoreFileCx($args, $response, self::TYPE_AUTHOR);
  }
 
  public function restoreFileScanCodeAuthor($request, $response, $args)
  {
    return $this->restoreFileCx($args, $response, self::TYPE_AUTHOR_SCANCODE);
  }
 
  public function restoreFileEcc($request, $response, $args)
  {
    return $this->restoreFileCx($args, $response, self::TYPE_ECC);
  }
 
  public function restoreFileKeyword($request, $response, $args)
  {
    return $this->restoreFileCx($args, $response, self::TYPE_KEYWORD);
  }
 
  public function restoreFileIpra($request, $response, $args)
  {
    return $this->restoreFileCx($args, $response, self::TYPE_IPRA);
  }
 
  public function getTotalFileCopyrights($request, $response, $args)
  {
    return $this->getTotalCX($request, $response, $args, self::TYPE_COPYRIGHT);
  }
 
  public function getTotalFileUserCopyrights($request, $response, $args)
  {
    return $this->getTotalCX($request, $response, $args, self::TYPE_COPYRIGHT_USERFINDINGS);
  }
 
  private function getTotalCX($request, $response, $args, $cxType)
  {
    $version = ApiVersion::getVersion($request);
    $uploadPk = $args["id"];
    $uploadTreeId = $args["itemId"];
    $query = $request->getQueryParams();
    $statusVal = true;
 
    $this->uploadAccessible($uploadPk);
    $this->isItemExists($uploadPk, $uploadTreeId);
 
    if (!array_key_exists(self::COPYRIGHT_PARAM, $query)) {
      throw new HttpBadRequestException("Bad Request. 'status' is a " .
        "required query param with expected values 'active' or 'inactive");
    }
    $status = $query[self::COPYRIGHT_PARAM];
    if ($status == "active") {
      $statusVal = true;
    } else if ($status == "inactive") {
      $statusVal = false;
    } else {
      throw new HttpBadRequestException("Bad Request. Invalid query " .
        "parameter, expected values 'active' or 'inactive");
    }
    $uploadTreeTableName = $this->restHelper->getUploadDao()->getUploadtreeTableName($uploadPk);
 
    if ($cxType == self::TYPE_COPYRIGHT) {
      $agentId = $this->copyrightHist->getAgentId($uploadPk, 'copyright_ars');
      $returnVal = $this->copyrightDao->getTotalCopyrights($uploadPk, $uploadTreeId, $uploadTreeTableName, $agentId, 'statement', $statusVal);
    } else if ($cxType == self::TYPE_COPYRIGHT_USERFINDINGS) {
      $copyrightData = $this->copyrightDao->getUserCopyrights($uploadPk, $uploadTreeId, $uploadTreeTableName, 'userfindingcopyright', $statusVal);
      $returnVal = $copyrightData[1];
    }
    return $response->withJson(array($version == ApiVersion::V2 ? "totalCopyrights" : "total_copyrights" => $returnVal), 200);
  }
 
  private function getFileCX($request, $response, $args, $cxType)
  {
    switch ($cxType) {
      case self::TYPE_COPYRIGHT:
        $dataType = 'statement';
        $agentArs = 'copyright_ars';
        break;
      case self::TYPE_COPYRIGHT_USERFINDINGS:
        $dataType = 'userfindingcopyright';
        $agentArs = 'copyright_ars';
        break;
      case self::TYPE_COPYRIGHT_SCANCODE:
        $dataType = 'scancode_statement';
        $agentArs = 'scancode_ars';
        break;
      case self::TYPE_EMAIL:
        $dataType = 'email';
        $agentArs = 'copyright_ars';
        break;
      case self::TYPE_EMAIL_SCANCODE:
        $dataType = 'scancode_email';
        $agentArs = 'scancode_ars';
        break;
      case self::TYPE_URL:
        $dataType = 'url';
        $agentArs = 'copyright_ars';
        break;
      case self::TYPE_URL_SCANCODE:
        $dataType = 'scancode_url';
        $agentArs = 'scancode_ars';
        break;
      case self::TYPE_AUTHOR:
        $dataType = 'author';
        $agentArs = 'copyright_ars';
        break;
      case self::TYPE_AUTHOR_SCANCODE:
        $dataType = 'scancode_author';
        $agentArs = 'scancode_ars';
        break;
      case self::TYPE_ECC:
        $dataType = 'ecc';
        $agentArs = 'ecc_ars';
        break;
      case self::TYPE_KEYWORD:
        $dataType = 'keyword';
        $agentArs = 'keyword_ars';
        break;
      case self::TYPE_IPRA:
        $dataType = 'ipra';
        $agentArs = 'ipra_ars';
        break;
      default:
        $dataType = 'statement';
        $agentArs = 'copyright_ars';
    }
    $apiVersion = ApiVersion::getVersion($request);
    $uploadPk = $args["id"];
    $uploadTreeId = $args["itemId"];
    $query = $request->getQueryParams();
    if ($apiVersion == ApiVersion::V2) {
      $limit = $query[self::LIMIT_PARAM] ?? "";
    } else {
      $limit = $request->getHeaderLine(self::LIMIT_PARAM);
    }
    $finalVal = [];
    if (!empty($limit)) {
      $limit = filter_var($limit, FILTER_VALIDATE_INT);
      if ($limit < 1) {
        throw new HttpBadRequestException(
          "limit should be positive integer > 1");
      }
    } else {
      $limit = self::COPYRIGHT_FETCH_LIMIT;
    }
    if (!array_key_exists(self::COPYRIGHT_PARAM, $query)) {
      throw new HttpBadRequestException("Bad Request. 'status' is a " .
        "required query param with expected values 'active' or 'inactive");
    }
    $status = $query[self::COPYRIGHT_PARAM];
    if ($status == "active") {
      $statusVal = true;
    } else if ($status == "inactive") {
      $statusVal = false;
    } else {
      throw new HttpBadRequestException("Bad Request. Invalid query " .
        "parameter, expected values 'active' or 'inactive");
    }
 
    $this->uploadAccessible($uploadPk);
    $this->isItemExists($uploadPk, $uploadTreeId);
 
    $agentId = $this->copyrightHist->getAgentId($uploadPk, $agentArs);
    $uploadTreeTableName = $this->restHelper->getUploadDao()->getuploadTreeTableName($uploadPk);
    if ($apiVersion == ApiVersion::V2) {
      $page = $query[self::PAGE_PARAM] ?? "";
    } else {
      $page = $request->getHeaderLine(self::PAGE_PARAM);
    }
    if (empty($page) && $page != "0") {
      $page = 1;
    }
    if (!empty($page) || $page == "0") {
      $page = filter_var($page, FILTER_VALIDATE_INT);
      if ($page <= 0) {
        throw new HttpBadRequestException(
          "page should be positive integer > 0");
      }
    }
    $offset = $limit * ($page - 1);
    if (self::TYPE_COPYRIGHT_USERFINDINGS == $cxType) {
      list($rows, $iTotalRecords) = $this->copyrightDao
        ->getUserCopyrights($uploadPk, $uploadTreeId, $uploadTreeTableName,
          $dataType, $statusVal, $offset, $limit);
    } else {
      list($rows, $iTotalDisplayRecords, $iTotalRecords) = $this->copyrightHist
        ->getCopyrights($uploadPk, $uploadTreeId, $uploadTreeTableName,
          $agentId, $dataType, 'active', $statusVal, $offset, $limit);
    }
    foreach ($rows as $row) {
      $row['count'] = intval($row['copyright_count']);
      unset($row['copyright_count']);
      $finalVal[] = $row;
    }
    $totalPages = intval(ceil($iTotalRecords / $limit));
    if ($totalPages != 0 && $page > $totalPages) {
      throw (new HttpBadRequestException(
        "Can not exceed total pages: $totalPages"))
        ->setHeaders(["X-Total-Pages" => $totalPages]);
    }
    return $response->withHeader("X-Total-Pages", $totalPages)->withJson($finalVal, 200);
  }
 
  private function deleteFileCX($args, $response, $cxType)
  {
    list($dataType, $delName) = $this->convertTypeToTable($cxType);
 
    $uploadDao = $this->restHelper->getUploadDao();
    $uploadPk = intval($args['id']);
    $uploadTreeId = intval($args['itemId']);
    $copyrightHash = $args['hash'];
    $userId = $this->restHelper->getUserId();
    $cpTable = $this->copyrightHist->getTableName($dataType);
 
    $this->uploadAccessible($uploadPk);
    $this->isItemExists($uploadPk, $uploadTreeId);
 
    $uploadTreeTableName = $uploadDao->getUploadTreeTableName($uploadTreeId);
    if (self::TYPE_COPYRIGHT_USERFINDINGS == $cxType) {
      $tableName = $cpTable."_decision";
      $decisions = $this->copyrightDao->getDecisionsFromHash($tableName, $copyrightHash,
        $uploadPk, $uploadTreeTableName);
      foreach ($decisions as $decision) {
        $this->copyrightDao->removeDecision($tableName, $decision['pfile_fk'],
          $decision[$tableName . '_pk']);
      }
    } else {
      $item = $uploadDao->getItemTreeBounds($uploadTreeId, $uploadTreeTableName);
      $this->copyrightDao->updateTable($item, $copyrightHash, '', $userId, $cpTable, 'delete');
    }
    $returnVal = new Info(200, "Successfully removed $delName.", InfoType::INFO);
    return $response->withJson($returnVal->getArray(), $returnVal->getCode());
  }
 
  private function restoreFileCx($args, $response, $cxType)
  {
    list($dataType, $resName) = $this->convertTypeToTable($cxType);
    $uploadPk = intval($args['id']);
    $uploadTreeId = intval($args['itemId']);
    $copyrightHash = ($args['hash']);
    $userId = $this->restHelper->getUserId();
    $cpTable = $this->copyrightHist->getTableName($dataType);
 
    $this->uploadAccessible($uploadPk);
    $this->isItemExists($uploadPk, $uploadTreeId);
 
    $uploadTreeTableName = $this->restHelper->getUploadDao()->getuploadTreeTableName($uploadTreeId);
    if (self::TYPE_COPYRIGHT_USERFINDINGS == $cxType) {
      $tableName = $cpTable."_decision";
      $decisions = $this->copyrightDao->getDecisionsFromHash($tableName, $copyrightHash,
        $uploadPk, $uploadTreeTableName);
      foreach ($decisions as $decision) {
        $this->copyrightDao->undoDecision($tableName, $decision['pfile_fk'],
          $decision[$tableName . '_pk']);
      }
    } else {
      $item = $this->restHelper->getUploadDao()->getItemTreeBounds($uploadTreeId, $uploadTreeTableName);
      $this->copyrightDao->updateTable($item, $copyrightHash, '', $userId, $cpTable, 'rollback');
    }
    $returnVal = new Info(200, "Successfully restored $resName.", InfoType::INFO);
    return $response->withJson($returnVal->getArray(), 200);
  }
 
  private function updateFileCx($request, $response, $args, $cxType)
  {
    list($dataType, $resName) = $this->convertTypeToTable($cxType);
    $uploadTreeId = intval($args["itemId"]);
    $uploadPk = intval($args["id"]);
    $copyrightHash = $args["hash"];
    $userId = $this->restHelper->getUserId();
    $cpTable = $this->copyrightHist->getTableName($dataType);
    $body = $this->getParsedBody($request);
    $content = $body['content'];
 
    $this->uploadAccessible($uploadPk);
    $this->isItemExists($uploadPk, $uploadTreeId);
 
    $uploadTreeTableName = $this->restHelper->getUploadDao()->getuploadTreeTableName($uploadTreeId);
    if (self::TYPE_COPYRIGHT_USERFINDINGS == $cxType) {
      $tableName = $cpTable."_decision";
      $decisions = $this->copyrightDao->getDecisionsFromHash($tableName, $copyrightHash,
        $uploadPk, $uploadTreeTableName);
      foreach ($decisions as $decision) {
        $this->copyrightDao->saveDecision($tableName, $decision['pfile_fk'], $decision['user_fk'],
          $decision['clearing_decision_type_fk'], $decision['description'],
          $content, $decision['comment'], $decision[$tableName . '_pk']);
      }
    } else {
      $item = $this->restHelper->getUploadDao()->getItemTreeBounds($uploadTreeId, $uploadTreeTableName);
      $this->copyrightDao->updateTable($item, $copyrightHash, $content, $userId, $cpTable);
    }
    $returnVal = new Info(200, "Successfully Updated $resName.", InfoType::INFO);
    return $response->withJson($returnVal->getArray(), 200);
  }
 
  private function convertTypeToTable(int $cxType): array
  {
    switch ($cxType) {
      case self::TYPE_COPYRIGHT:
        $dataType = 'statement';
        $dispName = 'copyright';
        break;
      case self::TYPE_COPYRIGHT_USERFINDINGS:
        $dataType = 'statement';
        $dispName = 'user-copyright';
        break;
      case self::TYPE_COPYRIGHT_SCANCODE:
        $dataType = 'scancode_statement';
        $dispName = 'scancode-copyright';
        break;
      case self::TYPE_EMAIL:
        $dispName = $dataType = 'email';
        break;
      case self::TYPE_EMAIL_SCANCODE:
        $dataType = 'scancode_email';
        $dispName = 'scancode-email';
        break;
      case self::TYPE_URL:
        $dispName = $dataType = 'url';
        break;
      case self::TYPE_URL_SCANCODE:
        $dataType = 'scancode_url';
        $dispName = 'scancode-url';
        break;
      case self::TYPE_AUTHOR:
        $dispName = $dataType = 'author';
        break;
      case self::TYPE_AUTHOR_SCANCODE:
        $dataType = 'scancode_author';
        $dispName = 'scancode-author';
        break;
      case self::TYPE_ECC:
        $dispName = $dataType = 'ecc';
        break;
      case self::TYPE_KEYWORD:
        $dispName = $dataType = 'keyword';
        break;
      case self::TYPE_IPRA:
        $dispName = $dataType = 'ipra';
        break;
      default:
        $dataType = 'statement';
        $dispName = 'copyright';
    }
    return array($dataType, $dispName);
  }
}