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