fisharebest /
webtrees
| 1 | <?php |
||
| 2 | |||
| 3 | /** |
||
| 4 | * webtrees: online genealogy |
||
| 5 | * Copyright (C) 2025 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 | |||
| 18 | declare(strict_types=1); |
||
| 19 | |||
| 20 | namespace Fisharebest\Webtrees\Http\RequestHandlers; |
||
| 21 | |||
| 22 | use Fisharebest\Webtrees\Http\Middleware\BadBotBlocker; |
||
| 23 | use Fisharebest\Webtrees\Module\SiteMapModule; |
||
| 24 | use Fisharebest\Webtrees\Services\ModuleService; |
||
| 25 | use Fisharebest\Webtrees\Services\TreeService; |
||
| 26 | use Fisharebest\Webtrees\Tree; |
||
| 27 | use Fisharebest\Webtrees\Validator; |
||
| 28 | use Psr\Http\Message\ResponseInterface; |
||
| 29 | use Psr\Http\Message\ServerRequestInterface; |
||
| 30 | use Psr\Http\Server\RequestHandlerInterface; |
||
| 31 | |||
| 32 | use function response; |
||
| 33 | |||
| 34 | use const PHP_URL_PATH; |
||
| 35 | |||
| 36 | /** |
||
| 37 | * Generate a robots exclusion file. |
||
| 38 | * |
||
| 39 | * @link https://robotstxt.org |
||
| 40 | */ |
||
| 41 | class RobotsTxt implements RequestHandlerInterface |
||
| 42 | { |
||
| 43 | private const array DISALLOWED_PATHS = [ |
||
|
0 ignored issues
–
show
Bug
introduced
by
Loading history...
|
|||
| 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 | public function __construct(ModuleService $module_service, TreeService $tree_service) |
||
| 56 | { |
||
| 57 | $this->module_service = $module_service; |
||
| 58 | $this->tree_service = $tree_service; |
||
| 59 | } |
||
| 60 | |||
| 61 | public function handle(ServerRequestInterface $request): ResponseInterface |
||
| 62 | { |
||
| 63 | $base_url = Validator::attributes($request)->string('base_url'); |
||
| 64 | $trees = $this->tree_service->all()->map(static fn (Tree $tree): string => $tree->name()); |
||
| 65 | |||
| 66 | $data = [ |
||
| 67 | 'bad_user_agents' => BadBotBlocker::BAD_ROBOTS, |
||
| 68 | 'base_url' => $base_url, |
||
| 69 | 'base_path' => parse_url($base_url, PHP_URL_PATH) ?? '', |
||
| 70 | 'disallowed_paths' => self::DISALLOWED_PATHS, |
||
| 71 | 'sitemap_url' => '', |
||
| 72 | 'trees' => $trees, |
||
| 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 |