spdxutils.php

<?php
/*
 SPDX-FileCopyrightText: © 2016 Siemens AG
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
namespace Fossology\Spdx;
 
use Fossology\Lib\Data\LicenseRef;
use Fossology\Lib\Util\StringOperation;
 
class SpdxUtils
{
  static public function preWorkOnArgsFlp($args,$key1,$key2)
  {
    $needle = ' --'.$key2.'=';
    if (is_array($args) &&
        array_key_exists($key1, $args) &&
        strpos($args[$key1],$needle) !== false) {
      $exploded = explode($needle,$args[$key1]);
      $args[$key1] = trim($exploded[0]);
      $args[$key2] = trim($exploded[1]);
    }
    return $args;
  }
 
  static public function addPrefixOnDemand($license)
  {
    if (empty($license) || $license === "NOASSERTION") {
      return "NOASSERTION";
    }
 
    if (strpos($license, " OR ") !== false) {
      return "(" . $license . ")";
    }
 
    $license = preg_replace('/[^a-zA-Z0-9\-\_\.\+]/','-',$license);
    if (strpos($license, LicenseRef::SPDXREF_PREFIX) !== false) {
      // License ref can not end with a '+'
      $license = preg_replace('/\+$/', '-or-later', $license);
    }
    return preg_replace('/\+(?!$)/','-',$license);
  }
 
  static public function addPrefixOnDemandKeys($licenses)
  {
    $ret = array();
    foreach ($licenses as $license=>$text) {
      $ret[self::addPrefixOnDemand($license)] = $text;
    }
    return $ret;
  }
 
  static public function addPrefixOnDemandList($licenses)
  {
    return array_map(function ($license)
    {
      return SpdxUtils::addPrefixOnDemand($license);
    },$licenses);
  }
 
  static public function implodeLicenses($licenses)
  {
    if (!$licenses || !is_array($licenses) || sizeof($licenses) == 0) {
      return "";
    }
 
    $licenses = self::addPrefixOnDemandList($licenses);
    sort($licenses, SORT_NATURAL | SORT_FLAG_CASE);
 
    if (count($licenses) == 3) {
      foreach ($licenses as $index => $lic) {
        if (StringOperation::stringStartsWith($lic, "Dual-license") ||
            StringOperation::stringStartsWith($lic, LicenseRef::SPDXREF_PREFIX . "Dual-license") ||
            StringOperation::stringStartsWith($lic, LicenseRef::SPDXREF_PREFIX_FOSSOLOGY . "Dual-license")) {
          return $licenses[$index===0?1:0] . " OR " . $licenses[$index===2?1:2];
        }
      }
    }
    return implode(" AND ", $licenses);
  }
 
  static public function cleanTextArray($texts): array
  {
    if (!$texts || !is_array($texts) || sizeof($texts) == 0) {
      return [];
    }
 
    sort($texts, SORT_NATURAL | SORT_FLAG_CASE);
 
    $cleanArray = [];
    foreach ($texts as $text) {
      $text = trim($text);
      if (empty($text)) {
        continue;
      }
      $cleanArray[] = $text;
    }
    return $cleanArray;
  }
 
  public static function removeEmptyLicenses($licenses): array
  {
    $newList = [];
    foreach ($licenses as $license) {
      if (empty($license) || $license === "NOASSERTION") {
        continue;
      }
      $newList[] = $license;
    }
    return $newList;
  }
}