Use Doctrine for schema changes

3 files changed, 375 insertions, 145 deletions

diff --git a/lib/db.php b/lib/db.php
index 0d1a70c7246..d43ca77ff57 100644
--- a/lib/db.php
+++ b/lib/db.php
@@ -20,6 +20,7 @@
  *
  */
 
+define('MDB2_SCHEMA_DUMP_STRUCTURE', '1');
 /**
  * This class manages the access to the database. It basically is a wrapper for
  * MDB2 with some adaptions.
@@ -503,18 +504,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);
 	}
 
 	/**
@@ -525,19 +516,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
@@ -549,34 +529,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 ) {
-			die( $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 ) {
-			echo (self::$MDB2->getDebugOutput());
-			die ($ret->getMessage() . ': ' . $ret->getUserInfo());
-		}
-
-		return true;
 	}
 
 	/**
@@ -585,26 +537,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
@@ -616,40 +556,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;
 	}
 
 	/**
@@ -696,9 +602,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);
 	}
 
 	/**
@@ -706,28 +611,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);
 	}
 
 	/**
@@ -735,21 +620,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);
 	}
 
 	/**
@@ -817,6 +689,16 @@ class OC_DB {
 			}else{
 				$msg = '';
 			}
+		} elseif (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] . ', ';
+				$msg .= 'Driver Message = '.$errorInfo[2];
+			}else{
+				$msg = '';
+			}
 		}else{
 			$msg = '';
 		}
diff --git a/lib/db/mdb2schemareader.php b/lib/db/mdb2schemareader.php
new file mode 100644
index 00000000000..3f6cadd3dc4
--- /dev/null
+++ b/lib/db/mdb2schemareader.php
@@ -0,0 +1,220 @@
+<?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'])) {
+						$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/schema.php b/lib/db/schema.php
new file mode 100644
index 00000000000..ca90e300e0d
--- /dev/null
+++ b/lib/db/schema.php
@@ -0,0 +1,128 @@
+<?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();
+		$fromSchema = $sm->createSchema();
+
+		return OC_DB_MDB2SchemaWriter::saveSchemaToFile($file);
+	}
+
+	/**
+	 * @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();
+	}
+}