Mercurial > hg > isophonics-drupal-site
diff modules/contrib/migrate_upgrade/src/MigrateUpgradeDrushRunner.php @ 0:4c8ae668cc8c
Initial import (non-working)
author | Chris Cannam |
---|---|
date | Wed, 29 Nov 2017 16:09:58 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/contrib/migrate_upgrade/src/MigrateUpgradeDrushRunner.php Wed Nov 29 16:09:58 2017 +0000 @@ -0,0 +1,218 @@ +<?php + +/** + * @file + * Contains \Drupal\migrate_upgrade\MigrateUpgradeDrushRunner. + */ + +namespace Drupal\migrate_upgrade; + +use Drupal\migrate\Plugin\MigrationInterface; +use Drupal\migrate\Event\MigrateEvents; +use Drupal\migrate\Event\MigrateIdMapMessageEvent; +use Drupal\migrate\MigrateExecutable; +use Drupal\Core\StringTranslation\StringTranslationTrait; +use Drupal\migrate_drupal\MigrationCreationTrait; +use Drupal\migrate_plus\Entity\Migration; +use Drupal\migrate_plus\Entity\MigrationGroup; + +class MigrateUpgradeDrushRunner { + + use MigrationCreationTrait; + use StringTranslationTrait; + + /** + * The list of migrations to run and their configuration. + * + * @var \Drupal\migrate\Plugin\Migration[] + */ + protected $migrationList; + + /** + * MigrateMessage instance to display messages during the migration process. + * + * @var \Drupal\migrate_upgrade\DrushLogMigrateMessage + */ + protected static $messages; + + /** + * The Drupal version being imported. + * + * @var string + */ + protected $version; + + /** + * The state key used to store database configuration. + * + * @var string + */ + protected $databaseStateKey; + + /** + * From the provided source information, instantiate the appropriate migrations + * in the active configuration. + * + * @throws \Exception + */ + public function configure() { + $db_url = drush_get_option('legacy-db-url'); + $db_spec = drush_convert_db_from_db_url($db_url); + $db_prefix = drush_get_option('legacy-db-prefix'); + $db_spec['prefix'] = $db_prefix; + + $connection = $this->getConnection($db_spec); + $this->version = $this->getLegacyDrupalVersion($connection); + $this->createDatabaseStateSettings($db_spec, $this->version); + $this->databaseStateKey = 'migrate_drupal_' . $this->version; + $migrations = $this->getMigrations($this->databaseStateKey, $this->version); + $this->migrationList = []; + foreach ($migrations as $migration) { + $destination = $migration->get('destination'); + if ($destination['plugin'] === 'entity:file') { + // Make sure we have a single trailing slash. + $source_base_path = rtrim(drush_get_option('legacy-root'), '/') . '/'; + $destination['source_base_path'] = $source_base_path; + $migration->set('destination', $destination); + } + $this->migrationList[$migration->id()] = $migration; + } + } + + /** + * Run the configured migrations. + */ + public function import() { + static::$messages = new DrushLogMigrateMessage(); + if (drush_get_option('debug')) { + \Drupal::service('event_dispatcher')->addListener(MigrateEvents::IDMAP_MESSAGE, + [get_class(), 'onIdMapMessage']); + } + foreach ($this->migrationList as $migration_id => $migration) { + drush_print(dt('Upgrading @migration', ['@migration' => $migration_id])); + $executable = new MigrateExecutable($migration, static::$messages); + // drush_op() provides --simulate support. + drush_op([$executable, 'import']); + } + } + + /** + * Export the configured migration plugins as configuration entities. + */ + public function export() { + $db_info = \Drupal::state()->get($this->databaseStateKey); + + // Create a group to hold the database configuration. + $group = [ + 'id' => $this->databaseStateKey, + 'label' => 'Import from Drupal ' . $this->version, + 'description' => 'Migrations originally generated from drush migrate-upgrade --configure-only', + 'source_type' => 'Drupal ' . $this->version, + 'shared_configuration' => [ + 'source' => [ + 'key' => 'drupal_' . $this->version, + 'database' => $db_info['database'], + ] + ] + ]; + $group = MigrationGroup::create($group); + $group->save(); + foreach ($this->migrationList as $migration_id => $migration) { + drush_print(dt('Exporting @migration as @new_migration', + ['@migration' => $migration_id, '@new_migration' => $this->modifyId($migration_id)])); + $entity_array['id'] = $migration_id; + $entity_array['migration_group'] = $this->databaseStateKey; + $entity_array['migration_tags'] = $migration->get('migration_tags'); + $entity_array['label'] = $migration->get('label'); + $entity_array['source'] = $migration->getSourceConfiguration(); + $entity_array['destination'] = $migration->getDestinationConfiguration(); + $entity_array['process'] = $migration->get('process'); + $entity_array['migration_dependencies'] = $migration->getMigrationDependencies(); + $migration_entity = Migration::create($this->substituteIds($entity_array)); + $migration_entity->save(); + } + } + + /** + * Rewrite any migration plugin IDs so they won't conflict with the core + * IDs. + * + * @param $entity_array + * A configuration array for a migration. + * + * @return array + * The migration configuration array modified with new IDs. + */ + protected function substituteIds($entity_array) { + $entity_array['id'] = $this->modifyId($entity_array['id']); + foreach ($entity_array['migration_dependencies'] as $type => $dependencies) { + foreach ($dependencies as $key => $dependency) { + $entity_array['migration_dependencies'][$type][$key] = $this->modifyId($dependency); + } + } + foreach ($entity_array['process'] as $destination => $process) { + if (is_array($process)) { + if ($process['plugin'] == 'migration') { + $entity_array['process'][$destination]['migration'] = + $this->modifyId($process['migration']); + } + } + } + return $entity_array; + } + + /** + * @param $id + * The original core plugin ID. + * + * @return string + * The ID modified to serve as a configuration entity ID. + */ + protected function modifyId($id) { + return drush_get_option('migration-prefix', 'upgrade_') . str_replace(':', '_', $id); + } + + /** + * Rolls back the configured migrations. + */ + public function rollback() { + static::$messages = new DrushLogMigrateMessage(); + $database_state_key = \Drupal::state()->get('migrate.fallback_state_key'); + $database_state = \Drupal::state()->get($database_state_key); + $db_spec = $database_state['database']; + $connection = $this->getConnection($db_spec); + $version = $this->getLegacyDrupalVersion($connection); + $migrations = $this->getMigrations('migrate_drupal_' . $version, $version); + + // Roll back in reverse order. + $this->migrationList = array_reverse($migrations); + + foreach ($migrations as $migration) { + drush_print(dt('Rolling back @migration', ['@migration' => $migration->id()])); + $executable = new MigrateExecutable($migration, static::$messages); + // drush_op() provides --simulate support. + drush_op([$executable, 'rollback']); + } + } + + /** + * Display any messages being logged to the ID map. + * + * @param \Drupal\migrate\Event\MigrateIdMapMessageEvent $event + * The message event. + */ + public static function onIdMapMessage(MigrateIdMapMessageEvent $event) { + if ($event->getLevel() == MigrationInterface::MESSAGE_NOTICE || + $event->getLevel() == MigrationInterface::MESSAGE_INFORMATIONAL) { + $type = 'status'; + } + else { + $type = 'error'; + } + $source_id_string = implode(',', $event->getSourceIdValues()); + $message = t('Source ID @source_id: @message', + ['@source_id' => $source_id_string, '@message' => $event->getMessage()]); + static::$messages->display($message, $type); + } + +}