feat: Add Laravel filesystem storage custom driver to tenantise stora…

…ge disks

resources/config/sprout.php

@@ -4,4 +4,8 @@
 
     'listen_for_routing' => true,
 
+    'services' => [
+        'storage' => true,
+    ],
+
 ];

src/Listeners/CleanupLaravelServices.php

@@ -0,0 +1,51 @@
+<?php
+declare(strict_types=1);
+
+namespace Sprout\Listeners;
+
+use Illuminate\Filesystem\FilesystemManager;
+use Sprout\Events\CurrentTenantChanged;
+
+final class CleanupLaravelServices
+{
+    /**
+     * @var \Illuminate\Filesystem\FilesystemManager
+     */
+    private FilesystemManager $filesystemManager;
+
+    public function __construct(FilesystemManager $filesystemManager)
+    {
+        $this->filesystemManager = $filesystemManager;
+    }
+
+    /**
+     * @template TenantClass of \Sprout\Contracts\Tenant
+     *
+     * @param \Sprout\Events\CurrentTenantChanged<TenantClass> $event
+     *
+     * @return void
+     */
+    public function handle(CurrentTenantChanged $event): void
+    {
+        $this->purgeFilesystemDisks();
+    }
+
+    private function purgeFilesystemDisks(): void
+    {
+        // If we're not overriding the storage service we can exit early
+        if (config('sprout.services.storage', false) === false) {
+            return;
+        }
+
+        /** @var array<string, array<string, mixed>> $diskConfig */
+        $diskConfig = config('filesystems.disks', []);
+
+        // If any of the disks have the 'sprout' driver we need to purge them,
+        // if they exist, so we don't end up leaking tenant information
+        foreach ($diskConfig as $disk => $config) {
+            if (($config['driver'] ?? null) === 'sprout') {
+                $this->filesystemManager->forgetDisk($disk);
+            }
+        }
+    }
+}

src/SproutServiceProvider.php

@@ -4,13 +4,18 @@
 namespace Sprout;
 
 use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Filesystem\FilesystemManager;
+use Illuminate\Foundation\Application;
 use Illuminate\Queue\Events\JobProcessing;
 use Illuminate\Routing\Events\RouteMatched;
 use Illuminate\Routing\Router;
 use Illuminate\Support\ServiceProvider;
+use RuntimeException;
+use Sprout\Contracts\TenantHasResources;
 use Sprout\Events\CurrentTenantChanged;
 use Sprout\Http\Middleware\TenantRoutes;
 use Sprout\Http\RouterMethods;
+use Sprout\Listeners\CleanupLaravelServices;
 use Sprout\Listeners\IdentifyTenantOnRouting;
 use Sprout\Listeners\PerformIdentityResolverSetup;
 use Sprout\Listeners\SetCurrentTenantContext;
@@ -86,6 +91,7 @@ public function boot(): void
     {
         $this->publishConfig();
         $this->registerEventListeners();
+        $this->registerServiceOverrides();
     }
 
     private function publishConfig(): void
@@ -105,6 +111,42 @@ private function registerEventListeners(): void
 
         $events->listen(CurrentTenantChanged::class, SetCurrentTenantContext::class);
         $events->listen(CurrentTenantChanged::class, PerformIdentityResolverSetup::class);
+        $events->listen(CurrentTenantChanged::class, CleanupLaravelServices::class);
         $events->listen(JobProcessing::class, SetCurrentTenantForJob::class);
     }
+
+    private function registerServiceOverrides(): void
+    {
+        // If we're providing a tenanted override for Laravels filesystem/storage
+        // service, we'll do that here
+        if ($this->sprout->config('services.storage', false)) {
+            $filesystemManager = $this->app->make(FilesystemManager::class);
+            $filesystemManager->extend('sprout', function (Application $app, array $config) use ($filesystemManager) {
+                $tenancy = $this->sprout->tenancies()->get($config['tenancy'] ?? null);
+
+                // If there's no tenant, error out
+                if (! $tenancy->check()) {
+                    // TODO: Better exception
+                    throw new RuntimeException('There isn\'t a current a tenant');
+                }
+
+                $tenant = $tenancy->tenant();
+
+                // If the tenant isn't configured for resources, also error out
+                if (! ($tenant instanceof TenantHasResources)) {
+                    // TODO: Better exception
+                    throw new RuntimeException('Current tenant isn\t configured for resources');
+                }
+
+                /** @var string $pathPrefix */
+                $pathPrefix = $this->config['path'] ?? '{tenant}';
+
+                // Build up the path prefix with the tenant resource key
+                $config['prefix'] = str_replace('{tenant}', $tenant->getTenantResourceKey(), $pathPrefix);
+
+                // Create a scoped driver for the new path
+                return $filesystemManager->createScopedDriver($config);
+            });
+        }
+    }
 }