ajax-spasht-copyright-hist.php

<?php
/*
 SPDX-FileCopyrightText: © 2019 Vivek Kumar <vvksindia@gmail.com>
 Author: Vivek Kumar<vvksindia@gmail.com>
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
use Fossology\Lib\Auth\Auth;
use Fossology\Lib\Dao\SpashtDao;
use Fossology\Lib\Util\DataTablesUtility;
use Fossology\Agent\Copyright\UI\TextFindingsAjax;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Response;
 
define("TITLE_SPASHTCOPYRIGHTHISTOGRAMPROCESSPOST", _("Private: Browse post"));
 
class SpashtCopyrightHistogramProcessPost extends FO_Plugin
{
  protected $listPage;
  private $uploadtree_tablename;
  private $uploadDao;
  private $spashtDao;
 
  private $dataTablesUtility;
 
  private $textFindingTypes = ["copyFindings"];
 
  function __construct()
  {
    $this->Name = "ajax-spasht-copyright-hist";
    $this->Title = TITLE_SPASHTCOPYRIGHTHISTOGRAMPROCESSPOST;
    $this->DBaccess = PLUGIN_DB_WRITE;
    $this->OutputType = 'JSON';
    $this->LoginFlag = 0;
    $this->NoMenu = 0;
 
    parent::__construct();
    global $container;
    $this->dataTablesUtility = $container->get('utils.data_tables_utility');
    $this->uploadDao = $container->get('dao.upload');
    $this->dbManager = $container->get('db.manager');
    $this->spashtDao = $container->get('dao.spasht');
  }
 
 
  function Output()
  {
    $returnValue = 0;
    if ($this->State != PLUGIN_STATE_READY) {
      return 0;
    }
 
    $action = GetParm("action", PARM_STRING);
    $upload = GetParm("upload", PARM_INTEGER);
    $type = GetParm("type", PARM_STRING);
 
    if ($action=="deletedecision" || $action=="undodecision") {
      $decision = GetParm("decision", PARM_INTEGER);
      $pfile = GetParm("pfile", PARM_INTEGER);
    } else if ($action=="deleteHashDecision" || $action=="undoHashDecision") {
      $hash = GetParm("hash", PARM_STRING);
    } else if ($action=="update" || $action=="delete" || $action=="undo") {
      $id = GetParm("id", PARM_STRING);
      $getEachID = array_filter(explode(",", trim($id, ',')), function($var) {
        return $var !== "";
      });
      if (count($getEachID) == 4) {
        list($upload, $item, $hash, $type) = $getEachID;
      } else {
        return new Response('bad request while '.$action,
                Response::HTTP_BAD_REQUEST,
                array('Content-type'=>'text/plain')
          );
      }
    }
 
    /* check upload permissions */
    if (!(($action == "getData" || $action == "getDeactivatedData") &&
        ($this->uploadDao->isAccessible($upload, Auth::getGroupId())) ||
        ($this->uploadDao->isEditable($upload, Auth::getGroupId())))) {
      $permDeniedText = _("Permission Denied");
      $returnValue = "<h2>$permDeniedText</h2>";
    }
    $this->uploadtree_tablename = $this->uploadDao->getUploadtreeTableName(
      $upload);
 
    if (in_array($type, $this->textFindingTypes) &&
      ($action == "getData" || $action == "getDeactivatedData")) {
      $textFindingsHandler = new TextFindingsAjax($this->uploadtree_tablename);
      if ($action == "getData") {
        $returnValue = $textFindingsHandler->doGetData($type, $upload);
      } elseif ($action == "getDeactivatedData") {
        $returnValue = $textFindingsHandler->doGetData($type, $upload, false);
      }
    } else {
      switch ($action) {
        case "getData":
          $returnValue = $this->doGetData($upload);
          break;
        case "getDeactivatedData":
          $returnValue = $this->doGetData($upload, false);
          break;
        case "update":
          $returnValue = $this->doUpdate($item, $hash, $type);
          break;
        case "delete":
          $returnValue = $this->doDelete($item, $hash, $type);
          break;
        case "undo":
          $returnValue = $this->doUndo($item, $hash, $type);
          break;
        default:
          $returnValue = "<h2>" . _("Unknown action") . "</h2>";
      }
    }
    return $returnValue;
  }
 
  protected function doGetData($upload, $activated = true)
  {
    $item = GetParm("item", PARM_INTEGER);
    $agent_pk = GetParm("agent", PARM_STRING);
    $type = GetParm("type", PARM_STRING);
    $filter = GetParm("filter", PARM_STRING);
    $this->listPage = "spasht-copyright-list";
 
    header('Content-type: text/json');
    list ($aaData, $iTotalRecords, $iTotalDisplayRecords) = $this->getTableData(
      $upload, $item, $agent_pk, $type, $this->listPage, $filter, $activated);
    return new JsonResponse(array(
            'sEcho' => intval($_GET['sEcho']),
            'aaData' => $aaData,
            'iTotalRecords' => $iTotalRecords,
            'iTotalDisplayRecords' => $iTotalDisplayRecords
        )
    );
  }
 
  private function getTableData($upload, $item, $agent_pk, $type, $listPage,
    $filter, $activated = true)
  {
    list ($rows, $iTotalDisplayRecords, $iTotalRecords) = $this->getCopyrights(
      $upload, $item, $this->uploadtree_tablename, $agent_pk, $type, $filter,
      $activated);
    $aaData = array();
    if (!empty($rows)) {
      $rw = $this->uploadDao->isEditable($upload, Auth::getGroupId());
      foreach ($rows as $row) {
        $aaData [] = $this->fillTableRow($row, $item, $upload, $agent_pk, $type,
          $listPage, $filter, $activated, $rw);
      }
    }
 
    return array($aaData, $iTotalRecords, $iTotalDisplayRecords);
  }
 
  protected function getCopyrights($upload_pk, $item, $uploadTreeTableName,
    $agentId, $type, $filter, $activated = true)
  {
    $offset = GetParm('iDisplayStart', PARM_INTEGER);
    $limit = GetParm('iDisplayLength', PARM_INTEGER);
 
    $tableName = $this->getTableName($type);
    $orderString = $this->getOrderString();
 
    list($left, $right) = $this->uploadDao->getLeftAndRight($item,
      $uploadTreeTableName);
 
    if ($filter == "") {
      $filter = "none";
    }
 
    $sql_upload = "";
    if ('uploadtree_a' == $uploadTreeTableName) {
      $sql_upload = " AND UT.upload_fk=$upload_pk ";
    }
 
    $join = "";
    $filterQuery = "";
    if ($type == 'statement' && $filter == "nolic") {
      $noLicStr = "No_license_found";
      $voidLicStr = "Void";
      $join = " INNER JOIN license_file AS LF on cp.pfile_fk=LF.pfile_fk ";
      $filterQuery = " AND LF.rf_fk IN (SELECT rf_pk FROM license_ref WHERE rf_shortname IN ('$noLicStr','$voidLicStr')) ";
    } else {
      // No filter, nothing to do
    }
    $params = array($left, $right, $agentId);
 
    $filterParms = $params;
    $searchFilter = $this->addSearchFilter($filterParms);
    $unorderedQuery = "FROM $tableName AS cp " .
        "INNER JOIN $uploadTreeTableName AS UT ON cp.pfile_fk = UT.pfile_fk " .
        $join .
        "WHERE textfinding!='' " .
        "AND ( UT.lft  BETWEEN  $1 AND  $2 ) " .
        "AND cp.agent_fk= $3 " .
        "AND cp.is_enabled=" . ($activated ? 'true' : 'false') .
        $sql_upload;
    $totalFilter = $filterQuery . " " . $searchFilter;
 
    $grouping = " GROUP BY hash, textfinding ";
 
    $countQuery = "SELECT count(*) FROM (SELECT textfinding AS content, count(*) $unorderedQuery $totalFilter $grouping) as K";
    $iTotalDisplayRecordsRow = $this->dbManager->getSingleRow($countQuery,
      $filterParms, __METHOD__.$tableName . ".count" .
      ($activated ? '' : '_deactivated'));
    $iTotalDisplayRecords = $iTotalDisplayRecordsRow['count'];
 
    $countAllQuery = "SELECT count(*) FROM (SELECT textfinding AS content, count(*) $unorderedQuery$grouping) as K";
    $iTotalRecordsRow = $this->dbManager->getSingleRow($countAllQuery, $params,
      __METHOD__,$tableName . "count.all" . ($activated ? '' : '_deactivated'));
    $iTotalRecords = $iTotalRecordsRow['count'];
 
    $range = "";
    $filterParms[] = $offset;
    $range .= ' OFFSET $' . count($filterParms);
    $filterParms[] = $limit;
    $range .= ' LIMIT $' . count($filterParms);
 
    $sql = "SELECT textfinding AS content, hash, count(*) as copyright_count " .
      $unorderedQuery . $totalFilter . " GROUP BY content, hash " .
      $orderString . $range;
    $statement = __METHOD__ . $filter.$tableName . $uploadTreeTableName .
      ($activated ? '' : '_deactivated');
    $rows = $this->dbManager->getRows($sql, $filterParms, $statement);
 
    return array($rows, $iTotalDisplayRecords, $iTotalRecords);
  }
 
  private function getTableName($type)
  {
    return "copyright_spasht";
  }
 
  private function getOrderString()
  {
    $columnNamesInDatabase = array('copyright_count', 'content');
 
    $defaultOrder = HistogramBase::returnSortOrder();
 
    return $this->dataTablesUtility->getSortingString($_GET,
      $columnNamesInDatabase, $defaultOrder);
  }
 
  private function addSearchFilter(&$filterParams)
  {
    $searchPattern = GetParm('sSearch', PARM_STRING);
    if (empty($searchPattern)) {
      return '';
    }
    $filterParams[] = "%$searchPattern%";
    return ' AND textfinding like $'.count($filterParams).' ';
  }
 
  private function getTableRowAction($hash, $uploadTreeId, $upload, $type, $activated = true, $rw = true)
  {
    if ($rw) {
      $act = "<img";
      if (!$activated) {
        $act .= " hidden='true'";
      }
      $act .= " id='delete$type$hash' onClick='delete$type($upload,$uploadTreeId,\"$hash\",\"$type\");' class=\"delete\" src=\"images/space_16.png\">";
      $act .= "<span";
      if ($activated) {
        $act .= " hidden='true'";
      }
      $act .= " id='update$type$hash'>deactivated [<a href=\"#\" id='undo$type$hash' onClick='undo$type($upload,$uploadTreeId,\"$hash\",\"$type\");return false;'>Undo</a>]</span>";
      return $act;
    }
    if (!$activated) {
      return "deactivated";
    }
    return "";
  }
 
  private function fillTableRow($row, $uploadTreeId, $upload, $agentId, $type,
    $listPage, $filter = "", $activated = true, $rw = true)
  {
    $hash = $row['hash'];
    $output = array('DT_RowId' => "$upload,$uploadTreeId,$hash,$type" );
 
    $link = "<a href='";
    $link .= Traceback_uri();
    $urlArgs = "?mod=".$listPage."&agent=$agentId&item=$uploadTreeId&hash=$hash&type=$type";
    if (!empty($filter)) {
      $urlArgs .= "&filter=$filter";
    }
    $link .= $urlArgs . "'>" . $row['copyright_count'] . "</a>";
    // Copyright filtering needs work. Removing link from output[0]
    $output['0'] = $row['copyright_count'];
    $output['1'] = convertToUTF8($row['content']);
    $output['2'] = $this->getTableRowAction($hash, $uploadTreeId, $upload,
      $type, $activated, $rw);
    if ($rw && $activated) {
      $output['3'] = "<input type='checkbox' class='deleteBySelect$type' id='deleteBySelect$type$hash' value='".$upload.",".$uploadTreeId.",".$hash.",".$type."'>";
    } else {
      $output['3'] = "<input type='checkbox' class='undoBySelect$type' id='undoBySelect$type$hash' value='".$upload.",".$uploadTreeId.",".$hash.",".$type."'>";
    }
    return $output;
  }
 
  protected function doUpdate($itemId, $hash, $type)
  {
    $content = GetParm("value", PARM_RAW);
    if (!$content) {
      return new Response('empty content not allowed',
        Response::HTTP_BAD_REQUEST, array('Content-type'=>'text/plain'));
    }
 
    $item = $this->uploadDao->getItemTreeBounds($itemId,
      $this->uploadtree_tablename);
    $this->spashtDao->updateCopyright($item, $hash, $content);
 
    return new Response('success', Response::HTTP_OK,
      array('Content-type'=>'text/plain'));
  }
 
  protected function doDelete($itemId, $hash, $type)
  {
    $item = $this->uploadDao->getItemTreeBounds($itemId,
      $this->uploadtree_tablename);
    $this->spashtDao->updateCopyright($item, $hash, '', 'delete');
    return new Response('Successfully deleted', Response::HTTP_OK,
      array('Content-type'=>'text/plain'));
  }
 
  protected function doUndo($itemId, $hash, $type)
  {
    $item = $this->uploadDao->getItemTreeBounds($itemId,
      $this->uploadtree_tablename);
    $this->spashtDao->updateCopyright($item, $hash, '', 'rollback');
    return new Response('Successfully restored', Response::HTTP_OK,
      array('Content-type'=>'text/plain'));
  }
}
 
$NewPlugin = new SpashtCopyrightHistogramProcessPost();
$NewPlugin->Initialize();