ArcanistLicenseLinter.php
No OneTemporary
Actions

Size

1 KB

Referenced Files

None

Subscribers

None

ArcanistLicenseLinter.php
View Options

	<?php

	/**
	* Adds a license or copyright header to source files.
	*
	* @group linter
	*/
	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) {
	$copyright_holder = $this->getConfig('copyright_holder');
	if ($copyright_holder === null) {
	$working_copy = $this->getEngine()->getWorkingCopy();
	$copyright_holder = $working_copy->getConfig('copyright_holder');
	}

	if (!$copyright_holder) {
	return;
	}

	$patterns = $this->getLicensePatterns();
	$license = $this->getLicenseText($copyright_holder);

	$data = $this->getData($path);
	$matches = 0;

	foreach ($patterns as $pattern) {
	if (preg_match($pattern, $data, $matches)) {
	$expect = rtrim(implode('', array_slice($matches, 1)))."\n".$license;
	if (trim($matches[0]) != trim($expect)) {
	$this->raiseLintAtOffset(
	0,
	self::LINT_NO_LICENSE_HEADER,
	'This file has a missing or out of date license header.',
	$matches[0],
	ltrim($expect));
	}
	break;
	}
	}
	}
	}

File Metadata

Mime Type: text/x-php
Expires: Sun, Jan 19, 13:06 (3 w, 3 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1124899
Default Alt Text: ArcanistLicenseLinter.php (1 KB)

ArcanistLicenseLinter.phpNo OneTemporaryActions

ArcanistLicenseLinter.phpView Options

File Metadata

Event Timeline

ArcanistLicenseLinter.php
No OneTemporary
Actions

ArcanistLicenseLinter.php
View Options