diff options
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/base.php | 6 | ||||
| -rw-r--r-- | lib/db.php | 502 | ||||
| -rw-r--r-- | lib/db/mdb2schemareader.php | 225 | ||||
| -rw-r--r-- | lib/db/mdb2schemawriter.php | 127 | ||||
| -rw-r--r-- | lib/db/schema.php | 127 |
5 files changed, 592 insertions, 395 deletions
diff --git a/lib/base.php b/lib/base.php index 273107e9b8a..d9a0e2c757f 100644 --- a/lib/base.php +++ b/lib/base.php @@ -99,6 +99,12 @@ class OC{ elseif(strpos($className, 'Sabre_')===0) { $path = str_replace('_', '/', $className) . '.php'; } + elseif(strpos($className, 'Doctrine\\Common')===0) { + $path = 'doctrine-common/lib/'.str_replace('\\', '/', $className) . '.php'; + } + elseif(strpos($className, 'Doctrine\\DBAL')===0) { + $path = 'doctrine-dbal/lib/'.str_replace('\\', '/', $className) . '.php'; + } elseif(strpos($className, 'Symfony\\Component\\Routing\\')===0) { $path = 'symfony/routing/'.str_replace('\\', '/', $className) . '.php'; } diff --git a/lib/db.php b/lib/db.php index e63a7a20c81..2e21a11d545 100644 --- a/lib/db.php +++ b/lib/db.php @@ -20,53 +20,34 @@ * */ +define('MDB2_SCHEMA_DUMP_STRUCTURE', '1'); /** * This class manages the access to the database. It basically is a wrapper for - * MDB2 with some adaptions. + * Doctrine with some adaptions. */ class OC_DB { - const BACKEND_PDO=0; - const BACKEND_MDB2=1; + const BACKEND_DOCTRINE=2; /** - * @var MDB2_Driver_Common + * @var \Doctrine\DBAL\Connection */ - static private $connection; //the prefered connection to use, either PDO or MDB2 + static private $connection; //the prefered connection to use, only Doctrine static private $backend=null; /** - * @var MDB2_Driver_Common + * @var Doctrine */ - static private $MDB2=null; - /** - * @var PDO - */ - static private $PDO=null; - /** - * @var MDB2_Schema - */ - static private $schema=null; + static private $DOCTRINE=null; + static private $inTransaction=false; static private $prefix=null; static private $type=null; /** * check which backend we should use - * @return int BACKEND_MDB2 or BACKEND_PDO + * @return int BACKEND_DOCTRINE */ private static function getDBBackend() { - //check if we can use PDO, else use MDB2 (installation always needs to be done my mdb2) - if(class_exists('PDO') && OC_Config::getValue('installed', false)) { - $type = OC_Config::getValue( "dbtype", "sqlite" ); - if($type=='oci') { //oracle also always needs mdb2 - return self::BACKEND_MDB2; - } - if($type=='sqlite3') $type='sqlite'; - $drivers=PDO::getAvailableDrivers(); - if(array_search($type, $drivers)!==false) { - return self::BACKEND_PDO; - } - } - return self::BACKEND_MDB2; + return self::BACKEND_DOCTRINE; } /** @@ -83,26 +64,22 @@ class OC_DB { if(is_null($backend)) { $backend=self::getDBBackend(); } - if($backend==self::BACKEND_PDO) { - $success = self::connectPDO(); - self::$connection=self::$PDO; - self::$backend=self::BACKEND_PDO; - }else{ - $success = self::connectMDB2(); - self::$connection=self::$MDB2; - self::$backend=self::BACKEND_MDB2; + if($backend==self::BACKEND_DOCTRINE) { + $success = self::connectDoctrine(); + self::$connection=self::$DOCTRINE; + self::$backend=self::BACKEND_DOCTRINE; } return $success; } /** - * connect to the database using pdo + * connect to the database using doctrine * * @return bool */ - public static function connectPDO() { + public static function connectDoctrine() { if(self::$connection) { - if(self::$backend==self::BACKEND_MDB2) { + if(self::$backend!=self::BACKEND_DOCTRINE) { self::disconnect(); }else{ return true; @@ -116,162 +93,61 @@ class OC_DB { $type = OC_Config::getValue( "dbtype", "sqlite" ); if(strpos($host, ':')) { list($host, $port)=explode(':', $host, 2); - }else{ + } else { $port=false; } - $opts = array(); - $datadir=OC_Config::getValue( "datadirectory", OC::$SERVERROOT.'/data' ); // do nothing if the connection already has been established - if(!self::$PDO) { - // Add the dsn according to the database type + if(!self::$DOCTRINE) { + $config = new \Doctrine\DBAL\Configuration(); switch($type) { case 'sqlite': - $dsn='sqlite2:'.$datadir.'/'.$name.'.db'; - break; case 'sqlite3': - $dsn='sqlite:'.$datadir.'/'.$name.'.db'; - break; - case 'mysql': - if($port) { - $dsn='mysql:dbname='.$name.';host='.$host.';port='.$port; - }else{ - $dsn='mysql:dbname='.$name.';host='.$host; - } - $opts[PDO::MYSQL_ATTR_INIT_COMMAND] = "SET NAMES 'UTF8'"; - break; - case 'pgsql': - if($port) { - $dsn='pgsql:dbname='.$name.';host='.$host.';port='.$port; - }else{ - $dsn='pgsql:dbname='.$name.';host='.$host; - } - /** - * Ugly fix for pg connections pbm when password use spaces - */ - $e_user = addslashes($user); - $e_password = addslashes($pass); - $pass = $user = null; - $dsn .= ";user='$e_user';password='$e_password'"; - /** END OF FIX***/ - break; - case 'oci': // Oracle with PDO is unsupported - if ($port) { - $dsn = 'oci:dbname=//' . $host . ':' . $port . '/' . $name; - } else { - $dsn = 'oci:dbname=//' . $host . '/' . $name; - } - break; - default: - return false; - } - try{ - self::$PDO=new PDO($dsn, $user, $pass, $opts); - }catch(PDOException $e) { - OC_Template::printErrorPage( 'can not connect to database, using '.$type.'. ('.$e->getMessage().')' ); - } - // We always, really always want associative arrays - self::$PDO->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_ASSOC); - self::$PDO->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); - } - return true; - } - - /** - * connect to the database using mdb2 - */ - public static function connectMDB2() { - if(self::$connection) { - if(self::$backend==self::BACKEND_PDO) { - self::disconnect(); - }else{ - return true; - } - } - // The global data we need - $name = OC_Config::getValue( "dbname", "owncloud" ); - $host = OC_Config::getValue( "dbhost", "" ); - $user = OC_Config::getValue( "dbuser", "" ); - $pass = OC_Config::getValue( "dbpassword", "" ); - $type = OC_Config::getValue( "dbtype", "sqlite" ); - $SERVERROOT=OC::$SERVERROOT; - $datadir=OC_Config::getValue( "datadirectory", "$SERVERROOT/data" ); - - // do nothing if the connection already has been established - if(!self::$MDB2) { - // Require MDB2.php (not required in the head of the file so we only load it when needed) - require_once 'MDB2.php'; - - // Prepare options array - $options = array( - 'portability' => MDB2_PORTABILITY_ALL - MDB2_PORTABILITY_FIX_CASE, - 'log_line_break' => '<br>', - 'idxname_format' => '%s', - 'debug' => true, - 'quote_identifier' => true ); - - // Add the dsn according to the database type - switch($type) { - case 'sqlite': - case 'sqlite3': - $dsn = array( - 'phptype' => $type, - 'database' => "$datadir/$name.db", - 'mode' => '0644' + $datadir=OC_Config::getValue( "datadirectory", OC::$SERVERROOT.'/data' ); + $connectionParams = array( + 'user' => $user, + 'password' => $pass, + 'path' => $datadir.'/'.$name.'.db', + 'driver' => 'pdo_sqlite', ); break; case 'mysql': - $dsn = array( - 'phptype' => 'mysql', - 'username' => $user, - 'password' => $pass, - 'hostspec' => $host, - 'database' => $name + $connectionParams = array( + 'user' => $user, + 'password' => $pass, + 'host' => $host, + 'port' => $port, + 'dbname' => $name, + 'charset' => 'UTF8', + 'driver' => 'pdo_mysql', ); break; case 'pgsql': - $dsn = array( - 'phptype' => 'pgsql', - 'username' => $user, - 'password' => $pass, - 'hostspec' => $host, - 'database' => $name + $connectionParams = array( + 'user' => $user, + 'password' => $pass, + 'host' => $host, + 'port' => $port, + 'dbname' => $name, + 'driver' => 'pdo_mysql', ); break; case 'oci': - $dsn = array( - 'phptype' => 'oci8', - 'username' => $user, + $connectionParams = array( + 'user' => $user, 'password' => $pass, + 'host' => $host, + 'port' => $port, + 'dbname' => $name, 'charset' => 'AL32UTF8', + 'driver' => 'oci8', ); - if ($host != '') { - $dsn['hostspec'] = $host; - $dsn['database'] = $name; - } else { // use dbname for hostspec - $dsn['hostspec'] = $name; - $dsn['database'] = $user; - } break; default: return false; } - - // Try to establish connection - self::$MDB2 = MDB2::factory( $dsn, $options ); - - // Die if we could not connect - if( PEAR::isError( self::$MDB2 )) { - OC_Log::write('core', self::$MDB2->getUserInfo(), OC_Log::FATAL); - OC_Log::write('core', self::$MDB2->getMessage(), OC_Log::FATAL); - OC_Template::printErrorPage( 'can not connect to database, using '.$type.'. ('.self::$MDB2->getUserInfo().')' ); - } - - // We always, really always want associative arrays - self::$MDB2->setFetchMode(MDB2_FETCHMODE_ASSOC); + self::$DOCTRINE = \Doctrine\DBAL\DriverManager::getConnection($connectionParams, $config); } - - // we are done. great! return true; } @@ -280,33 +156,28 @@ class OC_DB { * @param string $query Query string * @param int $limit * @param int $offset - * @return MDB2_Statement_Common prepared SQL query + * @return \Doctrine\DBAL\Statement prepared SQL query * - * SQL query via MDB2 prepare(), needs to be execute()'d! + * SQL query via Doctrine prepare(), needs to be execute()'d! */ static public function prepare( $query , $limit=null, $offset=null ) { if (!is_null($limit) && $limit != -1) { - if (self::$backend == self::BACKEND_MDB2) { - //MDB2 uses or emulates limits & offset internally - self::$MDB2->setLimit($limit, $offset); + //PDO does not handle limit and offset. + //FIXME: check limit notation for other dbs + //the following sql thus might needs to take into account db ways of representing it + //(oracle has no LIMIT / OFFSET) + $limit = (int)$limit; + $limitsql = ' LIMIT ' . $limit; + if (!is_null($offset)) { + $offset = (int)$offset; + $limitsql .= ' OFFSET ' . $offset; + } + //insert limitsql + if (substr($query, -1) == ';') { //if query ends with ; + $query = substr($query, 0, -1) . $limitsql . ';'; } else { - //PDO does not handle limit and offset. - //FIXME: check limit notation for other dbs - //the following sql thus might needs to take into account db ways of representing it - //(oracle has no LIMIT / OFFSET) - $limit = (int)$limit; - $limitsql = ' LIMIT ' . $limit; - if (!is_null($offset)) { - $offset = (int)$offset; - $limitsql .= ' OFFSET ' . $offset; - } - //insert limitsql - if (substr($query, -1) == ';') { //if query ends with ; - $query = substr($query, 0, -1) . $limitsql . ';'; - } else { - $query.=$limitsql; - } + $query.=$limitsql; } } @@ -315,18 +186,7 @@ class OC_DB { self::connect(); // return the result - if(self::$backend==self::BACKEND_MDB2) { - $result = self::$connection->prepare( $query ); - - // Die if we have an error (error means: bad query, not 0 results!) - if( PEAR::isError($result)) { - $entry = 'DB Error: "'.$result->getMessage().'"<br />'; - $entry .= 'Offending command was: '.htmlentities($query).'<br />'; - OC_Log::write('core', $entry, OC_Log::FATAL); - error_log('DB error: '.$entry); - OC_Template::printErrorPage( $entry ); - } - }else{ + if (self::$backend == self::BACKEND_DOCTRINE) { try{ $result=self::$connection->prepare($query); }catch(PDOException $e) { @@ -336,7 +196,7 @@ class OC_DB { error_log('DB error: '.$entry); OC_Template::printErrorPage( $entry ); } - $result=new PDOStatementWrapper($result); + $result=new DoctrineStatementWrapper($result); } return $result; } @@ -346,7 +206,7 @@ class OC_DB { * @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix * @return int id * - * MDB2 lastInsertID() + * \Doctrine\DBAL\Connection lastInsertId * * Call this method right after the insert command or other functions may * cause trouble! @@ -358,7 +218,7 @@ class OC_DB { $query = self::prepare('SELECT lastval() AS id'); $row = $query->execute()->fetchRow(); return $row['id']; - }else{ + } else { if($table !== null) { $prefix = OC_Config::getValue( "dbtableprefix", "oc_" ); $suffix = OC_Config::getValue( "dbsequencesuffix", "_id_seq" ); @@ -377,12 +237,8 @@ class OC_DB { public static function disconnect() { // Cut connection if required if(self::$connection) { - if(self::$backend==self::BACKEND_MDB2) { - self::$connection->disconnect(); - } self::$connection=false; - self::$MDB2=false; - self::$PDO=false; + self::$DOCTRINE=false; } return true; @@ -397,18 +253,8 @@ class OC_DB { * TODO: write more documentation */ public static function getDbStructure( $file, $mode=MDB2_SCHEMA_DUMP_STRUCTURE) { - self::connectScheme(); - - // write the scheme - $definition = self::$schema->getDefinitionFromDatabase(); - $dump_options = array( - 'output_mode' => 'file', - 'output' => $file, - 'end_of_line' => "\n" - ); - self::$schema->dumpDatabase( $definition, $dump_options, $mode ); - - return true; + self::connectDoctrine(); + return OC_DB_Schema::getDbStructure(self::$connection, $file); } /** @@ -419,19 +265,8 @@ class OC_DB { * TODO: write more documentation */ public static function createDbFromStructure( $file ) { - $CONFIG_DBNAME = OC_Config::getValue( "dbname", "owncloud" ); - $CONFIG_DBTABLEPREFIX = OC_Config::getValue( "dbtableprefix", "oc_" ); - $CONFIG_DBTYPE = OC_Config::getValue( "dbtype", "sqlite" ); - - self::connectScheme(); - - // read file - $content = file_get_contents( $file ); - - // Make changes and save them to an in-memory file - $file2 = 'static://db_scheme'; - $content = str_replace( '*dbname*', $CONFIG_DBNAME, $content ); - $content = str_replace( '*dbprefix*', $CONFIG_DBTABLEPREFIX, $content ); + self::connectDoctrine(); + return OC_DB_Schema::createDbFromStructure(self::$connection, $file); /* FIXME: use CURRENT_TIMESTAMP for all databases. mysql supports it as a default for DATETIME since 5.6.5 [1] * as a fallback we could use <default>0000-01-01 00:00:00</default> everywhere * [1] http://bugs.mysql.com/bug.php?id=27645 @@ -443,33 +278,6 @@ class OC_DB { if( $CONFIG_DBTYPE == 'pgsql' ) { //mysql support it too but sqlite doesn't $content = str_replace( '<default>0000-00-00 00:00:00</default>', '<default>CURRENT_TIMESTAMP</default>', $content ); } - - file_put_contents( $file2, $content ); - - // Try to create tables - $definition = self::$schema->parseDatabaseDefinitionFile( $file2 ); - - //clean up memory - unlink( $file2 ); - - // Die in case something went wrong - if( $definition instanceof MDB2_Schema_Error ) { - OC_Template::printErrorPage( $definition->getMessage().': '.$definition->getUserInfo() ); - } - if(OC_Config::getValue('dbtype', 'sqlite')==='oci') { - unset($definition['charset']); //or MDB2 tries SHUTDOWN IMMEDIATE - $oldname = $definition['name']; - $definition['name']=OC_Config::getValue( "dbuser", $oldname ); - } - - $ret=self::$schema->createDatabase( $definition ); - - // Die in case something went wrong - if( $ret instanceof MDB2_Error ) { - OC_Template::printErrorPage( self::$MDB2->getDebugOutput().' '.$ret->getMessage() . ': ' . $ret->getUserInfo() ); - } - - return true; } /** @@ -478,26 +286,14 @@ class OC_DB { * @return bool */ public static function updateDbFromStructure($file) { - $CONFIG_DBTABLEPREFIX = OC_Config::getValue( "dbtableprefix", "oc_" ); - $CONFIG_DBTYPE = OC_Config::getValue( "dbtype", "sqlite" ); - - self::connectScheme(); - - // read file - $content = file_get_contents( $file ); - - $previousSchema = self::$schema->getDefinitionFromDatabase(); - if (PEAR::isError($previousSchema)) { - $error = $previousSchema->getMessage(); - $detail = $previousSchema->getDebugInfo(); - OC_Log::write('core', 'Failed to get existing database structure for upgrading ('.$error.', '.$detail.')', OC_Log::FATAL); + self::connectDoctrine(); + try { + $result = OC_DB_Schema::updateDbFromStructure(self::$connection, $file); + } catch (Exception $e) { + OC_Log::write('core', 'Failed to update database structure ('.$e.')', OC_Log::FATAL); return false; } - - // Make changes and save them to an in-memory file - $file2 = 'static://db_scheme'; - $content = str_replace( '*dbname*', $previousSchema['name'], $content ); - $content = str_replace( '*dbprefix*', $CONFIG_DBTABLEPREFIX, $content ); + return $result; /* FIXME: use CURRENT_TIMESTAMP for all databases. mysql supports it as a default for DATETIME since 5.6.5 [1] * as a fallback we could use <default>0000-01-01 00:00:00</default> everywhere * [1] http://bugs.mysql.com/bug.php?id=27645 @@ -509,40 +305,6 @@ class OC_DB { if( $CONFIG_DBTYPE == 'pgsql' ) { //mysql support it too but sqlite doesn't $content = str_replace( '<default>0000-00-00 00:00:00</default>', '<default>CURRENT_TIMESTAMP</default>', $content ); } - file_put_contents( $file2, $content ); - $op = self::$schema->updateDatabase($file2, $previousSchema, array(), false); - - //clean up memory - unlink( $file2 ); - - if (PEAR::isError($op)) { - $error = $op->getMessage(); - $detail = $op->getDebugInfo(); - OC_Log::write('core', 'Failed to update database structure ('.$error.', '.$detail.')', OC_Log::FATAL); - return false; - } - return true; - } - - /** - * @brief connects to a MDB2 database scheme - * @returns bool - * - * Connects to a MDB2 database scheme - */ - private static function connectScheme() { - // We need a mdb2 database connection - self::connectMDB2(); - self::$MDB2->loadModule('Manager'); - self::$MDB2->loadModule('Reverse'); - - // Connect if this did not happen before - if(!self::$schema) { - require_once 'MDB2/Schema.php'; - self::$schema=MDB2_Schema::factory(self::$MDB2); - } - - return true; } /** @@ -661,9 +423,8 @@ class OC_DB { * @param string $tableName the table to drop */ public static function dropTable($tableName) { - self::connectMDB2(); - self::$MDB2->loadModule('Manager'); - self::$MDB2->dropTable($tableName); + self::connectDoctrine(); + OC_DB_Schema::dropTable(self::$connection, $tableName); } /** @@ -671,28 +432,8 @@ class OC_DB { * @param string $file the xml file describing the tables */ public static function removeDBStructure($file) { - $CONFIG_DBNAME = OC_Config::getValue( "dbname", "owncloud" ); - $CONFIG_DBTABLEPREFIX = OC_Config::getValue( "dbtableprefix", "oc_" ); - self::connectScheme(); - - // read file - $content = file_get_contents( $file ); - - // Make changes and save them to a temporary file - $file2 = tempnam( get_temp_dir(), 'oc_db_scheme_' ); - $content = str_replace( '*dbname*', $CONFIG_DBNAME, $content ); - $content = str_replace( '*dbprefix*', $CONFIG_DBTABLEPREFIX, $content ); - file_put_contents( $file2, $content ); - - // get the tables - $definition = self::$schema->parseDatabaseDefinitionFile( $file2 ); - - // Delete our temporary file - unlink( $file2 ); - $tables=array_keys($definition['tables']); - foreach($tables as $table) { - self::dropTable($table); - } + self::connectDoctrine(); + OC_DB_Schema::removeDBStructure(self::$connection, $file); } /** @@ -700,21 +441,8 @@ class OC_DB { * @param $file string path to the MDB2 xml db export file */ public static function replaceDB( $file ) { - $apps = OC_App::getAllApps(); - self::beginTransaction(); - // Delete the old tables - self::removeDBStructure( OC::$SERVERROOT . '/db_structure.xml' ); - - foreach($apps as $app) { - $path = OC_App::getAppPath($app).'/appinfo/database.xml'; - if(file_exists($path)) { - self::removeDBStructure( $path ); - } - } - - // Create new tables - self::createDBFromStructure( $file ); - self::commit(); + self::connectDoctrine(); + OC_DB_Schema::replaceDB(self::$connection, $file); } /** @@ -723,9 +451,6 @@ class OC_DB { */ public static function beginTransaction() { self::connect(); - if (self::$backend==self::BACKEND_MDB2 && !self::$connection->supports('transactions')) { - return false; - } self::$connection->beginTransaction(); self::$inTransaction=true; return true; @@ -746,15 +471,13 @@ class OC_DB { } /** - * check if a result is an error, works with MDB2 and PDOException + * check if a result is an error, works with Doctrine * @param mixed $result * @return bool */ public static function isError($result) { if(!$result) { return true; - }elseif(self::$backend==self::BACKEND_MDB2 and PEAR::isError($result)) { - return true; }else{ return false; } @@ -762,19 +485,14 @@ class OC_DB { /** * returns the error code and message as a string for logging - * works with MDB2 and PDOException + * works with DoctrineException * @param mixed $error * @return string */ public static function getErrorMessage($error) { - if ( self::$backend==self::BACKEND_MDB2 and PEAR::isError($error) ) { - $msg = $error->getCode() . ': ' . $error->getMessage(); - if (defined('DEBUG') && DEBUG) { - $msg .= '(' . $error->getDebugInfo() . ')'; - } - } elseif (self::$backend==self::BACKEND_PDO and self::$PDO) { - $msg = self::$PDO->errorCode() . ': '; - $errorInfo = self::$PDO->errorInfo(); + if (self::$backend==self::BACKEND_DOCTRINE and self::$DOCTRINE) { + $msg = self::$DOCTRINE->errorCode() . ': '; + $errorInfo = self::$DOCTRINE->errorInfo(); if (is_array($errorInfo)) { $msg .= 'SQLSTATE = '.$errorInfo[0] . ', '; $msg .= 'Driver Code = '.$errorInfo[1] . ', '; @@ -790,11 +508,11 @@ class OC_DB { } /** - * small wrapper around PDOStatement to make it behave ,more like an MDB2 Statement + * small wrapper around \Doctrine\DBAL\Driver\Statement to make it behave, more like an MDB2 Statement */ -class PDOStatementWrapper{ +class DoctrineStatementWrapper { /** - * @var PDOStatement + * @var \Doctrine\DBAL\Driver\Statement */ private $statement=null; private $lastArguments=array(); @@ -804,6 +522,20 @@ class PDOStatementWrapper{ } /** + * pass all other function directly to the \Doctrine\DBAL\Driver\Statement + */ + public function __call($name,$arguments) { + return call_user_func_array(array($this->statement,$name), $arguments); + } + + /** + * provide numRows + */ + public function numRows() { + return $this->statement->rowCount(); + } + + /** * make execute return the result instead of a bool */ public function execute($input=array()) { @@ -821,19 +553,6 @@ class PDOStatementWrapper{ } /** - * provide numRows - */ - public function numRows() { - $regex = '/^SELECT\s+(?:ALL\s+|DISTINCT\s+)?(?:.*?)\s+FROM\s+(.*)$/i'; - if (preg_match($regex, $this->statement->queryString, $output) > 0) { - $query = OC_DB::prepare("SELECT COUNT(*) FROM {$output[1]}", PDO::FETCH_NUM); - return $query->execute($this->lastArguments)->fetchColumn(); - }else{ - return $this->statement->rowCount(); - } - } - - /** * provide an alias for fetch */ public function fetchRow() { @@ -841,13 +560,6 @@ class PDOStatementWrapper{ } /** - * pass all other function directly to the PDOStatement - */ - public function __call($name, $arguments) { - return call_user_func_array(array($this->statement, $name), $arguments); - } - - /** * Provide a simple fetchOne. * fetch single column from the next row * @param int $colnum the column number to fetch diff --git a/lib/db/mdb2schemareader.php b/lib/db/mdb2schemareader.php new file mode 100644 index 00000000000..05b9bd21289 --- /dev/null +++ b/lib/db/mdb2schemareader.php @@ -0,0 +1,225 @@ +<?php +/** + * Copyright (c) 2012 Bart Visscher <bartv@thisnet.nl> + * This file is licensed under the Affero General Public License version 3 or + * later. + * See the COPYING-README file. + */ + +class OC_DB_MDB2SchemaReader { + static protected $DBNAME; + static protected $DBTABLEPREFIX; + + public static function loadSchemaFromFile($file) { + self::$DBNAME = OC_Config::getValue( "dbname", "owncloud" ); + self::$DBTABLEPREFIX = OC_Config::getValue( "dbtableprefix", "oc_" ); + $schema = new \Doctrine\DBAL\Schema\Schema(); + $xml = simplexml_load_file($file); + foreach($xml->children() as $child) { + switch($child->getName()) { + case 'name': + $name = (string)$child; + $name = str_replace( '*dbname*', self::$DBNAME, $name ); + break; + case 'create': + case 'overwrite': + case 'charset': + break; + case 'table': + self::loadTable($schema, $child); + break; + default: + var_dump($child->getName()); + + } + } + return $schema; + } + + private static function loadTable($schema, $xml) { + foreach($xml->children() as $child) { + switch($child->getName()) { + case 'name': + $name = (string)$child; + $name = str_replace( '*dbprefix*', self::$DBTABLEPREFIX, $name ); + $table = $schema->createTable($name); + break; + case 'create': + case 'overwrite': + case 'charset': + break; + case 'declaration': + self::loadDeclaration($table, $child); + break; + default: + var_dump($child->getName()); + + } + } + } + + private static function loadDeclaration($table, $xml) { + foreach($xml->children() as $child) { + switch($child->getName()) { + case 'field': + self::loadField($table, $child); + break; + case 'index': + self::loadIndex($table, $child); + break; + default: + var_dump($child->getName()); + + } + } + } + + private static function loadField($table, $xml) { + $options = array(); + foreach($xml->children() as $child) { + switch($child->getName()) { + case 'name': + $name = (string)$child; + break; + case 'type': + $type = (string)$child; + switch($type) { + case 'text': + $type = 'string'; + break; + case 'clob': + $type = 'text'; + break; + case 'timestamp': + $type = 'datetime'; + break; + // TODO + return; + } + break; + case 'length': + $length = (string)$child; + $options['length'] = $length; + break; + case 'unsigned': + $unsigned = self::asBool($child); + $options['unsigned'] = $unsigned; + break; + case 'notnull': + $notnull = self::asBool($child); + $options['notnull'] = $notnull; + break; + case 'autoincrement': + $autoincrement = self::asBool($child); + $options['autoincrement'] = $autoincrement; + break; + case 'default': + $default = (string)$child; + $options['default'] = $default; + break; + default: + var_dump($child->getName()); + + } + } + if (isset($name) && isset($type)) { + if ($name == 'x') { + var_dump($name, $type, $options); + echo '<pre>'; + debug_print_backtrace(); + } + if (empty($options['default'])) { + if ($type == 'integer') { + if (empty($options['default'])) { + if (empty($options['notnull'])) { + unset($options['default']); + } + else { + $options['default'] = 0; + } + } + } + if (!empty($options['autoincrement'])) { + unset($options['default']); + } + } + if ($type == 'integer') { + $length = $options['length']; + if ($length == 1) { + $type = 'boolean'; + } + else if ($length < 4) { + $type = 'smallint'; + } + else if ($length > 4) { + $type = 'bigint'; + } + } + $table->addColumn($name, $type, $options); + if (!empty($options['autoincrement']) + && !empty($options['notnull'])) { + $table->setPrimaryKey(array($name)); + } + } + } + + private static function loadIndex($table, $xml) { + $name = null; + $fields = array(); + foreach($xml->children() as $child) { + switch($child->getName()) { + case 'name': + $name = (string)$child; + break; + case 'primary': + $primary = self::asBool($child); + break; + case 'unique': + $unique = self::asBool($child); + break; + case 'field': + foreach($child->children() as $field) { + switch($field->getName()) { + case 'name': + $field_name = (string)$field; + $fields[] = $field_name; + break; + case 'sorting': + break; + default: + var_dump($field->getName()); + + } + } + break; + default: + var_dump($child->getName()); + + } + } + if (!empty($fields)) { + if (isset($primary) && $primary) { + $table->setPrimaryKey($fields, $name); + } else + if (isset($unique) && $unique) { + $table->addUniqueIndex($fields, $name); + } else { + $table->addIndex($fields, $name); + } + } else { + var_dump($name, $fields); + } + } + + private static function asBool($xml) { + $result = (string)$xml; + if ($result == 'true') { + $result = true; + } else + if ($result == 'false') { + $result = false; + } + return (bool)$result; + } + +} diff --git a/lib/db/mdb2schemawriter.php b/lib/db/mdb2schemawriter.php new file mode 100644 index 00000000000..a6367a0e354 --- /dev/null +++ b/lib/db/mdb2schemawriter.php @@ -0,0 +1,127 @@ +<?php +/** + * Copyright (c) 2012 Bart Visscher <bartv@thisnet.nl> + * This file is licensed under the Affero General Public License version 3 or + * later. + * See the COPYING-README file. + */ + +class OC_DB_MDB2SchemaWriter { + static public function saveSchemaToFile($file, $sm) { + $xml = new SimpleXMLElement('<database/>'); + $xml->addChild('name', OC_Config::getValue( "dbname", "owncloud" )); + $xml->addChild('create', 'true'); + $xml->addChild('overwrite', 'false'); + $xml->addChild('charset', 'utf8'); + foreach ($sm->listTables() as $table) { + self::saveTable($table, $xml->addChild('table')); + } + file_put_contents($file, $xml->asXML()); + return true; + } + + 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')); + } + } + + 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; + + } + } + + 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'; + } +} diff --git a/lib/db/schema.php b/lib/db/schema.php new file mode 100644 index 00000000000..231b8068af0 --- /dev/null +++ b/lib/db/schema.php @@ -0,0 +1,127 @@ +<?php +/** + * Copyright (c) 2012 Bart Visscher <bartv@thisnet.nl> + * This file is licensed under the Affero General Public License version 3 or + * later. + * See the COPYING-README file. + */ + +class OC_DB_Schema { + private static $DBNAME; + private static $DBTABLEPREFIX; + + /** + * @brief saves database scheme to xml file + * @param string $file name of file + * @param int $mode + * @return bool + * + * TODO: write more documentation + */ + public static function getDbStructure( $conn, $file, $mode=MDB2_SCHEMA_DUMP_STRUCTURE) { + $sm = $conn->getSchemaManager(); + + return OC_DB_MDB2SchemaWriter::saveSchemaToFile($file, $sm); + } + + /** + * @brief Creates tables from XML file + * @param string $file file to read structure from + * @return bool + * + * TODO: write more documentation + */ + public static function createDbFromStructure( $conn, $file ) { + $toSchema = OC_DB_MDB2SchemaReader::loadSchemaFromFile($file); + return self::executeSchemaChange($conn, $toSchema); + } + + /** + * @brief update the database scheme + * @param string $file file to read structure from + * @return bool + */ + public static function updateDbFromStructure($conn, $file) { + $sm = $conn->getSchemaManager(); + $fromSchema = $sm->createSchema(); + + $toSchema = OC_DB_MDB2SchemaReader::loadSchemaFromFile($file); + + // remove tables we don't know about + foreach($fromSchema->getTables() as $table) { + if (!$toSchema->hasTable($table->getName())) { + $fromSchema->dropTable($table->getName()); + } + } + + $comparator = new \Doctrine\DBAL\Schema\Comparator(); + $schemaDiff = $comparator->compare($fromSchema, $toSchema); + + //$from = $fromSchema->toSql($conn->getDatabasePlatform()); + //$to = $toSchema->toSql($conn->getDatabasePlatform()); + //echo($from[9]); + //echo '<br>'; + //echo($to[9]); + //var_dump($from, $to); + return self::executeSchemaChange($conn, $schemaDiff); + } + + /** + * @brief drop a table + * @param string $tableName the table to drop + */ + public static function dropTable($conn, $tableName) { + $sm = $conn->getSchemaManager(); + $fromSchema = $sm->createSchema(); + $toSchema = clone $fromSchema; + $toSchema->dropTable('user'); + $sql = $fromSchema->getMigrateToSql($toSchema, $conn->getDatabasePlatform()); + var_dump($sql); + die; + $conn->execute($sql); + } + + /** + * remove all tables defined in a database structure xml file + * @param string $file the xml file describing the tables + */ + public static function removeDBStructure($conn, $file) { + $fromSchema = OC_DB_MDB2SchemaReader::loadSchemaFromFile($file); + $toSchema = clone $fromSchema; + foreach($toSchema->getTables() as $table) { + $toSchema->dropTable($table->getName()); + } + $comparator = new \Doctrine\DBAL\Schema\Comparator(); + $schemaDiff = $comparator->compare($fromSchema, $toSchema); + self::executeSchemaChange($conn, $schemaDiff); + } + + /** + * @brief replaces the owncloud tables with a new set + * @param $file string path to the MDB2 xml db export file + */ + public static function replaceDB( $conn, $file ) { + $apps = OC_App::getAllApps(); + self::beginTransaction(); + // Delete the old tables + self::removeDBStructure( OC::$SERVERROOT . '/db_structure.xml' ); + + foreach($apps as $app) { + $path = OC_App::getAppPath($app).'/appinfo/database.xml'; + if(file_exists($path)) { + self::removeDBStructure( $path ); + } + } + + // Create new tables + self::commit(); + } + + private static function executeSchemaChange($conn, $schema) { + $conn->beginTransaction(); + foreach($schema->toSql($conn->getDatabasePlatform()) as $sql) { + $conn->query($sql); + } + $conn->commit(); + } +} |