nextcloud / server

lib/private/DB/MDB2SchemaWriter.php

Indentation +140 added lines, -140 removed lines

@@ -31,153 +31,153 @@
 
 class MDB2SchemaWriter {
 
-	/**
-	 * @param string $file
-	 * @param \OC\DB\Connection $conn
-	 * @return bool
-	 */
-	static public function saveSchemaToFile($file, \OC\DB\Connection $conn) {
-		$config = \OC::$server->getConfig();
+    /**
+     * @param string $file
+     * @param \OC\DB\Connection $conn
+     * @return bool
+     */
+    static public function saveSchemaToFile($file, \OC\DB\Connection $conn) {
+        $config = \OC::$server->getConfig();
 
-		$xml = new \SimpleXMLElement('<database/>');
-		$xml->addChild('name', $config->getSystemValue('dbname', 'owncloud'));
-		$xml->addChild('create', 'true');
-		$xml->addChild('overwrite', 'false');
-		if($config->getSystemValue('dbtype', 'sqlite') === 'mysql' && $config->getSystemValue('mysql.utf8mb4', false)) {
-			$xml->addChild('charset', 'utf8mb4');
-		} else {
-			$xml->addChild('charset', 'utf8');
-		}
+        $xml = new \SimpleXMLElement('<database/>');
+        $xml->addChild('name', $config->getSystemValue('dbname', 'owncloud'));
+        $xml->addChild('create', 'true');
+        $xml->addChild('overwrite', 'false');
+        if($config->getSystemValue('dbtype', 'sqlite') === 'mysql' && $config->getSystemValue('mysql.utf8mb4', false)) {
+            $xml->addChild('charset', 'utf8mb4');
+        } else {
+            $xml->addChild('charset', 'utf8');
+        }
 
-		// FIX ME: bloody work around
-		if ($config->getSystemValue('dbtype', 'sqlite') === 'oci') {
-			$filterExpression = '/^"' . preg_quote($conn->getPrefix()) . '/';
-		} else {
-			$filterExpression = '/^' . preg_quote($conn->getPrefix()) . '/';
-		}
-		$conn->getConfiguration()->setFilterSchemaAssetsExpression($filterExpression);
+        // FIX ME: bloody work around
+        if ($config->getSystemValue('dbtype', 'sqlite') === 'oci') {
+            $filterExpression = '/^"' . preg_quote($conn->getPrefix()) . '/';
+        } else {
+            $filterExpression = '/^' . preg_quote($conn->getPrefix()) . '/';
+        }
+        $conn->getConfiguration()->setFilterSchemaAssetsExpression($filterExpression);
 
-		foreach ($conn->getSchemaManager()->listTables() as $table) {
-			self::saveTable($table, $xml->addChild('table'));
-		}
-		file_put_contents($file, $xml->asXML());
-		return true;
-	}
+        foreach ($conn->getSchemaManager()->listTables() as $table) {
+            self::saveTable($table, $xml->addChild('table'));
+        }
+        file_put_contents($file, $xml->asXML());
+        return true;
+    }
 
-	/**
-	 * @param \Doctrine\DBAL\Schema\Table $table
-	 * @param \SimpleXMLElement $xml
-	 */
-	private static function saveTable($table, $xml) {
-		$xml->addChild('name', $table->getName());
-		$declaration = $xml->addChild('declaration');
-		foreach($table->getColumns() as $column) {
-			self::saveColumn($column, $declaration->addChild('field'));
-		}
-		foreach($table->getIndexes() as $index) {
-			if ($index->getName() == 'PRIMARY') {
-				$autoincrement = false;
-				foreach($index->getColumns() as $column) {
-					if ($table->getColumn($column)->getAutoincrement()) {
-						$autoincrement = true;
-					}
-				}
-				if ($autoincrement) {
-					continue;
-				}
-			}
-			self::saveIndex($index, $declaration->addChild('index'));
-		}
-	}
+    /**
+     * @param \Doctrine\DBAL\Schema\Table $table
+     * @param \SimpleXMLElement $xml
+     */
+    private static function saveTable($table, $xml) {
+        $xml->addChild('name', $table->getName());
+        $declaration = $xml->addChild('declaration');
+        foreach($table->getColumns() as $column) {
+            self::saveColumn($column, $declaration->addChild('field'));
+        }
+        foreach($table->getIndexes() as $index) {
+            if ($index->getName() == 'PRIMARY') {
+                $autoincrement = false;
+                foreach($index->getColumns() as $column) {
+                    if ($table->getColumn($column)->getAutoincrement()) {
+                        $autoincrement = true;
+                    }
+                }
+                if ($autoincrement) {
+                    continue;
+                }
+            }
+            self::saveIndex($index, $declaration->addChild('index'));
+        }
+    }
 
-	/**
-	 * @param Column $column
-	 * @param \SimpleXMLElement $xml
-	 */
-	private static function saveColumn($column, $xml) {
-		$xml->addChild('name', $column->getName());
-		switch($column->getType()) {
-			case 'SmallInt':
-			case 'Integer':
-			case 'BigInt':
-				$xml->addChild('type', 'integer');
-				$default = $column->getDefault();
-				if (is_null($default) && $column->getAutoincrement()) {
-					$default = '0';
-				}
-				$xml->addChild('default', $default);
-				$xml->addChild('notnull', self::toBool($column->getNotnull()));
-				if ($column->getAutoincrement()) {
-					$xml->addChild('autoincrement', '1');
-				}
-				if ($column->getUnsigned()) {
-					$xml->addChild('unsigned', 'true');
-				}
-				$length = '4';
-				if ($column->getType() == 'SmallInt') {
-					$length = '2';
-				}
-				elseif ($column->getType() == 'BigInt') {
-					$length = '8';
-				}
-				$xml->addChild('length', $length);
-				break;
-			case 'String':
-				$xml->addChild('type', 'text');
-				$default = trim($column->getDefault());
-				if ($default === '') {
-					$default = false;
-				}
-				$xml->addChild('default', $default);
-				$xml->addChild('notnull', self::toBool($column->getNotnull()));
-				$xml->addChild('length', $column->getLength());
-				break;
-			case 'Text':
-				$xml->addChild('type', 'clob');
-				$xml->addChild('notnull', self::toBool($column->getNotnull()));
-				break;
-			case 'Decimal':
-				$xml->addChild('type', 'decimal');
-				$xml->addChild('default', $column->getDefault());
-				$xml->addChild('notnull', self::toBool($column->getNotnull()));
-				$xml->addChild('length', '15');
-				break;
-			case 'Boolean':
-				$xml->addChild('type', 'integer');
-				$xml->addChild('default', $column->getDefault());
-				$xml->addChild('notnull', self::toBool($column->getNotnull()));
-				$xml->addChild('length', '1');
-				break;
-			case 'DateTime':
-				$xml->addChild('type', 'timestamp');
-				$xml->addChild('default', $column->getDefault());
-				$xml->addChild('notnull', self::toBool($column->getNotnull()));
-				break;
+    /**
+     * @param Column $column
+     * @param \SimpleXMLElement $xml
+     */
+    private static function saveColumn($column, $xml) {
+        $xml->addChild('name', $column->getName());
+        switch($column->getType()) {
+            case 'SmallInt':
+            case 'Integer':
+            case 'BigInt':
+                $xml->addChild('type', 'integer');
+                $default = $column->getDefault();
+                if (is_null($default) && $column->getAutoincrement()) {
+                    $default = '0';
+                }
+                $xml->addChild('default', $default);
+                $xml->addChild('notnull', self::toBool($column->getNotnull()));
+                if ($column->getAutoincrement()) {
+                    $xml->addChild('autoincrement', '1');
+                }
+                if ($column->getUnsigned()) {
+                    $xml->addChild('unsigned', 'true');
+                }
+                $length = '4';
+                if ($column->getType() == 'SmallInt') {
+                    $length = '2';
+                }
+                elseif ($column->getType() == 'BigInt') {
+                    $length = '8';
+                }
+                $xml->addChild('length', $length);
+                break;
+            case 'String':
+                $xml->addChild('type', 'text');
+                $default = trim($column->getDefault());
+                if ($default === '') {
+                    $default = false;
+                }
+                $xml->addChild('default', $default);
+                $xml->addChild('notnull', self::toBool($column->getNotnull()));
+                $xml->addChild('length', $column->getLength());
+                break;
+            case 'Text':
+                $xml->addChild('type', 'clob');
+                $xml->addChild('notnull', self::toBool($column->getNotnull()));
+                break;
+            case 'Decimal':
+                $xml->addChild('type', 'decimal');
+                $xml->addChild('default', $column->getDefault());
+                $xml->addChild('notnull', self::toBool($column->getNotnull()));
+                $xml->addChild('length', '15');
+                break;
+            case 'Boolean':
+                $xml->addChild('type', 'integer');
+                $xml->addChild('default', $column->getDefault());
+                $xml->addChild('notnull', self::toBool($column->getNotnull()));
+                $xml->addChild('length', '1');
+                break;
+            case 'DateTime':
+                $xml->addChild('type', 'timestamp');
+                $xml->addChild('default', $column->getDefault());
+                $xml->addChild('notnull', self::toBool($column->getNotnull()));
+                break;
 
-		}
-	}
+        }
+    }
 
-	/**
-	 * @param Index $index
-	 * @param \SimpleXMLElement $xml
-	 */
-	private static function saveIndex($index, $xml) {
-		$xml->addChild('name', $index->getName());
-		if ($index->isPrimary()) {
-			$xml->addChild('primary', 'true');
-		}
-		elseif ($index->isUnique()) {
-			$xml->addChild('unique', 'true');
-		}
-		foreach($index->getColumns() as $column) {
-			$field = $xml->addChild('field');
-			$field->addChild('name', $column);
-			$field->addChild('sorting', 'ascending');
+    /**
+     * @param Index $index
+     * @param \SimpleXMLElement $xml
+     */
+    private static function saveIndex($index, $xml) {
+        $xml->addChild('name', $index->getName());
+        if ($index->isPrimary()) {
+            $xml->addChild('primary', 'true');
+        }
+        elseif ($index->isUnique()) {
+            $xml->addChild('unique', 'true');
+        }
+        foreach($index->getColumns() as $column) {
+            $field = $xml->addChild('field');
+            $field->addChild('name', $column);
+            $field->addChild('sorting', 'ascending');
 			
-		}
-	}
+        }
+    }
 
-	private static function toBool($bool) {
-		return $bool ? 'true' : 'false';
-	}
+    private static function toBool($bool) {
+        return $bool ? 'true' : 'false';
+    }
 }

Spacing +8 added lines, -8 removed lines

@@ -43,7 +43,7 @@ 
 		$xml->addChild('name', $config->getSystemValue('dbname', 'owncloud'));
 		$xml->addChild('create', 'true');
 		$xml->addChild('overwrite', 'false');
-		if($config->getSystemValue('dbtype', 'sqlite') === 'mysql' && $config->getSystemValue('mysql.utf8mb4', false)) {
+		if ($config->getSystemValue('dbtype', 'sqlite') === 'mysql' && $config->getSystemValue('mysql.utf8mb4', false)) {
 			$xml->addChild('charset', 'utf8mb4');
 		} else {
 			$xml->addChild('charset', 'utf8');
@@ -51,9 +51,9 @@ 
 
 		// FIX ME: bloody work around
 		if ($config->getSystemValue('dbtype', 'sqlite') === 'oci') {
-			$filterExpression = '/^"' . preg_quote($conn->getPrefix()) . '/';
+			$filterExpression = '/^"'.preg_quote($conn->getPrefix()).'/';
 		} else {
-			$filterExpression = '/^' . preg_quote($conn->getPrefix()) . '/';
+			$filterExpression = '/^'.preg_quote($conn->getPrefix()).'/';
 		}
 		$conn->getConfiguration()->setFilterSchemaAssetsExpression($filterExpression);
 
@@ -71,13 +71,13 @@ 
 	private static function saveTable($table, $xml) {
 		$xml->addChild('name', $table->getName());
 		$declaration = $xml->addChild('declaration');
-		foreach($table->getColumns() as $column) {
+		foreach ($table->getColumns() as $column) {
 			self::saveColumn($column, $declaration->addChild('field'));
 		}
-		foreach($table->getIndexes() as $index) {
+		foreach ($table->getIndexes() as $index) {
 			if ($index->getName() == 'PRIMARY') {
 				$autoincrement = false;
-				foreach($index->getColumns() as $column) {
+				foreach ($index->getColumns() as $column) {
 					if ($table->getColumn($column)->getAutoincrement()) {
 						$autoincrement = true;
 					}
@@ -96,7 +96,7 @@ 
 	 */
 	private static function saveColumn($column, $xml) {
 		$xml->addChild('name', $column->getName());
-		switch($column->getType()) {
+		switch ($column->getType()) {
 			case 'SmallInt':
 			case 'Integer':
 			case 'BigInt':
@@ -169,7 +169,7 @@ 
 		elseif ($index->isUnique()) {
 			$xml->addChild('unique', 'true');
 		}
-		foreach($index->getColumns() as $column) {
+		foreach ($index->getColumns() as $column) {
 			$field = $xml->addChild('field');
 			$field->addChild('name', $column);
 			$field->addChild('sorting', 'ascending');

Braces +2 added lines, -4 removed lines

@@ -116,8 +116,7 @@ 
 				$length = '4';
 				if ($column->getType() == 'SmallInt') {
 					$length = '2';
-				}
-				elseif ($column->getType() == 'BigInt') {
+				} elseif ($column->getType() == 'BigInt') {
 					$length = '8';
 				}
 				$xml->addChild('length', $length);
@@ -165,8 +164,7 @@ 
 		$xml->addChild('name', $index->getName());
 		if ($index->isPrimary()) {
 			$xml->addChild('primary', 'true');
-		}
-		elseif ($index->isUnique()) {
+		} elseif ($index->isUnique()) {
 			$xml->addChild('unique', 'true');
 		}
 		foreach($index->getColumns() as $column) {

lib/private/DB/Migrator.php

Spacing +11 added lines, -11 removed lines

@@ -137,7 +137,7 @@ 
 	 * @return string
 	 */
 	protected function generateTemporaryTableName($name) {
-		return $this->config->getSystemValue('dbtableprefix', 'oc_') . $name . '_' . $this->random->generate(13, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS);
+		return $this->config->getSystemValue('dbtableprefix', 'oc_').$name.'_'.$this->random->generate(13, ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_DIGITS);
 	}
 
 	/**
@@ -188,7 +188,7 @@ 
 				$indexName = $index->getName();
 			} else {
 				// avoid conflicts in index names
-				$indexName = $this->config->getSystemValue('dbtableprefix', 'oc_') . $this->random->generate(13, ISecureRandom::CHAR_LOWER);
+				$indexName = $this->config->getSystemValue('dbtableprefix', 'oc_').$this->random->generate(13, ISecureRandom::CHAR_LOWER);
 			}
 			$newIndexes[] = new Index($indexName, $index->getColumns(), $index->isUnique(), $index->isPrimary());
 		}
@@ -268,15 +268,15 @@ 
 		$quotedSource = $this->connection->quoteIdentifier($sourceName);
 		$quotedTarget = $this->connection->quoteIdentifier($targetName);
 
-		$this->connection->exec('CREATE TABLE ' . $quotedTarget . ' (LIKE ' . $quotedSource . ')');
-		$this->connection->exec('INSERT INTO ' . $quotedTarget . ' SELECT * FROM ' . $quotedSource);
+		$this->connection->exec('CREATE TABLE '.$quotedTarget.' (LIKE '.$quotedSource.')');
+		$this->connection->exec('INSERT INTO '.$quotedTarget.' SELECT * FROM '.$quotedSource);
 	}
 
 	/**
 	 * @param string $name
 	 */
 	protected function dropTable($name) {
-		$this->connection->exec('DROP TABLE ' . $this->connection->quoteIdentifier($name));
+		$this->connection->exec('DROP TABLE '.$this->connection->quoteIdentifier($name));
 	}
 
 	/**
@@ -284,30 +284,30 @@ 
 	 * @return string
 	 */
 	protected function convertStatementToScript($statement) {
-		$script = $statement . ';';
+		$script = $statement.';';
 		$script .= PHP_EOL;
 		$script .= PHP_EOL;
 		return $script;
 	}
 
 	protected function getFilterExpression() {
-		return '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
+		return '/^'.preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')).'/';
 	}
 
 	protected function emit($sql, $step, $max) {
 		if ($this->noEmit) {
 			return;
 		}
-		if(is_null($this->dispatcher)) {
+		if (is_null($this->dispatcher)) {
 			return;
 		}
-		$this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step+1, $max]));
+		$this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step + 1, $max]));
 	}
 
 	private function emitCheckStep($tableName, $step, $max) {
-		if(is_null($this->dispatcher)) {
+		if (is_null($this->dispatcher)) {
 			return;
 		}
-		$this->dispatcher->dispatch('\OC\DB\Migrator::checkTable', new GenericEvent($tableName, [$step+1, $max]));
+		$this->dispatcher->dispatch('\OC\DB\Migrator::checkTable', new GenericEvent($tableName, [$step + 1, $max]));
 	}
 }

Indentation +268 added lines, -268 removed lines

@@ -44,272 +44,272 @@
 
 class Migrator {
 
-	/** @var \Doctrine\DBAL\Connection */
-	protected $connection;
-
-	/** @var ISecureRandom */
-	private $random;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var EventDispatcherInterface  */
-	private $dispatcher;
-
-	/** @var bool */
-	private $noEmit = false;
-
-	/**
-	 * @param \Doctrine\DBAL\Connection|Connection $connection
-	 * @param ISecureRandom $random
-	 * @param IConfig $config
-	 * @param EventDispatcherInterface $dispatcher
-	 */
-	public function __construct(\Doctrine\DBAL\Connection $connection,
-								ISecureRandom $random,
-								IConfig $config,
-								EventDispatcherInterface $dispatcher = null) {
-		$this->connection = $connection;
-		$this->random = $random;
-		$this->config = $config;
-		$this->dispatcher = $dispatcher;
-	}
-
-	/**
-	 * @param \Doctrine\DBAL\Schema\Schema $targetSchema
-	 */
-	public function migrate(Schema $targetSchema) {
-		$this->noEmit = true;
-		$this->applySchema($targetSchema);
-	}
-
-	/**
-	 * @param \Doctrine\DBAL\Schema\Schema $targetSchema
-	 * @return string
-	 */
-	public function generateChangeScript(Schema $targetSchema) {
-		$schemaDiff = $this->getDiff($targetSchema, $this->connection);
-
-		$script = '';
-		$sqls = $schemaDiff->toSql($this->connection->getDatabasePlatform());
-		foreach ($sqls as $sql) {
-			$script .= $this->convertStatementToScript($sql);
-		}
-
-		return $script;
-	}
-
-	/**
-	 * @param Schema $targetSchema
-	 * @throws \OC\DB\MigrationException
-	 */
-	public function checkMigrate(Schema $targetSchema) {
-		$this->noEmit = true;
-		/**@var \Doctrine\DBAL\Schema\Table[] $tables */
-		$tables = $targetSchema->getTables();
-		$filterExpression = $this->getFilterExpression();
-		$this->connection->getConfiguration()->
-			setFilterSchemaAssetsExpression($filterExpression);
-		$existingTables = $this->connection->getSchemaManager()->listTableNames();
-
-		$step = 0;
-		foreach ($tables as $table) {
-			if (strpos($table->getName(), '.')) {
-				list(, $tableName) = explode('.', $table->getName());
-			} else {
-				$tableName = $table->getName();
-			}
-			$this->emitCheckStep($tableName, $step++, count($tables));
-			// don't need to check for new tables
-			if (array_search($tableName, $existingTables) !== false) {
-				$this->checkTableMigrate($table);
-			}
-		}
-	}
-
-	/**
-	 * Create a unique name for the temporary table
-	 *
-	 * @param string $name
-	 * @return string
-	 */
-	protected function generateTemporaryTableName($name) {
-		return $this->config->getSystemValue('dbtableprefix', 'oc_') . $name . '_' . $this->random->generate(13, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS);
-	}
-
-	/**
-	 * Check the migration of a table on a copy so we can detect errors before messing with the real table
-	 *
-	 * @param \Doctrine\DBAL\Schema\Table $table
-	 * @throws \OC\DB\MigrationException
-	 */
-	protected function checkTableMigrate(Table $table) {
-		$name = $table->getName();
-		$tmpName = $this->generateTemporaryTableName($name);
-
-		$this->copyTable($name, $tmpName);
-
-		//create the migration schema for the temporary table
-		$tmpTable = $this->renameTableSchema($table, $tmpName);
-		$schemaConfig = new SchemaConfig();
-		$schemaConfig->setName($this->connection->getDatabase());
-		$schema = new Schema(array($tmpTable), array(), $schemaConfig);
-
-		try {
-			$this->applySchema($schema);
-			$this->dropTable($tmpName);
-		} catch (DBALException $e) {
-			// pgsql needs to commit it's failed transaction before doing anything else
-			if ($this->connection->isTransactionActive()) {
-				$this->connection->commit();
-			}
-			$this->dropTable($tmpName);
-			throw new MigrationException($table->getName(), $e->getMessage());
-		}
-	}
-
-	/**
-	 * @param \Doctrine\DBAL\Schema\Table $table
-	 * @param string $newName
-	 * @return \Doctrine\DBAL\Schema\Table
-	 */
-	protected function renameTableSchema(Table $table, $newName) {
-		/**
-		 * @var \Doctrine\DBAL\Schema\Index[] $indexes
-		 */
-		$indexes = $table->getIndexes();
-		$newIndexes = array();
-		foreach ($indexes as $index) {
-			if ($index->isPrimary()) {
-				// do not rename primary key
-				$indexName = $index->getName();
-			} else {
-				// avoid conflicts in index names
-				$indexName = $this->config->getSystemValue('dbtableprefix', 'oc_') . $this->random->generate(13, ISecureRandom::CHAR_LOWER);
-			}
-			$newIndexes[] = new Index($indexName, $index->getColumns(), $index->isUnique(), $index->isPrimary());
-		}
-
-		// foreign keys are not supported so we just set it to an empty array
-		return new Table($newName, $table->getColumns(), $newIndexes, array(), 0, $table->getOptions());
-	}
-
-	public function createSchema() {
-		$filterExpression = $this->getFilterExpression();
-		$this->connection->getConfiguration()->setFilterSchemaAssetsExpression($filterExpression);
-		return $this->connection->getSchemaManager()->createSchema();
-	}
-
-	/**
-	 * @param Schema $targetSchema
-	 * @param \Doctrine\DBAL\Connection $connection
-	 * @return \Doctrine\DBAL\Schema\SchemaDiff
-	 * @throws DBALException
-	 */
-	protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
-		// adjust varchar columns with a length higher then getVarcharMaxLength to clob
-		foreach ($targetSchema->getTables() as $table) {
-			foreach ($table->getColumns() as $column) {
-				if ($column->getType() instanceof StringType) {
-					if ($column->getLength() > $connection->getDatabasePlatform()->getVarcharMaxLength()) {
-						$column->setType(Type::getType('text'));
-						$column->setLength(null);
-					}
-				}
-			}
-		}
-
-		$filterExpression = $this->getFilterExpression();
-		$this->connection->getConfiguration()->setFilterSchemaAssetsExpression($filterExpression);
-		$sourceSchema = $connection->getSchemaManager()->createSchema();
-
-		// remove tables we don't know about
-		/** @var $table \Doctrine\DBAL\Schema\Table */
-		foreach ($sourceSchema->getTables() as $table) {
-			if (!$targetSchema->hasTable($table->getName())) {
-				$sourceSchema->dropTable($table->getName());
-			}
-		}
-		// remove sequences we don't know about
-		foreach ($sourceSchema->getSequences() as $table) {
-			if (!$targetSchema->hasSequence($table->getName())) {
-				$sourceSchema->dropSequence($table->getName());
-			}
-		}
-
-		$comparator = new Comparator();
-		return $comparator->compare($sourceSchema, $targetSchema);
-	}
-
-	/**
-	 * @param \Doctrine\DBAL\Schema\Schema $targetSchema
-	 * @param \Doctrine\DBAL\Connection $connection
-	 */
-	protected function applySchema(Schema $targetSchema, \Doctrine\DBAL\Connection $connection = null) {
-		if (is_null($connection)) {
-			$connection = $this->connection;
-		}
-
-		$schemaDiff = $this->getDiff($targetSchema, $connection);
-
-		$connection->beginTransaction();
-		$sqls = $schemaDiff->toSql($connection->getDatabasePlatform());
-		$step = 0;
-		foreach ($sqls as $sql) {
-			$this->emit($sql, $step++, count($sqls));
-			$connection->query($sql);
-		}
-		$connection->commit();
-	}
-
-	/**
-	 * @param string $sourceName
-	 * @param string $targetName
-	 */
-	protected function copyTable($sourceName, $targetName) {
-		$quotedSource = $this->connection->quoteIdentifier($sourceName);
-		$quotedTarget = $this->connection->quoteIdentifier($targetName);
-
-		$this->connection->exec('CREATE TABLE ' . $quotedTarget . ' (LIKE ' . $quotedSource . ')');
-		$this->connection->exec('INSERT INTO ' . $quotedTarget . ' SELECT * FROM ' . $quotedSource);
-	}
-
-	/**
-	 * @param string $name
-	 */
-	protected function dropTable($name) {
-		$this->connection->exec('DROP TABLE ' . $this->connection->quoteIdentifier($name));
-	}
-
-	/**
-	 * @param $statement
-	 * @return string
-	 */
-	protected function convertStatementToScript($statement) {
-		$script = $statement . ';';
-		$script .= PHP_EOL;
-		$script .= PHP_EOL;
-		return $script;
-	}
-
-	protected function getFilterExpression() {
-		return '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
-	}
-
-	protected function emit($sql, $step, $max) {
-		if ($this->noEmit) {
-			return;
-		}
-		if(is_null($this->dispatcher)) {
-			return;
-		}
-		$this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step+1, $max]));
-	}
-
-	private function emitCheckStep($tableName, $step, $max) {
-		if(is_null($this->dispatcher)) {
-			return;
-		}
-		$this->dispatcher->dispatch('\OC\DB\Migrator::checkTable', new GenericEvent($tableName, [$step+1, $max]));
-	}
+    /** @var \Doctrine\DBAL\Connection */
+    protected $connection;
+
+    /** @var ISecureRandom */
+    private $random;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var EventDispatcherInterface  */
+    private $dispatcher;
+
+    /** @var bool */
+    private $noEmit = false;
+
+    /**
+     * @param \Doctrine\DBAL\Connection|Connection $connection
+     * @param ISecureRandom $random
+     * @param IConfig $config
+     * @param EventDispatcherInterface $dispatcher
+     */
+    public function __construct(\Doctrine\DBAL\Connection $connection,
+                                ISecureRandom $random,
+                                IConfig $config,
+                                EventDispatcherInterface $dispatcher = null) {
+        $this->connection = $connection;
+        $this->random = $random;
+        $this->config = $config;
+        $this->dispatcher = $dispatcher;
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $targetSchema
+     */
+    public function migrate(Schema $targetSchema) {
+        $this->noEmit = true;
+        $this->applySchema($targetSchema);
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $targetSchema
+     * @return string
+     */
+    public function generateChangeScript(Schema $targetSchema) {
+        $schemaDiff = $this->getDiff($targetSchema, $this->connection);
+
+        $script = '';
+        $sqls = $schemaDiff->toSql($this->connection->getDatabasePlatform());
+        foreach ($sqls as $sql) {
+            $script .= $this->convertStatementToScript($sql);
+        }
+
+        return $script;
+    }
+
+    /**
+     * @param Schema $targetSchema
+     * @throws \OC\DB\MigrationException
+     */
+    public function checkMigrate(Schema $targetSchema) {
+        $this->noEmit = true;
+        /**@var \Doctrine\DBAL\Schema\Table[] $tables */
+        $tables = $targetSchema->getTables();
+        $filterExpression = $this->getFilterExpression();
+        $this->connection->getConfiguration()->
+            setFilterSchemaAssetsExpression($filterExpression);
+        $existingTables = $this->connection->getSchemaManager()->listTableNames();
+
+        $step = 0;
+        foreach ($tables as $table) {
+            if (strpos($table->getName(), '.')) {
+                list(, $tableName) = explode('.', $table->getName());
+            } else {
+                $tableName = $table->getName();
+            }
+            $this->emitCheckStep($tableName, $step++, count($tables));
+            // don't need to check for new tables
+            if (array_search($tableName, $existingTables) !== false) {
+                $this->checkTableMigrate($table);
+            }
+        }
+    }
+
+    /**
+     * Create a unique name for the temporary table
+     *
+     * @param string $name
+     * @return string
+     */
+    protected function generateTemporaryTableName($name) {
+        return $this->config->getSystemValue('dbtableprefix', 'oc_') . $name . '_' . $this->random->generate(13, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS);
+    }
+
+    /**
+     * Check the migration of a table on a copy so we can detect errors before messing with the real table
+     *
+     * @param \Doctrine\DBAL\Schema\Table $table
+     * @throws \OC\DB\MigrationException
+     */
+    protected function checkTableMigrate(Table $table) {
+        $name = $table->getName();
+        $tmpName = $this->generateTemporaryTableName($name);
+
+        $this->copyTable($name, $tmpName);
+
+        //create the migration schema for the temporary table
+        $tmpTable = $this->renameTableSchema($table, $tmpName);
+        $schemaConfig = new SchemaConfig();
+        $schemaConfig->setName($this->connection->getDatabase());
+        $schema = new Schema(array($tmpTable), array(), $schemaConfig);
+
+        try {
+            $this->applySchema($schema);
+            $this->dropTable($tmpName);
+        } catch (DBALException $e) {
+            // pgsql needs to commit it's failed transaction before doing anything else
+            if ($this->connection->isTransactionActive()) {
+                $this->connection->commit();
+            }
+            $this->dropTable($tmpName);
+            throw new MigrationException($table->getName(), $e->getMessage());
+        }
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Table $table
+     * @param string $newName
+     * @return \Doctrine\DBAL\Schema\Table
+     */
+    protected function renameTableSchema(Table $table, $newName) {
+        /**
+         * @var \Doctrine\DBAL\Schema\Index[] $indexes
+         */
+        $indexes = $table->getIndexes();
+        $newIndexes = array();
+        foreach ($indexes as $index) {
+            if ($index->isPrimary()) {
+                // do not rename primary key
+                $indexName = $index->getName();
+            } else {
+                // avoid conflicts in index names
+                $indexName = $this->config->getSystemValue('dbtableprefix', 'oc_') . $this->random->generate(13, ISecureRandom::CHAR_LOWER);
+            }
+            $newIndexes[] = new Index($indexName, $index->getColumns(), $index->isUnique(), $index->isPrimary());
+        }
+
+        // foreign keys are not supported so we just set it to an empty array
+        return new Table($newName, $table->getColumns(), $newIndexes, array(), 0, $table->getOptions());
+    }
+
+    public function createSchema() {
+        $filterExpression = $this->getFilterExpression();
+        $this->connection->getConfiguration()->setFilterSchemaAssetsExpression($filterExpression);
+        return $this->connection->getSchemaManager()->createSchema();
+    }
+
+    /**
+     * @param Schema $targetSchema
+     * @param \Doctrine\DBAL\Connection $connection
+     * @return \Doctrine\DBAL\Schema\SchemaDiff
+     * @throws DBALException
+     */
+    protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
+        // adjust varchar columns with a length higher then getVarcharMaxLength to clob
+        foreach ($targetSchema->getTables() as $table) {
+            foreach ($table->getColumns() as $column) {
+                if ($column->getType() instanceof StringType) {
+                    if ($column->getLength() > $connection->getDatabasePlatform()->getVarcharMaxLength()) {
+                        $column->setType(Type::getType('text'));
+                        $column->setLength(null);
+                    }
+                }
+            }
+        }
+
+        $filterExpression = $this->getFilterExpression();
+        $this->connection->getConfiguration()->setFilterSchemaAssetsExpression($filterExpression);
+        $sourceSchema = $connection->getSchemaManager()->createSchema();
+
+        // remove tables we don't know about
+        /** @var $table \Doctrine\DBAL\Schema\Table */
+        foreach ($sourceSchema->getTables() as $table) {
+            if (!$targetSchema->hasTable($table->getName())) {
+                $sourceSchema->dropTable($table->getName());
+            }
+        }
+        // remove sequences we don't know about
+        foreach ($sourceSchema->getSequences() as $table) {
+            if (!$targetSchema->hasSequence($table->getName())) {
+                $sourceSchema->dropSequence($table->getName());
+            }
+        }
+
+        $comparator = new Comparator();
+        return $comparator->compare($sourceSchema, $targetSchema);
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $targetSchema
+     * @param \Doctrine\DBAL\Connection $connection
+     */
+    protected function applySchema(Schema $targetSchema, \Doctrine\DBAL\Connection $connection = null) {
+        if (is_null($connection)) {
+            $connection = $this->connection;
+        }
+
+        $schemaDiff = $this->getDiff($targetSchema, $connection);
+
+        $connection->beginTransaction();
+        $sqls = $schemaDiff->toSql($connection->getDatabasePlatform());
+        $step = 0;
+        foreach ($sqls as $sql) {
+            $this->emit($sql, $step++, count($sqls));
+            $connection->query($sql);
+        }
+        $connection->commit();
+    }
+
+    /**
+     * @param string $sourceName
+     * @param string $targetName
+     */
+    protected function copyTable($sourceName, $targetName) {
+        $quotedSource = $this->connection->quoteIdentifier($sourceName);
+        $quotedTarget = $this->connection->quoteIdentifier($targetName);
+
+        $this->connection->exec('CREATE TABLE ' . $quotedTarget . ' (LIKE ' . $quotedSource . ')');
+        $this->connection->exec('INSERT INTO ' . $quotedTarget . ' SELECT * FROM ' . $quotedSource);
+    }
+
+    /**
+     * @param string $name
+     */
+    protected function dropTable($name) {
+        $this->connection->exec('DROP TABLE ' . $this->connection->quoteIdentifier($name));
+    }
+
+    /**
+     * @param $statement
+     * @return string
+     */
+    protected function convertStatementToScript($statement) {
+        $script = $statement . ';';
+        $script .= PHP_EOL;
+        $script .= PHP_EOL;
+        return $script;
+    }
+
+    protected function getFilterExpression() {
+        return '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
+    }
+
+    protected function emit($sql, $step, $max) {
+        if ($this->noEmit) {
+            return;
+        }
+        if(is_null($this->dispatcher)) {
+            return;
+        }
+        $this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step+1, $max]));
+    }
+
+    private function emitCheckStep($tableName, $step, $max) {
+        if(is_null($this->dispatcher)) {
+            return;
+        }
+        $this->dispatcher->dispatch('\OC\DB\Migrator::checkTable', new GenericEvent($tableName, [$step+1, $max]));
+    }
 }

lib/private/DB/SQLiteMigrator.php

Indentation +53 added lines, -53 removed lines

@@ -32,62 +32,62 @@
 
 class SQLiteMigrator extends Migrator {
 
-	/**
-	 * @param \Doctrine\DBAL\Schema\Schema $targetSchema
-	 * @throws \OC\DB\MigrationException
-	 *
-	 * For sqlite we simple make a copy of the entire database, and test the migration on that
-	 */
-	public function checkMigrate(\Doctrine\DBAL\Schema\Schema $targetSchema) {
-		$dbFile = $this->connection->getDatabase();
-		$tmpFile = $this->buildTempDatabase();
-		copy($dbFile, $tmpFile);
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $targetSchema
+     * @throws \OC\DB\MigrationException
+     *
+     * For sqlite we simple make a copy of the entire database, and test the migration on that
+     */
+    public function checkMigrate(\Doctrine\DBAL\Schema\Schema $targetSchema) {
+        $dbFile = $this->connection->getDatabase();
+        $tmpFile = $this->buildTempDatabase();
+        copy($dbFile, $tmpFile);
 
-		$connectionParams = array(
-			'path' => $tmpFile,
-			'driver' => 'pdo_sqlite',
-		);
-		$conn = \Doctrine\DBAL\DriverManager::getConnection($connectionParams);
-		try {
-			$this->applySchema($targetSchema, $conn);
-			$conn->close();
-			unlink($tmpFile);
-		} catch (DBALException $e) {
-			$conn->close();
-			unlink($tmpFile);
-			throw new MigrationException('', $e->getMessage());
-		}
-	}
+        $connectionParams = array(
+            'path' => $tmpFile,
+            'driver' => 'pdo_sqlite',
+        );
+        $conn = \Doctrine\DBAL\DriverManager::getConnection($connectionParams);
+        try {
+            $this->applySchema($targetSchema, $conn);
+            $conn->close();
+            unlink($tmpFile);
+        } catch (DBALException $e) {
+            $conn->close();
+            unlink($tmpFile);
+            throw new MigrationException('', $e->getMessage());
+        }
+    }
 
-	/**
-	 * @return string
-	 */
-	private function buildTempDatabase() {
-		$dataDir = $this->config->getSystemValue("datadirectory", \OC::$SERVERROOT . '/data');
-		$tmpFile = uniqid("oc_");
-		return "$dataDir/$tmpFile.db";
-	}
+    /**
+     * @return string
+     */
+    private function buildTempDatabase() {
+        $dataDir = $this->config->getSystemValue("datadirectory", \OC::$SERVERROOT . '/data');
+        $tmpFile = uniqid("oc_");
+        return "$dataDir/$tmpFile.db";
+    }
 
-	/**
-	 * @param Schema $targetSchema
-	 * @param \Doctrine\DBAL\Connection $connection
-	 * @return \Doctrine\DBAL\Schema\SchemaDiff
-	 */
-	protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
-		$platform = $connection->getDatabasePlatform();
-		$platform->registerDoctrineTypeMapping('tinyint unsigned', 'integer');
-		$platform->registerDoctrineTypeMapping('smallint unsigned', 'integer');
-		$platform->registerDoctrineTypeMapping('varchar ', 'string');
+    /**
+     * @param Schema $targetSchema
+     * @param \Doctrine\DBAL\Connection $connection
+     * @return \Doctrine\DBAL\Schema\SchemaDiff
+     */
+    protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
+        $platform = $connection->getDatabasePlatform();
+        $platform->registerDoctrineTypeMapping('tinyint unsigned', 'integer');
+        $platform->registerDoctrineTypeMapping('smallint unsigned', 'integer');
+        $platform->registerDoctrineTypeMapping('varchar ', 'string');
 
-		// with sqlite autoincrement columns is of type integer
-		foreach ($targetSchema->getTables() as $table) {
-			foreach ($table->getColumns() as $column) {
-				if ($column->getType() instanceof BigIntType && $column->getAutoincrement()) {
-					$column->setType(Type::getType('integer'));
-				}
-			}
-		}
+        // with sqlite autoincrement columns is of type integer
+        foreach ($targetSchema->getTables() as $table) {
+            foreach ($table->getColumns() as $column) {
+                if ($column->getType() instanceof BigIntType && $column->getAutoincrement()) {
+                    $column->setType(Type::getType('integer'));
+                }
+            }
+        }
 
-		return parent::getDiff($targetSchema, $connection);
-	}
+        return parent::getDiff($targetSchema, $connection);
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -63,7 +63,7 @@
 	 * @return string
 	 */
 	private function buildTempDatabase() {
-		$dataDir = $this->config->getSystemValue("datadirectory", \OC::$SERVERROOT . '/data');
+		$dataDir = $this->config->getSystemValue("datadirectory", \OC::$SERVERROOT.'/data');
 		$tmpFile = uniqid("oc_");
 		return "$dataDir/$tmpFile.db";
 	}

lib/private/App/AppStore/Version/Version.php

Indentation +24 added lines, -24 removed lines

@@ -22,31 +22,31 @@
 namespace OC\App\AppStore\Version;
 
 class Version {
-	/** @var string */
-	private $minVersion;
-	/** @var string */
-	private $maxVersion;
+    /** @var string */
+    private $minVersion;
+    /** @var string */
+    private $maxVersion;
 
-	/**
-	 * @param string $minVersion
-	 * @param string $maxVersion
-	 */
-	public function __construct($minVersion, $maxVersion) {
-		$this->minVersion = $minVersion;
-		$this->maxVersion = $maxVersion;
-	}
+    /**
+     * @param string $minVersion
+     * @param string $maxVersion
+     */
+    public function __construct($minVersion, $maxVersion) {
+        $this->minVersion = $minVersion;
+        $this->maxVersion = $maxVersion;
+    }
 
-	/**
-	 * @return string
-	 */
-	public function getMinimumVersion() {
-		return $this->minVersion;
-	}
+    /**
+     * @return string
+     */
+    public function getMinimumVersion() {
+        return $this->minVersion;
+    }
 
-	/**
-	 * @return string
-	 */
-	public function getMaximumVersion() {
-		return $this->maxVersion;
-	}
+    /**
+     * @return string
+     */
+    public function getMaximumVersion() {
+        return $this->maxVersion;
+    }
 }

lib/private/App/CodeChecker/NodeVisitor.php

Spacing +13 added lines, -13 removed lines

@@ -102,7 +102,7 @@ 
 
 	public function enterNode(Node $node) {
 		if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\Equal) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => '==',
 				'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED,
 				'line' => $node->getLine(),
@@ -110,7 +110,7 @@ 
 			];
 		}
 		if ($this->checkEqualOperatorUsage && $node instanceof Node\Expr\BinaryOp\NotEqual) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => '!=',
 				'errorCode' => CodeChecker::OP_OPERATOR_USAGE_DISCOURAGED,
 				'line' => $node->getLine(),
@@ -214,28 +214,28 @@ 
 		$alias = strtolower($alias);
 
 		foreach ($this->blackListedClassNames as $blackListedAlias => $blackListedClassName) {
-			if (strpos($blackListedClassName, $name . '\\') === 0) {
+			if (strpos($blackListedClassName, $name.'\\') === 0) {
 				$aliasedClassName = str_replace($name, $alias, $blackListedClassName);
 				$this->blackListedClassNames[$aliasedClassName] = $blackListedClassName;
 			}
 		}
 
 		foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) {
-			if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) {
+			if (strpos($blackListedConstant, $name.'\\') === 0 || strpos($blackListedConstant, $name.'::') === 0) {
 				$aliasedConstantName = str_replace($name, $alias, $blackListedConstant);
 				$this->blackListedConstants[$aliasedConstantName] = $blackListedConstant;
 			}
 		}
 
 		foreach ($this->blackListedFunctions as $blackListedAlias => $blackListedFunction) {
-			if (strpos($blackListedFunction, $name . '\\') === 0 || strpos($blackListedFunction, $name . '::') === 0) {
+			if (strpos($blackListedFunction, $name.'\\') === 0 || strpos($blackListedFunction, $name.'::') === 0) {
 				$aliasedFunctionName = str_replace($name, $alias, $blackListedFunction);
 				$this->blackListedFunctions[$aliasedFunctionName] = $blackListedFunction;
 			}
 		}
 
 		foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) {
-			if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) {
+			if (strpos($blackListedMethod, $name.'\\') === 0 || strpos($blackListedMethod, $name.'::') === 0) {
 				$aliasedMethodName = str_replace($name, $alias, $blackListedMethod);
 				$this->blackListedMethods[$aliasedMethodName] = $blackListedMethod;
 			}
@@ -246,7 +246,7 @@ 
 		$lowerName = strtolower($name);
 
 		if (isset($this->blackListedClassNames[$lowerName])) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => $name,
 				'errorCode' => $errorCode,
 				'line' => $node->getLine(),
@@ -256,11 +256,11 @@ 
 	}
 
 	private function checkBlackListConstant($class, $constantName, Node $node) {
-		$name = $class . '::' . $constantName;
+		$name = $class.'::'.$constantName;
 		$lowerName = strtolower($name);
 
 		if (isset($this->blackListedConstants[$lowerName])) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => $name,
 				'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED,
 				'line' => $node->getLine(),
@@ -270,11 +270,11 @@ 
 	}
 
 	private function checkBlackListFunction($class, $functionName, Node $node) {
-		$name = $class . '::' . $functionName;
+		$name = $class.'::'.$functionName;
 		$lowerName = strtolower($name);
 
 		if (isset($this->blackListedFunctions[$lowerName])) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => $name,
 				'errorCode' => CodeChecker::STATIC_CALL_NOT_ALLOWED,
 				'line' => $node->getLine(),
@@ -284,11 +284,11 @@ 
 	}
 
 	private function checkBlackListMethod($class, $functionName, Node $node) {
-		$name = $class . '::' . $functionName;
+		$name = $class.'::'.$functionName;
 		$lowerName = strtolower($name);
 
 		if (isset($this->blackListedMethods[$lowerName])) {
-			$this->errors[]= [
+			$this->errors[] = [
 				'disallowedToken' => $name,
 				'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED,
 				'line' => $node->getLine(),

Indentation +276 added lines, -276 removed lines

@@ -29,280 +29,280 @@
 use PhpParser\NodeVisitorAbstract;
 
 class NodeVisitor extends NodeVisitorAbstract {
-	/** @var ICheck */
-	protected $list;
-
-	/** @var string */
-	protected $blackListDescription;
-	/** @var string[] */
-	protected $blackListedClassNames;
-	/** @var string[] */
-	protected $blackListedConstants;
-	/** @var string[] */
-	protected $blackListedFunctions;
-	/** @var string[] */
-	protected $blackListedMethods;
-	/** @var bool */
-	protected $checkEqualOperatorUsage;
-	/** @var string[] */
-	protected $errorMessages;
-
-	/**
-	 * @param ICheck $list
-	 */
-	public function __construct(ICheck $list) {
-		$this->list = $list;
-
-		$this->blackListedClassNames = [];
-		foreach ($list->getClasses() as $class => $blackListInfo) {
-			if (is_numeric($class) && is_string($blackListInfo)) {
-				$class = $blackListInfo;
-				$blackListInfo = null;
-			}
-
-			$class = strtolower($class);
-			$this->blackListedClassNames[$class] = $class;
-		}
-
-		$this->blackListedConstants = [];
-		foreach ($list->getConstants() as $constantName => $blackListInfo) {
-			$constantName = strtolower($constantName);
-			$this->blackListedConstants[$constantName] = $constantName;
-		}
-
-		$this->blackListedFunctions = [];
-		foreach ($list->getFunctions() as $functionName => $blackListInfo) {
-			$functionName = strtolower($functionName);
-			$this->blackListedFunctions[$functionName] = $functionName;
-		}
-
-		$this->blackListedMethods = [];
-		foreach ($list->getMethods() as $functionName => $blackListInfo) {
-			$functionName = strtolower($functionName);
-			$this->blackListedMethods[$functionName] = $functionName;
-		}
-
-		$this->checkEqualOperatorUsage = $list->checkStrongComparisons();
-
-		$this->errorMessages = [
-			CodeChecker::CLASS_EXTENDS_NOT_ALLOWED => "%s class must not be extended",
-			CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED => "%s interface must not be implemented",
-			CodeChecker::STATIC_CALL_NOT_ALLOWED => "Static method of %s class must not be called",
-			CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED => "Constant of %s class must not not be fetched",
-			CodeChecker::CLASS_NEW_NOT_ALLOWED => "%s class must not be instantiated",
-			CodeChecker::CLASS_USE_NOT_ALLOWED => "%s class must not be imported with a use statement",
-			CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED => "Method of %s class must not be called",
-
-			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) {
-			$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) {
-			$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);
-
-					$this->checkBlackListFunction($node->class->toString(), $node->name, $node);
-					$this->checkBlackListMethod($node->class->toString(), $node->name, $node);
-				}
-
-				if ($node->class instanceof Node\Expr\Variable) {
-					/**
-					 * TODO: find a way to detect something like this:
-					 *       $c = "OC_API";
-					 *       $n = $c::call();
-					 */
-					// $this->checkBlackListMethod($node->class->..., $node->name, $node);
-				}
-			}
-		}
-		if ($node instanceof Node\Expr\MethodCall) {
-			if (!is_null($node->var)) {
-				if ($node->var instanceof Node\Expr\Variable) {
-					/**
-					 * TODO: find a way to detect something like this:
-					 *       $c = new OC_API();
-					 *       $n = $c::call();
-					 *       $n = $c->call();
-					 */
-					// $this->checkBlackListMethod($node->var->..., $node->name, $node);
-				}
-			}
-		}
-		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 || $node->class instanceof Node\Expr\PropertyFetch) {
-					/**
-					 * TODO: find a way to detect something like this:
-					 *       $c = "OC_API";
-					 *       $n = $i::ADMIN_AUTH;
-					 */
-				} else {
-					$this->checkBlackListConstant($node->class->toString(), $node->name, $node);
-				}
-			}
-		}
-		if ($node instanceof Node\Expr\New_) {
-			if (!is_null($node->class)) {
-				if ($node->class instanceof Name) {
-					$this->checkBlackList($node->class->toString(), CodeChecker::CLASS_NEW_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;
-					 */
-				}
-			}
-		}
-		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;
-			}
-		}
-
-		foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) {
-			if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) {
-				$aliasedConstantName = str_replace($name, $alias, $blackListedConstant);
-				$this->blackListedConstants[$aliasedConstantName] = $blackListedConstant;
-			}
-		}
-
-		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;
-			}
-		}
-
-		foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) {
-			if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) {
-				$aliasedMethodName = str_replace($name, $alias, $blackListedMethod);
-				$this->blackListedMethods[$aliasedMethodName] = $blackListedMethod;
-			}
-		}
-	}
-
-	private function checkBlackList($name, $errorCode, Node $node) {
-		$lowerName = strtolower($name);
-
-		if (isset($this->blackListedClassNames[$lowerName])) {
-			$this->errors[]= [
-				'disallowedToken' => $name,
-				'errorCode' => $errorCode,
-				'line' => $node->getLine(),
-				'reason' => $this->buildReason($this->blackListedClassNames[$lowerName], $errorCode)
-			];
-		}
-	}
-
-	private function checkBlackListConstant($class, $constantName, Node $node) {
-		$name = $class . '::' . $constantName;
-		$lowerName = strtolower($name);
-
-		if (isset($this->blackListedConstants[$lowerName])) {
-			$this->errors[]= [
-				'disallowedToken' => $name,
-				'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED,
-				'line' => $node->getLine(),
-				'reason' => $this->buildReason($this->blackListedConstants[$lowerName], CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED)
-			];
-		}
-	}
-
-	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 checkBlackListMethod($class, $functionName, Node $node) {
-		$name = $class . '::' . $functionName;
-		$lowerName = strtolower($name);
-
-		if (isset($this->blackListedMethods[$lowerName])) {
-			$this->errors[]= [
-				'disallowedToken' => $name,
-				'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED,
-				'line' => $node->getLine(),
-				'reason' => $this->buildReason($this->blackListedMethods[$lowerName], CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED)
-			];
-		}
-	}
-
-	private function buildReason($name, $errorCode) {
-		if (isset($this->errorMessages[$errorCode])) {
-			$desc = $this->list->getDescription($errorCode, $name);
-			return sprintf($this->errorMessages[$errorCode], $desc);
-		}
-
-		return "$name usage not allowed - error: $errorCode";
-	}
+    /** @var ICheck */
+    protected $list;
+
+    /** @var string */
+    protected $blackListDescription;
+    /** @var string[] */
+    protected $blackListedClassNames;
+    /** @var string[] */
+    protected $blackListedConstants;
+    /** @var string[] */
+    protected $blackListedFunctions;
+    /** @var string[] */
+    protected $blackListedMethods;
+    /** @var bool */
+    protected $checkEqualOperatorUsage;
+    /** @var string[] */
+    protected $errorMessages;
+
+    /**
+     * @param ICheck $list
+     */
+    public function __construct(ICheck $list) {
+        $this->list = $list;
+
+        $this->blackListedClassNames = [];
+        foreach ($list->getClasses() as $class => $blackListInfo) {
+            if (is_numeric($class) && is_string($blackListInfo)) {
+                $class = $blackListInfo;
+                $blackListInfo = null;
+            }
+
+            $class = strtolower($class);
+            $this->blackListedClassNames[$class] = $class;
+        }
+
+        $this->blackListedConstants = [];
+        foreach ($list->getConstants() as $constantName => $blackListInfo) {
+            $constantName = strtolower($constantName);
+            $this->blackListedConstants[$constantName] = $constantName;
+        }
+
+        $this->blackListedFunctions = [];
+        foreach ($list->getFunctions() as $functionName => $blackListInfo) {
+            $functionName = strtolower($functionName);
+            $this->blackListedFunctions[$functionName] = $functionName;
+        }
+
+        $this->blackListedMethods = [];
+        foreach ($list->getMethods() as $functionName => $blackListInfo) {
+            $functionName = strtolower($functionName);
+            $this->blackListedMethods[$functionName] = $functionName;
+        }
+
+        $this->checkEqualOperatorUsage = $list->checkStrongComparisons();
+
+        $this->errorMessages = [
+            CodeChecker::CLASS_EXTENDS_NOT_ALLOWED => "%s class must not be extended",
+            CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED => "%s interface must not be implemented",
+            CodeChecker::STATIC_CALL_NOT_ALLOWED => "Static method of %s class must not be called",
+            CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED => "Constant of %s class must not not be fetched",
+            CodeChecker::CLASS_NEW_NOT_ALLOWED => "%s class must not be instantiated",
+            CodeChecker::CLASS_USE_NOT_ALLOWED => "%s class must not be imported with a use statement",
+            CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED => "Method of %s class must not be called",
+
+            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) {
+            $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) {
+            $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);
+
+                    $this->checkBlackListFunction($node->class->toString(), $node->name, $node);
+                    $this->checkBlackListMethod($node->class->toString(), $node->name, $node);
+                }
+
+                if ($node->class instanceof Node\Expr\Variable) {
+                    /**
+                     * TODO: find a way to detect something like this:
+                     *       $c = "OC_API";
+                     *       $n = $c::call();
+                     */
+                    // $this->checkBlackListMethod($node->class->..., $node->name, $node);
+                }
+            }
+        }
+        if ($node instanceof Node\Expr\MethodCall) {
+            if (!is_null($node->var)) {
+                if ($node->var instanceof Node\Expr\Variable) {
+                    /**
+                     * TODO: find a way to detect something like this:
+                     *       $c = new OC_API();
+                     *       $n = $c::call();
+                     *       $n = $c->call();
+                     */
+                    // $this->checkBlackListMethod($node->var->..., $node->name, $node);
+                }
+            }
+        }
+        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 || $node->class instanceof Node\Expr\PropertyFetch) {
+                    /**
+                     * TODO: find a way to detect something like this:
+                     *       $c = "OC_API";
+                     *       $n = $i::ADMIN_AUTH;
+                     */
+                } else {
+                    $this->checkBlackListConstant($node->class->toString(), $node->name, $node);
+                }
+            }
+        }
+        if ($node instanceof Node\Expr\New_) {
+            if (!is_null($node->class)) {
+                if ($node->class instanceof Name) {
+                    $this->checkBlackList($node->class->toString(), CodeChecker::CLASS_NEW_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;
+                     */
+                }
+            }
+        }
+        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;
+            }
+        }
+
+        foreach ($this->blackListedConstants as $blackListedAlias => $blackListedConstant) {
+            if (strpos($blackListedConstant, $name . '\\') === 0 || strpos($blackListedConstant, $name . '::') === 0) {
+                $aliasedConstantName = str_replace($name, $alias, $blackListedConstant);
+                $this->blackListedConstants[$aliasedConstantName] = $blackListedConstant;
+            }
+        }
+
+        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;
+            }
+        }
+
+        foreach ($this->blackListedMethods as $blackListedAlias => $blackListedMethod) {
+            if (strpos($blackListedMethod, $name . '\\') === 0 || strpos($blackListedMethod, $name . '::') === 0) {
+                $aliasedMethodName = str_replace($name, $alias, $blackListedMethod);
+                $this->blackListedMethods[$aliasedMethodName] = $blackListedMethod;
+            }
+        }
+    }
+
+    private function checkBlackList($name, $errorCode, Node $node) {
+        $lowerName = strtolower($name);
+
+        if (isset($this->blackListedClassNames[$lowerName])) {
+            $this->errors[]= [
+                'disallowedToken' => $name,
+                'errorCode' => $errorCode,
+                'line' => $node->getLine(),
+                'reason' => $this->buildReason($this->blackListedClassNames[$lowerName], $errorCode)
+            ];
+        }
+    }
+
+    private function checkBlackListConstant($class, $constantName, Node $node) {
+        $name = $class . '::' . $constantName;
+        $lowerName = strtolower($name);
+
+        if (isset($this->blackListedConstants[$lowerName])) {
+            $this->errors[]= [
+                'disallowedToken' => $name,
+                'errorCode' => CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED,
+                'line' => $node->getLine(),
+                'reason' => $this->buildReason($this->blackListedConstants[$lowerName], CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED)
+            ];
+        }
+    }
+
+    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 checkBlackListMethod($class, $functionName, Node $node) {
+        $name = $class . '::' . $functionName;
+        $lowerName = strtolower($name);
+
+        if (isset($this->blackListedMethods[$lowerName])) {
+            $this->errors[]= [
+                'disallowedToken' => $name,
+                'errorCode' => CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED,
+                'line' => $node->getLine(),
+                'reason' => $this->buildReason($this->blackListedMethods[$lowerName], CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED)
+            ];
+        }
+    }
+
+    private function buildReason($name, $errorCode) {
+        if (isset($this->errorMessages[$errorCode])) {
+            $desc = $this->list->getDescription($errorCode, $name);
+            return sprintf($this->errorMessages[$errorCode], $desc);
+        }
+
+        return "$name usage not allowed - error: $errorCode";
+    }
 }

lib/private/App/CodeChecker/AbstractCheck.php

Indentation +114 added lines, -114 removed lines

@@ -23,118 +23,118 @@
 namespace OC\App\CodeChecker;
 
 abstract class AbstractCheck implements ICheck {
-	/** @var ICheck */
-	protected $check;
-
-	/**
-	 * @param ICheck $check
-	 */
-	public function __construct(ICheck $check) {
-		$this->check = $check;
-	}
-
-	/**
-	 * @param int $errorCode
-	 * @param string $errorObject
-	 * @return string
-	 */
-	public function getDescription($errorCode, $errorObject) {
-		switch ($errorCode) {
-			case CodeChecker::STATIC_CALL_NOT_ALLOWED:
-				$functions = $this->getLocalFunctions();
-				$functions = array_change_key_case($functions, CASE_LOWER);
-				if (isset($functions[$errorObject])) {
-					return $this->getLocalDescription();
-				}
-			// no break;
-			case CodeChecker::CLASS_EXTENDS_NOT_ALLOWED:
-			case CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED:
-			case CodeChecker::CLASS_NEW_NOT_ALLOWED:
-			case CodeChecker::CLASS_USE_NOT_ALLOWED:
-				$classes = $this->getLocalClasses();
-				$classes = array_change_key_case($classes, CASE_LOWER);
-				if (isset($classes[$errorObject])) {
-					return $this->getLocalDescription();
-				}
-			break;
-
-			case CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED:
-				$constants = $this->getLocalConstants();
-				$constants = array_change_key_case($constants, CASE_LOWER);
-				if (isset($constants[$errorObject])) {
-					return $this->getLocalDescription();
-				}
-			break;
-
-			case CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED:
-				$methods = $this->getLocalMethods();
-				$methods = array_change_key_case($methods, CASE_LOWER);
-				if (isset($methods[$errorObject])) {
-					return $this->getLocalDescription();
-				}
-			break;
-		}
-
-		return $this->check->getDescription($errorCode, $errorObject);
-	}
-
-	/**
-	 * @return string
-	 */
-	abstract protected function getLocalDescription();
-
-	/**
-	 * @return array
-	 */
-	abstract protected function getLocalClasses();
-
-	/**
-	 * @return array
-	 */
-	abstract protected function getLocalConstants();
-
-	/**
-	 * @return array
-	 */
-	abstract protected function getLocalFunctions();
-
-	/**
-	 * @return array
-	 */
-	abstract protected function getLocalMethods();
-
-	/**
-	 * @return array E.g.: `'ClassName' => 'oc version',`
-	 */
-	public function getClasses() {
-		return array_merge($this->getLocalClasses(), $this->check->getClasses());
-	}
-
-	/**
-	 * @return array E.g.: `'ClassName::CONSTANT_NAME' => 'oc version',`
-	 */
-	public function getConstants() {
-		return array_merge($this->getLocalConstants(), $this->check->getConstants());
-	}
-
-	/**
-	 * @return array E.g.: `'functionName' => 'oc version',`
-	 */
-	public function getFunctions() {
-		return array_merge($this->getLocalFunctions(), $this->check->getFunctions());
-	}
-
-	/**
-	 * @return array E.g.: `'ClassName::methodName' => 'oc version',`
-	 */
-	public function getMethods() {
-		return array_merge($this->getLocalMethods(), $this->check->getMethods());
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function checkStrongComparisons() {
-		return $this->check->checkStrongComparisons();
-	}
+    /** @var ICheck */
+    protected $check;
+
+    /**
+     * @param ICheck $check
+     */
+    public function __construct(ICheck $check) {
+        $this->check = $check;
+    }
+
+    /**
+     * @param int $errorCode
+     * @param string $errorObject
+     * @return string
+     */
+    public function getDescription($errorCode, $errorObject) {
+        switch ($errorCode) {
+            case CodeChecker::STATIC_CALL_NOT_ALLOWED:
+                $functions = $this->getLocalFunctions();
+                $functions = array_change_key_case($functions, CASE_LOWER);
+                if (isset($functions[$errorObject])) {
+                    return $this->getLocalDescription();
+                }
+            // no break;
+            case CodeChecker::CLASS_EXTENDS_NOT_ALLOWED:
+            case CodeChecker::CLASS_IMPLEMENTS_NOT_ALLOWED:
+            case CodeChecker::CLASS_NEW_NOT_ALLOWED:
+            case CodeChecker::CLASS_USE_NOT_ALLOWED:
+                $classes = $this->getLocalClasses();
+                $classes = array_change_key_case($classes, CASE_LOWER);
+                if (isset($classes[$errorObject])) {
+                    return $this->getLocalDescription();
+                }
+            break;
+
+            case CodeChecker::CLASS_CONST_FETCH_NOT_ALLOWED:
+                $constants = $this->getLocalConstants();
+                $constants = array_change_key_case($constants, CASE_LOWER);
+                if (isset($constants[$errorObject])) {
+                    return $this->getLocalDescription();
+                }
+            break;
+
+            case CodeChecker::CLASS_METHOD_CALL_NOT_ALLOWED:
+                $methods = $this->getLocalMethods();
+                $methods = array_change_key_case($methods, CASE_LOWER);
+                if (isset($methods[$errorObject])) {
+                    return $this->getLocalDescription();
+                }
+            break;
+        }
+
+        return $this->check->getDescription($errorCode, $errorObject);
+    }
+
+    /**
+     * @return string
+     */
+    abstract protected function getLocalDescription();
+
+    /**
+     * @return array
+     */
+    abstract protected function getLocalClasses();
+
+    /**
+     * @return array
+     */
+    abstract protected function getLocalConstants();
+
+    /**
+     * @return array
+     */
+    abstract protected function getLocalFunctions();
+
+    /**
+     * @return array
+     */
+    abstract protected function getLocalMethods();
+
+    /**
+     * @return array E.g.: `'ClassName' => 'oc version',`
+     */
+    public function getClasses() {
+        return array_merge($this->getLocalClasses(), $this->check->getClasses());
+    }
+
+    /**
+     * @return array E.g.: `'ClassName::CONSTANT_NAME' => 'oc version',`
+     */
+    public function getConstants() {
+        return array_merge($this->getLocalConstants(), $this->check->getConstants());
+    }
+
+    /**
+     * @return array E.g.: `'functionName' => 'oc version',`
+     */
+    public function getFunctions() {
+        return array_merge($this->getLocalFunctions(), $this->check->getFunctions());
+    }
+
+    /**
+     * @return array E.g.: `'ClassName::methodName' => 'oc version',`
+     */
+    public function getMethods() {
+        return array_merge($this->getLocalMethods(), $this->check->getMethods());
+    }
+
+    /**
+     * @return bool
+     */
+    public function checkStrongComparisons() {
+        return $this->check->checkStrongComparisons();
+    }
 }

lib/private/App/CodeChecker/EmptyCheck.php

Indentation +38 added lines, -38 removed lines

@@ -22,47 +22,47 @@
 namespace OC\App\CodeChecker;
 
 class EmptyCheck implements ICheck {
-	/**
-	 * @param int $errorCode
-	 * @param string $errorObject
-	 * @return string
-	 */
-	public function getDescription($errorCode, $errorObject) {
-		return '';
-	}
+    /**
+     * @param int $errorCode
+     * @param string $errorObject
+     * @return string
+     */
+    public function getDescription($errorCode, $errorObject) {
+        return '';
+    }
 
-	/**
-	 * @return array E.g.: `'ClassName' => 'oc version',`
-	 */
-	public function getClasses() {
-		return [];
-	}
+    /**
+     * @return array E.g.: `'ClassName' => 'oc version',`
+     */
+    public function getClasses() {
+        return [];
+    }
 
-	/**
-	 * @return array E.g.: `'ClassName::CONSTANT_NAME' => 'oc version',`
-	 */
-	public function getConstants() {
-		return [];
-	}
+    /**
+     * @return array E.g.: `'ClassName::CONSTANT_NAME' => 'oc version',`
+     */
+    public function getConstants() {
+        return [];
+    }
 
-	/**
-	 * @return array E.g.: `'functionName' => 'oc version',`
-	 */
-	public function getFunctions() {
-		return [];
-	}
+    /**
+     * @return array E.g.: `'functionName' => 'oc version',`
+     */
+    public function getFunctions() {
+        return [];
+    }
 
-	/**
-	 * @return array E.g.: `'ClassName::methodName' => 'oc version',`
-	 */
-	public function getMethods() {
-		return [];
-	}
+    /**
+     * @return array E.g.: `'ClassName::methodName' => 'oc version',`
+     */
+    public function getMethods() {
+        return [];
+    }
 
-	/**
-	 * @return bool
-	 */
-	public function checkStrongComparisons() {
-		return false;
-	}
+    /**
+     * @return bool
+     */
+    public function checkStrongComparisons() {
+        return false;
+    }
 }

lib/private/App/CodeChecker/StrongComparisonCheck.php

Indentation +46 added lines, -46 removed lines

@@ -23,57 +23,57 @@
 namespace OC\App\CodeChecker;
 
 class StrongComparisonCheck implements ICheck {
-	/** @var ICheck */
-	protected $check;
+    /** @var ICheck */
+    protected $check;
 
-	/**
-	 * @param ICheck $check
-	 */
-	public function __construct(ICheck $check) {
-		$this->check = $check;
-	}
+    /**
+     * @param ICheck $check
+     */
+    public function __construct(ICheck $check) {
+        $this->check = $check;
+    }
 
-	/**
-	 * @param int $errorCode
-	 * @param string $errorObject
-	 * @return string
-	 */
-	public function getDescription($errorCode, $errorObject) {
-		return $this->check->getDescription($errorCode, $errorObject);
-	}
+    /**
+     * @param int $errorCode
+     * @param string $errorObject
+     * @return string
+     */
+    public function getDescription($errorCode, $errorObject) {
+        return $this->check->getDescription($errorCode, $errorObject);
+    }
 
-	/**
-	 * @return array
-	 */
-	public function getClasses() {
-		return $this->check->getClasses();
-	}
+    /**
+     * @return array
+     */
+    public function getClasses() {
+        return $this->check->getClasses();
+    }
 
-	/**
-	 * @return array
-	 */
-	public function getConstants() {
-		return $this->check->getConstants();
-	}
+    /**
+     * @return array
+     */
+    public function getConstants() {
+        return $this->check->getConstants();
+    }
 
-	/**
-	 * @return array
-	 */
-	public function getFunctions() {
-		return $this->check->getFunctions();
-	}
+    /**
+     * @return array
+     */
+    public function getFunctions() {
+        return $this->check->getFunctions();
+    }
 
-	/**
-	 * @return array
-	 */
-	public function getMethods() {
-		return $this->check->getMethods();
-	}
+    /**
+     * @return array
+     */
+    public function getMethods() {
+        return $this->check->getMethods();
+    }
 
-	/**
-	 * @return bool
-	 */
-	public function checkStrongComparisons() {
-		return true;
-	}
+    /**
+     * @return bool
+     */
+    public function checkStrongComparisons() {
+        return true;
+    }
 }

lib/private/App/CodeChecker/CodeChecker.php

Spacing +6 added lines, -6 removed lines

@@ -42,10 +42,10 @@ 
 	const CLASS_IMPLEMENTS_NOT_ALLOWED = 1001;
 	const STATIC_CALL_NOT_ALLOWED = 1002;
 	const CLASS_CONST_FETCH_NOT_ALLOWED = 1003;
-	const CLASS_NEW_NOT_ALLOWED =  1004;
-	const OP_OPERATOR_USAGE_DISCOURAGED =  1005;
-	const CLASS_USE_NOT_ALLOWED =  1006;
-	const CLASS_METHOD_CALL_NOT_ALLOWED =  1007;
+	const CLASS_NEW_NOT_ALLOWED = 1004;
+	const OP_OPERATOR_USAGE_DISCOURAGED = 1005;
+	const CLASS_USE_NOT_ALLOWED = 1006;
+	const CLASS_METHOD_CALL_NOT_ALLOWED = 1007;
 
 	/** @var Parser */
 	private $parser;
@@ -85,13 +85,13 @@ 
 		}
 
 		$excludes = array_map(function($item) use ($folder) {
-			return $folder . '/' . $item;
+			return $folder.'/'.$item;
 		}, $excludedDirectories);
 
 		$iterator = new RecursiveDirectoryIterator($folder, RecursiveDirectoryIterator::SKIP_DOTS);
 		$iterator = new RecursiveCallbackFilterIterator($iterator, function($item) use ($folder, $excludes){
 			/** @var SplFileInfo $item */
-			foreach($excludes as $exclude) {
+			foreach ($excludes as $exclude) {
 				if (substr($item->getPath(), 0, strlen($exclude)) === $exclude) {
 					return false;
 				}

Indentation +101 added lines, -101 removed lines

@@ -36,105 +36,105 @@
 
 class CodeChecker extends BasicEmitter {
 
-	const CLASS_EXTENDS_NOT_ALLOWED = 1000;
-	const CLASS_IMPLEMENTS_NOT_ALLOWED = 1001;
-	const STATIC_CALL_NOT_ALLOWED = 1002;
-	const CLASS_CONST_FETCH_NOT_ALLOWED = 1003;
-	const CLASS_NEW_NOT_ALLOWED =  1004;
-	const OP_OPERATOR_USAGE_DISCOURAGED =  1005;
-	const CLASS_USE_NOT_ALLOWED =  1006;
-	const CLASS_METHOD_CALL_NOT_ALLOWED =  1007;
-
-	/** @var Parser */
-	private $parser;
-
-	/** @var ICheck */
-	protected $checkList;
-
-	/** @var bool */
-	protected $checkMigrationSchema;
-
-	public function __construct(ICheck $checkList, $checkMigrationSchema) {
-		$this->checkList = $checkList;
-		$this->checkMigrationSchema = $checkMigrationSchema;
-		$this->parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
-	}
-
-	/**
-	 * @param string $appId
-	 * @return array
-	 * @throws \RuntimeException if app with $appId is unknown
-	 */
-	public function analyse(string $appId): array {
-		$appPath = \OC_App::getAppPath($appId);
-		if ($appPath === false) {
-			throw new \RuntimeException("No app with given id <$appId> known.");
-		}
-
-		return $this->analyseFolder($appId, $appPath);
-	}
-
-	/**
-	 * @param string $appId
-	 * @param string $folder
-	 * @return array
-	 */
-	public function analyseFolder(string $appId, string $folder): array {
-		$errors = [];
-
-		$excludedDirectories = ['vendor', '3rdparty', '.git', 'l10n', 'tests', 'test', 'build'];
-		if ($appId === 'password_policy') {
-			$excludedDirectories[] = 'lists';
-		}
-
-		$excludes = array_map(function($item) use ($folder) {
-			return $folder . '/' . $item;
-		}, $excludedDirectories);
-
-		$iterator = new RecursiveDirectoryIterator($folder, RecursiveDirectoryIterator::SKIP_DOTS);
-		$iterator = new RecursiveCallbackFilterIterator($iterator, function($item) use ($folder, $excludes){
-			/** @var SplFileInfo $item */
-			foreach($excludes as $exclude) {
-				if (substr($item->getPath(), 0, strlen($exclude)) === $exclude) {
-					return false;
-				}
-			}
-			return true;
-		});
-		$iterator = new RecursiveIteratorIterator($iterator);
-		$iterator = new RegexIterator($iterator, '/^.+\.php$/i');
-
-		foreach ($iterator as $file) {
-			/** @var SplFileInfo $file */
-			$this->emit('CodeChecker', 'analyseFileBegin', [$file->getPathname()]);
-			$fileErrors = $this->analyseFile($file->__toString());
-			$this->emit('CodeChecker', 'analyseFileFinished', [$file->getPathname(), $fileErrors]);
-			$errors = array_merge($fileErrors, $errors);
-		}
-
-		return $errors;
-	}
-
-
-	/**
-	 * @param string $file
-	 * @return array
-	 */
-	public function analyseFile(string $file): array {
-		$code = file_get_contents($file);
-		$statements = $this->parser->parse($code);
-
-		$visitor = new NodeVisitor($this->checkList);
-		$migrationVisitor = new MigrationSchemaChecker();
-		$traverser = new NodeTraverser;
-		$traverser->addVisitor($visitor);
-
-		if ($this->checkMigrationSchema && preg_match('#^.+\\/Migration\\/Version[^\\/]{1,255}\\.php$#i', $file)) {
-			$traverser->addVisitor($migrationVisitor);
-		}
-
-		$traverser->traverse($statements);
-
-		return array_merge($visitor->errors, $migrationVisitor->errors);
-	}
+    const CLASS_EXTENDS_NOT_ALLOWED = 1000;
+    const CLASS_IMPLEMENTS_NOT_ALLOWED = 1001;
+    const STATIC_CALL_NOT_ALLOWED = 1002;
+    const CLASS_CONST_FETCH_NOT_ALLOWED = 1003;
+    const CLASS_NEW_NOT_ALLOWED =  1004;
+    const OP_OPERATOR_USAGE_DISCOURAGED =  1005;
+    const CLASS_USE_NOT_ALLOWED =  1006;
+    const CLASS_METHOD_CALL_NOT_ALLOWED =  1007;
+
+    /** @var Parser */
+    private $parser;
+
+    /** @var ICheck */
+    protected $checkList;
+
+    /** @var bool */
+    protected $checkMigrationSchema;
+
+    public function __construct(ICheck $checkList, $checkMigrationSchema) {
+        $this->checkList = $checkList;
+        $this->checkMigrationSchema = $checkMigrationSchema;
+        $this->parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
+    }
+
+    /**
+     * @param string $appId
+     * @return array
+     * @throws \RuntimeException if app with $appId is unknown
+     */
+    public function analyse(string $appId): array {
+        $appPath = \OC_App::getAppPath($appId);
+        if ($appPath === false) {
+            throw new \RuntimeException("No app with given id <$appId> known.");
+        }
+
+        return $this->analyseFolder($appId, $appPath);
+    }
+
+    /**
+     * @param string $appId
+     * @param string $folder
+     * @return array
+     */
+    public function analyseFolder(string $appId, string $folder): array {
+        $errors = [];
+
+        $excludedDirectories = ['vendor', '3rdparty', '.git', 'l10n', 'tests', 'test', 'build'];
+        if ($appId === 'password_policy') {
+            $excludedDirectories[] = 'lists';
+        }
+
+        $excludes = array_map(function($item) use ($folder) {
+            return $folder . '/' . $item;
+        }, $excludedDirectories);
+
+        $iterator = new RecursiveDirectoryIterator($folder, RecursiveDirectoryIterator::SKIP_DOTS);
+        $iterator = new RecursiveCallbackFilterIterator($iterator, function($item) use ($folder, $excludes){
+            /** @var SplFileInfo $item */
+            foreach($excludes as $exclude) {
+                if (substr($item->getPath(), 0, strlen($exclude)) === $exclude) {
+                    return false;
+                }
+            }
+            return true;
+        });
+        $iterator = new RecursiveIteratorIterator($iterator);
+        $iterator = new RegexIterator($iterator, '/^.+\.php$/i');
+
+        foreach ($iterator as $file) {
+            /** @var SplFileInfo $file */
+            $this->emit('CodeChecker', 'analyseFileBegin', [$file->getPathname()]);
+            $fileErrors = $this->analyseFile($file->__toString());
+            $this->emit('CodeChecker', 'analyseFileFinished', [$file->getPathname(), $fileErrors]);
+            $errors = array_merge($fileErrors, $errors);
+        }
+
+        return $errors;
+    }
+
+
+    /**
+     * @param string $file
+     * @return array
+     */
+    public function analyseFile(string $file): array {
+        $code = file_get_contents($file);
+        $statements = $this->parser->parse($code);
+
+        $visitor = new NodeVisitor($this->checkList);
+        $migrationVisitor = new MigrationSchemaChecker();
+        $traverser = new NodeTraverser;
+        $traverser->addVisitor($visitor);
+
+        if ($this->checkMigrationSchema && preg_match('#^.+\\/Migration\\/Version[^\\/]{1,255}\\.php$#i', $file)) {
+            $traverser->addVisitor($migrationVisitor);
+        }
+
+        $traverser->traverse($statements);
+
+        return array_merge($visitor->errors, $migrationVisitor->errors);
+    }
 }