xref: /webtrees/app/Http/RequestHandlers/DeletePath.php (revision e6747449f8e9bc991dc3b20abe694161c7f5d9e6)
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\FlashMessages;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Registry;
25use League\Flysystem\FilesystemException;
26use League\Flysystem\UnableToDeleteDirectory;
27use League\Flysystem\UnableToDeleteFile;
28use League\Flysystem\WhitespacePathNormalizer;
29use Psr\Http\Message\ResponseInterface;
30use Psr\Http\Message\ServerRequestInterface;
31use Psr\Http\Server\RequestHandlerInterface;
32
33use function e;
34use function in_array;
35use function response;
36use function str_ends_with;
37
38/**
39 * Delete a file or folder from the data filesystem.
40 */
41class DeletePath implements RequestHandlerInterface
42{
43    private const PROTECTED_PATHS = [
44        'config.ini.php',
45        'index.php',
46        '.htaccess',
47    ];
48
49    private WhitespacePathNormalizer $whitespace_path_normalizer;
50
51    /**
52     * @param WhitespacePathNormalizer $whitespace_path_normalizer
53     */
54    public function __construct(WhitespacePathNormalizer $whitespace_path_normalizer)
55    {
56        $this->whitespace_path_normalizer = $whitespace_path_normalizer;
57    }
58
59    /**
60     * @param ServerRequestInterface $request
61     *
62     * @return ResponseInterface
63     */
64    public function handle(ServerRequestInterface $request): ResponseInterface
65    {
66        $data_filesystem = Registry::filesystem()->data();
67
68        $path = $request->getQueryParams()['path'] ?? '';
69
70        $normalized_path = $this->whitespace_path_normalizer->normalizePath($path);
71
72        if (in_array($normalized_path, self::PROTECTED_PATHS, true)) {
73            FlashMessages::addMessage(I18N::translate('The file %s could not be deleted.', e($path)), 'danger');
74            return response();
75        }
76
77        // The request adds a slash to folders, so we know which delete function to use.
78        if (str_ends_with($path, '/')) {
79            try {
80                $data_filesystem->deleteDirectory($normalized_path);
81                FlashMessages::addMessage(I18N::translate('The folder %s has been deleted.', e($path)), 'success');
82            } catch (FilesystemException | UnableToDeleteDirectory $ex) {
83                FlashMessages::addMessage(I18N::translate('The folder %s could not be deleted.', e($path)), 'danger');
84            }
85        } else {
86            try {
87                $data_filesystem->delete($normalized_path);
88                FlashMessages::addMessage(I18N::translate('The file %s has been deleted.', e($path)), 'success');
89            } catch (FilesystemException | UnableToDeleteFile $ex) {
90                FlashMessages::addMessage(I18N::translate('The file %s could not be deleted.', e($path)), 'danger');
91            }
92        }
93
94        return response();
95    }
96}
97