Added ability to set resolution strategy for copy and move conflicts.

thephpleague · Oct 19, 2023 · 8e5ac91 · 8e5ac91
1 parent 01e7c17
commit 8e5ac91
Show file tree

Hide file tree

Showing 6 changed files with 94 additions and 13 deletions.
diff --git a/src/Config.php b/src/Config.php
@@ -8,6 +8,8 @@
 
 class Config
 {
+    public const OPTION_COPY_DESTINATION_SAME_AS_SOURCE = 'copy_destination_same_as_source';
+    public const OPTION_MOVE_DESTINATION_SAME_AS_SOURCE = 'move_destination_same_as_source';
     public const OPTION_VISIBILITY = 'visibility';
     public const OPTION_DIRECTORY_VISIBILITY = 'directory_visibility';
 

diff --git a/src/Filesystem.php b/src/Filesystem.php
@@ -123,9 +123,17 @@ public function move(string $source, string $destination, array $config = []): v
         $to = $this->pathNormalizer->normalizePath($destination);
 
         if ($from === $to) {
-            throw UnableToMoveFile::sourceAndDestinationAreTheSame($source, $destination);
-        }
+            $resolutionStrategy = $this->config->get(
+                Config::OPTION_MOVE_DESTINATION_SAME_AS_SOURCE,
+                ResolveSameSourceAndDestinationConflict::TRY,
+            );
 
+            if ($resolutionStrategy === ResolveSameSourceAndDestinationConflict::FAIL) {
+                throw UnableToMoveFile::sourceAndDestinationAreTheSame($source, $destination);
+            } elseif ($resolutionStrategy === ResolveSameSourceAndDestinationConflict::IGNORE) {
+                return;
+            }
+        }
         $this->adapter->move($from, $to, $this->config->extend($config));
     }
 
@@ -135,7 +143,16 @@ public function copy(string $source, string $destination, array $config = []): v
         $to = $this->pathNormalizer->normalizePath($destination);
 
         if ($from === $to) {
-            throw UnableToCopyFile::sourceAndDestinationAreTheSame($source, $destination);
+            $resolutionStrategy = $this->config->get(
+                Config::OPTION_COPY_DESTINATION_SAME_AS_SOURCE,
+                ResolveSameSourceAndDestinationConflict::TRY,
+            );
+
+            if ($resolutionStrategy === ResolveSameSourceAndDestinationConflict::FAIL) {
+                throw UnableToCopyFile::sourceAndDestinationAreTheSame($source, $destination);
+            } elseif ($resolutionStrategy === ResolveSameSourceAndDestinationConflict::IGNORE) {
+                return;
+            }
         }
 
         $this->adapter->copy($from, $to, $this->config->extend($config));

diff --git a/src/FilesystemTest.php b/src/FilesystemTest.php
@@ -485,19 +485,19 @@ public function publicUrl(string $path, Config $config): string
      */
     public function copying_from_and_to_the_same_location_fails(): void
     {
-        $this->expectExceptionObject(UnableToMoveFile::sourceAndDestinationAreTheSame('from.txt', 'from.txt'));
+        $this->expectExceptionObject(UnableToCopyFile::fromLocationTo('from.txt', 'from.txt'));
 
-        $this->filesystem->move('from.txt', 'from.txt');
+        $this->filesystem->copy('from.txt', 'from.txt');
     }
 
     /**
      * @test
      */
     public function moving_from_and_to_the_same_location_fails(): void
     {
-        $this->expectExceptionObject(UnableToCopyFile::sourceAndDestinationAreTheSame('from.txt', 'from.txt'));
+        $this->expectExceptionObject(UnableToMoveFile::fromLocationTo('from.txt', 'from.txt'));
 
-        $this->filesystem->copy('from.txt', 'from.txt');
+        $this->filesystem->move('from.txt', 'from.txt');
     }
 
     /**
@@ -611,6 +611,57 @@ public function not_being_able_to_generate_temporary_urls(): void
         $filesystem->temporaryUrl('some/file.txt', new DateTimeImmutable());
     }
 
+    /**
+     * @test
+     */
+    public function ignoring_same_paths_for_move_and_copy(): void
+    {
+        $this->expectNotToPerformAssertions();
+
+        $filesystem = new Filesystem(
+            new InMemoryFilesystemAdapter(),
+            [
+                Config::OPTION_COPY_DESTINATION_SAME_AS_SOURCE => ResolveSameSourceAndDestinationConflict::IGNORE,
+                Config::OPTION_MOVE_DESTINATION_SAME_AS_SOURCE => ResolveSameSourceAndDestinationConflict::IGNORE,
+            ]
+        );
+
+        $filesystem->move('from.txt', 'from.txt');
+        $filesystem->copy('from.txt', 'from.txt');
+    }
+
+    /**
+     * @test
+     */
+    public function failing_same_paths_for_move(): void
+    {
+        $filesystem = new Filesystem(
+            new InMemoryFilesystemAdapter(),
+            [
+                Config::OPTION_MOVE_DESTINATION_SAME_AS_SOURCE => ResolveSameSourceAndDestinationConflict::FAIL,
+            ]
+        );
+
+        $this->expectExceptionObject(UnableToMoveFile::fromLocationTo('from.txt', 'from.txt'));
+        $filesystem->move('from.txt', 'from.txt');
+    }
+
+    /**
+     * @test
+     */
+    public function failing_same_paths_for_copy(): void
+    {
+        $filesystem = new Filesystem(
+            new InMemoryFilesystemAdapter(),
+            [
+                Config::OPTION_COPY_DESTINATION_SAME_AS_SOURCE => ResolveSameSourceAndDestinationConflict::FAIL,
+            ]
+        );
+
+        $this->expectExceptionObject(UnableToCopyFile::fromLocationTo('from.txt', 'from.txt'));
+        $filesystem->copy('from.txt', 'from.txt');
+    }
+
     /**
      * @test
      */

diff --git a/src/InMemory/InMemoryFilesystemAdapter.php b/src/InMemory/InMemoryFilesystemAdapter.php
@@ -221,15 +221,15 @@ public function listContents(string $path, bool $deep): iterable
 
     public function move(string $source, string $destination, Config $config): void
     {
-        $source = $this->preparePath($source);
-        $destination = $this->preparePath($destination);
+        $sourcePath = $this->preparePath($source);
+        $destinationPath = $this->preparePath($destination);
 
         if ( ! $this->fileExists($source) || $this->fileExists($destination)) {
             throw UnableToMoveFile::fromLocationTo($source, $destination);
         }
 
-        $this->files[$destination] = $this->files[$source];
-        unset($this->files[$source]);
+        $this->files[$destinationPath] = $this->files[$sourcePath];
+        unset($this->files[$sourcePath]);
     }
 
     public function copy(string $source, string $destination, Config $config): void

diff --git a/src/Local/LocalFilesystemAdapter.php b/src/Local/LocalFilesystemAdapter.php
@@ -248,7 +248,7 @@ public function move(string $source, string $destination, Config $config): void
         );
 
         if ( ! @rename($sourcePath, $destinationPath)) {
-            throw UnableToMoveFile::fromLocationTo($sourcePath, $destinationPath);
+            throw UnableToMoveFile::because(error_get_last()['message'] ?? 'unknown reason', $source, $destination);
         }
     }
 
@@ -263,7 +263,7 @@ public function copy(string $source, string $destination, Config $config): void
         );
 
         if ( ! @copy($sourcePath, $destinationPath)) {
-            throw UnableToCopyFile::fromLocationTo($sourcePath, $destinationPath);
+            throw UnableToCopyFile::because(error_get_last()['message'] ?? 'unknown', $source, $destination);
         }
     }
 

diff --git a/src/ResolveSameSourceAndDestinationConflict.php b/src/ResolveSameSourceAndDestinationConflict.php
@@ -0,0 +1,11 @@
+<?php
+declare(strict_types=1);
+
+namespace League\Flysystem;
+
+class ResolveSameSourceAndDestinationConflict
+{
+    public const IGNORE = 'ignore';
+    public const FAIL = 'fail';
+    public const TRY = 'try';
+}