xref: /webtrees/app/Http/RequestHandlers/RobotsTxt.php (revision 6c026d70d897d8076941fd1e54b2af814be913d5) 
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\RequestHandlers;
21
22use Fisharebest\Webtrees\Http\Middleware\BadBotBlocker;
23use Fisharebest\Webtrees\Module\SiteMapModule;
24use Fisharebest\Webtrees\Services\ModuleService;
25use Fisharebest\Webtrees\Services\TreeService;
26use Fisharebest\Webtrees\Tree;
27use Fisharebest\Webtrees\Validator;
28use Psr\Http\Message\ResponseInterface;
29use Psr\Http\Message\ServerRequestInterface;
30use Psr\Http\Server\RequestHandlerInterface;
31
32use function response;
33
34use const PHP_URL_PATH;
35
36/**
37 * Generate a robots exclusion file.
38 *
39 * @link https://robotstxt.org
40 */
41class RobotsTxt implements RequestHandlerInterface
42{
43    private const DISALLOWED_PATHS = [
44        'admin',
45        'manager',
46        'moderator',
47        'editor',
48        'account',
49    ];
50
51    private ModuleService $module_service;
52
53    private TreeService $tree_service;
54
55    /**
56     * @param ModuleService $module_service
57     */
58    public function __construct(ModuleService $module_service, TreeService $tree_service)
59    {
60        $this->module_service = $module_service;
61        $this->tree_service   = $tree_service;
62    }
63
64    /**
65     * @param ServerRequestInterface $request
66     *
67     * @return ResponseInterface
68     */
69    public function handle(ServerRequestInterface $request): ResponseInterface
70    {
71        $base_url = Validator::attributes($request)->string('base_url');
72        $trees    = $this->tree_service->all()->map(static fn (Tree $tree): string => $tree->name());
73
74        $data = [
75            'bad_user_agents'  => BadBotBlocker::BAD_ROBOTS,
76            'base_url'         => $base_url,
77            'base_path'        => parse_url($base_url, PHP_URL_PATH) ?? '',
78            'disallowed_paths' => self::DISALLOWED_PATHS,
79            'sitemap_url'      => '',
80            'trees'            => $trees,
81        ];
82
83        $sitemap_module = $this->module_service->findByInterface(SiteMapModule::class)->first();
84
85        if ($sitemap_module instanceof SiteMapModule) {
86            $data['sitemap_url'] = route('sitemap-index');
87        }
88
89        return response(view('robots-txt', $data))
90            ->withHeader('content-type', 'text/plain');
91    }
92}
93