change-license-bulk.php

<?php
/*
 SPDX-FileCopyrightText: © 2014-2015, 2018 Siemens AG
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
use Fossology\DeciderJob\UI\DeciderJobAgentPlugin;
use Fossology\Lib\Auth\Auth;
use Fossology\Lib\Dao\LicenseDao;
use Fossology\Lib\Dao\UploadDao;
use Fossology\Lib\Db\DbManager;
use Fossology\Lib\Plugin\DefaultPlugin;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
 
class ChangeLicenseBulk extends DefaultPlugin
{
  const NAME = "change-license-bulk";
  private $licenseDao;
  private $dbManager;
  private $uploadDao;
 
  function __construct()
  {
    parent::__construct(self::NAME, array(
        self::TITLE => _("Private: schedule a bulk scan from post"),
        self::PERMISSION => Auth::PERM_WRITE
    ));
 
    $this->dbManager = $this->getObject('db.manager');
    $this->licenseDao = $this->getObject('dao.license');
    $this->uploadDao = $this->getObject('dao.upload');
  }
 
  public function handle(Request $request)
  {
    $uploadTreeId = $request->get('uploadTreeId');
    $uploadTreeId = strpos($uploadTreeId, ',') !== false
      ? explode(',', $uploadTreeId)
      : intval($uploadTreeId);
 
    if (empty($uploadTreeId)) {
      return new JsonResponse(array("error" => 'bad request'), JsonResponse::HTTP_BAD_REQUEST);
    }
 
    try {
      $jobQueueId = $this->scheduleBulkScan($uploadTreeId, $request);
    } catch (Exception $ex) {
      $errorMsg = $ex->getMessage();
      return new JsonResponse(array("error" => $errorMsg), JsonResponse::HTTP_INTERNAL_SERVER_ERROR);
    }
    ReportCachePurgeAll();
 
    return new JsonResponse(array("jqid" => $jobQueueId));
  }
 
  private function scheduleBulkScan($uploadTreeId, Request $request)
  {
    if (is_array($uploadTreeId)) {
      $jqId = array();
      foreach ($uploadTreeId as $uploadTreePk) {
        $jqId[] = $this->getJobQueueId($uploadTreePk, $request);
      }
      return $jqId;
    } else {
      return $this->getJobQueueId($uploadTreeId, $request);
    }
  }
  private function getJobQueueId($uploadTreeId, Request $request)
  {
    $uploadEntry = $this->uploadDao->getUploadEntry($uploadTreeId);
    $uploadId = intval($uploadEntry['upload_fk']);
    $userId = Auth::getUserId();
    $groupId = Auth::getGroupId();
 
    if ($uploadId <= 0 || !$this->uploadDao->isAccessible($uploadId, $groupId)) {
      throw new Exception('permission denied');
    }
 
    $bulkScope = $request->get('bulkScope');
    switch ($bulkScope) {
      case 'u':
        $uploadTreeTable = $this->uploadDao->getUploadtreeTableName($uploadId);
        $topBounds = $this->uploadDao->getParentItemBounds($uploadId, $uploadTreeTable);
        $uploadTreeId = $topBounds->getItemId();
        break;
 
      case 'f':
        if (!Isdir($uploadEntry['ufile_mode']) &&
            !Iscontainer($uploadEntry['ufile_mode']) &&
            !Isartifact($uploadEntry['ufile_mode'])) {
          $uploadTreeId = $uploadEntry['parent'] ?: $uploadTreeId;
        }
        break;
 
      default:
        throw new InvalidArgumentException('bad scope request');
    }
 
    $refText = $request->get('refText');
    $actions = $request->get('bulkAction');
    $ignoreIrrelevantFiles = (intval($request->get('ignoreIrre')) == 1);
    $scanFindingsOnly = boolval(intval($request->get('scanOnlyFindings')));
    $delimiters = $request->get('delimiters');
 
    $licenseRemovals = array();
    foreach ($actions as $licenseAction) {
      $licenseRemovals[$licenseAction['licenseId']] = array(($licenseAction['action']=='Remove'), $licenseAction['comment'], $licenseAction['reportinfo'], $licenseAction['acknowledgement']);
    }
    $bulkId = $this->licenseDao->insertBulkLicense($userId, $groupId,
      $uploadTreeId, $licenseRemovals, $refText, $ignoreIrrelevantFiles,
      $delimiters, $scanFindingsOnly);
 
    if ($bulkId <= 0) {
      throw new Exception('cannot insert bulk reference');
    }
    $upload = $this->uploadDao->getUpload($uploadId);
    $uploadName = $upload->getFilename();
    $job_pk = JobAddJob($userId, $groupId, $uploadName, $uploadId);
    $deciderPlugin = plugin_find("agent_deciderjob");
    $dependecies = array(array('name' => 'agent_monk_bulk', 'args' => $bulkId));
    $conflictStrategyId = intval($request->get('forceDecision'));
    $errorMsg = '';
    $jqId = $deciderPlugin->AgentAdd($job_pk, $uploadId, $errorMsg, $dependecies, $conflictStrategyId);
 
    if (!empty($errorMsg)) {
      throw new Exception(str_replace('<br>', "\n", $errorMsg));
    }
    return $jqId;
  }
}
 
register_plugin(new ChangeLicenseBulk());