Add a script to generate a migration from database.xml

Signed-off-by: Joas Schilling <coding@schilljs.com>
This commit is contained in:
Joas Schilling 2017-07-18 13:37:01 +02:00
parent 8d751ff2b4
commit f6c48b1548
No known key found for this signature in database
GPG Key ID: E166FD8976B3BAC8
3 changed files with 215 additions and 5 deletions

View File

@ -36,7 +36,7 @@ use Symfony\Component\Console\Output\OutputInterface;
class GenerateCommand extends Command { class GenerateCommand extends Command {
private static $_templateSimple = protected static $_templateSimple =
'<?php '<?php
namespace <namespace>; namespace <namespace>;
@ -66,7 +66,7 @@ class <classname> extends SimpleMigrationStep {
* @since 13.0.0 * @since 13.0.0
*/ */
public function changeSchema(IOutput $output, \Closure $schemaClosure, array $options) { public function changeSchema(IOutput $output, \Closure $schemaClosure, array $options) {
return null; <schemabody>
} }
/** /**
@ -81,7 +81,7 @@ class <classname> extends SimpleMigrationStep {
'; ';
/** @var IDBConnection */ /** @var IDBConnection */
private $connection; protected $connection;
/** /**
* @param IDBConnection $connection * @param IDBConnection $connection
@ -123,16 +123,24 @@ class <classname> extends SimpleMigrationStep {
/** /**
* @param MigrationService $ms * @param MigrationService $ms
* @param string $className * @param string $className
* @param string $schemaBody
* @return string * @return string
*/ */
private function generateMigration(MigrationService $ms, $className) { protected function generateMigration(MigrationService $ms, $className, $schemaBody = '') {
if ($schemaBody === '') {
$schemaBody = "\t\t" . 'return null;';
}
$placeHolders = [ $placeHolders = [
'<namespace>', '<namespace>',
'<classname>', '<classname>',
'<schemabody>',
]; ];
$replacements = [ $replacements = [
$ms->getMigrationsNamespace(), $ms->getMigrationsNamespace(),
$className, $className,
$schemaBody,
]; ];
$code = str_replace($placeHolders, $replacements, self::$_templateSimple); $code = str_replace($placeHolders, $replacements, self::$_templateSimple);
$dir = $ms->getMigrationsDirectory(); $dir = $ms->getMigrationsDirectory();
@ -147,7 +155,7 @@ class <classname> extends SimpleMigrationStep {
return $path; return $path;
} }
private function ensureMigrationDirExists($directory) { protected function ensureMigrationDirExists($directory) {
if (file_exists($directory) && is_dir($directory)) { if (file_exists($directory) && is_dir($directory)) {
return; return;
} }

View File

@ -0,0 +1,201 @@
<?php
/**
* @copyright Copyright (c) 2017 Joas Schilling <coding@schilljs.com>
*
* @author Joas Schilling <coding@schilljs.com>
* @author Julius Haertl <jus@bitgrid.net>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OC\Core\Command\Db\Migrations;
use Doctrine\DBAL\Schema\Schema;
use OC\DB\MDB2SchemaReader;
use OC\DB\MigrationService;
use OC\Migration\ConsoleOutput;
use OCP\App\IAppManager;
use OCP\IConfig;
use OCP\IDBConnection;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
class GenerateFromSchemaFileCommand extends GenerateCommand {
/** @var IConfig */
protected $config;
/** @var IAppManager */
protected $appManager;
public function __construct(IConfig $config, IAppManager $appManager, IDBConnection $connection) {
parent::__construct($connection);
$this->config = $config;
$this->appManager = $appManager;
}
protected function configure() {
parent::configure();
$this->setName('migrations:generate-from-schema');
}
public function execute(InputInterface $input, OutputInterface $output) {
$appName = $input->getArgument('app');
$version = $input->getArgument('version');
if (!preg_match('/^\d{1,16}$/',$version)) {
$output->writeln('<error>The given version is invalid. Only 0-9 are allowed (max. 16 digits)</error>');
return 1;
}
$reader = new MDB2SchemaReader($this->config, $this->connection->getDatabasePlatform());
$schema = new Schema();
if ($appName === 'core') {
$reader->loadSchemaFromFile(\OC::$SERVERROOT . '/db_structure.xml', $schema);
} else {
if (!file_exists($this->appManager->getAppPath($appName) . '/appinfo/database.xml')) {
throw new \RuntimeException('App ' . $appName . ' does not have a database.xml file');
}
$reader->loadSchemaFromFile($this->appManager->getAppPath($appName) . '/appinfo/database.xml', $schema);
}
$schemaBody = $this->schemaToMigration($schema);
$ms = new MigrationService($appName, $this->connection, new ConsoleOutput($output));
$date = date('YmdHis');
$path = $this->generateMigration($ms, 'Version' . $version . 'Date' . $date, $schemaBody);
$output->writeln("New migration class has been generated to <info>$path</info>");
return 0;
}
/**
* @param Schema $schema
* @return string
*/
protected function schemaToMigration(Schema $schema) {
$content = <<<'EOT'
/** @var Schema $schema */
$schema = $schemaClosure();
EOT;
foreach ($schema->getTables() as $table) {
$content .= str_replace('{{table-name}}', substr($table->getName(), 3), <<<'EOT'
if (!$schema->hasTable('{{table-name}}')) {
$table = $schema->createTable('{{table-name}}');
EOT
);
foreach ($table->getColumns() as $column) {
$content .= str_replace(['{{name}}', '{{type}}'], [$column->getName(), $column->getType()->getName()], <<<'EOT'
$table->addColumn('{{name}}', '{{type}}', [
EOT
);
if ($column->getAutoincrement()) {
$content .= <<<'EOT'
'autoincrement' => true,
EOT;
}
$content .= str_replace('{{notnull}}', $column->getNotnull() ? 'true' : 'false', <<<'EOT'
'notnull' => {{notnull}},
EOT
);
if ($column->getLength() !== null) {
$content .= str_replace('{{length}}', $column->getLength(), <<<'EOT'
'length' => {{length}},
EOT
);
}
$default = $column->getDefault();
if ($default !== null) {
$default = is_numeric($default) ? $default : "'$default'";
$content .= str_replace('{{default}}', $default, <<<'EOT'
'default' => {{default}},
EOT
);
}
$content .= <<<'EOT'
]);
EOT;
}
$content .= <<<'EOT'
EOT;
$primaryKey = $table->getPrimaryKey();
if ($primaryKey !== null) {
$content .= str_replace('{{columns}}', implode('\', \'', $primaryKey->getUnquotedColumns()), <<<'EOT'
$table->setPrimaryKey(['{{columns}}']);
EOT
);
}
foreach ($table->getIndexes() as $index) {
if ($index->isPrimary()) {
continue;
}
if ($index->isUnique()) {
$content .= str_replace(
['{{columns}}', '{{name}}'],
[implode('\', \'', $index->getUnquotedColumns()), $index->getName()],
<<<'EOT'
$table->addUniqueIndex(['{{columns}}'], '{{name}}');
EOT
);
} else {
$content .= str_replace(
['{{columns}}', '{{name}}'],
[implode('\', \'', $index->getUnquotedColumns()), $index->getName()],
<<<'EOT'
$table->addIndex(['{{columns}}'], '{{name}}');
EOT
);
}
}
$content .= <<<'EOT'
}
EOT;
}
$content .= <<<'EOT'
return $schema;
EOT;
return $content;
}
}

View File

@ -88,6 +88,7 @@ if (\OC::$server->getConfig()->getSystemValue('installed', false)) {
$application->add(new OC\Core\Command\Db\Migrations\StatusCommand(\OC::$server->getDatabaseConnection())); $application->add(new OC\Core\Command\Db\Migrations\StatusCommand(\OC::$server->getDatabaseConnection()));
$application->add(new OC\Core\Command\Db\Migrations\MigrateCommand(\OC::$server->getDatabaseConnection())); $application->add(new OC\Core\Command\Db\Migrations\MigrateCommand(\OC::$server->getDatabaseConnection()));
$application->add(new OC\Core\Command\Db\Migrations\GenerateCommand(\OC::$server->getDatabaseConnection())); $application->add(new OC\Core\Command\Db\Migrations\GenerateCommand(\OC::$server->getDatabaseConnection()));
$application->add(new OC\Core\Command\Db\Migrations\GenerateFromSchemaFileCommand(\OC::$server->getConfig(), \OC::$server->getAppManager(), \OC::$server->getDatabaseConnection()));
$application->add(new OC\Core\Command\Db\Migrations\ExecuteCommand(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig())); $application->add(new OC\Core\Command\Db\Migrations\ExecuteCommand(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()));
$application->add(new OC\Core\Command\Encryption\Disable(\OC::$server->getConfig())); $application->add(new OC\Core\Command\Encryption\Disable(\OC::$server->getConfig()));