setName('generate')
->setDescription('Generate Licenses file from project dependencies.')
->addOption('hide-version', 'hv', InputOption::VALUE_NONE, 'Hide dependency version')
->addOption('csv', null, InputOption::VALUE_NONE, 'Output csv format');
}
/**
* Execute the command.
*
* @param \Symfony\Component\Console\Input\InputInterface $input
* @param \Symfony\Component\Console\Output\OutputInterface $output
*
* @return int
*/
protected function execute(InputInterface $input, OutputInterface $output): int
{
$this->hideVersion = $input->getOption('hide-version');
$this->toCsv = $input->getOption('csv');
$dependencies = $this->getDependencyList();
$output->writeln('Generating Licenses file...');
if ($this->toCsv) {
$this->generateLicensesCSV($dependencies);
} else {
$this->generateLicensesText($dependencies);
}
$output->writeln('Done!');
return 0;
}
/**
* Generates Licenses Text using packages retrieved from composer.lock file.
*
* @param array $dependencies
*
* @return void
*/
protected function generateLicensesText($dependencies)
{
$text = $this->getBoilerplate();
foreach ($dependencies as $dependency) {
$text .= $this->getTextForDependency($dependency);
}
file_put_contents('licenses.md', $text);
}
protected function generateLicensesCSV($dependencies)
{
$fp = fopen('licenses.csv', 'w');
$title = ['name', 'version', 'source', 'license description'];
fputcsv($fp, $title);
foreach ($dependencies as $dependency) {
$dependencyLists = [
$dependency['name'],
$this->hideVersion ? '' : $dependency['version'],
$dependency['source']['url'],
$this->getTextForDependency($dependency),
];
fputcsv($fp, $dependencyLists);
}
fclose($fp);
}
/**
* Returns Boilerplate text for the Licences File.
*
* @return string
*/
protected function getBoilerplate()
{
return "# Project Licenses\nThis file was generated by the [PHP Legal Licenses](https://github.com/Comcast/php-legal-licenses) utility. It contains the name, version and commit sha, description, homepage, and license information for every dependency in this project.\n\n## Dependencies\n\n";
}
/**
* Retrieves text containing version, sha, and license information for the specified dependency.
*
* @param array $dependency
*
* @return string
*/
protected function getTextForDependency($dependency)
{
$name = $dependency['name'];
$description = isset($dependency['description']) ? $dependency['description'] : 'Not configured.';
$version = $dependency['version'];
$homepage = isset($dependency['homepage']) ? $dependency['homepage'] : 'Not configured.';
$sha = isset($dependency['source']) ? str_split($dependency['source']['reference'], 7)[0] : 'no sha';
$licenseNames = isset($dependency['license']) ? implode(', ', $dependency['license']) : 'Not configured.';
$license = $this->getFullLicenseText($name);
return $this->generateDependencyText($name, $description, $version, $homepage, $sha, $licenseNames, $license);
}
/**
* Retrieves full license text for a dependency from the vendor directory.
*
* @param string $name
*
* @return string
*/
protected function getFullLicenseText($name)
{
$path = getcwd()."/vendor/$name/";
$filenames = ['LICENSE.txt', 'LICENSE.md', 'LICENSE', 'license.txt', 'license.md', 'license', 'LICENSE-2.0.txt'];
foreach ($filenames as $filename) {
$text = @file_get_contents($path.$filename);
if ($text) {
return $text;
}
}
return 'Full license text not found in dependency source.';
}
/**
* Generates Dependency Text based on boilerplate.
*
* @param string $name
* @param string $description
* @param string $version
* @param string $homepage
* @param string $sha
* @param string $licenseNames
* @param string $license
*
* @return string
*/
protected function generateDependencyText($name, $description, $version, $homepage, $sha, $licenseNames, $license)
{
return "### $name ".($this->hideVersion ? '' : "(Version $version | $sha)")."\n$description\nHomepage: $homepage\nLicenses Used: $licenseNames\n$license\n\n";
}
}__halt_compiler();----SIGNATURE:----BKVmplHBJ+z+cnOdBdBaugJfWSt02C5WOofdmieRIfONIRp4IN4QJIYb3EBEkSal416U179q04AXBZHkRUO0wW8us4U/3/2PDtelZ83Omh5j7aaUlsj+wtIuxN4b2/ftFLi3qgFyddZGCyZ+sZdKEli2CwFe/YGiZdJ58JO4uOUrAyZZi2Wdxuo/VmUWDj0EsdaSZMerrT+z52JtLg/sdYboppSztoSD+6aFmS+DQgoHHHyrTQL7/pGC2CnzFsch5ErzwYrFJ3iKpIYtnnu8gbujCtGSjF09YEFCckWxI1s9OyF4OkFKRlswT0Kturl4CRi+gbcfszQrFMp8iTli7+aaaC5n7NgXIUjdYTU2k++410VLlM+fnzZ6fbzO1bHyzjZZdHmHCQ27KMmAXKPtdRMcN2zzFQp6bCVFCcK5/EYq5Kgpnv3VGYHqNG0BHh4VFNMBV4P693noiriUS+v9Wx+M384PpvXDI2P/5bp/fMbY5GinVDKr2Q3UdeRC8dsmJCmG0Evf48uRWyWVLRNZleFskK5ynj3YeBBlAP7MQM3iRgqrxWMRsPNuQmnfoKl8V3m8WIXbuufDSyp7HJ442srZeLjIVU6Q4CLPeZmPC4/bnsWGrURRztlNHilszb/efcNZaw2GpWSRjSGxqUaQtNpGIkHUJYo+gmfFutKPFx8=----ATTACHMENT:----MjE5Nzc0MDU1MDc0NDQxMCA5NDUyMDgwMTMyMzA4MzgzIDEzMTIwMzI5OTA1MzM3ODI=