xref: /webtrees/app/Http/RequestHandlers/CleanDataFolder.php (revision e93a8df2f8d797005750082cc3766c0e80799688) 
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\Http\ViewResponseTrait;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Registry;
25use Fisharebest\Webtrees\Services\TreeService;
26use Fisharebest\Webtrees\Validator;
27use League\Flysystem\FilesystemException;
28use League\Flysystem\FilesystemReader;
29use League\Flysystem\StorageAttributes;
30use Psr\Http\Message\ResponseInterface;
31use Psr\Http\Message\ServerRequestInterface;
32use Psr\Http\Server\RequestHandlerInterface;
33
34use function explode;
35
36/**
37 * Show old files that could be deleted.
38 */
39class CleanDataFolder implements RequestHandlerInterface
40{
41    use ViewResponseTrait;
42
43    private TreeService $tree_service;
44
45    /**
46     * @param TreeService $tree_service
47     */
48    public function __construct(TreeService $tree_service)
49    {
50        $this->tree_service = $tree_service;
51    }
52
53    /**
54     * @param ServerRequestInterface $request
55     *
56     * @return ResponseInterface
57     */
58    public function handle(ServerRequestInterface $request): ResponseInterface
59    {
60        $data_filesystem = Registry::filesystem()->data();
61
62        $this->layout = 'layouts/administration';
63
64        $protected = [
65            '.htaccess',
66            '.gitignore',
67            'index.php',
68            'config.ini.php',
69        ];
70
71        if (Validator::attributes($request)->string('dbtype', 'mysql') === 'sqlite') {
72            $protected[] = Validator::attributes($request)->string('dbname') . '.sqlite';
73        }
74
75        // Protect the media folders
76        foreach ($this->tree_service->all() as $tree) {
77            $media_directory = $tree->getPreference('MEDIA_DIRECTORY');
78            [$folder] = explode('/', $media_directory);
79
80            $protected[] = $folder . '/';
81        }
82
83        // List the top-level contents of the data folder
84        try {
85            $entries = $data_filesystem->listContents('', FilesystemReader::LIST_SHALLOW)
86                ->map(static function (StorageAttributes $attributes): string {
87                    if ($attributes->isDir()) {
88                        return $attributes->path() . '/';
89                    }
90
91                    return $attributes->path();
92                })
93                ->toArray();
94        } catch (FilesystemException) {
95            $entries = [];
96        }
97
98
99        return $this->viewResponse('admin/clean-data', [
100            'title'     => I18N::translate('Clean up data folder'),
101            'entries'   => $entries,
102            'protected' => $protected,
103        ]);
104    }
105}
106