class MigrateUpgradeRunBatch in Migrate Upgrade 8
Runs a single migration batch.
Hierarchy
- class \Drupal\migrate_upgrade\MigrateUpgradeRunBatch
Expanded class hierarchy of MigrateUpgradeRunBatch
1 file declares its use of MigrateUpgradeRunBatch
- MigrateUpgradeForm.php in src/
Form/ MigrateUpgradeForm.php - Contains \Drupal\migrate_upgrade\Form\MigrateUpgradeForm.
File
- src/
MigrateUpgradeRunBatch.php, line 25 - Contains \Drupal\migrate_upgrade\MigrateUpgradeRunBatch.
Namespace
Drupal\migrate_upgradeView source
class MigrateUpgradeRunBatch {
/**
* Maximum number of previous messages to display.
*/
const MESSAGE_LENGTH = 20;
/**
* The processed items for one batch of a given migration.
*
* @var int
*/
protected static $numProcessed = 0;
/**
* Ensure we only add the listeners once per request.
*
* @var bool
*/
protected static $listenersAdded = FALSE;
/**
* The maximum length in seconds to allow processing in a request.
*
* @var int
*/
protected static $maxExecTime;
/**
* MigrateMessage instance to capture messages during the migration process.
*
* @var \Drupal\migrate_upgrade\MigrateMessageCapture
*/
protected static $messages;
/**
* Runs a single migration batch.
*
* @param int[] $initial_ids
* The full set of migration IDs to import.
* @param string $operation
* The operation to perform, 'import' or 'rollback'.
* @param array $context
* The batch context.
*/
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'] .= '…';
}
// 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'];
}
/**
* Returns the logger using the migrate_upgrade channel.
*
* @return \Psr\Log\LoggerInterface
* The logger instance.
*/
protected static function logger() {
return \Drupal::logger('migrate_upgrade');
}
/**
* Wraps the translation manager.
*
* @return \Drupal\Core\StringTranslation\TranslationManager
* The string translation manager.
*/
protected static function getTranslation() {
return \Drupal::translation();
}
/**
* Implements the Batch API finished method.
*/
public static function finished($success, $results, $operations, $elapsed) {
static::displayResults($results);
}
/**
* Displays counts of success/failures on the migration upgrade complete page.
*
* @param array $results
* An array of result data built during the batch.
*/
protected static function displayResults($results) {
$successes = $results['successes'];
$failures = $results['failures'];
// If we had any successes lot that for the user.
if ($successes > 0) {
if ($results['operation'] == 'import') {
drupal_set_message(static::getTranslation()
->formatPlural($successes, 'Completed 1 upgrade task successfully', 'Completed @count upgrade tasks successfully'));
}
else {
drupal_set_message(static::getTranslation()
->formatPlural($successes, 'Completed 1 rollback task successfully', 'Completed @count rollback tasks successfully'));
}
}
// If we had failures, log them and show the migration failed.
if ($failures > 0) {
if ($results['operation'] == 'import') {
drupal_set_message(static::getTranslation()
->formatPlural($failures, '1 upgrade failed', '@count upgrades failed'));
drupal_set_message(t('Upgrade process not completed'), 'error');
}
else {
drupal_set_message(static::getTranslation()
->formatPlural($failures, '1 rollback failed', '@count rollbacks failed'));
drupal_set_message(t('Rollback process not completed'), 'error');
}
}
else {
if ($results['operation'] == 'import') {
// Everything went off without a hitch. We may not have had successes
// but we didn't have failures so this is fine.
drupal_set_message(t('Congratulations, you upgraded Drupal!'));
}
else {
drupal_set_message(t('Rollback of the upgrade is complete - you may now start the upgrade process from scratch.'));
}
}
if (\Drupal::moduleHandler()
->moduleExists('dblog')) {
$url = Url::fromRoute('migrate_upgrade.log');
drupal_set_message(Link::fromTextAndUrl(t('Review the detailed upgrade log'), $url), $failures ? 'error' : 'status');
}
}
/**
* Reacts to item import.
*
* @param \Drupal\migrate\Event\MigratePostRowSaveEvent $event
* The post-save event.
*/
public static function onPostRowSave(MigratePostRowSaveEvent $event) {
// We want to interrupt this batch and start a fresh one.
if (time() - REQUEST_TIME > static::$maxExecTime) {
$event
->getMigration()
->interruptMigration(MigrationInterface::RESULT_INCOMPLETE);
}
}
/**
* Reacts to item deletion.
*
* @param \Drupal\migrate\Event\MigrateRowDeleteEvent $event
* The post-save event.
*/
public static function onPostRowDelete(MigrateRowDeleteEvent $event) {
// We want to interrupt this batch and start a fresh one.
if (time() - REQUEST_TIME > static::$maxExecTime) {
$event
->getMigration()
->interruptMigration(MigrationInterface::RESULT_INCOMPLETE);
}
}
/**
* Counts up any map save events.
*
* @param \Drupal\migrate\Event\MigrateMapSaveEvent $event
* The map event.
*/
public static function onMapSave(MigrateMapSaveEvent $event) {
static::$numProcessed++;
}
/**
* Counts up any map delete events.
*
* @param \Drupal\migrate\Event\MigrateMapDeleteEvent $event
* The map event.
*/
public static function onMapDelete(MigrateMapDeleteEvent $event) {
static::$numProcessed++;
}
/**
* Displays 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);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
MigrateUpgradeRunBatch:: |
protected static | property | Ensure we only add the listeners once per request. | |
MigrateUpgradeRunBatch:: |
protected static | property | The maximum length in seconds to allow processing in a request. | |
MigrateUpgradeRunBatch:: |
protected static | property | MigrateMessage instance to capture messages during the migration process. | |
MigrateUpgradeRunBatch:: |
protected static | property | The processed items for one batch of a given migration. | |
MigrateUpgradeRunBatch:: |
protected static | function | Displays counts of success/failures on the migration upgrade complete page. | |
MigrateUpgradeRunBatch:: |
public static | function | Implements the Batch API finished method. | |
MigrateUpgradeRunBatch:: |
protected static | function | Wraps the translation manager. | |
MigrateUpgradeRunBatch:: |
protected static | function | Returns the logger using the migrate_upgrade channel. | |
MigrateUpgradeRunBatch:: |
constant | Maximum number of previous messages to display. | ||
MigrateUpgradeRunBatch:: |
public static | function | Displays any messages being logged to the ID map. | |
MigrateUpgradeRunBatch:: |
public static | function | Counts up any map delete events. | |
MigrateUpgradeRunBatch:: |
public static | function | Counts up any map save events. | |
MigrateUpgradeRunBatch:: |
public static | function | Reacts to item deletion. | |
MigrateUpgradeRunBatch:: |
public static | function | Reacts to item import. | |
MigrateUpgradeRunBatch:: |
public static | function | Runs a single migration batch. |