Refactor Route Resolving and Dispatch (#2425)

- Split DispatchRoute. This allows us to run middleware after we figure out which route we're on, but before we actually execute the controller for that route.
- By making the route name explicitly available to middlewares, applications like CSRF and floodgate can set patterns based on route names instead of the path, which is an implementation detail.
- Support using route name match for CSRF extender, deprecate path match

framework/core/src/Http/HttpServiceProvider.php

@@ -19,7 +19,7 @@ class HttpServiceProvider extends AbstractServiceProvider
     public function register()
     {
         $this->app->singleton('flarum.http.csrfExemptPaths', function () {
-            return ['/api/token'];
+            return ['token'];
         });
 
         $this->app->bind(Middleware\CheckCsrfToken::class, function ($app) {

framework/core/src/Http/Middleware/CheckCsrfToken.php

@@ -28,7 +28,10 @@ class CheckCsrfToken implements Middleware
     {
         $path = $request->getAttribute('originalUri')->getPath();
         foreach ($this->exemptRoutes as $exemptRoute) {
-            if (fnmatch($exemptRoute, $path)) {
+            /**
+             * @deprecated path match should be removed in beta 16, only route name match should be supported.
+             */
+            if ($exemptRoute === $request->getAttribute('routeName') || fnmatch($exemptRoute, $path)) {
                 return $handler->handle($request);
             }
         }

framework/core/src/Http/Middleware/ExecuteRoute.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of Flarum.
+ *
+ * For detailed copyright and license information, please view the
+ * LICENSE file that was distributed with this source code.
+ */
+
+namespace Flarum\Http\Middleware;
+
+use Psr\Http\Message\ResponseInterface as Response;
+use Psr\Http\Message\ServerRequestInterface as Request;
+use Psr\Http\Server\MiddlewareInterface as Middleware;
+use Psr\Http\Server\RequestHandlerInterface as Handler;
+
+class ExecuteRoute implements Middleware
+{
+    /**
+     * Executes the route handler resolved in ResolveRoute.
+     */
+    public function process(Request $request, Handler $handler): Response
+    {
+        $handler = $request->getAttribute('routeHandler');
+        $parameters = $request->getAttribute('routeParameters');
+
+        return $handler($request, $parameters);
+    }
+}

framework/core/src/Http/Middleware/ResolveRoute.php

@@ -18,7 +18,7 @@ use Psr\Http\Message\ServerRequestInterface as Request;
 use Psr\Http\Server\MiddlewareInterface as Middleware;
 use Psr\Http\Server\RequestHandlerInterface as Handler;
 
-class DispatchRoute implements Middleware
+class ResolveRoute implements Middleware
 {
     /**
      * @var RouteCollection
@@ -41,7 +41,7 @@ class DispatchRoute implements Middleware
     }
 
     /**
-     * Dispatch the given request to our route collection.
+     * Resolve the given request from our route collection.
      *
      * @throws MethodNotAllowedException
      * @throws RouteNotFoundException
@@ -59,10 +59,12 @@ class DispatchRoute implements Middleware
             case Dispatcher::METHOD_NOT_ALLOWED:
                 throw new MethodNotAllowedException($method);
             case Dispatcher::FOUND:
-                $handler = $routeInfo[1];
-                $parameters = $routeInfo[2];
+                $request = $request
+                    ->withAttribute('routeName', $routeInfo[1]['name'])
+                    ->withAttribute('routeHandler', $routeInfo[1]['handler'])
+                    ->withAttribute('routeParameters', $routeInfo[2]);
 
-                return $handler($request, $parameters);
+                return $handler->handle($request);
         }
     }
 

framework/core/src/Http/RouteCollection.php

@@ -66,7 +66,7 @@ class RouteCollection
         $routeDatas = $this->routeParser->parse($path);
 
         foreach ($routeDatas as $routeData) {
-            $this->dataGenerator->addRoute($method, $routeData, $handler);
+            $this->dataGenerator->addRoute($method, $routeData, ['name' => $name, 'handler' => $handler]);
         }
 
         $this->reverse[$name] = $routeDatas;