ObligationMap.php

<?php
/*
 SPDX-FileCopyrightText: © 2017 Siemens AG
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
namespace Fossology\Lib\BusinessRules;
 
use Fossology\Lib\Db\DbManager;
 
class ObligationMap
{
 
  private $dbManager;
 
  public function __construct(DbManager $dbManager)
  {
    $this->dbManager = $dbManager;
  }
 
  public function getAvailableShortnames($candidate=false)
  {
    $params = [];
    if ($candidate) {
      $sql = "SELECT rf_shortname FROM license_candidate;";
      $stmt = __METHOD__.".rf_candidate_shortnames";
    } else {
      $sql = LicenseMap::getMappedLicenseRefView();
      $stmt = __METHOD__.".rf_shortnames";
      $params[] = LicenseMap::CONCLUSION;
    }
    $this->dbManager->prepare($stmt,$sql);
    $res = $this->dbManager->execute($stmt, $params);
    $vars = $this->dbManager->fetchAll($res);
    $this->dbManager->freeResult($res);
 
    $licshortnames = array();
    foreach ($vars as $rf_entry) {
      $shortname = $rf_entry['rf_shortname'];
      $licshortnames[$shortname] = $shortname;
    }
 
    return $licshortnames;
  }
 
  public function getIdFromShortname($shortname, $candidate=false)
  {
    $tableName = "";
    if ($candidate) {
      $tableName = "license_candidate";
    } else {
      $tableName = "license_ref";
    }
    $sql = "SELECT * FROM ONLY $tableName WHERE rf_shortname = $1;";
    $statement = __METHOD__ . ".getLicId.$tableName";
    $results = $this->dbManager->getRows($sql, array($shortname), $statement);
    $licenseIds = array();
    foreach ($results as $row) {
      $licenseIds[] = $row['rf_pk'];
    }
    return $licenseIds;
  }
 
  public function getShortnameFromId($rfId,$candidate=false)
  {
    if ($candidate) {
      $sql = "SELECT * FROM ONLY license_candidate WHERE rf_pk = $1;";
    } else {
      $sql = "SELECT * FROM ONLY license_ref WHERE rf_pk = $1;";
    }
    $statement = __METHOD__ . "." . ($candidate ? "candidate" : "license");
    $result = $this->dbManager->getSingleRow($sql,array($rfId), $statement);
    return $result['rf_shortname'];
  }
 
  public function getLicenseList($obId,$candidate=false)
  {
    $liclist = array();
    if ($candidate) {
      $sql = "SELECT rf_fk FROM obligation_candidate_map WHERE ob_fk=$1;";
      $stmt = __METHOD__.".om_candidate";
    } else {
      $sql = "SELECT rf_fk FROM obligation_map WHERE ob_fk=$1;";
      $stmt = __METHOD__.".om_license";
    }
    $this->dbManager->prepare($stmt,$sql);
    $res = $this->dbManager->execute($stmt, array($obId));
    $vars = $this->dbManager->fetchAll($res);
    $this->dbManager->freeResult($res);
    foreach ($vars as $map_entry) {
      $liclist[] = $this->getShortnameFromId($map_entry['rf_fk'], $candidate);
    }
 
    return join(";", array_unique($liclist));
  }
 
  public function isLicenseAssociated($obId,$licId,$candidate=false)
  {
    $tableName = "";
    if ($candidate) {
      $stmt = __METHOD__.".om_testcandidate";
      $tableName .= "obligation_candidate_map";
    } else {
      $stmt = __METHOD__.".om_testlicense";
      $tableName .= "obligation_map";
    }
    $sql = "SELECT * FROM $tableName WHERE ob_fk = $1 AND rf_fk = $2;";
    $this->dbManager->prepare($stmt,$sql);
    $res = $this->dbManager->execute($stmt,array($obId,$licId));
    $vars = $this->dbManager->fetchAll($res);
    $this->dbManager->freeResult($res);
 
    if (!empty($vars)) {
      return true;
    }
 
    return false;
  }
 
  public function associateLicenseWithObligation($obId,$licId,$candidate=false)
  {
    if (! $this->isLicenseAssociated($obId, $licId, $candidate)) {
      if ($candidate) {
        $sql = "INSERT INTO obligation_candidate_map (ob_fk, rf_fk) VALUES ($1, $2)";
        $stmt = __METHOD__ . ".om_addcandidate";
      } else {
        $sql = "INSERT INTO obligation_map (ob_fk, rf_fk) VALUES ($1, $2)";
        $stmt = __METHOD__ . ".om_addlicense";
      }
      $this->dbManager->prepare($stmt, $sql);
      $res = $this->dbManager->execute($stmt, array($obId,$licId));
      $this->dbManager->fetchArray($res);
      $this->dbManager->freeResult($res);
    }
  }
 
  public function unassociateLicenseFromObligation($obId,$licId=0,$candidate=false)
  {
    if ($licId == 0) {
      $stmt = __METHOD__.".omdel_all";
      if ($candidate) {
        $sql = "DELETE FROM obligation_candidate_map WHERE ob_fk=$1";
        $stmt .= ".candidate";
      } else {
        $sql = "DELETE FROM obligation_map WHERE ob_fk=$1";
      }
      $this->dbManager->prepare($stmt,$sql);
      $res = $this->dbManager->execute($stmt,array($obId));
    } else {
      $stmt = __METHOD__.".omdel_lic";
      if ($candidate) {
        $sql = "DELETE FROM obligation_candidate_map WHERE ob_fk=$1 AND rf_fk=$2";
        $stmt .= ".candidate";
      } else {
        $sql = "DELETE FROM obligation_map WHERE ob_fk=$1 AND rf_fk=$2";
      }
      $this->dbManager->prepare($stmt,$sql);
      $res = $this->dbManager->execute($stmt,array($obId,$licId));
    }
    $this->dbManager->fetchArray($res);
    $this->dbManager->freeResult($res);
  }
 
  public function getObligations()
  {
    $sql = "SELECT * FROM obligation_ref;";
    return $this->dbManager->getRows($sql);
  }
 
  public function getTopicNameFromId($ob_pk)
  {
    $sql = "SELECT ob_topic FROM obligation_ref WHERE ob_pk = $1;";
    $result = $this->dbManager->getSingleRow($sql,array($ob_pk));
    return $result['ob_topic'];
  }
 
  public function associateLicenseFromLicenseList($obligationId, $licenses, $candidate = false)
  {
    $updated = false;
    foreach ($licenses as $license) {
      if (! $this->isLicenseAssociated($obligationId, $license, $candidate)) {
        $this->associateLicenseWithObligation($obligationId, $license, $candidate);
        $updated = true;
      }
    }
    return $updated;
  }
 
  public function unassociateLicenseFromLicenseList($obligationId, $licenses, $candidate = false)
  {
    foreach ($licenses as $license) {
        $this->unassociateLicenseFromObligation($obligationId, $license, $candidate);
    }
  }
 
  public function getObligationById($ob_pk)
  {
    $sql = "SELECT * FROM obligation_ref WHERE ob_pk = $1;";
    return $this->dbManager->getSingleRow($sql, [$ob_pk]);
  }
 
  public function deleteObligation($ob_pk)
  {
    $stmt = __METHOD__ . '.deleteObligation';
    $sql = "DELETE FROM obligation_ref WHERE ob_pk = $1";
    $this->dbManager->getSingleRow($sql, [$ob_pk], $stmt);
 
    $this->unassociateLicenseFromObligation($ob_pk);
    $this->unassociateLicenseFromObligation($ob_pk, 0, true);
  }
}