Implement redirecting

Fix PHPstan errors

Author: sten

README.md

@@ -247,6 +247,34 @@ The style can also be configured in the database model, then you can skip the `s
 
 See the [menu seeding documentation](documentation/seeders.md) for programmatic menu creation.
 
+## Redirects
+
+The package includes automatic redirect management: when the slug of a page changes, a redirect from the old page 
+to the new page is added. These redirects are stored in the database and are managable with the Filament resource, 
+so you can add your own redirects.
+
+Additionally, we integrated [spatie/laravel-missing-page-redirector](https://github.com/spatie/laravel-missing-page-redirector),
+so you can easily configure other redirects in the spatie packages config.
+
+### Configuration
+
+1. Prepend/append the [RedirectsMissingPages.php](src/Http/Middleware/RedirectsMissingPages.php) middleware to your global middleware stack:
+
+```php
+// bootstrap/app.php
+->withMiddleware(function (Middleware $middleware) {
+    $middleware->append([
+        \Statikbe\FilamentFlexibleContentBlockPages\Http\Middleware\RedirectsMissingPages::class,
+    ]);
+})
+```
+
+2. **Optional:** If you want to hardcode a set of redirects, you can [do this in the config file of the spatie package](https://github.com/spatie/laravel-missing-page-redirector?tab=readme-ov-file#usage). Publish this package:
+
+```php
+php artisan vendor:publish --provider="Spatie\MissingPageRedirector\MissingPageRedirectorServiceProvider"
+```
+
 ## Sitemap Generator
 
 The package includes an automatic sitemap generator that creates XML sitemaps for your website with support for multilingual sites and various content types.

config/filament-flexible-content-block-pages.php

@@ -136,6 +136,17 @@
 
     'redirects' => [
         'navigation_sort' => 10,
+
+        /*
+        |--------------------------------------------------------------------------
+        | Redirector
+        |--------------------------------------------------------------------------
+        |
+        | This package implements its own redirector for spatie/laravel-missing-page-redirector.
+        | To avoid manual configuration of this custom redirector in the spatie-package's config, we set the default here.
+        | In case you would like to customise this, please change the redirector here and not in the spatie package.
+        */
+        'redirector' => \Statikbe\FilamentFlexibleContentBlockPages\Services\DatabaseAndConfigRedirector::class,
     ],
 
     'settings' => [

src/Actions/LinkedToMenuItemBulkDeleteAction.php

@@ -28,6 +28,7 @@ public function setUp(): void
                 /** @var Model&HasMenuLabel $record */
                 // Prevent deletion if the page is referenced by a menu item
                 /** @var ?MenuItem $menuItem */
+                /** @phpstan-ignore-next-line */
                 $menuItem = $record->menuItem;
 
                 if ($menuItem) {
@@ -39,11 +40,14 @@ public function setUp(): void
 
             if (! empty($referencedPages)) {
                 $pageNames = collect($referencedPages)->map(function (Model&HasMenuLabel $page) {
+                    /** @var ?MenuItem $menuItem */
+                    /** @phpstan-ignore-next-line */
+                    $menuItem = $page->menuItem;
                     return '<li>'.
                         flexiblePagesTrans('pages.notifications.page_referenced_by_menu_item', [
                             'page' => $page->getMenuLabel(),
-                            'menu' => $page->menuItem->menu->name,
-                            'menu_item' => $page->menuItem->getDisplayLabel(),
+                            'menu' => $menuItem?->menu->name,
+                            'menu_item' => $menuItem?->getDisplayLabel(),
                         ])
                         .'</li>';
                 })->join('');

src/Actions/LinkedToMenuItemDeleteAction.php

@@ -20,6 +20,7 @@ protected function setUp(): void
         $this->action(function (Model&HasMenuLabel $record, $action) {
             // Prevent deletion if the page is referenced by a menu item
             /** @var ?MenuItem $menuItem */
+            /** @phpstan-ignore-next-line */
             $menuItem = $record->menuItem;
 
             if ($menuItem) {

src/FilamentFlexibleContentBlockPagesServiceProvider.php

@@ -6,6 +6,7 @@
 use Mcamara\LaravelLocalization\Facades\LaravelLocalization;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
+use Spatie\MissingPageRedirector\Redirector\Redirector;
 use Statikbe\FilamentFlexibleContentBlockPages\Commands\GenerateSitemapCommand;
 use Statikbe\FilamentFlexibleContentBlockPages\Commands\SeedDefaultsCommand;
 use Statikbe\FilamentFlexibleContentBlockPages\Components\BaseLayout;
@@ -69,5 +70,8 @@ function ($app) {
                 return $app->make($serviceClass);
             }
         );
+
+        // set our custom redirector for spatie/laravel-missing-page-redirector
+        $this->app->bind(Redirector::class, config('filament-flexible-content-block-pages.redirects.redirector'));
     }
 }

src/Http/Middleware/RedirectsMissingPages.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Statikbe\FilamentFlexibleContentBlockPages\Http\Middleware;
+
+use Closure;
+use Illuminate\Http\RedirectResponse;
+use Illuminate\Http\Request;
+use Illuminate\Http\Response;
+use Illuminate\Support\Str;
+use Spatie\MissingPageRedirector\RedirectsMissingPages as SpatieRedirectsMissingPages;
+
+/**
+ * Extended to keep query strings in redirects working.
+ */
+class RedirectsMissingPages extends SpatieRedirectsMissingPages
+{
+    public function handle(Request $request, Closure $next)
+    {
+        /** @var Response $response */
+        $response = parent::handle($request, $next);
+
+        if ($request->query->count() > 0 && $response->$this->shouldRedirect($response)) {
+            // make sure we do not lose the query string:
+            /** @var RedirectResponse $response */
+            if (! Str::contains($response->getTargetUrl(), '?')) {
+                $response->setTargetUrl($response->getTargetUrl().'?'.$request->getQueryString());
+            }
+        }
+
+        return $response;
+    }
+}

src/Models/MenuItem.php

@@ -29,6 +29,7 @@
  * @property int $parent_id
  * @property \Illuminate\Database\Eloquent\Collection<int, MenuItem> $children
  * @property \Illuminate\Database\Eloquent\Model|null $linkable
+ * @property Menu $menu
  */
 class MenuItem extends Model
 {

src/Models/Redirect.php

@@ -21,42 +21,13 @@ class Redirect extends Model
 {
     use HasFactory;
 
-    const CACHE_REDIRECTS_KEY = 'filament-flexible-content-block-pages:redirects';
-
     protected $guarded = ['id'];
 
     public function getTable()
     {
         return FilamentFlexibleContentBlockPages::config()->getRedirectsTable();
     }
 
-    /**
-     * Returns a list of old and new urls with the status code if set compatible with spatie/laravel-missing-page-redirector,
-     * that merges the redirects set in the database over the redirects set in the config.
-     */
-    public static function getDirectionMap(): array
-    {
-        // Get from the database and remember forever
-        // we clear this on new model or updated model
-        $dbRedirects = Cache::rememberForever(static::CACHE_REDIRECTS_KEY, function () {
-            return Redirect::all()->flatMap(function (Redirect $redirect) {
-                if ($redirect->status_code) {
-                    return [
-                        $redirect->old_url => [$redirect->new_url, $redirect->status_code],
-                    ];
-                } else {
-                    return [$redirect->old_url => $redirect->new_url];
-                }
-            })->toArray();
-        });
-
-        // Get the redirects from the config
-        $configRedirects = config('missing-page-redirector.redirects');
-
-        // Merge both values
-        return array_merge($configRedirects, $dbRedirects);
-    }
-
     public function getMorphClass()
     {
         return 'filament-flexible-content-block-pages::redirect';

src/Observers/RedirectObserver.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Support\Facades\Cache;
 use Statikbe\FilamentFlexibleContentBlockPages\Models\Redirect;
+use Statikbe\FilamentFlexibleContentBlockPages\Services\DatabaseAndConfigRedirector;
 
 /**
  * Clear redirect cache if a redirect changes
@@ -15,38 +16,43 @@ class RedirectObserver
      */
     public function created(Redirect $redirect): void
     {
-        Cache::forget(Redirect::CACHE_REDIRECTS_KEY);
+        $this->clearRedirectCache();
     }
 
     /**
      * Handle the Redirect "updated" event.
      */
     public function updated(Redirect $redirect): void
     {
-        Cache::forget(Redirect::CACHE_REDIRECTS_KEY);
+        $this->clearRedirectCache();
     }
 
     /**
      * Handle the Redirect "deleted" event.
      */
     public function deleted(Redirect $redirect): void
     {
-        Cache::forget(Redirect::CACHE_REDIRECTS_KEY);
+        $this->clearRedirectCache();
     }
 
     /**
      * Handle the Redirect "restored" event.
      */
     public function restored(Redirect $redirect): void
     {
-        Cache::forget(Redirect::CACHE_REDIRECTS_KEY);
+        $this->clearRedirectCache();
     }
 
     /**
      * Handle the Redirect "force deleted" event.
      */
     public function forceDeleted(Redirect $redirect): void
     {
-        Cache::forget(Redirect::CACHE_REDIRECTS_KEY);
+        $this->clearRedirectCache();
+    }
+
+    private function clearRedirectCache(): void
+    {
+        Cache::forget(DatabaseAndConfigRedirector::CACHE_REDIRECTS_KEY);
     }
 }

src/Services/DatabaseAndConfigRedirector.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Statikbe\FilamentFlexibleContentBlockPages\Services;
+
+use Illuminate\Support\Facades\Cache;
+use Spatie\MissingPageRedirector\Redirector\Redirector;
+use Statikbe\FilamentFlexibleContentBlockPages\Models\Redirect;
+use Symfony\Component\HttpFoundation\Request;
+
+class DatabaseAndConfigRedirector implements Redirector
+{
+    const CACHE_REDIRECTS_KEY = 'filament-flexible-content-block-pages:redirects';
+
+    /**
+     * Returns a list of old and new urls with the status code if set compatible with spatie/laravel-missing-page-redirector,
+     * that merges the redirects set in the database over the redirects set in the config.
+     */
+    public function getRedirectsFor(Request $request): array
+    {
+        // Get from the database and remember forever
+        // we clear this on new model or updated model
+        $dbRedirects = Cache::rememberForever(static::CACHE_REDIRECTS_KEY, function () {
+            return Redirect::all()->flatMap(function (Redirect $redirect) {
+                if ($redirect->status_code) {
+                    return [
+                        $redirect->old_url => [$redirect->new_url, $redirect->status_code],
+                    ];
+                } else {
+                    return [$redirect->old_url => $redirect->new_url];
+                }
+            })->toArray();
+        });
+
+        // Get the redirects from the config
+        $configRedirects = config('missing-page-redirector.redirects', []);
+
+        // Merge both values
+        return array_merge($configRedirects, $dbRedirects);
+    }
+}