summaryrefslogtreecommitdiff
path: root/library/WT/Media.php
diff options
context:
space:
mode:
Diffstat (limited to 'library/WT/Media.php')
-rw-r--r--library/WT/Media.php319
1 files changed, 319 insertions, 0 deletions
diff --git a/library/WT/Media.php b/library/WT/Media.php
new file mode 100644
index 0000000000..9189d89e95
--- /dev/null
+++ b/library/WT/Media.php
@@ -0,0 +1,319 @@
+<?php
+/**
+ * Class that defines a media object
+ *
+ * webtrees: Web based Family History software
+ * Copyright (C) 2010 webtrees development team.
+ *
+ * Derived from PhpGedView
+ * Copyright (C) 2002 to 2009 PGV Development Team. All rights reserved.
+ *
+ * Modifications Copyright (c) 2010 Greg Roach
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ *
+ * @package webtrees
+ * @subpackage Charts
+ * @version $Id$
+ */
+
+if (!defined('WT_WEBTREES')) {
+ header('HTTP/1.0 403 Forbidden');
+ exit;
+}
+
+define('WT_WT_MEDIA_PHP', '');
+
+class WT_Media extends WT_GedcomRecord {
+ var $title =null;
+ var $file =null;
+ var $ext ='';
+ var $mime ='';
+ var $note =null;
+ var $filesizeraw =-1;
+ var $width =0;
+ var $height =0;
+ var $serverfilename='';
+ var $fileexists =false;
+ var $filepropset =false;
+
+ // Create a Media object from either raw GEDCOM data or a database row
+ function __construct($data) {
+ if (is_array($data)) {
+ // Construct from a row from the database
+ $this->title=$data['m_titl'];
+ $this->file =$data['m_file'];
+ } else {
+ // Construct from raw GEDCOM data
+ $this->title = get_gedcom_value('TITL', 1, $data);
+ if (empty($this->title)) {
+ $this->title = get_gedcom_value('TITL', 2, $data);
+ }
+ $this->file = get_gedcom_value('FILE', 1, $data);
+ }
+ if (empty($this->title)) $this->title = $this->file;
+
+ parent::__construct($data);
+ }
+
+ /**
+ * get the media note
+ * @return string
+ */
+ function getNote() {
+ if (is_null($this->note)) {
+ $this->note=get_gedcom_value('NOTE', 1, $this->getGedcomRecord());
+ }
+ return $this->note;
+ }
+
+ /**
+ * get the thumbnail filename
+ * @return string
+ */
+ function getThumbnail($generateThumb = true) {
+ return thumbnail_file($this->file,$generateThumb);
+ }
+
+ /**
+ * get the media icon filename
+ * @return string
+ */
+ function getMediaIcon() {
+ return media_icon_file($this->file);
+ }
+
+ /**
+ * get the media file name
+ * @return string
+ */
+ function getFilename() {
+ return $this->file;
+ }
+
+ /**
+ * get the relative file path of the image on the server
+ * @return string
+ */
+ function getLocalFilename() {
+ return check_media_depth($this->file);
+ }
+
+ /**
+ * get the file name on the server
+ * @return string
+ */
+ function getServerFilename() {
+ global $USE_MEDIA_FIREWALL;
+ if ($this->serverfilename) return $this->serverfilename;
+ $localfilename = $this->getLocalFilename();
+ if (!empty($localfilename)) {
+ if (file_exists($localfilename)) {
+ // found image in unprotected directory
+ $this->fileexists = 2;
+ $this->serverfilename = $localfilename;
+ return $this->serverfilename;
+ }
+ if ($USE_MEDIA_FIREWALL) {
+ $protectedfilename = get_media_firewall_path($localfilename);
+ if (file_exists($protectedfilename)) {
+ // found image in protected directory
+ $this->fileexists = 3;
+ $this->serverfilename = $protectedfilename;
+ return $this->serverfilename;
+ }
+ }
+ }
+ // file doesn't exist, return the standard localfilename for backwards compatibility
+ $this->fileexists = false;
+ $this->serverfilename = $localfilename;
+ return $this->serverfilename;
+ }
+
+ /**
+ * check if the file exists on this server
+ * @return boolean
+ */
+ function fileExists() {
+ if (!$this->serverfilename) $this->getServerFilename();
+ return $this->fileexists;
+ }
+
+ /**
+ * get the media file size
+ * @return string
+ */
+ function getFilesize() {
+ if (!$this->filepropset) $this->setFileProperties();
+ return sprintf('%.2f', @$this->filesizeraw/1024);
+ }
+
+ /**
+ * get the media file size, unformatted
+ * @return number
+ */
+ function getFilesizeraw() {
+ if (!$this->filepropset) $this->setFileProperties();
+ return $this->filesizeraw;
+ }
+
+ /**
+ * get the media type
+ * @return string
+ */
+ function getMediatype() {
+ $mediaType = strtolower(get_gedcom_value('FORM:TYPE', 2, $this->gedrec));
+ return $mediaType;
+ }
+
+ /**
+ * get the media file type
+ * @return string
+ */
+ function getFiletype() {
+ if (!$this->filepropset) $this->setFileProperties();
+ return $this->ext;
+ }
+
+ /**
+ * get the media mime type
+ * @return string
+ */
+ function getMimetype() {
+ if (!$this->filepropset) $this->setFileProperties();
+ return $this->mime;
+ }
+
+ /**
+ * get the width of the image
+ * @return number (0 if not an image)
+ */
+ function getWidth() {
+ if (!$this->filepropset) $this->setFileProperties();
+ return $this->width;
+ }
+
+ /**
+ * get the height of the image
+ * @return number (0 if not an image)
+ */
+ function getHeight() {
+ if (!$this->filepropset) $this->setFileProperties();
+ return $this->height;
+ }
+
+ /**
+ * internal function, sets a number of properties
+ * no need to call directly
+ * @return nothing
+ */
+ function setFileProperties() {
+ if ($this->fileExists()) {
+ $this->filesizeraw = @filesize($this->getServerFilename());
+ $imgsize=@getimagesize($this->getServerFilename()); // [0]=width [1]=height [2]=filetype ['mime']=mimetype
+ if (is_array($imgsize)) {
+ // this is an image
+ $this->width =0+$imgsize[0];
+ $this->height=0+$imgsize[1];
+ $imageTypes =array('','GIF','JPG','PNG','SWF','PSD','BMP','TIFF','TIFF','JPC','JP2','JPX','JB2','SWC','IFF','WBMP','XBM');
+ $this->ext =$imageTypes[0+$imgsize[2]];
+ $this->mime =$imgsize['mime'];
+ }
+ }
+ if (!$this->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->file);
+ $pathinfo = pathinfo($exp[0]);
+ $this->ext = @strtoupper($pathinfo['extension']);
+ // all mimetypes we wish to serve with the media firewall must be added to this array.
+ $mime=array('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');
+ if (empty($mime[$this->ext])) {
+ // if we don't know what the mimetype is, use something ambiguous
+ $this->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
+ AddToLog('Media Firewall error: >Unknown Mimetype< for file >'.$this->file.'<', 'media');
+ }
+ } else {
+ $this->mime=$mime[$this->ext];
+ }
+ }
+ $this->filepropset = true;
+ }
+
+ // Generate a URL to this record, suitable for use in HTML
+ public function getHtmlUrl() {
+ return parent::_getLinkUrl('mediaviewer.php?mid=', '&amp;');
+ }
+ // Generate a URL to this record, suitable for use in javascript, HTTP headers, etc.
+ public function getRawUrl() {
+ return parent::_getLinkUrl('mediaviewer.php?mid=', '&');
+ }
+
+ /**
+ * check if the given Media object is in the objectlist
+ * @param Media $obje
+ * @return mixed returns the ID for the for the matching media or null if not found
+ */
+ static function in_obje_list($obje, $ged_id) {
+ return
+ WT_DB::prepare("SELECT m_media FROM `##media` WHERE m_file=? AND m_titl LIKE ? AND m_gedfile=?")
+ ->execute(array($obje->file, $obje->title, $ged_id))
+ ->fetchOne();
+ }
+
+ /**
+ * check if this object is equal to the given object
+ * basically just checks if the IDs are the same
+ * @param GedcomRecord $obj
+ */
+ function equals(&$obj) {
+ if (is_null($obj)) return false;
+ if ($this->xref==$obj->getXref()) return true;
+ if ($this->title==$obj->title && $this->file==$obj->file) return true;
+ return false;
+ }
+
+ // If this object has no name, what do we call it?
+ function getFallBackName() {
+ if ($this->canDisplayDetails()) {
+ return utf8_strtoupper(basename($this->file));
+ } else {
+ return $this->getXref();
+ }
+ }
+
+ // Get an array of structures containing all the names in the record
+ public function getAllNames() {
+ if (strpos($this->gedrec, "\n1 TITL ")) {
+ // Earlier gedcom versions had level 1 titles
+ return parent::_getAllNames('TITL', 1);
+ } else {
+ // Later gedcom versions had level 2 titles
+ return parent::_getAllNames('TITL', 2);
+ }
+ }
+
+ // Extra info to display when displaying this record in a list of
+ // selection items or favorites.
+ function format_list_details() {
+ ob_start();
+ print_media_links('1 OBJE @'.$this->getXref().'@', 1, $this->getXref());
+ return ob_get_clean();
+ }
+}
generated by cgit v1.3 (git 2.53.0) at 2026-07-06 14:53:55 +0000