* @copyright Copyright (c) 2017, ownCloud GmbH * * @author Christoph Wurst * @author Joas Schilling * @author Roeland Jago Douma * * @license AGPL-3.0 * * This code is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License, version 3, * as published by the Free Software Foundation. * * 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, version 3, * along with this program. If not, see * */ namespace OC\Core\Command\Db\Migrations; use OC\DB\Connection; use OC\DB\MigrationService; use OC\Migration\ConsoleOutput; use OCP\App\IAppManager; use Stecman\Component\Symfony\Console\BashCompletion\Completion\CompletionAwareInterface; use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Exception\RuntimeException; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; class GenerateCommand extends Command implements CompletionAwareInterface { protected static $_templateSimple = 'connection = $connection; $this->appManager = $appManager; parent::__construct(); } protected function configure() { $this ->setName('migrations:generate') ->addArgument('app', InputArgument::REQUIRED, 'Name of the app this migration command shall work on') ->addArgument('version', InputArgument::REQUIRED, 'Major version of this app, to allow versions on parallel development branches') ; parent::configure(); } public function execute(InputInterface $input, OutputInterface $output): int { $appName = $input->getArgument('app'); $version = $input->getArgument('version'); if (!preg_match('/^\d{1,16}$/', $version)) { $output->writeln('The given version is invalid. Only 0-9 are allowed (max. 16 digits)'); return 1; } $ms = new MigrationService($appName, $this->connection, new ConsoleOutput($output)); $date = date('YmdHis'); $path = $this->generateMigration($ms, 'Version' . $version . 'Date' . $date); $output->writeln("New migration class has been generated to $path"); return 0; } /** * @param string $optionName * @param CompletionContext $context * @return string[] */ public function completeOptionValues($optionName, CompletionContext $context) { return []; } /** * @param string $argumentName * @param CompletionContext $context * @return string[] */ public function completeArgumentValues($argumentName, CompletionContext $context) { if ($argumentName === 'app') { $allApps = \OC_App::getAllApps(); return array_diff($allApps, \OC_App::getEnabledApps(true, true)); } if ($argumentName === 'version') { $appName = $context->getWordAtIndex($context->getWordIndex() - 1); $version = explode('.', $this->appManager->getAppVersion($appName)); return [$version[0] . sprintf('%1$03d', $version[1])]; } return []; } /** * @param MigrationService $ms * @param string $className * @param string $schemaBody * @return string */ protected function generateMigration(MigrationService $ms, $className, $schemaBody = '') { if ($schemaBody === '') { $schemaBody = "\t\t" . 'return null;'; } $placeHolders = [ '{{namespace}}', '{{classname}}', '{{schemabody}}', ]; $replacements = [ $ms->getMigrationsNamespace(), $className, $schemaBody, ]; $code = str_replace($placeHolders, $replacements, self::$_templateSimple); $dir = $ms->getMigrationsDirectory(); $this->ensureMigrationDirExists($dir); $path = $dir . '/' . $className . '.php'; if (file_put_contents($path, $code) === false) { throw new RuntimeException('Failed to generate new migration step.'); } return $path; } protected function ensureMigrationDirExists($directory) { if (file_exists($directory) && is_dir($directory)) { return; } if (file_exists($directory)) { throw new \RuntimeException("Could not create folder \"$directory\""); } $this->ensureMigrationDirExists(dirname($directory)); if (!@mkdir($directory) && !is_dir($directory)) { throw new \RuntimeException("Could not create folder \"$directory\""); } } }