fossjobs.php

Go to the documentation of this file.

<?php
/*
 SPDX-FileCopyrightText: © 2008-2012 Hewlett-Packard Development Company, L.P.
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
use Fossology\Lib\Auth\Auth;
use Fossology\Lib\Dao\UploadDao;
 
/**********************************************************************
 **********************************************************************
SUPPORT FUNCTIONS
**********************************************************************
**********************************************************************/
function list_agents()
{
  $agent_list = menu_find("Agents", $depth);
  return ($agent_list);
}
 
require_once("$MODDIR/lib/php/common-cli.php");
 
global $Plugins;
global $PERM_NAMES;
global $SysConf;
global $PG_CONN;
 
/**********************************************************************
 **********************************************************************
INITIALIZE THIS INTERFACE
**********************************************************************
**********************************************************************/
$usage = basename($argv[0]) . " [options]
  Options:
  -h        :: help, this message
  -v        :: verbose output
  -a        :: list available agent tasks
  -A string :: specify agent to schedule (default is everything from -a)
               The string can be a comma-separated list of agent tasks.
  -u        :: list available upload ids
  -U upload :: the upload identifier for scheduling agent tasks
               The string can be a comma-separated list of upload ids.
               Or, use 'ALL' to specify all upload ids.
  -D upload :: the upload identifier for scheduling delete tasks
               The string can either be 'ALL', a string (the upload_pk),
               or an array of upload_pk's if multiple -D's were specified.
  --username string :: user name
  --password string :: password
  --groupname string :: group name
  -c string :: Specify the directory for the system configuration
";
//process parameters, see usage above
$longopts = array("username:", "password:", "groupname:");
$options = getopt("c:haA:P:uU:D:v", $longopts);
//print_r($options);
if (empty($options)) {
  echo $usage;
  exit(1);
}
if (array_key_exists("h", $options)) {
  echo $usage;
  exit(0);
}
 
/**********************************************************************
 **********************************************************************
PROCESS COMMAND LINE SELECTION
**********************************************************************
**********************************************************************/
$user = "";
$passwd = "";
$group = "";
if (array_key_exists("username", $options)) {
  $user = $options["username"];
}
 
if (array_key_exists("groupname", $options)) {
  $group = $options["groupname"];
}
 
if (array_key_exists("password", $options)) {
  $passwd = $options["password"];
}
 
account_check($user, $passwd, $group); // check username/password
$groupId = Auth::getGroupId();
 
/* init plugins */
cli_Init();
 
$Verbose = 0;
if (array_key_exists("v", $options)) {
  $Verbose = 1;
}
 
// Get the list of registered agents
$agent_list = list_agents();
if (empty($agent_list)) {
  echo "ERROR! could not get list of agents\n";
  echo "Are Plugins configured?\n";
  exit(1);
}
 
/* List available agents */
if (array_key_exists("a", $options)) {
  if (empty($agent_list)) {
    echo "No agents configured\n";
  } else {
    echo "The available agents are:\n";
    $agent_count = count($agent_list);
    for ($ac = 0;$ac < $agent_count;$ac++) {
      $agent = ($agent_list[$ac]->URI);
      if (!empty($agent)) {
        echo " $agent\n";
      }
    }
  }
}
 
/* Hide agents  that aren't related to data scans */
$Skip = array("agent_unpack", "agent_adj2nest", "wget_agent");
for ($ac=0; !empty($agent_list[$ac]->URI); $ac++) {
  if (array_search($agent_list[$ac]->URI, $Skip) !== false) {
    unset($agent_list[$ac]);
  }
}
 
/* If the user specified a list, then disable every agent not in the list */
$Skip = array("agent_unpack", "agent_adj2nest", "wget_agent");
if (array_key_exists("A", $options)) {
  $agent_count = count($agent_list);
  for ($ac = 0;$ac < $agent_count;$ac++) {
    $Found = 0;
    foreach (explode(',', $options["A"]) as $Val) {
      if (!strcmp($Val, $agent_list[$ac]->URI)) {
        $Found = 1;
      }
    }
    if ($Found == 0) {
      $agent_list[$ac]->URI = null;
    }
  }
}
 
/* List available uploads */
if (array_key_exists("u", $options)) {
  $root_folder_pk = GetUserRootFolder();
  $FolderPath = null;
  $FolderList = FolderListUploadsRecurse($root_folder_pk, $FolderPath, Auth::PERM_WRITE);
 
  print "# The following uploads are available (upload id: name)\n";
  foreach ($FolderList as $Folder) {
    $Label = $Folder['name'] . " (" . $Folder['upload_desc'] . ')';
    print $Folder['upload_pk'] . ": $Label\n";
  }
  exit(0);
}
 
/* @var $uploadDao UploadDao */
$uploadDao = $GLOBALS['container']->get('dao.upload');
 
if (array_key_exists("U", $options)) {
  /* $options['U'] can either be 'ALL', a string (the upload_pk),
     or an array of upload_pk's if multiple -U's were specified.
   */
  $upload_options = $options['U'];
  $upload_pk_array = array();
  if ($upload_options == 'ALL') {
    $SQL = "SELECT upload_pk,upload_desc,upload_filename FROM upload ORDER BY upload_pk;";
    $result = pg_query($PG_CONN, $SQL);
    DBCheckResult($result, $SQL, __FILE__, __LINE__);
    while ($row = pg_fetch_assoc($result) && !empty($row['upload_pk'])) {
        $upload_pk_array[] = $row['upload_pk'];
    }
    pg_free_result($result);
  } else if (is_array($upload_options)) {
    $upload_pk_array = $upload_options;
  } else {
    $upload_pk_array[] = $upload_options;
  }
 
  /* check permissions */
  $checked_list = array();
  foreach ($upload_pk_array as $upload_pk) {
    if (!$uploadDao->isEditable($upload_pk, $groupId)) {
      print "You have no permission to queue agents for upload $upload_pk in group $groupId\n";
      continue;
    }
    $checked_list[] = $upload_pk;
  }
  $checked_list_str = implode(",", $checked_list);
 
  QueueUploadsOnAgents($checked_list_str, $agent_list, $Verbose);
}
 
if (array_key_exists("D", $options)) {
  /* $options['D'] can either be 'ALL', a string (the upload_pk),
     or an array of upload_pk's if multiple -D's were specified.
   */
  $upload_options = $options['D'];
  $upload_pk_array = array();
  if ($upload_options == 'ALL') {
    $SQL = "SELECT upload_pk,upload_desc,upload_filename FROM upload ORDER BY upload_pk;";
    $result = pg_query($PG_CONN, $SQL);
    DBCheckResult($result, $SQL, __FILE__, __LINE__);
    while ($row = pg_fetch_assoc($result) && !empty($row['upload_pk'])) {
        $upload_pk_array[] = $row['upload_pk'];
    }
    pg_free_result($result);
  } else if (is_array($upload_options)) {
    $upload_pk_array = $upload_options;
  } else {
    $upload_pk_array[] = $upload_options;
  }
  /* check permissions */
  $checked_list = array();
  foreach ($upload_pk_array as $upload_pk) {
    if (!$uploadDao->isEditable($upload_pk, $groupId)) {
      print "You have no permission to delete upload " . $upload_pk . "\n";
      continue;
    }
    $checked_list[] = $upload_pk;
  }
  $checked_list_str = implode(",", $checked_list);
 
  QueueUploadsOnDelagents($checked_list_str);
}