Merge pull request #17998 from craftcms/feature/routes

[6.x] Routes

Author: brandonkelly

CHANGELOG-WIP.md

@@ -276,6 +276,11 @@ Moved the following controllers:
 - Removed `craft\models\ReadOnlyProjectConfigData` in favor of `CraftCms\Cms\ProjectConfig\Data\ReadOnlyProjectConfigData`
 - Deprecated `craft\helpers\ProjectConfig`. `CraftCms\Cms\ProjectConfig\ProjectConfigHelper` should be used instead.
 
+## Routes
+
+- Deprecated `craft\services\Routes`. `CraftCms\Cms\Route\Routes` should be used instead.
+- Using routes in `config/routes.php` is no longer supported. Register routes using [Laravel's routing](https://laravel.com/docs/12.x/routing) instead.
+
 ## Sections
 
 - Deprecated the section related methods in `craft\services\Entries`. `CraftCms\Cms\Section\Sections` should be used instead.

packages/craftcms-asset-bundles/bundles/routes/dist/routes.js

@@ -1,9 +1,7 @@
 {% from '_includes/forms.twig' import button %}
-{% requireAdmin false %}
 
 {% extends "_layouts/cp" %}
 {% set title = "Routes"|t('app') %}
-{% set readOnly = not app.config.craft.general.allowAdminChanges %}
 
 {% block actionButton %}
     {% if not readOnly %}
@@ -15,8 +13,6 @@
     { label: "Settings"|t('app'), url: url('settings') }
 ] %}
 
-{% do view.registerAssetBundle("craft\\web\\assets\\routes\\RoutesAsset") %}
-
 {% do view.registerTranslations('app', [
     "Add a token",
     "Are you sure you want to delete this route?",
@@ -33,9 +29,6 @@
     "The URI can’t begin with the {setting} config setting.",
 ]) %}
 
-
-{% set routes = craft.routes.getProjectConfigRoutes() %}
-
 {% set actionMenuItems = [
     {
         icon: 'arrow-up',

resources/templates/settings/routes.twig

@@ -23,6 +23,7 @@
 use CraftCms\Cms\Http\Controllers\PluginStore\RemoveController;
 use CraftCms\Cms\Http\Controllers\Settings\EntryTypesController;
 use CraftCms\Cms\Http\Controllers\Settings\GeneralSettingsController;
+use CraftCms\Cms\Http\Controllers\Settings\RoutesController;
 use CraftCms\Cms\Http\Controllers\Settings\SectionsController;
 use CraftCms\Cms\Http\Controllers\Settings\SiteGroupsController;
 use CraftCms\Cms\Http\Controllers\Settings\SitesController;
@@ -189,6 +190,13 @@
             Route::post(BaseUpdaterController::ACTION_FINISH, [ConfigSyncController::class, 'finish']);
         });
 
+        // Routes
+        Route::middleware([RequireAdminChanges::class])->group(function () {
+            Route::post('routes/save-route', [RoutesController::class, 'store']);
+            Route::post('routes/delete-route', [RoutesController::class, 'destroy']);
+            Route::post('routes/update-route-order', [RoutesController::class, 'reorder']);
+        });
+
         // Sections
         Route::get('sections/table-data', [SectionsController::class, 'tableData']);
         Route::get('sections/edit/{sectionId?}', [SectionsController::class, 'edit']);

routes/actions.php

@@ -12,6 +12,7 @@
 use CraftCms\Cms\Http\Controllers\PluginStore\PluginStoreController;
 use CraftCms\Cms\Http\Controllers\Settings\EntryTypesController;
 use CraftCms\Cms\Http\Controllers\Settings\GeneralSettingsController;
+use CraftCms\Cms\Http\Controllers\Settings\RoutesController;
 use CraftCms\Cms\Http\Controllers\Settings\SectionsController;
 use CraftCms\Cms\Http\Controllers\Settings\SitesController;
 use CraftCms\Cms\Http\Controllers\Updates\UpdaterController;
@@ -45,8 +46,8 @@
     Route::get('entries/{section}/new', CreateEntryController::class);
 
     Route::get('content', EntriesIndexController::class);
-    Route::view('content/{page}', 'craftcms::entries.index');
-    Route::view('content/{page}/{sectionHandle}', 'craftcms::entries.index');
+    Route::view('content/{page}', 'craftcms::entries.index')->where('page', '[^\/]+');
+    Route::view('content/{page}/{sectionHandle}', 'craftcms::entries.index')->where('page', '[^\/]+');
     Route::get('content/{section}/new', CreateEntryController::class);
 
     /**
@@ -73,6 +74,9 @@
         Route::get('settings/plugins/{handle}', [PluginsController::class, 'editSettings']);
         Route::get('plugin-store{any?}', [PluginStoreController::class, 'index'])->where('any', '.*');
 
+        // Routes
+        Route::get('settings/routes', [RoutesController::class, 'index']);
+
         // Sections
         Route::get('settings/sections', [SectionsController::class, 'index']);
         Route::middleware(RequireAdminChanges::class)->get('settings/sections/new', [SectionsController::class, 'create']);

routes/cp.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Http\Controllers\Settings;
+
+use craft\web\assets\routes\RoutesAsset;
+use CraftCms\Cms\Cms;
+use CraftCms\Cms\Http\RespondsWithFlash;
+use CraftCms\Cms\Route\Data\Route;
+use CraftCms\Cms\Route\Routes;
+use Illuminate\Contracts\View\View;
+use Illuminate\Http\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+final readonly class RoutesController
+{
+    use RespondsWithFlash;
+
+    public function __construct(
+        private Routes $routes,
+    ) {}
+
+    public function index(): View
+    {
+        \Craft::$app->getView()->registerAssetBundle(RoutesAsset::class);
+
+        return view('craftcms::settings.routes', [
+            'tokens' => $this->routes->tokens,
+            'routes' => $this->routes->getProjectConfigRoutes(),
+            'readOnly' => ! Cms::config()->allowAdminChanges,
+        ]);
+    }
+
+    public function store(Route $route): Response
+    {
+        $routeUid = $this->routes->saveRoute($route);
+
+        return $this->asSuccess(data: [
+            'routeUid' => $routeUid,
+            'siteUid' => $route->siteUid,
+        ]);
+    }
+
+    public function destroy(Request $request): Response
+    {
+        $routeUid = $request->validate([
+            'routeUid' => ['required', 'string'],
+        ])['routeUid'];
+
+        $this->routes->deleteRouteByUid($routeUid);
+
+        return $this->asSuccess();
+    }
+
+    public function reorder(Request $request): Response
+    {
+        $routeUids = $request->validate([
+            'routeUids' => ['required', 'array'],
+            'routeUids.*' => ['required', 'string'],
+        ])['routeUids'];
+
+        $this->routes->updateRouteOrder($routeUids);
+
+        return $this->asSuccess();
+    }
+}

src/Http/Controllers/Settings/RoutesController.php

@@ -4,36 +4,24 @@
 
 namespace CraftCms\Cms\Providers;
 
-use Craft;
 use craft\helpers\FileHelper;
 use CraftCms\Aliases\Aliases;
 use CraftCms\Cms\Cms;
 use CraftCms\Cms\Edition;
 use CraftCms\Cms\GarbageCollection\GarbageCollection;
-use CraftCms\Cms\Http\Middleware\CheckForUpdates;
-use CraftCms\Cms\Http\Middleware\CheckRequirements;
-use CraftCms\Cms\Http\Middleware\CheckSchemaVersion;
-use CraftCms\Cms\Http\Middleware\ExtractNamespace;
-use CraftCms\Cms\Http\Middleware\FlushProjectConfig;
-use CraftCms\Cms\Http\Middleware\HandleActionRequest;
-use CraftCms\Cms\Http\Middleware\RequireCpRequest;
-use CraftCms\Cms\Http\Middleware\SendPoweredByHeader;
-use CraftCms\Cms\Http\Middleware\UpdateLocale;
 use CraftCms\Cms\ProjectConfig\ProjectConfig;
 use CraftCms\Cms\Shared\Models\Info;
 use CraftCms\Cms\Support\Env;
 use CraftCms\Cms\Support\Facades\Updates;
 use CraftCms\Cms\User\Models\User;
 use GuzzleHttp\Utils;
 use Illuminate\Auth\Middleware\Authenticate;
-use Illuminate\Contracts\Http\Kernel as HttpKernel;
 use Illuminate\Foundation\Application;
 use Illuminate\Foundation\Console\AboutCommand;
 use Illuminate\Foundation\Events\LocaleUpdated;
 use Illuminate\Http\Client\Factory;
 use Illuminate\Http\Client\PendingRequest;
 use Illuminate\Http\Request;
-use Illuminate\Routing\Router;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Event;
@@ -65,17 +53,6 @@ public function register(): void
             Config::set('auth.providers.users.model', User::class);
         }
 
-        /**
-         * HandleActionRequest is special and needs to run
-         * before any other middleware as it rewrites
-         * which path needs to get used.
-         */
-        $kernel = $this->app->get(HttpKernel::class);
-        $kernel->setGlobalMiddleware(array_merge([
-            ExtractNamespace::class,
-            HandleActionRequest::class,
-        ], $kernel->getGlobalMiddleware()));
-
         Authenticate::redirectUsing(function () {
             if (\request()->isCpRequest()) {
                 return Cms::config()->cpTrigger.'/login';
@@ -105,9 +82,6 @@ public function boot(): void
         $this->setTimezone();
         $this->setNamespace();
         $this->bootAliases();
-        $this->bootMiddleware();
-
-        $this->loadRoutesFrom("{$this->root}/routes/routes.php");
 
         $this->app->booted(function () {
             if (Info::isInstalled() && ! Updates::isCraftUpdatePending()) {
@@ -217,28 +191,6 @@ private function registerMacros(): void
             ));
     }
 
-    protected function bootMiddleware(): void
-    {
-        $router = $this->app->make(Router::class);
-
-        collect([
-            UpdateLocale::class,
-            CheckSchemaVersion::class,
-            CheckForUpdates::class,
-            SendPoweredByHeader::class,
-            FlushProjectConfig::class,
-        ])->each(fn ($middleware) => $router->pushMiddlewareToGroup('craft', $middleware));
-
-        collect([
-            RequireCpRequest::class,
-            CheckRequirements::class,
-        ])->each(fn ($middleware) => $router->pushMiddlewareToGroup('craft.cp', $middleware));
-
-        collect([
-            'web',
-        ])->each(fn ($middleware) => $router->pushMiddlewareToGroup('craft.web', $middleware));
-    }
-
     private function setTimezone(): void
     {
         $timezone = app(ProjectConfig::class)->get('system.timeZone')

src/Providers/AppServiceProvider.php

@@ -14,6 +14,7 @@
 use CraftCms\Cms\License\LicenseServiceProvider;
 use CraftCms\Cms\Plugin\PluginServiceProvider;
 use CraftCms\Cms\ProjectConfig\ProjectConfigServiceProvider;
+use CraftCms\Cms\Route\RouteServiceProvider;
 use CraftCms\Cms\Section\SectionServiceProvider;
 use CraftCms\Cms\Structure\StructureServiceProvider;
 use CraftCms\Cms\Translation\TranslationServiceProvider;
@@ -33,6 +34,7 @@ final class CraftServiceProvider extends AggregateServiceProvider
         ProjectConfigServiceProvider::class,
         DeprecatorServiceProvider::class,
         LicenseServiceProvider::class,
+        RouteServiceProvider::class,
         AppServiceProvider::class,
         IconServiceProvider::class,
         ConsoleServiceProvider::class,

src/Providers/CraftServiceProvider.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Route\Data;
+
+use CraftCms\Cms\Support\Html;
+use Spatie\LaravelData\Dto;
+
+final class Route extends Dto
+{
+    public function __construct(
+        /**
+         * @var array $uriParts The URI as defined by the user. This is an array where each element is either a
+         *            string or an array containing the name of a subpattern and the subpattern
+         */
+        public array $uriParts {
+            get => array_filter($this->uriParts);
+            set(array $value) => $this->uriParts = $value;
+        },
+
+        /**
+         * @var string $template The template to route matching requests to
+         */
+        public string $template,
+
+        /**
+         * @var string|null The site UID the route should be limited to, if any
+         */
+        public ?string $siteUid,
+
+        /**
+         * @var string $uid The route UID.
+         */
+        public ?string $uid = null,
+
+        public ?int $sortOrder = null,
+    ) {
+    }
+
+    public function configData(): array
+    {
+        return [
+            'template' => $this->template,
+            'uriParts' => $this->uriParts,
+            'siteUid' => $this->siteUid,
+        ];
+    }
+
+    public function getUri(): string
+    {
+        return collect($this->uriParts)->map(function (string|array|null $part) {
+            if (is_string($part)) {
+                return $part;
+            }
+
+            return "{{$part[0]}}";
+        })->implode('');
+    }
+
+    public function uriDisplayHtml(): string
+    {
+        if (empty($this->uriParts)) {
+            return '';
+        }
+
+        $uriDisplayHtml = '';
+
+        foreach ($this->uriParts as $part) {
+            if (is_string($part)) {
+                $uriDisplayHtml .= Html::encode($part);
+
+                continue;
+            }
+
+            $uriDisplayHtml .= Html::encodeParams(
+                '<span class="token" data-name="{name}" data-value="{value}"><span>{name}</span></span>',
+                [
+                    'name' => $part[0],
+                    'value' => $part[1],
+                ],
+            );
+        }
+
+        return $uriDisplayHtml;
+    }
+}

src/Route/Data/Route.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Route\Events;
+
+final class DeletingRoute extends RouteEvent {}