xref: /webtrees/app/Http/Middleware/Router.php (revision 15c4f62c40de0c794536302daf7d5ec0548a1973) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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 <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Http\Middleware;
21
22use Aura\Router\Route;
23use Aura\Router\RouterContainer;
24use Aura\Router\Rule\Accepts;
25use Aura\Router\Rule\Allows;
26use Fig\Http\Message\StatusCodeInterface;
27use Fisharebest\Webtrees\Registry;
28use Fisharebest\Webtrees\Services\ModuleService;
29use Fisharebest\Webtrees\Services\TreeService;
30use Fisharebest\Webtrees\Tree;
31use Fisharebest\Webtrees\Validator;
32use Fisharebest\Webtrees\Webtrees;
33use Middleland\Dispatcher;
34use Psr\Http\Message\ResponseInterface;
35use Psr\Http\Message\ServerRequestInterface;
36use Psr\Http\Server\MiddlewareInterface;
37use Psr\Http\Server\RequestHandlerInterface;
38
39use function explode;
40use function implode;
41use function str_contains;
42
43/**
44 * Simple class to help migrate to a third-party routing library.
45 */
46class Router implements MiddlewareInterface
47{
48    private ModuleService $module_service;
49
50    private RouterContainer $router_container;
51
52    private TreeService $tree_service;
53
54    /**
55     * @param ModuleService   $module_service
56     * @param RouterContainer $router_container
57     * @param TreeService     $tree_service
58     */
59    public function __construct(
60        ModuleService $module_service,
61        RouterContainer $router_container,
62        TreeService $tree_service
63    ) {
64        $this->module_service   = $module_service;
65        $this->router_container = $router_container;
66        $this->tree_service     = $tree_service;
67    }
68
69    /**
70     * @param ServerRequestInterface  $request
71     * @param RequestHandlerInterface $handler
72     *
73     * @return ResponseInterface
74     */
75    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
76    {
77        // Ugly URLs store the path in a query parameter.
78        $url_route = Validator::queryParams($request)->string('route', '');
79
80        if (Validator::attributes($request)->boolean('rewrite_urls', false)) {
81            // We are creating pretty URLs, but received an ugly one. Probably a search-engine. Redirect it.
82            if ($url_route !== '') {
83                $uri = $request->getUri()
84                    ->withPath($url_route)
85                    ->withQuery(explode('&', $request->getUri()->getQuery(), 2)[1] ?? '');
86
87                return Registry::responseFactory()
88                    ->redirectUrl($uri, StatusCodeInterface::STATUS_PERMANENT_REDIRECT)
89                    ->withHeader('Link', '<' . $uri . '>; rel="canonical"');
90            }
91
92            $pretty = $request;
93        } else {
94            // Turn the ugly URL into a pretty one, so the router can parse it.
95            $uri    = $request->getUri()->withPath($url_route);
96            $pretty = $request->withUri($uri);
97        }
98
99        // Match the request to a route.
100        $matcher = $this->router_container->getMatcher();
101        $route   = $matcher->match($pretty);
102
103        // No route matched?
104        if ($route === false) {
105            $failed_route = $matcher->getFailedRoute();
106
107            if ($failed_route instanceof Route) {
108                if ($failed_route->failedRule === Allows::class) {
109                    return Registry::responseFactory()->response('', StatusCodeInterface::STATUS_METHOD_NOT_ALLOWED, [
110                        'Allow' => implode(', ', $failed_route->allows),
111                    ]);
112                }
113
114                if ($failed_route->failedRule === Accepts::class) {
115                    return Registry::responseFactory()->response('Negotiation failed', StatusCodeInterface::STATUS_NOT_ACCEPTABLE);
116                }
117            }
118
119            // Not found
120            return $handler->handle($request);
121        }
122
123        // Add the route as attribute of the request
124        $request = $request->withAttribute('route', $route);
125
126        // This middleware cannot run until after the routing, as it needs to know the route.
127        $post_routing_middleware = [CheckCsrf::class];
128
129        // Firstly, apply the route middleware
130        $route_middleware = $route->extras['middleware'] ?? [];
131
132        // Secondly, apply any module middleware
133        $module_middleware = $this->module_service->findByInterface(MiddlewareInterface::class)->all();
134
135        // Finally, run the handler using middleware
136        $handler_middleware = [RequestHandler::class];
137
138        $middleware = array_merge(
139            $post_routing_middleware,
140            $route_middleware,
141            $module_middleware,
142            $handler_middleware
143        );
144
145        // Add the matched attributes to the request.
146        foreach ($route->attributes as $key => $value) {
147            if ($key === 'tree') {
148                $value = $this->tree_service->all()->get($value);
149
150                if ($value instanceof Tree) {
151                    Registry::container()->set(Tree::class, $value);
152                }
153
154                // Missing mandatory parameter? Let the default handler take care of it.
155                if ($value === null && str_contains($route->path, '{tree}')) {
156                    return $handler->handle($request);
157                }
158            }
159
160            $request = $request->withAttribute((string) $key, $value);
161        }
162
163        // Bind the updated request into the container
164        Registry::container()->set(ServerRequestInterface::class, $request);
165
166        $dispatcher = new Dispatcher($middleware, Registry::container());
167
168        return $dispatcher->dispatch($request);
169    }
170}
171