nextcloud / server

lib/private/DB/Connection.php

Indentation +406 added lines, -406 removed lines

@@ -48,410 +48,410 @@
 use OCP\PreConditionNotMetException;
 
 class Connection extends ReconnectWrapper implements IDBConnection {
-	/**
-	 * @var string $tablePrefix
-	 */
-	protected $tablePrefix;
-
-	/**
-	 * @var \OC\DB\Adapter $adapter
-	 */
-	protected $adapter;
-
-	protected $lockedTable = null;
-
-	public function connect() {
-		try {
-			return parent::connect();
-		} catch (DBALException $e) {
-			// throw a new exception to prevent leaking info from the stacktrace
-			throw new DBALException('Failed to connect to the database: ' . $e->getMessage(), $e->getCode());
-		}
-	}
-
-	/**
-	 * Returns a QueryBuilder for the connection.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder
-	 */
-	public function getQueryBuilder() {
-		return new QueryBuilder(
-			$this,
-			\OC::$server->getSystemConfig(),
-			\OC::$server->getLogger()
-		);
-	}
-
-	/**
-	 * Gets the QueryBuilder for the connection.
-	 *
-	 * @return \Doctrine\DBAL\Query\QueryBuilder
-	 * @deprecated please use $this->getQueryBuilder() instead
-	 */
-	public function createQueryBuilder() {
-		$backtrace = $this->getCallerBacktrace();
-		\OC::$server->getLogger()->debug('Doctrine QueryBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
-		return parent::createQueryBuilder();
-	}
-
-	/**
-	 * Gets the ExpressionBuilder for the connection.
-	 *
-	 * @return \Doctrine\DBAL\Query\Expression\ExpressionBuilder
-	 * @deprecated please use $this->getQueryBuilder()->expr() instead
-	 */
-	public function getExpressionBuilder() {
-		$backtrace = $this->getCallerBacktrace();
-		\OC::$server->getLogger()->debug('Doctrine ExpressionBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
-		return parent::getExpressionBuilder();
-	}
-
-	/**
-	 * Get the file and line that called the method where `getCallerBacktrace()` was used
-	 *
-	 * @return string
-	 */
-	protected function getCallerBacktrace() {
-		$traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
-
-		// 0 is the method where we use `getCallerBacktrace`
-		// 1 is the target method which uses the method we want to log
-		if (isset($traces[1])) {
-			return $traces[1]['file'] . ':' . $traces[1]['line'];
-		}
-
-		return '';
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getPrefix() {
-		return $this->tablePrefix;
-	}
-
-	/**
-	 * Initializes a new instance of the Connection class.
-	 *
-	 * @param array $params  The connection parameters.
-	 * @param \Doctrine\DBAL\Driver $driver
-	 * @param \Doctrine\DBAL\Configuration $config
-	 * @param \Doctrine\Common\EventManager $eventManager
-	 * @throws \Exception
-	 */
-	public function __construct(array $params, Driver $driver, Configuration $config = null,
-		EventManager $eventManager = null)
-	{
-		if (!isset($params['adapter'])) {
-			throw new \Exception('adapter not set');
-		}
-		if (!isset($params['tablePrefix'])) {
-			throw new \Exception('tablePrefix not set');
-		}
-		parent::__construct($params, $driver, $config, $eventManager);
-		$this->adapter = new $params['adapter']($this);
-		$this->tablePrefix = $params['tablePrefix'];
-	}
-
-	/**
-	 * Prepares an SQL statement.
-	 *
-	 * @param string $statement The SQL statement to prepare.
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \Doctrine\DBAL\Driver\Statement The prepared statement.
-	 */
-	public function prepare( $statement, $limit=null, $offset=null ) {
-		if ($limit === -1) {
-			$limit = null;
-		}
-		if (!is_null($limit)) {
-			$platform = $this->getDatabasePlatform();
-			$statement = $platform->modifyLimitQuery($statement, $limit, $offset);
-		}
-		$statement = $this->replaceTablePrefix($statement);
-		$statement = $this->adapter->fixupStatement($statement);
-
-		return parent::prepare($statement);
-	}
-
-	/**
-	 * Executes an, optionally parametrized, SQL query.
-	 *
-	 * If the query is parametrized, a prepared statement is used.
-	 * If an SQLLogger is configured, the execution is logged.
-	 *
-	 * @param string                                      $query  The SQL query to execute.
-	 * @param array                                       $params The parameters to bind to the query, if any.
-	 * @param array                                       $types  The types the previous parameters are in.
-	 * @param \Doctrine\DBAL\Cache\QueryCacheProfile|null $qcp    The query cache profile, optional.
-	 *
-	 * @return \Doctrine\DBAL\Driver\Statement The executed statement.
-	 *
-	 * @throws \Doctrine\DBAL\DBALException
-	 */
-	public function executeQuery($query, array $params = array(), $types = array(), QueryCacheProfile $qcp = null)
-	{
-		$query = $this->replaceTablePrefix($query);
-		$query = $this->adapter->fixupStatement($query);
-		return parent::executeQuery($query, $params, $types, $qcp);
-	}
-
-	/**
-	 * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters
-	 * and returns the number of affected rows.
-	 *
-	 * This method supports PDO binding types as well as DBAL mapping types.
-	 *
-	 * @param string $query  The SQL query.
-	 * @param array  $params The query parameters.
-	 * @param array  $types  The parameter types.
-	 *
-	 * @return integer The number of affected rows.
-	 *
-	 * @throws \Doctrine\DBAL\DBALException
-	 */
-	public function executeUpdate($query, array $params = array(), array $types = array())
-	{
-		$query = $this->replaceTablePrefix($query);
-		$query = $this->adapter->fixupStatement($query);
-		return parent::executeUpdate($query, $params, $types);
-	}
-
-	/**
-	 * Returns the ID of the last inserted row, or the last value from a sequence object,
-	 * depending on the underlying driver.
-	 *
-	 * Note: This method may not return a meaningful or consistent result across different drivers,
-	 * because the underlying database may not even support the notion of AUTO_INCREMENT/IDENTITY
-	 * columns or sequences.
-	 *
-	 * @param string $seqName Name of the sequence object from which the ID should be returned.
-	 * @return string A string representation of the last inserted ID.
-	 */
-	public function lastInsertId($seqName = null) {
-		if ($seqName) {
-			$seqName = $this->replaceTablePrefix($seqName);
-		}
-		return $this->adapter->lastInsertId($seqName);
-	}
-
-	// internal use
-	public function realLastInsertId($seqName = null) {
-		return parent::lastInsertId($seqName);
-	}
-
-	/**
-	 * Insert a row if the matching row does not exists. To accomplish proper race condition avoidance
-	 * it is needed that there is also a unique constraint on the values. Then this method will
-	 * catch the exception and return 0.
-	 *
-	 * @param string $table The table name (will replace *PREFIX* with the actual prefix)
-	 * @param array $input data that should be inserted into the table  (column name => value)
-	 * @param array|null $compare List of values that should be checked for "if not exists"
-	 *				If this is null or an empty array, all keys of $input will be compared
-	 *				Please note: text fields (clob) must not be used in the compare array
-	 * @return int number of inserted rows
-	 * @throws \Doctrine\DBAL\DBALException
-	 * @deprecated 15.0.0 - use unique index and "try { $db->insert() } catch (UniqueConstraintViolationException $e) {}" instead, because it is more reliable and does not have the risk for deadlocks - see https://github.com/nextcloud/server/pull/12371
-	 */
-	public function insertIfNotExist($table, $input, array $compare = null) {
-		return $this->adapter->insertIfNotExist($table, $input, $compare);
-	}
-
-	public function insertIgnoreConflict(string $table, array $values) : int {
-		return $this->adapter->insertIgnoreConflict($table, $values);
-	}
-
-	private function getType($value) {
-		if (is_bool($value)) {
-			return IQueryBuilder::PARAM_BOOL;
-		} else if (is_int($value)) {
-			return IQueryBuilder::PARAM_INT;
-		} else {
-			return IQueryBuilder::PARAM_STR;
-		}
-	}
-
-	/**
-	 * Insert or update a row value
-	 *
-	 * @param string $table
-	 * @param array $keys (column name => value)
-	 * @param array $values (column name => value)
-	 * @param array $updatePreconditionValues ensure values match preconditions (column name => value)
-	 * @return int number of new rows
-	 * @throws \Doctrine\DBAL\DBALException
-	 * @throws PreConditionNotMetException
-	 * @suppress SqlInjectionChecker
-	 */
-	public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []) {
-		try {
-			$insertQb = $this->getQueryBuilder();
-			$insertQb->insert($table)
-				->values(
-					array_map(function($value) use ($insertQb) {
-						return $insertQb->createNamedParameter($value, $this->getType($value));
-					}, array_merge($keys, $values))
-				);
-			return $insertQb->execute();
-		} catch (ConstraintViolationException $e) {
-			// value already exists, try update
-			$updateQb = $this->getQueryBuilder();
-			$updateQb->update($table);
-			foreach ($values as $name => $value) {
-				$updateQb->set($name, $updateQb->createNamedParameter($value, $this->getType($value)));
-			}
-			$where = $updateQb->expr()->andX();
-			$whereValues = array_merge($keys, $updatePreconditionValues);
-			foreach ($whereValues as $name => $value) {
-				$where->add($updateQb->expr()->eq(
-					$name,
-					$updateQb->createNamedParameter($value, $this->getType($value)),
-					$this->getType($value)
-				));
-			}
-			$updateQb->where($where);
-			$affected = $updateQb->execute();
-
-			if ($affected === 0 && !empty($updatePreconditionValues)) {
-				throw new PreConditionNotMetException();
-			}
-
-			return 0;
-		}
-	}
-
-	/**
-	 * Create an exclusive read+write lock on a table
-	 *
-	 * @param string $tableName
-	 * @throws \BadMethodCallException When trying to acquire a second lock
-	 * @since 9.1.0
-	 */
-	public function lockTable($tableName) {
-		if ($this->lockedTable !== null) {
-			throw new \BadMethodCallException('Can not lock a new table until the previous lock is released.');
-		}
-
-		$tableName = $this->tablePrefix . $tableName;
-		$this->lockedTable = $tableName;
-		$this->adapter->lockTable($tableName);
-	}
-
-	/**
-	 * Release a previous acquired lock again
-	 *
-	 * @since 9.1.0
-	 */
-	public function unlockTable() {
-		$this->adapter->unlockTable();
-		$this->lockedTable = null;
-	}
-
-	/**
-	 * returns the error code and message as a string for logging
-	 * works with DoctrineException
-	 * @return string
-	 */
-	public function getError() {
-		$msg = $this->errorCode() . ': ';
-		$errorInfo = $this->errorInfo();
-		if (is_array($errorInfo)) {
-			$msg .= 'SQLSTATE = '.$errorInfo[0] . ', ';
-			$msg .= 'Driver Code = '.$errorInfo[1] . ', ';
-			$msg .= 'Driver Message = '.$errorInfo[2];
-		}
-		return $msg;
-	}
-
-	/**
-	 * Drop a table from the database if it exists
-	 *
-	 * @param string $table table name without the prefix
-	 */
-	public function dropTable($table) {
-		$table = $this->tablePrefix . trim($table);
-		$schema = $this->getSchemaManager();
-		if($schema->tablesExist(array($table))) {
-			$schema->dropTable($table);
-		}
-	}
-
-	/**
-	 * Check if a table exists
-	 *
-	 * @param string $table table name without the prefix
-	 * @return bool
-	 */
-	public function tableExists($table){
-		$table = $this->tablePrefix . trim($table);
-		$schema = $this->getSchemaManager();
-		return $schema->tablesExist(array($table));
-	}
-
-	// internal use
-	/**
-	 * @param string $statement
-	 * @return string
-	 */
-	protected function replaceTablePrefix($statement) {
-		return str_replace( '*PREFIX*', $this->tablePrefix, $statement );
-	}
-
-	/**
-	 * Check if a transaction is active
-	 *
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function inTransaction() {
-		return $this->getTransactionNestingLevel() > 0;
-	}
-
-	/**
-	 * Escape a parameter to be used in a LIKE query
-	 *
-	 * @param string $param
-	 * @return string
-	 */
-	public function escapeLikeParameter($param) {
-		return addcslashes($param, '\\_%');
-	}
-
-	/**
-	 * Check whether or not the current database support 4byte wide unicode
-	 *
-	 * @return bool
-	 * @since 11.0.0
-	 */
-	public function supports4ByteText() {
-		if (!$this->getDatabasePlatform() instanceof MySqlPlatform) {
-			return true;
-		}
-		return $this->getParams()['charset'] === 'utf8mb4';
-	}
-
-
-	/**
-	 * Create the schema of the connected database
-	 *
-	 * @return Schema
-	 */
-	public function createSchema() {
-		$schemaManager = new MDB2SchemaManager($this);
-		$migrator = $schemaManager->getMigrator();
-		return $migrator->createSchema();
-	}
-
-	/**
-	 * Migrate the database to the given schema
-	 *
-	 * @param Schema $toSchema
-	 */
-	public function migrateToSchema(Schema $toSchema) {
-		$schemaManager = new MDB2SchemaManager($this);
-		$migrator = $schemaManager->getMigrator();
-		$migrator->migrate($toSchema);
-	}
+    /**
+     * @var string $tablePrefix
+     */
+    protected $tablePrefix;
+
+    /**
+     * @var \OC\DB\Adapter $adapter
+     */
+    protected $adapter;
+
+    protected $lockedTable = null;
+
+    public function connect() {
+        try {
+            return parent::connect();
+        } catch (DBALException $e) {
+            // throw a new exception to prevent leaking info from the stacktrace
+            throw new DBALException('Failed to connect to the database: ' . $e->getMessage(), $e->getCode());
+        }
+    }
+
+    /**
+     * Returns a QueryBuilder for the connection.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder
+     */
+    public function getQueryBuilder() {
+        return new QueryBuilder(
+            $this,
+            \OC::$server->getSystemConfig(),
+            \OC::$server->getLogger()
+        );
+    }
+
+    /**
+     * Gets the QueryBuilder for the connection.
+     *
+     * @return \Doctrine\DBAL\Query\QueryBuilder
+     * @deprecated please use $this->getQueryBuilder() instead
+     */
+    public function createQueryBuilder() {
+        $backtrace = $this->getCallerBacktrace();
+        \OC::$server->getLogger()->debug('Doctrine QueryBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
+        return parent::createQueryBuilder();
+    }
+
+    /**
+     * Gets the ExpressionBuilder for the connection.
+     *
+     * @return \Doctrine\DBAL\Query\Expression\ExpressionBuilder
+     * @deprecated please use $this->getQueryBuilder()->expr() instead
+     */
+    public function getExpressionBuilder() {
+        $backtrace = $this->getCallerBacktrace();
+        \OC::$server->getLogger()->debug('Doctrine ExpressionBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
+        return parent::getExpressionBuilder();
+    }
+
+    /**
+     * Get the file and line that called the method where `getCallerBacktrace()` was used
+     *
+     * @return string
+     */
+    protected function getCallerBacktrace() {
+        $traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
+
+        // 0 is the method where we use `getCallerBacktrace`
+        // 1 is the target method which uses the method we want to log
+        if (isset($traces[1])) {
+            return $traces[1]['file'] . ':' . $traces[1]['line'];
+        }
+
+        return '';
+    }
+
+    /**
+     * @return string
+     */
+    public function getPrefix() {
+        return $this->tablePrefix;
+    }
+
+    /**
+     * Initializes a new instance of the Connection class.
+     *
+     * @param array $params  The connection parameters.
+     * @param \Doctrine\DBAL\Driver $driver
+     * @param \Doctrine\DBAL\Configuration $config
+     * @param \Doctrine\Common\EventManager $eventManager
+     * @throws \Exception
+     */
+    public function __construct(array $params, Driver $driver, Configuration $config = null,
+        EventManager $eventManager = null)
+    {
+        if (!isset($params['adapter'])) {
+            throw new \Exception('adapter not set');
+        }
+        if (!isset($params['tablePrefix'])) {
+            throw new \Exception('tablePrefix not set');
+        }
+        parent::__construct($params, $driver, $config, $eventManager);
+        $this->adapter = new $params['adapter']($this);
+        $this->tablePrefix = $params['tablePrefix'];
+    }
+
+    /**
+     * Prepares an SQL statement.
+     *
+     * @param string $statement The SQL statement to prepare.
+     * @param int $limit
+     * @param int $offset
+     * @return \Doctrine\DBAL\Driver\Statement The prepared statement.
+     */
+    public function prepare( $statement, $limit=null, $offset=null ) {
+        if ($limit === -1) {
+            $limit = null;
+        }
+        if (!is_null($limit)) {
+            $platform = $this->getDatabasePlatform();
+            $statement = $platform->modifyLimitQuery($statement, $limit, $offset);
+        }
+        $statement = $this->replaceTablePrefix($statement);
+        $statement = $this->adapter->fixupStatement($statement);
+
+        return parent::prepare($statement);
+    }
+
+    /**
+     * Executes an, optionally parametrized, SQL query.
+     *
+     * If the query is parametrized, a prepared statement is used.
+     * If an SQLLogger is configured, the execution is logged.
+     *
+     * @param string                                      $query  The SQL query to execute.
+     * @param array                                       $params The parameters to bind to the query, if any.
+     * @param array                                       $types  The types the previous parameters are in.
+     * @param \Doctrine\DBAL\Cache\QueryCacheProfile|null $qcp    The query cache profile, optional.
+     *
+     * @return \Doctrine\DBAL\Driver\Statement The executed statement.
+     *
+     * @throws \Doctrine\DBAL\DBALException
+     */
+    public function executeQuery($query, array $params = array(), $types = array(), QueryCacheProfile $qcp = null)
+    {
+        $query = $this->replaceTablePrefix($query);
+        $query = $this->adapter->fixupStatement($query);
+        return parent::executeQuery($query, $params, $types, $qcp);
+    }
+
+    /**
+     * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters
+     * and returns the number of affected rows.
+     *
+     * This method supports PDO binding types as well as DBAL mapping types.
+     *
+     * @param string $query  The SQL query.
+     * @param array  $params The query parameters.
+     * @param array  $types  The parameter types.
+     *
+     * @return integer The number of affected rows.
+     *
+     * @throws \Doctrine\DBAL\DBALException
+     */
+    public function executeUpdate($query, array $params = array(), array $types = array())
+    {
+        $query = $this->replaceTablePrefix($query);
+        $query = $this->adapter->fixupStatement($query);
+        return parent::executeUpdate($query, $params, $types);
+    }
+
+    /**
+     * Returns the ID of the last inserted row, or the last value from a sequence object,
+     * depending on the underlying driver.
+     *
+     * Note: This method may not return a meaningful or consistent result across different drivers,
+     * because the underlying database may not even support the notion of AUTO_INCREMENT/IDENTITY
+     * columns or sequences.
+     *
+     * @param string $seqName Name of the sequence object from which the ID should be returned.
+     * @return string A string representation of the last inserted ID.
+     */
+    public function lastInsertId($seqName = null) {
+        if ($seqName) {
+            $seqName = $this->replaceTablePrefix($seqName);
+        }
+        return $this->adapter->lastInsertId($seqName);
+    }
+
+    // internal use
+    public function realLastInsertId($seqName = null) {
+        return parent::lastInsertId($seqName);
+    }
+
+    /**
+     * Insert a row if the matching row does not exists. To accomplish proper race condition avoidance
+     * it is needed that there is also a unique constraint on the values. Then this method will
+     * catch the exception and return 0.
+     *
+     * @param string $table The table name (will replace *PREFIX* with the actual prefix)
+     * @param array $input data that should be inserted into the table  (column name => value)
+     * @param array|null $compare List of values that should be checked for "if not exists"
+     *				If this is null or an empty array, all keys of $input will be compared
+     *				Please note: text fields (clob) must not be used in the compare array
+     * @return int number of inserted rows
+     * @throws \Doctrine\DBAL\DBALException
+     * @deprecated 15.0.0 - use unique index and "try { $db->insert() } catch (UniqueConstraintViolationException $e) {}" instead, because it is more reliable and does not have the risk for deadlocks - see https://github.com/nextcloud/server/pull/12371
+     */
+    public function insertIfNotExist($table, $input, array $compare = null) {
+        return $this->adapter->insertIfNotExist($table, $input, $compare);
+    }
+
+    public function insertIgnoreConflict(string $table, array $values) : int {
+        return $this->adapter->insertIgnoreConflict($table, $values);
+    }
+
+    private function getType($value) {
+        if (is_bool($value)) {
+            return IQueryBuilder::PARAM_BOOL;
+        } else if (is_int($value)) {
+            return IQueryBuilder::PARAM_INT;
+        } else {
+            return IQueryBuilder::PARAM_STR;
+        }
+    }
+
+    /**
+     * Insert or update a row value
+     *
+     * @param string $table
+     * @param array $keys (column name => value)
+     * @param array $values (column name => value)
+     * @param array $updatePreconditionValues ensure values match preconditions (column name => value)
+     * @return int number of new rows
+     * @throws \Doctrine\DBAL\DBALException
+     * @throws PreConditionNotMetException
+     * @suppress SqlInjectionChecker
+     */
+    public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []) {
+        try {
+            $insertQb = $this->getQueryBuilder();
+            $insertQb->insert($table)
+                ->values(
+                    array_map(function($value) use ($insertQb) {
+                        return $insertQb->createNamedParameter($value, $this->getType($value));
+                    }, array_merge($keys, $values))
+                );
+            return $insertQb->execute();
+        } catch (ConstraintViolationException $e) {
+            // value already exists, try update
+            $updateQb = $this->getQueryBuilder();
+            $updateQb->update($table);
+            foreach ($values as $name => $value) {
+                $updateQb->set($name, $updateQb->createNamedParameter($value, $this->getType($value)));
+            }
+            $where = $updateQb->expr()->andX();
+            $whereValues = array_merge($keys, $updatePreconditionValues);
+            foreach ($whereValues as $name => $value) {
+                $where->add($updateQb->expr()->eq(
+                    $name,
+                    $updateQb->createNamedParameter($value, $this->getType($value)),
+                    $this->getType($value)
+                ));
+            }
+            $updateQb->where($where);
+            $affected = $updateQb->execute();
+
+            if ($affected === 0 && !empty($updatePreconditionValues)) {
+                throw new PreConditionNotMetException();
+            }
+
+            return 0;
+        }
+    }
+
+    /**
+     * Create an exclusive read+write lock on a table
+     *
+     * @param string $tableName
+     * @throws \BadMethodCallException When trying to acquire a second lock
+     * @since 9.1.0
+     */
+    public function lockTable($tableName) {
+        if ($this->lockedTable !== null) {
+            throw new \BadMethodCallException('Can not lock a new table until the previous lock is released.');
+        }
+
+        $tableName = $this->tablePrefix . $tableName;
+        $this->lockedTable = $tableName;
+        $this->adapter->lockTable($tableName);
+    }
+
+    /**
+     * Release a previous acquired lock again
+     *
+     * @since 9.1.0
+     */
+    public function unlockTable() {
+        $this->adapter->unlockTable();
+        $this->lockedTable = null;
+    }
+
+    /**
+     * returns the error code and message as a string for logging
+     * works with DoctrineException
+     * @return string
+     */
+    public function getError() {
+        $msg = $this->errorCode() . ': ';
+        $errorInfo = $this->errorInfo();
+        if (is_array($errorInfo)) {
+            $msg .= 'SQLSTATE = '.$errorInfo[0] . ', ';
+            $msg .= 'Driver Code = '.$errorInfo[1] . ', ';
+            $msg .= 'Driver Message = '.$errorInfo[2];
+        }
+        return $msg;
+    }
+
+    /**
+     * Drop a table from the database if it exists
+     *
+     * @param string $table table name without the prefix
+     */
+    public function dropTable($table) {
+        $table = $this->tablePrefix . trim($table);
+        $schema = $this->getSchemaManager();
+        if($schema->tablesExist(array($table))) {
+            $schema->dropTable($table);
+        }
+    }
+
+    /**
+     * Check if a table exists
+     *
+     * @param string $table table name without the prefix
+     * @return bool
+     */
+    public function tableExists($table){
+        $table = $this->tablePrefix . trim($table);
+        $schema = $this->getSchemaManager();
+        return $schema->tablesExist(array($table));
+    }
+
+    // internal use
+    /**
+     * @param string $statement
+     * @return string
+     */
+    protected function replaceTablePrefix($statement) {
+        return str_replace( '*PREFIX*', $this->tablePrefix, $statement );
+    }
+
+    /**
+     * Check if a transaction is active
+     *
+     * @return bool
+     * @since 8.2.0
+     */
+    public function inTransaction() {
+        return $this->getTransactionNestingLevel() > 0;
+    }
+
+    /**
+     * Escape a parameter to be used in a LIKE query
+     *
+     * @param string $param
+     * @return string
+     */
+    public function escapeLikeParameter($param) {
+        return addcslashes($param, '\\_%');
+    }
+
+    /**
+     * Check whether or not the current database support 4byte wide unicode
+     *
+     * @return bool
+     * @since 11.0.0
+     */
+    public function supports4ByteText() {
+        if (!$this->getDatabasePlatform() instanceof MySqlPlatform) {
+            return true;
+        }
+        return $this->getParams()['charset'] === 'utf8mb4';
+    }
+
+
+    /**
+     * Create the schema of the connected database
+     *
+     * @return Schema
+     */
+    public function createSchema() {
+        $schemaManager = new MDB2SchemaManager($this);
+        $migrator = $schemaManager->getMigrator();
+        return $migrator->createSchema();
+    }
+
+    /**
+     * Migrate the database to the given schema
+     *
+     * @param Schema $toSchema
+     */
+    public function migrateToSchema(Schema $toSchema) {
+        $schemaManager = new MDB2SchemaManager($this);
+        $migrator = $schemaManager->getMigrator();
+        $migrator->migrate($toSchema);
+    }
 }

lib/private/DB/ConnectionFactory.php

Indentation +194 added lines, -194 removed lines

@@ -39,219 +39,219 @@
  * Takes care of creating and configuring Doctrine connections.
  */
 class ConnectionFactory {
-	/** @var string default database name */
-	const DEFAULT_DBNAME = 'owncloud';
+    /** @var string default database name */
+    const DEFAULT_DBNAME = 'owncloud';
 
-	/** @var string default database table prefix */
-	const DEFAULT_DBTABLEPREFIX = 'oc_';
+    /** @var string default database table prefix */
+    const DEFAULT_DBTABLEPREFIX = 'oc_';
 
-	/**
-	 * @var array
-	 *
-	 * Array mapping DBMS type to default connection parameters passed to
-	 * \Doctrine\DBAL\DriverManager::getConnection().
-	 */
-	protected $defaultConnectionParams = [
-		'mysql' => [
-			'adapter' => AdapterMySQL::class,
-			'charset' => 'UTF8',
-			'driver' => 'pdo_mysql',
-			'wrapperClass' => Connection::class,
-		],
-		'oci' => [
-			'adapter' => AdapterOCI8::class,
-			'charset' => 'AL32UTF8',
-			'driver' => 'oci8',
-			'wrapperClass' => OracleConnection::class,
-		],
-		'pgsql' => [
-			'adapter' => AdapterPgSql::class,
-			'driver' => 'pdo_pgsql',
-			'wrapperClass' => Connection::class,
-		],
-		'sqlite3' => [
-			'adapter' => AdapterSqlite::class,
-			'driver' => 'pdo_sqlite',
-			'wrapperClass' => Connection::class,
-		],
-	];
+    /**
+     * @var array
+     *
+     * Array mapping DBMS type to default connection parameters passed to
+     * \Doctrine\DBAL\DriverManager::getConnection().
+     */
+    protected $defaultConnectionParams = [
+        'mysql' => [
+            'adapter' => AdapterMySQL::class,
+            'charset' => 'UTF8',
+            'driver' => 'pdo_mysql',
+            'wrapperClass' => Connection::class,
+        ],
+        'oci' => [
+            'adapter' => AdapterOCI8::class,
+            'charset' => 'AL32UTF8',
+            'driver' => 'oci8',
+            'wrapperClass' => OracleConnection::class,
+        ],
+        'pgsql' => [
+            'adapter' => AdapterPgSql::class,
+            'driver' => 'pdo_pgsql',
+            'wrapperClass' => Connection::class,
+        ],
+        'sqlite3' => [
+            'adapter' => AdapterSqlite::class,
+            'driver' => 'pdo_sqlite',
+            'wrapperClass' => Connection::class,
+        ],
+    ];
 
-	/** @var SystemConfig */
-	private $config;
+    /** @var SystemConfig */
+    private $config;
 
-	/**
-	 * ConnectionFactory constructor.
-	 *
-	 * @param SystemConfig $systemConfig
-	 */
-	public function __construct(SystemConfig $systemConfig) {
-		$this->config = $systemConfig;
-		if ($this->config->getValue('mysql.utf8mb4', false)) {
-			$this->defaultConnectionParams['mysql']['charset'] = 'utf8mb4';
-		}
-	}
+    /**
+     * ConnectionFactory constructor.
+     *
+     * @param SystemConfig $systemConfig
+     */
+    public function __construct(SystemConfig $systemConfig) {
+        $this->config = $systemConfig;
+        if ($this->config->getValue('mysql.utf8mb4', false)) {
+            $this->defaultConnectionParams['mysql']['charset'] = 'utf8mb4';
+        }
+    }
 
-	/**
-	 * @brief Get default connection parameters for a given DBMS.
-	 * @param string $type DBMS type
-	 * @throws \InvalidArgumentException If $type is invalid
-	 * @return array Default connection parameters.
-	 */
-	public function getDefaultConnectionParams($type) {
-		$normalizedType = $this->normalizeType($type);
-		if (!isset($this->defaultConnectionParams[$normalizedType])) {
-			throw new \InvalidArgumentException("Unsupported type: $type");
-		}
-		$result = $this->defaultConnectionParams[$normalizedType];
-		// \PDO::MYSQL_ATTR_FOUND_ROWS may not be defined, e.g. when the MySQL
-		// driver is missing. In this case, we won't be able to connect anyway.
-		if ($normalizedType === 'mysql' && defined('\PDO::MYSQL_ATTR_FOUND_ROWS')) {
-			$result['driverOptions'] = array(
-				\PDO::MYSQL_ATTR_FOUND_ROWS => true,
-			);
-		}
-		return $result;
-	}
+    /**
+     * @brief Get default connection parameters for a given DBMS.
+     * @param string $type DBMS type
+     * @throws \InvalidArgumentException If $type is invalid
+     * @return array Default connection parameters.
+     */
+    public function getDefaultConnectionParams($type) {
+        $normalizedType = $this->normalizeType($type);
+        if (!isset($this->defaultConnectionParams[$normalizedType])) {
+            throw new \InvalidArgumentException("Unsupported type: $type");
+        }
+        $result = $this->defaultConnectionParams[$normalizedType];
+        // \PDO::MYSQL_ATTR_FOUND_ROWS may not be defined, e.g. when the MySQL
+        // driver is missing. In this case, we won't be able to connect anyway.
+        if ($normalizedType === 'mysql' && defined('\PDO::MYSQL_ATTR_FOUND_ROWS')) {
+            $result['driverOptions'] = array(
+                \PDO::MYSQL_ATTR_FOUND_ROWS => true,
+            );
+        }
+        return $result;
+    }
 
-	/**
-	 * @brief Get default connection parameters for a given DBMS.
-	 * @param string $type DBMS type
-	 * @param array $additionalConnectionParams Additional connection parameters
-	 * @return \OC\DB\Connection
-	 */
-	public function getConnection($type, $additionalConnectionParams) {
-		$normalizedType = $this->normalizeType($type);
-		$eventManager = new EventManager();
-		$eventManager->addEventSubscriber(new SetTransactionIsolationLevel());
-		switch ($normalizedType) {
-			case 'mysql':
-				$eventManager->addEventSubscriber(
-					new SQLSessionInit("SET SESSION AUTOCOMMIT=1"));
-				break;
-			case 'oci':
-				$eventManager->addEventSubscriber(new OracleSessionInit);
-				// the driverOptions are unused in dbal and need to be mapped to the parameters
-				if (isset($additionalConnectionParams['driverOptions'])) {
-					$additionalConnectionParams = array_merge($additionalConnectionParams, $additionalConnectionParams['driverOptions']);
-				}
-				$host = $additionalConnectionParams['host'];
-				$port = isset($additionalConnectionParams['port']) ? $additionalConnectionParams['port'] : null;
-				$dbName = $additionalConnectionParams['dbname'];
+    /**
+     * @brief Get default connection parameters for a given DBMS.
+     * @param string $type DBMS type
+     * @param array $additionalConnectionParams Additional connection parameters
+     * @return \OC\DB\Connection
+     */
+    public function getConnection($type, $additionalConnectionParams) {
+        $normalizedType = $this->normalizeType($type);
+        $eventManager = new EventManager();
+        $eventManager->addEventSubscriber(new SetTransactionIsolationLevel());
+        switch ($normalizedType) {
+            case 'mysql':
+                $eventManager->addEventSubscriber(
+                    new SQLSessionInit("SET SESSION AUTOCOMMIT=1"));
+                break;
+            case 'oci':
+                $eventManager->addEventSubscriber(new OracleSessionInit);
+                // the driverOptions are unused in dbal and need to be mapped to the parameters
+                if (isset($additionalConnectionParams['driverOptions'])) {
+                    $additionalConnectionParams = array_merge($additionalConnectionParams, $additionalConnectionParams['driverOptions']);
+                }
+                $host = $additionalConnectionParams['host'];
+                $port = isset($additionalConnectionParams['port']) ? $additionalConnectionParams['port'] : null;
+                $dbName = $additionalConnectionParams['dbname'];
 
-				// we set the connect string as dbname and unset the host to coerce doctrine into using it as connect string
-				if ($host === '') {
-					$additionalConnectionParams['dbname'] = $dbName; // use dbname as easy connect name
-				} else {
-					$additionalConnectionParams['dbname'] = '//' . $host . (!empty($port) ? ":{$port}" : "") . '/' . $dbName;
-				}
-				unset($additionalConnectionParams['host']);
-				break;
+                // we set the connect string as dbname and unset the host to coerce doctrine into using it as connect string
+                if ($host === '') {
+                    $additionalConnectionParams['dbname'] = $dbName; // use dbname as easy connect name
+                } else {
+                    $additionalConnectionParams['dbname'] = '//' . $host . (!empty($port) ? ":{$port}" : "") . '/' . $dbName;
+                }
+                unset($additionalConnectionParams['host']);
+                break;
 
-			case 'sqlite3':
-				$journalMode = $additionalConnectionParams['sqlite.journal_mode'];
-				$additionalConnectionParams['platform'] = new OCSqlitePlatform();
-				$eventManager->addEventSubscriber(new SQLiteSessionInit(true, $journalMode));
-				break;
-		}
-		/** @var Connection $connection */
-		$connection = DriverManager::getConnection(
-			array_merge($this->getDefaultConnectionParams($type), $additionalConnectionParams),
-			new Configuration(),
-			$eventManager
-		);
-		return $connection;
-	}
+            case 'sqlite3':
+                $journalMode = $additionalConnectionParams['sqlite.journal_mode'];
+                $additionalConnectionParams['platform'] = new OCSqlitePlatform();
+                $eventManager->addEventSubscriber(new SQLiteSessionInit(true, $journalMode));
+                break;
+        }
+        /** @var Connection $connection */
+        $connection = DriverManager::getConnection(
+            array_merge($this->getDefaultConnectionParams($type), $additionalConnectionParams),
+            new Configuration(),
+            $eventManager
+        );
+        return $connection;
+    }
 
-	/**
-	 * @brief Normalize DBMS type
-	 * @param string $type DBMS type
-	 * @return string Normalized DBMS type
-	 */
-	public function normalizeType($type) {
-		return $type === 'sqlite' ? 'sqlite3' : $type;
-	}
+    /**
+     * @brief Normalize DBMS type
+     * @param string $type DBMS type
+     * @return string Normalized DBMS type
+     */
+    public function normalizeType($type) {
+        return $type === 'sqlite' ? 'sqlite3' : $type;
+    }
 
-	/**
-	 * Checks whether the specified DBMS type is valid.
-	 *
-	 * @param string $type
-	 * @return bool
-	 */
-	public function isValidType($type) {
-		$normalizedType = $this->normalizeType($type);
-		return isset($this->defaultConnectionParams[$normalizedType]);
-	}
+    /**
+     * Checks whether the specified DBMS type is valid.
+     *
+     * @param string $type
+     * @return bool
+     */
+    public function isValidType($type) {
+        $normalizedType = $this->normalizeType($type);
+        return isset($this->defaultConnectionParams[$normalizedType]);
+    }
 
-	/**
-	 * Create the connection parameters for the config
-	 *
-	 * @return array
-	 */
-	public function createConnectionParams() {
-		$type = $this->config->getValue('dbtype', 'sqlite');
+    /**
+     * Create the connection parameters for the config
+     *
+     * @return array
+     */
+    public function createConnectionParams() {
+        $type = $this->config->getValue('dbtype', 'sqlite');
 
-		$connectionParams = [
-			'user' => $this->config->getValue('dbuser', ''),
-			'password' => $this->config->getValue('dbpassword', ''),
-		];
-		$name = $this->config->getValue('dbname', self::DEFAULT_DBNAME);
+        $connectionParams = [
+            'user' => $this->config->getValue('dbuser', ''),
+            'password' => $this->config->getValue('dbpassword', ''),
+        ];
+        $name = $this->config->getValue('dbname', self::DEFAULT_DBNAME);
 
-		if ($this->normalizeType($type) === 'sqlite3') {
-			$dataDir = $this->config->getValue("datadirectory", \OC::$SERVERROOT . '/data');
-			$connectionParams['path'] = $dataDir . '/' . $name . '.db';
-		} else {
-			$host = $this->config->getValue('dbhost', '');
-			$connectionParams = array_merge($connectionParams, $this->splitHostFromPortAndSocket($host));
-			$connectionParams['dbname'] = $name;
-		}
+        if ($this->normalizeType($type) === 'sqlite3') {
+            $dataDir = $this->config->getValue("datadirectory", \OC::$SERVERROOT . '/data');
+            $connectionParams['path'] = $dataDir . '/' . $name . '.db';
+        } else {
+            $host = $this->config->getValue('dbhost', '');
+            $connectionParams = array_merge($connectionParams, $this->splitHostFromPortAndSocket($host));
+            $connectionParams['dbname'] = $name;
+        }
 
-		$connectionParams['tablePrefix'] = $this->config->getValue('dbtableprefix', self::DEFAULT_DBTABLEPREFIX);
-		$connectionParams['sqlite.journal_mode'] = $this->config->getValue('sqlite.journal_mode', 'WAL');
+        $connectionParams['tablePrefix'] = $this->config->getValue('dbtableprefix', self::DEFAULT_DBTABLEPREFIX);
+        $connectionParams['sqlite.journal_mode'] = $this->config->getValue('sqlite.journal_mode', 'WAL');
 
-		//additional driver options, eg. for mysql ssl
-		$driverOptions = $this->config->getValue('dbdriveroptions', null);
-		if ($driverOptions) {
-			$connectionParams['driverOptions'] = $driverOptions;
-		}
+        //additional driver options, eg. for mysql ssl
+        $driverOptions = $this->config->getValue('dbdriveroptions', null);
+        if ($driverOptions) {
+            $connectionParams['driverOptions'] = $driverOptions;
+        }
 
-		// set default table creation options
-		$connectionParams['defaultTableOptions'] = [
-			'collate' => 'utf8_bin',
-			'tablePrefix' => $connectionParams['tablePrefix']
-		];
+        // set default table creation options
+        $connectionParams['defaultTableOptions'] = [
+            'collate' => 'utf8_bin',
+            'tablePrefix' => $connectionParams['tablePrefix']
+        ];
 
-		if ($this->config->getValue('mysql.utf8mb4', false)) {
-			$connectionParams['defaultTableOptions'] = [
-				'collate' => 'utf8mb4_bin',
-				'charset' => 'utf8mb4',
-				'row_format' => 'compressed',
-				'tablePrefix' => $connectionParams['tablePrefix']
-			];
-		}
+        if ($this->config->getValue('mysql.utf8mb4', false)) {
+            $connectionParams['defaultTableOptions'] = [
+                'collate' => 'utf8mb4_bin',
+                'charset' => 'utf8mb4',
+                'row_format' => 'compressed',
+                'tablePrefix' => $connectionParams['tablePrefix']
+            ];
+        }
 
-		return $connectionParams;
-	}
+        return $connectionParams;
+    }
 
-	/**
-	 * @param string $host
-	 * @return array
-	 */
-	protected function splitHostFromPortAndSocket($host): array {
-		$params = [
-			'host' => $host,
-		];
+    /**
+     * @param string $host
+     * @return array
+     */
+    protected function splitHostFromPortAndSocket($host): array {
+        $params = [
+            'host' => $host,
+        ];
 
-		$matches = [];
-		if (preg_match('/^(.*):([^\]:]+)$/', $host, $matches)) {
-			// Host variable carries a port or socket.
-			$params['host'] = $matches[1];
-			if (is_numeric($matches[2])) {
-				$params['port'] = (int) $matches[2];
-			} else {
-				$params['unix_socket'] = $matches[2];
-			}
-		}
+        $matches = [];
+        if (preg_match('/^(.*):([^\]:]+)$/', $host, $matches)) {
+            // Host variable carries a port or socket.
+            $params['host'] = $matches[1];
+            if (is_numeric($matches[2])) {
+                $params['port'] = (int) $matches[2];
+            } else {
+                $params['unix_socket'] = $matches[2];
+            }
+        }
 
-		return $params;
-	}
+        return $params;
+    }
 }

lib/private/DB/SetTransactionIsolationLevel.php

Indentation +10 added lines, -10 removed lines

@@ -32,15 +32,15 @@
 use Doctrine\DBAL\TransactionIsolationLevel;
 
 class SetTransactionIsolationLevel implements EventSubscriber {
-	/**
-	 * @param ConnectionEventArgs $args
-	 * @return void
-	 */
-	public function postConnect(ConnectionEventArgs $args) {
-		$args->getConnection()->setTransactionIsolation(TransactionIsolationLevel::READ_COMMITTED);
-	}
+    /**
+     * @param ConnectionEventArgs $args
+     * @return void
+     */
+    public function postConnect(ConnectionEventArgs $args) {
+        $args->getConnection()->setTransactionIsolation(TransactionIsolationLevel::READ_COMMITTED);
+    }
 
-	public function getSubscribedEvents() {
-		return [Events::postConnect];
-	}
+    public function getSubscribedEvents() {
+        return [Events::postConnect];
+    }
 }