1<?php 2 3/** 4 * webtrees: online genealogy 5 * Copyright (C) 2022 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\Http\RequestHandlers; 21 22use Fisharebest\Webtrees\Http\ViewResponseTrait; 23use Fisharebest\Webtrees\I18N; 24use Fisharebest\Webtrees\Module\FamilyListModule; 25use Fisharebest\Webtrees\Module\IndividualListModule; 26use Fisharebest\Webtrees\Module\MediaListModule; 27use Fisharebest\Webtrees\Module\ModuleAnalyticsInterface; 28use Fisharebest\Webtrees\Module\ModuleBlockInterface; 29use Fisharebest\Webtrees\Module\ModuleChartInterface; 30use Fisharebest\Webtrees\Module\ModuleCustomInterface; 31use Fisharebest\Webtrees\Module\ModuleDataFixInterface; 32use Fisharebest\Webtrees\Module\ModuleFooterInterface; 33use Fisharebest\Webtrees\Module\ModuleHistoricEventsInterface; 34use Fisharebest\Webtrees\Module\ModuleLanguageInterface; 35use Fisharebest\Webtrees\Module\ModuleListInterface; 36use Fisharebest\Webtrees\Module\ModuleMapAutocompleteInterface; 37use Fisharebest\Webtrees\Module\ModuleMapGeoLocationInterface; 38use Fisharebest\Webtrees\Module\ModuleMapLinkInterface; 39use Fisharebest\Webtrees\Module\ModuleMapProviderInterface; 40use Fisharebest\Webtrees\Module\ModuleMenuInterface; 41use Fisharebest\Webtrees\Module\ModuleReportInterface; 42use Fisharebest\Webtrees\Module\ModuleShareInterface; 43use Fisharebest\Webtrees\Module\ModuleSidebarInterface; 44use Fisharebest\Webtrees\Module\ModuleTabInterface; 45use Fisharebest\Webtrees\Module\ModuleThemeInterface; 46use Fisharebest\Webtrees\Module\NoteListModule; 47use Fisharebest\Webtrees\Module\RepositoryListModule; 48use Fisharebest\Webtrees\Module\SourceListModule; 49use Fisharebest\Webtrees\Module\SubmitterListModule; 50use Fisharebest\Webtrees\Note; 51use Fisharebest\Webtrees\Registry; 52use Fisharebest\Webtrees\Repository; 53use Fisharebest\Webtrees\Services\AdminService; 54use Fisharebest\Webtrees\Services\HousekeepingService; 55use Fisharebest\Webtrees\Services\MessageService; 56use Fisharebest\Webtrees\Services\ModuleService; 57use Fisharebest\Webtrees\Services\ServerCheckService; 58use Fisharebest\Webtrees\Services\TreeService; 59use Fisharebest\Webtrees\Services\UpgradeService; 60use Fisharebest\Webtrees\Services\UserService; 61use Fisharebest\Webtrees\Submitter; 62use Fisharebest\Webtrees\Webtrees; 63use Illuminate\Database\Capsule\Manager as DB; 64use Illuminate\Database\Query\Expression; 65use Illuminate\Database\Query\JoinClause; 66use Illuminate\Support\Collection; 67use League\Flysystem\Filesystem; 68use League\Flysystem\Local\LocalFilesystemAdapter; 69use Psr\Http\Message\ResponseInterface; 70use Psr\Http\Message\ServerRequestInterface; 71use Psr\Http\Server\RequestHandlerInterface; 72 73/** 74 * The control panel shows a summary of the site and links to admin functions. 75 */ 76class ControlPanel implements RequestHandlerInterface 77{ 78 use ViewResponseTrait; 79 80 private AdminService $admin_service; 81 82 private HousekeepingService $housekeeping_service; 83 84 private MessageService $message_service; 85 86 private ModuleService $module_service; 87 88 private ServerCheckService $server_check_service; 89 90 private TreeService $tree_service; 91 92 private UpgradeService $upgrade_service; 93 94 private UserService $user_service; 95 96 /** 97 * ControlPanel constructor. 98 * 99 * @param AdminService $admin_service 100 * @param HousekeepingService $housekeeping_service 101 * @param MessageService $message_service 102 * @param ModuleService $module_service 103 * @param ServerCheckService $server_check_service 104 * @param TreeService $tree_service 105 * @param UpgradeService $upgrade_service 106 * @param UserService $user_service 107 */ 108 public function __construct( 109 AdminService $admin_service, 110 HousekeepingService $housekeeping_service, 111 MessageService $message_service, 112 ModuleService $module_service, 113 ServerCheckService $server_check_service, 114 TreeService $tree_service, 115 UpgradeService $upgrade_service, 116 UserService $user_service 117 ) { 118 $this->admin_service = $admin_service; 119 $this->housekeeping_service = $housekeeping_service; 120 $this->message_service = $message_service; 121 $this->module_service = $module_service; 122 $this->server_check_service = $server_check_service; 123 $this->tree_service = $tree_service; 124 $this->upgrade_service = $upgrade_service; 125 $this->user_service = $user_service; 126 } 127 128 /** 129 * @param ServerRequestInterface $request 130 * 131 * @return ResponseInterface 132 */ 133 public function handle(ServerRequestInterface $request): ResponseInterface 134 { 135 $this->layout = 'layouts/administration'; 136 137 $filesystem = new Filesystem(new LocalFilesystemAdapter(Webtrees::ROOT_DIR)); 138 $files_to_delete = $this->housekeeping_service->deleteOldWebtreesFiles($filesystem); 139 140 $custom_updates = $this->module_service 141 ->findByInterface(ModuleCustomInterface::class) 142 ->filter(static function (ModuleCustomInterface $module): bool { 143 return version_compare($module->customModuleLatestVersion(), $module->customModuleVersion()) > 0; 144 }); 145 146 $multiple_tree_threshold = $this->admin_service->multipleTreeThreshold(); 147 $gedcom_file_count = $this->admin_service->gedcomFiles(Registry::filesystem()->data())->count(); 148 149 return $this->viewResponse('admin/control-panel', [ 150 'title' => I18N::translate('Control panel'), 151 'server_errors' => $this->server_check_service->serverErrors(), 152 'server_warnings' => $this->server_check_service->serverWarnings(), 153 'latest_version' => $this->upgrade_service->latestVersion(), 154 'all_users' => $this->user_service->all(), 155 'administrators' => $this->user_service->administrators(), 156 'managers' => $this->user_service->managers(), 157 'moderators' => $this->user_service->moderators(), 158 'unapproved' => $this->user_service->unapproved(), 159 'unverified' => $this->user_service->unverified(), 160 'recipients' => $this->message_service->recipientTypes(), 161 'all_trees' => $this->tree_service->all(), 162 'changes' => $this->totalChanges(), 163 'individuals' => $this->totalIndividuals(), 164 'families' => $this->totalFamilies(), 165 'sources' => $this->totalSources(), 166 'media' => $this->totalMediaObjects(), 167 'repositories' => $this->totalRepositories(), 168 'notes' => $this->totalNotes(), 169 'submitters' => $this->totalSubmitters(), 170 'individual_list_module' => $this->module_service->findByInterface(IndividualListModule::class)->last(), 171 'family_list_module' => $this->module_service->findByInterface(FamilyListModule::class)->first(), 172 'media_list_module' => $this->module_service->findByInterface(MediaListModule::class)->first(), 173 'note_list_module' => $this->module_service->findByInterface(NoteListModule::class)->first(), 174 'repository_list_module' => $this->module_service->findByInterface(RepositoryListModule::class)->first(), 175 'source_list_module' => $this->module_service->findByInterface(SourceListModule::class)->first(), 176 'submitter_list_module' => $this->module_service->findByInterface(SubmitterListModule::class)->first(), 177 'files_to_delete' => $files_to_delete, 178 'all_modules_disabled' => $this->module_service->all(true), 179 'all_modules_enabled' => $this->module_service->all(), 180 'deleted_modules' => $this->module_service->deletedModules(), 181 'analytics_modules_disabled' => $this->module_service->findByInterface(ModuleAnalyticsInterface::class, true), 182 'analytics_modules_enabled' => $this->module_service->findByInterface(ModuleAnalyticsInterface::class), 183 'block_modules_disabled' => $this->module_service->findByInterface(ModuleBlockInterface::class, true), 184 'block_modules_enabled' => $this->module_service->findByInterface(ModuleBlockInterface::class), 185 'chart_modules_disabled' => $this->module_service->findByInterface(ModuleChartInterface::class, true), 186 'chart_modules_enabled' => $this->module_service->findByInterface(ModuleChartInterface::class), 187 'custom_updates' => $custom_updates, 188 'data_fix_modules_disabled' => $this->module_service->findByInterface(ModuleDataFixInterface::class, true), 189 'data_fix_modules_enabled' => $this->module_service->findByInterface(ModuleDataFixInterface::class), 190 'other_modules' => $this->module_service->otherModules(true), 191 'footer_modules_disabled' => $this->module_service->findByInterface(ModuleFooterInterface::class, true), 192 'footer_modules_enabled' => $this->module_service->findByInterface(ModuleFooterInterface::class), 193 'history_modules_disabled' => $this->module_service->findByInterface(ModuleHistoricEventsInterface::class, true), 194 'history_modules_enabled' => $this->module_service->findByInterface(ModuleHistoricEventsInterface::class), 195 'language_modules_disabled' => $this->module_service->findByInterface(ModuleLanguageInterface::class, true), 196 'language_modules_enabled' => $this->module_service->findByInterface(ModuleLanguageInterface::class), 197 'list_modules_disabled' => $this->module_service->findByInterface(ModuleListInterface::class, true), 198 'list_modules_enabled' => $this->module_service->findByInterface(ModuleListInterface::class), 199 'map_autocomplete_modules_disabled' => $this->module_service->findByInterface(ModuleMapAutocompleteInterface::class, true), 200 'map_autocomplete_modules_enabled' => $this->module_service->findByInterface(ModuleMapAutocompleteInterface::class), 201 'map_link_modules_disabled' => $this->module_service->findByInterface(ModuleMapLinkInterface::class, true), 202 'map_link_modules_enabled' => $this->module_service->findByInterface(ModuleMapLinkInterface::class), 203 'map_provider_modules_disabled' => $this->module_service->findByInterface(ModuleMapProviderInterface::class, true), 204 'map_provider_modules_enabled' => $this->module_service->findByInterface(ModuleMapProviderInterface::class), 205 'map_search_modules_disabled' => $this->module_service->findByInterface(ModuleMapGeoLocationInterface::class, true), 206 'map_search_modules_enabled' => $this->module_service->findByInterface(ModuleMapGeoLocationInterface::class), 207 'menu_modules_disabled' => $this->module_service->findByInterface(ModuleMenuInterface::class, true), 208 'menu_modules_enabled' => $this->module_service->findByInterface(ModuleMenuInterface::class), 209 'report_modules_disabled' => $this->module_service->findByInterface(ModuleReportInterface::class, true), 210 'report_modules_enabled' => $this->module_service->findByInterface(ModuleReportInterface::class), 211 'share_modules_disabled' => $this->module_service->findByInterface(ModuleShareInterface::class, true), 212 'share_modules_enabled' => $this->module_service->findByInterface(ModuleShareInterface::class), 213 'sidebar_modules_disabled' => $this->module_service->findByInterface(ModuleSidebarInterface::class, true), 214 'sidebar_modules_enabled' => $this->module_service->findByInterface(ModuleSidebarInterface::class), 215 'tab_modules_disabled' => $this->module_service->findByInterface(ModuleTabInterface::class, true), 216 'tab_modules_enabled' => $this->module_service->findByInterface(ModuleTabInterface::class), 217 'theme_modules_disabled' => $this->module_service->findByInterface(ModuleThemeInterface::class, true), 218 'theme_modules_enabled' => $this->module_service->findByInterface(ModuleThemeInterface::class), 219 'show_synchronize' => $gedcom_file_count >= $multiple_tree_threshold, 220 ]); 221 } 222 223 /** 224 * Count the number of pending changes in each tree. 225 * 226 * @return array<string> 227 */ 228 private function totalChanges(): array 229 { 230 return DB::table('gedcom') 231 ->leftJoin('change', static function (JoinClause $join): void { 232 $join 233 ->on('change.gedcom_id', '=', 'gedcom.gedcom_id') 234 ->where('change.status', '=', 'pending'); 235 }) 236 ->groupBy(['gedcom.gedcom_id']) 237 ->pluck(new Expression('COUNT(change_id) AS aggregate'), 'gedcom.gedcom_id') 238 ->all(); 239 } 240 241 /** 242 * Count the number of individuals in each tree. 243 * 244 * @return Collection<int,int> 245 */ 246 private function totalIndividuals(): Collection 247 { 248 return DB::table('gedcom') 249 ->leftJoin('individuals', 'i_file', '=', 'gedcom_id') 250 ->groupBy(['gedcom_id']) 251 ->pluck(new Expression('COUNT(i_id) AS aggregate'), 'gedcom_id') 252 ->map(static function (string $count) { 253 return (int) $count; 254 }); 255 } 256 257 /** 258 * Count the number of families in each tree. 259 * 260 * @return Collection<int,int> 261 */ 262 private function totalFamilies(): Collection 263 { 264 return DB::table('gedcom') 265 ->leftJoin('families', 'f_file', '=', 'gedcom_id') 266 ->groupBy(['gedcom_id']) 267 ->pluck(new Expression('COUNT(f_id) AS aggregate'), 'gedcom_id') 268 ->map(static function (string $count) { 269 return (int) $count; 270 }); 271 } 272 273 /** 274 * Count the number of sources in each tree. 275 * 276 * @return Collection<int,int> 277 */ 278 private function totalSources(): Collection 279 { 280 return DB::table('gedcom') 281 ->leftJoin('sources', 's_file', '=', 'gedcom_id') 282 ->groupBy(['gedcom_id']) 283 ->pluck(new Expression('COUNT(s_id) AS aggregate'), 'gedcom_id') 284 ->map(static function (string $count) { 285 return (int) $count; 286 }); 287 } 288 289 /** 290 * Count the number of media objects in each tree. 291 * 292 * @return Collection<int,int> 293 */ 294 private function totalMediaObjects(): Collection 295 { 296 return DB::table('gedcom') 297 ->leftJoin('media', 'm_file', '=', 'gedcom_id') 298 ->groupBy(['gedcom_id']) 299 ->pluck(new Expression('COUNT(m_id) AS aggregate'), 'gedcom_id') 300 ->map(static function (string $count) { 301 return (int) $count; 302 }); 303 } 304 305 /** 306 * Count the number of repositories in each tree. 307 * 308 * @return Collection<int,int> 309 */ 310 private function totalRepositories(): Collection 311 { 312 return DB::table('gedcom') 313 ->leftJoin('other', static function (JoinClause $join): void { 314 $join 315 ->on('o_file', '=', 'gedcom_id') 316 ->where('o_type', '=', Repository::RECORD_TYPE); 317 }) 318 ->groupBy(['gedcom_id']) 319 ->pluck(new Expression('COUNT(o_id) AS aggregate'), 'gedcom_id') 320 ->map(static function (string $count) { 321 return (int) $count; 322 }); 323 } 324 325 /** 326 * Count the number of notes in each tree. 327 * 328 * @return Collection<int,int> 329 */ 330 private function totalNotes(): Collection 331 { 332 return DB::table('gedcom') 333 ->leftJoin('other', static function (JoinClause $join): void { 334 $join 335 ->on('o_file', '=', 'gedcom_id') 336 ->where('o_type', '=', Note::RECORD_TYPE); 337 }) 338 ->groupBy(['gedcom_id']) 339 ->pluck(new Expression('COUNT(o_id) AS aggregate'), 'gedcom_id') 340 ->map(static function (string $count) { 341 return (int) $count; 342 }); 343 } 344 345 /** 346 * Count the number of submitters in each tree. 347 * 348 * @return Collection<int,int> 349 */ 350 private function totalSubmitters(): Collection 351 { 352 return DB::table('gedcom') 353 ->leftJoin('other', static function (JoinClause $join): void { 354 $join 355 ->on('o_file', '=', 'gedcom_id') 356 ->where('o_type', '=', Submitter::RECORD_TYPE); 357 }) 358 ->groupBy(['gedcom_id']) 359 ->pluck(new Expression('COUNT(o_id) AS aggregate'), 'gedcom_id') 360 ->map(static function (string $count) { 361 return (int) $count; 362 }); 363 } 364} 365