24require_once DOL_DOCUMENT_ROOT.
'/core/lib/files.lib.php';
25require_once DOL_DOCUMENT_ROOT.
'/core/lib/images.lib.php';
34 protected $fk_element;
45 public function __construct($options =
null, $fk_element =
null, $element =
null)
50 $hookmanager->initHooks(array(
'fileupload'));
55 $this->fk_element = $fk_element;
56 $this->element = $element;
58 $pathname = str_replace(
'/class',
'', $element_prop[
'classpath']);
59 $filename = $element_prop[
'classfile'];
60 $dir_output = $element_prop[
'dir_output'];
65 if (empty($dir_output)) {
66 setEventMessage(
'The element '.$element.
' is not supported for uploading file. dir_output is unknow.',
'errors');
67 throw new Exception(
'The element '.$element.
' is not supported for uploading file. dir_output is unknow.');
71 if ($pathname !==
null && $filename !==
null) {
79 $savingDocMask = $object_ref.
'-__file__';
83 if ($element ==
'invoice_supplier') {
84 $object_ref =
get_exdir($object->id, 2, 0, 0, $object,
'invoice_supplier').$object_ref;
85 } elseif ($element ==
'project_task') {
86 $parentForeignKey =
'fk_project';
87 $parentClass =
'Project';
88 $parentElement =
'projet';
89 $parentObject =
'project';
92 $parent =
new $parentClass($db);
93 $parent->fetch($object->$parentForeignKey);
94 if (!empty($parent->socid)) {
95 $parent->fetch_thirdparty();
97 $object->$parentObject = clone $parent;
103 $this->options = array(
104 'script_url' => $_SERVER[
'PHP_SELF'],
105 'upload_dir' => $dir_output.
'/'.$object_ref.
'/',
106 'upload_url' => DOL_URL_ROOT.
'/document.php?modulepart='.$element.
'&attachment=1&file=/'.$object_ref.
'/',
107 'saving_doc_mask' => $savingDocMask,
108 'param_name' =>
'files',
111 'delete_type' =>
'DELETE',
114 'max_file_size' =>
null,
115 'min_file_size' => 1,
116 'accept_file_types' =>
'/.+$/i',
118 'max_number_of_files' =>
null,
121 'max_height' =>
null,
125 'discard_aborted_uploads' =>
true,
126 'image_versions' => array(
139 'thumbnail' => array(
140 'upload_dir' => $dir_output.
'/'.$object_ref.
'/thumbs/',
141 'upload_url' => DOL_URL_ROOT.
'/document.php?modulepart='.urlencode($element).
'&attachment=1&file=/'.$object_ref.
'/thumbs/',
150 $hookmanager->executeHooks(
151 'overrideUploadOptions',
153 'options' => &$options,
154 'element' => $element
161 $this->options = array_replace_recursive($this->options, $options);
166 if ($pathname ===
null || $filename ===
null) {
167 if (!key_exists(
"upload_dir", $this->options)) {
168 setEventMessage(
'If $fk_element = null or $element = null you must specify upload_dir on $options',
'errors');
169 throw new Exception(
'If $fk_element = null or $element = null you must specify upload_dir on $options');
170 } elseif (!is_dir($this->options[
'upload_dir'])) {
171 setEventMessage(
'The directory '.$this->options[
'upload_dir'].
' doesn\'t exists',
'errors');
172 throw new Exception(
'The directory '.$this->options[
'upload_dir'].
' doesn\'t exists');
173 } elseif (!is_writable($this->options[
'upload_dir'])) {
174 setEventMessage(
'The directory '.$this->options[
'upload_dir'].
' is not writable',
'errors');
175 throw new Exception(
'The directory '.$this->options[
'upload_dir'].
' is not writable');
187 $https = !empty($_SERVER[
'HTTPS']) && $_SERVER[
'HTTPS'] !==
'off';
189 ($https ?
'https://' :
'http://').
190 (!empty($_SERVER[
'REMOTE_USER']) ? $_SERVER[
'REMOTE_USER'].
'@' :
'').
191 (isset($_SERVER[
'HTTP_HOST']) ? $_SERVER[
'HTTP_HOST'] : ($_SERVER[
'SERVER_NAME'].
192 ($https && $_SERVER[
'SERVER_PORT'] === 443 ||
193 $_SERVER[
'SERVER_PORT'] === 80 ?
'' :
':'.$_SERVER[
'SERVER_PORT']))).
194 substr($_SERVER[
'SCRIPT_NAME'], 0, strrpos($_SERVER[
'SCRIPT_NAME'],
'/'));
205 $file->delete_url = $this->options[
'script_url']
206 .
'?file='.urlencode($file->name).
'&fk_element='.urlencode($this->fk_element).
'&element='.urlencode($this->element);
207 $file->delete_type = $this->options[
'delete_type'];
208 if ($file->delete_type !==
'DELETE') {
209 $file->delete_url .=
'&_method=DELETE';
222 $file_path = $this->options[
'upload_dir'].$file_name;
223 if (is_file($file_path) && $file_name[0] !==
'.') {
224 $file =
new stdClass();
225 $file->name = $file_name;
227 $file->size = filesize($file_path);
228 $file->url = $this->options[
'upload_url'].rawurlencode($file->name);
229 foreach ($this->options[
'image_versions'] as $version => $options) {
230 if (is_file($options[
'upload_dir'].$file_name)) {
231 $tmp = explode(
'.', $file->name);
234 $keyforfile = $version.
'_url';
235 $file->$keyforfile = $options[
'upload_url'].rawurlencode($tmp[0].
'_mini.'.$tmp[1]);
251 return array_values(array_filter(array_map(array($this,
'getFileObject'), scandir($this->options[
'upload_dir']))));
263 global $maxwidthmini, $maxheightmini, $maxwidthsmall, $maxheightsmall;
265 $file_path = $this->options[
'upload_dir'].$file_name;
266 $new_file_path = $options[
'upload_dir'].$file_name;
268 if (
dol_mkdir($options[
'upload_dir']) >= 0) {
269 list($img_width, $img_height) = @getimagesize($file_path);
270 if (!$img_width || !$img_height) {
274 $res =
vignette($file_path, $maxwidthmini, $maxheightmini,
'_mini');
275 if (preg_match(
'/error/i', $res)) {
279 $res =
vignette($file_path, $maxwidthsmall, $maxheightsmall,
'_small');
280 if (preg_match(
'/error/i', $res)) {
299 protected function validate($uploaded_file, $file, $error, $index)
302 $file->error = $error;
306 $file->error =
'missingFileName';
309 if (!preg_match($this->options[
'accept_file_types'], $file->name)) {
310 $file->error =
'acceptFileTypes';
313 if ($uploaded_file && is_uploaded_file($uploaded_file)) {
314 $file_size = filesize($uploaded_file);
316 $file_size = $_SERVER[
'CONTENT_LENGTH'];
318 if ($this->options[
'max_file_size'] && (
319 $file_size > $this->options[
'max_file_size'] ||
320 $file->size > $this->options[
'max_file_size'])
322 $file->error =
'maxFileSize';
325 if ($this->options[
'min_file_size'] &&
326 $file_size < $this->options[
'min_file_size']) {
327 $file->error =
'minFileSize';
330 if (is_numeric($this->options[
'max_number_of_files']) && (
331 count($this->
getFileObjects()) >= $this->options[
'max_number_of_files'])
333 $file->error =
'maxNumberOfFiles';
336 list($img_width, $img_height) = @getimagesize($uploaded_file);
337 if (is_numeric($img_width)) {
338 if ($this->options[
'max_width'] && $img_width > $this->options[
'max_width'] ||
339 $this->options[
'max_height'] && $img_height > $this->options[
'max_height']) {
340 $file->error =
'maxResolution';
343 if ($this->options[
'min_width'] && $img_width < $this->options[
'min_width'] ||
344 $this->options[
'min_height'] && $img_height < $this->options[
'min_height']) {
345 $file->error =
'minResolution';
360 $index = isset($matches[1]) ? intval($matches[1]) + 1 : 1;
361 $ext = isset($matches[2]) ? $matches[2] :
'';
362 return ' ('.$index.
')'.$ext;
373 return preg_replace_callback(
'/(?:(?: \(([\d]+)\))?(\.[^.]+))?$/', array($this,
'upcountNameCallback'), $name, 1);
389 $file_name = trim(basename(stripslashes($name)),
".\x00..\x20");
392 if (strpos($file_name,
'.') ===
false && preg_match(
'/^image\/(gif|jpe?g|png)/', $type, $matches)) {
393 $file_name .=
'.'.$matches[1];
395 if ($this->options[
'discard_aborted_uploads']) {
396 while (is_file($this->options[
'upload_dir'].$file_name)) {
417 $file =
new stdClass();
418 $file->name = $this->
trimFileName($name, $type, $index);
420 $file->size = intval($size);
423 $validate = $this->
validate($uploaded_file, $file, $error, $index);
426 if (
dol_mkdir($this->options[
'upload_dir']) >= 0) {
428 $fileNameWithoutExt = preg_replace(
'/\.[^\.]+$/',
'', $file->name);
429 $savingDocMask = $this->options[
'saving_doc_mask'];
430 if ($savingDocMask && strpos($savingDocMask, $fileNameWithoutExt) !== 0) {
431 $fileNameWithPrefix = preg_replace(
'/__file__/', $file->name, $savingDocMask);
432 $file->name = $fileNameWithPrefix;
435 $file_path = $this->options[
'upload_dir'].$file->name;
436 $append_file = !$this->options[
'discard_aborted_uploads'] && is_file($file_path) && $file->size > filesize($file_path);
440 if ($uploaded_file && is_uploaded_file($uploaded_file)) {
443 file_put_contents($file_path, fopen($uploaded_file,
'r'), FILE_APPEND);
449 file_put_contents($file_path, fopen(
'php://input',
'r'), $append_file ? FILE_APPEND : 0);
451 $file_size = filesize($file_path);
452 if ($file_size === $file->size) {
453 $file->url = $this->options[
'upload_url'].rawurlencode($file->name);
454 foreach ($this->options[
'image_versions'] as $version => $options) {
456 $tmp = explode(
'.', $file->name);
459 $keyforfile = $version.
'_url';
460 $file->$keyforfile = $options[
'upload_url'].rawurlencode($tmp[0].
'_mini.'.$tmp[1]);
463 } elseif ($this->options[
'discard_aborted_uploads']) {
465 $file->error =
'abort';
467 $file->size = $file_size;
470 $file->error =
'failedtocreatedestdir';
484 public function get()
486 $file_name = isset($_REQUEST[
'file']) ?
487 basename(stripslashes($_REQUEST[
'file'])) :
null;
493 header(
'Content-type: application/json');
494 echo json_encode($info);
506 if (isset($_REQUEST[
'_method']) && $_REQUEST[
'_method'] ===
'DELETE') {
507 return $this->
delete();
511 $upload = isset($_FILES[$this->options[
'param_name']]) ?
512 $_FILES[$this->options[
'param_name']] :
null;
514 if ($upload && is_array($upload[
'tmp_name'])) {
517 foreach ($upload[
'tmp_name'] as $index => $value) {
519 $upload[
'tmp_name'][$index],
520 isset($_SERVER[
'HTTP_X_FILE_NAME']) ? $_SERVER[
'HTTP_X_FILE_NAME'] : $upload[
'name'][$index],
521 isset($_SERVER[
'HTTP_X_FILE_SIZE']) ? $_SERVER[
'HTTP_X_FILE_SIZE'] : $upload[
'size'][$index],
522 isset($_SERVER[
'HTTP_X_FILE_TYPE']) ? $_SERVER[
'HTTP_X_FILE_TYPE'] : $upload[
'type'][$index],
523 $upload[
'error'][$index],
526 if (!empty($tmpres->error)) {
531 } elseif ($upload || isset($_SERVER[
'HTTP_X_FILE_NAME'])) {
535 isset($upload[
'tmp_name']) ? $upload[
'tmp_name'] :
null,
536 isset($_SERVER[
'HTTP_X_FILE_NAME']) ? $_SERVER[
'HTTP_X_FILE_NAME'] : (isset($upload[
'name']) ? $upload[
'name'] :
null),
537 isset($_SERVER[
'HTTP_X_FILE_SIZE']) ? $_SERVER[
'HTTP_X_FILE_SIZE'] : (isset($upload[
'size']) ? $upload[
'size'] :
null),
538 isset($_SERVER[
'HTTP_X_FILE_TYPE']) ? $_SERVER[
'HTTP_X_FILE_TYPE'] : (isset($upload[
'type']) ? $upload[
'type'] :
null),
539 isset($upload[
'error']) ? $upload[
'error'] :
null,
542 if (!empty($tmpres->error)) {
548 header(
'Vary: Accept');
549 $json = json_encode($info);
559 if (isset($_SERVER[
'HTTP_ACCEPT']) && (strpos($_SERVER[
'HTTP_ACCEPT'],
'application/json') !==
false)) {
560 header(
'Content-type: application/json');
562 header(
'Content-type: text/plain');
574 public function delete()
576 $file_name = isset($_REQUEST[
'file']) ?
577 basename(stripslashes($_REQUEST[
'file'])) :
null;
578 $file_path = $this->options[
'upload_dir'].$file_name;
579 $success = is_file($file_path) && $file_name[0] !==
'.' && unlink($file_path);
581 foreach ($this->options[
'image_versions'] as $version => $options) {
582 $file = $options[
'upload_dir'].$file_name;
583 if (is_file($file)) {
589 header(
'Content-type: application/json');
590 echo json_encode($success);
This class is used to manage file upload using ajax.
getFileObjects()
getFileObjects
setFileDeleteUrl($file)
Set delete url.
__construct($options=null, $fk_element=null, $element=null)
Constructor.
handleFileUpload($uploaded_file, $name, $size, $type, $error, $index)
handleFileUpload.
upcountName($name)
Enter description here ...
getFileObject($file_name)
getFileObject
upcountNameCallback($matches)
Enter description here ...
createScaledImage($file_name, $options)
Create thumbs of a file uploaded.
getFullUrl()
Return full URL.
trimFileName($name, $type, $index)
trimFileName
validate($uploaded_file, $file, $error, $index)
Enter description here ...
dol_move_uploaded_file($src_file, $dest_file, $allowoverwrite, $disablevirusscan=0, $uploaderrorcode=0, $nohook=0, $varfiles='addedfile', $upload_dir='')
Make control on an uploaded file from an GUI page and move it to final destination.
dol_mimetype($file, $default='application/octet-stream', $mode=0)
Return MIME type of a file from its name with extension.
setEventMessage($mesgs, $style='mesgs', $noduplicate=0)
Set event message in dol_events session object.
getDolGlobalInt($key, $default=0)
Return dolibarr global constant int value.
if(!function_exists( 'dol_getprefix')) dol_include_once($relpath, $classname='')
Make an include_once using default root and alternate root if it fails.
getElementProperties($element_type)
Get an array with properties of an element.
dol_sanitizeFileName($str, $newstr='_', $unaccent=1)
Clean a string to use it as a file name.
fetchObjectByElement($element_id, $element_type, $element_ref='')
Fetch an object from its id and element_type Inclusion of classes is automatic.
get_exdir($num, $level, $alpha, $withoutslash, $object, $modulepart='')
Return a path to have a the directory according to object where files are stored.
dol_mkdir($dir, $dataroot='', $newmask='')
Creation of a directory (this can create recursive subdir)
vignette($file, $maxWidth=160, $maxHeight=120, $extName='_small', $quality=50, $outdir='thumbs', $targetformat=0)
Create a thumbnail from an image file (Supported extensions are gif, jpg, png and bmp).