@@ -33,7 +33,7 @@ |
||
| 33 | 33 | } |
| 34 | 34 | if ($table !== null) { |
| 35 | 35 | $suffix = '_SEQ'; |
| 36 | - $table = '"' . $table . $suffix . '"'; |
|
| 36 | + $table = '"'.$table.$suffix.'"'; |
|
| 37 | 37 | } |
| 38 | 38 | return $this->conn->realLastInsertId($table); |
| 39 | 39 | } |
@@ -26,24 +26,24 @@ |
||
| 26 | 26 | namespace OC\DB; |
| 27 | 27 | |
| 28 | 28 | class AdapterOCI8 extends Adapter { |
| 29 | - public function lastInsertId($table) { |
|
| 30 | - if (is_null($table)) { |
|
| 31 | - throw new \InvalidArgumentException('Oracle requires a table name to be passed into lastInsertId()'); |
|
| 32 | - } |
|
| 33 | - if ($table !== null) { |
|
| 34 | - $suffix = '_SEQ'; |
|
| 35 | - $table = '"' . $table . $suffix . '"'; |
|
| 36 | - } |
|
| 37 | - return $this->conn->realLastInsertId($table); |
|
| 38 | - } |
|
| 29 | + public function lastInsertId($table) { |
|
| 30 | + if (is_null($table)) { |
|
| 31 | + throw new \InvalidArgumentException('Oracle requires a table name to be passed into lastInsertId()'); |
|
| 32 | + } |
|
| 33 | + if ($table !== null) { |
|
| 34 | + $suffix = '_SEQ'; |
|
| 35 | + $table = '"' . $table . $suffix . '"'; |
|
| 36 | + } |
|
| 37 | + return $this->conn->realLastInsertId($table); |
|
| 38 | + } |
|
| 39 | 39 | |
| 40 | - public const UNIX_TIMESTAMP_REPLACEMENT = "(cast(sys_extract_utc(systimestamp) as date) - date'1970-01-01') * 86400"; |
|
| 40 | + public const UNIX_TIMESTAMP_REPLACEMENT = "(cast(sys_extract_utc(systimestamp) as date) - date'1970-01-01') * 86400"; |
|
| 41 | 41 | |
| 42 | - public function fixupStatement($statement) { |
|
| 43 | - $statement = preg_replace('/`(\w+)` ILIKE \?/', 'REGEXP_LIKE(`$1`, \'^\' || REPLACE(?, \'%\', \'.*\') || \'$\', \'i\')', $statement); |
|
| 44 | - $statement = str_replace('`', '"', $statement); |
|
| 45 | - $statement = str_ireplace('NOW()', 'CURRENT_TIMESTAMP', $statement); |
|
| 46 | - $statement = str_ireplace('UNIX_TIMESTAMP()', self::UNIX_TIMESTAMP_REPLACEMENT, $statement); |
|
| 47 | - return $statement; |
|
| 48 | - } |
|
| 42 | + public function fixupStatement($statement) { |
|
| 43 | + $statement = preg_replace('/`(\w+)` ILIKE \?/', 'REGEXP_LIKE(`$1`, \'^\' || REPLACE(?, \'%\', \'.*\') || \'$\', \'i\')', $statement); |
|
| 44 | + $statement = str_replace('`', '"', $statement); |
|
| 45 | + $statement = str_ireplace('NOW()', 'CURRENT_TIMESTAMP', $statement); |
|
| 46 | + $statement = str_ireplace('UNIX_TIMESTAMP()', self::UNIX_TIMESTAMP_REPLACEMENT, $statement); |
|
| 47 | + return $statement; |
|
| 48 | + } |
|
| 49 | 49 | } |
@@ -25,17 +25,17 @@ |
||
| 25 | 25 | use OCP\DB\QueryBuilder\IQueryFunction; |
| 26 | 26 | |
| 27 | 27 | class QueryFunction implements IQueryFunction { |
| 28 | - /** @var string */ |
|
| 29 | - protected $function; |
|
| 28 | + /** @var string */ |
|
| 29 | + protected $function; |
|
| 30 | 30 | |
| 31 | - public function __construct($function) { |
|
| 32 | - $this->function = $function; |
|
| 33 | - } |
|
| 31 | + public function __construct($function) { |
|
| 32 | + $this->function = $function; |
|
| 33 | + } |
|
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @return string |
|
| 37 | - */ |
|
| 38 | - public function __toString() { |
|
| 39 | - return (string) $this->function; |
|
| 40 | - } |
|
| 35 | + /** |
|
| 36 | + * @return string |
|
| 37 | + */ |
|
| 38 | + public function __toString() { |
|
| 39 | + return (string) $this->function; |
|
| 40 | + } |
|
| 41 | 41 | } |
@@ -25,17 +25,17 @@ |
||
| 25 | 25 | use OCP\DB\QueryBuilder\IParameter; |
| 26 | 26 | |
| 27 | 27 | class Parameter implements IParameter { |
| 28 | - /** @var mixed */ |
|
| 29 | - protected $name; |
|
| 28 | + /** @var mixed */ |
|
| 29 | + protected $name; |
|
| 30 | 30 | |
| 31 | - public function __construct($name) { |
|
| 32 | - $this->name = $name; |
|
| 33 | - } |
|
| 31 | + public function __construct($name) { |
|
| 32 | + $this->name = $name; |
|
| 33 | + } |
|
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @return string |
|
| 37 | - */ |
|
| 38 | - public function __toString() { |
|
| 39 | - return (string) $this->name; |
|
| 40 | - } |
|
| 35 | + /** |
|
| 36 | + * @return string |
|
| 37 | + */ |
|
| 38 | + public function __toString() { |
|
| 39 | + return (string) $this->name; |
|
| 40 | + } |
|
| 41 | 41 | } |
@@ -48,7 +48,7 @@ |
||
| 48 | 48 | public function iLike($x, $y, $type = null) { |
| 49 | 49 | $x = $this->helper->quoteColumnName($x); |
| 50 | 50 | $y = $this->helper->quoteColumnName($y); |
| 51 | - return $this->expressionBuilder->comparison($x, ' COLLATE ' . $this->charset . '_general_ci LIKE', $y); |
|
| 51 | + return $this->expressionBuilder->comparison($x, ' COLLATE '.$this->charset.'_general_ci LIKE', $y); |
|
| 52 | 52 | } |
| 53 | 53 | |
| 54 | 54 | } |
@@ -30,26 +30,26 @@ |
||
| 30 | 30 | |
| 31 | 31 | class MySqlExpressionBuilder extends ExpressionBuilder { |
| 32 | 32 | |
| 33 | - /** @var string */ |
|
| 34 | - protected $charset; |
|
| 33 | + /** @var string */ |
|
| 34 | + protected $charset; |
|
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @param \OCP\IDBConnection|Connection $connection |
|
| 38 | - * @param IQueryBuilder $queryBuilder |
|
| 39 | - */ |
|
| 40 | - public function __construct(IDBConnection $connection, IQueryBuilder $queryBuilder) { |
|
| 41 | - parent::__construct($connection, $queryBuilder); |
|
| 36 | + /** |
|
| 37 | + * @param \OCP\IDBConnection|Connection $connection |
|
| 38 | + * @param IQueryBuilder $queryBuilder |
|
| 39 | + */ |
|
| 40 | + public function __construct(IDBConnection $connection, IQueryBuilder $queryBuilder) { |
|
| 41 | + parent::__construct($connection, $queryBuilder); |
|
| 42 | 42 | |
| 43 | - $params = $connection->getParams(); |
|
| 44 | - $this->charset = isset($params['charset']) ? $params['charset'] : 'utf8'; |
|
| 45 | - } |
|
| 43 | + $params = $connection->getParams(); |
|
| 44 | + $this->charset = isset($params['charset']) ? $params['charset'] : 'utf8'; |
|
| 45 | + } |
|
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * @inheritdoc |
|
| 49 | - */ |
|
| 50 | - public function iLike($x, $y, $type = null) { |
|
| 51 | - $x = $this->helper->quoteColumnName($x); |
|
| 52 | - $y = $this->helper->quoteColumnName($y); |
|
| 53 | - return $this->expressionBuilder->comparison($x, ' COLLATE ' . $this->charset . '_general_ci LIKE', $y); |
|
| 54 | - } |
|
| 47 | + /** |
|
| 48 | + * @inheritdoc |
|
| 49 | + */ |
|
| 50 | + public function iLike($x, $y, $type = null) { |
|
| 51 | + $x = $this->helper->quoteColumnName($x); |
|
| 52 | + $y = $this->helper->quoteColumnName($y); |
|
| 53 | + return $this->expressionBuilder->comparison($x, ' COLLATE ' . $this->charset . '_general_ci LIKE', $y); |
|
| 54 | + } |
|
| 55 | 55 | } |
@@ -25,32 +25,32 @@ |
||
| 25 | 25 | use Doctrine\DBAL\Schema\Schema; |
| 26 | 26 | |
| 27 | 27 | class PostgreSqlMigrator extends Migrator { |
| 28 | - /** |
|
| 29 | - * @param Schema $targetSchema |
|
| 30 | - * @param \Doctrine\DBAL\Connection $connection |
|
| 31 | - * @return \Doctrine\DBAL\Schema\SchemaDiff |
|
| 32 | - */ |
|
| 33 | - protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) { |
|
| 34 | - $schemaDiff = parent::getDiff($targetSchema, $connection); |
|
| 28 | + /** |
|
| 29 | + * @param Schema $targetSchema |
|
| 30 | + * @param \Doctrine\DBAL\Connection $connection |
|
| 31 | + * @return \Doctrine\DBAL\Schema\SchemaDiff |
|
| 32 | + */ |
|
| 33 | + protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) { |
|
| 34 | + $schemaDiff = parent::getDiff($targetSchema, $connection); |
|
| 35 | 35 | |
| 36 | - foreach ($schemaDiff->changedTables as $tableDiff) { |
|
| 37 | - // fix default value in brackets - pg 9.4 is returning a negative default value in () |
|
| 38 | - // see https://github.com/doctrine/dbal/issues/2427 |
|
| 39 | - foreach ($tableDiff->changedColumns as $column) { |
|
| 40 | - $column->changedProperties = array_filter($column->changedProperties, function ($changedProperties) use ($column) { |
|
| 41 | - if ($changedProperties !== 'default') { |
|
| 42 | - return true; |
|
| 43 | - } |
|
| 44 | - $fromDefault = $column->fromColumn->getDefault(); |
|
| 45 | - $toDefault = $column->column->getDefault(); |
|
| 46 | - $fromDefault = trim($fromDefault, "()"); |
|
| 36 | + foreach ($schemaDiff->changedTables as $tableDiff) { |
|
| 37 | + // fix default value in brackets - pg 9.4 is returning a negative default value in () |
|
| 38 | + // see https://github.com/doctrine/dbal/issues/2427 |
|
| 39 | + foreach ($tableDiff->changedColumns as $column) { |
|
| 40 | + $column->changedProperties = array_filter($column->changedProperties, function ($changedProperties) use ($column) { |
|
| 41 | + if ($changedProperties !== 'default') { |
|
| 42 | + return true; |
|
| 43 | + } |
|
| 44 | + $fromDefault = $column->fromColumn->getDefault(); |
|
| 45 | + $toDefault = $column->column->getDefault(); |
|
| 46 | + $fromDefault = trim($fromDefault, "()"); |
|
| 47 | 47 | |
| 48 | - // by intention usage of != |
|
| 49 | - return $fromDefault != $toDefault; |
|
| 50 | - }); |
|
| 51 | - } |
|
| 52 | - } |
|
| 48 | + // by intention usage of != |
|
| 49 | + return $fromDefault != $toDefault; |
|
| 50 | + }); |
|
| 51 | + } |
|
| 52 | + } |
|
| 53 | 53 | |
| 54 | - return $schemaDiff; |
|
| 55 | - } |
|
| 54 | + return $schemaDiff; |
|
| 55 | + } |
|
| 56 | 56 | } |
@@ -37,7 +37,7 @@ |
||
| 37 | 37 | // fix default value in brackets - pg 9.4 is returning a negative default value in () |
| 38 | 38 | // see https://github.com/doctrine/dbal/issues/2427 |
| 39 | 39 | foreach ($tableDiff->changedColumns as $column) { |
| 40 | - $column->changedProperties = array_filter($column->changedProperties, function ($changedProperties) use ($column) { |
|
| 40 | + $column->changedProperties = array_filter($column->changedProperties, function($changedProperties) use ($column) { |
|
| 41 | 41 | if ($changedProperties !== 'default') { |
| 42 | 42 | return true; |
| 43 | 43 | } |
@@ -27,31 +27,31 @@ |
||
| 27 | 27 | |
| 28 | 28 | class AdapterMySQL extends Adapter { |
| 29 | 29 | |
| 30 | - /** @var string */ |
|
| 31 | - protected $charset; |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * @param string $tableName |
|
| 35 | - */ |
|
| 36 | - public function lockTable($tableName) { |
|
| 37 | - $this->conn->executeUpdate('LOCK TABLES `' .$tableName . '` WRITE'); |
|
| 38 | - } |
|
| 39 | - |
|
| 40 | - public function unlockTable() { |
|
| 41 | - $this->conn->executeUpdate('UNLOCK TABLES'); |
|
| 42 | - } |
|
| 43 | - |
|
| 44 | - public function fixupStatement($statement) { |
|
| 45 | - $statement = str_replace(' ILIKE ', ' COLLATE ' . $this->getCharset() . '_general_ci LIKE ', $statement); |
|
| 46 | - return $statement; |
|
| 47 | - } |
|
| 48 | - |
|
| 49 | - protected function getCharset() { |
|
| 50 | - if (!$this->charset) { |
|
| 51 | - $params = $this->conn->getParams(); |
|
| 52 | - $this->charset = isset($params['charset']) ? $params['charset'] : 'utf8'; |
|
| 53 | - } |
|
| 54 | - |
|
| 55 | - return $this->charset; |
|
| 56 | - } |
|
| 30 | + /** @var string */ |
|
| 31 | + protected $charset; |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * @param string $tableName |
|
| 35 | + */ |
|
| 36 | + public function lockTable($tableName) { |
|
| 37 | + $this->conn->executeUpdate('LOCK TABLES `' .$tableName . '` WRITE'); |
|
| 38 | + } |
|
| 39 | + |
|
| 40 | + public function unlockTable() { |
|
| 41 | + $this->conn->executeUpdate('UNLOCK TABLES'); |
|
| 42 | + } |
|
| 43 | + |
|
| 44 | + public function fixupStatement($statement) { |
|
| 45 | + $statement = str_replace(' ILIKE ', ' COLLATE ' . $this->getCharset() . '_general_ci LIKE ', $statement); |
|
| 46 | + return $statement; |
|
| 47 | + } |
|
| 48 | + |
|
| 49 | + protected function getCharset() { |
|
| 50 | + if (!$this->charset) { |
|
| 51 | + $params = $this->conn->getParams(); |
|
| 52 | + $this->charset = isset($params['charset']) ? $params['charset'] : 'utf8'; |
|
| 53 | + } |
|
| 54 | + |
|
| 55 | + return $this->charset; |
|
| 56 | + } |
|
| 57 | 57 | } |
@@ -34,7 +34,7 @@ discard block |
||
| 34 | 34 | * @param string $tableName |
| 35 | 35 | */ |
| 36 | 36 | public function lockTable($tableName) { |
| 37 | - $this->conn->executeUpdate('LOCK TABLES `' .$tableName . '` WRITE'); |
|
| 37 | + $this->conn->executeUpdate('LOCK TABLES `'.$tableName.'` WRITE'); |
|
| 38 | 38 | } |
| 39 | 39 | |
| 40 | 40 | public function unlockTable() { |
@@ -42,7 +42,7 @@ discard block |
||
| 42 | 42 | } |
| 43 | 43 | |
| 44 | 44 | public function fixupStatement($statement) { |
| 45 | - $statement = str_replace(' ILIKE ', ' COLLATE ' . $this->getCharset() . '_general_ci LIKE ', $statement); |
|
| 45 | + $statement = str_replace(' ILIKE ', ' COLLATE '.$this->getCharset().'_general_ci LIKE ', $statement); |
|
| 46 | 46 | return $statement; |
| 47 | 47 | } |
| 48 | 48 | |
@@ -63,7 +63,7 @@ |
||
| 63 | 63 | * @return string |
| 64 | 64 | */ |
| 65 | 65 | private function buildTempDatabase() { |
| 66 | - $dataDir = $this->config->getSystemValue("datadirectory", \OC::$SERVERROOT . '/data'); |
|
| 66 | + $dataDir = $this->config->getSystemValue("datadirectory", \OC::$SERVERROOT.'/data'); |
|
| 67 | 67 | $tmpFile = uniqid("oc_"); |
| 68 | 68 | return "$dataDir/$tmpFile.db"; |
| 69 | 69 | } |
@@ -32,62 +32,62 @@ |
||
| 32 | 32 | |
| 33 | 33 | class SQLiteMigrator extends Migrator { |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @param \Doctrine\DBAL\Schema\Schema $targetSchema |
|
| 37 | - * @throws \OC\DB\MigrationException |
|
| 38 | - * |
|
| 39 | - * For sqlite we simple make a copy of the entire database, and test the migration on that |
|
| 40 | - */ |
|
| 41 | - public function checkMigrate(\Doctrine\DBAL\Schema\Schema $targetSchema) { |
|
| 42 | - $dbFile = $this->connection->getDatabase(); |
|
| 43 | - $tmpFile = $this->buildTempDatabase(); |
|
| 44 | - copy($dbFile, $tmpFile); |
|
| 35 | + /** |
|
| 36 | + * @param \Doctrine\DBAL\Schema\Schema $targetSchema |
|
| 37 | + * @throws \OC\DB\MigrationException |
|
| 38 | + * |
|
| 39 | + * For sqlite we simple make a copy of the entire database, and test the migration on that |
|
| 40 | + */ |
|
| 41 | + public function checkMigrate(\Doctrine\DBAL\Schema\Schema $targetSchema) { |
|
| 42 | + $dbFile = $this->connection->getDatabase(); |
|
| 43 | + $tmpFile = $this->buildTempDatabase(); |
|
| 44 | + copy($dbFile, $tmpFile); |
|
| 45 | 45 | |
| 46 | - $connectionParams = [ |
|
| 47 | - 'path' => $tmpFile, |
|
| 48 | - 'driver' => 'pdo_sqlite', |
|
| 49 | - ]; |
|
| 50 | - $conn = \Doctrine\DBAL\DriverManager::getConnection($connectionParams); |
|
| 51 | - try { |
|
| 52 | - $this->applySchema($targetSchema, $conn); |
|
| 53 | - $conn->close(); |
|
| 54 | - unlink($tmpFile); |
|
| 55 | - } catch (DBALException $e) { |
|
| 56 | - $conn->close(); |
|
| 57 | - unlink($tmpFile); |
|
| 58 | - throw new MigrationException('', $e->getMessage()); |
|
| 59 | - } |
|
| 60 | - } |
|
| 46 | + $connectionParams = [ |
|
| 47 | + 'path' => $tmpFile, |
|
| 48 | + 'driver' => 'pdo_sqlite', |
|
| 49 | + ]; |
|
| 50 | + $conn = \Doctrine\DBAL\DriverManager::getConnection($connectionParams); |
|
| 51 | + try { |
|
| 52 | + $this->applySchema($targetSchema, $conn); |
|
| 53 | + $conn->close(); |
|
| 54 | + unlink($tmpFile); |
|
| 55 | + } catch (DBALException $e) { |
|
| 56 | + $conn->close(); |
|
| 57 | + unlink($tmpFile); |
|
| 58 | + throw new MigrationException('', $e->getMessage()); |
|
| 59 | + } |
|
| 60 | + } |
|
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * @return string |
|
| 64 | - */ |
|
| 65 | - private function buildTempDatabase() { |
|
| 66 | - $dataDir = $this->config->getSystemValue("datadirectory", \OC::$SERVERROOT . '/data'); |
|
| 67 | - $tmpFile = uniqid("oc_"); |
|
| 68 | - return "$dataDir/$tmpFile.db"; |
|
| 69 | - } |
|
| 62 | + /** |
|
| 63 | + * @return string |
|
| 64 | + */ |
|
| 65 | + private function buildTempDatabase() { |
|
| 66 | + $dataDir = $this->config->getSystemValue("datadirectory", \OC::$SERVERROOT . '/data'); |
|
| 67 | + $tmpFile = uniqid("oc_"); |
|
| 68 | + return "$dataDir/$tmpFile.db"; |
|
| 69 | + } |
|
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * @param Schema $targetSchema |
|
| 73 | - * @param \Doctrine\DBAL\Connection $connection |
|
| 74 | - * @return \Doctrine\DBAL\Schema\SchemaDiff |
|
| 75 | - */ |
|
| 76 | - protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) { |
|
| 77 | - $platform = $connection->getDatabasePlatform(); |
|
| 78 | - $platform->registerDoctrineTypeMapping('tinyint unsigned', 'integer'); |
|
| 79 | - $platform->registerDoctrineTypeMapping('smallint unsigned', 'integer'); |
|
| 80 | - $platform->registerDoctrineTypeMapping('varchar ', 'string'); |
|
| 71 | + /** |
|
| 72 | + * @param Schema $targetSchema |
|
| 73 | + * @param \Doctrine\DBAL\Connection $connection |
|
| 74 | + * @return \Doctrine\DBAL\Schema\SchemaDiff |
|
| 75 | + */ |
|
| 76 | + protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) { |
|
| 77 | + $platform = $connection->getDatabasePlatform(); |
|
| 78 | + $platform->registerDoctrineTypeMapping('tinyint unsigned', 'integer'); |
|
| 79 | + $platform->registerDoctrineTypeMapping('smallint unsigned', 'integer'); |
|
| 80 | + $platform->registerDoctrineTypeMapping('varchar ', 'string'); |
|
| 81 | 81 | |
| 82 | - // with sqlite autoincrement columns is of type integer |
|
| 83 | - foreach ($targetSchema->getTables() as $table) { |
|
| 84 | - foreach ($table->getColumns() as $column) { |
|
| 85 | - if ($column->getType() instanceof BigIntType && $column->getAutoincrement()) { |
|
| 86 | - $column->setType(Type::getType('integer')); |
|
| 87 | - } |
|
| 88 | - } |
|
| 89 | - } |
|
| 82 | + // with sqlite autoincrement columns is of type integer |
|
| 83 | + foreach ($targetSchema->getTables() as $table) { |
|
| 84 | + foreach ($table->getColumns() as $column) { |
|
| 85 | + if ($column->getType() instanceof BigIntType && $column->getAutoincrement()) { |
|
| 86 | + $column->setType(Type::getType('integer')); |
|
| 87 | + } |
|
| 88 | + } |
|
| 89 | + } |
|
| 90 | 90 | |
| 91 | - return parent::getDiff($targetSchema, $connection); |
|
| 92 | - } |
|
| 91 | + return parent::getDiff($targetSchema, $connection); |
|
| 92 | + } |
|
| 93 | 93 | } |
@@ -22,31 +22,31 @@ |
||
| 22 | 22 | namespace OC\App\AppStore\Version; |
| 23 | 23 | |
| 24 | 24 | class Version { |
| 25 | - /** @var string */ |
|
| 26 | - private $minVersion; |
|
| 27 | - /** @var string */ |
|
| 28 | - private $maxVersion; |
|
| 25 | + /** @var string */ |
|
| 26 | + private $minVersion; |
|
| 27 | + /** @var string */ |
|
| 28 | + private $maxVersion; |
|
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * @param string $minVersion |
|
| 32 | - * @param string $maxVersion |
|
| 33 | - */ |
|
| 34 | - public function __construct($minVersion, $maxVersion) { |
|
| 35 | - $this->minVersion = $minVersion; |
|
| 36 | - $this->maxVersion = $maxVersion; |
|
| 37 | - } |
|
| 30 | + /** |
|
| 31 | + * @param string $minVersion |
|
| 32 | + * @param string $maxVersion |
|
| 33 | + */ |
|
| 34 | + public function __construct($minVersion, $maxVersion) { |
|
| 35 | + $this->minVersion = $minVersion; |
|
| 36 | + $this->maxVersion = $maxVersion; |
|
| 37 | + } |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @return string |
|
| 41 | - */ |
|
| 42 | - public function getMinimumVersion() { |
|
| 43 | - return $this->minVersion; |
|
| 44 | - } |
|
| 39 | + /** |
|
| 40 | + * @return string |
|
| 41 | + */ |
|
| 42 | + public function getMinimumVersion() { |
|
| 43 | + return $this->minVersion; |
|
| 44 | + } |
|
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @return string |
|
| 48 | - */ |
|
| 49 | - public function getMaximumVersion() { |
|
| 50 | - return $this->maxVersion; |
|
| 51 | - } |
|
| 46 | + /** |
|
| 47 | + * @return string |
|
| 48 | + */ |
|
| 49 | + public function getMaximumVersion() { |
|
| 50 | + return $this->maxVersion; |
|
| 51 | + } |
|
| 52 | 52 | } |
@@ -102,7 +102,7 @@ discard block |
||
| 102 | 102 | |
| 103 | 103 | public function enterNode(Node $node) { |
| 104 | 104 | if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\Equal) { |
| 105 | - $this->errors[]= [ |
|
| 105 | + $this->errors[] = [ |
|
| 106 | 106 | 'disallowedToken' => '==', |
| 107 | 107 | 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
| 108 | 108 | 'line' => $node->getLine(), |
@@ -110,7 +110,7 @@ discard block |
||
| 110 | 110 | ]; |
| 111 | 111 | } |
| 112 | 112 | if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\NotEqual) { |
| 113 | - $this->errors[]= [ |
|
| 113 | + $this->errors[] = [ |
|
| 114 | 114 | 'disallowedToken' => '!=', |
| 115 | 115 | 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
| 116 | 116 | 'line' => $node->getLine(), |
@@ -214,28 +214,28 @@ discard block |
||
| 214 | 214 | $alias = strtolower($alias); |
| 215 | 215 | |
| 216 | 216 | foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) { |
| 217 | - if (strpos($blackListedClassName, $name . '\\') === 0) { |
|
| 217 | + if (strpos($blackListedClassName, $name.'\\') === 0) { |
|
| 218 | 218 | $aliasedClassName = str_replace($name, $alias, $blackListedClassName); |
| 219 | 219 | $this->blackListedClassNames[$aliasedClassName] = $blackListedClassName; |
| 220 | 220 | } |
| 221 | 221 | } |
| 222 | 222 | |
| 223 | 223 | foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) { |
| 224 | - if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) { |
|
| 224 | + if (strpos($blackListedConstant, $name.'\\') === 0 || strpos($blackListedConstant, $name.'::') === 0) { |
|
| 225 | 225 | $aliasedConstantName = str_replace($name, $alias, $blackListedConstant); |
| 226 | 226 | $this->blackListedConstants[$aliasedConstantName] = $blackListedConstant; |
| 227 | 227 | } |
| 228 | 228 | } |
| 229 | 229 | |
| 230 | 230 | foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) { |
| 231 | - if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) { |
|
| 231 | + if (strpos($blackListedFunction, $name.'\\') === 0 || strpos($blackListedFunction, $name.'::') === 0) { |
|
| 232 | 232 | $aliasedFunctionName = str_replace($name, $alias, $blackListedFunction); |
| 233 | 233 | $this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction; |
| 234 | 234 | } |
| 235 | 235 | } |
| 236 | 236 | |
| 237 | 237 | foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) { |
| 238 | - if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) { |
|
| 238 | + if (strpos($blackListedMethod, $name.'\\') === 0 || strpos($blackListedMethod, $name.'::') === 0) { |
|
| 239 | 239 | $aliasedMethodName = str_replace($name, $alias, $blackListedMethod); |
| 240 | 240 | $this->blackListedMethods[$aliasedMethodName] = $blackListedMethod; |
| 241 | 241 | } |
@@ -246,7 +246,7 @@ discard block |
||
| 246 | 246 | $lowerName = strtolower($name); |
| 247 | 247 | |
| 248 | 248 | if (isset($this->blackListedClassNames[$lowerName])) { |
| 249 | - $this->errors[]= [ |
|
| 249 | + $this->errors[] = [ |
|
| 250 | 250 | 'disallowedToken' => $name, |
| 251 | 251 | 'errorCode' => $errorCode, |
| 252 | 252 | 'line' => $node->getLine(), |
@@ -256,11 +256,11 @@ discard block |
||
| 256 | 256 | } |
| 257 | 257 | |
| 258 | 258 | private function checkBlackListConstant($class, $constantName, Node $node) { |
| 259 | - $name = $class . '::' . $constantName; |
|
| 259 | + $name = $class.'::'.$constantName; |
|
| 260 | 260 | $lowerName = strtolower($name); |
| 261 | 261 | |
| 262 | 262 | if (isset($this->blackListedConstants[$lowerName])) { |
| 263 | - $this->errors[]= [ |
|
| 263 | + $this->errors[] = [ |
|
| 264 | 264 | 'disallowedToken' => $name, |
| 265 | 265 | 'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, |
| 266 | 266 | 'line' => $node->getLine(), |
@@ -270,11 +270,11 @@ discard block |
||
| 270 | 270 | } |
| 271 | 271 | |
| 272 | 272 | private function checkBlackListFunction($class, $functionName, Node $node) { |
| 273 | - $name = $class . '::' . $functionName; |
|
| 273 | + $name = $class.'::'.$functionName; |
|
| 274 | 274 | $lowerName = strtolower($name); |
| 275 | 275 | |
| 276 | 276 | if (isset($this->blackListedFunctions[$lowerName])) { |
| 277 | - $this->errors[]= [ |
|
| 277 | + $this->errors[] = [ |
|
| 278 | 278 | 'disallowedToken' => $name, |
| 279 | 279 | 'errorCode' => CodeChecker::STATIC_CALL_NOT_ALLOWED, |
| 280 | 280 | 'line' => $node->getLine(), |
@@ -284,11 +284,11 @@ discard block |
||
| 284 | 284 | } |
| 285 | 285 | |
| 286 | 286 | private function checkBlackListMethod($class, $functionName, Node $node) { |
| 287 | - $name = $class . '::' . $functionName; |
|
| 287 | + $name = $class.'::'.$functionName; |
|
| 288 | 288 | $lowerName = strtolower($name); |
| 289 | 289 | |
| 290 | 290 | if (isset($this->blackListedMethods[$lowerName])) { |
| 291 | - $this->errors[]= [ |
|
| 291 | + $this->errors[] = [ |
|
| 292 | 292 | 'disallowedToken' => $name, |
| 293 | 293 | 'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED, |
| 294 | 294 | 'line' => $node->getLine(), |
@@ -29,280 +29,280 @@ |
||
| 29 | 29 | use PhpParser\NodeVisitorAbstract; |
| 30 | 30 | |
| 31 | 31 | class NodeVisitor extends NodeVisitorAbstract { |
| 32 | - /** @var ICheck */ |
|
| 33 | - protected $list; |
|
| 34 | - |
|
| 35 | - /** @var string */ |
|
| 36 | - protected $blackListDescription; |
|
| 37 | - /** @var string[] */ |
|
| 38 | - protected $blackListedClassNames; |
|
| 39 | - /** @var string[] */ |
|
| 40 | - protected $blackListedConstants; |
|
| 41 | - /** @var string[] */ |
|
| 42 | - protected $blackListedFunctions; |
|
| 43 | - /** @var string[] */ |
|
| 44 | - protected $blackListedMethods; |
|
| 45 | - /** @var bool */ |
|
| 46 | - protected $checkEqualOperatorUsage; |
|
| 47 | - /** @var string[] */ |
|
| 48 | - protected $errorMessages; |
|
| 49 | - |
|
| 50 | - /** |
|
| 51 | - * @param ICheck $list |
|
| 52 | - */ |
|
| 53 | - public function __construct(ICheck $list) { |
|
| 54 | - $this->list = $list; |
|
| 55 | - |
|
| 56 | - $this->blackListedClassNames = []; |
|
| 57 | - foreach ($list->getClasses() as $class => $blackListInfo) { |
|
| 58 | - if (is_numeric($class) && is_string($blackListInfo)) { |
|
| 59 | - $class = $blackListInfo; |
|
| 60 | - $blackListInfo = null; |
|
| 61 | - } |
|
| 62 | - |
|
| 63 | - $class = strtolower($class); |
|
| 64 | - $this->blackListedClassNames[$class] = $class; |
|
| 65 | - } |
|
| 66 | - |
|
| 67 | - $this->blackListedConstants = []; |
|
| 68 | - foreach ($list->getConstants() as $constantName => $blackListInfo) { |
|
| 69 | - $constantName = strtolower($constantName); |
|
| 70 | - $this->blackListedConstants[$constantName] = $constantName; |
|
| 71 | - } |
|
| 72 | - |
|
| 73 | - $this->blackListedFunctions = []; |
|
| 74 | - foreach ($list->getFunctions() as $functionName => $blackListInfo) { |
|
| 75 | - $functionName = strtolower($functionName); |
|
| 76 | - $this->blackListedFunctions[$functionName] = $functionName; |
|
| 77 | - } |
|
| 78 | - |
|
| 79 | - $this->blackListedMethods = []; |
|
| 80 | - foreach ($list->getMethods() as $functionName => $blackListInfo) { |
|
| 81 | - $functionName = strtolower($functionName); |
|
| 82 | - $this->blackListedMethods[$functionName] = $functionName; |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - $this->checkEqualOperatorUsage = $list->checkStrongComparisons(); |
|
| 86 | - |
|
| 87 | - $this->errorMessages = [ |
|
| 88 | - CodeChecker::CLASS_EXTENDS_NOT_ALLOWED => "%s class must not be extended", |
|
| 89 | - CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED => "%s interface must not be implemented", |
|
| 90 | - CodeChecker::STATIC_CALL_NOT_ALLOWED => "Static method of %s class must not be called", |
|
| 91 | - CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED => "Constant of %s class must not not be fetched", |
|
| 92 | - CodeChecker::CLASS_NEW_NOT_ALLOWED => "%s class must not be instantiated", |
|
| 93 | - CodeChecker::CLASS_USE_NOT_ALLOWED => "%s class must not be imported with a use statement", |
|
| 94 | - CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED => "Method of %s class must not be called", |
|
| 95 | - |
|
| 96 | - CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED => "is discouraged", |
|
| 97 | - ]; |
|
| 98 | - } |
|
| 99 | - |
|
| 100 | - /** @var array */ |
|
| 101 | - public $errors = []; |
|
| 102 | - |
|
| 103 | - public function enterNode(Node $node) { |
|
| 104 | - if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\Equal) { |
|
| 105 | - $this->errors[]= [ |
|
| 106 | - 'disallowedToken' => '==', |
|
| 107 | - 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
|
| 108 | - 'line' => $node->getLine(), |
|
| 109 | - 'reason' => $this->buildReason('==', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED) |
|
| 110 | - ]; |
|
| 111 | - } |
|
| 112 | - if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\NotEqual) { |
|
| 113 | - $this->errors[]= [ |
|
| 114 | - 'disallowedToken' => '!=', |
|
| 115 | - 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
|
| 116 | - 'line' => $node->getLine(), |
|
| 117 | - 'reason' => $this->buildReason('!=', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED) |
|
| 118 | - ]; |
|
| 119 | - } |
|
| 120 | - if ($node instanceof Node\Stmt\Class_) { |
|
| 121 | - if (!is_null($node->extends)) { |
|
| 122 | - $this->checkBlackList($node->extends->toString(), CodeChecker::CLASS_EXTENDS_NOT_ALLOWED, $node); |
|
| 123 | - } |
|
| 124 | - foreach ($node->implements as $implements) { |
|
| 125 | - $this->checkBlackList($implements->toString(), CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED, $node); |
|
| 126 | - } |
|
| 127 | - } |
|
| 128 | - if ($node instanceof Node\Expr\StaticCall) { |
|
| 129 | - if (!is_null($node->class)) { |
|
| 130 | - if ($node->class instanceof Name) { |
|
| 131 | - $this->checkBlackList($node->class->toString(), CodeChecker::STATIC_CALL_NOT_ALLOWED, $node); |
|
| 132 | - |
|
| 133 | - $this->checkBlackListFunction($node->class->toString(), $node->name, $node); |
|
| 134 | - $this->checkBlackListMethod($node->class->toString(), $node->name, $node); |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - if ($node->class instanceof Node\Expr\Variable) { |
|
| 138 | - /** |
|
| 139 | - * TODO: find a way to detect something like this: |
|
| 140 | - * $c = "OC_API"; |
|
| 141 | - * $n = $c::call(); |
|
| 142 | - */ |
|
| 143 | - // $this->checkBlackListMethod($node->class->..., $node->name, $node); |
|
| 144 | - } |
|
| 145 | - } |
|
| 146 | - } |
|
| 147 | - if ($node instanceof Node\Expr\MethodCall) { |
|
| 148 | - if (!is_null($node->var)) { |
|
| 149 | - if ($node->var instanceof Node\Expr\Variable) { |
|
| 150 | - /** |
|
| 151 | - * TODO: find a way to detect something like this: |
|
| 152 | - * $c = new OC_API(); |
|
| 153 | - * $n = $c::call(); |
|
| 154 | - * $n = $c->call(); |
|
| 155 | - */ |
|
| 156 | - // $this->checkBlackListMethod($node->var->..., $node->name, $node); |
|
| 157 | - } |
|
| 158 | - } |
|
| 159 | - } |
|
| 160 | - if ($node instanceof Node\Expr\ClassConstFetch) { |
|
| 161 | - if (!is_null($node->class)) { |
|
| 162 | - if ($node->class instanceof Name) { |
|
| 163 | - $this->checkBlackList($node->class->toString(), CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, $node); |
|
| 164 | - } |
|
| 165 | - if ($node->class instanceof Node\Expr\Variable || $node->class instanceof Node\Expr\PropertyFetch) { |
|
| 166 | - /** |
|
| 167 | - * TODO: find a way to detect something like this: |
|
| 168 | - * $c = "OC_API"; |
|
| 169 | - * $n = $i::ADMIN_AUTH; |
|
| 170 | - */ |
|
| 171 | - } else { |
|
| 172 | - $this->checkBlackListConstant($node->class->toString(), $node->name, $node); |
|
| 173 | - } |
|
| 174 | - } |
|
| 175 | - } |
|
| 176 | - if ($node instanceof Node\Expr\New_) { |
|
| 177 | - if (!is_null($node->class)) { |
|
| 178 | - if ($node->class instanceof Name) { |
|
| 179 | - $this->checkBlackList($node->class->toString(), CodeChecker::CLASS_NEW_NOT_ALLOWED, $node); |
|
| 180 | - } |
|
| 181 | - if ($node->class instanceof Node\Expr\Variable) { |
|
| 182 | - /** |
|
| 183 | - * TODO: find a way to detect something like this: |
|
| 184 | - * $c = "OC_API"; |
|
| 185 | - * $n = new $i; |
|
| 186 | - */ |
|
| 187 | - } |
|
| 188 | - } |
|
| 189 | - } |
|
| 190 | - if ($node instanceof Node\Stmt\UseUse) { |
|
| 191 | - $this->checkBlackList($node->name->toString(), CodeChecker::CLASS_USE_NOT_ALLOWED, $node); |
|
| 192 | - if ($node->alias) { |
|
| 193 | - $this->addUseNameToBlackList($node->name->toString(), $node->alias); |
|
| 194 | - } else { |
|
| 195 | - $this->addUseNameToBlackList($node->name->toString(), $node->name->getLast()); |
|
| 196 | - } |
|
| 197 | - } |
|
| 198 | - } |
|
| 199 | - |
|
| 200 | - /** |
|
| 201 | - * Check whether an alias was introduced for a namespace of a blacklisted class |
|
| 202 | - * |
|
| 203 | - * Example: |
|
| 204 | - * - Blacklist entry: OCP\AppFramework\IApi |
|
| 205 | - * - Name: OCP\AppFramework |
|
| 206 | - * - Alias: OAF |
|
| 207 | - * => new blacklist entry: OAF\IApi |
|
| 208 | - * |
|
| 209 | - * @param string $name |
|
| 210 | - * @param string $alias |
|
| 211 | - */ |
|
| 212 | - private function addUseNameToBlackList($name, $alias) { |
|
| 213 | - $name = strtolower($name); |
|
| 214 | - $alias = strtolower($alias); |
|
| 215 | - |
|
| 216 | - foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) { |
|
| 217 | - if (strpos($blackListedClassName, $name . '\\') === 0) { |
|
| 218 | - $aliasedClassName = str_replace($name, $alias, $blackListedClassName); |
|
| 219 | - $this->blackListedClassNames[$aliasedClassName] = $blackListedClassName; |
|
| 220 | - } |
|
| 221 | - } |
|
| 222 | - |
|
| 223 | - foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) { |
|
| 224 | - if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) { |
|
| 225 | - $aliasedConstantName = str_replace($name, $alias, $blackListedConstant); |
|
| 226 | - $this->blackListedConstants[$aliasedConstantName] = $blackListedConstant; |
|
| 227 | - } |
|
| 228 | - } |
|
| 229 | - |
|
| 230 | - foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) { |
|
| 231 | - if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) { |
|
| 232 | - $aliasedFunctionName = str_replace($name, $alias, $blackListedFunction); |
|
| 233 | - $this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction; |
|
| 234 | - } |
|
| 235 | - } |
|
| 236 | - |
|
| 237 | - foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) { |
|
| 238 | - if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) { |
|
| 239 | - $aliasedMethodName = str_replace($name, $alias, $blackListedMethod); |
|
| 240 | - $this->blackListedMethods[$aliasedMethodName] = $blackListedMethod; |
|
| 241 | - } |
|
| 242 | - } |
|
| 243 | - } |
|
| 244 | - |
|
| 245 | - private function checkBlackList($name, $errorCode, Node $node) { |
|
| 246 | - $lowerName = strtolower($name); |
|
| 247 | - |
|
| 248 | - if (isset($this->blackListedClassNames[$lowerName])) { |
|
| 249 | - $this->errors[]= [ |
|
| 250 | - 'disallowedToken' => $name, |
|
| 251 | - 'errorCode' => $errorCode, |
|
| 252 | - 'line' => $node->getLine(), |
|
| 253 | - 'reason' => $this->buildReason($this->blackListedClassNames[$lowerName], $errorCode) |
|
| 254 | - ]; |
|
| 255 | - } |
|
| 256 | - } |
|
| 257 | - |
|
| 258 | - private function checkBlackListConstant($class, $constantName, Node $node) { |
|
| 259 | - $name = $class . '::' . $constantName; |
|
| 260 | - $lowerName = strtolower($name); |
|
| 261 | - |
|
| 262 | - if (isset($this->blackListedConstants[$lowerName])) { |
|
| 263 | - $this->errors[]= [ |
|
| 264 | - 'disallowedToken' => $name, |
|
| 265 | - 'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, |
|
| 266 | - 'line' => $node->getLine(), |
|
| 267 | - 'reason' => $this->buildReason($this->blackListedConstants[$lowerName], CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED) |
|
| 268 | - ]; |
|
| 269 | - } |
|
| 270 | - } |
|
| 271 | - |
|
| 272 | - private function checkBlackListFunction($class, $functionName, Node $node) { |
|
| 273 | - $name = $class . '::' . $functionName; |
|
| 274 | - $lowerName = strtolower($name); |
|
| 275 | - |
|
| 276 | - if (isset($this->blackListedFunctions[$lowerName])) { |
|
| 277 | - $this->errors[]= [ |
|
| 278 | - 'disallowedToken' => $name, |
|
| 279 | - 'errorCode' => CodeChecker::STATIC_CALL_NOT_ALLOWED, |
|
| 280 | - 'line' => $node->getLine(), |
|
| 281 | - 'reason' => $this->buildReason($this->blackListedFunctions[$lowerName], CodeChecker::STATIC_CALL_NOT_ALLOWED) |
|
| 282 | - ]; |
|
| 283 | - } |
|
| 284 | - } |
|
| 285 | - |
|
| 286 | - private function checkBlackListMethod($class, $functionName, Node $node) { |
|
| 287 | - $name = $class . '::' . $functionName; |
|
| 288 | - $lowerName = strtolower($name); |
|
| 289 | - |
|
| 290 | - if (isset($this->blackListedMethods[$lowerName])) { |
|
| 291 | - $this->errors[]= [ |
|
| 292 | - 'disallowedToken' => $name, |
|
| 293 | - 'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED, |
|
| 294 | - 'line' => $node->getLine(), |
|
| 295 | - 'reason' => $this->buildReason($this->blackListedMethods[$lowerName], CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED) |
|
| 296 | - ]; |
|
| 297 | - } |
|
| 298 | - } |
|
| 299 | - |
|
| 300 | - private function buildReason($name, $errorCode) { |
|
| 301 | - if (isset($this->errorMessages[$errorCode])) { |
|
| 302 | - $desc = $this->list->getDescription($errorCode, $name); |
|
| 303 | - return sprintf($this->errorMessages[$errorCode], $desc); |
|
| 304 | - } |
|
| 305 | - |
|
| 306 | - return "$name usage not allowed - error: $errorCode"; |
|
| 307 | - } |
|
| 32 | + /** @var ICheck */ |
|
| 33 | + protected $list; |
|
| 34 | + |
|
| 35 | + /** @var string */ |
|
| 36 | + protected $blackListDescription; |
|
| 37 | + /** @var string[] */ |
|
| 38 | + protected $blackListedClassNames; |
|
| 39 | + /** @var string[] */ |
|
| 40 | + protected $blackListedConstants; |
|
| 41 | + /** @var string[] */ |
|
| 42 | + protected $blackListedFunctions; |
|
| 43 | + /** @var string[] */ |
|
| 44 | + protected $blackListedMethods; |
|
| 45 | + /** @var bool */ |
|
| 46 | + protected $checkEqualOperatorUsage; |
|
| 47 | + /** @var string[] */ |
|
| 48 | + protected $errorMessages; |
|
| 49 | + |
|
| 50 | + /** |
|
| 51 | + * @param ICheck $list |
|
| 52 | + */ |
|
| 53 | + public function __construct(ICheck $list) { |
|
| 54 | + $this->list = $list; |
|
| 55 | + |
|
| 56 | + $this->blackListedClassNames = []; |
|
| 57 | + foreach ($list->getClasses() as $class => $blackListInfo) { |
|
| 58 | + if (is_numeric($class) && is_string($blackListInfo)) { |
|
| 59 | + $class = $blackListInfo; |
|
| 60 | + $blackListInfo = null; |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + $class = strtolower($class); |
|
| 64 | + $this->blackListedClassNames[$class] = $class; |
|
| 65 | + } |
|
| 66 | + |
|
| 67 | + $this->blackListedConstants = []; |
|
| 68 | + foreach ($list->getConstants() as $constantName => $blackListInfo) { |
|
| 69 | + $constantName = strtolower($constantName); |
|
| 70 | + $this->blackListedConstants[$constantName] = $constantName; |
|
| 71 | + } |
|
| 72 | + |
|
| 73 | + $this->blackListedFunctions = []; |
|
| 74 | + foreach ($list->getFunctions() as $functionName => $blackListInfo) { |
|
| 75 | + $functionName = strtolower($functionName); |
|
| 76 | + $this->blackListedFunctions[$functionName] = $functionName; |
|
| 77 | + } |
|
| 78 | + |
|
| 79 | + $this->blackListedMethods = []; |
|
| 80 | + foreach ($list->getMethods() as $functionName => $blackListInfo) { |
|
| 81 | + $functionName = strtolower($functionName); |
|
| 82 | + $this->blackListedMethods[$functionName] = $functionName; |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + $this->checkEqualOperatorUsage = $list->checkStrongComparisons(); |
|
| 86 | + |
|
| 87 | + $this->errorMessages = [ |
|
| 88 | + CodeChecker::CLASS_EXTENDS_NOT_ALLOWED => "%s class must not be extended", |
|
| 89 | + CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED => "%s interface must not be implemented", |
|
| 90 | + CodeChecker::STATIC_CALL_NOT_ALLOWED => "Static method of %s class must not be called", |
|
| 91 | + CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED => "Constant of %s class must not not be fetched", |
|
| 92 | + CodeChecker::CLASS_NEW_NOT_ALLOWED => "%s class must not be instantiated", |
|
| 93 | + CodeChecker::CLASS_USE_NOT_ALLOWED => "%s class must not be imported with a use statement", |
|
| 94 | + CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED => "Method of %s class must not be called", |
|
| 95 | + |
|
| 96 | + CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED => "is discouraged", |
|
| 97 | + ]; |
|
| 98 | + } |
|
| 99 | + |
|
| 100 | + /** @var array */ |
|
| 101 | + public $errors = []; |
|
| 102 | + |
|
| 103 | + public function enterNode(Node $node) { |
|
| 104 | + if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\Equal) { |
|
| 105 | + $this->errors[]= [ |
|
| 106 | + 'disallowedToken' => '==', |
|
| 107 | + 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
|
| 108 | + 'line' => $node->getLine(), |
|
| 109 | + 'reason' => $this->buildReason('==', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED) |
|
| 110 | + ]; |
|
| 111 | + } |
|
| 112 | + if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\NotEqual) { |
|
| 113 | + $this->errors[]= [ |
|
| 114 | + 'disallowedToken' => '!=', |
|
| 115 | + 'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED, |
|
| 116 | + 'line' => $node->getLine(), |
|
| 117 | + 'reason' => $this->buildReason('!=', CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED) |
|
| 118 | + ]; |
|
| 119 | + } |
|
| 120 | + if ($node instanceof Node\Stmt\Class_) { |
|
| 121 | + if (!is_null($node->extends)) { |
|
| 122 | + $this->checkBlackList($node->extends->toString(), CodeChecker::CLASS_EXTENDS_NOT_ALLOWED, $node); |
|
| 123 | + } |
|
| 124 | + foreach ($node->implements as $implements) { |
|
| 125 | + $this->checkBlackList($implements->toString(), CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED, $node); |
|
| 126 | + } |
|
| 127 | + } |
|
| 128 | + if ($node instanceof Node\Expr\StaticCall) { |
|
| 129 | + if (!is_null($node->class)) { |
|
| 130 | + if ($node->class instanceof Name) { |
|
| 131 | + $this->checkBlackList($node->class->toString(), CodeChecker::STATIC_CALL_NOT_ALLOWED, $node); |
|
| 132 | + |
|
| 133 | + $this->checkBlackListFunction($node->class->toString(), $node->name, $node); |
|
| 134 | + $this->checkBlackListMethod($node->class->toString(), $node->name, $node); |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + if ($node->class instanceof Node\Expr\Variable) { |
|
| 138 | + /** |
|
| 139 | + * TODO: find a way to detect something like this: |
|
| 140 | + * $c = "OC_API"; |
|
| 141 | + * $n = $c::call(); |
|
| 142 | + */ |
|
| 143 | + // $this->checkBlackListMethod($node->class->..., $node->name, $node); |
|
| 144 | + } |
|
| 145 | + } |
|
| 146 | + } |
|
| 147 | + if ($node instanceof Node\Expr\MethodCall) { |
|
| 148 | + if (!is_null($node->var)) { |
|
| 149 | + if ($node->var instanceof Node\Expr\Variable) { |
|
| 150 | + /** |
|
| 151 | + * TODO: find a way to detect something like this: |
|
| 152 | + * $c = new OC_API(); |
|
| 153 | + * $n = $c::call(); |
|
| 154 | + * $n = $c->call(); |
|
| 155 | + */ |
|
| 156 | + // $this->checkBlackListMethod($node->var->..., $node->name, $node); |
|
| 157 | + } |
|
| 158 | + } |
|
| 159 | + } |
|
| 160 | + if ($node instanceof Node\Expr\ClassConstFetch) { |
|
| 161 | + if (!is_null($node->class)) { |
|
| 162 | + if ($node->class instanceof Name) { |
|
| 163 | + $this->checkBlackList($node->class->toString(), CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, $node); |
|
| 164 | + } |
|
| 165 | + if ($node->class instanceof Node\Expr\Variable || $node->class instanceof Node\Expr\PropertyFetch) { |
|
| 166 | + /** |
|
| 167 | + * TODO: find a way to detect something like this: |
|
| 168 | + * $c = "OC_API"; |
|
| 169 | + * $n = $i::ADMIN_AUTH; |
|
| 170 | + */ |
|
| 171 | + } else { |
|
| 172 | + $this->checkBlackListConstant($node->class->toString(), $node->name, $node); |
|
| 173 | + } |
|
| 174 | + } |
|
| 175 | + } |
|
| 176 | + if ($node instanceof Node\Expr\New_) { |
|
| 177 | + if (!is_null($node->class)) { |
|
| 178 | + if ($node->class instanceof Name) { |
|
| 179 | + $this->checkBlackList($node->class->toString(), CodeChecker::CLASS_NEW_NOT_ALLOWED, $node); |
|
| 180 | + } |
|
| 181 | + if ($node->class instanceof Node\Expr\Variable) { |
|
| 182 | + /** |
|
| 183 | + * TODO: find a way to detect something like this: |
|
| 184 | + * $c = "OC_API"; |
|
| 185 | + * $n = new $i; |
|
| 186 | + */ |
|
| 187 | + } |
|
| 188 | + } |
|
| 189 | + } |
|
| 190 | + if ($node instanceof Node\Stmt\UseUse) { |
|
| 191 | + $this->checkBlackList($node->name->toString(), CodeChecker::CLASS_USE_NOT_ALLOWED, $node); |
|
| 192 | + if ($node->alias) { |
|
| 193 | + $this->addUseNameToBlackList($node->name->toString(), $node->alias); |
|
| 194 | + } else { |
|
| 195 | + $this->addUseNameToBlackList($node->name->toString(), $node->name->getLast()); |
|
| 196 | + } |
|
| 197 | + } |
|
| 198 | + } |
|
| 199 | + |
|
| 200 | + /** |
|
| 201 | + * Check whether an alias was introduced for a namespace of a blacklisted class |
|
| 202 | + * |
|
| 203 | + * Example: |
|
| 204 | + * - Blacklist entry: OCP\AppFramework\IApi |
|
| 205 | + * - Name: OCP\AppFramework |
|
| 206 | + * - Alias: OAF |
|
| 207 | + * => new blacklist entry: OAF\IApi |
|
| 208 | + * |
|
| 209 | + * @param string $name |
|
| 210 | + * @param string $alias |
|
| 211 | + */ |
|
| 212 | + private function addUseNameToBlackList($name, $alias) { |
|
| 213 | + $name = strtolower($name); |
|
| 214 | + $alias = strtolower($alias); |
|
| 215 | + |
|
| 216 | + foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) { |
|
| 217 | + if (strpos($blackListedClassName, $name . '\\') === 0) { |
|
| 218 | + $aliasedClassName = str_replace($name, $alias, $blackListedClassName); |
|
| 219 | + $this->blackListedClassNames[$aliasedClassName] = $blackListedClassName; |
|
| 220 | + } |
|
| 221 | + } |
|
| 222 | + |
|
| 223 | + foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) { |
|
| 224 | + if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) { |
|
| 225 | + $aliasedConstantName = str_replace($name, $alias, $blackListedConstant); |
|
| 226 | + $this->blackListedConstants[$aliasedConstantName] = $blackListedConstant; |
|
| 227 | + } |
|
| 228 | + } |
|
| 229 | + |
|
| 230 | + foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) { |
|
| 231 | + if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) { |
|
| 232 | + $aliasedFunctionName = str_replace($name, $alias, $blackListedFunction); |
|
| 233 | + $this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction; |
|
| 234 | + } |
|
| 235 | + } |
|
| 236 | + |
|
| 237 | + foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) { |
|
| 238 | + if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) { |
|
| 239 | + $aliasedMethodName = str_replace($name, $alias, $blackListedMethod); |
|
| 240 | + $this->blackListedMethods[$aliasedMethodName] = $blackListedMethod; |
|
| 241 | + } |
|
| 242 | + } |
|
| 243 | + } |
|
| 244 | + |
|
| 245 | + private function checkBlackList($name, $errorCode, Node $node) { |
|
| 246 | + $lowerName = strtolower($name); |
|
| 247 | + |
|
| 248 | + if (isset($this->blackListedClassNames[$lowerName])) { |
|
| 249 | + $this->errors[]= [ |
|
| 250 | + 'disallowedToken' => $name, |
|
| 251 | + 'errorCode' => $errorCode, |
|
| 252 | + 'line' => $node->getLine(), |
|
| 253 | + 'reason' => $this->buildReason($this->blackListedClassNames[$lowerName], $errorCode) |
|
| 254 | + ]; |
|
| 255 | + } |
|
| 256 | + } |
|
| 257 | + |
|
| 258 | + private function checkBlackListConstant($class, $constantName, Node $node) { |
|
| 259 | + $name = $class . '::' . $constantName; |
|
| 260 | + $lowerName = strtolower($name); |
|
| 261 | + |
|
| 262 | + if (isset($this->blackListedConstants[$lowerName])) { |
|
| 263 | + $this->errors[]= [ |
|
| 264 | + 'disallowedToken' => $name, |
|
| 265 | + 'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED, |
|
| 266 | + 'line' => $node->getLine(), |
|
| 267 | + 'reason' => $this->buildReason($this->blackListedConstants[$lowerName], CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED) |
|
| 268 | + ]; |
|
| 269 | + } |
|
| 270 | + } |
|
| 271 | + |
|
| 272 | + private function checkBlackListFunction($class, $functionName, Node $node) { |
|
| 273 | + $name = $class . '::' . $functionName; |
|
| 274 | + $lowerName = strtolower($name); |
|
| 275 | + |
|
| 276 | + if (isset($this->blackListedFunctions[$lowerName])) { |
|
| 277 | + $this->errors[]= [ |
|
| 278 | + 'disallowedToken' => $name, |
|
| 279 | + 'errorCode' => CodeChecker::STATIC_CALL_NOT_ALLOWED, |
|
| 280 | + 'line' => $node->getLine(), |
|
| 281 | + 'reason' => $this->buildReason($this->blackListedFunctions[$lowerName], CodeChecker::STATIC_CALL_NOT_ALLOWED) |
|
| 282 | + ]; |
|
| 283 | + } |
|
| 284 | + } |
|
| 285 | + |
|
| 286 | + private function checkBlackListMethod($class, $functionName, Node $node) { |
|
| 287 | + $name = $class . '::' . $functionName; |
|
| 288 | + $lowerName = strtolower($name); |
|
| 289 | + |
|
| 290 | + if (isset($this->blackListedMethods[$lowerName])) { |
|
| 291 | + $this->errors[]= [ |
|
| 292 | + 'disallowedToken' => $name, |
|
| 293 | + 'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED, |
|
| 294 | + 'line' => $node->getLine(), |
|
| 295 | + 'reason' => $this->buildReason($this->blackListedMethods[$lowerName], CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED) |
|
| 296 | + ]; |
|
| 297 | + } |
|
| 298 | + } |
|
| 299 | + |
|
| 300 | + private function buildReason($name, $errorCode) { |
|
| 301 | + if (isset($this->errorMessages[$errorCode])) { |
|
| 302 | + $desc = $this->list->getDescription($errorCode, $name); |
|
| 303 | + return sprintf($this->errorMessages[$errorCode], $desc); |
|
| 304 | + } |
|
| 305 | + |
|
| 306 | + return "$name usage not allowed - error: $errorCode"; |
|
| 307 | + } |
|
| 308 | 308 | } |