<?php

/**

* CodeIgniter

*

* An open source application development framework for PHP 5.2.4 or newer

*

* NOTICE OF LICENSE

*

* Licensed under the Open Software License version 3.0

*

* This source file is subject to the Open Software License (OSL 3.0) that is

* bundled with this package in the files license.txt / license.rst. It is

* also available through the world wide web at this URL:

* http://opensource.org/licenses/OSL-3.0

* If you did not receive a copy of the license and are unable to obtain it

* through the world wide web, please send an email to

* licensing@ellislab.com so we can send you a copy immediately.

*

* @package CodeIgniter

* @author EllisLab Dev Team

* @copyright Copyright (c) 2008 - 2013, EllisLab, Inc. (http://ellislab.com/)

* @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)

* @link http://codeigniter.com

* @since Version 1.0

* @filesource

*/

defined('BASEPATH') OR exit('No direct script access allowed');

/**

* Image Manipulation class

*

* @package CodeIgniter

* @subpackage Libraries

* @category Image_lib

* @author EllisLab Dev Team

* @link http://codeigniter.com/user_guide/libraries/image_lib.html

*/

class CI_Image_lib {

/**

* PHP extension/library to use for image manipulation

* Can be: imagemagick, netpbm, gd, gd2

*

* @var string

*/

public $image_library = 'gd2';

/**

* Path to the graphic library (if applicable)

*

* @var string

*/

public $library_path = '';

/**

* Whether to send to browser or write to disk

*

* @var bool

*/

public $dynamic_output = FALSE;

/**

* Path to original image

*

* @var string

*/

public $source_image = '';

/**

* Path to the modified image

*

* @var string

*/

public $new_image = '';

/**

* Image width

*

* @var int

*/

public $width = '';

/**

* Image height

*

* @var int

*/

public $height = '';

/**

* Quality percentage of new image

*

* @var int

*/

public $quality = 90;

/**

* Whether to create a thumbnail

*

* @var bool

*/

public $create_thumb = FALSE;

/**

* String to add to thumbnail version of image

*

* @var string

*/

public $thumb_marker = '_thumb';

/**

* Whether to maintain aspect ratio when resizing or use hard values

*

* @var bool

*/

public $maintain_ratio = TRUE;

/**

* auto, height, or width. Determines what to use as the master dimension

*

* @var string

*/

public $master_dim = 'auto';

/**

* Angle at to rotate image

*

* @var string

*/

public $rotation_angle = '';

/**

* X Coordinate for manipulation of the current image

*

* @var int

*/

public $x_axis = '';

/**

* Y Coordinate for manipulation of the current image

*

* @var int

*/

public $y_axis = '';

// --------------------------------------------------------------------------

// Watermark Vars

// --------------------------------------------------------------------------

/**

* Watermark text if graphic is not used

*

* @var string

*/

public $wm_text = '';

/**

* Type of watermarking. Options: text/overlay

*

* @var string

*/

public $wm_type = 'text';

/**

* Default transparency for watermark

*

* @var int

*/

public $wm_x_transp = 4;

/**

* Default transparency for watermark

*

* @var int

*/

public $wm_y_transp = 4;

/**

* Watermark image path

*

* @var string

*/

public $wm_overlay_path = '';

/**

* TT font

*

* @var string

*/

public $wm_font_path = '';

/**

* Font size (different versions of GD will either use points or pixels)

*

* @var int

*/

public $wm_font_size = 17;

/**

* Vertical alignment: T M B

*

* @var string

*/

public $wm_vrt_alignment = 'B';

/**

* Horizontal alignment: L R C

*

* @var string

*/

public $wm_hor_alignment = 'C';

/**

* Padding around text

*

* @var int

*/

public $wm_padding = 0;

/**

* Lets you push text to the right

*

* @var int

*/

public $wm_hor_offset = 0;

/**

* Lets you push text down

*

* @var int

*/

public $wm_vrt_offset = 0;

/**

* Text color

*

* @var string

*/

protected $wm_font_color = '#ffffff';

/**

* Dropshadow color

*

* @var string

*/

protected $wm_shadow_color = '';

/**

* Dropshadow distance

*

* @var int

*/

public $wm_shadow_distance = 2;

/**

* Image opacity: 1 - 100 Only works with image

*

* @var int

*/

public $wm_opacity = 50;

// --------------------------------------------------------------------------

// Private Vars

// --------------------------------------------------------------------------

/**

* Source image folder

*

* @var string

*/

public $source_folder = '';

/**

* Destination image folder

*

* @var string

*/

public $dest_folder = '';

/**

* Image mime-type

*

* @var string

*/

public $mime_type = '';

/**

* Original image width

*

* @var int

*/

public $orig_width = '';

/**

* Original image height

*

* @var int

*/

public $orig_height = '';

/**

* Image format

*

* @var string

*/

public $image_type = '';

/**

* Size of current image

*

* @var string

*/

public $size_str = '';

/**

* Full path to source image

*

* @var string

*/

public $full_src_path = '';

/**

* Full path to destination image

*

* @var string

*/

public $full_dst_path = '';

/**

* Name of function to create image

*

* @var string

*/

public $create_fnc = 'imagecreatetruecolor';

/**

* Name of function to copy image

*

* @var string

*/

public $copy_fnc = 'imagecopyresampled';

/**

* Error messages

*

* @var array

*/

public $error_msg = array();

/**

* Whether to have a drop shadow on watermark

*

* @var bool

*/

protected $wm_use_drop_shadow = FALSE;

/**

* Whether to use truetype fonts

*

* @var bool

*/

public $wm_use_truetype = FALSE;

/**

* Initialize Image Library

*

* @param array $props

* @return void

*/

public function __construct($props = array())

{

if (count($props) > 0)

{

$this->initialize($props);

}

log_message('debug', 'Image Lib Class Initialized');

}

// --------------------------------------------------------------------

/**

* Initialize image properties

*

* Resets values in case this class is used in a loop

*

* @return void

*/

public function clear()

{

$props = array('library_path', 'source_image', 'new_image', 'width', 'height', 'rotation_angle', 'x_axis', 'y_axis', 'wm_text', 'wm_overlay_path', 'wm_font_path', 'wm_shadow_color', 'source_folder', 'dest_folder', 'mime_type', 'orig_width', 'orig_height', 'image_type', 'size_str', 'full_src_path', 'full_dst_path');

foreach ($props as $val)

{

$this->$val = '';

}

$this->image_library = 'gd2';

$this->dynamic_output = FALSE;

$this->quality = 90;

$this->create_thumb = FALSE;

$this->thumb_marker = '_thumb';

$this->maintain_ratio = TRUE;

$this->master_dim = 'auto';

$this->wm_type = 'text';

$this->wm_x_transp = 4;

$this->wm_y_transp = 4;

$this->wm_font_size = 17;

$this->wm_vrt_alignment = 'B';

$this->wm_hor_alignment = 'C';

$this->wm_padding = 0;

$this->wm_hor_offset = 0;

$this->wm_vrt_offset = 0;

$this->wm_font_color = '#ffffff';

$this->wm_shadow_distance = 2;

$this->wm_opacity = 50;

$this->create_fnc = 'imagecreatetruecolor';

$this->copy_fnc = 'imagecopyresampled';

$this->error_msg = array();

$this->wm_use_drop_shadow = FALSE;

$this->wm_use_truetype = FALSE;

}

// --------------------------------------------------------------------

/**

* initialize image preferences

*

* @param array

* @return bool

*/

public function initialize($props = array())

{

// Convert array elements into class variables

if (count($props) > 0)

{

foreach ($props as $key => $val)

{

if (property_exists($this, $key))

{

if (in_array($key, array('wm_font_color', 'wm_shadow_color')))

{

if (preg_match('/^#?([0-9a-f]{3}|[0-9a-f]{6})$/i', $val, $matches))

{

/* $matches[1] contains our hex color value, but it might be

* both in the full 6-length format or the shortened 3-length

* value.

* We'll later need the full version, so we keep it if it's

* already there and if not - we'll convert to it. We can

* access string characters by their index as in an array,

* so we'll do that and use concatenation to form the final

* value:

*/

$val = (strlen($matches[1]) === 6)

? '#'.$matches[1]

: '#'.$matches[1][0].$matches[1][0].$matches[1][1].$matches[1][1].$matches[1][2].$matches[1][2];

}

else

{

continue;

}

}

$this->$key = $val;

}

}

}

// Is there a source image? If not, there's no reason to continue

if ($this->source_image === '')

{

$this->set_error('imglib_source_image_required');

return FALSE;

}

/* Is getimagesize() available?

*

* We use it to determine the image properties (width/height).

* Note: We need to figure out how to determine image

* properties using ImageMagick and NetPBM

*/

if ( ! function_exists('getimagesize'))

{

$this->set_error('imglib_gd_required_for_props');

return FALSE;

}

$this->image_library = strtolower($this->image_library);

/* Set the full server path

*

* The source image may or may not contain a path.

* Either way, we'll try use realpath to generate the

* full server path in order to more reliably read it.

*/

if (function_exists('realpath') && @realpath($this->source_image) !== FALSE)

{

$full_source_path = str_replace('\\', '/', realpath($this->source_image));

}

else

{

$full_source_path = $this->source_image;

}

$x = explode('/', $full_source_path);

$this->source_image = end($x);

$this->source_folder = str_replace($this->source_image, '', $full_source_path);

// Set the Image Properties

if ( ! $this->get_image_properties($this->source_folder.$this->source_image))

{

return FALSE;

}

/*

* Assign the "new" image name/path

*

* If the user has set a "new_image" name it means

* we are making a copy of the source image. If not

* it means we are altering the original. We'll

* set the destination filename and path accordingly.

*/

if ($this->new_image === '')

{

$this->dest_image = $this->source_image;

$this->dest_folder = $this->source_folder;

}

elseif (strpos($this->new_image, '/') === FALSE)

{

$this->dest_folder = $this->source_folder;

$this->dest_image = $this->new_image;

}

else

{

if (strpos($this->new_image, '/') === FALSE && strpos($this->new_image, '\\') === FALSE)

{

$full_dest_path = str_replace('\\', '/', realpath($this->new_image));

}

else

{

$full_dest_path = $this->new_image;

}

// Is there a file name?

if ( ! preg_match('#\.(jpg|jpeg|gif|png)$#i', $full_dest_path))

{

$this->dest_folder = $full_dest_path.'/';

$this->dest_image = $this->source_image;

}

else

{

$x = explode('/', $full_dest_path);

$this->dest_image = end($x);

$this->dest_folder = str_replace($this->dest_image, '', $full_dest_path);

}

}

/* Compile the finalized filenames/paths

*

* We'll create two master strings containing the

* full server path to the source image and the

* full server path to the destination image.

* We'll also split the destination image name

* so we can insert the thumbnail marker if needed.

*/

if ($this->create_thumb === FALSE OR $this->thumb_marker === '')

{

$this->thumb_marker = '';

}

$xp = $this->explode_name($this->dest_image);

$filename = $xp['name'];

$file_ext = $xp['ext'];

$this->full_src_path = $this->source_folder.$this->source_image;

$this->full_dst_path = $this->dest_folder.$filename.$this->thumb_marker.$file_ext;

/* Should we maintain image proportions?

*

* When creating thumbs or copies, the target width/height

* might not be in correct proportion with the source

* image's width/height. We'll recalculate it here.

*/

if ($this->maintain_ratio === TRUE && ($this->width !== 0 OR $this->height !== 0))

{

$this->image_reproportion();

}

/* Was a width and height specified?

*

* If the destination width/height was not submitted we

* will use the values from the actual file

*/

if ($this->width === '')

{

$this->width = $this->orig_width;

}

if ($this->height === '')

{

$this->height = $this->orig_height;

}

// Set the quality

$this->quality = trim(str_replace('%', '', $this->quality));

if ($this->quality === '' OR $this->quality === 0 OR ! ctype_digit($this->quality))

{

$this->quality = 90;

}

// Set the x/y coordinates

is_numeric($this->x_axis) OR $this->x_axis = 0;

is_numeric($this->y_axis) OR $this->y_axis = 0;

// Watermark-related Stuff...

if ($this->wm_overlay_path !== '')

{

$this->wm_overlay_path = str_replace('\\', '/', realpath($this->wm_overlay_path));

}

if ($this->wm_shadow_color !== '')

{

$this->wm_use_drop_shadow = TRUE;

}

elseif ($this->wm_use_drop_shadow === TRUE && $this->wm_shadow_color === '')

{

$this->wm_use_drop_shadow = FALSE;

}

if ($this->wm_font_path !== '')

{

$this->wm_use_truetype = TRUE;

}

return TRUE;

}

// --------------------------------------------------------------------

/**

* Image Resize

*

* This is a wrapper function that chooses the proper

* resize function based on the protocol specified

*

* @return bool

*/

public function resize()

{

$protocol = ($this->image_library === 'gd2') ? 'image_process_gd' : 'image_process_'.$this->image_library;

return $this->$protocol('resize');

}

// --------------------------------------------------------------------

/**

* Image Crop

*

* This is a wrapper function that chooses the proper

* cropping function based on the protocol specified

*

* @return bool

*/

public function crop()

{

$protocol = ($this->image_library === 'gd2') ? 'image_process_gd' : 'image_process_'.$this->image_library;

return $this->$protocol('crop');

}

// --------------------------------------------------------------------

/**

* Image Rotate

*

* This is a wrapper function that chooses the proper

* rotation function based on the protocol specified

*

* @return bool

*/

public function rotate()

{

// Allowed rotation values

$degs = array(90, 180, 270, 'vrt', 'hor');

if ($this->rotation_angle === '' OR ! in_array($this->rotation_angle, $degs))

{

$this->set_error('imglib_rotation_angle_required');

return FALSE;

}

// Reassign the width and height

if ($this->rotation_angle === 90 OR $this->rotation_angle === 270)

{

$this->width = $this->orig_height;

$this->height = $this->orig_width;

}

else

{

$this->width = $this->orig_width;

$this->height = $this->orig_height;

}

// Choose resizing function

if ($this->image_library === 'imagemagick' OR $this->image_library === 'netpbm')

{

$protocol = 'image_process_'.$this->image_library;

return $this->$protocol('rotate');

}

return ($this->rotation_angle === 'hor' OR $this->rotation_angle === 'vrt')

? $this->image_mirror_gd()

: $this->image_rotate_gd();

}

// --------------------------------------------------------------------

/**

* Image Process Using GD/GD2

*

* This function will resize or crop

*

* @param string

* @return bool

*/

public function image_process_gd($action = 'resize')

{

$v2_override = FALSE;

// If the target width/height match the source, AND if the new file name is not equal to the old file name

// we'll simply make a copy of the original with the new name... assuming dynamic rendering is off.

if ($this->dynamic_output === FALSE && $this->orig_width === $this->width && $this->orig_height === $this->height)

{

if ($this->source_image !== $this->new_image && @copy($this->full_src_path, $this->full_dst_path))

{

@chmod($this->full_dst_path, FILE_WRITE_MODE);

}

return TRUE;

}

// Let's set up our values based on the action

if ($action === 'crop')

{

// Reassign the source width/height if cropping

$this->orig_width = $this->width;

$this->orig_height = $this->height;

// GD 2.0 has a cropping bug so we'll test for it

if ($this->gd_version() !== FALSE)

{

$gd_version = str_replace('0', '', $this->gd_version());

$v2_override = ($gd_version === 2);

}

}

else

{

// If resizing the x/y axis must be zero

$this->x_axis = 0;

$this->y_axis = 0;

}

// Create the image handle

if ( ! ($src_img = $this->image_create_gd()))

{

return FALSE;

}

/* Create the image

*

* Old conditional which users report cause problems with shared GD libs who report themselves as "2.0 or greater"

* it appears that this is no longer the issue that it was in 2004, so we've removed it, retaining it in the comment

* below should that ever prove inaccurate.

*

* if ($this->image_library === 'gd2' && function_exists('imagecreatetruecolor') && $v2_override === FALSE)

*/

if ($this->image_library === 'gd2' && function_exists('imagecreatetruecolor'))

{

$create = 'imagecreatetruecolor';

$copy = 'imagecopyresampled';

}

else

{

$create = 'imagecreate';

$copy = 'imagecopyresized';

}

$dst_img = $create($this->width, $this->height);

if ($this->image_type === 3) // png we can actually preserve transparency

{

imagealphablending($dst_img, FALSE);

imagesavealpha($dst_img, TRUE);

}

$copy($dst_img, $src_img, 0, 0, $this->x_axis, $this->y_axis, $this->width, $this->height, $this->orig_width, $this->orig_height);

// Show the image

if ($this->dynamic_output === TRUE)

{

$this->image_display_gd($dst_img);

}

elseif ( ! $this->image_save_gd($dst_img)) // Or save it

{

return FALSE;

}

// Kill the file handles

imagedestroy($dst_img);

imagedestroy($src_img);

// Set the file to 666

@chmod($this->full_dst_path, FILE_WRITE_MODE);

return TRUE;

}

// --------------------------------------------------------------------

/**

* Image Process Using ImageMagick

*

* This function will resize, crop or rotate

*

* @param string

* @return bool

*/

public function image_process_imagemagick($action = 'resize')

{

// Do we have a vaild library path?

if ($this->library_path === '')

{

$this->set_error('imglib_libpath_invalid');

return FALSE;

}

if ( ! preg_match('/convert$/i', $this->library_path))

{

$this->library_path = rtrim($this->library_path, '/').'/convert';

}

// Execute the command

$cmd = $this->library_path.' -quality '.$this->quality;

if ($action === 'crop')

{

$cmd .= ' -crop '.$this->width.'x'.$this->height.'+'.$this->x_axis.'+'.$this->y_axis.' "'.$this->full_src_path.'" "'.$this->full_dst_path .'" 2>&1';

}

elseif ($action === 'rotate')

{

$angle = ($this->rotation_angle === 'hor' OR $this->rotation_angle === 'vrt')

? '-flop' : '-rotate '.$this->rotation_angle;

$cmd .= ' '.$angle.' "'.$this->full_src_path.'" "'.$this->full_dst_path.'" 2>&1';

}

else // Resize

{

if($this->maintain_ratio === TRUE)

{

$cmd .= ' -resize '.$this->width.'x'.$this->height.' "'.$this->full_src_path.'" "'.$this->full_dst_path.'" 2>&1';

}

else

{

$cmd .= ' -resize '.$this->width.'x'.$this->height.'\! "'.$this->full_src_path.'" "'.$this->full_dst_path.'" 2>&1';

}

}

$retval = 1;

// exec() might be disabled

if (function_usable('exec'))

{

@exec($cmd, $output, $retval);

}

// Did it work?

if ($retval > 0)

{

$this->set_error('imglib_image_process_failed');

return FALSE;

}

// Set the file to 777

@chmod($this->full_dst_path, FILE_WRITE_MODE);

return TRUE;

}

// --------------------------------------------------------------------

/**

* Image Process Using NetPBM

*

* This function will resize, crop or rotate

*

* @param string

* @return bool

*/

public function image_process_netpbm($action = 'resize')

{

if ($this->library_path === '')

{

$this->set_error('imglib_libpath_invalid');

return FALSE;

}

// Build the resizing command

switch ($this->image_type)

{

case 1 :

$cmd_in = 'giftopnm';

$cmd_out = 'ppmtogif';

break;

case 2 :

$cmd_in = 'jpegtopnm';

$cmd_out = 'ppmtojpeg';

break;

case 3 :

$cmd_in = 'pngtopnm';

$cmd_out = 'ppmtopng';

break;

}

if ($action === 'crop')

{

$cmd_inner = 'pnmcut -left '.$this->x_axis.' -top '.$this->y_axis.' -width '.$this->width.' -height '.$this->height;

}

elseif ($action === 'rotate')

{

switch ($this->rotation_angle)

{

case 90: $angle = 'r270';

break;

case 180: $angle = 'r180';

break;

case 270: $angle = 'r90';

break;

case 'vrt': $angle = 'tb';

break;

case 'hor': $angle = 'lr';

break;

}

$cmd_inner = 'pnmflip -'.$angle.' ';

}

else // Resize

{

$cmd_inner = 'pnmscale -xysize '.$this->width.' '.$this->height;

}

$cmd = $this->library_path.$cmd_in.' '.$this->full_src_path.' | '.$cmd_inner.' | '.$cmd_out.' > '.$this->dest_folder.'netpbm.tmp';

$retval = 1;

// exec() might be disabled

if (function_usable('exec'))

{

@exec($cmd, $output, $retval);

}

// Did it work?

if ($retval > 0)

{

$this->set_error('imglib_image_process_failed');

return FALSE;

}

// With NetPBM we have to create a temporary image.

// If you try manipulating the original it fails so

// we have to rename the temp file.

copy($this->dest_folder.'netpbm.tmp', $this->full_dst_path);

unlink($this->dest_folder.'netpbm.tmp');

@chmod($this->full_dst_path, FILE_WRITE_MODE);

return TRUE;

}

// --------------------------------------------------------------------

/**

* Image Rotate Using GD

*

* @return bool

*/

public function image_rotate_gd()

{

// Create the image handle

if ( ! ($src_img = $this->image_create_gd()))

{

return FALSE;

}

// Set the background color

// This won't work with transparent PNG files so we are

// going to have to figure out how to determine the color

// of the alpha channel in a future release.

$white = imagecolorallocate($src_img, 255, 255, 255);

// Rotate it!

$dst_img = imagerotate($src_img, $this->rotation_angle, $white);