AgentPlugin.php

<?php
/***********************************************************
 * Copyright (C) 2015, Siemens AG
 *
 * 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\Lib\Plugin;

abstract class AgentPlugin implements Plugin
{
  const PRE_JOB_QUEUE = 'preJq';

  public $AgentName;
  public $Name = "agent_abstract";
  public $Dependency = array();
  public $Title = 'how to show checkbox';
  public $PluginLevel = 10;
  public $State = PLUGIN_STATE_READY;
  public $DBaccess = PLUGIN_DB_WRITE;

  function __construct()
  {
  }
  function execute()
  {
  }
  function postInstall()
  {
  }

  function preInstall()
  {
    menu_insert("Agents::" . $this->Title, 0, $this->Name);
  }

  function unInstall()
  {
  }

  function getName()
  {
    return $this->Name;
  }

  public function AgentHasResults($uploadId=0)
  {
    return 0;
  }

  public function AgentAdd($jobId, $uploadId, &$errorMsg, $dependencies=array(), $arguments=null)
  {
    $dependencies[] = "agent_adj2nest";
    if ($this->AgentHasResults($uploadId) == 1) {
      return 0;
    }

    $jobQueueId = \IsAlreadyScheduled($jobId, $this->AgentName, $uploadId);
    if ($jobQueueId != 0) {
      return $jobQueueId;
    }

    $args = is_array($arguments) ? '' : $arguments;
    return $this->doAgentAdd($jobId, $uploadId, $errorMsg, $dependencies, $uploadId, $args);
  }

  protected function doAgentAdd($jobId, $uploadId, &$errorMsg, $dependencies, $jqargs = "", $jq_cmd_args = null)
  {
    $deps = array();
    foreach ($dependencies as $dependency) {
      $dep = $this->implicitAgentAdd($jobId, $uploadId, $errorMsg, $dependency);
      if ($dep == - 1) {
        return -1;
      }
      $deps[] = $dep;
    }

    if (empty($jqargs)) {
      $jqargs = $uploadId;
    }
    $jobQueueId = \JobQueueAdd($jobId, $this->AgentName, $jqargs, "", $deps, NULL, $jq_cmd_args);
    if (empty($jobQueueId)) {
      $errorMsg = "Failed to insert agent $this->AgentName into job queue. jqargs: $jqargs";
      return -1;
    }
    $success = \fo_communicate_with_scheduler("database", $output, $errorMsg);
    if (! $success) {
      $errorMsg .= "\n" . $output;
    }

    return $jobQueueId;
  }

  protected function implicitAgentAdd($jobId, $uploadId, &$errorMsg, $dependency)
  {
    if (is_array($dependency)) {
      $pluginName = $dependency['name'];
      $depArgs = array_key_exists('args', $dependency) ? $dependency['args'] : null;
      $preJq = array_key_exists(self::PRE_JOB_QUEUE, $dependency) ? $dependency[self::PRE_JOB_QUEUE] : array();
    } else {
      $pluginName = $dependency;
      $depArgs = null;
      $preJq = array();
    }
    $depPlugin = plugin_find($pluginName);
    if (! $depPlugin) {
      $errorMsg = "Invalid plugin name: $pluginName, (implicitAgentAdd())";
      return -1;
    }

    return $depPlugin->AgentAdd($jobId, $uploadId, $errorMsg, $preJq, $depArgs);
  }

  function __toString()
  {
    return getStringRepresentation(get_object_vars($this), get_class($this));
  }
}