xref: /webtrees/app/MediaFile.php (revision dd7dd2a11a7399e56fa4d21fb56b0ecdff69c7d0) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees;
19
20use League\Glide\Urls\UrlBuilderFactory;
21use Throwable;
22
23/**
24 * A GEDCOM media file.  A media object can contain many media files,
25 * such as scans of both sides of a document, the transcript of an audio
26 * recording, etc.
27 */
28class MediaFile
29{
30    private const MIME_TYPES = [
31        'bmp'  => 'image/bmp',
32        'doc'  => 'application/msword',
33        'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
34        'ged'  => 'text/x-gedcom',
35        'gif'  => 'image/gif',
36        'html' => 'text/html',
37        'htm'  => 'text/html',
38        'jpeg' => 'image/jpeg',
39        'jpg'  => 'image/jpeg',
40        'mov'  => 'video/quicktime',
41        'mp3'  => 'audio/mpeg',
42        'mp4'  => 'video/mp4',
43        'ogv'  => 'video/ogg',
44        'pdf'  => 'application/pdf',
45        'png'  => 'image/png',
46        'rar'  => 'application/x-rar-compressed',
47        'swf'  => 'application/x-shockwave-flash',
48        'svg'  => 'image/svg',
49        'tiff' => 'image/tiff',
50        'tif'  => 'image/tiff',
51        'xls'  => 'application/vnd-ms-excel',
52        'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
53        'wmv'  => 'video/x-ms-wmv',
54        'zip'  => 'application/zip',
55    ];
56
57    /** @var string The filename */
58    private $multimedia_file_refn = '';
59
60    /** @var string The file extension; jpeg, txt, mp4, etc. */
61    private $multimedia_format = '';
62
63    /** @var string The type of document; newspaper, microfiche, etc. */
64    private $source_media_type = '';
65    /** @var string The filename */
66
67    /** @var string The name of the document */
68    private $descriptive_title = '';
69
70    /** @var Media $media The media object to which this file belongs */
71    private $media;
72
73    /** @var string */
74    private $fact_id;
75
76    /**
77     * Create a MediaFile from raw GEDCOM data.
78     *
79     * @param string $gedcom
80     * @param Media  $media
81     */
82    public function __construct($gedcom, Media $media)
83    {
84        $this->media   = $media;
85        $this->fact_id = md5($gedcom);
86
87        if (preg_match('/^\d FILE (.+)/m', $gedcom, $match)) {
88            $this->multimedia_file_refn = $match[1];
89            $this->multimedia_format    = pathinfo($match[1], PATHINFO_EXTENSION);
90        }
91
92        if (preg_match('/^\d FORM (.+)/m', $gedcom, $match)) {
93            $this->multimedia_format = $match[1];
94        }
95
96        if (preg_match('/^\d TYPE (.+)/m', $gedcom, $match)) {
97            $this->source_media_type = $match[1];
98        }
99
100        if (preg_match('/^\d TITL (.+)/m', $gedcom, $match)) {
101            $this->descriptive_title = $match[1];
102        }
103    }
104
105    /**
106     * Get the filename.
107     *
108     * @return string
109     */
110    public function filename(): string
111    {
112        return $this->multimedia_file_refn;
113    }
114
115    /**
116     * Get the base part of the filename.
117     *
118     * @return string
119     */
120    public function basename(): string
121    {
122        return basename($this->multimedia_file_refn);
123    }
124
125    /**
126     * Get the folder part of the filename.
127     *
128     * @return string
129     */
130    public function dirname(): string
131    {
132        $dirname = dirname($this->multimedia_file_refn);
133
134        if ($dirname === '.') {
135            return '';
136        }
137
138        return $dirname;
139    }
140
141    /**
142     * Get the format.
143     *
144     * @return string
145     */
146    public function format(): string
147    {
148        return $this->multimedia_format;
149    }
150
151    /**
152     * Get the type.
153     *
154     * @return string
155     */
156    public function type(): string
157    {
158        return $this->source_media_type;
159    }
160
161    /**
162     * Get the title.
163     *
164     * @return string
165     */
166    public function title(): string
167    {
168        return $this->descriptive_title;
169    }
170
171    /**
172     * Get the fact ID.
173     *
174     * @return string
175     */
176    public function factId(): string
177    {
178        return $this->fact_id;
179    }
180
181    /**
182     * @return bool
183     */
184    public function isPendingAddition(): bool
185    {
186        foreach ($this->media->facts() as $fact) {
187            if ($fact->id() === $this->fact_id) {
188                return $fact->isPendingAddition();
189            }
190        }
191
192        return false;
193    }
194
195    /**
196     * @return bool
197     */
198    public function isPendingDeletion(): bool
199    {
200        foreach ($this->media->facts() as $fact) {
201            if ($fact->id() === $this->fact_id) {
202                return $fact->isPendingDeletion();
203            }
204        }
205
206        return false;
207    }
208
209    /**
210     * Display an image-thumbnail or a media-icon, and add markup for image viewers such as colorbox.
211     *
212     * @param int      $width      Pixels
213     * @param int      $height     Pixels
214     * @param string   $fit        "crop" or "contain"
215     * @param string[] $attributes Additional HTML attributes
216     *
217     * @return string
218     */
219    public function displayImage($width, $height, $fit, $attributes = []): string
220    {
221        if ($this->isExternal()) {
222            $src    = $this->multimedia_file_refn;
223            $srcset = [];
224        } else {
225            // Generate multiple images for displays with higher pixel densities.
226            $src    = $this->imageUrl($width, $height, $fit);
227            $srcset = [];
228            foreach ([
229                         2,
230                         3,
231                         4,
232                     ] as $x) {
233                $srcset[] = $this->imageUrl($width * $x, $height * $x, $fit) . ' ' . $x . 'x';
234            }
235        }
236
237        if ($this->isImage()) {
238            $image = '<img ' . Html::attributes($attributes + [
239                        'dir'    => 'auto',
240                        'src'    => $src,
241                        'srcset' => implode(',', $srcset),
242                        'alt'    => htmlspecialchars_decode(strip_tags($this->media->getFullName())),
243                    ]) . '>';
244
245            $attributes = Html::attributes([
246                'class'      => 'gallery',
247                'type'       => $this->mimeType(),
248                'href'       => $this->imageUrl(0, 0, 'contain'),
249                'data-title' => htmlspecialchars_decode(strip_tags($this->media->getFullName())),
250            ]);
251        } else {
252            $image = view('icons/mime', ['type' => $this->mimeType()]);
253            $attributes = Html::attributes([
254                'type' => $this->mimeType(),
255                'href' => $this->downloadUrl(),
256            ]);
257        }
258
259        return '<a ' . $attributes . '>' . $image . '</a>';
260    }
261
262    /**
263     * A list of image attributes
264     *
265     * @return string[]
266     */
267    public function attributes(): array
268    {
269        $attributes = [];
270
271        if (!$this->isExternal() || $this->fileExists()) {
272            $file = $this->folder() . $this->multimedia_file_refn;
273
274            $attributes['__FILE_SIZE__'] = $this->fileSizeKB();
275
276            $imgsize = getimagesize($file);
277            if (is_array($imgsize) && !empty($imgsize['0'])) {
278                $attributes['__IMAGE_SIZE__'] = I18N::translate('%1$s × %2$s pixels', I18N::number($imgsize['0']), I18N::number($imgsize['1']));
279            }
280        }
281
282        return $attributes;
283    }
284
285    /**
286     * check if the file exists on this server
287     *
288     * @return bool
289     */
290    public function fileExists(): bool
291    {
292        return !$this->isExternal() && file_exists($this->folder() . $this->multimedia_file_refn);
293    }
294
295    /**
296     * Is the media file actually a URL?
297     */
298    public function isExternal(): bool
299    {
300        return strpos($this->multimedia_file_refn, '://') !== false;
301    }
302
303    /**
304     * Is the media file an image?
305     */
306    public function isImage(): bool
307    {
308        return in_array($this->extension(), [
309            'jpeg',
310            'jpg',
311            'gif',
312            'png',
313        ]);
314    }
315
316    /**
317     * Where is the file stored on disk?
318     */
319    public function folder(): string
320    {
321        return WT_DATA_DIR . $this->media->tree()->getPreference('MEDIA_DIRECTORY');
322    }
323
324    /**
325     * A user-friendly view of the file size
326     *
327     * @return int
328     */
329    private function fileSizeBytes(): int
330    {
331        try {
332            return filesize($this->folder() . $this->multimedia_file_refn);
333        } catch (Throwable $ex) {
334            return 0;
335        }
336    }
337
338    /**
339     * get the media file size in KB
340     *
341     * @return string
342     */
343    public function fileSizeKB(): string
344    {
345        $size = $this->fileSizeBytes();
346        $size = intdiv($size + 1023, 1024);
347
348        /* I18N: size of file in KB */
349        return I18N::translate('%s KB', I18N::number($size));
350    }
351
352    /**
353     * Get the filename on the server - for those (very few!) functions which actually
354     * need the filename, such as the PDF reports.
355     *
356     * @return string
357     */
358    public function getServerFilename()
359    {
360        $MEDIA_DIRECTORY = $this->media->tree()->getPreference('MEDIA_DIRECTORY');
361
362        if ($this->isExternal() || !$this->multimedia_file_refn) {
363            // External image, or (in the case of corrupt GEDCOM data) no image at all
364            return $this->multimedia_file_refn;
365        }
366
367        // Main image
368        return WT_DATA_DIR . $MEDIA_DIRECTORY . $this->multimedia_file_refn;
369    }
370
371    /**
372     * Generate a URL to download a non-image media file.
373     *
374     * @return string
375     */
376    public function downloadUrl(): string
377    {
378        return route('media-download', [
379            'xref'    => $this->media->xref(),
380            'ged'     => $this->media->tree()->name(),
381            'fact_id' => $this->fact_id,
382        ]);
383    }
384
385    /**
386     * Generate a URL for an image.
387     *
388     * @param int    $width  Maximum width in pixels
389     * @param int    $height Maximum height in pixels
390     * @param string $fit    "crop" or "contain"
391     *
392     * @return string
393     */
394    public function imageUrl($width, $height, $fit): string
395    {
396        // Sign the URL, to protect against mass-resize attacks.
397        $glide_key = Site::getPreference('glide-key');
398        if (empty($glide_key)) {
399            $glide_key = bin2hex(random_bytes(128));
400            Site::setPreference('glide-key', $glide_key);
401        }
402
403        if (Auth::accessLevel($this->media->tree()) > $this->media->tree()->getPreference('SHOW_NO_WATERMARK')) {
404            $mark = 'watermark.png';
405        } else {
406            $mark = '';
407        }
408
409        $url_builder = UrlBuilderFactory::create(WT_BASE_URL, $glide_key);
410
411        $url = $url_builder->getUrl('index.php', [
412            'route'     => 'media-thumbnail',
413            'xref'      => $this->media->xref(),
414            'ged'       => $this->media->tree()->name(),
415            'fact_id'   => $this->fact_id,
416            'w'         => $width,
417            'h'         => $height,
418            'fit'       => $fit,
419            'mark'      => $mark,
420            'markh'     => '100h',
421            'markw'     => '100w',
422            'markalpha' => 25,
423            'or'        => 0,
424            // Intervention uses exif_read_data() which is very buggy.
425        ]);
426
427        return $url;
428    }
429
430    /**
431     * What file extension is used by this file?
432     *
433     * @return string
434     */
435    public function extension()
436    {
437        if (preg_match('/\.([a-zA-Z0-9]+)$/', $this->multimedia_file_refn, $match)) {
438            return strtolower($match[1]);
439        }
440
441        return '';
442    }
443
444    /**
445     * What is the mime-type of this object?
446     * For simplicity and efficiency, use the extension, rather than the contents.
447     *
448     * @return string
449     */
450    public function mimeType(): string
451    {
452        return self::MIME_TYPES[$this->extension()] ?? 'application/octet-stream';
453    }
454}
455