remove spdx files, introduce external library
Rob Bast
9 years ago
parent
92faf1c7a8
commit
5ae9e7fe22
@ -1,10 +0,0 @@
|
||||
#!/usr/bin/env php
|
||||
<?php
|
||||
|
||||
require __DIR__ . '/../src/bootstrap.php';
|
||||
|
||||
use Composer\Util\SpdxLicensesUpdater;
|
||||
|
||||
$updater = new SpdxLicensesUpdater;
|
||||
$updater->dumpLicenses(__DIR__ . '/../res/spdx-licenses.json');
|
||||
$updater->dumpExceptions(__DIR__ . '/../res/spdx-exceptions.json');
|
||||
@ -1,29 +0,0 @@
|
||||
{
|
||||
"Autoconf-exception-2.0": [
|
||||
"Autoconf exception 2.0"
|
||||
],
|
||||
"Autoconf-exception-3.0": [
|
||||
"Autoconf exception 3.0"
|
||||
],
|
||||
"Bison-exception-2.2": [
|
||||
"Bison exception 2.2"
|
||||
],
|
||||
"Classpath-exception-2.0": [
|
||||
"Classpath exception 2.0"
|
||||
],
|
||||
"eCos-exception-2.0": [
|
||||
"eCos exception 2.0"
|
||||
],
|
||||
"Font-exception-2.0": [
|
||||
"Font exception 2.0"
|
||||
],
|
||||
"GCC-exception-2.0": [
|
||||
"GCC Runtime Library exception 2.0"
|
||||
],
|
||||
"GCC-exception-3.1": [
|
||||
"GCC Runtime Library exception 3.1"
|
||||
],
|
||||
"WxWindows-exception-3.1": [
|
||||
"WxWindows Library Exception 3.1"
|
||||
]
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,306 +0,0 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of Composer.
|
||||
*
|
||||
* (c) Nils Adermann <naderman@naderman.de>
|
||||
* Jordi Boggiano <j.boggiano@seld.be>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Composer\Util;
|
||||
|
||||
/**
|
||||
* Supports composer array and SPDX tag notation for disjunctive/conjunctive
|
||||
* licenses.
|
||||
*
|
||||
* @author Tom Klingenberg <tklingenberg@lastflood.net>
|
||||
*/
|
||||
class SpdxLicense
|
||||
{
|
||||
/** @var array */
|
||||
private $licenses;
|
||||
|
||||
/** @var array */
|
||||
private $exceptions;
|
||||
|
||||
public function __construct()
|
||||
{
|
||||
$this->loadLicenses();
|
||||
$this->loadExceptions();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns license metadata by license identifier.
|
||||
*
|
||||
* @param string $identifier
|
||||
*
|
||||
* @return array|null
|
||||
*/
|
||||
public function getLicenseByIdentifier($identifier)
|
||||
{
|
||||
if (!isset($this->licenses[$identifier])) {
|
||||
return;
|
||||
}
|
||||
|
||||
$license = $this->licenses[$identifier];
|
||||
$license[] = 'http://spdx.org/licenses/' . $identifier . '.html#licenseText';
|
||||
|
||||
return $license;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns license exception metadata by license exception identifier.
|
||||
*
|
||||
* @param string $identifier
|
||||
*
|
||||
* @return array|null
|
||||
*/
|
||||
public function getExceptionByIdentifier($identifier)
|
||||
{
|
||||
if (!isset($this->exceptions[$identifier])) {
|
||||
return;
|
||||
}
|
||||
|
||||
$license = $this->exceptions[$identifier];
|
||||
$license[] = 'http://spdx.org/licenses/' . $identifier . '.html#licenseExceptionText';
|
||||
|
||||
return $license;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the short identifier of a license (exception) by full name.
|
||||
*
|
||||
* @param string $name
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getIdentifierByName($name)
|
||||
{
|
||||
foreach ($this->licenses as $identifier => $licenseData) {
|
||||
if ($licenseData[0] === $name) { // key 0 = fullname
|
||||
return $identifier;
|
||||
}
|
||||
}
|
||||
|
||||
foreach ($this->exceptions as $identifier => $licenseData) {
|
||||
if ($licenseData[0] === $name) { // key 0 = fullname
|
||||
return $identifier;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the OSI Approved status for a license by identifier.
|
||||
*
|
||||
* @param string $identifier
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isOsiApprovedByIdentifier($identifier)
|
||||
{
|
||||
return $this->licenses[$identifier][1]; // key 1 = osi approved
|
||||
}
|
||||
|
||||
/**
|
||||
* Check, if the identifier for a license is valid.
|
||||
*
|
||||
* @param string $identifier
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
private function isValidLicenseIdentifier($identifier)
|
||||
{
|
||||
$identifiers = array_keys($this->licenses);
|
||||
|
||||
return in_array($identifier, $identifiers);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check, if the identifier for a exception is valid.
|
||||
*
|
||||
* @param string $identifier
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
private function isValidExceptionIdentifier($identifier)
|
||||
{
|
||||
$identifiers = array_keys($this->exceptions);
|
||||
|
||||
return in_array($identifier, $identifiers);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array|string $license
|
||||
*
|
||||
* @return bool
|
||||
* @throws \InvalidArgumentException
|
||||
*/
|
||||
public function validate($license)
|
||||
{
|
||||
if (is_array($license)) {
|
||||
$count = count($license);
|
||||
if ($count !== count(array_filter($license, 'is_string'))) {
|
||||
throw new \InvalidArgumentException('Array of strings expected.');
|
||||
}
|
||||
$license = $count > 1 ? '('.implode(' OR ', $license).')' : (string) reset($license);
|
||||
}
|
||||
|
||||
if (!is_string($license)) {
|
||||
throw new \InvalidArgumentException(sprintf(
|
||||
'Array or String expected, %s given.',
|
||||
gettype($license)
|
||||
));
|
||||
}
|
||||
|
||||
return $this->isValidLicenseString($license);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
private function loadLicenses()
|
||||
{
|
||||
if (is_array($this->licenses)) {
|
||||
return $this->licenses;
|
||||
}
|
||||
|
||||
$jsonFile = file_get_contents(__DIR__ . '/../../../res/spdx-licenses.json');
|
||||
$this->licenses = json_decode($jsonFile, true);
|
||||
|
||||
return $this->licenses;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
private function loadExceptions()
|
||||
{
|
||||
if (is_array($this->exceptions)) {
|
||||
return $this->exceptions;
|
||||
}
|
||||
|
||||
$jsonFile = file_get_contents(__DIR__ . '/../../../res/spdx-exceptions.json');
|
||||
$this->exceptions = json_decode($jsonFile, true);
|
||||
|
||||
return $this->exceptions;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $license
|
||||
*
|
||||
* @return bool
|
||||
* @throws \RuntimeException
|
||||
*/
|
||||
private function isValidLicenseString($license)
|
||||
{
|
||||
$tokens = array(
|
||||
'po' => '\(',
|
||||
'pc' => '\)',
|
||||
'op' => '(?:or|OR|and|AND)',
|
||||
'wi' => '(?:with|WITH)',
|
||||
'lix' => '(?:NONE|NOASSERTION)',
|
||||
'lir' => 'LicenseRef-\d+',
|
||||
'lic' => '[-_.a-zA-Z0-9]{3,}\+?',
|
||||
'ws' => '\s+',
|
||||
'_' => '.',
|
||||
);
|
||||
|
||||
$next = function () use ($license, $tokens) {
|
||||
static $offset = 0;
|
||||
|
||||
if ($offset >= strlen($license)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
foreach ($tokens as $name => $token) {
|
||||
if (false === $r = preg_match('{' . $token . '}', $license, $matches, PREG_OFFSET_CAPTURE, $offset)) {
|
||||
throw new \RuntimeException('Pattern for token %s failed (regex error).', $name);
|
||||
}
|
||||
if ($r === 0) {
|
||||
continue;
|
||||
}
|
||||
if ($matches[0][1] !== $offset) {
|
||||
continue;
|
||||
}
|
||||
$offset += strlen($matches[0][0]);
|
||||
|
||||
return array($name, $matches[0][0]);
|
||||
}
|
||||
|
||||
throw new \RuntimeException(
|
||||
'At least the last pattern needs to match, but it did not (dot-match-all is missing?).'
|
||||
);
|
||||
};
|
||||
|
||||
$open = 0;
|
||||
$with = false;
|
||||
$require = true;
|
||||
$lastop = null;
|
||||
|
||||
while (list($token, $string) = $next()) {
|
||||
switch ($token) {
|
||||
case 'po':
|
||||
if ($open || !$require || $with) {
|
||||
return false;
|
||||
}
|
||||
$open = 1;
|
||||
break;
|
||||
case 'pc':
|
||||
if ($open !== 1 || $require || !$lastop || $with) {
|
||||
return false;
|
||||
}
|
||||
$open = 2;
|
||||
break;
|
||||
case 'op':
|
||||
if ($require || !$open || $with) {
|
||||
return false;
|
||||
}
|
||||
$lastop || $lastop = $string;
|
||||
if ($lastop !== $string) {
|
||||
return false;
|
||||
}
|
||||
$require = true;
|
||||
break;
|
||||
case 'wi':
|
||||
$with = true;
|
||||
break;
|
||||
case 'lix':
|
||||
if ($open || $with) {
|
||||
return false;
|
||||
}
|
||||
goto lir;
|
||||
case 'lic':
|
||||
if ($with && $this->isValidExceptionIdentifier($string)) {
|
||||
$require = true;
|
||||
$with = false;
|
||||
goto lir;
|
||||
}
|
||||
if ($with) {
|
||||
return false;
|
||||
}
|
||||
if (!$this->isValidLicenseIdentifier(rtrim($string, '+'))) {
|
||||
return false;
|
||||
}
|
||||
// Fall-through intended
|
||||
case 'lir':
|
||||
lir:
|
||||
if (!$require) {
|
||||
return false;
|
||||
}
|
||||
$require = false;
|
||||
break;
|
||||
case 'ws':
|
||||
break;
|
||||
case '_':
|
||||
return false;
|
||||
default:
|
||||
throw new \RuntimeException(sprintf('Unparsed token: %s.', print_r($token, true)));
|
||||
}
|
||||
}
|
||||
|
||||
return !($open % 2 || $require || $with);
|
||||
}
|
||||
}
|
||||
@ -1,139 +0,0 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of Composer.
|
||||
*
|
||||
* (c) Nils Adermann <naderman@naderman.de>
|
||||
* Jordi Boggiano <j.boggiano@seld.be>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Composer\Util;
|
||||
|
||||
/**
|
||||
* The SPDX Licenses Updater scrapes licenses from the spdx website
|
||||
* and updates the "res/spdx-licenses.json" file accordingly.
|
||||
*
|
||||
* The class is used by the update script "bin/update-spdx-licenses".
|
||||
*/
|
||||
class SpdxLicensesUpdater
|
||||
{
|
||||
/**
|
||||
* @param string $file
|
||||
* @param string $url
|
||||
*/
|
||||
public function dumpLicenses($file, $url = 'http://www.spdx.org/licenses/')
|
||||
{
|
||||
$options = 0;
|
||||
|
||||
if (defined('JSON_PRETTY_PRINT')) {
|
||||
$options |= JSON_PRETTY_PRINT;
|
||||
}
|
||||
|
||||
if (defined('JSON_UNESCAPED_SLASHES')) {
|
||||
$options |= JSON_UNESCAPED_SLASHES;
|
||||
}
|
||||
|
||||
$licenses = json_encode($this->getLicenses($url), $options);
|
||||
file_put_contents($file, $licenses);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $file
|
||||
* @param string $url
|
||||
*/
|
||||
public function dumpExceptions($file, $url = 'http://www.spdx.org/licenses/exceptions-index.html')
|
||||
{
|
||||
$options = 0;
|
||||
|
||||
if (defined('JSON_PRETTY_PRINT')) {
|
||||
$options |= JSON_PRETTY_PRINT;
|
||||
}
|
||||
|
||||
if (defined('JSON_UNESCAPED_SLASHES')) {
|
||||
$options |= JSON_UNESCAPED_SLASHES;
|
||||
}
|
||||
|
||||
$exceptions = json_encode($this->getExceptions($url), $options);
|
||||
file_put_contents($file, $exceptions);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $url
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
private function getLicenses($url)
|
||||
{
|
||||
$licenses = array();
|
||||
|
||||
$dom = new \DOMDocument;
|
||||
@$dom->loadHTMLFile($url);
|
||||
|
||||
$xPath = new \DOMXPath($dom);
|
||||
$trs = $xPath->query('//table//tbody//tr');
|
||||
|
||||
// iterate over each row in the table
|
||||
foreach ($trs as $tr) {
|
||||
$tds = $tr->getElementsByTagName('td'); // get the columns in this row
|
||||
|
||||
if ($tds->length !== 4) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (trim($tds->item(3)->nodeValue) == 'License Text') {
|
||||
$fullname = trim($tds->item(0)->nodeValue);
|
||||
$identifier = trim($tds->item(1)->nodeValue);
|
||||
$osiApproved = ((isset($tds->item(2)->nodeValue) && $tds->item(2)->nodeValue === 'Y')) ? true : false;
|
||||
|
||||
// The license URL is not scraped intentionally to keep json file size low.
|
||||
// It's build when requested, see SpdxLicense->getLicenseByIdentifier().
|
||||
//$licenseURL = $tds->item(3)->getAttribute('href');
|
||||
|
||||
$licenses += array($identifier => array($fullname, $osiApproved));
|
||||
}
|
||||
}
|
||||
|
||||
return $licenses;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $url
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
private function getExceptions($url)
|
||||
{
|
||||
$exceptions = array();
|
||||
|
||||
$dom = new \DOMDocument;
|
||||
@$dom->loadHTMLFile($url);
|
||||
|
||||
$xPath = new \DOMXPath($dom);
|
||||
$trs = $xPath->query('//table//tbody//tr');
|
||||
|
||||
// iterate over each row in the table
|
||||
foreach ($trs as $tr) {
|
||||
$tds = $tr->getElementsByTagName('td'); // get the columns in this row
|
||||
|
||||
if ($tds->length !== 3) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (trim($tds->item(2)->nodeValue) == 'License Exception Text') {
|
||||
$fullname = trim($tds->item(0)->nodeValue);
|
||||
$identifier = trim($tds->item(1)->nodeValue);
|
||||
|
||||
// The license URL is not scraped intentionally to keep json file size low.
|
||||
// It's build when requested, see SpdxLicense->getLicenseExceptionByIdentifier().
|
||||
//$licenseURL = $tds->item(2)->getAttribute('href');
|
||||
|
||||
$exceptions += array($identifier => array($fullname));
|
||||
}
|
||||
}
|
||||
|
||||
return $exceptions;
|
||||
}
|
||||
}
|
||||
@ -1,145 +0,0 @@
|
||||
<?php
|
||||
namespace Composer\Test\Util;
|
||||
|
||||
use Composer\TestCase;
|
||||
use Composer\Util\SpdxLicense;
|
||||
|
||||
class SpdxLicenseTest extends TestCase
|
||||
{
|
||||
/**
|
||||
* @var object
|
||||
*/
|
||||
private $license;
|
||||
|
||||
public function setUp()
|
||||
{
|
||||
$this->license = new SpdxLicense;
|
||||
}
|
||||
|
||||
public static function provideValidLicenses()
|
||||
{
|
||||
$json = file_get_contents(__DIR__ . '/../../../../res/spdx-licenses.json');
|
||||
|
||||
$licenses = json_decode($json, true);
|
||||
|
||||
$identifiers = array_keys($licenses);
|
||||
|
||||
$valid = array_merge(
|
||||
array(
|
||||
"MIT",
|
||||
"MIT+",
|
||||
"NONE",
|
||||
"NOASSERTION",
|
||||
"LicenseRef-3",
|
||||
array("LGPL-2.0", "GPL-3.0+"),
|
||||
"(LGPL-2.0 or GPL-3.0+)",
|
||||
"(LGPL-2.0 OR GPL-3.0+)",
|
||||
"(EUDatagrid and GPL-3.0+)",
|
||||
"(EUDatagrid AND GPL-3.0+)",
|
||||
"GPL-2.0 with Autoconf-exception-2.0",
|
||||
"GPL-2.0 WITH Autoconf-exception-2.0",
|
||||
"GPL-2.0+ WITH Autoconf-exception-2.0",
|
||||
),
|
||||
$identifiers
|
||||
);
|
||||
|
||||
foreach ($valid as &$r) {
|
||||
$r = array($r);
|
||||
}
|
||||
|
||||
return $valid;
|
||||
}
|
||||
|
||||
public static function provideInvalidLicenses()
|
||||
{
|
||||
return array(
|
||||
array(""),
|
||||
array(array()),
|
||||
array("The system pwns you"),
|
||||
array("()"),
|
||||
array("(MIT)"),
|
||||
array("(MIT"),
|
||||
array("MIT)"),
|
||||
array("MIT NONE"),
|
||||
array("MIT AND NONE"),
|
||||
array("MIT (MIT and MIT)"),
|
||||
array("(MIT and MIT) MIT"),
|
||||
array(array("LGPL-2.0", "The system pwns you")),
|
||||
array("and GPL-3.0+"),
|
||||
array("EUDatagrid and GPL-3.0+"),
|
||||
array("(GPL-3.0 and GPL-2.0 or GPL-3.0+)"),
|
||||
array("(EUDatagrid and GPL-3.0+ and )"),
|
||||
array("(EUDatagrid xor GPL-3.0+)"),
|
||||
array("(MIT Or MIT)"),
|
||||
array("(NONE or MIT)"),
|
||||
array("(NOASSERTION or MIT)"),
|
||||
array("Autoconf-exception-2.0 WITH MIT"),
|
||||
array("MIT WITH"),
|
||||
array("MIT OR"),
|
||||
array("MIT AND"),
|
||||
);
|
||||
}
|
||||
|
||||
public static function provideInvalidArgument()
|
||||
{
|
||||
return array(
|
||||
array(null),
|
||||
array(new \stdClass),
|
||||
array(array(new \stdClass)),
|
||||
array(array("mixed", new \stdClass)),
|
||||
array(array(new \stdClass, new \stdClass)),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider provideValidLicenses
|
||||
* @param $license
|
||||
*/
|
||||
public function testValidate($license)
|
||||
{
|
||||
$this->assertTrue($this->license->validate($license));
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider provideInvalidLicenses
|
||||
* @param string|array $invalidLicense
|
||||
*/
|
||||
public function testInvalidLicenses($invalidLicense)
|
||||
{
|
||||
$this->assertFalse($this->license->validate($invalidLicense));
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider provideInvalidArgument
|
||||
* @expectedException InvalidArgumentException
|
||||
*/
|
||||
public function testInvalidArgument($invalidArgument)
|
||||
{
|
||||
$this->license->validate($invalidArgument);
|
||||
}
|
||||
|
||||
public function testGetLicenseByIdentifier()
|
||||
{
|
||||
$license = $this->license->getLicenseByIdentifier('AGPL-1.0');
|
||||
$this->assertEquals($license[0], 'Affero General Public License v1.0'); // fullname
|
||||
$this->assertFalse($license[1]); // osi approved
|
||||
}
|
||||
|
||||
public function testGetIdentifierByName()
|
||||
{
|
||||
$identifier = $this->license->getIdentifierByName('Affero General Public License v1.0');
|
||||
$this->assertEquals($identifier, 'AGPL-1.0');
|
||||
|
||||
$identifier = $this->license->getIdentifierByName('BSD 2-clause "Simplified" License');
|
||||
$this->assertEquals($identifier, 'BSD-2-Clause');
|
||||
}
|
||||
|
||||
public function testIsOsiApprovedByIdentifier()
|
||||
{
|
||||
$osiApproved = $this->license->isOsiApprovedByIdentifier('MIT');
|
||||
$this->assertTrue($osiApproved);
|
||||
|
||||
$osiApproved = $this->license->isOsiApprovedByIdentifier('AGPL-1.0');
|
||||
$this->assertFalse($osiApproved);
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue