agent-scancode.php

<?php
/*****************************************************************************
 * SPDX-License-Identifier: GPL-2.0
 * SPDX-FileCopyrightText: 2021 Sarita Singh <[email protected]>
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 ****************************************************************************/

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();
  }

  /**
   * @brief Render HTML from template
   * @param array $vars Variables using in template
   * @return string HTML rendered from agent_decider.html.twig template
   */
  public function renderContent(&$vars)
  {
    $renderer = $GLOBALS['container']->get('twig.environment');
    return $renderer->loadTemplate('scancode.html.twig')->render($vars);
  }

  /**
   * @brief Render footer HTML
   * @param array $vars Variables using in template
   * @return string Footer HTML
   */
  public function renderFoot(&$vars)
  {
    return "";
  }

  /**
   * @brief Schedule scancode agent
   * 
   * flags 
   * @param int $jobId
   * @param int $uploadId
   * @param string $errorMsg
   * @param Request $request Session request
   * @return int  $jobQueueId 
   */
  public function scheduleAgent($jobId, $uploadId, &$errorMsg, $request, $scanArgs='')
  {
    $dependencies = array();
    $flags = $request->get('scancodeFlags') ?: array();
    $scanMode =$scanArgs;
    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 0;
    }
    $unpackArgs = intval(@$_POST['scm']) == 1 ? 'I' : '';
    if (!empty($unpackArgs)) 
    {
      $dependencies[] = 'agent_mimetype';
      $scanMode .= $unpackArgs;
    }
    $args = self::SCAN_FLAG.$scanMode;
    return parent::AgentAdd($jobId, $uploadId, $errorMsg, array_unique($dependencies) , $args);
  }
  
  /**
   * @copydoc Fossology::Lib::Plugin::AgentPlugin::AgentHasResults()
   * @see Fossology::Lib::Plugin::AgentPlugin::AgentHasResults()
   */
  function AgentHasResults($uploadId=0)
  {
    return CheckARS($uploadId, $this->AgentName, "scancode agent", "scancode_ars");
  }
  
  /**
   * Check if agent already included in the dependency list
   * @param mixed  $dependencies Array of job dependencies
   * @param string $agentName    Name of the agent to be checked for
   * @return boolean true if agent already in dependency list else false
   */
  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;
  }

  /**
   * @copydoc Fossology::Lib::Plugin::AgentPlugin::preInstall()
   * @see Fossology::Lib::Plugin::AgentPlugin::preInstall()
   */
  public function preInstall()
  {
    menu_insert("ParmAgents::" . $this->Title, 0, $this->Name);
  }
}

register_plugin(new ScancodesAgentPlugin());

ajax-schedule-agent.php

<?php

use Fossology\Lib\Auth\Auth;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Request;
/***********************************************************
 Copyright (C) 2014 Hewlett-Packard Development Company, L.P.

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 version 2 as published by the Free Software Foundation.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License along
 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
***********************************************************/

/**
 * \file ajax_schedule_agent.php
 * \brief schedule one agent on one upload
 * This is intended as an active plugin to provide support
 * data to the UI.
 */

define("TITLE_AJAX_SCHEDULE_AGENT", _("Schedule agent"));

/**
 * \class ajax_upload_agents extends from FO_Plugin
 * \brief list all agents that can be scheduled for a given upload.
 */
class ajax_schedule_agent extends FO_Plugin
{
  function __construct()
  {
    $this->Name       = "schedule_agent";
    $this->Title      = TITLE_AJAX_SCHEDULE_AGENT;
    $this->DBaccess   = PLUGIN_DB_READ;
    parent::__construct();
  }


  /**
   * \brief Display the loaded menu and plugins.
   */
  public function Output()
  {
    global $Plugins;
    global $PG_CONN;
    $UploadPk = GetParm("upload",PARM_INTEGER);
    $Agent = GetParm("agent",PARM_STRING);
    $args = GetParm("args",PARM_STRING);
    if (empty($UploadPk) || empty($Agent)) {
      return new Response('missing parameter', Response::HTTP_BAD_REQUEST,
        array('Content-type' => 'text/plain'));
    }
    $sql = "SELECT upload_pk, upload_filename FROM upload WHERE upload_pk = '$UploadPk'";
    $result = pg_query($PG_CONN, $sql);
    DBCheckResult($result, $sql, __FILE__, __LINE__);
    if (pg_num_rows($result) < 1) {
      $errMsg = __FILE__ . ":" . __LINE__ . " " . _("Upload") . " " . $UploadPk .
        " " . _("not found");
      return new Response($errMsg, Response::HTTP_BAD_REQUEST,
        array('Content-type' => 'text/plain'));
    }
    $UploadRow = pg_fetch_assoc($result);
    $ShortName = $UploadRow['upload_filename'];
    pg_free_result($result);

    $user_pk = Auth::getUserId();
    $group_pk = Auth::getGroupId();
    $job_pk = JobAddJob($user_pk, $group_pk, $ShortName, $UploadPk);

    $Dependencies = array();
    $P = &$Plugins[plugin_find_id($Agent)];
    if ($args=='scanCopy'){
      $request = Request::createFromGlobals();
      // $request->add('scancodeFlags');
      // $request->set('scancodeFlags','copyright');
      $scanArgs='r';
      $rv = $P->scheduleAgent($job_pk, $UploadPk, $ErrorMsg, $request, $scanArgs);
    }
    else{
      $rv = $P->AgentAdd($job_pk, $UploadPk, $ErrorMsg, $Dependencies);
    }
    if ($rv <= 0) {
      $text = _("Scheduling of Agent(s) failed: ");
      return new Response($text . $rv . $ErrorMsg, Response::HTTP_BAD_REQUEST,
        array('Content-type' => 'text/plain'));
    }

    /** check if the scheudler is running */
    $status = GetRunnableJobList();
    $scheduler_msg = "";
    if (empty($status)) {
      $scheduler_msg .= _("Is the scheduler running? ");
    }

    $URL = Traceback_uri() . "?mod=showjobs&upload=$UploadPk";
    /* Need to refresh the screen */
    $text = _("Your jobs have been added to job queue.");
    $LinkText = _("View Jobs");
    $msg = "$scheduler_msg"."$text <a href=$URL>$LinkText</a>";
    $this->vars['message'] = $msg;
    return new Response($msg, Response::HTTP_OK, array('Content-type'=>'text/plain'));
  }
}

$NewPlugin = new ajax_schedule_agent;
$NewPlugin->Initialize();

HistogramBase.php

<?php
/***********************************************************
 * Copyright (C) 2014-2017 Siemens AG
 * Author: J.Najjar
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 ***********************************************************/

use Fossology\Lib\Auth\Auth;
use Fossology\Lib\Dao\UploadDao;

/**
 * @class HistogramBase
 * @abstract
 * @brief Base class for histogram plugins
 */
abstract class HistogramBase extends FO_Plugin {
  /** @var string
   * Name of agent serving the histogram
   */
  protected $agentName;
  /** @var  string
   * Plugin serving the request
   */
  protected $viewName;
  /** @var string
   * Name of uploadtree table to use
   */
  private $uploadtree_tablename;
  /** @var UploadDao
   * UploadDao object
   */
  private $uploadDao;

  function __construct()
  {
    $this->DBaccess = PLUGIN_DB_READ;
    $this->LoginFlag = 0;

    parent::__construct();

    global $container;
    $this->uploadDao = $container->get('dao.upload');
    $this->renderer = $container->get('twig.environment');

    $this->vars['name']=$this->Name;
  }

  /**
   * @param string $type         Type to be fetched
   * @param string $description  Description of the content
   * @param int    $uploadId     Upload id to process
   * @param int    $uploadTreeId Uploadtree id of the item
   * @param string $filter       Filter for query
   * @param int    $agentId      Id of the agent populated the result
   * @return array
   * @todo Template this! For now I just template the js
   */
  public function getTableForSingleType($type, $description, $uploadId, $uploadTreeId, $filter, $agentId)
  {
    $sorting = json_encode($this->returnSortOrder());

    $out = array("type" => $type, "sorting" => $sorting, "uploadId" => $uploadId,
        "uploadTreeId" => $uploadTreeId, "agentId" => $agentId, "filter" => $filter, "description" => $description);
    $typeDescriptor = "";
    if($type !== "statement" || $type !== 'scancode_statement')
    {
      $typeDescriptor = $description;
    }
    $output = "<h4>Activated $typeDescriptor statements:</h4>
<div><table border=1 width='100%' id='copyright".$type."' class='wordbreaktable'></table></div>
<br/><br/>
<div>
  <table border=0 width='100%' id='searchReplaceTable".$type."'>
  <tr>
    <td style='width:80%'>
      <div class='form-group'>
        <label class='control-label col-sm-2'>Advance search:<img src='images/info_16.png' title='Use \"(*)\" to match any thing.\nExample: \"Copyright (*) All rights reserved(*)\" will match \"Copyright 2012-2020 Company ABC. All rights reserved {and some garbage here}\"' alt='' class='info-bullet'></label>
        <div class='col-sm-10'>
          <input id='advSearchText".$type."' type='text' class='form-control advSearch'>
        </div>
      </div>
    </td>
    <td rowspan='2'>
      <div class='form-group'>
        <div class='col-sm-offset-2 col-sm-10'>
          <button class='btn btn-default' style='margin-top:25px;padding:15%;' onClick='createReplacementText(\"".$type."\")' title='Create a replacement text with all placeholders.'>Create replacement text</button>
        </div>
      </div>
    </td>
  </tr>
  <tr>
    <td>
      <div class='form-group'>
        <label class='control-label col-sm-2'>Replace:<img src='images/info_16.png' title='Use \"$1 $2\" as placeholder for corresponding (*) values.\nExample: \"Copyright $1 All rights reserved\" will result in \"Copyright 2012-2020 Company ABC. All rights reserved\" from example above' alt='' class='info-bullet'></label>
        <div class='col-sm-10'>
          <input id='replaceText".$type."' type='text' class='form-control'>
      </div>
    </div>
  </td>
  </tr></table>
    <div class='form-group'>
      <div class='col-sm-offset-2 col-sm-10'>
        <button class='btn btn-default' id='testReplacement".$type."'>Test replacement</button>
        <button class='btn btn-default' id='replaceSelected".$type."'>Replace selected rows</button>
        <button class='btn btn-default' id='deleteSelected".$type."'>Deactivate selected rows</button>
      </div>
    </div>
  <br /><br />
  <table border=1 id='testVal".$type."' style='display:none' class='dataTable wordbreaktable'>
    <tr><th style='width:50%'>From</th><th style='width:50%'>To</th></tr>
    <tr><td id='testVal".$type."From'></td><td id='testVal".$type."To'></td></tr>
  </table>
  <br/><br/>
  <h4>Deactivated $typeDescriptor statements:</h4>
</div>
<div><table border=1 width='100%' id='copyright".$type."deactivated' class='wordbreaktable'></table>
  <br/><br/>
  <a id='undoSelected".$type."' class='buttonLink'>Undo selected rows</a>
  <br /><br />
</div>";

    return array($output, $out);
  }


  /**
   * @brief Get copyright statements and fill the main content table
   * @param int    $upload_pk     Upload id for fetch request
   * @param int    $Uploadtree_pk Upload tree id of the item
   * @param string $filter        Filter to apply for query
   * @param int    $agentId       Agent id which populate the result
   * @param array  $VF
   * @return array Output, table variables
   */
  abstract protected function fillTables($upload_pk, $Uploadtree_pk, $filter, $agentId, $VF);

  /**
   * @brief Given an $Uploadtree_pk, display: \n
   * (1) The histogram for the directory BY LICENSE. \n
   * (2) The file listing for the directory.
   *
   * @param int    $Uploadtree_pk        Upload id
   * @param string $Uri                  URI
   * @param string $filter               Filter for query
   * @param string $uploadtree_tablename Uploadtree table to use
   * @param int    $Agent_pk             Agent id
   * @return array|void
   */
  protected function ShowUploadHist($upload_pk, $Uploadtree_pk, $Uri, $filter, $uploadtree_tablename, $Agent_pk)
  {
    list($ChildCount, $VF) = $this->getFileListing($Uploadtree_pk, $Uri, $uploadtree_tablename, $Agent_pk, $upload_pk);
    $this->vars['childcount'] = $ChildCount;
    $this->vars['fileListing'] = $VF;

    /***************************************
    @todo
    Problem: $ChildCount can be zero!
    This happens if you have a container that does not
    unpack to a directory.  For example:
    file.gz extracts to archive.txt that contains a license.
    Same problem seen with .pdf and .Z files.
    Solution: if $ChildCount == 0, then just view the license!
    $ChildCount can also be zero if the directory is empty.
     ***************************************/
    if ($ChildCount == 0)
    {
      $isADirectory = $this->isADirectory($Uploadtree_pk);
      if ($isADirectory) {
        return;
      }
      $ModLicView = plugin_find($this->viewName);
      return $ModLicView->execute();
    }
    return $this->fillTables($upload_pk, $Uploadtree_pk, $filter, $Agent_pk, $VF);
  }

  /**
   * @copydoc FO_Plugin::OutputOpen()
   * @see FO_Plugin::OutputOpen()
   */
  function OutputOpen()
  {
    if ($this->State != PLUGIN_STATE_READY) {
      return 0;
    }
    return parent::OutputOpen();
  }

  /**
   * @copydoc FO_Plugin::Output()
   * @see FO_Plugin::Output()
   */
  public function Output()
  {
    $OutBuf="";
    $uploadId = GetParm("upload",PARM_INTEGER);
    $item = GetParm("item",PARM_INTEGER);
    $filter = GetParm("filter",PARM_STRING);

    /* check upload permissions */
    if (!$this->uploadDao->isAccessible($uploadId, Auth::getGroupId()))
    {
      $text = _("Permission Denied");
      return "<h2>$text</h2>";
    }

    /* Get uploadtree_tablename */
    $uploadtree_tablename = GetUploadtreeTableName($uploadId);
    $this->uploadtree_tablename = $uploadtree_tablename;

    /************************/
    /* Show the folder path */
    /************************/

    $this->vars['dir2browse'] =  Dir2Browse($this->Name,$item,NULL,1,"Browse",-1,'','',$uploadtree_tablename);
    if (empty($uploadId))
    {
      return 'no item selected';
    }

    /* advanced interface allowing user to select dataset (agent version) */
    $dataset = $this->agentName."_dataset";
    $arstable = $this->agentName."_ars";
    /* get proper agent_id */
    // $agentId = GetParm("agent", PARM_INTEGER);
    if (empty($agentId))
    {
      $agentId = LatestAgentpk($uploadId, $arstable);
    }

    if ($agentId == 0)
    {
      /* schedule copyright */
      $OutBuf .= ActiveHTTPscript("Schedule");
      $OutBuf .= "<script language='javascript'>\n";
      $OutBuf .= "function Schedule_Reply()\n";
      $OutBuf .= "  {\n";
      $OutBuf .= "  if ((Schedule.readyState==4) && (Schedule.status==200 || Schedule.status==400))\n";
      $OutBuf .= "    document.getElementById('msgdiv').innerHTML = Schedule.responseText;\n";
      $OutBuf .= "  }\n";
      $OutBuf .= "</script>\n";

      $OutBuf .= "<form name='formy' method='post'>\n";
      $OutBuf .= "<div id='msgdiv'>\n";
      $OutBuf .= _("No data available.");
      $OutBuf .= "<input type='button' class='btn btn-default btn-sm' name='scheduleAgent' value='Schedule FOSSology Copyright'";
      $OutBuf .= "onClick=\"Schedule_Get('" . Traceback_uri() . "?mod=schedule_agent&upload=$uploadId&agent=agent_{$this->agentName}')\">\n";
      $OutBuf .= "</input>";
      $OutBuf .= "<input type='button' class='btn btn-default btn-sm' name='scheduleAgent' value='Schedule ScanCode for Copyright'";
      $OutBuf .= "onClick=\"Schedule_Get('" . Traceback_uri() . "?mod=schedule_agent&upload=$uploadId&agent=agent_scancode&args=scanCopy')\">\n";
      $OutBuf .= "</input>";
      $OutBuf .= "</div> \n";
      $OutBuf .= "</form>\n";

      $this->vars['pageContent'] = $OutBuf;
      return;
    }

    $AgentSelect = AgentSelect($this->agentName, $uploadId, $dataset, $agentId, "onchange=\"addArsGo('newds', $dataset);\"");

    /* change the copyright  result when selecting one version of copyright */
    if (!empty($AgentSelect))
    {
      $action = Traceback_uri() . '?mod=' . GetParm('mod',PARM_RAW) . Traceback_parm_keep(array('upload','item'));

      $OutBuf .= "<script type='text/javascript'>
        function addArsGo(formid, selectid)
        {
          var selectobj = document.getElementById(selectid);
          var Agent_pk = selectobj.options[selectobj.selectedIndex].value;
          document.getElementById(formid).action='$action'+'&agent='+Agent_pk;
          document.getElementById(formid).submit();
          return;
        }
      </script>";

      $OutBuf .= "<form action=\"$action\" id=\"newds\" method=\"POST\">$AgentSelect</form>";
    }

    $selectKey = $filter == 'nolic' ? 'nolic' : 'all';
    $OutBuf .= "<select name='view_filter' class='form-control-sm' id='view_filter' onchange='ChangeFilter(this,$uploadId, $item);'>";
    foreach(array('all'=>_("Show all"), 'nolic'=> _("Show files without licenses")) as $key=>$text)
    {
      $selected = ($selectKey == $key) ? "selected" : "";
      $OutBuf .= "<option $selected value=\"$key\">$text</option>";
    }
    $OutBuf .= "</select>";

    $uri = preg_replace("/&item=([0-9]*)/", "", Traceback());
    list($tables, $tableVars) = $this->ShowUploadHist($uploadId, $item, $uri, $selectKey, $uploadtree_tablename, $agentId);
    $this->vars['tables'] = $tableVars;
    $this->vars['pageContent'] = $OutBuf . $tables;
    $this->vars['scriptBlock'] = $this->createScriptBlock();

    return;
  }

  /**
   * @param int    $Uploadtree_pk        Uploadtree id
   * @param string $Uri                  URI
   * @param string $uploadtree_tablename Uploadtree table name
   * @param int    $Agent_pk             Agent id
   * @param int    $upload_pk            Upload id
   * @return array
   */
  protected function getFileListing($Uploadtree_pk, $Uri, $uploadtree_tablename, $Agent_pk, $upload_pk)
  {
    $VF=""; // return values for file listing
    /*******    File Listing     ************/
    /* Get ALL the items under this Uploadtree_pk */
    $Children = GetNonArtifactChildren($Uploadtree_pk, $uploadtree_tablename);
    $ChildCount = 0;
    $ChildLicCount = 0;
    $ChildDirCount = 0; /* total number of directory or containers */
    foreach ($Children as $c)
    {
      if (Iscontainer($c['ufile_mode']))
      {
        $ChildDirCount++;
      }
    }

    $VF .= "<table border=0>";
    foreach ($Children as $child)
    {
      if (empty($child))
      {
        continue;
      }
      $ChildCount++;

      global $Plugins;
      $ModLicView = &$Plugins[plugin_find_id($this->viewName)];
      /* Determine the hyperlink for non-containers to view-license  */
      if (!empty($child['pfile_fk']) && !empty($ModLicView))
      {
        $LinkUri = Traceback_uri();
        $LinkUri .= "?mod=".$this->viewName."&agent=$Agent_pk&upload=$upload_pk&item=$child[uploadtree_pk]";
      } else
      {
        $LinkUri = NULL;
      }

      /* Determine link for containers */
      if (Iscontainer($child['ufile_mode']))
      {
        $uploadtree_pk = DirGetNonArtifact($child['uploadtree_pk'], $uploadtree_tablename);
        $LicUri = "$Uri&item=" . $uploadtree_pk;
      } else
      {
        $LicUri = NULL;
      }

      /* Populate the output ($VF) - file list */
      /* id of each element is its uploadtree_pk */
      $LicCount = 0;

      $cellContent = Isdir($child['ufile_mode']) ? $child['ufile_name'].'/' : $child['ufile_name'];
      if (Iscontainer($child['ufile_mode']))
      {
        $cellContent = "<a class='btn btn-outline-secondary btn-sm' href='$LicUri'><b>$cellContent</b></a>";
      }
      else if (!empty($LinkUri)) //  && ($LicCount > 0))
      {
        $cellContent = "<a class='btn btn-outline-secondary btn-sm' href='$LinkUri'>$cellContent</a>";
      }
      $VF .= "<tr><td id='$child[uploadtree_pk]' align='left'>$cellContent</td><td>";

      if ($LicCount)
      {
        $VF .= "[" . number_format($LicCount, 0, "", ",") . "&nbsp;";
        $VF .= "license" . ($LicCount == 1 ? "" : "s");
        $VF .= "</a>";
        $VF .= "]";
        $ChildLicCount += $LicCount;
      }
      $VF .= "</td></tr>\n";
    }
    $VF .= "</table>\n";
    return array($ChildCount, $VF);
  }

  /**
   * @brief Check if passed element is a directory
   * @param int $Uploadtree_pk Uploadtree id of the element
   * @return boolean True if it is a directory, false otherwise
   */
  protected function isADirectory($Uploadtree_pk)
  {
    $row =  $this->uploadDao->getUploadEntry($Uploadtree_pk, $this->uploadtree_tablename);
    $isADirectory = IsDir($row['ufile_mode']);
    return $isADirectory;
  }

  /**
   * @brief Get sorting orders
   * @return string[][]
   */
  public function returnSortOrder () {
    $defaultOrder = array (
        array(0, "desc"),
        array(1, "desc"),
    );
    return $defaultOrder;
  }

  /**
   * @copydoc FO_Plugin::getTemplateName()
   * @see FO_Plugin::getTemplateName()
   */
  public function getTemplateName()
  {
    return "copyrighthist.html.twig";
  }

  /**
   * @brief Create JavaScript block for histogram
   * @return string JavaScript block
   */
  abstract protected function createScriptBlock();

}