agent-bucket.php

<?php
/*
 SPDX-FileCopyrightText: © 2010-2013 Hewlett-Packard Development Company, L.P.
 SPDX-FileCopyrightText: © 2015 Siemens AG
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
use Fossology\Lib\Auth\Auth;
use Fossology\Lib\Dao\AgentDao;
use Fossology\Lib\Db\DbManager;
use Fossology\Lib\Plugin\AgentPlugin;
 
class BucketAgentPlugin extends AgentPlugin
{
  private $bucketDesc = "Performs grouping based on different needs. you can group licenses as 'Good Licenses', 'Academic Licenses', 'Copyleft Licenses' etc. One can also group files by copyright holder, or by file-type, or files without my copyright.
  Note: There is no FOSSology UI to create bucket pools, bucket definitions, scripts, or anything else you need.";
 
  public function __construct() {
    $this->Name = "agent_bucket";
    $this->Title = _("Bucket Analysis <img src=\"images/info_16.png\" data-toggle=\"tooltip\" title=\"".$this->bucketDesc."\" class=\"info-bullet\"/>");
    $this->AgentName = "buckets";
 
    parent::__construct();
  }
 
  protected function getDefaultBucketPool()
  {
    $user_pk = Auth::getUserId();
    if (empty($user_pk)) {
      return 0;
    }
 
    $dbManager = $GLOBALS['container']->get('db.manager');
    $usersRec = $dbManager->getSingleRow('SELECT default_bucketpool_fk FROM users WHERE user_pk=$1', array($user_pk));
    return $usersRec['default_bucketpool_fk'];
  }
 
  function preInstall()
  {
    $bucketPool = $this->getDefaultBucketPool();
    if (!empty($bucketPool))
    {
      menu_insert("Agents::" . $this->Title, 0, $this->Name);
    }
  }
 
  public function AgentHasResults($uploadId=0)
  {
    $default_bucketpool_fk = $this->getDefaultBucketPool();
    if (empty($default_bucketpool_fk)) {
      return 0;
    }
    /* @var $agentDao AgentDao */
    $agentDao = $GLOBALS['container']->get('dao.agent');
    $latestNomosAgentId = $agentDao->getCurrentAgentId("nomos", "Nomos license scanner");
    if (empty($latestNomosAgentId)) {
      return 0;
    }
    $latestBucketAgentId = $agentDao->getCurrentAgentId($this->AgentName, "Bucket scanner");
    if (empty($latestBucketAgentId)) {
      return 0;
    }
    /* @var $dbManager DbManager */
    $dbManager = $GLOBALS['container']->get('db.manager');
 
    $bucketLatestArsRec = $dbManager->getSingleRow("SELECT * FROM bucket_ars WHERE bucketpool_fk=$1 AND upload_fk=$2 AND nomosagent_fk=$3 and agent_fk=$4 AND ars_success=$5",
            array($default_bucketpool_fk,$uploadId,$latestNomosAgentId,$latestBucketAgentId,$dbManager->booleanToDb(true)),
            __METHOD__.'.latestNomosAndBucketScannedThisPool');
    if (!empty($bucketLatestArsRec)) return 1;
 
    $bucketOldArsRec = $dbManager->getSingleRow("SELECT * FROM bucket_ars WHERE bucketpool_fk=$1 AND upload_fk=$2 AND ars_success=$3",
            array($default_bucketpool_fk,$uploadId,$dbManager->booleanToDb(true)),
            __METHOD__.'.anyBucketScannedThisPool');
    if (!empty($bucketOldArsRec)) return 2;
 
    return 0;
  }
 
  public function AgentAdd($jobId, $uploadId, &$errorMsg, $dependencies=[],
      $arguments=null, $request=null, $unpackArgs=null)
  {
    $default_bucketpool_fk = $this->getDefaultBucketPool();
    if (!$default_bucketpool_fk)
    {
      $errorMsg = _("User does not have a default bucketpool.  Bucket agent cannot be scheduled without this.");
      return (-1);
    }
 
    $dependencies[] = "agent_nomos";
    $dependencies[] = "agent_pkgagent";
    $jqargs = "bppk=$default_bucketpool_fk, upk=$uploadId";
    return $this->doAgentAdd($jobId, $uploadId, $errorMsg, $dependencies,
        $jqargs, null, $request);
  }
}
 
register_plugin(new BucketAgentPlugin());