Context Navigation

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

Last change on this file since 204 was 204, checked in by scdev, 18 years ago
Q - added match_remote_ip_exempt_usernames functionality to 1.1dev/lib/AuthSQL.inc.php
File size: 34.0 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
[119]	158	* @param array $spec The specifications for a size of output image.
[1]	159	*/
[120]	160	function setSpec($spec, $index=null)
[1]	161	{
[136]	162	$app =& App::getInstance();
	163
[119]	164	// A little sanity checking.
[152]	165	if (!isset($spec['dest_dir']) \|\| '' == trim($spec['dest_dir'])) {
[136]	166	$app->logMsg('setSpec error: dest_dir not specified.', LOG_ERR, __FILE__, __LINE__);
[152]	167	} else {
	168	$spec['dest_dir'] = trim($spec['dest_dir']);
[1]	169	}
[120]	170	if (isset($spec['dest_file_type'])) {
	171	switch ($spec['dest_file_type']) {
	172	case IMG_JPG :
	173	if (imagetypes() & IMG_JPG == 0) {
[136]	174	$app->logMsg(sprintf('IMG_JPG is not supported by this version of PHP GD.', null), LOG_ERR, __FILE__, __LINE__);
[120]	175	}
[199]	176	$spec['dest_file_extension'] = 'jpg';
[120]	177	break;
	178	case IMG_PNG :
	179	if (imagetypes() & IMG_PNG == 0) {
[136]	180	$app->logMsg(sprintf('IMG_PNG is not supported by this version of PHP GD.', null), LOG_ERR, __FILE__, __LINE__);
[120]	181	}
[199]	182	$spec['dest_file_extension'] = 'png';
[120]	183	break;
	184	case IMG_GIF :
	185	if (imagetypes() & IMG_GIF == 0) {
[136]	186	$app->logMsg(sprintf('IMG_GIF is not supported by this version of PHP GD.', null), LOG_ERR, __FILE__, __LINE__);
[120]	187	}
[199]	188	$spec['dest_file_extension'] = 'gif';
[120]	189	break;
	190	case IMG_WBMP :
	191	if (imagetypes() & IMG_WBMP == 0) {
[136]	192	$app->logMsg(sprintf('IMG_WBMP is not supported by this version of PHP GD.', null), LOG_ERR, __FILE__, __LINE__);
[120]	193	}
[199]	194	$spec['dest_file_extension'] = 'wbmp';
[120]	195	break;
	196	default :
[136]	197	$app->logMsg(sprintf('Invalid dest_file_type: %s', $spec['dest_file_type']), LOG_ERR, __FILE__, __LINE__);
[120]	198	break;
	199	}
	200	}
[119]	201	if (!isset($spec['width']) \|\| !is_int($spec['width'])) {
[136]	202	$app->logMsg('setSpec error: width not specified.', LOG_ERR, __FILE__, __LINE__);
[119]	203	}
	204	if (!isset($spec['height']) \|\| !is_int($spec['height'])) {
[136]	205	$app->logMsg('setSpec error: height not specified.', LOG_ERR, __FILE__, __LINE__);
[119]	206	}
[120]	207	if (isset($spec['quality']) && IMG_JPG != $spec['dest_file_type']) {
[136]	208	$app->logMsg('The "quality" specification is not used unless IMG_JPG is the dest_file_type.', LOG_INFO, __FILE__, __LINE__);
[119]	209	}
[120]	210	if (isset($spec['progressive']) && IMG_JPG != $spec['dest_file_type']) {
[136]	211	$app->logMsg('The "progressive" specification is not used unless IMG_JPG is the dest_file_type.', LOG_INFO, __FILE__, __LINE__);
[119]	212	}
[120]	213
[152]	214	// Add to _image_specs array.
	215	if (isset($index) && isset($this->_image_specs[$index])) {
	216	// Merge with existing spec if index is provided.
	217	$final_spec = array_merge($this->_image_specs[$index], $spec);
	218	$this->_image_specs[$index] = $final_spec;
[120]	219	} else {
[152]	220	// Merge with spec defaults.
	221	$final_spec = array_merge($this->_default_image_specs, $spec);
	222	$this->_image_specs[] = $final_spec;
[120]	223	}
[121]	224
	225	return $final_spec;
[1]	226	}
	227
	228	/**
[119]	229	* Process an entire directory of images.
[1]	230	*
	231	* @access public
	232	* @return bool true on success, false on failure.
	233	*/
[121]	234	function processAll($runtime_specs=null)
[1]	235	{
[136]	236	$app =& App::getInstance();
	237
[1]	238	// Ensure we have a source.
[119]	239	if ('' == $this->getParam('source_dir')) {
[136]	240	$app->logMsg(sprintf('Source directory not set before processing.'), LOG_ERR, __FILE__, __LINE__);
[1]	241	return false;
	242	}
[119]	243
	244	// Get all files in source directory.
	245	$dir_handle = opendir($this->getParam('source_dir'));
	246	while ($dir_handle && ($file = readdir($dir_handle)) !== false) {
	247	// If the file name does not start with a dot (. or .. or .htaccess).
	248	if (!preg_match('/^\./', $file) && in_array(strtolower(substr($file, strrpos($file, '.') + 1)), $this->getParam('valid_file_extensions'))) {
	249	$files[] = $file;
[1]	250	}
	251	}
[42]	252
[119]	253	// Process each found file.
	254	if (is_array($files) && !empty($files)) {
	255	$return_val = 0;
	256	foreach ($files as $file_name) {
[121]	257	$return_val += $this->processFile($file_name, $runtime_specs);
[119]	258	}
[120]	259	$this->_raiseMsg(sprintf(_("Resized %s images."), sizeof($files)), MSG_SUCCESS, __FILE__, __LINE__);
[119]	260	return 0 === $return_val;
	261	} else {
[152]	262	$app->logMsg(sprintf('No source images found in directory: %s', $this->getParam('source_dir')), LOG_NOTICE, __FILE__, __LINE__);
[119]	263	return false;
	264	}
[1]	265	}
	266
	267	/**
	268	* Generate thumbnails for the specified file.
	269	*
	270	* @access public
[199]	271	* @param string $file_name Name of file with extension.
[121]	272	* @param array $runtime_specs Array of specifications that will override all configured specifications.
[1]	273	* @return bool true on success, false on failure.
	274	*/
[121]	275	function processFile($file_name, $runtime_specs=null)
[1]	276	{
[136]	277	$app =& App::getInstance();
	278
[119]	279	// Source file determinted by provided file_name.
	280	$source_file = realpath(sprintf('%s/%s', $this->getParam('source_dir'), $file_name));
	281
	282	// Ensure we have a source.
[152]	283	if (sizeof($this->_image_specs) < 1) {
[121]	284	if (is_array($runtime_specs)) {
	285	$this->setSpec($runtime_specs, 0);
	286	} else {
[136]	287	$app->logMsg(sprintf('Image specifications not set before processing.'), LOG_ERR, __FILE__, __LINE__);
[121]	288	return false;
	289	}
[1]	290	}
[42]	291
[1]	292	// Ensure we have a source.
[119]	293	if ('' == $this->getParam('source_dir')) {
[136]	294	$app->logMsg(sprintf('Source directory not set before processing.'), LOG_ERR, __FILE__, __LINE__);
[1]	295	return false;
	296	}
[42]	297
[1]	298	// Confirm source image exists.
[119]	299	if (!file_exists($source_file)) {
[199]	300	$this->_raiseMsg(sprintf(_("Image resizing failed: source image <em>%s</em> was not found."), $file_name), MSG_ERR, __FILE__, __LINE__);
[152]	301	$app->logMsg(sprintf('Source image not found: %s', $source_file), LOG_WARNING, __FILE__, __LINE__);
[1]	302	return false;
	303	}
[42]	304
[1]	305	// Confirm source image is readable.
[119]	306	if (!is_readable($source_file)) {
[199]	307	$this->_raiseMsg(sprintf(_("Image resizing failed: source image <em>%s</em> is not readable."), $file_name), MSG_ERR, __FILE__, __LINE__);
[152]	308	$app->logMsg(sprintf('Source image not readable: %s', $source_file), LOG_WARNING, __FILE__, __LINE__);
[1]	309	return false;
	310	}
[42]	311
[1]	312	// Confirm source image contains data.
[119]	313	if (filesize($source_file) <= 0) {
[199]	314	$this->_raiseMsg(sprintf(_("Image resizing failed: source image <em>%s</em> is zero bytes."), $file_name), MSG_ERR, __FILE__, __LINE__);
[152]	315	$app->logMsg(sprintf('Source image is zero bytes: %s', $source_file), LOG_WARNING, __FILE__, __LINE__);
[1]	316	return false;
	317	}
[42]	318
[1]	319	// Confirm source image has a valid file extension.
[119]	320	if (!$this->_validFileExtension($file_name)) {
[199]	321	$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]	322	$app->logMsg(sprintf('Image resizing failed: source image not of valid type: %s', $source_file), LOG_WARNING, __FILE__, __LINE__);
[1]	323	return false;
	324	}
[42]	325
[119]	326	// Ensure destination directories are created. This will only be called once per page load.
[152]	327	if (!$this->_createDestDirs()) {
	328	return false;
	329	}
[119]	330
	331	// To keep this script running even if user tries to stop browser.
	332	ignore_user_abort(true);
[121]	333	ini_set('max_execution_time', 300);
	334	ini_set('max_input_time', 300);
[1]	335
	336	// This remains zero until something goes wrong.
[119]	337	$return_val = 0;
[42]	338
[152]	339	foreach ($this->_image_specs as $index => $spec) {
[119]	340
[121]	341	if (is_array($runtime_specs)) {
	342	// Override with runtime specs.
	343	$spec = $this->setSpec($runtime_specs, $index);
	344	}
	345
[199]	346	// Destination filename uses the extension defined by dest_file_extension.
[152]	347	if ('/' == $spec['dest_dir']{0}) {
	348	// Absolute path.
[199]	349	$dest_file = sprintf('%s/%s.%s', $spec['dest_dir'], substr($file_name, 0, strrpos($file_name, '.')), $spec['dest_file_extension']);
[152]	350	} else {
	351	// Relative path.
[199]	352	$dest_file = sprintf('%s/%s/%s.%s', $this->getParam('source_dir'), $spec['dest_dir'], substr($file_name, 0, strrpos($file_name, '.')), $spec['dest_file_extension']);
[152]	353	}
	354
	355	// Ensure destination directory exists and is writable.
	356	if (!is_dir(dirname($dest_file)) \|\| !is_writable(dirname($dest_file))) {
	357	$this->_createDestDirs($dest_file);
	358	if (!is_dir(dirname($dest_file)) \|\| !is_writable(dirname($dest_file))) {
	359	$app->logMsg(sprintf('Image resizing failed, dest_dir invalid: %s', dirname($dest_file)), LOG_ERR, __FILE__, __LINE__);
	360	$return_val++;
	361	continue;
	362	}
	363	}
[42]	364
[119]	365	// Skip existing thumbnails with file size below $spec['keep_filesize'].
	366	if (isset($spec['keep_filesize']) && file_exists($dest_file)) {
	367	$file_size = filesize($dest_file);
	368	if (false !== $file_size && $file_size < $spec['keep_filesize']) {
[201]	369	$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]	370	continue;
	371	}
	372	}
[42]	373
[119]	374	// Determine if original file size is smaller than specified thumbnail size. Do not scale-up if $spec['allow_upscaling'] config is set to false.
	375	$image_size = getimagesize($source_file);
	376	if ($image_size['0'] <= $spec['width'] && $image_size['1'] <= $spec['height'] && !$spec['allow_upscaling']) {
	377	$spec['scaling_type'] = IMAGETHUMB_NO_SCALE;
[201]	378	$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]	379	}
[42]	380
[119]	381	// DO IT! Based on available method.
	382	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'))) {
	383	// Resize using Netpbm binaries.
[201]	384	$app->logMsg(sprintf('Resizing with Netpbm: %s', $source_file), LOG_DEBUG, __FILE__, __LINE__);
[119]	385	$return_val += $this->_resizeWithNetpbm($source_file, $dest_file, $spec);
	386	} else if (IMAGETHUMB_METHOD_GD === $this->getParam('resize_method') && extension_loaded('gd')) {
	387	// Resize with GD.
[201]	388	$app->logMsg(sprintf('Resizing with GD: %s', $source_file), LOG_DEBUG, __FILE__, __LINE__);
[119]	389	$return_val += $this->_resizeWithGD($source_file, $dest_file, $spec);
[1]	390	} else {
[152]	391	$app->logMsg(sprintf('Image thumbnailing canceled. Neither Netpbm or GD is available.', null), LOG_ERR, __FILE__, __LINE__);
[119]	392	return false;
[1]	393	}
[119]	394	}
[42]	395
[152]	396	// If > 0, there was a problem thumbnailing.
[119]	397	return 0 === $return_val;
	398	}
	399
	400	/*
	401	* Use the Netpbm and libjpg cjpeg tools to generate a rescaled compressed image.
	402	* This is the preferred method over GD which has (supposedly) less quality.
	403	*
	404	* @access private
	405	* @param string $source_file Full path to source image file.
	406	* @param string $dest_file Full path to destination image file.
	407	* @param array $spec Array of image size specifications.
[120]	408	* @return int 0 if no error, n > 0 if errors.
[119]	409	* @author Quinn Comendant <quinn@strangecode.com>
	410	* @version 1.0
	411	* @since 19 May 2006 13:55:46
	412	*/
	413	function _resizeWithNetpbm($source_file, $dest_file, $spec)
	414	{
[136]	415	$app =& App::getInstance();
	416
[119]	417	// Define pnmscale arguments.
	418	switch ($spec['scaling_type']) {
	419	case IMAGETHUMB_FIT_WIDTH :
	420	$pnmscale_args = sprintf(' -width %s ', escapeshellarg($spec['width']));
	421	break;
	422	case IMAGETHUMB_FIT_HEIGHT :
	423	$pnmscale_args = sprintf(' -height %s ', escapeshellarg($spec['height']));
	424	break;
	425	case IMAGETHUMB_FIT_LARGER :
	426	$pnmscale_args = sprintf(' -xysize %s %s ', escapeshellarg($spec['width']), escapeshellarg($spec['height']));
	427	break;
	428	case IMAGETHUMB_STRETCH :
	429	$pnmscale_args = sprintf(' -width %s -height %s ', escapeshellarg($spec['width']), escapeshellarg($spec['height']));
	430	break;
	431	case IMAGETHUMB_NO_SCALE :
	432	default :
	433	$pnmscale_args = ' 1 ';
	434	break;
[1]	435	}
[42]	436
[119]	437	// Define cjpeg arguments.
	438	$cjpeg_args = sprintf(' -optimize -quality %s ', escapeshellarg($spec['quality']));
	439	$cjpeg_args .= (true === $spec['progressive']) ? ' -progressive ' : '';
	440
	441	// Format the command that creates the thumbnail.
[199]	442	$command = sprintf('%s %s \| %s %s \| %s %s > %s',
[119]	443	escapeshellcmd($this->getParam('anytopnm_binary')),
	444	escapeshellcmd($source_file),
	445	escapeshellcmd($this->getParam('pnmscale_binary')),
	446	escapeshellcmd($pnmscale_args),
	447	escapeshellcmd($this->getParam('cjpeg_binary')),
	448	escapeshellcmd($cjpeg_args),
[199]	449	escapeshellcmd($dest_file)
[119]	450	);
[136]	451	$app->logMsg(sprintf('ImageThumb Netpbm command: %s', $command), LOG_DEBUG, __FILE__, __LINE__);
[119]	452
	453	// Execute!
	454	exec($command, $output, $return_val);
	455
	456	if (0 === $return_val) {
	457	// Success!
	458	// Make the thumbnail writable so the user can delete it over ftp without being 'apache'.
	459	chmod($dest_file, $this->getParam('dest_file_perms'));
[136]	460	$app->logMsg(sprintf('Successfully resized image %s', $spec['dest_dir'] . '/' . basename($dest_file), $return_val), LOG_DEBUG, __FILE__, __LINE__);
[119]	461	} else {
	462	// An error occurred.
[136]	463	$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]	464	}
	465
	466	// Return from the command will be > 0 if there was an error.
	467	return $return_val;
[1]	468	}
	469
[119]	470	/*
	471	* Use PHP's built-in GD tools to generate a rescaled compressed image.
	472	*
	473	* @access private
	474	* @param string $source_file Full path to source image file.
	475	* @param string $dest_file Full path to destination image file.
	476	* @param array $spec Array of image size specifications.
[120]	477	* @return int 0 if no error, n > 0 if errors.
[119]	478	* @author Quinn Comendant <quinn@strangecode.com>
	479	* @version 1.0
	480	* @since 19 May 2006 15:46:02
	481	*/
	482	function _resizeWithGD($source_file, $dest_file, $spec)
[1]	483	{
[136]	484	$app =& App::getInstance();
	485
[119]	486	// Get original file dimensions and type.
	487	list($source_image_width, $source_image_height, $source_image_type) = getimagesize($source_file);
	488
	489	// Define destination image dimentions.
	490	switch ($spec['scaling_type']) {
	491	case IMAGETHUMB_FIT_WIDTH :
[120]	492	$dest_image_width = $spec['width'];
[119]	493	$dest_image_height = $source_image_height * ($spec['width'] / $source_image_width);
	494	break;
	495	case IMAGETHUMB_FIT_HEIGHT :
[120]	496	$dest_image_height = $spec['height'];
[119]	497	$dest_image_width = $source_image_width * ($spec['height'] / $source_image_height);
	498	break;
	499	case IMAGETHUMB_FIT_LARGER :
[120]	500	if (($source_image_width * ($spec['height'] / $source_image_height)) <= $spec['width']) {
	501	// Height is larger.
	502	$dest_image_height = $spec['height'];
	503	$dest_image_width = $source_image_width * ($spec['height'] / $source_image_height);
[119]	504	} else {
[120]	505	// Width is larger.
	506	$dest_image_width = $spec['width'];
	507	$dest_image_height = $source_image_height * ($spec['width'] / $source_image_width);
[119]	508	}
	509	break;
	510	case IMAGETHUMB_STRETCH :
	511	$dest_image_width = $spec['width'];
	512	$dest_image_height = $spec['height'];
	513	break;
	514	case IMAGETHUMB_NO_SCALE :
	515	default :
	516	$dest_image_width = $source_image_width;
	517	$dest_image_height = $source_image_height;
	518	break;
	519	}
	520
	521	// Create source image data in memory.
	522	switch ($source_image_type) {
	523	case IMAGETYPE_JPEG :
[120]	524	$source_image_resource = imagecreatefromjpeg($source_file);
[119]	525	break;
	526	case IMAGETYPE_PNG :
[120]	527	$source_image_resource = imagecreatefrompng($source_file);
[119]	528	break;
	529	case IMAGETYPE_GIF :
[120]	530	$source_image_resource = imagecreatefromgif($source_file);
[119]	531	break;
	532	case IMAGETYPE_WBMP :
[120]	533	$source_image_resource = imagecreatefromwbmp($source_file);
[119]	534	default :
[136]	535	$app->logMsg(sprintf('Source image type %s not supported.', $source_image_type), LOG_WARNING, __FILE__, __LINE__);
[120]	536	return 1;
[119]	537	break;
[1]	538	}
[120]	539	if (!$source_image_resource) {
[136]	540	$app->logMsg(sprintf('Error creating %s image in memory from %s', $source_image_type, $source_file), LOG_WARNING, __FILE__, __LINE__);
[120]	541	return 1;
[119]	542	}
	543
	544	// Create destination image data in memory.
[120]	545	$dest_image_resource = imagecreatetruecolor($dest_image_width, $dest_image_height);
[42]	546
[119]	547	// Resample!
[120]	548	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]	549	$app->logMsg(sprintf('Error resampling image %s', $source_file), LOG_WARNING, __FILE__, __LINE__);
[152]	550	// Always cleanup images from memory.
	551	imagedestroy($source_image_resource);
	552	imagedestroy($dest_image_resource);
[120]	553	return 1;
[1]	554	}
[120]	555
	556	// Sharpen image using a custom filter matrix.
	557	if (phpversion() > '5.1' && true === $spec['sharpen'] && $spec['sharpen_value'] > 0) {
	558	$sharpen_value = round((((48 - 10) / (100 - 1)) * (100 - $spec['sharpen_value'])) + 10);
	559	imageconvolution($dest_image_resource, array(array(-1,-1,-1),array(-1,$sharpen_value,-1),array(-1,-1,-1)), ($sharpen_value - 8), 0);
	560	}
[42]	561
[119]	562	// Save image.
	563	$return_val = true;
[120]	564	switch ($spec['dest_file_type']) {
[119]	565	case IMG_JPG :
[120]	566	imageinterlace($dest_image_resource, (true == $spec['progressive'] ? 1 : 0));
	567	$return_val = imagejpeg($dest_image_resource, $dest_file, $spec['quality']);
[119]	568	break;
	569	case IMG_PNG :
[120]	570	$return_val = imagepng($dest_image_resource, $dest_file);
[119]	571	break;
	572	case IMG_GIF :
[120]	573	$return_val = imagegif($dest_image_resource, $dest_file);
[119]	574	break;
	575	case IMG_WBMP :
[120]	576	$return_val = imagewbmp($dest_image_resource, $dest_file);
[119]	577	break;
	578	default :
[136]	579	$app->logMsg(sprintf('Destination image type %s not supported for image %s.', $spec['dest_file_type'], $dest_file), LOG_WARNING, __FILE__, __LINE__);
[152]	580	// Always cleanup images from memory.
	581	imagedestroy($source_image_resource);
	582	imagedestroy($dest_image_resource);
[120]	583	return 1;
[119]	584	break;
	585	}
	586
[152]	587	// Always cleanup images from memory.
	588	imagedestroy($source_image_resource);
	589	imagedestroy($dest_image_resource);
	590
[119]	591	if ($return_val) {
	592	// Success!
	593	// Make the thumbnail writable so the user can delete it over ftp without being 'apache'.
[152]	594	if (!chmod($dest_file, $this->getParam('dest_file_perms'))) {
	595	$app->logMsg(sprintf('chmod failed on file: %s', $dest_file), LOG_ERR, __FILE__, __LINE__);
	596	}
	597	$app->logMsg(sprintf('Successfully resized image: %s', $dest_file), LOG_DEBUG, __FILE__, __LINE__);
[120]	598	return 0;
[1]	599	} else {
[119]	600	// An error occurred.
[152]	601	$app->logMsg(sprintf('Failed resizing image: %s', $dest_file), LOG_ERR, __FILE__, __LINE__);
[120]	602	return 1;
[1]	603	}
	604	}
	605
	606	/**
	607	* Delete the thumbnails for the specified file name.
	608	*
	609	* @access public
[199]	610	* @param string $file_name The file name to delete, with extension.
[1]	611	* @return bool true on success, false on failure.
	612	*/
	613	function deleteThumbs($file_name)
	614	{
[136]	615	$app =& App::getInstance();
	616
[1]	617	// Ensure we have a source.
[119]	618	if ('' == $this->getParam('source_dir')) {
[136]	619	$app->logMsg(sprintf('Source directory not set before processing.'), LOG_ERR, __FILE__, __LINE__);
[1]	620	return false;
	621	}
[42]	622
[119]	623	$return_val = 0;
[152]	624	foreach ($this->_image_specs as $spec) {
	625	if ('/' == $spec['dest_dir']{0}) {
	626	// Absolute path.
[199]	627	$dest_file = realpath(sprintf('%s/%s.%s', $spec['dest_dir'], substr($file_name, 0, strrpos($file_name, '.')), $spec['dest_file_extension']));
[152]	628	} else {
	629	// Relative path.
[199]	630	$dest_file = realpath(sprintf('%s/%s/%s.%s', $this->getParam('source_dir'), $spec['dest_dir'], substr($file_name, 0, strrpos($file_name, '.')), $spec['dest_file_extension']));
[152]	631	}
[119]	632	if (file_exists($dest_file)) {
	633	if (!unlink($dest_file)) {
	634	$return_val++;
[141]	635	$app->logMsg(sprintf('Delete thumbs failed: %s', $dest_file), LOG_WARNING, __FILE__, __LINE__);
[1]	636	}
	637	}
	638	}
[204]	639	$app->logMsg(sprintf('Thumbnails deleted for file: %s', $file_name), LOG_INFO, __FILE__, __LINE__);
[119]	640	return 0 === $return_val;
[1]	641	}
	642
	643	/**
	644	* Delete the source image with the specified file name.
	645	*
	646	* @access public
[199]	647	* @param string $file_name The file name to delete, with extension.
[1]	648	* @return bool true on success, false on failure.
	649	*/
	650	function deleteOriginal($file_name)
	651	{
[136]	652	$app =& App::getInstance();
	653
[1]	654	// Ensure we have a source.
[119]	655	if ('' == $this->getParam('source_dir')) {
[136]	656	$app->logMsg(sprintf('Source directory not set before processing.'), LOG_ERR, __FILE__, __LINE__);
[1]	657	return false;
	658	}
[42]	659
[201]	660	// Ensure we have a source.
	661	if ('' == $file_name) {
	662	$app->logMsg(sprintf('Cannot delete, filename empty.'), LOG_WARNING, __FILE__, __LINE__);
	663	return false;
	664	}
	665
[119]	666	$source_file = realpath(sprintf('%s/%s', $this->getParam('source_dir'), $file_name));
[201]	667	if (is_file($source_file) && unlink($source_file)) {
	668	$app->logMsg(sprintf('Original file successfully deleted: %s', $file_name), LOG_INFO, __FILE__, __LINE__);
	669	return true;
	670	} else {
[141]	671	$app->logMsg(sprintf('Delete original failed: %s', $source_file), LOG_WARNING, __FILE__, __LINE__);
[1]	672	return false;
	673	}
	674	}
[42]	675
[1]	676	/**
	677	* Returns true if file exists.
	678	*
	679	* @access public
[199]	680	* @param string $file_name The file name to test, with extension.
[1]	681	* @return bool true on success, false on failure.
	682	*/
	683	function exists($file_name)
	684	{
[136]	685	$app =& App::getInstance();
	686
[1]	687	// Ensure we have a source.
[119]	688	if ('' == $this->getParam('source_dir')) {
[136]	689	$app->logMsg(sprintf('Source directory not set before processing.'), LOG_ERR, __FILE__, __LINE__);
[1]	690	return false;
	691	}
[42]	692
[119]	693	$source_file = realpath(sprintf('%s/%s', $this->getParam('source_dir'), $file_name));
	694	return file_exists($source_file);
[1]	695	}
[42]	696
[1]	697	/**
[199]	698	* Tests if extension of $file_name is in the array valid_file_extensions.
[1]	699	*
	700	* @access public
	701	* @param string $file_name A file name.
	702	* @return bool True on success, false on failure.
	703	*/
[119]	704	function _validFileExtension($file_name)
[1]	705	{
	706	preg_match('/.*?\.(\w+)$/i', $file_name, $ext);
[121]	707	return !empty($ext) && in_array(strtolower($ext[1]), $this->getParam('valid_file_extensions'));
[1]	708	}
[42]	709
[1]	710	/**
[119]	711	* Make directory for each specified thumbnail size, if it doesn't exist.
[1]	712	*
[119]	713	* @access public
	714	* @return bool true on success, false on failure.
	715	*/
[152]	716	function _createDestDirs($filename=null)
[119]	717	{
[136]	718	$app =& App::getInstance();
	719
[152]	720	// Keep track of directories we've already created.
	721	$dd_hash = md5(isset($filename) ? dirname($filename) : 'none');
	722	static $already_checked = array();
[119]	723
[152]	724	$return_val = 0;
	725
	726	if (!isset($already_checked[$dd_hash])) {
[119]	727	// Ensure we have a source.
	728	if ('' == $this->getParam('source_dir')) {
[136]	729	$app->logMsg(sprintf('Source directory not set before creating destination directories.'), LOG_ERR, __FILE__, __LINE__);
[119]	730	return false;
	731	}
	732
	733	// Loop through specs and ensure all dirs are created.
[152]	734	foreach ($this->_image_specs as $spec) {
	735	if (isset($filename)) {
	736	$dest_dir = dirname($filename);
	737	} else {
	738	if ('/' == $spec['dest_dir']{0}) {
	739	// Absolute path.
	740	$dest_dir = $spec['dest_dir'];
	741	} else {
	742	// Relative path.
	743	$dest_dir = sprintf('%s/%s', $this->getParam('source_dir'), $spec['dest_dir']);
[119]	744	}
	745	}
[152]	746	if (!file_exists($dest_dir)) {
[154]	747	if (phpversion() > '5') {
[152]	748	// Recursive.
[154]	749	if (!file_exists($dest_dir) && !($ret = mkdir($dest_dir, $this->getParam('dest_dir_perms'), true))) {
[152]	750	$return_val++;
	751	$app->logMsg(sprintf('mkdir failure: %s', $dest_dir), LOG_ERR, __FILE__, __LINE__);
	752	}
	753	} else {
	754	// Recursive mkdir for php 4.
	755	$path = '';
	756	foreach (array_diff(explode('/', $dest_dir), array('')) as $dir) {
	757	$path .= '/' . $dir;
	758	if (! ($ret = file_exists($path) ? true : mkdir($path, $this->getParam('dest_dir_perms')))) {
	759	$return_val++;
	760	$app->logMsg(sprintf('mkdir failure: %s', $path), LOG_ERR, __FILE__, __LINE__);
	761	break;
	762	}
	763	}
	764	}
	765
	766	if ($ret) {
	767	$app->logMsg(sprintf('mkdir success: %s', $dest_dir), LOG_DEBUG, __FILE__, __LINE__);
	768	}
	769	}
[119]	770	}
	771	}
	772
[152]	773	$already_checked[$dd_hash] = true;
	774
	775	// If > 0, there was a problem creating dest dirs.
	776	return 0 === $return_val;
[119]	777	}
	778
	779	/**
[136]	780	* An alias for $app->raiseMsg that only sends messages configured by display_messages.
[119]	781	*
[1]	782	* @access public
	783	*
	784	* @param string $message The text description of the message.
	785	* @param int $type The type of message: MSG_NOTICE,
	786	* MSG_SUCCESS, MSG_WARNING, or MSG_ERR.
	787	* @param string $file __FILE__.
	788	* @param string $line __LINE__.
	789	*/
[119]	790	function _raiseMsg($message, $type, $file, $line)
[1]	791	{
[136]	792	$app =& App::getInstance();
	793
[119]	794	if ($this->getParam('display_messages') === true \|\| (is_int($this->getParam('display_messages')) && $this->getParam('display_messages') & $type > 0)) {
[136]	795	$app->raiseMsg($message, $type, $file, $line);
[1]	796	}
	797	}
	798
	799	} // End of class.
	800	?>

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

Download in other formats: