nextcloud / server

lib/private/DB/PgSqlTools.php

Indentation +32 added lines, -32 removed lines

@@ -31,41 +31,41 @@
 */
 class PgSqlTools {
 
-	/** @var \OCP\IConfig */
-	private $config;
+    /** @var \OCP\IConfig */
+    private $config;
 
-	/**
-	 * @param \OCP\IConfig $config
-	 */
-	public function __construct(IConfig $config) {
-		$this->config = $config;
-	}
+    /**
+     * @param \OCP\IConfig $config
+     */
+    public function __construct(IConfig $config) {
+        $this->config = $config;
+    }
 
-	/**
-	* @brief Resynchronizes all sequences of a database after using INSERTs
-	*        without leaving out the auto-incremented column.
-	* @param \OC\DB\Connection $conn
-	* @return null
-	*/
-	public function resynchronizeDatabaseSequences(Connection $conn) {
-		$filterExpression = '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
-		$databaseName = $conn->getDatabase();
-		$conn->getConfiguration()->setFilterSchemaAssetsExpression($filterExpression);
+    /**
+     * @brief Resynchronizes all sequences of a database after using INSERTs
+     *        without leaving out the auto-incremented column.
+     * @param \OC\DB\Connection $conn
+     * @return null
+     */
+    public function resynchronizeDatabaseSequences(Connection $conn) {
+        $filterExpression = '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
+        $databaseName = $conn->getDatabase();
+        $conn->getConfiguration()->setFilterSchemaAssetsExpression($filterExpression);
 
-		foreach ($conn->getSchemaManager()->listSequences() as $sequence) {
-			$sequenceName = $sequence->getName();
-			$sqlInfo = 'SELECT table_schema, table_name, column_name
+        foreach ($conn->getSchemaManager()->listSequences() as $sequence) {
+            $sequenceName = $sequence->getName();
+            $sqlInfo = 'SELECT table_schema, table_name, column_name
 				FROM information_schema.columns
 				WHERE column_default = ? AND table_catalog = ?';
-			$sequenceInfo = $conn->fetchAssoc($sqlInfo, array(
-				"nextval('$sequenceName'::regclass)",
-				$databaseName
-			));
-			$tableName = $sequenceInfo['table_name'];
-			$columnName = $sequenceInfo['column_name'];
-			$sqlMaxId = "SELECT MAX($columnName) FROM $tableName";
-			$sqlSetval = "SELECT setval('$sequenceName', ($sqlMaxId))";
-			$conn->executeQuery($sqlSetval);
-		}
-	}
+            $sequenceInfo = $conn->fetchAssoc($sqlInfo, array(
+                "nextval('$sequenceName'::regclass)",
+                $databaseName
+            ));
+            $tableName = $sequenceInfo['table_name'];
+            $columnName = $sequenceInfo['column_name'];
+            $sqlMaxId = "SELECT MAX($columnName) FROM $tableName";
+            $sqlSetval = "SELECT setval('$sequenceName', ($sqlMaxId))";
+            $conn->executeQuery($sqlSetval);
+        }
+    }
 }

lib/private/DB/PostgreSqlMigrator.php

Indentation +25 added lines, -25 removed lines

@@ -25,32 +25,32 @@
 use Doctrine\DBAL\Schema\Schema;
 
 class PostgreSqlMigrator extends Migrator {
-	/**
-	 * @param Schema $targetSchema
-	 * @param \Doctrine\DBAL\Connection $connection
-	 * @return \Doctrine\DBAL\Schema\SchemaDiff
-	 */
-	protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
-		$schemaDiff = parent::getDiff($targetSchema, $connection);
+    /**
+     * @param Schema $targetSchema
+     * @param \Doctrine\DBAL\Connection $connection
+     * @return \Doctrine\DBAL\Schema\SchemaDiff
+     */
+    protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
+        $schemaDiff = parent::getDiff($targetSchema, $connection);
 
-		foreach ($schemaDiff->changedTables as $tableDiff) {
-			// fix default value in brackets - pg 9.4 is returning a negative default value in ()
-			// see https://github.com/doctrine/dbal/issues/2427
-			foreach ($tableDiff->changedColumns as $column) {
-				$column->changedProperties = array_filter($column->changedProperties, function ($changedProperties) use ($column) {
-					if ($changedProperties !== 'default') {
-						return true;
-					}
-					$fromDefault = $column->fromColumn->getDefault();
-					$toDefault = $column->column->getDefault();
-					$fromDefault = trim($fromDefault, "()");
+        foreach ($schemaDiff->changedTables as $tableDiff) {
+            // fix default value in brackets - pg 9.4 is returning a negative default value in ()
+            // see https://github.com/doctrine/dbal/issues/2427
+            foreach ($tableDiff->changedColumns as $column) {
+                $column->changedProperties = array_filter($column->changedProperties, function ($changedProperties) use ($column) {
+                    if ($changedProperties !== 'default') {
+                        return true;
+                    }
+                    $fromDefault = $column->fromColumn->getDefault();
+                    $toDefault = $column->column->getDefault();
+                    $fromDefault = trim($fromDefault, "()");
 
-					// by intention usage of !=
-					return $fromDefault != $toDefault;
-				});
-			}
-		}
+                    // by intention usage of !=
+                    return $fromDefault != $toDefault;
+                });
+            }
+        }
 
-		return $schemaDiff;
-	}
+        return $schemaDiff;
+    }
 }

lib/private/DB/AdapterMySQL.php

Indentation +27 added lines, -27 removed lines

@@ -27,31 +27,31 @@
 
 class AdapterMySQL extends Adapter {
 
-	/** @var string */
-	protected $charset;
-
-	/**
-	 * @param string $tableName
-	 */
-	public function lockTable($tableName) {
-		$this->conn->executeUpdate('LOCK TABLES `' .$tableName . '` WRITE');
-	}
-
-	public function unlockTable() {
-		$this->conn->executeUpdate('UNLOCK TABLES');
-	}
-
-	public function fixupStatement($statement) {
-		$statement = str_replace(' ILIKE ', ' COLLATE ' . $this->getCharset() . '_general_ci LIKE ', $statement);
-		return $statement;
-	}
-
-	protected function getCharset() {
-		if (!$this->charset) {
-			$params = $this->conn->getParams();
-			$this->charset = isset($params['charset']) ? $params['charset'] : 'utf8';
-		}
-
-		return $this->charset;
-	}
+    /** @var string */
+    protected $charset;
+
+    /**
+     * @param string $tableName
+     */
+    public function lockTable($tableName) {
+        $this->conn->executeUpdate('LOCK TABLES `' .$tableName . '` WRITE');
+    }
+
+    public function unlockTable() {
+        $this->conn->executeUpdate('UNLOCK TABLES');
+    }
+
+    public function fixupStatement($statement) {
+        $statement = str_replace(' ILIKE ', ' COLLATE ' . $this->getCharset() . '_general_ci LIKE ', $statement);
+        return $statement;
+    }
+
+    protected function getCharset() {
+        if (!$this->charset) {
+            $params = $this->conn->getParams();
+            $this->charset = isset($params['charset']) ? $params['charset'] : 'utf8';
+        }
+
+        return $this->charset;
+    }
 }

lib/private/DB/MigrationException.php

Indentation +11 added lines, -11 removed lines

@@ -25,17 +25,17 @@
 
 
 class MigrationException extends \Exception {
-	private $table;
+    private $table;
 
-	public function __construct($table, $message) {
-		$this->table = $table;
-		parent::__construct($message);
-	}
+    public function __construct($table, $message) {
+        $this->table = $table;
+        parent::__construct($message);
+    }
 
-	/**
-	 * @return string
-	 */
-	public function getTable() {
-		return $this->table;
-	}
+    /**
+     * @return string
+     */
+    public function getTable() {
+        return $this->table;
+    }
 }

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';
+    }
 }

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);
+    }
 }

lib/private/DB/AdapterPgSql.php

Indentation +9 added lines, -9 removed lines

@@ -25,14 +25,14 @@
 namespace OC\DB;
 
 class AdapterPgSql extends Adapter {
-	public function lastInsertId($table) {
-		return $this->conn->fetchColumn('SELECT lastval()');
-	}
+    public function lastInsertId($table) {
+        return $this->conn->fetchColumn('SELECT lastval()');
+    }
 
-	const UNIX_TIMESTAMP_REPLACEMENT = 'cast(extract(epoch from current_timestamp) as integer)';
-	public function fixupStatement($statement) {
-		$statement = str_replace( '`', '"', $statement );
-		$statement = str_ireplace( 'UNIX_TIMESTAMP()', self::UNIX_TIMESTAMP_REPLACEMENT, $statement );
-		return $statement;
-	}
+    const UNIX_TIMESTAMP_REPLACEMENT = 'cast(extract(epoch from current_timestamp) as integer)';
+    public function fixupStatement($statement) {
+        $statement = str_replace( '`', '"', $statement );
+        $statement = str_ireplace( 'UNIX_TIMESTAMP()', self::UNIX_TIMESTAMP_REPLACEMENT, $statement );
+        return $statement;
+    }
 }

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

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) {
-					/**
-					 * 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) {
+                    /**
+                     * 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";
+    }
 }