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 * DescendancyChartModule constructor. 66 * 67 * @param ChartService $chart_service 68 */ 69 public function __construct(ChartService $chart_service) 70 { 71 $this->chart_service = $chart_service; 72 } 73 74 /** 75 * Initialization. 76 * 77 * @return void 78 */ 79 public function boot(): void 80 { 81 Registry::routeFactory()->routeMap() 82 ->get(static::class, static::ROUTE_URL, $this) 83 ->allows(RequestMethodInterface::METHOD_POST); 84 } 85 86 /** 87 * How should this module be identified in the control panel, etc.? 88 * 89 * @return string 90 */ 91 public function title(): string 92 { 93 /* I18N: Name of a module/chart */ 94 return I18N::translate('Descendants'); 95 } 96 97 /** 98 * A sentence describing what this module does. 99 * 100 * @return string 101 */ 102 public function description(): string 103 { 104 /* I18N: Description of the “DescendancyChart” module */ 105 return I18N::translate('A chart of an individual’s descendants.'); 106 } 107 108 /** 109 * CSS class for the URL. 110 * 111 * @return string 112 */ 113 public function chartMenuClass(): string 114 { 115 return 'menu-chart-descendants'; 116 } 117 118 /** 119 * Return a menu item for this chart - for use in individual boxes. 120 * 121 * @param Individual $individual 122 * 123 * @return Menu|null 124 */ 125 public function chartBoxMenu(Individual $individual): ?Menu 126 { 127 return $this->chartMenu($individual); 128 } 129 130 /** 131 * The title for a specific instance of this chart. 132 * 133 * @param Individual $individual 134 * 135 * @return string 136 */ 137 public function chartTitle(Individual $individual): string 138 { 139 /* I18N: %s is an individual’s name */ 140 return I18N::translate('Descendants of %s', $individual->fullName()); 141 } 142 143 /** 144 * The URL for a page showing chart options. 145 * 146 * @param Individual $individual 147 * @param array<bool|int|string|array<string>|null> $parameters 148 * 149 * @return string 150 */ 151 public function chartUrl(Individual $individual, array $parameters = []): string 152 { 153 return route(static::class, [ 154 'tree' => $individual->tree()->name(), 155 'xref' => $individual->xref(), 156 ] + $parameters + self::DEFAULT_PARAMETERS); 157 } 158 159 /** 160 * @param ServerRequestInterface $request 161 * 162 * @return ResponseInterface 163 */ 164 public function handle(ServerRequestInterface $request): ResponseInterface 165 { 166 $tree = Validator::attributes($request)->tree(); 167 $user = Validator::attributes($request)->user(); 168 $xref = Validator::attributes($request)->isXref()->string('xref'); 169 $style = Validator::attributes($request)->isInArrayKeys($this->styles())->string('style'); 170 $generations = Validator::attributes($request)->isBetween(self::MINIMUM_GENERATIONS, self::MAXIMUM_GENERATIONS)->integer('generations'); 171 $ajax = Validator::queryParams($request)->boolean('ajax', false); 172 173 // Convert POST requests into GET requests for pretty URLs. 174 if ($request->getMethod() === RequestMethodInterface::METHOD_POST) { 175 return redirect(route(static::class, [ 176 'tree' => $tree->name(), 177 'generations' => Validator::parsedBody($request)->isBetween(self::MINIMUM_GENERATIONS, self::MAXIMUM_GENERATIONS)->integer('generations'), 178 'style' => Validator::parsedBody($request)->isInArrayKeys($this->styles())->string('style'), 179 'xref' => Validator::parsedBody($request)->isXref()->string('xref'), 180 ])); 181 } 182 183 Auth::checkComponentAccess($this, ModuleChartInterface::class, $tree, $user); 184 185 $individual = Registry::individualFactory()->make($xref, $tree); 186 $individual = Auth::checkIndividualAccess($individual, false, true); 187 188 if ($ajax) { 189 $this->layout = 'layouts/ajax'; 190 191 switch ($style) { 192 case self::CHART_STYLE_TREE: 193 return $this->viewResponse('modules/descendancy_chart/tree', [ 194 'individual' => $individual, 195 'generations' => $generations, 196 'daboville' => '1', 197 ]); 198 199 case self::CHART_STYLE_INDIVIDUALS: 200 $individuals = $this->chart_service->descendants($individual, $generations - 1); 201 202 return $this->viewResponse('lists/individuals-table', [ 203 'individuals' => $individuals, 204 'sosa' => false, 205 'tree' => $tree, 206 ]); 207 208 case self::CHART_STYLE_FAMILIES: 209 $families = $this->chart_service->descendantFamilies($individual, $generations - 1); 210 211 return $this->viewResponse('lists/families-table', [ 212 'families' => $families, 213 'tree' => $tree, 214 ]); 215 } 216 } 217 218 $ajax_url = $this->chartUrl($individual, [ 219 'generations' => $generations, 220 'style' => $style, 221 'ajax' => true, 222 ]); 223 224 return $this->viewResponse('modules/descendancy_chart/page', [ 225 'ajax_url' => $ajax_url, 226 'style' => $style, 227 'styles' => $this->styles(), 228 'default_generations' => self::DEFAULT_GENERATIONS, 229 'generations' => $generations, 230 'individual' => $individual, 231 'maximum_generations' => self::MAXIMUM_GENERATIONS, 232 'minimum_generations' => self::MINIMUM_GENERATIONS, 233 'module' => $this->name(), 234 'title' => $this->chartTitle($individual), 235 'tree' => $tree, 236 ]); 237 } 238 239 /** 240 * This chart can display its output in a number of styles 241 * 242 * @return array<string> 243 */ 244 protected function styles(): array 245 { 246 return [ 247 self::CHART_STYLE_TREE => I18N::translate('Tree'), 248 self::CHART_STYLE_INDIVIDUALS => I18N::translate('Individuals'), 249 self::CHART_STYLE_FAMILIES => I18N::translate('Families'), 250 ]; 251 } 252} 253