xref: /webtrees/app/Http/Middleware/Router.php (revision 71378461661e7642e52abe7d41c9cfffb3e5369b) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17declare(strict_types=1);
18
19namespace Fisharebest\Webtrees\Http\Middleware;
20
21use Aura\Router\RouterContainer;
22use Fisharebest\Webtrees\Services\ModuleService;
23use Fisharebest\Webtrees\Tree;
24use Fisharebest\Webtrees\View;
25use Middleland\Dispatcher;
26use Psr\Http\Message\ResponseInterface;
27use Psr\Http\Message\ServerRequestInterface;
28use Psr\Http\Server\MiddlewareInterface;
29use Psr\Http\Server\RequestHandlerInterface;
30
31use function app;
32use function array_map;
33
34/**
35 * Simple class to help migrate to a third-party routing library.
36 */
37class Router implements MiddlewareInterface
38{
39    /** @var ModuleService */
40    private $module_service;
41
42    /**
43     * Router constructor.
44     *
45     * @param ModuleService $module_service
46     */
47    public function __construct(ModuleService $module_service)
48    {
49        $this->module_service = $module_service;
50    }
51
52    /**
53     * @param ServerRequestInterface  $request
54     * @param RequestHandlerInterface $handler
55     *
56     * @return ResponseInterface
57     */
58    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
59    {
60        if ($request->getAttribute('rewrite_urls') !== '1') {
61            // Turn the ugly URL into a pretty one.
62            $params = $request->getQueryParams();
63            $route  = $params['route'] ?? '';
64            unset($params['route']);
65            $uri     = $request->getUri()->withPath($route);
66            $request = $request->withUri($uri)->withQueryParams($params);
67        }
68
69        // Bind the request into the container and the layout
70        app()->instance(ServerRequestInterface::class, $request);
71        View::share('request', $request);
72
73        // Match the request to a route.
74        $route = app(RouterContainer::class)->getMatcher()->match($request);
75
76        // No route matched?
77        if ($route === false) {
78            return $handler->handle($request);
79        }
80
81        // Firstly, apply the route middleware
82        $route_middleware = $route->extras['middleware'] ?? [];
83        $route_middleware = array_map('app', $route_middleware);
84
85        // Secondly, apply any module middleware
86        $module_middleware = $this->module_service->findByInterface(MiddlewareInterface::class)->all();
87
88        // Add the route as attribute of the request
89        $request = $request->withAttribute('route', $route->name);
90
91        // Finally, run the handler using middleware
92        $handler_middleware = [new WrapHandler($route->handler)];
93
94        $middleware = array_merge($route_middleware, $module_middleware, $handler_middleware);
95
96        // Add the matched attributes to the request.
97        foreach ($route->attributes as $key => $value) {
98            if ($key === 'tree') {
99                $value = Tree::findByName($value);
100            }
101            $request = $request->withAttribute($key, $value);
102        }
103
104        $dispatcher = new Dispatcher($middleware, app());
105
106        return $dispatcher->dispatch($request);
107    }
108}
109