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 DescendancyChartModule 38 */ 39class DescendancyChartModule extends AbstractModule implements ModuleChartInterface, RequestHandlerInterface 40{ 41 use ModuleChartTrait; 42 43 protected const ROUTE_URL = '/tree/{tree}/descendants-{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_STYLE = self::CHART_STYLE_TREE; 52 public const DEFAULT_GENERATIONS = '3'; 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 } 83 84 /** 85 * How should this module be identified in the control panel, etc.? 86 * 87 * @return string 88 */ 89 public function title(): string 90 { 91 /* I18N: Name of a module/chart */ 92 return I18N::translate('Descendants'); 93 } 94 95 /** 96 * A sentence describing what this module does. 97 * 98 * @return string 99 */ 100 public function description(): string 101 { 102 /* I18N: Description of the “DescendancyChart” module */ 103 return I18N::translate('A chart of an individual’s descendants.'); 104 } 105 106 /** 107 * CSS class for the URL. 108 * 109 * @return string 110 */ 111 public function chartMenuClass(): string 112 { 113 return 'menu-chart-descendants'; 114 } 115 116 /** 117 * Return a menu item for this chart - for use in individual boxes. 118 * 119 * @param Individual $individual 120 * 121 * @return Menu|null 122 */ 123 public function chartBoxMenu(Individual $individual): ?Menu 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('Descendants 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 'tree' => $individual->tree()->name(), 153 'xref' => $individual->xref(), 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 $xref = Validator::attributes($request)->isXref()->string('xref'); 167 $style = Validator::attributes($request)->isInArrayKeys($this->styles())->string('style'); 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 'generations' => Validator::parsedBody($request)->isBetween(self::MINIMUM_GENERATIONS, self::MAXIMUM_GENERATIONS)->integer('generations'), 176 'style' => Validator::parsedBody($request)->isInArrayKeys($this->styles())->string('style'), 177 'xref' => Validator::parsedBody($request)->isXref()->string('xref'), 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 switch ($style) { 190 case self::CHART_STYLE_TREE: 191 return $this->viewResponse('modules/descendancy_chart/tree', [ 192 'individual' => $individual, 193 'generations' => $generations, 194 'daboville' => '1', 195 ]); 196 197 case self::CHART_STYLE_INDIVIDUALS: 198 $individuals = $this->chart_service->descendants($individual, $generations - 1); 199 200 return $this->viewResponse('lists/individuals-table', [ 201 'individuals' => $individuals, 202 'sosa' => false, 203 'tree' => $tree, 204 ]); 205 206 case self::CHART_STYLE_FAMILIES: 207 $families = $this->chart_service->descendantFamilies($individual, $generations - 1); 208 209 return $this->viewResponse('lists/families-table', [ 210 'families' => $families, 211 'tree' => $tree, 212 ]); 213 } 214 } 215 216 $ajax_url = $this->chartUrl($individual, [ 217 'generations' => $generations, 218 'style' => $style, 219 'ajax' => true, 220 ]); 221 222 return $this->viewResponse('modules/descendancy_chart/page', [ 223 'ajax_url' => $ajax_url, 224 'style' => $style, 225 'styles' => $this->styles(), 226 'default_generations' => self::DEFAULT_GENERATIONS, 227 'generations' => $generations, 228 'individual' => $individual, 229 'maximum_generations' => self::MAXIMUM_GENERATIONS, 230 'minimum_generations' => self::MINIMUM_GENERATIONS, 231 'module' => $this->name(), 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