From 2783a780708e4e5c04b6935840416d219bc4d852 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Mon, 15 Jun 2015 17:50:37 +0200 Subject: [PATCH] Allow checking for functions --- lib/private/app/codechecker.php | 4 +- lib/private/app/codecheckvisitor.php | 48 +++++++++++++++---- lib/private/app/deprecationcodechecker.php | 12 +++++ .../test-deprecated-constant-alias.php | 8 +--- .../test-deprecated-constant-sub-alias.php | 8 +--- .../test-deprecated-constant-sub.php | 6 +-- .../code-checker/test-deprecated-constant.php | 6 +-- .../test-deprecated-function-alias.php | 5 ++ .../test-deprecated-function-sub-alias.php | 5 ++ .../test-deprecated-function-sub.php | 5 ++ .../code-checker/test-deprecated-function.php | 3 ++ tests/lib/app/codecheckvisitor.php | 28 ++++++++++- tests/lib/app/mock/codechecker.php | 5 ++ 13 files changed, 109 insertions(+), 34 deletions(-) create mode 100644 tests/data/app/code-checker/test-deprecated-function-alias.php create mode 100644 tests/data/app/code-checker/test-deprecated-function-sub-alias.php create mode 100644 tests/data/app/code-checker/test-deprecated-function-sub.php create mode 100644 tests/data/app/code-checker/test-deprecated-function.php diff --git a/lib/private/app/codechecker.php b/lib/private/app/codechecker.php index 57e1a4c5b5..b3d8a3b1e8 100644 --- a/lib/private/app/codechecker.php +++ b/lib/private/app/codechecker.php @@ -81,6 +81,8 @@ class CodeChecker extends BasicEmitter { protected $blackListedConstants = []; + protected $blackListedFunctions = []; + /** @var bool */ protected $checkEqualOperators = false; @@ -146,7 +148,7 @@ class CodeChecker extends BasicEmitter { $code = file_get_contents($file); $statements = $this->parser->parse($code); - $visitor = new CodeCheckVisitor($this->blackListDescription, $this->blackListedClassNames, $this->blackListedConstants, $this->checkEqualOperators); + $visitor = new CodeCheckVisitor($this->blackListDescription, $this->blackListedClassNames, $this->blackListedConstants, $this->blackListedFunctions, $this->checkEqualOperators); $traverser = new NodeTraverser; $traverser->addVisitor($visitor); diff --git a/lib/private/app/codecheckvisitor.php b/lib/private/app/codecheckvisitor.php index 60c685747b..4741a997c7 100644 --- a/lib/private/app/codecheckvisitor.php +++ b/lib/private/app/codecheckvisitor.php @@ -33,6 +33,8 @@ class CodeCheckVisitor extends NodeVisitorAbstract { protected $blackListedClassNames; /** @var string[] */ protected $blackListedConstants; + /** @var string[] */ + protected $blackListedFunctions; /** @var bool */ protected $checkEqualOperatorUsage; /** @var string[] */ @@ -42,9 +44,10 @@ class CodeCheckVisitor extends NodeVisitorAbstract { * @param string $blackListDescription * @param array $blackListedClassNames * @param array $blackListedConstants + * @param array $blackListedFunctions * @param bool $checkEqualOperatorUsage */ - public function __construct($blackListDescription, $blackListedClassNames, $blackListedConstants, $checkEqualOperatorUsage) { + public function __construct($blackListDescription, $blackListedClassNames, $blackListedConstants, $blackListedFunctions, $checkEqualOperatorUsage) { $this->blackListDescription = $blackListDescription; $this->blackListedClassNames = []; @@ -59,9 +62,15 @@ class CodeCheckVisitor extends NodeVisitorAbstract { } $this->blackListedConstants = []; - foreach ($blackListedConstants as $constant => $blackListInfo) { - $constant = strtolower($constant); - $this->blackListedConstants[$constant] = $constant; + foreach ($blackListedConstants as $constantName => $blackListInfo) { + $constantName = strtolower($constantName); + $this->blackListedConstants[$constantName] = $constantName; + } + + $this->blackListedFunctions = []; + foreach ($blackListedFunctions as $functionName => $blackListInfo) { + $functionName = strtolower($functionName); + $this->blackListedFunctions[$functionName] = $functionName; } $this->checkEqualOperatorUsage = $checkEqualOperatorUsage; @@ -118,6 +127,8 @@ class CodeCheckVisitor extends NodeVisitorAbstract { * $n = $i::call(); */ } + + $this->checkBlackListFunction($node->class->toString(), $node->name, $node); } } if ($node instanceof Node\Expr\ClassConstFetch) { @@ -185,12 +196,17 @@ class CodeCheckVisitor extends NodeVisitorAbstract { foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) { if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) { - $aliasedClassName = str_replace($name, $alias, $blackListedConstant); - $this->blackListedConstants[$aliasedClassName] = $blackListedConstant; + $aliasedConstantName = str_replace($name, $alias, $blackListedConstant); + $this->blackListedConstants[$aliasedConstantName] = $blackListedConstant; } } - $name = strtolower($name); + foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) { + if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) { + $aliasedFunctionName = str_replace($name, $alias, $blackListedFunction); + $this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction; + } + } } private function checkBlackList($name, $errorCode, Node $node) { @@ -206,8 +222,8 @@ class CodeCheckVisitor extends NodeVisitorAbstract { } } - private function checkBlackListConstant($class, $constants, Node $node) { - $name = $class . '::' . $constants; + private function checkBlackListConstant($class, $constantName, Node $node) { + $name = $class . '::' . $constantName; $lowerName = strtolower($name); if (isset($this->blackListedConstants[$lowerName])) { @@ -220,6 +236,20 @@ class CodeCheckVisitor extends NodeVisitorAbstract { } } + private function checkBlackListFunction($class, $functionName, Node $node) { + $name = $class . '::' . $functionName; + $lowerName = strtolower($name); + + if (isset($this->blackListedFunctions[$lowerName])) { + $this->errors[]= [ + 'disallowedToken' => $name, + 'errorCode' => CodeChecker::STATIC_CALL_NOT_ALLOWED, + 'line' => $node->getLine(), + 'reason' => $this->buildReason($this->blackListedFunctions[$lowerName], CodeChecker::STATIC_CALL_NOT_ALLOWED) + ]; + } + } + private function buildReason($name, $errorCode) { if (isset($this->errorMessages[$errorCode])) { return $this->errorMessages[$errorCode]; diff --git a/lib/private/app/deprecationcodechecker.php b/lib/private/app/deprecationcodechecker.php index 9a23bb2c53..48146c74fa 100644 --- a/lib/private/app/deprecationcodechecker.php +++ b/lib/private/app/deprecationcodechecker.php @@ -48,4 +48,16 @@ class DeprecationCodeChecker extends CodeChecker { 'OCP::PERMISSION_ALL' => '8.0.0', 'OCP::FILENAME_INVALID_CHARS' => '8.0.0', ]; + + protected $blackListedFunctions = [ + // Deprecated functions + 'OCP::image_path' => '8.0.0', + 'OCP::mimetype_icon' => '8.0.0', + 'OCP::preview_icon' => '8.0.0', + 'OCP::publicPreview_icon' => '8.0.0', + 'OCP::human_file_size' => '8.0.0', + 'OCP::relative_modified_date' => '8.0.0', + 'OCP::simple_file_size' => '8.0.0', + 'OCP::html_select_options' => '8.0.0', + ]; } diff --git a/tests/data/app/code-checker/test-deprecated-constant-alias.php b/tests/data/app/code-checker/test-deprecated-constant-alias.php index 4f3d3e8131..b5a5bfdb76 100644 --- a/tests/data/app/code-checker/test-deprecated-constant-alias.php +++ b/tests/data/app/code-checker/test-deprecated-constant-alias.php @@ -1,12 +1,8 @@ assertEquals($expectedErrorCode, $errors[0]['errorCode']); $this->assertEquals($expectedErrorToken, $errors[0]['disallowedToken']); } + + public function providesFunctionsToCheck() { + return [ + ['OCP\NamespaceName\ClassName::functionName', 1002, 'test-deprecated-function.php'], + ['Alias::functionName', 1002, 'test-deprecated-function-alias.php'], + ['NamespaceName\ClassName::functionName', 1002, 'test-deprecated-function-sub.php'], + ['SubAlias\ClassName::functionName', 1002, 'test-deprecated-function-sub-alias.php'], + ]; + } + + /** + * @dataProvider providesFunctionsToCheck + * @param string $expectedErrorToken + * @param int $expectedErrorCode + * @param string $fileToVerify + */ + public function testFunctionsToCheck($expectedErrorToken, $expectedErrorCode, $fileToVerify) { + $checker = new \Test\App\Mock\CodeChecker(); + $errors = $checker->analyseFile(OC::$SERVERROOT . "/tests/data/app/code-checker/$fileToVerify"); + + $this->assertEquals(1, count($errors)); + $this->assertEquals($expectedErrorCode, $errors[0]['errorCode']); + $this->assertEquals($expectedErrorToken, $errors[0]['disallowedToken']); + } } diff --git a/tests/lib/app/mock/codechecker.php b/tests/lib/app/mock/codechecker.php index 228fd881e4..e67d060b1f 100644 --- a/tests/lib/app/mock/codechecker.php +++ b/tests/lib/app/mock/codechecker.php @@ -36,4 +36,9 @@ class CodeChecker extends \OC\App\CodeChecker { // Deprecated constants 'OCP\NamespaceName\ClassName::CONSTANT_NAME' => '8.0.0', ]; + + protected $blackListedFunctions = [ + // Deprecated constants + 'OCP\NamespaceName\ClassName::functionName' => '8.0.0', + ]; }