feat!: Updated auth plugin to use filament plugin interface

phpsa · Feb 18, 2024 · 1e3e710 · 1e3e710
1 parent dad492b
commit 1e3e710
Show file tree

Hide file tree

Showing 23 changed files with 202 additions and 89 deletions.
diff --git a/routes/web.php b/routes/web.php
@@ -5,4 +5,4 @@
 
 Route::get('/impersonate/stop', fn () => ImpersonateLink::leave())
     ->name('filament-authentication.stop.impersonation')
-    ->middleware(config('filament-authentication.impersonate.guard'));
+    ->middleware('web');
diff --git a/src/Actions/ImpersonateLink.php b/src/Actions/ImpersonateLink.php
@@ -8,7 +8,7 @@
 use Illuminate\Http\RedirectResponse;
 use Lab404\Impersonate\Services\ImpersonateManager;
 use Illuminate\Contracts\Auth\Authenticatable as User;
-
+use Phpsa\FilamentAuthentication\FilamentAuthentication;
 
 class ImpersonateLink
 {
@@ -30,7 +30,8 @@ public static function make(): Action
      */
     public static function allowed(User $current, User $target): bool
     {
-        return config('filament-authentication.impersonate.enabled', false)
+        $enabled = FilamentAuthentication::getPlugin()->impersonateEnabled();
+        return $enabled
         && $current->isNot($target)
         && ! app(ImpersonateManager::class)->isImpersonating()
         && (! method_exists($current, 'canImpersonate') || $current->canImpersonate())
@@ -46,32 +47,35 @@ public static function impersonate(User $record): false|Redirector|RedirectRespo
         app(ImpersonateManager::class)->take(
             Filament::auth()->user(),
             $record,
-            config('filament-authentication.impersonate.guard', 'web')
+            FilamentAuthentication::getPlugin()->getImpersonateGuard()
         );
 
+        session()->put('impersonate.back_to', url()->previous());
+
         session()->forget(array_unique([
-            'password_hash_'.config('filament-authentication.impersonate.guard', 'web'),
-            'password_hash_'.config('filament.auth.guard'),
+            'password_hash_' . FilamentAuthentication::getPlugin()->getImpersonateGuard(),
+            'password_hash_' . config('filament.auth.guard'),
         ]));
 
-        return redirect(config('filament-authentication.impersonate.redirect', '/'));
+        return redirect(FilamentAuthentication::getPlugin()->getImpersonateRedirect());
     }
 
     public static function leave(): Redirector|RedirectResponse
     {
+
         if (! app(ImpersonateManager::class)->isImpersonating()) {
             return redirect('/');
         }
 
         app(ImpersonateManager::class)->leave();
 
         session()->forget(array_unique([
-            'password_hash_'.config('filament-authentication.impersonate.guard'),
-            'password_hash_'.config('filament.auth.guard'),
+            'password_hash_' . FilamentAuthentication::getPlugin()->getImpersonateGuard(),
+            'password_hash_' . config('filament.auth.guard'),
         ]));
 
         return redirect(
-            session()->pull('impersonate.back_to') ?? config('filament.path')
+            session()->pull('impersonate.back_to') ?? '/'
         );
     }
 }
diff --git a/src/FilamentAuthentication.php b/src/FilamentAuthentication.php
@@ -2,16 +2,146 @@
 
 namespace Phpsa\FilamentAuthentication;
 
-use Filament\Navigation\MenuItem;
+use Closure;
 use Filament\Panel;
+use App\Models\User;
+use Filament\Contracts\Plugin;
+use Spatie\Permission\Models\Role;
+use Filament\Tables\Columns\TextColumn;
+use Spatie\Permission\Models\Permission;
+use Phpsa\FilamentAuthentication\Resources\RoleResource;
+use Phpsa\FilamentAuthentication\Resources\UserResource;
+use Phpsa\FilamentAuthentication\Resources\PermissionResource;
+use Phpsa\FilamentAuthentication\Http\Middleware\ImpersonatingMiddleware;
 
-class FilamentAuthentication
+class FilamentAuthentication implements Plugin
 {
-    public static function resources(array $with = []): array
+    protected bool $preloadRoles = true;
+    protected bool $preloadPermissions = true;
+    protected bool $impersonate = false;
+    protected string $impersonateGuard = 'web';
+    protected string|Closure $impersonateRedirect = '/';
+
+    /**
+     * @var array<string, class-string>
+     */
+    protected array $models              = [
+        'User'       => User::class,
+        'Role'       => Role::class,
+        'Permission' => Permission::class,
+    ];
+
+    /**
+     * @var array<string, class-string>
+     */
+    protected array $resources =  [
+        'UserResource'       => UserResource::class,
+        'RoleResource'       => RoleResource::class,
+        'PermissionResource' => PermissionResource::class,
+    ];
+
+    public static function make(): self
+    {
+        return new static();
+    }
+
+    public static function getPlugin(): self
+    {
+        return filament('filament-authentication');
+    }
+
+    public function getId(): string
+    {
+        return 'filament-authentication';
+    }
+
+    public function register(Panel $panel): void
+    {
+        $panel->resources($this->resources);
+        $panel->middleware([ImpersonatingMiddleware::class]);
+    }
+
+    public function boot(Panel $panel): void
+    {
+        TextColumn::macro('humanDate', function () {
+            /** @var \Filament\Tables\Columns\TextColumn&\Filament\Tables\Columns\Concerns\CanFormatState $this */
+            $this->formatStateUsing(fn ($state): ?string => $state ? $state->diffForHumans() : null);
+
+            return $this;
+        });
+    }
+
+    public function setPreload(bool $roles = true, bool $permissions = true): self
+    {
+        $this->preloadRoles = $roles;
+        $this->preloadPermissions = $permissions;
+
+        return $this;
+    }
+
+    public function getPreloadRoles(): bool
+    {
+        return $this->preloadRoles;
+    }
+
+    public function getPreloadPermissions(): bool
+    {
+        return $this->preloadPermissions;
+    }
+
+    public function setImpersonation(bool $enabled = true, string $guard = 'web', string|Closure $redirect = '/'): self
+    {
+        $this->impersonate = $enabled;
+        $this->impersonateGuard = $guard;
+        $this->impersonateRedirect = $redirect;
+
+        return $this;
+    }
+
+    public function impersonateEnabled(): bool
+    {
+        return $this->impersonate;
+    }
+
+    public function getImpersonateGuard(): string
+    {
+        return $this->impersonateGuard;
+    }
+
+    public function getImpersonateRedirect(): string|Closure
+    {
+        $value = $this->impersonateRedirect;
+        if (! $value instanceof Closure) {
+            return $value;
+        }
+        return $value();
+    }
+
+    /**
+     * @param array<string,class-string> $overrides
+     */
+    public function overrideModels(array $overrides): self
+    {
+        $this->models = array_merge($this->models, $overrides);
+        return $this;
+    }
+
+    public function getModel(string $model): string
+    {
+        return $this->models[$model];
+    }
+
+        /**
+     * @param array<string,class-string> $overrides
+     */
+    public function overrideResources(array $overrides): self
+    {
+        $this->resources = array_merge($this->resources, $overrides);
+        return $this;
+    }
+
+    public function getResource(string $resource): string
     {
-        return array_merge(
-            config('filament-authentication.resources'),
-            $with
-        );
+        return $this->resources[$resource];
     }
 }
diff --git a/src/FilamentAuthenticationProvider.php b/src/FilamentAuthenticationProvider.php
@@ -15,44 +15,12 @@ class FilamentAuthenticationProvider extends PackageServiceProvider
 {
     public static string $name = 'filament-authentication';
 
-    protected array $widgets = [
-        LatestUsersWidget::class,
-    ];
-
-    protected function getResources(): array
-    {
-        return config('filament-authentication.resources');
-    }
-
-    protected function getWidgets(): array
-    {
-        return config('filament-authentication.resources.widgets');
-    }
 
     public function configurePackage(Package $package): void
     {
-        Config::push('filament.middleware.base', ImpersonatingMiddleware::class);
-
         $package->name('filament-authentication')
-            ->hasConfigFile()
             ->hasViews()
             ->hasRoute('web')
             ->hasTranslations();
     }
-
-    public function getPages(): array
-    {
-        return config('filament-authentication.pages');
-    }
-
-    public function packageRegistered(): void
-    {
-
-        TextColumn::macro('humanDate', function () {
-            /** @var \Filament\Tables\Columns\TextColumn&\Filament\Tables\Columns\Concerns\CanFormatState $this */
-            $this->formatStateUsing(fn ($state): ?string => $state ? $state->diffForHumans() : null);
-
-            return $this;
-        });
-    }
 }
diff --git a/src/Http/Middleware/ImpersonatingMiddleware.php b/src/Http/Middleware/ImpersonatingMiddleware.php
@@ -24,7 +24,7 @@ public function handle(Request $request, \Closure $next)
         $response->setContent(
             str_replace(
                 '</body>',
-                $this->getHtmlContent($request).'</body>',
+                $this->getHtmlContent($request) . '</body>',
                 // @phpstan-ignore-next-line
                 $response->getContent()
             )

diff --git a/src/Resources/PermissionResource.php b/src/Resources/PermissionResource.php
@@ -15,6 +15,7 @@
 use Filament\Tables\Actions\DeleteBulkAction;
 use Filament\Forms\Components\Section as Card;
 use Filament\Forms\Components\BelongsToManyMultiSelect;
+use Phpsa\FilamentAuthentication\FilamentAuthentication;
 use Phpsa\FilamentAuthentication\Resources\PermissionResource\Pages\EditPermission;
 use Phpsa\FilamentAuthentication\Resources\PermissionResource\Pages\ViewPermission;
 use Phpsa\FilamentAuthentication\Resources\PermissionResource\Pages\ListPermissions;
@@ -29,7 +30,7 @@ class PermissionResource extends Resource
 
     public function __construct()
     {
-        static::$model = config('filament-authentication.models.Permission');
+        static::$model = FilamentAuthentication::getPlugin()->getModel('Permission');
     }
 
     public static function getLabel(): string
@@ -61,10 +62,7 @@ public static function form(Form $form): Form
                                 ->required()
                                 ->label(strval(__('filament-authentication::filament-authentication.field.guard_name')))
                                 ->default(config('auth.defaults.guard')),
-                            // BelongsToManyMultiSelect::make('roles')
-                            //     ->label(strval(__('filament-authentication::filament-authentication.field.roles')))
-                            //     ->relationship('roles', 'name')
-                            //     ->preload(config('filament-spatie-roles-permissions.preload_roles'))
+
                         ]),
                     ]),
             ]);

diff --git a/src/Resources/PermissionResource/Pages/CreatePermission.php b/src/Resources/PermissionResource/Pages/CreatePermission.php
@@ -2,16 +2,17 @@
 
 namespace Phpsa\FilamentAuthentication\Resources\PermissionResource\Pages;
 
-use Filament\Resources\Pages\CreateRecord;
 use Illuminate\Support\Facades\Config;
-use Spatie\Permission\Contracts\Permission;
+use Filament\Resources\Pages\CreateRecord;
 use Spatie\Permission\PermissionRegistrar;
+use Spatie\Permission\Contracts\Permission;
+use Phpsa\FilamentAuthentication\FilamentAuthentication;
 
 class CreatePermission extends CreateRecord
 {
     public static function getResource(): string
     {
-        return Config::get('filament-authentication.resources.PermissionResource');
+        return FilamentAuthentication::getPlugin()->getResource('PermissionResource');
     }
 
     public function afterSave(): void

diff --git a/src/Resources/PermissionResource/Pages/EditPermission.php b/src/Resources/PermissionResource/Pages/EditPermission.php
@@ -8,12 +8,13 @@
 use Filament\Resources\Pages\EditRecord;
 use Spatie\Permission\PermissionRegistrar;
 use Spatie\Permission\Contracts\Permission;
+use Phpsa\FilamentAuthentication\FilamentAuthentication;
 
 class EditPermission extends EditRecord
 {
     public static function getResource(): string
     {
-        return Config::get('filament-authentication.resources.PermissionResource');
+        return FilamentAuthentication::getPlugin()->getResource('PermissionResource');
     }
 
     public function afterSave(): void

diff --git a/src/Resources/PermissionResource/Pages/ListPermissions.php b/src/Resources/PermissionResource/Pages/ListPermissions.php
@@ -8,12 +8,13 @@
 use Filament\Tables\Actions\BulkAction;
 use Filament\Resources\Pages\ListRecords;
 use Illuminate\Database\Eloquent\Collection;
+use Phpsa\FilamentAuthentication\FilamentAuthentication;
 
 class ListPermissions extends ListRecords
 {
     public static function getResource(): string
     {
-        return Config::get('filament-authentication.resources.PermissionResource');
+        return FilamentAuthentication::getPlugin()->getResource('PermissionResource');
     }
 
     protected function getHeaderActions(): array

diff --git a/src/Resources/PermissionResource/Pages/ViewPermission.php b/src/Resources/PermissionResource/Pages/ViewPermission.php
@@ -5,12 +5,13 @@
 use Filament\Actions\EditAction;
 use Illuminate\Support\Facades\Config;
 use Filament\Resources\Pages\ViewRecord;
+use Phpsa\FilamentAuthentication\FilamentAuthentication;
 
 class ViewPermission extends ViewRecord
 {
     public static function getResource(): string
     {
-        return Config::get('filament-authentication.resources.PermissionResource');
+        return FilamentAuthentication::getPlugin()->getResource('PermissionResource');
     }
 
     protected function getHeaderActions(): array

diff --git a/src/Resources/PermissionResource/RelationManager/RoleRelationManager.php b/src/Resources/PermissionResource/RelationManager/RoleRelationManager.php
@@ -12,6 +12,7 @@
 use Spatie\Permission\PermissionRegistrar;
 use Filament\Tables\Actions\DissociateBulkAction;
 use Filament\Resources\RelationManagers\RelationManager;
+use Phpsa\FilamentAuthentication\FilamentAuthentication;
 
 class RoleRelationManager extends RelationManager
 {
@@ -44,7 +45,7 @@ public function table(Table $table): Table
             ])
             ->headerActions([
                 CreateAction::make(),
-                AttachAction::make()->preloadRecordSelect(config('filament-authentication.preload_roles', true))
+                AttachAction::make()->preloadRecordSelect(FilamentAuthentication::getPlugin()->getPreloadRoles())
                 ->recordSelect(fn($select) => $select->multiple())
                 ->closeModalByClickingAway(false),
             ])