Total Complexity | 85 |
Total Lines | 745 |
Duplicated Lines | 0 % |
Changes | 5 | ||
Bugs | 1 | Features | 0 |
Complex classes like Upload often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Upload, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
40 | class Upload{ |
||
41 | |||
42 | /** |
||
43 | * Version |
||
44 | * |
||
45 | * @since 1.5 |
||
46 | * @version 1.0 |
||
47 | */ |
||
48 | const VERSION = '1.5'; |
||
49 | |||
50 | /** |
||
51 | * Upload function name |
||
52 | * Remember: |
||
53 | * Default function: move_uploaded_file |
||
54 | * Native options: |
||
55 | * - move_uploaded_file (Default and best option) |
||
56 | * - copy |
||
57 | * |
||
58 | * @since 1.0 |
||
59 | * @version 1.0 |
||
60 | * @var string |
||
61 | */ |
||
62 | private $upload_function = 'move_uploaded_file'; |
||
63 | |||
64 | /** |
||
65 | * Array with the information obtained from the |
||
66 | * variable $_FILES or $HTTP_POST_FILES. |
||
67 | * |
||
68 | * @since 1.0 |
||
69 | * @version 1.0 |
||
70 | * @var array |
||
71 | */ |
||
72 | private $file_array = array(); |
||
73 | |||
74 | /** |
||
75 | * If the file you are trying to upload already exists it will |
||
76 | * be overwritten if you set the variable to true. |
||
77 | * |
||
78 | * @since 1.0 |
||
79 | * @version 1.0 |
||
80 | * @var boolean |
||
81 | */ |
||
82 | private $overwrite_file = false; |
||
83 | |||
84 | /** |
||
85 | * Input element |
||
86 | * Example: |
||
87 | * <input type="file" name="file" /> |
||
88 | * Result: |
||
89 | * FileUpload::$input = file |
||
90 | * |
||
91 | * @since 1.0 |
||
92 | * @version 1.0 |
||
93 | * @var string |
||
94 | */ |
||
95 | private $input; |
||
96 | |||
97 | /** |
||
98 | * Path output |
||
99 | * |
||
100 | * @since 1.0 |
||
101 | * @version 1.0 |
||
102 | * @var string |
||
103 | */ |
||
104 | private $destination_directory; |
||
105 | |||
106 | /** |
||
107 | * Output filename |
||
108 | * |
||
109 | * @since 1.0 |
||
110 | * @version 1.0 |
||
111 | * @var string |
||
112 | */ |
||
113 | private $filename; |
||
114 | |||
115 | /** |
||
116 | * Max file size |
||
117 | * |
||
118 | * @since 1.0 |
||
119 | * @version 1.0 |
||
120 | * @var float |
||
121 | */ |
||
122 | private $max_file_size= 0.0; |
||
123 | |||
124 | /** |
||
125 | * List of allowed mime types |
||
126 | * |
||
127 | * @since 1.0 |
||
128 | * @version 1.0 |
||
129 | * @var array |
||
130 | */ |
||
131 | private $allowed_mime_types = array(); |
||
132 | |||
133 | /** |
||
134 | * Callbacks |
||
135 | * |
||
136 | * @since 1.0 |
||
137 | * @version 1.0 |
||
138 | * @var array |
||
139 | */ |
||
140 | private $callbacks = array('before' => null, 'after' => null); |
||
141 | |||
142 | /** |
||
143 | * File object |
||
144 | * |
||
145 | * @since 1.0 |
||
146 | * @version 1.0 |
||
147 | * @var object |
||
148 | */ |
||
149 | private $file; |
||
150 | |||
151 | /** |
||
152 | * Helping mime types |
||
153 | * |
||
154 | * @since 1.0 |
||
155 | * @version 1.0 |
||
156 | * @var array |
||
157 | */ |
||
158 | private $mime_helping = array( |
||
159 | 'text' => array('text/plain',), |
||
160 | 'image' => array( |
||
161 | 'image/jpeg', |
||
162 | 'image/jpg', |
||
163 | 'image/pjpeg', |
||
164 | 'image/png', |
||
165 | 'image/gif', |
||
166 | ), |
||
167 | 'document' => array( |
||
168 | 'application/pdf', |
||
169 | 'application/msword', |
||
170 | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', |
||
171 | 'application/vnd.openxmlformats-officedocument.presentationml.presentation', |
||
172 | 'application/vnd.ms-powerpoint', |
||
173 | 'application/vnd.ms-excel', |
||
174 | 'application/vnd.oasis.opendocument.spreadsheet', |
||
175 | 'application/vnd.oasis.opendocument.presentation', |
||
176 | ), |
||
177 | 'video' => array( |
||
178 | 'video/3gpp', |
||
179 | 'video/3gpp', |
||
180 | 'video/x-msvideo', |
||
181 | 'video/avi', |
||
182 | 'video/mpeg4', |
||
183 | 'video/mp4', |
||
184 | 'video/mpeg', |
||
185 | 'video/mpg', |
||
186 | 'video/quicktime', |
||
187 | 'video/x-sgi-movie', |
||
188 | 'video/x-ms-wmv', |
||
189 | 'video/x-flv', |
||
190 | ), |
||
191 | ); |
||
192 | |||
193 | /** |
||
194 | * The upload error message |
||
195 | * @var array |
||
196 | */ |
||
197 | public $error_messages = array(); |
||
198 | |||
199 | /** |
||
200 | * The upload error message |
||
201 | * @var string |
||
202 | */ |
||
203 | protected $error = null; |
||
204 | |||
205 | /** |
||
206 | * The logger instance |
||
207 | * @var Log |
||
208 | */ |
||
209 | private $logger; |
||
210 | |||
211 | |||
212 | /** |
||
213 | * Construct |
||
214 | * |
||
215 | * @since 0.1 |
||
216 | * @version 1.0.1 |
||
217 | * @return object |
||
218 | * @method object __construct |
||
219 | */ |
||
220 | public function __construct(){ |
||
263 | } |
||
264 | /** |
||
265 | * Set input. |
||
266 | * If you have $_FILES["file"], you must use the key "file" |
||
267 | * Example: |
||
268 | * $object->setInput("file"); |
||
269 | * |
||
270 | * @since 1.0 |
||
271 | * @version 1.0 |
||
272 | * @param string $input |
||
273 | * @return object |
||
274 | * @method boolean setInput |
||
275 | */ |
||
276 | public function setInput($input) |
||
277 | { |
||
278 | if (!empty($input) && (is_string($input) || is_numeric($input) )) { |
||
279 | $this->input = $input; |
||
280 | } |
||
281 | return $this; |
||
282 | } |
||
283 | /** |
||
284 | * Set new filename |
||
285 | * Example: |
||
286 | * FileUpload::setFilename("new file.txt") |
||
287 | * Remember: |
||
288 | * Use %s to retrive file extension |
||
289 | * |
||
290 | * @since 1.0 |
||
291 | * @version 1.0 |
||
292 | * @param string $filename |
||
293 | * @return object |
||
294 | * @method boolean setFilename |
||
295 | */ |
||
296 | public function setFilename($filename) |
||
297 | { |
||
298 | if ($this->isFilename($filename)) { |
||
299 | $this->filename = $filename; |
||
300 | } |
||
301 | return $this; |
||
302 | } |
||
303 | /** |
||
304 | * Set automatic filename |
||
305 | * |
||
306 | * @since 1.0 |
||
307 | * @version 1.5 |
||
308 | * @param string $extension |
||
309 | * @return object |
||
310 | * @method boolean setAutoFilename |
||
311 | */ |
||
312 | public function setAutoFilename() |
||
313 | { |
||
314 | $this->filename = sha1(mt_rand(1, 9999).uniqid()); |
||
315 | $this->filename .= time(); |
||
316 | return $this; |
||
317 | } |
||
318 | /** |
||
319 | * Set file size limit |
||
320 | * |
||
321 | * @since 1.0 |
||
322 | * @version 1.0 |
||
323 | * @param double $file_size |
||
324 | * @return object |
||
325 | * @method boolean setMaxFileSize |
||
326 | */ |
||
327 | public function setMaxFileSize($file_size) |
||
328 | { |
||
329 | $file_size = $this->sizeInBytes($file_size); |
||
330 | if (is_numeric($file_size) && $file_size > -1) { |
||
331 | // Get php config |
||
332 | $php_size = $this->sizeInBytes((int) ini_get('upload_max_filesize')); |
||
333 | // Calculate difference |
||
334 | if ($php_size < $file_size) { |
||
335 | $this->logger->warning('The upload max file size you set [' .$file_size. '] is greather than the PHP configuration for upload max file size [' .$php_size. ']'); |
||
336 | } |
||
337 | $this->max_file_size = $file_size; |
||
338 | } |
||
339 | return $this; |
||
340 | } |
||
341 | /** |
||
342 | * Set array mime types |
||
343 | * |
||
344 | * @since 1.0 |
||
345 | * @version 1.0 |
||
346 | * @param array $mimes |
||
347 | * @return object |
||
348 | * @method boolean setAllowedMimeTypes |
||
349 | */ |
||
350 | public function setAllowedMimeTypes(array $mimes) |
||
351 | { |
||
352 | if (count($mimes) > 0) { |
||
353 | array_map(array($this , 'setAllowMimeType'), $mimes); |
||
354 | } |
||
355 | return $this; |
||
356 | } |
||
357 | /** |
||
358 | * Set input callback |
||
359 | * |
||
360 | * @since 1.0 |
||
361 | * @version 1.0 |
||
362 | * @param mixed $callback |
||
363 | * @return object |
||
364 | * @method boolean setCallbackInput |
||
365 | */ |
||
366 | public function setCallbackInput($callback) |
||
367 | { |
||
368 | if (is_callable($callback, false)) { |
||
369 | $this->callbacks['input'] = $callback; |
||
370 | } |
||
371 | return $this; |
||
372 | } |
||
373 | /** |
||
374 | * Set output callback |
||
375 | * |
||
376 | * @since 1.0 |
||
377 | * @version 1.0 |
||
378 | * @param mixed $callback |
||
379 | * @return object |
||
380 | * @method boolean setCallbackOutput |
||
381 | */ |
||
382 | public function setCallbackOutput($callback) |
||
383 | { |
||
384 | if (is_callable($callback, false)) { |
||
385 | $this->callbacks['output'] = $callback; |
||
386 | } |
||
387 | return $this; |
||
388 | } |
||
389 | /** |
||
390 | * Append a mime type to allowed mime types |
||
391 | * |
||
392 | * @since 1.0 |
||
393 | * @version 1.0.1 |
||
394 | * @param string $mime |
||
395 | * @return object |
||
396 | * @method boolean setAllowMimeType |
||
397 | */ |
||
398 | public function setAllowMimeType($mime) |
||
405 | } |
||
406 | /** |
||
407 | * Set allowed mime types from mime helping |
||
408 | * |
||
409 | * @since 1.0.1 |
||
410 | * @version 1.0.1 |
||
411 | * @return object |
||
412 | * @method boolean setMimeHelping |
||
413 | */ |
||
414 | public function setMimeHelping($name) |
||
415 | { |
||
416 | if (!empty($name) && is_string($name)) { |
||
417 | if (array_key_exists($name, $this->mime_helping)) { |
||
418 | return $this->setAllowedMimeTypes($this->mime_helping[ $name ]); |
||
419 | } |
||
420 | } |
||
421 | return $this; |
||
422 | } |
||
423 | /** |
||
424 | * Set function to upload file |
||
425 | * Examples: |
||
426 | * 1.- FileUpload::setUploadFunction("move_uploaded_file"); |
||
427 | * 2.- FileUpload::setUploadFunction("copy"); |
||
428 | * |
||
429 | * @since 1.0 |
||
430 | * @version 1.0 |
||
431 | * @param string $function |
||
432 | * @return object |
||
433 | * @method boolean setUploadFunction |
||
434 | */ |
||
435 | public function setUploadFunction($function) |
||
443 | } |
||
444 | /** |
||
445 | * Clear allowed mime types cache |
||
446 | * |
||
447 | * @since 1.0 |
||
448 | * @version 1.0 |
||
449 | * @return object |
||
450 | * @method boolean clearAllowedMimeTypes |
||
451 | */ |
||
452 | public function clearAllowedMimeTypes() |
||
457 | } |
||
458 | /** |
||
459 | * Set destination output |
||
460 | * |
||
461 | * @since 1.0 |
||
462 | * @version 1.0 |
||
463 | * @param string $destination_directory Destination path |
||
464 | * @param boolean $create_if_not_exist |
||
465 | * @return object |
||
466 | * @method boolean setDestinationDirectory |
||
467 | */ |
||
468 | public function setDestinationDirectory($destination_directory, $create_if_not_exist = false) { |
||
469 | $destination_directory = realpath($destination_directory); |
||
470 | if (substr($destination_directory, -1) != DIRECTORY_SEPARATOR) { |
||
471 | $destination_directory .= DIRECTORY_SEPARATOR; |
||
472 | } |
||
473 | |||
474 | if ($this->isDirpath($destination_directory)) { |
||
475 | if ($this->dirExists($destination_directory)) { |
||
476 | $this->destination_directory = $destination_directory; |
||
477 | chdir($destination_directory); |
||
478 | } else if ($create_if_not_exist === true) { |
||
479 | if (mkdir($destination_directory, 0775, true)) { |
||
480 | $this->destination_directory = $destination_directory; |
||
481 | chdir($destination_directory); |
||
482 | } |
||
483 | else{ |
||
484 | $this->logger->warning('Can not create the upload directory [' .$destination_directory. ']'); |
||
485 | } |
||
486 | } |
||
487 | } |
||
488 | return $this; |
||
489 | } |
||
490 | /** |
||
491 | * Check file exists |
||
492 | * |
||
493 | * @since 1.0 |
||
494 | * @version 1.0.1 |
||
495 | * @param string $file_destination |
||
496 | * @return boolean |
||
497 | * @method boolean fileExists |
||
498 | */ |
||
499 | public function fileExists($file_destination) |
||
500 | { |
||
501 | if ($this->isFilename($file_destination)) { |
||
502 | return (file_exists($file_destination) && is_file($file_destination)); |
||
503 | } |
||
504 | return false; |
||
505 | } |
||
506 | /** |
||
507 | * Check dir exists |
||
508 | * |
||
509 | * @since 1.0 |
||
510 | * @version 1.0.1 |
||
511 | * @param string $path |
||
512 | * @return boolean |
||
513 | * @method boolean dirExists |
||
514 | */ |
||
515 | public function dirExists($path) |
||
516 | { |
||
517 | if ($this->isDirpath($path)) { |
||
518 | return (file_exists($path) && is_dir($path)); |
||
519 | } |
||
520 | return false; |
||
521 | } |
||
522 | /** |
||
523 | * Check valid filename |
||
524 | * |
||
525 | * @since 1.0 |
||
526 | * @version 1.0.1 |
||
527 | * @param string $filename |
||
528 | * @return boolean |
||
529 | * @method boolean isFilename |
||
530 | */ |
||
531 | public function isFilename($filename) |
||
532 | { |
||
533 | $filename = basename($filename); |
||
534 | return (!empty($filename) && (is_string( $filename) || is_numeric($filename))); |
||
535 | } |
||
536 | /** |
||
537 | * Validate mime type with allowed mime types, |
||
538 | * but if allowed mime types is empty, this method return true |
||
539 | * |
||
540 | * @since 1.0 |
||
541 | * @version 1.0 |
||
542 | * @param string $mime |
||
543 | * @return boolean |
||
544 | * @method boolean checkMimeType |
||
545 | */ |
||
546 | public function checkMimeType($mime) |
||
547 | { |
||
548 | if (count($this->allowed_mime_types) == 0) { |
||
549 | return true; |
||
550 | } |
||
551 | return in_array(strtolower($mime), $this->allowed_mime_types); |
||
552 | } |
||
553 | /** |
||
554 | * Retrive status of upload |
||
555 | * |
||
556 | * @since 1.0 |
||
557 | * @version 1.0 |
||
558 | * @return boolean |
||
559 | * @method boolean getStatus |
||
560 | */ |
||
561 | public function getStatus() |
||
562 | { |
||
563 | return $this->file['status']; |
||
564 | } |
||
565 | /** |
||
566 | * Check valid path |
||
567 | * |
||
568 | * @since 1.0 |
||
569 | * @version 1.0.1 |
||
570 | * @param string $filename |
||
571 | * @return boolean |
||
572 | * @method boolean isDirpath |
||
573 | */ |
||
574 | public function isDirpath($path) |
||
575 | { |
||
576 | if (!empty( $path) && (is_string( $path) || is_numeric($path) )) { |
||
577 | if (DIRECTORY_SEPARATOR == '/') { |
||
578 | return (preg_match( '/^[^*?"<>|:]*$/' , $path) == 1 ); |
||
579 | } else { |
||
580 | return (preg_match( "/^[^*?\"<>|:]*$/" , substr($path,2) ) == 1); |
||
581 | } |
||
582 | } |
||
583 | return false; |
||
584 | } |
||
585 | /** |
||
586 | * Allow overwriting files |
||
587 | * |
||
588 | * @since 1.0 |
||
589 | * @version 1.0 |
||
590 | * @return object |
||
591 | * @method boolean allowOverwriting |
||
592 | */ |
||
593 | public function allowOverwriting() |
||
594 | { |
||
595 | $this->overwrite_file = true; |
||
596 | return $this; |
||
597 | } |
||
598 | /** |
||
599 | * File info |
||
600 | * |
||
601 | * @since 1.0 |
||
602 | * @version 1.0 |
||
603 | * @return object |
||
604 | * @method object getInfo |
||
605 | */ |
||
606 | public function getInfo() |
||
607 | { |
||
608 | return (object)$this->file; |
||
609 | } |
||
610 | |||
611 | public function isUploaded(){ |
||
612 | return isset($this->file_array[$this->input]) |
||
613 | && |
||
614 | is_uploaded_file($this->file_array[$this->input]['tmp_name']); |
||
615 | } |
||
616 | /** |
||
617 | * Upload file |
||
618 | * |
||
619 | * @since 1.0 |
||
620 | * @version 1.0.1 |
||
621 | * @return boolean |
||
622 | * @method boolean save |
||
623 | */ |
||
624 | public function save(){ |
||
625 | //check if file upload is allowed in the configuration |
||
626 | if(! ini_get('file_uploads')){ |
||
627 | $this->setError($this->error_messages['file_uploads']); |
||
628 | return false; |
||
629 | } |
||
630 | if (count($this->file_array) > 0) { |
||
631 | if (array_key_exists($this->input, $this->file_array)) { |
||
632 | // set original filename if not have a new name |
||
633 | if (empty($this->filename)) { |
||
634 | $this->filename = $this->file_array[$this->input]['name']; |
||
635 | } |
||
636 | else{ |
||
637 | // Replace %s for extension in filename |
||
638 | // Before: /[\w\d]*(.[\d\w]+)$/i |
||
639 | // After: /^[\s[:alnum:]\-\_\.]*\.([\d\w]+)$/iu |
||
640 | // Support unicode(utf-8) characters |
||
641 | // Example: "русские.jpeg" is valid; "Zhōngguó.jpeg" is valid; "Tønsberg.jpeg" is valid |
||
642 | $extension = preg_replace( |
||
643 | '/^[\p{L}\d\s\-\_\.\(\)]*\.([\d\w]+)$/iu', |
||
644 | '$1', |
||
645 | $this->file_array[$this->input]['name'] |
||
646 | ); |
||
647 | $this->filename = $this->filename . '.' . $extension; |
||
648 | } |
||
649 | |||
650 | // set file info |
||
651 | $this->file['mime'] = $this->file_array[$this->input]['type']; |
||
652 | $this->file['tmp'] = $this->file_array[$this->input]['tmp_name']; |
||
653 | $this->file['original'] = $this->file_array[$this->input]['name']; |
||
654 | $this->file['size'] = $this->file_array[$this->input]['size']; |
||
655 | $this->file['sizeFormated'] = $this->sizeFormat($this->file['size']); |
||
656 | $this->file['destination'] = $this->destination_directory . $this->filename; |
||
657 | $this->file['filename'] = $this->filename; |
||
658 | $this->file['error'] = $this->file_array[$this->input]['error']; |
||
659 | |||
660 | $this->logger->info('The upload file information to process is : ' .stringfy_vars($this->file)); |
||
661 | |||
662 | //check for php upload error |
||
663 | if(is_numeric($this->file['error']) && $this->file['error'] > 0){ |
||
664 | $this->setError($this->getPhpUploadErrorMessageByCode($this->file['error'])); |
||
665 | return false; |
||
666 | } |
||
667 | |||
668 | //check for mime type |
||
669 | if (!$this->checkMimeType($this->file['mime'])) { |
||
670 | $this->setError($this->error_messages['accept_file_types']); |
||
671 | return false; |
||
672 | } |
||
673 | |||
674 | // Check file size |
||
675 | if ($this->max_file_size > 0) { |
||
676 | if ($this->max_file_size < $this->file['size']) { |
||
677 | $this->setError(sprintf($this->error_messages['max_file_size'], $this->sizeFormat($this->max_file_size))); |
||
678 | return false; |
||
679 | } |
||
680 | } |
||
681 | |||
682 | // Check if exists file |
||
683 | if ($this->fileExists($this->destination_directory . $this->filename) && $this->overwrite_file === false) { |
||
684 | $this->setError($this->error_messages['overwritten_not_allowed']); |
||
685 | return false; |
||
686 | } |
||
687 | |||
688 | // Execute input callback |
||
689 | if (!empty( $this->callbacks['input'])) { |
||
690 | call_user_func($this->callbacks['input'], (object)$this->file); |
||
691 | } |
||
692 | |||
693 | |||
694 | $this->file['status'] = call_user_func_array( |
||
695 | $this->upload_function, array( |
||
696 | $this->file_array[$this->input]['tmp_name'], |
||
697 | $this->destination_directory . $this->filename |
||
698 | ) |
||
699 | ); |
||
700 | |||
701 | // Execute output callback |
||
702 | if (!empty( $this->callbacks['output'])) { |
||
703 | call_user_func($this->callbacks['output'], (object)$this->file); |
||
704 | } |
||
705 | return $this->file['status']; |
||
706 | } |
||
707 | } |
||
708 | } |
||
709 | |||
710 | /** |
||
711 | * File size for humans. |
||
712 | * |
||
713 | * @since 1.0 |
||
714 | * @version 1.0 |
||
715 | * @param integer $bytes |
||
716 | * @param integer $precision |
||
717 | * @return string |
||
718 | * @method string sizeFormat |
||
719 | */ |
||
720 | public function sizeFormat($size, $precision = 2) |
||
721 | { |
||
722 | if($size > 0){ |
||
723 | $base = log($size) / log(1024); |
||
724 | $suffixes = array('B', 'K', 'M', 'G', 'T'); |
||
725 | return round(pow(1024, $base - floor($base)), $precision) . ( isset($suffixes[floor($base)]) ? $suffixes[floor($base)] : ''); |
||
726 | } |
||
727 | return null; |
||
728 | } |
||
729 | |||
730 | |||
731 | /** |
||
732 | * Convert human file size to bytes |
||
733 | * |
||
734 | * @since 1.0 |
||
735 | * @version 1.0.1 |
||
736 | * @param integer|double $size |
||
737 | * @return integer|double |
||
738 | * @method string sizeInBytes |
||
739 | */ |
||
740 | public function sizeInBytes($size) |
||
750 | } |
||
751 | |||
752 | /** |
||
753 | * Get the upload error message |
||
754 | * @return string |
||
755 | */ |
||
756 | public function getError(){ |
||
757 | return $this->error; |
||
758 | } |
||
759 | |||
760 | /** |
||
761 | * Set the upload error message |
||
762 | * @param string $message the upload error message to set |
||
763 | */ |
||
764 | public function setError($message){ |
||
765 | $this->logger->info('The upload got error : ' . $message); |
||
766 | $this->error = $message; |
||
767 | } |
||
768 | |||
769 | /** |
||
770 | * Get the PHP upload error message for the given code |
||
771 | * @param int $code the error code |
||
772 | * @return string the error message |
||
773 | */ |
||
774 | private function getPhpUploadErrorMessageByCode($code){ |
||
785 | } |
||
786 | } |
||
787 |