PHPLIB-1324 Implement rename using stream wrapper

Rename all the revisions as defined in the spec

https://github.com/mongodb/specifications/blob/0b47194538aa817978fae0f77f684f6d5e62ebab/source/gridfs/gridfs-spec.rst#renaming-stored-files

Author: GromNaN

docs/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt

@@ -48,6 +48,7 @@ Supported stream functions:
 - :php:`filesize() <filesize>`
 - :php:`file() <file>`
 - :php:`fopen() <fopen>` (with "r", "rb", "w", and "wb" modes)
+- :php:`rename() <rename>`
 
 In read mode, the stream context can contain the option ``gridfs['revision']``
 to specify the revision number of the file to read. If omitted, the most recent

phpcs.xml.dist

@@ -162,4 +162,11 @@
     <rule ref="PSR1.Classes.ClassDeclaration.MissingNamespace">
         <exclude-pattern>/docs/examples/codecs/</exclude-pattern>
     </rule>
+
+    <!-- **************************************** -->
+    <!-- Exclude certain rules for stream wrapper -->
+    <!-- **************************************** -->
+    <rule ref="Squiz.NamingConventions.ValidVariableName.NotCamelCaps">
+        <exclude-pattern>/src/GridFS/StreamWrapper.php</exclude-pattern>
+    </rule>
 </ruleset>

src/GridFS/Exception/LogicException.php

@@ -67,4 +67,9 @@ public static function openModeNotSupported(string $mode): self
     {
         return new self(sprintf('Mode "%s" is not supported by "gridfs://" files. Use one of "r", "rb", "w", or "wb".', $mode));
     }
+
+    public static function renamePathMismatch(string $from, string $to): self
+    {
+        return new self(sprintf('Cannot rename "%s" to "%s" because they are not in the same GridFS bucket.', $from, $to));
+    }
 }

src/GridFS/ReadableStream.php

@@ -19,6 +19,7 @@
 
 use Iterator;
 use MongoDB\BSON\Binary;
+use MongoDB\BSON\Document;
 use MongoDB\Driver\CursorInterface;
 use MongoDB\Exception\InvalidArgumentException;
 use MongoDB\GridFS\Exception\CorruptFileException;
@@ -176,6 +177,28 @@ public function readBytes(int $length): string
         return $data;
     }
 
+    /**
+     * Rename all revisions of the file.
+     *
+     * @return int The number of revisions renamed
+     */
+    public function rename(string $newFilename): int
+    {
+        /** @var Document[] $revisions */
+        $revisions = $this->collectionWrapper->findFiles(
+            ['filename' => $this->file->filename],
+            ['typeMap' => ['root' => 'bson'], 'projection' => ['_id' => 1]],
+        );
+        $count = 0;
+
+        foreach ($revisions as $revision) {
+            $this->collectionWrapper->updateFilenameForId($revision->get('_id'), $newFilename);
+            $count++;
+        }
+
+        return $count;
+    }
+
     /**
      * Seeks the chunk and buffer offsets for the next read operation.
      *

src/GridFS/StreamWrapper.php

@@ -22,12 +22,15 @@
 use MongoDB\GridFS\Exception\FileNotFoundException;
 use MongoDB\GridFS\Exception\LogicException;
 
+use function array_slice;
 use function assert;
 use function explode;
+use function implode;
 use function in_array;
 use function is_array;
 use function is_integer;
 use function is_resource;
+use function str_starts_with;
 use function stream_context_get_options;
 use function stream_get_wrappers;
 use function stream_wrapper_register;
@@ -90,6 +93,30 @@ public static function register(string $protocol = 'gridfs'): void
         stream_wrapper_register($protocol, static::class, STREAM_IS_URL);
     }
 
+    /**
+     * Rename all revisions of a filename.
+     *
+     * @return int Number of revisions updated
+     */
+    public function rename(string $path_from, string $path_to): int
+    {
+        $prefix = implode('/', array_slice(explode('/', $path_from, 4), 0, 3)) . '/';
+        if (! str_starts_with($path_to, $prefix)) {
+            throw LogicException::renamePathMismatch($path_from, $path_to);
+        }
+
+        try {
+            $this->stream_open($path_from, 'r', 0, $openedPath);
+        } catch (FileNotFoundException $e) {
+            return false;
+        }
+
+        $newName = explode('/', $path_to, 4)[3] ?? '';
+        assert($this->stream instanceof ReadableStream);
+
+        return $this->stream->rename($newName) > 0;
+    }
+
     /**
      * @see Bucket::resolveStreamContext()
      *

tests/GridFS/StreamWrapperFunctionalTest.php

@@ -25,6 +25,7 @@
 use function is_dir;
 use function is_file;
 use function is_link;
+use function rename;
 use function stream_context_create;
 use function stream_get_contents;
 use function time;
@@ -363,4 +364,27 @@ public function testCopy(): void
         $this->assertSame('foobar', file_get_contents($path . '.copy'));
         $this->assertSame('foobar', file_get_contents($path));
     }
+
+    public function testRenameAllRevisions(): void
+    {
+        $this->bucket->registerGlobalStreamWrapperAlias('bucket');
+        $path = 'gridfs://bucket/filename';
+
+        $this->assertSame(6, file_put_contents($path, 'foobar'));
+        $this->assertSame(6, file_put_contents($path, 'foobar'));
+        $this->assertSame(6, file_put_contents($path, 'foobar'));
+
+        $this->assertTrue(rename($path, $path . '.renamed'));
+        $this->assertTrue(file_exists($path . '.renamed'));
+        $this->assertFalse(file_exists($path));
+        $this->assertSame('foobar', file_get_contents($path . '.renamed'));
+    }
+
+    public function testRenamePathMismatch(): void
+    {
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage('Cannot rename "gridfs://bucket/filename" to "gridfs://other/other" because they are not in the same GridFS bucket.');
+
+        rename('gridfs://bucket/filename', 'gridfs://other/other');
+    }
 }