From 92a5a8f075fe5e6b72037cc4a668090d3a8cacf5 Mon Sep 17 00:00:00 2001 From: Carl Schwan Date: Tue, 19 Apr 2022 13:05:38 +0200 Subject: Cleanup tags and Share component - Port to LoggerInterface - Use IDBConnection and IQueryBuilder instead of raw SQL and OC_DB - Use IEventListener instead of hooks - Remove the now unused OC_DB and OC_DB_StatementWrapper legacy utils Signed-off-by: Carl Schwan --- lib/private/legacy/OC_DB.php | 184 -------------------------- lib/private/legacy/OC_DB_StatementWrapper.php | 135 ------------------- lib/private/legacy/OC_Util.php | 9 +- 3 files changed, 7 insertions(+), 321 deletions(-) delete mode 100644 lib/private/legacy/OC_DB.php delete mode 100644 lib/private/legacy/OC_DB_StatementWrapper.php (limited to 'lib/private/legacy') diff --git a/lib/private/legacy/OC_DB.php b/lib/private/legacy/OC_DB.php deleted file mode 100644 index 39faf8e80aa..00000000000 --- a/lib/private/legacy/OC_DB.php +++ /dev/null @@ -1,184 +0,0 @@ - - * @author Bart Visscher - * @author Christoph Wurst - * @author Joas Schilling - * @author Jörn Friedrich Dreyer - * @author Lukas Reschke - * @author Morris Jobke - * @author Robin Appelman - * @author Thomas Müller - * @author Vincent Petry - * - * @license AGPL-3.0 - * - * This code is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License, version 3, - * as published by the Free Software Foundation. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Affero General Public License for more details. - * - * You should have received a copy of the GNU Affero General Public License, version 3, - * along with this program. If not, see - * - */ -class OC_DB { - - /** - * Prepare a SQL query - * @param string $query Query string - * @param int|null $limit - * @param int|null $offset - * @param bool|null $isManipulation - * @throws \OC\DatabaseException - * @return OC_DB_StatementWrapper prepared SQL query - * @deprecated 21.0.0 Please use \OCP\IDBConnection::getQueryBuilder() instead - * - * SQL query via Doctrine prepare(), needs to be execute()'d! - */ - public static function prepare($query, $limit = null, $offset = null, $isManipulation = null) { - $connection = \OC::$server->getDatabaseConnection(); - - if ($isManipulation === null) { - //try to guess, so we return the number of rows on manipulations - $isManipulation = self::isManipulation($query); - } - - // return the result - try { - $result = $connection->prepare($query, $limit, $offset); - } catch (\Doctrine\DBAL\Exception $e) { - throw new \OC\DatabaseException($e->getMessage()); - } - // differentiate between query and manipulation - return new OC_DB_StatementWrapper($result, $isManipulation); - } - - /** - * tries to guess the type of statement based on the first 10 characters - * the current check allows some whitespace but does not work with IF EXISTS or other more complex statements - * - * @param string $sql - * @return bool - */ - public static function isManipulation($sql) { - $sql = trim($sql); - $selectOccurrence = stripos($sql, 'SELECT'); - if ($selectOccurrence === 0) { - return false; - } - $insertOccurrence = stripos($sql, 'INSERT'); - if ($insertOccurrence === 0) { - return true; - } - $updateOccurrence = stripos($sql, 'UPDATE'); - if ($updateOccurrence === 0) { - return true; - } - $deleteOccurrence = stripos($sql, 'DELETE'); - if ($deleteOccurrence === 0) { - return true; - } - - // This is triggered with "SHOW VERSION" and some more, so until we made a list, we keep this out. - // \OC::$server->getLogger()->logException(new \Exception('Can not detect if query is manipulating: ' . $sql)); - - return false; - } - - /** - * execute a prepared statement, on error write log and throw exception - * @param mixed $stmt OC_DB_StatementWrapper, - * an array with 'sql' and optionally 'limit' and 'offset' keys - * .. or a simple sql query string - * @param array $parameters - * @return OC_DB_StatementWrapper - * @throws \OC\DatabaseException - * @deprecated 21.0.0 Please use \OCP\IDBConnection::getQueryBuilder() instead - */ - public static function executeAudited($stmt, array $parameters = []) { - if (is_string($stmt)) { - // convert to an array with 'sql' - if (stripos($stmt, 'LIMIT') !== false) { //OFFSET requires LIMIT, so we only need to check for LIMIT - // TODO try to convert LIMIT OFFSET notation to parameters - $message = 'LIMIT and OFFSET are forbidden for portability reasons,' - . ' pass an array with \'limit\' and \'offset\' instead'; - throw new \OC\DatabaseException($message); - } - $stmt = ['sql' => $stmt, 'limit' => null, 'offset' => null]; - } - if (is_array($stmt)) { - // convert to prepared statement - if (! array_key_exists('sql', $stmt)) { - $message = 'statement array must at least contain key \'sql\''; - throw new \OC\DatabaseException($message); - } - if (! array_key_exists('limit', $stmt)) { - $stmt['limit'] = null; - } - if (! array_key_exists('limit', $stmt)) { - $stmt['offset'] = null; - } - $stmt = self::prepare($stmt['sql'], $stmt['limit'], $stmt['offset']); - } - self::raiseExceptionOnError($stmt, 'Could not prepare statement'); - if ($stmt instanceof OC_DB_StatementWrapper) { - $result = $stmt->execute($parameters); - self::raiseExceptionOnError($result, 'Could not execute statement'); - } else { - if (is_object($stmt)) { - $message = 'Expected a prepared statement or array got ' . get_class($stmt); - } else { - $message = 'Expected a prepared statement or array got ' . gettype($stmt); - } - throw new \OC\DatabaseException($message); - } - return $result; - } - - /** - * check if a result is an error and throws an exception, works with \Doctrine\DBAL\Exception - * @param mixed $result - * @param string $message - * @return void - * @throws \OC\DatabaseException - */ - public static function raiseExceptionOnError($result, $message = null) { - if ($result === false) { - if ($message === null) { - $message = self::getErrorMessage(); - } else { - $message .= ', Root cause:' . self::getErrorMessage(); - } - throw new \OC\DatabaseException($message); - } - } - - /** - * returns the error code and message as a string for logging - * works with DoctrineException - * @return string - */ - public static function getErrorMessage() { - $connection = \OC::$server->getDatabaseConnection(); - return $connection->getError(); - } - - /** - * Checks if a table exists in the database - the database prefix will be prepended - * - * @param string $table - * @return bool - * @throws \OC\DatabaseException - */ - public static function tableExists($table) { - $connection = \OC::$server->getDatabaseConnection(); - return $connection->tableExists($table); - } -} diff --git a/lib/private/legacy/OC_DB_StatementWrapper.php b/lib/private/legacy/OC_DB_StatementWrapper.php deleted file mode 100644 index d6214a49a33..00000000000 --- a/lib/private/legacy/OC_DB_StatementWrapper.php +++ /dev/null @@ -1,135 +0,0 @@ - - * @author Christoph Wurst - * @author Joas Schilling - * @author Jörn Friedrich Dreyer - * @author Lukas Reschke - * @author Morris Jobke - * @author Robin Appelman - * @author Thomas Müller - * - * @license AGPL-3.0 - * - * This code is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License, version 3, - * as published by the Free Software Foundation. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Affero General Public License for more details. - * - * You should have received a copy of the GNU Affero General Public License, version 3, - * along with this program. If not, see - * - */ -use OCP\DB\IPreparedStatement; - -/** - * small wrapper around \Doctrine\DBAL\Driver\Statement to make it behave, more like an MDB2 Statement - * - * @method boolean bindValue(mixed $param, mixed $value, integer $type = null); - * @method string errorCode(); - * @method array errorInfo(); - * @method integer rowCount(); - * @method array fetchAll(integer $fetchMode = null); - */ -class OC_DB_StatementWrapper { - /** @var IPreparedStatement */ - private $statement = null; - - /** @var bool */ - private $isManipulation = false; - - /** @var array */ - private $lastArguments = []; - - /** - * @param IPreparedStatement $statement - * @param boolean $isManipulation - */ - public function __construct(IPreparedStatement $statement, $isManipulation) { - $this->statement = $statement; - $this->isManipulation = $isManipulation; - } - - /** - * pass all other function directly to the \Doctrine\DBAL\Driver\Statement - */ - public function __call($name, $arguments) { - return call_user_func_array([$this->statement,$name], $arguments); - } - - /** - * make execute return the result instead of a bool - * - * @param mixed[] $input - * @return \OC_DB_StatementWrapper|int|bool - * @deprecated - */ - public function execute($input = []) { - $this->lastArguments = $input; - try { - if (count($input) > 0) { - $result = $this->statement->execute($input); - } else { - $result = $this->statement->execute(); - } - } catch (\Doctrine\DBAL\Exception $e) { - return false; - } - - if ($this->isManipulation) { - return $this->statement->rowCount(); - } - - return $this; - } - - /** - * provide an alias for fetch - * - * @return mixed - * @deprecated - */ - public function fetchRow() { - return $this->statement->fetch(); - } - - /** - * Provide a simple fetchOne. - * - * fetch single column from the next row - * @return string - * @deprecated - */ - public function fetchOne() { - return $this->statement->fetchOne(); - } - - /** - * Closes the cursor, enabling the statement to be executed again. - * - * @deprecated Use Result::free() instead. - */ - public function closeCursor(): void { - $this->statement->closeCursor(); - } - - /** - * Binds a PHP variable to a corresponding named or question mark placeholder in the - * SQL statement that was use to prepare the statement. - * - * @param mixed $column Either the placeholder name or the 1-indexed placeholder index - * @param mixed $variable The variable to bind - * @param integer|null $type one of the PDO::PARAM_* constants - * @param integer|null $length max length when using an OUT bind - * @return boolean - */ - public function bindParam($column, &$variable, $type = null, $length = null) { - return $this->statement->bindParam($column, $variable, $type, $length); - } -} diff --git a/lib/private/legacy/OC_Util.php b/lib/private/legacy/OC_Util.php index bf9ed6e29ff..4778fe33097 100644 --- a/lib/private/legacy/OC_Util.php +++ b/lib/private/legacy/OC_Util.php @@ -69,6 +69,7 @@ use OC\AppFramework\Http\Request; use OC\Files\SetupManager; use OCP\Files\Template\ITemplateManager; use OCP\IConfig; +use OCP\IDBConnection; use OCP\IGroupManager; use OCP\IURLGenerator; use OCP\IUser; @@ -749,9 +750,13 @@ class OC_Util { $dbType = \OC::$server->getSystemConfig()->getValue('dbtype', 'sqlite'); if ($dbType === 'pgsql') { // check PostgreSQL version + // TODO latest postgresql 8 released was 8 years ago, maybe remove the + // check completely? try { - $result = \OC_DB::executeAudited('SHOW SERVER_VERSION'); - $data = $result->fetchRow(); + /** @var IDBConnection $connection */ + $connection = \OC::$server->get(IDBConnection::class); + $result = $connection->executeQuery('SHOW SERVER_VERSION'); + $data = $result->fetch(); $result->closeCursor(); if (isset($data['server_version'])) { $version = $data['server_version']; -- cgit v1.2.3