xref: /webtrees/app/Http/Middleware/ClientIp.php (revision e99ac601cee7ced57ac8545ceba47ece1b15d883) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2022 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 Psr\Http\Message\ResponseInterface;
23use Psr\Http\Message\ServerRequestInterface;
24use Psr\Http\Server\RequestHandlerInterface;
25
26use function explode;
27
28/**
29 * Middleware to detect the client's IP address.
30 */
31class ClientIp extends \Middlewares\ClientIp
32{
33    /**
34     * @param ServerRequestInterface  $request
35     * @param RequestHandlerInterface $handler
36     *
37     * @return ResponseInterface
38     */
39    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
40    {
41        // The configuration comes from config.ini.php, via request attributes.
42        $trusted_headers = $this->getCommaSeparatedAttribute($request, 'trusted_headers');
43        $trusted_proxies = $this->getCommaSeparatedAttribute($request, 'trusted_proxies');
44
45        $this->proxy($trusted_proxies, $trusted_headers);
46
47        return parent::process($request, $handler);
48    }
49
50    /**
51     * @param ServerRequestInterface $request
52     * @param string                 $attribute
53     *
54     * @return array<string>
55     */
56    private function getCommaSeparatedAttribute(ServerRequestInterface $request, string $attribute): array
57    {
58        $value = $request->getAttribute($attribute);
59
60        if ($value === null) {
61            return [];
62        }
63
64        return explode(',', $value);
65    }
66}
67