Merge branch 'main' of github.com:statikbe/laravel-filament-flexible-blocks-asset-manager

sten · sten · commit 8359eba31dbb · 2024-10-09T16:28:06.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to `laravel-filament-flexible-blocks-asset-manager` will be documented in this file.
 
+## v1.0.0 - 2024-10-09
+
+First version of the asset manager
+
 ## 1.0.0 - 202X-XX-XX
 
 - initial release
diff --git a/config/filament-flexible-blocks-asset-manager.php b/config/filament-flexible-blocks-asset-manager.php
@@ -1,6 +1,7 @@
 <?php
 
 // config for Statik/FilamentFlexibleBlocksAssetManager
+
 return [
     /*
     |--------------------------------------------------------------------------
@@ -21,6 +22,16 @@
     */
     'navigation_group' => null,
 
+    /*
+    |--------------------------------------------------------------------------
+    | Model & Resource
+    |--------------------------------------------------------------------------
+    |
+    | You can override the model and resource that are used. Be sure to inherit from our defaults.
+    */
+    'model' => \Statikbe\FilamentFlexibleBlocksAssetManager\Models\Asset::class,
+    'resource' => \Statikbe\FilamentFlexibleBlocksAssetManager\Filament\Resources\AssetResource::class,
+
     /*
     |--------------------------------------------------------------------------
     | Image editor
@@ -90,15 +101,20 @@
     | Asset authorisation
     |--------------------------------------------------------------------------
     |
-    | The assets URLs can be protected. This can be done in different ways:
-    | 1. a gate, see https://laravel.com/docs/11.x/authorization#gates
-    |    You can define a gate that takes the asset record as argument.
-    | 2. a policy, see https://laravel.com/docs/11.x/authorization#writing-policies
-    |    You can write a policy for the Asset model. The `view` policy will be used to authorise.
+    | The assets URLs can be protected and access to the Filament can be configured.
+    | You need to define a new model policy and add an extra function for the public
+    | file access of the asset. The name of this function needs to be added to the key
+    | 'gate'. The policy class needs to be added to the key 'policy'.
+    | The middleware is only used for assets URLs. You can get the assetId in the middleware by
+    | calling $request->route('assetId')
+    |
+    | see https://laravel.com/docs/11.x/authorization#gates and
+    | https://laravel.com/docs/11.x/authorization#writing-policies
     */
     'asset_authorisation' => [
         //'gate' => 'asset-access',
         //'policy' => AssetPolicy::class,
+        //'middleware' => AssetRedirectMiddleware::class,
     ],
 
     /*
diff --git a/routes/filament-flexible-blocks-asset-manager.php b/routes/filament-flexible-blocks-asset-manager.php
@@ -5,9 +5,10 @@
 use Statikbe\FilamentFlexibleBlocksAssetManager\FilamentFlexibleBlocksAssetManagerConfig;
 use Statikbe\FilamentFlexibleBlocksAssetManager\Http\Controllers\AssetController;
 
+$assetMiddleware = FilamentFlexibleBlocksAssetManagerConfig::getAssetMiddleware();
 $assetRoutePrefix = FilamentFlexibleBlocksAssetManagerConfig::getAssetRoutePrefix();
 $assetRoutePrefix = Str::replaceEnd('/', '', $assetRoutePrefix);
 
-Route::get("$assetRoutePrefix/{asset}/{locale?}", [AssetController::class, 'index'])
-    ->middleware(['web'])
+Route::get("$assetRoutePrefix/{assetId}/{locale?}", [AssetController::class, 'index'])
+    ->middleware(['web', $assetMiddleware ?? ''])
     ->name('filament-flexible-blocks-asset-manager.asset_index');
diff --git a/src/Filament/Form/Fields/Blocks/Type/AssetCallToActionType.php b/src/Filament/Form/Fields/Blocks/Type/AssetCallToActionType.php
@@ -2,6 +2,7 @@
 
 namespace Statikbe\FilamentFlexibleBlocksAssetManager\Filament\Form\Fields\Blocks\Type;
 
+use Statikbe\FilamentFlexibleBlocksAssetManager\FilamentFlexibleBlocksAssetManagerConfig;
 use Statikbe\FilamentFlexibleBlocksAssetManager\Models\Asset;
 use Statikbe\FilamentFlexibleContentBlocks\Filament\Form\Fields\Blocks\Type\CallToActionType;
 
@@ -12,7 +13,7 @@ protected function setUp(): void
         parent::setUp();
 
         $this->titleColumnName('name');
-        $this->model(Asset::class);
+        $this->model(FilamentFlexibleBlocksAssetManagerConfig::getModel());
         $this->label(trans('filament-flexible-blocks-asset-manager::filament-flexible-blocks-asset-manager.asset_lbl'));
 
         $this->searchColumns(['name']);
diff --git a/src/Filament/Resources/AssetResource.php b/src/Filament/Resources/AssetResource.php
@@ -15,16 +15,15 @@
 use Statikbe\FilamentFlexibleBlocksAssetManager\Filament\Resources\AssetResource\Pages\EditAsset;
 use Statikbe\FilamentFlexibleBlocksAssetManager\Filament\Resources\AssetResource\Pages\ListAssets;
 use Statikbe\FilamentFlexibleBlocksAssetManager\FilamentFlexibleBlocksAssetManagerConfig;
-use Statikbe\FilamentFlexibleBlocksAssetManager\Models\Asset;
 
 class AssetResource extends Resource
 {
     use Translatable;
 
-    protected static ?string $model = Asset::class;
-
     protected static ?string $navigationIcon = 'heroicon-o-photo';
 
+    protected static ?string $recordTitleAttribute = 'name';
+
     public static function getNavigationLabel(): string
     {
         return trans('filament-flexible-blocks-asset-manager::filament-flexible-blocks-asset-manager.asset_nav_lbl');
@@ -40,20 +39,33 @@ public static function getPluralLabel(): string
         return trans('filament-flexible-blocks-asset-manager::filament-flexible-blocks-asset-manager.asset_plural_lbl');
     }
 
+    public static function getModel(): string
+    {
+        return FilamentFlexibleBlocksAssetManagerConfig::getModel();
+    }
+
     public static function getNavigationGroup(): ?string
     {
         return FilamentFlexibleBlocksAssetManagerConfig::getNavigationGroup();
     }
 
+    public static function getDefaultComponents(): array
+    {
+        return [
+            AssetNameField::create(true),
+            AssetMediaField::create(FilamentFlexibleBlocksAssetManagerConfig::hasTranslatableAssets())
+                ->required(),
+        ];
+    }
+
     public static function form(Form $form): Form
     {
         return $form
             ->schema([
                 Section::make()
                     ->columns(2)
                     ->schema([
-                        AssetNameField::create(true),
-                        AssetMediaField::create(FilamentFlexibleBlocksAssetManagerConfig::hasTranslatableAssets()),
+                        ...static::getDefaultComponents(),
                     ]),
             ]);
     }
@@ -75,6 +87,7 @@ public static function table(Table $table): Table
                         // Only render the tooltip if the column contents exceeds the length limit.
                         return $state;
                     })
+                    ->searchable()
                     ->sortable(),
             ])
             ->actions([
diff --git a/src/Filament/Resources/AssetResource/Pages/CreateAsset.php b/src/Filament/Resources/AssetResource/Pages/CreateAsset.php
@@ -5,6 +5,7 @@
 use Filament\Actions;
 use Filament\Resources\Pages\CreateRecord;
 use Statikbe\FilamentFlexibleBlocksAssetManager\Filament\Resources\AssetResource;
+use Statikbe\FilamentFlexibleBlocksAssetManager\FilamentFlexibleBlocksAssetManagerConfig;
 use Statikbe\FilamentFlexibleContentBlocks\Filament\Pages\CreateRecord\Concerns\TranslatableWithMedia;
 
 class CreateAsset extends CreateRecord
@@ -13,6 +14,11 @@ class CreateAsset extends CreateRecord
 
     protected static string $resource = AssetResource::class;
 
+    public static function getResource(): string
+    {
+        return FilamentFlexibleBlocksAssetManagerConfig::getResource();
+    }
+
     protected function getHeaderActions(): array
     {
         return [
diff --git a/src/Filament/Resources/AssetResource/Pages/EditAsset.php b/src/Filament/Resources/AssetResource/Pages/EditAsset.php
@@ -5,6 +5,7 @@
 use Filament\Actions;
 use Filament\Resources\Pages\EditRecord;
 use Statikbe\FilamentFlexibleBlocksAssetManager\Filament\Resources\AssetResource;
+use Statikbe\FilamentFlexibleBlocksAssetManager\FilamentFlexibleBlocksAssetManagerConfig;
 use Statikbe\FilamentFlexibleContentBlocks\Filament\Pages\EditRecord\Concerns\TranslatableWithMedia;
 
 class EditAsset extends EditRecord
@@ -13,6 +14,11 @@ class EditAsset extends EditRecord
 
     protected static string $resource = AssetResource::class;
 
+    public static function getResource(): string
+    {
+        return FilamentFlexibleBlocksAssetManagerConfig::getResource();
+    }
+
     protected function getHeaderActions(): array
     {
         return [
diff --git a/src/Filament/Resources/AssetResource/Pages/ListAssets.php b/src/Filament/Resources/AssetResource/Pages/ListAssets.php
@@ -6,13 +6,19 @@
 use Filament\Resources\Pages\ListRecords;
 use Filament\Resources\Pages\ListRecords\Concerns\Translatable;
 use Statikbe\FilamentFlexibleBlocksAssetManager\Filament\Resources\AssetResource;
+use Statikbe\FilamentFlexibleBlocksAssetManager\FilamentFlexibleBlocksAssetManagerConfig;
 
 class ListAssets extends ListRecords
 {
     use Translatable;
 
     protected static string $resource = AssetResource::class;
 
+    public static function getResource(): string
+    {
+        return FilamentFlexibleBlocksAssetManagerConfig::getResource();
+    }
+
     protected function getHeaderActions(): array
     {
         return [
diff --git a/src/FilamentFlexibleBlocksAssetManagerConfig.php b/src/FilamentFlexibleBlocksAssetManagerConfig.php
@@ -19,6 +19,11 @@ public static function getAssetAuthorisationPolicy(): ?string
         return self::getConfig('asset_authorisation.policy');
     }
 
+    public static function getAssetMiddleware(): ?string
+    {
+        return self::getConfig('asset_authorisation.middleware');
+    }
+
     public static function getStorageDisk(): ?string
     {
         return self::getConfig('storage_disk');
@@ -49,6 +54,16 @@ public static function getNavigationGroup(): ?string
         return self::getConfig('navigation_group') ?? trans('filament-flexible-blocks-asset-manager::filament-flexible-blocks-asset-manager.navigation_group');
     }
 
+    public static function getModel(): ?string
+    {
+        return self::getConfig('model');
+    }
+
+    public static function getResource(): ?string
+    {
+        return self::getConfig('resource');
+    }
+
     public static function getAssetRoutePrefix(): ?string
     {
         return self::getConfig('asset_route_prefix', '/asset');
diff --git a/src/FilamentFlexibleBlocksAssetManagerPlugin.php b/src/FilamentFlexibleBlocksAssetManagerPlugin.php
@@ -4,7 +4,6 @@
 
 use Filament\Contracts\Plugin;
 use Filament\Panel;
-use Statikbe\FilamentFlexibleBlocksAssetManager\Filament\Resources\AssetResource;
 
 class FilamentFlexibleBlocksAssetManagerPlugin implements Plugin
 {
@@ -16,7 +15,7 @@ public function getId(): string
     public function register(Panel $panel): void
     {
         $panel->resources([
-            AssetResource::class,
+            FilamentFlexibleBlocksAssetManagerConfig::getResource(),
         ]);
     }
 
diff --git a/src/FilamentFlexibleBlocksAssetManagerServiceProvider.php b/src/FilamentFlexibleBlocksAssetManagerServiceProvider.php
@@ -2,10 +2,7 @@
 
 namespace Statikbe\FilamentFlexibleBlocksAssetManager;
 
-use Filament\Support\Assets\AlpineComponent;
 use Filament\Support\Assets\Asset;
-use Filament\Support\Assets\Css;
-use Filament\Support\Assets\Js;
 use Filament\Support\Facades\FilamentAsset;
 use Filament\Support\Facades\FilamentIcon;
 use Illuminate\Database\Eloquent\Relations\Relation;
@@ -15,7 +12,6 @@
 use Spatie\LaravelPackageTools\Commands\InstallCommand;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
-use Statikbe\FilamentFlexibleBlocksAssetManager\Models\Asset as AssetModel;
 use Statikbe\FilamentFlexibleBlocksAssetManager\Testing\TestsLaravelFilamentFlexibleBlocksAssetManager;
 
 class FilamentFlexibleBlocksAssetManagerServiceProvider extends PackageServiceProvider
@@ -91,17 +87,17 @@ public function packageBooted(): void
         }
 
         // Testing
-        Testable::mixin(new TestsLaravelFilamentFlexibleBlocksAssetManager());
+        Testable::mixin(new TestsLaravelFilamentFlexibleBlocksAssetManager);
 
         //add Asset to morph map when used:
         Relation::morphMap([
-            'filament-flexible-blocks-asset-manager::asset' => AssetModel::class,
+            'filament-flexible-blocks-asset-manager::asset' => FilamentFlexibleBlocksAssetManagerConfig::getModel(),
         ], true);
 
         //add policies
         if (FilamentFlexibleBlocksAssetManagerConfig::getAssetAuthorisationPolicy()) {
             Gate::policy(
-                \Statikbe\FilamentFlexibleBlocksAssetManager\Models\Asset::class,
+                FilamentFlexibleBlocksAssetManagerConfig::getModel(),
                 FilamentFlexibleBlocksAssetManagerConfig::getAssetAuthorisationPolicy()
             );
         }
diff --git a/src/Http/Controllers/AssetController.php b/src/Http/Controllers/AssetController.php
@@ -5,12 +5,13 @@
 use Illuminate\Http\Response;
 use Illuminate\Support\Facades\Gate;
 use Statikbe\FilamentFlexibleBlocksAssetManager\FilamentFlexibleBlocksAssetManagerConfig;
-use Statikbe\FilamentFlexibleBlocksAssetManager\Models\Asset;
 
 class AssetController
 {
-    public function index(Asset $asset, ?string $locale = null)
+    public function index(string $assetId, ?string $locale = null)
     {
+        $asset = FilamentFlexibleBlocksAssetManagerConfig::getModel()::findOrFail($assetId);
+
         //check if a gate needs to be applied:
         $authGate = FilamentFlexibleBlocksAssetManagerConfig::getAssetAuthorisationGate();
         if ($authGate) {
@@ -25,6 +26,10 @@ public function index(Asset $asset, ?string $locale = null)
             $filters = ['locale' => $locale];
         }
 
-        return $asset->getFirstMedia($asset->getAssetCollection(), $filters);
+        return $asset
+            ->getFirstMedia($asset->getAssetCollection(), $filters)
+            ->setCustomHeaders([
+                'X-Robots-Tag' => 'none', //equivalent to noindex, nofollow.
+            ]);
     }
 }
diff --git a/src/Models/Asset.php b/src/Models/Asset.php
@@ -49,13 +49,13 @@ public function getAssetCollection(): string
     public function getViewUrl(?string $locale = null): string
     {
         return route('filament-flexible-blocks-asset-manager.asset_index', [
-            'asset' => $this,
+            'assetId' => $this,
             'locale' => $locale,
         ]);
     }
 
     public function getPreviewUrl(?string $locale = null): string
     {
-        $this->getViewUrl($locale);
+        return $this->getViewUrl($locale);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@`
`4`	`4`
`5`	`5`	`use Filament\Contracts\Plugin;`
`6`	`6`	`use Filament\Panel;`
`7`		`-use Statikbe\FilamentFlexibleBlocksAssetManager\Filament\Resources\AssetResource;`
`8`	`7`
`9`	`8`	`class FilamentFlexibleBlocksAssetManagerPlugin implements Plugin`
`10`	`9`	`{`
`@@ -16,7 +15,7 @@ public function getId(): string`
`16`	`15`	`public function register(Panel $panel): void`
`17`	`16`	`{`
`18`	`17`	`$panel->resources([`
`19`		`- AssetResource::class,`
	`18`	`+ FilamentFlexibleBlocksAssetManagerConfig::getResource(),`
`20`	`19`	`]);`
`21`	`20`	`}`
`22`	`21`