Passed
Push — master ( 2b0d92...f30742 )
by Greg
07:05
created

Router   A

Complexity

Total Complexity 8

Size/Duplication

Total Lines 96
Duplicated Lines 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 36
c 1
b 0
f 0
dl 0
loc 96
rs 10
wmc 8

2 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 5 1
B process() 0 65 7
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
18
declare(strict_types=1);
19
20
namespace Fisharebest\Webtrees\Http\Middleware;
21
22
use Aura\Router\RouterContainer;
23
use Fisharebest\Webtrees\Exceptions\HttpNotFoundException;
24
use Fisharebest\Webtrees\Services\ModuleService;
25
use Fisharebest\Webtrees\Services\TreeService;
26
use Fisharebest\Webtrees\Tree;
27
use Middleland\Dispatcher;
28
use Psr\Http\Message\ResponseInterface;
29
use Psr\Http\Message\ServerRequestInterface;
30
use Psr\Http\Server\MiddlewareInterface;
31
use Psr\Http\Server\RequestHandlerInterface;
32
33
use function app;
34
use function array_map;
35
36
/**
37
 * Simple class to help migrate to a third-party routing library.
38
 */
39
class Router implements MiddlewareInterface
40
{
41
    /** @var ModuleService */
42
    private $module_service;
43
44
    /** @var RouterContainer */
45
    private $router_container;
46
47
    /** @var TreeService */
48
    private $tree_service;
49
50
    /**
51
     * Router constructor.
52
     *
53
     * @param ModuleService   $module_service
54
     * @param RouterContainer $router_container
55
     * @param TreeService     $tree_service
56
     */
57
    public function __construct(ModuleService $module_service, RouterContainer $router_container, TreeService $tree_service)
58
    {
59
        $this->module_service   = $module_service;
60
        $this->router_container = $router_container;
61
        $this->tree_service     = $tree_service;
62
    }
63
64
    /**
65
     * @param ServerRequestInterface  $request
66
     * @param RequestHandlerInterface $handler
67
     *
68
     * @return ResponseInterface
69
     */
70
    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
71
    {
72
        // Turn the ugly URL into a pretty one, so the router can parse it.
73
        $pretty = $request;
74
75
        if ($request->getAttribute('rewrite_urls') !== '1') {
76
            // Ugly URLs store the path in a query parameter.
77
            $url_route = $request->getQueryParams()['route'] ?? '';
78
            $uri       = $request->getUri()->withPath($url_route);
79
            $pretty    = $request->withUri($uri);
80
        }
81
82
        // Match the request to a route.
83
        $route = $this->router_container->getMatcher()->match($pretty);
84
85
        // No route matched? Let the default handler take care of it
86
        if ($route === false) {
87
            return $handler->handle($request);
88
        }
89
90
        // Add the route as attribute of the request
91
        $request = $request->withAttribute('route', $route);
92
93
        // This middleware needs cannot run until after the routing, as it needs to know the route.
94
        $post_routing_middleware = [CheckCsrf::class];
95
        $post_routing_middleware = array_map('app', $post_routing_middleware);
96
97
        // Firstly, apply the route middleware
98
        $route_middleware = $route->extras['middleware'] ?? [];
99
        $route_middleware = array_map('app', $route_middleware);
100
101
        // Secondly, apply any module middleware
102
        $module_middleware = $this->module_service->findByInterface(MiddlewareInterface::class)->all();
103
104
        // Finally, run the handler using middleware
105
        $handler_middleware = [new WrapHandler($route->handler)];
106
107
        $middleware = array_merge(
108
            $post_routing_middleware,
109
            $route_middleware,
110
            $module_middleware,
111
            $handler_middleware
112
        );
113
114
        // Add the matched attributes to the request.
115
        foreach ($route->attributes as $key => $value) {
116
            if ($key === 'tree') {
117
                $value = $this->tree_service->all()->get($value);
118
                app()->instance(Tree::class, $value);
119
120
                // Missing mandatory parameter? Let the default handler take care of it.
121
                if ($value === null && strpos($route->path, '{tree}') !== false) {
122
                    return $handler->handle($request);
123
                }
124
            }
125
126
            $request = $request->withAttribute((string) $key, $value);
127
        }
128
129
        // Bind the request into the container
130
        app()->instance(ServerRequestInterface::class, $request);
131
132
        $dispatcher = new Dispatcher($middleware, app());
133
134
        return $dispatcher->dispatch($request);
135
    }
136
}
137