public static function MigrateUpgradeRunBatch::run in Migrate Upgrade 8

Runs a single migration batch.

Parameters

int[] $initial_ids: The full set of migration IDs to import.

string $operation: The operation to perform, 'import' or 'rollback'.

array $context: The batch context.

File

src/MigrateUpgradeRunBatch.php, line 70

Contains \Drupal\migrate_upgrade\MigrateUpgradeRunBatch.

Class

MigrateUpgradeRunBatch

Runs a single migration batch.

Namespace

Drupal\migrate_upgrade

Code

public static function run($initial_ids, $operation, &$context) {
  if (!static::$listenersAdded) {
    $event_dispatcher = \Drupal::service('event_dispatcher');
    if ($operation == 'import') {
      $event_dispatcher
        ->addListener(MigrateEvents::POST_ROW_SAVE, [
        static::class,
        'onPostRowSave',
      ]);
      $event_dispatcher
        ->addListener(MigrateEvents::MAP_SAVE, [
        static::class,
        'onMapSave',
      ]);
      $event_dispatcher
        ->addListener(MigrateEvents::IDMAP_MESSAGE, [
        static::class,
        'onIdMapMessage',
      ]);
    }
    else {
      $event_dispatcher
        ->addListener(MigrateEvents::POST_ROW_DELETE, [
        static::class,
        'onPostRowDelete',
      ]);
      $event_dispatcher
        ->addListener(MigrateEvents::MAP_DELETE, [
        static::class,
        'onMapDelete',
      ]);
    }
    static::$maxExecTime = ini_get('max_execution_time');
    if (static::$maxExecTime <= 0) {
      static::$maxExecTime = 60;
    }

    // Set an arbitrary threshold of 3 seconds (e.g., if max_execution_time is
    // 45 seconds, we will quit at 42 seconds so a slow item or cleanup
    // overhead don't put us over 45).
    static::$maxExecTime -= 3;
    static::$listenersAdded = TRUE;
  }
  if (!isset($context['sandbox']['migration_ids'])) {
    $context['sandbox']['max'] = count($initial_ids);
    $context['sandbox']['current'] = 1;

    // Total number processed for this migration.
    $context['sandbox']['num_processed'] = 0;

    // migration_ids will be the list of IDs remaining to run.
    $context['sandbox']['migration_ids'] = $initial_ids;
    $context['sandbox']['messages'] = [];
    $context['results']['failures'] = 0;
    $context['results']['successes'] = 0;
    $context['results']['operation'] = $operation;
  }

  // Number processed in this batch.
  static::$numProcessed = 0;
  $migration_id = reset($context['sandbox']['migration_ids']);

  /** @var \Drupal\migrate\Entity\Migration $migration */
  $migration = Migration::load($migration_id);
  if ($migration) {
    static::$messages = new MigrateMessageCapture();
    $executable = new MigrateExecutable($migration, static::$messages);
    $migration_name = $migration
      ->label() ? $migration
      ->label() : $migration_id;
    try {
      if ($operation == 'import') {
        $migration_status = $executable
          ->import();
      }
      else {
        $migration_status = $executable
          ->rollback();
      }
    } catch (\Exception $e) {
      static::logger()
        ->error($e
        ->getMessage());
      $migration_status = MigrationInterface::RESULT_FAILED;
    }
    switch ($migration_status) {
      case MigrationInterface::RESULT_COMPLETED:

        // Store the number processed in the sandbox.
        $context['sandbox']['num_processed'] += static::$numProcessed;
        if ($operation == 'import') {
          $message = static::getTranslation()
            ->formatPlural($context['sandbox']['num_processed'], 'Upgraded @migration (processed 1 item total)', 'Upgraded @migration (processed @num_processed items total)', [
            '@migration' => $migration_name,
            '@num_processed' => $context['sandbox']['num_processed'],
          ]);
        }
        else {
          $message = static::getTranslation()
            ->formatPlural($context['sandbox']['num_processed'], 'Rolled back @migration (processed 1 item total)', 'Rolled back @migration (processed @num_processed items total)', [
            '@migration' => $migration_name,
            '@num_processed' => $context['sandbox']['num_processed'],
          ]);
          $migration
            ->delete();
        }
        $context['sandbox']['messages'][] = $message;
        static::logger()
          ->notice($message);
        $context['sandbox']['num_processed'] = 0;
        $context['results']['successes']++;
        break;
      case MigrationInterface::RESULT_INCOMPLETE:
        $context['sandbox']['messages'][] = static::getTranslation()
          ->formatPlural(static::$numProcessed, 'Continuing with @migration (processed 1 item)', 'Continuing with @migration (processed @num_processed items)', [
          '@migration' => $migration_name,
          '@num_processed' => static::$numProcessed,
        ]);
        $context['sandbox']['num_processed'] += static::$numProcessed;
        break;
      case MigrationInterface::RESULT_STOPPED:
        $context['sandbox']['messages'][] = t('Operation stopped by request');
        break;
      case MigrationInterface::RESULT_FAILED:
        $context['sandbox']['messages'][] = t('Operation on @migration failed', [
          '@migration' => $migration_name,
        ]);
        $context['results']['failures']++;
        static::logger()
          ->error('Operation on @migration failed', [
          '@migration' => $migration_name,
        ]);
        break;
      case MigrationInterface::RESULT_SKIPPED:
        $context['sandbox']['messages'][] = t('Operation on @migration skipped due to unfulfilled dependencies', [
          '@migration' => $migration_name,
        ]);
        static::logger()
          ->error('Operation on @migration skipped due to unfulfilled dependencies', [
          '@migration' => $migration_name,
        ]);
        break;
      case MigrationInterface::RESULT_DISABLED:

        // Skip silently if disabled.
        break;
    }

    // Unless we're continuing on with this migration, take it off the list.
    if ($migration_status != MigrationInterface::RESULT_INCOMPLETE) {
      array_shift($context['sandbox']['migration_ids']);
      $context['sandbox']['current']++;
    }

    // Add and log any captured messages.
    foreach (static::$messages
      ->getMessages() as $message) {
      $context['sandbox']['messages'][] = $message;
      static::logger()
        ->error($message);
    }

    // Only display the last MESSAGE_LENGTH messages, in reverse order.
    $message_count = count($context['sandbox']['messages']);
    $context['message'] = '';
    for ($index = max(0, $message_count - self::MESSAGE_LENGTH); $index < $message_count; $index++) {
      $context['message'] = $context['sandbox']['messages'][$index] . "<br />\n" . $context['message'];
    }
    if ($message_count > self::MESSAGE_LENGTH) {

      // Indicate there are earlier messages not displayed.
      $context['message'] .= '&hellip;';
    }

    // At the top of the list, display the next one (which will be the one
    // that is running while this message is visible).
    if (!empty($context['sandbox']['migration_ids'])) {
      $migration_id = reset($context['sandbox']['migration_ids']);
      $migration = Migration::load($migration_id);
      $migration_name = $migration
        ->label() ? $migration
        ->label() : $migration_id;
      if ($operation == 'import') {
        $context['message'] = t('Currently upgrading @migration (@current of @max total tasks)', [
          '@migration' => $migration_name,
          '@current' => $context['sandbox']['current'],
          '@max' => $context['sandbox']['max'],
        ]) . "<br />\n" . $context['message'];
      }
      else {
        $context['message'] = t('Currently rolling back @migration (@current of @max total tasks)', [
          '@migration' => $migration_name,
          '@current' => $context['sandbox']['current'],
          '@max' => $context['sandbox']['max'],
        ]) . "<br />\n" . $context['message'];
      }
    }
  }
  else {
    array_shift($context['sandbox']['migration_ids']);
    $context['sandbox']['current']++;
  }
  $context['finished'] = 1 - count($context['sandbox']['migration_ids']) / $context['sandbox']['max'];
}