JobController.php

Go to the documentation of this file.

<?php
/*
 SPDX-FileCopyrightText: © 2018 Siemens AG
 Author: Gaurav Mishra <mishra.gaurav@siemens.com>
 SPDX-FileCopyrightText: © 2022 Samuel Dushimimana <dushsam100@gmail.com>
 
 SPDX-License-Identifier: GPL-2.0-only
*/
namespace Fossology\UI\Api\Controllers;
 
use Fossology\Lib\Db\DbManager;
use Fossology\UI\Api\Exceptions\HttpBadRequestException;
use Fossology\UI\Api\Exceptions\HttpErrorException;
use Fossology\UI\Api\Exceptions\HttpForbiddenException;
use Fossology\UI\Api\Exceptions\HttpInternalServerErrorException;
use Fossology\UI\Api\Exceptions\HttpNotFoundException;
use Fossology\UI\Api\Helper\ResponseHelper;
use Fossology\UI\Api\Helper\UploadHelper;
use Fossology\UI\Api\Models\Info;
use Fossology\UI\Api\Models\InfoType;
use Fossology\UI\Api\Models\JobQueue;
use Fossology\UI\Api\Models\ShowJob;
use Fossology\UI\Api\Models\ApiVersion;
use Psr\Http\Message\ServerRequestInterface;
use Slim\Psr7\Request;
 
class JobController extends RestController
{
  const UPLOAD_PARAM = "upload";
  const JOB_COMPLETED = 0x1 << 1;
  const JOB_STARTED = 0x1 << 2;
  const JOB_QUEUED = 0x1 << 3;
  const JOB_FAILED = 0x1 << 4;
 
  public function getAllJobs($request, $response, $args)
  {
    $apiVersion = ApiVersion::getVersion($request);
    $this->throwNotAdminException();
 
    $queryParams = $request->getQueryParams();
    $query = $apiVersion == ApiVersion::V2 ? $queryParams : array_map(function($header) {
      return implode(",", $header);
    }, $request->getHeaders());
 
    $limit = isset($query['limit']) ? intval($query['limit']) : 0;
    $page = isset($query['page']) ? intval($query['page']) : 1;
    $sort = $queryParams['sort'] ?? "ASC";
    $status = $queryParams['status'] ?? null;
 
    if ($limit < 0 || $page < 1) {
      throw new HttpBadRequestException("Limit cannot be negative and page must be >= 1.");
    }
 
    return $this->getAllResults(null, $status, $request, $response, $sort, $limit, $page, $apiVersion);
  }
 
  public function getJobs($request, $response, $args)
  {
    $apiVersion = ApiVersion::getVersion($request);
    $userId = $this->restHelper->getUserId();
 
    $queryParams = $request->getQueryParams();
    $query = $apiVersion == ApiVersion::V2 ? $queryParams : array_map(function($header) {
      return implode(",", $header);
    }, $request->getHeaders());
 
    $limit = isset($query['limit']) ? intval($query['limit']) : 0;
    $page = isset($query['page']) ? intval($query['page']) : 1;
    $sort = $queryParams['sort'] ?? "ASC";
    $status = $queryParams['status'] ?? null;
 
    if ($limit < 0 || $page < 1) {
      throw new HttpBadRequestException("Limit cannot be negative and page must be >= 1.");
    }
 
    $id = isset($args['id']) ? intval($args['id']) : null;
    if ($id !== null && !$this->dbHelper->doesIdExist("job", "job_pk", $id)) {
      throw new HttpNotFoundException("Job id " . $id . " doesn't exist");
    }
 
    if ($id !== null) {
      /* If the ID is passed, ignore any upload query parameter and let
       * getAllResults() authorize access to the job's own upload. */
      return $this->getAllResults($id, $status, $request, $response, $sort, $limit, $page, $apiVersion);
    }
 
    if (array_key_exists(self::UPLOAD_PARAM, $queryParams)) {
      /* If the upload is passed, filter accordingly */
      return $this->getFilteredResults(intval($queryParams[self::UPLOAD_PARAM]),
        $status, $request, $response, $sort, $limit, $page, $apiVersion);
    }
 
    /* Otherwise return all jobs for the current user */
    return $this->getAllUserResults($userId, $status, $request, $response, $sort, $limit, $page, $apiVersion);
  }
 
  public function createJob($request, $response, $args)
  {
    $apiVersion = ApiVersion::getVersion($request);
    $folder = null;
    $upload = null;
    if ($apiVersion == ApiVersion::V2) {
      $query = $request->getQueryParams();
      $folder = $query["folderId"] ?? null;
      $upload = $query["uploadId"] ?? null;
    } else {
      $folder = $request->hasHeader('folderId') ? $request->getHeaderLine('folderId') : null;
      $upload = $request->hasHeader('uploadId') ? $request->getHeaderLine('uploadId') : null;
    }
    if (is_numeric($folder) && is_numeric($upload) && $folder > 0 && $upload > 0) {
      $scanOptionsJSON = $this->getParsedBody($request);
      if (empty($scanOptionsJSON)) {
        throw new HttpBadRequestException("No agents selected!");
      }
      $uploadHelper = new UploadHelper();
      $info = $uploadHelper->handleScheduleAnalysis($upload, $folder,
        $scanOptionsJSON, false, $apiVersion);
      return $response->withJson($info->getArray(), $info->getCode());
    }
    throw new HttpBadRequestException(
      "Folder id and upload id should be integers!");
  }
 
  public function deleteJob($request, $response, $args)
  {
    $userId = $this->restHelper->getUserId();
    $userName = $this->restHelper->getUserDao()->getUserName($userId);
 
    /* Check if the job exists */
    $jobId  = intval($args['id']);
    if (! $this->dbHelper->doesIdExist("job", "job_pk", $jobId)) {
      throw new HttpNotFoundException("Job id " . $jobId . " doesn't exist");
    }
 
    /* Check if user has permission to delete this job*/
    $canDeleteJob = $this->restHelper->getJobDao()->hasActionPermissionsOnJob($jobId, $userId, $this->restHelper->getGroupId());
    if (! $canDeleteJob) {
      throw new HttpForbiddenException(
        "You don't have permission to delete this job.");
    }
 
    $queueId = $args['queue'];
 
    /* Get Jobs that depend on the job to be deleted */
    $JobQueue = $this->restHelper->getShowJobDao()->getJobInfo([$jobId])[$jobId]["jobqueue"];
 
    if (!array_key_exists($queueId, $JobQueue)) {
      throw new HttpNotFoundException(
        "Job queue " . $queueId . " doesn't exist in Job " . $jobId);
    }
 
    $dependentJobs = [];
    $dependentJobs[] = $queueId;
 
    foreach ($JobQueue as $job) {
      if (in_array($queueId, $job["depends"])) {
        $dependentJobs[] = $job["jq_pk"];
      }
    }
 
    /* Delete All jobs in dependentJobs */
    foreach ($dependentJobs as $job) {
      $Msg = "\"" . _("Killed by") . " " . $userName . "\"";
      $command = "kill $job $Msg";
      $rv = fo_communicate_with_scheduler($command, $response_from_scheduler, $error_info);
      if (!$rv) {
        throw new HttpInternalServerErrorException(
          "Failed to kill job $jobId");
      }
    }
    $returnVal = new Info(200, "Job deleted successfully", InfoType::INFO);
    return $response->withJson($returnVal->getArray(), $returnVal->getCode());
  }
 
  private function getAllUserResults($userId, $status, $request, $response, $sort, $limit, $page, $apiVersion)
  {
    list($jobs, $count) = $this->dbHelper->getUserJobs($userId, $status, $sort, $limit, $page);
    $finalJobs = [];
    foreach ($jobs as $job) {
      $this->updateEta($job);
      if ($apiVersion == ApiVersion::V2) {
        $this->addJobQueue($job, $request);
      }
      $finalJobs[] = $job->getArray($apiVersion);
    }
    return $response->withHeader("X-Total-Pages", $count)->withJson($finalJobs, 200);
  }
 
  private function getAllResults($id, $status, $request, $response, $sort, $limit, $page, $apiVersion)
  {
    list($jobs, $count) = $this->dbHelper->getJobs($id, $status, $sort, $limit, $page, null);
    if ($id !== null && !empty($jobs)) {
      /* A specific job was requested, make sure the caller can access the
       * upload it belongs to before returning any of its data. */
      $this->uploadAccessible($jobs[0]->getUploadId());
    }
    $finalJobs = [];
    foreach ($jobs as $job) {
      $this->updateEta($job);
      if ($apiVersion == ApiVersion::V2) {
        $this->addJobQueue($job, $request);
      }
      $finalJobs[] = $job->getArray($apiVersion);
    }
    if ($id !== null) {
      $finalJobs = $finalJobs[0];
    }
    return $response->withHeader("X-Total-Pages", $count)->withJson($finalJobs, 200);
  }
 
  private function getFilteredResults($uploadId, $status, $request, $response, $sort, $limit, $page, $apiVersion)
  {
    $this->uploadAccessible($uploadId);
    list($jobs, $count) = $this->dbHelper->getJobs(null, $status, $sort, $limit, $page, $uploadId);
    $finalJobs = [];
    foreach ($jobs as $job) {
      $this->updateEta($job);
      if ($apiVersion == ApiVersion::V2) {
        $this->addJobQueue($job, $request);
      }
      $finalJobs[] = $job->getArray($apiVersion);
    }
    return $response->withHeader("X-Total-Pages", $count)->withJson($finalJobs, 200);
  }
 
  private function updateEta(&$job)
  {
    $job->setEta($this->getUploadEtaInSeconds($job->getId(),
      $job->getUploadId()));
  }
 
  private function getUploadEtaInSeconds($jobId, $uploadId)
  {
    $showJobDao = $this->restHelper->getShowJobDao();
    $eta = $showJobDao->getEstimatedTime($jobId, '', 0, $uploadId);
    $eta = explode(":", $eta);
    if (count($eta) > 1) {
      $eta = (intval($eta[0]) * 3600) + (intval($eta[1]) * 60) + intval($eta[2]);
    } else {
      $eta = 0;
    }
    return $eta;
  }
 
  public function getJobsHistory($request, $response, $args)
  {
    $query = $request->getQueryParams();
    if (!array_key_exists(self::UPLOAD_PARAM, $query)) {
      throw new HttpBadRequestException("'upload' is a required query param");
    }
    $upload_fk = intval($query[self::UPLOAD_PARAM]);
    // checking if the upload exists and if yes, whether it is accessible
    $this->uploadAccessible($upload_fk);
 
    $dbManager = $this->dbHelper->getDbManager();
 
    // getting all the jobs from the DB for the upload id
    $query = "SELECT job_pk FROM job WHERE job_upload_fk=$1;";
    $statement = __METHOD__.".getJobs";
    $result = $dbManager->getRows($query, [$upload_fk], $statement);
 
    // creating a list of all the job_pks
    $allJobPks = array_column($result, 'job_pk');
 
    // getting the show jobs data for each job
    $showJobData = $this->getJobQueue($allJobPks);
 
    // creating the response structure
    $allJobsHistory = array();
    foreach ($showJobData as $jobValObj) {
      $finalJobqueue = array();
      foreach ($jobValObj['job']['jobQueue'] as $jqVal) {
        $depends = [];
        if ($jqVal['depends'][0] != null) {
          $depends = $jqVal['depends'];
        }
        $download = null;
        if (!empty($jqVal['download'])) {
          $download = [
            "text" => $jqVal["download"],
            "link" => ReportController::buildDownloadPath($request,
              $jqVal['jq_job_fk'])
          ];
        }
        $jobQueue = new JobQueue($jqVal['jq_pk'], $jqVal['jq_type'],
          $jqVal['jq_starttime'], $jqVal['jq_endtime'], $jqVal['jq_endtext'],
          $jqVal['jq_itemsprocessed'], $jqVal['jq_log'], $depends,
          $jqVal['itemsPerSec'], $jqVal['canDoActions'], $jqVal['isInProgress'],
          $jqVal['isReady'], $download);
        $finalJobqueue[] = $jobQueue->getArray();
      }
      $job = new ShowJob($jobValObj['job']['jobId'],
        $jobValObj['job']['jobName'], $finalJobqueue,
        $jobValObj['upload']['uploadId']);
      $allJobsHistory[] = $job->getArray();
    }
    return $response->withJson($allJobsHistory, 200);
  }
 
  private function getJobQueue($allJobPks)
  {
    $showJobsDao = $this->restHelper->getShowJobDao();
    $jobsInfo = $showJobsDao->getJobInfo($allJobPks);
    usort($jobsInfo, [$this, "compareJobsInfo"]);
 
    $ajaxShowJobs = $this->restHelper->getPlugin('ajaxShowJobs');
    $showJobData = $ajaxShowJobs->getShowJobsForEachJob($jobsInfo, true);
 
    return $showJobData;
  }
 
  private function addJobQueue(&$job, $request = null)
  {
    $jobQueue = $this->getJobQueue([$job->getId()]);
    $finalJobqueue = array();
    foreach ($jobQueue[0]['job']['jobQueue'] as $jqVal) {
      $depends = [];
      if ($jqVal['depends'][0] != null) {
        $depends = $jqVal['depends'];
      }
      $download = null;
      if (!empty($jqVal['download'])) {
        $download = [
          "text" => $jqVal["download"],
          "link" => ReportController::buildDownloadPath($request,
            $jqVal['jq_job_fk'])
        ];
      }
      $singleJobQueue = new JobQueue($jqVal['jq_pk'], $jqVal['jq_type'],
        $jqVal['jq_starttime'], $jqVal['jq_endtime'], $jqVal['jq_endtext'],
        $jqVal['jq_itemsprocessed'], $jqVal['jq_log'], $depends,
        $jqVal['itemsPerSec'], $jqVal['canDoActions'], $jqVal['isInProgress'],
        $jqVal['isReady'], $download);
      $finalJobqueue[] = $singleJobQueue->getArray();
    }
    $job->setJobQueue($finalJobqueue);
  }
 
  private function compareJobsInfo($JobsInfo1, $JobsInfo2)
  {
    return $JobsInfo2["job"]["job_pk"] - $JobsInfo1["job"]["job_pk"];
  }
 
  public function getJobStatistics($request, $response, $args)
  {
    $this->throwNotAdminException();
    $statisticsPlugin = $this->restHelper->getPlugin('dashboard-statistics');
    $res = $statisticsPlugin->CountAllJobs(true);
    return $response->withJson($res, 200);
  }
 
  public function getAllServerJobsStatus($request, $response, $args)
  {
    $this->throwNotAdminException();
    $allJobStatusPlugin = $this->restHelper->getPlugin('ajax_all_job_status');
    $symfonyRequest = new \Symfony\Component\HttpFoundation\Request();
    $res = $allJobStatusPlugin->handle($symfonyRequest);
    return $response->withJson(json_decode($res->getContent(), true), 200);
  }
 
  public function getSchedulerJobOptionsByOperation($request, $response, $args)
  {
    $this->throwNotAdminException();
    $operation = $args['operationName'];
    $adminSchedulerPlugin = $this->restHelper->getPlugin('admin_scheduler');
 
    if (!in_array($operation, array_keys($adminSchedulerPlugin->operation_array))) {
      $allowedOperations = implode(', ', array_keys($adminSchedulerPlugin->operation_array));
      throw new HttpBadRequestException("Operation '$operation' not allowed." .
        " Allowed operations are: $allowedOperations");
    }
 
    $schedulerPlugin = $this->restHelper->getPlugin('ajax_admin_scheduler');
    $symfonyRequest = new \Symfony\Component\HttpFoundation\Request();
    $symfonyRequest->request->set('operation', $operation);
    $symfonyRequest->request->set('fromRest', true);
    $res = $schedulerPlugin->handle($symfonyRequest);
    return $response->withJson($res, 200);
  }
 
  public function handleRunSchedulerOption($request, $response, $args)
  {
    $this->throwNotAdminException();
    $body = $this->getParsedBody($request);
    $query = $request->getQueryParams();
 
    $operation = $body['operation'];
    $adminSchedulerPlugin = $this->restHelper->getPlugin('admin_scheduler');
 
    if (!in_array($operation, array_keys($adminSchedulerPlugin->operation_array))) {
      $allowedOperations = implode(', ', array_keys($adminSchedulerPlugin->operation_array));
      throw new HttpBadRequestException("Operation '$operation' not allowed." .
        " Allowed operations are: $allowedOperations");
    }
 
    $schedulerPlugin = $this->restHelper->getPlugin('ajax_admin_scheduler');
    $symfonyRequest = new \Symfony\Component\HttpFoundation\Request();
    $symfonyRequest->request->set('operation', $operation);
    $symfonyRequest->request->set('fromRest', true);
    $data = $schedulerPlugin->handle($symfonyRequest);
 
    if ($operation == 'status' || $operation == 'verbose') {
      if (!isset($query['job']) || !in_array($query['job'], $data['jobList'])) {
        $allowedJobs = implode(', ', $data['jobList']);
        throw new HttpBadRequestException("Job '{$query['job']}' not " .
          "allowed. Allowed jobs are: $allowedJobs");
      }
      if (($operation == 'verbose') && (!isset($query['level']) || !in_array($query['level'], $data['verboseList']))) {
        $allowedLevels = implode(', ', $data['verboseList']);
        throw new HttpBadRequestException("Level '{$query['level']}' not " .
          "allowed. Allowed levels are: $allowedLevels");
      }
    } elseif ($operation == 'priority' && (!isset($query['priority']) || !in_array($query['priority'], $data['priorityList']))) {
      $allowedPriorities = implode(', ', $data['priorityList']);
      throw new HttpBadRequestException("Priority '{$query['priority']}' not " .
        "allowed. Allowed priorities are: $allowedPriorities");
    }
 
    if ($operation == 'status') {
      $query['priority'] = null;
      $query['level'] = null;
    } else if ($operation == 'priority') {
      $query['job'] = null;
      $query['level'] = null;
    } else if ($operation == 'verbose') {
      $query['priority'] = null;
    } else {
      $query['job'] = null;
      $query['priority'] = null;
      $query['level'] = null;
    }
 
    $response_from_scheduler = $adminSchedulerPlugin->OperationSubmit(
      $operation, array_search($query['job'], $data['jobList']),
      $query['priority'], $query['level']);
    $operation_text = $adminSchedulerPlugin->GetOperationText($operation);
    $status_msg = "";
    $report = "";
 
    if (!empty($adminSchedulerPlugin->error_info)) {
      $text = _("failed");
      $status_msg .= "$operation_text $text.";
      throw new HttpInternalServerErrorException($status_msg . $report);
    }
    $text = _("successfully");
    $status_msg .= "$operation_text $text.";
    if (! empty($response_from_scheduler)) {
      $report .= $response_from_scheduler;
    }
 
    $info = new Info(200, $status_msg. $report, InfoType::INFO);
    return $response->withJson($info->getArray(), $info->getCode());
  }
}