xref: /webtrees/app/Module/AncestorsChartModule.php (revision 54f9ed18c67402425839d8ad7a6ffd425b6361b8) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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 Fig\Http\Message\RequestMethodInterface;
23use Fisharebest\Webtrees\Auth;
24use Fisharebest\Webtrees\I18N;
25use Fisharebest\Webtrees\Individual;
26use Fisharebest\Webtrees\Menu;
27use Fisharebest\Webtrees\Registry;
28use Fisharebest\Webtrees\Services\ChartService;
29use Fisharebest\Webtrees\Validator;
30use Psr\Http\Message\ResponseInterface;
31use Psr\Http\Message\ServerRequestInterface;
32use Psr\Http\Server\RequestHandlerInterface;
33
34use function route;
35
36/**
37 * Class AncestorsChartModule
38 */
39class AncestorsChartModule extends AbstractModule implements ModuleChartInterface, RequestHandlerInterface
40{
41    use ModuleChartTrait;
42
43    protected const ROUTE_URL = '/tree/{tree}/ancestors-{style}-{generations}/{xref}';
44
45    // Chart styles
46    public const CHART_STYLE_TREE        = 'tree';
47    public const CHART_STYLE_INDIVIDUALS = 'individuals';
48    public const CHART_STYLE_FAMILIES    = 'families';
49
50    // Defaults
51    public const DEFAULT_GENERATIONS = '4';
52    public const DEFAULT_STYLE       = self::CHART_STYLE_TREE;
53    protected const DEFAULT_PARAMETERS  = [
54        'generations' => self::DEFAULT_GENERATIONS,
55        'style'       => self::DEFAULT_STYLE,
56    ];
57
58    // Limits
59    protected const MINIMUM_GENERATIONS = 2;
60    protected const MAXIMUM_GENERATIONS = 10;
61
62    private ChartService $chart_service;
63
64    /**
65     * @param ChartService $chart_service
66     */
67    public function __construct(ChartService $chart_service)
68    {
69        $this->chart_service = $chart_service;
70    }
71
72    /**
73     * Initialization.
74     *
75     * @return void
76     */
77    public function boot(): void
78    {
79        Registry::routeFactory()->routeMap()
80            ->get(static::class, static::ROUTE_URL, $this)
81            ->allows(RequestMethodInterface::METHOD_POST)
82            ->tokens([
83                'generations' => '\d+',
84                'style'       => implode('|', array_keys($this->styles())),
85            ]);
86    }
87
88    /**
89     * How should this module be identified in the control panel, etc.?
90     *
91     * @return string
92     */
93    public function title(): string
94    {
95        /* I18N: Name of a module/chart */
96        return I18N::translate('Ancestors');
97    }
98
99    /**
100     * A sentence describing what this module does.
101     *
102     * @return string
103     */
104    public function description(): string
105    {
106        /* I18N: Description of the “AncestorsChart” module */
107        return I18N::translate('A chart of an individual’s ancestors.');
108    }
109
110    /**
111     * CSS class for the URL.
112     *
113     * @return string
114     */
115    public function chartMenuClass(): string
116    {
117        return 'menu-chart-ancestry';
118    }
119
120    /**
121     * Return a menu item for this chart - for use in individual boxes.
122     */
123    public function chartBoxMenu(Individual $individual): Menu|null
124    {
125        return $this->chartMenu($individual);
126    }
127
128    /**
129     * The title for a specific instance of this chart.
130     *
131     * @param Individual $individual
132     *
133     * @return string
134     */
135    public function chartTitle(Individual $individual): string
136    {
137        /* I18N: %s is an individual’s name */
138        return I18N::translate('Ancestors of %s', $individual->fullName());
139    }
140
141    /**
142     * The URL for a page showing chart options.
143     *
144     * @param Individual                                $individual
145     * @param array<bool|int|string|array<string>|null> $parameters
146     *
147     * @return string
148     */
149    public function chartUrl(Individual $individual, array $parameters = []): string
150    {
151        return route(static::class, [
152                'xref' => $individual->xref(),
153                'tree' => $individual->tree()->name(),
154            ] + $parameters + self::DEFAULT_PARAMETERS);
155    }
156
157    /**
158     * @param ServerRequestInterface $request
159     *
160     * @return ResponseInterface
161     */
162    public function handle(ServerRequestInterface $request): ResponseInterface
163    {
164        $tree        = Validator::attributes($request)->tree();
165        $user        = Validator::attributes($request)->user();
166        $style       = Validator::attributes($request)->isInArrayKeys($this->styles())->string('style');
167        $xref        = Validator::attributes($request)->isXref()->string('xref');
168        $generations = Validator::attributes($request)->isBetween(self::MINIMUM_GENERATIONS, self::MAXIMUM_GENERATIONS)->integer('generations');
169        $ajax        = Validator::queryParams($request)->boolean('ajax', false);
170
171        // Convert POST requests into GET requests for pretty URLs.
172        if ($request->getMethod() === RequestMethodInterface::METHOD_POST) {
173            return redirect(route(static::class, [
174                'tree'        => $tree->name(),
175                'xref'        => Validator::parsedBody($request)->isXref()->string('xref'),
176                'style'       => Validator::parsedBody($request)->isInArrayKeys($this->styles())->string('style'),
177                'generations' => Validator::parsedBody($request)->isBetween(self::MINIMUM_GENERATIONS, self::MAXIMUM_GENERATIONS)->integer('generations'),
178            ]));
179        }
180
181        Auth::checkComponentAccess($this, ModuleChartInterface::class, $tree, $user);
182
183        $individual  = Registry::individualFactory()->make($xref, $tree);
184        $individual  = Auth::checkIndividualAccess($individual, false, true);
185
186        if ($ajax) {
187            $this->layout = 'layouts/ajax';
188
189            $ancestors = $this->chart_service->sosaStradonitzAncestors($individual, $generations);
190
191            switch ($style) {
192                default:
193                case self::CHART_STYLE_TREE:
194                    return $this->viewResponse('modules/ancestors-chart/tree', [
195                        'individual'  => $individual,
196                        'parents'     => $individual->childFamilies()->first(),
197                        'generations' => $generations,
198                        'sosa'        => 1,
199                    ]);
200
201                case self::CHART_STYLE_INDIVIDUALS:
202                    return $this->viewResponse('lists/individuals-table', [
203                        'individuals' => $ancestors,
204                        'sosa'        => true,
205                        'tree'        => $tree,
206                    ]);
207
208                case self::CHART_STYLE_FAMILIES:
209                    $families = [];
210
211                    foreach ($ancestors as $individual) {
212                        foreach ($individual->childFamilies() as $family) {
213                            $families[$family->xref()] = $family;
214                        }
215                    }
216
217                    return $this->viewResponse('lists/families-table', ['families' => $families, 'tree' => $tree]);
218            }
219        }
220
221        $ajax_url = $this->chartUrl($individual, [
222            'ajax'        => true,
223            'generations' => $generations,
224            'style'       => $style,
225            'xref'        => $xref,
226        ]);
227
228        return $this->viewResponse('modules/ancestors-chart/page', [
229            'ajax_url'            => $ajax_url,
230            'generations'         => $generations,
231            'individual'          => $individual,
232            'maximum_generations' => self::MAXIMUM_GENERATIONS,
233            'minimum_generations' => self::MINIMUM_GENERATIONS,
234            'module'              => $this->name(),
235            'style'               => $style,
236            'styles'              => $this->styles(),
237            'title'               => $this->chartTitle($individual),
238            'tree'                => $tree,
239        ]);
240    }
241
242    /**
243     * This chart can display its output in a number of styles
244     *
245     * @return array<string>
246     */
247    protected function styles(): array
248    {
249        return [
250            self::CHART_STYLE_TREE        => I18N::translate('Tree'),
251            self::CHART_STYLE_INDIVIDUALS => I18N::translate('Individuals'),
252            self::CHART_STYLE_FAMILIES    => I18N::translate('Families'),
253        ];
254    }
255}
256