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