agent-keyword.php

<?php
/*
 SPDX-FileCopyrightText: © 2018 Siemens AG
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
use Fossology\Lib\Plugin\AgentPlugin;
 
class KeywordAgentPlugin extends AgentPlugin
{
  private $keywordDesc = "Performs file scanning to find text fragments that could be relevant for given keywords. Note: More keywords can be included using the configuration file.";
 
  public function __construct()
  {
    $this->Name = "agent_keyword";
    $this->Title = _("Keyword Analysis <img src=\"images/info_16.png\" data-toggle=\"tooltip\" title=\"".$this->keywordDesc."\" class=\"info-bullet\"/>");
    $this->AgentName = "keyword";
 
    parent::__construct();
  }
 
  function AgentHasResults($uploadId=0)
  {
    return CheckARS($uploadId, $this->AgentName, "keyword scanner", "keyword_ars");
  }
 
 
  public function AgentAdd($jobId, $uploadId, &$errorMsg, $dependencies=[],
      $arguments=null, $request=null, $unpackArgs=null)
  {
    if ($request != null && !is_array($request)) {
      $unpackArgs = intval($request->get('scm', 0)) == 1 ? '-I' : '';
    } else {
      $unpackArgs = intval(@$_POST['scm']) == 1 ? '-I' : '';
    }
    if ($this->AgentHasResults($uploadId) == 1) {
      return 0;
    }
 
    $jobQueueId = \IsAlreadyScheduled($jobId, $this->AgentName, $uploadId);
    if ($jobQueueId != 0) {
      return $jobQueueId;
    }
 
    $args = $unpackArgs;
    if (!empty($unpackArgs)) {
      return $this->doAgentAdd($jobId, $uploadId, $errorMsg, array("agent_mimetype"),$uploadId,$args,$request);
    } else {
      return $this->doAgentAdd($jobId, $uploadId, $errorMsg, array("agent_adj2nest"), $uploadId, null, $request);
    }
  }
 
  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;
  }
}
 
register_plugin(new KeywordAgentPlugin());