X-Git-Url: http://aleph1.co.uk/gitweb/?a=blobdiff_plain;f=web%2Fmodules%2Fcontrib%2Fmigrate_tools%2Fmigrate_tools.drush.inc;h=73ddec5307cf285b602278ae90d00fd4014908ac;hb=059867c3f96750652c80f39e44c442a58c2549ee;hp=30ddf5934f148127095bedd27dfdd20874538dc8;hpb=a2bd1bf0c2c1f1a17d188f4dc0726a45494cefae;p=yaffs-website

diff --git a/web/modules/contrib/migrate_tools/migrate_tools.drush.inc b/web/modules/contrib/migrate_tools/migrate_tools.drush.inc
index 30ddf5934..73ddec530 100644
--- a/web/modules/contrib/migrate_tools/migrate_tools.drush.inc
+++ b/web/modules/contrib/migrate_tools/migrate_tools.drush.inc
@@ -6,11 +6,12 @@
  */
 
 use Drupal\Component\Utility\Unicode;
+use Drupal\migrate\Exception\RequirementsException;
 use Drupal\migrate\Plugin\MigrationInterface;
-use Drupal\migrate_tools\MigrateExecutable;
-use Drupal\migrate_tools\DrushLogMigrateMessage;
-use Drupal\Core\Datetime\DateFormatter;
+use Drupal\migrate\Plugin\RequirementsInterface;
 use Drupal\migrate_plus\Entity\MigrationGroup;
+use Drupal\migrate_tools\DrushLogMigrateMessage;
+use Drupal\migrate_tools\MigrateExecutable;
 
 /**
  * Implements hook_drush_command().
@@ -63,30 +64,30 @@ function migrate_tools_drush_command() {
       'migrate-import beer_user --idlist=5' => 'Import the user record with source ID 5',
     ],
     'drupal dependencies' => ['migrate_tools'],
-    'aliases' => ['mi'],
+    'aliases' => ['mi', 'mim'],
   ];
 
-  $items['migrate-rollback'] = array(
+  $items['migrate-rollback'] = [
     'description' => 'Rollback one or more migrations.',
-    'options' => array(
+    'options' => [
       'all' => 'Process all migrations.',
       'group' => 'A comma-separated list of migration groups to rollback',
       'tag' => 'ID of the migration tag to rollback',
       'feedback' => 'Frequency of progress messages, in items processed',
-    ),
-    'arguments' => array(
+    ],
+    'arguments' => [
       'migration' => 'Name of migration(s) to rollback. Delimit multiple using commas.',
-    ),
-    'examples' => array(
+    ],
+    'examples' => [
       'migrate-rollback --all' => 'Perform all migrations',
       'migrate-rollback --group=beer' => 'Rollback all migrations in the beer group',
       'migrate-rollback --tag=user' => 'Rollback all migrations with the user tag',
       'migrate-rollback --group=beer --tag=user' => 'Rollback all migrations in the beer group and with the user tag',
       'migrate-rollback beer_term,beer_node' => 'Rollback imported terms and nodes',
-    ),
-    'drupal dependencies' => array('migrate_tools'),
-    'aliases' => array('mr'),
-  );
+    ],
+    'drupal dependencies' => ['migrate_tools'],
+    'aliases' => ['mr'],
+  ];
 
   $items['migrate-stop'] = [
     'description' => 'Stop an active migration operation.',
@@ -112,7 +113,7 @@ function migrate_tools_drush_command() {
       'migration' => 'ID of the migration',
     ],
     'options' => [
-      'csv' => 'Export messages as a CSV'
+      'csv' => 'Export messages as a CSV',
     ],
     'examples' => [
       'migrate-messages MyNode' => 'Show all messages for the MyNode migration',
@@ -137,7 +138,10 @@ function migrate_tools_drush_command() {
 }
 
 /**
+ * Display migration status.
+ *
  * @param string $migration_names
+ *   The migration names.
  */
 function drush_migrate_tools_migrate_status($migration_names = '') {
   $names_only = drush_get_option('names-only');
@@ -151,12 +155,12 @@ function drush_migrate_tools_migrate_status($migration_names = '') {
     $group_name = !empty($group) ? "{$group->label()} ({$group->id()})" : $group_id;
     if ($names_only) {
       $table[] = [
-        dt('Group: @name', array('@name' => $group_name))
+        dt('Group: @name', ['@name' => $group_name]),
       ];
     }
     else {
       $table[] = [
-        dt('Group: @name', array('@name' => $group_name)),
+        dt('Group: @name', ['@name' => $group_name]),
         dt('Status'),
         dt('Total'),
         dt('Imported'),
@@ -175,34 +179,34 @@ function drush_migrate_tools_migrate_status($migration_names = '') {
           ['@migration' => $migration_id, '@message' => $e->getMessage()]));
         continue;
       }
-      try {
-        $source_rows = $source_plugin->count();
-        // -1 indicates uncountable sources.
-        if ($source_rows == -1) {
-          $source_rows = dt('N/A');
-          $unprocessed = dt('N/A');
-        }
-        else {
-          $unprocessed = $source_rows - $map->processedCount();
-        }
-      }
-      catch (Exception $e) {
-        drush_print($e->getMessage());
-        drush_log(dt('Could not retrieve source count from @migration: @message',
-          ['@migration' => $migration_id, '@message' => $e->getMessage()]));
-        $source_rows = dt('N/A');
-        $unprocessed = dt('N/A');
-      }
-
       if ($names_only) {
         $table[] = [$migration_id];
       }
       else {
+        try {
+          $source_rows = $source_plugin->count();
+          // -1 indicates uncountable sources.
+          if ($source_rows == -1) {
+            $source_rows = dt('N/A');
+            $unprocessed = dt('N/A');
+          }
+          else {
+            $unprocessed = $source_rows - $map->processedCount();
+          }
+        }
+        catch (Exception $e) {
+          drush_print($e->getMessage());
+          drush_log(dt('Could not retrieve source count from @migration: @message',
+            ['@migration' => $migration_id, '@message' => $e->getMessage()]));
+          $source_rows = dt('N/A');
+          $unprocessed = dt('N/A');
+        }
+
         $status = $migration->getStatusLabel();
         $migrate_last_imported_store = \Drupal::keyValue('migrate_last_imported');
         $last_imported = $migrate_last_imported_store->get($migration->id(), FALSE);
         if ($last_imported) {
-          /** @var DateFormatter $date_formatter */
+          /** @var \Drupal\Core\Datetime\DateFormatter $date_formatter */
           $date_formatter = \Drupal::service('date.formatter');
           $last_imported = $date_formatter->format($last_imported / 1000,
             'custom', 'Y-m-d H:i:s');
@@ -210,7 +214,14 @@ function drush_migrate_tools_migrate_status($migration_names = '') {
         else {
           $last_imported = '';
         }
-        $table[] = [$migration_id, $status, $source_rows, $imported, $unprocessed, $last_imported];
+        $table[] = [
+          $migration_id,
+          $status,
+          $source_rows,
+          $imported,
+          $unprocessed,
+          $last_imported,
+        ];
       }
     }
   }
@@ -218,12 +229,22 @@ function drush_migrate_tools_migrate_status($migration_names = '') {
 }
 
 /**
+ * Import a migration.
+ *
  * @param string $migration_names
+ *   The migration names.
  */
 function drush_migrate_tools_migrate_import($migration_names = '') {
   $group_names = drush_get_option('group');
   $tag_names = drush_get_option('tag');
   $all = drush_get_option('all');
+
+  // Display a depreciation message if "mi" alias is used.
+  $args = drush_get_arguments();
+  if ($args[0] === 'mi') {
+    drush_log('The \'mi\' alias is deprecated and will no longer work with Drush 9. Consider the use of \'mim\' alias instead.', 'warning');
+  }
+
   $options = [];
   if (!$all && !$group_names && !$migration_names && !$tag_names) {
     drush_set_error('MIGRATE_ERROR', dt('You must specify --all, --group, --tag or one or more migration names separated by commas'));
@@ -248,22 +269,24 @@ function drush_migrate_tools_migrate_import($migration_names = '') {
 }
 
 /**
- * Executes a single migration. If the --execute-dependencies option was given,
- * the migration's dependencies will also be executed first.
+ * Executes a single migration.
+ *
+ * If the --execute-dependencies option was given, the migration's dependencies
+ * will also be executed first.
  *
  * @param \Drupal\migrate\Plugin\MigrationInterface $migration
- *  The migration to execute.
+ *   The migration to execute.
  * @param string $migration_id
- *  The migration ID (not used, just an artifact of array_walk()).
+ *   The migration ID (not used, just an artifact of array_walk()).
  * @param array $options
- *  Additional options for the migration.
+ *   Additional options for the migration.
  */
-function _drush_migrate_tools_execute_migration(MigrationInterface $migration, $migration_id,  array $options = []) {
+function _drush_migrate_tools_execute_migration(MigrationInterface $migration, $migration_id, array $options = []) {
   $log = new DrushLogMigrateMessage();
 
   if (drush_get_option('execute-dependencies')) {
     if ($required_IDS = $migration->get('requirements')) {
-      $manager = \Drupal::service('plugin.manager.config_entity_migration');
+      $manager = \Drupal::service('plugin.manager.migration');
       $required_migrations = $manager->createInstances($required_IDS);
       $dependency_options = array_merge($options, ['is_dependency' => TRUE]);
       array_walk($required_migrations, __FUNCTION__, $dependency_options);
@@ -276,12 +299,22 @@ function _drush_migrate_tools_execute_migration(MigrationInterface $migration, $
     $migration->getIdMap()->prepareUpdate();
   }
   $executable = new MigrateExecutable($migration, $log, $options);
-  // drush_op() provides --simulate support
-  drush_op(array($executable, 'import'));
+  // Function drush_op() provides --simulate support.
+  drush_op([$executable, 'import']);
+  if ($count = $executable->getFailedCount()) {
+    // Nudge Drush to use a non-zero exit code.
+    drush_set_error('MIGRATE_ERROR', dt('!name Migration - !count failed.', [
+      '!name' => $migration_id,
+      '!count' => $count,
+    ]));
+  }
 }
 
 /**
+ * Rollback migrations.
+ *
  * @param string $migration_names
+ *   The migration names.
  */
 function drush_migrate_tools_migrate_rollback($migration_names = '') {
   $group_names = drush_get_option('group');
@@ -311,17 +344,21 @@ function drush_migrate_tools_migrate_rollback($migration_names = '') {
     foreach ($migration_list as $migration_id => $migration) {
       $executable = new MigrateExecutable($migration, $log, $options);
       // drush_op() provides --simulate support.
-      drush_op(array($executable, 'rollback'));
+      drush_op([$executable, 'rollback']);
     }
   }
 }
 
 /**
+ * Stop a migration.
+ *
  * @param string $migration_id
+ *   The migration id.
  */
 function drush_migrate_tools_migrate_stop($migration_id = '') {
-  /** @var MigrationInterface $migration */
-  $migration = \Drupal::service('plugin.manager.migration')->createInstance($migration_id);
+  /** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
+  $migration = \Drupal::service('plugin.manager.migration')
+    ->createInstance($migration_id);
   if ($migration) {
     $status = $migration->getStatus();
     switch ($status) {
@@ -346,11 +383,15 @@ function drush_migrate_tools_migrate_stop($migration_id = '') {
 }
 
 /**
+ * Reset status.
+ *
  * @param string $migration_id
+ *   The migration id.
  */
 function drush_migrate_tools_migrate_reset_status($migration_id = '') {
-  /** @var MigrationInterface $migration */
-  $migration = \Drupal::service('plugin.manager.migration')->createInstance($migration_id);
+  /** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
+  $migration = \Drupal::service('plugin.manager.migration')
+    ->createInstance($migration_id);
   if ($migration) {
     $status = $migration->getStatus();
     if ($status == MigrationInterface::STATUS_IDLE) {
@@ -367,11 +408,15 @@ function drush_migrate_tools_migrate_reset_status($migration_id = '') {
 }
 
 /**
+ * Print messages.
+ *
  * @param string $migration_id
+ *   The migration id.
  */
 function drush_migrate_tools_migrate_messages($migration_id) {
-  /** @var MigrationInterface $migration */
-  $migration = \Drupal::service('plugin.manager.migration')->createInstance($migration_id);
+  /** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
+  $migration = \Drupal::service('plugin.manager.migration')
+    ->createInstance($migration_id);
   if ($migration) {
     $map = $migration->getIdMap();
     $first = TRUE;
@@ -386,7 +431,7 @@ function drush_migrate_tools_migrate_messages($migration_id) {
         }
         $first = FALSE;
       }
-      $table[] = (array)$row;
+      $table[] = (array) $row;
     }
     if (empty($table)) {
       drush_log(dt('No messages for this migration'), 'status');
@@ -412,11 +457,15 @@ function drush_migrate_tools_migrate_messages($migration_id) {
 }
 
 /**
+ * Print source fields.
+ *
  * @param string $migration_id
+ *   The migration id.
  */
 function drush_migrate_tools_migrate_fields_source($migration_id) {
-  /** @var MigrationInterface $migration */
-  $migration = \Drupal::service('plugin.manager.migration')->createInstance($migration_id);
+  /** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
+  $migration = \Drupal::service('plugin.manager.migration')
+    ->createInstance($migration_id);
   if ($migration) {
     $source = $migration->getSourcePlugin();
     $table = [];
@@ -434,9 +483,10 @@ function drush_migrate_tools_migrate_fields_source($migration_id) {
  * Retrieve a list of active migrations.
  *
  * @param string $migration_ids
- *  Comma-separated list of migrations - if present, return only these migrations.
+ *   Comma-separated list of migrations - if present, return only these
+ *   migrations.
  *
- * @return MigrationInterface[][]
+ * @return \Drupal\migrate\Plugin\MigrationInterface[][]
  *   An array keyed by migration group, each value containing an array of
  *   migrations or an empty array if no migrations match the input criteria.
  */
@@ -445,20 +495,33 @@ function drush_migrate_tools_migration_list($migration_ids = '') {
   $filter['migration_group'] = drush_get_option('group') ? explode(',', drush_get_option('group')) : [];
   $filter['migration_tags'] = drush_get_option('tag') ? explode(',', drush_get_option('tag')) : [];
 
-  $manager = \Drupal::service('plugin.manager.config_entity_migration');
+  $manager = \Drupal::service('plugin.manager.migration');
   $plugins = $manager->createInstances([]);
   $matched_migrations = [];
 
   // Get the set of migrations that may be filtered.
   if (empty($migration_ids)) {
-    $matched_migrations  = $plugins;
+    $matched_migrations = $plugins;
   }
   else {
     // Get the requested migrations.
     $migration_ids = explode(',', Unicode::strtolower($migration_ids));
     foreach ($plugins as $id => $migration) {
       if (in_array(Unicode::strtolower($id), $migration_ids)) {
-        $matched_migrations [$id] = $migration;
+        $matched_migrations[$id] = $migration;
+      }
+    }
+  }
+
+  // Do not return any migrations which fail to meet requirements.
+  /** @var \Drupal\migrate\Plugin\Migration $migration */
+  foreach ($matched_migrations as $id => $migration) {
+    if ($migration->getSourcePlugin() instanceof RequirementsInterface) {
+      try {
+        $migration->getSourcePlugin()->checkRequirements();
+      }
+      catch (RequirementsException $e) {
+        unset($matched_migrations[$id]);
       }
     }
   }