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