. */ declare(strict_types=1); namespace Fisharebest\Webtrees\Http\Middleware; use Aura\Router\RouterContainer; use Aura\Router\Rule\Accepts; use Aura\Router\Rule\Allows; use Fig\Http\Message\StatusCodeInterface; use Fisharebest\Webtrees\Registry; use Fisharebest\Webtrees\Services\ModuleService; use Fisharebest\Webtrees\Services\TreeService; use Fisharebest\Webtrees\Tree; use Middleland\Dispatcher; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use function app; use function array_map; use function response; use function str_contains; /** * Simple class to help migrate to a third-party routing library. */ class Router implements MiddlewareInterface { /** @var ModuleService */ private $module_service; /** @var RouterContainer */ private $router_container; /** @var TreeService */ private $tree_service; /** * Router constructor. * * @param ModuleService $module_service * @param RouterContainer $router_container * @param TreeService $tree_service */ public function __construct(ModuleService $module_service, RouterContainer $router_container, TreeService $tree_service) { $this->module_service = $module_service; $this->router_container = $router_container; $this->tree_service = $tree_service; } /** * @param ServerRequestInterface $request * @param RequestHandlerInterface $handler * * @return ResponseInterface */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { // Turn the ugly URL into a pretty one, so the router can parse it. $pretty = $request; if ($request->getAttribute('rewrite_urls') !== '1') { // Ugly URLs store the path in a query parameter. $url_route = $request->getQueryParams()['route'] ?? ''; $uri = $request->getUri()->withPath($url_route); $pretty = $request->withUri($uri); } // Match the request to a route. $matcher = $this->router_container->getMatcher(); $route = $matcher->match($pretty); // No route matched? if ($route === false) { $failed_route = $matcher->getFailedRoute(); switch ($failed_route->failedRule) { case Allows::class: return response('', StatusCodeInterface::STATUS_METHOD_NOT_ALLOWED, [ 'Allow' => implode(', ', $failed_route->allows), ]); case Accepts::class: // We don't use this, but modules might. return response('Negotiation failed', StatusCodeInterface::STATUS_NOT_ACCEPTABLE); default: // Not found return $handler->handle($request); } } // Add the route as attribute of the request $request = $request->withAttribute('route', $route); // This middleware cannot run until after the routing, as it needs to know the route. $post_routing_middleware = [CheckCsrf::class]; $post_routing_middleware = array_map('app', $post_routing_middleware); // Firstly, apply the route middleware $route_middleware = $route->extras['middleware'] ?? []; $route_middleware = array_map('app', $route_middleware); // Secondly, apply any module middleware $module_middleware = $this->module_service->findByInterface(MiddlewareInterface::class)->all(); // Finally, run the handler using middleware $handler_middleware = [new WrapHandler($route->handler)]; $middleware = array_merge( $post_routing_middleware, $route_middleware, $module_middleware, $handler_middleware ); // Add the matched attributes to the request. foreach ($route->attributes as $key => $value) { if ($key === 'tree') { $value = $this->tree_service->all()->get($value); app()->instance(Tree::class, $value); // Missing mandatory parameter? Let the default handler take care of it. if ($value === null && str_contains($route->path, '{tree}')) { return $handler->handle($request); } } $request = $request->withAttribute((string) $key, $value); } // Bind the request into the container app()->instance(ServerRequestInterface::class, $request); $dispatcher = new Dispatcher($middleware, app()); // These are deprecated, and will be removed in webtrees 2.1.0 app()->instance('cache.array', Registry::cache()->array()); app()->instance('cache.files', Registry::cache()->file()); // These are deprecated, and will be removed in webtrees 2.1.0 $request = $request ->withAttribute('filesystem.data', Registry::filesystem()->data()) ->withAttribute('filesystem.data.name', Registry::filesystem()->dataName()) ->withAttribute('filesystem.root', Registry::filesystem()->root()) ->withAttribute('filesystem.root.name', Registry::filesystem()->rootName()); return $dispatcher->dispatch($request); } }