xref: /webtrees/app/Http/Middleware/Router.php (revision 4874f72da8279544d9c0a459e2920a9986acfaa0) 
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;
30use function app;
31use function array_map;
32use function http_build_query;
33use const PHP_QUERY_RFC3986;
34
35/**
36 * Simple class to help migrate to a third-party routing library.
37 */
38class Router implements MiddlewareInterface
39{
40    /** @var ModuleService */
41    private $module_service;
42
43    /** @var RouterContainer */
44    private $router_container;
45
46    /**
47     * Router constructor.
48     *
49     * @param ModuleService   $module_service
50     * @param RouterContainer $router_container
51     */
52    public function __construct(ModuleService $module_service, RouterContainer $router_container)
53    {
54        $this->module_service   = $module_service;
55        $this->router_container = $router_container;
56    }
57
58    /**
59     * @param ServerRequestInterface  $request
60     * @param RequestHandlerInterface $handler
61     *
62     * @return ResponseInterface
63     */
64    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
65    {
66        if ((bool) $request->getAttribute('rewrite_urls') === false) {
67            // Turn the ugly URL into a pretty one, so the router can parse it.
68            // Note that the 'route' parameter contains the full path.
69            $uri       = $request->getUri();
70            $params    = $request->getQueryParams();
71            $url_route = $params['route'] ?? '/';
72            $uri       = $uri->withPath($url_route);
73            unset($params['route']);
74            $uri     = $uri->withQuery(http_build_query($params, '', '&', PHP_QUERY_RFC3986));
75            $request = $request->withUri($uri)->withQueryParams($params);
76        }
77
78        // Match the request to a route.
79        $route = $this->router_container->getMatcher()->match($request);
80
81        // No route matched?
82        if ($route === false) {
83            // Bind the request into the container and the layout
84            app()->instance(ServerRequestInterface::class, $request);
85            View::share('request', $request);
86
87            return $handler->handle($request);
88        }
89
90        // Add the route as attribute of the request
91        $request = $request->withAttribute('route', $route->name);
92
93        // Firstly, apply the route middleware
94        $route_middleware = $route->extras['middleware'] ?? [];
95        $route_middleware = array_map('app', $route_middleware);
96
97        // Secondly, apply any module middleware
98        $module_middleware = $this->module_service->findByInterface(MiddlewareInterface::class)->all();
99
100        // Finally, run the handler using middleware
101        $handler_middleware = [new WrapHandler($route->handler)];
102
103        $middleware = array_merge($route_middleware, $module_middleware, $handler_middleware);
104
105        // Add the matched attributes to the request.
106        foreach ($route->attributes as $key => $value) {
107            if ($key === 'tree') {
108                $value = Tree::findByName($value);
109                // @TODO - this is still required for some legacy code.
110                app()->instance(Tree::class, $value);
111            }
112            $request = $request->withAttribute($key, $value);
113        }
114
115        // Bind the request into the container and the layout
116        app()->instance(ServerRequestInterface::class, $request);
117        View::share('request', $request);
118
119        $dispatcher = new Dispatcher($middleware, app());
120
121        return $dispatcher->dispatch($request);
122    }
123}
124