Context Navigation

source: trunk/lib/ImageThumb.inc.php @ 250

Last change on this file since 250 was 247, checked in by quinn, 17 years ago
Converted all string functions to multi-byte (mb_*) functions
File size: 34.7 KB

Rev	Line
[1]	1	<?php
	2	/**
[42]	3	* ImageThumb.inc.php
[136]	4	* code by strangecode :: www.strangecode.com :: this document contains copyrighted information
[1]	5	*
	6	* @author Quinn Comendant <quinn@strangecode.com>
[119]	7	* @requires Netpbm <http://sourceforge.net/projects/netpbm/> and libjpeg or GD.
	8	* @version 2.0
[1]	9	*/
	10
[152]	11	// Image proprtion options.
[1]	12	define('IMAGETHUMB_FIT_WIDTH', 1);
	13	define('IMAGETHUMB_FIT_HEIGHT', 2);
	14	define('IMAGETHUMB_FIT_LARGER', 3);
	15	define('IMAGETHUMB_STRETCH', 4);
	16	define('IMAGETHUMB_NO_SCALE', 5);
[152]	17
	18	// Image resize options.
[119]	19	define('IMAGETHUMB_METHOD_NETPBM', 6);
	20	define('IMAGETHUMB_METHOD_GD', 7);
[1]	21
	22	class ImageThumb {
[119]	23
	24	// General object parameters.
	25	var $_params = array(
	26	// The location for images to create thumbnails from.
	27	'source_dir' => null,
[42]	28
[119]	29	// Existing files will be overwritten when there is a name conflict?
	30	'allow_overwriting' => false,
[42]	31
[119]	32	// The file permissions of the uploaded files. Remember, files will be owned by the web server user.
	33	'dest_file_perms' => 0600,
[42]	34
[119]	35	// Permissions of autocreated directories. Must be at least 0700 with owner=apache.
[152]	36	'dest_dir_perms' => 0700,
[42]	37
[199]	38	// Require file to have one of the following file name extensions.
[119]	39	'valid_file_extensions' => array('jpg', 'jpeg', 'gif', 'png'),
	40
	41	// Method to use for resizing. (IMAGETHUMB_METHOD_NETPBM or IMAGETHUMB_METHOD_GD)
	42	'resize_method' => IMAGETHUMB_METHOD_NETPBM,
[1]	43
[119]	44	// Netpbm and libjpeg binary locations.
	45	'anytopnm_binary' => '/usr/bin/anytopnm',
	46	'pnmscale_binary' => '/usr/bin/pnmscale',
	47	'cjpeg_binary' => '/usr/bin/cjpeg',
[42]	48
[119]	49	// Which messages do we pass to raiseMsg? Use one of the MSG_* constants or false to disable.
	50	'display_messages' => MSG_ALL,
	51	);
	52
	53	// Default image size specs.
[152]	54	var $_default_image_specs = array(
	55	// The destination for an image thumbnail size.
	56	// Use initial / to specify absolute paths, leave off to specify a path relative to source_dir (eg: ../thumbs).
[119]	57	'dest_dir' => null,
[120]	58
	59	// Destination file types. (IMG_JPG, IMG_PNG, IMG_GIF, IMG_WBMP)
	60	'dest_file_type' => IMG_JPG,
	61
	62	// Destination file types. ('jpg', 'png', 'gif', 'wbmp')
[199]	63	'dest_file_extension' => 'jpg',
[120]	64
[119]	65	// Type of scaling to perform, and sizes used to calculate max dimentions.
	66	'scaling_type' => IMAGETHUMB_FIT_LARGER,
	67	'width' => null,
	68	'height' => null,
[120]	69
[119]	70	// Percentage quality of image compression output 0-100.
	71	'quality' => 65,
[120]	72
[119]	73	// Create progressive jpegs?
	74	'progressive' => false,
[120]	75
	76	// If using GD method, apply sharpen filter. Requires PHP > 5.1.
	77	'sharpen' => true,
	78
	79	// Integers between 1-100, useful values are 65-85.
	80	'sharpen_value' => 75,
	81
[119]	82	// If source image is smaller than thumbnail, allow upscaling?
	83	'allow_upscaling' => false,
[120]	84
[119]	85	// If thumb exists and filesize is smaller than this, do not overwrite the thumb.
	86	'keep_filesize' => null,
	87	);
[1]	88
[119]	89	// Final specifications for image sizes, set with setSpec().
[152]	90	var $_image_specs = array();
[119]	91
[1]	92	/**
[119]	93	* Set (or overwrite existing) parameters by passing an array of new parameters.
[1]	94	*
[119]	95	* @access public
	96	* @param array $params Array of parameters (key => val pairs).
[1]	97	*/
[119]	98	function setParam($params)
[1]	99	{
[136]	100	$app =& App::getInstance();
	101
[119]	102	if (isset($params) && is_array($params)) {
	103
[152]	104	// Enforce valid source_dir parameter.
[119]	105	if (isset($params['source_dir'])) {
	106	$params['source_dir'] = realpath($params['source_dir']);
[152]	107	// Source must be directory.
[119]	108	if (!is_dir($params['source_dir'])) {
[152]	109	$app->logMsg(sprintf('Attempting to auto-create source directory: %s', $params['source_dir']), LOG_NOTICE, __FILE__, __LINE__);
	110	if (phpversion() > '5') {
	111	// Recursive.
	112	mkdir($params['source_dir'], isset($params['dest_dir_perms']) ? $params['dest_dir_perms'] : $this->getParam('dest_dir_perms'), true);
	113	} else {
	114	mkdir($params['source_dir'], isset($params['dest_dir_perms']) ? $params['dest_dir_perms'] : $this->getParam('dest_dir_perms'));
	115	}
	116	if (!is_dir($params['source_dir'])) {
	117	$app->logMsg(sprintf('Source directory invalid: %s', $params['source_dir']), LOG_ERR, __FILE__, __LINE__);
	118	trigger_error(sprintf('Source directory invalid: %s', $params['source_dir']), E_USER_ERROR);
	119	}
[119]	120	}
[152]	121	// Source must be readable.
[119]	122	if (!is_readable($params['source_dir'])) {
[136]	123	$app->logMsg(sprintf('Source directory not readable: %s', $params['source_dir']), LOG_ERR, __FILE__, __LINE__);
[119]	124	trigger_error(sprintf('Source directory not readable: %s', $params['source_dir']), E_USER_ERROR);
	125	}
	126	}
	127
	128	// Merge new parameters with old overriding only those passed.
	129	$this->_params = array_merge($this->_params, $params);
	130	} else {
[136]	131	$app->logMsg(sprintf('Parameters are not an array: %s', $params), LOG_ERR, __FILE__, __LINE__);
[1]	132	}
	133	}
	134
	135	/**
[119]	136	* Return the value of a parameter, if it exists.
[1]	137	*
[119]	138	* @access public
	139	* @param string $param Which parameter to return.
	140	* @return mixed Configured parameter value.
[1]	141	*/
[119]	142	function getParam($param)
[1]	143	{
[136]	144	$app =& App::getInstance();
	145
[119]	146	if (isset($this->_params[$param])) {
	147	return $this->_params[$param];
	148	} else {
[146]	149	$app->logMsg(sprintf('Parameter is not set: %s', $param), LOG_DEBUG, __FILE__, __LINE__);
[119]	150	return null;
[1]	151	}
	152	}
	153
	154	/**
	155	* Set the specification of thumbnails.
	156	*
	157	* @access public
[235]	158	* @param array $spec The specifications for a size of output image.
	159	* @param int $index The position of the specification in the spec array
	160	* Use to overwrite existing spev array values.
[1]	161	*/
[120]	162	function setSpec($spec, $index=null)
[1]	163	{
[136]	164	$app =& App::getInstance();
	165
[119]	166	// A little sanity checking.
[152]	167	if (!isset($spec['dest_dir']) \|\| '' == trim($spec['dest_dir'])) {
[136]	168	$app->logMsg('setSpec error: dest_dir not specified.', LOG_ERR, __FILE__, __LINE__);
[152]	169	} else {
	170	$spec['dest_dir'] = trim($spec['dest_dir']);
[1]	171	}
[120]	172	if (isset($spec['dest_file_type'])) {
	173	switch ($spec['dest_file_type']) {
	174	case IMG_JPG :
	175	if (imagetypes() & IMG_JPG == 0) {
[136]	176	$app->logMsg(sprintf('IMG_JPG is not supported by this version of PHP GD.', null), LOG_ERR, __FILE__, __LINE__);
[120]	177	}
[199]	178	$spec['dest_file_extension'] = 'jpg';
[120]	179	break;
	180	case IMG_PNG :
	181	if (imagetypes() & IMG_PNG == 0) {
[136]	182	$app->logMsg(sprintf('IMG_PNG is not supported by this version of PHP GD.', null), LOG_ERR, __FILE__, __LINE__);
[120]	183	}
[199]	184	$spec['dest_file_extension'] = 'png';
[120]	185	break;
	186	case IMG_GIF :
	187	if (imagetypes() & IMG_GIF == 0) {
[136]	188	$app->logMsg(sprintf('IMG_GIF is not supported by this version of PHP GD.', null), LOG_ERR, __FILE__, __LINE__);
[120]	189	}
[199]	190	$spec['dest_file_extension'] = 'gif';
[120]	191	break;
	192	case IMG_WBMP :
	193	if (imagetypes() & IMG_WBMP == 0) {
[136]	194	$app->logMsg(sprintf('IMG_WBMP is not supported by this version of PHP GD.', null), LOG_ERR, __FILE__, __LINE__);
[120]	195	}
[199]	196	$spec['dest_file_extension'] = 'wbmp';
[120]	197	break;
	198	default :
[136]	199	$app->logMsg(sprintf('Invalid dest_file_type: %s', $spec['dest_file_type']), LOG_ERR, __FILE__, __LINE__);
[120]	200	break;
	201	}
	202	}
[119]	203	if (!isset($spec['width']) \|\| !is_int($spec['width'])) {
[136]	204	$app->logMsg('setSpec error: width not specified.', LOG_ERR, __FILE__, __LINE__);
[119]	205	}
	206	if (!isset($spec['height']) \|\| !is_int($spec['height'])) {
[136]	207	$app->logMsg('setSpec error: height not specified.', LOG_ERR, __FILE__, __LINE__);
[119]	208	}
[120]	209	if (isset($spec['quality']) && IMG_JPG != $spec['dest_file_type']) {
[136]	210	$app->logMsg('The "quality" specification is not used unless IMG_JPG is the dest_file_type.', LOG_INFO, __FILE__, __LINE__);
[119]	211	}
[120]	212	if (isset($spec['progressive']) && IMG_JPG != $spec['dest_file_type']) {
[136]	213	$app->logMsg('The "progressive" specification is not used unless IMG_JPG is the dest_file_type.', LOG_INFO, __FILE__, __LINE__);
[119]	214	}
[120]	215
[152]	216	// Add to _image_specs array.
	217	if (isset($index) && isset($this->_image_specs[$index])) {
	218	// Merge with existing spec if index is provided.
	219	$final_spec = array_merge($this->_image_specs[$index], $spec);
	220	$this->_image_specs[$index] = $final_spec;
[120]	221	} else {
[152]	222	// Merge with spec defaults.
	223	$final_spec = array_merge($this->_default_image_specs, $spec);
	224	$this->_image_specs[] = $final_spec;
[120]	225	}
[121]	226
	227	return $final_spec;
[1]	228	}
	229
	230	/**
[119]	231	* Process an entire directory of images.
[1]	232	*
	233	* @access public
	234	* @return bool true on success, false on failure.
	235	*/
[121]	236	function processAll($runtime_specs=null)
[1]	237	{
[136]	238	$app =& App::getInstance();
	239
[1]	240	// Ensure we have a source.
[119]	241	if ('' == $this->getParam('source_dir')) {
[136]	242	$app->logMsg(sprintf('Source directory not set before processing.'), LOG_ERR, __FILE__, __LINE__);
[1]	243	return false;
	244	}
[119]	245
	246	// Get all files in source directory.
	247	$dir_handle = opendir($this->getParam('source_dir'));
	248	while ($dir_handle && ($file = readdir($dir_handle)) !== false) {
	249	// If the file name does not start with a dot (. or .. or .htaccess).
[247]	250	if (!preg_match('/^\./', $file) && in_array(mb_strtolower(mb_substr($file, mb_strrpos($file, '.') + 1)), $this->getParam('valid_file_extensions'))) {
[119]	251	$files[] = $file;
[1]	252	}
	253	}
[42]	254
[119]	255	// Process each found file.
	256	if (is_array($files) && !empty($files)) {
	257	$return_val = 0;
	258	foreach ($files as $file_name) {
[121]	259	$return_val += $this->processFile($file_name, $runtime_specs);
[119]	260	}
[120]	261	$this->_raiseMsg(sprintf(_("Resized %s images."), sizeof($files)), MSG_SUCCESS, __FILE__, __LINE__);
[119]	262	return 0 === $return_val;
	263	} else {
[152]	264	$app->logMsg(sprintf('No source images found in directory: %s', $this->getParam('source_dir')), LOG_NOTICE, __FILE__, __LINE__);
[119]	265	return false;
	266	}
[1]	267	}
	268
	269	/**
	270	* Generate thumbnails for the specified file.
	271	*
	272	* @access public
[199]	273	* @param string $file_name Name of file with extension.
[121]	274	* @param array $runtime_specs Array of specifications that will override all configured specifications.
[1]	275	* @return bool true on success, false on failure.
	276	*/
[121]	277	function processFile($file_name, $runtime_specs=null)
[1]	278	{
[136]	279	$app =& App::getInstance();
	280
[119]	281	// Source file determinted by provided file_name.
	282	$source_file = realpath(sprintf('%s/%s', $this->getParam('source_dir'), $file_name));
	283
	284	// Ensure we have a source.
[152]	285	if (sizeof($this->_image_specs) < 1) {
[121]	286	if (is_array($runtime_specs)) {
	287	$this->setSpec($runtime_specs, 0);
	288	} else {
[136]	289	$app->logMsg(sprintf('Image specifications not set before processing.'), LOG_ERR, __FILE__, __LINE__);
[121]	290	return false;
	291	}
[1]	292	}
[42]	293
[1]	294	// Ensure we have a source.
[119]	295	if ('' == $this->getParam('source_dir')) {
[136]	296	$app->logMsg(sprintf('Source directory not set before processing.'), LOG_ERR, __FILE__, __LINE__);
[1]	297	return false;
	298	}
[42]	299
[1]	300	// Confirm source image exists.
[119]	301	if (!file_exists($source_file)) {
[199]	302	$this->_raiseMsg(sprintf(_("Image resizing failed: source image <em>%s</em> was not found."), $file_name), MSG_ERR, __FILE__, __LINE__);
[152]	303	$app->logMsg(sprintf('Source image not found: %s', $source_file), LOG_WARNING, __FILE__, __LINE__);
[1]	304	return false;
	305	}
[42]	306
[1]	307	// Confirm source image is readable.
[119]	308	if (!is_readable($source_file)) {
[199]	309	$this->_raiseMsg(sprintf(_("Image resizing failed: source image <em>%s</em> is not readable."), $file_name), MSG_ERR, __FILE__, __LINE__);
[152]	310	$app->logMsg(sprintf('Source image not readable: %s', $source_file), LOG_WARNING, __FILE__, __LINE__);
[1]	311	return false;
	312	}
[42]	313
[1]	314	// Confirm source image contains data.
[119]	315	if (filesize($source_file) <= 0) {
[199]	316	$this->_raiseMsg(sprintf(_("Image resizing failed: source image <em>%s</em> is zero bytes."), $file_name), MSG_ERR, __FILE__, __LINE__);
[152]	317	$app->logMsg(sprintf('Source image is zero bytes: %s', $source_file), LOG_WARNING, __FILE__, __LINE__);
[1]	318	return false;
	319	}
[42]	320
[1]	321	// Confirm source image has a valid file extension.
[119]	322	if (!$this->_validFileExtension($file_name)) {
[199]	323	$this->_raiseMsg(sprintf(_("Image resizing failed: source image <em>%s</em> not a valid type. It must have one of the following file name extensions: %s"), $file_name, join(', ', $this->getParam('valid_file_extensions'))), MSG_ERR, __FILE__, __LINE__);
[154]	324	$app->logMsg(sprintf('Image resizing failed: source image not of valid type: %s', $source_file), LOG_WARNING, __FILE__, __LINE__);
[1]	325	return false;
	326	}
[42]	327
[119]	328	// Ensure destination directories are created. This will only be called once per page load.
[152]	329	if (!$this->_createDestDirs()) {
	330	return false;
	331	}
[119]	332
	333	// To keep this script running even if user tries to stop browser.
	334	ignore_user_abort(true);
[121]	335	ini_set('max_execution_time', 300);
	336	ini_set('max_input_time', 300);
[1]	337
	338	// This remains zero until something goes wrong.
[119]	339	$return_val = 0;
[42]	340
[152]	341	foreach ($this->_image_specs as $index => $spec) {
[119]	342
[121]	343	if (is_array($runtime_specs)) {
	344	// Override with runtime specs.
	345	$spec = $this->setSpec($runtime_specs, $index);
	346	}
	347
[199]	348	// Destination filename uses the extension defined by dest_file_extension.
[152]	349	if ('/' == $spec['dest_dir']{0}) {
	350	// Absolute path.
[247]	351	$dest_file = sprintf('%s/%s.%s', $spec['dest_dir'], mb_substr($file_name, 0, mb_strrpos($file_name, '.')), $spec['dest_file_extension']);
[152]	352	} else {
	353	// Relative path.
[247]	354	$dest_file = sprintf('%s/%s/%s.%s', $this->getParam('source_dir'), $spec['dest_dir'], mb_substr($file_name, 0, mb_strrpos($file_name, '.')), $spec['dest_file_extension']);
[152]	355	}
	356
	357	// Ensure destination directory exists and is writable.
	358	if (!is_dir(dirname($dest_file)) \|\| !is_writable(dirname($dest_file))) {
	359	$this->_createDestDirs($dest_file);
	360	if (!is_dir(dirname($dest_file)) \|\| !is_writable(dirname($dest_file))) {
	361	$app->logMsg(sprintf('Image resizing failed, dest_dir invalid: %s', dirname($dest_file)), LOG_ERR, __FILE__, __LINE__);
	362	$return_val++;
	363	continue;
	364	}
	365	}
[42]	366
[119]	367	// Skip existing thumbnails with file size below $spec['keep_filesize'].
	368	if (isset($spec['keep_filesize']) && file_exists($dest_file)) {
	369	$file_size = filesize($dest_file);
	370	if (false !== $file_size && $file_size < $spec['keep_filesize']) {
[201]	371	$app->logMsg(sprintf('Skipping thumbnail %s. File already exists and file size is less than %s bytes.', $spec['dest_dir'] . '/' . $file_name, $spec['keep_filesize']), LOG_INFO, __FILE__, __LINE__);
[1]	372	continue;
	373	}
	374	}
[42]	375
[119]	376	// Determine if original file size is smaller than specified thumbnail size. Do not scale-up if $spec['allow_upscaling'] config is set to false.
	377	$image_size = getimagesize($source_file);
	378	if ($image_size['0'] <= $spec['width'] && $image_size['1'] <= $spec['height'] && !$spec['allow_upscaling']) {
	379	$spec['scaling_type'] = IMAGETHUMB_NO_SCALE;
[201]	380	$app->logMsg(sprintf('Image %s smaller than specified %s thumbnail size. Keeping original size.', $file_name, basename($spec['dest_dir'])), LOG_INFO, __FILE__, __LINE__);
[1]	381	}
[42]	382
[119]	383	// DO IT! Based on available method.
	384	if (IMAGETHUMB_METHOD_NETPBM === $this->getParam('resize_method') && file_exists($this->getParam('anytopnm_binary')) && file_exists($this->getParam('pnmscale_binary')) && file_exists($this->getParam('cjpeg_binary'))) {
	385	// Resize using Netpbm binaries.
[201]	386	$app->logMsg(sprintf('Resizing with Netpbm: %s', $source_file), LOG_DEBUG, __FILE__, __LINE__);
[119]	387	$return_val += $this->_resizeWithNetpbm($source_file, $dest_file, $spec);
	388	} else if (IMAGETHUMB_METHOD_GD === $this->getParam('resize_method') && extension_loaded('gd')) {
	389	// Resize with GD.
[201]	390	$app->logMsg(sprintf('Resizing with GD: %s', $source_file), LOG_DEBUG, __FILE__, __LINE__);
[119]	391	$return_val += $this->_resizeWithGD($source_file, $dest_file, $spec);
[1]	392	} else {
[152]	393	$app->logMsg(sprintf('Image thumbnailing canceled. Neither Netpbm or GD is available.', null), LOG_ERR, __FILE__, __LINE__);
[119]	394	return false;
[1]	395	}
[119]	396	}
[42]	397
[152]	398	// If > 0, there was a problem thumbnailing.
[119]	399	return 0 === $return_val;
	400	}
	401
	402	/*
	403	* Use the Netpbm and libjpg cjpeg tools to generate a rescaled compressed image.
	404	* This is the preferred method over GD which has (supposedly) less quality.
	405	*
	406	* @access private
	407	* @param string $source_file Full path to source image file.
	408	* @param string $dest_file Full path to destination image file.
	409	* @param array $spec Array of image size specifications.
[120]	410	* @return int 0 if no error, n > 0 if errors.
[119]	411	* @author Quinn Comendant <quinn@strangecode.com>
	412	* @version 1.0
	413	* @since 19 May 2006 13:55:46
	414	*/
	415	function _resizeWithNetpbm($source_file, $dest_file, $spec)
	416	{
[136]	417	$app =& App::getInstance();
	418
[119]	419	// Define pnmscale arguments.
	420	switch ($spec['scaling_type']) {
	421	case IMAGETHUMB_FIT_WIDTH :
	422	$pnmscale_args = sprintf(' -width %s ', escapeshellarg($spec['width']));
	423	break;
	424	case IMAGETHUMB_FIT_HEIGHT :
	425	$pnmscale_args = sprintf(' -height %s ', escapeshellarg($spec['height']));
	426	break;
	427	case IMAGETHUMB_FIT_LARGER :
	428	$pnmscale_args = sprintf(' -xysize %s %s ', escapeshellarg($spec['width']), escapeshellarg($spec['height']));
	429	break;
	430	case IMAGETHUMB_STRETCH :
	431	$pnmscale_args = sprintf(' -width %s -height %s ', escapeshellarg($spec['width']), escapeshellarg($spec['height']));
	432	break;
	433	case IMAGETHUMB_NO_SCALE :
	434	default :
	435	$pnmscale_args = ' 1 ';
	436	break;
[1]	437	}
[42]	438
[119]	439	// Define cjpeg arguments.
	440	$cjpeg_args = sprintf(' -optimize -quality %s ', escapeshellarg($spec['quality']));
	441	$cjpeg_args .= (true === $spec['progressive']) ? ' -progressive ' : '';
	442
	443	// Format the command that creates the thumbnail.
[199]	444	$command = sprintf('%s %s \| %s %s \| %s %s > %s',
[119]	445	escapeshellcmd($this->getParam('anytopnm_binary')),
	446	escapeshellcmd($source_file),
	447	escapeshellcmd($this->getParam('pnmscale_binary')),
	448	escapeshellcmd($pnmscale_args),
	449	escapeshellcmd($this->getParam('cjpeg_binary')),
	450	escapeshellcmd($cjpeg_args),
[199]	451	escapeshellcmd($dest_file)
[119]	452	);
[136]	453	$app->logMsg(sprintf('ImageThumb Netpbm command: %s', $command), LOG_DEBUG, __FILE__, __LINE__);
[119]	454
	455	// Execute!
	456	exec($command, $output, $return_val);
	457
	458	if (0 === $return_val) {
	459	// Success!
	460	// Make the thumbnail writable so the user can delete it over ftp without being 'apache'.
	461	chmod($dest_file, $this->getParam('dest_file_perms'));
[136]	462	$app->logMsg(sprintf('Successfully resized image %s', $spec['dest_dir'] . '/' . basename($dest_file), $return_val), LOG_DEBUG, __FILE__, __LINE__);
[119]	463	} else {
	464	// An error occurred.
[136]	465	$app->logMsg(sprintf('Image %s failed resizing with return value: %s%s', $spec['dest_dir'] . '/' . basename($dest_file), $return_val, empty($output) ? '' : ' (' . getDump($output) . ')'), LOG_ERR, __FILE__, __LINE__);
[119]	466	}
	467
	468	// Return from the command will be > 0 if there was an error.
	469	return $return_val;
[1]	470	}
	471
[119]	472	/*
	473	* Use PHP's built-in GD tools to generate a rescaled compressed image.
	474	*
	475	* @access private
	476	* @param string $source_file Full path to source image file.
	477	* @param string $dest_file Full path to destination image file.
	478	* @param array $spec Array of image size specifications.
[120]	479	* @return int 0 if no error, n > 0 if errors.
[119]	480	* @author Quinn Comendant <quinn@strangecode.com>
	481	* @version 1.0
	482	* @since 19 May 2006 15:46:02
	483	*/
	484	function _resizeWithGD($source_file, $dest_file, $spec)
[1]	485	{
[136]	486	$app =& App::getInstance();
	487
[119]	488	// Get original file dimensions and type.
	489	list($source_image_width, $source_image_height, $source_image_type) = getimagesize($source_file);
	490
	491	// Define destination image dimentions.
	492	switch ($spec['scaling_type']) {
	493	case IMAGETHUMB_FIT_WIDTH :
[120]	494	$dest_image_width = $spec['width'];
[119]	495	$dest_image_height = $source_image_height * ($spec['width'] / $source_image_width);
	496	break;
	497	case IMAGETHUMB_FIT_HEIGHT :
[120]	498	$dest_image_height = $spec['height'];
[119]	499	$dest_image_width = $source_image_width * ($spec['height'] / $source_image_height);
	500	break;
	501	case IMAGETHUMB_FIT_LARGER :
[120]	502	if (($source_image_width * ($spec['height'] / $source_image_height)) <= $spec['width']) {
	503	// Height is larger.
	504	$dest_image_height = $spec['height'];
	505	$dest_image_width = $source_image_width * ($spec['height'] / $source_image_height);
[119]	506	} else {
[120]	507	// Width is larger.
	508	$dest_image_width = $spec['width'];
	509	$dest_image_height = $source_image_height * ($spec['width'] / $source_image_width);
[119]	510	}
	511	break;
	512	case IMAGETHUMB_STRETCH :
	513	$dest_image_width = $spec['width'];
	514	$dest_image_height = $spec['height'];
	515	break;
	516	case IMAGETHUMB_NO_SCALE :
	517	default :
	518	$dest_image_width = $source_image_width;
	519	$dest_image_height = $source_image_height;
	520	break;
	521	}
	522
	523	// Create source image data in memory.
	524	switch ($source_image_type) {
[224]	525	case IMAGETYPE_JPEG : // = 2
[120]	526	$source_image_resource = imagecreatefromjpeg($source_file);
[119]	527	break;
[224]	528	case IMAGETYPE_PNG : // = 3
[120]	529	$source_image_resource = imagecreatefrompng($source_file);
[119]	530	break;
[224]	531	case IMAGETYPE_GIF : // = 1
[120]	532	$source_image_resource = imagecreatefromgif($source_file);
[119]	533	break;
[224]	534	case IMAGETYPE_WBMP : // = 15
[120]	535	$source_image_resource = imagecreatefromwbmp($source_file);
[224]	536	case IMAGETYPE_SWF : // = 4
	537	case IMAGETYPE_PSD : // = 5
	538	case IMAGETYPE_BMP : // = 6
	539	case IMAGETYPE_TIFF_II : // = 7
	540	case IMAGETYPE_TIFF_MM : // = 8
	541	case IMAGETYPE_JPC : // = 9
	542	case IMAGETYPE_JP2 : // = 10
	543	case IMAGETYPE_JPX : // = 11
	544	case IMAGETYPE_JB2 : // = 12
	545	case IMAGETYPE_SWC : // = 13
	546	case IMAGETYPE_IFF : // = 14
	547	case IMAGETYPE_XBM : // = 16
[119]	548	default :
[136]	549	$app->logMsg(sprintf('Source image type %s not supported.', $source_image_type), LOG_WARNING, __FILE__, __LINE__);
[120]	550	return 1;
[119]	551	break;
[1]	552	}
[120]	553	if (!$source_image_resource) {
[136]	554	$app->logMsg(sprintf('Error creating %s image in memory from %s', $source_image_type, $source_file), LOG_WARNING, __FILE__, __LINE__);
[120]	555	return 1;
[119]	556	}
	557
	558	// Create destination image data in memory.
[120]	559	$dest_image_resource = imagecreatetruecolor($dest_image_width, $dest_image_height);
[42]	560
[119]	561	// Resample!
[120]	562	if (!imagecopyresampled($dest_image_resource, $source_image_resource, 0, 0, 0, 0, $dest_image_width, $dest_image_height, $source_image_width, $source_image_height)) {
[136]	563	$app->logMsg(sprintf('Error resampling image %s', $source_file), LOG_WARNING, __FILE__, __LINE__);
[152]	564	// Always cleanup images from memory.
	565	imagedestroy($source_image_resource);
	566	imagedestroy($dest_image_resource);
[120]	567	return 1;
[1]	568	}
[120]	569
	570	// Sharpen image using a custom filter matrix.
	571	if (phpversion() > '5.1' && true === $spec['sharpen'] && $spec['sharpen_value'] > 0) {
	572	$sharpen_value = round((((48 - 10) / (100 - 1)) * (100 - $spec['sharpen_value'])) + 10);
	573	imageconvolution($dest_image_resource, array(array(-1,-1,-1),array(-1,$sharpen_value,-1),array(-1,-1,-1)), ($sharpen_value - 8), 0);
	574	}
[42]	575
[119]	576	// Save image.
	577	$return_val = true;
[120]	578	switch ($spec['dest_file_type']) {
[119]	579	case IMG_JPG :
[120]	580	imageinterlace($dest_image_resource, (true == $spec['progressive'] ? 1 : 0));
	581	$return_val = imagejpeg($dest_image_resource, $dest_file, $spec['quality']);
[119]	582	break;
	583	case IMG_PNG :
[120]	584	$return_val = imagepng($dest_image_resource, $dest_file);
[119]	585	break;
	586	case IMG_GIF :
[120]	587	$return_val = imagegif($dest_image_resource, $dest_file);
[119]	588	break;
	589	case IMG_WBMP :
[120]	590	$return_val = imagewbmp($dest_image_resource, $dest_file);
[119]	591	break;
	592	default :
[136]	593	$app->logMsg(sprintf('Destination image type %s not supported for image %s.', $spec['dest_file_type'], $dest_file), LOG_WARNING, __FILE__, __LINE__);
[152]	594	// Always cleanup images from memory.
	595	imagedestroy($source_image_resource);
	596	imagedestroy($dest_image_resource);
[120]	597	return 1;
[119]	598	break;
	599	}
	600
[152]	601	// Always cleanup images from memory.
	602	imagedestroy($source_image_resource);
	603	imagedestroy($dest_image_resource);
	604
[119]	605	if ($return_val) {
	606	// Success!
	607	// Make the thumbnail writable so the user can delete it over ftp without being 'apache'.
[152]	608	if (!chmod($dest_file, $this->getParam('dest_file_perms'))) {
	609	$app->logMsg(sprintf('chmod failed on file: %s', $dest_file), LOG_ERR, __FILE__, __LINE__);
	610	}
	611	$app->logMsg(sprintf('Successfully resized image: %s', $dest_file), LOG_DEBUG, __FILE__, __LINE__);
[120]	612	return 0;
[1]	613	} else {
[119]	614	// An error occurred.
[152]	615	$app->logMsg(sprintf('Failed resizing image: %s', $dest_file), LOG_ERR, __FILE__, __LINE__);
[120]	616	return 1;
[1]	617	}
	618	}
	619
	620	/**
	621	* Delete the thumbnails for the specified file name.
	622	*
	623	* @access public
[199]	624	* @param string $file_name The file name to delete, with extension.
[1]	625	* @return bool true on success, false on failure.
	626	*/
	627	function deleteThumbs($file_name)
	628	{
[136]	629	$app =& App::getInstance();
	630
[1]	631	// Ensure we have a source.
[119]	632	if ('' == $this->getParam('source_dir')) {
[136]	633	$app->logMsg(sprintf('Source directory not set before processing.'), LOG_ERR, __FILE__, __LINE__);
[1]	634	return false;
	635	}
[42]	636
[119]	637	$return_val = 0;
[152]	638	foreach ($this->_image_specs as $spec) {
	639	if ('/' == $spec['dest_dir']{0}) {
	640	// Absolute path.
[247]	641	$dest_file = realpath(sprintf('%s/%s.%s', $spec['dest_dir'], mb_substr($file_name, 0, mb_strrpos($file_name, '.')), $spec['dest_file_extension']));
[152]	642	} else {
	643	// Relative path.
[247]	644	$dest_file = realpath(sprintf('%s/%s/%s.%s', $this->getParam('source_dir'), $spec['dest_dir'], mb_substr($file_name, 0, mb_strrpos($file_name, '.')), $spec['dest_file_extension']));
[152]	645	}
[119]	646	if (file_exists($dest_file)) {
	647	if (!unlink($dest_file)) {
	648	$return_val++;
[141]	649	$app->logMsg(sprintf('Delete thumbs failed: %s', $dest_file), LOG_WARNING, __FILE__, __LINE__);
[1]	650	}
	651	}
	652	}
[204]	653	$app->logMsg(sprintf('Thumbnails deleted for file: %s', $file_name), LOG_INFO, __FILE__, __LINE__);
[119]	654	return 0 === $return_val;
[1]	655	}
	656
	657	/**
	658	* Delete the source image with the specified file name.
	659	*
	660	* @access public
[199]	661	* @param string $file_name The file name to delete, with extension.
[1]	662	* @return bool true on success, false on failure.
	663	*/
	664	function deleteOriginal($file_name)
	665	{
[136]	666	$app =& App::getInstance();
	667
[1]	668	// Ensure we have a source.
[119]	669	if ('' == $this->getParam('source_dir')) {
[136]	670	$app->logMsg(sprintf('Source directory not set before processing.'), LOG_ERR, __FILE__, __LINE__);
[1]	671	return false;
	672	}
[42]	673
[201]	674	// Ensure we have a source.
	675	if ('' == $file_name) {
	676	$app->logMsg(sprintf('Cannot delete, filename empty.'), LOG_WARNING, __FILE__, __LINE__);
	677	return false;
	678	}
	679
[119]	680	$source_file = realpath(sprintf('%s/%s', $this->getParam('source_dir'), $file_name));
[201]	681	if (is_file($source_file) && unlink($source_file)) {
	682	$app->logMsg(sprintf('Original file successfully deleted: %s', $file_name), LOG_INFO, __FILE__, __LINE__);
	683	return true;
	684	} else {
[141]	685	$app->logMsg(sprintf('Delete original failed: %s', $source_file), LOG_WARNING, __FILE__, __LINE__);
[1]	686	return false;
	687	}
	688	}
[42]	689
[1]	690	/**
	691	* Returns true if file exists.
	692	*
	693	* @access public
[199]	694	* @param string $file_name The file name to test, with extension.
[1]	695	* @return bool true on success, false on failure.
	696	*/
	697	function exists($file_name)
	698	{
[136]	699	$app =& App::getInstance();
	700
[1]	701	// Ensure we have a source.
[119]	702	if ('' == $this->getParam('source_dir')) {
[136]	703	$app->logMsg(sprintf('Source directory not set before processing.'), LOG_ERR, __FILE__, __LINE__);
[1]	704	return false;
	705	}
[42]	706
[119]	707	$source_file = realpath(sprintf('%s/%s', $this->getParam('source_dir'), $file_name));
	708	return file_exists($source_file);
[1]	709	}
[42]	710
[1]	711	/**
[199]	712	* Tests if extension of $file_name is in the array valid_file_extensions.
[1]	713	*
	714	* @access public
	715	* @param string $file_name A file name.
	716	* @return bool True on success, false on failure.
	717	*/
[119]	718	function _validFileExtension($file_name)
[1]	719	{
	720	preg_match('/.*?\.(\w+)$/i', $file_name, $ext);
[247]	721	return !empty($ext) && in_array(mb_strtolower($ext[1]), $this->getParam('valid_file_extensions'));
[1]	722	}
[42]	723
[1]	724	/**
[119]	725	* Make directory for each specified thumbnail size, if it doesn't exist.
[1]	726	*
[119]	727	* @access public
	728	* @return bool true on success, false on failure.
	729	*/
[152]	730	function _createDestDirs($filename=null)
[119]	731	{
[136]	732	$app =& App::getInstance();
	733
[152]	734	// Keep track of directories we've already created.
	735	$dd_hash = md5(isset($filename) ? dirname($filename) : 'none');
	736	static $already_checked = array();
[119]	737
[152]	738	$return_val = 0;
	739
	740	if (!isset($already_checked[$dd_hash])) {
[119]	741	// Ensure we have a source.
	742	if ('' == $this->getParam('source_dir')) {
[136]	743	$app->logMsg(sprintf('Source directory not set before creating destination directories.'), LOG_ERR, __FILE__, __LINE__);
[119]	744	return false;
	745	}
	746
	747	// Loop through specs and ensure all dirs are created.
[152]	748	foreach ($this->_image_specs as $spec) {
	749	if (isset($filename)) {
	750	$dest_dir = dirname($filename);
	751	} else {
	752	if ('/' == $spec['dest_dir']{0}) {
	753	// Absolute path.
	754	$dest_dir = $spec['dest_dir'];
	755	} else {
	756	// Relative path.
	757	$dest_dir = sprintf('%s/%s', $this->getParam('source_dir'), $spec['dest_dir']);
[119]	758	}
	759	}
[152]	760	if (!file_exists($dest_dir)) {
[154]	761	if (phpversion() > '5') {
[152]	762	// Recursive.
[154]	763	if (!file_exists($dest_dir) && !($ret = mkdir($dest_dir, $this->getParam('dest_dir_perms'), true))) {
[152]	764	$return_val++;
	765	$app->logMsg(sprintf('mkdir failure: %s', $dest_dir), LOG_ERR, __FILE__, __LINE__);
	766	}
	767	} else {
	768	// Recursive mkdir for php 4.
	769	$path = '';
	770	foreach (array_diff(explode('/', $dest_dir), array('')) as $dir) {
	771	$path .= '/' . $dir;
	772	if (! ($ret = file_exists($path) ? true : mkdir($path, $this->getParam('dest_dir_perms')))) {
	773	$return_val++;
	774	$app->logMsg(sprintf('mkdir failure: %s', $path), LOG_ERR, __FILE__, __LINE__);
	775	break;
	776	}
	777	}
	778	}
	779
	780	if ($ret) {
	781	$app->logMsg(sprintf('mkdir success: %s', $dest_dir), LOG_DEBUG, __FILE__, __LINE__);
	782	}
	783	}
[119]	784	}
	785	}
	786
[152]	787	$already_checked[$dd_hash] = true;
	788
	789	// If > 0, there was a problem creating dest dirs.
	790	return 0 === $return_val;
[119]	791	}
	792
	793	/**
[136]	794	* An alias for $app->raiseMsg that only sends messages configured by display_messages.
[119]	795	*
[1]	796	* @access public
	797	*
	798	* @param string $message The text description of the message.
	799	* @param int $type The type of message: MSG_NOTICE,
	800	* MSG_SUCCESS, MSG_WARNING, or MSG_ERR.
	801	* @param string $file __FILE__.
	802	* @param string $line __LINE__.
	803	*/
[119]	804	function _raiseMsg($message, $type, $file, $line)
[1]	805	{
[136]	806	$app =& App::getInstance();
	807
[119]	808	if ($this->getParam('display_messages') === true \|\| (is_int($this->getParam('display_messages')) && $this->getParam('display_messages') & $type > 0)) {
[136]	809	$app->raiseMsg($message, $type, $file, $line);
[1]	810	}
	811	}
	812
	813	} // End of class.
	814	?>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: