MigrateExecutable.php 17.9 KB
Newer Older
1 2 3 4 5 6 7 8 9
<?php

/**
 * @file
 * Contains \Drupal\migrate\MigrateExecutable.
 */

namespace Drupal\migrate;

10
use Drupal\Core\Utility\Error;
11
use Drupal\Core\StringTranslation\StringTranslationTrait;
12
use Drupal\migrate\Entity\MigrationInterface;
13 14 15 16
use Drupal\migrate\Event\MigrateEvents;
use Drupal\migrate\Event\MigrateImportEvent;
use Drupal\migrate\Event\MigratePostRowSaveEvent;
use Drupal\migrate\Event\MigratePreRowSaveEvent;
17 18
use Drupal\migrate\Event\MigrateRollbackEvent;
use Drupal\migrate\Event\MigrateRowDeleteEvent;
19
use Drupal\migrate\Exception\RequirementsException;
20
use Drupal\migrate\Plugin\MigrateIdMapInterface;
21
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
22 23 24 25

/**
 * Defines a migrate executable class.
 */
26
class MigrateExecutable implements MigrateExecutableInterface {
27
  use StringTranslationTrait;
28 29

  /**
30
   * The configuration of the migration to do.
31
   *
32
   * @var \Drupal\migrate\Entity\Migration
33 34 35 36 37 38 39 40 41 42 43
   */
  protected $migration;

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

46 47 48 49 50 51 52 53 54 55 56 57 58 59
  /**
   * 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;

60 61
  /**
   * The configuration values of the source.
62
   *
63
   * @var array
64
   */
65 66
  protected $sourceIdValues;

67
  /**
68
   * The rollback action to be saved for the current row.
69 70 71
   *
   * @var int
   */
72
  public $rollbackAction;
73 74

  /**
75
   * An array of counts. Initially used for cache hit/miss tracking.
76
   *
77 78
   * @var array
   */
79
  protected $counts = array();
80 81

  /**
82
   * The object currently being constructed.
83
   *
84
   * @var \stdClass
85
   */
86 87 88 89 90
  protected $destinationValues;

  /**
   * The source.
   *
91
   * @var \Drupal\migrate\Plugin\MigrateSourceInterface
92 93 94 95 96 97 98 99 100
   */
  protected $source;

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

102 103 104 105 106 107 108
  /**
   * The event dispatcher.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $eventDispatcher;

109
  /**
110 111 112 113 114 115
   * Constructs a MigrateExecutable and verifies and sets the memory limit.
   *
   * @param \Drupal\migrate\Entity\MigrationInterface $migration
   *   The migration to run.
   * @param \Drupal\migrate\MigrateMessageInterface $message
   *   The message to record.
116 117
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
   *   The event dispatcher.
118 119 120
   *
   * @throws \Drupal\migrate\MigrateException
   */
121
  public function __construct(MigrationInterface $migration, MigrateMessageInterface $message, EventDispatcherInterface $event_dispatcher = NULL) {
122 123 124
    $this->migration = $migration;
    $this->message = $message;
    $this->migration->getIdMap()->setMessage($message);
125
    $this->eventDispatcher = $event_dispatcher;
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
    // 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;
144 145
            $this->message->display($this->t('Invalid PHP memory_limit @limit, setting to unlimited.',
              array('@limit' => $limit)));
146 147 148 149
        }
      }
      $this->memoryLimit = $limit;
    }
150 151 152
  }

  /**
153 154 155 156
   * Returns the source.
   *
   * Makes sure source is initialized based on migration settings.
   *
157
   * @return \Drupal\migrate\Plugin\MigrateSourceInterface
158
   *   The source.
159
   */
160
  protected function getSource() {
161
    if (!isset($this->source)) {
162
      $this->source = $this->migration->getSourcePlugin();
163 164 165 166
    }
    return $this->source;
  }

167 168 169 170 171 172 173 174 175 176 177 178
  /**
   * Gets the event dispatcher.
   *
   * @return \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected function getEventDispatcher() {
    if (!$this->eventDispatcher) {
      $this->eventDispatcher = \Drupal::service('event_dispatcher');
    }
    return $this->eventDispatcher;
  }

179
  /**
180
   * {@inheritdoc}
181 182
   */
  public function import() {
183 184 185 186 187 188 189 190 191
    // 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;
    }
192 193
    $this->getEventDispatcher()->dispatch(MigrateEvents::PRE_IMPORT, new MigrateImportEvent($this->migration));

194
    // Knock off migration if the requirements haven't been met.
195 196 197 198
    try {
      $this->migration->checkRequirements();
    }
    catch (RequirementsException $e) {
199
      $this->message->display(
200 201 202 203 204
        $this->t('Migration @id did not meet the requirements. @message @requirements', array(
          '@id' => $this->migration->id(),
          '@message' => $e->getMessage(),
          '@requirements' => $e->getRequirementsString(),
        )), 'error');
205 206
      return MigrationInterface::RESULT_FAILED;
    }
207

208
    $this->migration->setStatus(MigrationInterface::STATUS_IMPORTING);
209 210 211 212 213 214 215 216 217
    $return = MigrationInterface::RESULT_COMPLETED;
    $source = $this->getSource();
    $id_map = $this->migration->getIdMap();

    try {
      $source->rewind();
    }
    catch (\Exception $e) {
      $this->message->display(
218
        $this->t('Migration failed with source plugin exception: @e', array('@e' => $e->getMessage())), 'error');
219
      $this->migration->setStatus(MigrationInterface::STATUS_IDLE);
220 221
      return MigrationInterface::RESULT_FAILED;
    }
222

223
    $destination = $this->migration->getDestinationPlugin();
224 225
    while ($source->valid()) {
      $row = $source->current();
226
      $this->sourceIdValues = $row->getSourceIdValues();
227 228

      try {
229 230
        $this->processRow($row);
        $save = TRUE;
231
      }
232 233 234 235 236
      catch (MigrateException $e) {
        $this->migration->getIdMap()->saveIdMapping($row, array(), $e->getStatus(), $this->rollbackAction);
        $this->saveMessage($e->getMessage(), $e->getLevel());
        $save = FALSE;
      }
237 238 239
      catch (MigrateSkipRowException $e) {
        $id_map->saveIdMapping($row, array(), MigrateIdMapInterface::STATUS_IGNORED, $this->rollbackAction);
        $save = FALSE;
240
      }
241 242 243

      if ($save) {
        try {
244
          $this->getEventDispatcher()->dispatch(MigrateEvents::PRE_ROW_SAVE, new MigratePreRowSaveEvent($this->migration, $row));
245
          $destination_id_values = $destination->import($row, $id_map->lookupDestinationId($this->sourceIdValues));
246
          $this->getEventDispatcher()->dispatch(MigrateEvents::POST_ROW_SAVE, new MigratePostRowSaveEvent($this->migration, $row, $destination_id_values));
247
          if ($destination_id_values) {
248 249 250 251
            // We do not save an idMap entry for config.
            if ($destination_id_values !== TRUE) {
              $id_map->saveIdMapping($row, $destination_id_values, $this->sourceRowStatus, $this->rollbackAction);
            }
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
          }
          else {
            $id_map->saveIdMapping($row, array(), MigrateIdMapInterface::STATUS_FAILED, $this->rollbackAction);
            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) {
          $this->migration->getIdMap()->saveIdMapping($row, array(), $e->getStatus(), $this->rollbackAction);
          $this->saveMessage($e->getMessage(), $e->getLevel());
        }
        catch (\Exception $e) {
          $this->migration->getIdMap()->saveIdMapping($row, array(), MigrateIdMapInterface::STATUS_FAILED, $this->rollbackAction);
          $this->handleException($e);
        }
270
      }
271 272
      if ($high_water_property = $this->migration->get('highWaterProperty')) {
        $this->migration->saveHighWater($row->getSourceProperty($high_water_property['name']));
273 274 275 276
      }

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

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

284 285 286 287 288 289
      // If anyone has requested we stop, return the requested result.
      if ($this->migration->getStatus() == MigrationInterface::STATUS_STOPPING) {
        $return = $this->migration->getMigrationResult();
        break;
      }

290 291 292 293 294
      try {
        $source->next();
      }
      catch (\Exception $e) {
        $this->message->display(
295 296
          $this->t('Migration failed with source plugin exception: @e',
            array('@e' => $e->getMessage())), 'error');
297
        $this->migration->setStatus(MigrationInterface::STATUS_IDLE);
298 299 300 301
        return MigrationInterface::RESULT_FAILED;
      }
    }

302
    $this->migration->setMigrationResult($return);
303
    $this->getEventDispatcher()->dispatch(MigrateEvents::POST_IMPORT, new MigrateImportEvent($this->migration));
304
    $this->migration->setStatus(MigrationInterface::STATUS_IDLE);
305 306 307
    return $return;
  }

308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
  /**
   * {@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.
    foreach ($id_map as $serialized_key => $map_row) {
      $destination_key = $id_map->currentDestination();
      if ($destination_key) {
        $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));
        // We're now done with this row, so remove it from the map.
        $id_map->delete(unserialize($serialized_key));
      }

      // 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) {
        $return = $this->migration->getMigrationResult();
        break;
      }
    }
    // If rollback completed successfully, reset the high water mark.
    if ($return == MigrationInterface::RESULT_COMPLETED) {
      $this->migration->saveHighWater(NULL);
    }

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

    return $return;
  }

366
  /**
367
   * {@inheritdoc}
368 369 370
   */
  public function processRow(Row $row, array $process = NULL, $value = NULL) {
    foreach ($this->migration->getProcessPlugins($process) as $destination => $plugins) {
371
      $multiple = FALSE;
372
      /** @var $plugin \Drupal\migrate\Plugin\MigrateProcessInterface */
373
      foreach ($plugins as $plugin) {
374 375 376 377 378 379 380 381 382 383
        $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));
          }
384
          $break = FALSE;
385
          foreach ($value as $scalar_value) {
386 387 388 389 390 391
            try {
              $new_value[] = $plugin->transform($scalar_value, $this, $row, $destination);
            }
            catch (MigrateSkipProcessException $e) {
              $break = TRUE;
            }
392 393
          }
          $value = $new_value;
394 395 396
          if ($break) {
            break;
          }
397 398
        }
        else {
399 400 401 402 403 404
          try {
            $value = $plugin->transform($value, $this, $row, $destination);
          }
          catch (MigrateSkipProcessException $e) {
            break;
          }
405 406
          $multiple = $multiple || $plugin->multiple();
        }
407
      }
408 409 410 411
      // No plugins means do not set.
      if ($plugins) {
        $row->setDestinationProperty($destination, $value);
      }
412 413 414 415 416 417
      // Reset the value.
      $value = NULL;
    }
  }

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

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

434 435 436 437
  /**
   * Takes an Exception object and both saves and displays it.
   *
   * Pulls in additional information on the location triggering the exception.
438 439
   *
   * @param \Exception $exception
440 441 442 443
   *   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.
444
   */
445
  protected function handleException(\Exception $exception, $save = TRUE) {
446
    $result = Error::decodeException($exception);
447
    $message = $result['@message'] . ' (' . $result['%file'] . ':' . $result['%line'] . ')';
448 449 450
    if ($save) {
      $this->saveMessage($message);
    }
451
    $this->message->display($message, 'error');
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 478 479
  /**
   * 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(
480 481 482 483
        $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))),
484 485 486 487 488 489 490
        'warning');
      $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(
491 492 493 494
          $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))),
495 496 497 498 499
          'warning');
        return TRUE;
      }
      else {
        $this->message->display(
500 501 502 503
          $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))),
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
          '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();
533 534

    // Entity storage can blow up with caches so clear them out.
535
    $manager =  \Drupal::entityManager();
536 537 538 539
    foreach ($manager->getDefinitions() as $id => $definition) {
      $manager->getStorage($id)->resetCache();
    }

540
    // @TODO: explore resetting the container.
541

542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
    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);
  }

558
}