nextcloud/lib/private/app/codecheckvisitor.php

194 lines
6.5 KiB
PHP
Raw Normal View History

<?php
/**
2015-03-26 13:44:34 +03:00
* @author Morris Jobke <hey@morrisjobke.de>
* @author Thomas Müller <thomas.mueller@tmit.eu>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OC\App;
use PhpParser\Node;
use PhpParser\Node\Name;
use PhpParser\NodeVisitorAbstract;
class CodeCheckVisitor extends NodeVisitorAbstract {
/** @var string */
protected $blackListDescription;
/** @var string[] */
protected $blackListedClassNames;
/** @var bool */
protected $checkEqualOperatorUsage;
/** @var string[] */
protected $errorMessages;
/**
* @param string $blackListDescription
2015-06-15 17:08:54 +03:00
* @param array $blackListedClassNames
* @param bool $checkEqualOperatorUsage
*/
public function __construct($blackListDescription, $blackListedClassNames, $checkEqualOperatorUsage) {
$this->blackListDescription = $blackListDescription;
2015-06-15 16:24:45 +03:00
$this->blackListedClassNames = [];
2015-06-15 17:08:54 +03:00
foreach ($blackListedClassNames as $class => $blackListInfo) {
if (is_numeric($class) && is_string($blackListInfo)) {
$class = $blackListInfo;
$blackListInfo = null;
}
2015-06-15 16:24:45 +03:00
$class = strtolower($class);
$this->blackListedClassNames[$class] = $class;
}
$this->checkEqualOperatorUsage = $checkEqualOperatorUsage;
$this->errorMessages = [
CodeChecker::CLASS_EXTENDS_NOT_ALLOWED => "{$this->blackListDescription} class must not be extended",
CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED => "{$this->blackListDescription} interface must not be implemented",
CodeChecker::STATIC_CALL_NOT_ALLOWED => "Static method of {$this->blackListDescription} class must not be called",
CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED => "Constant of {$this->blackListDescription} class must not not be fetched",
CodeChecker::CLASS_NEW_FETCH_NOT_ALLOWED => "{$this->blackListDescription} class must not be instanciated",
2015-06-15 16:24:45 +03:00
CodeChecker::CLASS_USE_NOT_ALLOWED => "{$this->blackListDescription} class must not be imported with a use statement",
CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED => "is discouraged",
];
}
/** @var array */
public $errors = [];
public function enterNode(Node $node) {
if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\Equal) {
2015-05-05 13:59:33 +03:00
$this->errors[]= [
'disallowedToken' => '==',
'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED,
'line' => $node->getLine(),
'reason' => $this->buildReason('==', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED)
];
}
if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\NotEqual) {
2015-05-05 13:59:33 +03:00
$this->errors[]= [
'disallowedToken' => '!=',
'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED,
'line' => $node->getLine(),
'reason' => $this->buildReason('!=', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED)
];
}
if ($node instanceof Node\Stmt\Class_) {
if (!is_null($node->extends)) {
$this->checkBlackList($node->extends->toString(), CodeChecker::CLASS_EXTENDS_NOT_ALLOWED, $node);
}
foreach ($node->implements as $implements) {
$this->checkBlackList($implements->toString(), CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED, $node);
}
}
if ($node instanceof Node\Expr\StaticCall) {
if (!is_null($node->class)) {
if ($node->class instanceof Name) {
$this->checkBlackList($node->class->toString(), CodeChecker::STATIC_CALL_NOT_ALLOWED, $node);
}
if ($node->class instanceof Node\Expr\Variable) {
/**
* TODO: find a way to detect something like this:
* $c = "OC_API";
* $n = $i::call();
*/
}
}
}
if ($node instanceof Node\Expr\ClassConstFetch) {
if (!is_null($node->class)) {
if ($node->class instanceof Name) {
$this->checkBlackList($node->class->toString(), CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, $node);
}
if ($node->class instanceof Node\Expr\Variable) {
/**
* TODO: find a way to detect something like this:
* $c = "OC_API";
* $n = $i::ADMIN_AUTH;
*/
}
}
}
if ($node instanceof Node\Expr\New_) {
if (!is_null($node->class)) {
if ($node->class instanceof Name) {
$this->checkBlackList($node->class->toString(), CodeChecker::CLASS_NEW_FETCH_NOT_ALLOWED, $node);
}
if ($node->class instanceof Node\Expr\Variable) {
/**
* TODO: find a way to detect something like this:
* $c = "OC_API";
* $n = new $i;
*/
}
}
}
2015-06-15 16:24:45 +03:00
if ($node instanceof Node\Stmt\UseUse) {
$this->checkBlackList($node->name->toString(), CodeChecker::CLASS_USE_NOT_ALLOWED, $node);
if ($node->alias) {
$this->addUseNameToBlackList($node->name->toString(), $node->alias);
} else {
$this->addUseNameToBlackList($node->name->toString(), $node->name->getLast());
}
}
}
/**
* Check whether an alias was introduced for a namespace of a blacklisted class
*
* Example:
* - Blacklist entry: OCP\AppFramework\IApi
* - Name: OCP\AppFramework
* - Alias: OAF
* => new blacklist entry: OAF\IApi
*
* @param string $name
* @param string $alias
*/
private function addUseNameToBlackList($name, $alias) {
$name = strtolower($name);
$alias = strtolower($alias);
foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) {
if (strpos($blackListedClassName, $name . '\\') === 0) {
$aliasedClassName = str_replace($name, $alias, $blackListedClassName);
$this->blackListedClassNames[$aliasedClassName] = $blackListedClassName;
}
}
}
private function checkBlackList($name, $errorCode, Node $node) {
2015-06-15 16:24:45 +03:00
if (isset($this->blackListedClassNames[strtolower($name)])) {
$this->errors[]= [
'disallowedToken' => $name,
'errorCode' => $errorCode,
'line' => $node->getLine(),
2015-06-15 16:24:45 +03:00
'reason' => $this->buildReason($this->blackListedClassNames[strtolower($name)], $errorCode)
];
}
}
private function buildReason($name, $errorCode) {
if (isset($this->errorMessages[$errorCode])) {
return $this->errorMessages[$errorCode];
}
return "$name usage not allowed - error: $errorCode";
}
}