|
- <?php
-
-
- namespace yii\console\controllers;
-
- use Yii;
- use yii\base\InvalidConfigException;
- use yii\console\Exception;
- use yii\console\Controller;
- use yii\helpers\Console;
- use yii\helpers\FileHelper;
-
-
- abstract class BaseMigrateController extends Controller
- {
-
-
- const BASE_MIGRATION = 'm000000_000000_base';
-
-
-
- public $defaultAction = 'up';
-
-
- public $migrationPath = '@app/migrations';
-
-
- public $migrationNamespaces = [];
-
-
- public $templateFile;
-
-
-
-
- public function options($actionID)
- {
- return array_merge(
- parent::options($actionID),
- ['migrationPath'],
- $actionID === 'create' ? ['templateFile'] : []
- );
- }
-
-
-
- public function beforeAction($action)
- {
- if (parent::beforeAction($action)) {
- if (empty($this->migrationNamespaces) && empty($this->migrationPath)) {
- throw new InvalidConfigException('At least one of `migrationPath` or `migrationNamespaces` should be specified.');
- }
-
- foreach ($this->migrationNamespaces as $key => $value) {
- $this->migrationNamespaces[$key] = trim($value, '\\');
- }
-
- if ($this->migrationPath !== null) {
- $path = Yii::getAlias($this->migrationPath);
- if (!is_dir($path)) {
- if ($action->id !== 'create') {
- throw new InvalidConfigException("Migration failed. Directory specified in migrationPath doesn't exist: {$this->migrationPath}");
- }
- FileHelper::createDirectory($path);
- }
- $this->migrationPath = $path;
- }
-
- $version = Yii::getVersion();
- $this->stdout("Yii Migration Tool (based on Yii v{$version})\n\n");
-
- return true;
- } else {
- return false;
- }
- }
-
-
-
- public function actionUp($limit = 0)
- {
- $migrations = $this->getNewMigrations();
- if (empty($migrations)) {
- $this->stdout("No new migrations found. Your system is up-to-date.\n", Console::FG_GREEN);
-
- return self::EXIT_CODE_NORMAL;
- }
-
- $total = count($migrations);
- $limit = (int) $limit;
- if ($limit > 0) {
- $migrations = array_slice($migrations, 0, $limit);
- }
-
- $n = count($migrations);
- if ($n === $total) {
- $this->stdout("Total $n new " . ($n === 1 ? 'migration' : 'migrations') . " to be applied:\n", Console::FG_YELLOW);
- } else {
- $this->stdout("Total $n out of $total new " . ($total === 1 ? 'migration' : 'migrations') . " to be applied:\n", Console::FG_YELLOW);
- }
-
- foreach ($migrations as $migration) {
- $this->stdout("\t$migration\n");
- }
- $this->stdout("\n");
-
- $applied = 0;
- if ($this->confirm('Apply the above ' . ($n === 1 ? 'migration' : 'migrations') . '?')) {
- foreach ($migrations as $migration) {
- if (!$this->migrateUp($migration)) {
- $this->stdout("\n$applied from $n " . ($applied === 1 ? 'migration was' : 'migrations were') ." applied.\n", Console::FG_RED);
- $this->stdout("\nMigration failed. The rest of the migrations are canceled.\n", Console::FG_RED);
-
- return self::EXIT_CODE_ERROR;
- }
- $applied++;
- }
-
- $this->stdout("\n$n " . ($n === 1 ? 'migration was' : 'migrations were') ." applied.\n", Console::FG_GREEN);
- $this->stdout("\nMigrated up successfully.\n", Console::FG_GREEN);
- }
- }
-
-
-
- public function actionDown($limit = 1)
- {
- if ($limit === 'all') {
- $limit = null;
- } else {
- $limit = (int) $limit;
- if ($limit < 1) {
- throw new Exception('The step argument must be greater than 0.');
- }
- }
-
- $migrations = $this->getMigrationHistory($limit);
-
- if (empty($migrations)) {
- $this->stdout("No migration has been done before.\n", Console::FG_YELLOW);
-
- return self::EXIT_CODE_NORMAL;
- }
-
- $migrations = array_keys($migrations);
-
- $n = count($migrations);
- $this->stdout("Total $n " . ($n === 1 ? 'migration' : 'migrations') . " to be reverted:\n", Console::FG_YELLOW);
- foreach ($migrations as $migration) {
- $this->stdout("\t$migration\n");
- }
- $this->stdout("\n");
-
- $reverted = 0;
- if ($this->confirm('Revert the above ' . ($n === 1 ? 'migration' : 'migrations') . '?')) {
- foreach ($migrations as $migration) {
- if (!$this->migrateDown($migration)) {
- $this->stdout("\n$reverted from $n " . ($reverted === 1 ? 'migration was' : 'migrations were') ." reverted.\n", Console::FG_RED);
- $this->stdout("\nMigration failed. The rest of the migrations are canceled.\n", Console::FG_RED);
-
- return self::EXIT_CODE_ERROR;
- }
- $reverted++;
- }
- $this->stdout("\n$n " . ($n === 1 ? 'migration was' : 'migrations were') ." reverted.\n", Console::FG_GREEN);
- $this->stdout("\nMigrated down successfully.\n", Console::FG_GREEN);
- }
- }
-
-
-
- public function actionRedo($limit = 1)
- {
- if ($limit === 'all') {
- $limit = null;
- } else {
- $limit = (int) $limit;
- if ($limit < 1) {
- throw new Exception('The step argument must be greater than 0.');
- }
- }
-
- $migrations = $this->getMigrationHistory($limit);
-
- if (empty($migrations)) {
- $this->stdout("No migration has been done before.\n", Console::FG_YELLOW);
-
- return self::EXIT_CODE_NORMAL;
- }
-
- $migrations = array_keys($migrations);
-
- $n = count($migrations);
- $this->stdout("Total $n " . ($n === 1 ? 'migration' : 'migrations') . " to be redone:\n", Console::FG_YELLOW);
- foreach ($migrations as $migration) {
- $this->stdout("\t$migration\n");
- }
- $this->stdout("\n");
-
- if ($this->confirm('Redo the above ' . ($n === 1 ? 'migration' : 'migrations') . '?')) {
- foreach ($migrations as $migration) {
- if (!$this->migrateDown($migration)) {
- $this->stdout("\nMigration failed. The rest of the migrations are canceled.\n", Console::FG_RED);
-
- return self::EXIT_CODE_ERROR;
- }
- }
- foreach (array_reverse($migrations) as $migration) {
- if (!$this->migrateUp($migration)) {
- $this->stdout("\nMigration failed. The rest of the migrations are canceled.\n", Console::FG_RED);
-
- return self::EXIT_CODE_ERROR;
- }
- }
- $this->stdout("\n$n " . ($n === 1 ? 'migration was' : 'migrations were') ." redone.\n", Console::FG_GREEN);
- $this->stdout("\nMigration redone successfully.\n", Console::FG_GREEN);
- }
- }
-
-
-
- public function actionTo($version)
- {
- if (($namespaceVersion = $this->extractNamespaceMigrationVersion($version)) !== false) {
- $this->migrateToVersion($namespaceVersion);
- } elseif (($migrationName = $this->extractMigrationVersion($version)) !== false) {
- $this->migrateToVersion($migrationName);
- } elseif ((string) (int) $version == $version) {
- $this->migrateToTime($version);
- } elseif (($time = strtotime($version)) !== false) {
- $this->migrateToTime($time);
- } else {
- throw new Exception("The version argument must be either a timestamp (e.g. 101129_185401),\n the full name of a migration (e.g. m101129_185401_create_user_table),\n the full namespaced name of a migration (e.g. app\\migrations\\M101129185401CreateUserTable),\n a UNIX timestamp (e.g. 1392853000), or a datetime string parseable\nby the strtotime() function (e.g. 2014-02-15 13:00:50).");
- }
- }
-
-
-
- public function actionMark($version)
- {
- $originalVersion = $version;
- if (($namespaceVersion = $this->extractNamespaceMigrationVersion($version)) !== false) {
- $version = $namespaceVersion;
- } elseif (($migrationName = $this->extractMigrationVersion($version)) !== false) {
- $version = $migrationName;
- } else {
- throw new Exception("The version argument must be either a timestamp (e.g. 101129_185401)\nor the full name of a migration (e.g. m101129_185401_create_user_table)\nor the full name of a namespaced migration (e.g. app\\migrations\\M101129185401CreateUserTable).");
- }
-
-
- $migrations = $this->getNewMigrations();
- foreach ($migrations as $i => $migration) {
- if (strpos($migration, $version) === 0) {
- if ($this->confirm("Set migration history at $originalVersion?")) {
- for ($j = 0; $j <= $i; ++$j) {
- $this->addMigrationHistory($migrations[$j]);
- }
- $this->stdout("The migration history is set at $originalVersion.\nNo actual migration was performed.\n", Console::FG_GREEN);
- }
-
- return self::EXIT_CODE_NORMAL;
- }
- }
-
-
- $migrations = array_keys($this->getMigrationHistory(null));
- foreach ($migrations as $i => $migration) {
- if (strpos($migration, $version) === 0) {
- if ($i === 0) {
- $this->stdout("Already at '$originalVersion'. Nothing needs to be done.\n", Console::FG_YELLOW);
- } else {
- if ($this->confirm("Set migration history at $originalVersion?")) {
- for ($j = 0; $j < $i; ++$j) {
- $this->removeMigrationHistory($migrations[$j]);
- }
- $this->stdout("The migration history is set at $originalVersion.\nNo actual migration was performed.\n", Console::FG_GREEN);
- }
- }
-
- return self::EXIT_CODE_NORMAL;
- }
- }
-
- throw new Exception("Unable to find the version '$originalVersion'.");
- }
-
-
-
- private function extractNamespaceMigrationVersion($rawVersion)
- {
- if (preg_match('/^\\\\?([\w_]+\\\\)+m(\d{6}_?\d{6})(\D.*)?$/is', $rawVersion, $matches)) {
- return trim($rawVersion, '\\');
- }
- return false;
- }
-
-
-
- private function extractMigrationVersion($rawVersion)
- {
- if (preg_match('/^m?(\d{6}_?\d{6})(\D.*)?$/is', $rawVersion, $matches)) {
- return 'm' . $matches[1];
- }
- return false;
- }
-
-
-
- public function actionHistory($limit = 10)
- {
- if ($limit === 'all') {
- $limit = null;
- } else {
- $limit = (int) $limit;
- if ($limit < 1) {
- throw new Exception('The limit must be greater than 0.');
- }
- }
-
- $migrations = $this->getMigrationHistory($limit);
-
- if (empty($migrations)) {
- $this->stdout("No migration has been done before.\n", Console::FG_YELLOW);
- } else {
- $n = count($migrations);
- if ($limit > 0) {
- $this->stdout("Showing the last $n applied " . ($n === 1 ? 'migration' : 'migrations') . ":\n", Console::FG_YELLOW);
- } else {
- $this->stdout("Total $n " . ($n === 1 ? 'migration has' : 'migrations have') . " been applied before:\n", Console::FG_YELLOW);
- }
- foreach ($migrations as $version => $time) {
- $this->stdout("\t(" . date('Y-m-d H:i:s', $time) . ') ' . $version . "\n");
- }
- }
- }
-
-
-
- public function actionNew($limit = 10)
- {
- if ($limit === 'all') {
- $limit = null;
- } else {
- $limit = (int) $limit;
- if ($limit < 1) {
- throw new Exception('The limit must be greater than 0.');
- }
- }
-
- $migrations = $this->getNewMigrations();
-
- if (empty($migrations)) {
- $this->stdout("No new migrations found. Your system is up-to-date.\n", Console::FG_GREEN);
- } else {
- $n = count($migrations);
- if ($limit && $n > $limit) {
- $migrations = array_slice($migrations, 0, $limit);
- $this->stdout("Showing $limit out of $n new " . ($n === 1 ? 'migration' : 'migrations') . ":\n", Console::FG_YELLOW);
- } else {
- $this->stdout("Found $n new " . ($n === 1 ? 'migration' : 'migrations') . ":\n", Console::FG_YELLOW);
- }
-
- foreach ($migrations as $migration) {
- $this->stdout("\t" . $migration . "\n");
- }
- }
- }
-
-
-
- public function actionCreate($name)
- {
- if (!preg_match('/^[\w\\\\]+$/', $name)) {
- throw new Exception('The migration name should contain letters, digits, underscore and/or backslash characters only.');
- }
-
- list($namespace, $className) = $this->generateClassName($name);
- $migrationPath = $this->findMigrationPath($namespace);
-
- $file = $migrationPath . DIRECTORY_SEPARATOR . $className . '.php';
- if ($this->confirm("Create new migration '$file'?")) {
- $content = $this->generateMigrationSourceCode([
- 'name' => $name,
- 'className' => $className,
- 'namespace' => $namespace,
- ]);
- FileHelper::createDirectory($migrationPath);
- file_put_contents($file, $content);
- $this->stdout("New migration created successfully.\n", Console::FG_GREEN);
- }
- }
-
-
-
- private function generateClassName($name)
- {
- $namespace = null;
- $name = trim($name, '\\');
- if (strpos($name, '\\') !== false) {
- $namespace = substr($name, 0, strrpos($name, '\\'));
- $name = substr($name, strrpos($name, '\\') + 1);
- } else {
- if ($this->migrationPath === null) {
- $migrationNamespaces = $this->migrationNamespaces;
- $namespace = array_shift($migrationNamespaces);
- }
- }
-
- if ($namespace === null) {
- $class = 'm' . gmdate('ymd_His') . '_' . $name;
- } else {
- $class = 'M' . gmdate('ymdHis') . ucfirst($name);
- }
-
- return [$namespace, $class];
- }
-
-
-
- private function findMigrationPath($namespace)
- {
- if (empty($namespace)) {
- return $this->migrationPath;
- }
-
- if (!in_array($namespace, $this->migrationNamespaces, true)) {
- throw new Exception("Namespace '{$namespace}' not found in `migrationNamespaces`");
- }
-
- return $this->getNamespacePath($namespace);
- }
-
-
-
- private function getNamespacePath($namespace)
- {
- return str_replace('/', DIRECTORY_SEPARATOR, Yii::getAlias('@' . str_replace('\\', '/', $namespace)));
- }
-
-
-
- protected function migrateUp($class)
- {
- if ($class === self::BASE_MIGRATION) {
- return true;
- }
-
- $this->stdout("*** applying $class\n", Console::FG_YELLOW);
- $start = microtime(true);
- $migration = $this->createMigration($class);
- if ($migration->up() !== false) {
- $this->addMigrationHistory($class);
- $time = microtime(true) - $start;
- $this->stdout("*** applied $class (time: " . sprintf('%.3f', $time) . "s)\n\n", Console::FG_GREEN);
-
- return true;
- } else {
- $time = microtime(true) - $start;
- $this->stdout("*** failed to apply $class (time: " . sprintf('%.3f', $time) . "s)\n\n", Console::FG_RED);
-
- return false;
- }
- }
-
-
-
- protected function migrateDown($class)
- {
- if ($class === self::BASE_MIGRATION) {
- return true;
- }
-
- $this->stdout("*** reverting $class\n", Console::FG_YELLOW);
- $start = microtime(true);
- $migration = $this->createMigration($class);
- if ($migration->down() !== false) {
- $this->removeMigrationHistory($class);
- $time = microtime(true) - $start;
- $this->stdout("*** reverted $class (time: " . sprintf('%.3f', $time) . "s)\n\n", Console::FG_GREEN);
-
- return true;
- } else {
- $time = microtime(true) - $start;
- $this->stdout("*** failed to revert $class (time: " . sprintf('%.3f', $time) . "s)\n\n", Console::FG_RED);
-
- return false;
- }
- }
-
-
-
- protected function createMigration($class)
- {
- $class = trim($class, '\\');
- if (strpos($class, '\\') === false) {
- $file = $this->migrationPath . DIRECTORY_SEPARATOR . $class . '.php';
- require_once($file);
- }
-
- return new $class();
- }
-
-
-
- protected function migrateToTime($time)
- {
- $count = 0;
- $migrations = array_values($this->getMigrationHistory(null));
- while ($count < count($migrations) && $migrations[$count] > $time) {
- ++$count;
- }
- if ($count === 0) {
- $this->stdout("Nothing needs to be done.\n", Console::FG_GREEN);
- } else {
- $this->actionDown($count);
- }
- }
-
-
-
- protected function migrateToVersion($version)
- {
- $originalVersion = $version;
-
-
- $migrations = $this->getNewMigrations();
- foreach ($migrations as $i => $migration) {
- if (strpos($migration, $version) === 0) {
- $this->actionUp($i + 1);
-
- return self::EXIT_CODE_NORMAL;
- }
- }
-
-
- $migrations = array_keys($this->getMigrationHistory(null));
- foreach ($migrations as $i => $migration) {
- if (strpos($migration, $version) === 0) {
- if ($i === 0) {
- $this->stdout("Already at '$originalVersion'. Nothing needs to be done.\n", Console::FG_YELLOW);
- } else {
- $this->actionDown($i);
- }
-
- return self::EXIT_CODE_NORMAL;
- }
- }
-
- throw new Exception("Unable to find the version '$originalVersion'.");
- }
-
-
-
- protected function getNewMigrations()
- {
- $applied = [];
- foreach ($this->getMigrationHistory(null) as $class => $time) {
- $applied[trim($class, '\\')] = true;
- }
-
- $migrationPaths = [];
- if (!empty($this->migrationPath)) {
- $migrationPaths[''] = $this->migrationPath;
- }
- foreach ($this->migrationNamespaces as $namespace) {
- $migrationPaths[$namespace] = $this->getNamespacePath($namespace);
- }
-
- $migrations = [];
- foreach ($migrationPaths as $namespace => $migrationPath) {
- if (!file_exists($migrationPath)) {
- continue;
- }
- $handle = opendir($migrationPath);
- while (($file = readdir($handle)) !== false) {
- if ($file === '.' || $file === '..') {
- continue;
- }
- $path = $migrationPath . DIRECTORY_SEPARATOR . $file;
- if (preg_match('/^(m(\d{6}_?\d{6})\D.*?)\.php$/is', $file, $matches) && is_file($path)) {
- $class = $matches[1];
- if (!empty($namespace)) {
- $class = $namespace . '\\' . $class;
- }
- $time = str_replace('_', '', $matches[2]);
- if (!isset($applied[$class])) {
- $migrations[$time . '\\' . $class] = $class;
- }
- }
- }
- closedir($handle);
- }
- ksort($migrations);
-
- return array_values($migrations);
- }
-
-
-
- protected function generateMigrationSourceCode($params)
- {
- return $this->renderFile(Yii::getAlias($this->templateFile), $params);
- }
-
-
-
- abstract protected function getMigrationHistory($limit);
-
-
-
- abstract protected function addMigrationHistory($version);
-
-
-
- abstract protected function removeMigrationHistory($version);
- }
|