PHPLIB-1323 Implement unlink for GridFS stream wrapper

Author: GromNaN

docs/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt

@@ -49,6 +49,7 @@ Supported stream functions:
 - :php:`file() <file>`
 - :php:`fopen() <fopen>` with "r", "rb", "w", and "wb" modes
 - :php:`rename() <rename>` rename all revisions of a file in the same bucket
+- :php:`unlink() <unlink>` (remove all revisions of a file)
 
 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
@@ -86,6 +87,8 @@ Each call to these functions makes a request to the server.
 
    echo file_get_contents('gridfs://mybucket/hello.txt');
 
+   unlink('gridfs://mybucket/hello.txt');
+
 The output would then resemble:
 
 .. code-block:: none

src/GridFS/StreamWrapper.php

@@ -324,6 +324,19 @@ public function stream_write(string $data): int
         return $this->stream->writeBytes($data);
     }
 
+    public function unlink(string $path): bool
+    {
+        try {
+            $this->stream_open($path, 'w', 0, $openedPath);
+        } catch (FileNotFoundException $e) {
+            return false;
+        }
+
+        assert($this->stream instanceof WritableStream);
+
+        return $this->stream->delete() > 0;
+    }
+
     /** @return false|array */
     public function url_stat(string $path, int $flags)
     {

src/GridFS/WritableStream.php

@@ -19,6 +19,7 @@
 
 use HashContext;
 use MongoDB\BSON\Binary;
+use MongoDB\BSON\Document;
 use MongoDB\BSON\ObjectId;
 use MongoDB\BSON\UTCDateTime;
 use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException;
@@ -173,6 +174,33 @@ public function close(): void
         $this->isClosed = true;
     }
 
+    /**
+     * Delete all files and chunks associated with this stream filename.
+     *
+     * @return int The number of deleted files
+     */
+    public function delete(): int
+    {
+        /** @var Document[] $revisions */
+        $revisions = $this->collectionWrapper->findFiles(['filename' => $this->file['filename']], [
+            'codec' => null,
+            'typeMap' => ['root' => 'bson'],
+            'projection' => ['_id' => 1],
+        ]);
+
+        $count = 0;
+
+        foreach ($revisions as $file) {
+            $this->collectionWrapper->findFileById($file->get('_id'));
+            $this->collectionWrapper->deleteFileAndChunksById($file->get('_id'));
+            $count++;
+        }
+
+        $this->abort();
+
+        return $count;
+    }
+
     /**
      * Return the stream's file document.
      */

tests/GridFS/StreamWrapperFunctionalTest.php

@@ -29,6 +29,7 @@
 use function stream_context_create;
 use function stream_get_contents;
 use function time;
+use function unlink;
 use function usleep;
 
 use const SEEK_CUR;
@@ -387,4 +388,18 @@ public function testRenamePathMismatch(): void
 
         rename('gridfs://bucket/filename', 'gridfs://other/newname');
     }
+
+    public function testUnlinkAllRevisions(): void
+    {
+        $this->bucket->registerGlobalStreamWrapperAlias('bucket');
+        $path = 'gridfs://bucket/path/to/filename';
+
+        file_put_contents($path, 'version 0');
+        file_put_contents($path, 'version 1');
+
+        $result = unlink($path);
+
+        $this->assertTrue($result);
+        $this->assertFalse(file_exists($path));
+    }
 }