xref: /webtrees/app/Module/LocationListModule.php (revision b55cbc6b43247e8b2ad14af6f6d24dc6747195ff) 
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\Module;
21
22use Aura\Router\RouterContainer;
23use Fisharebest\Webtrees\Auth;
24use Fisharebest\Webtrees\GedcomRecord;
25use Fisharebest\Webtrees\I18N;
26use Fisharebest\Webtrees\Location;
27use Fisharebest\Webtrees\Registry;
28use Fisharebest\Webtrees\Tree;
29use Fisharebest\Webtrees\Validator;
30use Illuminate\Database\Capsule\Manager as DB;
31use Psr\Http\Message\ResponseInterface;
32use Psr\Http\Message\ServerRequestInterface;
33use Psr\Http\Server\RequestHandlerInterface;
34
35use function app;
36use function assert;
37use function redirect;
38
39/**
40 * Class LocationListModule
41 */
42class LocationListModule extends AbstractModule implements ModuleListInterface, RequestHandlerInterface
43{
44    use ModuleListTrait;
45
46    protected const ROUTE_URL = '/tree/{tree}/location-list';
47
48    /** @var int The default access level for this module.  It can be changed in the control panel. */
49    protected int $access_level = Auth::PRIV_USER;
50
51    /**
52     * Initialization.
53     *
54     * @return void
55     */
56    public function boot(): void
57    {
58        $router_container = app(RouterContainer::class);
59        assert($router_container instanceof RouterContainer);
60
61        $router_container->getMap()
62            ->get(static::class, static::ROUTE_URL, $this);
63    }
64
65    /**
66     * How should this module be identified in the control panel, etc.?
67     *
68     * @return string
69     */
70    public function title(): string
71    {
72        /* I18N: Name of a module/list */
73        return I18N::translate('Locations');
74    }
75
76    /**
77     * A sentence describing what this module does.
78     *
79     * @return string
80     */
81    public function description(): string
82    {
83        /* I18N: Description of the “Locations” module */
84        return I18N::translate('A list of locations.');
85    }
86
87    /**
88     * CSS class for the URL.
89     *
90     * @return string
91     */
92    public function listMenuClass(): string
93    {
94        return 'menu-list-loc';
95    }
96
97    /**
98     * @return array<string>
99     */
100    public function listUrlAttributes(): array
101    {
102        return [];
103    }
104
105    /**
106     * @param Tree $tree
107     *
108     * @return bool
109     */
110    public function listIsEmpty(Tree $tree): bool
111    {
112        return !DB::table('other')
113            ->where('o_file', '=', $tree->id())
114            ->where('o_type', '=', Location::RECORD_TYPE)
115            ->exists();
116    }
117
118    /**
119     * Handle URLs generated by older versions of webtrees
120     *
121     * @param ServerRequestInterface $request
122     *
123     * @return ResponseInterface
124     */
125    public function getListAction(ServerRequestInterface $request): ResponseInterface
126    {
127        $tree = Validator::attributes($request)->tree();
128
129        return redirect($this->listUrl($tree, $request->getQueryParams()));
130    }
131
132    /**
133     * @param Tree                                      $tree
134     * @param array<bool|int|string|array<string>|null> $parameters
135     *
136     * @return string
137     */
138    public function listUrl(Tree $tree, array $parameters = []): string
139    {
140        $parameters['tree'] = $tree->name();
141
142        return route(static::class, $parameters);
143    }
144
145    /**
146     * @param ServerRequestInterface $request
147     *
148     * @return ResponseInterface
149     */
150    public function handle(ServerRequestInterface $request): ResponseInterface
151    {
152        $tree = Validator::attributes($request)->tree();
153        $user = Validator::attributes($request)->user();
154
155        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
156
157        $locations = DB::table('other')
158            ->where('o_file', '=', $tree->id())
159            ->where('o_type', '=', Location::RECORD_TYPE)
160            ->get()
161            ->map(Registry::locationFactory()->mapper($tree))
162            ->filter(GedcomRecord::accessFilter());
163
164        return $this->viewResponse('modules/location-list/page', [
165            'locations' => $locations,
166            'title'     => I18N::translate('Locations'),
167            'tree'      => $tree,
168        ]);
169    }
170}
171