No OneTemporary
Actions

Size

6 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/src/lint/linter/ArcanistPhutilXHPASTLinter.php b/src/lint/linter/ArcanistPhutilXHPASTLinter.php
	index 1a50300a..9a0e9d47 100644
	--- a/src/lint/linter/ArcanistPhutilXHPASTLinter.php
	+++ b/src/lint/linter/ArcanistPhutilXHPASTLinter.php
	@@ -1,219 +1,223 @@
	<?php

	/**
	* @group linter
	*/
	final class ArcanistPhutilXHPASTLinter extends ArcanistBaseXHPASTLinter {

	const LINT_PHT_WITH_DYNAMIC_STRING = 1;
	const LINT_ARRAY_COMBINE = 2;
	const LINT_DEPRECATED_FUNCTION = 3;
	const LINT_UNSAFE_DYNAMIC_STRING = 4;

	private $xhpastLinter;

	public function setXHPASTLinter(ArcanistXHPASTLinter $linter) {
	$this->xhpastLinter = $linter;
	return $this;
	}

	public function setEngine(ArcanistLintEngine $engine) {
	if (!$this->xhpastLinter) {
	throw new Exception(
	'Call setXHPASTLinter() before using ArcanistPhutilXHPASTLinter.');
	}
	$this->xhpastLinter->setEngine($engine);
	return parent::setEngine($engine);
	}

	public function getLintNameMap() {
	return array(
	self::LINT_PHT_WITH_DYNAMIC_STRING => 'Use of pht() on Dynamic String',
	self::LINT_ARRAY_COMBINE => 'array_combine() Unreliable',
	- self::LINT_DEPRECATED_FUNCTION => 'Use of deprecated function',
	+ self::LINT_DEPRECATED_FUNCTION => 'Use of Deprecated Function',
	self::LINT_UNSAFE_DYNAMIC_STRING => 'Unsafe Usage of Dynamic String',
	);
	}

	public function getLintSeverityMap() {
	$warning = ArcanistLintSeverity::SEVERITY_WARNING;
	return array(
	self::LINT_ARRAY_COMBINE => $warning,
	self::LINT_DEPRECATED_FUNCTION => $warning,
	self::LINT_UNSAFE_DYNAMIC_STRING => $warning,
	);
	}

	public function getLinterName() {
	return 'PHLXHP';
	}

	public function getCacheVersion() {
	return 2;
	}

	public function willLintPaths(array $paths) {
	$this->xhpastLinter->willLintPaths($paths);
	}

	public function lintPath($path) {
	$tree = $this->xhpastLinter->getXHPASTTreeForPath($path);
	if (!$tree) {
	return;
	}

	$root = $tree->getRootNode();

	$this->lintPHT($root);
	$this->lintArrayCombine($root);
	$this->lintUnsafeDynamicString($root);
	$this->lintDeprecatedFunctions($root);
	}


	private function lintPHT($root) {
	$calls = $root->selectDescendantsOfType('n_FUNCTION_CALL');
	foreach ($calls as $call) {
	$name = $call->getChildByIndex(0)->getConcreteString();
	if (strcasecmp($name, 'pht') != 0) {
	continue;
	}

	$parameters = $call->getChildOfType(1, 'n_CALL_PARAMETER_LIST');
	if (!$parameters->getChildren()) {
	continue;
	}

	$identifier = $parameters->getChildByIndex(0);
	if ($identifier->isConstantString()) {
	continue;
	}

	$this->raiseLintAtNode(
	$call,
	self::LINT_PHT_WITH_DYNAMIC_STRING,
	"The first parameter of pht() can be only a scalar string, ".
	"otherwise it can't be extracted.");
	}
	}


	private function lintUnsafeDynamicString($root) {
	$safe = array(
	'hsprintf' => 0,

	'csprintf' => 0,
	'vcsprintf' => 0,
	'execx' => 0,
	'exec_manual' => 0,
	'phutil_passthru' => 0,

	'qsprintf' => 1,
	'vqsprintf' => 1,
	'queryfx' => 1,
	'vqueryfx' => 1,
	'queryfx_all' => 1,
	'vqueryfx_all' => 1,
	'queryfx_one' => 1,
	);

	$calls = $root->selectDescendantsOfType('n_FUNCTION_CALL');
	$this->lintUnsafeDynamicStringCall($calls, $safe);

	$safe = array(
	'execfuture' => 0,
	);

	$news = $root->selectDescendantsOfType('n_NEW');
	$this->lintUnsafeDynamicStringCall($news, $safe);
	}

	private function lintUnsafeDynamicStringCall(
	AASTNodeList $calls,
	array $safe) {

	foreach ($calls as $call) {
	$name = $call->getChildByIndex(0)->getConcreteString();
	$param = idx($safe, strtolower($name));

	if ($param === null) {
	continue;
	}

	$parameters = $call->getChildByIndex(1);
	if (count($parameters->getChildren()) <= $param) {
	continue;
	}

	$identifier = $parameters->getChildByIndex($param);
	if (!$identifier->isConstantString()) {
	$this->raiseLintAtNode(
	$call,
	self::LINT_UNSAFE_DYNAMIC_STRING,
	"Parameter ".($param + 1)." of {$name}() should be a scalar string, ".
	"otherwise it's not safe.");
	}
	}
	}


	private function lintArrayCombine($root) {
	$function_calls = $root->selectDescendantsOfType('n_FUNCTION_CALL');
	foreach ($function_calls as $call) {
	$name = $call->getChildByIndex(0)->getConcreteString();
	if (strcasecmp($name, 'array_combine') == 0) {
	$parameter_list = $call->getChildOfType(1, 'n_CALL_PARAMETER_LIST');
	if (count($parameter_list->getChildren()) !== 2) {
	// Wrong number of parameters, but raise that elsewhere if we want.
	continue;
	}

	$first = $parameter_list->getChildByIndex(0);
	$second = $parameter_list->getChildByIndex(1);

	if ($first->getConcreteString() == $second->getConcreteString()) {
	$this->raiseLintAtNode(
	$call,
	self::LINT_ARRAY_COMBINE,
	'Prior to PHP 5.4, array_combine() fails when given empty '.
	'arrays. Prefer to write array_combine(x, x) as array_fuse(x).');
	}
	}
	}
	}

	private function lintDeprecatedFunctions($root) {
	$map = array(
	// Silly; for unit testing.
	'deprecated_function' => 'This function is most likely deprecated.',

	'phutil_render_tag' =>
	'The phutil_render_tag() function is deprecated and unsafe. '.
	'Use phutil_tag() instead.',

	'javelin_render_tag' =>
	'The javelin_render_tag() function is deprecated and unsafe. '.
	'Use javelin_tag() instead.',

	'phabricator_render_form' =>
	'The phabricator_render_form() function is deprecated and unsafe. '.
	'Use phabricator_form() instead.',
	+
	+ 'phutil_escape_html' =>
	+ 'The phutil_escape_html() function is deprecated. Raw strings passed '.
	+ 'to phutil_tag() or hsprintf() are escaped automatically.',
	);

	$function_calls = $root->selectDescendantsOfType('n_FUNCTION_CALL');
	foreach ($function_calls as $call) {
	$name = $call->getChildByIndex(0)->getConcreteString();

	$name = strtolower($name);
	if (empty($map[$name])) {
	continue;
	}

	$this->raiseLintAtNode(
	$call,
	self::LINT_DEPRECATED_FUNCTION,
	$map[$name]);
	}
	}

	}

File Metadata

Mime Type: text/x-diff
Expires: Sun, Jan 19, 18:09 (1 w, 4 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1127283
Default Alt Text: (6 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions