PHPLIB-1206 Add default bucket for GridFS StreamWrapper

Author: GromNaN

src/GridFS/Bucket.php

@@ -631,6 +631,12 @@ public function uploadFromStream(string $filename, $source, array $options = [])
         return $this->getFileIdForStream($destination);
     }
 
+    /** @internal */
+    public function getCollectionWrapper(): CollectionWrapper
+    {
+        return $this->collectionWrapper;
+    }
+
     /**
      * Creates a path for an existing GridFS file.
      *

src/GridFS/StreamWrapper.php

@@ -18,12 +18,14 @@
 namespace MongoDB\GridFS;
 
 use MongoDB\BSON\UTCDateTime;
+use RuntimeException;
 
 use function assert;
 use function explode;
 use function in_array;
 use function is_integer;
 use function is_resource;
+use function parse_url;
 use function stream_context_get_options;
 use function stream_get_wrappers;
 use function stream_wrapper_register;
@@ -43,14 +45,24 @@
  */
 class StreamWrapper
 {
+    private static ?Bucket $defaultBucket = null;
+
     /** @var resource|null Stream context (set by PHP) */
     public $context;
 
     private ?string $protocol = null;
 
+    /** @var array{collectionWrapper: CollectionWrapper, file: ?object, filename: string, options: array} */
+    private array $contextOptions;
+
     /** @var ReadableStream|WritableStream|null */
     private $stream;
 
+    public static function setDefaultBucket(?Bucket $defaultBucket = null): void
+    {
+        self::$defaultBucket = $defaultBucket;
+    }
+
     public function __destruct()
     {
         /* This destructor is a workaround for PHP trying to use the stream well
@@ -280,8 +292,24 @@ private function getStatTemplate(): array
      */
     private function initProtocol(string $path): void
     {
-        $parts = explode('://', $path, 2);
-        $this->protocol = $parts[0] ?: 'gridfs';
+        $parts = parse_url($path);
+        $this->protocol = $parts['scheme'] ?: 'gridfs';
+
+        $context = stream_context_get_options($this->context);
+
+        if (isset($context[$this->protocol]['collectionWrapper'])) {
+            $this->contextOptions = $context[$this->protocol];
+        } elseif (! isset(self::$defaultBucket)) {
+            throw new RuntimeException('No default GridFS bucket available for stream wrapper.');
+        } else {
+            $file = explode('/', $parts['path'], 3)[2] ?? '';
+            $this->contextOptions = [
+                'collectionWrapper' => self::$defaultBucket->getCollectionWrapper(),
+                'file'              => self::$defaultBucket->findOne(['_id' => $file]),
+                'filename'          => $file,
+                'options'           => [],
+            ];
+        }
     }
 
     /**
@@ -296,8 +324,8 @@ private function initReadableStream(): bool
 
         assert($this->protocol !== null);
         $this->stream = new ReadableStream(
-            $context[$this->protocol]['collectionWrapper'],
-            $context[$this->protocol]['file'],
+            $this->contextOptions['collectionWrapper'],
+            $this->contextOptions['file'],
         );
 
         return true;
@@ -315,9 +343,9 @@ private function initWritableStream(): bool
 
         assert($this->protocol !== null);
         $this->stream = new WritableStream(
-            $context[$this->protocol]['collectionWrapper'],
-            $context[$this->protocol]['filename'],
-            $context[$this->protocol]['options'],
+            $this->contextOptions['collectionWrapper'],
+            $this->contextOptions['filename'],
+            $this->contextOptions['options'],
         );
 
         return true;

tests/GridFS/FunctionalTestCase.php

@@ -4,6 +4,7 @@
 
 use MongoDB\Collection;
 use MongoDB\GridFS\Bucket;
+use MongoDB\GridFS\StreamWrapper;
 use MongoDB\Tests\FunctionalTestCase as BaseFunctionalTestCase;
 
 use function fopen;
@@ -34,6 +35,13 @@ public function setUp(): void
         $this->filesCollection = $this->createCollection($this->getDatabaseName(), 'fs.files');
     }
 
+    public function tearDown(): void
+    {
+        StreamWrapper::setDefaultBucket(null);
+
+        parent::tearDown();
+    }
+
     /**
      * Asserts that a variable is a stream containing the expected data.
      *

tests/GridFS/StreamWrapperFunctionalTest.php

@@ -4,9 +4,11 @@
 
 use MongoDB\BSON\Binary;
 use MongoDB\BSON\UTCDateTime;
+use MongoDB\GridFS\StreamWrapper;
 
 use function fclose;
 use function feof;
+use function fopen;
 use function fread;
 use function fseek;
 use function fstat;
@@ -36,6 +38,15 @@ public function setUp(): void
         ]);
     }
 
+    public function testReadableStreamCloseWithDefaultBucket(): void
+    {
+        StreamWrapper::setDefaultBucket($this->bucket);
+
+        $stream = fopen('gridfs://default/default/length-10', 'r');
+
+        $this->assertTrue(fclose($stream));
+    }
+
     public function testReadableStreamClose(): void
     {
         $stream = $this->bucket->openDownloadStream('length-10');
@@ -104,6 +115,15 @@ public function testReadableStreamStat(): void
         $this->assertSame(4, $stat['blksize']);
     }
 
+    public function testReadableStreamWriteWithDefaultBucket(): void
+    {
+        StreamWrapper::setDefaultBucket($this->bucket);
+
+        $stream = fopen('gridfs://default/default/length-10', 'w');
+
+        $this->assertSame(0, fwrite($stream, 'foobar'));
+    }
+
     public function testReadableStreamWrite(): void
     {
         $stream = $this->bucket->openDownloadStream('length-10');