123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477 |
- <?php
- class Licenses {
- protected $paths = [];
- protected $mailMap = [];
- protected $checkFiles = [];
- public $authors = [];
- public function __construct() {
- $this->licenseText = <<<EOD
- /**
- @COPYRIGHT@
- *
- @AUTHORS@
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
- */
- EOD;
- $this->licenseTextLegacy = <<<EOD
- /**
- @COPYRIGHT@
- *
- @AUTHORS@
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
- */
- EOD;
- $this->licenseTextLegacy = str_replace('@YEAR@', date('Y'), $this->licenseTextLegacy);
- }
-
- public function exec($folder, $gitRoot = false) {
- if (is_array($folder)) {
- foreach ($folder as $f) {
- $this->exec($f, $gitRoot);
- }
- return;
- }
- if ($gitRoot !== false && substr($gitRoot, -1) !== '/') {
- $gitRoot .= '/';
- }
- if (is_file($folder)) {
- $this->handleFile($folder, $gitRoot);
- $this->printFilesToCheck();
- return;
- }
- $excludes = array_map(function ($item) use ($folder) {
- return $folder . '/' . $item;
- }, ['vendor', '3rdparty', '.git', 'l10n', 'templates', 'composer', 'js', 'node_modules']);
- $iterator = new RecursiveDirectoryIterator($folder, RecursiveDirectoryIterator::SKIP_DOTS);
- $iterator = new RecursiveCallbackFilterIterator($iterator, function ($item) use ($folder, $excludes) {
-
- foreach ($excludes as $exclude) {
- if (substr($item->getPath(), 0, strlen($exclude)) === $exclude) {
- return false;
- }
- }
- return true;
- });
- $iterator = new RecursiveIteratorIterator($iterator);
- $iterator = new RegexIterator($iterator, '/^.+\.(js|php)$/i');
- foreach ($iterator as $file) {
-
- $this->handleFile($file, $gitRoot);
- }
- $this->printFilesToCheck();
- }
- public function writeAuthorsFile() {
- ksort($this->authors);
- $template = 'Nextcloud is written by:
- @AUTHORS@
- With help from many libraries and frameworks including:
- Open Collaboration Services
- SabreDAV
- jQuery
- …
- ';
- $authors = implode(PHP_EOL, array_map(function ($author) {
- return ' - ' . $author;
- }, $this->authors));
- $template = str_replace('@AUTHORS@', $authors, $template);
- file_put_contents(__DIR__ . '/../AUTHORS', $template);
- }
- public function handleFile($path, $gitRoot) {
- $isPhp = preg_match('/^.+\.php$/i', $path);
- $source = file_get_contents($path);
- if ($this->isMITLicensed($source)) {
- echo "MIT licensed file: $path" . PHP_EOL;
- return;
- }
- $copyrightNotices = $this->getCopyrightNotices($path, $source);
- $authors = $this->getAuthors($path, $gitRoot);
- if ($this->isOwnCloudLicensed($source)) {
- $license = str_replace('@AUTHORS@', $authors, $this->licenseTextLegacy);
- $this->checkCopyrightState($path, $gitRoot);
- } else {
- $license = str_replace('@AUTHORS@', $authors, $this->licenseText);
- }
- if ($copyrightNotices === '') {
- $creator = $this->getCreatorCopyright($path, $gitRoot);
- $license = str_replace('@COPYRIGHT@', $creator, $license);
- } else {
- $license = str_replace('@COPYRIGHT@', $copyrightNotices, $license);
- }
- [$source, $isStrict] = $this->eatOldLicense($source);
- if ($isPhp) {
- if ($isStrict) {
- $source = '<?php' . PHP_EOL . PHP_EOL . 'declare(strict_types=1);' . PHP_EOL . PHP_EOL . $license . PHP_EOL . $source;
- } else {
- $source = '<?php' . PHP_EOL . $license . PHP_EOL . $source;
- }
- } else {
- $source = $license . PHP_EOL . PHP_EOL . $source;
- }
- file_put_contents($path, $source);
- echo "License updated: $path" . PHP_EOL;
- }
-
- private function isMITLicensed($source) {
- $lines = explode(PHP_EOL, $source);
- while (!empty($lines)) {
- $line = $lines[0];
- array_shift($lines);
- if (strpos($line, 'The MIT License') !== false) {
- return true;
- }
- }
- return false;
- }
- private function isOwnCloudLicensed($source) {
- $lines = explode(PHP_EOL, $source);
- while (!empty($lines)) {
- $line = $lines[0];
- array_shift($lines);
- if (strpos($line, 'ownCloud, Inc') !== false || strpos($line, 'ownCloud GmbH') !== false) {
- return true;
- }
- }
- return false;
- }
-
- private function eatOldLicense($source) {
- $lines = explode(PHP_EOL, $source);
- $isStrict = false;
- $index = 0;
- while (!empty($lines) && array_key_exists($index, $lines)) {
- $line = $lines[$index];
- if (trim($line) === '<?php') {
- array_splice($lines, $index, 1);
- continue;
- }
-
- if (strpos($line, 'eslint-') !== false
- || strpos($line, 'globals') !== false
- || strpos($line, 'const') !== false
- || strpos($line, 'import') !== false) {
- $index++;
- continue;
- }
-
- if (strpos($line, '<?php declare(strict_types') !== false) {
- $isStrict = true;
- array_splice($lines, $index, 1);
- continue;
- }
- if (strpos($line, 'declare (strict_types') !== false) {
- $isStrict = true;
- array_splice($lines, $index, 1);
- continue;
- }
- if (strpos($line, 'declare(strict_types') !== false) {
- $isStrict = true;
- array_splice($lines, $index, 1);
- continue;
- }
- if (strpos($line, '/**') !== false) {
- array_splice($lines, $index, 1);
- continue;
- }
-
- if (strpos($line, '*/') !== false && strpos($line, '/*') !== false) {
- array_splice($lines, $index, 1);
- break;
- }
- if (strpos($line, '*') !== false) {
- array_splice($lines, $index, 1);
- continue;
- }
- if (trim($line) === '') {
- array_splice($lines, $index, 1);
- continue;
- }
- break;
- }
- return [implode(PHP_EOL, $lines), $isStrict];
- }
- private function getCopyrightNotices($path, $file) {
- $licenseHeaderCopyrightAtLines = trim(shell_exec("grep -ni 'copyright' $path | cut -d ':' -f 1"));
- $lineByLine = explode(PHP_EOL, $file);
-
- $copyrightNotice = [];
- if (trim($licenseHeaderCopyrightAtLines !== '')) {
- $copyrightNotice = array_map(function ($line) use ($lineByLine) {
- return $lineByLine[(int)$line - 1];
- }, explode(PHP_EOL, $licenseHeaderCopyrightAtLines));
- }
- return implode(PHP_EOL, $copyrightNotice);
- }
-
- private function checkCopyrightState($path, $gitRoot) {
-
- $deadline = new DateTime('06/06/2016');
- $deadlineTimestamp = $deadline->getTimestamp();
- $buildDir = getcwd();
- if ($gitRoot) {
- chdir($gitRoot);
- $path = substr($path, strlen($gitRoot));
- }
- $out = shell_exec("git --no-pager blame --line-porcelain $path | sed -n 's/^author-time //p'");
- if ($gitRoot) {
- chdir($buildDir);
- }
- $timestampChanges = explode(PHP_EOL, $out);
- $timestampChanges = array_slice($timestampChanges, 0, count($timestampChanges) - 1);
- foreach ($timestampChanges as $timestamp) {
- if ((int)$timestamp < $deadlineTimestamp) {
- return;
- }
- }
-
- $this->checkFiles[] = $path;
- }
- private function printFilesToCheck() {
- if (!empty($this->checkFiles)) {
- print "\n";
- print 'For following files all lines changed since the Nextcloud fork.' . PHP_EOL;
- print 'Please check if these files can be moved over to AGPLv3 or later' . PHP_EOL;
- print "\n";
- foreach ($this->checkFiles as $file) {
- print $file . PHP_EOL;
- }
- print "\n";
- }
- }
- private function filterAuthors($authors = []) {
- $authors = array_filter($authors, function ($author) {
- return !in_array($author, [
- '',
- 'Not Committed Yet <not.committed.yet>',
- 'Jenkins for ownCloud <owncloud-bot@tmit.eu>',
- 'Scrutinizer Auto-Fixer <auto-fixer@scrutinizer-ci.com>',
- ]);
- });
-
- $authors = array_filter($authors, function ($author) {
- return strpos($author, 'dependabot') === false;
- });
- return $authors;
- }
- private function getCreatorCopyright($file, $gitRoot) {
- $buildDir = getcwd();
- if ($gitRoot) {
- chdir($gitRoot);
- $file = substr($file, strlen($gitRoot));
- }
- $year = trim(shell_exec('date +%Y -d "$(git log --format=%aD ../apps/files/lib/Controller/ViewController.php | tail -1)"'));
- $blame = shell_exec("git blame --line-porcelain $file | sed -n 's/^author //p;s/^author-mail //p' | sed 'N;s/\\n/ /'");
- $authors = explode(PHP_EOL, $blame);
- if ($gitRoot) {
- chdir($buildDir);
- }
- $authors = $this->filterAuthors($authors);
-
- if ($gitRoot) {
- $authors = array_map([$this, 'checkCoreMailMap'], $authors);
- $authors = array_unique($authors);
- }
- $creator = array_key_exists(0, $authors)
- ? $this->fixInvalidEmail($authors[0])
- : '';
- return " * @copyright Copyright (c) $year $creator";
- }
- private function getAuthors($file, $gitRoot) {
-
- $licenseHeaderEndsAtLine = trim(shell_exec("grep -n '*/' $file | head -n 1 | cut -d ':' -f 1"));
- $buildDir = getcwd();
- if ($gitRoot) {
- chdir($gitRoot);
- $file = substr($file, strlen($gitRoot));
- }
- $out = shell_exec("git blame --line-porcelain -L $licenseHeaderEndsAtLine, $file | sed -n 's/^author //p;s/^author-mail //p' | sed 'N;s/\\n/ /' | sort -f | uniq");
- if ($gitRoot) {
- chdir($buildDir);
- }
- $authors = explode(PHP_EOL, $out);
- $authors = $this->filterAuthors($authors);
- if ($gitRoot) {
- $authors = array_map([$this, 'checkCoreMailMap'], $authors);
- $authors = array_unique($authors);
- }
- $authors = array_map(function ($author) {
- $author = $this->fixInvalidEmail($author);
- $this->authors[$author] = $author;
- return " * @author $author";
- }, $authors);
- return implode(PHP_EOL, $authors);
- }
- private function checkCoreMailMap($author) {
- if (empty($this->mailMap)) {
- $content = file_get_contents(__DIR__ . '/../.mailmap');
- $entries = explode("\n", $content);
- foreach ($entries as $entry) {
- if (strpos($entry, '> ') === false) {
- $this->mailMap[$entry] = $entry;
- } else {
- [$use, $actual] = explode('> ', $entry);
- $this->mailMap[$actual] = $use . '>';
- }
- }
- }
- if (isset($this->mailMap[$author])) {
- return $this->mailMap[$author];
- }
- return $author;
- }
- private function fixInvalidEmail($author) {
- preg_match('/<(.*)>/', $author, $mailMatch);
- if (count($mailMatch) === 2 && !filter_var($mailMatch[1], FILTER_VALIDATE_EMAIL)) {
- $author = str_replace('<' . $mailMatch[1] . '>', '"' . $mailMatch[1] . '"', $author);
- }
- return $author;
- }
- }
- $licenses = new Licenses;
- if (isset($argv[1])) {
- $licenses->exec($argv[1], isset($argv[2]) ? $argv[1] : false);
- } else {
- $licenses->exec([
- '../apps/admin_audit',
- '../apps/cloud_federation_api',
- '../apps/comments',
- '../apps/contactsinteraction',
- '../apps/dashboard',
- '../apps/dav',
- '../apps/encryption',
- '../apps/federatedfilesharing',
- '../apps/federation',
- '../apps/files',
- '../apps/files_external',
- '../apps/files_sharing',
- '../apps/files_trashbin',
- '../apps/files_versions',
- '../apps/lookup_server_connector',
- '../apps/oauth2',
- '../apps/provisioning_api',
- '../apps/settings',
- '../apps/sharebymail',
- '../apps/systemtags',
- '../apps/testing',
- '../apps/theming',
- '../apps/twofactor_backupcodes',
- '../apps/updatenotification',
- '../apps/user_ldap',
- '../apps/user_status',
- '../apps/weather_status',
- '../apps/workflowengine',
- '../build/integration/features/bootstrap',
- '../core',
- '../lib',
- '../ocs',
- '../console.php',
- '../cron.php',
- '../index.php',
- '../public.php',
- '../remote.php',
- '../status.php',
- '../version.php',
- ]);
- $licenses->writeAuthorsFile();
- }
|