xref: /webtrees/app/Http/RequestHandlers/ModuleAction.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\RequestHandlers;
21
22use Fisharebest\Webtrees\Auth;
23use Fisharebest\Webtrees\Contracts\UserInterface;
24use Fisharebest\Webtrees\Http\Exceptions\HttpAccessDeniedException;
25use Fisharebest\Webtrees\Http\Exceptions\HttpNotFoundException;
26use Fisharebest\Webtrees\Services\ModuleService;
27use Fisharebest\Webtrees\Validator;
28use Psr\Http\Message\ResponseInterface;
29use Psr\Http\Message\ServerRequestInterface;
30use Psr\Http\Server\RequestHandlerInterface;
31
32use function call_user_func;
33use function method_exists;
34use function str_contains;
35use function strtolower;
36
37/**
38 * Controller for module actions.
39 */
40class ModuleAction implements RequestHandlerInterface
41{
42    private ModuleService $module_service;
43
44    /**
45     * @param ModuleService $module_service
46     */
47    public function __construct(ModuleService $module_service)
48    {
49        $this->module_service = $module_service;
50    }
51
52    /**
53     * Perform an HTTP action for one of the modules.
54     *
55     * @param ServerRequestInterface $request
56     *
57     * @return ResponseInterface
58     */
59    public function handle(ServerRequestInterface $request): ResponseInterface
60    {
61        $module_name = $request->getAttribute('module');
62        $action      = $request->getAttribute('action');
63        $user        = Validator::attributes($request)->user();
64
65        // Check that the module is enabled.
66        // The module itself will need to check any tree-level access,
67        // which may be different for each component (tab, menu, etc.) of the module.
68        $module = $this->module_service->findByName($module_name);
69
70        if ($module === null) {
71            throw new HttpNotFoundException('Module ' . $module_name . ' does not exist');
72        }
73
74        // We'll call a function such as Module::getFooBarAction()
75        $verb   = strtolower($request->getMethod());
76        $method = $verb . $action . 'Action';
77
78        // Actions with "Admin" in the name are for administrators only.
79        if (str_contains($action, 'Admin') && !Auth::isAdmin($user)) {
80            throw new HttpAccessDeniedException('Admin only action');
81        }
82
83        if (!method_exists($module, $method)) {
84            throw new HttpNotFoundException('Method ' . $method . '() not found in ' . $module_name);
85        }
86
87        return $module->$method($request);
88    }
89}
90