xref: /webtrees/app/Http/RequestHandlers/RobotsTxt.php (revision 30e63383b10bafff54347985dcdbd10c40c33f62) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 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 Psr\Http\Message\ResponseInterface;
26use Psr\Http\Message\ServerRequestInterface;
27use Psr\Http\Server\RequestHandlerInterface;
28
29use function response;
30
31use const PHP_URL_PATH;
32
33/**
34 * Generate a robots exclusion file.
35 *
36 * @link https://robotstxt.org
37 */
38class RobotsTxt implements RequestHandlerInterface
39{
40    private const DISALLOWED_PATHS = [
41        'admin',
42        'manager',
43        'moderator',
44        'editor',
45        'account',
46    ];
47
48    private ModuleService $module_service;
49
50    /**
51     * @param ModuleService $module_service
52     */
53    public function __construct(ModuleService $module_service)
54    {
55        $this->module_service = $module_service;
56    }
57
58    /**
59     * @param ServerRequestInterface $request
60     *
61     * @return ResponseInterface
62     */
63    public function handle(ServerRequestInterface $request): ResponseInterface
64    {
65        $base_url = $request->getAttribute('base_url');
66
67        $data = [
68            'bad_user_agents'  => BadBotBlocker::BAD_ROBOTS,
69            'base_url'         => $base_url,
70            'base_path'        => parse_url($base_url, PHP_URL_PATH) ?? '',
71            'disallowed_paths' => self::DISALLOWED_PATHS,
72            'sitemap_url'      => '',
73        ];
74
75        $sitemap_module = $this->module_service->findByInterface(SiteMapModule::class)->first();
76
77        if ($sitemap_module instanceof SiteMapModule) {
78            $data['sitemap_url'] = route('sitemap-index');
79        }
80
81        return response(view('robots-txt', $data))
82            ->withHeader('Content-type', 'text/plain');
83    }
84}
85