. */ declare(strict_types=1); namespace Fisharebest\Webtrees\Services; use Fisharebest\Webtrees\Registry; use Fisharebest\Webtrees\FlashMessages; use Fisharebest\Webtrees\GedcomTag; use Fisharebest\Webtrees\I18N; use Fisharebest\Webtrees\Tree; use Illuminate\Database\Capsule\Manager as DB; use Illuminate\Database\Query\Expression; use Illuminate\Support\Collection; use InvalidArgumentException; use League\Flysystem\FilesystemInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\UploadedFileInterface; use RuntimeException; use function array_combine; use function array_diff; use function array_filter; use function array_map; use function assert; use function dirname; use function ini_get; use function intdiv; use function min; use function pathinfo; use function preg_replace; use function sha1; use function sort; use function str_contains; use function strtolower; use function strtr; use function substr; use function trim; use const PATHINFO_EXTENSION; use const UPLOAD_ERR_OK; /** * Managing media files. */ class MediaFileService { public const EDIT_RESTRICTIONS = [ 'locked', ]; public const PRIVACY_RESTRICTIONS = [ 'none', 'privacy', 'confidential', ]; public const EXTENSION_TO_FORM = [ 'jpg' => 'jpeg', 'tif' => 'tiff', ]; /** * What is the largest file a user may upload? */ public function maxUploadFilesize(): string { $sizePostMax = $this->parseIniFileSize(ini_get('post_max_size')); $sizeUploadMax = $this->parseIniFileSize(ini_get('upload_max_filesize')); $bytes = min($sizePostMax, $sizeUploadMax); $kb = intdiv($bytes + 1023, 1024); return I18N::translate('%s KB', I18N::number($kb)); } /** * Returns the given size from an ini value in bytes. * * @param string $size * * @return int */ private function parseIniFileSize(string $size): int { $number = (int) $size; switch (substr($size, -1)) { case 'g': case 'G': return $number * 1073741824; case 'm': case 'M': return $number * 1048576; case 'k': case 'K': return $number * 1024; default: return $number; } } /** * A list of key/value options for media types. * * @param string $current * * @return array * * @deprecated - Will be removed in 2.1.0 - use Registry::elementFactory()->make('OBJE:FILE:FORM:TYPE')->values() */ public function mediaTypes($current = ''): array { return Registry::elementFactory()->make('OBJE:FILE:FORM:TYPE')->values(); } /** * A list of media files not already linked to a media object. * * @param Tree $tree * @param FilesystemInterface $data_filesystem * * @return array */ public function unusedFiles(Tree $tree, FilesystemInterface $data_filesystem): array { $used_files = DB::table('media_file') ->where('m_file', '=', $tree->id()) ->where('multimedia_file_refn', 'NOT LIKE', 'http://%') ->where('multimedia_file_refn', 'NOT LIKE', 'https://%') ->pluck('multimedia_file_refn') ->all(); $disk_files = $tree->mediaFilesystem($data_filesystem)->listContents('', true); $disk_files = array_filter($disk_files, static function (array $item) { // Older versions of webtrees used a couple of special folders. return $item['type'] === 'file' && !str_contains($item['path'], '/thumbs/') && !str_contains($item['path'], '/watermarks/'); }); $disk_files = array_map(static function (array $item): string { return $item['path']; }, $disk_files); $unused_files = array_diff($disk_files, $used_files); sort($unused_files); return array_combine($unused_files, $unused_files); } /** * Store an uploaded file (or URL), either to be added to a media object * or to create a media object. * * @param ServerRequestInterface $request * * @return string The value to be stored in the 'FILE' field of the media object. */ public function uploadFile(ServerRequestInterface $request): string { $tree = $request->getAttribute('tree'); assert($tree instanceof Tree); $data_filesystem = Registry::filesystem()->data(); $params = (array) $request->getParsedBody(); $file_location = $params['file_location']; switch ($file_location) { case 'url': $remote = $params['remote']; if (str_contains($remote, '://')) { return $remote; } return ''; case 'unused': $unused = $params['unused']; if ($tree->mediaFilesystem($data_filesystem)->has($unused)) { return $unused; } return ''; case 'upload': default: $folder = $params['folder']; $auto = $params['auto']; $new_file = $params['new_file']; /** @var UploadedFileInterface|null $uploaded_file */ $uploaded_file = $request->getUploadedFiles()['file']; if ($uploaded_file === null || $uploaded_file->getError() !== UPLOAD_ERR_OK) { return ''; } // The filename $new_file = strtr($new_file, ['\\' => '/']); if ($new_file !== '' && !str_contains($new_file, '/')) { $file = $new_file; } else { $file = $uploaded_file->getClientFilename(); } // The folder $folder = strtr($folder, ['\\' => '/']); $folder = trim($folder, '/'); if ($folder !== '') { $folder .= '/'; } // Generate a unique name for the file? if ($auto === '1' || $tree->mediaFilesystem($data_filesystem)->has($folder . $file)) { $folder = ''; $extension = pathinfo($uploaded_file->getClientFilename(), PATHINFO_EXTENSION); $file = sha1((string) $uploaded_file->getStream()) . '.' . $extension; } try { $tree->mediaFilesystem($data_filesystem)->putStream($folder . $file, $uploaded_file->getStream()->detach()); return $folder . $file; } catch (RuntimeException | InvalidArgumentException $ex) { FlashMessages::addMessage(I18N::translate('There was an error uploading your file.')); return ''; } } } /** * Convert the media file attributes into GEDCOM format. * * @param string $file * @param string $type * @param string $title * @param string $note * * @return string */ public function createMediaFileGedcom(string $file, string $type, string $title, string $note): string { // Tidy non-printing characters $type = trim(preg_replace('/\s+/', ' ', $type)); $title = trim(preg_replace('/\s+/', ' ', $title)); $gedcom = '1 FILE ' . $file; $format = strtolower(pathinfo($file, PATHINFO_EXTENSION)); $format = self::EXTENSION_TO_FORM[$format] ?? $format; if ($format !== '') { $gedcom .= "\n2 FORM " . $format; } elseif ($type !== '') { $gedcom .= "\n2 FORM"; } if ($type !== '') { $gedcom .= "\n3 TYPE " . $type; } if ($title !== '') { $gedcom .= "\n2 TITL " . $title; } if ($note !== '') { // Convert HTML line endings to GEDCOM continuations $gedcom .= "\n1 NOTE " . strtr($note, ["\r\n" => "\n2 CONT "]); } return $gedcom; } /** * Fetch a list of all files on disk (in folders used by any tree). * * @param FilesystemInterface $data_filesystem Fileystem to search * @param string $media_folder Root folder * @param bool $subfolders Include subfolders * * @return Collection */ public function allFilesOnDisk(FilesystemInterface $data_filesystem, string $media_folder, bool $subfolders): Collection { $array = $data_filesystem->listContents($media_folder, $subfolders); return Collection::make($array) ->filter(static function (array $metadata): bool { return $metadata['type'] === 'file' && !str_contains($metadata['path'], '/thumbs/') && !str_contains($metadata['path'], '/watermark/'); }) ->map(static function (array $metadata): string { return $metadata['path']; }); } /** * Fetch a list of all files on in the database. * * @param string $media_folder Root folder * @param bool $subfolders Include subfolders * * @return Collection */ public function allFilesInDatabase(string $media_folder, bool $subfolders): Collection { $query = DB::table('media_file') ->join('gedcom_setting', 'gedcom_id', '=', 'm_file') ->where('setting_name', '=', 'MEDIA_DIRECTORY') //->where('multimedia_file_refn', 'LIKE', '%/%') ->where('multimedia_file_refn', 'NOT LIKE', 'http://%') ->where('multimedia_file_refn', 'NOT LIKE', 'https://%') ->where(new Expression('setting_value || multimedia_file_refn'), 'LIKE', $media_folder . '%') ->select(new Expression('setting_value || multimedia_file_refn AS path')) ->orderBy(new Expression('setting_value || multimedia_file_refn')); if (!$subfolders) { $query->where(new Expression('setting_value || multimedia_file_refn'), 'NOT LIKE', $media_folder . '%/%'); } return $query->pluck('path'); } /** * Generate a list of all folders in either the database or the filesystem. * * @param FilesystemInterface $data_filesystem * * @return Collection */ public function allMediaFolders(FilesystemInterface $data_filesystem): Collection { $db_folders = DB::table('media_file') ->join('gedcom_setting', 'gedcom_id', '=', 'm_file') ->where('setting_name', '=', 'MEDIA_DIRECTORY') ->where('multimedia_file_refn', 'NOT LIKE', 'http://%') ->where('multimedia_file_refn', 'NOT LIKE', 'https://%') ->select(new Expression('setting_value || multimedia_file_refn AS path')) ->pluck('path') ->map(static function (string $path): string { return dirname($path) . '/'; }); $media_roots = DB::table('gedcom_setting') ->where('setting_name', '=', 'MEDIA_DIRECTORY') ->where('gedcom_id', '>', '0') ->pluck('setting_value') ->uniqueStrict(); $disk_folders = new Collection($media_roots); foreach ($media_roots as $media_folder) { $tmp = Collection::make($data_filesystem->listContents($media_folder, true)) ->filter(static function (array $metadata) { return $metadata['type'] === 'dir'; }) ->map(static function (array $metadata): string { return $metadata['path'] . '/'; }) ->filter(static function (string $dir): bool { return !str_contains($dir, '/thumbs/') && !str_contains($dir, 'watermarks'); }); $disk_folders = $disk_folders->concat($tmp); } return $disk_folders->concat($db_folders) ->uniqueStrict() ->mapWithKeys(static function (string $folder): array { return [$folder => $folder]; }); } }