From 2a1f208f87fea3092cb9f4208e5f946f12238f3c Mon Sep 17 00:00:00 2001
From: Mike Ryan <mikeryan@virtuoso-performance.com>
Date: Fri, 5 Aug 2016 16:00:56 -0500
Subject: [PATCH] Issue #2635622 by mikeryan: Add file_copy process plugin
---
src/Plugin/migrate/process/FileCopy.php | 207 ++++++++++++++++++++++++
1 file changed, 207 insertions(+)
create mode 100644 src/Plugin/migrate/process/FileCopy.php
diff --git a/src/Plugin/migrate/process/FileCopy.php b/src/Plugin/migrate/process/FileCopy.php
new file mode 100644
index 00000000..92f1dda0
--- /dev/null
+++ b/src/Plugin/migrate/process/FileCopy.php
@@ -0,0 +1,207 @@
+<?php
+
+namespace Drupal\migrate_plus\Plugin\migrate\process;
+
+use Drupal\Core\File\FileSystemInterface;
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\Core\StreamWrapper\LocalStream;
+use Drupal\Core\StreamWrapper\StreamWrapperManagerInterface;
+use Drupal\migrate\MigrateExecutableInterface;
+use Drupal\migrate\MigrateSkipProcessException;
+use Drupal\migrate\ProcessPluginBase;
+use Drupal\migrate\Row;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Copy a file from one place into another.
+ *
+ * @MigrateProcessPlugin(
+ * id = "file_copy"
+ * )
+ */
+class FileCopy extends ProcessPluginBase implements ContainerFactoryPluginInterface {
+
+ /**
+ * The stream wrapper manager service.
+ *
+ * @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface
+ */
+ protected $streamWrapperManager;
+
+ /**
+ * The file system service.
+ *
+ * @var \Drupal\Core\File\FileSystemInterface
+ */
+ protected $fileSystem;
+
+ /**
+ * Constructs a file_copy process plugin.
+ *
+ * @param array $configuration
+ * The plugin configuration.
+ * @param string $plugin_id
+ * The plugin ID.
+ * @param mixed $plugin_definition
+ * The plugin definition.
+ * @param \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrappers
+ * The stream wrapper manager service.
+ * @param \Drupal\Core\File\FileSystemInterface $file_system
+ * The file system service.
+ */
+ public function __construct(array $configuration, $plugin_id, array $plugin_definition, StreamWrapperManagerInterface $stream_wrappers, FileSystemInterface $file_system) {
+ $configuration += array(
+ 'move' => FALSE,
+ 'rename' => FALSE,
+ );
+ parent::__construct($configuration, $plugin_id, $plugin_definition);
+ $this->streamWrapperManager = $stream_wrappers;
+ $this->fileSystem = $file_system;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+ return new static(
+ $configuration,
+ $plugin_id,
+ $plugin_definition,
+ $container->get('stream_wrapper_manager'),
+ $container->get('file_system')
+ );
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
+ // If we're stubbing a file entity, return a uri of NULL so it will get
+ // stubbed by the general process.
+ if ($row->isStub()) {
+ return NULL;
+ }
+ list($source, $destination) = $value;
+
+ // Ensure the source file exists, if it's a local URI or path.
+ if ($this->isLocalUri($source) && !file_exists($source)) {
+ throw new MigrateSkipProcessException("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 $destination;
+ }
+
+ $replace = $this->getOverwriteMode();
+ // We attempt the copy first to avoid calling file_prepare_directory() any
+ // more than absolutely necessary.
+ if ($this->writeFile($source, $destination, $replace)) {
+ return $destination;
+ }
+ $dir = $this->getDirectory($destination);
+ if (!file_prepare_directory($dir, FILE_CREATE_DIRECTORY)) {
+ throw new MigrateSkipProcessException("Could not create directory '$dir'");
+ }
+ if ($this->writeFile($source, $destination, $replace)) {
+ return $destination;
+ }
+ throw new MigrateSkipProcessException("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 int $replace
+ * (optional) 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 (boolean) file_unmanaged_move($source, $destination, $replace);
+ }
+ $destination = file_destination($destination, $replace);
+ return @copy($source, $destination);
+ }
+
+ /**
+ * Determines how to handle file conflicts.
+ *
+ * @return int
+ * Either FILE_EXISTS_REPLACE (default) or FILE_EXISTS_RENAME, depending
+ * on the current configuration.
+ */
+ protected function getOverwriteMode() {
+ if (!empty($this->configuration['rename'])) {
+ 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);
+ }
+ return $dir;
+ }
+
+ /**
+ * Determines 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);
+ }
+ return FALSE;
+ }
+
+ /**
+ * Determines 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;
+ }
+
+}
--
GitLab