Professional Documents
Culture Documents
php
// +------------------------------------------------------------------------+
// | class.upload.php |
// +------------------------------------------------------------------------+
// | Copyright (c) Colin Verot 2003-2009. All rights reserved. |
// | Version 0.27 |
// | Last modified 14/05/2009 |
// | Email colin@verot.net |
// | Web http://www.verot.net |
// +------------------------------------------------------------------------+
// | This program is free software; you can redistribute it and/or modify |
// | it under the terms of the GNU General Public License version 2 as |
// | published by the Free Software Foundation. |
// | |
// | This program is distributed in the hope that it will be useful, |
// | but WITHOUT ANY WARRANTY; without even the implied warranty of |
// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
// | GNU General Public License for more details. |
// | |
// | You should have received a copy of the GNU General Public License |
// | along with this program; if not, write to the |
// | Free Software Foundation, Inc., 59 Temple Place, Suite 330, |
// | Boston, MA 02111-1307 USA |
// | |
// | Please give credit on sites that use class.upload and submit changes |
// | of the script so other people can use them as well. |
// | This script is free to use, don't abuse. |
// +------------------------------------------------------------------------+
//
/**
* Class upload
*
* @version 0.27
* @author Colin Verot <colin@verot.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @copyright Colin Verot
* @package cmf
* @subpackage external
*/
/**
* Class upload
*
* <b>What does it do?</b>
*
* It manages file uploads for you. In short, it manages the uploaded file,
* and allows you to do whatever you want with the file, especially if it
* is an image, and as many times as you want.
*
* It is the ideal class to quickly integrate file upload in your site.
* If the file is an image, you can convert, resize, crop it in many ways.
* You can also apply filters, add borders, text, watermarks, etc...
* That's all you need for a gallery script for instance. Supported formats
* are PNG, JPG, GIF and BMP.
*
* You can also use the class to work on local files, which is especially
* useful to use the image manipulation features. The class also supports
* Flash uploaders.
*
* The class works with PHP 4 and 5, and its error messages can
* be localized at will.
*
* <b>How does it work?</b>
*
* You instanciate the class with the $_FILES['my_field'] array
* where my_field is the field name from your upload form.
* The class will check if the original file has been uploaded
* to its temporary location (alternatively, you can instanciate
* the class with a local filename).
*
* You can then set a number of processing variables to act on the file.
* For instance, you can rename the file, and if it is an image,
* convert and resize it in many ways.
* You can also set what will the class do if the file already exists.
*
* Then you call the function {@link process} to actually perform the actions
* according to the processing parameters you set above.
* It will create new instances of the original file,
* so the original file remains the same between each process.
* The file will be manipulated, and copied to the given location.
* The processing variables will be reset once it is done.
*
* You can repeat setting up a new set of processing variables,
* and calling {@link process} again as many times as you want.
* When you have finished, you can call {@link clean} to delete
* the original uploaded file.
*
* If you don't set any processing parameters and call {@link process}
* just after instanciating the class. The uploaded file will be simply
* copied to the given location without any alteration or checks.
*
* Don't forget to add <i>enctype="multipart/form-data"</i> in your form
* tag <form> if you want your form to upload the file.
*
* <b>How to use it?</b><br>
* Create a simple HTML file, with a form such as:
* <pre>
* <form enctype="multipart/form-data" method="post" action="upload.php">
* <input type="file" size="32" name="image_field" value="">
* <input type="submit" name="Submit" value="upload">
* </form>
* </pre>
* Create a file called upload.php:
* <pre>
* $handle = new upload($_FILES['image_field']);
* if ($handle->uploaded) {
* $handle->file_new_name_body = 'image_resized';
* $handle->image_resize = true;
* $handle->image_x = 100;
* $handle->image_ratio_y = true;
* $handle->process('/home/user/files/');
* if ($handle->processed) {
* echo 'image resized';
* $handle->clean();
* } else {
* echo 'error : ' . $handle->error;
* }
* }
* </pre>
*
* <b>How to process local files?</b><br>
* Use the class as following, the rest being the same as above:
* <pre>
* $handle = new upload('/home/user/myfile.jpg');
* </pre>
*
* <b>How to set the language?</b><br>
* Instantiate the class with a second argument being the language code:
* <pre>
* $handle = new upload($_FILES['image_field'], 'fr_FR');
* $handle = new upload('/home/user/myfile.jpg', 'fr_FR');
* </pre>
*
* <b>How to output the resulting file or picture directly to the browser?</b><b
r>
* Simply call {@link process}() without an argument (or with null as first argu
ment):
* <pre>
* $handle = new upload($_FILES['image_field']);
* header('Content-type: ' . $handle->file_src_mime);
* echo $handle->Process();
* die();
* </pre>
* Or if you want to force the download of the file:
* <pre>
* $handle = new upload($_FILES['image_field']);
* header('Content-type: ' . $handle->file_src_mime);
* header("Content-Disposition: attachment; filename=".rawurlencode($handle->fi
le_src_name).";");
* echo $handle->Process();
* die();
* </pre>
*
* <b>Processing parameters</b> (reset after each process)
* <ul>
* <li><b>file_new_name_body</b> replaces the name body (default: '')<br>
* <pre>$handle->file_new_name_body = 'new name';</pre></li>
* <li><b>file_name_body_add</b> appends to the name body (default: '')<br>
* <pre>$handle->file_name_body_add = '_uploaded';</pre></li>
* <li><b>file_new_name_ext</b> replaces the file extension (default: '')<br>
* <pre>$handle->file_new_name_ext = 'txt';</pre></li>
* <li><b>file_safe_name</b> formats the filename (spaces changed to _) (defaul
t: true)<br>
* <pre>$handle->file_safe_name = true;</pre></li>
* <li><b>file_overwrite</b> sets behaviour if file already exists (default: fa
lse)<br>
* <pre>$handle->file_overwrite = true;</pre></li>
* <li><b>file_auto_rename</b> automatically renames file if it already exists
(default: true)<br>
* <pre>$handle->file_auto_rename = true;</pre></li>
* <li><b>auto_create_dir</b> automatically creates destination directory if mi
ssing (default: true)<br>
* <pre>$handle->auto_create_dir = true;</pre></li>
* <li><b>dir_auto_chmod</b> automatically attempts to chmod the destination di
rectory if not writeable (default: true)<br>
* <pre>$handle->dir_auto_chmod = true;</pre></li>
* <li><b>dir_chmod</b> chmod used when creating directory or if directory not
writeable (default: 0777)<br>
* <pre>$handle->dir_chmod = 0777;</pre></li>
* <li><b>file_max_size</b> sets maximum upload size (default: upload_max_files
ize from php.ini)<br>
* <pre>$handle->file_max_size = '1024'; // 1KB</pre></li>
* <li><b>mime_check</b> sets if the class check the MIME against the {@link al
lowed} list (default: true)<br>
* <pre>$handle->mime_check = true;</pre></li>
* <li><b>no_script</b> sets if the class turns scripts into text files (defaul
t: true)<br>
* <pre>$handle->no_script = false;</pre></li>
* <li><b>allowed</b> array of allowed mime-types. wildcard accepted, as in ima
ge/* (default: check {@link Init})<br>
* <pre>$handle->allowed = array('application/pdf','application/msword', 'image
/*');</pre></li>
* <li><b>forbidden</b> array of forbidden mime-types. wildcard accepted, as in
image/* (default: check {@link Init})<br>
* <pre>$handle->forbidden = array('application/*');</pre></li>
* </ul>
* <ul>
* <li><b>image_convert</b> if set, image will be converted (possible values :
''|'png'|'jpeg'|'gif'|'bmp'; default: '')<br>
* <pre>$handle->image_convert = 'jpg';</pre></li>
* <li><b>image_background_color</b> if set, will forcibly fill transparent are
as with the color, in hexadecimal (default: null)<br>
* <pre>$handle->image_background_color = '#FF00FF';</pre></li>
* <li><b>image_default_color</b> fallback color background color for non alpha
-transparent output formats, such as JPEG or BMP, in hexadecimal (default: #FFFF
FF)<br>
* <pre>$handle->image_default_color = '#FF00FF';</pre></li>
* <li><b>jpeg_quality</b> sets the compression quality for JPEG images (defaul
t: 85)<br>
* <pre>$handle->jpeg_quality = 50;</pre></li>
* <li><b>jpeg_size</b> if set to a size in bytes, will approximate {@link jpeg
_quality} so the output image fits within the size (default: null)<br>
* <pre>$handle->jpeg_size = 3072;</pre></li>
* </ul>
* The following eight settings can be used to invalidate an upload if the file
is an image (note that <i>open_basedir</i> restrictions prevent the use of these
settings)
* <ul>
* <li><b>image_max_width</b> if set to a dimension in pixels, the upload will
be invalid if the image width is greater (default: null)<br>
* <pre>$handle->image_max_width = 200;</pre></li>
* <li><b>image_max_height</b> if set to a dimension in pixels, the upload will
be invalid if the image height is greater (default: null)<br>
* <pre>$handle->image_max_height = 100;</pre></li>
* <li><b>image_max_pixels</b> if set to a number of pixels, the upload will be
invalid if the image number of pixels is greater (default: null)<br>
* <pre>$handle->image_max_pixels = 50000;</pre></li>
* <li><b>image_max_ratio</b> if set to a aspect ratio (width/height), the uplo
ad will be invalid if the image apect ratio is greater (default: null)<br>
* <pre>$handle->image_max_ratio = 1.5;</pre></li>
* <li><b>image_min_width</b> if set to a dimension in pixels, the upload will
be invalid if the image width is lower (default: null)<br>
* <pre>$handle->image_min_width = 100;</pre></li>
* <li><b>image_min_height</b> if set to a dimension in pixels, the upload will
be invalid if the image height is lower (default: null)<br>
* <pre>$handle->image_min_height = 500;</pre></li>
* <li><b>image_min_pixels</b> if set to a number of pixels, the upload will be
invalid if the image number of pixels is lower (default: null)<br>
* <pre>$handle->image_min_pixels = 20000;</pre></li>
* <li><b>image_min_ratio</b> if set to a aspect ratio (width/height), the uplo
ad will be invalid if the image apect ratio is lower (default: null)<br>
* <pre>$handle->image_min_ratio = 0.5;</pre></li>
* </ul>
* <ul>
* <li><b>image_resize</b> determines is an image will be resized (default: fal
se)<br>
* <pre>$handle->image_resize = true;</pre></li>
* </ul>
* The following variables are used only if {@link image_resize} == true
* <ul>
* <li><b>image_x</b> destination image width (default: 150)<br>
* <pre>$handle->image_x = 100;</pre></li>
* <li><b>image_y</b> destination image height (default: 150)<br>
* <pre>$handle->image_y = 200;</pre></li>
* </ul>
* Use either one of the following
* <ul>
* <li><b>image_ratio</b> if true, resize image conserving the original sizes r
atio, using {@link image_x} AND {@link image_y} as max sizes if true (default: f
alse)<br>
* <pre>$handle->image_ratio = true;</pre></li>
* <li><b>image_ratio_crop</b> if true, resize image conserving the original si
zes ratio, using {@link image_x} AND {@link image_y} as max sizes, and cropping
excedent to fill the space. setting can also be a string, with one or more from
'TBLR', indicating which side of the image will be kept while cropping (default:
false)<br>
* <pre>$handle->image_ratio_crop = true;</pre></li>
* <li><b>image_ratio_fill</b> if true, resize image conserving the original si
zes ratio, using {@link image_x} AND {@link image_y} as max sizes, fitting the i
mage in the space and coloring the remaining space. setting can also be a string
, with one or more from 'TBLR', indicating which side of the space the image wil
l be in (default: false)<br>
* <pre>$handle->image_ratio_fill = true;</pre></li>
* <li><b>image_ratio_no_zoom_in</b> same as {@link image_ratio}, but won't res
ize if the source image is smaller than {@link image_x} x {@link image_y} (defau
lt: false)<br>
* <pre>$handle->image_ratio_no_zoom_in = true;</pre></li>
* <li><b>image_ratio_no_zoom_out</b> same as {@link image_ratio}, but won't re
size if the source image is bigger than {@link image_x} x {@link image_y} (defau
lt: false)<br>
* <pre>$handle->image_ratio_no_zoom_out = true;</pre></li>
* <li><b>image_ratio_x</b> if true, resize image, calculating {@link image_x}
from {@link image_y} and conserving the original sizes ratio (default: false)<br
>
* <pre>$handle->image_ratio_x = true;</pre></li>
* <li><b>image_ratio_y</b> if true, resize image, calculating {@link image_y}
from {@link image_x} and conserving the original sizes ratio (default: false)<br
>
* <pre>$handle->image_ratio_y = true;</pre></li>
* <li><b>image_ratio_pixels</b> if set to a long integer, resize image, calcul
ating {@link image_y} and {@link image_x} to match a the number of pixels (defau
lt: false)<br>
* <pre>$handle->image_ratio_pixels = 25000;</pre></li>
* </ul>
* The following image manipulations require GD2+
* <ul>
* <li><b>image_brightness</b> if set, corrects the brightness. value between -
127 and 127 (default: null)<br>
* <pre>$handle->image_brightness = 40;</pre></li>
* <li><b>image_contrast</b> if set, corrects the contrast. value between -127
and 127 (default: null)<br>
* <pre>$handle->image_contrast = 50;</pre></li>
* <li><b>image_tint_color</b> if set, will tint the image with a color, value
as hexadecimal #FFFFFF (default: null)<br>
* <pre>$handle->image_tint_color = '#FF0000';</pre></li>
* <li><b>image_overlay_color</b> if set, will add a colored overlay, value as
hexadecimal #FFFFFF (default: null)<br>
* <pre>$handle->image_overlay_color = '#FF0000';</pre></li>
* <li><b>image_overlay_percent</b> used when {@link image_overlay_color} is se
t, determines the opacity (default: 50)<br>
* <pre>$handle->image_overlay_percent = 20;</pre></li>
* <li><b>image_negative</b> inverts the colors in the image (default: false)<b
r>
* <pre>$handle->image_negative = true;</pre></li>
* <li><b>image_greyscale</b> transforms an image into greyscale (default: fals
e)<br>
* <pre>$handle->image_greyscale = true;</pre></li>
* <li><b>image_threshold</b> applies a threshold filter. value between -127 an
d 127 (default: null)<br>
* <pre>$handle->image_threshold = 20;</pre></li>
* </ul>
* <ul>
* <li><b>image_text</b> creates a text label on the image, value is a string,
with eventual replacement tokens (default: null)<br>
* <pre>$handle->image_text = 'test';</pre></li>
* <li><b>image_text_direction</b> text label direction, either 'h' horizontal
or 'v' vertical (default: 'h')<br>
* <pre>$handle->image_text_direction = 'v';</pre></li>
* <li><b>image_text_color</b> text color for the text label, in hexadecimal (d
efault: #FFFFFF)<br>
* <pre>$handle->image_text_color = '#FF0000';</pre></li>
* <li><b>image_text_percent</b> text opacity on the text label, integer betwee
n 0 and 100 (default: 100)<br>
* <pre>$handle->image_text_percent = 50;</pre></li>
* <li><b>image_text_background</b> text label background color, in hexadecimal
(default: null)<br>
* <pre>$handle->image_text_background = '#FFFFFF';</pre></li>
* <li><b>image_text_background_percent</b> text label background opacity, inte
ger between 0 and 100 (default: 100)<br>
* <pre>$handle->image_text_background_percent = 50;</pre></li>
* <li><b>image_text_font</b> built-in font for the text label, from 1 to 5. 1
is the smallest (default: 5)<br>
* <pre>$handle->image_text_font = 4;</pre></li>
* <li><b>image_text_x</b> absolute text label position, in pixels from the lef
t border. can be negative (default: null)<br>
* <pre>$handle->image_text_x = 5;</pre></li>
* <li><b>image_text_y</b> absolute text label position, in pixels from the top
border. can be negative (default: null)<br>
* <pre>$handle->image_text_y = 5;</pre></li>
* <li><b>image_text_position</b> text label position withing the image, a comb
ination of one or two from 'TBLR': top, bottom, left, right (default: null)<br>
* <pre>$handle->image_text_position = 'LR';</pre></li>
* <li><b>image_text_padding</b> text label padding, in pixels. can be overridd
en by {@link image_text_padding_x} and {@link image_text_padding_y} (default: 0)
<br>
* <pre>$handle->image_text_padding = 5;</pre></li>
* <li><b>image_text_padding_x</b> text label horizontal padding (default: null
)<br>
* <pre>$handle->image_text_padding_x = 2;</pre></li>
* <li><b>image_text_padding_y</b> text label vertical padding (default: null)<
br>
* <pre>$handle->image_text_padding_y = 10;</pre></li>
* <li><b>image_text_alignment</b> text alignment when text has multiple lines,
either 'L', 'C' or 'R' (default: 'C')<br>
* <pre>$handle->image_text_alignment = 'R';</pre></li>
* <li><b>image_text_line_spacing</b> space between lines in pixels, when text
has multiple lines (default: 0)<br>
* <pre>$handle->image_text_line_spacing = 3;</pre></li>
* </ul>
* <ul>
* <li><b>image_flip</b> flips image, wither 'h' horizontal or 'v' vertical (de
fault: null)<br>
* <pre>$handle->image_flip = 'h';</pre></li>
* <li><b>image_rotate</b> rotates image. possible values are 90, 180 and 270 (
default: null)<br>
* <pre>$handle->image_rotate = 90;</pre></li>
* <li><b>image_crop</b> crops image. accepts 4, 2 or 1 values as 'T R B L' or
'TB LR' or 'TBLR'. dimension can be 20, or 20px or 20% (default: null)<br>
* <pre>$handle->image_crop = array(50,40,30,20); OR '-20 20%'...</pre></li>
* <li><b>image_precrop</b> crops image, before an eventual resizing. accepts 4
, 2 or 1 values as 'T R B L' or 'TB LR' or 'TBLR'. dimension can be 20, or 20px
or 20% (default: null)<br>
* <pre>$handle->image_precrop = array(50,40,30,20); OR '-20 20%'...</pre></li>
* </ul>
* <ul>
* <li><b>image_bevel</b> adds a bevel border to the image. value is thickness
in pixels (default: null)<br>
* <pre>$handle->image_bevel = 20;</pre></li>
* <li><b>image_bevel_color1</b> top and left bevel color, in hexadecimal (defa
ult: #FFFFFF)<br>
* <pre>$handle->image_bevel_color1 = '#FFFFFF';</pre></li>
* <li><b>image_bevel_color2</b> bottom and right bevel color, in hexadecimal (
default: #000000)<br>
* <pre>$handle->image_bevel_color2 = '#000000';</pre></li>
* <li><b>image_border</b> adds a unicolor border to the image. accepts 4, 2 or
1 values as 'T R B L' or 'TB LR' or 'TBLR'. dimension can be 20, or 20px or 20%
(default: null)<br>
* <pre>$handle->image_border = '3px'; OR '-20 20%' OR array(3,2)...</pre></li>
* <li><b>image_border_color</b> border color, in hexadecimal (default: #FFFFFF
)<br>
* <pre>$handle->image_border_color = '#FFFFFF';</pre></li>
* <li><b>image_frame</b> type of frame: 1=flat 2=crossed (default: null)<br>
* <pre>$handle->image_frame = 2;</pre></li>
* <li><b>image_frame_colors</b> list of hex colors, in an array or a space sep
arated string (default: '#FFFFFF #999999 #666666 #000000')<br>
* <pre>$handle->image_frame_colors = array('#999999', '#FF0000', '#666666', '
#333333', '#000000');</pre></li>
* </ul>
* <ul>
* <li><b>image_watermark</b> adds a watermark on the image, value is a local f
ilename. accepted files are GIF, JPG, BMP, PNG and PNG alpha (default: null)<br>
* <pre>$handle->image_watermark = 'watermark.png';</pre></li>
* <li><b>image_watermark_x</b> absolute watermark position, in pixels from the
left border. can be negative (default: null)<br>
* <pre>$handle->image_watermark_x = 5;</pre></li>
* <li><b>image_watermark_y</b> absolute watermark position, in pixels from the
top border. can be negative (default: null)<br>
* <pre>$handle->image_watermark_y = 5;</pre></li>
* <li><b>image_watermark_position</b> watermark position withing the image, a
combination of one or two from 'TBLR': top, bottom, left, right (default: null)<
br>
* <pre>$handle->image_watermark_position = 'LR';</pre></li>
* </ul>
* <ul>
* <li><b>image_reflection_height</b> if set, a reflection will be added. Forma
t is either in pixels or percentage, such as 40, '40', '40px' or '40%' (default:
null)<br>
* <pre>$handle->image_reflection_height = '25%';</pre></li>
* <li><b>image_reflection_space</b> space in pixels between the source image a
nd the reflection, can be negative (default: null)<br>
* <pre>$handle->image_reflection_space = 3;</pre></li>
* <li><b>image_reflection_color</b> reflection background color, in hexadecima
l. Now deprecated in favor of {@link image_default_color} (default: #FFFFFF)<br>
* <pre>$handle->image_default_color = '#000000';</pre></li>
* <li><b>image_reflection_opacity</b> opacity level at which the reflection st
arts, integer between 0 and 100 (default: 60)<br>
* <pre>$handle->image_reflection_opacity = 60;</pre></li>
* </ul>
*
* <b>Values that can be read before calling {@link process}()</b>
* <ul>
* <li><b>file_src_name</b> Source file name</li>
* <li><b>file_src_name_body</b> Source file name body</li>
* <li><b>file_src_name_ext</b> Source file extension</li>
* <li><b>file_src_pathname</b> Source file complete path and name</li>
* <li><b>file_src_mime</b> Source file mime type</li>
* <li><b>file_src_size</b> Source file size in bytes</li>
* <li><b>file_src_error</b> Upload error code</li>
* <li><b>file_is_image</b> Boolean flag, true if the file is a supported image
type</li>
* </ul>
* If the file is a supported image type (and <i>open_basedir</i> restrictions a
llow it)
* <ul>
* <li><b>image_src_x</b> Source file width in pixels</li>
* <li><b>image_src_y</b> Source file height in pixels</li>
* <li><b>image_src_pixels</b> Source file number of pixels</li>
* <li><b>image_src_type</b> Source file type (png, jpg, gif or bmp)</li>
* <li><b>image_src_bits</b> Source file color depth</li>
* </ul>
*
* <b>Values that can be read after calling {@link process}()</b>
* <ul>
* <li><b>file_dst_path</b> Destination file path</li>
* <li><b>file_dst_name_body</b> Destination file name body</li>
* <li><b>file_dst_name_ext</b> Destination file extension</li>
* <li><b>file_dst_name</b> Destination file name</li>
* <li><b>file_dst_pathname</b> Destination file complete path and name</li>
* </ul>
* If the file is a supported image type
* <ul>
* <li><b>image_dst_x</b> Destination file width</li>
* <li><b>image_dst_y</b> Destination file height</li>
* <li><b>image_convert</b> Destination file format</li>
* </ul>
*
* <b>Requirements</b>
*
* Most of the image operations require GD. GD2 is greatly recommended
*
* The class is compatible with PHP 4.3+, and compatible with PHP5
*
* <b>Changelog</b>
* <ul>
* <li><b>v 0.27</b> 14/05/2009<br>
* - look for the language files directory from __FILE__<br>
* - deactivate {@link file_auto_rename} if {@link file_overwrite} is set<br>
* - improved transparency replacement for true color images<br>
* - fixed calls to newer version of UNIX file utility<br>
* - fixed error when using PECL Fileinfo extension in SAFE MODE, and when usi
ng the finfo class<br>
* - added {@link image_precrop} to crop the image before an eventual resizing
</li>
* <li><b>v 0.26</b> 13/11/2008<br>
* - rewrote conversion from palette to true color to handle transparency bett
er<br>
* - fixed imagecopymergealpha() when the overlayed image is of wrong dimensio
ns<br>
* - fixed imagecreatenew() when the image to create have less than 1 pixels w
idth or height<br>
* - rewrote MIME type detection to be more secure and not rely on browser inf
ormation; now using Fileinfo PECL extension, UNIX file() command, MIME magic, an
d getimagesize(), in that order<br>
* - added support for Flash uploaders<br>
* - some bug fixing and error handling</li>
* <li><b>v 0.25</b> 17/11/2007<br>
* - added translation files and mechanism to instantiate the class with a lan
guage different from English<br>
* - added {@link forbidden} to set an array of forbidden MIME types<br>
* - implemented support for simple wildcards in {@link allowed} and {@link fo
rbidden}, such as image/*<br>
* - preset the file extension to the desired conversion format when convertin
g an image<br>
* - added read and write support for BMP images<br>
* - added a flag {@link file_is_image} to determine if the file is a supporte
d image type<br>
* - the class now provides some information about the image, before calling {
@link process}(). Available are {@link image_src_x}, {@link image_src_y} and the
newly introduced {@link image_src_bits}, {@link image_src_pixels} and {@link im
age_src_type}. Note that this will not work if <i>open_basedir</i> restrictions
are in place<br>
* - improved logging; now provides useful system information<br>
* - added some more pre-processing checks for files that are images: {@link i
mage_max_width}, {@link image_max_height}, {@link image_max_pixels}, {@link imag
e_max_ratio}, {@link image_min_width}, {@link image_min_height}, {@link image_mi
n_pixels} and {@link image_min_ratio}<br>
* - added {@link image_ratio_pixels} to resize an image to a number of pixels
, keeping aspect ratio<br>
* - added {@link image_is_palette} and {@link image_is_transparent} and {@lin
k image_transparent_color} for GIF images<br>
* - added {@link image_default_color} to define a fallback color for non alph
a-transparent output formats, such as JPEG or BMP<br>
* - changed {@link image_background_color}, which now forces transparent area
s to be painted<br>
* - improved reflections and color overlays so that it works with alpha trans
parent images<br>
* - {@link image_reflection_color} is now deprecated in favour of {@link imag
e_default_color}<br />
* - transparent PNGs are now processed in true color, and fully preserving th
e alpha channel when doing merges<br>
* - transparent GIFs are now automatically detected. {@link preserve_transpar
ency} is deprecated<br>
* - transparent true color images can be saved as GIF while retaining transpa
rency, semi transparent areas being merged with {@link image_default_color}<br>
* - transparent true color images can be saved as JPG/BMP with the semi trans
parent areas being merged with {@link image_default_color}<br>
* - fixed conversion of images to true color<br>
* - the class can now output the uploaded files content as the return value o
f process() if the function is called with an empty or null argumenti, or no arg
ument</li>
* <li><b>v 0.24</b> 25/05/2007<br>
* - added {@link image_background_color}, to set the default background color
of an image<br>
* - added possibility of using replacement tokens in text labels<br>
* - changed default JPEG quality to 85<br>
* - fixed a small bug when using greyscale filter and associated filters<br>
* - added {@link image_ratio_fill} in order to fit an image within some dimen
sions and color the remaining space. Very similar to {@link image_ratio_crop}<br
>
* - improved the recursive creation of directories<br>
* - the class now converts palette based images to true colors before doing g
raphic manipulations</li>
* <li><b>v 0.23</b> 23/12/2006<br>
* - fixed a bug when processing more than once the same uploaded file. If the
re is an open_basedir restriction, the class now creates a temporary file for th
e first call to process(). This file will be used for subsequent processes, and
will be deleted upon calling clean()</li>
* <li><b>v 0.22</b> 16/12/2006<br>
* - added automatic creation of a temporary file if the upload directory is n
ot within open_basedir<br>
* - fixed a bug which was preventing to work on a local file by overwriting i
t with its processed copy<br>
* - added MIME types video/x-ms-wmv and image/x-png and fixed PNG support for
IE weird MIME types<br>
* - modified {@link image_ratio_crop} so it can accept one or more from strin
g 'TBLR', determining which side of the image is kept while cropping<br>
* - added support for multiple lines in the text, using "\n" as a line break<
br>
* - added {@link image_text_line_spacing} which allow to set the space betwee
n several lines of text<br>
* - added {@link image_text_alignment} which allow to set the alignment when
text has several lines<br>
* - {@link image_text_font} can now be set to the path of a GDF font to load
external fonts<br>
* - added {@link image_reflection_height} to create a reflection of the sourc
e image, which height is in pixels or percentage<br>
* - added {@link image_reflection_space} to set the space in pixels between t
he source image and the reflection<br>
* - added {@link image_reflection_color} to set the reflection background col
or<br>
* - added {@link image_reflection_opacity} to set the initial level of opacit
y of the reflection</li>
* <li><b>v 0.21</b> 30/09/2006<br>
* - added {@link image_ratio_crop} which resizes within {@link image_x} and {
@link image_y}, keeping ratio, but filling the space by cropping excedent of ima
ge<br>
* - added {@link mime_check}, which default is true, to set checks against {@
link allowed} MIME list<br>
* - if MIME is empty, the class now triggers an error<br>
* - color #000000 is OK for {@link image_text_color}, and related text transp
arency bug fixed<br>
* - {@link gd_version}() now uses gd_info(), or else phpinfo()<br>
* - fixed path issue when the destination path has no trailing slash on Windo
ws systems <br>
* - removed inline functions to be fully PHP5 compatible </li>
* <li><b>v 0.20</b> 11/08/2006<br>
* - added some more error checking and messages (GD presence, permissions...)
<br>
* - fix when uploading files without extension<br>
* - changed values for {@link image_brightness} and {@link image_contrast} to
be between -127 and 127<br>
* - added {@link dir_auto_create} to automatically and recursively create des
tination directory if missing.<br>
* - added {@link dir_auto_chmod} to automatically chmod the destination direc
tory if not writeable.<br>
* - added {@link dir_chmod} to set the default chmod to use.<br>
* - added {@link image_crop} to crop images<br>
* - added {@link image_negative} to invert the colors on the image<br>
* - added {@link image_greyscale} to turn the image into greyscale<br>
* - added {@link image_threshold} to apply a threshold filter on the image<br
>
* - added {@link image_bevel}, {@link image_bevel_color1} and {@link image_be
vel_color2} to add a bevel border<br>
* - added {@link image_border} and {@link image_border_color} to add a single
color border<br>
* - added {@link image_frame} and {@link image_frame_colors} to add a multico
lored frame</li>
* <li><b>v 0.19</b> 29/03/2006<br>
* - class is now compatible i18n (thanks Sylwester).<br>
* - the class can mow manipulate local files, not only uploaded files (instan
ciate the class with a local filename).<br>
* - {@link file_safe_name} has been improved a bit.<br>
* - added {@link image_brightness}, {@link image_contrast}, {@link image_tint
_color}, {@link image_overlay_color} and {@link image_overlay_percent} to do col
or manipulation on the images.<br>
* - added {@link image_text} and all derivated settings to add a text label o
n the image.<br>
* - added {@link image_watermark} and all derivated settings to add a waterma
rk image on the image.<br>
* - added {@link image_flip} and {@link image_rotate} for more image manipula
tions<br>
* - added {@link jpeg_size} to calculate the JPG compression quality in order
to fit within one filesize.</li>
* <li><b>v 0.18</b> 02/02/2006<br>
* - added {@link no_script} to turn dangerous scripts into text files.<br>
* - added {@link mime_magic_check} to set the class to use mime_magic.<br>
* - added {@link preserve_transparency} *experimental*. Thanks Gregor.<br>
* - fixed size and mime checking, wasn't working :/ Thanks Willem.<br>
* - fixed memory leak when resizing images.<br>
* - when resizing, it is not necessary anymore to set {@link image_convert}.<
br>
* - il is now possible to simply convert an image, with no resizing.<br>
* - sets the default {@link file_max_size} to upload_max_filesize from php.in
i. Thanks Edward</li>
* <li><b>v 0.17</b> 28/05/2005<br>
* - the class can be used with any version of GD.<br>
* - added security check on the file with a list of mime-types.<br>
* - changed the license to GPL v2 only</li>
* <li><b>v 0.16</b> 19/05/2005<br>
* - added {@link file_auto_rename} automatic file renaming if the same filena
me already exists.<br>
* - added {@link file_safe_name} safe formatting of the filename (spaces to _
underscores so far).<br>
* - added some more error reporting to avoid crash if GD is not present</li>
* <li><b>v 0.15</b> 16/04/2005<br>
* - added JPEG compression quality setting. Thanks Vad</li>
* <li><b>v 0.14</b> 14/03/2005<br>
* - reworked the class file to allow parsing with phpDocumentor</li>
* <li><b>v 0.13</b> 07/03/2005<br>
* - fixed a bug with {@link image_ratio}. Thanks Justin.<br>
* - added {@link image_ratio_no_zoom_in} and {@link image_ratio_no_zoom_out}
</li>
* <li><b>v 0.12</b> 21/01/2005<br>
* - added {@link image_ratio} to resize within max values, keeping image rati
o</li>
* <li><b>v 0.11</b> 22/08/2003<br>
* - update for GD2 (changed imageresized() into imagecopyresampled() and imag
ecreate() into imagecreatetruecolor())</li>
* </ul>
*
* @package cmf
* @subpackage external
*/
class upload {
/**
* Class version
*
* @access public
* @var string
*/
var $version;
/**
* Uploaded file name
*
* @access public
* @var string
*/
var $file_src_name;
/**
* Uploaded file name body (i.e. without extension)
*
* @access public
* @var string
*/
var $file_src_name_body;
/**
* Uploaded file name extension
*
* @access public
* @var string
*/
var $file_src_name_ext;
/**
* Uploaded file MIME type
*
* @access public
* @var string
*/
var $file_src_mime;
/**
* Uploaded file size, in bytes
*
* @access public
* @var double
*/
var $file_src_size;
/**
* Holds eventual PHP error code from $_FILES
*
* @access public
* @var string
*/
var $file_src_error;
/**
* Uloaded file name, including server path
*
* @access private
* @var string
*/
var $file_src_pathname;
/**
* Uloaded file name temporary copy
*
* @access private
* @var string
*/
var $file_src_temp;
/**
* Destination file name
*
* @access private
* @var string
*/
var $file_dst_path;
/**
* Destination file name
*
* @access public
* @var string
*/
var $file_dst_name;
/**
* Destination file name body (i.e. without extension)
*
* @access public
* @var string
*/
var $file_dst_name_body;
/**
* Destination file extension
*
* @access public
* @var string
*/
var $file_dst_name_ext;
/**
* Destination file name, including path
*
* @access private
* @var string
*/
var $file_dst_pathname;
/**
* Source image width
*
* @access private
* @var integer
*/
var $image_src_x;
/**
* Source image height
*
* @access private
* @var integer
*/
var $image_src_y;
/**
* Source image color depth
*
* @access private
* @var integer
*/
var $image_src_bits;
/**
* Number of pixels
*
* @access private
* @var long
*/
var $image_src_pixels;
/**
* Type of image (png, gif, jpg or bmp)
*
* @access private
* @var string
*/
var $image_src_type;
/**
* Destination image width
*
* @access private
* @var integer
*/
var $image_dst_x;
/**
* Destination image height
*
* @access private
* @var integer
*/
var $image_dst_y;
/**
* Supported image formats
*
* @access private
* @var array
*/
var $image_supported;
/**
* Flag to determine if the source file is an image
*
* @access private
* @var boolean
*/
var $file_is_image;
/**
* Flag set after instanciating the class
*
* Indicates if the file has been uploaded properly
*
* @access public
* @var bool
*/
var $uploaded;
/**
* Flag stopping PHP upload checks
*
* Indicates whether we instanciated the class with a filename, in which cas
e
* we will not check on the validity of the PHP *upload*
*
* This flag is automatically set to true when working on a local file
*
* Warning: for uploads, this flag MUST be set to false for security reason
*
* @access public
* @var bool
*/
var $no_upload_check;
/**
* Flag set after calling a process
*
* Indicates if the processing, and copy of the resulting file went OK
*
* @access public
* @var bool
*/
var $processed;
/**
* Holds eventual error message in plain english
*
* @access public
* @var string
*/
var $error;
/**
* Holds an HTML formatted log
*
* @access public
* @var string
*/
var $log;
/**
* Set this variable to replace the name body (i.e. without extension)
*
* @access public
* @var string
*/
var $file_new_name_body;
/**
* Set this variable to add a string to the faile name body
*
* @access public
* @var string
*/
var $file_name_body_add;
/**
* Set this variable to change the file extension
*
* @access public
* @var string
*/
var $file_new_name_ext;
/**
* Set this variable to format the filename (spaces changed to _)
*
* @access public
* @var boolean
*/
var $file_safe_name;
/**
* Set this variable to false if you don't want to check the MIME against th
e allowed list
*
* This variable is set to true by default for security reason
*
* @access public
* @var boolean
*/
var $mime_check;
/**
* Set this variable to false if you don't want to turn dangerous scripts in
to simple text files
*
* @access public
* @var boolean
*/
var $no_script;
/**
* Set this variable to true to allow automatic renaming of the file
* if the file already exists
*
* Default value is true
*
* For instance, on uploading foo.ext,<br>
* if foo.ext already exists, upload will be renamed foo_1.ext<br>
* and if foo_1.ext already exists, upload will be renamed foo_2.ext<br>
*
* Note that this option doesn't have any effect if {@link file_overwrite} i
s true
*
* @access public
* @var bool
*/
var $file_auto_rename;
/**
* Set this variable to true to allow automatic creation of the destination
* directory if it is missing (works recursively)
*
* Default value is true
*
* @access public
* @var bool
*/
var $dir_auto_create;
/**
* Set this variable to true to allow automatic chmod of the destination
* directory if it is not writeable
*
* Default value is true
*
* @access public
* @var bool
*/
var $dir_auto_chmod;
/**
* Set this variable to the default chmod you want the class to use
* when creating directories, or attempting to write in a directory
*
* Default value is 0777 (without quotes)
*
* @access public
* @var bool
*/
var $dir_chmod;
/**
* Set this variable tu true to allow overwriting of an existing file
*
* Default value is false, so no files will be overwritten
*
* @access public
* @var bool
*/
var $file_overwrite;
/**
* Set this variable to change the maximum size in bytes for an uploaded fil
e
*
* Default value is the value <i>upload_max_filesize</i> from php.ini
*
* @access public
* @var double
*/
var $file_max_size;
/**
* Set this variable to true to resize the file if it is an image
*
* You will probably want to set {@link image_x} and {@link image_y}, and ma
ybe one of the ratio variables
*
* Default value is false (no resizing)
*
* @access public
* @var bool
*/
var $image_resize;
/**
* Set this variable to convert the file if it is an image
*
* Possibles values are : ''; 'png'; 'jpeg'; 'gif'; 'bmp'
*
* Default value is '' (no conversion)<br>
* If {@link resize} is true, {@link convert} will be set to the source file
extension
*
* @access public
* @var string
*/
var $image_convert;
/**
* Set this variable to the wanted (or maximum/minimum) width for the proces
sed image, in pixels
*
* Default value is 150
*
* @access public
* @var integer
*/
var $image_x;
/**
* Set this variable to the wanted (or maximum/minimum) height for the proce
ssed image, in pixels
*
* Default value is 150
*
* @access public
* @var integer
*/
var $image_y;
/**
* Set this variable to keep the original size ratio to fit within {@link im
age_x} x {@link image_y}
*
* Default value is false
*
* @access public
* @var bool
*/
var $image_ratio;
/**
* Set this variable to keep the original size ratio to fit within {@link im
age_x} x {@link image_y}
*
* The image will be resized as to fill the whole space, and excedent will b
e cropped
*
* Value can also be a string, one or more character from 'TBLR' (top, botto
m, left and right)
* If set as a string, it determines which side of the image is kept while c
ropping.
* By default, the part of the image kept is in the center, i.e. it crops eq
ually on both sides
*
* Default value is false
*
* @access public
* @var mixed
*/
var $image_ratio_crop;
/**
* Set this variable to keep the original size ratio to fit within {@link im
age_x} x {@link image_y}
*
* The image will be resized to fit entirely in the space, and the rest will
be colored.
* The default color is white, but can be set with {@link image_default_colo
r}
*
* Value can also be a string, one or more character from 'TBLR' (top, botto
m, left and right)
* If set as a string, it determines in which side of the space the image is
displayed.
* By default, the image is displayed in the center, i.e. it fills the remai
ning space equally on both sides
*
* Default value is false
*
* @access public
* @var mixed
*/
var $image_ratio_fill;
/**
* Set this variable to a number of pixels so that {@link image_x} and {@lin
k image_y} are the best match possible
*
* The image will be resized to have approximatively the number of pixels
* The aspect ratio wil be conserved
*
* Default value is false
*
* @access public
* @var mixed
*/
var $image_ratio_pixels;
/**
* Set this variable to keep the original size ratio to fit within {@link im
age_x} x {@link image_y},
* but only if original image is bigger
*
* Default value is false
*
* @access public
* @var bool
*/
var $image_ratio_no_zoom_in;
/**
* Set this variable to keep the original size ratio to fit within {@link im
age_x} x {@link image_y},
* but only if original image is smaller
*
* Default value is false
*
* @access public
* @var bool
*/
var $image_ratio_no_zoom_out;
/**
* Set this variable to calculate {@link image_x} automatically , using {@li
nk image_y} and conserving ratio
*
* Default value is false
*
* @access public
* @var bool
*/
var $image_ratio_x;
/**
* Set this variable to calculate {@link image_y} automatically , using {@li
nk image_x} and conserving ratio
*
* Default value is false
*
* @access public
* @var bool
*/
var $image_ratio_y;
/**
* Set this variable to set a maximum image width, above which the upload wi
ll be invalid
*
* Default value is null
*
* @access public
* @var integer
*/
var $image_max_width;
/**
* Set this variable to set a maximum image height, above which the upload w
ill be invalid
*
* Default value is null
*
* @access public
* @var integer
*/
var $image_max_height;
/**
* Set this variable to set a maximum number of pixels for an image, above w
hich the upload will be invalid
*
* Default value is null
*
* @access public
* @var long
*/
var $image_max_pixels;
/**
* Set this variable to set a maximum image aspect ratio, above which the up
load will be invalid
*
* Note that ratio = width / height
*
* Default value is null
*
* @access public
* @var float
*/
var $image_max_ratio;
/**
* Set this variable to set a minimum image width, below which the upload wi
ll be invalid
*
* Default value is null
*
* @access public
* @var integer
*/
var $image_min_width;
/**
* Set this variable to set a minimum image height, below which the upload w
ill be invalid
*
* Default value is null
*
* @access public
* @var integer
*/
var $image_min_height;
/**
* Set this variable to set a minimum number of pixels for an image, below w
hich the upload will be invalid
*
* Default value is null
*
* @access public
* @var long
*/
var $image_min_pixels;
/**
* Set this variable to set a minimum image aspect ratio, below which the up
load will be invalid
*
* Note that ratio = width / height
*
* Default value is null
*
* @access public
* @var float
*/
var $image_min_ratio;
/**
* Quality of JPEG created/converted destination image
*
* Default value is 85
*
* @access public
* @var integer
*/
var $jpeg_quality;
/**
* Determines the quality of the JPG image to fit a desired file size
*
* Value is in bytes. The JPG quality will be set between 1 and 100%
* The calculations are approximations.
*
* Default value is null (no calculations)
*
* @access public
* @var integer
*/
var $jpeg_size;
/**
* Preserve transparency when resizing or converting an image (deprecated)
*
* Default value is automatically set to true for transparent GIFs
* This setting is now deprecated
*
* @access public
* @var integer
*/
var $preserve_transparency;
/**
* Flag set to true when the image is transparent
*
* This is actually used only for transparent GIFs
*
* @access public
* @var boolean
*/
var $image_is_transparent;
/**
* Transparent color in a palette
*
* This is actually used only for transparent GIFs
*
* @access public
* @var boolean
*/
var $image_transparent_color;
/**
* Background color, used to paint transparent areas with
*
* If set, it will forcibly remove transparency by painting transparent area
s with the color
* This setting will fill in all transparent areas in PNG and GIF, as oppose
d to {@link image_default_color}
* which will do so only in BMP, JPEG, and alpha transparent areas in transp
arent GIFs
* This setting overrides {@link image_default_color}
*
* Default value is null
*
* @access public
* @var string
*/
var $image_background_color;
/**
* Default color for non alpha-transparent images
*
* This setting is to be used to define a background color for semi transpar
ent areas
* of an alpha transparent when the output format doesn't support alpha tran
sparency
* This is useful when, from an alpha transparent PNG image, or an image wit
h alpha transparent features
* if you want to output it as a transparent GIFs for instance, you can set
a blending color for transparent areas
* If you output in JPEG or BMP, this color will be used to fill in the prev
iously transparent areas
*
* The default color white
*
* @access public
* @var boolean
*/
var $image_default_color;
/**
* Flag set to true when the image is not true color
*
* @access public
* @var boolean
*/
var $image_is_palette;
/**
* Corrects the image brightness
*
* Value can range between -127 and 127
*
* Default value is null
*
* @access public
* @var integer
*/
var $image_brightness;
/**
* Corrects the image contrast
*
* Value can range between -127 and 127
*
* Default value is null
*
* @access public
* @var integer
*/
var $image_contrast;
/**
* Applies threshold filter
*
* Value can range between -127 and 127
*
* Default value is null
*
* @access public
* @var integer
*/
var $image_threshold;
/**
* Applies a tint on the image
*
* Value is an hexadecimal color, such as #FFFFFF
*
* Default value is null
*
* @access public
* @var string;
*/
var $image_tint_color;
/**
* Applies a colored overlay on the image
*
* Value is an hexadecimal color, such as #FFFFFF
*
* To use with {@link image_overlay_percent}
*
* Default value is null
*
* @access public
* @var string;
*/
var $image_overlay_color;
/**
* Sets the percentage for the colored overlay
*
* Value is a percentage, as an integer between 0 and 100
*
* Unless used with {@link image_overlay_color}, this setting has no effect
*
* Default value is 50
*
* @access public
* @var integer
*/
var $image_overlay_percent;
/**
* Inverts the color of an image
*
* Default value is FALSE
*
* @access public
* @var boolean;
*/
var $image_negative;
/**
* Turns the image into greyscale
*
* Default value is FALSE
*
* @access public
* @var boolean;
*/
var $image_greyscale;
/**
* Adds a text label on the image
*
* Value is a string, any text. Text will not word-wrap, although you can us
e breaklines in your text "\n"
*
* If set, this setting allow the use of all other settings starting with im
age_text_
*
* Replacement tokens can be used in the string:
* <pre>
* gd_version src_name src_name_body src_name_ext
* src_pathname src_mime src_x src_y
* src_type src_bits src_pixels
* src_size src_size_kb src_size_mb src_size_human
* dst_path dst_name_body dst_pathname
* dst_name dst_name_ext dst_x dst_y
* date time host server ip
* </pre>
* The tokens must be enclosed in square brackets: [dst_x] will be replaced
by the width of the picture
*
* Default value is null
*
* @access public
* @var string;
*/
var $image_text;
/**
* Sets the text direction for the text label
*
* Value is either 'h' or 'v', as in horizontal and vertical
*
* Default value is h (horizontal)
*
* @access public
* @var string;
*/
var $image_text_direction;
/**
* Sets the text color for the text label
*
* Value is an hexadecimal color, such as #FFFFFF
*
* Default value is #FFFFFF (white)
*
* @access public
* @var string;
*/
var $image_text_color;
/**
* Sets the text visibility in the text label
*
* Value is a percentage, as an integer between 0 and 100
*
* Default value is 100
*
* @access public
* @var integer
*/
var $image_text_percent;
/**
* Sets the text background color for the text label
*
* Value is an hexadecimal color, such as #FFFFFF
*
* Default value is null (no background)
*
* @access public
* @var string;
*/
var $image_text_background;
/**
* Sets the text background visibility in the text label
*
* Value is a percentage, as an integer between 0 and 100
*
* Default value is 100
*
* @access public
* @var integer
*/
var $image_text_background_percent;
/**
* Sets the text font in the text label
*
* Value is a an integer between 1 and 5 for GD built-in fonts. 1 is the sma
llest font, 5 the biggest
* Value can also be a string, which represents the path to a GDF font. The
font will be loaded into GD, and used as a built-in font.
*
* Default value is 5
*
* @access public
* @var mixed;
*/
var $image_text_font;
/**
* Sets the text label position within the image
*
* Value is one or two out of 'TBLR' (top, bottom, left, right)
*
* The positions are as following:
* <pre>
* TL T TR
* L R
* BL B BR
* </pre>
*
* Default value is null (centered, horizontal and vertical)
*
* Note that is {@link image_text_x} and {@link image_text_y} are used, this
setting has no effect
*
* @access public
* @var string;
*/
var $image_text_position;
/**
* Sets the text label absolute X position within the image
*
* Value is in pixels, representing the distance between the left of the ima
ge and the label
* If a negative value is used, it will represent the distance between the r
ight of the image and the label
*
* Default value is null (so {@link image_text_position} is used)
*
* @access public
* @var integer
*/
var $image_text_x;
/**
* Sets the text label absolute Y position within the image
*
* Value is in pixels, representing the distance between the top of the imag
e and the label
* If a negative value is used, it will represent the distance between the b
ottom of the image and the label
*
* Default value is null (so {@link image_text_position} is used)
*
* @access public
* @var integer
*/
var $image_text_y;
/**
* Sets the text label padding
*
* Value is in pixels, representing the distance between the text and the la
bel background border
*
* Default value is 0
*
* This setting can be overriden by {@link image_text_padding_x} and {@link
image_text_padding_y}
*
* @access public
* @var integer
*/
var $image_text_padding;
/**
* Sets the text label horizontal padding
*
* Value is in pixels, representing the distance between the text and the le
ft and right label background borders
*
* Default value is null
*
* If set, this setting overrides the horizontal part of {@link image_text_p
adding}
*
* @access public
* @var integer
*/
var $image_text_padding_x;
/**
* Sets the text label vertical padding
*
* Value is in pixels, representing the distance between the text and the to
p and bottom label background borders
*
* Default value is null
*
* If set, his setting overrides the vertical part of {@link image_text_padd
ing}
*
* @access public
* @var integer
*/
var $image_text_padding_y;
/**
* Sets the text alignment
*
* Value is a string, which can be either 'L', 'C' or 'R'
*
* Default value is 'C'
*
* This setting is relevant only if the text has several lines.
*
* @access public
* @var string;
*/
var $image_text_alignment;
/**
* Sets the text line spacing
*
* Value is an integer, in pixels
*
* Default value is 0
*
* This setting is relevant only if the text has several lines.
*
* @access public
* @var integer
*/
var $image_text_line_spacing;
/**
* Sets the height of the reflection
*
* Value is an integer in pixels, or a string which format can be in pixels
or percentage.
* For instance, values can be : 40, '40', '40px' or '40%'
*
* Default value is null, no reflection
*
* @access public
* @var mixed;
*/
var $image_reflection_height;
/**
* Sets the space between the source image and its relection
*
* Value is an integer in pixels, which can be negative
*
* Default value is 2
*
* This setting is relevant only if {@link image_reflection_height} is set
*
* @access public
* @var integer
*/
var $image_reflection_space;
/**
* Sets the color of the reflection background (deprecated)
*
* Value is an hexadecimal color, such as #FFFFFF
*
* Default value is #FFFFFF
*
* This setting is relevant only if {@link image_reflection_height} is set
*
* This setting is now deprecated in favor of {@link image_default_color}
*
* @access public
* @var string;
*/
var $image_reflection_color;
/**
* Sets the initial opacity of the reflection
*
* Value is an integer between 0 (no opacity) and 100 (full opacity).
* The reflection will start from {@link image_reflection_opacity} and end u
p at 0
*
* Default value is 60
*
* This setting is relevant only if {@link image_reflection_height} is set
*
* @access public
* @var integer
*/
var $image_reflection_opacity;
/**
* Flips the image vertically or horizontally
*
* Value is either 'h' or 'v', as in horizontal and vertical
*
* Default value is null (no flip)
*
* @access public
* @var string;
*/
var $image_flip;
/**
* Rotates the image by increments of 45 degrees
*
* Value is either 90, 180 or 270
*
* Default value is null (no rotation)
*
* @access public
* @var string;
*/
var $image_rotate;
/**
* Crops an image
*
* Values are four dimensions, or two, or one (CSS style)
* They represent the amount cropped top, right, bottom and left.
* These values can either be in an array, or a space separated string.
* Each value can be in pixels (with or without 'px'), or percentage (of the
source image)
*
* For instance, are valid:
* <pre>
* $foo->image_crop = 20 OR array(20);
* $foo->image_crop = '20px' OR array('20px');
* $foo->image_crop = '20 40' OR array('20', 40);
* $foo->image_crop = '-20 25%' OR array(-20, '25%');
* $foo->image_crop = '20px 25%' OR array('20px', '25%');
* $foo->image_crop = '20% 25%' OR array('20%', '25%');
* $foo->image_crop = '20% 25% 10% 30%' OR array('20%', '25%', '10%', '30%
');
* $foo->image_crop = '20px 25px 2px 2px' OR array('20px', '25%px', '2px', '
2px');
* $foo->image_crop = '20 25% 40px 10%' OR array(20, '25%', '40px', '10%')
;
* </pre>
*
* If a value is negative, the image will be expanded, and the extra parts w
ill be filled with black
*
* Default value is null (no cropping)
*
* @access public
* @var string OR array;
*/
var $image_crop;
/**
* Crops an image, before an eventual resizing
*
* See {@link image_crop} for valid formats
*
* Default value is null (no cropping)
*
* @access public
* @var string OR array;
*/
var $image_precrop;
/**
* Adds a bevel border on the image
*
* Value is a positive integer, representing the thickness of the bevel
*
* If the bevel colors are the same as the background, it makes a fade out e
ffect
*
* Default value is null (no bevel)
*
* @access public
* @var integer
*/
var $image_bevel;
/**
* Top and left bevel color
*
* Value is a color, in hexadecimal format
* This setting is used only if {@link image_bevel} is set
*
* Default value is #FFFFFF
*
* @access public
* @var string;
*/
var $image_bevel_color1;
/**
* Right and bottom bevel color
*
* Value is a color, in hexadecimal format
* This setting is used only if {@link image_bevel} is set
*
* Default value is #000000
*
* @access public
* @var string;
*/
var $image_bevel_color2;
/**
* Adds a single-color border on the outer of the image
*
* Values are four dimensions, or two, or one (CSS style)
* They represent the border thickness top, right, bottom and left.
* These values can either be in an array, or a space separated string.
* Each value can be in pixels (with or without 'px'), or percentage (of the
source image)
*
* See {@link image_crop} for valid formats
*
* If a value is negative, the image will be cropped.
* Note that the dimensions of the picture will be increased by the borders'
thickness
*
* Default value is null (no border)
*
* @access public
* @var integer
*/
var $image_border;
/**
* Border color
*
* Value is a color, in hexadecimal format.
* This setting is used only if {@link image_border} is set
*
* Default value is #FFFFFF
*
* @access public
* @var string;
*/
var $image_border_color;
/**
* Adds a multi-color frame on the outer of the image
*
* Value is an integer. Two values are possible for now:
* 1 for flat border, meaning that the frame is mirrored horizontally and ve
rtically
* 2 for crossed border, meaning that the frame will be inversed, as in a be
vel effect
*
* The frame will be composed of colored lines set in {@link image_frame_col
ors}
*
* Note that the dimensions of the picture will be increased by the borders'
thickness
*
* Default value is null (no frame)
*
* @access public
* @var integer
*/
var $image_frame;
/**
* Sets the colors used to draw a frame
*
* Values is a list of n colors in hexadecimal format.
* These values can either be in an array, or a space separated string.
*
* The colors are listed in the following order: from the outset of the imag
e to its center
*
* For instance, are valid:
* <pre>
* $foo->image_frame_colors = '#FFFFFF #999999 #666666 #000000';
* $foo->image_frame_colors = array('#FFFFFF', '#999999', '#666666', '#00000
0');
* </pre>
*
* This setting is used only if {@link image_frame} is set
*
* Default value is '#FFFFFF #999999 #666666 #000000'
*
* @access public
* @var string OR array;
*/
var $image_frame_colors;
/**
* Adds a watermark on the image
*
* Value is a local image filename, relative or absolute. GIF, JPG, BMP and
PNG are supported, as well as PNG alpha.
*
* If set, this setting allow the use of all other settings starting with im
age_watermark_
*
* Default value is null
*
* @access public
* @var string;
*/
var $image_watermark;
/**
* Sets the watermarkposition within the image
*
* Value is one or two out of 'TBLR' (top, bottom, left, right)
*
* The positions are as following: TL T TR
* L R
* BL B BR
*
* Default value is null (centered, horizontal and vertical)
*
* Note that is {@link image_watermark_x} and {@link image_watermark_y} are
used, this setting has no effect
*
* @access public
* @var string;
*/
var $image_watermark_position;
/**
* Sets the watermark absolute X position within the image
*
* Value is in pixels, representing the distance between the top of the imag
e and the watermark
* If a negative value is used, it will represent the distance between the b
ottom of the image and the watermark
*
* Default value is null (so {@link image_watermark_position} is used)
*
* @access public
* @var integer
*/
var $image_watermark_x;
/**
* Sets the twatermark absolute Y position within the image
*
* Value is in pixels, representing the distance between the left of the ima
ge and the watermark
* If a negative value is used, it will represent the distance between the r
ight of the image and the watermark
*
* Default value is null (so {@link image_watermark_position} is used)
*
* @access public
* @var integer
*/
var $image_watermark_y;
/**
* Allowed MIME types
*
* Default is a selection of safe mime-types, but you might want to change i
t
*
* Simple wildcards are allowed, such as image/* or application/*
*
* @access public
* @var array
*/
var $allowed;
/**
* Forbidden MIME types
*
* Default is a selection of safe mime-types, but you might want to change i
t
* To only check for forbidden MIME types, and allow everything else, set {@
link allowed} to array('* / *') without the spaces
*
* Simple wildcards are allowed, such as image/* or application/*
*
* @access public
* @var array
*/
var $forbidden;
/**
* Array of translated error messages
*
* By default, the language is english (en_GB)
* Translations can be in separate files, in a lang/ subdirectory
*
* @access public
* @var array
*/
var $translation;
/**
* Language selected for the translations
*
* By default, the language is english ("en_GB")
*
* @access public
* @var array
*/
var $language;
/**
* Init or re-init all the processing variables to their default values
*
* This function is called in the constructor, and after each call of {@link
process}
*
* @access private
*/
function init() {
// overiddable variables
$this->file_new_name_body = ''; // replace the name body
$this->file_name_body_add = ''; // append to the name body
$this->file_new_name_ext = ''; // replace the file extensio
n
$this->file_safe_name = true; // format safely the filenam
e
$this->file_overwrite = false; // allows overwritting if th
e file already exists
$this->file_auto_rename = true; // auto-rename if the file a
lready exists
$this->dir_auto_create = true; // auto-creates directory if
missing
$this->dir_auto_chmod = true; // auto-chmod directory if n
ot writeable
$this->dir_chmod = 0777; // default chmod to use
$this->mime_check = true; // don't check the mime type
against the allowed list
$this->no_script = true; // turns scripts into test f
iles
$val = trim(ini_get('upload_max_filesize'));
$last = strtolower($val{strlen($val)-1});
switch($last) {
case 'g':
$val *= 1024;
case 'm':
$val *= 1024;
case 'k':
$val *= 1024;
}
$this->file_max_size = $val;
$this->image_resize = false; // resize the image
$this->image_convert = ''; // convert. values :''; 'png
'; 'jpeg'; 'gif'; 'bmp'
$this->image_x = 150;
$this->image_y = 150;
$this->image_ratio = false; // keeps aspect ratio with x
and y dimensions
$this->image_ratio_crop = false; // keeps aspect ratio with x
and y dimensions, filling the space
$this->image_ratio_fill = false; // keeps aspect ratio with x
and y dimensions, fitting the image in the space, and coloring the rest
$this->image_ratio_pixels = false; // keeps aspect ratio, calcu
lating x and y so that the image is approx the set number of pixels
$this->image_ratio_no_zoom_in = false;
$this->image_ratio_no_zoom_out = false;
$this->image_ratio_x = false; // calculate the $image_x if
true
$this->image_ratio_y = false; // calculate the $image_y if
true
$this->jpeg_quality = 85;
$this->jpeg_size = null;
$this->preserve_transparency = false;
$this->image_is_transparent = false;
$this->image_transparent_color = null;
$this->image_background_color = null;
$this->image_default_color = '#ffffff';
$this->image_is_palette = false;
$this->image_max_width = null;
$this->image_max_height = null;
$this->image_max_pixels = null;
$this->image_max_ratio = null;
$this->image_min_width = null;
$this->image_min_height = null;
$this->image_min_pixels = null;
$this->image_min_ratio = null;
$this->image_brightness = null;
$this->image_contrast = null;
$this->image_threshold = null;
$this->image_tint_color = null;
$this->image_overlay_color = null;
$this->image_overlay_percent = null;
$this->image_negative = false;
$this->image_greyscale = false;
$this->image_text = null;
$this->image_text_direction = null;
$this->image_text_color = '#FFFFFF';
$this->image_text_percent = 100;
$this->image_text_background = null;
$this->image_text_background_percent = 100;
$this->image_text_font = 5;
$this->image_text_x = null;
$this->image_text_y = null;
$this->image_text_position = null;
$this->image_text_padding = 0;
$this->image_text_padding_x = null;
$this->image_text_padding_y = null;
$this->image_text_alignment = 'C';
$this->image_text_line_spacing = 0;
$this->image_reflection_height = null;
$this->image_reflection_space = 2;
$this->image_reflection_color = '#ffffff';
$this->image_reflection_opacity = 60;
$this->image_watermark = null;
$this->image_watermark_x = null;
$this->image_watermark_y = null;
$this->image_watermark_position = null;
$this->image_flip = null;
$this->image_rotate = null;
$this->image_crop = null;
$this->image_precrop = null;
$this->image_bevel = null;
$this->image_bevel_color1 = '#FFFFFF';
$this->image_bevel_color2 = '#000000';
$this->image_border = null;
$this->image_border_color = '#FFFFFF';
$this->image_frame = null;
$this->image_frame_colors = '#FFFFFF #999999 #666666 #000000';
$this->forbidden = array();
$this->allowed = array("application/rar",
"application/x-rar-compressed",
"application/arj",
"application/excel",
"application/gnutar",
"application/octet-stream",
"application/pdf",
"application/powerpoint",
"application/postscript",
"application/plain",
"application/rtf",
"application/vocaltec-media-file",
"application/wordperfect",
"application/x-bzip",
"application/x-bzip2",
"application/x-compressed",
"application/x-excel",
"application/x-gzip",
"application/x-latex",
"application/x-midi",
"application/x-msexcel",
"application/x-rtf",
"application/x-sit",
"application/x-stuffit",
"application/x-shockwave-flash",
"application/x-troff-msvideo",
"application/x-zip-compressed",
"application/xml",
"application/zip",
"application/msword",
"application/mspowerpoint",
"application/vnd.ms-excel",
"application/vnd.ms-powerpoint",
"application/vnd.ms-word",
"application/vnd.ms-word.document.macroEnabled.12
",
"application/vnd.openxmlformats-officedocument.wo
rdprocessingml.document",
"application/vnd.ms-word.template.macroEnabled.12
",
"application/vnd.openxmlformats-officedocument.wo
rdprocessingml.template",
"application/vnd.ms-powerpoint.template.macroEnab
led.12",
"application/vnd.openxmlformats-officedocument.pr
esentationml.template",
"application/vnd.ms-powerpoint.addin.macroEnabled
.12",
"application/vnd.ms-powerpoint.slideshow.macroEna
bled.12",
"application/vnd.openxmlformats-officedocument.pr
esentationml.slideshow",
"application/vnd.ms-powerpoint.presentation.macro
Enabled.12",
"application/vnd.openxmlformats-officedocument.pr
esentationml.presentation",
"application/vnd.ms-excel.addin.macroEnabled.12",
"application/vnd.ms-excel.sheet.binary.macroEnabl
ed.12",
"application/vnd.ms-excel.sheet.macroEnabled.12",
"application/vnd.openxmlformats-officedocument.sp
readsheetml.sheet",
"application/vnd.ms-excel.template.macroEnabled.1
2",
"application/vnd.openxmlformats-officedocument.sp
readsheetml.template",
"audio/*",
"image/*",
"video/*",
"multipart/x-zip",
"multipart/x-gzip",
"text/richtext",
"text/plain",
"text/xml");
}
/**
* Constructor. Checks if the file has been uploaded
*
* The constructor takes $_FILES['form_field'] array as argument
* where form_field is the form field name
*
* The constructor will check if the file has been uploaded in its temporary
location, and
* accordingly will set {@link uploaded} (and {@link error} is an error occu
rred)
*
* If the file has been uploaded, the constructor will populate all the vari
ables holding the upload
* information (none of the processing class variables are used here).
* You can have access to information about the file (name, size, MIME type.
..).
*
*
* Alternatively, you can set the first argument to be a local filename (str
ing)
* This allows processing of a local file, as if the file was uploaded
*
* The optional second argument allows you to set the language for the error
messages
*
* @access private
* @param array $file $_FILES['form_field']
* or string $file Local filename
* @param string $lang Optional language code
*/
function upload($file, $lang = 'en_GB') {
$this->version = '0.27';
$this->file_src_name = '';
$this->file_src_name_body = '';
$this->file_src_name_ext = '';
$this->file_src_mime = '';
$this->file_src_size = '';
$this->file_src_error = '';
$this->file_src_pathname = '';
$this->file_src_temp = '';
$this->file_dst_path = '';
$this->file_dst_name = '';
$this->file_dst_name_body = '';
$this->file_dst_name_ext = '';
$this->file_dst_pathname = '';
$this->image_src_x = null;
$this->image_src_y = null;
$this->image_src_bits = null;
$this->image_src_type = null;
$this->image_src_pixels = null;
$this->image_dst_x = 0;
$this->image_dst_y = 0;
$this->uploaded = true;
$this->no_upload_check = false;
$this->processed = true;
$this->error = '';
$this->log = '';
$this->allowed = array();
$this->forbidden = array();
$this->file_is_image = false;
$this->init();
$info = null;
$mime_from_browser = null;
// sets default language
$this->translation = array();
$this->translation['file_error'] = 'File error. Please
try again.';
$this->translation['local_file_missing'] = 'Local file doesn\'t
exist.';
$this->translation['local_file_not_readable'] = 'Local file is not r
eadable.';
$this->translation['uploaded_too_big_ini'] = 'File upload error (
the uploaded file exceeds the upload_max_filesize directive in php.ini).';
$this->translation['uploaded_too_big_html'] = 'File upload error (
the uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the
html form).';
$this->translation['uploaded_partial'] = 'File upload error (
the uploaded file was only partially uploaded).';
$this->translation['uploaded_missing'] = 'File upload error (
no file was uploaded).';
$this->translation['uploaded_unknown'] = 'File upload error (
unknown error code).';
$this->translation['try_again'] = 'File upload error.
Please try again.';
$this->translation['file_too_big'] = 'File too big.';
$this->translation['no_mime'] = 'MIME type can\'t be
detected.';
$this->translation['incorrect_file'] = 'Incorrect type of f
ile.';
$this->translation['image_too_wide'] = 'Image too wide.';
$this->translation['image_too_narrow'] = 'Image too narrow.';
$this->translation['image_too_high'] = 'Image too high.';
$this->translation['image_too_short'] = 'Image too short.';
$this->translation['ratio_too_high'] = 'Image ratio too hig
h (image too wide).';
$this->translation['ratio_too_low'] = 'Image ratio too low
(image too high).';
$this->translation['too_many_pixels'] = 'Image has too many
pixels.';
$this->translation['not_enough_pixels'] = 'Image has not enoug
h pixels.';
$this->translation['file_not_uploaded'] = 'File not uploaded.
Can\'t carry on a process.';
$this->translation['already_exists'] = '%s already exists.
Please change the file name.';
$this->translation['temp_file_missing'] = 'No correct temp sou
rce file. Can\'t carry on a process.';
$this->translation['source_missing'] = 'No correct uploaded
source file. Can\'t carry on a process.';
$this->translation['destination_dir'] = 'Destination directo
ry can\'t be created. Can\'t carry on a process.';
$this->translation['destination_dir_missing'] = 'Destination directo
ry doesn\'t exist. Can\'t carry on a process.';
$this->translation['destination_path_not_dir'] = 'Destination path is
not a directory. Can\'t carry on a process.';
$this->translation['destination_dir_write'] = 'Destination directo
ry can\'t be made writeable. Can\'t carry on a process.';
$this->translation['destination_path_write'] = 'Destination path is
not a writeable. Can\'t carry on a process.';
$this->translation['temp_file'] = 'Can\'t create the t
emporary file. Can\'t carry on a process.';
$this->translation['source_not_readable'] = 'Source file is not
readable. Can\'t carry on a process.';
$this->translation['no_create_support'] = 'No create from %s s
upport.';
$this->translation['create_error'] = 'Error in creating %
s image from source.';
$this->translation['source_invalid'] = 'Can\'t read image s
ource. Not an image?.';
$this->translation['gd_missing'] = 'GD doesn\'t seem to
be present.';
$this->translation['watermark_no_create_support'] = 'No create from %s s
upport, can\'t read watermark.';
$this->translation['watermark_create_error'] = 'No %s read support,
can\'t create watermark.';
$this->translation['watermark_invalid'] = 'Unknown image forma
t, can\'t read watermark.';
$this->translation['file_create'] = 'No %s create suppor
t.';
$this->translation['no_conversion_type'] = 'No conversion type
defined.';
$this->translation['copy_failed'] = 'Error copying file
on the server. copy() failed.';
$this->translation['reading_failed'] = 'Error reading the f
ile.';
// determines the language
$this->lang = $lang;
if ($this->lang != 'en_GB' && file_exists(dirname(__FILE__).'/lang/class
.upload.' . $lang . '.php')) {
$translation = null;
include(dirname(__FILE__).'/lang/class.upload.' . $lang . '.php');
if (is_array($translation)) {
$this->translation = array_merge($this->translation, $translatio
n);
} else {
$this->lang = 'en_GB';
}
}
/**
* Creates directories recursively
*
* @access private
* @param string $path Path to create
* @param integer $mode Optional permissions
* @return boolean Success
*/
function rmkdir($path, $mode = 0777) {
return is_dir($path) || ( $this->rmkdir(dirname($path), $mode) && $this-
>_mkdir($path, $mode) );
}
/**
* Creates directory
*
* @access private
* @param string $path Path to create
* @param integer $mode Optional permissions
* @return boolean Success
*/
function _mkdir($path, $mode = 0777) {
$old = umask(0);
$res = @mkdir($path, $mode);
umask($old);
return $res;
}
/**
* Translate error messages
*
* @access private
* @param string $str Message to translate
* @param array $tokens Optional token values
* @return string Translated string
*/
function translate($str, $tokens = array()) {
if (array_key_exists($str, $this->translation)) $str = $this->translatio
n[$str];
if (is_array($tokens) && sizeof($tokens) > 0) $str = vsprintf($str, $t
okens);
return $str;
}
/**
* Decodes colors
*
* @access private
* @param string $color Color string
* @return array RGB colors
*/
function getcolors($color) {
$r = sscanf($color, "#%2x%2x%2x");
$red = (array_key_exists(0, $r) && is_numeric($r[0]) ? $r[0] : 0);
$green = (array_key_exists(1, $r) && is_numeric($r[1]) ? $r[1] : 0);
$blue = (array_key_exists(2, $r) && is_numeric($r[2]) ? $r[2] : 0);
return array($red, $green, $blue);
}
/**
* Creates a container image
*
* @access private
* @param integer $x Width
* @param integer $y Height
* @param boolean $fill Optional flag to draw the background color or not
* @param boolean $trsp Optional flag to set the background to be transpar
ent
* @return resource Container image
*/
function imagecreatenew($x, $y, $fill = true, $trsp = false) {
if ($x < 1) $x = 1; if ($y < 1) $y = 1;
if ($this->gdversion() >= 2 && !$this->image_is_palette) {
// create a true color image
$dst_im = imagecreatetruecolor($x, $y);
// this preserves transparency in PNGs, in true color
if (empty($this->image_background_color) || $trsp) {
imagealphablending($dst_im, false );
imagefilledrectangle($dst_im, 0, 0, $x, $y, imagecolorallocateal
pha($dst_im, 0, 0, 0, 127));
}
} else {
// creates a palette image
$dst_im = imagecreate($x, $y);
// preserves transparency for palette images, if the original image
has transparency
if (($fill && $this->image_is_transparent && empty($this->image_back
ground_color)) || $trsp) {
imagefilledrectangle($dst_im, 0, 0, $x, $y, $this->image_transpa
rent_color);
imagecolortransparent($dst_im, $this->image_transparent_color);
}
}
// fills with background color if any is set
if ($fill && !empty($this->image_background_color) && !$trsp) {
list($red, $green, $blue) = $this->getcolors($this->image_background
_color);
$background_color = imagecolorallocate($dst_im, $red, $green, $blue)
;
imagefilledrectangle($dst_im, 0, 0, $x, $y, $background_color);
}
return $dst_im;
}
/**
* Transfers an image from the container to the destination image
*
* @access private
* @param resource $src_im Container image
* @param resource $dst_im Destination image
* @return resource Destination image
*/
function imagetransfer($src_im, $dst_im) {
if (is_resource($dst_im)) imagedestroy($dst_im);
$dst_im = & $src_im;
return $dst_im;
}
/**
* Merges two images
*
* If the output format is PNG, then we do it pixel per pixel to retain the
alpha channel
*
* @access private
* @param resource $dst_img Destination image
* @param resource $src_img Overlay image
* @param int $dst_x x-coordinate of destination point
* @param int $dst_y y-coordinate of destination point
* @param int $src_x x-coordinate of source point
* @param int $src_y y-coordinate of source point
* @param int $src_w Source width
* @param int $src_h Source height
* @param int $pct Optional percentage of the overlay, between 0 a
nd 100 (default: 100)
* @return resource Destination image
*/
function imagecopymergealpha(&$dst_im, &$src_im, $dst_x, $dst_y, $src_x, $sr
c_y, $src_w, $src_h, $pct = 0) {
$dst_x = (int) $dst_x;
$dst_y = (int) $dst_y;
$src_x = (int) $src_x;
$src_y = (int) $src_y;
$src_w = (int) $src_w;
$src_h = (int) $src_h;
$pct = (int) $pct;
$dst_w = imagesx($dst_im);
$dst_h = imagesy($dst_im);
for ($y = $src_y; $y < $src_h; $y++) {
for ($x = $src_x; $x < $src_w; $x++) {
if ($x + $dst_x >= 0 && $x + $dst_x < $dst_w && $x + $src_x >= 0
&& $x + $src_x < $src_w
&& $y + $dst_y >= 0 && $y + $dst_y < $dst_h && $y + $src_y >= 0
&& $y + $src_y < $src_h) {
$dst_pixel = imagecolorsforindex($dst_im, imagecolorat($dst_
im, $x + $dst_x, $y + $dst_y));
$src_pixel = imagecolorsforindex($src_im, imagecolorat($src_
im, $x + $src_x, $y + $src_y));
$src_alpha = 1 - ($src_pixel['alpha'] / 127);
$dst_alpha = 1 - ($dst_pixel['alpha'] / 127);
$opacity = $src_alpha * $pct / 100;
if ($dst_alpha >= $opacity) $alpha = $dst_alpha;
if ($dst_alpha < $opacity) $alpha = $opacity;
if ($alpha > 1) $alpha = 1;
if ($opacity > 0) {
$dst_red = round(( ($dst_pixel['red'] * $dst_alpha *
(1 - $opacity)) ) );
$dst_green = round(( ($dst_pixel['green'] * $dst_alpha *
(1 - $opacity)) ) );
$dst_blue = round(( ($dst_pixel['blue'] * $dst_alpha *
(1 - $opacity)) ) );
$src_red = round((($src_pixel['red'] * $opacity)) );
$src_green = round((($src_pixel['green'] * $opacity)) );
$src_blue = round((($src_pixel['blue'] * $opacity)) );
$red = round(($dst_red + $src_red ) / ($dst_alpha *
(1 - $opacity) + $opacity));
$green = round(($dst_green + $src_green) / ($dst_alpha *
(1 - $opacity) + $opacity));
$blue = round(($dst_blue + $src_blue ) / ($dst_alpha *
(1 - $opacity) + $opacity));
if ($red > 255) $red = 255;
if ($green > 255) $green = 255;
if ($blue > 255) $blue = 255;
$alpha = round((1 - $alpha) * 127);
$color = imagecolorallocatealpha($dst_im, $red, $green,
$blue, $alpha);
imagesetpixel($dst_im, $x + $dst_x, $y + $dst_y, $color)
;
}
}
}
}
return true;
}
/**
* Actually uploads the file, and act on it according to the set processing
class variables
*
* This function copies the uploaded file to the given location, eventually
performing actions on it.
* Typically, you can call {@link process} several times for the same file,
* for instance to create a resized image and a thumbnail of the same file.
* The original uploaded file remains intact in its temporary location, so y
ou can use {@link process} several times.
* You will be able to delete the uploaded file with {@link clean} when you
have finished all your {@link process} calls.
*
* According to the processing class variables set in the calling file, the
file can be renamed,
* and if it is an image, can be resized or converted.
*
* When the processing is completed, and the file copied to its new location
, the
* processing class variables will be reset to their default value.
* This allows you to set new properties, and perform another {@link process
} on the same uploaded file
*
* If the function is called with a null or empty argument, then it will ret
urn the content of the picture
*
* It will set {@link processed} (and {@link error} is an error occurred)
*
* @access public
* @param string $server_path Optional path location of the uploaded file,
with an ending slash
* @return string Optional content of the image
*/
function process($server_path = null) {
$this->error = '';
$this->processed = true;
$return_mode = false;
$return_content = null;
if (empty($server_path) || is_null($server_path)) {
$this->log .= '<b>process file and return the content</b><br />';
$return_mode = true;
} else {
if(strtolower(substr(PHP_OS, 0, 3)) === 'win') {
if (substr($server_path, -1, 1) != '\\') $server_path = $server_
path . '\\';
} else {
if (substr($server_path, -1, 1) != '/') $server_path = $server_p
ath . '/';
}
$this->log .= '<b>process file to ' . $server_path . '</b><br />';
}
// checks file size and mine type
if ($this->uploaded) {
if ($this->file_src_size > $this->file_max_size ) {
$this->processed = false;
$this->error = $this->translate('file_too_big');
} else {
$this->log .= '- file size OK<br />';
}
// turn dangerous scripts into text files
if ($this->no_script) {
if (((substr($this->file_src_mime, 0, 5) == 'text/' || strpos($t
his->file_src_mime, 'javascript') !== false) && (substr($this->file_src_name, -
4) != '.txt'))
|| preg_match('/\.(php|pl|py|cgi|asp)$/i', $this->file_src_n
ame) || empty($this->file_src_name_ext)) {
$this->file_src_mime = 'text/plain';
$this->log .= '- script ' . $this->file_src_name . ' rename
d as ' . $this->file_src_name . '.txt!<br />';
$this->file_src_name_ext .= (empty($this->file_src_name_ext)
? 'txt' : '.txt');
}
}
if ($this->mime_check && empty($this->file_src_mime)) {
$this->processed = false;
$this->error = $this->translate('no_mime');
} else if ($this->mime_check && !empty($this->file_src_mime) && strp
os($this->file_src_mime, '/') !== false) {
list($m1, $m2) = explode('/', $this->file_src_mime);
$allowed = false;
// check wether the mime type is allowed
foreach($this->allowed as $k => $v) {
list($v1, $v2) = explode('/', $v);
if (($v1 == '*' && $v2 == '*') || ($v1 == $m1 && ($v2 == $m2
|| $v2 == '*'))) {
$allowed = true;
break;
}
}
// check wether the mime type is forbidden
foreach($this->forbidden as $k => $v) {
list($v1, $v2) = explode('/', $v);
if (($v1 == '*' && $v2 == '*') || ($v1 == $m1 && ($v2 == $m2
|| $v2 == '*'))) {
$allowed = false;
break;
}
}
if (!$allowed) {
$this->processed = false;
$this->error = $this->translate('incorrect_file');
} else {
$this->log .= '- file mime OK : ' . $this->file_src_mime . '
<br />';
}
} else {
$this->log .= '- file mime OK : ' . $this->file_src_mime . '<br
/>';
}
// if the file is an image, we can check on its dimensions
// these checks are not available if open_basedir restrictions are i
n place
if ($this->file_is_image) {
if (is_numeric($this->image_src_x) && is_numeric($this->image_sr
c_y)) {
$ratio = $this->image_src_x / $this->image_src_y;
if (!is_null($this->image_max_width) && $this->image_src_x >
$this->image_max_width) {
$this->processed = false;
$this->error = $this->translate('image_too_wide');
}
if (!is_null($this->image_min_width) && $this->image_src_x <
$this->image_min_width) {
$this->processed = false;
$this->error = $this->translate('image_too_narrow');
}
if (!is_null($this->image_max_height) && $this->image_src_y
> $this->image_max_height) {
$this->processed = false;
$this->error = $this->translate('image_too_high');
}
if (!is_null($this->image_min_height) && $this->image_src_y
< $this->image_min_height) {
$this->processed = false;
$this->error = $this->translate('image_too_short');
}
if (!is_null($this->image_max_ratio) && $ratio > $this->imag
e_max_ratio) {
$this->processed = false;
$this->error = $this->translate('ratio_too_high');
}
if (!is_null($this->image_min_ratio) && $ratio < $this->imag
e_min_ratio) {
$this->processed = false;
$this->error = $this->translate('ratio_too_low');
}
if (!is_null($this->image_max_pixels) && $this->image_src_pi
xels > $this->image_max_pixels) {
$this->processed = false;
$this->error = $this->translate('too_many_pixels');
}
if (!is_null($this->image_min_pixels) && $this->image_src_pi
xels < $this->image_min_pixels) {
$this->processed = false;
$this->error = $this->translate('not_enough_pixels');
}
} else {
$this->log .= '- no image properties available, can\'t enfor
ce dimension checks : ' . $this->file_src_mime . '<br />';
}
}
} else {
$this->error = $this->translate('file_not_uploaded');
$this->processed = false;
}
if ($this->processed) {
$this->file_dst_path = $server_path;
// repopulate dst variables from src
$this->file_dst_name = $this->file_src_name;
$this->file_dst_name_body = $this->file_src_name_body;
$this->file_dst_name_ext = $this->file_src_name_ext;
if ($this->file_overwrite) $this->file_auto_rename = false;
if ($this->image_convert != '') { // if we convert as an image
$this->file_dst_name_ext = $this->image_convert;
$this->log .= '- new file name ext : ' . $this->image_convert .
'<br />';
}
if ($this->file_new_name_body != '') { // rename file body
$this->file_dst_name_body = $this->file_new_name_body;
$this->log .= '- new file name body : ' . $this->file_new_name_b
ody . '<br />';
}
if ($this->file_new_name_ext != '') { // rename file ext
$this->file_dst_name_ext = $this->file_new_name_ext;
$this->log .= '- new file name ext : ' . $this->file_new_name_ex
t . '<br />';
}
if ($this->file_name_body_add != '') { // append a bit to the name
$this->file_dst_name_body = $this->file_dst_name_body . $this->
file_name_body_add;
$this->log .= '- file name body add : ' . $this->file_name_body_
add . '<br />';
}
if ($this->file_safe_name) { // formats the name
$this->file_dst_name_body = str_replace(array(' ', '-'), array('
_','_'), $this->file_dst_name_body) ;
$this->file_dst_name_body = ereg_replace('[^A-Za-z0-9_]', '', $t
his->file_dst_name_body) ;
$this->log .= '- file name safe format<br />';
}
$this->log .= '- destination variables<br />';
if (empty($this->file_dst_path) || is_null($this->file_dst_path)) {
$this->log .= ' file_dst_path : n
/a<br />';
} else {
$this->log .= ' file_dst_path : '
. $this->file_dst_path . '<br />';
}
$this->log .= ' file_dst_name_body : ' . $
this->file_dst_name_body . '<br />';
$this->log .= ' file_dst_name_ext : ' . $
this->file_dst_name_ext . '<br />';
// do we do some image manipulation?
$image_manipulation = ($this->file_is_image && (
$this->image_resize
|| $this->image_convert != ''
|| is_numeric($this->image_brightness)
|| is_numeric($this->image_contrast)
|| is_numeric($this->image_threshold)
|| !empty($this->image_tint_color)
|| !empty($this->image_overlay_color)
|| !empty($this->image_text)
|| $this->image_greyscale
|| $this->image_negative
|| !empty($this->image_watermark)
|| is_numeric($this->image_rotate)
|| is_numeric($this->jpeg_size)
|| !empty($this->image_flip)
|| !empty($this->image_crop)
|| !empty($this->image_precrop)
|| !empty($this->image_border)
|| $this->image_frame > 0
|| $this->image_bevel > 0
|| $this->image_reflection_height));
if ($image_manipulation) {
if ($this->image_convert=='') {
$this->file_dst_name = $this->file_dst_name_body . (!empty($
this->file_dst_name_ext) ? '.' . $this->file_dst_name_ext : '');
$this->log .= '- image operation, keep extension<br />';
} else {
$this->file_dst_name = $this->file_dst_name_body . '.' . $th
is->image_convert;
$this->log .= '- image operation, change extension for conve
rsion type<br />';
}
} else {
$this->file_dst_name = $this->file_dst_name_body . (!empty($this
->file_dst_name_ext) ? '.' . $this->file_dst_name_ext : '');
$this->log .= '- no image operation, keep extension<br />';
}
if (!$return_mode) {
if (!$this->file_auto_rename) {
$this->log .= '- no auto_rename if same filename exists<br /
>';
$this->file_dst_pathname = $this->file_dst_path . $this->fil
e_dst_name;
} else {
$this->log .= '- checking for auto_rename<br />';
$this->file_dst_pathname = $this->file_dst_path . $this->fil
e_dst_name;
$body = $this->file_dst_name_body;
$cpt = 1;
while (@file_exists($this->file_dst_pathname)) {
$this->file_dst_name_body = $body . '_' . $cpt;
$this->file_dst_name = $this->file_dst_name_body . (!emp
ty($this->file_dst_name_ext) ? '.' . $this->file_dst_name_ext : '');
$cpt++;
$this->file_dst_pathname = $this->file_dst_path . $this-
>file_dst_name;
}
if ($cpt>1) $this->log .= ' auto_rena
me to ' . $this->file_dst_name . '<br />';
}
$this->log .= '- destination file details<br />';
$this->log .= ' file_dst_name : '
. $this->file_dst_name . '<br />';
$this->log .= ' file_dst_pathname : '
. $this->file_dst_pathname . '<br />';
if ($this->file_overwrite) {
$this->log .= '- no overwrite checking<br />';
} else {
if (@file_exists($this->file_dst_pathname)) {
$this->processed = false;
$this->error = $this->translate('already_exists', array(
$this->file_dst_name));
} else {
$this->log .= '- ' . $this->file_dst_name . ' doesn\'t e
xist already<br />';
}
}
}
} else {
$this->processed = false;
}
// if we have already moved the uploaded file, we use the temporary copy
as source file, and check if it exists
if (!empty($this->file_src_temp)) {
$this->log .= '- use the temp file instead of the original file sinc
e it is a second process<br />';
$this->file_src_pathname = $this->file_src_temp;
if (!file_exists($this->file_src_pathname)) {
$this->processed = false;
$this->error = $this->translate('temp_file_missing');
}
// if we haven't a temp file, and that we do check on uploads, we use is
_uploaded_file()
} else if (!$this->no_upload_check) {
if (!is_uploaded_file($this->file_src_pathname)) {
$this->processed = false;
$this->error = $this->translate('source_missing');
}
// otherwise, if we don't check on uploaded files (local file for instan
ce), we use file_exists()
} else {
if (!file_exists($this->file_src_pathname)) {
$this->processed = false;
$this->error = $this->translate('source_missing');
}
}
// checks if the destination directory exists, and attempt to create it
if (!$return_mode) {
if ($this->processed && !file_exists($this->file_dst_path)) {
if ($this->dir_auto_create) {
$this->log .= '- ' . $this->file_dst_path . ' doesn\'t exist
. Attempting creation:';
if (!$this->rmkdir($this->file_dst_path, $this->dir_chmod))
{
$this->log .= ' failed<br />';
$this->processed = false;
$this->error = $this->translate('destination_dir');
} else {
$this->log .= ' success<br />';
}
} else {
$this->error = $this->translate('destination_dir_missing');
}
}
if ($this->processed && !is_dir($this->file_dst_path)) {
$this->processed = false;
$this->error = $this->translate('destination_path_not_dir');
}
// checks if the destination directory is writeable, and attempt to
make it writeable
$hash = md5($this->file_dst_name_body . rand(1, 1000));
if ($this->processed && !($f = @fopen($this->file_dst_path . $hash .
'.' . $this->file_dst_name_ext, 'a+'))) {
if ($this->dir_auto_chmod) {
$this->log .= '- ' . $this->file_dst_path . ' is not writeab
le. Attempting chmod:';
if (!@chmod($this->file_dst_path, $this->dir_chmod)) {
$this->log .= ' failed<br />';
$this->processed = false;
$this->error = $this->translate('destination_dir_write')
;
} else {
$this->log .= ' success<br />';
if (!($f = @fopen($this->file_dst_path . $hash . '.' . $
this->file_dst_name_ext, 'a+'))) { // we re-check
$this->processed = false;
$this->error = $this->translate('destination_dir_wri
te');
} else {
@fclose($f);
}
}
} else {
$this->processed = false;
$this->error = $this->translate('destination_path_write');
}
} else {
if ($this->processed) @fclose($f);
@unlink($this->file_dst_path . $hash . '.' . $this->file_dst_nam
e_ext);
}
/**
* Opens a BMP image
*
* This function has been written by DHKold, and is used with permission of
the author
*
* @access public
*/
function imagecreatefrombmp($filename) {
if (! $f1 = fopen($filename,"rb")) return false;
$file = unpack("vfile_type/Vfile_size/Vreserved/Vbitmap_offset", fread($
f1,14));
if ($file['file_type'] != 19778) return false;
$bmp = unpack('Vheader_size/Vwidth/Vheight/vplanes/vbits_per_pixel'.
'/Vcompression/Vsize_bitmap/Vhoriz_resolution'.
'/Vvert_resolution/Vcolors_used/Vcolors_important', fread(
$f1,40));
$bmp['colors'] = pow(2,$bmp['bits_per_pixel']);
if ($bmp['size_bitmap'] == 0) $bmp['size_bitmap'] = $file['file_size'] -
$file['bitmap_offset'];
$bmp['bytes_per_pixel'] = $bmp['bits_per_pixel']/8;
$bmp['bytes_per_pixel2'] = ceil($bmp['bytes_per_pixel']);
$bmp['decal'] = ($bmp['width']*$bmp['bytes_per_pixel']/4);
$bmp['decal'] -= floor($bmp['width']*$bmp['bytes_per_pixel']/4);
$bmp['decal'] = 4-(4*$bmp['decal']);
if ($bmp['decal'] == 4) $bmp['decal'] = 0;
$palette = array();
if ($bmp['colors'] < 16777216) {
$palette = unpack('V'.$bmp['colors'], fread($f1,$bmp['colors']*4));
}
$im = fread($f1,$bmp['size_bitmap']);
$vide = chr(0);
$res = imagecreatetruecolor($bmp['width'],$bmp['height']);
$P = 0;
$Y = $bmp['height']-1;
while ($Y >= 0) {
$X=0;
while ($X < $bmp['width']) {
if ($bmp['bits_per_pixel'] == 24)
$color = unpack("V",substr($im,$P,3).$vide);
elseif ($bmp['bits_per_pixel'] == 16) {
$color = unpack("n",substr($im,$P,2));
$color[1] = $palette[$color[1]+1];
} elseif ($bmp['bits_per_pixel'] == 8) {
$color = unpack("n",$vide.substr($im,$P,1));
$color[1] = $palette[$color[1]+1];
} elseif ($bmp['bits_per_pixel'] == 4) {
$color = unpack("n",$vide.substr($im,floor($P),1));
if (($P*2)%2 == 0) $color[1] = ($color[1] >> 4) ; else $colo
r[1] = ($color[1] & 0x0F);
$color[1] = $palette[$color[1]+1];
} elseif ($bmp['bits_per_pixel'] == 1) {
$color = unpack("n",$vide.substr($im,floor($P),1));
if (($P*8)%8 == 0) $color[1] = $color[1] >>7;
elseif (($P*8)%8 == 1) $color[1] = ($color[1] & 0x40)>>6;
elseif (($P*8)%8 == 2) $color[1] = ($color[1] & 0x20)>>5;
elseif (($P*8)%8 == 3) $color[1] = ($color[1] & 0x10)>>4;
elseif (($P*8)%8 == 4) $color[1] = ($color[1] & 0x8)>>3;
elseif (($P*8)%8 == 5) $color[1] = ($color[1] & 0x4)>>2;
elseif (($P*8)%8 == 6) $color[1] = ($color[1] & 0x2)>>1;
elseif (($P*8)%8 == 7) $color[1] = ($color[1] & 0x1);
$color[1] = $palette[$color[1]+1];
} else
return FALSE;
imagesetpixel($res,$X,$Y,$color[1]);
$X++;
$P += $bmp['bytes_per_pixel'];
}
$Y--;
$P+=$bmp['decal'];
}
fclose($f1);
return $res;
}
/**
* Saves a BMP image
*
* This function has been published on the PHP website, and can be used free
ly
*
* @access public
*/
function imagebmp(&$im, $filename = "") {
if (!$im) return false;
$w = imagesx($im);
$h = imagesy($im);
$result = '';
// if the image is not true color, we convert it first
if (!imageistruecolor($im)) {
$tmp = imagecreatetruecolor($w, $h);
imagecopy($tmp, $im, 0, 0, 0, 0, $w, $h);
imagedestroy($im);
$im = & $tmp;
}
$biBPLine = $w * 3;
$biStride = ($biBPLine + 3) & ~3;
$biSizeImage = $biStride * $h;
$bfOffBits = 54;
$bfSize = $bfOffBits + $biSizeImage;
$result .= substr('BM', 0, 2);
$result .= pack ('VvvV', $bfSize, 0, 0, $bfOffBits);
$result .= pack ('VVVvvVVVVVV', 40, $w, $h, 1, 24, 0, $biSizeImage, 0, 0
, 0, 0);
$numpad = $biStride - $biBPLine;
for ($y = $h - 1; $y >= 0; --$y) {
for ($x = 0; $x < $w; ++$x) {
$col = imagecolorat ($im, $x, $y);
$result .= substr(pack ('V', $col), 0, 3);
}
for ($i = 0; $i < $numpad; ++$i)
$result .= pack ('C', 0);
}
if($filename==""){
echo $result;
} else {
$file = fopen($filename, "wb");
fwrite($file, $result);
fclose($file);
}
return true;
}
}
?>