LicenseRef.php

<?php
/*
 SPDX-FileCopyrightText: © 2014 Siemens AG
 Author: Johannes Najjar
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
namespace Fossology\Lib\Data;
 
use Fossology\Lib\Dao\LicenseDao;
use Fossology\Lib\Util\StringOperation;
 
class LicenseRef
{
  private $id;
 
  private $shortName;
 
  private $fullName;
 
  private $spdxId;
 
  const SPDXREF_PREFIX = "LicenseRef-";
  const SPDXREF_PREFIX_FOSSOLOGY = "LicenseRef-fossology-";
 
  function __construct($licenseId, $licenseShortName, $licenseName, $spdxId)
  {
    $this->id = $licenseId;
    $this->shortName = $licenseShortName;
    $this->fullName = $licenseName ? : $licenseShortName;
    $this->spdxId = self::convertToSpdxId($this->shortName, $spdxId);
  }
 
  public function getId()
  {
    return $this->id;
  }
 
  public function getFullName()
  {
    return $this->fullName;
  }
 
  public function getShortName()
  {
    return $this->shortName;
  }
 
  public function getSpdxId()
  {
    return $this->spdxId;
  }
 
  public function __toString()
  {
    return 'LicenseRef('
      .$this->id
      .", ".$this->spdxId
      .", ".$this->shortName
      .", ".$this->fullName
    .')';
  }
 
  public static function convertToSpdxId($shortname, $spdxId): string
  {
    if (strcasecmp($shortname, LicenseDao::NO_LICENSE_FOUND) === 0 ||
        strcasecmp($shortname, LicenseDao::VOID_LICENSE) === 0) {
      $spdxLicense = $shortname;
    } elseif (empty($spdxId)) {
      $spdxLicense = $shortname;
      if (! StringOperation::stringStartsWith($shortname, self::SPDXREF_PREFIX)) {
        $spdxLicense = self::SPDXREF_PREFIX_FOSSOLOGY . $shortname;
      }
    } else {
      $spdxLicense = $spdxId;
    }
    if (StringOperation::stringStartsWith($spdxLicense, self::SPDXREF_PREFIX)) {
      // License ref can not end with a '+'
      $spdxLicense = preg_replace('/\+$/', '-or-later', $spdxLicense);
    }
    return self::replaceSpaces($spdxLicense);
  }
 
  public static function replaceSpaces($licenseName): string
  {
    $licenseName = str_replace(' ', '-', $licenseName);
    return preg_replace('/-(OR|AND|WITH)-(?!later)/i', ' $1 ', $licenseName);
  }
}