<?php

// +------------------------------------------------------------------------+

// | class.upload.php |

// +------------------------------------------------------------------------+

// | Copyright (c) Colin Verot 2003-2019. All rights reserved. |

// | 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. |

// +------------------------------------------------------------------------+

namespace Verot\Upload;

if (!defined('IMG_WEBP')) define('IMG_WEBP', 32);

/**

* Class upload

*

* @author Colin Verot <colin@verot.net>

* @license http://opensource.org/licenses/gpl-license.php GNU Public License

* @copyright Colin Verot

*/

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 public

* @var string

*/

var $file_src_pathname;

/**

* Uloaded file name temporary copy

*

* @access private

* @var string

*/

var $file_src_temp;

/**

* Destination file name

*

* @access public

* @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 public

* @var string

*/

var $file_dst_pathname;

/**

* Source image width

*

* @access public

* @var integer

*/

var $image_src_x;

/**

* Source image height

*

* @access public

* @var integer

*/

var $image_src_y;

/**

* Source image color depth

*

* @access public

* @var integer

*/

var $image_src_bits;

/**

* Number of pixels

*

* @access public

* @var long

*/

var $image_src_pixels;

/**

* Type of image (png, gif, jpg, webp or bmp)

*

* @access public

* @var string

*/

var $image_src_type;

/**

* Destination image width

*

* @access public

* @var integer

*/

var $image_dst_x;

/**

* Destination image height

*

* @access public

* @var integer

*/

var $image_dst_y;

/**

* Destination image type (png, gif, jpg, webp or bmp)

*

* @access public

* @var integer

*/

var $image_dst_type;

/**

* Supported image formats

*

* @access private

* @var array

*/

var $image_supported;

/**

* Flag to determine if the source file is an image

*

* @access public

* @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 case

* 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;

// overiddable processing variables

/**

* 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 append a string to the file name body

*

* @access public

* @var string

*/

var $file_name_body_add;

/**

* Set this variable to prepend a string to the file name body

*

* @access public

* @var string

*/

var $file_name_body_pre;

/**

* 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;

/**

* Forces an extension if the source file doesn't have one

*

* If the file is an image, then the correct extension will be added

* Otherwise, a .txt extension will be chosen

*

* @access public

* @var boolean

*/

var $file_force_extension;

/**

* Set this variable to false if you don't want to check the MIME against the 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 in the init() function if you don't want to check the MIME

* with Fileinfo PECL extension. On some systems, Fileinfo is known to be buggy, and you

* may want to deactivate it in the class code directly.

*

* You can also set it with the path of the magic database file.

* If set to true, the class will try to read the MAGIC environment variable

* and if it is empty, will default to the system's default

* If set to an empty string, it will call finfo_open without the path argument

*

* This variable is set to true by default for security reason

*

* @access public

* @var boolean

*/

var $mime_fileinfo;

/**

* Set this variable to false in the init() function if you don't want to check the MIME

* with UNIX file() command

*

* This variable is set to true by default for security reason

*

* @access public

* @var boolean

*/

var $mime_file;

/**

* Set this variable to false in the init() function if you don't want to check the MIME

* with the magic.mime file

*

* The function mime_content_type() will be deprecated,

* and this variable will be set to false in a future release

*

* This variable is set to true by default for security reason

*

* @access public

* @var boolean

*/

var $mime_magic;

/**

* Set this variable to false in the init() function if you don't want to check the MIME

* with getimagesize()

*

* The class tries to get a MIME type from getimagesize()

* If no MIME is returned, it tries to guess the MIME type from the file type

*

* This variable is set to true by default for security reason

*

* @access public

* @var boolean

*/

var $mime_getimagesize;

/**

* Set this variable to false if you don't want to turn dangerous scripts into simple text files

* The list of blacklisted extensions is in {@link dangerous}

*

* Note that this check happens before checking for forbidden MIME types or extensions

* If you want to forbid uploads rather than turning scripts into text files,

* set {@link no_script} to false and use {@link forbidden} instead

*

* @access public

* @var boolean

*/

var $no_script;

/**

* Dangerous file extensions

*

* List of dangerous extensions, that are enforced if {@link no_script} is true

* If the file has such extension, then it is turned into a text file

*

* @access public

* @var array

*/

var $dangerous;

/**

* 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} is 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 0755 (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 file

*

* Default value is the value <i>upload_max_filesize</i> from php.ini

*

* Value in bytes (integer) or shorthand byte values (string) is allowed.

* The available options are K (for Kilobytes), M (for Megabytes) and G (for Gigabytes)

*

* @access public

* @var double

*/

var $file_max_size;

/**

* Max file size, from php.ini

*

* @access private

* @var double

*/

var $file_max_size_raw;

/**

* 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 maybe 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'; 'webp'; '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 processed 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 processed 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 image_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 image_x} x {@link image_y}

*

* The image will be resized as to fill the whole space, and excedent will be cropped

*

* Value can also be a string, one or more character from 'TBLR' (top, bottom, left and right)

* If set as a string, it determines which side of the image is kept while cropping.

* By default, the part of the image kept is in the center, i.e. it crops equally 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 image_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_color}

*

* Value can also be a string, one or more character from 'TBLR' (top, bottom, 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 remaining 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 {@link 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 calculate {@link image_x} automatically , using {@link 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 {@link image_x} and conserving ratio

*

* Default value is false

*

* @access public

* @var bool

*/

var $image_ratio_y;

/**

* (deprecated) Set this variable to keep the original size ratio to fit within {@link image_x} x {@link image_y},

* but only if original image is bigger

*

* This setting is soon to be deprecated. Instead, use {@link image_ratio} and {@link image_no_enlarging}

*

* Default value is false

*

* @access public

* @var bool

*/

var $image_ratio_no_zoom_in;

/**

* (deprecated) Set this variable to keep the original size ratio to fit within {@link image_x} x {@link image_y},

* but only if original image is smaller

*

* Default value is false

*

* This setting is soon to be deprecated. Instead, use {@link image_ratio} and {@link image_no_shrinking}

*

* @access public

* @var bool

*/

var $image_ratio_no_zoom_out;

/**

* Cancel resizing if the resized image is bigger than the original image, to prevent enlarging

*

* Default value is false

*

* @access public

* @var bool

*/

var $image_no_enlarging;

/**

* Cancel resizing if the resized image is smaller than the original image, to prevent shrinking

*

* Default value is false

*

* @access public

* @var bool

*/

var $image_no_shrinking;

/**

* Set this variable to set a maximum image width, above which the upload will 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 will 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 which 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 upload 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 will 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 will 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 which 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 upload will be invalid

*

* Note that ratio = width / height

*

* Default value is null

*

* @access public

* @var float

*/

var $image_min_ratio;

/**

* Compression level for PNG images

*

* Between 1 (fast but large files) and 9 (slow but smaller files)

*

* Default value is null (Zlib default)

*

* @access public

* @var integer

*/

var $png_compression;

/**

* Quality of JPEG created/converted destination image

*

* Default value is 85

*

* @access public

* @var integer

*/

var $jpeg_quality;

/**

* Quality of WebP created/converted destination image

*

* Default value is 85

*

* @access public

* @var integer

*/

var $webp_quality;

/**

* Determines the quality of the JPG image to fit a desired file size

*

* The JPG quality will be set between 1 and 100%

* The calculations are approximations.

*

* Value in bytes (integer) or shorthand byte values (string) is allowed.

* The available options are K (for Kilobytes), M (for Megabytes) and G (for Gigabytes)

*

* Default value is null (no calculations)

*

* @access public

* @var integer

*/

var $jpeg_size;

/**

* Turns the interlace bit on

*

* This is actually used only for JPEG images, and defaults to false

*

* @access public

* @var boolean

*/

var $image_interlace;

/**

* 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 areas with the color

* This setting will fill in all transparent areas in PNG, WEPB and GIF, as opposed to {@link image_default_color}

* which will do so only in BMP, JPEG, and alpha transparent areas in transparent 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 transparent areas

* of an alpha transparent when the output format doesn't support alpha transparency

* This is useful when, from an alpha transparent PNG or WEBP image, or an image with 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 previously 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;

/**

* Changes the image opacity

*

* Value can range between 0 and 100

*

* Default value is null

*

* @access public

* @var integer

*/

var $image_opacity;

/**

* 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_opacity}

*

* Default value is null

*

* @access public

* @var string;

*/

var $image_overlay_color;

/**

* Sets the opacity for the colored overlay

*

* Value is a percentage, as an integer between 0 (transparent) and 100 (opaque)

*

* Unless used with {@link image_overlay_color}, this setting has no effect

*

* Default value is 50

*

* @access public

* @var integer

*/

var $image_overlay_opacity;

/**

* 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;

/**

* Pixelate an image

*

* Value is integer, represents the block size

*

* Default value is null

*

* @access public

* @var integer;

*/

var $image_pixelate;

/**

* Applies an unsharp mask, with alpha transparency support