Mirrors/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2024-08-05 20:16:00 +02:00
Code Issues Actions 26 Packages Projects Releases Wiki Activity

make MDB2Schema reader non static

Browse Source
This commit is contained in:
Robin Appelman 2013-07-29 16:33:00 +02:00
parent fbbe0ebe77
commit d6c56b584a
2 changed files with 144 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

197
lib/db/mdb2schemareader.php
View File

@ -6,35 +6,57 @@
* See the COPYING-README file. * See the COPYING-README file.
*/ */
class OC_DB_MDB2SchemaReader { namespace OC\DB;
static protected $DBNAME;
static protected $DBTABLEPREFIX; class MDB2SchemaReader {
static protected $platform; /**
* @var string $DBNAME
*/
protected $DBNAME;
/** /**
* @param $file * @var string $DBTABLEPREFIX
* @param $platform
* @return \Doctrine\DBAL\Schema\Schema
* @throws DomainException
*/ */
public static function loadSchemaFromFile($file, $platform) { protected $DBTABLEPREFIX;
self::$DBNAME = OC_Config::getValue( "dbname", "owncloud" );
self::$DBTABLEPREFIX = OC_Config::getValue( "dbtableprefix", "oc_" ); /**
self::$platform = $platform; * @var \Doctrine\DBAL\Platforms\AbstractPlatform $platform
*/
protected $platform;
/**
* @param \OC\Config $config
* @param \Doctrine\DBAL\Platforms\AbstractPlatform $platform
*/
public function __construct($config, $platform) {
$this->platform = $platform;
$this->DBNAME = $config->getValue('dbname', 'owncloud');
$this->DBTABLEPREFIX = $config->getValue('dbtableprefix', 'oc_');
}
/**
* @param string $file
* @return \Doctrine\DBAL\Schema\Schema
* @throws \DomainException
*/
public function loadSchemaFromFile($file) {
$schema = new \Doctrine\DBAL\Schema\Schema(); $schema = new \Doctrine\DBAL\Schema\Schema();
$xml = simplexml_load_file($file); $xml = simplexml_load_file($file);
foreach($xml->children() as $child) { foreach ($xml->children() as $child) {
switch($child->getName()) { /**
* @var \SimpleXMLElement $child
*/
switch ($child->getName()) {
case 'name': case 'name':
case 'create': case 'create':
case 'overwrite': case 'overwrite':
case 'charset': case 'charset':
break; break;
case 'table': case 'table':
self::loadTable($schema, $child); $this->loadTable($schema, $child);
break; break;
default: default:
throw new DomainException('Unknown element: '.$child->getName()); throw new \DomainException('Unknown element: ' . $child->getName());
} }
} }
@ -43,16 +65,20 @@ class OC_DB_MDB2SchemaReader {
/** /**
* @param\Doctrine\DBAL\Schema\Schema $schema * @param\Doctrine\DBAL\Schema\Schema $schema
* @param $xml * @param \SimpleXMLElement $xml
* @throws DomainException * @throws \DomainException
*/ */
private static function loadTable($schema, $xml) { private function loadTable($schema, $xml) {
foreach($xml->children() as $child) { $table = null;
switch($child->getName()) { foreach ($xml->children() as $child) {
/**
* @var \SimpleXMLElement $child
*/
switch ($child->getName()) {
case 'name': case 'name':
$name = (string)$child; $name = (string)$child;
$name = str_replace( '*dbprefix*', self::$DBTABLEPREFIX, $name ); $name = str_replace('*dbprefix*', $this->DBTABLEPREFIX, $name);
$name = self::$platform->quoteIdentifier($name); $name = $this->platform->quoteIdentifier($name);
$table = $schema->createTable($name); $table = $schema->createTable($name);
break; break;
case 'create': case 'create':
@ -60,10 +86,13 @@ class OC_DB_MDB2SchemaReader {
case 'charset': case 'charset':
break; break;
case 'declaration': case 'declaration':
self::loadDeclaration($table, $child); if (is_null($table)) {
throw new \DomainException('Table declaration before table name');
}
$this->loadDeclaration($table, $child);
break; break;
default: default:
throw new DomainException('Unknown element: '.$child->getName()); throw new \DomainException('Unknown element: ' . $child->getName());
} }
} }
@ -71,36 +100,47 @@ class OC_DB_MDB2SchemaReader {
/** /**
* @param \Doctrine\DBAL\Schema\Table $table * @param \Doctrine\DBAL\Schema\Table $table
* @param $xml * @param \SimpleXMLElement $xml
* @throws DomainException * @throws \DomainException
*/ */
private static function loadDeclaration($table, $xml) { private function loadDeclaration($table, $xml) {
foreach($xml->children() as $child) { foreach ($xml->children() as $child) {
switch($child->getName()) { /**
* @var \SimpleXMLElement $child
*/
switch ($child->getName()) {
case 'field': case 'field':
self::loadField($table, $child); $this->loadField($table, $child);
break; break;
case 'index': case 'index':
self::loadIndex($table, $child); $this->loadIndex($table, $child);
break; break;
default: default:
throw new DomainException('Unknown element: '.$child->getName()); throw new \DomainException('Unknown element: ' . $child->getName());
} }
} }
} }
private static function loadField($table, $xml) { /**
* @param \Doctrine\DBAL\Schema\Table $table
* @param \SimpleXMLElement $xml
* @throws \DomainException
*/
private function loadField($table, $xml) {
$options = array(); $options = array();
foreach($xml->children() as $child) { foreach ($xml->children() as $child) {
switch($child->getName()) { /**
* @var \SimpleXMLElement $child
*/
switch ($child->getName()) {
case 'name': case 'name':
$name = (string)$child; $name = (string)$child;
$name = self::$platform->quoteIdentifier($name); $name = $this->platform->quoteIdentifier($name);
break; break;
case 'type': case 'type':
$type = (string)$child; $type = (string)$child;
switch($type) { switch ($type) {
case 'text': case 'text':
$type = 'string'; $type = 'string';
break; break;
@ -110,8 +150,6 @@ class OC_DB_MDB2SchemaReader {
case 'timestamp': case 'timestamp':
$type = 'datetime'; $type = 'datetime';
break; break;
// TODO
return;
} }
break; break;
case 'length': case 'length':
@ -119,15 +157,15 @@ class OC_DB_MDB2SchemaReader {
$options['length'] = $length; $options['length'] = $length;
break; break;
case 'unsigned': case 'unsigned':
$unsigned = self::asBool($child); $unsigned = $this->asBool($child);
$options['unsigned'] = $unsigned; $options['unsigned'] = $unsigned;
break; break;
case 'notnull': case 'notnull':
$notnull = self::asBool($child); $notnull = $this->asBool($child);
$options['notnull'] = $notnull; $options['notnull'] = $notnull;
break; break;
case 'autoincrement': case 'autoincrement':
$autoincrement = self::asBool($child); $autoincrement = $this->asBool($child);
$options['autoincrement'] = $autoincrement; $options['autoincrement'] = $autoincrement;
break; break;
case 'default': case 'default':
@ -139,11 +177,11 @@ class OC_DB_MDB2SchemaReader {
$options['comment'] = $comment; $options['comment'] = $comment;
break; break;
case 'primary': case 'primary':
$primary = self::asBool($child); $primary = $this->asBool($child);
$options['primary'] = $primary; $options['primary'] = $primary;
break; break;
default: default:
throw new DomainException('Unknown element: '.$child->getName()); throw new \DomainException('Unknown element: ' . $child->getName());
} }
} }
@ -157,25 +195,30 @@ class OC_DB_MDB2SchemaReader {
} }
if ($type == 'integer') { if ($type == 'integer') {
$options['default'] = 0; $options['default'] = 0;
} elseif ($type == 'boolean') {
$options['default'] = false;
} }
if (!empty($options['autoincrement']) && $options['autoincrement']) { if (!empty($options['autoincrement']) && $options['autoincrement']) {
unset($options['default']); unset($options['default']);
} }
} }
if ($type == 'integer' && isset($options['length'])) { if ($type === 'integer' && isset($options['default'])) {
$options['default'] = (int)$options['default'];
}
if ($type === 'integer' && isset($options['length'])) {
$length = $options['length']; $length = $options['length'];
if ($length < 4) { if ($length < 4) {
$type = 'smallint'; $type = 'smallint';
} } else if ($length > 4) {
else if ($length > 4) {
$type = 'bigint'; $type = 'bigint';
} }
} }
if ($type === 'boolean' && isset($options['default'])){ if ($type === 'boolean' && isset($options['default'])) {
$options['default'] = self::asBool($options['default']); $options['default'] = $this->asBool($options['default']);
} }
if (!empty($options['autoincrement']) if (!empty($options['autoincrement'])
&& !empty($options['notnull'])) { && !empty($options['notnull'])
) {
$options['primary'] = true; $options['primary'] = true;
} }
$table->addColumn($name, $type, $options); $table->addColumn($name, $type, $options);
@ -185,38 +228,49 @@ class OC_DB_MDB2SchemaReader {
} }
} }
private static function loadIndex($table, $xml) { /**
* @param \Doctrine\DBAL\Schema\Table $table
* @param \SimpleXMLElement $xml
* @throws \DomainException
*/
private function loadIndex($table, $xml) {
$name = null; $name = null;
$fields = array(); $fields = array();
foreach($xml->children() as $child) { foreach ($xml->children() as $child) {
switch($child->getName()) { /**
* @var \SimpleXMLElement $child
*/
switch ($child->getName()) {
case 'name': case 'name':
$name = (string)$child; $name = (string)$child;
break; break;
case 'primary': case 'primary':
$primary = self::asBool($child); $primary = $this->asBool($child);
break; break;
case 'unique': case 'unique':
$unique = self::asBool($child); $unique = $this->asBool($child);
break; break;
case 'field': case 'field':
foreach($child->children() as $field) { foreach ($child->children() as $field) {
switch($field->getName()) { /**
* @var \SimpleXMLElement $field
*/
switch ($field->getName()) {
case 'name': case 'name':
$field_name = (string)$field; $field_name = (string)$field;
$field_name = self::$platform->quoteIdentifier($field_name); $field_name = $this->platform->quoteIdentifier($field_name);
$fields[] = $field_name; $fields[] = $field_name;
break; break;
case 'sorting': case 'sorting':
break; break;
default: default:
throw new DomainException('Unknown element: '.$field->getName()); throw new \DomainException('Unknown element: ' . $field->getName());
} }
} }
break; break;
default: default:
throw new DomainException('Unknown element: '.$child->getName()); throw new \DomainException('Unknown element: ' . $child->getName());
} }
} }
@ -224,22 +278,25 @@ class OC_DB_MDB2SchemaReader {
if (isset($primary) && $primary) { if (isset($primary) && $primary) {
$table->setPrimaryKey($fields, $name); $table->setPrimaryKey($fields, $name);
} else } else
if (isset($unique) && $unique) { if (isset($unique) && $unique) {
$table->addUniqueIndex($fields, $name); $table->addUniqueIndex($fields, $name);
} else { } else {
$table->addIndex($fields, $name); $table->addIndex($fields, $name);
} }
} else { } else {
throw new DomainException('Empty index definition: '.$name.' options:'. print_r($fields, true)); throw new \DomainException('Empty index definition: ' . $name . ' options:' . print_r($fields, true));
} }
} }
private static function asBool($xml) { /**
* @param \SimpleXMLElement | string $xml
* @return bool
*/
private function asBool($xml) {
$result = (string)$xml; $result = (string)$xml;
if ($result == 'true') { if ($result == 'true') {
$result = true; $result = true;
} else } elseif ($result == 'false') {
if ($result == 'false') {
$result = false; $result = false;
} }
return (bool)$result; return (bool)$result;

20
lib/db/schema.php
View File

@ -24,18 +24,21 @@ class OC_DB_Schema {
/** /**
* @brief Creates tables from XML file * @brief Creates tables from XML file
* @param \Doctrine\DBAL\Connection $conn
* @param string $file file to read structure from * @param string $file file to read structure from
* @return bool * @return bool
* *
* TODO: write more documentation * TODO: write more documentation
*/ */
public static function createDbFromStructure( $conn, $file ) { public static function createDbFromStructure( $conn, $file ) {
$toSchema = OC_DB_MDB2SchemaReader::loadSchemaFromFile($file, $conn->getDatabasePlatform()); $schemaReader = new \OC\DB\MDB2SchemaReader(\OC_Config::getObject(), $conn->getDatabasePlatform());
$toSchema = $schemaReader->loadSchemaFromFile($file);
return self::executeSchemaChange($conn, $toSchema); return self::executeSchemaChange($conn, $toSchema);
} }
/** /**
* @brief update the database scheme * @brief update the database scheme
* @param \Doctrine\DBAL\Connection $conn
* @param string $file file to read structure from * @param string $file file to read structure from
* @return bool * @return bool
*/ */
@ -43,7 +46,8 @@ class OC_DB_Schema {
$sm = $conn->getSchemaManager(); $sm = $conn->getSchemaManager();
$fromSchema = $sm->createSchema(); $fromSchema = $sm->createSchema();
$toSchema = OC_DB_MDB2SchemaReader::loadSchemaFromFile($file, $conn->getDatabasePlatform()); $schemaReader = new \OC\DB\MDB2SchemaReader(\OC_Config::getObject(), $conn->getDatabasePlatform());
$toSchema = $schemaReader->loadSchemaFromFile($file);
// remove tables we don't know about // remove tables we don't know about
foreach($fromSchema->getTables() as $table) { foreach($fromSchema->getTables() as $table) {
@ -79,6 +83,7 @@ class OC_DB_Schema {
/** /**
* @brief drop a table * @brief drop a table
* @param \Doctrine\DBAL\Connection $conn
* @param string $tableName the table to drop * @param string $tableName the table to drop
*/ */
public static function dropTable($conn, $tableName) { public static function dropTable($conn, $tableName) {
@ -92,10 +97,12 @@ class OC_DB_Schema {
/** /**
* remove all tables defined in a database structure xml file * remove all tables defined in a database structure xml file
* @param \Doctrine\DBAL\Connection $conn
* @param string $file the xml file describing the tables * @param string $file the xml file describing the tables
*/ */
public static function removeDBStructure($conn, $file) { public static function removeDBStructure($conn, $file) {
$fromSchema = OC_DB_MDB2SchemaReader::loadSchemaFromFile($file, $conn->getDatabasePlatform()); $schemaReader = new \OC\DB\MDB2SchemaReader(\OC_Config::getObject(), $conn->getDatabasePlatform());
$fromSchema = $schemaReader->loadSchemaFromFile($file);
$toSchema = clone $fromSchema; $toSchema = clone $fromSchema;
foreach($toSchema->getTables() as $table) { foreach($toSchema->getTables() as $table) {
$toSchema->dropTable($table->getName()); $toSchema->dropTable($table->getName());
@ -107,6 +114,7 @@ class OC_DB_Schema {
/** /**
* @brief replaces the ownCloud tables with a new set * @brief replaces the ownCloud tables with a new set
* @param \Doctrine\DBAL\Connection $conn
* @param $file string path to the MDB2 xml db export file * @param $file string path to the MDB2 xml db export file
*/ */
public static function replaceDB( $conn, $file ) { public static function replaceDB( $conn, $file ) {
@ -126,11 +134,17 @@ class OC_DB_Schema {
self::commit(); self::commit();
} }
/**
* @param \Doctrine\DBAL\Connection $conn
* @param \Doctrine\DBAL\Schema\Schema $schema
* @return bool
*/
private static function executeSchemaChange($conn, $schema) { private static function executeSchemaChange($conn, $schema) {
$conn->beginTransaction(); $conn->beginTransaction();
foreach($schema->toSql($conn->getDatabasePlatform()) as $sql) { foreach($schema->toSql($conn->getDatabasePlatform()) as $sql) {
$conn->query($sql); $conn->query($sql);
} }
$conn->commit(); $conn->commit();
return true;
} }
} }