AdminObligationFromCSV.php

<?php
/*
 SPDX-FileCopyrightText: © 2008-2013 Hewlett-Packard Development Company, L.P.
 SPDX-FileCopyrightText: © 2014-2017 Siemens AG
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
namespace Fossology\UI\Page;
 
use Fossology\Lib\Application\ObligationCsvImport;
use Fossology\Lib\Auth\Auth;
use Fossology\Lib\Exceptions\HttpClientException;
use Fossology\Lib\Plugin\DefaultPlugin;
use Fossology\Lib\Util\HttpUtils;
use Fossology\UI\Api\Models\ApiVersion;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;
use GuzzleHttp\Exception\RequestException;
use Symfony\Component\HttpFoundation\File\UploadedFile;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use League\OAuth2\Client\Provider\GenericProvider;
 
class AdminObligationFromCSV extends DefaultPlugin
{
  const NAME = "admin_obligation_from_csv";
  const KEY_UPLOAD_MAX_FILESIZE = 'upload_max_filesize';
  const FILE_INPUT_NAME = 'file_input';
  const FILE_INPUT_NAME_V2 = 'fileInput';
 
  private $oidcProvider;
 
  private $sysconfig;
 
  function __construct()
  {
    global $SysConf;
    parent::__construct(self::NAME, array(
      self::TITLE => "Admin Obligation Import",
      self::MENU_LIST => "Admin::Obligation Admin::Obligation Import",
      self::REQUIRES_LOGIN => true,
      self::PERMISSION => Auth::PERM_ADMIN
    ));
    $this->obligationsCsvImport = $GLOBALS['container']->get('app.obligation_csv_import');
    $this->sysconfig = $SysConf;
    $this->configuration = [
      'uri' => trim($this->sysconfig['SYSCONFIG']['LicenseDBBaseURL']),
      'content' => trim($this->sysconfig['SYSCONFIG']['LicenseDBContentObligations']),
      'health' => trim($this->sysconfig['SYSCONFIG']['LicenseDBHealth']),
      'token' => empty(trim($this->sysconfig['SYSCONFIG']['LicenseDBToken'])) ? null : trim($this->sysconfig['SYSCONFIG']['LicenseDBToken']),
    ];
 
    if ($this->configuration['token'] == null) {
      $this->oidcProvider = new GenericProvider([
        "clientId" => trim($this->sysconfig['SYSCONFIG']['OidcM2MAppId']),
        "clientSecret" => trim($this->sysconfig['SYSCONFIG']['OidcM2MSecret']),
        "urlAuthorize" => trim($this->sysconfig['SYSCONFIG']['OidcM2MAuthorizeURL']),
        "urlAccessToken" => trim($this->sysconfig['SYSCONFIG']['OidcM2MAccessTokenURL']),
        "urlResourceOwnerDetails" => trim($this->sysconfig['SYSCONFIG']['OidcM2MResourceOwnerURL']),
      ]);
 
      if (isset($this->sysconfig['SYSCONFIG']['OidcM2MScope'])) {
        $this->configuration['scope'] = trim($this->sysconfig['SYSCONFIG']['OidcM2MScope']);
      }
    } else {
      $this->oidcProvider = null;
    }
  }
 
  public function getFileInputName($apiVersion = ApiVersion::V1)
  {
    if ($apiVersion == ApiVersion::V2) {
      return $this::FILE_INPUT_NAME_V2;
    } else {
      return $this::FILE_INPUT_NAME;
    }
  }
 
  protected function handle(Request $request)
  {
    $vars = array();
    if (!$request->isMethod('POST')) {
      $getHealth = $this->configuration['uri'] . $this->configuration['health'];
      $guzzleClient = HttpUtils::getGuzzleClient($this->sysconfig, $this->configuration['uri']);
      $vars['licenseDBHealth'] = HttpUtils::checkLicenseDBHealth($getHealth, $guzzleClient);
    }
    if ($request->isMethod('POST')) {
      if ($request->get('importFrom') === 'licensedb') {
        $startTime = microtime(true);
        $vars['message'] = $this->handleLicenseDbObligationImport();
        $fetchLicenseTime = microtime(true) - $startTime;
        $this->fileLogger->debug("Fetching Obligations and Check time took: " . sprintf("%0.3fms", 1000 * $fetchLicenseTime));
        $this->fileLogger->debug("****************** Message From LicenseDB import [" . date('Y-m-d H:i:s') . "] ******************");
        $this->fileLogger->debug($vars["message"]);
        $this->fileLogger->debug("****************** End Message From LicenseDB import ******************");
      } else {
        $uploadFile = $request->files->get(self::FILE_INPUT_NAME);
        $delimiter = $request->get('delimiter') ?: ',';
        $enclosure = $request->get('enclosure') ?: '"';
        $result = $this->handleFileUpload($uploadFile, $delimiter, $enclosure);
        $vars['message'] = is_array($result) ? $result[1] : $result;
      }
    }
 
    $vars[self::KEY_UPLOAD_MAX_FILESIZE] = ini_get(self::KEY_UPLOAD_MAX_FILESIZE);
    $vars['baseUrl'] = $request->getBaseUrl();
    $vars['license_csv_import'] = false;
 
    if (!empty(trim($this->configuration['uri']))) {
      $vars['baseURL'] = !empty($this->configuration['uri']);
      $vars['tokenConfig'] = !empty($this->configuration['token']) || $this->oidcProvider != null;
      $vars['exportEndpoint'] = !empty($this->configuration['content']);
      return $this->render("admin_license_from_licensedb.html.twig", $this->mergeWithDefault($vars));
    } else {
      return $this->render("admin_license_from_csv.html.twig", $this->mergeWithDefault($vars));
    }
  }
 
  public function handleLicenseDbObligationImport()
  {
    $msg = '<br>';
    $data = null;
    $finalURL = $this->configuration['uri'] . $this->configuration['content'];
    try {
      $startTimeReq = microtime(true);
 
      $accessToken = null;
      if ($this->configuration['token'] != null) {
        $accessToken = $this->configuration['token'];
      } else {
        $options = [];
        if (isset($this->configuration['scope'])) {
          $options['scope'] = $this->configuration['scope'];
        }
        $accessToken = $this->oidcProvider->getAccessToken('client_credentials', $options);
      }
      $guzzleClient = HttpUtils::getGuzzleClient($this->sysconfig, $this->configuration['uri'], $accessToken);
      $response = $guzzleClient->get($finalURL);
      $fetchLicenseTimeReq = microtime(true) - $startTimeReq;
      $this->fileLogger->debug("LicenseDB req:' took " . sprintf("%0.3fms", 1000 * $fetchLicenseTimeReq));
 
      $data = HttpUtils::processHttpResponse($response);
      return $this->obligationsCsvImport->importJsonData($data, $msg);
    } catch (HttpClientException $e) {
      return $msg . $e->getMessage();
    } catch (RequestException | GuzzleException $e) {
      return $msg . _('Something Went Wrong, check if host is accessible') . ': ' . $e->getMessage();
    }
  }
 
  public function handleFileUpload($uploadedFile, $delimiter = ',', $enclosure = '"', $fromRest = false)
  {
    $errMsg = '';
    if (!($uploadedFile instanceof UploadedFile)) {
      $errMsg = _("No file selected");
    } elseif ($uploadedFile->getSize() == 0 && $uploadedFile->getError() == 0) {
      $errMsg = _("Larger than upload_max_filesize ") . ini_get(self::KEY_UPLOAD_MAX_FILESIZE);
    } elseif (
      $uploadedFile->getClientOriginalExtension() != 'csv'
      && $uploadedFile->getClientOriginalExtension() != 'json'
    ) {
      $errMsg = _('Invalid extension ') .
        $uploadedFile->getClientOriginalExtension() . ' of file ' .
        $uploadedFile->getClientOriginalName();
    }
    if (!empty($errMsg)) {
      if ($fromRest) {
        return array(false, $errMsg, 400);
      }
      return $errMsg;
    }
    $this->obligationsCsvImport->setDelimiter($delimiter);
    $this->obligationsCsvImport->setEnclosure($enclosure);
 
    return array(true, $this->obligationsCsvImport->handleFile($uploadedFile->getRealPath(), $uploadedFile->getClientOriginalExtension()), 200);
  }
}
 
register_plugin(new AdminObligationFromCSV());