PageRenderTime 56ms CodeModel.GetById 15ms RepoModel.GetById 1ms app.codeStats 1ms

/protected/modules/fileManager/extensions/upload/Upload.php

https://bitbucket.org/graaaf/erso
PHP | 5139 lines | 2601 code | 321 blank | 2217 comment | 859 complexity | a717db24ca507be071cde3fd3fe22a25 MD5 | raw file
Possible License(s): GPL-3.0, LGPL-3.0, LGPL-2.1, BSD-3-Clause, BSD-2-Clause

Large files files are truncated, but you can click here to view the full file

    

  1. <?php
    2. 

  2. // +------------------------------------------------------------------------+
    3. 

  3. // | class.upload.php                                                       |
    4. 

  4. // +------------------------------------------------------------------------+
    5. 

  5. // | Copyright (c) Colin Verot 2003-2010. All rights reserved.              |
    6. 

  6. // | Version       0.31                                                     |
    7. 

  7. // | Last modified 11/04/2011                                               |
    8. 

  8. // | Email         colin@verot.net                                          |
    9. 

  9. // | Web           http://www.verot.net                                     |
    10. 

  10. // +------------------------------------------------------------------------+
    11. 

  11. // | This program is free software; you can redistribute it and/or modify   |
    12. 

  12. // | it under the terms of the GNU General Public License version 2 as      |
    13. 

  13. // | published by the Free Software Foundation.                             |
    14. 

  14. // |                                                                        |
    15. 

  15. // | This program is distributed in the hope that it will be useful,        |
    16. 

  16. // | but WITHOUT ANY WARRANTY; without even the implied warranty of         |
    17. 

  17. // | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          |
    18. 

  18. // | GNU General Public License for more details.                           |
    19. 

  19. // |                                                                        |
    20. 

  20. // | You should have received a copy of the GNU General Public License      |
    21. 

  21. // | along with this program; if not, write to the                          |
    22. 

  22. // |   Free Software Foundation, Inc., 59 Temple Place, Suite 330,          |
    23. 

  23. // |   Boston, MA 02111-1307 USA                                            |
    24. 

  24. // |                                                                        |
    25. 

  25. // | Please give credit on sites that use class.upload and submit changes   |
    26. 

  26. // | of the script so other people can use them as well.                    |
    27. 

  27. // | This script is free to use, don't abuse.                               |
    28. 

  28. // +------------------------------------------------------------------------+
    29. 

  29. //
    30. 

  30. 

  31. /**
    32. 

  32.  * Class upload
    33. 

  33.  *
    34. 

  34.  * @version   0.31
    35. 

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

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

  37.  * @copyright Colin Verot
    38. 

  38.  * @package   cmf
    39. 

  39.  * @subpackage external
    40. 

  40.  */
    41. 

  41. 

  42. /**
    43. 

  43.  * Class upload
    44. 

  44.  *
    45. 

  45.  * <b>What does it do?</b>
    46. 

  46.  *
    47. 

  47.  * It manages file uploads for you. In short, it manages the uploaded file,
    48. 

  48.  * and allows you to do whatever you want with the file, especially if it
    49. 

  49.  * is an image, and as many times as you want.
    50. 

  50.  *
    51. 

  51.  * It is the ideal class to quickly integrate file upload in your site.
    52. 

  52.  * If the file is an image, you can convert, resize, crop it in many ways.
    53. 

  53.  * You can also apply filters, add borders, text, watermarks, etc...
    54. 

  54.  * That's all you need for a gallery script for instance. Supported formats
    55. 

  55.  * are PNG, JPG, GIF and BMP.
    56. 

  56.  *
    57. 

  57.  * You can also use the class to work on local files, which is especially
    58. 

  58.  * useful to use the image manipulation features. The class also supports
    59. 

  59.  * Flash uploaders.
    60. 

  60.  *
    61. 

  61.  * The class works with PHP 4 and 5, and its error messages can
    62. 

  62.  * be localized at will.
    63. 

  63.  *
    64. 

  64.  * <b>How does it work?</b>
    65. 

  65.  *
    66. 

  66.  * You instanciate the class with the $_FILES['my_field'] array
    67. 

  67.  * where my_field is the field name from your upload form.
    68. 

  68.  * The class will check if the original file has been uploaded
    69. 

  69.  * to its temporary location (alternatively, you can instanciate
    70. 

  70.  * the class with a local filename).
    71. 

  71.  *
    72. 

  72.  * You can then set a number of processing variables to act on the file.
    73. 

  73.  * For instance, you can rename the file, and if it is an image,
    74. 

  74.  * convert and resize it in many ways.
    75. 

  75.  * You can also set what will the class do if the file already exists.
    76. 

  76.  *
    77. 

  77.  * Then you call the function {@link process} to actually perform the actions
    78. 

  78.  * according to the processing parameters you set above.
    79. 

  79.  * It will create new instances of the original file,
    80. 

  80.  * so the original file remains the same between each process.
    81. 

  81.  * The file will be manipulated, and copied to the given location.
    82. 

  82.  * The processing variables will be reset once it is done.
    83. 

  83.  *
    84. 

  84.  * You can repeat setting up a new set of processing variables,
    85. 

  85.  * and calling {@link process} again as many times as you want.
    86. 

  86.  * When you have finished, you can call {@link clean} to delete
    87. 

  87.  * the original uploaded file.
    88. 

  88.  *
    89. 

  89.  * If you don't set any processing parameters and call {@link process}
    90. 

  90.  * just after instanciating the class. The uploaded file will be simply
    91. 

  91.  * copied to the given location without any alteration or checks.
    92. 

  92.  *
    93. 

  93.  * Don't forget to add <i>enctype="multipart/form-data"</i> in your form
    94. 

  94.  * tag <form> if you want your form to upload the file.
    95. 

  95.  *
    96. 

  96.  * <b>How to use it?</b><br>
    97. 

  97.  * Create a simple HTML file, with a form such as:
    98. 

  98.  * <pre>
    99. 

  99.  * <form enctype="multipart/form-data" method="post" action="upload.php">
    100. 

  100.  *   <input type="file" size="32" name="image_field" value="">
    101. 

  101.  *   <input type="submit" name="Submit" value="upload">
    102. 

  102.  * </form>
    103. 

  103.  * </pre>
    104. 

  104.  * Create a file called upload.php:
    105. 

  105.  * <pre>
    106. 

  106.  *  $handle = new Upload($_FILES['image_field']);
    107. 

  107.  *  if ($handle->uploaded) {
    108. 

  108.  *      $handle->file_new_name_body   = 'image_resized';
    109. 

  109.  *      $handle->image_resize         = true;
    110. 

  110.  *      $handle->image_x              = 100;
    111. 

  111.  *      $handle->image_ratio_y        = true;
    112. 

  112.  *      $handle->process('/home/user/files/');
    113. 

  113.  *      if ($handle->processed) {
    114. 

  114.  *          echo 'image resized';
    115. 

  115.  *          $handle->clean();
    116. 

  116.  *      } else {
    117. 

  117.  *          echo 'error : ' . $handle->error;
    118. 

  118.  *      }
    119. 

  119.  *  }
    120. 

  120.  * </pre>
    121. 

  121.  *
    122. 

  122.  * <b>How to process local files?</b><br>
    123. 

  123.  * Use the class as following, the rest being the same as above:
    124. 

  124.  * <pre>
    125. 

  125.  *  $handle = new Upload('/home/user/myfile.jpg');
    126. 

  126.  * </pre>
    127. 

  127.  *
    128. 

  128.  * <b>How to set the language?</b><br>
    129. 

  129.  * Instantiate the class with a second argument being the language code:
    130. 

  130.  * <pre>
    131. 

  131.  *  $handle = new Upload($_FILES['image_field'], 'fr_FR');
    132. 

  132.  *  $handle = new Upload('/home/user/myfile.jpg', 'fr_FR');
    133. 

  133.  * </pre>
    134. 

  134.  *
    135. 

  135.  * <b>How to output the resulting file or picture directly to the browser?</b><br>
    136. 

  136.  * Simply call {@link process}() without an argument (or with null as first argument):
    137. 

  137.  * <pre>
    138. 

  138.  *  $handle = new Upload($_FILES['image_field']);
    139. 

  139.  *  header('Content-type: ' . $handle->file_src_mime);
    140. 

  140.  *  echo $handle->Process();
    141. 

  141.  *  die();
    142. 

  142.  * </pre>
    143. 

  143.  * Or if you want to force the download of the file:
    144. 

  144.  * <pre>
    145. 

  145.  *  $handle = new Upload($_FILES['image_field']);
    146. 

  146.  *  header('Content-type: ' . $handle->file_src_mime);
    147. 

  147.  *  header("Content-Disposition: attachment; filename=".rawurlencode($handle->file_src_name).";");
    148. 

  148.  *  echo $handle->Process();
    149. 

  149.  *  die();
    150. 

  150.  * </pre>
    151. 

  151.  *
    152. 

  152.  * <b>Processing parameters</b> (reset after each process)
    153. 

  153.  * <ul>
    154. 

  154.  *  <li><b>{@link file_new_name_body}</b> replaces the name body (default: null)<br>
    155. 

  155.  *  <pre>$handle->file_new_name_body = 'new name';</pre></li>
    156. 

  156.  *  <li><b>{@link file_name_body_add}</b> appends to the name body (default: null)<br>
    157. 

  157.  *  <pre>$handle->file_name_body_add = '_uploaded';</pre></li>
    158. 

  158.  *  <li><b>{@link file_name_body_pre}</b> prepends to the name body (default: null)<br>
    159. 

  159.  *  <pre>$handle->file_name_body_pre = 'thumb_';</pre></li>
    160. 

  160.  *  <li><b>{@link file_new_name_ext}</b> replaces the file extension (default: null)<br>
    161. 

  161.  *  <pre>$handle->file_new_name_ext = 'txt';</pre></li>
    162. 

  162.  *  <li><b>{@link file_safe_name}</b> formats the filename (spaces changed to _) (default: true)<br>
    163. 

  163.  *  <pre>$handle->file_safe_name = true;</pre></li>
    164. 

  164.  *  <li><b>{@link file_force_extension}</b> forces an extension if there is't any (default: true)<br>
    165. 

  165.  *  <pre>$handle->file_force_extension = true;</pre></li>
    166. 

  166.  *  <li><b>{@link file_overwrite}</b> sets behaviour if file already exists (default: false)<br>
    167. 

  167.  *  <pre>$handle->file_overwrite = true;</pre></li>
    168. 

  168.  *  <li><b>{@link file_auto_rename}</b> automatically renames file if it already exists (default: true)<br>
    169. 

  169.  *  <pre>$handle->file_auto_rename = true;</pre></li>
    170. 

  170.  *  <li><b>{@link dir_auto_create}</b> automatically creates destination directory if missing (default: true)<br>
    171. 

  171.  *  <pre>$handle->auto_create_dir = true;</pre></li>
    172. 

  172.  *  <li><b>{@link dir_auto_chmod}</b> automatically attempts to chmod the destination directory if not writeable (default: true)<br>
    173. 

  173.  *  <pre>$handle->dir_auto_chmod = true;</pre></li>
    174. 

  174.  *  <li><b>{@link dir_chmod}</b> chmod used when creating directory or if directory not writeable (default: 0777)<br>
    175. 

  175.  *  <pre>$handle->dir_chmod = 0777;</pre></li>
    176. 

  176.  *  <li><b>{@link file_max_size}</b> sets maximum upload size (default: upload_max_filesize from php.ini)<br>
    177. 

  177.  *  <pre>$handle->file_max_size = '1024'; // 1KB</pre></li>
    178. 

  178.  *  <li><b>{@link mime_check}</b> sets if the class check the MIME against the {@link allowed} list (default: true)<br>
    179. 

  179.  *  <pre>$handle->mime_check = true;</pre></li>
    180. 

  180.  *  <li><b>{@link no_script}</b> sets if the class turns scripts into text files (default: true)<br>
    181. 

  181.  *  <pre>$handle->no_script = false;</pre></li>
    182. 

  182.  *  <li><b>{@link allowed}</b> array of allowed mime-types (or one string). wildcard accepted, as in image/* (default: check {@link Init})<br>
    183. 

  183.  *  <pre>$handle->allowed = array('application/pdf','application/msword', 'image/*');</pre></li>
    184. 

  184.  *  <li><b>{@link forbidden}</b> array of forbidden mime-types (or one string). wildcard accepted, as in image/*  (default: check {@link Init})<br>
    185. 

  185.  *  <pre>$handle->forbidden = array('application/*');</pre></li>
    186. 

  186.  * </ul>
    187. 

  187.  * <ul>
    188. 

  188.  *  <li><b>{@link image_convert}</b> if set, image will be converted (possible values : ''|'png'|'jpeg'|'gif'|'bmp'; default: '')<br>
    189. 

  189.  *  <pre>$handle->image_convert = 'jpg';</pre></li>
    190. 

  190.  *  <li><b>{@link image_background_color}</b> if set, will forcibly fill transparent areas with the color, in hexadecimal (default: null)<br>
    191. 

  191.  *  <pre>$handle->image_background_color = '#FF00FF';</pre></li>
    192. 

  192.  *  <li><b>{@link image_default_color}</b> fallback color background color for non alpha-transparent output formats, such as JPEG or BMP, in hexadecimal (default: #FFFFFF)<br>
    193. 

  193.  *  <pre>$handle->image_default_color = '#FF00FF';</pre></li>
    194. 

  194.  *  <li><b>{@link jpeg_quality}</b> sets the compression quality for JPEG images (default: 85)<br>
    195. 

  195.  *  <pre>$handle->jpeg_quality = 50;</pre></li>
    196. 

  196.  *  <li><b>{@link 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>
    197. 

  197.  *  <pre>$handle->jpeg_size = 3072;</pre></li>
    198. 

  198.  * </ul>
    199. 

  199.  * 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)
    200. 

  200.  * <ul>
    201. 

  201.  *  <li><b>{@link 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>
    202. 

  202.  *  <pre>$handle->image_max_width = 200;</pre></li>
    203. 

  203.  *  <li><b>{@link 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>
    204. 

  204.  *  <pre>$handle->image_max_height = 100;</pre></li>
    205. 

  205.  *  <li><b>{@link 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>
    206. 

  206.  *  <pre>$handle->image_max_pixels = 50000;</pre></li>
    207. 

  207.  *  <li><b>{@link image_max_ratio}</b> if set to a aspect ratio (width/height), the upload will be invalid if the image apect ratio is greater (default: null)<br>
    208. 

  208.  *  <pre>$handle->image_max_ratio = 1.5;</pre></li>
    209. 

  209.  *  <li><b>{@link 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>
    210. 

  210.  *  <pre>$handle->image_min_width = 100;</pre></li>
    211. 

  211.  *  <li><b>{@link 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>
    212. 

  212.  *  <pre>$handle->image_min_height = 500;</pre></li>
    213. 

  213.  *  <li><b>{@link 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>
    214. 

  214.  *  <pre>$handle->image_min_pixels = 20000;</pre></li>
    215. 

  215.  *  <li><b>{@link image_min_ratio}</b> if set to a aspect ratio (width/height), the upload will be invalid if the image apect ratio is lower (default: null)<br>
    216. 

  216.  *  <pre>$handle->image_min_ratio = 0.5;</pre></li>
    217. 

  217.  * </ul>
    218. 

  218.  * <ul>
    219. 

  219.  *  <li><b>{@link image_resize}</b> determines is an image will be resized (default: false)<br>
    220. 

  220.  *  <pre>$handle->image_resize = true;</pre></li>
    221. 

  221.  * </ul>
    222. 

  222.  *  The following variables are used only if {@link image_resize} == true
    223. 

  223.  * <ul>
    224. 

  224.  *  <li><b>{@link image_x}</b> destination image width (default: 150)<br>
    225. 

  225.  *  <pre>$handle->image_x = 100;</pre></li>
    226. 

  226.  *  <li><b>{@link image_y}</b> destination image height (default: 150)<br>
    227. 

  227.  *  <pre>$handle->image_y = 200;</pre></li>
    228. 

  228.  * </ul>
    229. 

  229.  *  Use either one of the following
    230. 

  230.  * <ul>
    231. 

  231.  *  <li><b>{@link image_ratio}</b> if true, resize image conserving the original sizes ratio, using {@link image_x} AND {@link image_y} as max sizes if true (default: false)<br>
    232. 

  232.  *  <pre>$handle->image_ratio = true;</pre></li>
    233. 

  233.  *  <li><b>{@link image_ratio_crop}</b> if true, resize image conserving the original sizes 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>
    234. 

  234.  *  <pre>$handle->image_ratio_crop = true;</pre></li>
    235. 

  235.  *  <li><b>{@link image_ratio_fill}</b> if true, resize image conserving the original sizes ratio, using {@link image_x} AND {@link image_y} as max sizes, fitting the image 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 will be in (default: false)<br>
    236. 

  236.  *  <pre>$handle->image_ratio_fill = true;</pre></li>
    237. 

  237.  *  <li><b>{@link image_ratio_no_zoom_in}</b> same as {@link image_ratio}, but won't resize if the source image is smaller than {@link image_x} x {@link image_y} (default: false)<br>
    238. 

  238.  *  <pre>$handle->image_ratio_no_zoom_in = true;</pre></li>
    239. 

  239.  *  <li><b>{@link image_ratio_no_zoom_out}</b> same as {@link image_ratio}, but won't resize if the source image is bigger than {@link image_x} x {@link image_y} (default: false)<br>
    240. 

  240.  *  <pre>$handle->image_ratio_no_zoom_out = true;</pre></li>
    241. 

  241.  *  <li><b>{@link 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>
    242. 

  242.  *  <pre>$handle->image_ratio_x = true;</pre></li>
    243. 

  243.  *  <li><b>{@link 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>
    244. 

  244.  *  <pre>$handle->image_ratio_y = true;</pre></li>
    245. 

  245.  *  <li><b>{@link image_ratio_pixels}</b> if set to a long integer, resize image, calculating {@link image_y} and {@link image_x} to match a the number of pixels (default: false)<br>
    246. 

  246.  *  <pre>$handle->image_ratio_pixels = 25000;</pre></li>
    247. 

  247.  * </ul>
    248. 

  248.  *  The following image manipulations require GD2+
    249. 

  249.  * <ul>
    250. 

  250.  *  <li><b>{@link image_brightness}</b> if set, corrects the brightness. value between -127 and 127 (default: null)<br>
    251. 

  251.  *  <pre>$handle->image_brightness = 40;</pre></li>
    252. 

  252.  *  <li><b>{@link image_contrast}</b> if set, corrects the contrast. value between -127 and 127 (default: null)<br>
    253. 

  253.  *  <pre>$handle->image_contrast = 50;</pre></li>
    254. 

  254.  *  <li><b>{@link image_opacity}</b> if set, changes the image opacity. value between 0 and 100 (default: null)<br>
    255. 

  255.  *  <pre>$handle->image_opacity = 50;</pre></li>
    256. 

  256.  *  <li><b>{@link image_tint_color}</b> if set, will tint the image with a color, value as hexadecimal #FFFFFF (default: null)<br>
    257. 

  257.  *  <pre>$handle->image_tint_color = '#FF0000';</pre></li>
    258. 

  258.  *  <li><b>{@link image_overlay_color}</b> if set, will add a colored overlay, value as hexadecimal #FFFFFF (default: null)<br>
    259. 

  259.  *  <pre>$handle->image_overlay_color = '#FF0000';</pre></li>
    260. 

  260.  *  <li><b>{@link image_overlay_opacity}</b> used when {@link image_overlay_color} is set, determines the opacity (default: 50)<br>
    261. 

  261.  *  <pre>$handle->image_overlay_opacity = 20;</pre></li>
    262. 

  262.  *  <li><b>{@link image_negative}</b> inverts the colors in the image (default: false)<br>
    263. 

  263.  *  <pre>$handle->image_negative = true;</pre></li>
    264. 

  264.  *  <li><b>{@link image_greyscale}</b> transforms an image into greyscale (default: false)<br>
    265. 

  265.  *  <pre>$handle->image_greyscale = true;</pre></li>
    266. 

  266.  *  <li><b>{@link image_threshold}</b> applies a threshold filter. value between -127 and 127 (default: null)<br>
    267. 

  267.  *  <pre>$handle->image_threshold = 20;</pre></li>
    268. 

  268.  *  <li><b>{@link image_unsharp}</b> applies an unsharp mask, with alpha transparency support (default: false)<br>
    269. 

  269.  *  <pre>$handle->image_unsharp = true;</pre></li>
    270. 

  270.  *  <li><b>{@link image_unsharp_amount}</b> unsharp mask amount, typically 50 - 200 (default: 80)<br>
    271. 

  271.  *  <pre>$handle->image_unsharp_amount = 120;</pre></li>
    272. 

  272.  *  <li><b>{@link image_unsharp_radius}</b> unsharp mask radius, typically 0.5 - 1 (default: 0.5)<br>
    273. 

  273.  *  <pre>$handle->image_unsharp_radius = 0.8;</pre></li>
    274. 

  274.  *  <li><b>{@link image_unsharp_threshold}</b> unsharp mask threshold, typically 0 - 5 (default: 1)<br>
    275. 

  275.  *  <pre>$handle->image_unsharp_threshold = 0;</pre></li>
    276. 

  276.  * </ul>
    277. 

  277.  * <ul>
    278. 

  278.  *  <li><b>{@link image_text}</b> creates a text label on the image, value is a string, with eventual replacement tokens (default: null)<br>
    279. 

  279.  *  <pre>$handle->image_text = 'test';</pre></li>
    280. 

  280.  *  <li><b>{@link image_text_direction}</b> text label direction, either 'h' horizontal or 'v' vertical (default: 'h')<br>
    281. 

  281.  *  <pre>$handle->image_text_direction = 'v';</pre></li>
    282. 

  282.  *  <li><b>{@link image_text_color}</b> text color for the text label, in hexadecimal (default: #FFFFFF)<br>
    283. 

  283.  *  <pre>$handle->image_text_color = '#FF0000';</pre></li>
    284. 

  284.  *  <li><b>{@link image_text_opacity}</b> text opacity on the text label, integer between 0 and 100 (default: 100)<br>
    285. 

  285.  *  <pre>$handle->image_text_opacity = 50;</pre></li>
    286. 

  286.  *  <li><b>{@link image_text_background}</b> text label background color, in hexadecimal (default: null)<br>
    287. 

  287.  *  <pre>$handle->image_text_background = '#FFFFFF';</pre></li>
    288. 

  288.  *  <li><b>{@link image_text_background_opacity}</b> text label background opacity, integer between 0 and 100 (default: 100)<br>
    289. 

  289.  *  <pre>$handle->image_text_background_opacity = 50;</pre></li>
    290. 

  290.  *  <li><b>{@link image_text_font}</b> built-in font for the text label, from 1 to 5. 1 is the smallest (default: 5)<br>
    291. 

  291.  *  <pre>$handle->image_text_font = 4;</pre></li>
    292. 

  292.  *  <li><b>{@link image_text_x}</b> absolute text label position, in pixels from the left border. can be negative (default: null)<br>
    293. 

  293.  *  <pre>$handle->image_text_x = 5;</pre></li>
    294. 

  294.  *  <li><b>{@link image_text_y}</b> absolute text label position, in pixels from the top border. can be negative (default: null)<br>
    295. 

  295.  *  <pre>$handle->image_text_y = 5;</pre></li>
    296. 

  296.  *  <li><b>{@link image_text_position}</b> text label position withing the image, a combination of one or two from 'TBLR': top, bottom, left, right (default: null)<br>
    297. 

  297.  *  <pre>$handle->image_text_position = 'LR';</pre></li>
    298. 

  298.  *  <li><b>{@link image_text_padding}</b> text label padding, in pixels. can be overridden by {@link image_text_padding_x} and {@link image_text_padding_y} (default: 0)<br>
    299. 

  299.  *  <pre>$handle->image_text_padding = 5;</pre></li>
    300. 

  300.  *  <li><b>{@link image_text_padding_x}</b> text label horizontal padding (default: null)<br>
    301. 

  301.  *  <pre>$handle->image_text_padding_x = 2;</pre></li>
    302. 

  302.  *  <li><b>{@link image_text_padding_y}</b> text label vertical padding (default: null)<br>
    303. 

  303.  *  <pre>$handle->image_text_padding_y = 10;</pre></li>
    304. 

  304.  *  <li><b>{@link image_text_alignment}</b> text alignment when text has multiple lines, either 'L', 'C' or 'R' (default: 'C')<br>
    305. 

  305.  *  <pre>$handle->image_text_alignment = 'R';</pre></li>
    306. 

  306.  *  <li><b>{@link image_text_line_spacing}</b> space between lines in pixels, when text has multiple lines (default: 0)<br>
    307. 

  307.  *  <pre>$handle->image_text_line_spacing = 3;</pre></li>
    308. 

  308.  * </ul>
    309. 

  309.  * <ul>
    310. 

  310.  *  <li><b>{@link image_flip}</b> flips image, wither 'h' horizontal or 'v' vertical (default: null)<br>
    311. 

  311.  *  <pre>$handle->image_flip = 'h';</pre></li>
    312. 

  312.  *  <li><b>{@link image_rotate}</b> rotates image. possible values are 90, 180 and 270 (default: null)<br>
    313. 

  313.  *  <pre>$handle->image_rotate = 90;</pre></li>
    314. 

  314.  *  <li><b>{@link 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>
    315. 

  315.  *  <pre>$handle->image_crop = array(50,40,30,20); OR '-20 20%'...</pre></li>
    316. 

  316.  *  <li><b>{@link 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>
    317. 

  317.  *  <pre>$handle->image_precrop = array(50,40,30,20); OR '-20 20%'...</pre></li>
    318. 

  318.  * </ul>
    319. 

  319.  * <ul>
    320. 

  320.  *  <li><b>{@link image_bevel}</b> adds a bevel border to the image. value is thickness in pixels (default: null)<br>
    321. 

  321.  *  <pre>$handle->image_bevel = 20;</pre></li>
    322. 

  322.  *  <li><b>{@link image_bevel_color1}</b> top and left bevel color, in hexadecimal (default: #FFFFFF)<br>
    323. 

  323.  *  <pre>$handle->image_bevel_color1 = '#FFFFFF';</pre></li>
    324. 

  324.  *  <li><b>{@link image_bevel_color2}</b> bottom and right bevel color, in hexadecimal (default: #000000)<br>
    325. 

  325.  *  <pre>$handle->image_bevel_color2 = '#000000';</pre></li>
    326. 

  326.  *  <li><b>{@link 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>
    327. 

  327.  *  <pre>$handle->image_border = '3px'; OR '-20 20%' OR array(3,2)...</pre></li>
    328. 

  328.  *  <li><b>{@link image_border_color}</b> border color, in hexadecimal (default: #FFFFFF)<br>
    329. 

  329.  *  <pre>$handle->image_border_color = '#FFFFFF';</pre></li>
    330. 

  330.  *  <li><b>{@link image_border_opacity}</b> border opacity, integer between 0 and 100 (default: 100)<br>
    331. 

  331.  *  <pre>$handle->image_border_opacity = 50;</pre></li>
    332. 

  332.  *  <li><b>{@link image_border_transparent}</b> adds a fading-to-transparent 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>
    333. 

  333.  *  <pre>$handle->image_border_transparent = '3px'; OR '-20 20%' OR array(3,2)...</pre></li>
    334. 

  334.  *  <li><b>{@link image_frame}</b> type of frame: 1=flat 2=crossed (default: null)<br>
    335. 

  335.  *  <pre>$handle->image_frame = 2;</pre></li>
    336. 

  336.  *  <li><b>{@link image_frame_colors}</b> list of hex colors, in an array or a space separated string (default: '#FFFFFF #999999 #666666 #000000')<br>
    337. 

  337.  *  <pre>$handle->image_frame_colors = array('#999999',  '#FF0000', '#666666', '#333333', '#000000');</pre></li>
    338. 

  338.  *  <li><b>{@link image_frame_opacity}</b> frame opacity, integer between 0 and 100 (default: 100)<br>
    339. 

  339.  *  <pre>$handle->image_frame_opacity = 50;</pre></li>
    340. 

  340.  * </ul>
    341. 

  341.  * <ul>
    342. 

  342.  *  <li><b>{@link image_watermark}</b> adds a watermark on the image, value is a local filename. accepted files are GIF, JPG, BMP, PNG and PNG alpha (default: null)<br>
    343. 

  343.  *  <pre>$handle->image_watermark = 'watermark.png';</pre></li>
    344. 

  344.  *  <li><b>{@link image_watermark_x}</b> absolute watermark position, in pixels from the left border. can be negative (default: null)<br>
    345. 

  345.  *  <pre>$handle->image_watermark_x = 5;</pre></li>
    346. 

  346.  *  <li><b>{@link image_watermark_y}</b> absolute watermark position, in pixels from the top border. can be negative (default: null)<br>
    347. 

  347.  *  <pre>$handle->image_watermark_y = 5;</pre></li>
    348. 

  348.  *  <li><b>{@link image_watermark_position}</b> watermark position withing the image, a combination of one or two from 'TBLR': top, bottom, left, right (default: null)<br>
    349. 

  349.  *  <pre>$handle->image_watermark_position = 'LR';</pre></li>
    350. 

  350.  *  <li><b>{@link image_watermark_no_zoom_in}</b> prevents the watermark to be resized up if it is smaller than the image (default: true)<br>
    351. 

  351.  *  <pre>$handle->image_watermark_no_zoom_in = false;</pre></li>
    352. 

  352.  *  <li><b>{@link image_watermark_no_zoom_out}</b> prevents the watermark to be resized down if it is bigger than the image (default: false)<br>
    353. 

  353.  *  <pre>$handle->image_watermark_no_zoom_out = true;</pre></li>
    354. 

  354.  * </ul>
    355. 

  355.  * <ul>
    356. 

  356.  *  <li><b>{@link image_reflection_height}</b> if set, a reflection will be added. Format is either in pixels or percentage, such as 40, '40', '40px' or '40%' (default: null)<br>
    357. 

  357.  *  <pre>$handle->image_reflection_height = '25%';</pre></li>
    358. 

  358.  *  <li><b>{@link image_reflection_space}</b> space in pixels between the source image and the reflection, can be negative (default: null)<br>
    359. 

  359.  *  <pre>$handle->image_reflection_space = 3;</pre></li>
    360. 

  360.  *  <li><b>{@link image_reflection_color}</b> reflection background color, in hexadecimal. Now deprecated in favor of {@link image_default_color} (default: #FFFFFF)<br>
    361. 

  361.  *  <pre>$handle->image_default_color = '#000000';</pre></li>
    362. 

  362.  *  <li><b>{@link image_reflection_opacity}</b> opacity level at which the reflection starts, integer between 0 and 100 (default: 60)<br>
    363. 

  363.  *  <pre>$handle->image_reflection_opacity = 60;</pre></li>
    364. 

  364.  * </ul>
    365. 

  365.  *
    366. 

  366.  * <b>Values that can be read before calling {@link process}()</b>
    367. 

  367.  * <ul>
    368. 

  368.  *  <li><b>{@link file_src_name}</b> Source file name</li>
    369. 

  369.  *  <li><b>{@link file_src_name_body}</b> Source file name body</li>
    370. 

  370.  *  <li><b>{@link file_src_name_ext}</b> Source file extension</li>
    371. 

  371.  *  <li><b>{@link file_src_pathname}</b> Source file complete path and name</li>
    372. 

  372.  *  <li><b>{@link file_src_mime}</b> Source file mime type</li>
    373. 

  373.  *  <li><b>{@link file_src_size}</b> Source file size in bytes</li>
    374. 

  374.  *  <li><b>{@link file_src_error}</b> Upload error code</li>
    375. 

  375.  *  <li><b>{@link file_is_image}</b> Boolean flag, true if the file is a supported image type</li>
    376. 

  376.  * </ul>
    377. 

  377.  * If the file is a supported image type (and <i>open_basedir</i> restrictions allow it)
    378. 

  378.  * <ul>
    379. 

  379.  *  <li><b>{@link image_src_x}</b> Source file width in pixels</li>
    380. 

  380.  *  <li><b>{@link image_src_y}</b> Source file height in pixels</li>
    381. 

  381.  *  <li><b>{@link image_src_pixels}</b> Source file number of pixels</li>
    382. 

  382.  *  <li><b>{@link image_src_type}</b> Source file type (png, jpg, gif or bmp)</li>
    383. 

  383.  *  <li><b>{@link image_src_bits}</b> Source file color depth</li>
    384. 

  384.  * </ul>
    385. 

  385.  *
    386. 

  386.  * <b>Values that can be read after calling {@link process}()</b>
    387. 

  387.  * <ul>
    388. 

  388.  *  <li><b>{@link file_dst_path}</b> Destination file path</li>
    389. 

  389.  *  <li><b>{@link file_dst_name_body}</b> Destination file name body</li>
    390. 

  390.  *  <li><b>{@link file_dst_name_ext}</b> Destination file extension</li>
    391. 

  391.  *  <li><b>{@link file_dst_name}</b> Destination file name</li>
    392. 

  392.  *  <li><b>{@link file_dst_pathname}</b> Destination file complete path and name</li>
    393. 

  393.  * </ul>
    394. 

  394.  * If the file is a supported image type
    395. 

  395.  * <ul>
    396. 

  396.  *  <li><b>{@link image_dst_x}</b> Destination file width</li>
    397. 

  397.  *  <li><b>{@link image_dst_y}</b> Destination file height</li>
    398. 

  398.  *  <li><b>{@link image_convert}</b> Destination file format</li>
    399. 

  399.  * </ul>
    400. 

  400.  *
    401. 

  401.  * <b>Requirements</b>
    402. 

  402.  *
    403. 

  403.  * Most of the image operations require GD. GD2 is greatly recommended
    404. 

  404.  *
    405. 

  405.  * The class is compatible with PHP 4.3+, and compatible with PHP5
    406. 

  406.  *
    407. 

  407.  * <b>Changelog</b>
    408. 

  408.  * <ul>
    409. 

  409.  *  <li><b>v 0.31</b> 11/04/2011<br>
    410. 

  410.  *   - added application/x-rar MIME type<br>
    411. 

  411.  *   - make sure exec() and ini_get_all()function are not disabled if we want to use them<br>
    412. 

  412.  *   - make sure that we don't divide by zero when calculating JPEG size<br>
    413. 

  413.  *   - {@link allowed} and {@link forbidden} can now accept strings<br>
    414. 

  414.  *   - try to guess the file extension from the MIME type if there is no file extension<br>
    415. 

  415.  *   - better class properties when changing the file extension<br>
    416. 

  416.  *   - added {@link file_force_extension} to allow extension-less files if needed<br>
    417. 

  417.  *   - better file safe conversion of the filename<br>
    418. 

  418.  *   - allow shorthand byte values, such as 1K, 2M, 3G for {@link file_max_size} and {@link jpeg_size}<br>
    419. 

  419.  *   - added {@link image_opacity} to change picture opacity<br>
    420. 

  420.  *   - added {@link image_border_opacity} to allow semi-transparent borders<br>
    421. 

  421.  *   - added {@link image_frame_opacity} to allow semi-transparent frames<br>
    422. 

  422.  *   - added {@link image_border_transparent} to allow borders fading to transparent<br>
    423. 

  423.  *   - duplicated {@link image_overlay_percent} into {@link image_overlay_opacity}<br>
    424. 

  424.  *   - duplicated {@link image_text_percent} into {@link image_text_opacity}<br>
    425. 

  425.  *   - duplicated {@link image_text_background_percent} into {@link image_text_background_opacity}</li>
    426. 

  426.  *  <li><b>v 0.30</b> 05/09/2010<br>
    427. 

  427.  *   - implemented an unsharp mask, with alpha transparency support, activated if {@link image_unsharp} is true. added {@link image_unsharp_amount}, {@link image_unsharp_radius}, and {@link image_unsharp_threshold}<br>
    428. 

  428.  *   - added text/rtf MIME type, and no_script exception<br>
    429. 

  429.  *   - corrected bug when {@link no_script} is activated and several process() are called<br>
    430. 

  430.  *   - better error handling for finfo<br>
    431. 

  431.  *   - display upload_max_filesize information from php.ini in the log<br>
    432. 

  432.  *   - automatic extension for extension-less images<br>
    433. 

  433.  *   - fixed {@link image_ratio_fill} top and left filling<br>
    434. 

  434.  *   - fixed alphablending issue when applying a transparent PNG watermark on a transparent PNG<br>
    435. 

  435.  *   - added {@link image_watermark_no_zoom_in} and {@link image_watermark_no_zoom_out} to allow the watermark to be resized down (or up) to fit in the image. By default, the watermark may be resized down, but not up.</li>
    436. 

  436.  *  <li><b>v 0.29</b> 03/02/2010<br>
    437. 

  437.  *   - added protection against malicious images<br>
    438. 

  438.  *   - added zip and torrent MIME type<br>
    439. 

  439.  *   - replaced split() with explode()<br>
    440. 

  440.  *   - initialise image_dst_x/y with image_src_x/y<br>
    441. 

  441.  *   - removed {@link mime_fileinfo}, {@link mime_file}, {@link mime_magic} and {@link mime_getimagesize} from the docs since they are used before {@link process}<br>
    442. 

  442.  *   - added more extensions and MIME types<br>
    443. 

  443.  *   - improved MIME type validation<br>
    444. 

  444.  *   - improved logging</li>
    445. 

  445.  *  <li><b>v 0.28</b> 10/08/2009<br>
    446. 

  446.  *   - replaced ereg functions to be compatible with PHP 5.3<br>
    447. 

  447.  *   - added flv MIME type<br>
    448. 

  448.  *   - improved MIME type detection<br>
    449. 

  449.  *   - added {@link file_name_body_pre} to prepend a string to the file name<br>
    450. 

  450.  *   - added {@link mime_fileinfo}, {@link mime_file}, {@link mime_magic} and {@link mime_getimagesize} so that it is possible to deactivate some MIME type checking method<br>
    451. 

  451.  *   - use exec() rather than shell_exec(), to play better with safe mode <br>
    452. 

  452.  *   - added some error messages<br>
    453. 

  453.  *   - fix bug when checking on conditions, {@link processed} wasn't propagated properly</li>
    454. 

  454.  *  <li><b>v 0.27</b> 14/05/2009<br>
    455. 

  455.  *   - look for the language files directory from __FILE__<br>
    456. 

  456.  *   - deactivate {@link file_auto_rename} if {@link file_overwrite} is set<br>
    457. 

  457.  *   - improved transparency replacement for true color images<br>
    458. 

  458.  *   - fixed calls to newer version of UNIX file utility<br>
    459. 

  459.  *   - fixed error when using PECL Fileinfo extension in SAFE MODE, and when using the finfo class<br>
    460. 

  460.  *   - added {@link image_precrop} to crop the image before an eventual resizing</li>
    461. 

  461.  *  <li><b>v 0.26</b> 13/11/2008<br>
    462. 

  462.  *   - rewrote conversion from palette to true color to handle transparency better<br>
    463. 

  463.  *   - fixed imagecopymergealpha() when the overlayed image is of wrong dimensions<br>
    464. 

  464.  *   - fixed imagecreatenew() when the image to create have less than 1 pixels width or height<br>
    465. 

  465.  *   - rewrote MIME type detection to be more secure and not rely on browser information; now using Fileinfo PECL extension, UNIX file() command, MIME magic, and getimagesize(), in that order<br>
    466. 

  466.  *   - added support for Flash uploaders<br>
    467. 

  467.  *   - some bug fixing and error handling</li>
    468. 

  468.  *  <li><b>v 0.25</b> 17/11/2007<br>
    469. 

  469.  *   - added translation files and mechanism to instantiate the class with a language different from English<br>
    470. 

  470.  *   - added {@link forbidden} to set an array of forbidden MIME types<br>
    471. 

  471.  *   - implemented support for simple wildcards in {@link allowed} and {@link forbidden}, such as image/*<br>
    472. 

  472.  *   - preset the file extension to the desired conversion format when converting an image<br>
    473. 

  473.  *   - added read and write support for BMP images<br>
    474. 

  474.  *   - added a flag {@link file_is_image} to determine if the file is a supported image type<br>
    475. 

  475.  *   - 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 image_src_type}. Note that this will not work if <i>open_basedir</i> restrictions are in place<br>
    476. 

  476.  *   - improved logging; now provides useful system information<br>
    477. 

  477.  *   - added some more pre-processing checks for files that are images: {@link image_max_width}, {@link image_max_height}, {@link image_max_pixels}, {@link image_max_ratio}, {@link image_min_width}, {@link image_min_height}, {@link image_min_pixels} and {@link image_min_ratio}<br>
    478. 

  478.  *   - added {@link image_ratio_pixels} to resize an image to a number of pixels, keeping aspect ratio<br>
    479. 

  479.  *   - added {@link image_is_palette} and {@link image_is_transparent} and {@link image_transparent_color} for GIF images<br>
    480. 

  480.  *   - added {@link image_default_color} to define a fallback color for non alpha-transparent output formats, such as JPEG or BMP<br>
    481. 

  481.  *   - changed {@link image_background_color}, which now forces transparent areas to be painted<br>
    482. 

  482.  *   - improved reflections and color overlays so that it works with alpha transparent images<br>
    483. 

  483.  *   - {@link image_reflection_color} is now deprecated in favour of {@link image_default_color}<br />
    484. 

  484.  *   - transparent PNGs are now processed in true color, and fully preserving the alpha channel when doing merges<br>
    485. 

  485.  *   - transparent GIFs are now automatically detected. {@link preserve_transparency} is deprecated<br>
    486. 

  486.  *   - transparent true color images can be saved as GIF while retaining transparency, semi transparent areas being merged with {@link image_default_color}<br>
    487. 

  487.  *   - transparent true color images can be saved as JPG/BMP with the semi transparent areas being merged with {@link image_default_color}<br>
    488. 

  488.  *   - fixed conversion of images to true color<br>
    489. 

  489.  *   - the class can now output the uploaded files content as the return value of process() if the function is called with an empty or null argumenti, or no argument</li>
    490. 

  490.  *  <li><b>v 0.24</b> 25/05/2007<br>
    491. 

  491.  *   - added {@link image_background_color}, to set the default background color of an image<br>
    492. 

  492.  *   - added possibility of using replacement tokens in text labels<br>
    493. 

  493.  *   - changed default JPEG quality to 85<br>
    494. 

  494.  *   - fixed a small bug when using greyscale filter and associated filters<br>
    495. 

  495.  *   - added {@link image_ratio_fill} in order to fit an image within some dimensions and color the remaining space. Very similar to {@link image_ratio_crop}<br>
    496. 

  496.  *   - improved the recursive creation of directories<br>
    497. 

  497.  *   - the class now converts palette based images to true colors before doing graphic manipulations</li>
    498. 

  498.  *  <li><b>v 0.23</b> 23/12/2006<br>
    499. 

  499.  *   - fixed a bug when processing more than once the same uploaded file. If there is an open_basedir restriction, the class now creates a temporary file for the first call to process(). This file will be used for subsequent processes, and will be deleted upon calling clean()</li>
    500. 

  500.  *  <li><b>v 0.22</b> 16/12/2006<br>
    501. 

  501.  *   - added automatic creation of a temporary file if the upload directory is not within open_basedir<br>
    502. 

  502.  *   - fixed a bug which was preventing to work on a local file by overwriting it with its processed copy<br>
    503. 

  503.  *   - added MIME types video/x-ms-wmv and image/x-png and fixed PNG support for IE weird MIME types<br>
    504. 

  504.  *   - modified {@link image_ratio_crop} so it can accept one or more from string 'TBLR', determining which side of the image is kept while cropping<br>
    505. 

  505.  *   - added support for multiple lines in the text, using "\n" as a line break<br>
    506. 

  506.  *   - added {@link image_text_line_spacing} which allow to set the space between several lines of text<br>
    507. 

  507.  *   - added {@link image_text_alignment} which allow to set the alignment when text has several lines<br>
    508. 

  508.  *   - {@link image_text_font} can now be set to the path of a GDF font to load external fonts<br>
    509. 

  509.  *   - added {@link image_reflection_height} to create a reflection of the source image, which height is in pixels or percentage<br>
    510. 

  510.  *   - added {@link image_reflection_space} to set the space in pixels between the source image and the reflection<br>
    511. 

  511.  *   - added {@link image_reflection_color} to set the reflection background color<br>
    512. 

  512.  *   - added {@link image_reflection_opacity} to set the initial level of opacity of the reflection</li>
    513. 

  513.  *  <li><b>v 0.21</b> 30/09/2006<br>
    514. 

  514.  *   - 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 image<br>
    515. 

  515.  *   - added {@link mime_check}, which default is true, to set checks against {@link allowed} MIME list<br>
    516. 

  516.  *   - if MIME is empty, the class now triggers an error<br>
    517. 

  517.  *   - color #000000 is OK for {@link image_text_color}, and related text transparency bug fixed<br>
    518. 

  518.  *   - {@link gd_version}() now uses gd_info(), or else phpinfo()<br>
    519. 

  519.  *   - fixed path issue when the destination path has no trailing slash on Windows systems <br>
    520. 

  520.  *   - removed inline functions to be fully PHP5 compatible </li>
    521. 

  521.  *  <li><b>v 0.20</b> 11/08/2006<br>
    522. 

  522.  *   - added some more error checking and messages (GD presence, permissions...)<br>
    523. 

  523.  *   - fix when uploading files without extension<br>
    524. 

  524.  *   - changed values for {@link image_brightness} and {@link image_contrast} to be between -127 and 127<br>
    525. 

  525.  *   - added {@link dir_auto_create} to automatically and recursively create destination directory if missing.<br>
    526. 

  526.  *   - added {@link dir_auto_chmod} to automatically chmod the destination directory if not writeable.<br>
    527. 

  527.  *   - added {@link dir_chmod} to set the default chmod to use.<br>
    528. 

  528.  *   - added {@link image_crop} to crop images<br>
    529. 

  529.  *   - added {@link image_negative} to invert the colors on the image<br>
    530. 

  530.  *   - added {@link image_greyscale} to turn the image into greyscale<br>
    531. 

  531.  *   - added {@link image_threshold} to apply a threshold filter on the image<br>
    532. 

  532.  *   - added {@link image_bevel}, {@link image_bevel_color1} and {@link image_bevel_color2} to add a bevel border<br>
    533. 

  533.  *   - added {@link image_border} and {@link image_border_color} to add a single color border<br>
    534. 

  534.  *   - added {@link image_frame} and {@link image_frame_colors} to add a multicolored frame</li>
    535. 

  535.  *  <li><b>v 0.19</b> 29/03/2006<br>
    536. 

  536.  *   - class is now compatible i18n (thanks Sylwester).<br>
    537. 

  537.  *   - the class can mow manipulate local files, not only uploaded files (instanciate the class with a local filename).<br>
    538. 

  538.  *   - {@link file_safe_name} has been improved a bit.<br>
    539. 

  539.  *   - added {@link image_brightness}, {@link image_contrast}, {@link image_tint_color}, {@link image_overlay_color} and {@link image_overlay_percent} to do color manipulation on the images.<br>
    540. 

  540.  *   - added {@link image_text} and all derivated settings to add a text label on the image.<br>
    541. 

  541.  *   - added {@link image_watermark} and all derivated settings to add a watermark image on the image.<br>
    542. 

  542.  *   - added {@link image_flip} and {@link image_rotate} for more image manipulations<br>
    543. 

  543.  *   - added {@link jpeg_size} to calculate the JPG compression quality in order to fit within one filesize.</li>
    544. 

  544.  *  <li><b>v 0.18</b> 02/02/2006<br>
    545. 

  545.  *   - added {@link no_script} to turn dangerous scripts into text files.<br>
    546. 

  546.  *   - added {@link mime_magic_check} to set the class to use mime_magic.<br>
    547. 

  547.  *   - added {@link preserve_transparency} *experimental*. Thanks Gregor.<br>
    548. 

  548.  *   - fixed size and mime checking, wasn't working :/ Thanks Willem.<br>
    549. 

  549.  *   - fixed memory leak when resizing images.<br>
    550. 

  550.  *   - when resizing, it is not necessary anymore to set {@link image_convert}.<br>
    551. 

  551.  *   - il is now possible to simply convert an image, with no resizing.<br>
    552. 

  552.  *   - sets the default {@link file_max_size} to upload_max_filesize from php.ini. Thanks Edward</li>
    553. 

  553.  *  <li><b>v 0.17</b> 28/05/2005<br>
    554. 

  554.  *   - the class can be used with any version of GD.<br>
    555. 

  555.  *   - added security check on the file with a list of mime-types.<br>
    556. 

  556.  *   - changed the license to GPL v2 only</li>
    557. 

  557.  *  <li><b>v 0.16</b> 19/05/2005<br>
    558. 

  558.  *   - added {@link file_auto_rename} automatic file renaming if the same filename already exists.<br>
    559. 

  559.  *   - added {@link file_safe_name} safe formatting of the filename (spaces to _underscores so far).<br>
    560. 

  560.  *   - added some more error reporting to avoid crash if GD is not present</li>
    561. 

  561.  *  <li><b>v 0.15</b> 16/04/2005<br>
    562. 

  562.  *   - added JPEG compression quality setting. Thanks Vad</li>
    563. 

  563.  *  <li><b>v 0.14</b> 14/03/2005<br>
    564. 

  564.  *   - reworked the class file to allow parsing with phpDocumentor</li>
    565. 

  565.  *  <li><b>v 0.13</b> 07/03/2005<br>
    566. 

  566.  *   - fixed a bug with {@link image_ratio}. Thanks Justin.<br>
    567. 

  567.  *   - added {@link image_ratio_no_zoom_in} and {@link image_ratio_no_zoom_out} </li>
    568. 

  568.  *  <li><b>v 0.12</b> 21/01/2005<br>
    569. 

  569.  *   - added {@link image_ratio} to resize within max values, keeping image ratio</li>
    570. 

  570.  *  <li><b>v 0.11</b> 22/08/2003<br>
    571. 

  571.  *   - update for GD2 (changed imageresized() into imagecopyresampled() and imagecreate() into imagecreatetruecolor())</li>
    572. 

  572.  * </ul>
    573. 

  573.  *
    574. 

  574.  * @package   cmf
    575. 

  575.  * @subpackage external
    576. 

  576.  */
    577. 

  577. class Upload {
    578. 

  578. 

  579. 

  580.     /**
    581. 

  581.      * Class version
    582. 

  582.      *
    583. 

  583.      * @access public
    584. 

  584.      * @var string
    585. 

  585.      */
    586. 

  586.     var $version;
    587. 

  587. 

  588.     /**
    589. 

  589.      * Uploaded file name
    590. 

  590.      *
    591. 

  591.      * @access public
    592. 

  592.      * @var string
    593. 

  593.      */
    594. 

  594.     var $file_src_name;
    595. 

  595. 

  596.     /**
    597. 

  597.      * Uploaded file name body (i.e. without extension)
    598. 

  598.      *
    599. 

  599.      * @access public
    600. 

  600.      * @var string
    601. 

  601.      */
    602. 

  602.     var $file_src_name_body;
    603. 

  603. 

  604.     /**
    605. 

  605.      * Uploaded file name extension
    606. 

  606.      *
    607. 

  607.      * @access public
    608. 

  608.      * @var string
    609. 

  609.      */
    610. 

  610.     var $file_src_name_ext;
    611. 

  611. 

  612.     /**
    613. 

  613.      * Uploaded file MIME type
    614. 

  614.      *
    615. 

  615.      * @access public
    616. 

  616.      * @var string
    617. 

  617.      */
    618. 

  618.     var $file_src_mime;
    619. 

  619. 

  620.     /**
    621. 

  621.      * Uploaded file size, in bytes
    622. 

  622.      *
    623. 

  623.      * @access public
    624. 

  624.      * @var double
    625. 

  625.      */
    626. 

  626.     var $file_src_size;
    627. 

  627. 

  628.     /**
    629. 

  629.      * Holds eventual PHP error code from $_FILES
    630. 

  630.      *
    631. 

  631.      * @access public
    632. 

  632.      * @var string
    633. 

  633.      */
    634. 

  634.     var $file_src_error;
    635. 

  635. 

  636.     /**
    637. 

  637.      * Uloaded file name, including server path
    638. 

  638.      *
    639. 

  639.      * @access public
    640. 

  640.      * @var string
    641. 

  641.      */
    642. 

  642.     var $file_src_pathname;
    643. 

  643. 

  644.     /**
    645. 

  645.      * Uloaded file name temporary copy
    646. 

  646.      *
    647. 

  647.      * @access private
    648. 

  648.      * @var string
    649. 

  649.      */
    650. 

  650.     var $file_src_temp;
    651. 

  651. 

  652.     /**
    653. 

  653.      * Destination file name
    654. 

  654.      *
    655. 

  655.      * @access public
    656. 

  656.      * @var string
    657. 

  657.      */
    658. 

  658.     var $file_dst_path;
    659. 

  659. 

  660.     /**
    661. 

  661.      * Destination file name
    662. 

  662.      *
    663. 

  663.      * @access public
    664. 

  664.      * @var string
    665. 

  665.      */
    666. 

  666.     var $file_dst_name;
    667. 

  667. 

  668.     /**
    669. 

  669.      * Destination file name body (i.e. without extension)
    670. 

  670.      *
    671. 

  671.      * @access public
    672. 

  672.      * @var string
    673. 

  673.      */
    674. 

  674.     var $file_dst_name_body;
    675. 

  675. 

  676.     /**
    677. 

  677.      * Destination file extension
    678. 

  678.      *
    679. 

  679.      * @access public
    680. 

  680.      * @var string
    681. 

  681.      */
    682. 

  682.     var $file_dst_name_ext;
    683. 

  683. 

  684.     /**
    685. 

  685.      * Destination file name, including path
    686. 

  686.      *
    687. 

  687.      * @access public
    688. 

  688.      * @var string
    689. 

  689.      */
    690. 

  690.     var $file_dst_pathname;
    691. 

  691. 

  692.     /**
    693. 

  693.      * Source image width
    694. 

  694.      *
    695. 

  695.      * @access public
    696. 

  696.      * @var integer
    697. 

  697.      */
    698. 

  698.     var $image_src_x;
    699. 

  699. 

  700.     /**
    701. 

  701.      * Source image height
    702. 

  702.      *
    703. 

  703.      * @access public
    704. 

  704.      * @var integer
    705. 

  705.      */
    706. 

  706.     var $image_src_y;
    707. 

  707. 

  708.     /**
    709. 

  709.      * Source image color depth
    710. 

  710.      *
    711. 

  711.      * @access public
    712. 

  712.      * @var integer
    713. 

  713.      */
    714. 

  714.     var $image_src_bits;
    715. 

  715. 

  716.     /**
    717. 

  717.      * Number of pixels
    718. 

  718.      *
    719. 

  719.      * @access public
    720. 

  720.      * @var long
    721. 

  721.      */
    722. 

  722.     var $image_src_pixels;
    723. 

  723. 

  724.     /**
    725. 

  725.      * Type of image (png, gif, jpg or bmp)
    726. 

  726.      *
    727. 

  727.      * @access public
    728. 

  728.      * @var string
    729. 

  729.      */
    730. 

  730.     var $image_src_type;
    731. 

  731. 

  732.     /**
    733. 

  733.      * Destination image width
    734. 

  734.      *
    735. 

  735.      * @access public
    736. 

  736.      * @var integer
    737. 

  737.      */
    738. 

  738.     var $image_dst_x;
    739. 

  739. 

  740.     /**
    741. 

  741.      * Destination image height
    742. 

  742.      *
    743. 

  743.      * @access public
    744. 

  744.      * @var integer
    745. 

  745.      */
    746. 

  746.     var $image_dst_y;
    747. 

  747. 

  748.     /**
    749. 

  749.      * Supported image formats
    750. 

  750.      *
    751. 

  751.      * @access private
    752. 

  752.      * @var array
    753. 

  753.      */
    754. 

  754.     var $image_supported;
    755. 

  755. 

  756.     /**
    757. 

  757.      * Flag to determine if the source file is an image
    758. 

  758.      *
    759. 

  759.      * @access public
    760. 

  760.      * @var boolean
    761. 

  761.      */
    762. 

  762.     var $file_is_image;
    763. 

  763. 

  764.     /**
    765. 

  765.      * Flag set after instanciating the class
    766. 

  766.      *
    767. 

  767.      * Indicates if the file has been uploaded properly
    768. 

  768.      *
    769. 

  769.      * @access public
    770. 

  770.      * @var bool
    771. 

  771.      */
    772. 

  772.     var $uploaded;
    773. 

  773. 

  774.     /**
    775. 

  775.      * Flag stopping PHP upload checks
    776. 

  776.      *
    777. 

  777.      * Indicates whether we instanciated the class with a filename, in which case
    778. 

  778.      * we will not check on the validity of the PHP *upload*
    779. 

  779.      *
    780. 

  780.      * This flag is automatically set to true when working on a local file
    781. 

  781.      *
    782. 

  782.      * Warning: for uploads, this flag MUST be set to false for security reason
    783. 

  783.      *
    784. 

  784.      * @access public
    785. 

  785.      * @var bool
    786. 

  786.      */
    787. 

  787.     var $no_upload_check;
    788. 

  788. 

  789.     /**
    790. 

  790.      * Flag set after calling a process
    791. 

  791.      *
    792. 

  792.      * Indicates if the processing, and copy of the resulting file went OK
    793. 

  793.      *
    794. 

  794.      * @access public
    795. 

  795.      * @var bool
    796. 

  796.      */
    797. 

  797.     var $processed;
    798. 

  798. 

  799.     /**
    800. 

  800.      * Holds eventual error message in plain english
    801. 

  801.      *
    802. 

  802.      * @access public
    803. 

  803.      * @var string
    804. 

  804.      */
    805. 

  805.     var $error;
    806. 

  806. 

  807.     /**
    808. 

  808.      * Holds an HTML formatted log
    809. 

  809.      *
    810. 

  810.      * @access public
    811. 

  811.      * @var string
    812. 

  812.      */
    813. 

  813.     var $log;
    814. 

  814. 

  815. 

  816.     // overiddable processing variables
    817. 

  817. 

  818. 

  819.     /**
    820. 

  820.      * Set this variable to replace the name body (i.e. without extension)
    821. 

  821.      *
    822. 

  822.      * @access public
    823. 

  823.      * @var string
    824. 

  824.      */
    825. 

  825.     var $file_new_name_body;
    826. 

  826. 

  827.     /**
    828. 

  828.      * Set this variable to append a string to the file name body
    829. 

  829.      *
    830. 

  830.      * @access public
    831. 

  831.      * @var string
    832. 

  832.      */
    833. 

  833.     var $file_name_body_add;
    834. 

  834. 

  835.     /**
    836. 

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

  837.      *
    838. 

  838.      * @access public
    839. 

  839.      * @var string
    840. 

  840.      */
    841. 

  841.     var $file_name_body_pre;
    842. 

  842. 

  843.     /**
    844. 

  844.      * Set this variable to change the file extension
    845. 

  845.      *
    846. 

  846.      * @access public
    847. 

  847.      * @var string
    848. 

  848.      */
    849. 

  849.     var $file_new_name_ext;
    850. 

  850. 

  851.     /**
    852. 

  852.      * Set this variable to format the filename (spaces changed to _)
    853. 

  853.      *
    854. 

  854.      * @access public
    855. 

  855.      * @var boolean
    856. 

  856.      */
    857. 

  857.     var $file_safe_name;
    858. 

  858. 

  859.     /**
    860. 

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

  861.      *
    862. 

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

  863.      * Otherwise, a .txt extension will be chosen
    864. 

  864.      *
    865. 

  865.      * @access public
    866. 

  866.      * @var boolean
    867. 

  867.      */
    868. 

  868.     var $file_force_extension;
    869. 

  869. 

  870.     /**
    871. 

  871.      * Set this variable to false if you don't want to check the MIME against the allowed list
    872. 

  872.      *
    873. 

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

  874.      *
    875. 

  875.      * @access public
    876. 

  876.      * @var boolean
    877. 

  877.      */
    878. 

  878.     var $mime_check;
    879. 

  879. 

  880.     /**
    881. 

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

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

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

  884.      *
    885. 

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

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

  887.      *   and if it is empty, will default to '/usr/share/file/magic'
    888. 

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

  889.      *
    890. 

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

  891.      *
    892. 

  892.      * @access public
    893. 

  893.      * @var boolean
    894. 

  894.      */
    895. 

  895.     var $mime_fileinfo;
    896. 

  896. 

  897.     /**
    898. 

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

  899.      * with UNIX file() command
    900. 

  900.      *
    901. 

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

  902.      *
    903. 

  903.      * @access public
    904. 

  904.      * @var boolean
    905. 

  905.      */
    906. 

  906.     var $mime_file;
    907. 

  907. 

  908.     /**
    909. 

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

  910.      * with the magic.mime file
    911. 

  911.      *
    912. 

  912.      * The function mime_content_type() will be deprecated,
    913. 

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

  914.      *
    915. 

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

  916.      *
    917. 

  917.      * @access public
    918. 

  918.      * @var boolean
    919. 

  919.      */
    920. 

  920.     var $mime_magic;
    921. 

  921. 

  922.     /**
    923. 

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

  924.      * with getimagesize()
    925. 

  925.      *
    926. 

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

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

  928.      *
    929. 

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

  930.      *
    931. 

  931.      * @access public
    932. 

  932.      * @var boolean
    933. 

  933.      */
    934. 

  934.     var $mime_getimagesize;
    935. 

  935. 

  936.     /**
    937. 

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

  938.      *
    939. 

  939.      * @access public
    940. 

  940.      * @var boolean
    941. 

  941.      */
    942. 

  942.     var $no_script;
    943. 

  943. 

  944.     /**
    945. 

  945.      * Set this variable to true to allow automatic renaming of the file
    946. 

  946.      * if the file already exists
    947. 

  947.      *
    948. 

  948.      * Default value is true
    949. 

  949.      *
    950. 

  950.      * For instance, on uploading foo.ext,<br>
    951. 

  951.      * if foo.ext already exists, upload will be renamed foo_1.ext<br>
    952. 

  952.      * and if foo_1.ext already exists, upload will be renamed foo_2.ext<br>
    953. 

  953.      *
    954. 

  954.      * Note that this option doesn't have any effect if {@link file_overwrite} is true
    955. 

  955.      *
    956. 

  956.      * @access public
    957. 

  957.      * @var bool
    958. 

  958.      */
    959. 

  959.     var $file_auto_rename;
    960. 

  960. 

  961.     /**
    962. 

  962.      * Set this variable to true to allow automatic creation of the destination
    963. 

  963.      * directory if it is missing (works recursively)
    964. 

  964.      *
    965. 

  965.      * Default value is true
    966. 

  966.      *
    967. 

  967.      * @access public
    968. 

  968.      * @var bool
    969. 

  969.      */
    970. 

  970.     var $dir_auto_create;
    971. 

  971. 

  972.     /**
    973. 

  973.      * Set this variable to true to allow automatic chmod of the destination
    974. 

  974.      * directory if it is not writeable
    975. 

  975.      *
    976. 

  976.      * Default value is true
    977. 

  977.      *
    978. 

  978.      * @access public
    979. 

  979.      * @var bool
    980. 

  980.      */
    981. 

  981.     var $dir_auto_chmod;
    982. 

  982. 

  983.     /**
    984. 

  984.      * Set this variable to the default chmod you want the class to use
    985. 

  985.      * when creating directories, or attempting to write in a directory
    986. 

  986.      *
    987. 

  987.      * Default value is 0777 (without quotes)
    988. 

  988.      *
    989. 

  989.      * @access public
    990. 

  990.      * @var bool
    991. 

  991.      */
    992. 

  992.     var $d…
    993.

Large files files are truncated, but you can click here to view the full file