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\Auth; 23use Fisharebest\Webtrees\FlashMessages; 24use Fisharebest\Webtrees\Html; 25use Fisharebest\Webtrees\I18N; 26use Fisharebest\Webtrees\MediaFile; 27use Fisharebest\Webtrees\Registry; 28use Fisharebest\Webtrees\Services\MediaFileService; 29use Fisharebest\Webtrees\Services\PendingChangesService; 30use Fisharebest\Webtrees\Validator; 31use League\Flysystem\FilesystemException; 32use League\Flysystem\UnableToMoveFile; 33use League\Flysystem\UnableToRetrieveMetadata; 34use Psr\Http\Message\ResponseInterface; 35use Psr\Http\Message\ServerRequestInterface; 36use Psr\Http\Server\RequestHandlerInterface; 37 38use function assert; 39use function is_string; 40use function preg_replace; 41use function redirect; 42use function route; 43use function str_replace; 44use function trim; 45 46/** 47 * Edit a media file. 48 */ 49class EditMediaFileAction implements RequestHandlerInterface 50{ 51 private MediaFileService $media_file_service; 52 53 private PendingChangesService $pending_changes_service; 54 55 /** 56 * EditMediaFileAction constructor. 57 * 58 * @param MediaFileService $media_file_service 59 * @param PendingChangesService $pending_changes_service 60 */ 61 public function __construct(MediaFileService $media_file_service, PendingChangesService $pending_changes_service) 62 { 63 $this->media_file_service = $media_file_service; 64 $this->pending_changes_service = $pending_changes_service; 65 } 66 67 /** 68 * Save an edited media file. 69 * 70 * @param ServerRequestInterface $request 71 * 72 * @return ResponseInterface 73 */ 74 public function handle(ServerRequestInterface $request): ResponseInterface 75 { 76 $tree = Validator::attributes($request)->tree(); 77 $xref = Validator::attributes($request)->isXref()->string('xref'); 78 $fact_id = Validator::attributes($request)->string('fact_id'); 79 $data_filesystem = Registry::filesystem()->data(); 80 81 $params = (array) $request->getParsedBody(); 82 $folder = $params['folder'] ?? ''; 83 $new_file = $params['new_file'] ?? ''; 84 $remote = $params['remote'] ?? ''; 85 $title = $params['title'] ?? ''; 86 $type = $params['type'] ?? ''; 87 $media = Registry::mediaFactory()->make($xref, $tree); 88 $media = Auth::checkMediaAccess($media, true); 89 90 // Tidy non-printing characters 91 $type = trim(preg_replace('/\s+/', ' ', $type)); 92 $title = trim(preg_replace('/\s+/', ' ', $title)); 93 94 // Find the fact to edit 95 $media_file = $media->mediaFiles() 96 ->first(static function (MediaFile $media_file) use ($fact_id): bool { 97 return $media_file->factId() === $fact_id; 98 }); 99 100 // Media file does not exist? 101 if ($media_file === null) { 102 return redirect(route(TreePage::class, ['tree' => $tree->name()])); 103 } 104 105 // We can edit the file as either a URL or a folder/file 106 if ($remote !== '') { 107 $file = $remote; 108 } else { 109 $new_file = str_replace('\\', '/', $new_file); 110 $folder = str_replace('\\', '/', $folder); 111 $folder = trim($folder, '/'); 112 113 if ($folder === '') { 114 $file = $new_file; 115 } else { 116 $file = $folder . '/' . $new_file; 117 } 118 } 119 120 // Invalid filename? Do not change it. 121 if ($new_file === '') { 122 $file = $media_file->filename(); 123 } 124 125 $filesystem = $media->tree()->mediaFilesystem($data_filesystem); 126 $old = $media_file->filename(); 127 $new = $file; 128 129 // Update the filesystem, if we can. 130 if ($old !== $new && !$media_file->isExternal() && $filesystem->fileExists($old)) { 131 try { 132 $file_exists = $filesystem->fileExists($old); 133 134 if ($file_exists) { 135 try { 136 $filesystem->move($old, $new); 137 FlashMessages::addMessage(I18N::translate('The media file %1$s has been renamed to %2$s.', Html::filename($media_file->filename()), Html::filename($file)), 'info'); 138 } catch (FilesystemException | UnableToMoveFile $ex) { 139 // Don't overwrite existing file 140 FlashMessages::addMessage(I18N::translate('The media file %1$s could not be renamed to %2$s.', Html::filename($media_file->filename()), Html::filename($file)), 'info'); 141 $file = $old; 142 } 143 } 144 } catch (FilesystemException | UnableToRetrieveMetadata $ex) { 145 // File does not exist? 146 } 147 } 148 149 $gedcom = $this->media_file_service->createMediaFileGedcom($file, $type, $title, ''); 150 151 $media->updateFact($fact_id, $gedcom, true); 152 153 // Accept the changes, to keep the filesystem in sync with the GEDCOM data. 154 if ($old !== $new && !$media_file->isExternal()) { 155 $this->pending_changes_service->acceptRecord($media); 156 } 157 158 return redirect($media->url()); 159 } 160} 161