ObligationsGetter.php

<?php
/*
 Copyright (C) 2017,2020, Siemens AG

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 version 2 as published by the Free Software Foundation.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License along
 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

namespace Fossology\Lib\Report;

use Fossology\Lib\Dao\LicenseDao;
use Fossology\Lib\Dao\ClearingDao;
use Fossology\Lib\Dao\UploadDao;

class ObligationsGetter
{
  private $licenseDao;

  private $clearingDao;

  private $uploadDao;

  public function __construct()
  {
    global $container;
    $this->licenseDao = $container->get('dao.license');
    $this->clearingDao = $container->get('dao.clearing');
    $this->uploadDao = $container->get('dao.upload');
  }

  function getObligations($licenseStatements, $mainLicenseStatements, $uploadId, $groupId)
  {
    $licenseIds = $this->contentOnly($licenseStatements) ?: array();
    $mainLicenseIds = $this->contentOnly($mainLicenseStatements);

    if (! empty($mainLicenseIds)) {
      $allLicenseIds = array_unique(array_merge($licenseIds, $mainLicenseIds));
    } else {
      $allLicenseIds = array_unique($licenseIds);
    }

    $bulkAddIds = $this->getBulkAddLicenseList($uploadId, $groupId);
    $obligationRef = $this->licenseDao->getLicenseObligations($allLicenseIds, 'obligation_map') ?: array();
    $obligationCandidate = $this->licenseDao->getLicenseObligations($allLicenseIds, 'obligation_candidate_map') ?: array();
    $obligations = array_merge($obligationRef, $obligationCandidate);
    $onlyLicenseIdsWithObligation = array_column($obligations, 'rf_fk');
    if (!empty($bulkAddIds)) {
      $onlyLicenseIdsWithObligation = array_unique(array_merge($onlyLicenseIdsWithObligation, $bulkAddIds));
    }
    $licenseWithoutObligations = array_diff($allLicenseIds, $onlyLicenseIdsWithObligation) ?: array();
    foreach ($licenseWithoutObligations as $licenseWithoutObligation) {
      $license = $this->licenseDao->getLicenseById($licenseWithoutObligation);
      if (!empty($license)) {
        $whiteLists[] = $license->getShortName();
      }
    }
    $newobligations = $this->groupObligations($obligations, $uploadId);
    return array($newobligations, $whiteLists);
  }

  function getBulkAddLicenseList($uploadId, $groupId)
  {
    $uploadTreeTableName = $this->uploadDao->getUploadtreeTableName($uploadId);
    $parentTreeBounds = $this->uploadDao->getParentItemBounds($uploadId, $uploadTreeTableName);
    $bulkHistory = $this->clearingDao->getBulkHistory($parentTreeBounds, $groupId, false);
    if (!empty($bulkHistory)) {
      $licenseLists = array_column($bulkHistory, 'addedLicenses');
      $allLicenses = array();
      foreach ($licenseLists as $licenseList) {
        $allLicenses = array_unique(array_merge($allLicenses, $licenseList));
      }
      foreach ($allLicenses as $allLicense) {
        $license = $this->licenseDao->getLicenseByShortName($allLicense);
        if (!empty($license)) {
          $licenseId[] = $license->getId();
        }
      }
    }
    return $licenseId;
  }

  function groupObligations($obligations, $uploadId)
  {
    $groupedOb = array();
    $row = $this->uploadDao->getReportInfo($uploadId);
    $excludedObligations = (array) json_decode($row['ri_excluded_obligations'], true);
    foreach ($obligations as $obligation ) {
      $obTopic = $obligation['ob_topic'];
      $obText = $obligation['ob_text'];
      $licenseName = $obligation['rf_shortname'];
      $groupBy = $obText;
      if (!in_array($licenseName,(array) $excludedObligations[$obTopic])) {
        if (array_key_exists($groupBy, $groupedOb)) {
          $currentLics = &$groupedOb[$groupBy]['license'];
          if (!in_array($licenseName, $currentLics)) {
            $currentLics[] = $licenseName;
          }
        } else {
          $singleOb = array(
            "topic" => $obTopic,
            "text" => $obText,
            "license" => array($licenseName)
          );
          $groupedOb[$groupBy] = $singleOb;
        }
      }
    }
    return $groupedOb;
  }

  function contentOnly($licenseStatements)
  {
    foreach ($licenseStatements as $licenseStatement) {
      $licenseId[] = $licenseStatement["licenseId"];
    }
    return $licenseId;
  }
}