xref: /webtrees/app/Http/RequestHandlers/CleanDataFolder.php (revision 090a06287954f43677f06ea778b3f67c029de8fe) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 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 League\Flysystem\Filesystem;
27use League\Flysystem\StorageAttributes;
28use Psr\Http\Message\ResponseInterface;
29use Psr\Http\Message\ServerRequestInterface;
30use Psr\Http\Server\RequestHandlerInterface;
31
32use function array_map;
33use function explode;
34
35/**
36 * Show old files that could be deleted.
37 */
38class CleanDataFolder implements RequestHandlerInterface
39{
40    use ViewResponseTrait;
41
42    /** @var TreeService */
43    private $tree_service;
44
45    /**
46     * CleanDataFolder constructor.
47     *
48     * @param TreeService $tree_service
49     */
50    public function __construct(TreeService $tree_service)
51    {
52        $this->tree_service = $tree_service;
53    }
54
55    /**
56     * @param ServerRequestInterface $request
57     *
58     * @return ResponseInterface
59     */
60    public function handle(ServerRequestInterface $request): ResponseInterface
61    {
62        $data_filesystem = Registry::filesystem()->data();
63
64        $this->layout = 'layouts/administration';
65
66        $protected = [
67            '.htaccess',
68            '.gitignore',
69            'index.php',
70            'config.ini.php',
71        ];
72
73        if ($request->getAttribute('dbtype') === 'sqlite') {
74            $protected[] = $request->getAttribute('dbname') . '.sqlite';
75        }
76
77        // Protect the media folders
78        foreach ($this->tree_service->all() as $tree) {
79            $media_directory = $tree->getPreference('MEDIA_DIRECTORY');
80            [$folder] = explode('/', $media_directory);
81
82            $protected[] = $folder . '/';
83        }
84
85        // List the top-level contents of the data folder
86        $entries = $data_filesystem->listContents('', Filesystem::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
95        return $this->viewResponse('admin/clean-data', [
96            'title'     => I18N::translate('Clean up data folder'),
97            'entries'   => $entries,
98            'protected' => $protected,
99        ]);
100    }
101}
102