mirror of
https://github.com/archtechx/tenancy.git
synced 2025-12-12 23:14:03 +00:00
Filesystem logic refactor, improved defaults for cache tenancy (#42)
* refactor FilesystemTenancyBootstrapper * clean up tests and improve coverage * minor maintenance mode changes * Improve tenants:migrate --skip-failing logic * make tenants:migrate output consistently formatted * minor RootUrlBootstrapper + misc changes * cache bootstrapper-related improvements * Fix code style (php-cs-fixer) * misc refactor * Fix code style (php-cs-fixer) * add %original_storage_path% to fs bootstrapper, improve default config for cache * rename method * inject concrete implementations where needed instead of abstracts * Fix code style (php-cs-fixer) * refactor DealsWithTenantSymlinks * remove obsolete phpstan ignore --------- Co-authored-by: PHP CS Fixer <phpcsfixer@example.com>
This commit is contained in:
Samuel Štancl
GitHub
parent
4b6fa22aa7
commit
a41ad69023
23 changed files with 234 additions and 160 deletions
|
|
@ -4,7 +4,7 @@ declare(strict_types=1);
|
|||
|
||||
namespace Stancl\Tenancy\Bootstrappers;
|
||||
|
||||
use Illuminate\Contracts\Foundation\Application;
|
||||
use Illuminate\Foundation\Application;
|
||||
use Illuminate\Routing\UrlGenerator;
|
||||
use Illuminate\Support\Facades\Storage;
|
||||
use Stancl\Tenancy\Contracts\TenancyBootstrapper;
|
||||
|
|
@ -12,20 +12,15 @@ use Stancl\Tenancy\Contracts\Tenant;
|
|||
|
||||
class FilesystemTenancyBootstrapper implements TenancyBootstrapper
|
||||
{
|
||||
/** @var Application */
|
||||
protected $app;
|
||||
public array $originalDisks = [];
|
||||
public string|null $originalAssetUrl;
|
||||
public string $originalStoragePath;
|
||||
|
||||
/** @var array */
|
||||
public $originalPaths = [];
|
||||
|
||||
public function __construct(Application $app)
|
||||
{
|
||||
$this->app = $app;
|
||||
$this->originalPaths = [
|
||||
'disks' => [],
|
||||
'storage' => $this->app->storagePath(),
|
||||
'asset_url' => $this->app['config']['app.asset_url'],
|
||||
];
|
||||
public function __construct(
|
||||
protected Application $app,
|
||||
) {
|
||||
$this->originalAssetUrl = $this->app['config']['app.asset_url'];
|
||||
$this->originalStoragePath = $app->storagePath();
|
||||
|
||||
$this->app['url']->macro('setAssetRoot', function ($root) {
|
||||
/** @var UrlGenerator $this */
|
||||
|
|
@ -37,83 +32,128 @@ class FilesystemTenancyBootstrapper implements TenancyBootstrapper
|
|||
|
||||
public function bootstrap(Tenant $tenant): void
|
||||
{
|
||||
$suffix = $this->app['config']['tenancy.filesystem.suffix_base'] . $tenant->getTenantKey();
|
||||
$suffix = $this->suffix($tenant);
|
||||
|
||||
// storage_path()
|
||||
if ($this->app['config']['tenancy.filesystem.suffix_storage_path'] ?? true) {
|
||||
$this->app->useStoragePath($this->originalPaths['storage'] . "/{$suffix}");
|
||||
}
|
||||
|
||||
// asset()
|
||||
if ($this->app['config']['tenancy.filesystem.asset_helper_tenancy']) {
|
||||
if ($this->originalPaths['asset_url']) {
|
||||
$this->app['config']['app.asset_url'] = $this->originalPaths['asset_url'] . "/$suffix";
|
||||
$this->app['url']->setAssetRoot($this->app['config']['app.asset_url']);
|
||||
} else {
|
||||
$this->app['url']->setAssetRoot($this->app['url']->route('stancl.tenancy.asset', ['path' => '']));
|
||||
}
|
||||
}
|
||||
|
||||
// Storage facade
|
||||
Storage::forgetDisk($this->app['config']['tenancy.filesystem.disks']);
|
||||
$this->storagePath($suffix);
|
||||
$this->assetHelper($suffix);
|
||||
$this->forgetDisks();
|
||||
|
||||
foreach ($this->app['config']['tenancy.filesystem.disks'] as $disk) {
|
||||
// todo@v4 \League\Flysystem\PathPrefixer is making this a lot more painful in flysystem v2
|
||||
$diskConfig = $this->app['config']["filesystems.disks.{$disk}"];
|
||||
$originalRoot = $diskConfig['root'] ?? null;
|
||||
$this->diskRoot($disk, $tenant);
|
||||
|
||||
$this->originalPaths['disks']['path'][$disk] = $originalRoot;
|
||||
|
||||
$finalPrefix = str_replace(
|
||||
['%storage_path%', '%tenant%'],
|
||||
[storage_path(), $tenant->getTenantKey()],
|
||||
$this->app['config']["tenancy.filesystem.root_override.{$disk}"] ?? '',
|
||||
$this->diskUrl(
|
||||
$disk,
|
||||
str($this->app['config']["tenancy.filesystem.url_override.{$disk}"])
|
||||
->replace('%tenant%', (string) $tenant->getTenantKey())
|
||||
->toString(),
|
||||
);
|
||||
|
||||
if (! $finalPrefix) {
|
||||
$finalPrefix = $originalRoot
|
||||
? rtrim($originalRoot, '/') . '/' . $suffix
|
||||
: $suffix;
|
||||
}
|
||||
|
||||
$this->app['config']["filesystems.disks.{$disk}.root"] = $finalPrefix;
|
||||
|
||||
// Storage Url
|
||||
if ($diskConfig['driver'] === 'local') {
|
||||
$this->originalPaths['disks']['url'][$disk] = $diskConfig['url'] ?? null;
|
||||
|
||||
if ($url = str_replace(
|
||||
'%tenant%',
|
||||
(string) $tenant->getTenantKey(),
|
||||
$this->app['config']["tenancy.filesystem.url_override.{$disk}"] ?? ''
|
||||
)) {
|
||||
$this->app['config']["filesystems.disks.{$disk}.url"] = url($url);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public function revert(): void
|
||||
{
|
||||
// storage_path()
|
||||
$this->app->useStoragePath($this->originalPaths['storage']);
|
||||
$this->storagePath(false);
|
||||
$this->assetHelper(false);
|
||||
$this->forgetDisks();
|
||||
|
||||
// asset()
|
||||
$this->app['config']['app.asset_url'] = $this->originalPaths['asset_url'];
|
||||
$this->app['url']->setAssetRoot($this->app['config']['app.asset_url']);
|
||||
foreach ($this->app['config']['tenancy.filesystem.disks'] as $disk) {
|
||||
$this->diskRoot($disk, false);
|
||||
$this->diskUrl($disk, false);
|
||||
}
|
||||
}
|
||||
|
||||
// Storage facade
|
||||
protected function suffix(Tenant $tenant): string
|
||||
{
|
||||
return $this->app['config']['tenancy.filesystem.suffix_base'] . $tenant->getTenantKey();
|
||||
}
|
||||
|
||||
protected function storagePath(string|false $suffix): void
|
||||
{
|
||||
if ($this->app['config']['tenancy.filesystem.suffix_storage_path'] === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($suffix === false) {
|
||||
$this->app->useStoragePath($this->originalStoragePath);
|
||||
} else {
|
||||
$this->app->useStoragePath($this->originalStoragePath . "/{$suffix}");
|
||||
}
|
||||
}
|
||||
|
||||
protected function assetHelper(string|false $suffix): void
|
||||
{
|
||||
if (! $this->app['config']['tenancy.filesystem.asset_helper_tenancy']) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($suffix === false) {
|
||||
$this->app['config']['app.asset_url'] = $this->originalAssetUrl;
|
||||
$this->app['url']->setAssetRoot($this->originalAssetUrl);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
if ($this->originalAssetUrl) {
|
||||
$this->app['config']['app.asset_url'] = $this->originalAssetUrl . "/$suffix";
|
||||
$this->app['url']->setAssetRoot($this->app['config']['app.asset_url']);
|
||||
} else {
|
||||
$this->app['url']->setAssetRoot($this->app['url']->route('stancl.tenancy.asset', ['path' => '']));
|
||||
}
|
||||
}
|
||||
|
||||
protected function forgetDisks(): void
|
||||
{
|
||||
Storage::forgetDisk($this->app['config']['tenancy.filesystem.disks']);
|
||||
foreach ($this->app['config']['tenancy.filesystem.disks'] as $diskName) {
|
||||
$this->app['config']["filesystems.disks.$diskName.root"] = $this->originalPaths['disks']['path'][$diskName];
|
||||
$diskConfig = $this->app['config']['filesystems.disks.' . $diskName];
|
||||
}
|
||||
|
||||
// Storage Url
|
||||
$url = data_get($this->originalPaths, "disks.url.$diskName");
|
||||
protected function diskRoot(string $disk, Tenant|false $tenant): void
|
||||
{
|
||||
if ($tenant === false) {
|
||||
$this->app['config']["filesystems.disks.$disk.root"] = $this->originalDisks[$disk]['root'];
|
||||
|
||||
if ($diskConfig['driver'] === 'local' && ! is_null($url)) {
|
||||
$this->app['config']["filesystems.disks.$diskName.url"] = $url;
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
$suffix = $this->suffix($tenant);
|
||||
|
||||
$diskConfig = $this->app['config']["filesystems.disks.{$disk}"];
|
||||
$originalRoot = $diskConfig['root'] ?? null;
|
||||
|
||||
$this->originalDisks[$disk]['root'] = $originalRoot;
|
||||
|
||||
if ($override = $this->app['config']["tenancy.filesystem.root_override.{$disk}"]) {
|
||||
// This is executed if the disk is in tenancy.filesystem.disks AND has a root_override
|
||||
// This behavior is used for local disks.
|
||||
$newRoot = str($override)
|
||||
->replace('%storage_path%', storage_path())
|
||||
->replace('%original_storage_path%', $this->originalStoragePath)
|
||||
->replace('%tenant%', (string) $tenant->getTenantKey())
|
||||
->toString();
|
||||
} else {
|
||||
// This is executed if the disk is in tenancy.filesystem.disks but does NOT have a root_override
|
||||
// This behavior is used for disks like S3.
|
||||
$newRoot = $originalRoot
|
||||
? rtrim($originalRoot, '/') . '/' . $suffix
|
||||
: $suffix;
|
||||
}
|
||||
|
||||
$this->app['config']["filesystems.disks.{$disk}.root"] = $newRoot;
|
||||
}
|
||||
|
||||
protected function diskUrl(string $disk, string|false $override): void
|
||||
{
|
||||
$diskConfig = $this->app['config']["filesystems.disks.{$disk}"];
|
||||
|
||||
if ($diskConfig['driver'] !== 'local' || $this->app['config']["tenancy.filesystem.url_override.{$disk}"] === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($override === false) {
|
||||
$url = data_get($this->originalDisks, "$disk.url");
|
||||
$this->app['config']["filesystems.disks.$disk.url"] = $url;
|
||||
} else {
|
||||
$this->originalDisks[$disk]['url'] ??= $diskConfig['url'] ?? null;
|
||||
$this->app['config']["filesystems.disks.{$disk}.url"] = url($override);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue