agent-scancode.php

<?php
/*
 SPDX-FileCopyrightText: © 2021 Sarita Singh <saritasingh.0425@gmail.com>
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
namespace Fossology\Scancode\Ui;
 
use Fossology\Lib\Plugin\AgentPlugin;
use Symfony\Component\HttpFoundation\Request;
 
class ScancodesAgentPlugin extends AgentPlugin
{
  const SCAN_FLAG = '-';
 
  public function __construct()
  {
    $this->Name = "agent_scancode";
    $this->Title =  _("Scancode Toolkit");
    $this->AgentName = "scancode";
 
    parent::__construct();
  }
 
  public function renderContent(&$vars)
  {
    $renderer = $GLOBALS['container']->get('twig.environment');
    return $renderer->load('scancode.html.twig')->render($vars);
  }
 
  public function renderFoot(&$vars)
  {
    return "";
  }
 
  public function getScriptIncludes(&$vars)
  {
    return "";
  }
 
  public function scheduleAgent($jobId, $uploadId, &$errorMsg, $request)
  {
    $dependencies = array();
    $flags = $request->get('scancodeFlags') ?: array();
    $unpackArgs = intval($request->get('scm', 0)) == 1 ? 'I' : '';
    $args = $this->getScanCodeArgs($flags, $unpackArgs);
    if ($args === null) {
      return 0;
    }
    if (!empty($unpackArgs)) {
      $dependencies[] = 'agent_mimetype';
    }
    return parent::AgentAdd($jobId, $uploadId, $errorMsg, array_unique($dependencies) , $args);
  }
 
  public function getScanCodeArgs($flags, $unpackArgs)
  {
    $scanMode = '';
    foreach ($flags as $flag) {
      switch ($flag)
      {
        case "license":
          $scanMode .= 'l';
          break;
        case "copyright":
          $scanMode .= 'r';
          break;
        case "email":
          $scanMode .= 'e';
          break;
        case "url":
          $scanMode .= 'u';
          break;
      }
    }
    if (empty($scanMode)) {
      return null;
    }
    if (!empty($unpackArgs)) {
      $scanMode .= $unpackArgs;
    }
    return self::SCAN_FLAG . $scanMode;
  }
 
  function AgentHasResults($uploadId=0)
  {
    return CheckARS($uploadId, $this->AgentName, "scancode agent", "scancode_ars");
  }
 
  protected function isAgentIncluded($dependencies, $agentName)
  {
    foreach ($dependencies as $dependency) {
      if ($dependency == $agentName) {
        return true;
      }
      if (is_array($dependency) && $agentName == $dependency['name']) {
        return true;
      }
    }
    return false;
  }
 
  public function preInstall()
  {
    menu_insert("ParmAgents::" . $this->Title, 0, $this->Name);
  }
 
  public function isScanCodeInstalled()
  {
    global $SysConf;
    return file_exists("/home/" .
      $SysConf['DIRECTORIES']['PROJECTUSER'] . "/pythondeps/bin/scancode");
  }
}
 
$scanCode = new ScancodesAgentPlugin();
if ($scanCode->isScanCodeInstalled()) {
  register_plugin($scanCode);
}