nextcloud / server

lib/private/DB/Migrator.php

Indentation +261 added lines, -261 removed lines

@@ -49,265 +49,265 @@
 
 class Migrator {
 
-	/** @var \Doctrine\DBAL\Connection */
-	protected $connection;
-
-	/** @var ISecureRandom */
-	private $random;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var EventDispatcherInterface  */
-	private $dispatcher;
-
-	/** @var bool */
-	private $noEmit = false;
-
-	/**
-	 * @param \Doctrine\DBAL\Connection $connection
-	 * @param ISecureRandom $random
-	 * @param IConfig $config
-	 * @param EventDispatcherInterface $dispatcher
-	 */
-	public function __construct(\Doctrine\DBAL\Connection $connection,
-								ISecureRandom $random,
-								IConfig $config,
-								EventDispatcherInterface $dispatcher = null) {
-		$this->connection = $connection;
-		$this->random = $random;
-		$this->config = $config;
-		$this->dispatcher = $dispatcher;
-	}
-
-	/**
-	 * @param \Doctrine\DBAL\Schema\Schema $targetSchema
-	 *
-	 * @throws Exception
-	 */
-	public function migrate(Schema $targetSchema) {
-		$this->noEmit = true;
-		$this->applySchema($targetSchema);
-	}
-
-	/**
-	 * @param \Doctrine\DBAL\Schema\Schema $targetSchema
-	 * @return string
-	 */
-	public function generateChangeScript(Schema $targetSchema) {
-		$schemaDiff = $this->getDiff($targetSchema, $this->connection);
-
-		$script = '';
-		$sqls = $schemaDiff->toSql($this->connection->getDatabasePlatform());
-		foreach ($sqls as $sql) {
-			$script .= $this->convertStatementToScript($sql);
-		}
-
-		return $script;
-	}
-
-	/**
-	 * Create a unique name for the temporary table
-	 *
-	 * @param string $name
-	 * @return string
-	 */
-	protected function generateTemporaryTableName($name) {
-		return $this->config->getSystemValue('dbtableprefix', 'oc_') . $name . '_' . $this->random->generate(13, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS);
-	}
-
-	/**
-	 * Check the migration of a table on a copy so we can detect errors before messing with the real table
-	 *
-	 * @param \Doctrine\DBAL\Schema\Table $table
-	 * @throws \OC\DB\MigrationException
-	 */
-	protected function checkTableMigrate(Table $table) {
-		$name = $table->getName();
-		$tmpName = $this->generateTemporaryTableName($name);
-
-		$this->copyTable($name, $tmpName);
-
-		//create the migration schema for the temporary table
-		$tmpTable = $this->renameTableSchema($table, $tmpName);
-		$schemaConfig = new SchemaConfig();
-		$schemaConfig->setName($this->connection->getDatabase());
-		$schema = new Schema([$tmpTable], [], $schemaConfig);
-
-		try {
-			$this->applySchema($schema);
-			$this->dropTable($tmpName);
-		} catch (Exception $e) {
-			// pgsql needs to commit it's failed transaction before doing anything else
-			if ($this->connection->isTransactionActive()) {
-				$this->connection->commit();
-			}
-			$this->dropTable($tmpName);
-			throw new MigrationException($table->getName(), $e->getMessage());
-		}
-	}
-
-	/**
-	 * @param \Doctrine\DBAL\Schema\Table $table
-	 * @param string $newName
-	 * @return \Doctrine\DBAL\Schema\Table
-	 */
-	protected function renameTableSchema(Table $table, $newName) {
-		/**
-		 * @var \Doctrine\DBAL\Schema\Index[] $indexes
-		 */
-		$indexes = $table->getIndexes();
-		$newIndexes = [];
-		foreach ($indexes as $index) {
-			if ($index->isPrimary()) {
-				// do not rename primary key
-				$indexName = $index->getName();
-			} else {
-				// avoid conflicts in index names
-				$indexName = $this->config->getSystemValue('dbtableprefix', 'oc_') . $this->random->generate(13, ISecureRandom::CHAR_LOWER);
-			}
-			$newIndexes[] = new Index($indexName, $index->getColumns(), $index->isUnique(), $index->isPrimary());
-		}
-
-		// foreign keys are not supported so we just set it to an empty array
-		return new Table($newName, $table->getColumns(), $newIndexes, [], [], $table->getOptions());
-	}
-
-	/**
-	 * @throws Exception
-	 */
-	public function createSchema() {
-		$this->connection->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
-			/** @var string|AbstractAsset $asset */
-			$filterExpression = $this->getFilterExpression();
-			if ($asset instanceof AbstractAsset) {
-				return preg_match($filterExpression, $asset->getName()) === 1;
-			}
-			return preg_match($filterExpression, $asset) === 1;
-		});
-		return $this->connection->getSchemaManager()->createSchema();
-	}
-
-	/**
-	 * @param Schema $targetSchema
-	 * @param \Doctrine\DBAL\Connection $connection
-	 * @return \Doctrine\DBAL\Schema\SchemaDiff
-	 */
-	protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
-		// adjust varchar columns with a length higher then getVarcharMaxLength to clob
-		foreach ($targetSchema->getTables() as $table) {
-			foreach ($table->getColumns() as $column) {
-				if ($column->getType() instanceof StringType) {
-					if ($column->getLength() > $connection->getDatabasePlatform()->getVarcharMaxLength()) {
-						$column->setType(Type::getType('text'));
-						$column->setLength(null);
-					}
-				}
-			}
-		}
-
-		$this->connection->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
-			/** @var string|AbstractAsset $asset */
-			$filterExpression = $this->getFilterExpression();
-			if ($asset instanceof AbstractAsset) {
-				return preg_match($filterExpression, $asset->getName()) === 1;
-			}
-			return preg_match($filterExpression, $asset) === 1;
-		});
-		$sourceSchema = $connection->getSchemaManager()->createSchema();
-
-		// remove tables we don't know about
-		foreach ($sourceSchema->getTables() as $table) {
-			if (!$targetSchema->hasTable($table->getName())) {
-				$sourceSchema->dropTable($table->getName());
-			}
-		}
-		// remove sequences we don't know about
-		foreach ($sourceSchema->getSequences() as $table) {
-			if (!$targetSchema->hasSequence($table->getName())) {
-				$sourceSchema->dropSequence($table->getName());
-			}
-		}
-
-		$comparator = new Comparator();
-		return $comparator->compare($sourceSchema, $targetSchema);
-	}
-
-	/**
-	 * @param \Doctrine\DBAL\Schema\Schema $targetSchema
-	 * @param \Doctrine\DBAL\Connection $connection
-	 *
-	 * @throws Exception
-	 */
-	protected function applySchema(Schema $targetSchema, \Doctrine\DBAL\Connection $connection = null) {
-		if (is_null($connection)) {
-			$connection = $this->connection;
-		}
-
-		$schemaDiff = $this->getDiff($targetSchema, $connection);
-
-		if (!$connection->getDatabasePlatform() instanceof MySQLPlatform) {
-			$connection->beginTransaction();
-		}
-		$sqls = $schemaDiff->toSql($connection->getDatabasePlatform());
-		$step = 0;
-		foreach ($sqls as $sql) {
-			$this->emit($sql, $step++, count($sqls));
-			$connection->query($sql);
-		}
-		if (!$connection->getDatabasePlatform() instanceof MySQLPlatform) {
-			$connection->commit();
-		}
-	}
-
-	/**
-	 * @param string $sourceName
-	 * @param string $targetName
-	 */
-	protected function copyTable($sourceName, $targetName) {
-		$quotedSource = $this->connection->quoteIdentifier($sourceName);
-		$quotedTarget = $this->connection->quoteIdentifier($targetName);
-
-		$this->connection->exec('CREATE TABLE ' . $quotedTarget . ' (LIKE ' . $quotedSource . ')');
-		$this->connection->exec('INSERT INTO ' . $quotedTarget . ' SELECT * FROM ' . $quotedSource);
-	}
-
-	/**
-	 * @param string $name
-	 */
-	protected function dropTable($name) {
-		$this->connection->exec('DROP TABLE ' . $this->connection->quoteIdentifier($name));
-	}
-
-	/**
-	 * @param $statement
-	 * @return string
-	 */
-	protected function convertStatementToScript($statement) {
-		$script = $statement . ';';
-		$script .= PHP_EOL;
-		$script .= PHP_EOL;
-		return $script;
-	}
-
-	protected function getFilterExpression() {
-		return '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
-	}
-
-	protected function emit($sql, $step, $max) {
-		if ($this->noEmit) {
-			return;
-		}
-		if (is_null($this->dispatcher)) {
-			return;
-		}
-		$this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step + 1, $max]));
-	}
-
-	private function emitCheckStep($tableName, $step, $max) {
-		if (is_null($this->dispatcher)) {
-			return;
-		}
-		$this->dispatcher->dispatch('\OC\DB\Migrator::checkTable', new GenericEvent($tableName, [$step + 1, $max]));
-	}
+    /** @var \Doctrine\DBAL\Connection */
+    protected $connection;
+
+    /** @var ISecureRandom */
+    private $random;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var EventDispatcherInterface  */
+    private $dispatcher;
+
+    /** @var bool */
+    private $noEmit = false;
+
+    /**
+     * @param \Doctrine\DBAL\Connection $connection
+     * @param ISecureRandom $random
+     * @param IConfig $config
+     * @param EventDispatcherInterface $dispatcher
+     */
+    public function __construct(\Doctrine\DBAL\Connection $connection,
+                                ISecureRandom $random,
+                                IConfig $config,
+                                EventDispatcherInterface $dispatcher = null) {
+        $this->connection = $connection;
+        $this->random = $random;
+        $this->config = $config;
+        $this->dispatcher = $dispatcher;
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $targetSchema
+     *
+     * @throws Exception
+     */
+    public function migrate(Schema $targetSchema) {
+        $this->noEmit = true;
+        $this->applySchema($targetSchema);
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $targetSchema
+     * @return string
+     */
+    public function generateChangeScript(Schema $targetSchema) {
+        $schemaDiff = $this->getDiff($targetSchema, $this->connection);
+
+        $script = '';
+        $sqls = $schemaDiff->toSql($this->connection->getDatabasePlatform());
+        foreach ($sqls as $sql) {
+            $script .= $this->convertStatementToScript($sql);
+        }
+
+        return $script;
+    }
+
+    /**
+     * Create a unique name for the temporary table
+     *
+     * @param string $name
+     * @return string
+     */
+    protected function generateTemporaryTableName($name) {
+        return $this->config->getSystemValue('dbtableprefix', 'oc_') . $name . '_' . $this->random->generate(13, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_DIGITS);
+    }
+
+    /**
+     * Check the migration of a table on a copy so we can detect errors before messing with the real table
+     *
+     * @param \Doctrine\DBAL\Schema\Table $table
+     * @throws \OC\DB\MigrationException
+     */
+    protected function checkTableMigrate(Table $table) {
+        $name = $table->getName();
+        $tmpName = $this->generateTemporaryTableName($name);
+
+        $this->copyTable($name, $tmpName);
+
+        //create the migration schema for the temporary table
+        $tmpTable = $this->renameTableSchema($table, $tmpName);
+        $schemaConfig = new SchemaConfig();
+        $schemaConfig->setName($this->connection->getDatabase());
+        $schema = new Schema([$tmpTable], [], $schemaConfig);
+
+        try {
+            $this->applySchema($schema);
+            $this->dropTable($tmpName);
+        } catch (Exception $e) {
+            // pgsql needs to commit it's failed transaction before doing anything else
+            if ($this->connection->isTransactionActive()) {
+                $this->connection->commit();
+            }
+            $this->dropTable($tmpName);
+            throw new MigrationException($table->getName(), $e->getMessage());
+        }
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Table $table
+     * @param string $newName
+     * @return \Doctrine\DBAL\Schema\Table
+     */
+    protected function renameTableSchema(Table $table, $newName) {
+        /**
+         * @var \Doctrine\DBAL\Schema\Index[] $indexes
+         */
+        $indexes = $table->getIndexes();
+        $newIndexes = [];
+        foreach ($indexes as $index) {
+            if ($index->isPrimary()) {
+                // do not rename primary key
+                $indexName = $index->getName();
+            } else {
+                // avoid conflicts in index names
+                $indexName = $this->config->getSystemValue('dbtableprefix', 'oc_') . $this->random->generate(13, ISecureRandom::CHAR_LOWER);
+            }
+            $newIndexes[] = new Index($indexName, $index->getColumns(), $index->isUnique(), $index->isPrimary());
+        }
+
+        // foreign keys are not supported so we just set it to an empty array
+        return new Table($newName, $table->getColumns(), $newIndexes, [], [], $table->getOptions());
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function createSchema() {
+        $this->connection->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
+            /** @var string|AbstractAsset $asset */
+            $filterExpression = $this->getFilterExpression();
+            if ($asset instanceof AbstractAsset) {
+                return preg_match($filterExpression, $asset->getName()) === 1;
+            }
+            return preg_match($filterExpression, $asset) === 1;
+        });
+        return $this->connection->getSchemaManager()->createSchema();
+    }
+
+    /**
+     * @param Schema $targetSchema
+     * @param \Doctrine\DBAL\Connection $connection
+     * @return \Doctrine\DBAL\Schema\SchemaDiff
+     */
+    protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
+        // adjust varchar columns with a length higher then getVarcharMaxLength to clob
+        foreach ($targetSchema->getTables() as $table) {
+            foreach ($table->getColumns() as $column) {
+                if ($column->getType() instanceof StringType) {
+                    if ($column->getLength() > $connection->getDatabasePlatform()->getVarcharMaxLength()) {
+                        $column->setType(Type::getType('text'));
+                        $column->setLength(null);
+                    }
+                }
+            }
+        }
+
+        $this->connection->getConfiguration()->setSchemaAssetsFilter(function ($asset) {
+            /** @var string|AbstractAsset $asset */
+            $filterExpression = $this->getFilterExpression();
+            if ($asset instanceof AbstractAsset) {
+                return preg_match($filterExpression, $asset->getName()) === 1;
+            }
+            return preg_match($filterExpression, $asset) === 1;
+        });
+        $sourceSchema = $connection->getSchemaManager()->createSchema();
+
+        // remove tables we don't know about
+        foreach ($sourceSchema->getTables() as $table) {
+            if (!$targetSchema->hasTable($table->getName())) {
+                $sourceSchema->dropTable($table->getName());
+            }
+        }
+        // remove sequences we don't know about
+        foreach ($sourceSchema->getSequences() as $table) {
+            if (!$targetSchema->hasSequence($table->getName())) {
+                $sourceSchema->dropSequence($table->getName());
+            }
+        }
+
+        $comparator = new Comparator();
+        return $comparator->compare($sourceSchema, $targetSchema);
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $targetSchema
+     * @param \Doctrine\DBAL\Connection $connection
+     *
+     * @throws Exception
+     */
+    protected function applySchema(Schema $targetSchema, \Doctrine\DBAL\Connection $connection = null) {
+        if (is_null($connection)) {
+            $connection = $this->connection;
+        }
+
+        $schemaDiff = $this->getDiff($targetSchema, $connection);
+
+        if (!$connection->getDatabasePlatform() instanceof MySQLPlatform) {
+            $connection->beginTransaction();
+        }
+        $sqls = $schemaDiff->toSql($connection->getDatabasePlatform());
+        $step = 0;
+        foreach ($sqls as $sql) {
+            $this->emit($sql, $step++, count($sqls));
+            $connection->query($sql);
+        }
+        if (!$connection->getDatabasePlatform() instanceof MySQLPlatform) {
+            $connection->commit();
+        }
+    }
+
+    /**
+     * @param string $sourceName
+     * @param string $targetName
+     */
+    protected function copyTable($sourceName, $targetName) {
+        $quotedSource = $this->connection->quoteIdentifier($sourceName);
+        $quotedTarget = $this->connection->quoteIdentifier($targetName);
+
+        $this->connection->exec('CREATE TABLE ' . $quotedTarget . ' (LIKE ' . $quotedSource . ')');
+        $this->connection->exec('INSERT INTO ' . $quotedTarget . ' SELECT * FROM ' . $quotedSource);
+    }
+
+    /**
+     * @param string $name
+     */
+    protected function dropTable($name) {
+        $this->connection->exec('DROP TABLE ' . $this->connection->quoteIdentifier($name));
+    }
+
+    /**
+     * @param $statement
+     * @return string
+     */
+    protected function convertStatementToScript($statement) {
+        $script = $statement . ';';
+        $script .= PHP_EOL;
+        $script .= PHP_EOL;
+        return $script;
+    }
+
+    protected function getFilterExpression() {
+        return '/^' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
+    }
+
+    protected function emit($sql, $step, $max) {
+        if ($this->noEmit) {
+            return;
+        }
+        if (is_null($this->dispatcher)) {
+            return;
+        }
+        $this->dispatcher->dispatch('\OC\DB\Migrator::executeSql', new GenericEvent($sql, [$step + 1, $max]));
+    }
+
+    private function emitCheckStep($tableName, $step, $max) {
+        if (is_null($this->dispatcher)) {
+            return;
+        }
+        $this->dispatcher->dispatch('\OC\DB\Migrator::checkTable', new GenericEvent($tableName, [$step + 1, $max]));
+    }
 }