[4.x] Storage::url() support (modified #689) (#909)

* This adds support for tenancy aware  Storage::url() method

* Trigger CI build

* Fixed Link command for Laravel v6, added StorageLink Events, more StorageLink tests, added RemoveStorageSymlinks Job, added Storage Jobs to TenancyServiceProvider stub, renamed misleading config example.

* Fix typo

* Fix code style (php-cs-fixer)

* Update config comments

* Format code in Link command, make writing more concise

* Change "symLinks" to "symlinks"

* Refactor Link command

* Fix test name typo

* Test fetching files using the public URL

* Extract Link command logic into actions

* Fix code style (php-cs-fixer)

* Check if closure is null in CreateStorageSymlinksAction

* Stop using command terminology in CreateStorageSymlinksAction

* Separate the Storage::url() test cases

* Update url_override comments

* Remove afterLink closures, add types, move actions, add usage explanation to the symlink trait

* Fix code style (php-cs-fixer)

* Update public storage URL test

* Fix issue with using str()

* Improve url_override comment, add todos

* add todo comment

* fix docblock style

* Add link command tests back

* Add types to $tenants in the action handle() methods

* Fix typo, update variable name formatting

* Add tests for the symlink actions

* Change possibleTenantSymlinks not to prefix the paths twice while tenancy is initialized

* Fix code style (php-cs-fixer)

* Stop testing storage directory existence in symlink test

* Don't specify full namespace for Tenant model annotation

* Don't specify full namespace in ActionTest

* Remove "change to DI" todo

* Remove possibleTenantSymlinks return annotation

* Remove symlink-related jobs, instantiate and use actions

* Revert "Remove symlink-related jobs, instantiate and use actions"

This reverts commit 547440c887.

* Add a comment line about the possible tenant symlinks

* Correct storagePath and publicPath variables

* Revert "Correct storagePath and publicPath variables"

This reverts commit e3aa8e2086.

* add a todo

Co-authored-by: Martin Vlcek <martin@dontfreakout.eu>
Co-authored-by: lukinovec <lukinovec@gmail.com>
Co-authored-by: PHP CS Fixer <phpcsfixer@example.com>

src/Actions/CreateStorageSymlinksAction.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Actions;
+
+use Exception;
+use Illuminate\Support\Collection;
+use Illuminate\Support\LazyCollection;
+use Stancl\Tenancy\Concerns\DealsWithTenantSymlinks;
+use Stancl\Tenancy\Database\Models\Tenant;
+use Stancl\Tenancy\Events\CreatingStorageSymlink;
+use Stancl\Tenancy\Events\StorageSymlinkCreated;
+
+class CreateStorageSymlinksAction
+{
+    use DealsWithTenantSymlinks;
+
+    public static function handle(Tenant|Collection|LazyCollection $tenants, bool $relativeLink = false, bool $force = false): void
+    {
+        $tenants = $tenants instanceof Tenant ? collect([$tenants]) : $tenants;
+
+        /** @var Tenant $tenant */
+        foreach ($tenants as $tenant) {
+            foreach (static::possibleTenantSymlinks($tenant) as $publicPath => $storagePath) {
+                static::createLink($publicPath, $storagePath, $tenant, $relativeLink, $force);
+            }
+        }
+    }
+
+    protected static function createLink(string $publicPath, string $storagePath, Tenant $tenant, bool $relativeLink, bool $force): void
+    {
+        event(new CreatingStorageSymlink($tenant));
+
+        if (static::symlinkExists($publicPath)) {
+            // If $force isn't passed, don't overwrite the existing symlink
+            throw_if(! $force, new Exception("The [$publicPath] link already exists."));
+
+            app()->make('files')->delete($publicPath);
+        }
+
+        // Make sure the storage path exists before we create a symlink
+        if (! is_dir($storagePath)) {
+            mkdir($storagePath, 0777, true);
+        }
+
+        if ($relativeLink) {
+            app()->make('files')->relativeLink($storagePath, $publicPath);
+        } else {
+            app()->make('files')->link($storagePath, $publicPath);
+        }
+
+        event((new StorageSymlinkCreated($tenant)));
+    }
+}

src/Actions/RemoveStorageSymlinksAction.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Actions;
+
+use Illuminate\Support\Collection;
+use Illuminate\Support\LazyCollection;
+use Stancl\Tenancy\Concerns\DealsWithTenantSymlinks;
+use Stancl\Tenancy\Database\Models\Tenant;
+use Stancl\Tenancy\Events\RemovingStorageSymlink;
+use Stancl\Tenancy\Events\StorageSymlinkRemoved;
+
+class RemoveStorageSymlinksAction
+{
+    use DealsWithTenantSymlinks;
+
+    public static function handle(Tenant|Collection|LazyCollection $tenants): void
+    {
+        $tenants = $tenants instanceof Tenant ? collect([$tenants]) : $tenants;
+
+        /** @var Tenant $tenant */
+        foreach ($tenants as $tenant) {
+            foreach (static::possibleTenantSymlinks($tenant) as $publicPath => $storagePath) {
+                static::removeLink($publicPath, $tenant);
+            }
+        }
+    }
+
+    protected static function removeLink(string $publicPath, Tenant $tenant): void
+    {
+        if (static::symlinkExists($publicPath)) {
+            event(new RemovingStorageSymlink($tenant));
+
+            app()->make('files')->delete($publicPath);
+
+            event(new StorageSymlinkRemoved($tenant));
+        }
+    }
+}