MigrateExecutable.php 18 KB
Newer Older
1 2 3 4
<?php

namespace Drupal\migrate;

5
use Drupal\Core\Utility\Error;
6
use Drupal\Core\StringTranslation\StringTranslationTrait;
7 8 9 10
use Drupal\migrate\Event\MigrateEvents;
use Drupal\migrate\Event\MigrateImportEvent;
use Drupal\migrate\Event\MigratePostRowSaveEvent;
use Drupal\migrate\Event\MigratePreRowSaveEvent;
11 12
use Drupal\migrate\Event\MigrateRollbackEvent;
use Drupal\migrate\Event\MigrateRowDeleteEvent;
13
use Drupal\migrate\Exception\RequirementsException;
14
use Drupal\migrate\Plugin\MigrateIdMapInterface;
15
use Drupal\migrate\Plugin\MigrationInterface;
16
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
17 18 19 20

/**
 * Defines a migrate executable class.
 */
21
class MigrateExecutable implements MigrateExecutableInterface {
22
  use StringTranslationTrait;
23 24

  /**
25
   * The configuration of the migration to do.
26
   *
27
   * @var \Drupal\migrate\Plugin\MigrationInterface
28 29 30 31 32 33 34 35 36 37 38
   */
  protected $migration;

  /**
   * Status of one row.
   *
   * The value is a MigrateIdMapInterface::STATUS_* constant, for example:
   * STATUS_IMPORTED.
   *
   * @var int
   */
39
  protected $sourceRowStatus;
40

41 42 43 44 45 46 47 48 49 50 51 52 53 54
  /**
   * The ratio of the memory limit at which an operation will be interrupted.
   *
   * @var float
   */
  protected $memoryThreshold = 0.85;

  /**
   * The PHP memory_limit expressed in bytes.
   *
   * @var int
   */
  protected $memoryLimit;

55 56
  /**
   * The configuration values of the source.
57
   *
58
   * @var array
59
   */
60 61
  protected $sourceIdValues;

62
  /**
63
   * An array of counts. Initially used for cache hit/miss tracking.
64
   *
65 66
   * @var array
   */
67
  protected $counts = array();
68 69

  /**
70
   * The object currently being constructed.
71
   *
72
   * @var \stdClass
73
   */
74 75 76 77 78
  protected $destinationValues;

  /**
   * The source.
   *
79
   * @var \Drupal\migrate\Plugin\MigrateSourceInterface
80 81 82 83 84 85 86 87 88
   */
  protected $source;

  /**
   * The current data row retrieved from the source.
   *
   * @var \stdClass
   */
  protected $sourceValues;
89

90 91 92 93 94 95 96
  /**
   * The event dispatcher.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $eventDispatcher;

97
  /**
98 99
   * Constructs a MigrateExecutable and verifies and sets the memory limit.
   *
100
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
101 102 103
   *   The migration to run.
   * @param \Drupal\migrate\MigrateMessageInterface $message
   *   The message to record.
104 105
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
   *   The event dispatcher.
106 107 108
   *
   * @throws \Drupal\migrate\MigrateException
   */
109
  public function __construct(MigrationInterface $migration, MigrateMessageInterface $message, EventDispatcherInterface $event_dispatcher = NULL) {
110 111 112
    $this->migration = $migration;
    $this->message = $message;
    $this->migration->getIdMap()->setMessage($message);
113
    $this->eventDispatcher = $event_dispatcher;
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
    // Record the memory limit in bytes
    $limit = trim(ini_get('memory_limit'));
    if ($limit == '-1') {
      $this->memoryLimit = PHP_INT_MAX;
    }
    else {
      if (!is_numeric($limit)) {
        $last = strtolower(substr($limit, -1));
        switch ($last) {
          case 'g':
            $limit *= 1024;
          case 'm':
            $limit *= 1024;
          case 'k':
            $limit *= 1024;
            break;
          default:
            $limit = PHP_INT_MAX;
132 133
            $this->message->display($this->t('Invalid PHP memory_limit @limit, setting to unlimited.',
              array('@limit' => $limit)));
134 135 136 137
        }
      }
      $this->memoryLimit = $limit;
    }
138 139 140
  }

  /**
141 142 143 144
   * Returns the source.
   *
   * Makes sure source is initialized based on migration settings.
   *
145
   * @return \Drupal\migrate\Plugin\MigrateSourceInterface
146
   *   The source.
147
   */
148
  protected function getSource() {
149
    if (!isset($this->source)) {
150
      $this->source = $this->migration->getSourcePlugin();
151 152 153 154
    }
    return $this->source;
  }

155 156 157 158 159 160 161 162 163 164 165 166
  /**
   * Gets the event dispatcher.
   *
   * @return \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected function getEventDispatcher() {
    if (!$this->eventDispatcher) {
      $this->eventDispatcher = \Drupal::service('event_dispatcher');
    }
    return $this->eventDispatcher;
  }

167
  /**
168
   * {@inheritdoc}
169 170
   */
  public function import() {
171 172 173 174 175 176 177 178 179
    // Only begin the import operation if the migration is currently idle.
    if ($this->migration->getStatus() !== MigrationInterface::STATUS_IDLE) {
      $this->message->display($this->t('Migration @id is busy with another operation: @status',
        array(
          '@id' => $this->migration->id(),
          '@status' => $this->t($this->migration->getStatusLabel()),
        )), 'error');
      return MigrationInterface::RESULT_FAILED;
    }
180
    $this->getEventDispatcher()->dispatch(MigrateEvents::PRE_IMPORT, new MigrateImportEvent($this->migration, $this->message));
181

182
    // Knock off migration if the requirements haven't been met.
183
    try {
184
      $this->migration->checkRequirements();
185 186
    }
    catch (RequirementsException $e) {
187
      $this->message->display(
188 189 190 191 192 193 194 195 196 197 198
        $this->t(
          'Migration @id did not meet the requirements. @message @requirements',
          array(
            '@id' => $this->migration->id(),
            '@message' => $e->getMessage(),
            '@requirements' => $e->getRequirementsString(),
          )
        ),
        'error'
      );

199 200
      return MigrationInterface::RESULT_FAILED;
    }
201

202
    $this->migration->setStatus(MigrationInterface::STATUS_IMPORTING);
203 204 205 206 207 208 209 210 211
    $return = MigrationInterface::RESULT_COMPLETED;
    $source = $this->getSource();
    $id_map = $this->migration->getIdMap();

    try {
      $source->rewind();
    }
    catch (\Exception $e) {
      $this->message->display(
212
        $this->t('Migration failed with source plugin exception: @e', array('@e' => $e->getMessage())), 'error');
213
      $this->migration->setStatus(MigrationInterface::STATUS_IDLE);
214 215
      return MigrationInterface::RESULT_FAILED;
    }
216

217
    $destination = $this->migration->getDestinationPlugin();
218 219
    while ($source->valid()) {
      $row = $source->current();
220
      $this->sourceIdValues = $row->getSourceIdValues();
221 222

      try {
223 224
        $this->processRow($row);
        $save = TRUE;
225
      }
226
      catch (MigrateException $e) {
227
        $this->migration->getIdMap()->saveIdMapping($row, array(), $e->getStatus());
228 229 230
        $this->saveMessage($e->getMessage(), $e->getLevel());
        $save = FALSE;
      }
231
      catch (MigrateSkipRowException $e) {
232
        $id_map->saveIdMapping($row, array(), MigrateIdMapInterface::STATUS_IGNORED);
233
        $save = FALSE;
234
      }
235 236 237

      if ($save) {
        try {
238
          $this->getEventDispatcher()->dispatch(MigrateEvents::PRE_ROW_SAVE, new MigratePreRowSaveEvent($this->migration, $this->message, $row));
239
          $destination_id_values = $destination->import($row, $id_map->lookupDestinationId($this->sourceIdValues));
240
          $this->getEventDispatcher()->dispatch(MigrateEvents::POST_ROW_SAVE, new MigratePostRowSaveEvent($this->migration, $this->message, $row, $destination_id_values));
241
          if ($destination_id_values) {
242 243
            // We do not save an idMap entry for config.
            if ($destination_id_values !== TRUE) {
244
              $id_map->saveIdMapping($row, $destination_id_values, $this->sourceRowStatus, $destination->rollbackAction());
245
            }
246 247
          }
          else {
248
            $id_map->saveIdMapping($row, array(), MigrateIdMapInterface::STATUS_FAILED);
249 250 251 252 253 254 255 256
            if (!$id_map->messageCount()) {
              $message = $this->t('New object was not saved, no error provided');
              $this->saveMessage($message);
              $this->message->display($message);
            }
          }
        }
        catch (MigrateException $e) {
257
          $this->migration->getIdMap()->saveIdMapping($row, array(), $e->getStatus());
258 259 260
          $this->saveMessage($e->getMessage(), $e->getLevel());
        }
        catch (\Exception $e) {
261
          $this->migration->getIdMap()->saveIdMapping($row, array(), MigrateIdMapInterface::STATUS_FAILED);
262 263
          $this->handleException($e);
        }
264 265 266 267
      }

      // Reset row properties.
      unset($sourceValues, $destinationValues);
268
      $this->sourceRowStatus = MigrateIdMapInterface::STATUS_IMPORTED;
269

270
      // Check for memory exhaustion.
271 272 273 274
      if (($return = $this->checkStatus()) != MigrationInterface::RESULT_COMPLETED) {
        break;
      }

275 276
      // If anyone has requested we stop, return the requested result.
      if ($this->migration->getStatus() == MigrationInterface::STATUS_STOPPING) {
277 278
        $return = $this->migration->getInterruptionResult();
        $this->migration->clearInterruptionResult();
279 280 281
        break;
      }

282 283 284 285 286
      try {
        $source->next();
      }
      catch (\Exception $e) {
        $this->message->display(
287 288
          $this->t('Migration failed with source plugin exception: @e',
            array('@e' => $e->getMessage())), 'error');
289
        $this->migration->setStatus(MigrationInterface::STATUS_IDLE);
290 291 292 293
        return MigrationInterface::RESULT_FAILED;
      }
    }

294
    $this->getEventDispatcher()->dispatch(MigrateEvents::POST_IMPORT, new MigrateImportEvent($this->migration, $this->message));
295
    $this->migration->setStatus(MigrationInterface::STATUS_IDLE);
296 297 298
    return $return;
  }

299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
  /**
   * {@inheritdoc}
   */
  public function rollback() {
    // Only begin the rollback operation if the migration is currently idle.
    if ($this->migration->getStatus() !== MigrationInterface::STATUS_IDLE) {
      $this->message->display($this->t('Migration @id is busy with another operation: @status', ['@id' => $this->migration->id(), '@status' => $this->t($this->migration->getStatusLabel())]), 'error');
      return MigrationInterface::RESULT_FAILED;
    }

    // Announce that rollback is about to happen.
    $this->getEventDispatcher()->dispatch(MigrateEvents::PRE_ROLLBACK, new MigrateRollbackEvent($this->migration));

    // Optimistically assume things are going to work out; if not, $return will be
    // updated to some other status.
    $return = MigrationInterface::RESULT_COMPLETED;

    $this->migration->setStatus(MigrationInterface::STATUS_ROLLING_BACK);
    $id_map = $this->migration->getIdMap();
    $destination = $this->migration->getDestinationPlugin();

    // Loop through each row in the map, and try to roll it back.
321
    foreach ($id_map as $map_row) {
322 323
      $destination_key = $id_map->currentDestination();
      if ($destination_key) {
324 325 326 327 328 329 330 331
        $map_row = $id_map->getRowByDestination($destination_key);
        if ($map_row['rollback_action'] == MigrateIdMapInterface::ROLLBACK_DELETE) {
          $this->getEventDispatcher()
            ->dispatch(MigrateEvents::PRE_ROW_DELETE, new MigrateRowDeleteEvent($this->migration, $destination_key));
          $destination->rollback($destination_key);
          $this->getEventDispatcher()
            ->dispatch(MigrateEvents::POST_ROW_DELETE, new MigrateRowDeleteEvent($this->migration, $destination_key));
        }
332
        // We're now done with this row, so remove it from the map.
333
        $id_map->deleteDestination($destination_key);
334
      }
335 336 337 338 339 340
      else {
        // If there is no destination key the import probably failed and we can
        // remove the row without further action.
        $source_key = $id_map->currentSource();
        $id_map->delete($source_key);
      }
341 342 343 344 345 346 347 348

      // Check for memory exhaustion.
      if (($return = $this->checkStatus()) != MigrationInterface::RESULT_COMPLETED) {
        break;
      }

      // If anyone has requested we stop, return the requested result.
      if ($this->migration->getStatus() == MigrationInterface::STATUS_STOPPING) {
349 350
        $return = $this->migration->getInterruptionResult();
        $this->migration->clearInterruptionResult();
351 352 353 354 355 356 357 358 359 360 361
        break;
      }
    }

    // Notify modules that rollback attempt was complete.
    $this->getEventDispatcher()->dispatch(MigrateEvents::POST_ROLLBACK, new MigrateRollbackEvent($this->migration));
    $this->migration->setStatus(MigrationInterface::STATUS_IDLE);

    return $return;
  }

362
  /**
363
   * {@inheritdoc}
364 365 366
   */
  public function processRow(Row $row, array $process = NULL, $value = NULL) {
    foreach ($this->migration->getProcessPlugins($process) as $destination => $plugins) {
367
      $multiple = FALSE;
368
      /** @var $plugin \Drupal\migrate\Plugin\MigrateProcessInterface */
369
      foreach ($plugins as $plugin) {
370 371 372 373 374 375 376 377 378 379
        $definition = $plugin->getPluginDefinition();
        // Many plugins expect a scalar value but the current value of the
        // pipeline might be multiple scalars (this is set by the previous
        // plugin) and in this case the current value needs to be iterated
        // and each scalar separately transformed.
        if ($multiple && !$definition['handle_multiples']) {
          $new_value = array();
          if (!is_array($value)) {
            throw new MigrateException(sprintf('Pipeline failed for destination %s: %s got instead of an array,', $destination, $value));
          }
380
          $break = FALSE;
381
          foreach ($value as $scalar_value) {
382 383 384 385
            try {
              $new_value[] = $plugin->transform($scalar_value, $this, $row, $destination);
            }
            catch (MigrateSkipProcessException $e) {
386
              $new_value[] = NULL;
387 388
              $break = TRUE;
            }
389 390
          }
          $value = $new_value;
391 392 393
          if ($break) {
            break;
          }
394 395
        }
        else {
396 397 398 399
          try {
            $value = $plugin->transform($value, $this, $row, $destination);
          }
          catch (MigrateSkipProcessException $e) {
400
            $value = NULL;
401 402
            break;
          }
403 404
          $multiple = $multiple || $plugin->multiple();
        }
405
      }
406 407
      // No plugins or no value means do not set.
      if ($plugins && !is_null($value)) {
408 409
        $row->setDestinationProperty($destination, $value);
      }
410 411 412 413 414 415
      // Reset the value.
      $value = NULL;
    }
  }

  /**
416
   * Fetches the key array for the current source record.
417 418
   *
   * @return array
419
   *   The current source IDs.
420 421 422 423 424 425
   */
  protected function currentSourceIds() {
    return $this->getSource()->getCurrentIds();
  }

  /**
426
   * {@inheritdoc}
427 428 429 430 431
   */
  public function saveMessage($message, $level = MigrationInterface::MESSAGE_ERROR) {
    $this->migration->getIdMap()->saveMessage($this->sourceIdValues, $message, $level);
  }

432 433 434 435
  /**
   * Takes an Exception object and both saves and displays it.
   *
   * Pulls in additional information on the location triggering the exception.
436 437
   *
   * @param \Exception $exception
438 439 440 441
   *   Object representing the exception.
   * @param bool $save
   *   (optional) Whether to save the message in the migration's mapping table.
   *   Set to FALSE in contexts where this doesn't make sense.
442
   */
443
  protected function handleException(\Exception $exception, $save = TRUE) {
444
    $result = Error::decodeException($exception);
445
    $message = $result['@message'] . ' (' . $result['%file'] . ':' . $result['%line'] . ')';
446 447 448
    if ($save) {
      $this->saveMessage($message);
    }
449
    $this->message->display($message, 'error');
450 451
  }

452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
  /**
   * Checks for exceptional conditions, and display feedback.
   */
  protected function checkStatus() {
    if ($this->memoryExceeded()) {
      return MigrationInterface::RESULT_INCOMPLETE;
    }
    return MigrationInterface::RESULT_COMPLETED;
  }

  /**
   * Tests whether we've exceeded the desired memory threshold.
   *
   * If so, output a message.
   *
   * @return bool
   *   TRUE if the threshold is exceeded, otherwise FALSE.
   */
  protected function memoryExceeded() {
    $usage = $this->getMemoryUsage();
    $pct_memory = $usage / $this->memoryLimit;
    if (!$threshold = $this->memoryThreshold) {
      return FALSE;
    }
    if ($pct_memory > $threshold) {
      $this->message->display(
478 479 480 481 482 483 484 485 486 487
        $this->t(
          'Memory usage is @usage (@pct% of limit @limit), reclaiming memory.',
          array(
            '@pct' => round($pct_memory * 100),
            '@usage' => $this->formatSize($usage),
            '@limit' => $this->formatSize($this->memoryLimit),
          )
        ),
        'warning'
      );
488 489 490 491 492 493
      $usage = $this->attemptMemoryReclaim();
      $pct_memory = $usage / $this->memoryLimit;
      // Use a lower threshold - we don't want to be in a situation where we keep
      // coming back here and trimming a tiny amount
      if ($pct_memory > (0.90 * $threshold)) {
        $this->message->display(
494 495 496 497 498 499 500 501 502 503
          $this->t(
            'Memory usage is now @usage (@pct% of limit @limit), not enough reclaimed, starting new batch',
            array(
              '@pct' => round($pct_memory * 100),
              '@usage' => $this->formatSize($usage),
              '@limit' => $this->formatSize($this->memoryLimit),
            )
          ),
          'warning'
        );
504 505 506 507
        return TRUE;
      }
      else {
        $this->message->display(
508 509 510 511 512 513 514 515
          $this->t(
            'Memory usage is now @usage (@pct% of limit @limit), reclaimed enough, continuing',
            array(
              '@pct' => round($pct_memory * 100),
              '@usage' => $this->formatSize($usage),
              '@limit' => $this->formatSize($this->memoryLimit),
            )
          ),
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
          'warning');
        return FALSE;
      }
    }
    else {
      return FALSE;
    }
  }

  /**
   * Returns the memory usage so far.
   *
   * @return int
   *   The memory usage.
   */
  protected function getMemoryUsage() {
    return memory_get_usage();
  }

  /**
   * Tries to reclaim memory.
   *
   * @return int
   *   The memory usage after reclaim.
   */
  protected function attemptMemoryReclaim() {
    // First, try resetting Drupal's static storage - this frequently releases
    // plenty of memory to continue.
    drupal_static_reset();
545 546

    // Entity storage can blow up with caches so clear them out.
547
    $manager = \Drupal::entityManager();
548 549 550 551
    foreach ($manager->getDefinitions() as $id => $definition) {
      $manager->getStorage($id)->resetCache();
    }

552
    // @TODO: explore resetting the container.
553

554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
    return memory_get_usage();
  }

  /**
   * Generates a string representation for the given byte count.
   *
   * @param int $size
   *   A size in bytes.
   *
   * @return string
   *   A translated string representation of the size.
   */
  protected function formatSize($size) {
    return format_size($size);
  }

570
}