GridFS adapter for Filesystem

Author: GromNaN

composer.json

@@ -34,6 +34,8 @@
     },
     "require-dev": {
         "mongodb/builder": "^0.2",
+        "league/flysystem-gridfs": "^3.28",
+        "league/flysystem-read-only": "^3.0",
         "phpunit/phpunit": "^10.3",
         "orchestra/testbench": "^8.0|^9.0",
         "mockery/mockery": "^1.4.4",

src/MongoDBServiceProvider.php

@@ -6,13 +6,27 @@
 
 use Illuminate\Cache\CacheManager;
 use Illuminate\Cache\Repository;
+use Illuminate\Filesystem\FilesystemAdapter;
+use Illuminate\Filesystem\FilesystemManager;
 use Illuminate\Foundation\Application;
 use Illuminate\Support\ServiceProvider;
+use InvalidArgumentException;
+use League\Flysystem\Filesystem;
+use League\Flysystem\GridFS\GridFSAdapter;
+use League\Flysystem\ReadOnly\ReadOnlyFilesystemAdapter;
+use MongoDB\Client;
+use MongoDB\GridFS\Bucket;
 use MongoDB\Laravel\Cache\MongoStore;
 use MongoDB\Laravel\Eloquent\Model;
 use MongoDB\Laravel\Queue\MongoConnector;
+use RuntimeException;
 
+use function array_keys;
 use function assert;
+use function class_exists;
+use function implode;
+use function is_string;
+use function sprintf;
 
 class MongoDBServiceProvider extends ServiceProvider
 {
@@ -66,5 +80,74 @@ public function register()
                 return new MongoConnector($this->app['db']);
             });
         });
+
+        $this->registerFlysystemAdapter();
+    }
+
+    private function registerFlysystemAdapter(): void
+    {
+        // GridFS adapter for filesystem
+        $this->app->resolving('filesystem', static function (FilesystemManager $filesystemManager) {
+            $filesystemManager->extend('gridfs', static function (Application $app, array $config) {
+                if (! class_exists(GridFSAdapter::class)) {
+                    throw new RuntimeException('GridFS adapter for Flysystem is missing. Try running "composer require league/flysystem-gridfs"');
+                }
+
+                // Reuse an existing database connection
+                if (isset($config['connection'])) {
+                    if (isset($config['mongodb_uri'])) {
+                        throw new InvalidArgumentException('In GridFS configuration, "connection" and "mongodb_uri" options cannot be set together.');
+                    }
+
+                    $connection = $app['db']->connection($config['connection']);
+                    if (! $connection instanceof Connection) {
+                        throw new InvalidArgumentException(sprintf('The database connection "%s" does not use the "mongodb" driver.', $connection['connection']));
+                    }
+
+                    $bucket = $connection->getMongoClient()
+                        ->selectDatabase($config['database'] ?? $connection->getDatabaseName())
+                        ->selectGridFSBucket(['bucketName' => $config['bucket'] ?? 'fs']);
+                } elseif (isset($config['mongodb_uri'])) {
+                    // Create a new MongoDB client from the config
+                    if (! isset($config['database'])) {
+                        throw new InvalidArgumentException('MongoDB "database" name is required for filesystem GridFS configuration');
+                    }
+
+                    $bucket = (new Client($config['mongodb_uri'], $config['mongodb_uri_options'] ?? [], $config['mongodb_driver_options'] ?? []))
+                        ->selectDatabase($config['database'])
+                        ->selectGridFSBucket(['bucketName' => $config['bucket'] ?? 'fs']);
+                } elseif (isset($config['bucket'])) {
+                    // Allows setting the bucket instance directly
+                    $bucket = $config['bucket'];
+                    if (is_string($bucket)) {
+                        // Resolves the "bucket" service
+                        $bucket = $app->get($bucket);
+                    } elseif ($bucket instanceof \Closure) {
+                        $bucket = $bucket($app, $config);
+                    }
+
+                    if (! $bucket instanceof Bucket) {
+                        throw new InvalidArgumentException(sprintf('Provided GridFS bucket is not a instance of "%s"', Bucket::class));
+                    }
+                }
+
+                if (! isset($bucket)) {
+                    throw new InvalidArgumentException(sprintf('The "gridfs" configuration requires the "connection", "mongodb_uri", or "bucket" option. Got "%s"', implode('", "', array_keys($config))));
+                }
+
+                $adapter = new GridFSAdapter($bucket, $config['prefix'] ?? '');
+
+                /** @see FilesystemManager::createFlysystem() */
+                if ($config['read-only'] ?? false) {
+                    if (! class_exists(ReadOnlyFilesystemAdapter::class)) {
+                        throw new RuntimeException('Read-only Adapter for Flysystem is missing. Try running "composer require league/flysystem-read-only"');
+                    }
+
+                    $adapter = new ReadOnlyFilesystemAdapter($adapter);
+                }
+
+                return new FilesystemAdapter(new Filesystem($adapter, $config), $adapter, $config);
+            });
+        });
     }
 }