Merge pull request #1715 from thephpleague/feature/prevent-same-path-…

…copy-and-move Prevent copy and move to same destinations as the source.
thephpleague · Oct 20, 2023 · bb363f2 · bb363f2
2 parents e5608b5 + 532bb63
commit bb363f2
Show file tree

Hide file tree

Showing 8 changed files with 152 additions and 16 deletions.
diff --git a/src/Config.php b/src/Config.php
@@ -8,6 +8,8 @@
 
 class Config
 {
+    public const OPTION_COPY_IDENTICAL_PATH = 'copy_destination_same_as_source';
+    public const OPTION_MOVE_IDENTICAL_PATH = '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
@@ -119,20 +119,40 @@ private function pipeListing(string $location, bool $deep, iterable $listing): G
 
     public function move(string $source, string $destination, array $config = []): void
     {
-        $this->adapter->move(
-            $this->pathNormalizer->normalizePath($source),
-            $this->pathNormalizer->normalizePath($destination),
-            $this->config->extend($config)
-        );
+        $config = $this->config->extend($config);
+        $from = $this->pathNormalizer->normalizePath($source);
+        $to = $this->pathNormalizer->normalizePath($destination);
+
+        if ($from === $to) {
+            $resolutionStrategy = $config->get(Config::OPTION_MOVE_IDENTICAL_PATH, ResolveIdenticalPathConflict::TRY);
+
+            if ($resolutionStrategy === ResolveIdenticalPathConflict::FAIL) {
+                throw UnableToMoveFile::sourceAndDestinationAreTheSame($source, $destination);
+            } elseif ($resolutionStrategy === ResolveIdenticalPathConflict::IGNORE) {
+                return;
+            }
+        }
+
+        $this->adapter->move($from, $to, $config);
     }
 
     public function copy(string $source, string $destination, array $config = []): void
     {
-        $this->adapter->copy(
-            $this->pathNormalizer->normalizePath($source),
-            $this->pathNormalizer->normalizePath($destination),
-            $this->config->extend($config)
-        );
+        $config = $this->config->extend($config);
+        $from = $this->pathNormalizer->normalizePath($source);
+        $to = $this->pathNormalizer->normalizePath($destination);
+
+        if ($from === $to) {
+            $resolutionStrategy = $config->get(Config::OPTION_COPY_IDENTICAL_PATH, ResolveIdenticalPathConflict::TRY);
+
+            if ($resolutionStrategy === ResolveIdenticalPathConflict::FAIL) {
+                throw UnableToCopyFile::sourceAndDestinationAreTheSame($source, $destination);
+            } elseif ($resolutionStrategy === ResolveIdenticalPathConflict::IGNORE) {
+                return;
+            }
+        }
+
+        $this->adapter->copy($from, $to, $config);
     }
 
     public function lastModified(string $path): int

diff --git a/src/FilesystemTest.php b/src/FilesystemTest.php
@@ -480,6 +480,26 @@ public function publicUrl(string $path, Config $config): string
         self::assertSame('custom/file.txt', $filesystem->publicUrl('file.txt'));
     }
 
+    /**
+     * @test
+     */
+    public function copying_from_and_to_the_same_location_fails(): void
+    {
+        $this->expectExceptionObject(UnableToCopyFile::fromLocationTo('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(UnableToMoveFile::fromLocationTo('from.txt', 'from.txt'));
+
+        $this->filesystem->move('from.txt', 'from.txt');
+    }
+
     /**
      * @test
      */
@@ -591,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_IDENTICAL_PATH => ResolveIdenticalPathConflict::IGNORE,
+                Config::OPTION_MOVE_IDENTICAL_PATH => ResolveIdenticalPathConflict::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_IDENTICAL_PATH => ResolveIdenticalPathConflict::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_IDENTICAL_PATH => ResolveIdenticalPathConflict::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/ResolveIdenticalPathConflict.php b/src/ResolveIdenticalPathConflict.php
@@ -0,0 +1,11 @@
+<?php
+declare(strict_types=1);
+
+namespace League\Flysystem;
+
+class ResolveIdenticalPathConflict
+{
+    public const IGNORE = 'ignore';
+    public const FAIL = 'fail';
+    public const TRY = 'try';
+}
diff --git a/src/UnableToCopyFile.php b/src/UnableToCopyFile.php
@@ -41,6 +41,20 @@ public static function fromLocationTo(
         return $e;
     }
 
+    public static function sourceAndDestinationAreTheSame(string $source, string $destination): UnableToCopyFile
+    {
+        return UnableToCopyFile::because('Source and destination are the same', $source, $destination);
+    }
+
+    public static function because(string $reason, string $sourcePath, string $destinationPath): UnableToCopyFile
+    {
+        $e = new static("Unable to copy file from $sourcePath to $destinationPath, because $reason");
+        $e->source = $sourcePath;
+        $e->destination = $destinationPath;
+
+        return $e;
+    }
+
     public function operation(): string
     {
         return FilesystemOperationFailed::OPERATION_COPY;

diff --git a/src/UnableToMoveFile.php b/src/UnableToMoveFile.php
@@ -19,6 +19,11 @@ final class UnableToMoveFile extends RuntimeException implements FilesystemOpera
      */
     private $destination;
 
+    public static function sourceAndDestinationAreTheSame(string $source, string $destination): UnableToMoveFile
+    {
+        return UnableToMoveFile::because('Source and destination are the same', $source, $destination);
+    }
+
     public function source(): string
     {
         return $this->source;
@@ -42,6 +47,19 @@ public static function fromLocationTo(
         return $e;
     }
 
+    public static function because(
+        string $reason,
+        string $sourcePath,
+        string $destinationPath,
+    ): UnableToMoveFile {
+        $message = "Unable to move file from $sourcePath to $destinationPath, because $reason";
+        $e = new static($message);
+        $e->source = $sourcePath;
+        $e->destination = $destinationPath;
+
+        return $e;
+    }
+
     public function operation(): string
     {
         return FilesystemOperationFailed::OPERATION_MOVE;