diff --git a/lib/private/app/codechecker.php b/lib/private/app/codechecker.php index 57e1a4c5b5dccbbc5166b350fb06d5bec0072b4d..b3d8a3b1e81dd0957289ab1a6bce168cbf936e78 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 60c685747be39451d334527054955e573de8f24f..4741a997c7dfd1d6fb23483d9580612badca5977 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 9a23bb2c5304a399fb7237e8996cb3f55f4fad71..48146c74fa8e296d858f4017f6693f19554cb240 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 4f3d3e813162f039b412311894eff863f4fe382e..b5a5bfdb7629136e7939abcd0ca51313042c91ce 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 @@ <?php -use OCP\NamespaceName\ClassName as Constant; +use OCP\NamespaceName\ClassName as Alias; /** * Class BadClass - creating an instance of a blacklisted class is not allowed */ -class BadClass { - public function test() { - return Constant::CONSTANT_NAME; - } -} +Alias::CONSTANT_NAME; diff --git a/tests/data/app/code-checker/test-deprecated-constant-sub-alias.php b/tests/data/app/code-checker/test-deprecated-constant-sub-alias.php index b7e7c7e6be95b087785e8a9ff76012fb73805156..9b1757aa683ace7952fa5302008ee9b12bd4cf60 100644 --- a/tests/data/app/code-checker/test-deprecated-constant-sub-alias.php +++ b/tests/data/app/code-checker/test-deprecated-constant-sub-alias.php @@ -1,12 +1,8 @@ <?php -use OCP\NamespaceName as Constant; +use OCP\NamespaceName as SubAlias; /** * Class BadClass - creating an instance of a blacklisted class is not allowed */ -class BadClass { - public function test() { - return Constant\ClassName::CONSTANT_NAME; - } -} +SubAlias\ClassName::CONSTANT_NAME; diff --git a/tests/data/app/code-checker/test-deprecated-constant-sub.php b/tests/data/app/code-checker/test-deprecated-constant-sub.php index 0ef837c14c6a2606c5e23577877c44196f346906..86e0ff52efe43a92ebe0d8042abb1790fe2dbc1d 100644 --- a/tests/data/app/code-checker/test-deprecated-constant-sub.php +++ b/tests/data/app/code-checker/test-deprecated-constant-sub.php @@ -5,8 +5,4 @@ use OCP\NamespaceName; /** * Class BadClass - creating an instance of a blacklisted class is not allowed */ -class BadClass { - public function test() { - return NamespaceName\ClassName::CONSTANT_NAME; - } -} +NamespaceName\ClassName::CONSTANT_NAME; diff --git a/tests/data/app/code-checker/test-deprecated-constant.php b/tests/data/app/code-checker/test-deprecated-constant.php index 965d84500fd80e7d64735c793c6bf82ef356afcd..170b1d9e5ade83068fbb17b2e9057338b2c55d54 100644 --- a/tests/data/app/code-checker/test-deprecated-constant.php +++ b/tests/data/app/code-checker/test-deprecated-constant.php @@ -3,8 +3,4 @@ /** * Class BadClass - creating an instance of a blacklisted class is not allowed */ -class BadClass { - public function test() { - return \OCP\NamespaceName\ClassName::CONSTANT_NAME; - } -} +\OCP\NamespaceName\ClassName::CONSTANT_NAME; diff --git a/tests/data/app/code-checker/test-deprecated-function-alias.php b/tests/data/app/code-checker/test-deprecated-function-alias.php new file mode 100644 index 0000000000000000000000000000000000000000..0c958cc635c9eca9e8d0b1e363aa0c13cd26ac4e --- /dev/null +++ b/tests/data/app/code-checker/test-deprecated-function-alias.php @@ -0,0 +1,5 @@ +<?php + +use OCP\NamespaceName\ClassName as Alias; + +Alias::functionName(); diff --git a/tests/data/app/code-checker/test-deprecated-function-sub-alias.php b/tests/data/app/code-checker/test-deprecated-function-sub-alias.php new file mode 100644 index 0000000000000000000000000000000000000000..f728eaf9fd0939dcb997e399f4fc5562265fdd02 --- /dev/null +++ b/tests/data/app/code-checker/test-deprecated-function-sub-alias.php @@ -0,0 +1,5 @@ +<?php + +use OCP\NamespaceName as SubAlias; + +SubAlias\ClassName::functionName(); diff --git a/tests/data/app/code-checker/test-deprecated-function-sub.php b/tests/data/app/code-checker/test-deprecated-function-sub.php new file mode 100644 index 0000000000000000000000000000000000000000..f7e15903d5daac5eca9219f2058df34b230f05d7 --- /dev/null +++ b/tests/data/app/code-checker/test-deprecated-function-sub.php @@ -0,0 +1,5 @@ +<?php + +use OCP\NamespaceName; + +NamespaceName\ClassName::functionName(); diff --git a/tests/data/app/code-checker/test-deprecated-function.php b/tests/data/app/code-checker/test-deprecated-function.php new file mode 100644 index 0000000000000000000000000000000000000000..0016076e377a15772981822cfcaee7856b5ae752 --- /dev/null +++ b/tests/data/app/code-checker/test-deprecated-function.php @@ -0,0 +1,3 @@ +<?php + +\OCP\NamespaceName\ClassName::functionName(); diff --git a/tests/lib/app/codecheckvisitor.php b/tests/lib/app/codecheckvisitor.php index 4b663cf40b73278653970f5c6cad7fc4a68c08d2..3eac3beedc856279bdb7eef98d55b62ba3501d52 100644 --- a/tests/lib/app/codecheckvisitor.php +++ b/tests/lib/app/codecheckvisitor.php @@ -40,9 +40,9 @@ class CodeCheckVisitor extends TestCase { public function providesConstantsToCheck() { return [ ['OCP\NamespaceName\ClassName::CONSTANT_NAME', 1003, 'test-deprecated-constant.php'], - ['Constant::CONSTANT_NAME', 1003, 'test-deprecated-constant-alias.php'], + ['Alias::CONSTANT_NAME', 1003, 'test-deprecated-constant-alias.php'], ['NamespaceName\ClassName::CONSTANT_NAME', 1003, 'test-deprecated-constant-sub.php'], - ['Constant\ClassName::CONSTANT_NAME', 1003, 'test-deprecated-constant-sub-alias.php'], + ['SubAlias\ClassName::CONSTANT_NAME', 1003, 'test-deprecated-constant-sub-alias.php'], ]; } @@ -60,4 +60,28 @@ class CodeCheckVisitor extends TestCase { $this->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 228fd881e44c4f3ba4b8d1614c4919eb10b52e28..e67d060b1f4767b9b1a9b78e402024353857c0d7 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', + ]; }