egroupware/api/thumbnail.php

624 lines
18 KiB
PHP
Raw Normal View History

<?php
/**
* eGroupWare - eTemplates
*
* @link http://www.egroupware.org
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @author Nathan Gray
* @author Andreas Stöckel
* @package etemplate
* @version $Id$
*/
2016-04-06 21:39:49 +02:00
use EGroupware\Api;
use EGroupware\Api\Vfs;
//Set all necessary info and fire up egroupware
$GLOBALS['egw_info']['flags'] = array(
'currentapp' => get_app(),
'noheader' => true,
'nonavbar' => true
);
include ('../header.inc.php');
// strip slashes from _GET parameters, if someone still has magic_quotes_gpc on
if (function_exists('get_magic_quotes_gpc') && get_magic_quotes_gpc() && $_GET)
{
$_GET = array_stripslashes($_GET);
}
// no need to keep the session open (it stops other parallel calls)
$GLOBALS['egw']->session->commit_session();
if (!read_thumbnail(get_srcfile()))
{
header('404 Not found');
}
2009-04-07 21:40:42 +02:00
/**
* Reads the source file from the path parameters
*/
function get_srcfile()
{
if (isset($_GET['path']))
{
$g_srcfile = $_GET['path'];
}
else
{
2016-04-06 21:39:49 +02:00
$g_srcfile = Api\Link::vfs_path($_GET['app'], $_GET['id'], $_GET['file'], true);
}
2016-04-06 21:39:49 +02:00
return Vfs::PREFIX.$g_srcfile;
}
/**
* Returns the currently active app.
*/
function get_app()
{
if (isset($_GET['app']))
{
$app = $_GET['app'];
}
elseif (isset($_GET['path']))
{
@list(, $apps, $app) = explode('/', $_GET['path']);
if ($apps !== 'apps')
{
$app = 'filemanager';
}
}
if (!preg_match('/^[a-z0-9_-]+$/i',$app))
{
die('Stop'); // just to prevent someone doing nasty things
}
return $app;
}
/**
* Returns the maximum width/height of a thumbnail
*/
function get_maxsize()
{
$preset = !($GLOBALS['egw_info']['server']['link_list_thumbnail'] > 0) ? 64 :
$GLOBALS['egw_info']['server']['link_list_thumbnail'];
// Another maximum size may be passed if thumbnails are turned on
if ($preset != 0 && isset($_GET['thsize']) && is_numeric($_GET['thsize']))
{
$preset = (int)$_GET['thsize'];
}
return $preset;
}
/**
* Either loads the thumbnail for the given file form cache or generates a new
* one
*
* @param string $src is the file of which a thumbnail should be created
* @returns false if the file doesn't exist or any other error occured.
*/
function read_thumbnail($src)
{
//Check whether the source file is readable and exists
2016-04-06 21:39:49 +02:00
if (!file_exists($src) || !Vfs::is_readable($src))
{
return false;
}
// Get the maxsize of an thumbnail. If thumbnailing is turned off, the value
// will be 0
$maxsize = get_maxsize();
if (isset($_GET['thheight']) && (int)$_GET['thheight'] > 0)
{
$height = (int)$_GET['thheight'];
$maxh = $minh = $height;
}
elseif (isset($_GET['thwidth']) && (int)$_GET['thwidth'] > 0)
{
$width = (int)$_GET['thwidth'];
$maxw = $minw = $width;
}
elseif (isset($_GET['thminsize']) && (int)$_GET['thminsize'] > 0)
{
$minsize = (int)$_GET['thminsize'];
$minw = $minh = $minsize;
}
else
{
$maxw = $maxh = $maxsize;
}
//error_log(__METHOD__."() maxsize=$maxsize, width=$width, height=$height, minsize=$minsize --> maxw=$maxw, maxh=$maxh, minw=$minw, minh=$minh");
// Generate the destination filename and check whether the destination directory
// had been successfully created (the cache class used in gen_dstfile does that).
2016-04-06 21:39:49 +02:00
$stat = Vfs::stat(Vfs::parse_url($src, PHP_URL_PATH));
// if pdf-thumbnail-creation is not available, generate a single scaled-down pdf-icon
2016-04-06 21:39:49 +02:00
if ($stat && Vfs::mime_content_type($src) == 'application/pdf' && !pdf_thumbnails_available())
{
2016-04-06 21:39:49 +02:00
list($app, $icon) = explode('/', Vfs::mime_icon('application/pdf'), 2);
list(, $path) = explode($GLOBALS['egw_info']['server']['webserver_url'],
2016-04-06 21:39:49 +02:00
Api\Image::find($app, $icon), 2);
$src = EGW_SERVER_ROOT.$path;
$stat = false;
$maxsize = $height = $width = $minsize = $maxh = $minh = $maxw = $minw = 16;
}
$dst = gen_dstfile($stat && !empty($stat['url']) ? $stat['url'] : $src, $maxsize, $height, $width, $minsize);
$dst_dir = dirname($dst);
if(!file_exists($dst_dir) && !mkdir($dst_dir, 0700, true))
{
error_log(__FILE__ . " Unable to cache thumbnail. Check $dst_dir exists and web server has write access.");
}
if(file_exists($dst_dir))
{
// Check whether the destination file already exists and is newer than
// the source file. Assume the file doesn't exist if thumbnailing is turned off.
$exists = file_exists($dst) && filemtime($dst) >= filemtime($src);
// Only generate the thumbnail if the destination file does not match the
// conditions mentioned above. Abort if $maxsize is 0.
$gen_thumb = !$exists;
if ($gen_thumb && ($thumb = gd_image_thumbnail($src, $maxw, $maxh, $minw, $minh)))
{
// Save the file to disk...
imagepng($thumb, $dst);
// Previous versions generated a new copy of the png to output it -
// as encoding pngs is quite cpu-intensive I think it might
// be better to just read it from the temp dir again - as it is probably
// still in the fs-cache
$exists = true;
imagedestroy($thumb);
}
$output_mime = 'image/png';
// If some error occured during thumbnail generation or thumbnailing is turned off,
// simply output the mime type icon
if (!$exists)
{
2016-04-06 21:39:49 +02:00
$mime = Vfs::mime_content_type($src);
list($app, $icon) = explode('/', Vfs::mime_icon($mime), 2);
list(, $path) = explode($GLOBALS['egw_info']['server']['webserver_url'],
2016-04-06 21:39:49 +02:00
Api\Image::find($app, $icon), 2);
$dst = EGW_SERVER_ROOT.$path;
2016-07-12 20:50:19 +02:00
if (function_exists('mime_content_type'))
{
$output_mime = mime_content_type($dst);
}
else
{
$output_mime = Api\MimeMagic::filename2mime($dst);
}
}
if ($dst)
{
// Allow client to cache these, makes scrolling in filemanager much nicer
// setting maximum allow caching time of one year, if url contains (non-empty) moditication time
2016-04-06 21:39:49 +02:00
Api\Session::cache_control(empty($_GET['mtime']) ? 300 : 31536000, true); // true = private / browser only caching
header('Content-Type: '.$output_mime);
readfile($dst);
return true;
}
}
return false;
}
/**
* Get filename for thumbnail used for caching depending on it's size
*
* Priority is (highest to lowest) if given is: $height, $width, $minsize, $maxsize
*
* @param string $src
* @param int $maxsize
* @param int $height =null
* @param int $width =null
* @param int $minsize =null
* @return string
*/
function gen_dstfile($src, $maxsize, $height=null, $width=null, $minsize=null)
{
// Use the egroupware file cache to store the thumbnails on a per instance basis
2016-04-06 21:39:49 +02:00
$cachefile = new Api\Cache\Files(array());
$size = ($height > 0 ? 'h'.$height : ($width > 0 ? 'w'.$height : ($minsize > 0 ? 'm'.$minsize : $maxsize)));
2016-04-06 21:39:49 +02:00
return $cachefile->filename(Api\Cache::keys(Api\Cache::INSTANCE, 'etemplate',
'thumb_'.md5($src.$size).'.png'), true);
}
/**
* Function which calculates the sizes of an image with the width w and the height
* h, which should be scaled to an thumbnail of the maximum dimensions maxw and
* maxh
*
* @param int $w original width of the image
* @param int $h original height of the image
* @param int $maxw maximum width of the image
* @param int $maxh maximum height of the image
* @param int $minw the minimum width of the thumbnail
* @param int $minh the minimum height of the thumbnail
* @returns an array with two elements, w, h or "false" if the original dimensions
* of the image are that "odd", that one of the output sizes is smaller than one pixel.
*
* TODO: As this is a general purpose function, it might probably be moved
* to some other php file or an "image utils" class.
*/
2015-03-19 11:52:34 +01:00
function get_scaled_image_size($w, $h, $maxw, $maxh, $minw=0, $minh=0)
{
//Scale will contain the factor by which the image has to be scaled down
$scale = 1.0;
//Select the constraining dimension
if ($w > $h) // landscape image: constraining factor $minh or $maxw
{
$scale = $minh ? $minh / $h : $maxw / $w;
}
else // portrail image: constraining factor $minw or $maxh
{
$scale = $minw ? $minw / $w : $maxh / $h;
}
// Don't scale images up
if ($scale > 1.0)
{
$scale = 1.0;
}
$wout = round($w * $scale);
$hout = round($h * $scale);
//error_log(__METHOD__."(w=$w, h=$h, maxw=$maxw, maxh=$maxh, minw=$minw, minh=$minh) --> wout=$wout, hout=$hout");
//Return the calculated values
if ($wout < 1 || $hout < 1)
{
return false;
}
else
{
return array($wout, $hout);
}
}
/**
* Read thumbnail from image, without loading it completly using optional exif extension
*
* @param string $file
* @return boolean|resource false or a gd_image
*/
function exif_thumbnail_load($file)
{
if (!function_exists('exif_thumbnail') ||
!($image = exif_thumbnail($file)))
{
return false;
}
return imagecreatefromstring($image);
}
/**
* Loads the given imagefile - returns "false" if the file wasn't an image,
* otherwise the gd-image is returned.
*
* @param string $file the file which to load
* @param int $maxw the maximum width of the thumbnail
* @param int $maxh the maximum height of the thumbnail
* @returns boolean|resource false or a gd_image
*/
function gd_image_load($file,$maxw,$maxh)
{
// Get mime type
2016-04-06 21:39:49 +02:00
list($type, $image_type) = explode('/', $mime = Vfs::mime_content_type($file));
// if $file is not from vfs, use Api\MimeMagic::filename2mime to get mime-type from extension
if (!$type) list($type, $image_type) = explode('/', $mime = Api\MimeMagic::filename2mime($file));
// Call the according gd constructor depending on the file type
if($type == 'image')
{
if (in_array($image_type, array('tiff','jpeg')) && ($image = exif_thumbnail_load($file)))
{
return $image;
}
switch ($image_type)
{
case 'png':
return imagecreatefrompng($file);
case 'jpeg':
return imagecreatefromjpeg($file);
case 'gif':
return imagecreatefromgif($file);
case 'bmp':
return imagecreatefromwbmp($file);
2016-02-29 14:05:48 +01:00
case 'svg+xml':
2016-04-06 21:39:49 +02:00
Api\Header\Content::type(Vfs::basename($file), $mime);
2016-02-29 14:05:48 +01:00
readfile($file);
2016-04-06 21:39:49 +02:00
exit;
}
}
2015-02-12 19:24:47 +01:00
else if ($type == 'application')
{
$thumb = false;
2015-02-12 19:24:47 +01:00
if(strpos($image_type,'vnd.oasis.opendocument.') === 0)
{
// OpenDocuments have thumbnails inside already
$thumb = get_opendocument_thumbnail($file);
2015-02-12 19:24:47 +01:00
}
else if($image_type == 'pdf')
{
$thumb = get_pdf_thumbnail($file);
}
else if (strpos($image_type, 'vnd.openxmlformats-officedocument.') === 0)
{
// TODO: Figure out how this can be done reliably
//$thumb = get_msoffice_thumbnail($file);
}
// Mark it with mime type icon
if($thumb)
{
// Need to scale first, or the mark will be wrong size
$scaled = get_scaled_image_size(imagesx($thumb), imagesy($thumb), $maxw, $maxh);
if ($scaled !== false)
{
list($sw, $sh) = $scaled;
//Now scale it down
$img_dst = gd_create_transparent_image($sw, $sh);
imagecopyresampled($img_dst, $thumb, 0, 0, 0, 0, $sw, $sh, imagesx($thumb), imagesy($thumb));
$thumb = $img_dst;
}
2016-04-06 21:39:49 +02:00
$mime = Vfs::mime_content_type($file);
$tag_image = null;
corner_tag($thumb, $tag_image, $mime);
imagedestroy($tag_image);
2015-02-12 19:24:47 +01:00
}
return $thumb;
}
return false;
}
/**
* Extract the thumbnail from an opendocument file and apply a colored mask
* so you can tell what type it is, and so it looks a little better in larger
* thumbnails (eg: in tiled view)
*
* Inspired by thumbnails for nautilus:
* http://bernaerts.dyndns.org/linux/76-gnome/285-gnome-shell-generate-libreoffice-thumbnail-nautilus
*
* @param string $file
* @return resource GD image
*/
function get_opendocument_thumbnail($file)
{
2016-04-06 21:39:49 +02:00
$mimetype = explode('/', Vfs::mime_content_type($file));
// Image is already there, but we can't access them directly through VFS
$ext = $mimetype == 'application/vnd.oasis.opendocument.text' ? '.odt' : '.ods';
$archive = tempnam($GLOBALS['egw_info']['server']['temp_dir'], basename($file,$ext).'-');
copy($file,$archive);
$thumbnail_url = 'zip://'.$archive.'#Thumbnails/thumbnail.png';
$image = imagecreatefromstring(file_get_contents($thumbnail_url));
unlink($archive);
/*
// Mask it with a color by type
$mask = imagecreatefrompng('templates/default/images/opendocument.png');
if($image)
{
$filter_color = array(0,0,0);
switch($mimetype[1])
{
// Type colors from LibreOffice (https://wiki.documentfoundation.org/Design/Whiteboards/LibreOffice_Initial_Icons)
case 'vnd.oasis.opendocument.text':
$filter_color = array(2,63,98); break;
case 'vnd.oasis.opendocument.spreadsheet':
$filter_color = array(16,104,2); break;
case 'vnd.oasis.opendocument.presentation':
$filter_color = array(98,37,2); break;
case 'vnd.oasis.opendocument.graphics':
$filter_color = array(135,105,0); break;
case 'vnd.oasis.opendocument.database':
$filter_color = array(83,2,96); break;
}
imagefilter($mask, IMG_FILTER_COLORIZE, $filter_color[0],$filter_color[1],$filter_color[2] );
imagecopyresampled($image, $mask,0,0,0,0,imagesx($image),imagesy($image),imagesx($mask),imagesy($mask));
}
*
*/
return $image;
}
/**
* Check if we have the necessary requirements to generate pdf thumbnails
*
* @return boolean
*/
function pdf_thumbnails_available()
{
return class_exists('Imagick');
}
2015-02-12 19:24:47 +01:00
/**
* Extract the thumbnail from a PDF file and apply a colored mask
* so you can tell what type it is, and so it looks a little better in larger
* thumbnails (eg: in tiled view).
*
* Requires ImageMagick & ghostscript.
*
* @param string $file
* @return resource GD image
*/
function get_pdf_thumbnail($file)
{
if(!pdf_thumbnails_available()) return false;
2015-02-12 19:24:47 +01:00
// switch off max_excution_time, as some thumbnails take longer and
// will be startet over and over again, if they dont finish
@set_time_limit(0);
2015-02-12 19:24:47 +01:00
$im = new Imagick($file);
$im->setimageformat('png');
$im->setresolution(300, 300);
$gd = imagecreatefromstring($im->getimageblob());
return $gd;
}
/**
* Put the tag image in the corner of the target image
*
* Used for thumbnails of documents, so you can still see the mime type
*
* @param resource& $target_image
* @param resource&|null $tag_image
* @param string|null $mime Use correct mime type icon instead of $tag_image
*/
function corner_tag(&$target_image, &$tag_image, $mime)
{
$target_width = imagesx($target_image);
$target_height = imagesy($target_image);
// Find mime image, if no tag image set
if(!$tag_image && $mime)
{
2016-04-06 21:39:49 +02:00
list($app, $icon) = explode('/', Vfs::mime_icon($mime), 2);
list(, $path) = explode($GLOBALS['egw_info']['server']['webserver_url'],
2016-04-06 21:39:49 +02:00
Api\Image::find($app, $icon), 2);
$dst = EGW_SERVER_ROOT.$path;
$tag_image = imagecreatefrompng($dst);
}
// Find correct size - max 1/3 target
$tag_size = get_scaled_image_size(imagesx($tag_image), imagesy($tag_image), $target_width / 3, $target_height / 3);
if(!$tag_size) return;
list($tag_width,$tag_height) = $tag_size;
// Put it in
if($mime)
{
imagecopyresampled($target_image,$tag_image,
$target_width - $tag_width,
$target_height - $tag_height,
0,0,
$tag_width,
$tag_height,
imagesx($tag_image),
imagesy($tag_image)
);
}
}
/**
* Create an gd_image with transparent background.
*
* @param int $w the width of the resulting image
* @param int $h the height of the resutling image
*/
function gd_create_transparent_image($w, $h)
{
if (!($gdVersion = gdVersion()))
{
//Looking up the gd version failed, return false
return false;
}
elseif ($gdVersion >= 2)
{
//Create an 32-bit image and fill it with transparency.
$img_dst = imagecreatetruecolor($w, $h);
imageSaveAlpha($img_dst, true);
$trans_color = imagecolorallocatealpha($img_dst, 0, 0, 0, 127);
imagefill($img_dst, 0, 0, $trans_color);
return $img_dst;
}
else
{
//Just crate a simple image
return imagecreate($w, $h);
}
}
/**
* Creates a scaled version of the given image - returns the gd-image or false if the
* process failed.
*
* @param string $file the filename of the file
* @param int $maxw the maximum width of the thumbnail
* @param int $maxh the maximum height of the thumbnail
* @param int $minw the minimum width of the thumbnail
* @param int $minh the minimum height of the thumbnail
* @return the gd_image or false if one of the steps taken to produce the thumbnail
* failed.
*/
function gd_image_thumbnail($file, $maxw, $maxh, $minw, $minh)
{
//Load the image
if (($img_src = gd_image_load($file,$maxw,$maxh)) !== false)
{
//Get the constraints of the image
$w = imagesx($img_src);
$h = imagesy($img_src);
//Calculate the actual size of the thumbnail
$scaled = get_scaled_image_size($w, $h, $maxw, $maxh, $minw, $minh);
if ($scaled !== false)
{
list($sw, $sh) = $scaled;
//Now scale it down
$img_dst = gd_create_transparent_image($sw, $sh);
imagecopyresampled($img_dst, $img_src, 0, 0, 0, 0, $sw, $sh, $w, $h);
return $img_dst;
}
}
return false;
}
/**
* Get which version of GD is installed, if any.
*
* Returns the version (1 or 2) of the GD extension.
* Off the php manual page, thanks Hagan Fox
*/
function gdVersion($user_ver = 0)
{
if (! extension_loaded('gd')) { return; }
static $gd_ver = 0;
// Just accept the specified setting if it's 1.
if ($user_ver == 1) { $gd_ver = 1; return 1; }
// Use the static variable if function was called previously.
if ($user_ver !=2 && $gd_ver > 0 ) { return $gd_ver; }
// Use the gd_info() function if possible.
if (function_exists('gd_info')) {
$ver_info = gd_info();
$match = null;
preg_match('/\d/', $ver_info['GD Version'], $match);
$gd_ver = $match[0];
return $match[0];
}
// If phpinfo() is disabled use a specified / fail-safe choice...
if (preg_match('/phpinfo/', ini_get('disable_functions'))) {
if ($user_ver == 2) {
$gd_ver = 2;
return 2;
} else {
$gd_ver = 1;
return 1;
}
}
// ...otherwise use phpinfo().
ob_start();
phpinfo(8);
$info = stristr(ob_get_clean(), 'gd version');
if (preg_match('/\d/', $info, $match)) $gd_ver = $match[0];
return $match[0];
}