MigrateExecutable.php 15.5 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
use Drupal\migrate\Exception\RequirementsException;
18
use Drupal\migrate\Plugin\MigrateIdMapInterface;
19
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
20 21 22 23

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

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

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

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

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

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

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

  /**
80 81 82
   * The maximum number of items to pass in a single call during a rollback.
   *
   * For use in bulkRollback(). Can be overridden in derived class constructor.
83
   *
84 85
   * @var int
   */
86
  protected $rollbackBatchSize = 50;
87 88

  /**
89
   * The object currently being constructed.
90
   *
91
   * @var \stdClass
92
   */
93 94 95 96 97
  protected $destinationValues;

  /**
   * The source.
   *
98
   * @var \Drupal\migrate\Plugin\MigrateSourceInterface
99 100 101 102 103 104 105 106 107
   */
  protected $source;

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

109 110 111 112 113 114 115
  /**
   * The event dispatcher.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $eventDispatcher;

116
  /**
117 118 119 120 121 122
   * 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.
123 124
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
   *   The event dispatcher.
125 126 127
   *
   * @throws \Drupal\migrate\MigrateException
   */
128
  public function __construct(MigrationInterface $migration, MigrateMessageInterface $message, EventDispatcherInterface $event_dispatcher = NULL) {
129 130 131
    $this->migration = $migration;
    $this->message = $message;
    $this->migration->getIdMap()->setMessage($message);
132
    $this->eventDispatcher = $event_dispatcher;
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
    // 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;
            $this->message->display($this->t('Invalid PHP memory_limit !limit, setting to unlimited.',
              array('!limit' => $limit)));
        }
      }
      $this->memoryLimit = $limit;
    }
157 158 159
  }

  /**
160 161 162 163
   * Returns the source.
   *
   * Makes sure source is initialized based on migration settings.
   *
164
   * @return \Drupal\migrate\Plugin\MigrateSourceInterface
165
   *   The source.
166
   */
167
  protected function getSource() {
168
    if (!isset($this->source)) {
169
      $this->source = $this->migration->getSourcePlugin();
170 171 172 173
    }
    return $this->source;
  }

174 175 176 177 178 179 180 181 182 183 184 185
  /**
   * Gets the event dispatcher.
   *
   * @return \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected function getEventDispatcher() {
    if (!$this->eventDispatcher) {
      $this->eventDispatcher = \Drupal::service('event_dispatcher');
    }
    return $this->eventDispatcher;
  }

186
  /**
187
   * {@inheritdoc}
188 189
   */
  public function import() {
190 191 192 193 194 195 196 197 198
    // 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;
    }
199 200
    $this->getEventDispatcher()->dispatch(MigrateEvents::PRE_IMPORT, new MigrateImportEvent($this->migration));

201
    // Knock off migration if the requirements haven't been met.
202 203 204 205
    try {
      $this->migration->checkRequirements();
    }
    catch (RequirementsException $e) {
206
      $this->message->display(
207 208 209 210 211
        $this->t('Migration @id did not meet the requirements. @message @requirements', array(
          '@id' => $this->migration->id(),
          '@message' => $e->getMessage(),
          '@requirements' => $e->getRequirementsString(),
        )), 'error');
212 213
      return MigrationInterface::RESULT_FAILED;
    }
214

215
    $this->migration->setStatus(MigrationInterface::STATUS_IMPORTING);
216 217 218 219 220 221 222 223 224
    $return = MigrationInterface::RESULT_COMPLETED;
    $source = $this->getSource();
    $id_map = $this->migration->getIdMap();

    try {
      $source->rewind();
    }
    catch (\Exception $e) {
      $this->message->display(
225
        $this->t('Migration failed with source plugin exception: !e', array('!e' => $e->getMessage())), 'error');
226
      $this->migration->setStatus(MigrationInterface::STATUS_IDLE);
227 228
      return MigrationInterface::RESULT_FAILED;
    }
229

230
    $destination = $this->migration->getDestinationPlugin();
231 232
    while ($source->valid()) {
      $row = $source->current();
233
      $this->sourceIdValues = $row->getSourceIdValues();
234 235

      try {
236 237
        $this->processRow($row);
        $save = TRUE;
238
      }
239 240 241 242 243
      catch (MigrateException $e) {
        $this->migration->getIdMap()->saveIdMapping($row, array(), $e->getStatus(), $this->rollbackAction);
        $this->saveMessage($e->getMessage(), $e->getLevel());
        $save = FALSE;
      }
244 245 246
      catch (MigrateSkipRowException $e) {
        $id_map->saveIdMapping($row, array(), MigrateIdMapInterface::STATUS_IGNORED, $this->rollbackAction);
        $save = FALSE;
247
      }
248 249 250

      if ($save) {
        try {
251
          $this->getEventDispatcher()->dispatch(MigrateEvents::PRE_ROW_SAVE, new MigratePreRowSaveEvent($this->migration, $row));
252
          $destination_id_values = $destination->import($row, $id_map->lookupDestinationId($this->sourceIdValues));
253
          $this->getEventDispatcher()->dispatch(MigrateEvents::POST_ROW_SAVE, new MigratePostRowSaveEvent($this->migration, $row, $destination_id_values));
254
          if ($destination_id_values) {
255 256 257 258
            // 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);
            }
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
          }
          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);
        }
277
      }
278 279
      if ($high_water_property = $this->migration->get('highWaterProperty')) {
        $this->migration->saveHighWater($row->getSourceProperty($high_water_property['name']));
280 281 282 283
      }

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

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

291 292 293 294 295 296
      // If anyone has requested we stop, return the requested result.
      if ($this->migration->getStatus() == MigrationInterface::STATUS_STOPPING) {
        $return = $this->migration->getMigrationResult();
        break;
      }

297 298 299 300 301 302
      try {
        $source->next();
      }
      catch (\Exception $e) {
        $this->message->display(
          $this->t('Migration failed with source plugin exception: !e',
303
            array('!e' => $e->getMessage())), 'error');
304
        $this->migration->setStatus(MigrationInterface::STATUS_IDLE);
305 306 307 308
        return MigrationInterface::RESULT_FAILED;
      }
    }

309
    $this->migration->setMigrationResult($return);
310
    $this->getEventDispatcher()->dispatch(MigrateEvents::POST_IMPORT, new MigrateImportEvent($this->migration));
311
    $this->migration->setStatus(MigrationInterface::STATUS_IDLE);
312 313 314 315
    return $return;
  }

  /**
316
   * {@inheritdoc}
317 318 319
   */
  public function processRow(Row $row, array $process = NULL, $value = NULL) {
    foreach ($this->migration->getProcessPlugins($process) as $destination => $plugins) {
320
      $multiple = FALSE;
321
      /** @var $plugin \Drupal\migrate\Plugin\MigrateProcessInterface */
322
      foreach ($plugins as $plugin) {
323 324 325 326 327 328 329 330 331 332
        $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));
          }
333
          $break = FALSE;
334
          foreach ($value as $scalar_value) {
335 336 337 338 339 340
            try {
              $new_value[] = $plugin->transform($scalar_value, $this, $row, $destination);
            }
            catch (MigrateSkipProcessException $e) {
              $break = TRUE;
            }
341 342
          }
          $value = $new_value;
343 344 345
          if ($break) {
            break;
          }
346 347
        }
        else {
348 349 350 351 352 353
          try {
            $value = $plugin->transform($value, $this, $row, $destination);
          }
          catch (MigrateSkipProcessException $e) {
            break;
          }
354 355
          $multiple = $multiple || $plugin->multiple();
        }
356
      }
357 358 359 360
      // No plugins means do not set.
      if ($plugins) {
        $row->setDestinationProperty($destination, $value);
      }
361 362 363 364 365 366
      // Reset the value.
      $value = NULL;
    }
  }

  /**
367
   * Fetches the key array for the current source record.
368 369
   *
   * @return array
370
   *   The current source IDs.
371 372 373 374 375 376
   */
  protected function currentSourceIds() {
    return $this->getSource()->getCurrentIds();
  }

  /**
377
   * {@inheritdoc}
378 379 380 381 382
   */
  public function saveMessage($message, $level = MigrationInterface::MESSAGE_ERROR) {
    $this->migration->getIdMap()->saveMessage($this->sourceIdValues, $message, $level);
  }

383 384 385 386
  /**
   * Takes an Exception object and both saves and displays it.
   *
   * Pulls in additional information on the location triggering the exception.
387 388
   *
   * @param \Exception $exception
389 390 391 392
   *   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.
393
   */
394
  protected function handleException(\Exception $exception, $save = TRUE) {
395
    $result = Error::decodeException($exception);
396
    $message = $result['@message'] . ' (' . $result['%file'] . ':' . $result['%line'] . ')';
397 398 399
    if ($save) {
      $this->saveMessage($message);
    }
400
    $this->message->display($message, 'error');
401 402
  }

403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
  /**
   * 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(
429 430 431 432
        $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))),
433 434 435 436 437 438 439
        '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(
440 441 442 443
          $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))),
444 445 446 447 448
          'warning');
        return TRUE;
      }
      else {
        $this->message->display(
449 450 451 452
          $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))),
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 480 481
          '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();
482 483

    // Entity storage can blow up with caches so clear them out.
484
    $manager =  \Drupal::entityManager();
485 486 487 488
    foreach ($manager->getDefinitions() as $id => $definition) {
      $manager->getStorage($id)->resetCache();
    }

489
    // @TODO: explore resetting the container.
490

491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
    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);
  }

507
}