AdminLicenseAcknowledgements.php

Go to the documentation of this file.

<?php
/*
 SPDX-FileCopyrightText: © 2022 Siemens AG
 Author: Gaurav Mishra <mishra.gaurav@siemens.com>
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
namespace Fossology\UI\Page;
 
use Fossology\Lib\Auth\Auth;
use Fossology\Lib\Dao\LicenseAcknowledgementDao;
use Fossology\Lib\Plugin\DefaultPlugin;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
 
class AdminLicenseAcknowledgements extends DefaultPlugin
{
 
  const NAME = "admin_license_acknowledgements";
 
  const ACKNOWLEDGEMENT_UPDATE_PARAM_NAME = "formUpdated";
 
  const ACKNOWLEDGEMENT_PARAM_NAME = "licenseAcknowledgement";
 
  const ACKNOWLEDGEMENT_ID_PARAM_NAME = "licenseAcknowledgementLaPK";
 
  const ACKNOWLEDGEMENT_NAME_PARAM_NAME = "licenseAcknowledgementName";
 
  const INSERT_ACKNOWLEDGEMENT_NAME_PARAM = "insertLicNames";
 
  const ACKNOWLEDGEMENT_INSERT_PARAM_NAME = "insertLicAcknowledgements";
 
  const ACKNOWLEDGEMENT_ENABLE_PARAM_NAME = "licAcknowledgementEnabled";
 
  private $licenseAcknowledgementDao;
 
  function __construct()
  {
    parent::__construct(self::NAME,
      array(
        self::TITLE => "Admin License Acknowledgements",
        self::MENU_LIST => "Admin::License Admin::Acknowledgements",
        self::REQUIRES_LOGIN => true,
        self::PERMISSION => Auth::PERM_ADMIN
      ));
    $this->licenseAcknowledgementDao = $this->getObject('dao.license.acknowledgement');
  }
 
  protected function handle(Request $request)
  {
    if ($request->get(self::ACKNOWLEDGEMENT_UPDATE_PARAM_NAME, 0) == 1) {
      return new JsonResponse($this->updateAcknowledgements($request),
        JsonResponse::HTTP_OK);
    }
 
    $vars = [];
    $vars["updateParam"] = self::ACKNOWLEDGEMENT_UPDATE_PARAM_NAME;
    $vars["acknowledgementParam"] = self::ACKNOWLEDGEMENT_PARAM_NAME;
    $vars["acknowledgementIdParam"] = self::ACKNOWLEDGEMENT_ID_PARAM_NAME;
    $vars["acknowledgementNameParam"] = self::ACKNOWLEDGEMENT_NAME_PARAM_NAME;
    $vars["enableParam"] = self::ACKNOWLEDGEMENT_ENABLE_PARAM_NAME;
 
    $vars['acknowledgementArray'] = $this->licenseAcknowledgementDao->getAllAcknowledgements();
    return $this->render('admin_license_acknowledgements.html.twig',
      $this->mergeWithDefault($vars));
  }
 
  private function updateAcknowledgements(Request $request)
  {
    $acknowledgements = [];
    $update = [
      "updated" => -1,
      "inserted" => []
    ];
    $acknowledgementStrings = $request->get(self::ACKNOWLEDGEMENT_PARAM_NAME);
    $acknowledgementNames = $request->get(self::ACKNOWLEDGEMENT_NAME_PARAM_NAME);
    $insertNames = $request->get(self::INSERT_ACKNOWLEDGEMENT_NAME_PARAM);
    $insertAcknowledgements = $request->get(self::ACKNOWLEDGEMENT_INSERT_PARAM_NAME);
    if ($acknowledgementStrings !== null && !empty($acknowledgementStrings)) {
      foreach ($acknowledgementStrings as $acknowledgementPk => $acknowledgement) {
        $acknowledgements[$acknowledgementPk]['acknowledgement'] = $acknowledgement;
      }
    }
    if ($acknowledgementNames !== null && !empty($acknowledgementNames)) {
      foreach ($acknowledgementNames as $acknowledgementPk => $name) {
        $acknowledgements[$acknowledgementPk]['name'] = $name;
      }
    }
    if (! empty($acknowledgements)) {
      try {
        $update['updated'] = $this->licenseAcknowledgementDao->updateAcknowledgementFromArray(
          $acknowledgements);
      } catch (\UnexpectedValueException $e) {
        $update['updated'] = $e->getMessage();
      }
    }
    $update["inserted"] = $this->insertAcknowledgements($insertNames, $insertAcknowledgements);
    return $update;
  }
 
  private function insertAcknowledgements($namesArray, $acknowledgementsArray)
  {
    $returnVal = [];
    if (($namesArray !== null && $acknowledgementsArray !== null) &&
      (! empty($namesArray) && !empty($acknowledgementsArray))) {
      for ($i = 0; $i < count($namesArray); $i++) {
        $returnVal[] = $this->licenseAcknowledgementDao->insertAcknowledgement($namesArray[$i],
          $acknowledgementsArray[$i]);
      }
      $returnVal['status'] = 0;
      // Check if at least one value was inserted
      if (count(array_filter($returnVal, function($val) {
        return $val > 0; // No error
      })) > 0) {
        $returnVal['status'] |= 1;
      }
      // Check if an error occurred while insertion
      if (in_array(-1, $returnVal)) {
        $returnVal['status'] |= 1 << 1;
      }
      // Check if an exception occurred while insertion
      if (in_array(-2, $returnVal)) {
        $returnVal['status'] |= 1 << 2;
      }
    }
    return $returnVal;
  }
}
 
register_plugin(new AdminLicenseAcknowledgements());