.
*/
namespace Fisharebest\Webtrees;
use ErrorException;
use League\Glide\Urls\UrlBuilderFactory;
/**
* A GEDCOM media file. A media object can contain many media files,
* such as scans of both sides of a document, the transcript of an audio
* recording, etc.
*/
class MediaFile {
/** @var string The filename */
private $multimedia_file_refn = '';
/** @var string The file extension; jpeg, txt, mp4, etc. */
private $multimedia_format = '';
/** @var string The type of document; newspaper, microfiche, etc. */
private $source_media_type = '';
/** @var string The filename */
/** @var string The name of the document */
private $descriptive_title = '';
/** @var Media $media The media object to which this file belongs */
private $media;
/** @var string */
private $fact_id;
/**
* Create a MediaFile from raw GEDCOM data.
*
* @param string $gedcom
* @param Media $media
*/
public function __construct($gedcom, Media $media) {
$this->media = $media;
$this->fact_id = md5($gedcom);
if (preg_match('/^\d FILE (.+)/m', $gedcom, $match)) {
$this->multimedia_file_refn = $match[1];
}
if (preg_match('/^\d FORM (.+)/m', $gedcom, $match)) {
$this->multimedia_format = $match[1];
}
if (preg_match('/^\d TYPE (.+)/m', $gedcom, $match)) {
$this->source_media_type = $match[1];
}
if (preg_match('/^\d TITL (.+)/m', $gedcom, $match)) {
$this->descriptive_title = $match[1];
}
}
/**
* Get the filename.
*
* @return string
*/
public function filename(): string {
return $this->multimedia_file_refn;
}
/**
* Get the format.
*
* @return string
*/
public function format(): string {
return $this->multimedia_format;
}
/**
* Get the type.
*
* @return string
*/
public function type(): string {
return $this->source_media_type;
}
/**
* Get the title.
*
* @return string
*/
public function title(): string {
return $this->descriptive_title;
}
/**
* Get the fact ID.
*
* @return string
*/
public function factId(): string {
return $this->fact_id;
}
/**
* Display an image-thumbnail or a media-icon, and add markup for image viewers such as colorbox.
*
* @param int $width Pixels
* @param int $height Pixels
* @param string $fit "crop" or "contain"
* @param string[] $attributes Additional HTML attributes
*
* @return string
*/
public function displayImage($width, $height, $fit, $attributes = []) {
if ($this->isExternal()) {
$src = $this->multimedia_file_refn;
$srcset = [];
} else {
// Generate multiple images for displays with higher pixel densities.
$src = $this->imageUrl($width, $height, $fit);
$srcset = [];
foreach ([2, 3, 4] as $x) {
$srcset[] = $this->imageUrl($width * $x, $height * $x, $fit) . ' ' . $x . 'x';
}
}
$image = '![]()
'auto',
'src' => $src,
'srcset' => implode(',', $srcset),
'alt' => strip_tags($this->media->getFullName()),
]) . '>';
$attributes = Html::attributes([
'class' => 'gallery',
'type' => $this->mimeType(),
'href' => $this->imageUrl(0, 0, ''),
]);
return '' . $image . '';
}
/**
* A list of image attributes
*
* @return string[]
*/
public function attributes(): array {
$attributes = [];
if (!$this->isExternal() || $this->fileExists()) {
$file = $this->folder() . $this->multimedia_file_refn;
$attributes['__FILE_SIZE__'] = $this->fileSizeKB();
$imgsize = getimagesize($file);
if (is_array($imgsize) && !empty($imgsize['0'])) {
$attributes['__IMAGE_SIZE__'] = I18N::translate('%1$s × %2$s pixels', I18N::number($imgsize['0']), I18N::number($imgsize['1']));
}
}
return $attributes;
}
/**
* check if the file exists on this server
*
* @return bool
*/
public function fileExists() {
return file_exists($this->folder() . $this->multimedia_file_refn);
}
/**
* Is the media file actually a URL?
*/
public function isExternal(): bool {
return strpos($this->multimedia_file_refn, '://') !== false;
}
/**
* Is the media file an image?
*/
public function isImage(): bool {
return in_array($this->extension(), ['jpeg', 'jpg', 'gif', 'png']);
}
/**
* Where is the file stored on disk?
*/
public function folder(): string {
return WT_DATA_DIR . $this->media->getTree()->getPreference('MEDIA_DIRECTORY');
}
/**
* A user-friendly view of the file size
*
* @return int
*/
private function fileSizeBytes(): int {
try {
return filesize($this->folder() . $this->multimedia_file_refn);
} catch (ErrorException $ex) {
DebugBar::addThrowable($ex);
return 0;
}
}
/**
* get the media file size in KB
*
* @return string
*/
public function fileSizeKB() {
$size = $this->filesizeBytes();
$size = (int) (($size + 1023) / 1024);
return /* I18N: size of file in KB */ I18N::translate('%s KB', I18N::number($size));
}
///////////////////////////////////////////////////////////////////////////
/**
* Get the filename on the server - for those (very few!) functions which actually
* need the filename, such as mediafirewall.php and the PDF reports.
*
* @return string
*/
public function getServerFilename() {
$MEDIA_DIRECTORY = $this->media->getTree()->getPreference('MEDIA_DIRECTORY');
if ($this->isExternal() || !$this->multimedia_file_refn) {
// External image, or (in the case of corrupt GEDCOM data) no image at all
return $this->multimedia_file_refn;
} else {
// Main image
return WT_DATA_DIR . $MEDIA_DIRECTORY . $this->multimedia_file_refn;
}
}
/**
* get image properties
*
* @return array
*/
public function getImageAttributes() {
$imgsize = [];
if ($this->fileExists()) {
try {
$imgsize = getimagesize($this->getServerFilename());
if (is_array($imgsize) && !empty($imgsize['0'])) {
// this is an image
$imageTypes = ['', 'GIF', 'JPG', 'PNG', 'SWF', 'PSD', 'BMP', 'TIFF', 'TIFF', 'JPC', 'JP2', 'JPX', 'JB2', 'SWC', 'IFF', 'WBMP', 'XBM'];
$imgsize['ext'] = $imageTypes[0 + $imgsize[2]];
// this is for display purposes, always show non-adjusted info
$imgsize['WxH'] = /* I18N: image dimensions, width × height */
I18N::translate('%1$s × %2$s pixels', I18N::number($imgsize['0']), I18N::number($imgsize['1']));
}
} catch (ErrorException $ex) {
DebugBar::addThrowable($ex);
// Not an image, or not a valid image?
$imgsize = false;
}
}
if (!is_array($imgsize) || empty($imgsize['0'])) {
// this is not an image, OR the file doesn’t exist OR it is a url
$imgsize[0] = 0;
$imgsize[1] = 0;
$imgsize['ext'] = '';
$imgsize['mime'] = '';
$imgsize['WxH'] = '';
}
if (empty($imgsize['mime'])) {
// this is not an image, OR the file doesn’t exist OR it is a url
// set file type equal to the file extension - can’t use parse_url because this may not be a full url
$exp = explode('?', $this->multimedia_file_refn);
$imgsize['ext'] = strtoupper(pathinfo($exp[0], PATHINFO_EXTENSION));
// all mimetypes we wish to serve with the media firewall must be added to this array.
$mime = [
'DOC' => 'application/msword',
'MOV' => 'video/quicktime',
'MP3' => 'audio/mpeg',
'PDF' => 'application/pdf',
'PPT' => 'application/vnd.ms-powerpoint',
'RTF' => 'text/rtf',
'SID' => 'image/x-mrsid',
'TXT' => 'text/plain',
'XLS' => 'application/vnd.ms-excel',
'WMV' => 'video/x-ms-wmv',
];
if (empty($mime[$imgsize['ext']])) {
// if we don’t know what the mimetype is, use something ambiguous
$imgsize['mime'] = 'application/octet-stream';
if ($this->fileExists()) {
// alert the admin if we cannot determine the mime type of an existing file
// as the media firewall will be unable to serve this file properly
Log::addMediaLog('Media Firewall error: >Unknown Mimetype< for file >' . $this->multimedia_file_refn . '<');
}
} else {
$imgsize['mime'] = $mime[$imgsize['ext']];
}
}
return $imgsize;
}
/**
* Generate a URL for an image.
*
* @param int $width Maximum width in pixels
* @param int $height Maximum height in pixels
* @param string $fit "crop" or "contain"
*
* @return string
*/
public function imageUrl($width, $height, $fit) {
// Sign the URL, to protect against mass-resize attacks.
$glide_key = Site::getPreference('glide-key');
if (empty($glide_key)) {
$glide_key = bin2hex(random_bytes(128));
Site::setPreference('glide-key', $glide_key);
}
if (Auth::accessLevel($this->media->getTree()) > $this->media->getTree()->getPreference('SHOW_NO_WATERMARK')) {
$mark = 'watermark.png';
} else {
$mark = '';
}
$url_builder = UrlBuilderFactory::create(WT_BASE_URL, $glide_key);
$url = $url_builder->getUrl('index.php', [
'route' => 'media-thumbnail',
'xref' => $this->media->getXref(),
'ged' => $this->media->getTree()->getName(),
'fact_id' => $this->fact_id,
'w' => $width,
'h' => $height,
'fit' => $fit,
'mark' => $mark,
'markh' => '100h',
'markw' => '100w',
'markalpha' => 25,
'or' => 0, // Intervention uses exif_read_data() which is very buggy.
]);
return $url;
}
/**
* What file extension is used by this file?
*
* @return string
*/
public function extension() {
if (preg_match('/\.([a-zA-Z0-9]+)$/', $this->multimedia_file_refn, $match)) {
return strtolower($match[1]);
} else {
return '';
}
}
/**
* What is the mime-type of this object?
* For simplicity and efficiency, use the extension, rather than the contents.
*
* @return string
*/
public function mimeType() {
// Themes contain icon definitions for some/all of these mime-types
switch ($this->extension()) {
case 'bmp':
return 'image/bmp';
case 'doc':
return 'application/msword';
case 'docx':
return 'application/msword';
case 'ged':
return 'text/x-gedcom';
case 'gif':
return 'image/gif';
case 'htm':
return 'text/html';
case 'html':
return 'text/html';
case 'jpeg':
return 'image/jpeg';
case 'jpg':
return 'image/jpeg';
case 'mov':
return 'video/quicktime';
case 'mp3':
return 'audio/mpeg';
case 'mp4':
return 'video/mp4';
case 'ogv':
return 'video/ogg';
case 'pdf':
return 'application/pdf';
case 'png':
return 'image/png';
case 'rar':
return 'application/x-rar-compressed';
case 'swf':
return 'application/x-shockwave-flash';
case 'svg':
return 'image/svg';
case 'tif':
return 'image/tiff';
case 'tiff':
return 'image/tiff';
case 'xls':
return 'application/vnd-ms-excel';
case 'xlsx':
return 'application/vnd-ms-excel';
case 'wmv':
return 'video/x-ms-wmv';
case 'zip':
return 'application/zip';
default:
return 'application/octet-stream';
}
}
}