mirror of
https://we.phorge.it/source/arcanist.git
synced 2024-11-22 06:42:41 +01:00
Refactor Apache license linter to parameterize the license itself.
Summary: Refactor Apache license linter to parameterize the license itself. Test Plan: meta - begin *PUBLIC* platform impact section - Bugzilla: # - end platform impact - Differential Revision: 33 Reviewed By: epriestley Reviewers: epriestley
This commit is contained in:
parent
f20db032bd
commit
f22d74f88d
6 changed files with 106 additions and 56 deletions
0
foo.bar
Normal file
0
foo.bar
Normal file
|
@ -34,6 +34,7 @@ phutil_register_library_map(array(
|
||||||
'ArcanistGitAPI' => 'repository/api/git',
|
'ArcanistGitAPI' => 'repository/api/git',
|
||||||
'ArcanistGitHookPreReceiveWorkflow' => 'workflow/git-hook-pre-receive',
|
'ArcanistGitHookPreReceiveWorkflow' => 'workflow/git-hook-pre-receive',
|
||||||
'ArcanistHelpWorkflow' => 'workflow/help',
|
'ArcanistHelpWorkflow' => 'workflow/help',
|
||||||
|
'ArcanistLicenseLinter' => 'lint/linter/license',
|
||||||
'ArcanistLintEngine' => 'lint/engine/base',
|
'ArcanistLintEngine' => 'lint/engine/base',
|
||||||
'ArcanistLintMessage' => 'lint/message',
|
'ArcanistLintMessage' => 'lint/message',
|
||||||
'ArcanistLintPatcher' => 'lint/patcher',
|
'ArcanistLintPatcher' => 'lint/patcher',
|
||||||
|
@ -75,7 +76,7 @@ phutil_register_library_map(array(
|
||||||
'requires_class' =>
|
'requires_class' =>
|
||||||
array(
|
array(
|
||||||
'ArcanistAmendWorkflow' => 'ArcanistBaseWorkflow',
|
'ArcanistAmendWorkflow' => 'ArcanistBaseWorkflow',
|
||||||
'ArcanistApacheLicenseLinter' => 'ArcanistLinter',
|
'ArcanistApacheLicenseLinter' => 'ArcanistLicenseLinter',
|
||||||
'ArcanistCommitWorkflow' => 'ArcanistBaseWorkflow',
|
'ArcanistCommitWorkflow' => 'ArcanistBaseWorkflow',
|
||||||
'ArcanistCoverWorkflow' => 'ArcanistBaseWorkflow',
|
'ArcanistCoverWorkflow' => 'ArcanistBaseWorkflow',
|
||||||
'ArcanistDiffParserTestCase' => 'ArcanistPhutilTestCase',
|
'ArcanistDiffParserTestCase' => 'ArcanistPhutilTestCase',
|
||||||
|
@ -86,6 +87,7 @@ phutil_register_library_map(array(
|
||||||
'ArcanistGitAPI' => 'ArcanistRepositoryAPI',
|
'ArcanistGitAPI' => 'ArcanistRepositoryAPI',
|
||||||
'ArcanistGitHookPreReceiveWorkflow' => 'ArcanistBaseWorkflow',
|
'ArcanistGitHookPreReceiveWorkflow' => 'ArcanistBaseWorkflow',
|
||||||
'ArcanistHelpWorkflow' => 'ArcanistBaseWorkflow',
|
'ArcanistHelpWorkflow' => 'ArcanistBaseWorkflow',
|
||||||
|
'ArcanistLicenseLinter' => 'ArcanistLinter',
|
||||||
'ArcanistLintWorkflow' => 'ArcanistBaseWorkflow',
|
'ArcanistLintWorkflow' => 'ArcanistBaseWorkflow',
|
||||||
'ArcanistListWorkflow' => 'ArcanistBaseWorkflow',
|
'ArcanistListWorkflow' => 'ArcanistBaseWorkflow',
|
||||||
'ArcanistMarkCommittedWorkflow' => 'ArcanistBaseWorkflow',
|
'ArcanistMarkCommittedWorkflow' => 'ArcanistBaseWorkflow',
|
||||||
|
|
|
@ -16,46 +16,15 @@
|
||||||
* limitations under the License.
|
* limitations under the License.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
class ArcanistApacheLicenseLinter extends ArcanistLinter {
|
class ArcanistApacheLicenseLinter extends ArcanistLicenseLinter {
|
||||||
|
|
||||||
const LINT_NO_LICENSE_HEADER = 1;
|
|
||||||
|
|
||||||
public function willLintPaths(array $paths) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
public function getLinterName() {
|
public function getLinterName() {
|
||||||
return 'APACHELICENSE';
|
return 'APACHELICENSE';
|
||||||
}
|
}
|
||||||
|
|
||||||
public function getLintSeverityMap() {
|
protected function getLicenseText($copyright_holder) {
|
||||||
return array();
|
|
||||||
}
|
|
||||||
|
|
||||||
public function getLintNameMap() {
|
|
||||||
return array(
|
|
||||||
self::LINT_NO_LICENSE_HEADER => 'No License Header',
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function lintPath($path) {
|
|
||||||
$working_copy = $this->getEngine()->getWorkingCopy();
|
|
||||||
$copyright_holder = $working_copy->getConfig('copyright_holder');
|
|
||||||
|
|
||||||
if (!$copyright_holder) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
$year = date('Y');
|
$year = date('Y');
|
||||||
|
|
||||||
$maybe_php_or_script = '(#![^\n]+?[\n])?(<[?]php\s+?)?';
|
return <<<EOLICENSE
|
||||||
$patterns = array(
|
|
||||||
"@^{$maybe_php_or_script}//[^\n]*Copyright[^\n]*[\n]\s*@i",
|
|
||||||
"@^{$maybe_php_or_script}/[*].*?Copyright.*?[*]/\s*@is",
|
|
||||||
"@^{$maybe_php_or_script}\s*@",
|
|
||||||
);
|
|
||||||
|
|
||||||
$license = <<<EOLICENSE
|
|
||||||
/*
|
/*
|
||||||
* Copyright {$year} {$copyright_holder}
|
* Copyright {$year} {$copyright_holder}
|
||||||
*
|
*
|
||||||
|
@ -74,24 +43,14 @@ class ArcanistApacheLicenseLinter extends ArcanistLinter {
|
||||||
|
|
||||||
|
|
||||||
EOLICENSE;
|
EOLICENSE;
|
||||||
|
|
||||||
foreach ($patterns as $pattern) {
|
|
||||||
$data = $this->getData($path);
|
|
||||||
$matches = 0;
|
|
||||||
if (preg_match($pattern, $data, $matches)) {
|
|
||||||
$expect = rtrim(implode('', array_slice($matches, 1)))."\n\n".$license;
|
|
||||||
$expect = ltrim($expect);
|
|
||||||
if (rtrim($matches[0]) != rtrim($expect)) {
|
|
||||||
$this->raiseLintAtOffset(
|
|
||||||
0,
|
|
||||||
self::LINT_NO_LICENSE_HEADER,
|
|
||||||
'This file has a missing or out of date license header.',
|
|
||||||
$matches[0],
|
|
||||||
$expect);
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
protected function getLicensePatterns() {
|
||||||
|
$maybe_php_or_script = '(#![^\n]+?[\n])?(<[?]php\s+?)?';
|
||||||
|
return array(
|
||||||
|
"@^{$maybe_php_or_script}//[^\n]*Copyright[^\n]*[\n]\s*@i",
|
||||||
|
"@^{$maybe_php_or_script}/[*].*?Copyright.*?[*]/\s*@is",
|
||||||
|
"@^{$maybe_php_or_script}\s*@",
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -5,8 +5,6 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
phutil_require_module('arcanist', 'lint/linter/license');
|
||||||
phutil_require_module('arcanist', 'lint/linter/base');
|
|
||||||
|
|
||||||
|
|
||||||
phutil_require_source('ArcanistApacheLicenseLinter.php');
|
phutil_require_source('ArcanistApacheLicenseLinter.php');
|
||||||
|
|
79
src/lint/linter/license/ArcanistLicenseLinter.php
Normal file
79
src/lint/linter/license/ArcanistLicenseLinter.php
Normal file
|
@ -0,0 +1,79 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Copyright 2011 Facebook, Inc.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
abstract class ArcanistLicenseLinter extends ArcanistLinter {
|
||||||
|
const LINT_NO_LICENSE_HEADER = 1;
|
||||||
|
|
||||||
|
public function willLintPaths(array $paths) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getLintSeverityMap() {
|
||||||
|
return array();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getLintNameMap() {
|
||||||
|
return array(
|
||||||
|
self::LINT_NO_LICENSE_HEADER => 'No License Header',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Given the name of the copyright holder, return appropriate license header
|
||||||
|
* text.
|
||||||
|
*/
|
||||||
|
abstract protected function getLicenseText($copyright_holder);
|
||||||
|
/**
|
||||||
|
* Return an array of regular expressions that, if matched, indicate
|
||||||
|
* that a copyright header is required. The appropriate match will be
|
||||||
|
* stripped from the input when comparing against the expected license.
|
||||||
|
*/
|
||||||
|
abstract protected function getLicensePatterns();
|
||||||
|
|
||||||
|
public function lintPath($path) {
|
||||||
|
$working_copy = $this->getEngine()->getWorkingCopy();
|
||||||
|
$copyright_holder = $working_copy->getConfig('copyright_holder');
|
||||||
|
|
||||||
|
if (!$copyright_holder) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$patterns = $this->getLicensePatterns();
|
||||||
|
$license = $this->getLicenseText($copyright_holder);
|
||||||
|
|
||||||
|
foreach ($patterns as $pattern) {
|
||||||
|
$data = $this->getData($path);
|
||||||
|
$matches = 0;
|
||||||
|
if (preg_match($pattern, $data, $matches)) {
|
||||||
|
$expect = rtrim(implode('', array_slice($matches, 1)))."\n\n".$license;
|
||||||
|
$expect = ltrim($expect);
|
||||||
|
if (rtrim($matches[0]) != rtrim($expect)) {
|
||||||
|
$this->raiseLintAtOffset(
|
||||||
|
0,
|
||||||
|
self::LINT_NO_LICENSE_HEADER,
|
||||||
|
'This file has a missing or out of date license header.',
|
||||||
|
$matches[0],
|
||||||
|
$expect);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
12
src/lint/linter/license/__init__.php
Normal file
12
src/lint/linter/license/__init__.php
Normal file
|
@ -0,0 +1,12 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* This file is automatically generated. Lint this module to rebuild it.
|
||||||
|
* @generated
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
phutil_require_module('arcanist', 'lint/linter/base');
|
||||||
|
|
||||||
|
|
||||||
|
phutil_require_source('ArcanistLicenseLinter.php');
|
Loading…
Reference in a new issue