wbrawner/server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Allow checking for functions

Browse source
This commit is contained in:
Joas Schilling 2015-06-15 17:50:37 +02:00
parent f228a3dc28
commit 2783a78070
13 changed files with 109 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
lib/private/app/codechecker.php
View file

@ -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);

48
lib/private/app/codecheckvisitor.php
View file

@ -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];

12
lib/private/app/deprecationcodechecker.php
View file

@ -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',
];
}

8
tests/data/app/code-checker/test-deprecated-constant-alias.php
View file

@ -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;

8
tests/data/app/code-checker/test-deprecated-constant-sub-alias.php
View file

@ -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;

6
tests/data/app/code-checker/test-deprecated-constant-sub.php
View file

@ -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;

6
tests/data/app/code-checker/test-deprecated-constant.php
View file

@ -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;

5
tests/data/app/code-checker/test-deprecated-function-alias.php Normal file
View file

@ -0,0 +1,5 @@
<?php
use OCP\NamespaceName\ClassName as Alias;
Alias::functionName();

5
tests/data/app/code-checker/test-deprecated-function-sub-alias.php Normal file
View file

@ -0,0 +1,5 @@
<?php
use OCP\NamespaceName as SubAlias;
SubAlias\ClassName::functionName();

5
tests/data/app/code-checker/test-deprecated-function-sub.php Normal file
View file

@ -0,0 +1,5 @@
<?php
use OCP\NamespaceName;
NamespaceName\ClassName::functionName();

3
tests/data/app/code-checker/test-deprecated-function.php Normal file
View file

@ -0,0 +1,3 @@
<?php
\OCP\NamespaceName\ClassName::functionName();

28
tests/lib/app/codecheckvisitor.php
View file

@ -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']);
}
}

5
tests/lib/app/mock/codechecker.php
View file

@ -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',
];
}