You are here

Home » API reference » Zircon Profile 8 » EntityFile.php

class EntityFile in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/file/src/Plugin/migrate/destination/EntityFile.php \Drupal\file\Plugin\migrate\destination\EntityFile

Every migration that uses this destination must have an optional dependency on the d6_file migration to ensure it runs first.

Plugin annotation


@MigrateDestination(
  id = "entity:file"
)

Hierarchy

Expanded class hierarchy of EntityFile

1 file declares its use of EntityFile
EntityFileTest.php in core/modules/file/src/Tests/Migrate/EntityFileTest.php
Contains \Drupal\file\Tests\Migrate\EntityFileTest.

File

core/modules/file/src/Plugin/migrate/destination/EntityFile.php, line 32
Contains \Drupal\file\Plugin\migrate\destination\EntityFile.

Namespace

Drupal\file\Plugin\migrate\destination
View source 
class EntityFile extends EntityContentBase {

  /**
   * @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface
   */
  protected $streamWrapperManager;

  /**
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, EntityStorageInterface $storage, array $bundles, EntityManagerInterface $entity_manager, FieldTypePluginManagerInterface $field_type_manager, StreamWrapperManagerInterface $stream_wrappers, FileSystemInterface $file_system) {
    $configuration += array(
      'source_base_path' => '',
      'source_path_property' => 'filepath',
      'destination_path_property' => 'uri',
      'move' => FALSE,
      'urlencode' => FALSE,
    );
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration, $storage, $bundles, $entity_manager, $field_type_manager);
    $this->streamWrapperManager = $stream_wrappers;
    $this->fileSystem = $file_system;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
    $entity_type = static::getEntityTypeId($plugin_id);
    return new static($configuration, $plugin_id, $plugin_definition, $migration, $container
      ->get('entity.manager')
      ->getStorage($entity_type), array_keys($container
      ->get('entity.manager')
      ->getBundleInfo($entity_type)), $container
      ->get('entity.manager'), $container
      ->get('plugin.manager.field.field_type'), $container
      ->get('stream_wrapper_manager'), $container
      ->get('file_system'));
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntity(Row $row, array $old_destination_id_values) {

    // For stub rows, there is no real file to deal with, let the stubbing
    // process take its default path.
    if ($row
      ->isStub()) {
      return parent::getEntity($row, $old_destination_id_values);
    }
    $destination = $row
      ->getDestinationProperty($this->configuration['destination_path_property']);
    $entity = $this->storage
      ->loadByProperties([
      'uri' => $destination,
    ]);
    if ($entity) {
      return reset($entity);
    }
    else {
      return parent::getEntity($row, $old_destination_id_values);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function import(Row $row, array $old_destination_id_values = array()) {

    // For stub rows, there is no real file to deal with, let the stubbing
    // process create the stub entity.
    if ($row
      ->isStub()) {
      return parent::import($row, $old_destination_id_values);
    }
    $file = $row
      ->getSourceProperty($this->configuration['source_path_property']);
    $destination = $row
      ->getDestinationProperty($this->configuration['destination_path_property']);
    $source = $this->configuration['source_base_path'] . $file;

    // Ensure the source file exists, if it's a local URI or path.
    if ($this
      ->isLocalUri($source) && !file_exists($source)) {
      throw new MigrateException("File '{$source}' does not exist.");
    }

    // If the start and end file is exactly the same, there is nothing to do.
    if ($this
      ->isLocationUnchanged($source, $destination)) {
      return parent::import($row, $old_destination_id_values);
    }
    $replace = $this
      ->getOverwriteMode($row);
    $success = $this
      ->writeFile($source, $destination, $replace);
    if (!$success) {
      $dir = $this
        ->getDirectory($destination);
      if (file_prepare_directory($dir, FILE_CREATE_DIRECTORY)) {
        $success = $this
          ->writeFile($source, $destination, $replace);
      }
      else {
        throw new MigrateException("Could not create directory '{$dir}'");
      }
    }
    if ($success) {
      return parent::import($row, $old_destination_id_values);
    }
    else {
      throw new MigrateException("File {$source} could not be copied to {$destination}.");
    }
  }

  /**
   * Tries to move or copy a file.
   *
   * @param string $source
   *  The source path or URI.
   * @param string $destination
   *  The destination path or URI.
   * @param integer $replace
   *  FILE_EXISTS_REPLACE (default) or FILE_EXISTS_RENAME.
   *
   * @return bool
   *  TRUE on success, FALSE on failure.
   */
  protected function writeFile($source, $destination, $replace = FILE_EXISTS_REPLACE) {
    if ($this->configuration['move']) {
      return (bool) file_unmanaged_move($source, $destination, $replace);
    }
    else {
      $destination = file_destination($destination, $replace);
      $source = $this
        ->urlencode($source);
      return @copy($source, $destination);
    }
  }

  /**
   * Determines how to handle file conflicts.
   *
   * @param \Drupal\migrate\Row $row
   *
   * @return integer
   *  Either FILE_EXISTS_REPLACE (default) or FILE_EXISTS_RENAME, depending
   *  on the current configuration.
   */
  protected function getOverwriteMode(Row $row) {
    if (!empty($this->configuration['rename'])) {
      $entity_id = $row
        ->getDestinationProperty($this
        ->getKey('id'));
      if ($entity_id && ($entity = $this->storage
        ->load($entity_id))) {
        return FILE_EXISTS_RENAME;
      }
    }
    return FILE_EXISTS_REPLACE;
  }

  /**
   * Returns the directory component of a URI or path.
   *
   * For URIs like public://foo.txt, the full physical path of public://
   * will be returned, since a scheme by itself will trip up certain file
   * API functions (such as file_prepare_directory()).
   *
   * @param string $uri
   *  The URI or path.
   *
   * @return string|false
   *  The directory component of the path or URI, or FALSE if it could not
   *  be determined.
   */
  protected function getDirectory($uri) {
    $dir = $this->fileSystem
      ->dirname($uri);
    if (substr($dir, -3) == '://') {
      return $this->fileSystem
        ->realpath($dir);
    }
    else {
      return $dir;
    }
  }

  /**
   * Returns if the source and destination URIs represent identical paths.
   * If either URI is a remote stream, will return FALSE.
   *
   * @param string $source
   *  The source URI.
   * @param string $destination
   *  The destination URI.
   *
   * @return bool
   *  TRUE if the source and destination URIs refer to the same physical path,
   *  otherwise FALSE.
   */
  protected function isLocationUnchanged($source, $destination) {
    if ($this
      ->isLocalUri($source) && $this
      ->isLocalUri($destination)) {
      return $this->fileSystem
        ->realpath($source) === $this->fileSystem
        ->realpath($destination);
    }
    else {
      return FALSE;
    }
  }

  /**
   * Returns if the given URI or path is considered local.
   *
   * A URI or path is considered local if it either has no scheme component,
   * or the scheme is implemented by a stream wrapper which extends
   * \Drupal\Core\StreamWrapper\LocalStream.
   *
   * @param string $uri
   *  The URI or path to test.
   *
   * @return bool
   */
  protected function isLocalUri($uri) {
    $scheme = $this->fileSystem
      ->uriScheme($uri);
    return $scheme === FALSE || $this->streamWrapperManager
      ->getViaScheme($scheme) instanceof LocalStream;
  }

  /**
   * Urlencode all the components of a remote filename.
   *
   * @param string $filename
   *   The filename of the file to be urlencoded.
   *
   * @return string
   *   The urlencoded filename.
   */
  protected function urlencode($filename) {

    // Only apply to a full URL
    if ($this->configuration['urlencode'] && strpos($filename, '://')) {
      $components = explode('/', $filename);
      foreach ($components as $key => $component) {
        $components[$key] = rawurlencode($component);
      }
      $filename = implode('/', $components);

      // Actually, we don't want certain characters encoded
      $filename = str_replace('%3A', ':', $filename);
      $filename = str_replace('%3F', '?', $filename);
      $filename = str_replace('%26', '&', $filename);
    }
    return $filename;
  }

  /**
   * {@inheritdoc}
   */
  protected function processStubRow(Row $row) {

    // We stub the uri value ourselves so we can create a real stub file for it.
    if (!$row
      ->getDestinationProperty('uri')) {
      $field_definitions = $this->entityManager
        ->getFieldDefinitions($this->storage
        ->getEntityTypeId(), $this
        ->getKey('bundle'));
      $value = UriItem::generateSampleValue($field_definitions['uri']);
      if (empty($value)) {
        throw new MigrateException('Stubbing failed, unable to generate value for field uri');
      }

      // generateSampleValue() wraps the value in an array.
      $value = reset($value);

      // Make it into a proper public file uri, stripping off the existing
      // scheme if present.
      $value = 'public://' . preg_replace('|^[a-z]+://|i', '', $value);
      $value = Unicode::substr($value, 0, $field_definitions['uri']
        ->getSetting('max_length'));

      // Create a real file, so File::preSave() can do filesize() on it.
      touch($value);
      $row
        ->setDestinationProperty('uri', $value);
    }
    parent::processStubRow($row);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies. 1
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
DestinationBase::$migration protected property The migration.
DestinationBase::$rollbackAction protected property The rollback action to be saved for the last imported item.
DestinationBase::$supportsRollback protected property Indicates whether the destination can be rolled back.
DestinationBase::checkRequirements public function Checks if requirements for this plugin are OK. Overrides RequirementsInterface::checkRequirements
DestinationBase::rollbackAction public function The rollback action for the last imported item. Overrides MigrateDestinationInterface::rollbackAction
DestinationBase::setRollbackAction protected function For a destination item being updated, set the appropriate rollback action.
DestinationBase::supportsRollback public function Whether the destination can be rolled back or not. Overrides MigrateDestinationInterface::supportsRollback
Entity::$bundles protected property The list of the bundles of this entity type.
Entity::$storage protected property The entity storage. 1
Entity::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
Entity::fields public function Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
Entity::getEntityId protected function Get the entity id of the row. 2
Entity::getEntityTypeId protected static function Finds the entity type from configuration or plugin id. 3
Entity::getKey protected function Returns a specific entity key.
Entity::rollback public function Delete the specified destination object from the target Drupal. Overrides DestinationBase::rollback
EntityContentBase::$entityManager protected property Entity manager.
EntityContentBase::$fieldTypeManager protected property Field type plugin manager.
EntityContentBase::getIds public function Get the destination ids. Overrides MigrateDestinationInterface::getIds 1
EntityContentBase::save protected function Save the entity. 2
EntityContentBase::updateEntity protected function Update an entity with the new values from row. 2
EntityFile::$fileSystem protected property 1
EntityFile::$streamWrapperManager protected property 1
EntityFile::create public static function Creates an instance of the plugin. Overrides EntityContentBase::create
EntityFile::getDirectory protected function Returns the directory component of a URI or path.
EntityFile::getEntity protected function Creates or loads an entity. Overrides Entity::getEntity 1
EntityFile::getOverwriteMode protected function Determines how to handle file conflicts.
EntityFile::import public function Import the row. Overrides EntityContentBase::import
EntityFile::isLocalUri protected function Returns if the given URI or path is considered local.
EntityFile::isLocationUnchanged protected function Returns if the source and destination URIs represent identical paths. If either URI is a remote stream, will return FALSE.
EntityFile::processStubRow protected function Do as much population of the stub row as we can. Overrides EntityContentBase::processStubRow
EntityFile::urlencode protected function Urlencode all the components of a remote filename.
EntityFile::writeFile protected function Tries to move or copy a file.
EntityFile::__construct public function Constructs a content entity. Overrides EntityContentBase::__construct 1
PluginBase::$configuration protected property Configuration information passed into the plugin. 2
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.