2011-04-16 12:17:40 +04:00
|
|
|
<?php
|
|
|
|
/**
|
2016-07-21 18:07:57 +03:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Andreas Fischer <bantu@owncloud.com>
|
2019-12-03 21:57:53 +03:00
|
|
|
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Bart Visscher <bartv@thisnet.nl>
|
2020-03-31 11:49:10 +03:00
|
|
|
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
|
2016-07-21 18:07:57 +03:00
|
|
|
* @author Joas Schilling <coding@schilljs.com>
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
2017-11-06 17:56:42 +03:00
|
|
|
* @author Lukas Reschke <lukas@statuscode.ch>
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
2016-07-21 19:13:36 +03:00
|
|
|
* @author Robin Appelman <robin@icewind.nl>
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
|
|
|
* @author Vincent Petry <pvince81@owncloud.com>
|
2011-04-16 12:17:40 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* @license AGPL-3.0
|
2011-04-16 12:17:40 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* 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.
|
2011-04-16 12:17:40 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* This program is distributed in the hope that it will be useful,
|
2011-04-16 12:17:40 +04:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-03-26 13:44:34 +03:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU Affero General Public License for more details.
|
2011-04-16 12:17:40 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* You should have received a copy of the GNU Affero General Public License, version 3,
|
2019-12-03 21:57:53 +03:00
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
2011-04-16 12:17:40 +04:00
|
|
|
*
|
|
|
|
*/
|
2015-02-26 13:37:37 +03:00
|
|
|
|
2018-04-25 16:22:28 +03:00
|
|
|
use OCP\ILogger;
|
|
|
|
|
2011-04-16 12:17:40 +04:00
|
|
|
/**
|
|
|
|
* This class manages the access to the database. It basically is a wrapper for
|
2012-11-01 21:11:50 +04:00
|
|
|
* Doctrine with some adaptions.
|
2011-04-16 12:17:40 +04:00
|
|
|
*/
|
|
|
|
class OC_DB {
|
2014-06-11 19:02:34 +04:00
|
|
|
|
2013-08-02 18:02:33 +04:00
|
|
|
/**
|
|
|
|
* get MDB2 schema manager
|
|
|
|
*
|
|
|
|
* @return \OC\DB\MDB2SchemaManager
|
|
|
|
*/
|
2015-03-10 00:12:31 +03:00
|
|
|
private static function getMDB2SchemaManager() {
|
2014-09-10 15:33:59 +04:00
|
|
|
return new \OC\DB\MDB2SchemaManager(\OC::$server->getDatabaseConnection());
|
2013-08-02 18:02:33 +04:00
|
|
|
}
|
|
|
|
|
2011-04-16 12:17:40 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Prepare a SQL query
|
2012-09-23 03:52:34 +04:00
|
|
|
* @param string $query Query string
|
2017-07-19 21:21:05 +03:00
|
|
|
* @param int|null $limit
|
|
|
|
* @param int|null $offset
|
|
|
|
* @param bool|null $isManipulation
|
2014-11-26 14:38:24 +03:00
|
|
|
* @throws \OC\DatabaseException
|
2014-02-06 19:30:58 +04:00
|
|
|
* @return OC_DB_StatementWrapper prepared SQL query
|
2011-04-16 12:17:40 +04:00
|
|
|
*
|
2012-11-01 21:11:50 +04:00
|
|
|
* SQL query via Doctrine prepare(), needs to be execute()'d!
|
2011-04-16 12:17:40 +04:00
|
|
|
*/
|
2020-04-09 14:53:40 +03:00
|
|
|
static public function prepare($query , $limit = null, $offset = null, $isManipulation = null) {
|
2014-09-10 15:11:04 +04:00
|
|
|
$connection = \OC::$server->getDatabaseConnection();
|
2014-03-31 22:00:44 +04:00
|
|
|
|
2013-06-20 16:46:22 +04:00
|
|
|
if ($isManipulation === null) {
|
|
|
|
//try to guess, so we return the number of rows on manipulations
|
|
|
|
$isManipulation = self::isManipulation($query);
|
|
|
|
}
|
2014-03-31 22:00:44 +04:00
|
|
|
|
2011-04-16 12:17:40 +04:00
|
|
|
// return the result
|
2013-02-26 02:45:07 +04:00
|
|
|
try {
|
2014-09-10 15:11:04 +04:00
|
|
|
$result =$connection->prepare($query, $limit, $offset);
|
2013-08-08 00:22:33 +04:00
|
|
|
} catch (\Doctrine\DBAL\DBALException $e) {
|
2017-07-24 14:44:12 +03:00
|
|
|
throw new \OC\DatabaseException($e->getMessage());
|
2011-04-16 12:17:40 +04:00
|
|
|
}
|
2013-02-26 02:45:07 +04:00
|
|
|
// differentiate between query and manipulation
|
2013-08-08 00:22:33 +04:00
|
|
|
$result = new OC_DB_StatementWrapper($result, $isManipulation);
|
2011-04-16 12:17:40 +04:00
|
|
|
return $result;
|
|
|
|
}
|
2013-02-26 02:45:07 +04:00
|
|
|
|
2013-06-20 16:46:22 +04:00
|
|
|
/**
|
|
|
|
* 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
|
2014-03-31 22:00:44 +04:00
|
|
|
*
|
2013-06-20 16:46:22 +04:00
|
|
|
* @param string $sql
|
2013-08-06 17:43:58 +04:00
|
|
|
* @return bool
|
2013-06-20 16:46:22 +04:00
|
|
|
*/
|
2020-04-09 14:53:40 +03:00
|
|
|
static public function isManipulation($sql) {
|
2013-08-08 00:22:33 +04:00
|
|
|
$selectOccurrence = stripos($sql, 'SELECT');
|
2013-08-06 17:43:58 +04:00
|
|
|
if ($selectOccurrence !== false && $selectOccurrence < 10) {
|
2013-06-20 16:46:22 +04:00
|
|
|
return false;
|
|
|
|
}
|
2013-08-08 00:22:33 +04:00
|
|
|
$insertOccurrence = stripos($sql, 'INSERT');
|
2013-08-06 17:43:58 +04:00
|
|
|
if ($insertOccurrence !== false && $insertOccurrence < 10) {
|
2013-06-20 16:46:22 +04:00
|
|
|
return true;
|
|
|
|
}
|
2013-08-08 00:22:33 +04:00
|
|
|
$updateOccurrence = stripos($sql, 'UPDATE');
|
2013-08-06 17:43:58 +04:00
|
|
|
if ($updateOccurrence !== false && $updateOccurrence < 10) {
|
2013-06-20 16:46:22 +04:00
|
|
|
return true;
|
|
|
|
}
|
2013-08-08 00:22:33 +04:00
|
|
|
$deleteOccurrence = stripos($sql, 'DELETE');
|
2013-08-06 17:43:58 +04:00
|
|
|
if ($deleteOccurrence !== false && $deleteOccurrence < 10) {
|
2013-06-20 16:46:22 +04:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
2014-03-31 22:00:44 +04:00
|
|
|
|
2013-06-10 14:56:45 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* execute a prepared statement, on error write log and throw exception
|
2013-06-28 13:48:38 +04:00
|
|
|
* @param mixed $stmt OC_DB_StatementWrapper,
|
2013-06-10 14:56:45 +04:00
|
|
|
* an array with 'sql' and optionally 'limit' and 'offset' keys
|
|
|
|
* .. or a simple sql query string
|
2017-12-18 15:58:54 +03:00
|
|
|
* @param array $parameters
|
2014-02-19 12:31:54 +04:00
|
|
|
* @return OC_DB_StatementWrapper
|
2014-11-26 14:38:24 +03:00
|
|
|
* @throws \OC\DatabaseException
|
2013-06-10 14:56:45 +04:00
|
|
|
*/
|
2020-04-09 14:53:40 +03:00
|
|
|
static public function executeAudited($stmt, array $parameters = []) {
|
2013-06-10 14:56:45 +04:00
|
|
|
if (is_string($stmt)) {
|
|
|
|
// convert to an array with 'sql'
|
2013-08-07 20:16:34 +04:00
|
|
|
if (stripos($stmt, 'LIMIT') !== false) { //OFFSET requires LIMIT, so we only need to check for LIMIT
|
2015-07-29 19:19:31 +03:00
|
|
|
// TODO try to convert LIMIT OFFSET notation to parameters
|
2013-06-10 14:56:45 +04:00
|
|
|
$message = 'LIMIT and OFFSET are forbidden for portability reasons,'
|
|
|
|
. ' pass an array with \'limit\' and \'offset\' instead';
|
2014-11-26 14:38:24 +03:00
|
|
|
throw new \OC\DatabaseException($message);
|
2013-06-10 14:56:45 +04:00
|
|
|
}
|
2020-03-26 11:30:18 +03:00
|
|
|
$stmt = ['sql' => $stmt, 'limit' => null, 'offset' => null];
|
2013-06-10 14:56:45 +04:00
|
|
|
}
|
2013-08-07 20:16:34 +04:00
|
|
|
if (is_array($stmt)) {
|
2013-06-10 14:56:45 +04:00
|
|
|
// convert to prepared statement
|
|
|
|
if ( ! array_key_exists('sql', $stmt) ) {
|
|
|
|
$message = 'statement array must at least contain key \'sql\'';
|
2014-11-26 14:38:24 +03:00
|
|
|
throw new \OC\DatabaseException($message);
|
2013-06-10 14:56:45 +04:00
|
|
|
}
|
|
|
|
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');
|
2013-06-28 13:48:38 +04:00
|
|
|
if ($stmt instanceof OC_DB_StatementWrapper) {
|
2013-06-10 14:56:45 +04:00
|
|
|
$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);
|
|
|
|
}
|
2014-11-26 14:38:24 +03:00
|
|
|
throw new \OC\DatabaseException($message);
|
2013-06-10 14:56:45 +04:00
|
|
|
}
|
|
|
|
return $result;
|
|
|
|
}
|
|
|
|
|
2013-08-06 17:43:58 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* saves database schema to xml file
|
2012-09-23 03:52:34 +04:00
|
|
|
* @param string $file name of file
|
|
|
|
* @return bool
|
2011-04-16 12:17:40 +04:00
|
|
|
*
|
|
|
|
* TODO: write more documentation
|
|
|
|
*/
|
2015-03-10 00:12:31 +03:00
|
|
|
public static function getDbStructure($file) {
|
2013-08-02 18:02:33 +04:00
|
|
|
$schemaManager = self::getMDB2SchemaManager();
|
|
|
|
return $schemaManager->getDbStructure($file);
|
2011-04-16 12:17:40 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Creates tables from XML file
|
2012-09-23 03:52:34 +04:00
|
|
|
* @param string $file file to read structure from
|
|
|
|
* @return bool
|
2011-04-16 12:17:40 +04:00
|
|
|
*
|
|
|
|
* TODO: write more documentation
|
|
|
|
*/
|
2020-04-09 14:53:40 +03:00
|
|
|
public static function createDbFromStructure($file) {
|
2013-08-02 18:02:33 +04:00
|
|
|
$schemaManager = self::getMDB2SchemaManager();
|
2018-01-26 02:02:03 +03:00
|
|
|
return $schemaManager->createDbFromStructure($file);
|
2011-04-16 12:17:40 +04:00
|
|
|
}
|
2012-08-29 10:38:33 +04:00
|
|
|
|
2011-10-23 17:25:38 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* update the database schema
|
2012-09-23 03:52:34 +04:00
|
|
|
* @param string $file file to read structure from
|
2013-03-19 21:52:54 +04:00
|
|
|
* @throws Exception
|
2014-02-06 19:30:58 +04:00
|
|
|
* @return string|boolean
|
2017-07-19 21:21:05 +03:00
|
|
|
* @suppress PhanDeprecatedFunction
|
2011-10-23 17:25:38 +04:00
|
|
|
*/
|
2014-06-04 20:15:58 +04:00
|
|
|
public static function updateDbFromStructure($file) {
|
2013-08-02 18:02:33 +04:00
|
|
|
$schemaManager = self::getMDB2SchemaManager();
|
2012-10-10 22:49:47 +04:00
|
|
|
try {
|
2014-06-04 20:15:58 +04:00
|
|
|
$result = $schemaManager->updateDbFromStructure($file);
|
2012-10-10 22:49:47 +04:00
|
|
|
} catch (Exception $e) {
|
2018-04-25 16:22:28 +03:00
|
|
|
\OCP\Util::writeLog('core', 'Failed to update database structure ('.$e.')', ILogger::FATAL);
|
2014-06-04 20:15:58 +04:00
|
|
|
throw $e;
|
|
|
|
}
|
|
|
|
return $result;
|
|
|
|
}
|
|
|
|
|
2011-06-12 19:51:31 +04:00
|
|
|
/**
|
|
|
|
* remove all tables defined in a database structure xml file
|
|
|
|
* @param string $file the xml file describing the tables
|
|
|
|
*/
|
2012-09-07 17:22:01 +04:00
|
|
|
public static function removeDBStructure($file) {
|
2013-08-02 18:02:33 +04:00
|
|
|
$schemaManager = self::getMDB2SchemaManager();
|
|
|
|
$schemaManager->removeDBStructure($file);
|
2011-06-12 19:51:31 +04:00
|
|
|
}
|
2012-08-29 10:38:33 +04:00
|
|
|
|
2013-06-10 14:56:45 +04:00
|
|
|
/**
|
2013-06-24 10:27:25 +04:00
|
|
|
* check if a result is an error and throws an exception, works with \Doctrine\DBAL\DBALException
|
2013-06-10 14:56:45 +04:00
|
|
|
* @param mixed $result
|
2013-06-27 18:48:09 +04:00
|
|
|
* @param string $message
|
2013-06-10 14:56:45 +04:00
|
|
|
* @return void
|
2014-11-26 14:38:24 +03:00
|
|
|
* @throws \OC\DatabaseException
|
2013-06-10 14:56:45 +04:00
|
|
|
*/
|
|
|
|
public static function raiseExceptionOnError($result, $message = null) {
|
2016-01-07 12:14:05 +03:00
|
|
|
if($result === false) {
|
2013-06-10 14:56:45 +04:00
|
|
|
if ($message === null) {
|
2015-04-18 18:02:39 +03:00
|
|
|
$message = self::getErrorMessage();
|
2013-06-10 14:56:45 +04:00
|
|
|
} else {
|
2015-04-18 18:02:39 +03:00
|
|
|
$message .= ', Root cause:' . self::getErrorMessage();
|
2013-06-10 14:56:45 +04:00
|
|
|
}
|
2017-07-24 14:44:12 +03:00
|
|
|
throw new \OC\DatabaseException($message);
|
2013-06-10 14:56:45 +04:00
|
|
|
}
|
|
|
|
}
|
2012-10-14 23:04:08 +04:00
|
|
|
|
2012-09-12 14:45:20 +04:00
|
|
|
/**
|
|
|
|
* returns the error code and message as a string for logging
|
2012-11-01 21:11:50 +04:00
|
|
|
* works with DoctrineException
|
2012-09-12 14:45:20 +04:00
|
|
|
* @return string
|
|
|
|
*/
|
2015-04-18 16:57:13 +03:00
|
|
|
public static function getErrorMessage() {
|
2014-09-10 15:33:59 +04:00
|
|
|
$connection = \OC::$server->getDatabaseConnection();
|
|
|
|
return $connection->getError();
|
2012-09-12 14:45:20 +04:00
|
|
|
}
|
2013-02-27 01:41:48 +04:00
|
|
|
|
2014-05-12 15:54:20 +04:00
|
|
|
/**
|
|
|
|
* Checks if a table exists in the database - the database prefix will be prepended
|
|
|
|
*
|
|
|
|
* @param string $table
|
|
|
|
* @return bool
|
2014-11-26 14:38:24 +03:00
|
|
|
* @throws \OC\DatabaseException
|
2014-05-12 15:54:20 +04:00
|
|
|
*/
|
|
|
|
public static function tableExists($table) {
|
2014-12-08 20:00:42 +03:00
|
|
|
$connection = \OC::$server->getDatabaseConnection();
|
|
|
|
return $connection->tableExists($table);
|
2014-05-12 15:54:20 +04:00
|
|
|
}
|
2011-09-17 04:30:58 +04:00
|
|
|
}
|