nextcloud/lib/private/db.php

327 lines
9.9 KiB
PHP
Raw Normal View History

2011-04-16 12:17:40 +04:00
<?php
/**
2015-03-26 13:44:34 +03:00
* @author Andreas Fischer <bantu@owncloud.com>
* @author Bart Visscher <bartv@thisnet.nl>
* @author Dan Bartram <daneybartram@gmail.com>
* @author Joas Schilling <nickvergessen@owncloud.com>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <icewind@owncloud.com>
* @author Scrutinizer Auto-Fixer <auto-fixer@scrutinizer-ci.com>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Tom Needham <tom@owncloud.com>
* @author Vincent Petry <pvince81@owncloud.com>
2011-04-16 12:17:40 +04:00
*
2015-03-26 13:44:34 +03:00
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @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,
* along with this program. If not, see <http://www.gnu.org/licenses/>
2011-04-16 12:17:40 +04:00
*
*/
2011-04-16 12:17:40 +04:00
/**
* This class manages the access to the database. It basically is a wrapper for
* Doctrine with some adaptions.
2011-04-16 12:17:40 +04:00
*/
class OC_DB {
2013-08-02 21:53:04 +04:00
/**
* @return \OCP\IDBConnection
2013-08-02 21:53:04 +04:00
*/
static public function getConnection() {
return \OC::$server->getDatabaseConnection();
}
2013-08-02 18:02:33 +04:00
/**
* get MDB2 schema manager
*
* @return \OC\DB\MDB2SchemaManager
*/
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
/**
* Prepare a SQL query
* @param string $query Query string
* @param int $limit
* @param int $offset
2013-06-27 15:13:49 +04:00
* @param bool $isManipulation
* @throws \OC\DatabaseException
* @return OC_DB_StatementWrapper prepared SQL query
2011-04-16 12:17:40 +04:00
*
* SQL query via Doctrine prepare(), needs to be execute()'d!
2011-04-16 12:17:40 +04:00
*/
static public 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);
}
2011-04-16 12:17:40 +04:00
// return the result
try {
$result =$connection->prepare($query, $limit, $offset);
2013-08-08 00:22:33 +04:00
} catch (\Doctrine\DBAL\DBALException $e) {
throw new \OC\DatabaseException($e->getMessage(), $query);
2011-04-16 12:17:40 +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;
}
/**
* 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
2013-08-06 17:43:58 +04:00
* @return bool
*/
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) {
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) {
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) {
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) {
return true;
}
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
*/
static public function executeAudited( $stmt, array $parameters = null) {
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
// TODO try to convert LIMIT OFFSET notation to parameters, see fixLimitClauseForMSSQL
$message = 'LIMIT and OFFSET are forbidden for portability reasons,'
. ' pass an array with \'limit\' and \'offset\' instead';
throw new \OC\DatabaseException($message);
}
$stmt = array('sql' => $stmt, 'limit' => null, 'offset' => null);
}
2013-08-07 20:16:34 +04:00
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;
}
2011-04-16 12:17:40 +04:00
/**
* gets last value of autoincrement
* @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix
* @return string id
* @throws \OC\DatabaseException
2011-04-16 12:17:40 +04:00
*
* \Doctrine\DBAL\Connection lastInsertId
2011-04-16 12:17:40 +04:00
*
* Call this method right after the insert command or other functions may
* cause trouble!
*/
2012-09-07 17:22:01 +04:00
public static function insertid($table=null) {
return \OC::$server->getDatabaseConnection()->lastInsertId($table);
2011-04-16 12:17:40 +04:00
}
/**
* Start a transaction
*/
public static function beginTransaction() {
return \OC::$server->getDatabaseConnection()->beginTransaction();
}
/**
* Commit the database changes done during a transaction that is in progress
*/
public static function commit() {
return \OC::$server->getDatabaseConnection()->commit();
}
2014-10-24 20:44:06 +04:00
/**
* Rollback the database changes done during a transaction that is in progress
*/
public static function rollback() {
return \OC::$server->getDatabaseConnection()->rollback();
}
2013-08-06 17:43:58 +04:00
/**
* saves database schema to xml file
* @param string $file name of file
* @param int $mode
* @return bool
2011-04-16 12:17:40 +04:00
*
* TODO: write more documentation
*/
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
}
/**
* Creates tables from XML file
* @param string $file file to read structure from
* @return bool
2011-04-16 12:17:40 +04:00
*
* TODO: write more documentation
*/
2012-09-07 17:22:01 +04:00
public static function createDbFromStructure( $file ) {
2013-08-02 18:02:33 +04:00
$schemaManager = self::getMDB2SchemaManager();
$result = $schemaManager->createDbFromStructure($file);
2013-02-25 01:12:02 +04:00
return $result;
2011-04-16 12:17:40 +04:00
}
2012-08-29 10:38:33 +04:00
/**
* update the database schema
* @param string $file file to read structure from
* @throws Exception
* @return string|boolean
*/
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 {
$result = $schemaManager->updateDbFromStructure($file);
2012-10-10 22:49:47 +04:00
} catch (Exception $e) {
2015-07-03 15:06:40 +03:00
\OCP\Util::writeLog('core', 'Failed to update database structure ('.$e.')', \OCP\Util::FATAL);
throw $e;
}
return $result;
}
/**
* simulate the database schema update
* @param string $file file to read structure from
* @throws Exception
* @return string|boolean
*/
public static function simulateUpdateDbFromStructure($file) {
$schemaManager = self::getMDB2SchemaManager();
try {
$result = $schemaManager->simulateUpdateDbFromStructure($file);
} catch (Exception $e) {
2015-07-03 15:06:40 +03:00
\OCP\Util::writeLog('core', 'Simulated database structure update failed ('.$e.')', \OCP\Util::FATAL);
throw $e;
2011-04-16 12:17:40 +04:00
}
2012-10-10 22:49:47 +04:00
return $result;
2011-04-16 12:17:40 +04:00
}
/**
* drop a table - the database prefix will be prepended
* @param string $tableName the table to drop
*/
2012-09-07 17:22:01 +04:00
public static function dropTable($tableName) {
2014-09-10 15:33:59 +04:00
$connection = \OC::$server->getDatabaseConnection();
2014-12-08 16:35:57 +03:00
$connection->dropTable($tableName);
}
2012-08-29 10:38:33 +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);
}
2012-08-29 10:38:33 +04:00
2012-03-01 23:41:14 +04:00
/**
* check if a result is an error, works with Doctrine
2012-03-01 23:41:14 +04:00
* @param mixed $result
* @return bool
*/
2012-09-07 17:22:01 +04:00
public static function isError($result) {
//Doctrine returns false on error (and throws an exception)
return $result === false;
2012-03-01 23:41:14 +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
* @param mixed $result
* @param string $message
* @return void
* @throws \OC\DatabaseException
*/
public static function raiseExceptionOnError($result, $message = null) {
if(self::isError($result)) {
if ($message === null) {
$message = self::getErrorMessage();
} else {
$message .= ', Root cause:' . self::getErrorMessage();
}
throw new \OC\DatabaseException($message, self::getErrorCode());
}
}
2012-10-14 23:04:08 +04:00
public static function getErrorCode() {
2014-09-10 15:33:59 +04:00
$connection = \OC::$server->getDatabaseConnection();
return $connection->errorCode();
}
2012-09-12 14:45:20 +04:00
/**
* returns the error code and message as a string for logging
* works with DoctrineException
2012-09-12 14:45:20 +04:00
* @return string
*/
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
}
/**
* 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) {
2014-12-08 20:00:42 +03:00
$connection = \OC::$server->getDatabaseConnection();
return $connection->tableExists($table);
}
2011-09-17 04:30:58 +04:00
}