xref: /webtrees/app/Http/Middleware/Router.php (revision f5402f3dbd759ec94d88460e5ae9815f9b823dae) 
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 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Http\Middleware;
21
22use Aura\Router\RouterContainer;
23use Fisharebest\Webtrees\Services\ModuleService;
24use Fisharebest\Webtrees\Services\TreeService;
25use Fisharebest\Webtrees\Tree;
26use Fisharebest\Webtrees\View;
27use Middleland\Dispatcher;
28use Psr\Http\Message\ResponseInterface;
29use Psr\Http\Message\ServerRequestInterface;
30use Psr\Http\Server\MiddlewareInterface;
31use Psr\Http\Server\RequestHandlerInterface;
32
33use function app;
34use function array_map;
35use function http_build_query;
36
37use const PHP_QUERY_RFC3986;
38
39/**
40 * Simple class to help migrate to a third-party routing library.
41 */
42class Router implements MiddlewareInterface
43{
44    /** @var ModuleService */
45    private $module_service;
46
47    /** @var RouterContainer */
48    private $router_container;
49
50    /** @var TreeService */
51    private $tree_service;
52
53    /**
54     * Router constructor.
55     *
56     * @param ModuleService   $module_service
57     * @param RouterContainer $router_container
58     * @param TreeService     $tree_service
59     */
60    public function __construct(ModuleService $module_service, RouterContainer $router_container, TreeService $tree_service)
61    {
62        $this->module_service   = $module_service;
63        $this->router_container = $router_container;
64        $this->tree_service     = $tree_service;
65    }
66
67    /**
68     * @param ServerRequestInterface  $request
69     * @param RequestHandlerInterface $handler
70     *
71     * @return ResponseInterface
72     */
73    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
74    {
75        // Turn the ugly URL into a pretty one, so the router can parse it.
76        if ($request->getAttribute('rewrite_urls') !== '1') {
77            $params    = $request->getQueryParams();
78            $url_route = $params['route'] ?? '';
79            unset($params['route']);
80            $uri = $request->getUri()
81                ->withPath($url_route)
82                ->withQuery(http_build_query($params, '', '&', PHP_QUERY_RFC3986));
83            $request = $request
84                ->withUri($uri)
85                ->withQueryParams($params);
86        }
87
88        // Match the request to a route.
89        $route = $this->router_container->getMatcher()->match($request);
90
91        // No route matched?
92        if ($route === false) {
93            // Bind the request into the container and the layout
94            app()->instance(ServerRequestInterface::class, $request);
95            View::share('request', $request);
96
97            return $handler->handle($request);
98        }
99
100        // Add the route as attribute of the request
101        $request = $request->withAttribute('route', $route->name);
102
103        // Firstly, apply the route middleware
104        $route_middleware = $route->extras['middleware'] ?? [];
105        $route_middleware = array_map('app', $route_middleware);
106
107        // Secondly, apply any module middleware
108        $module_middleware = $this->module_service->findByInterface(MiddlewareInterface::class)->all();
109
110        // Finally, run the handler using middleware
111        $handler_middleware = [new WrapHandler($route->handler)];
112
113        $middleware = array_merge($route_middleware, $module_middleware, $handler_middleware);
114
115        // Add the matched attributes to the request.
116        foreach ($route->attributes as $key => $value) {
117            if ($key === 'tree') {
118                $value = $this->tree_service->findByName($value);
119                // @TODO - this is still required by the date formatter.
120                app()->instance(Tree::class, $value);
121                // @TODO - this is still required by various view templates.
122                View::share('tree', $value);
123            }
124            $request = $request->withAttribute($key, $value);
125        }
126
127        // Bind the request into the container and the layout
128        app()->instance(ServerRequestInterface::class, $request);
129        View::share('request', $request);
130
131        $dispatcher = new Dispatcher($middleware, app());
132
133        return $dispatcher->dispatch($request);
134    }
135}
136