blob: a1bd149309431f95517719c2fc36f4b47b77f6ed [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Andrey Andreevfe9309d2015-01-09 17:48:58 +02005 * An open source application development framework for PHP
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +02007 * This content is released under the MIT License (MIT)
Andrey Andreev3a459572011-12-21 11:23:11 +02008 *
Andrey Andreevfe9309d2015-01-09 17:48:58 +02009 * Copyright (c) 2014 - 2015, British Columbia Institute of Technology
Andrey Andreev3a459572011-12-21 11:23:11 +020010 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020011 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
Derek Jonesf4a4bd82011-10-20 12:18:42 -050017 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020018 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 * THE SOFTWARE.
28 *
29 * @package CodeIgniter
30 * @author EllisLab Dev Team
darwinel871754a2014-02-11 17:34:57 +010031 * @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (http://ellislab.com/)
Andrey Andreevfe9309d2015-01-09 17:48:58 +020032 * @copyright Copyright (c) 2014 - 2015, British Columbia Institute of Technology (http://bcit.ca/)
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020033 * @license http://opensource.org/licenses/MIT MIT License
34 * @link http://codeigniter.com
35 * @since Version 1.0.0
Derek Allard2067d1a2008-11-13 22:59:24 +000036 * @filesource
37 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020038defined('BASEPATH') OR exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +000039
Derek Allard2067d1a2008-11-13 22:59:24 +000040/**
41 * File Uploading Class
42 *
43 * @package CodeIgniter
44 * @subpackage Libraries
45 * @category Uploads
Derek Jonesf4a4bd82011-10-20 12:18:42 -050046 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000047 * @link http://codeigniter.com/user_guide/libraries/file_uploading.html
48 */
49class CI_Upload {
Barry Mienydd671972010-10-04 16:33:58 +020050
Andrey Andreevf5ccd122012-11-02 00:17:39 +020051 /**
52 * Maximum file size
53 *
54 * @var int
55 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +020056 public $max_size = 0;
Andrey Andreevf5ccd122012-11-02 00:17:39 +020057
58 /**
59 * Maximum image width
60 *
61 * @var int
62 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +020063 public $max_width = 0;
Andrey Andreevf5ccd122012-11-02 00:17:39 +020064
65 /**
66 * Maximum image height
67 *
68 * @var int
69 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +020070 public $max_height = 0;
Andrey Andreevf5ccd122012-11-02 00:17:39 +020071
72 /**
Andrey Andreev05aa2d62012-12-03 16:06:55 +020073 * Minimum image width
74 *
75 * @var int
76 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +020077 public $min_width = 0;
Andrey Andreev05aa2d62012-12-03 16:06:55 +020078
79 /**
80 * Minimum image height
81 *
82 * @var int
83 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +020084 public $min_height = 0;
Andrey Andreev05aa2d62012-12-03 16:06:55 +020085
86 /**
Andrey Andreevf5ccd122012-11-02 00:17:39 +020087 * Maximum filename length
88 *
89 * @var int
90 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +020091 public $max_filename = 0;
Andrey Andreevf5ccd122012-11-02 00:17:39 +020092
93 /**
94 * Maximum duplicate filename increment ID
95 *
96 * @var int
97 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +020098 public $max_filename_increment = 100;
Andrey Andreevf5ccd122012-11-02 00:17:39 +020099
100 /**
101 * Allowed file types
102 *
103 * @var string
104 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200105 public $allowed_types = '';
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200106
107 /**
108 * Temporary filename
109 *
110 * @var string
111 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200112 public $file_temp = '';
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200113
114 /**
115 * Filename
116 *
117 * @var string
118 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200119 public $file_name = '';
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200120
121 /**
122 * Original filename
123 *
124 * @var string
125 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200126 public $orig_name = '';
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200127
128 /**
129 * File type
130 *
131 * @var string
132 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200133 public $file_type = '';
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200134
135 /**
136 * File size
137 *
138 * @var int
139 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200140 public $file_size = NULL;
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200141
142 /**
143 * Filename extension
144 *
145 * @var string
146 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200147 public $file_ext = '';
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200148
149 /**
Adrianf496d132013-06-24 15:56:45 +0200150 * Force filename extension to lowercase
151 *
152 * @var string
153 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200154 public $file_ext_tolower = FALSE;
Adrianf496d132013-06-24 15:56:45 +0200155
156 /**
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200157 * Upload path
158 *
159 * @var string
160 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200161 public $upload_path = '';
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200162
163 /**
164 * Overwrite flag
165 *
166 * @var bool
167 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200168 public $overwrite = FALSE;
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200169
170 /**
171 * Obfuscate filename flag
172 *
173 * @var bool
174 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200175 public $encrypt_name = FALSE;
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200176
177 /**
178 * Is image flag
179 *
180 * @var bool
181 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200182 public $is_image = FALSE;
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200183
184 /**
185 * Image width
186 *
187 * @var int
188 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200189 public $image_width = NULL;
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200190
191 /**
192 * Image height
193 *
194 * @var int
195 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200196 public $image_height = NULL;
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200197
198 /**
199 * Image type
200 *
201 * @var string
202 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200203 public $image_type = '';
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200204
205 /**
206 * Image size string
207 *
208 * @var string
209 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200210 public $image_size_str = '';
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200211
212 /**
213 * Error messages list
214 *
215 * @var array
216 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200217 public $error_msg = array();
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200218
219 /**
220 * Remove spaces flag
221 *
222 * @var bool
223 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200224 public $remove_spaces = TRUE;
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200225
226 /**
227 * MIME detection flag
228 *
229 * @var bool
230 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200231 public $detect_mime = TRUE;
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200232
233 /**
234 * XSS filter flag
235 *
236 * @var bool
237 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200238 public $xss_clean = FALSE;
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200239
240 /**
Andrey Andreev32c72122013-10-21 15:35:05 +0300241 * Apache mod_mime fix flag
242 *
243 * @var bool
244 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200245 public $mod_mime_fix = TRUE;
Andrey Andreev32c72122013-10-21 15:35:05 +0300246
247 /**
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200248 * Temporary filename prefix
249 *
250 * @var string
251 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200252 public $temp_prefix = 'temp_file_';
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200253
254 /**
255 * Filename sent by the client
256 *
257 * @var bool
258 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200259 public $client_name = '';
Barry Mienydd671972010-10-04 16:33:58 +0200260
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200261 // --------------------------------------------------------------------
262
263 /**
264 * Filename override
265 *
266 * @var string
267 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200268 protected $_file_name_override = '';
269
270 /**
271 * MIME types list
272 *
273 * @var array
274 */
275 protected $_mimes = array();
Barry Mienydd671972010-10-04 16:33:58 +0200276
Andrey Andreev119d8a72014-01-08 15:27:53 +0200277 /**
278 * CI Singleton
279 *
280 * @var object
281 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200282 protected $_CI;
Andrey Andreev119d8a72014-01-08 15:27:53 +0200283
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200284 // --------------------------------------------------------------------
285
Derek Allard2067d1a2008-11-13 22:59:24 +0000286 /**
287 * Constructor
288 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200289 * @param array $props
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300290 * @return void
Derek Allard2067d1a2008-11-13 22:59:24 +0000291 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200292 public function __construct($config = array())
Derek Allard2067d1a2008-11-13 22:59:24 +0000293 {
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200294 empty($config) OR $this->initialize($config, FALSE);
Barry Mienydd671972010-10-04 16:33:58 +0200295
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200296 $this->_mimes =& get_mimes();
297 $this->_CI =& get_instance();
Andrey Andreev6ef498b2012-06-05 22:01:58 +0300298
Andrey Andreev90726b82015-01-20 12:39:22 +0200299 log_message('info', 'Upload Class Initialized');
Derek Allard2067d1a2008-11-13 22:59:24 +0000300 }
Barry Mienydd671972010-10-04 16:33:58 +0200301
Derek Allard2067d1a2008-11-13 22:59:24 +0000302 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200303
Derek Allard2067d1a2008-11-13 22:59:24 +0000304 /**
305 * Initialize preferences
306 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200307 * @param array $config
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200308 * @param bool $reset
309 * @return CI_Upload
Barry Mienydd671972010-10-04 16:33:58 +0200310 */
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200311 public function initialize(array $config = array(), $reset = TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000312 {
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200313 $reflection = new ReflectionClass($this);
Barry Mienydd671972010-10-04 16:33:58 +0200314
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200315 if ($reset === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000316 {
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200317 $defaults = $reflection->getDefaultProperties();
318 foreach (array_keys($defaults) as $key)
Derek Allard2067d1a2008-11-13 22:59:24 +0000319 {
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200320 if ($key[0] === '_')
Derek Allard2067d1a2008-11-13 22:59:24 +0000321 {
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200322 continue;
323 }
324
325 if (isset($config[$key]))
326 {
327 if ($reflection->hasMethod('set_'.$key))
328 {
329 $this->{'set_'.$key}($config[$key]);
330 }
331 else
332 {
333 $this->$key = $config[$key];
334 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000335 }
336 else
337 {
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200338 $this->$key = $defaults[$key];
Barry Mienydd671972010-10-04 16:33:58 +0200339 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000340 }
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200341 }
Joseba Juániza8027ff2014-08-06 20:03:25 +0200342 else
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200343 {
Joseba Juániza8027ff2014-08-06 20:03:25 +0200344 foreach ($config as $key => &$value)
Derek Allard2067d1a2008-11-13 22:59:24 +0000345 {
Joseba Juániza8027ff2014-08-06 20:03:25 +0200346 if ($key[0] !== '_' && $reflection->hasProperty($key))
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200347 {
Joseba Juániza8027ff2014-08-06 20:03:25 +0200348 if ($reflection->hasMethod('set_'.$key))
349 {
350 $this->{'set_'.$key}($value);
351 }
352 else
353 {
354 $this->$key = $value;
355 }
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200356 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000357 }
358 }
Barry Mienydd671972010-10-04 16:33:58 +0200359
Derek Jonese9d723f2010-07-12 10:10:59 -0500360 // if a file_name was provided in the config, use it instead of the user input
361 // supplied file name for all uploads until initialized again
362 $this->_file_name_override = $this->file_name;
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200363 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000364 }
Barry Mienydd671972010-10-04 16:33:58 +0200365
Derek Allard2067d1a2008-11-13 22:59:24 +0000366 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200367
Derek Allard2067d1a2008-11-13 22:59:24 +0000368 /**
369 * Perform the file upload
370 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200371 * @param string $field
Derek Allard2067d1a2008-11-13 22:59:24 +0000372 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +0200373 */
Greg Aker58fdee82010-11-10 15:07:09 -0600374 public function do_upload($field = 'userfile')
Derek Allard2067d1a2008-11-13 22:59:24 +0000375 {
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300376 // Is $_FILES[$field] set? If not, no reason to continue.
Andrey Andreeve7d017b2014-02-25 12:23:34 +0200377 if (isset($_FILES[$field]))
378 {
379 $_file = $_FILES[$field];
380 }
381 // Does the field name contain array notation?
382 elseif (($c = preg_match_all('/(?:^[^\[]+)|\[[^]]*\]/', $field, $matches)) > 1)
383 {
384 $_file = $_FILES;
385 for ($i = 0; $i < $c; $i++)
386 {
387 // We can't track numeric iterations, only full field names are accepted
388 if (($field = trim($matches[0][$i], '[]')) === '' OR ! isset($_file[$field]))
389 {
390 $_file = NULL;
391 break;
392 }
393
394 $_file = $_file[$field];
395 }
396 }
397
398 if ( ! isset($_file))
Derek Allard2067d1a2008-11-13 22:59:24 +0000399 {
Andrey Andreevd5784082015-06-22 11:50:04 +0300400 $this->set_error('upload_no_file_selected', 'debug');
Derek Allard2067d1a2008-11-13 22:59:24 +0000401 return FALSE;
402 }
Barry Mienydd671972010-10-04 16:33:58 +0200403
Derek Allard2067d1a2008-11-13 22:59:24 +0000404 // Is the upload path valid?
405 if ( ! $this->validate_upload_path())
406 {
407 // errors will already be set by validate_upload_path() so just return FALSE
408 return FALSE;
409 }
410
411 // Was the file able to be uploaded? If not, determine the reason why.
Andrey Andreeve7d017b2014-02-25 12:23:34 +0200412 if ( ! is_uploaded_file($_file['tmp_name']))
Derek Allard2067d1a2008-11-13 22:59:24 +0000413 {
Andrey Andreeve7d017b2014-02-25 12:23:34 +0200414 $error = isset($_file['error']) ? $_file['error'] : 4;
Derek Allard2067d1a2008-11-13 22:59:24 +0000415
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300416 switch ($error)
Derek Allard2067d1a2008-11-13 22:59:24 +0000417 {
Darren Benneye123a602013-03-30 18:17:54 +0000418 case UPLOAD_ERR_INI_SIZE:
Andrey Andreevd5784082015-06-22 11:50:04 +0300419 $this->set_error('upload_file_exceeds_limit', 'info');
Derek Allard2067d1a2008-11-13 22:59:24 +0000420 break;
Darren Benneye123a602013-03-30 18:17:54 +0000421 case UPLOAD_ERR_FORM_SIZE:
Andrey Andreevd5784082015-06-22 11:50:04 +0300422 $this->set_error('upload_file_exceeds_form_limit', 'info');
Derek Allard2067d1a2008-11-13 22:59:24 +0000423 break;
Darren Benneye123a602013-03-30 18:17:54 +0000424 case UPLOAD_ERR_PARTIAL:
Andrey Andreevd5784082015-06-22 11:50:04 +0300425 $this->set_error('upload_file_partial', 'debug');
Derek Allard2067d1a2008-11-13 22:59:24 +0000426 break;
Darren Benneye123a602013-03-30 18:17:54 +0000427 case UPLOAD_ERR_NO_FILE:
Andrey Andreevd5784082015-06-22 11:50:04 +0300428 $this->set_error('upload_no_file_selected', 'debug');
Derek Allard2067d1a2008-11-13 22:59:24 +0000429 break;
Darren Benneye123a602013-03-30 18:17:54 +0000430 case UPLOAD_ERR_NO_TMP_DIR:
Andrey Andreevd5784082015-06-22 11:50:04 +0300431 $this->set_error('upload_no_temp_directory', 'error');
Derek Allard2067d1a2008-11-13 22:59:24 +0000432 break;
Darren Benneye123a602013-03-30 18:17:54 +0000433 case UPLOAD_ERR_CANT_WRITE:
Andrey Andreevd5784082015-06-22 11:50:04 +0300434 $this->set_error('upload_unable_to_write_file', 'error');
Derek Allard2067d1a2008-11-13 22:59:24 +0000435 break;
Darren Benneye123a602013-03-30 18:17:54 +0000436 case UPLOAD_ERR_EXTENSION:
Andrey Andreevd5784082015-06-22 11:50:04 +0300437 $this->set_error('upload_stopped_by_extension', 'debug');
Derek Allard2067d1a2008-11-13 22:59:24 +0000438 break;
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300439 default:
Andrey Andreevd5784082015-06-22 11:50:04 +0300440 $this->set_error('upload_no_file_selected', 'debug');
Derek Allard2067d1a2008-11-13 22:59:24 +0000441 break;
442 }
443
444 return FALSE;
445 }
446
447 // Set the uploaded data as class variables
Andrey Andreeve7d017b2014-02-25 12:23:34 +0200448 $this->file_temp = $_file['tmp_name'];
449 $this->file_size = $_file['size'];
Andrey Andreevd60e7002012-06-17 00:03:03 +0300450
451 // Skip MIME type detection?
452 if ($this->detect_mime !== FALSE)
453 {
Andrey Andreeve7d017b2014-02-25 12:23:34 +0200454 $this->_file_mime_type($_file);
Andrey Andreevd60e7002012-06-17 00:03:03 +0300455 }
456
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300457 $this->file_type = preg_replace('/^(.+?);.*$/', '\\1', $this->file_type);
Derek Jones616fb022010-04-22 16:52:18 -0500458 $this->file_type = strtolower(trim(stripslashes($this->file_type), '"'));
Andrey Andreeve7d017b2014-02-25 12:23:34 +0200459 $this->file_name = $this->_prep_filename($_file['name']);
Derek Jonese9d723f2010-07-12 10:10:59 -0500460 $this->file_ext = $this->get_extension($this->file_name);
461 $this->client_name = $this->file_name;
Barry Mienydd671972010-10-04 16:33:58 +0200462
Derek Allard2067d1a2008-11-13 22:59:24 +0000463 // Is the file type allowed to be uploaded?
464 if ( ! $this->is_allowed_filetype())
465 {
Andrey Andreevd5784082015-06-22 11:50:04 +0300466 $this->set_error('upload_invalid_filetype', 'debug');
Derek Allard2067d1a2008-11-13 22:59:24 +0000467 return FALSE;
468 }
469
Derek Jonese9d723f2010-07-12 10:10:59 -0500470 // if we're overriding, let's now make sure the new name and type is allowed
Alex Bilbied261b1e2012-06-02 11:12:16 +0100471 if ($this->_file_name_override !== '')
Derek Jonese9d723f2010-07-12 10:10:59 -0500472 {
473 $this->file_name = $this->_prep_filename($this->_file_name_override);
Phil Sturgeon1e74da22010-12-15 10:45:06 +0000474
475 // If no extension was provided in the file_name config item, use the uploaded one
Pascal Kriete14287f32011-02-14 13:39:34 -0500476 if (strpos($this->_file_name_override, '.') === FALSE)
Phil Sturgeon1e74da22010-12-15 10:45:06 +0000477 {
478 $this->file_name .= $this->file_ext;
479 }
Phil Sturgeon1e74da22010-12-15 10:45:06 +0000480 else
481 {
vlakoff35672462013-02-15 01:36:04 +0100482 // An extension was provided, let's have it!
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300483 $this->file_ext = $this->get_extension($this->_file_name_override);
Phil Sturgeon1e74da22010-12-15 10:45:06 +0000484 }
Derek Jonese9d723f2010-07-12 10:10:59 -0500485
486 if ( ! $this->is_allowed_filetype(TRUE))
487 {
Andrey Andreevd5784082015-06-22 11:50:04 +0300488 $this->set_error('upload_invalid_filetype', 'debug');
Barry Mienydd671972010-10-04 16:33:58 +0200489 return FALSE;
Derek Jonese9d723f2010-07-12 10:10:59 -0500490 }
491 }
Barry Mienydd671972010-10-04 16:33:58 +0200492
Derek Jonese9d723f2010-07-12 10:10:59 -0500493 // Convert the file size to kilobytes
494 if ($this->file_size > 0)
495 {
496 $this->file_size = round($this->file_size/1024, 2);
497 }
498
Derek Allard2067d1a2008-11-13 22:59:24 +0000499 // Is the file size within the allowed maximum?
500 if ( ! $this->is_allowed_filesize())
501 {
Andrey Andreevd5784082015-06-22 11:50:04 +0300502 $this->set_error('upload_invalid_filesize', 'info');
Derek Allard2067d1a2008-11-13 22:59:24 +0000503 return FALSE;
504 }
505
506 // Are the image dimensions within the allowed size?
vlakoffc941d852013-08-06 14:44:40 +0200507 // Note: This can fail if the server has an open_basedir restriction.
Derek Allard2067d1a2008-11-13 22:59:24 +0000508 if ( ! $this->is_allowed_dimensions())
509 {
Andrey Andreevd5784082015-06-22 11:50:04 +0300510 $this->set_error('upload_invalid_dimensions', 'info');
Derek Allard2067d1a2008-11-13 22:59:24 +0000511 return FALSE;
512 }
513
514 // Sanitize the file name for security
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200515 $this->file_name = $this->_CI->security->sanitize_filename($this->file_name);
Barry Mienydd671972010-10-04 16:33:58 +0200516
Derek Allard2067d1a2008-11-13 22:59:24 +0000517 // Truncate the file name if it's too long
518 if ($this->max_filename > 0)
519 {
520 $this->file_name = $this->limit_filename_length($this->file_name, $this->max_filename);
521 }
522
523 // Remove white spaces in the name
Alex Bilbied261b1e2012-06-02 11:12:16 +0100524 if ($this->remove_spaces === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000525 {
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300526 $this->file_name = preg_replace('/\s+/', '_', $this->file_name);
Derek Allard2067d1a2008-11-13 22:59:24 +0000527 }
528
529 /*
530 * Validate the file name
531 * This function appends an number onto the end of
532 * the file if one with the same name already exists.
533 * If it returns false there was a problem.
534 */
535 $this->orig_name = $this->file_name;
536
Alex Bilbied261b1e2012-06-02 11:12:16 +0100537 if ($this->overwrite === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000538 {
539 $this->file_name = $this->set_filename($this->upload_path, $this->file_name);
Barry Mienydd671972010-10-04 16:33:58 +0200540
Derek Allard2067d1a2008-11-13 22:59:24 +0000541 if ($this->file_name === FALSE)
542 {
543 return FALSE;
544 }
545 }
546
547 /*
Derek Jonese9d723f2010-07-12 10:10:59 -0500548 * Run the file through the XSS hacking filter
549 * This helps prevent malicious code from being
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300550 * embedded within a file. Scripts can easily
Derek Jonese9d723f2010-07-12 10:10:59 -0500551 * be disguised as images or other file types.
552 */
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300553 if ($this->xss_clean && $this->do_xss_clean() === FALSE)
Derek Jonese9d723f2010-07-12 10:10:59 -0500554 {
Andrey Andreevd5784082015-06-22 11:50:04 +0300555 $this->set_error('upload_unable_to_write_file', 'error');
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300556 return FALSE;
Derek Jonese9d723f2010-07-12 10:10:59 -0500557 }
558
559 /*
Derek Allard2067d1a2008-11-13 22:59:24 +0000560 * Move the file to the final destination
561 * To deal with different server configurations
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300562 * we'll attempt to use copy() first. If that fails
563 * we'll use move_uploaded_file(). One of the two should
Derek Allard2067d1a2008-11-13 22:59:24 +0000564 * reliably work in most environments
565 */
566 if ( ! @copy($this->file_temp, $this->upload_path.$this->file_name))
567 {
568 if ( ! @move_uploaded_file($this->file_temp, $this->upload_path.$this->file_name))
569 {
Andrey Andreevd5784082015-06-22 11:50:04 +0300570 $this->set_error('upload_destination_error', 'error');
Barry Mienydd671972010-10-04 16:33:58 +0200571 return FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000572 }
573 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000574
575 /*
576 * Set the finalized image dimensions
577 * This sets the image width/height (assuming the
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300578 * file was an image). We use this information
Derek Allard2067d1a2008-11-13 22:59:24 +0000579 * in the "data" function.
580 */
581 $this->set_image_properties($this->upload_path.$this->file_name);
582
583 return TRUE;
584 }
Barry Mienydd671972010-10-04 16:33:58 +0200585
Derek Allard2067d1a2008-11-13 22:59:24 +0000586 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200587
Derek Allard2067d1a2008-11-13 22:59:24 +0000588 /**
589 * Finalized Data Array
Barry Mienydd671972010-10-04 16:33:58 +0200590 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000591 * Returns an associative array containing all of the information
592 * related to the upload, allowing the developer easy access in one array.
593 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200594 * @param string $index
Michiel Vugteveen0ee287e2012-06-11 10:38:14 +0200595 * @return mixed
Barry Mienydd671972010-10-04 16:33:58 +0200596 */
Michiel Vugteveendca9f232012-06-11 09:17:14 +0200597 public function data($index = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +0000598 {
Michiel Vugteveendca9f232012-06-11 09:17:14 +0200599 $data = array(
Michiel Vugteveen3a7fb042012-06-11 09:29:16 +0200600 'file_name' => $this->file_name,
601 'file_type' => $this->file_type,
602 'file_path' => $this->upload_path,
603 'full_path' => $this->upload_path.$this->file_name,
604 'raw_name' => str_replace($this->file_ext, '', $this->file_name),
605 'orig_name' => $this->orig_name,
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300606 'client_name' => $this->client_name,
Michiel Vugteveen3a7fb042012-06-11 09:29:16 +0200607 'file_ext' => $this->file_ext,
608 'file_size' => $this->file_size,
609 'is_image' => $this->is_image(),
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300610 'image_width' => $this->image_width,
611 'image_height' => $this->image_height,
612 'image_type' => $this->image_type,
613 'image_size_str' => $this->image_size_str,
614 );
Michiel Vugteveendca9f232012-06-11 09:17:14 +0200615
Michiel Vugteveen46a04292012-06-11 10:37:52 +0200616 if ( ! empty($index))
Michiel Vugteveendca9f232012-06-11 09:17:14 +0200617 {
Michiel Vugteveen46a04292012-06-11 10:37:52 +0200618 return isset($data[$index]) ? $data[$index] : NULL;
Michiel Vugteveendca9f232012-06-11 09:17:14 +0200619 }
620
Michiel Vugteveen46a04292012-06-11 10:37:52 +0200621 return $data;
Derek Allard2067d1a2008-11-13 22:59:24 +0000622 }
Barry Mienydd671972010-10-04 16:33:58 +0200623
Derek Allard2067d1a2008-11-13 22:59:24 +0000624 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200625
Derek Allard2067d1a2008-11-13 22:59:24 +0000626 /**
627 * Set Upload Path
628 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200629 * @param string $path
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200630 * @return CI_Upload
Barry Mienydd671972010-10-04 16:33:58 +0200631 */
Greg Aker58fdee82010-11-10 15:07:09 -0600632 public function set_upload_path($path)
Derek Allard2067d1a2008-11-13 22:59:24 +0000633 {
634 // Make sure it has a trailing slash
635 $this->upload_path = rtrim($path, '/').'/';
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200636 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000637 }
Barry Mienydd671972010-10-04 16:33:58 +0200638
Derek Allard2067d1a2008-11-13 22:59:24 +0000639 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200640
Derek Allard2067d1a2008-11-13 22:59:24 +0000641 /**
642 * Set the file name
643 *
644 * This function takes a filename/path as input and looks for the
645 * existence of a file with the same name. If found, it will append a
646 * number to the end of the filename to avoid overwriting a pre-existing file.
647 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200648 * @param string $path
649 * @param string $filename
Derek Allard2067d1a2008-11-13 22:59:24 +0000650 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200651 */
Greg Aker58fdee82010-11-10 15:07:09 -0600652 public function set_filename($path, $filename)
Derek Allard2067d1a2008-11-13 22:59:24 +0000653 {
Alex Bilbied261b1e2012-06-02 11:12:16 +0100654 if ($this->encrypt_name === TRUE)
Barry Mienydd671972010-10-04 16:33:58 +0200655 {
Barry Mienydd671972010-10-04 16:33:58 +0200656 $filename = md5(uniqid(mt_rand())).$this->file_ext;
Derek Allard2067d1a2008-11-13 22:59:24 +0000657 }
Barry Mienydd671972010-10-04 16:33:58 +0200658
Derek Allard2067d1a2008-11-13 22:59:24 +0000659 if ( ! file_exists($path.$filename))
660 {
661 return $filename;
662 }
Barry Mienydd671972010-10-04 16:33:58 +0200663
Derek Allard2067d1a2008-11-13 22:59:24 +0000664 $filename = str_replace($this->file_ext, '', $filename);
Barry Mienydd671972010-10-04 16:33:58 +0200665
Derek Allard2067d1a2008-11-13 22:59:24 +0000666 $new_filename = '';
Adam Jackettccbbea12011-08-21 16:19:11 -0400667 for ($i = 1; $i < $this->max_filename_increment; $i++)
Barry Mienydd671972010-10-04 16:33:58 +0200668 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000669 if ( ! file_exists($path.$filename.$i.$this->file_ext))
670 {
671 $new_filename = $filename.$i.$this->file_ext;
672 break;
673 }
674 }
675
Alex Bilbied261b1e2012-06-02 11:12:16 +0100676 if ($new_filename === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000677 {
Andrey Andreevd5784082015-06-22 11:50:04 +0300678 $this->set_error('upload_bad_filename', 'debug');
Derek Allard2067d1a2008-11-13 22:59:24 +0000679 return FALSE;
680 }
681 else
682 {
683 return $new_filename;
684 }
685 }
Barry Mienydd671972010-10-04 16:33:58 +0200686
Derek Allard2067d1a2008-11-13 22:59:24 +0000687 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200688
Derek Allard2067d1a2008-11-13 22:59:24 +0000689 /**
690 * Set Maximum File Size
691 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200692 * @param int $n
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200693 * @return CI_Upload
Barry Mienydd671972010-10-04 16:33:58 +0200694 */
Greg Aker58fdee82010-11-10 15:07:09 -0600695 public function set_max_filesize($n)
Derek Allard2067d1a2008-11-13 22:59:24 +0000696 {
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200697 $this->max_size = ($n < 0) ? 0 : (int) $n;
698 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000699 }
Barry Mienydd671972010-10-04 16:33:58 +0200700
Derek Allard2067d1a2008-11-13 22:59:24 +0000701 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200702
Derek Allard2067d1a2008-11-13 22:59:24 +0000703 /**
704 * Set Maximum File Name Length
705 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200706 * @param int $n
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200707 * @return CI_Upload
Barry Mienydd671972010-10-04 16:33:58 +0200708 */
Greg Aker58fdee82010-11-10 15:07:09 -0600709 public function set_max_filename($n)
Derek Allard2067d1a2008-11-13 22:59:24 +0000710 {
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200711 $this->max_filename = ($n < 0) ? 0 : (int) $n;
712 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000713 }
714
715 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200716
Derek Allard2067d1a2008-11-13 22:59:24 +0000717 /**
718 * Set Maximum Image Width
719 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200720 * @param int $n
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200721 * @return CI_Upload
Barry Mienydd671972010-10-04 16:33:58 +0200722 */
Greg Aker58fdee82010-11-10 15:07:09 -0600723 public function set_max_width($n)
Derek Allard2067d1a2008-11-13 22:59:24 +0000724 {
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200725 $this->max_width = ($n < 0) ? 0 : (int) $n;
726 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000727 }
Barry Mienydd671972010-10-04 16:33:58 +0200728
Derek Allard2067d1a2008-11-13 22:59:24 +0000729 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200730
Derek Allard2067d1a2008-11-13 22:59:24 +0000731 /**
732 * Set Maximum Image Height
733 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200734 * @param int $n
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200735 * @return CI_Upload
Barry Mienydd671972010-10-04 16:33:58 +0200736 */
Greg Aker58fdee82010-11-10 15:07:09 -0600737 public function set_max_height($n)
Derek Allard2067d1a2008-11-13 22:59:24 +0000738 {
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200739 $this->max_height = ($n < 0) ? 0 : (int) $n;
740 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000741 }
Barry Mienydd671972010-10-04 16:33:58 +0200742
Derek Allard2067d1a2008-11-13 22:59:24 +0000743 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200744
Derek Allard2067d1a2008-11-13 22:59:24 +0000745 /**
Andrey Andreev05aa2d62012-12-03 16:06:55 +0200746 * Set minimum image width
747 *
748 * @param int $n
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200749 * @return CI_Upload
Andrey Andreev05aa2d62012-12-03 16:06:55 +0200750 */
751 public function set_min_width($n)
752 {
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200753 $this->min_width = ($n < 0) ? 0 : (int) $n;
754 return $this;
Andrey Andreev05aa2d62012-12-03 16:06:55 +0200755 }
756
757 // --------------------------------------------------------------------
758
759 /**
760 * Set minimum image height
761 *
762 * @param int $n
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200763 * @return CI_Upload
Andrey Andreev05aa2d62012-12-03 16:06:55 +0200764 */
765 public function set_min_height($n)
766 {
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200767 $this->min_height = ($n < 0) ? 0 : (int) $n;
768 return $this;
Andrey Andreev05aa2d62012-12-03 16:06:55 +0200769 }
770
771 // --------------------------------------------------------------------
772
773 /**
Derek Allard2067d1a2008-11-13 22:59:24 +0000774 * Set Allowed File Types
775 *
Andrey Andreev82179bf2014-02-22 00:29:53 +0200776 * @param mixed $types
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200777 * @return CI_Upload
Barry Mienydd671972010-10-04 16:33:58 +0200778 */
Greg Aker58fdee82010-11-10 15:07:09 -0600779 public function set_allowed_types($types)
Derek Allard2067d1a2008-11-13 22:59:24 +0000780 {
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200781 $this->allowed_types = (is_array($types) OR $types === '*')
782 ? $types
783 : explode('|', $types);
784 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000785 }
Barry Mienydd671972010-10-04 16:33:58 +0200786
Derek Allard2067d1a2008-11-13 22:59:24 +0000787 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200788
Derek Allard2067d1a2008-11-13 22:59:24 +0000789 /**
790 * Set Image Properties
791 *
792 * Uses GD to determine the width/height/type of image
793 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200794 * @param string $path
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200795 * @return CI_Upload
Barry Mienydd671972010-10-04 16:33:58 +0200796 */
Greg Aker58fdee82010-11-10 15:07:09 -0600797 public function set_image_properties($path = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000798 {
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200799 if ($this->is_image() && function_exists('getimagesize'))
Derek Allard2067d1a2008-11-13 22:59:24 +0000800 {
801 if (FALSE !== ($D = @getimagesize($path)))
Barry Mienydd671972010-10-04 16:33:58 +0200802 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000803 $types = array(1 => 'gif', 2 => 'jpeg', 3 => 'png');
804
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300805 $this->image_width = $D[0];
806 $this->image_height = $D[1];
807 $this->image_type = isset($types[$D[2]]) ? $types[$D[2]] : 'unknown';
808 $this->image_size_str = $D[3]; // string containing height and width
Derek Allard2067d1a2008-11-13 22:59:24 +0000809 }
810 }
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200811
812 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000813 }
Barry Mienydd671972010-10-04 16:33:58 +0200814
Derek Allard2067d1a2008-11-13 22:59:24 +0000815 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200816
Derek Allard2067d1a2008-11-13 22:59:24 +0000817 /**
818 * Set XSS Clean
819 *
820 * Enables the XSS flag so that the file that was uploaded
821 * will be run through the XSS filter.
822 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200823 * @param bool $flag
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200824 * @return CI_Upload
Derek Allard2067d1a2008-11-13 22:59:24 +0000825 */
Greg Aker58fdee82010-11-10 15:07:09 -0600826 public function set_xss_clean($flag = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000827 {
Alex Bilbied261b1e2012-06-02 11:12:16 +0100828 $this->xss_clean = ($flag === TRUE);
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200829 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +0000830 }
Barry Mienydd671972010-10-04 16:33:58 +0200831
Derek Allard2067d1a2008-11-13 22:59:24 +0000832 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200833
Derek Allard2067d1a2008-11-13 22:59:24 +0000834 /**
835 * Validate the image
836 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000837 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +0200838 */
Greg Aker58fdee82010-11-10 15:07:09 -0600839 public function is_image()
Derek Allard2067d1a2008-11-13 22:59:24 +0000840 {
841 // IE will sometimes return odd mime-types during upload, so here we just standardize all
842 // jpegs or pngs to the same file type.
843
Derek Jones4b9c6292011-07-01 17:40:48 -0500844 $png_mimes = array('image/x-png');
Derek Allard2067d1a2008-11-13 22:59:24 +0000845 $jpeg_mimes = array('image/jpg', 'image/jpe', 'image/jpeg', 'image/pjpeg');
Barry Mienydd671972010-10-04 16:33:58 +0200846
Derek Allard2067d1a2008-11-13 22:59:24 +0000847 if (in_array($this->file_type, $png_mimes))
848 {
849 $this->file_type = 'image/png';
850 }
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300851 elseif (in_array($this->file_type, $jpeg_mimes))
Derek Allard2067d1a2008-11-13 22:59:24 +0000852 {
853 $this->file_type = 'image/jpeg';
854 }
855
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300856 $img_mimes = array('image/gif', 'image/jpeg', 'image/png');
Derek Allard2067d1a2008-11-13 22:59:24 +0000857
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300858 return in_array($this->file_type, $img_mimes, TRUE);
Derek Allard2067d1a2008-11-13 22:59:24 +0000859 }
Barry Mienydd671972010-10-04 16:33:58 +0200860
Derek Allard2067d1a2008-11-13 22:59:24 +0000861 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200862
Derek Allard2067d1a2008-11-13 22:59:24 +0000863 /**
864 * Verify that the filetype is allowed
865 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +0200866 * @param bool $ignore_mime
Derek Allard2067d1a2008-11-13 22:59:24 +0000867 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +0200868 */
Greg Aker58fdee82010-11-10 15:07:09 -0600869 public function is_allowed_filetype($ignore_mime = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000870 {
Andrey Andreev6ca407e2012-03-01 15:33:21 +0200871 if ($this->allowed_types === '*')
Derek Jonese12f64e2010-03-02 22:55:08 -0600872 {
873 return TRUE;
874 }
Barry Mienydd671972010-10-04 16:33:58 +0200875
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200876 if (empty($this->allowed_types) OR ! is_array($this->allowed_types))
Derek Allard2067d1a2008-11-13 22:59:24 +0000877 {
Andrey Andreevd5784082015-06-22 11:50:04 +0300878 $this->set_error('upload_no_file_types', 'debug');
Derek Allard2067d1a2008-11-13 22:59:24 +0000879 return FALSE;
880 }
Barry Mienydd671972010-10-04 16:33:58 +0200881
Derek Jonese9d723f2010-07-12 10:10:59 -0500882 $ext = strtolower(ltrim($this->file_ext, '.'));
Barry Mienydd671972010-10-04 16:33:58 +0200883
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200884 if ( ! in_array($ext, $this->allowed_types, TRUE))
Derek Allard2067d1a2008-11-13 22:59:24 +0000885 {
Derek Jonese9d723f2010-07-12 10:10:59 -0500886 return FALSE;
887 }
Derek Jonesafa282f2009-02-10 17:11:52 +0000888
Barry Mienydd671972010-10-04 16:33:58 +0200889 // Images get some additional checks
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200890 if (in_array($ext, array('gif', 'jpg', 'jpeg', 'jpe', 'png'), TRUE) && @getimagesize($this->file_temp) === FALSE)
Derek Jonese9d723f2010-07-12 10:10:59 -0500891 {
Andrey Andreev6ca407e2012-03-01 15:33:21 +0200892 return FALSE;
Derek Jonese9d723f2010-07-12 10:10:59 -0500893 }
Barry Mienydd671972010-10-04 16:33:58 +0200894
Derek Jonese9d723f2010-07-12 10:10:59 -0500895 if ($ignore_mime === TRUE)
896 {
897 return TRUE;
898 }
Barry Mienydd671972010-10-04 16:33:58 +0200899
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200900 if (isset($this->_mimes[$ext]))
Derek Jonese9d723f2010-07-12 10:10:59 -0500901 {
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +0200902 return is_array($this->_mimes[$ext])
903 ? in_array($this->file_type, $this->_mimes[$ext], TRUE)
904 : ($this->_mimes[$ext] === $this->file_type);
Derek Allard2067d1a2008-11-13 22:59:24 +0000905 }
Barry Mienydd671972010-10-04 16:33:58 +0200906
Derek Allard2067d1a2008-11-13 22:59:24 +0000907 return FALSE;
908 }
Barry Mienydd671972010-10-04 16:33:58 +0200909
Derek Allard2067d1a2008-11-13 22:59:24 +0000910 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200911
Derek Allard2067d1a2008-11-13 22:59:24 +0000912 /**
913 * Verify that the file is within the allowed size
914 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000915 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +0200916 */
Greg Aker58fdee82010-11-10 15:07:09 -0600917 public function is_allowed_filesize()
Derek Allard2067d1a2008-11-13 22:59:24 +0000918 {
Alex Bilbied261b1e2012-06-02 11:12:16 +0100919 return ($this->max_size === 0 OR $this->max_size > $this->file_size);
Derek Allard2067d1a2008-11-13 22:59:24 +0000920 }
Barry Mienydd671972010-10-04 16:33:58 +0200921
Derek Allard2067d1a2008-11-13 22:59:24 +0000922 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200923
Derek Allard2067d1a2008-11-13 22:59:24 +0000924 /**
925 * Verify that the image is within the allowed width/height
926 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000927 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +0200928 */
Greg Aker58fdee82010-11-10 15:07:09 -0600929 public function is_allowed_dimensions()
Derek Allard2067d1a2008-11-13 22:59:24 +0000930 {
931 if ( ! $this->is_image())
932 {
933 return TRUE;
934 }
935
936 if (function_exists('getimagesize'))
937 {
938 $D = @getimagesize($this->file_temp);
939
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300940 if ($this->max_width > 0 && $D[0] > $this->max_width)
Derek Allard2067d1a2008-11-13 22:59:24 +0000941 {
942 return FALSE;
943 }
944
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300945 if ($this->max_height > 0 && $D[1] > $this->max_height)
Derek Allard2067d1a2008-11-13 22:59:24 +0000946 {
947 return FALSE;
948 }
Andrey Andreev05aa2d62012-12-03 16:06:55 +0200949
950 if ($this->min_width > 0 && $D[0] < $this->min_width)
951 {
952 return FALSE;
953 }
954
955 if ($this->min_height > 0 && $D[1] < $this->min_height)
956 {
957 return FALSE;
958 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000959 }
960
961 return TRUE;
962 }
Barry Mienydd671972010-10-04 16:33:58 +0200963
Derek Allard2067d1a2008-11-13 22:59:24 +0000964 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200965
Derek Allard2067d1a2008-11-13 22:59:24 +0000966 /**
967 * Validate Upload Path
968 *
969 * Verifies that it is a valid upload path with proper permissions.
970 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000971 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +0200972 */
Greg Aker58fdee82010-11-10 15:07:09 -0600973 public function validate_upload_path()
Derek Allard2067d1a2008-11-13 22:59:24 +0000974 {
Alex Bilbied261b1e2012-06-02 11:12:16 +0100975 if ($this->upload_path === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000976 {
Andrey Andreevd5784082015-06-22 11:50:04 +0300977 $this->set_error('upload_no_filepath', 'error');
Derek Allard2067d1a2008-11-13 22:59:24 +0000978 return FALSE;
979 }
Barry Mienydd671972010-10-04 16:33:58 +0200980
Andrey Andreevea41c8a2014-02-26 18:31:02 +0200981 if (realpath($this->upload_path) !== FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000982 {
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300983 $this->upload_path = str_replace('\\', '/', realpath($this->upload_path));
Derek Allard2067d1a2008-11-13 22:59:24 +0000984 }
985
Andrey Andreev382b5132014-02-26 18:41:59 +0200986 if ( ! is_dir($this->upload_path))
Derek Allard2067d1a2008-11-13 22:59:24 +0000987 {
Andrey Andreevd5784082015-06-22 11:50:04 +0300988 $this->set_error('upload_no_filepath', 'error');
Derek Allard2067d1a2008-11-13 22:59:24 +0000989 return FALSE;
990 }
991
992 if ( ! is_really_writable($this->upload_path))
993 {
Andrey Andreevd5784082015-06-22 11:50:04 +0300994 $this->set_error('upload_not_writable', 'error');
Derek Allard2067d1a2008-11-13 22:59:24 +0000995 return FALSE;
996 }
997
Andrey Andreev8e6f7a92012-03-26 20:13:00 +0300998 $this->upload_path = preg_replace('/(.+?)\/*$/', '\\1/', $this->upload_path);
Derek Allard2067d1a2008-11-13 22:59:24 +0000999 return TRUE;
1000 }
Barry Mienydd671972010-10-04 16:33:58 +02001001
Derek Allard2067d1a2008-11-13 22:59:24 +00001002 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001003
Derek Allard2067d1a2008-11-13 22:59:24 +00001004 /**
1005 * Extract the file extension
1006 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +02001007 * @param string $filename
Derek Allard2067d1a2008-11-13 22:59:24 +00001008 * @return string
Barry Mienydd671972010-10-04 16:33:58 +02001009 */
Greg Aker58fdee82010-11-10 15:07:09 -06001010 public function get_extension($filename)
Derek Allard2067d1a2008-11-13 22:59:24 +00001011 {
1012 $x = explode('.', $filename);
Adrianf496d132013-06-24 15:56:45 +02001013
Adrian74a228b2013-06-25 12:09:22 +02001014 if (count($x) === 1)
1015 {
1016 return '';
1017 }
1018
1019 $ext = ($this->file_ext_tolower) ? strtolower(end($x)) : end($x);
1020 return '.'.$ext;
Barry Mienydd671972010-10-04 16:33:58 +02001021 }
1022
Derek Allard2067d1a2008-11-13 22:59:24 +00001023 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001024
Derek Allard2067d1a2008-11-13 22:59:24 +00001025 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00001026 * Limit the File Name Length
1027 *
Andrey Andreev5fd3ae82012-10-24 14:55:35 +03001028 * @param string $filename
1029 * @param int $length
Derek Allard2067d1a2008-11-13 22:59:24 +00001030 * @return string
Barry Mienydd671972010-10-04 16:33:58 +02001031 */
Greg Aker58fdee82010-11-10 15:07:09 -06001032 public function limit_filename_length($filename, $length)
Derek Allard2067d1a2008-11-13 22:59:24 +00001033 {
1034 if (strlen($filename) < $length)
1035 {
1036 return $filename;
1037 }
Barry Mienydd671972010-10-04 16:33:58 +02001038
Derek Allard2067d1a2008-11-13 22:59:24 +00001039 $ext = '';
1040 if (strpos($filename, '.') !== FALSE)
1041 {
1042 $parts = explode('.', $filename);
1043 $ext = '.'.array_pop($parts);
1044 $filename = implode('.', $parts);
1045 }
Barry Mienydd671972010-10-04 16:33:58 +02001046
Derek Allard2067d1a2008-11-13 22:59:24 +00001047 return substr($filename, 0, ($length - strlen($ext))).$ext;
1048 }
1049
1050 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001051
Derek Allard2067d1a2008-11-13 22:59:24 +00001052 /**
1053 * Runs the file through the XSS clean function
1054 *
1055 * This prevents people from embedding malicious code in their files.
1056 * I'm not sure that it won't negatively affect certain files in unexpected ways,
1057 * but so far I haven't found that it causes trouble.
1058 *
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +02001059 * @return string
Barry Mienydd671972010-10-04 16:33:58 +02001060 */
Greg Aker58fdee82010-11-10 15:07:09 -06001061 public function do_xss_clean()
Barry Mienydd671972010-10-04 16:33:58 +02001062 {
Derek Jonese9d723f2010-07-12 10:10:59 -05001063 $file = $this->file_temp;
Barry Mienydd671972010-10-04 16:33:58 +02001064
Andrey Andreev5036c9c2012-06-04 15:34:56 +03001065 if (filesize($file) == 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00001066 {
1067 return FALSE;
1068 }
Barry Mienydd671972010-10-04 16:33:58 +02001069
Andrey Andreevc839d282012-06-07 14:35:27 +03001070 if (memory_get_usage() && ($memory_limit = ini_get('memory_limit')))
Greg Akerf82e51c2010-04-14 19:33:50 -05001071 {
Andrey Andreevc839d282012-06-07 14:35:27 +03001072 $memory_limit *= 1024 * 1024;
Barry Mienydd671972010-10-04 16:33:58 +02001073
Greg Akerc78a2592010-06-09 11:45:32 -05001074 // There was a bug/behavioural change in PHP 5.2, where numbers over one million get output
Andrey Andreev8e6f7a92012-03-26 20:13:00 +03001075 // into scientific notation. number_format() ensures this number is an integer
Greg Akerc78a2592010-06-09 11:45:32 -05001076 // http://bugs.php.net/bug.php?id=43053
Barry Mienydd671972010-10-04 16:33:58 +02001077
Andrey Andreevc839d282012-06-07 14:35:27 +03001078 $memory_limit = number_format(ceil(filesize($file) + $memory_limit), 0, '.', '');
Barry Mienydd671972010-10-04 16:33:58 +02001079
Andrey Andreevc839d282012-06-07 14:35:27 +03001080 ini_set('memory_limit', $memory_limit); // When an integer is used, the value is measured in bytes. - PHP.net
Greg Akerf82e51c2010-04-14 19:33:50 -05001081 }
1082
1083 // If the file being uploaded is an image, then we should have no problem with XSS attacks (in theory), but
1084 // IE can be fooled into mime-type detecting a malformed image as an html file, thus executing an XSS attack on anyone
Andrey Andreev8e6f7a92012-03-26 20:13:00 +03001085 // using IE who looks at the image. It does this by inspecting the first 255 bytes of an image. To get around this
1086 // CI will itself look at the first 255 bytes of an image to determine its relative safety. This can save a lot of
Barry Mienydd671972010-10-04 16:33:58 +02001087 // processor power and time if it is actually a clean image, as it will be in nearly all instances _except_ an
Greg Akerf82e51c2010-04-14 19:33:50 -05001088 // attempted XSS attack.
1089
1090 if (function_exists('getimagesize') && @getimagesize($file) !== FALSE)
1091 {
Barry Mienydd671972010-10-04 16:33:58 +02001092 if (($file = @fopen($file, 'rb')) === FALSE) // "b" to force binary
1093 {
Greg Akerf82e51c2010-04-14 19:33:50 -05001094 return FALSE; // Couldn't open the file, return FALSE
Barry Mienydd671972010-10-04 16:33:58 +02001095 }
Greg Akerf82e51c2010-04-14 19:33:50 -05001096
Barry Mienydd671972010-10-04 16:33:58 +02001097 $opening_bytes = fread($file, 256);
1098 fclose($file);
Greg Akerf82e51c2010-04-14 19:33:50 -05001099
1100 // These are known to throw IE into mime-type detection chaos
1101 // <a, <body, <head, <html, <img, <plaintext, <pre, <script, <table, <title
1102 // title is basically just in SVG, but we filter it anyhow
1103
vlakoff35672462013-02-15 01:36:04 +01001104 // if it's an image or no "triggers" detected in the first 256 bytes - we're good
Andrey Andreevc839d282012-06-07 14:35:27 +03001105 return ! preg_match('/<(a|body|head|html|img|plaintext|pre|script|table|title)[\s>]/i', $opening_bytes);
Greg Akerf82e51c2010-04-14 19:33:50 -05001106 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001107
1108 if (($data = @file_get_contents($file)) === FALSE)
1109 {
1110 return FALSE;
1111 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001112
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +02001113 return $this->_CI->security->xss_clean($data, TRUE);
Derek Allard2067d1a2008-11-13 22:59:24 +00001114 }
Barry Mienydd671972010-10-04 16:33:58 +02001115
Derek Allard2067d1a2008-11-13 22:59:24 +00001116 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001117
Derek Allard2067d1a2008-11-13 22:59:24 +00001118 /**
1119 * Set an error message
1120 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +02001121 * @param string $msg
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +02001122 * @return CI_Upload
Barry Mienydd671972010-10-04 16:33:58 +02001123 */
Andrey Andreevd5784082015-06-22 11:50:04 +03001124 public function set_error($msg, $log_level = 'error')
Derek Allard2067d1a2008-11-13 22:59:24 +00001125 {
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +02001126 $this->_CI->lang->load('upload');
Barry Mienydd671972010-10-04 16:33:58 +02001127
Andrey Andreev119d8a72014-01-08 15:27:53 +02001128 is_array($msg) OR $msg = array($msg);
Darren Benney38d5f4b2013-03-30 21:00:38 +00001129 foreach ($msg as $val)
Derek Allard2067d1a2008-11-13 22:59:24 +00001130 {
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +02001131 $msg = ($this->_CI->lang->line($val) === FALSE) ? $val : $this->_CI->lang->line($val);
Derek Allard2067d1a2008-11-13 22:59:24 +00001132 $this->error_msg[] = $msg;
Andrey Andreevd5784082015-06-22 11:50:04 +03001133 log_message($log_level, $msg);
Derek Allard2067d1a2008-11-13 22:59:24 +00001134 }
Andrey Andreev2cf4c9b2014-02-21 15:01:48 +02001135
1136 return $this;
Derek Allard2067d1a2008-11-13 22:59:24 +00001137 }
Barry Mienydd671972010-10-04 16:33:58 +02001138
Derek Allard2067d1a2008-11-13 22:59:24 +00001139 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001140
Derek Allard2067d1a2008-11-13 22:59:24 +00001141 /**
1142 * Display the error message
1143 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +02001144 * @param string $open
1145 * @param string $close
Derek Allard2067d1a2008-11-13 22:59:24 +00001146 * @return string
Barry Mienydd671972010-10-04 16:33:58 +02001147 */
Greg Aker58fdee82010-11-10 15:07:09 -06001148 public function display_errors($open = '<p>', $close = '</p>')
Derek Allard2067d1a2008-11-13 22:59:24 +00001149 {
Andrey Andreev8e6f7a92012-03-26 20:13:00 +03001150 return (count($this->error_msg) > 0) ? $open.implode($close.$open, $this->error_msg).$close : '';
Derek Allard2067d1a2008-11-13 22:59:24 +00001151 }
Barry Mienydd671972010-10-04 16:33:58 +02001152
Derek Allard2067d1a2008-11-13 22:59:24 +00001153 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +02001154
Derek Allard2067d1a2008-11-13 22:59:24 +00001155 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00001156 * Prep Filename
1157 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +02001158 * Prevents possible script execution from Apache's handling
1159 * of files' multiple extensions.
Derek Allard2067d1a2008-11-13 22:59:24 +00001160 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +02001161 * @link http://httpd.apache.org/docs/1.3/mod/mod_mime.html#multipleext
1162 *
1163 * @param string $filename
Derek Allard2067d1a2008-11-13 22:59:24 +00001164 * @return string
1165 */
Greg Aker58fdee82010-11-10 15:07:09 -06001166 protected function _prep_filename($filename)
Derek Allard2067d1a2008-11-13 22:59:24 +00001167 {
Andrey Andreevf38c9c22014-08-27 14:56:31 +03001168 if ($this->mod_mime_fix === FALSE OR $this->allowed_types === '*' OR ($ext_pos = strrpos($filename, '.')) === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001169 {
1170 return $filename;
1171 }
Derek Allard616dab82009-02-16 15:44:32 +00001172
Andrey Andreevf38c9c22014-08-27 14:56:31 +03001173 $ext = substr($filename, $ext_pos);
1174 $filename = substr($filename, 0, $ext_pos);
1175 return str_replace('.', '_', $filename).$ext;
Derek Allard2067d1a2008-11-13 22:59:24 +00001176 }
1177
1178 // --------------------------------------------------------------------
1179
Andrey Andreev3a3c9472011-09-24 14:25:33 +03001180 /**
1181 * File MIME type
1182 *
1183 * Detects the (actual) MIME type of the uploaded file, if possible.
1184 * The input array is expected to be $_FILES[$field]
1185 *
Andrey Andreevf5ccd122012-11-02 00:17:39 +02001186 * @param array $file
Andrey Andreev3a3c9472011-09-24 14:25:33 +03001187 * @return void
1188 */
1189 protected function _file_mime_type($file)
1190 {
Andrey Andreeva49e3812011-12-09 13:05:22 +02001191 // We'll need this to validate the MIME info string (e.g. text/plain; charset=us-ascii)
Andrey Andreevf7aed122011-12-13 11:01:06 +02001192 $regexp = '/^([a-z\-]+\/[a-z0-9\-\.\+]+)(;\s.+)?$/';
Andrey Andreeva49e3812011-12-09 13:05:22 +02001193
1194 /* Fileinfo extension - most reliable method
1195 *
1196 * Unfortunately, prior to PHP 5.3 - it's only available as a PECL extension and the
1197 * more convenient FILEINFO_MIME_TYPE flag doesn't exist.
1198 */
1199 if (function_exists('finfo_file'))
Andrey Andreev3a3c9472011-09-24 14:25:33 +03001200 {
Andrey Andreevd60e7002012-06-17 00:03:03 +03001201 $finfo = @finfo_open(FILEINFO_MIME);
Andrey Andreeva49e3812011-12-09 13:05:22 +02001202 if (is_resource($finfo)) // It is possible that a FALSE value is returned, if there is no magic MIME database file found on the system
Andrey Andreev3a3c9472011-09-24 14:25:33 +03001203 {
Andrey Andreeva49e3812011-12-09 13:05:22 +02001204 $mime = @finfo_file($finfo, $file['tmp_name']);
1205 finfo_close($finfo);
Andrey Andreev3a3c9472011-09-24 14:25:33 +03001206
1207 /* According to the comments section of the PHP manual page,
1208 * it is possible that this function returns an empty string
Andrey Andreev2cec39f2011-09-24 22:59:37 +03001209 * for some files (e.g. if they don't exist in the magic MIME database)
Andrey Andreev3a3c9472011-09-24 14:25:33 +03001210 */
Andrey Andreeva49e3812011-12-09 13:05:22 +02001211 if (is_string($mime) && preg_match($regexp, $mime, $matches))
Andrey Andreev3a3c9472011-09-24 14:25:33 +03001212 {
Andrey Andreeva49e3812011-12-09 13:05:22 +02001213 $this->file_type = $matches[1];
Andrey Andreev3a3c9472011-09-24 14:25:33 +03001214 return;
1215 }
1216 }
1217 }
1218
Andrey Andreeva49e3812011-12-09 13:05:22 +02001219 /* This is an ugly hack, but UNIX-type systems provide a "native" way to detect the file type,
1220 * which is still more secure than depending on the value of $_FILES[$field]['type'], and as it
1221 * was reported in issue #750 (https://github.com/EllisLab/CodeIgniter/issues/750) - it's better
1222 * than mime_content_type() as well, hence the attempts to try calling the command line with
1223 * three different functions.
Andrey Andreev6700b932011-09-24 14:25:33 +03001224 *
1225 * Notes:
Andrey Andreev59654312011-12-02 14:28:54 +02001226 * - the DIRECTORY_SEPARATOR comparison ensures that we're not on a Windows system
Andrey Andreeva49e3812011-12-09 13:05:22 +02001227 * - many system admins would disable the exec(), shell_exec(), popen() and similar functions
vlakofff3994252013-02-19 01:45:23 +01001228 * due to security concerns, hence the function_usable() checks
Andrey Andreev6700b932011-09-24 14:25:33 +03001229 */
Andrey Andreeva49e3812011-12-09 13:05:22 +02001230 if (DIRECTORY_SEPARATOR !== '\\')
Andrey Andreev6700b932011-09-24 14:25:33 +03001231 {
Andrey Andreevd60e7002012-06-17 00:03:03 +03001232 $cmd = function_exists('escapeshellarg')
1233 ? 'file --brief --mime '.escapeshellarg($file['tmp_name']).' 2>&1'
1234 : 'file --brief --mime '.$file['tmp_name'].' 2>&1';
Andrey Andreeva49e3812011-12-09 13:05:22 +02001235
Andrey Andreeve9d2dc82012-11-07 14:23:29 +02001236 if (function_usable('exec'))
Andrey Andreev6700b932011-09-24 14:25:33 +03001237 {
Andrey Andreeva49e3812011-12-09 13:05:22 +02001238 /* This might look confusing, as $mime is being populated with all of the output when set in the second parameter.
vlakofff3994252013-02-19 01:45:23 +01001239 * However, we only need the last line, which is the actual return value of exec(), and as such - it overwrites
Andrey Andreeva49e3812011-12-09 13:05:22 +02001240 * anything that could already be set for $mime previously. This effectively makes the second parameter a dummy
1241 * value, which is only put to allow us to get the return status code.
1242 */
1243 $mime = @exec($cmd, $mime, $return_status);
1244 if ($return_status === 0 && is_string($mime) && preg_match($regexp, $mime, $matches))
1245 {
1246 $this->file_type = $matches[1];
1247 return;
1248 }
1249 }
1250
Andrey Andreevf6274742014-02-20 18:05:58 +02001251 if ( ! ini_get('safe_mode') && function_usable('shell_exec'))
Andrey Andreeva49e3812011-12-09 13:05:22 +02001252 {
1253 $mime = @shell_exec($cmd);
1254 if (strlen($mime) > 0)
1255 {
1256 $mime = explode("\n", trim($mime));
1257 if (preg_match($regexp, $mime[(count($mime) - 1)], $matches))
1258 {
1259 $this->file_type = $matches[1];
1260 return;
1261 }
1262 }
1263 }
1264
Andrey Andreeve9d2dc82012-11-07 14:23:29 +02001265 if (function_usable('popen'))
Andrey Andreeva49e3812011-12-09 13:05:22 +02001266 {
1267 $proc = @popen($cmd, 'r');
1268 if (is_resource($proc))
1269 {
tubalmartin010f1f42012-03-03 22:24:31 +01001270 $mime = @fread($proc, 512);
Andrey Andreeva49e3812011-12-09 13:05:22 +02001271 @pclose($proc);
1272 if ($mime !== FALSE)
1273 {
1274 $mime = explode("\n", trim($mime));
1275 if (preg_match($regexp, $mime[(count($mime) - 1)], $matches))
1276 {
1277 $this->file_type = $matches[1];
1278 return;
1279 }
1280 }
1281 }
1282 }
1283 }
1284
1285 // Fall back to the deprecated mime_content_type(), if available (still better than $_FILES[$field]['type'])
Andrey Andreev3a3c9472011-09-24 14:25:33 +03001286 if (function_exists('mime_content_type'))
1287 {
1288 $this->file_type = @mime_content_type($file['tmp_name']);
Andrey Andreeva49e3812011-12-09 13:05:22 +02001289 if (strlen($this->file_type) > 0) // It's possible that mime_content_type() returns FALSE or an empty string
Andrey Andreev3a3c9472011-09-24 14:25:33 +03001290 {
Andrey Andreev3a3c9472011-09-24 14:25:33 +03001291 return;
1292 }
1293 }
1294
1295 $this->file_type = $file['type'];
1296 }
1297
Derek Allard2067d1a2008-11-13 22:59:24 +00001298}