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\Http\RequestHandlers; 21 22use Fisharebest\Webtrees\DB; 23use Fisharebest\Webtrees\Http\ViewResponseTrait; 24use Fisharebest\Webtrees\I18N; 25use Fisharebest\Webtrees\Module\FamilyListModule; 26use Fisharebest\Webtrees\Module\IndividualListModule; 27use Fisharebest\Webtrees\Module\MediaListModule; 28use Fisharebest\Webtrees\Module\ModuleAnalyticsInterface; 29use Fisharebest\Webtrees\Module\ModuleBlockInterface; 30use Fisharebest\Webtrees\Module\ModuleChartInterface; 31use Fisharebest\Webtrees\Module\ModuleCustomInterface; 32use Fisharebest\Webtrees\Module\ModuleDataFixInterface; 33use Fisharebest\Webtrees\Module\ModuleFooterInterface; 34use Fisharebest\Webtrees\Module\ModuleHistoricEventsInterface; 35use Fisharebest\Webtrees\Module\ModuleLanguageInterface; 36use Fisharebest\Webtrees\Module\ModuleListInterface; 37use Fisharebest\Webtrees\Module\ModuleMapAutocompleteInterface; 38use Fisharebest\Webtrees\Module\ModuleMapGeoLocationInterface; 39use Fisharebest\Webtrees\Module\ModuleMapLinkInterface; 40use Fisharebest\Webtrees\Module\ModuleMapProviderInterface; 41use Fisharebest\Webtrees\Module\ModuleMenuInterface; 42use Fisharebest\Webtrees\Module\ModuleReportInterface; 43use Fisharebest\Webtrees\Module\ModuleShareInterface; 44use Fisharebest\Webtrees\Module\ModuleSidebarInterface; 45use Fisharebest\Webtrees\Module\ModuleTabInterface; 46use Fisharebest\Webtrees\Module\ModuleThemeInterface; 47use Fisharebest\Webtrees\Module\NoteListModule; 48use Fisharebest\Webtrees\Module\RepositoryListModule; 49use Fisharebest\Webtrees\Module\SourceListModule; 50use Fisharebest\Webtrees\Module\SubmitterListModule; 51use Fisharebest\Webtrees\Note; 52use Fisharebest\Webtrees\Registry; 53use Fisharebest\Webtrees\Repository; 54use Fisharebest\Webtrees\Services\AdminService; 55use Fisharebest\Webtrees\Services\HousekeepingService; 56use Fisharebest\Webtrees\Services\MessageService; 57use Fisharebest\Webtrees\Services\ModuleService; 58use Fisharebest\Webtrees\Services\ServerCheckService; 59use Fisharebest\Webtrees\Services\TreeService; 60use Fisharebest\Webtrees\Services\UpgradeService; 61use Fisharebest\Webtrees\Services\UserService; 62use Fisharebest\Webtrees\Submitter; 63use Fisharebest\Webtrees\Webtrees; 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 * @param AdminService $admin_service 98 * @param HousekeepingService $housekeeping_service 99 * @param MessageService $message_service 100 * @param ModuleService $module_service 101 * @param ServerCheckService $server_check_service 102 * @param TreeService $tree_service 103 * @param UpgradeService $upgrade_service 104 * @param UserService $user_service 105 */ 106 public function __construct( 107 AdminService $admin_service, 108 HousekeepingService $housekeeping_service, 109 MessageService $message_service, 110 ModuleService $module_service, 111 ServerCheckService $server_check_service, 112 TreeService $tree_service, 113 UpgradeService $upgrade_service, 114 UserService $user_service 115 ) { 116 $this->admin_service = $admin_service; 117 $this->housekeeping_service = $housekeeping_service; 118 $this->message_service = $message_service; 119 $this->module_service = $module_service; 120 $this->server_check_service = $server_check_service; 121 $this->tree_service = $tree_service; 122 $this->upgrade_service = $upgrade_service; 123 $this->user_service = $user_service; 124 } 125 126 /** 127 * @param ServerRequestInterface $request 128 * 129 * @return ResponseInterface 130 */ 131 public function handle(ServerRequestInterface $request): ResponseInterface 132 { 133 $this->layout = 'layouts/administration'; 134 135 $filesystem = new Filesystem(new LocalFilesystemAdapter(Webtrees::ROOT_DIR)); 136 $files_to_delete = $this->housekeeping_service->deleteOldWebtreesFiles($filesystem); 137 138 $custom_updates = $this->module_service 139 ->findByInterface(ModuleCustomInterface::class) 140 ->filter(static function (ModuleCustomInterface $module): bool { 141 return version_compare($module->customModuleLatestVersion(), $module->customModuleVersion()) > 0; 142 }); 143 144 $multiple_tree_threshold = $this->admin_service->multipleTreeThreshold(); 145 $gedcom_file_count = $this->admin_service->gedcomFiles(Registry::filesystem()->data())->count(); 146 147 return $this->viewResponse('admin/control-panel', [ 148 'title' => I18N::translate('Control panel'), 149 'server_errors' => $this->server_check_service->serverErrors(), 150 'server_warnings' => $this->server_check_service->serverWarnings(), 151 'latest_version' => $this->upgrade_service->latestVersion(), 152 'latest_version_error' => $this->upgrade_service->latestVersionError(), 153 'latest_version_timestamp' => $this->upgrade_service->latestVersionTimestamp(), 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<int> 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 ->map(static fn (string $count): int => (int) $count) 239 ->all(); 240 } 241 242 /** 243 * Count the number of individuals in each tree. 244 * 245 * @return Collection<int,int> 246 */ 247 private function totalIndividuals(): Collection 248 { 249 return DB::table('gedcom') 250 ->leftJoin('individuals', 'i_file', '=', 'gedcom_id') 251 ->groupBy(['gedcom_id']) 252 ->pluck(new Expression('COUNT(i_id) AS aggregate'), 'gedcom_id') 253 ->map(static fn (string $count): int => (int) $count); 254 } 255 256 /** 257 * Count the number of families in each tree. 258 * 259 * @return Collection<int,int> 260 */ 261 private function totalFamilies(): Collection 262 { 263 return DB::table('gedcom') 264 ->leftJoin('families', 'f_file', '=', 'gedcom_id') 265 ->groupBy(['gedcom_id']) 266 ->pluck(new Expression('COUNT(f_id) AS aggregate'), 'gedcom_id') 267 ->map(static fn (string $count): int => (int) $count); 268 } 269 270 /** 271 * Count the number of sources in each tree. 272 * 273 * @return Collection<int,int> 274 */ 275 private function totalSources(): Collection 276 { 277 return DB::table('gedcom') 278 ->leftJoin('sources', 's_file', '=', 'gedcom_id') 279 ->groupBy(['gedcom_id']) 280 ->pluck(new Expression('COUNT(s_id) AS aggregate'), 'gedcom_id') 281 ->map(static fn (string $count): int => (int) $count); 282 } 283 284 /** 285 * Count the number of media objects in each tree. 286 * 287 * @return Collection<int,int> 288 */ 289 private function totalMediaObjects(): Collection 290 { 291 return DB::table('gedcom') 292 ->leftJoin('media', 'm_file', '=', 'gedcom_id') 293 ->groupBy(['gedcom_id']) 294 ->pluck(new Expression('COUNT(m_id) AS aggregate'), 'gedcom_id') 295 ->map(static fn (string $count): int => (int) $count); 296 } 297 298 /** 299 * Count the number of repositories in each tree. 300 * 301 * @return Collection<int,int> 302 */ 303 private function totalRepositories(): Collection 304 { 305 return DB::table('gedcom') 306 ->leftJoin('other', static function (JoinClause $join): void { 307 $join 308 ->on('o_file', '=', 'gedcom_id') 309 ->where('o_type', '=', Repository::RECORD_TYPE); 310 }) 311 ->groupBy(['gedcom_id']) 312 ->pluck(new Expression('COUNT(o_id) AS aggregate'), 'gedcom_id') 313 ->map(static fn (string $count): int => (int) $count); 314 } 315 316 /** 317 * Count the number of notes in each tree. 318 * 319 * @return Collection<int,int> 320 */ 321 private function totalNotes(): Collection 322 { 323 return DB::table('gedcom') 324 ->leftJoin('other', static function (JoinClause $join): void { 325 $join 326 ->on('o_file', '=', 'gedcom_id') 327 ->where('o_type', '=', Note::RECORD_TYPE); 328 }) 329 ->groupBy(['gedcom_id']) 330 ->pluck(new Expression('COUNT(o_id) AS aggregate'), 'gedcom_id') 331 ->map(static fn (string $count): int => (int) $count); 332 } 333 334 /** 335 * Count the number of submitters in each tree. 336 * 337 * @return Collection<int,int> 338 */ 339 private function totalSubmitters(): Collection 340 { 341 return DB::table('gedcom') 342 ->leftJoin('other', static function (JoinClause $join): void { 343 $join 344 ->on('o_file', '=', 'gedcom_id') 345 ->where('o_type', '=', Submitter::RECORD_TYPE); 346 }) 347 ->groupBy(['gedcom_id']) 348 ->pluck(new Expression('COUNT(o_id) AS aggregate'), 'gedcom_id') 349 ->map(static fn (string $count): int => (int) $count); 350 } 351} 352