ui-report-conf.php

<?php
/*
 SPDX-FileCopyrightText: © 2019 Siemens AG
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
use Fossology\Lib\Auth\Auth;
use Fossology\Lib\Dao\UploadDao;
use Fossology\Lib\Db\DbManager;
use Fossology\Lib\Dao\UserDao;
use Fossology\Lib\Dao\ClearingDao;
use Fossology\Lib\Dao\LicenseDao;
use Fossology\Lib\Data\LicenseRef;
use Fossology\Lib\Data\DecisionTypes;
use Fossology\Lib\BusinessRules\LicenseMap;
use Fossology\Lib\Data\Package\ComponentType;
 
class ui_report_conf extends FO_Plugin
{
 
  private $dbManager;
 
  private $uploadDao;
 
  private $userDao;
 
  private $licenseDao;
 
  private $clearingDao;
 
  private $mapDBColumns = array(
    "reviewedBy" => "ri_reviewed",
    "department" => "ri_department",
    "reportRel" => "ri_report_rel",
    "community" => "ri_community",
    "component" => "ri_component",
    "version" => "ri_version",
    "relDate" => "ri_release_date",
    "sw360Link" => "ri_sw360_link",
    "componentType" => "ri_component_type",
    "componentId" => "ri_component_id",
    "footerNote" => "ri_footer",
    "generalAssesment" => "ri_general_assesment",
    "gaAdditional" => "ri_ga_additional",
    "gaRisk" => "ri_ga_risk",
    "dependencyBinarySource" => "ri_depnotes",
    "exportRestrictionText" => "ri_exportnotes",
    "copyrightRestrictionText" => "ri_copyrightnotes"
  );
 
  private $radioListUR = array(
    "nonCritical" => "critical",
    "critical" => "critical",
    "noDependency" => "dependencySourceBinary",
    "dependencySource" => "dependencySourceBinary",
    "dependencyBinary" => "dependencySourceBinary",
    "noExportRestriction" => "exportRestriction",
    "exportRestriction" => "exportRestriction",
    "noRestriction" => "restrictionForUse",
    "restrictionForUse" => "restrictionForUse"
  );
 
  private $checkBoxListSPDX = array(
    "spdxLicenseComment" => "spdxLicenseComment",
    "ignoreFilesWOInfo" => "ignoreFilesWOInfo"
  );
 
 
  function __construct()
  {
    $this->Name       = "report_conf";
    $this->Title      = _("Report Configuration");
    $this->Dependency = array("browse");
    $this->DBaccess   = PLUGIN_DB_READ;
    $this->LoginFlag  = 0;
    parent::__construct();
    $this->uploadDao = $GLOBALS['container']->get('dao.upload');
    $this->dbManager = $GLOBALS['container']->get('db.manager');
    $this->userDao = $GLOBALS['container']->get('dao.user');
    $this->clearingDao = $GLOBALS['container']->get('dao.clearing');
    $this->licenseDao = $GLOBALS['container']->get('dao.license');
  }
 
  function RegisterMenus()
  {
    $tooltipText = _("Report Configuration");
    menu_insert("Browse-Pfile::Conf",5,$this->Name,$tooltipText);
    // For the Browse menu, permit switching between detail and summary.
    $Parm = Traceback_parm_keep(array("upload","item","format"));
    $URI = $this->Name . $Parm;
 
    $menuPosition = 60;
    $menuText = "Conf";
    if (GetParm("mod", PARM_STRING) == $this->Name) {
      menu_insert("View::[BREAK]", 61);
      menu_insert("View::[BREAK]", 50);
      menu_insert("View::{$menuText}", $menuPosition);
      menu_insert("View-Meta::[BREAK]", 61);
      menu_insert("View-Meta::[BREAK]", 50);
      menu_insert("View-Meta::{$menuText}", $menuPosition);
 
      menu_insert("Browse::Conf",-3);
    } else {
      $tooltipText = _("Report Configuration");
      menu_insert("View::[BREAK]", 61);
      menu_insert("View::[BREAK]", 50);
      menu_insert("View::{$menuText}", $menuPosition, $URI, $tooltipText);
      menu_insert("View-Meta::[BREAK]", 61);
      menu_insert("View-Meta::[BREAK]", 50);
      menu_insert("View-Meta::{$menuText}", $menuPosition, $URI, $tooltipText);
 
      menu_insert("Browse::Conf", -3, $URI, $tooltipText);
    }
  } // RegisterMenus()
 
  function allReportConfiguration($uploadId, $groupId)
  {
    $vars = [];
    $row = $this->uploadDao->getReportInfo($uploadId);
    foreach ($this->mapDBColumns as $key => $value) {
      $vars[$key] = $row[$value];
    }
    $textAreaNoneStyle = ' style="display:none;overflow:auto;width:98%;height:80px;"';
    $textAreaStyle = ' style="overflow:auto;width:98%;height:80px;"';
    $vars['styleDependencyTA'] = $vars['styleExportTA'] = $vars['styleRestrictionTA'] = $textAreaStyle;
    if ($row['ri_depnotes'] == 'NA' || empty($row['ri_depnotes'])) {
       $vars['styleDependencyTA'] = $textAreaNoneStyle;
    }
 
    if ($row['ri_exportnotes'] == 'NA' || empty($row['ri_exportnotes'])) {
       $vars['styleExportTA'] = $textAreaNoneStyle;
    }
 
    if ($row['ri_copyrightnotes'] == 'NA' || empty($row['ri_copyrightnotes'])) {
       $vars['styleRestrictionTA'] = $textAreaNoneStyle;
    }
 
    if (!empty($row['ri_ga_checkbox_selection'])) {
      $listURCheckbox = explode(',', $row['ri_ga_checkbox_selection']);
      foreach (array_keys($this->radioListUR) as $key => $value) {
        $vars[$value] = $listURCheckbox[$key];
      }
    }
 
    if (!empty($row['ri_spdx_selection'])) {
      $listSPDXCheckbox = explode(',', $row['ri_spdx_selection']);
      foreach (array_keys($this->checkBoxListSPDX) as $key => $value) {
        $vars[$value] = $listSPDXCheckbox[$key];
      }
    }
 
    $tableRows = "";
    $excludedObligations = array();
    $excludedObligations = (array) json_decode($row['ri_excluded_obligations'], true);
    foreach ($this->getAllObligationsForGivenUploadId($uploadId, $groupId) as $obTopic => $obData) {
      $tableRows .= '<tr><td style="width:35%">'.$obTopic.'</td>';
      $tableRows .= '<td><textarea readonly="readonly" style="overflow:auto;width:98%;height:80px;">'.
                     $obData['text'].'</textarea></td><td>';
      foreach ($obData['license'] as $value) {
        if (!empty($excludedObligations[$obTopic]) && in_array($value, $excludedObligations[$obTopic])) {
          $tableRows .= '<input class="browse-upload-checkbox view-license-rc-size" type="checkbox" name="obLicenses['.urlencode($obTopic).'][]" value="'.$value.'" checked> '.$value.'<br />';
        } else {
          $tableRows .= '<input class="browse-upload-checkbox view-license-rc-size" type="checkbox" name="obLicenses['.urlencode($obTopic).'][]" value="'.$value.'"> '.$value.'<br />';
        }
      }
      $tableRows .= '</td></tr>';
    }
    $tableRowsUnifiedReport = "";
    $unifiedColumns = array();
    if (!empty($row['ri_unifiedcolumns'])) {
      $unifiedColumns = (array) json_decode($row['ri_unifiedcolumns'], true);
    } else {
      $unifiedColumns = UploadDao::UNIFIED_REPORT_HEADINGS;
    }
    foreach ($unifiedColumns as $name => $unifiedReportColumns) {
      foreach ($unifiedReportColumns as $columnName => $isenabled) {
        $tableRowsUnifiedReport .= '<tr>';
        $tableRowsUnifiedReport .= '<td><input class="form-control" type="text" style="width:95%" name="'.$name.'[]" value="'.$columnName.'"></td>';
        $checked = '';
        if ($isenabled) {
          $checked = 'checked';
        }
        $tableRowsUnifiedReport .= '<td style="vertical-align:middle"><input class="browse-upload-checkbox view-license-rc-size" type="checkbox" style="width:95%" name="'.$name.'[]" '.$checked.'></td>';
        $tableRowsUnifiedReport .= '</tr>';
      }
    }
 
    $tableRowsClixmlReport = "";
    $clixmlColumns = array();
    if (!empty($row['ri_clixmlcolumns'])) {
      $clixmlColumns = (array) json_decode($row['ri_clixmlcolumns'], true);
    } else {
      $clixmlColumns = UploadDao::CLIXML_REPORT_HEADINGS;
    }
    foreach ($clixmlColumns as $name => $clixmlReportColumns) {
      foreach ($clixmlReportColumns as $columnName => $isenabled) {
        $tableRowsClixmlReport .= '<tr>';
        $tableRowsClixmlReport .= '<td><input class="form-control" type="text" style="width:95%" name="'.$name.'[]" value="'.$columnName.'" readonly></td>';
        $checked = '';
        if ($isenabled) {
          $checked = 'checked';
        }
        $tableRowsClixmlReport .= '<td style="vertical-align:middle"><input class="browse-upload-checkbox view-license-rc-size" type="checkbox" style="width:95%" name="'.$name.'[]" '.$checked.'></td>';
        $tableRowsClixmlReport .= '</tr>';
      }
    }
 
    if (!empty($row['ri_globaldecision'])) {
      $vars['applyGlobal'] = "checked";
    }
    $vars['tableRows'] = $tableRows;
    $vars['tableRowsUnifiedReport'] = $tableRowsUnifiedReport;
    $vars['tableRowsClixmlReport'] = $tableRowsClixmlReport;
    $vars['scriptBlock'] = $this->createScriptBlock();
 
    return $vars;
  }
 
  function getAllObligationsForGivenUploadId($uploadId, $groupId)
  {
    $allClearedLicenses = array();
    $uploadTreeTableName = $this->uploadDao->getUploadtreeTableName($uploadId);
    $itemTreeBounds = $this->uploadDao->getParentItemBounds($uploadId, $uploadTreeTableName);
    $allClearingDecisions = $this->clearingDao->getFileClearingsFolder($itemTreeBounds, $groupId);
    $licenseMap = new LicenseMap($this->dbManager, $groupId, LicenseMap::REPORT);
    foreach ($allClearingDecisions as $clearingDecisions) {
      if ($clearingDecisions->getType() == DecisionTypes::IRRELEVANT) {
        continue;
      }
      foreach ($clearingDecisions->getClearingLicenses() as $eachClearingLicense) {
        if ($eachClearingLicense->isRemoved()) {
          continue;
        }
        $getLicenseId = $eachClearingLicense->getLicenseId();
        $allClearedLicenses[] = $licenseMap->getProjectedId($getLicenseId);
      }
    }
    $obligationsForLicenses = $this->licenseDao->getLicenseObligations($allClearedLicenses) ?: array();
    $obligationsForLicenseCandidates = $this->licenseDao->getLicenseObligations($allClearedLicenses, true) ?: array();
    $allObligations = array_merge($obligationsForLicenses, $obligationsForLicenseCandidates);
    $groupedObligations = array();
    foreach ($allObligations as $obligations) {
      $groupBy = $obligations['ob_topic'];
      $licenseName = LicenseRef::convertToSpdxId($obligations['rf_shortname'],
        $obligations['rf_spdx_id']);
      if (array_key_exists($groupBy, $groupedObligations)) {
        $currentLicenses = &$groupedObligations[$groupBy]['license'];
        if (!in_array($licenseName, $currentLicenses)) {
          $currentLicenses[] = $licenseName;
        }
      } else {
        $groupedObligations[$groupBy] = array(
         "topic" => $obligations['ob_topic'],
         "text" => $obligations['ob_text'],
         "license" => array($licenseName)
        );
      }
    }
    return $groupedObligations;
  }
 
  protected function getCheckBoxSelectionList($listParams)
  {
    foreach ($listParams as $listkey => $listValue) {
      $ret = GetParm($listValue, PARM_STRING);
      if ($ret != $listkey) {
        $cbList[] = "unchecked";
      } else {
        $cbList[] = "checked";
      }
    }
    $cbSelectionList = implode(",", $cbList);
 
    return $cbSelectionList;
  }
 
  public function Output()
  {
    $uploadId = GetParm("upload", PARM_INTEGER);
    $groupId = Auth::getGroupId();
    $userId = Auth::getUserId();
    if (!$this->uploadDao->isAccessible($uploadId, $groupId)) {
      return;
    }
 
    $itemId = GetParm("item",PARM_INTEGER);
    $this->vars['micromenu'] = Dir2Browse("browse", $itemId, NULL, $showBox=0, "View-Meta");
    $this->vars['globalClearingAvailable'] = Auth::isClearingAdmin();
 
    $submitReportConf = GetParm("submitReportConf", PARM_STRING);
 
    if (isset($submitReportConf)) {
      $applyGlobal = @$_POST["applyGlobal"];
      $applyGlobal = !empty($applyGlobal) ? 1 : 0;
      $parms = array();
      $obLicensesEncoded = @$_POST["obLicenses"];
      $obLicensesEncoded = !empty($obLicensesEncoded) ? $obLicensesEncoded : array();
      $obLicenses = array();
      array_walk($obLicensesEncoded,
        function (&$licArray, $obTopic) use (&$obLicenses) {
          $obLicenses[urldecode($obTopic)] = $licArray;
        }
      );
      $i = 1;
      $columns = "";
      foreach ($this->mapDBColumns as $key => $value) {
        $columns .= $value." = $".$i.", ";
        $parms[] = GetParm($key, PARM_RAW);
        $i++;
      }
      $parms[] = $this->getCheckBoxSelectionList($this->radioListUR);
 
      $unifiedReportColumnsForJson = array();
      foreach (UploadDao::UNIFIED_REPORT_HEADINGS as $columnName => $columnValue) {
        $columnResult = @$_POST[$columnName];
        $unifiedReportColumnsForJson[$columnName] = array($columnResult[0] => isset($columnResult[1]) ? $columnResult[1] : null);
      }
      $clixmlColumnsForJson = array();
      foreach (UploadDao::CLIXML_REPORT_HEADINGS as $columnName => $columnValue) {
        $columnResult = @$_POST[$columnName];
        $clixmlColumnsForJson[$columnName] = array($columnResult[0] => isset($columnResult[1]) ? $columnResult[1] : null);
      }
      $checkBoxUrPos = count($parms);
      $parms[] = $this->getCheckBoxSelectionList($this->checkBoxListSPDX);
      $checkBoxSpdxPos = count($parms);
      $parms[] = json_encode($obLicenses);
      $excludeObligationPos = count($parms);
      $parms[] = json_encode($unifiedReportColumnsForJson);
      $unifiedColumnsPos = count($parms);
      $parms[] = json_encode($clixmlColumnsForJson);
      $clixmlColumnsPos = count($parms);
      $parms[] = $applyGlobal;
      $applyGlobalPos = count($parms);
      $parms[] = $uploadId;
      $uploadIdPos = count($parms);
 
      $SQL = "UPDATE report_info SET $columns" .
               "ri_ga_checkbox_selection = $$checkBoxUrPos, " .
               "ri_spdx_selection = $$checkBoxSpdxPos, " .
               "ri_excluded_obligations = $$excludeObligationPos, " .
               "ri_unifiedcolumns = $$unifiedColumnsPos, " .
               "ri_clixmlcolumns = $$clixmlColumnsPos, " .
               "ri_globaldecision = $$applyGlobalPos " .
               "WHERE upload_fk = $$uploadIdPos;";
      $this->dbManager->getSingleRow($SQL, $parms,
        __METHOD__ . "updateReportInfoData");
 
      if (@$_POST['markGlobal']) {
        $upload = $this->uploadDao->getUpload($uploadId);
        $uploadName = $upload->getFilename();
        $jobId = JobAddJob($userId, $groupId, $uploadName, $uploadId);
        $deciderPlugin = plugin_find("agent_deciderjob");
        $conflictStrategyId = "global";
        $errorMsg = "";
        $deciderPlugin->AgentAdd($jobId, $uploadId, $errorMsg, array(), $conflictStrategyId);
        $schedulerMsg = empty(GetRunnableJobList()) ? _("Is the scheduler running? ") : '';
        $url = Traceback_uri() . "?mod=showjobs&upload=$uploadId";
        $text = _("Your jobs have been added to job queue.");
        $linkText = _("View Jobs");
        $this->vars['message'] = "$schedulerMsg" . "$text <a href=\"$url\">$linkText</a>";
      }
    }
    $this->vars += $this->allReportConfiguration($uploadId, $groupId);
    $this->vars['typemap'] = [];
    foreach (ComponentType::TYPE_MAP as $key => $name) {
      if ($key == ComponentType::PACKAGEURL) {
        continue;
      }
      $this->vars['typemap'][] = ['key' => $key, 'name' => $name];
    }
  }
 
  public function getTemplateName()
  {
    return "ui-report-conf.html.twig";
  }
 
  protected function createScriptBlock()
  {
    return "
 
    var reportTabCookie = 'stickyReportTab';
 
    $(document).ready(function() {
      $(\"#confTabs\").tabs({
        active: ($.cookie(reportTabCookie) || 0),
        activate: function(e, ui){
          // Get active tab index and update cookie
          var idString = $(e.currentTarget).attr('id');
          idString = parseInt(idString.slice(-1)) - 1;
          $.cookie(reportTabCookie, idString);
        }
      });
      $(\"input[name='dependencySourceBinary']\").change(function(){
        var val = $(\"input[name='dependencySourceBinary']:checked\").val();
        if (val == 'noDependency') {
          $('#dependencyBinarySource').hide();
          $('#dependencyBinarySource').val('');
        } else {
          $('#dependencyBinarySource').css('display', 'block');
        }
      });
      $(\"input[name='exportRestriction']\").change(function(){
        var val = $(\"input[name='exportRestriction']:checked\").val();
        if (val == 'noExportRestriction') {
          $('#exportRestrictionText').hide();
          $('#exportRestrictionText').val('');
        } else {
          $('#exportRestrictionText').css('display', 'block');
        }
      });
      $(\"input[name='restrictionForUse']\").change(function(){
        var val = $(\"input[name='restrictionForUse']:checked\").val();
        if (val == 'noRestriction') {
          $('#copyrightRestrictionText').hide();
          $('#copyrightRestrictionText').val('');
        } else {
          $('#copyrightRestrictionText').css('display', 'block');
        }
      });
    });
    ";
  }
}
 
$NewPlugin = new ui_report_conf();
$NewPlugin->Initialize();