xref: /webtrees/app/Module/AncestorsChartModule.php (revision e873f434551745f888937263ff89e80db3b0f785) 
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 string ROUTE_URL = '/tree/{tree}/ancestors-{style}-{generations}/{xref}';
44
45    // Chart styles
46    public const string CHART_STYLE_TREE        = 'tree';
47    public const string CHART_STYLE_INDIVIDUALS = 'individuals';
48    public const string CHART_STYLE_FAMILIES    = 'families';
49
50    // Defaults
51    public const string DEFAULT_GENERATIONS = '4';
52    public const string DEFAULT_STYLE       = self::CHART_STYLE_TREE;
53    protected const array DEFAULT_PARAMETERS  = [
54        'generations' => self::DEFAULT_GENERATIONS,
55        'style'       => self::DEFAULT_STYLE,
56    ];
57
58    // Limits
59    protected const int MINIMUM_GENERATIONS = 2;
60    protected const int 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    public function description(): string
100    {
101        /* I18N: Description of the “AncestorsChart” module */
102        return I18N::translate('A chart of an individual’s ancestors.');
103    }
104
105    /**
106     * CSS class for the URL.
107     *
108     * @return string
109     */
110    public function chartMenuClass(): string
111    {
112        return 'menu-chart-ancestry';
113    }
114
115    /**
116     * Return a menu item for this chart - for use in individual boxes.
117     */
118    public function chartBoxMenu(Individual $individual): Menu|null
119    {
120        return $this->chartMenu($individual);
121    }
122
123    /**
124     * The title for a specific instance of this chart.
125     *
126     * @param Individual $individual
127     *
128     * @return string
129     */
130    public function chartTitle(Individual $individual): string
131    {
132        /* I18N: %s is an individual’s name */
133        return I18N::translate('Ancestors of %s', $individual->fullName());
134    }
135
136    /**
137     * The URL for a page showing chart options.
138     *
139     * @param Individual                                $individual
140     * @param array<bool|int|string|array<string>|null> $parameters
141     *
142     * @return string
143     */
144    public function chartUrl(Individual $individual, array $parameters = []): string
145    {
146        return route(static::class, [
147                'xref' => $individual->xref(),
148                'tree' => $individual->tree()->name(),
149            ] + $parameters + self::DEFAULT_PARAMETERS);
150    }
151
152    /**
153     * @param ServerRequestInterface $request
154     *
155     * @return ResponseInterface
156     */
157    public function handle(ServerRequestInterface $request): ResponseInterface
158    {
159        $tree        = Validator::attributes($request)->tree();
160        $user        = Validator::attributes($request)->user();
161        $style       = Validator::attributes($request)->isInArrayKeys($this->styles())->string('style');
162        $xref        = Validator::attributes($request)->isXref()->string('xref');
163        $generations = Validator::attributes($request)->isBetween(self::MINIMUM_GENERATIONS, self::MAXIMUM_GENERATIONS)->integer('generations');
164        $ajax        = Validator::queryParams($request)->boolean('ajax', false);
165
166        // Convert POST requests into GET requests for pretty URLs.
167        if ($request->getMethod() === RequestMethodInterface::METHOD_POST) {
168            return redirect(route(static::class, [
169                'tree'        => $tree->name(),
170                'xref'        => Validator::parsedBody($request)->isXref()->string('xref'),
171                'style'       => Validator::parsedBody($request)->isInArrayKeys($this->styles())->string('style'),
172                'generations' => Validator::parsedBody($request)->isBetween(self::MINIMUM_GENERATIONS, self::MAXIMUM_GENERATIONS)->integer('generations'),
173            ]));
174        }
175
176        Auth::checkComponentAccess($this, ModuleChartInterface::class, $tree, $user);
177
178        $individual  = Registry::individualFactory()->make($xref, $tree);
179        $individual  = Auth::checkIndividualAccess($individual, false, true);
180
181        if ($ajax) {
182            $this->layout = 'layouts/ajax';
183
184            $ancestors = $this->chart_service->sosaStradonitzAncestors($individual, $generations);
185
186            switch ($style) {
187                default:
188                case self::CHART_STYLE_TREE:
189                    return $this->viewResponse('modules/ancestors-chart/tree', [
190                        'individual'  => $individual,
191                        'parents'     => $individual->childFamilies()->first(),
192                        'generations' => $generations,
193                        'sosa'        => 1,
194                    ]);
195
196                case self::CHART_STYLE_INDIVIDUALS:
197                    return $this->viewResponse('lists/individuals-table', [
198                        'individuals' => $ancestors,
199                        'sosa'        => true,
200                        'tree'        => $tree,
201                    ]);
202
203                case self::CHART_STYLE_FAMILIES:
204                    $families = [];
205
206                    foreach ($ancestors as $individual) {
207                        foreach ($individual->childFamilies() as $family) {
208                            $families[$family->xref()] = $family;
209                        }
210                    }
211
212                    return $this->viewResponse('lists/families-table', ['families' => $families, 'tree' => $tree]);
213            }
214        }
215
216        $ajax_url = $this->chartUrl($individual, [
217            'ajax'        => true,
218            'generations' => $generations,
219            'style'       => $style,
220            'xref'        => $xref,
221        ]);
222
223        return $this->viewResponse('modules/ancestors-chart/page', [
224            'ajax_url'            => $ajax_url,
225            'generations'         => $generations,
226            'individual'          => $individual,
227            'maximum_generations' => self::MAXIMUM_GENERATIONS,
228            'minimum_generations' => self::MINIMUM_GENERATIONS,
229            'module'              => $this->name(),
230            'style'               => $style,
231            'styles'              => $this->styles(),
232            'title'               => $this->chartTitle($individual),
233            'tree'                => $tree,
234        ]);
235    }
236
237    /**
238     * This chart can display its output in a number of styles
239     *
240     * @return array<string>
241     */
242    protected function styles(): array
243    {
244        return [
245            self::CHART_STYLE_TREE        => I18N::translate('Tree'),
246            self::CHART_STYLE_INDIVIDUALS => I18N::translate('Individuals'),
247            self::CHART_STYLE_FAMILIES    => I18N::translate('Families'),
248        ];
249    }
250}
251