dolibarr 24.0.0-beta
files.lib.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2008-2012 Laurent Destailleur <eldy@users.sourceforge.net>
3 * Copyright (C) 2012-2021 Regis Houssin <regis.houssin@inodbox.com>
4 * Copyright (C) 2012-2016 Juanjo Menent <jmenent@2byte.es>
5 * Copyright (C) 2015 Marcos García <marcosgdf@gmail.com>
6 * Copyright (C) 2016 Raphaël Doursenaud <rdoursenaud@gpcsolutions.fr>
7 * Copyright (C) 2019-2026 Frédéric France <frederic.france@free.fr>
8 * Copyright (C) 2023 Lenin Rivas <lenin.rivas777@gmail.com>
9 * Copyright (C) 2024-2026 MDW <mdeweerd@users.noreply.github.com>
10 * Copyright (C) 2025 William Mead <william@m34d.com>
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 3 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <https://www.gnu.org/licenses/>.
24 * or see https://www.gnu.org/
25 */
26
39function dol_basename($pathfile)
40{
41 return preg_replace('/^.*\/([^\/]+)$/', '$1', rtrim($pathfile, '/'));
42}
43
64function dol_dir_list($utf8_path, $types = "all", $recursive = 0, $filter = "", $excludefilter = null, $sortcriteria = "name", $sortorder = SORT_ASC, $mode = 0, $nohook = 0, $relativename = "", $donotfollowsymlinks = 0, $nbsecondsold = 0)
65{
66 global $hookmanager;
67 global $object;
68
69 if ($recursive <= 1) { // Avoid too verbose log
70 $error_info = "";
71
72 // Verify filters (only on the first call of the function)
73 $filter_ok = true;
74 if (!empty($filter) && !is_array($filter)) {
75 if (strlen($filter) > 25000) { // Note that limit depends on syntax of filter
76 dol_syslog("Value for filter is too large", LOG_ERR);
77 $filter_ok = false;
78 } else {
79 // Check that all '/' are escaped.
80 if ((int) preg_match('/(?:^|[^\\\\])\//', $filter) > 0) {
81 $excludefilter_ok = false;
82 $error_info .= " error='filter_has_unescaped_slash'";
83 dol_syslog("'$filter' has unescaped '/'", LOG_ERR);
84 }
85 }
86 }
87
88 // Ensure we have an array for the exclusions
89 $excludefilter_ok = true;
90 $exclude_array = ($excludefilter === null || $excludefilter === '') ? array() : (is_array($excludefilter) ? $excludefilter : array($excludefilter));
91 foreach ($exclude_array as $f) {
92 // Check that all '/' are escaped.
93 if ((int) preg_match('/(?:^|[^\\\\])\//', $f) > 0) {
94 $excludefilter_ok = false;
95 $error_info .= " error='excludefilter_has_unescaped_slash'";
96 dol_syslog("'$f' has unescaped '/'", LOG_ERR);
97 }
98 }
99
100 dol_syslog("files.lib.php::dol_dir_list path=".$utf8_path." types=".$types." recursive=".$recursive." filter=".json_encode($filter)." excludefilter=".json_encode($excludefilter).$error_info);
101 // print 'xxx'."files.lib.php::dol_dir_list path=".$utf8_path." types=".$types." recursive=".$recursive." filter=".json_encode($filter)." excludefilter=".json_encode($exclude_array);
102 if (!$filter_ok || !$excludefilter_ok) {
103 // Return empty array when filters are invalid
104 return array();
105 }
106 } else {
107 // Already computed before
108 $exclude_array = ($excludefilter === null || $excludefilter === '') ? array() : (is_array($excludefilter) ? $excludefilter : array($excludefilter));
109 }
110
111 // Define excludefilterarray (before while, for speed)
112 $excludefilterarray = array_merge(array('^\.'), $exclude_array);
113
114 $loaddate = ($mode == 1 || $mode == 2 || $nbsecondsold != 0 || $sortcriteria == 'date');
115 $loadsize = ($mode == 1 || $mode == 3 || $sortcriteria == 'size');
116 $loadperm = ($mode == 1 || $mode == 4 || $sortcriteria == 'perm');
117
118 $now = dol_now();
119 $reshook = 0;
120 $file_list = array();
121
122 // Clean parameters
123 $utf8_path = preg_replace('/([\\/]+)$/', '', $utf8_path);
124
125 if (preg_match('/\*/', $utf8_path)) {
126 $utf8_path_array = glob($utf8_path, GLOB_ONLYDIR); // This scan dir for files. If file does not exists, return empty.
127 //$os_path_array = dol_dir_list($utf8_path);
128 } else {
129 $utf8_path_array = array($utf8_path);
130 }
131
132 foreach ($utf8_path_array as $utf8_path_cursor) {
133 $os_path = dol_osencode($utf8_path_cursor);
134 if (!$nohook && $hookmanager instanceof HookManager) {
135 $hookmanager->resArray = array();
136
137 $hookmanager->initHooks(array('fileslib'));
138
139 $parameters = array(
140 'path' => $os_path,
141 'types' => $types,
142 'recursive' => $recursive,
143 'filter' => $filter,
144 'excludefilter' => $exclude_array, // Already converted to array.
145 'sortcriteria' => $sortcriteria,
146 'sortorder' => $sortorder,
147 'loaddate' => $loaddate,
148 'loadsize' => $loadsize,
149 'mode' => $mode
150 );
151 $reshook = $hookmanager->executeHooks('getDirList', $parameters, $object);
152 }
153
154 // $hookmanager->resArray may contain array stacked by other modules
155 if (empty($reshook)) {
156 if (!is_dir($os_path)) {
157 continue;
158 }
159
160 if (($dir = opendir($os_path)) === false) {
161 continue;
162 }
163
164 $filedate = '';
165 $filesize = '';
166 $fileperm = '';
167
168 while (false !== ($os_file = readdir($dir))) { // $utf8_file is always a basename (in directory $os_path)
169 $os_fullpathfile = ($os_path ? $os_path.'/' : '').$os_file;
170
171 if (!utf8_check($os_file)) {
172 $utf8_file = mb_convert_encoding($os_file, 'UTF-8', 'ISO-8859-1'); // Make sure data is stored in utf8 in memory
173 } else {
174 $utf8_file = $os_file;
175 }
176
177 $utf8_fullpathfile = $utf8_path_cursor."/".$utf8_file; // Temp variable for speed
178
179 // Check if file is qualified
180 $qualified = 1;
181 foreach ($excludefilterarray as $filt) {
182 if (preg_match('/'.$filt.'/i', $utf8_file) || preg_match('/'.$filt.'/i', $utf8_fullpathfile)) {
183 $qualified = 0;
184 break;
185 }
186 }
187 //print $utf8_fullpathfile.' '.$utf8_file.' '.$qualified.'<br>';
188
189 if ($qualified) {
190 $isdir = is_dir($os_fullpathfile);
191 // Check whether this is a file or directory and whether we're interested in that type
192 if ($isdir) {
193 // Add entry into file_list array
194 if (($types == "directories") || ($types == "all")) {
195 if ($loaddate || $sortcriteria == 'date') {
196 $filedate = dol_filemtime($utf8_fullpathfile);
197 }
198 if ($loadsize || $sortcriteria == 'size') {
199 $filesize = dol_filesize($utf8_fullpathfile);
200 }
201 if ($loadperm || $sortcriteria == 'perm') {
202 $fileperm = dol_fileperm($utf8_fullpathfile);
203 }
204
205 $qualifiedforfilter = 0;
206 if (empty($filter)) {
207 $qualifiedforfilter = 1;
208 } else {
209 $testpregmatch = false;
210 if (is_array($filter)) {
211 $chunks = array_chunk($filter, 500);
212 foreach ($chunks as $chunk) {
213 $testpregmatch = preg_match('/'.implode('|', $chunk).'/i', $utf8_file); // May failed if $filter too large
214 if ($testpregmatch) {
215 break;
216 }
217 }
218 } else {
219 $testpregmatch = preg_match('/'.$filter.'/i', $utf8_file); // May failed if $filter too large
220 }
221 if ($testpregmatch) {
222 $qualifiedforfilter = 1;
223 }
224 }
225
226 if ($qualifiedforfilter) { // We do not search key $filter into all $path, only into $file part
227 $reg = array();
228 preg_match('/([^\/]+)\/[^\/]+$/', $utf8_fullpathfile, $reg);
229 $level1name = (isset($reg[1]) ? $reg[1] : '');
230 $file_list[] = array(
231 "name" => $utf8_file,
232 "path" => $utf8_path,
233 "level1name" => $level1name,
234 "relativename" => ($relativename ? $relativename.'/' : '').$utf8_file,
235 "fullname" => $utf8_fullpathfile,
236 "date" => $filedate,
237 "size" => $filesize,
238 "perm" => $fileperm,
239 "type" => 'dir'
240 );
241 }
242 }
243
244 // if we're in a directory and we want recursive behavior, call this function again
245 if ($recursive > 0) {
246 if (empty($donotfollowsymlinks) || !is_link($os_fullpathfile)) {
247 //var_dump('eee '. $utf8_fullpathfile. ' '.is_dir($utf8_fullpathfile).' '.is_link($utf8_fullpathfile));
248 $file_list = array_merge($file_list, dol_dir_list($utf8_fullpathfile, $types, $recursive + 1, $filter, $exclude_array, $sortcriteria, $sortorder, $mode, $nohook, ($relativename != '' ? $relativename.'/' : '').$utf8_file, $donotfollowsymlinks, $nbsecondsold));
249 }
250 }
251 } elseif (in_array($types, array("files", "all"))) {
252 // Add file into file_list array
253 if ($loaddate || $sortcriteria == 'date') {
254 $filedate = dol_filemtime($utf8_fullpathfile);
255 }
256 if ($loadsize || $sortcriteria == 'size') {
257 $filesize = dol_filesize($utf8_fullpathfile);
258 }
259
260 $qualifiedforfilter = 0;
261 if (empty($filter)) {
262 $qualifiedforfilter = 1;
263 } else {
264 $testpregmatch = false;
265 if (is_array($filter)) {
266 $chunks = array_chunk($filter, 500);
267 foreach ($chunks as $chunk) {
268 $testpregmatch = preg_match('/'.implode('|', $chunk).'/i', $utf8_file); // May failed if $filter too large
269 if ($testpregmatch) {
270 break;
271 }
272 }
273 } else {
274 $testpregmatch = preg_match('/'.$filter.'/i', $utf8_file); // May failed if $filter too large
275 }
276 if ($testpregmatch) {
277 $qualifiedforfilter = 1;
278 }
279 }
280
281 if ($qualifiedforfilter) { // We do not search key $filter into all $path, only into $file part
282 if (empty($nbsecondsold) || $filedate <= ($now - $nbsecondsold)) {
283 preg_match('/([^\/]+)\/[^\/]+$/', $utf8_fullpathfile, $reg);
284 $level1name = (isset($reg[1]) ? $reg[1] : '');
285 $file_list[] = array(
286 "name" => $utf8_file,
287 "path" => $utf8_path,
288 "level1name" => $level1name,
289 "relativename" => ($relativename ? $relativename.'/' : '').$utf8_file,
290 "fullname" => $utf8_fullpathfile,
291 "date" => $filedate,
292 "size" => $filesize,
293 "type" => 'file'
294 );
295 }
296 }
297 }
298 }
299 }
300 closedir($dir);
301 }
302 }
303
304 // Obtain a list of columns
305 if (!empty($sortcriteria) && $sortorder) {
306 $file_list = dol_sort_array($file_list, $sortcriteria, ($sortorder == SORT_ASC ? 'asc' : 'desc'));
307 }
308
309 if ($hookmanager instanceof HookManager && is_array($hookmanager->resArray)) {
310 $file_list = array_merge($file_list, $hookmanager->resArray);
311 }
312
313 return $file_list;
314}
315
316
333function dol_dir_list_in_database($path, $filter = "", $excludefilter = null, $sortcriteria = "name", $sortorder = SORT_ASC, $mode = 0, $sqlfilters = "", $object = null)
334{
335 global $conf, $db;
336
337 if (is_null($object)) {
338 $object = new stdClass();
339 }
340
341 $sql = "SELECT rowid, label, entity, filename, filepath, fullpath_orig, keywords, cover, gen_or_uploaded, extraparams,";
342 $sql .= " date_c, tms as date_m, fk_user_c, fk_user_m, acl, position, share";
343 if ($mode) {
344 $sql .= ", description";
345 }
346 $sql .= " FROM ".MAIN_DB_PREFIX."ecm_files";
347 if (!empty($object->entity)) {
348 $sql .= " WHERE entity = ".((int) $object->entity);
349 } else {
350 $sql .= " WHERE entity = ".((int) $conf->entity);
351 }
352 if (preg_match('/%$/', $path)) {
353 $sql .= " AND (filepath LIKE '".$db->escape($path)."' OR filepath = '".$db->escape(preg_replace('/\/%$/', '', $path))."')";
354 } else {
355 $sql .= " AND filepath = '".$db->escape($path)."'";
356 }
357
358 // Manage filter
359 $errormessage = '';
360 $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
361 if ($errormessage) {
362 dol_print_error(null, $errormessage);
363 return array();
364 }
365
366 $resql = $db->query($sql);
367 if ($resql) {
368 $file_list = array();
369 $num = $db->num_rows($resql);
370 $i = 0;
371 while ($i < $num) {
372 $obj = $db->fetch_object($resql);
373 if ($obj) {
374 $reg = array();
375 preg_match('/([^\/]+)\/[^\/]+$/', DOL_DATA_ROOT.'/'.$obj->filepath.'/'.$obj->filename, $reg);
376 $level1name = (isset($reg[1]) ? $reg[1] : '');
377 $file_list[] = array(
378 "rowid" => $obj->rowid,
379 "label" => $obj->label, // md5
380 "name" => $obj->filename,
381 "path" => DOL_DATA_ROOT.'/'.$obj->filepath,
382 "level1name" => $level1name,
383 "fullname" => DOL_DATA_ROOT.'/'.$obj->filepath.'/'.$obj->filename,
384 "fullpath_orig" => $obj->fullpath_orig,
385 "date_c" => $db->jdate($obj->date_c),
386 "date_m" => $db->jdate($obj->date_m),
387 "type" => 'file',
388 "keywords" => $obj->keywords,
389 "cover" => $obj->cover,
390 "position" => (int) $obj->position,
391 "acl" => $obj->acl,
392 "share" => $obj->share,
393 "description" => ($mode ? $obj->description : '')
394 // TODO Add 'content' with $mode == 2 ?
395 );
396 }
397 $i++;
398 }
399
400 // Obtain a list of columns
401 if (!empty($sortcriteria)) {
402 $myarray = array();
403 foreach ($file_list as $key => $row) {
404 $myarray[$key] = (isset($row[$sortcriteria]) ? $row[$sortcriteria] : '');
405 }
406 // Sort the data
407 if ($sortorder) {
408 array_multisort($myarray, $sortorder, SORT_REGULAR, $file_list);
409 }
410 }
411
412 return $file_list;
413 } else {
415 return array();
416 }
417}
418
419
429function completeFileArrayWithDatabaseInfo(&$filearray, $relativedir, $object = null)
430{
431 global $conf, $db, $user;
432
433 if (is_null($object)) {
434 $object = new stdClass();
435 $object->id = null;
436 $object->element = null;
437 }
438
439 $filearrayindatabase = dol_dir_list_in_database(rtrim($relativedir, "/\\"), '', null, 'name', SORT_ASC, 0, '', $object);
440
441 global $modulepart;
442 if ($modulepart == 'produit' && getDolGlobalInt('PRODUCT_USE_OLD_PATH_FOR_PHOTO')) {
443 // TODO Remove this when PRODUCT_USE_OLD_PATH_FOR_PHOTO will be removed
444 global $object;
445 if (!empty($object->id)) {
446 if (isModEnabled("product")) {
447 $upload_dirold = $conf->product->multidir_output[$object->entity ?? $conf->entity].'/'.substr(substr("000".$object->id, -2), 1, 1).'/'.substr(substr("000".$object->id, -2), 0, 1).'/'.$object->id."/photos";
448 } else {
449 $upload_dirold = $conf->service->multidir_output[$object->entity ?? $conf->entity].'/'.substr(substr("000".$object->id, -2), 1, 1).'/'.substr(substr("000".$object->id, -2), 0, 1).'/'.$object->id."/photos";
450 }
451
452 $relativedirold = preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'/', '', $upload_dirold);
453 $relativedirold = ltrim($relativedirold, "/\\");
454
455 $filearrayindatabase = array_merge($filearrayindatabase, dol_dir_list_in_database($relativedirold, '', null, 'name', SORT_ASC));
456 }
457 } elseif ($modulepart == 'ticket') {
458 foreach ($filearray as $key => $val) {
459 $rel_dir = preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'/', '', $filearray[$key]['path']);
460 $rel_dir = trim($rel_dir, "/\\");
461 if ($rel_dir != $relativedir) {
462 $filearrayindatabase = array_merge($filearrayindatabase, dol_dir_list_in_database($rel_dir, '', null, 'name', SORT_ASC));
463 }
464 }
465 }
466
467 // Complete filearray with properties found into $filearrayindatabase
468 foreach ($filearray as $key => $val) {
469 $tmpfilename = preg_replace('/\.noexe$/', '', $filearray[$key]['name']);
470 $found = 0;
471 // Search if it exists into $filearrayindatabase
472 foreach ($filearrayindatabase as $key2 => $val2) {
473 if (($filearrayindatabase[$key2]['path'] == $filearray[$key]['path']) && ($filearrayindatabase[$key2]['name'] == $tmpfilename)) {
474 $filearray[$key]['position_name'] = ($filearrayindatabase[$key2]['position'] ? $filearrayindatabase[$key2]['position'] : '0').'_'.$filearrayindatabase[$key2]['name'];
475 $filearray[$key]['position'] = $filearrayindatabase[$key2]['position'];
476 $filearray[$key]['cover'] = $filearrayindatabase[$key2]['cover'];
477 $filearray[$key]['keywords'] = $filearrayindatabase[$key2]['keywords'];
478 $filearray[$key]['acl'] = $filearrayindatabase[$key2]['acl'];
479 $filearray[$key]['rowid'] = $filearrayindatabase[$key2]['rowid'];
480 $filearray[$key]['label'] = $filearrayindatabase[$key2]['label'];
481 $filearray[$key]['share'] = $filearrayindatabase[$key2]['share'];
482 $found = 1;
483 break;
484 }
485 }
486
487 if (!$found) { // This happen in transition toward version 6, or if files were added manually into os dir.
488 $filearray[$key]['position'] = '999999'; // File not indexed are at end. So if we add a file, it will not replace an existing position
489 $filearray[$key]['cover'] = 0;
490 $filearray[$key]['acl'] = '';
491 $filearray[$key]['share'] = 0;
492
493 $rel_filename = preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'/', '', $filearray[$key]['fullname']);
494
495 if (!preg_match('/([\\/]temp[\\/]|[\\/]thumbs|\.meta$)/', $rel_filename)) { // If not a tmp file
496 dol_syslog("list_of_documents We found a file called '".$filearray[$key]['name']."' not indexed into database. We add it");
497
498 include_once DOL_DOCUMENT_ROOT.'/ecm/class/ecmfiles.class.php';
499 $ecmfile = new EcmFiles($db);
500
501 // Add entry into database
502 $filename = basename($rel_filename);
503 $rel_dir = dirname($rel_filename);
504 $rel_dir = preg_replace('/[\\/]$/', '', $rel_dir);
505 $rel_dir = preg_replace('/^[\\/]/', '', $rel_dir);
506
507 $ecmfile->filepath = $rel_dir;
508 $ecmfile->filename = $filename;
509 $ecmfile->label = md5_file(dol_osencode($filearray[$key]['fullname'])); // $destfile is a full path to file
510 $ecmfile->fullpath_orig = $filearray[$key]['fullname'];
511 $ecmfile->gen_or_uploaded = 'unknown';
512 if (is_object($object)) {
513 $ecmfile->src_object_type = $object->element;
514 $ecmfile->src_object_id = $object->id;
515 }
516 $ecmfile->description = ''; // indexed content
517 $ecmfile->keywords = ''; // keyword content
518 // When you scan file with dol_dir_list_in_database, you scan for files in entity of object (like with projects), even if you
519 // are connected into another entity. So we must also create record that was not found into the entity scan, so the one of the object).
520 $ecmfile->entity = empty($object->entity) ? $conf->entity : $object->entity;
521
522 $result = $ecmfile->create($user);
523 if ($result < 0) {
524 setEventMessages($ecmfile->error, $ecmfile->errors, 'warnings');
525 } else {
526 $filearray[$key]['rowid'] = $result;
527 }
528 } else {
529 $filearray[$key]['rowid'] = 0; // Should not happened
530 }
531 }
532 }
533 //var_dump($filearray); var_dump($relativedir.' - tmpfilename='.$tmpfilename.' - found='.$found);
534}
535
536
544function dol_compare_file($a, $b)
545{
546 global $sortorder, $sortfield;
547
548 $sortorder = strtoupper($sortorder);
549
550 if ($sortorder == 'ASC') {
551 $retup = -1;
552 $retdown = 1;
553 } else {
554 $retup = 1;
555 $retdown = -1;
556 }
557
558 if ($sortfield == 'name') {
559 if ($a->name == $b->name) {
560 return 0;
561 }
562 return ($a->name < $b->name) ? $retup : $retdown;
563 }
564 if ($sortfield == 'date') {
565 if ($a->date == $b->date) {
566 return 0;
567 }
568 return ($a->date < $b->date) ? $retup : $retdown;
569 }
570 if ($sortfield == 'size') {
571 if ($a->size == $b->size) {
572 return 0;
573 }
574 return ($a->size < $b->size) ? $retup : $retdown;
575 }
576
577 return 0;
578}
579
580
587function dol_is_dir($folder)
588{
589 $newfolder = dol_osencode($folder);
590 if (is_dir($newfolder)) {
591 return true;
592 } else {
593 return false;
594 }
595}
596
603function dol_is_dir_empty($dir)
604{
605 if (!is_readable($dir)) {
606 return false;
607 }
608 return (count(scandir($dir)) == 2);
609}
610
617function dol_is_file($pathoffile)
618{
619 $newpathoffile = dol_osencode($pathoffile);
620 return is_file($newpathoffile);
621}
622
629function dol_is_link($pathoffile)
630{
631 $newpathoffile = dol_osencode($pathoffile);
632 return is_link($newpathoffile);
633}
634
641function dol_is_writable($folderorfile)
642{
643 $newfolderorfile = dol_osencode($folderorfile);
644 return is_writable($newfolderorfile);
645}
646
655function dol_is_url($uri)
656{
657 $prots = array('file', 'http', 'https', 'ftp', 'zlib', 'data', 'ssh', 'ssh2', 'ogg', 'expect');
658 return false !== preg_match('/^('.implode('|', $prots).'):/i', $uri);
659}
660
667function dol_dir_is_emtpy($folder)
668{
669 $newfolder = dol_osencode($folder);
670 if (is_dir($newfolder)) {
671 $handle = opendir($newfolder);
672 $folder_content = '';
673 $name_array = [];
674 while ((gettype($name = readdir($handle)) != "boolean")) {
675 $name_array[] = $name;
676 }
677 foreach ($name_array as $temp) {
678 $folder_content .= $temp;
679 }
680
681 closedir($handle);
682
683 if ($folder_content == "...") {
684 return true;
685 } else {
686 return false;
687 }
688 } else {
689 return true; // Dir does not exists
690 }
691}
692
700function dol_count_nb_of_line($file)
701{
702 $nb = 0;
703
704 $newfile = dol_osencode($file);
705 //print 'x'.$file;
706 $fp = fopen($newfile, 'r');
707 if ($fp) {
708 while (!feof($fp)) {
709 $line = fgets($fp);
710 // Increase count only if read was success.
711 // Test needed because feof returns true only after fgets
712 // so we do n+1 fgets for a file with n lines.
713 if ($line !== false) {
714 $nb++;
715 }
716 }
717 fclose($fp);
718 } else {
719 $nb = -1;
720 }
721
722 return $nb;
723}
724
725
733function dol_filesize($pathoffile)
734{
735 $newpathoffile = dol_osencode($pathoffile);
736 return filesize($newpathoffile);
737}
738
745function dol_filemtime($pathoffile)
746{
747 $newpathoffile = dol_osencode($pathoffile);
748 return @filemtime($newpathoffile); // @Is to avoid errors if files does not exists
749}
750
757function dol_fileperm($pathoffile)
758{
759 $newpathoffile = dol_osencode($pathoffile);
760 return fileperms($newpathoffile);
761}
762
775function dolReplaceInFile($srcfile, $arrayreplacement, $destfile = '', $newmask = '0', $indexdatabase = 0, $arrayreplacementisregex = 0)
776{
777 dol_syslog("files.lib.php::dolReplaceInFile srcfile=".$srcfile." destfile=".$destfile." newmask=".$newmask." indexdatabase=".$indexdatabase." arrayreplacementisregex=".$arrayreplacementisregex);
778
779 if (empty($srcfile)) {
780 return -1;
781 }
782 if (empty($destfile)) {
783 $destfile = $srcfile;
784 }
785
786 // Clean the aa/bb/../cc into aa/cc
787 $srcfile = preg_replace('/\.\.\/?/', '', $srcfile);
788 $destfile = preg_replace('/\.\.\/?/', '', $destfile);
789
790 $destexists = dol_is_file($destfile);
791 if (($destfile != $srcfile) && $destexists) {
792 return 0;
793 }
794
795 $srcexists = dol_is_file($srcfile);
796 if (!$srcexists) {
797 dol_syslog("files.lib.php::dolReplaceInFile failed to read src file", LOG_WARNING);
798 return -3;
799 }
800
801 $tmpdestfile = $destfile.'.tmp';
802
803 $newpathofsrcfile = dol_osencode($srcfile);
804 $newpathoftmpdestfile = dol_osencode($tmpdestfile);
805 $newpathofdestfile = dol_osencode($destfile);
806 $newdirdestfile = dirname($newpathofdestfile);
807
808 if ($destexists && !is_writable($newpathofdestfile)) {
809 dol_syslog("files.lib.php::dolReplaceInFile failed Permission denied to overwrite target file", LOG_WARNING);
810 return -1;
811 }
812 if (!is_writable($newdirdestfile)) {
813 dol_syslog("files.lib.php::dolReplaceInFile failed Permission denied to write into target directory ".$newdirdestfile, LOG_WARNING);
814 return -2;
815 }
816
817 dol_delete_file($tmpdestfile);
818
819 // Create $newpathoftmpdestfile from $newpathofsrcfile
820 $content = file_get_contents($newpathofsrcfile);
821
822 if (empty($arrayreplacementisregex)) {
823 $content = make_substitutions($content, $arrayreplacement, null);
824 } else {
825 foreach ($arrayreplacement as $key => $value) {
826 $content = preg_replace($key, (string) $value, $content);
827 }
828 }
829
830 file_put_contents($newpathoftmpdestfile, $content);
831 dolChmod($newpathoftmpdestfile, $newmask);
832
833 // Rename
834 $moreinfo = array('gen_or_uploaded' => 'unknown');
835 $result = dol_move($newpathoftmpdestfile, $newpathofdestfile, $newmask, (($destfile == $srcfile) ? 1 : 0), 0, $indexdatabase, $moreinfo);
836 if (!$result) {
837 dol_syslog("files.lib.php::dolReplaceInFile failed to move tmp file to final dest", LOG_WARNING);
838 return -3;
839 }
840 if (empty($newmask) && getDolGlobalString('MAIN_UMASK')) {
841 $newmask = getDolGlobalString('MAIN_UMASK');
842 }
843 if (empty($newmask)) { // This should no happen
844 dol_syslog("Warning: dolReplaceInFile called with empty value for newmask and no default value defined", LOG_WARNING);
845 $newmask = '0664';
846 }
847
848 dolChmod($newpathofdestfile, $newmask);
849
850 return 1;
851}
852
860function removePatternFromFile(string $filePath, string $pattern): bool
861{
862 // Check if the file exists
863 if (! file_exists($filePath)) {
864 dol_syslog("files.lib.php::removePatternFromFile: File $filePath does not exist", LOG_WARNING);
865
866 return false;
867 }
868
869 // Read the file content
870 $content = file_get_contents($filePath);
871 if ($content === false) {
872 dol_syslog("files.lib.php::removePatternFromFile: Unable to read the file $filePath", LOG_WARNING);
873
874 return false;
875 }
876
877 // Remove content matching the pattern
878 $updatedContent = preg_replace($pattern, '', $content);
879 if ($updatedContent === null) {
880 dol_syslog("files.lib.php::removePatternFromFile: Error while processing the file $filePath", LOG_WARNING);
881
882 return false;
883 }
884
885 // Write the updated content back to the file
886 $result = file_put_contents($filePath, $updatedContent);
887 if ($result === false) {
888 dol_syslog("files.lib.php::removePatternFromFile: Permission denied to overwrite the target file $filePath", LOG_WARNING);
889
890 return false;
891 }
892
893 dol_syslog("files.lib.php::removePatternFromFile: Content successfully removed in the file $filePath", LOG_INFO);
894
895 return true;
896}
897
898
899
912function dol_copy($srcfile, $destfile, $newmask = '0', $overwriteifexists = 1, $testvirus = 0, $indexdatabase = 0)
913{
914 global $db, $user;
915
916 dol_syslog("files.lib.php::dol_copy srcfile=".$srcfile." destfile=".$destfile." newmask=".$newmask." overwriteifexists=".$overwriteifexists);
917
918 if (empty($srcfile) || empty($destfile)) {
919 return -1;
920 }
921
922 $destexists = dol_is_file($destfile);
923 if (!$overwriteifexists && $destexists) {
924 return 0;
925 }
926
927 $newpathofsrcfile = dol_osencode($srcfile);
928 $newpathofdestfile = dol_osencode($destfile);
929 $newdirdestfile = dirname($newpathofdestfile);
930
931 if ($destexists && !is_writable($newpathofdestfile)) {
932 dol_syslog("files.lib.php::dol_copy failed Permission denied to overwrite target file", LOG_WARNING);
933 return -1;
934 }
935 if (!is_writable($newdirdestfile)) {
936 dol_syslog("files.lib.php::dol_copy failed Permission denied to write into target directory ".$newdirdestfile, LOG_WARNING);
937 return -2;
938 }
939
940 // Check virus
941 $testvirusarray = array();
942 if ($testvirus) {
943 $testvirusarray = dolCheckVirus($srcfile, $destfile);
944 if (count($testvirusarray)) {
945 dol_syslog("files.lib.php::dol_copy canceled because a virus was found into source file. we ignore the copy request.", LOG_WARNING);
946 return -3;
947 }
948 }
949
950 // Copy with overwriting if exists
951 $result = @copy($newpathofsrcfile, $newpathofdestfile);
952 //$result=copy($newpathofsrcfile, $newpathofdestfile); // To see errors, remove @
953 if (!$result) {
954 dol_syslog("files.lib.php::dol_copy failed to copy", LOG_WARNING);
955 return -3;
956 }
957 if (empty($newmask) && getDolGlobalString('MAIN_UMASK')) {
958 $newmask = getDolGlobalString('MAIN_UMASK');
959 }
960 if (empty($newmask)) { // This should no happen
961 dol_syslog("Warning: dol_copy called with empty value for newmask and no default value defined", LOG_WARNING);
962 $newmask = '0664';
963 }
964
965 dolChmod($newpathofdestfile, $newmask);
966
967 if ($result && $indexdatabase) {
968 // Add entry into ecm database
969 $rel_filetocopyafter = preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'/', '', $newpathofdestfile);
970 if (!preg_match('/([\\/]temp[\\/]|[\\/]thumbs|\.meta$)/', $rel_filetocopyafter)) { // If not a tmp file
971 $rel_filetocopyafter = preg_replace('/^[\\/]/', '', $rel_filetocopyafter);
972 //var_dump($rel_filetorenamebefore.' - '.$rel_filetocopyafter);exit;
973
974 dol_syslog("Try to copy also entries in database for: ".$rel_filetocopyafter, LOG_DEBUG);
975 include_once DOL_DOCUMENT_ROOT.'/ecm/class/ecmfiles.class.php';
976
977 $ecmfiletarget = new EcmFiles($db);
978 $resultecmtarget = $ecmfiletarget->fetch(0, '', $rel_filetocopyafter);
979 if ($resultecmtarget > 0) { // An entry for target name already exists for target, we delete it, a new one will be created.
980 dol_syslog("ECM dest file found, remove it", LOG_DEBUG);
981 $ecmfiletarget->delete($user);
982 } else {
983 dol_syslog("ECM dest file not found, create it", LOG_DEBUG);
984 }
985
986 $ecmSrcfile = new EcmFiles($db);
987 $resultecm = $ecmSrcfile->fetch(0, '', $srcfile);
988 if ($resultecm) {
989 dol_syslog("Fetch src file ok", LOG_DEBUG);
990 } else {
991 dol_syslog("Fetch src file error", LOG_DEBUG);
992 }
993
994 $ecmfile = new EcmFiles($db);
995 $filename = basename($rel_filetocopyafter);
996 $rel_dir = dirname($rel_filetocopyafter);
997 $rel_dir = preg_replace('/[\\/]$/', '', $rel_dir);
998 $rel_dir = preg_replace('/^[\\/]/', '', $rel_dir);
999
1000 $ecmfile->filepath = $rel_dir;
1001 $ecmfile->filename = $filename;
1002 $ecmfile->label = md5_file(dol_osencode($destfile)); // $destfile is a full path to file
1003 $ecmfile->fullpath_orig = $srcfile;
1004 $ecmfile->gen_or_uploaded = 'copy';
1005 $ecmfile->description = $ecmSrcfile->description;
1006 $ecmfile->keywords = $ecmSrcfile->keywords;
1007 $resultecm = $ecmfile->create($user);
1008 if ($resultecm < 0) {
1009 dol_syslog("Create ECM file ok", LOG_DEBUG);
1010 setEventMessages($ecmfile->error, $ecmfile->errors, 'warnings');
1011 } else {
1012 dol_syslog("Create ECM file error", LOG_DEBUG);
1013 setEventMessages($ecmfile->error, $ecmfile->errors, 'warnings');
1014 }
1015
1016 if ($resultecm > 0) {
1017 $result = 1;
1018 } else {
1019 $result = -1;
1020 }
1021 }
1022 }
1023
1024 return (int) $result;
1025}
1026
1041function dolCopyDir($srcfile, $destfile, $newmask, $overwriteifexists, $arrayreplacement = null, $excludesubdir = 0, $excludefileext = null, $excludearchivefiles = 0)
1042{
1043 $result = 0;
1044
1045 dol_syslog("files.lib.php::dolCopyDir srcfile=".$srcfile." destfile=".$destfile." newmask=".$newmask." overwriteifexists=".$overwriteifexists);
1046
1047 if (empty($srcfile) || empty($destfile)) {
1048 return -1;
1049 }
1050
1051 $destexists = dol_is_dir($destfile);
1052
1053 //if (! $overwriteifexists && $destexists) return 0; // The overwriteifexists is for files only, so propagated to dol_copy only.
1054
1055 if (!$destexists) {
1056 // We must set mask just before creating dir, because it can be set differently by dol_copy
1057 umask(0);
1058 $dirmaskdec = octdec($newmask);
1059 if (empty($newmask) && getDolGlobalString('MAIN_UMASK')) {
1060 $dirmaskdec = octdec(getDolGlobalString('MAIN_UMASK'));
1061 }
1062 $dirmaskdec |= octdec('0200'); // Set w bit required to be able to create content for recursive subdirs files
1063
1064 $result = dol_mkdir($destfile, '', decoct($dirmaskdec));
1065
1066 if (!dol_is_dir($destfile)) {
1067 // The output directory does not exists and we failed to create it. So we stop here.
1068 return -1;
1069 }
1070 }
1071
1072 $ossrcfile = dol_osencode($srcfile);
1073 $osdestfile = dol_osencode($destfile);
1074
1075 // Recursive function to copy all subdirectories and contents:
1076 if (is_dir($ossrcfile)) {
1077 $dir_handle = opendir($ossrcfile);
1078 $tmpresult = 0; // Initialised before loop to keep old behavior, may be needed inside loop
1079 while ($file = readdir($dir_handle)) {
1080 if ($file != "." && $file != ".." && !is_link($ossrcfile."/".$file)) {
1081 if (is_dir($ossrcfile."/".$file)) {
1082 if (empty($excludesubdir) || ($excludesubdir == 2 && strlen($file) == 2)) {
1083 $newfile = $file;
1084 // Replace destination filename with a new one
1085 if (is_array($arrayreplacement)) {
1086 foreach ($arrayreplacement as $key => $val) {
1087 $newfile = str_replace($key, $val, $newfile);
1088 }
1089 }
1090 //var_dump("xxx dolCopyDir $srcfile/$file, $destfile/$file, $newmask, $overwriteifexists");
1091 $tmpresult = dolCopyDir($srcfile."/".$file, $destfile."/".$newfile, $newmask, $overwriteifexists, $arrayreplacement, $excludesubdir, $excludefileext, $excludearchivefiles);
1092 }
1093 } else {
1094 $newfile = $file;
1095
1096 if (is_array($excludefileext)) {
1097 $extension = pathinfo($file, PATHINFO_EXTENSION);
1098 if (in_array($extension, $excludefileext)) {
1099 //print "We exclude the file ".$file." because its extension is inside list ".join(', ', $excludefileext); exit;
1100 continue;
1101 }
1102 }
1103
1104 if ($excludearchivefiles == 1) {
1105 $extension = pathinfo($file, PATHINFO_EXTENSION);
1106 if (preg_match('/^[v|d]\d+$/', $extension)) {
1107 continue;
1108 }
1109 }
1110
1111 // Replace destination filename with a new one
1112 if (is_array($arrayreplacement)) {
1113 foreach ($arrayreplacement as $key => $val) {
1114 $newfile = str_replace($key, $val, $newfile);
1115 }
1116 }
1117 $tmpresult = dol_copy($srcfile."/".$file, $destfile."/".$newfile, $newmask, $overwriteifexists);
1118 }
1119 // Set result
1120 if ($result > 0 && $tmpresult >= 0) {
1121 // Do nothing, so we don't set result to 0 if tmpresult is 0 and result was success in a previous pass
1122 } else {
1123 $result = $tmpresult;
1124 }
1125 if ($result < 0) {
1126 break;
1127 }
1128 }
1129 }
1130 closedir($dir_handle);
1131 } else {
1132 // Source directory does not exists
1133 $result = -2;
1134 }
1135
1136 return (int) $result;
1137}
1138
1139
1158function dol_move($srcfile, $destfile, $newmask = '0', $overwriteifexists = 1, $testvirus = 0, $indexdatabase = 1, $moreinfo = array(), $entity = null)
1159{
1160 global $user, $db;
1161 $result = false;
1162
1163 dol_syslog("files.lib.php::dol_move srcfile=".$srcfile." destfile=".$destfile." newmask=".$newmask." overwritifexists=".$overwriteifexists);
1164 $srcexists = dol_is_file($srcfile);
1165 $destexists = dol_is_file($destfile);
1166
1167 if (!$srcexists) {
1168 dol_syslog("files.lib.php::dol_move srcfile does not exists. we ignore the move request.");
1169 return false;
1170 }
1171
1172 if ($overwriteifexists || !$destexists) {
1173 $newpathofsrcfile = dol_osencode($srcfile);
1174 $newpathofdestfile = dol_osencode($destfile);
1175
1176 // Check on virus
1177 $testvirusarray = array();
1178 if ($testvirus) {
1179 // Check using filename + antivirus
1180 $testvirusarray = dolCheckVirus($newpathofsrcfile, $newpathofdestfile);
1181 if (count($testvirusarray)) {
1182 dol_syslog("files.lib.php::dol_move canceled because a virus was found into source file. We ignore the move request.", LOG_WARNING);
1183 return false;
1184 }
1185 } else {
1186 // Check using filename only
1187 $testvirusarray = dolCheckOnFileName($newpathofsrcfile, $newpathofdestfile);
1188 if (count($testvirusarray)) {
1189 dol_syslog("files.lib.php::dol_move canceled because a virus was found into source file. We ignore the move request.", LOG_WARNING);
1190 return false;
1191 }
1192 }
1193
1194 global $dolibarr_main_restrict_os_commands;
1195 if (!empty($dolibarr_main_restrict_os_commands)) {
1196 $arrayofallowedcommand = explode(',', $dolibarr_main_restrict_os_commands);
1197 $arrayofallowedcommand = array_map('trim', $arrayofallowedcommand);
1198 if (in_array(basename($destfile), $arrayofallowedcommand)) {
1199 //$langs->load("errors"); // key must be loaded because we can't rely on loading during output, we need var substitution to be done now.
1200 //setEventMessages($langs->trans("ErrorFilenameReserved", basename($destfile)), null, 'errors');
1201 dol_syslog("files.lib.php::dol_move canceled because target filename ".basename($destfile)." is using a reserved command name. we ignore the move request.", LOG_WARNING);
1202 return false;
1203 }
1204 }
1205
1206 $result = @rename($newpathofsrcfile, $newpathofdestfile); // To see errors, remove @
1207 if (!$result) {
1208 if ($destexists) {
1209 dol_syslog("files.lib.php::dol_move Failed. We try to delete target first and move after.", LOG_WARNING);
1210 // We force delete and try again. Rename function sometimes fails to replace dest file with some windows NTFS partitions.
1211 dol_delete_file($destfile);
1212 $result = @rename($newpathofsrcfile, $newpathofdestfile); // To see errors, remove @
1213 } else {
1214 dol_syslog("files.lib.php::dol_move Failed.", LOG_WARNING);
1215 }
1216 }
1217
1218 // Move ok
1219 if ($result && $indexdatabase) {
1220 // Rename entry into ecm database
1221 $rel_filetorenamebefore = preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'/', '', $srcfile);
1222 $rel_filetorenameafter = preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'/', '', $destfile);
1223 if (!preg_match('/([\\/]temp[\\/]|[\\/]thumbs|\.meta$)/', $rel_filetorenameafter)) { // If not a tmp file
1224 $rel_filetorenamebefore = preg_replace('/^[\\/]/', '', $rel_filetorenamebefore);
1225 $rel_filetorenameafter = preg_replace('/^[\\/]/', '', $rel_filetorenameafter);
1226 //var_dump($rel_filetorenamebefore.' - '.$rel_filetorenameafter);exit;
1227
1228 dol_syslog("Try to rename also entries in database for full relative path before = ".$rel_filetorenamebefore." after = ".$rel_filetorenameafter, LOG_DEBUG);
1229 include_once DOL_DOCUMENT_ROOT.'/ecm/class/ecmfiles.class.php';
1230
1231 $ecmfiletarget = new EcmFiles($db);
1232 $resultecmtarget = $ecmfiletarget->fetch(0, '', $rel_filetorenameafter, '', '', '', 0, $entity);
1233 if ($resultecmtarget > 0) { // An entry for target name already exists for target, we delete it, a new one will be created.
1234 $ecmfiletarget->delete($user);
1235 }
1236
1237 $ecmfile = new EcmFiles($db);
1238 $resultecm = $ecmfile->fetch(0, '', $rel_filetorenamebefore, '', '', '', 0, $entity);
1239 if ($resultecm > 0) { // If an entry was found for src file, we use it to move entry
1240 $filename = basename($rel_filetorenameafter);
1241 $rel_dir = dirname($rel_filetorenameafter);
1242 $rel_dir = preg_replace('/[\\/]$/', '', $rel_dir);
1243 $rel_dir = preg_replace('/^[\\/]/', '', $rel_dir);
1244
1245 $ecmfile->filepath = $rel_dir;
1246 $ecmfile->filename = $filename;
1247
1248 $resultecm = $ecmfile->update($user);
1249 } elseif ($resultecm == 0) { // If no entry were found for src files, create/update target file
1250 $filename = basename($rel_filetorenameafter);
1251 $rel_dir = dirname($rel_filetorenameafter);
1252 $rel_dir = preg_replace('/[\\/]$/', '', $rel_dir);
1253 $rel_dir = preg_replace('/^[\\/]/', '', $rel_dir);
1254
1255 $ecmfile->filepath = $rel_dir;
1256 $ecmfile->filename = $filename;
1257 $ecmfile->label = md5_file(dol_osencode($destfile)); // $destfile is a full path to file
1258 $ecmfile->fullpath_orig = basename($srcfile);
1259 if (!empty($moreinfo) && !empty($moreinfo['gen_or_uploaded'])) {
1260 $ecmfile->gen_or_uploaded = $moreinfo['gen_or_uploaded'];
1261 } else {
1262 $ecmfile->gen_or_uploaded = 'unknown'; // 'generated', 'uploaded', 'api'
1263 }
1264 if (!empty($moreinfo) && !empty($moreinfo['description'])) {
1265 $ecmfile->description = $moreinfo['description']; // indexed content
1266 } else {
1267 $ecmfile->description = ''; // indexed content
1268 }
1269 if (!empty($moreinfo) && !empty($moreinfo['keywords'])) {
1270 $ecmfile->keywords = $moreinfo['keywords']; // indexed content
1271 } else {
1272 $ecmfile->keywords = ''; // keyword content
1273 }
1274 if (!empty($moreinfo) && !empty($moreinfo['note_private'])) {
1275 $ecmfile->note_private = $moreinfo['note_private'];
1276 }
1277 if (!empty($moreinfo) && !empty($moreinfo['note_public'])) {
1278 $ecmfile->note_public = $moreinfo['note_public'];
1279 }
1280 if (!empty($moreinfo) && !empty($moreinfo['src_object_type'])) {
1281 $ecmfile->src_object_type = $moreinfo['src_object_type'];
1282 }
1283 if (!empty($moreinfo) && !empty($moreinfo['src_object_id'])) {
1284 $ecmfile->src_object_id = $moreinfo['src_object_id'];
1285 }
1286 if (!empty($moreinfo) && !empty($moreinfo['position'])) {
1287 $ecmfile->position = $moreinfo['position'];
1288 }
1289 if (!empty($moreinfo) && !empty($moreinfo['cover'])) {
1290 $ecmfile->cover = $moreinfo['cover'];
1291 }
1292 if (! empty($entity)) {
1293 $ecmfile->entity = $entity;
1294 }
1295
1296 $resultecm = $ecmfile->create($user);
1297 if ($resultecm < 0) {
1298 setEventMessages($ecmfile->error, $ecmfile->errors, 'warnings');
1299 } else {
1300 if (!empty($moreinfo) && !empty($moreinfo['array_options']) && is_array($moreinfo['array_options'])) {
1301 $ecmfile->array_options = $moreinfo['array_options'];
1302 $resultecm = $ecmfile->insertExtraFields();
1303 if ($resultecm < 0) {
1304 setEventMessages($ecmfile->error, $ecmfile->errors, 'warnings');
1305 }
1306 }
1307 }
1308 } elseif ($resultecm < 0) {
1309 setEventMessages($ecmfile->error, $ecmfile->errors, 'warnings');
1310 }
1311
1312 if ($resultecm > 0) {
1313 $result = true;
1314 } else {
1315 $result = false;
1316 }
1317 }
1318 }
1319
1320 if (empty($newmask)) {
1321 $newmask = getDolGlobalString('MAIN_UMASK', '0755');
1322 }
1323
1324 // Currently method is restricted to files (dol_delete_files previously used is for files, and mask usage if for files too)
1325 // to allow mask usage for dir, we should introduce a new param "isdir" to 1 to complete newmask like this
1326 // if ($isdir) $newmaskdec |= octdec('0111'); // Set x bit required for directories
1327 dolChmod($newpathofdestfile, $newmask);
1328 }
1329
1330 return $result;
1331}
1332
1343function dol_move_dir($srcdir, $destdir, $overwriteifexists = 1, $indexdatabase = 1, $renamedircontent = 1)
1344{
1345 $result = false;
1346
1347 dol_syslog("files.lib.php::dol_move_dir srcdir=".$srcdir." destdir=".$destdir." overwritifexists=".$overwriteifexists." indexdatabase=".$indexdatabase." renamedircontent=".$renamedircontent);
1348 $srcexists = dol_is_dir($srcdir);
1349 $srcbasename = basename($srcdir);
1350 $destexists = dol_is_dir($destdir);
1351
1352 if (!$srcexists) {
1353 dol_syslog("files.lib.php::dol_move_dir srcdir does not exists. Move fails");
1354 return false;
1355 }
1356
1357 if ($overwriteifexists || !$destexists) {
1358 $newpathofsrcdir = dol_osencode($srcdir);
1359 $newpathofdestdir = dol_osencode($destdir);
1360
1361 // On windows, if destination directory exists and is empty, command fails. So if overwrite is on, we first remove destination directory.
1362 // On linux, if destination directory exists and is empty, command succeed. So no need to delete di destination directory first.
1363 // Note: If dir exists and is not empty, it will and must fail on both linux and windows even, if option $overwriteifexists is on.
1364 if ($overwriteifexists) {
1365 if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
1366 if (is_dir($newpathofdestdir)) {
1367 @rmdir($newpathofdestdir);
1368 }
1369 }
1370 }
1371
1372 $result = @rename($newpathofsrcdir, $newpathofdestdir);
1373
1374 // Now rename contents in the directory after the move to match the new destination
1375 if ($result && $renamedircontent) {
1376 if (file_exists($newpathofdestdir)) {
1377 $destbasename = basename($newpathofdestdir);
1378 $files = dol_dir_list($newpathofdestdir);
1379 if (!empty($files) && is_array($files)) {
1380 foreach ($files as $key => $file) {
1381 if (!file_exists($file["fullname"])) {
1382 continue;
1383 }
1384 $filepath = $file["path"];
1385 $oldname = $file["name"];
1386
1387 $newname = str_replace($srcbasename, $destbasename, $oldname);
1388 if (!empty($newname) && $newname !== $oldname) {
1389 if ($file["type"] == "dir") {
1390 $res = dol_move_dir($filepath.'/'.$oldname, $filepath.'/'.$newname, $overwriteifexists, $indexdatabase, $renamedircontent);
1391 } else {
1392 $moreinfo = array('gen_or_uploaded' => 'unknown');
1393 $res = dol_move($filepath.'/'.$oldname, $filepath.'/'.$newname, '0', $overwriteifexists, 0, $indexdatabase, $moreinfo);
1394 }
1395 if (!$res) {
1396 return $result;
1397 }
1398 }
1399 }
1400 $result = true;
1401 }
1402 }
1403 }
1404 }
1405 return $result;
1406}
1407
1415function dol_unescapefile($filename)
1416{
1417 // Remove path information and dots around the filename, to prevent uploading
1418 // into different directories or replacing hidden system files.
1419 // Also remove control characters and spaces (\x00..\x20) around the filename:
1420 return trim(basename($filename), ".\x00..\x20");
1421}
1422
1423
1431function dolCheckVirus($src_file, $dest_file = '')
1432{
1433 global $db;
1434
1435 $reterrors = dolCheckOnFileName($src_file, $dest_file);
1436 if (!empty($reterrors)) {
1437 return $reterrors;
1438 }
1439
1440 if (getDolGlobalString('MAIN_ANTIVIRUS_UPLOAD_ON')) {
1441 if (!class_exists('AntiVir')) {
1442 require_once DOL_DOCUMENT_ROOT.'/core/class/antivir.class.php';
1443 }
1444 $antivir = new AntiVir($db);
1445 $result = $antivir->dol_avscan_file($src_file);
1446 if ($result < 0) { // If virus or error, we stop here
1447 $reterrors = $antivir->errors;
1448 return $reterrors;
1449 }
1450 }
1451 return array();
1452}
1453
1461function dolCheckOnFileName($src_file, $dest_file = '')
1462{
1463 if (preg_match('/\.pdf$/i', $dest_file)) {
1464 if (!getDolGlobalString('MAIN_ANTIVIRUS_ALLOW_JS_IN_PDF')) {
1465 dol_syslog("dolCheckOnFileName Check that pdf does not contains js code");
1466
1467 $tmp = file_get_contents(trim($src_file));
1468 if (preg_match('/[\n\s]+\/JavaScript[\n\s]+/m', $tmp)) {
1469 return array('File is a PDF with javascript inside');
1470 }
1471 } else {
1472 dol_syslog("dolCheckOnFileName Check js into pdf disabled");
1473 }
1474 }
1475
1476 return array();
1477}
1478
1479
1501function dol_move_uploaded_file($src_file, $dest_file, $allowoverwrite, $disablevirusscan = 0, $uploaderrorcode = 0, $nohook = 0, $keyforsourcefile = 'addedfile', $upload_dir = '', $mode = 0)
1502{
1503 global $conf;
1504 global $object, $hookmanager;
1505
1506 $reshook = 0;
1507 $file_name = $dest_file;
1508 $successcode = 1;
1509
1510 if (empty($nohook)) {
1511 $reshook = $hookmanager->initHooks(array('fileslib'));
1512
1513 $parameters = array('dest_file' => $dest_file, 'src_file' => $src_file, 'file_name' => $file_name, 'varfiles' => $keyforsourcefile, 'allowoverwrite' => $allowoverwrite);
1514 $reshook = $hookmanager->executeHooks('moveUploadedFile', $parameters, $object);
1515 }
1516
1517 if (empty($reshook)) {
1518 // If an upload error has been reported
1519 if ($uploaderrorcode) {
1520 switch ($uploaderrorcode) {
1521 case UPLOAD_ERR_INI_SIZE: // 1
1522 return 'ErrorFileSizeTooLarge';
1523 case UPLOAD_ERR_FORM_SIZE: // 2 - Exceed the MAX_FILE_SIZE specified into a field in form
1524 return 'ErrorFileSizeTooLarge';
1525 case UPLOAD_ERR_PARTIAL: // 3
1526 return 'ErrorPartialFile';
1527 case UPLOAD_ERR_NO_TMP_DIR: //
1528 return 'ErrorNoTmpDir';
1529 case UPLOAD_ERR_CANT_WRITE:
1530 return 'ErrorFailedToWriteInDir';
1531 case UPLOAD_ERR_EXTENSION:
1532 return 'ErrorUploadBlockedByAddon';
1533 default:
1534 break;
1535 }
1536 }
1537
1538 // Security:
1539 // If we need to make a virus scan
1540 if (empty($disablevirusscan) && file_exists($src_file)) {
1541 $checkvirusarray = dolCheckVirus($src_file, $dest_file);
1542 if (count($checkvirusarray)) {
1543 dol_syslog('Files.lib::dol_move_uploaded_file File "'.$src_file.'" (target name "'.$dest_file.'") KO with antivirus: errors='.implode(',', $checkvirusarray), LOG_WARNING);
1544 return 'ErrorFileIsInfectedWithAVirus: '.implode(',', $checkvirusarray);
1545 }
1546 }
1547
1548 // Security:
1549 // Disallow file with some extensions. We rename them.
1550 // Because if we put the documents directory into a directory inside web root (very bad), this allows to execute on demand arbitrary code.
1551 if (isAFileWithExecutableContent($dest_file) && !getDolGlobalString('MAIN_DOCUMENT_IS_OUTSIDE_WEBROOT_SO_NOEXE_NOT_REQUIRED')) {
1552 // $upload_dir ends with a slash, so be must be sure the medias dir to compare to ends with slash too.
1553 $publicmediasdirwithslash = $conf->medias->multidir_output[$conf->entity];
1554 if (!preg_match('/\/$/', $publicmediasdirwithslash)) {
1555 $publicmediasdirwithslash .= '/';
1556 }
1557
1558 if (strpos($upload_dir, $publicmediasdirwithslash) !== 0 || !getDolGlobalInt("MAIN_DOCUMENT_DISABLE_NOEXE_IN_MEDIAS_DIR")) { // We never add .noexe on files into media directory
1559 $file_name .= '.noexe';
1560 $successcode = 2;
1561 }
1562 }
1563
1564 // Security:
1565 // We refuse cache files/dirs, upload using .. and pipes into filenames.
1566 if (preg_match('/^\./', basename($src_file)) || preg_match('/\.\./', $src_file) || preg_match('/[<>|]/', $src_file)) {
1567 dol_syslog("Refused to deliver file ".$src_file, LOG_WARNING);
1568 return -1;
1569 }
1570
1571 // Security:
1572 // We refuse cache files/dirs, upload using .. and pipes into filenames.
1573 if (preg_match('/^\./', basename($dest_file)) || preg_match('/\.\./', $dest_file) || preg_match('/[<>|]/', $dest_file)) {
1574 dol_syslog("Refused to deliver file ".$dest_file, LOG_WARNING);
1575 return -2;
1576 }
1577 }
1578
1579 if ($reshook < 0) { // At least one blocking error returned by one hook
1580 $errmsg = implode(',', $hookmanager->errors);
1581 if (empty($errmsg)) {
1582 $errmsg = 'ErrorReturnedBySomeHooks'; // Should not occurs. Added if hook is bugged and does not set ->errors when there is error.
1583 }
1584 return $errmsg;
1585 } elseif (empty($reshook)) {
1586 // The file functions must be in OS filesystem encoding.
1587 $src_file_osencoded = dol_osencode($src_file);
1588 $file_name_osencoded = dol_osencode($file_name);
1589
1590 // Check if destination dir is writable
1591 if (!is_writable(dirname($file_name_osencoded))) {
1592 dol_syslog("Files.lib::dol_move_uploaded_file Dir ".dirname($file_name_osencoded)." is not writable. Return 'ErrorDirNotWritable'", LOG_WARNING);
1593 return 'ErrorDirNotWritable';
1594 }
1595
1596 // Check if destination file already exists
1597 if (!$allowoverwrite) {
1598 if (file_exists($file_name_osencoded)) {
1599 dol_syslog("Files.lib::dol_move_uploaded_file File ".$file_name." already exists. Return 'ErrorFileAlreadyExists'", LOG_WARNING);
1600 return 'ErrorFileAlreadyExists';
1601 }
1602 } else { // We are allowed to erase
1603 if (is_dir($file_name_osencoded)) { // If there is a directory with name of file to create
1604 dol_syslog("Files.lib::dol_move_uploaded_file A directory with name ".$file_name." already exists. Return 'ErrorDirWithFileNameAlreadyExists'", LOG_WARNING);
1605 return 'ErrorDirWithFileNameAlreadyExists';
1606 }
1607 }
1608
1609 // Move file using a simple system function
1610 if ($mode == 0) {
1611 $return = move_uploaded_file($src_file_osencoded, $file_name_osencoded);
1612 } else {
1613 $return = rename($src_file_osencoded, $file_name_osencoded);
1614 }
1615
1616 if ($return) {
1617 dolChmod($file_name_osencoded);
1618 dol_syslog("Files.lib::dol_move_uploaded_file Success to move ".$src_file." to ".$file_name." - Umask=" . getDolGlobalString('MAIN_UMASK'), LOG_DEBUG);
1619 return $successcode; // Success
1620 } else {
1621 dol_syslog("Files.lib::dol_move_uploaded_file Failed to move ".$src_file." to ".$file_name, LOG_ERR);
1622 return -3; // Unknown error
1623 }
1624 }
1625
1626 return $successcode; // Success
1627}
1628
1644function dol_delete_file($file, $disableglob = 0, $nophperrors = 0, $nohook = 0, $object = null, $allowdotdot = false, $indexdatabase = 1, $nolog = 0)
1645{
1646 global $db, $user;
1647 global $hookmanager;
1648
1649 if (empty($nolog)) {
1650 dol_syslog("dol_delete_file file=".$file." disableglob=".$disableglob." nophperrors=".$nophperrors." nohook=".$nohook);
1651 }
1652
1653 // Security:
1654 // We refuse transversal using .. and pipes into filenames.
1655 if ((!$allowdotdot && preg_match('/\.\./', $file)) || preg_match('/[<>|]/', $file)) {
1656 dol_syslog("Refused to delete file ".$file, LOG_WARNING);
1657 return false;
1658 }
1659
1660 $reshook = 0;
1661 if (empty($nohook) && !empty($hookmanager)) {
1662 $hookmanager->initHooks(array('fileslib'));
1663
1664 $parameters = array(
1665 'file' => $file,
1666 'disableglob' => $disableglob,
1667 'nophperrors' => $nophperrors
1668 );
1669 $reshook = $hookmanager->executeHooks('deleteFile', $parameters, $object);
1670 }
1671
1672 if (empty($nohook) && $reshook != 0) { // reshook = 0 to do standard actions, 1 = ok and replace, -1 = ko
1673 dol_syslog("reshook=".$reshook);
1674 if ($reshook < 0) {
1675 return false;
1676 }
1677 return true;
1678 } else {
1679 $file_osencoded = dol_osencode($file); // New filename encoded in OS filesystem encoding charset
1680 if (empty($disableglob) && !empty($file_osencoded)) {
1681 $ok = true;
1682 $globencoded = str_replace('[', '\[', $file_osencoded);
1683 $globencoded = str_replace(']', '\]', $globencoded);
1684 $listofdir = glob($globencoded); // This scan dir for files. If file does not exists, return empty.
1685
1686 if (!empty($listofdir) && is_array($listofdir)) {
1687 foreach ($listofdir as $filename) {
1688 if ($nophperrors) {
1689 $ok = @unlink($filename);
1690 } else {
1691 $ok = unlink($filename);
1692 }
1693
1694 // If it fails and it is because of the missing write permission on parent dir
1695 if (!$ok && file_exists(dirname($filename)) && !(fileperms(dirname($filename)) & 0200)) {
1696 dol_syslog("Error in deletion, but parent directory exists with no permission to write, we try to change permission on parent directory and retry...", LOG_DEBUG);
1697 dolChmod(dirname($filename), decoct(fileperms(dirname($filename)) | 0200));
1698 // Now we retry deletion
1699 if ($nophperrors) {
1700 $ok = @unlink($filename);
1701 } else {
1702 $ok = unlink($filename);
1703 }
1704 }
1705
1706 if ($ok) {
1707 if (empty($nolog)) {
1708 dol_syslog("Removed file ".$filename, LOG_DEBUG);
1709 }
1710
1711 // Delete entry into ecm database
1712 $rel_filetodelete = preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'/', '', $filename);
1713 if (!preg_match('/(\/temp\/|\/thumbs\/|\.meta$)/', $rel_filetodelete)) { // If not a tmp file
1714 if (is_object($db) && $indexdatabase) { // $db may not be defined when lib is in a context with define('NOREQUIREDB',1)
1715 $rel_filetodelete = preg_replace('/^[\\/]/', '', $rel_filetodelete);
1716 $rel_filetodelete = preg_replace('/\.noexe$/', '', $rel_filetodelete);
1717
1718 dol_syslog("Try to remove also entries in database for full relative path = ".$rel_filetodelete, LOG_DEBUG);
1719 include_once DOL_DOCUMENT_ROOT.'/ecm/class/ecmfiles.class.php';
1720 $ecmfile = new EcmFiles($db);
1721 $entity = (isset($object->entity) ? $object->entity : null);
1722 $result = $ecmfile->fetch(0, '', $rel_filetodelete, '', '', '', 0, $entity);
1723 if ($result >= 0 && $ecmfile->id > 0) {
1724 $result = $ecmfile->delete($user);
1725 }
1726 if ($result < 0) {
1727 setEventMessages($ecmfile->error, $ecmfile->errors, 'warnings');
1728 }
1729 }
1730 }
1731 } else {
1732 dol_syslog("Failed to remove file ".$filename, LOG_WARNING);
1733 // TODO Failure to remove can be because file was already removed or because of permission
1734 // If error because it does not exists, we should return true, and we should return false if this is a permission problem
1735 }
1736 }
1737 } else {
1738 $ok = true; // nothing to delete when glob is on must return ok
1739 dol_syslog("No files to delete found", LOG_DEBUG);
1740 }
1741 } else {
1742 $ok = false;
1743 if ($nophperrors) {
1744 $ok = @unlink($file_osencoded);
1745 } else {
1746 $ok = unlink($file_osencoded);
1747 }
1748 if ($ok) {
1749 if (empty($nolog)) {
1750 dol_syslog("Removed file ".$file_osencoded, LOG_DEBUG);
1751 }
1752 } else {
1753 dol_syslog("Failed to remove file ".$file_osencoded, LOG_WARNING);
1754 }
1755 }
1756
1757 return $ok;
1758 }
1759}
1760
1770function dol_delete_dir($dir, $nophperrors = 0)
1771{
1772 // Security:
1773 // We refuse transversal using .. and pipes into filenames.
1774 if (preg_match('/\.\./', $dir) || preg_match('/[<>|]/', $dir)) {
1775 dol_syslog("Refused to delete dir ".$dir.' (contains invalid char sequence)', LOG_WARNING);
1776 return false;
1777 }
1778
1779 $dir_osencoded = dol_osencode($dir);
1780 return ($nophperrors ? @rmdir($dir_osencoded) : rmdir($dir_osencoded));
1781}
1782
1796function dol_delete_dir_recursive($dir, $count = 0, $nophperrors = 0, $onlysub = 0, &$countdeleted = 0, $indexdatabase = 1, $nolog = 0, $level = 0)
1797{
1798 if (empty($nolog) || empty($level)) {
1799 dol_syslog("functions.lib:dol_delete_dir_recursive ".$dir, LOG_DEBUG);
1800 }
1801 if ($level > 1000) {
1802 dol_syslog("functions.lib:dol_delete_dir_recursive too many depth", LOG_WARNING);
1803 }
1804
1805 if (dol_is_dir($dir)) {
1806 $dir_osencoded = dol_osencode($dir);
1807 if ($handle = opendir("$dir_osencoded")) {
1808 while (false !== ($item = readdir($handle))) {
1809 if (!utf8_check($item)) {
1810 $item = mb_convert_encoding($item, 'UTF-8', 'ISO-8859-1'); // should be useless
1811 }
1812
1813 if ($item != "." && $item != "..") {
1814 if (is_dir(dol_osencode("$dir/$item")) && !is_link(dol_osencode("$dir/$item"))) {
1815 $count = dol_delete_dir_recursive("$dir/$item", $count, $nophperrors, 0, $countdeleted, $indexdatabase, $nolog, ($level + 1));
1816 } else {
1817 chmod(dol_osencode("$dir/$item"), 0755);
1818 $result = dol_delete_file("$dir/$item", 1, $nophperrors, 0, null, false, $indexdatabase, $nolog);
1819 $count++;
1820 if ($result) {
1821 $countdeleted++;
1822 }
1823 //else print 'Error on '.$item."\n";
1824 }
1825 }
1826 }
1827 closedir($handle);
1828
1829 // Delete also the main directory
1830 if (empty($onlysub)) {
1831 $result = dol_delete_dir($dir, $nophperrors);
1832 $count++;
1833 if ($result) {
1834 $countdeleted++;
1835 }
1836 //else print 'Error on '.$dir."\n";
1837 }
1838 }
1839 }
1840
1841 return $count;
1842}
1843
1844
1854{
1855 global $langs, $conf;
1856
1857 // Define parent dir of elements
1858 $element = $object->element;
1859
1860 if ($object->element == 'order_supplier') {
1861 $dir = $conf->fournisseur->commande->dir_output;
1862 } elseif ($object->element == 'invoice_supplier') {
1863 $dir = $conf->fournisseur->facture->dir_output;
1864 } elseif ($object->element == 'project') {
1865 $dir = $conf->project->dir_output;
1866 } elseif ($object->element == 'shipping') {
1867 $dir = $conf->expedition->dir_output.'/sending';
1868 } elseif ($object->element == 'delivery') {
1869 $dir = $conf->expedition->dir_output.'/receipt';
1870 } elseif ($object->element == 'fichinter') {
1871 $dir = $conf->ficheinter->dir_output;
1872 } else {
1873 $dir = empty($conf->$element->dir_output) ? '' : $conf->$element->dir_output;
1874 }
1875
1876 if (empty($dir)) {
1877 $object->error = $langs->trans('ErrorObjectNoSupportedByFunction');
1878 return 0;
1879 }
1880
1881 $refsan = dol_sanitizeFileName($object->ref);
1882 $dir = $dir."/".$refsan;
1883 $filepreviewnew = $dir."/".$refsan.".pdf_preview.png";
1884 $filepreviewnewbis = $dir."/".$refsan.".pdf_preview-0.png";
1885 $filepreviewold = $dir."/".$refsan.".pdf.png";
1886
1887 // For new preview files
1888 if (file_exists($filepreviewnew) && is_writable($filepreviewnew)) {
1889 if (!dol_delete_file($filepreviewnew, 1)) {
1890 $object->error = $langs->trans("ErrorFailedToDeleteFile", $filepreviewnew);
1891 return 0;
1892 }
1893 }
1894 if (file_exists($filepreviewnewbis) && is_writable($filepreviewnewbis)) {
1895 if (!dol_delete_file($filepreviewnewbis, 1)) {
1896 $object->error = $langs->trans("ErrorFailedToDeleteFile", $filepreviewnewbis);
1897 return 0;
1898 }
1899 }
1900 // For old preview files
1901 if (file_exists($filepreviewold) && is_writable($filepreviewold)) {
1902 if (!dol_delete_file($filepreviewold, 1)) {
1903 $object->error = $langs->trans("ErrorFailedToDeleteFile", $filepreviewold);
1904 return 0;
1905 }
1906 } else {
1907 $multiple = $filepreviewold.".";
1908 for ($i = 0; $i < 20; $i++) {
1909 $preview = $multiple.$i;
1910
1911 if (file_exists($preview) && is_writable($preview)) {
1912 if (!dol_delete_file($preview, 1)) {
1913 $object->error = $langs->trans("ErrorFailedToOpenFile", $preview);
1914 return 0;
1915 }
1916 }
1917 }
1918 }
1919
1920 return 1;
1921}
1922
1932{
1933 global $conf;
1934
1935 // Create meta file
1936 if (!getDolGlobalString('MAIN_DOC_CREATE_METAFILE')) {
1937 return 0; // By default, no metafile.
1938 }
1939
1940 // Define parent dir of elements
1941 $element = $object->element;
1942
1943 if ($object->element == 'order_supplier') {
1944 $dir = $conf->fournisseur->dir_output.'/commande';
1945 } elseif ($object->element == 'invoice_supplier') {
1946 $dir = $conf->fournisseur->dir_output.'/facture';
1947 } elseif ($object->element == 'project') {
1948 $dir = $conf->project->dir_output;
1949 } elseif ($object->element == 'shipping') {
1950 $dir = $conf->expedition->dir_output.'/sending';
1951 } elseif ($object->element == 'delivery') {
1952 $dir = $conf->expedition->dir_output.'/receipt';
1953 } elseif ($object->element == 'fichinter') {
1954 $dir = $conf->ficheinter->dir_output;
1955 } else {
1956 $dir = empty($conf->$element->dir_output) ? '' : $conf->$element->dir_output;
1957 }
1958
1959 if ($dir) {
1960 $object->fetch_thirdparty();
1961
1962 $objectref = dol_sanitizeFileName((string) $object->ref);
1963 $dir = $dir."/".$objectref;
1964 $file = $dir."/".$objectref.".meta";
1965
1966 if (!is_dir($dir)) {
1967 dol_mkdir($dir);
1968 }
1969
1970 $meta = '';
1971 if (is_dir($dir)) {
1972 if (is_countable($object->lines) && count($object->lines) > 0) {
1973 $nblines = count($object->lines);
1974 } else {
1975 $nblines = 0;
1976 }
1977 $client = $object->thirdparty->name." ".$object->thirdparty->address." ".$object->thirdparty->zip." ".$object->thirdparty->town;
1978 $meta = "REFERENCE=\"".$object->ref."\"
1979 DATE=\"" . dol_print_date($object->date, '')."\"
1980 NB_ITEMS=\"" . $nblines."\"
1981 CLIENT=\"" . $client."\"
1982 AMOUNT_EXCL_TAX=\"" . $object->total_ht."\"
1983 AMOUNT=\"" . $object->total_ttc."\"\n";
1984
1985 for ($i = 0; $i < $nblines; $i++) {
1986 //Pour les articles
1987 $meta .= "ITEM_".$i."_QUANTITY=\"".$object->lines[$i]->qty."\"
1988 ITEM_" . $i."_AMOUNT_WO_TAX=\"".$object->lines[$i]->total_ht."\"
1989 ITEM_" . $i."_VAT=\"".$object->lines[$i]->tva_tx."\"
1990 ITEM_" . $i."_DESCRIPTION=\"".str_replace("\r\n", "", nl2br($object->lines[$i]->desc))."\"
1991 ";
1992 }
1993 }
1994
1995 $fp = fopen($file, "w");
1996 fwrite($fp, $meta);
1997 fclose($fp);
1998
1999 dolChmod($file);
2000
2001 return 1;
2002 } else {
2003 dol_syslog('FailedToDetectDirInDolMetaCreateFor'.$object->element, LOG_WARNING);
2004 }
2005
2006 return 0;
2007}
2008
2009
2010
2019function dol_init_file_process($pathtoscan = '', $trackid = '')
2020{
2021 $listofpaths = array();
2022 $listofnames = array();
2023 $listofmimes = array();
2024
2025 if ($pathtoscan) {
2026 $listoffiles = dol_dir_list($pathtoscan, 'files');
2027 foreach ($listoffiles as $key => $val) {
2028 $listofpaths[] = $val['fullname'];
2029 $listofnames[] = $val['name'];
2030 $listofmimes[] = dol_mimetype($val['name']);
2031 }
2032 }
2033 $keytoavoidconflict = empty($trackid) ? '' : '-'.$trackid;
2034 $_SESSION["listofpaths".$keytoavoidconflict] = implode(';', $listofpaths);
2035 $_SESSION["listofnames".$keytoavoidconflict] = implode(';', $listofnames);
2036 $_SESSION["listofmimes".$keytoavoidconflict] = implode(';', $listofmimes);
2037}
2038
2039
2060function dol_add_file_process($upload_dir, $allowoverwrite = 0, $updatesessionordb = 0, $keyforsourcefile = 'addedfile', $savingdocmask = '', $link = null, $trackid = '', $generatethumbs = 1, $object = null, $forceFullTextIndexation = '', $mode = 0)
2061{
2062 global $db, $user, $conf, $langs;
2063
2064 $res = 0;
2065
2066 // If mode 1, prepare environment to be compatible with mode 0
2067 if ($mode == 1) {
2068 $_FILES = array($keyforsourcefile => array());
2069 $_FILES[$keyforsourcefile]['tmp_name'] = $keyforsourcefile;
2070 $_FILES[$keyforsourcefile]['name'] = $keyforsourcefile;
2071 $mode = 0;
2072 }
2073
2074 if (!empty($_FILES[$keyforsourcefile])) { // For view $_FILES[$keyforsourcefile]['error']
2075 dol_syslog('dol_add_file_process varfiles = '.$keyforsourcefile.' upload_dir='.$upload_dir.' allowoverwrite='.$allowoverwrite.' updatesessionordb='.$updatesessionordb.' savingdocmask='.$savingdocmask, LOG_DEBUG);
2076 $maxfilesinform = getDolGlobalInt("MAIN_SECURITY_MAX_ATTACHMENT_ON_FORMS", 10);
2077 if (is_array($_FILES[$keyforsourcefile]["name"]) && count($_FILES[$keyforsourcefile]["name"]) > $maxfilesinform) {
2078 $langs->load("errors"); // key must be loaded because we can't rely on loading during output, we need var substitution to be done now.
2079 setEventMessages($langs->trans("ErrorTooMuchFileInForm", $maxfilesinform), null, "errors");
2080 return -1;
2081 }
2082
2083 $result = dol_mkdir($upload_dir);
2084 //var_dump($result);exit;
2085
2086 if ($result >= 0) {
2087 $TFile = $_FILES[$keyforsourcefile];
2088 // Convert value of $TFile
2089 if (!is_array($TFile['name'])) {
2090 foreach ($TFile as $key => &$val) {
2091 $val = array($val);
2092 }
2093 }
2094
2095 $nbfile = count($TFile['name']);
2096 $nbok = 0;
2097 for ($i = 0; $i < $nbfile; $i++) {
2098 if (empty($TFile['name'][$i])) {
2099 continue; // For example, when submitting a form with no file name
2100 }
2101
2102 // Define $destfull (path to file including filename) and $destfile (only filename)
2103 $destfile = trim($TFile['name'][$i]);
2104 $destfull = $upload_dir."/".$destfile;
2105 $destfilewithoutext = preg_replace('/\.[^\.]+$/', '', $destfile);
2106
2107 if ($savingdocmask && strpos($savingdocmask, $destfilewithoutext) !== 0) {
2108 $destfile = trim(preg_replace('/__file__/', $TFile['name'][$i], $savingdocmask));
2109 $destfull = $upload_dir."/".$destfile;
2110 }
2111
2112 $filenameto = basename($destfile);
2113 if (preg_match('/^\./', $filenameto)) {
2114 $langs->load("errors"); // key must be loaded because we can't rely on loading during output, we need var substitution to be done now.
2115 setEventMessages($langs->trans("ErrorFilenameCantStartWithDot", $filenameto), null, 'errors');
2116 break;
2117 }
2118 // dol_sanitizeFileName the file name and lowercase extension
2119 $info = pathinfo($destfull);
2120 $destfull = $info['dirname'].'/'.dol_sanitizeFileName($info['filename'].($info['extension'] != '' ? ('.'.strtolower($info['extension'])) : ''));
2121 $info = pathinfo($destfile);
2122 $destfile = dol_sanitizeFileName($info['filename'].($info['extension'] != '' ? ('.'.strtolower($info['extension'])) : ''));
2123
2124 // Check extension is allowed for upload.
2125 // Guard against partial upgrades where files.lib.php has been refreshed
2126 // but functions.lib.php has not been reloaded with getExecutableContent() yet.
2127 $defaultexecutableextensions = function_exists('getExecutableContent') ? implode(',', getExecutableContent()) : 'htm,html,shtml,js,phar,php,php3,php4,php5,phtml,pht,pl,py,cgi,ksh,sh,bash,bat,cmd,wpk,exe';
2128 $fileextensionrestriction = getDolGlobalString("MAIN_FILE_EXTENSION_UPLOAD_RESTRICTION", $defaultexecutableextensions);
2129 if (!empty($fileextensionrestriction)) {
2130 $arrayofregexextension = explode(",", $fileextensionrestriction);
2131
2132 foreach ($arrayofregexextension as $fileextension) {
2133 if (preg_match('/\.'.preg_quote(trim($fileextension), '/').'$/i', $destfull)) {
2134 $langs->load("errors"); // key must be loaded because we can't rely on loading during output, we need var substitution to be done now.
2135 setEventMessages($langs->trans("ErrorFilenameExtensionNotAllowed", $filenameto), null, 'errors');
2136 return -1;
2137 }
2138 }
2139 }
2140
2141 // We apply dol_string_nohtmltag also to clean file names (this remove duplicate spaces) because
2142 // this function is also applied when we rename and when we make try to download file (by the GETPOST(filename, 'alphanohtml') call).
2143 $destfile = dol_string_nohtmltag($destfile);
2144 $destfull = dol_string_nohtmltag($destfull);
2145
2146 // Check that filename is not the one of a reserved allowed CLI command
2147 global $dolibarr_main_restrict_os_commands;
2148 if (!empty($dolibarr_main_restrict_os_commands)) {
2149 $arrayofallowedcommand = explode(',', $dolibarr_main_restrict_os_commands);
2150 $arrayofallowedcommand = array_map('trim', $arrayofallowedcommand);
2151 if (in_array($destfile, $arrayofallowedcommand)) {
2152 $langs->load("errors"); // key must be loaded because we can't rely on loading during output, we need var substitution to be done now.
2153 setEventMessages($langs->trans("ErrorFilenameReserved", $destfile), null, 'errors');
2154 return -1;
2155 }
2156 }
2157
2158 // Move file from source directory to final destination. Check for virus is also embedded and a .noexe may also be appended on file name.
2159 $resupload = dol_move_uploaded_file($TFile['tmp_name'][$i], $destfull, $allowoverwrite, 0, $TFile['error'][$i], 0, $keyforsourcefile, $upload_dir, $mode);
2160
2161 if (is_numeric($resupload) && $resupload > 0) { // $resupload can be 'ErrorFileAlreadyExists', 'ErrorFileIsInfectedWithAVirus...'
2162 include_once DOL_DOCUMENT_ROOT.'/core/lib/images.lib.php';
2163
2164 $tmparraysize = getDefaultImageSizes();
2165 $maxwidthsmall = $tmparraysize['maxwidthsmall'];
2166 $maxheightsmall = $tmparraysize['maxheightsmall'];
2167 $maxwidthmini = $tmparraysize['maxwidthmini'];
2168 $maxheightmini = $tmparraysize['maxheightmini'];
2169 //$quality = $tmparraysize['quality'];
2170 $quality = 50; // For thumbs, we force quality to 50
2171
2172 // Generate thumbs.
2173 if ($generatethumbs) {
2174 if (image_format_supported($destfull) == 1) {
2175 // Create thumbs
2176 // We can't use $object->addThumbs here because there is no $object known
2177
2178 // Used on logon for example
2179 $imgThumbSmall = vignette($destfull, $maxwidthsmall, $maxheightsmall, '_small', $quality, "thumbs");
2180 // Create mini thumbs for image (Ratio is near 16/9)
2181 // Used on menu or for setup page for example
2182 $imgThumbMini = vignette($destfull, $maxwidthmini, $maxheightmini, '_mini', $quality, "thumbs");
2183 }
2184 }
2185
2186 // Update session
2187 if (empty($updatesessionordb)) {
2188 include_once DOL_DOCUMENT_ROOT.'/core/class/html.formmail.class.php';
2189 $formmail = new FormMail($db);
2190 $formmail->trackid = $trackid;
2191 $formmail->add_attached_files($destfull, $destfile, $TFile['type'][$i]);
2192 }
2193
2194 // Update index table of files (llx_ecm_files)
2195 if ($updatesessionordb == 1) {
2196 $sharefile = 0;
2197 if ($TFile['type'][$i] == 'application/pdf' && strpos($_SERVER["REQUEST_URI"], 'product') !== false && getDolGlobalString('PRODUCT_ALLOW_EXTERNAL_DOWNLOAD')) {
2198 $sharefile = 1;
2199 }
2200
2201 // If we allow overwrite, we may need to also overwrite index, so we delete index first so insert can work
2202 if ($allowoverwrite) {
2203 deleteFilesIntoDatabaseIndex($upload_dir, basename($destfile).($resupload == 2 ? '.noexe' : ''), '', $object);
2204 }
2205
2206 $result = addFileIntoDatabaseIndex($upload_dir, basename($destfile).($resupload == 2 ? '.noexe' : ''), $TFile['name'][$i], 'uploaded', $sharefile, $object, $forceFullTextIndexation);
2207 if ($result < 0) {
2208 if ($allowoverwrite) {
2209 // Do not show error message. We can have an error due to DB_ERROR_RECORD_ALREADY_EXISTS
2210 } else {
2211 setEventMessages('WarningFailedToAddFileIntoDatabaseIndex', null, 'warnings');
2212 }
2213 }
2214 }
2215
2216 $nbok++;
2217 } else {
2218 $langs->load("errors");
2219 if (is_numeric($resupload) && $resupload < 0) { // Unknown error
2220 setEventMessages($langs->trans("ErrorFileNotUploaded"), null, 'errors');
2221 } elseif (preg_match('/ErrorFileIsInfectedWithAVirus/', $resupload)) { // Files infected by a virus
2222 if (preg_match('/File is a PDF with javascript inside/', $resupload)) {
2223 setEventMessages($langs->trans("ErrorFileIsAnInfectedPDFWithJSInside"), null, 'errors');
2224 } else {
2225 setEventMessages($langs->trans("ErrorFileIsInfectedWithAVirus").'<br>'.dolGetFirstLineOfText($resupload), null, 'errors');
2226 }
2227 } else { // Known error
2228 setEventMessages($langs->trans($resupload), null, 'errors');
2229 }
2230 }
2231 }
2232 if ($nbok > 0) {
2233 $res = $nbok;
2234 setEventMessages($langs->trans("FileTransferComplete"), null, 'mesgs');
2235 }
2236 } else {
2237 setEventMessages($langs->trans("ErrorFailedToCreateDir", $upload_dir), null, 'errors');
2238 }
2239 } elseif ($link) {
2240 require_once DOL_DOCUMENT_ROOT.'/core/class/link.class.php';
2241 $linkObject = new Link($db);
2242 $linkObject->entity = $conf->entity;
2243 $linkObject->url = $link;
2244 $linkObject->objecttype = GETPOST('objecttype', 'alpha');
2245 $linkObject->objectid = GETPOSTINT('objectid');
2246 $linkObject->label = GETPOST('label', 'alpha');
2247 $res = $linkObject->create($user);
2248
2249 if ($res > 0) {
2250 setEventMessages($langs->trans("LinkComplete"), null, 'mesgs');
2251 } else {
2252 setEventMessages($langs->trans("ErrorFileNotLinked"), null, 'errors');
2253 }
2254 } else {
2255 $langs->load("errors");
2256 setEventMessages($langs->trans("ErrorFieldRequired", $langs->transnoentities("File")), null, 'errors');
2257 }
2258
2259 return $res;
2260}
2261
2262
2274function dol_remove_file_process($filenb, $donotupdatesession = 0, $donotdeletefile = 1, $trackid = '')
2275{
2276 global $db, $langs;
2277
2278 $keytodelete = $filenb;
2279 $keytodelete--;
2280
2281 $listofpaths = array();
2282 $listofnames = array();
2283 $listofmimes = array();
2284 $keytoavoidconflict = empty($trackid) ? '' : '-'.$trackid;
2285 if (!empty($_SESSION["listofpaths".$keytoavoidconflict])) {
2286 $listofpaths = explode(';', $_SESSION["listofpaths".$keytoavoidconflict]);
2287 }
2288 if (!empty($_SESSION["listofnames".$keytoavoidconflict])) {
2289 $listofnames = explode(';', $_SESSION["listofnames".$keytoavoidconflict]);
2290 }
2291 if (!empty($_SESSION["listofmimes".$keytoavoidconflict])) {
2292 $listofmimes = explode(';', $_SESSION["listofmimes".$keytoavoidconflict]);
2293 }
2294
2295 if ($keytodelete >= 0) {
2296 $pathtodelete = $listofpaths[$keytodelete];
2297 $filetodelete = $listofnames[$keytodelete];
2298 if (empty($donotdeletefile)) {
2299 $result = dol_delete_file($pathtodelete, 1); // The delete of ecm database is inside the function dol_delete_file
2300 } else {
2301 $result = 0;
2302 }
2303 if ($result >= 0) {
2304 if (empty($donotdeletefile)) {
2305 $langs->load("other");
2306 setEventMessages($langs->trans("FileWasRemoved", $filetodelete), null, 'mesgs');
2307 }
2308 if (empty($donotupdatesession)) {
2309 include_once DOL_DOCUMENT_ROOT.'/core/class/html.formmail.class.php';
2310 $formmail = new FormMail($db);
2311 $formmail->trackid = $trackid;
2312 $formmail->remove_attached_files($keytodelete);
2313 }
2314 }
2315 }
2316}
2317
2318
2333function addFileIntoDatabaseIndex($dir, $file, $fullpathorig = '', $mode = 'uploaded', $setsharekey = 0, $object = null, $forceFullTextIndexation = '')
2334{
2335 global $db, $user;
2336
2337 $result = 0;
2338 $error = 0;
2339
2340 dol_syslog("addFileIntoDatabaseIndex dir=".$dir." file=".$file, LOG_DEBUG);
2341
2342 $rel_dir = preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'/', '', $dir);
2343
2344 if (!preg_match('/[\\/]temp[\\/]|[\\/]thumbs|\.meta$/', $rel_dir)) { // If not a temporary directory. TODO Does this test work ?
2345 $filename = basename(preg_replace('/\.noexe$/', '', $file));
2346 $rel_dir = preg_replace('/[\\/]$/', '', $rel_dir);
2347 $rel_dir = preg_replace('/^[\\/]/', '', $rel_dir);
2348
2349 include_once DOL_DOCUMENT_ROOT.'/ecm/class/ecmfiles.class.php';
2350 $ecmfile = new EcmFiles($db);
2351 $ecmfile->filepath = $rel_dir;
2352 $ecmfile->filename = $filename;
2353 $ecmfile->label = md5_file(dol_osencode($dir.'/'.$file)); // MD5 of file content
2354 $ecmfile->fullpath_orig = $fullpathorig;
2355 $ecmfile->gen_or_uploaded = $mode;
2356 $ecmfile->description = ''; // indexed content
2357 $ecmfile->keywords = ''; // keyword content
2358
2359 if (is_object($object) && $object->id > 0) {
2360 $ecmfile->src_object_id = $object->id;
2361 if (isset($object->table_element)) {
2362 $ecmfile->src_object_type = $object->table_element;
2363 } else {
2364 dol_syslog('Error: object ' . get_class($object) . ' has no table_element attribute.');
2365 return -1;
2366 }
2367 if (isset($object->src_object_description)) {
2368 $ecmfile->description = $object->src_object_description;
2369 }
2370 if (isset($object->src_object_keywords)) {
2371 $ecmfile->keywords = $object->src_object_keywords;
2372 }
2373 if (isset($object->entity)) {
2374 $ecmfile->entity = $object->entity;
2375 }
2376 }
2377
2378 if (getDolGlobalString('MAIN_FORCE_SHARING_ON_ANY_UPLOADED_FILE')) {
2379 $setsharekey = 1;
2380 }
2381
2382 if ($setsharekey) {
2383 require_once DOL_DOCUMENT_ROOT.'/core/lib/security2.lib.php';
2384 $ecmfile->share = getRandomPassword(true);
2385 }
2386
2387 // Use a convert tool for Doc to Text
2388 $useFullTextIndexation = getDolGlobalString('MAIN_SAVE_FILE_CONTENT_AS_TEXT'); // Can be '', 'pdftotext' or 'docling'
2389 if (empty($useFullTextIndexation) && $forceFullTextIndexation == '1') {
2390 if (getDolGlobalString('MAIN_SAVE_FILE_CONTENT_AS_TEXT_PDFTOTEXT')) { // Command line for pdftotext
2391 $useFullTextIndexation = 'pdftotext';
2392 } elseif (getDolGlobalString('MAIN_SAVE_FILE_CONTENT_AS_TEXT_DOCLING')) { // Command line for docling
2393 $useFullTextIndexation = 'docling';
2394 }
2395 }
2396
2397 //$useFullTextIndexation = 1;
2398 if ($useFullTextIndexation) {
2399 $ecmfile->filepath = $rel_dir;
2400 $ecmfile->filename = $filename;
2401
2402 $filetoprocess = $dir.'/'.$ecmfile->filename;
2403
2404 $textforfulltextindex = '';
2405 $keywords = '';
2406 $cmd = '';
2407 if (preg_match('/\.pdf/i', $filename)) {
2408 // Convertfile into text
2409 $result = dolDocToText($filetoprocess);
2410
2411 if (empty($result['error'])) {
2412 $textforfulltextindex = $result['content'];
2413 $filetoprocess = $result['keywords'];
2414 $cmd = $result['cmd'];
2415 } else {
2416 $error++;
2417 }
2418 }
2419
2420 if ($cmd) {
2421 $ecmfile->description = 'File content generated by '.$cmd;
2422 }
2423 $ecmfile->content = $textforfulltextindex;
2424 $ecmfile->keywords = $keywords;
2425 }
2426
2427 if (!$error) {
2428 $result = $ecmfile->create($user);
2429 if ($result < 0) {
2430 dol_syslog($ecmfile->error);
2431 }
2432 }
2433 }
2434
2435 return $result;
2436}
2437
2447function deleteFilesIntoDatabaseIndex($dir, $file, $mode = 'uploaded', $object = null)
2448{
2449 global $conf, $db;
2450
2451 $error = 0;
2452
2453 if (empty($dir)) {
2454 dol_syslog("deleteFilesIntoDatabaseIndex: dir parameter can't be empty", LOG_ERR);
2455 return -1;
2456 }
2457
2458 dol_syslog("deleteFilesIntoDatabaseIndex dir=".$dir." file=".$file, LOG_DEBUG);
2459
2460 $db->begin();
2461
2462 $rel_dir = preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'/', '', $dir);
2463
2464 if (!preg_match('/[\\/]temp[\\/]|[\\/]thumbs|\.meta$/', $rel_dir)) { // If not a temporary directory. TODO Does this test work ?
2465 //$filename = basename($file);
2466 $rel_dir = preg_replace('/[\\/]$/', '', $rel_dir);
2467 $rel_dir = preg_replace('/^[\\/]/', '', $rel_dir);
2468
2469 if (!$error) {
2470 $sql = 'DELETE FROM '.MAIN_DB_PREFIX.'ecm_files';
2471 if (isset($object->entity)) {
2472 $sql .= ' WHERE entity = ' . ((int) $object->entity);
2473 } else {
2474 $sql .= ' WHERE entity = ' . ((int) $conf->entity);
2475 }
2476 $sql .= " AND filepath = '".$db->escape($rel_dir)."'";
2477 if ($file) {
2478 $sql .= " AND filename = '".$db->escape($file)."'";
2479 }
2480 if ($mode) {
2481 $sql .= " AND gen_or_uploaded = '".$db->escape($mode)."'";
2482 }
2483
2484 $resql = $db->query($sql);
2485 if (!$resql) {
2486 $error++;
2487 dol_syslog(__FUNCTION__.' '.$db->lasterror(), LOG_ERR);
2488 }
2489 }
2490 }
2491
2492 // Commit or rollback
2493 if ($error) {
2494 $db->rollback();
2495 return -1 * $error;
2496 } else {
2497 $db->commit();
2498 return 1;
2499 }
2500}
2501
2509function isRealPdf(string $filePath)
2510{
2511 if (!is_file($filePath) || !is_readable($filePath)) {
2512 return false;
2513 }
2514
2515 // Open file
2516 $handle = fopen($filePath, 'rb');
2517 if (!$handle) {
2518 return false;
2519 }
2520 $header = fread($handle, 5);
2521 fclose($handle);
2522
2523 if ($header !== '%PDF-') {
2524 return false;
2525 }
2526
2527 // Check using finfo_file
2528 /*
2529 $finfo = finfo_open(FILEINFO_MIME_TYPE);
2530 $mime = finfo_file($finfo, $filePath);
2531 finfo_close($finfo);
2532 if ($mime !== 'application/pdf') {
2533 return false;
2534 }
2535 */
2536
2537 return true;
2538}
2539
2551function dol_convert_file($fileinput, $ext = 'png', $fileoutput = '', $page = '')
2552{
2553 if (class_exists('Imagick')) {
2554 $image = new Imagick();
2555 try {
2556 // Imagick may have a support for Magick Scripting Language (MSL) that allows to run execution code with some files like SVG. So we need to check
2557 // that file is really a PDF file.
2558 // Note: The Imagick policy options can be disabled into /etc/ImageMagick*/policy.xml.
2559 if (!isRealPdf($fileinput)) {
2560 dol_syslog("We try to convert a PDF file with name ".$fileinput." but it is not a real PDF file (hack attempt ?).", LOG_WARNING);
2561 return -4;
2562 }
2563
2564 $filetoconvert = $fileinput.(($page != '') ? '['.$page.']' : '');
2565 //var_dump($filetoconvert);
2566 $ret = $image->readImage($filetoconvert);
2567 } catch (Exception $e) {
2568 $ext = pathinfo($fileinput, PATHINFO_EXTENSION);
2569 dol_syslog("Failed to read image using Imagick (Try to install package 'apt-get install php-imagick ghostscript' and check there is no policy to disable ".$ext." conversion in /etc/ImageMagick*/policy.xml): ".$e->getMessage(), LOG_WARNING);
2570 return 0;
2571 }
2572
2573 if ($ret) {
2574 $ret = $image->setImageFormat($ext);
2575 if ($ret) {
2576 if (empty($fileoutput)) {
2577 $fileoutput = $fileinput.".".$ext;
2578 }
2579
2580 $count = $image->getNumberImages();
2581
2582 if (!dol_is_file($fileoutput) || is_writable($fileoutput)) {
2583 try {
2584 $ret = $image->writeImages($fileoutput, true);
2585 } catch (Exception $e) {
2586 dol_syslog($e->getMessage(), LOG_WARNING);
2587 }
2588 } else {
2589 dol_syslog("Warning: Failed to write cache preview file '.$fileoutput.'. Check permission on file/dir", LOG_ERR);
2590 }
2591 if ($ret) {
2592 return $count;
2593 } else {
2594 return -3;
2595 }
2596 } else {
2597 return -2;
2598 }
2599 } else {
2600 return -1;
2601 }
2602 } else {
2603 return 0;
2604 }
2605}
2606
2607
2619function dol_compress_file($inputfile, $outputfile, $mode = "gz", &$errorstring = null)
2620{
2621 $foundhandler = 0;
2622 //var_dump(basename($inputfile)); exit;
2623
2624 try {
2625 dol_syslog("dol_compress_file mode=".$mode." inputfile=".$inputfile." outputfile=".$outputfile);
2626
2627 $data = implode("", file(dol_osencode($inputfile)));
2628 $compressdata = null;
2629 if ($mode == 'gz' && function_exists('gzencode')) {
2630 $foundhandler = 1;
2631 $compressdata = gzencode($data, 9);
2632 } elseif ($mode == 'bz' && function_exists('bzcompress')) {
2633 $foundhandler = 1;
2634 $compressdata = bzcompress($data, 9);
2635 } elseif ($mode == 'zstd' && function_exists('zstd_compress')) {
2636 $foundhandler = 1;
2637 $compressdata = zstd_compress($data, 9);
2638 } elseif ($mode == 'zip') {
2639 if (class_exists('ZipArchive') && getDolGlobalString('MAIN_USE_ZIPARCHIVE_FOR_ZIP_COMPRESS')) {
2640 $foundhandler = 1;
2641
2642 $rootPath = realpath($inputfile);
2643
2644 dol_syslog("Class ZipArchive is set so we zip using ZipArchive to zip into ".$outputfile.' rootPath='.$rootPath);
2645 $zip = new ZipArchive();
2646
2647 if ($zip->open($outputfile, ZipArchive::CREATE) !== true) {
2648 $errorstring = "dol_compress_file failure - Failed to open file ".$outputfile."\n";
2649 dol_syslog($errorstring, LOG_ERR);
2650
2651 global $errormsg;
2652 $errormsg = $errorstring;
2653
2654 return -6;
2655 }
2656
2657 // Create recursive directory iterator
2659 $files = new RecursiveIteratorIterator(
2660 new RecursiveDirectoryIterator($rootPath, FilesystemIterator::UNIX_PATHS),
2661 RecursiveIteratorIterator::LEAVES_ONLY
2662 );
2663 '@phan-var-force SplFileInfo[] $files';
2664
2665 foreach ($files as $name => $file) {
2666 // Skip directories (they would be added automatically)
2667 if (!$file->isDir()) {
2668 // Get real and relative path for current file
2669 $filePath = $file->getPath(); // the full path with filename using the $inputdir root.
2670 $fileName = $file->getFilename();
2671 $fileFullRealPath = $file->getRealPath(); // the full path with name and transformed to use real path directory.
2672
2673 //$relativePath = substr($fileFullRealPath, strlen($rootPath) + 1);
2674 $relativePath = substr(($filePath ? $filePath.'/' : '').$fileName, strlen($rootPath) + 1);
2675
2676 // Add current file to archive
2677 $zip->addFile($fileFullRealPath, $relativePath);
2678 }
2679 }
2680
2681 // Zip archive will be created only after closing object
2682 $zip->close();
2683
2684 dol_syslog("dol_compress_file success - ".$zip->numFiles." files");
2685 return 1;
2686 }
2687
2688 if (defined('ODTPHP_PATHTOPCLZIP')) {
2689 $foundhandler = 1;
2690
2691 include_once ODTPHP_PATHTOPCLZIP.'pclzip.lib.php';
2692 $archive = new PclZip($outputfile);
2693
2694 $result = $archive->add($inputfile, PCLZIP_OPT_REMOVE_PATH, dirname($inputfile));
2695
2696 if ($result === 0) {
2697 global $errormsg;
2698 $errormsg = $archive->errorInfo(true);
2699
2700 if ($archive->errorCode() == PCLZIP_ERR_WRITE_OPEN_FAIL) {
2701 $errorstring = "PCLZIP_ERR_WRITE_OPEN_FAIL";
2702 dol_syslog("dol_compress_file error - archive->errorCode() = PCLZIP_ERR_WRITE_OPEN_FAIL", LOG_ERR);
2703 return -4;
2704 }
2705
2706 $errorstring = "dol_compress_file error archive->errorCode = ".$archive->errorCode()." errormsg=".$errormsg;
2707 dol_syslog("dol_compress_file failure - ".$errormsg, LOG_ERR);
2708 return -3;
2709 } else {
2710 dol_syslog("dol_compress_file success - ".count($result)." files");
2711 return 1;
2712 }
2713 }
2714 }
2715
2716 if ($foundhandler && is_string($compressdata)) {
2717 $fp = fopen($outputfile, "w");
2718 fwrite($fp, $compressdata);
2719 fclose($fp);
2720 return 1;
2721 } else {
2722 $errorstring = "Try to zip with format ".$mode." with no handler for this format";
2723 dol_syslog($errorstring, LOG_ERR);
2724
2725 global $errormsg;
2726 $errormsg = $errorstring;
2727 return -2;
2728 }
2729 } catch (Exception $e) {
2730 global $langs, $errormsg;
2731 $langs->load("errors");
2732 $errormsg = $langs->trans("ErrorFailedToWriteInDir");
2733
2734 $errorstring = "Failed to open file ".$outputfile;
2735 dol_syslog($errorstring, LOG_ERR);
2736 return -1;
2737 }
2738}
2739
2748function dol_uncompress($inputfile, $outputdir)
2749{
2750 global $langs, $db;
2751
2752 $fileinfo = pathinfo($inputfile);
2753 $fileinfo["extension"] = strtolower($fileinfo["extension"]);
2754
2755 if ($fileinfo["extension"] == "zip") {
2756 if (defined('ODTPHP_PATHTOPCLZIP') && !getDolGlobalString('MAIN_USE_ZIPARCHIVE_FOR_ZIP_UNCOMPRESS')) {
2757 dol_syslog("Constant ODTPHP_PATHTOPCLZIP for pclzip library is set to ".ODTPHP_PATHTOPCLZIP.", so we use Pclzip to unzip into ".$outputdir);
2758 include_once ODTPHP_PATHTOPCLZIP.'pclzip.lib.php';
2759 $archive = new PclZip($inputfile);
2760
2761 // We create output dir manually, so it uses the correct permission (When created by the archive->extract, dir is rwx for everybody).
2762 dol_mkdir(dol_sanitizePathName($outputdir));
2763
2764 try {
2765 // Extract into outputdir, but only files that match the regex '/^((?!\.\.).)*$/' that means "does not include .."
2766 $result = $archive->extract(PCLZIP_OPT_PATH, $outputdir, PCLZIP_OPT_BY_PREG, '/^((?!\.\.).)*$/');
2767 } catch (Exception $e) {
2768 return array('error' => $e->getMessage());
2769 }
2770
2771 if (!is_array($result) && $result <= 0) {
2772 return array('error' => $archive->errorInfo(true));
2773 } else {
2774 $ok = 1;
2775 $errmsg = '';
2776 // Loop on each file to check result for unzipping file
2777 foreach ($result as $key => $val) {
2778 if ($val['status'] == 'path_creation_fail') {
2779 $langs->load("errors");
2780 $ok = 0;
2781 $errmsg = $langs->trans("ErrorFailToCreateDir", $val['filename']);
2782 break;
2783 }
2784 if ($val['status'] == 'write_protected') {
2785 $langs->load("errors");
2786 $ok = 0;
2787 $errmsg = $langs->trans("ErrorFailToCreateFile", $val['filename']);
2788 break;
2789 }
2790 }
2791
2792 if ($ok) {
2793 return array();
2794 } else {
2795 return array('error' => $errmsg);
2796 }
2797 }
2798 }
2799
2800 if (class_exists('ZipArchive')) { // Must install php-zip to have it
2801 dol_syslog("Class ZipArchive is set so we unzip using ZipArchive to unzip into ".$outputdir);
2802 $zip = new ZipArchive();
2803 $res = $zip->open($inputfile);
2804 if ($res === true) {
2805 //$zip->extractTo($outputdir.'/');
2806 // We must extract one file at time so we can check that file name does not contain '..' to avoid transversal path of zip built for example using
2807 // python3 path_traversal_archiver.py <Created_file_name> test.zip -l 10 -p tmp/
2808 // with -l is the range of dot to go back in path.
2809 // and path_traversal_archiver.py found at https://github.com/Alamot/code-snippets/blob/master/path_traversal/path_traversal_archiver.py
2810 for ($i = 0; $i < $zip->numFiles; $i++) {
2811 if (preg_match('/\.\./', $zip->getNameIndex($i))) {
2812 dol_syslog("Warning: Try to unzip a file with a transversal path ".$zip->getNameIndex($i), LOG_WARNING);
2813 continue; // Discard the file
2814 }
2815 $zip->extractTo($outputdir.'/', array($zip->getNameIndex($i)));
2816 }
2817
2818 $zip->close();
2819 return array();
2820 } else {
2821 return array('error' => 'ErrUnzipFails');
2822 }
2823 }
2824
2825 return array('error' => 'ErrNoZipEngine');
2826 } elseif (in_array($fileinfo["extension"], array('gz', 'bz2', 'zst'))) {
2827 include_once DOL_DOCUMENT_ROOT."/core/class/utils.class.php";
2828 $utils = new Utils($db);
2829
2830 dol_mkdir(dol_sanitizePathName($outputdir));
2831 $outputfilename = escapeshellcmd(dol_sanitizePathName($outputdir).'/'.dol_sanitizeFileName($fileinfo["filename"]));
2832 dol_delete_file($outputfilename.'.tmp');
2833 dol_delete_file($outputfilename.'.err');
2834
2835 $extension = strtolower(pathinfo($fileinfo["filename"], PATHINFO_EXTENSION));
2836 if ($extension == "tar") {
2837 $cmd = 'tar -C '.escapeshellcmd(dol_sanitizePathName($outputdir)).' -xvf '.escapeshellcmd(dol_sanitizePathName($fileinfo["dirname"]).'/'.dol_sanitizeFileName($fileinfo["basename"]));
2838
2839 $resarray = $utils->executeCLI($cmd, $outputfilename.'.tmp', 0, $outputfilename.'.err', 0);
2840 if ($resarray["result"] != 0) {
2841 $resarray["error"] .= file_get_contents($outputfilename.'.err');
2842 }
2843 } else {
2844 $program = "";
2845 if ($fileinfo["extension"] == "gz") {
2846 $program = 'gzip';
2847 } elseif ($fileinfo["extension"] == "bz2") {
2848 $program = 'bzip2';
2849 } elseif ($fileinfo["extension"] == "zst") {
2850 $program = 'zstd';
2851 } else {
2852 return array('error' => 'ErrorBadFileExtension');
2853 }
2854 $cmd = $program.' -dc '.escapeshellcmd(dol_sanitizePathName($fileinfo["dirname"]).'/'.dol_sanitizeFileName($fileinfo["basename"]));
2855 $cmd .= ' > '.$outputfilename;
2856
2857 $resarray = $utils->executeCLI($cmd, $outputfilename.'.tmp', 0, null, 1, $outputfilename.'.err');
2858 if ($resarray["result"] != 0) {
2859 $errfilecontent = @file_get_contents($outputfilename.'.err');
2860 if ($errfilecontent) {
2861 $resarray["error"] .= " - ".$errfilecontent;
2862 }
2863 }
2864 }
2865 return $resarray["result"] != 0 ? array('error' => $resarray["error"]) : array();
2866 }
2867
2868 return array('error' => 'ErrorBadFileExtension');
2869}
2870
2871
2884function dol_compress_dir($inputdir, $outputfile, $mode = "zip", $excludefiles = '', $rootdirinzip = '', $newmask = '0')
2885{
2886 $foundhandler = 0;
2887
2888 dol_syslog("Try to zip dir ".$inputdir." into ".$outputfile." mode=".$mode);
2889
2890 if (!dol_is_dir(dirname($outputfile)) || !is_writable(dirname($outputfile))) {
2891 global $langs, $errormsg;
2892 $langs->load("errors");
2893 $errormsg = $langs->trans("ErrorFailedToWriteInDir", $outputfile);
2894 return -3;
2895 }
2896
2897 try {
2898 if ($mode == 'gz') {
2899 $foundhandler = 0;
2900 } elseif ($mode == 'bz') {
2901 $foundhandler = 0;
2902 } elseif ($mode == 'zip') {
2903 /*if (defined('ODTPHP_PATHTOPCLZIP'))
2904 {
2905 $foundhandler=0; // TODO implement this
2906
2907 include_once ODTPHP_PATHTOPCLZIP.'/pclzip.lib.php';
2908 $archive = new PclZip($outputfile);
2909 $archive->add($inputfile, PCLZIP_OPT_REMOVE_PATH, dirname($inputfile));
2910 //$archive->add($inputfile);
2911 return 1;
2912 }
2913 else*/
2914 //if (class_exists('ZipArchive') && !empty($conf->global->MAIN_USE_ZIPARCHIVE_FOR_ZIP_COMPRESS))
2915
2916 if (class_exists('ZipArchive')) {
2917 $foundhandler = 1;
2918
2919 // Initialize archive object
2920 $zip = new ZipArchive();
2921 $result = $zip->open($outputfile, ZipArchive::CREATE | ZipArchive::OVERWRITE);
2922 if ($result !== true) {
2923 global $langs, $errormsg;
2924 $langs->load("errors");
2925 $errormsg = $langs->trans("ErrorFailedToBuildArchive", $outputfile);
2926 return -4;
2927 }
2928
2929 // Create recursive directory iterator
2930 // This does not return symbolic links
2932 $files = new RecursiveIteratorIterator(
2933 new RecursiveDirectoryIterator($inputdir, FilesystemIterator::UNIX_PATHS),
2934 RecursiveIteratorIterator::LEAVES_ONLY
2935 );
2936 '@phan-var-force SplFileInfo[] $files';
2937
2938 //var_dump($inputdir);
2939 foreach ($files as $name => $file) {
2940 // Skip directories (they would be added automatically)
2941 if (!$file->isDir()) {
2942 // Get real and relative path for current file
2943 $filePath = $file->getPath(); // the full path with filename using the $inputdir root.
2944 $fileName = $file->getFilename();
2945 $fileFullRealPath = $file->getRealPath(); // the full path with name and transformed to use real path directory.
2946
2947 //$relativePath = ($rootdirinzip ? $rootdirinzip.'/' : '').substr($fileFullRealPath, strlen($inputdir) + 1);
2948 $relativePath = ($rootdirinzip ? $rootdirinzip.'/' : '').substr(($filePath ? $filePath.'/' : '').$fileName, strlen($inputdir) + 1);
2949
2950 //var_dump($filePath);var_dump($fileFullRealPath);var_dump($relativePath);
2951 if (empty($excludefiles) || !preg_match($excludefiles, $fileFullRealPath)) {
2952 // Add current file to archive
2953 $zip->addFile($fileFullRealPath, $relativePath);
2954 }
2955 }
2956 }
2957
2958 // Zip archive will be created only after closing object
2959 $zip->close();
2960
2961 if (empty($newmask) && getDolGlobalString('MAIN_UMASK')) {
2962 $newmask = getDolGlobalString('MAIN_UMASK');
2963 }
2964 if (empty($newmask)) { // This should no happen
2965 dol_syslog("Warning: dol_compress_dir called with empty value for newmask and no default value defined", LOG_WARNING);
2966 $newmask = '0664';
2967 }
2968
2969 dolChmod($outputfile, $newmask);
2970
2971 return 1;
2972 }
2973 }
2974
2975 if (!$foundhandler) {
2976 dol_syslog("Try to zip with format ".$mode." with no handler for this format", LOG_ERR);
2977 return -2;
2978 } else {
2979 return 0;
2980 }
2981 } catch (Exception $e) {
2982 global $langs, $errormsg;
2983 $langs->load("errors");
2984 dol_syslog("Failed to open file ".$outputfile, LOG_ERR);
2985 dol_syslog($e->getMessage(), LOG_ERR);
2986 $errormsg = $langs->trans("ErrorFailedToBuildArchive", $outputfile).' - '.$e->getMessage();
2987 return -1;
2988 }
2989}
2990
2991
2992
3003function dol_most_recent_file($dir, $regexfilter = '', $excludefilter = array('(\.meta|_preview.*\.png)$', '^\.'), $nohook = 0, $mode = 0)
3004{
3005 $tmparray = dol_dir_list($dir, 'files', 0, $regexfilter, $excludefilter, 'date', SORT_DESC, $mode, $nohook);
3006 return isset($tmparray[0]) ? $tmparray[0] : null;
3007}
3008
3022function dol_check_secure_access_document($modulepart, $original_file, $entity, $fuser = null, $refname = '', $mode = 'read')
3023{
3024 global $conf, $db, $user, $hookmanager;
3025 global $dolibarr_main_data_root, $dolibarr_main_document_root_alt;
3026 global $object;
3027
3028 if (!is_object($fuser)) {
3029 $fuser = $user;
3030 }
3031
3032 if (empty($modulepart)) {
3033 return 'ErrorBadParameter';
3034 }
3035 if (empty($entity)) {
3036 if (!isModEnabled('multicompany')) {
3037 $entity = 1;
3038 } else {
3039 $entity = 0;
3040 }
3041 }
3042 // Fix modulepart for backward compatibility
3043 if ($modulepart == 'facture') {
3044 $modulepart = 'invoice';
3045 } elseif ($modulepart == 'users') {
3046 $modulepart = 'user';
3047 } elseif ($modulepart == 'tva') {
3048 $modulepart = 'tax-vat';
3049 } elseif ($modulepart == 'expedition' && strpos($original_file, 'receipt/') === 0) {
3050 // Fix modulepart delivery
3051 $modulepart = 'delivery';
3052 } elseif ($modulepart == 'propale') {
3053 $modulepart = 'propal';
3054 }
3055
3056 //print 'dol_check_secure_access_document modulepart='.$modulepart.' original_file='.$original_file.' entity='.$entity;
3057 dol_syslog('dol_check_secure_access_document modulepart='.$modulepart.' original_file='.$original_file.' entity='.$entity);
3058
3059 // We define $accessallowed and $sqlprotectagainstexternals
3060 $accessallowed = 0;
3061 $sqlprotectagainstexternals = '';
3062 $ret = array();
3063
3064 // Find the subdirectory name as the reference. For example original_file='10/myfile.pdf' -> refname='10'
3065 if (empty($refname)) {
3066 $refname = basename(dirname($original_file)."/");
3067 if ($refname == 'thumbs' || $refname == 'temp') {
3068 // If we get the thumbs directory, we must go one step higher. For example original_file='10/thumbs/myfile_small.jpg' -> refname='10'
3069 $refname = basename(dirname(dirname($original_file))."/");
3070 }
3071 }
3072
3073 // Define possible keys to use for permission check
3074 $lire = 'lire';
3075 $read = 'read';
3076 $download = 'download';
3077 if ($mode == 'write') {
3078 $lire = 'creer';
3079 $read = 'write';
3080 $download = 'upload';
3081 }
3082
3083 // Wrapping for miscellaneous medias files
3084 if ($modulepart == 'common') {
3085 // Wrapping for some images
3086 $accessallowed = 1;
3087 $original_file = DOL_DOCUMENT_ROOT.'/public/theme/common/'.$original_file;
3088 } elseif ($modulepart == 'medias' && !empty($dolibarr_main_data_root)) {
3089 /* the medias directory is by default a public directory accessible online for everybody, so test on permission per entity is not done, it has no sense */
3090 if (empty($entity)) {
3091 $entity = 1;
3092 }
3093 $accessallowed = 0;
3094 if ($mode == 'write') {
3095 if ($fuser->hasRight('website', 'write')) {
3096 $accessallowed = 1;
3097 }
3098 } else {
3099 $accessallowed = 1; // As dir is public, we allow read access to all files in medias directory
3100 }
3101 $original_file = (empty($conf->medias->multidir_output[$entity]) ? (empty($conf->medias->dir_output) ? DOL_DATA_ROOT.'/medias' : $conf->medias->dir_output) : $conf->medias->multidir_output[$entity]).'/'.$original_file;
3102 } elseif ($modulepart == 'logs' && !empty($dolibarr_main_data_root)) {
3103 // Wrapping for *.log files, like when used with url http://.../document.php?modulepart=logs&file=dolibarr.log
3104 $accessallowed = ($user->admin && basename($original_file) == $original_file && preg_match('/^dolibarr.*\.(log|json)$/', basename($original_file)));
3105 $original_file = $dolibarr_main_data_root.'/'.$original_file;
3106 } elseif ($modulepart == 'doctemplates' && !empty($dolibarr_main_data_root)) {
3107 $accessallowed = $user->admin;
3108 $relative_file = $original_file;
3109 $ent = ($entity > 0 ? $entity : $conf->entity);
3110 $path_with_entity = $dolibarr_main_data_root . '/' . $ent . '/doctemplates/' . $relative_file;
3111 if ($ent > 1 && file_exists(dol_osencode($path_with_entity))) {
3112 $original_file = $path_with_entity;
3113 } else {
3114 $original_file = $dolibarr_main_data_root . '/doctemplates/' . $relative_file;
3115 }
3116 } elseif ($modulepart == 'doctemplateswebsite' && !empty($dolibarr_main_data_root)) {
3117 // Wrapping for doctemplates of websites
3118 $accessallowed = ($fuser->hasRight('website', 'write') && preg_match('/\.jpg$/i', basename($original_file)));
3119 $original_file = $dolibarr_main_data_root.'/doctemplates/websites/'.$original_file;
3120 } elseif ($modulepart == 'packages' && !empty($dolibarr_main_data_root)) { // To download zip of modules
3121 // Wrapping for *.zip package files, like when used with url http://.../document.php?modulepart=packages&file=module_myfile.zip
3122 // Dir for custom dirs
3123 $tmp = explode(',', $dolibarr_main_document_root_alt);
3124 $dirins = $tmp[0];
3125
3126 $accessallowed = ($user->admin && preg_match('/^module_.*\.zip$/', basename($original_file)));
3127 $original_file = $dirins.'/'.$original_file;
3128 } elseif ($modulepart == 'mycompany' && !empty($conf->mycompany->dir_output)) {
3129 // Wrapping for some images
3130 $accessallowed = 1;
3131 $original_file = $conf->mycompany->dir_output.'/'.$original_file;
3132 } elseif ($modulepart == 'userphoto' && !empty($conf->user->dir_output)) {
3133 // Wrapping for users photos (user photos are allowed to any connected users)
3134 $accessallowed = 0;
3135 if (preg_match('/^\d+\/photos\//', $original_file)) {
3136 $accessallowed = 1;
3137 }
3138 $original_file = $conf->user->dir_output.'/'.$original_file;
3139 } elseif ($modulepart == 'userphotopublic' && !empty($conf->user->dir_output)) {
3140 // Wrapping for users photos that were set to public (for virtual credit card) by their owner (public user photos can be read
3141 // with the public link and securekey)
3142 $accessok = false;
3143 $reg = array();
3144 if (preg_match('/^(\d+)\/photos\//', $original_file, $reg)) {
3145 if ((int) $reg[1]) {
3146 $tmpobject = new User($db);
3147 $tmpobject->fetch((int) $reg[1], '', '', 1);
3148 if (getDolUserInt('USER_ENABLE_PUBLIC', 0, $tmpobject)) {
3149 $securekey = GETPOST('securekey', 'alpha', 1);
3150 // Security check
3151 global $dolibarr_main_cookie_cryptkey, $dolibarr_main_instance_unique_id;
3152 $valuetouse = $dolibarr_main_instance_unique_id ? $dolibarr_main_instance_unique_id : $dolibarr_main_cookie_cryptkey; // Use $dolibarr_main_instance_unique_id first then $dolibarr_main_cookie_cryptkey
3153 $encodedsecurekey = dol_hash($valuetouse.'uservirtualcard'.$tmpobject->id.'-'.$tmpobject->login, 'md5');
3154 if ($encodedsecurekey == $securekey) {
3155 $accessok = true;
3156 }
3157 }
3158 }
3159 }
3160 if ($accessok) {
3161 $accessallowed = 1;
3162 }
3163 $original_file = $conf->user->dir_output.'/'.$original_file;
3164 } elseif (($modulepart == 'companylogo') && !empty($conf->mycompany->dir_output)) {
3165 // Wrapping for company logos (company logos are allowed to anyboby, they are public)
3166 $accessallowed = 1;
3167 $original_file = $conf->mycompany->dir_output.'/logos/'.$original_file;
3168 } elseif ($modulepart == 'memberphoto' && !empty($conf->member->dir_output)) {
3169 // Wrapping for members photos
3170 $accessallowed = 0;
3171 // Simple chosen for automatic generation of member codes
3172 if (preg_match('/^\d+\/photos\//', $original_file)) {
3173 $accessallowed = 1;
3174 }
3175 // Advanced chosen for automatic generation of member codes
3176 if (preg_match('/^MEM\d\d\d\d-\d\d\d\d\/photos\//', $original_file)) {
3177 $accessallowed = 1;
3178 }
3179 $original_file = $conf->member->dir_output.'/'.$original_file;
3180 } elseif ($modulepart == 'apercufacture' && !empty($conf->invoice->multidir_output[$entity])) {
3181 // Wrapping for invoices (user need permission to read invoices)
3182 if ($fuser->hasRight('facture', $lire)) {
3183 $accessallowed = 1;
3184 }
3185 $original_file = $conf->invoice->multidir_output[$entity].'/'.$original_file;
3186 } elseif ($modulepart == 'apercupropal' && !empty($conf->propal->multidir_output[$entity])) {
3187 // Wrapping for preview of proposals
3188 if ($fuser->hasRight('propal', $lire)) {
3189 $accessallowed = 1;
3190 }
3191 $original_file = $conf->propal->multidir_output[$entity].'/'.$original_file;
3192 } elseif ($modulepart == 'apercucommande' && !empty($conf->order->multidir_output[$entity])) {
3193 // Wrapping for preview of orders
3194 if ($fuser->hasRight('commande', $lire)) {
3195 $accessallowed = 1;
3196 }
3197 $original_file = $conf->order->multidir_output[$entity].'/'.$original_file;
3198 } elseif (($modulepart == 'apercufichinter' || $modulepart == 'apercuficheinter') && !empty($conf->ficheinter->dir_output)) {
3199 // Wrapping for preview of intervention
3200 if ($fuser->hasRight('ficheinter', $lire)) {
3201 $accessallowed = 1;
3202 }
3203 $original_file = $conf->ficheinter->dir_output.'/'.$original_file;
3204 } elseif (($modulepart == 'apercucontract') && !empty($conf->contract->multidir_output[$entity])) {
3205 // Wrapping for preview of contracts
3206 if ($fuser->hasRight('contrat', $lire)) {
3207 $accessallowed = 1;
3208 }
3209 $original_file = $conf->contract->multidir_output[$entity].'/'.$original_file;
3210 } elseif (($modulepart == 'apercusupplier_proposal') && !empty($conf->supplier_proposal->dir_output)) {
3211 // Wrapping for preview of vendor proposals
3212 if ($fuser->hasRight('supplier_proposal', $lire)) {
3213 $accessallowed = 1;
3214 }
3215 $original_file = $conf->supplier_proposal->dir_output.'/'.$original_file;
3216 } elseif (($modulepart == 'apercusupplier_order') && !empty($conf->fournisseur->commande->dir_output)) {
3217 // Wrapping for preview of purchase orders
3218 if ($fuser->hasRight('fournisseur', 'commande', $lire)) {
3219 $accessallowed = 1;
3220 }
3221 $original_file = $conf->fournisseur->commande->dir_output.'/'.$original_file;
3222 } elseif (($modulepart == 'apercusupplier_invoice') && !empty($conf->fournisseur->facture->dir_output)) {
3223 // Wrapping for preview of supplier invoices
3224 if ($fuser->hasRight('fournisseur', $lire)) {
3225 $accessallowed = 1;
3226 }
3227 $original_file = $conf->fournisseur->facture->dir_output.'/'.$original_file;
3228 } elseif (($modulepart == 'holiday') && !empty($conf->holiday->dir_output)) {
3229 if ($fuser->hasRight('holiday', $read) || $fuser->hasRight('holiday', 'readall') || preg_match('/^specimen/i', $original_file)) {
3230 $accessallowed = 1;
3231 // If we known $id of holiday, call checkUserAccessToObject to check permission on properties and hierarchy of leave request
3232 if ($refname && !$fuser->hasRight('holiday', 'readall') && !preg_match('/^specimen/i', $original_file)) {
3233 include_once DOL_DOCUMENT_ROOT.'/holiday/class/holiday.class.php';
3234 $tmpholiday = new Holiday($db);
3235 $tmpholiday->fetch(0, $refname);
3236 $accessallowed = checkUserAccessToObject($user, array('holiday'), $tmpholiday, 'holiday', '', '', 'rowid', '');
3237 }
3238 }
3239 $original_file = $conf->holiday->dir_output.'/'.$original_file;
3240 } elseif (($modulepart == 'expensereport') && !empty($conf->expensereport->dir_output)) {
3241 if ($fuser->hasRight('expensereport', $lire) || $fuser->hasRight('expensereport', 'readall') || preg_match('/^specimen/i', $original_file)) {
3242 $accessallowed = 1;
3243 // If we known $id of expensereport, call checkUserAccessToObject to check permission on properties and hierarchy of expense report
3244 if ($refname && !$fuser->hasRight('expensereport', 'readall') && !preg_match('/^specimen/i', $original_file)) {
3245 include_once DOL_DOCUMENT_ROOT.'/expensereport/class/expensereport.class.php';
3246 $tmpexpensereport = new ExpenseReport($db);
3247 $tmpexpensereport->fetch(0, $refname);
3248 $accessallowed = checkUserAccessToObject($user, array('expensereport'), $tmpexpensereport, 'expensereport', '', '', 'rowid', '');
3249 }
3250 }
3251 $original_file = $conf->expensereport->dir_output.'/'.$original_file;
3252 } elseif (($modulepart == 'apercuexpensereport') && !empty($conf->expensereport->dir_output)) {
3253 // Wrapping for preview of expense report
3254 if ($fuser->hasRight('expensereport', $lire)) {
3255 $accessallowed = 1;
3256 }
3257 $original_file = $conf->expensereport->dir_output.'/'.$original_file;
3258 } elseif ($modulepart == 'propalstats' && !empty($conf->propal->multidir_temp[$entity])) {
3259 // Wrapping for statistics images of proposal
3260 if ($fuser->hasRight('propal', $lire)) {
3261 $accessallowed = 1;
3262 }
3263 $original_file = $conf->propal->multidir_temp[$entity].'/'.$original_file;
3264 } elseif ($modulepart == 'orderstats' && !empty($conf->order->dir_temp)) {
3265 // Wrapping for statistics images of orders
3266 if ($fuser->hasRight('commande', $lire)) {
3267 $accessallowed = 1;
3268 }
3269 $original_file = $conf->order->dir_temp.'/'.$original_file;
3270 } elseif ($modulepart == 'orderstatssupplier' && !empty($conf->fournisseur->dir_output)) {
3271 if ($fuser->hasRight('fournisseur', 'commande', $lire)) {
3272 $accessallowed = 1;
3273 }
3274 $original_file = $conf->fournisseur->commande->dir_temp.'/'.$original_file;
3275 } elseif ($modulepart == 'billstats' && !empty($conf->invoice->dir_temp)) {
3276 // Wrapping for statistics images of purchase orders
3277 if ($fuser->hasRight('facture', $lire)) {
3278 $accessallowed = 1;
3279 }
3280 $original_file = $conf->invoice->dir_temp.'/'.$original_file;
3281 } elseif ($modulepart == 'billstatssupplier' && !empty($conf->fournisseur->dir_output)) {
3282 if ($fuser->hasRight('fournisseur', 'facture', $lire)) {
3283 $accessallowed = 1;
3284 }
3285 $original_file = $conf->fournisseur->facture->dir_temp.'/'.$original_file;
3286 } elseif ($modulepart == 'expeditionstats' && !empty($conf->expedition->dir_temp)) {
3287 // Wrapping for statistics images of shipments
3288 if ($fuser->hasRight('expedition', $lire)) {
3289 $accessallowed = 1;
3290 }
3291 $original_file = $conf->expedition->dir_temp.'/'.$original_file;
3292 } elseif ($modulepart == 'tripsexpensesstats' && !empty($conf->deplacement->dir_temp)) {
3293 // Wrapping pour les images des stats expeditions
3294 if ($fuser->hasRight('deplacement', $lire)) {
3295 $accessallowed = 1;
3296 }
3297 $original_file = $conf->deplacement->dir_temp.'/'.$original_file;
3298 } elseif ($modulepart == 'memberstats' && !empty($conf->member->dir_temp)) {
3299 // Wrapping for statistics images of memberships
3300 if ($fuser->hasRight('adherent', $lire)) {
3301 $accessallowed = 1;
3302 }
3303 $original_file = $conf->member->dir_temp.'/'.$original_file;
3304 } elseif (preg_match('/^productstats_/i', $modulepart) && !empty($conf->product->dir_temp)) {
3305 // Wrapping for statistics images of products
3306 if ($fuser->hasRight('produit', $lire) || $fuser->hasRight('service', $lire)) {
3307 $accessallowed = 1;
3308 }
3309 $original_file = (!empty($conf->product->multidir_temp[$entity]) ? $conf->product->multidir_temp[$entity] : $conf->service->multidir_temp[$entity]).'/'.$original_file;
3310 } elseif (in_array($modulepart, array('tax', 'tax-vat', 'tva')) && !empty($conf->tax->dir_output)) {
3311 // Wrapping for taxes
3312 if ($fuser->hasRight('tax', 'charges', $lire)) {
3313 $accessallowed = 1;
3314 }
3315 $modulepartsuffix = str_replace('tax-', '', $modulepart);
3316 $original_file = $conf->tax->dir_output.'/'.($modulepartsuffix != 'tax' ? $modulepartsuffix.'/' : '').$original_file;
3317 } elseif (($modulepart == 'actions' || $modulepart == 'actioncomm') && !empty($conf->agenda->dir_output)) {
3318 // Wrapping for events
3319 if ($fuser->hasRight('agenda', 'myactions', $read)) {
3320 $accessallowed = 1;
3321 // If we known $id of project, call checkUserAccessToObject to check permission on the given agenda event on properties and assigned users
3322 if ($refname && !preg_match('/^specimen/i', $original_file)) {
3323 include_once DOL_DOCUMENT_ROOT.'/comm/action/class/actioncomm.class.php';
3324 $tmpobject = new ActionComm($db);
3325 $tmpobject->fetch((int) $refname);
3326 $accessallowed = checkUserAccessToObject($user, array('agenda'), $tmpobject->id, 'actioncomm&societe', 'myactions|allactions', 'fk_soc', 'id', '');
3327 if ($user->socid && $tmpobject->socid) {
3328 $accessallowed = checkUserAccessToObject($user, array('societe'), $tmpobject->socid);
3329 }
3330 }
3331 }
3332 $original_file = $conf->agenda->dir_output.'/'.$original_file;
3333 } elseif ($modulepart == 'category' && !empty($conf->categorie->multidir_output[$entity])) {
3334 // Wrapping for categories (categories are allowed if user has permission to read categories or to work on TakePos)
3335 if (empty($entity) || empty($conf->categorie->multidir_output[$entity])) {
3336 return array('accessallowed' => 0, 'error' => 'Value entity must be provided');
3337 }
3338 if ($fuser->hasRight("categorie", $lire) || $fuser->hasRight("takepos", "run")) {
3339 $accessallowed = 1;
3340 }
3341 $original_file = $conf->categorie->multidir_output[$entity].'/'.$original_file;
3342 } elseif ($modulepart == 'prelevement' && !empty($conf->prelevement->dir_output)) {
3343 // Wrapping pour les prelevements
3344 if ($fuser->hasRight('prelevement', 'bons', $lire) || preg_match('/^specimen/i', $original_file)) {
3345 $accessallowed = 1;
3346 }
3347 $original_file = $conf->prelevement->dir_output.'/'.$original_file;
3348 } elseif ($modulepart == 'graph_stock' && !empty($conf->stock->dir_temp)) {
3349 // Wrapping pour les graph energie
3350 $accessallowed = 1;
3351 $original_file = $conf->stock->dir_temp.'/'.$original_file;
3352 } elseif ($modulepart == 'graph_fourn' && !empty($conf->fournisseur->dir_temp)) {
3353 // Wrapping pour les graph fournisseurs
3354 $accessallowed = 1;
3355 $original_file = $conf->fournisseur->dir_temp.'/'.$original_file;
3356 } elseif ($modulepart == 'graph_product' && !empty($conf->product->dir_temp)) {
3357 // Wrapping pour les graph des produits
3358 $accessallowed = 1;
3359 $original_file = $conf->product->multidir_temp[$entity].'/'.$original_file;
3360 } elseif ($modulepart == 'barcode') {
3361 // Wrapping pour les code barre
3362 $accessallowed = 1;
3363 // If viewimage is called for barcode, we try to output an image on the fly, with no build of file on disk.
3364 //$original_file=$conf->barcode->dir_temp.'/'.$original_file;
3365 $original_file = '';
3366 } elseif ($modulepart == 'iconmailing' && !empty($conf->mailing->dir_temp)) {
3367 // Wrapping for icon of background of mailings
3368 $accessallowed = 1;
3369 $original_file = $conf->mailing->dir_temp.'/'.$original_file;
3370 } elseif ($modulepart == 'scanner_user_temp' && !empty($conf->scanner->dir_temp)) {
3371 // Wrapping pour le scanner
3372 $accessallowed = 1;
3373 $original_file = $conf->scanner->dir_temp.'/'.$fuser->id.'/'.$original_file;
3374 } elseif ($modulepart == 'fckeditor' && !empty($conf->fckeditor->dir_output)) {
3375 // Wrapping pour les images fckeditor
3376 $accessallowed = 1;
3377 $original_file = $conf->fckeditor->dir_output.'/'.$original_file;
3378 } elseif ($modulepart == 'user' && !empty($conf->user->dir_output)) {
3379 // Wrapping for users
3380 $canreaduser = (!empty($fuser->admin) || $fuser->hasRight('user', 'user', $lire));
3381 if ($fuser->id == (int) $refname) {
3382 $canreaduser = 1;
3383 } // A user can always read its own card
3384 if ($canreaduser || preg_match('/^specimen/i', $original_file)) {
3385 $accessallowed = 1;
3386 }
3387 $original_file = $conf->user->dir_output.'/'.$original_file;
3388 } elseif (($modulepart == 'company' || $modulepart == 'societe' || $modulepart == 'thirdparty') && !empty($conf->societe->multidir_output[$entity])) {
3389 // Wrapping for third parties
3390 if (empty($entity) || empty($conf->societe->multidir_output[$entity])) {
3391 return array('accessallowed' => 0, 'error' => 'Value entity must be provided');
3392 }
3393 if ($fuser->hasRight('societe', $lire) || preg_match('/^specimen/i', $original_file)) {
3394 $accessallowed = 1;
3395 }
3396 $original_file = $conf->societe->multidir_output[$entity].'/'.$original_file;
3397 $sqlprotectagainstexternals = "SELECT rowid as fk_soc FROM ".MAIN_DB_PREFIX."societe WHERE rowid='".$db->escape($refname)."' AND entity IN (".getEntity('societe').")";
3398 } elseif (($modulepart == 'contact' || $modulepart == 'socpeople') && !empty($conf->societe->multidir_output[$entity])) {
3399 // Wrapping for contact
3400 if (empty($entity) || empty($conf->societe->multidir_output[$entity])) {
3401 return array('accessallowed' => 0, 'error' => 'Value entity must be provided');
3402 }
3403 if ($fuser->hasRight('societe', $lire)) {
3404 $accessallowed = 1;
3405 }
3406 $original_file = $conf->societe->multidir_output[$entity].'/contact/'.$original_file;
3407 } elseif (($modulepart == 'facture' || $modulepart == 'invoice') && !empty($conf->invoice->multidir_output[$entity])) {
3408 // Wrapping for invoices
3409 if ($fuser->hasRight('facture', $lire) || preg_match('/^specimen/i', $original_file)) {
3410 $accessallowed = 1;
3411 }
3412 $original_file = $conf->invoice->multidir_output[$entity].'/'.$original_file;
3413 $sqlprotectagainstexternals = "SELECT fk_soc as fk_soc FROM ".MAIN_DB_PREFIX."facture WHERE ref='".$db->escape($refname)."' AND entity IN (".getEntity('invoice').")";
3414 } elseif ($modulepart == 'massfilesarea_proposals' && !empty($conf->propal->multidir_output[$entity])) {
3415 // Wrapping for mass actions
3416 if ($fuser->hasRight('propal', $lire) || preg_match('/^specimen/i', $original_file)) {
3417 $accessallowed = 1;
3418 }
3419 $original_file = $conf->propal->multidir_output[$entity].'/temp/massgeneration/'.$user->id.'/'.$original_file;
3420 } elseif ($modulepart == 'massfilesarea_orders') {
3421 if ($fuser->hasRight('commande', $lire) || preg_match('/^specimen/i', $original_file)) {
3422 $accessallowed = 1;
3423 }
3424 $original_file = $conf->order->multidir_output[$entity].'/temp/massgeneration/'.$user->id.'/'.$original_file;
3425 } elseif ($modulepart == 'massfilesarea_sendings') {
3426 if ($fuser->hasRight('expedition', $lire) || preg_match('/^specimen/i', $original_file)) {
3427 $accessallowed = 1;
3428 }
3429 $original_file = $conf->expedition->dir_output.'/sending/temp/massgeneration/'.$user->id.'/'.$original_file;
3430 } elseif ($modulepart == 'massfilesarea_receipts') {
3431 if ($fuser->hasRight('reception', $lire) || preg_match('/^specimen/i', $original_file)) {
3432 $accessallowed = 1;
3433 }
3434 $original_file = $conf->reception->dir_output.'/temp/massgeneration/'.$user->id.'/'.$original_file;
3435 } elseif ($modulepart == 'massfilesarea_invoices') {
3436 if ($fuser->hasRight('facture', $lire) || preg_match('/^specimen/i', $original_file)) {
3437 $accessallowed = 1;
3438 }
3439 $original_file = $conf->invoice->multidir_output[$entity].'/temp/massgeneration/'.$user->id.'/'.$original_file;
3440 } elseif ($modulepart == 'massfilesarea_expensereport') {
3441 if ($fuser->hasRight('facture', $lire) || preg_match('/^specimen/i', $original_file)) {
3442 $accessallowed = 1;
3443 }
3444 $original_file = $conf->expensereport->dir_output.'/temp/massgeneration/'.$user->id.'/'.$original_file;
3445 } elseif ($modulepart == 'massfilesarea_interventions') {
3446 if ($fuser->hasRight('ficheinter', $lire) || preg_match('/^specimen/i', $original_file)) {
3447 $accessallowed = 1;
3448 }
3449 $original_file = $conf->ficheinter->dir_output.'/temp/massgeneration/'.$user->id.'/'.$original_file;
3450 } elseif ($modulepart == 'massfilesarea_supplier_proposal' && !empty($conf->supplier_proposal->dir_output)) {
3451 if ($fuser->hasRight('supplier_proposal', $lire) || preg_match('/^specimen/i', $original_file)) {
3452 $accessallowed = 1;
3453 }
3454 $original_file = $conf->supplier_proposal->dir_output.'/temp/massgeneration/'.$user->id.'/'.$original_file;
3455 } elseif ($modulepart == 'massfilesarea_supplier_order') {
3456 if ($fuser->hasRight('fournisseur', 'commande', $lire) || preg_match('/^specimen/i', $original_file)) {
3457 $accessallowed = 1;
3458 }
3459 $original_file = $conf->fournisseur->commande->dir_output.'/temp/massgeneration/'.$user->id.'/'.$original_file;
3460 } elseif ($modulepart == 'massfilesarea_supplier_invoice') {
3461 if ($fuser->hasRight('fournisseur', 'facture', $lire) || preg_match('/^specimen/i', $original_file)) {
3462 $accessallowed = 1;
3463 }
3464 $original_file = $conf->fournisseur->facture->dir_output.'/temp/massgeneration/'.$user->id.'/'.$original_file;
3465 } elseif ($modulepart == 'massfilesarea_contract' && !empty($conf->contract->dir_output)) {
3466 if ($fuser->hasRight('contrat', $lire) || preg_match('/^specimen/i', $original_file)) {
3467 $accessallowed = 1;
3468 }
3469 $original_file = $conf->contract->dir_output.'/temp/massgeneration/'.$user->id.'/'.$original_file;
3470 } elseif ($modulepart == 'massfilesarea_stock' && !empty($conf->stock->dir_output)) {
3471 if ($fuser->hasRight('stock', $lire) || preg_match('/^specimen/i', $original_file)) {
3472 $accessallowed = 1;
3473 }
3474 $original_file = $conf->stock->dir_output.'/temp/massgeneration/'.$user->id.'/'.$original_file;
3475 } elseif (($modulepart == 'fichinter' || $modulepart == 'ficheinter') && !empty($conf->ficheinter->dir_output)) {
3476 // Wrapping for interventions
3477 if ($fuser->hasRight('ficheinter', $lire) || preg_match('/^specimen/i', $original_file)) {
3478 $accessallowed = 1;
3479 }
3480 $original_file = $conf->ficheinter->dir_output.'/'.$original_file;
3481 $sqlprotectagainstexternals = "SELECT fk_soc as fk_soc FROM ".MAIN_DB_PREFIX."fichinter WHERE ref='".$db->escape($refname)."' AND entity=".$conf->entity;
3482 } elseif ($modulepart == 'deplacement' && !empty($conf->deplacement->dir_output)) {
3483 // Wrapping pour les deplacements et notes de frais
3484 if ($fuser->hasRight('deplacement', $lire) || preg_match('/^specimen/i', $original_file)) {
3485 $accessallowed = 1;
3486 }
3487 $original_file = $conf->deplacement->dir_output.'/'.$original_file;
3488 //$sqlprotectagainstexternals = "SELECT fk_soc as fk_soc FROM ".MAIN_DB_PREFIX."fichinter WHERE ref='".$db->escape($refname)."' AND entity=".$conf->entity;
3489 } elseif (($modulepart == 'propal' || $modulepart == 'propale') && isset($conf->propal->multidir_output[$entity])) {
3490 // Wrapping pour les propales
3491 if ($fuser->hasRight('propal', $lire) || preg_match('/^specimen/i', $original_file)) {
3492 $accessallowed = 1;
3493 }
3494 $original_file = $conf->propal->multidir_output[$entity].'/'.$original_file;
3495 $sqlprotectagainstexternals = "SELECT fk_soc as fk_soc FROM ".MAIN_DB_PREFIX."propal WHERE ref='".$db->escape($refname)."' AND entity IN (".getEntity('propal').")";
3496 } elseif (($modulepart == 'commande' || $modulepart == 'order') && !empty($conf->order->multidir_output[$entity])) {
3497 // Wrapping pour les commandes
3498 if ($fuser->hasRight('commande', $lire) || preg_match('/^specimen/i', $original_file)) {
3499 $accessallowed = 1;
3500 }
3501 $original_file = $conf->order->multidir_output[$entity].'/'.$original_file;
3502 $sqlprotectagainstexternals = "SELECT fk_soc as fk_soc FROM ".MAIN_DB_PREFIX."commande WHERE ref='".$db->escape($refname)."' AND entity IN (".getEntity('order').")";
3503 } elseif ($modulepart == 'project' && !empty($conf->project->multidir_output[$entity])) {
3504 // Wrapping pour les projects
3505 if ($fuser->hasRight('projet', $lire) || preg_match('/^specimen/i', $original_file)) {
3506 $accessallowed = 1;
3507 // If we known $id of project, call checkUserAccessToObject to check permission on properties and contact of project
3508 if ($refname && !preg_match('/^specimen/i', $original_file)) {
3509 include_once DOL_DOCUMENT_ROOT.'/projet/class/project.class.php';
3510 $tmpproject = new Project($db);
3511 $tmpproject->fetch(0, $refname);
3512 $accessallowed = checkUserAccessToObject($user, array('projet'), $tmpproject->id, 'projet&project', '', '', 'rowid', '');
3513 }
3514 }
3515 $original_file = $conf->project->multidir_output[$entity].'/'.$original_file;
3516 $sqlprotectagainstexternals = "SELECT fk_soc as fk_soc FROM ".MAIN_DB_PREFIX."projet WHERE ref='".$db->escape($refname)."' AND entity IN (".getEntity('project').")";
3517 } elseif ($modulepart == 'project_task' && !empty($conf->project->multidir_output[$entity])) {
3518 if ($fuser->hasRight('projet', $lire) || preg_match('/^specimen/i', $original_file)) {
3519 $accessallowed = 1;
3520 // If we known $id of project, call checkUserAccessToObject to check permission on properties and contact of project
3521 if ($refname && !preg_match('/^specimen/i', $original_file)) {
3522 include_once DOL_DOCUMENT_ROOT.'/projet/class/task.class.php';
3523 $tmptask = new Task($db);
3524 $tmptask->fetch(0, $refname);
3525 $accessallowed = checkUserAccessToObject($user, array('projet_task'), $tmptask->id, 'projet_task&project', '', '', 'rowid', '');
3526 }
3527 }
3528 $original_file = $conf->project->multidir_output[$entity].'/'.$original_file;
3529 $sqlprotectagainstexternals = "SELECT fk_soc as fk_soc FROM ".MAIN_DB_PREFIX."projet WHERE ref='".$db->escape($refname)."' AND entity IN (".getEntity('project').")";
3530 } elseif (($modulepart == 'commande_fournisseur' || $modulepart == 'order_supplier') && !empty($conf->fournisseur->commande->dir_output)) {
3531 // Wrapping for purchase orders
3532 if ($fuser->hasRight('fournisseur', 'commande', $lire) || preg_match('/^specimen/i', $original_file)) {
3533 $accessallowed = 1;
3534 }
3535 $original_file = $conf->fournisseur->commande->dir_output.'/'.$original_file;
3536 $sqlprotectagainstexternals = "SELECT fk_soc as fk_soc FROM ".MAIN_DB_PREFIX."commande_fournisseur WHERE ref='".$db->escape($refname)."' AND entity=".$conf->entity;
3537 } elseif (($modulepart == 'facture_fournisseur' || $modulepart == 'invoice_supplier') && !empty($conf->fournisseur->facture->dir_output)) {
3538 // Wrapping for supplier invoices
3539 if ($fuser->hasRight('fournisseur', 'facture', $lire) || preg_match('/^specimen/i', $original_file)) {
3540 $accessallowed = 1;
3541 }
3542 $original_file = $conf->fournisseur->facture->dir_output.'/'.$original_file;
3543 $sqlprotectagainstexternals = "SELECT fk_soc as fk_soc FROM ".MAIN_DB_PREFIX."facture_fourn WHERE ref='".$db->escape($refname)."' AND entity=".$conf->entity;
3544 } elseif ($modulepart == 'supplier_payment') {
3545 // Wrapping for supplier payments
3546 if ($fuser->hasRight('fournisseur', 'facture', $lire) || preg_match('/^specimen/i', $original_file)) {
3547 $accessallowed = 1;
3548 }
3549 $original_file = preg_replace("/payment\//", "", $original_file); // Because the $conf->fournisseur->payment->dir_output already contains the "payment/"
3550 $original_file = $conf->fournisseur->payment->dir_output.'/'.$original_file;
3551 $sqlprotectagainstexternals = "SELECT fk_soc as fk_soc FROM ".MAIN_DB_PREFIX."paiementfournisseur WHERE ref='".$db->escape($refname)."' AND entity=".$conf->entity;
3552 } elseif ($modulepart == 'payment') {
3553 // Wrapping for report of payments
3554 if ($fuser->hasRight('facture', $lire) || preg_match('/^specimen/i', $original_file)) {
3555 $accessallowed = 1;
3556 }
3557 $original_file = $conf->compta->payment->dir_output.'/'.$original_file;
3558 } elseif ($modulepart == 'facture_paiement' && !empty($conf->invoice->dir_output)) {
3559 // Wrapping for report of payments
3560 if ($fuser->hasRight('facture', $lire) || preg_match('/^specimen/i', $original_file)) {
3561 $accessallowed = 1;
3562 }
3563 if ($fuser->socid > 0) {
3564 $original_file = $conf->invoice->dir_output.'/payments/private/'.$fuser->id.'/'.$original_file;
3565 } else {
3566 $original_file = $conf->invoice->dir_output.'/payments/'.$original_file;
3567 }
3568 } elseif ($modulepart == 'export_compta' && !empty($conf->accounting->dir_output)) {
3569 // Wrapping for accounting exports
3570 if ($fuser->hasRight('accounting', 'bind', 'write') || preg_match('/^specimen/i', $original_file)) {
3571 $accessallowed = 1;
3572 }
3573 $original_file = $conf->accounting->dir_output.'/'.$original_file;
3574 } elseif (($modulepart == 'expedition' || $modulepart == 'shipment' || $modulepart == 'shipping') && !empty($conf->expedition->dir_output)) {
3575 // Wrapping pour les expedition
3576 if ($fuser->hasRight('expedition', $lire) || preg_match('/^specimen/i', $original_file)) {
3577 $accessallowed = 1;
3578 }
3579 $original_file = $conf->expedition->dir_output."/".(strpos($original_file, 'sending/') === 0 ? '' : 'sending/').$original_file;
3580 //$original_file = $conf->expedition->dir_output."/".$original_file;
3581 } elseif (($modulepart == 'livraison' || $modulepart == 'delivery') && !empty($conf->expedition->dir_output)) {
3582 // Delivery Note Wrapping
3583 if ($fuser->hasRight('expedition', 'delivery', $lire) || preg_match('/^specimen/i', $original_file)) {
3584 $accessallowed = 1;
3585 }
3586 $original_file = $conf->expedition->dir_output."/".(strpos($original_file, 'receipt/') === 0 ? '' : 'receipt/').$original_file;
3587 } elseif ($modulepart == 'actionsreport' && !empty($conf->agenda->dir_temp)) {
3588 // Wrapping for actions
3589 if ($fuser->hasRight('agenda', 'allactions', $read) || preg_match('/^specimen/i', $original_file)) {
3590 $accessallowed = 1;
3591 }
3592 $original_file = $conf->agenda->dir_temp."/".$original_file;
3593 } elseif ($modulepart == 'product' || $modulepart == 'produit' || $modulepart == 'service' || $modulepart == 'produit|service') {
3594 // Wrapping for products and services
3595 if (empty($entity) || (empty($conf->product->multidir_output[$entity]) && empty($conf->service->multidir_output[$entity]))) {
3596 return array('accessallowed' => 0, 'error' => 'Value entity must be provided');
3597 }
3598 if (($fuser->hasRight('produit', $lire) || $fuser->hasRight('service', $lire)) || preg_match('/^specimen/i', $original_file)) {
3599 $accessallowed = 1;
3600 }
3601 if (isModEnabled("product")) {
3602 $original_file = $conf->product->multidir_output[$entity].'/'.$original_file;
3603 } elseif (isModEnabled("service")) {
3604 $original_file = $conf->service->multidir_output[$entity].'/'.$original_file;
3605 }
3606 } elseif ($modulepart == 'product_batch' || $modulepart == 'produitlot') {
3607 // Wrapping for product lots
3608 if (empty($entity) || (empty($conf->productbatch->multidir_output[$entity]))) {
3609 return array('accessallowed' => 0, 'error' => 'Value entity must be provided');
3610 }
3611 if (($fuser->hasRight('produit', $lire)) || preg_match('/^specimen/i', $original_file)) {
3612 $accessallowed = 1;
3613 }
3614 if (isModEnabled('productbatch')) {
3615 $original_file = $conf->productbatch->multidir_output[$entity].'/'.$original_file;
3616 }
3617 } elseif ($modulepart == 'movement' || $modulepart == 'mouvement') {
3618 // Wrapping for stock movements
3619 if (empty($entity) || empty($conf->stock->multidir_output[$entity])) {
3620 return array('accessallowed' => 0, 'error' => 'Value entity must be provided');
3621 }
3622 if (($fuser->hasRight('stock', $lire) || $fuser->hasRight('stock', 'movement', $lire) || $fuser->hasRight('stock', 'mouvement', $lire)) || preg_match('/^specimen/i', $original_file)) {
3623 $accessallowed = 1;
3624 }
3625 if (isModEnabled('stock')) {
3626 $original_file = $conf->stock->multidir_output[$entity].'/movement/'.$original_file;
3627 }
3628 } elseif ($modulepart == 'entrepot') {
3629 // Wrapping for stock warehouse
3630 if (empty($entity) || empty($conf->stock->multidir_output[$entity])) {
3631 return array('accessallowed' => 0, 'error' => 'Value entity must be provided');
3632 }
3633 if (($fuser->hasRight('stock', $lire) || $fuser->hasRight('stock', 'movement', $lire) || $fuser->hasRight('stock', 'mouvement', $lire)) || preg_match('/^specimen/i', $original_file)) {
3634 $accessallowed = 1;
3635 }
3636 if (isModEnabled('stock')) {
3637 $original_file = $conf->stock->multidir_output[$entity].'/'.$original_file;
3638 }
3639 } elseif ($modulepart == 'contract' && !empty($conf->contract->multidir_output[$entity])) {
3640 // Wrapping for contracts
3641 if ($fuser->hasRight('contrat', $lire) || preg_match('/^specimen/i', $original_file)) {
3642 $accessallowed = 1;
3643 }
3644 $original_file = $conf->contract->multidir_output[$entity].'/'.$original_file;
3645 $sqlprotectagainstexternals = "SELECT fk_soc as fk_soc FROM ".MAIN_DB_PREFIX."contrat WHERE ref='".$db->escape($refname)."' AND entity IN (".getEntity('contract').")";
3646 } elseif ($modulepart == 'donation' && !empty($conf->don->dir_output)) {
3647 // Wrapping for donation
3648 if ($fuser->hasRight('don', $lire) || preg_match('/^specimen/i', $original_file)) {
3649 $accessallowed = 1;
3650 }
3651 $original_file = $conf->don->dir_output.'/'.$original_file;
3652 } elseif ($modulepart == 'dolresource' && !empty($conf->resource->dir_output)) {
3653 // Wrapping for resources
3654 if ($fuser->hasRight('resource', $read) || preg_match('/^specimen/i', $original_file)) {
3655 $accessallowed = 1;
3656 }
3657 $original_file = $conf->resource->dir_output.'/'.$original_file;
3658 } elseif (($modulepart == 'remisecheque' || $modulepart == 'chequereceipt') && !empty($conf->bank->dir_output)) {
3659 // Wrapping pour les remises de cheques
3660 if ($fuser->hasRight('banque', $lire) || preg_match('/^specimen/i', $original_file)) {
3661 $accessallowed = 1;
3662 }
3663 $original_file = $conf->bank->dir_output.'/checkdeposits/'.$original_file; // original_file should contains relative path so include the get_exdir result
3664 } elseif (($modulepart == 'banque' || $modulepart == 'bank') && !empty($conf->bank->dir_output)) {
3665 // Wrapping for bank
3666 if ($fuser->hasRight('banque', $lire)) {
3667 $accessallowed = 1;
3668 }
3669 $original_file = $conf->bank->dir_output.'/'.$original_file;
3670 } elseif ($modulepart == 'export' && !empty($conf->export->dir_temp)) {
3671 // Wrapping for export module
3672 // Note that a test may not be required because we force the dir of download on the directory of the user that export
3673 $accessallowed = $user->hasRight('export', 'lire');
3674 $original_file = $conf->export->dir_temp.'/'.$fuser->id.'/'.$original_file;
3675 } elseif ($modulepart == 'import' && !empty($conf->import->dir_temp)) {
3676 // Wrapping for import module
3677 $accessallowed = $user->hasRight('import', 'run');
3678 $original_file = $conf->import->dir_temp.'/'.$original_file;
3679 } elseif ($modulepart == 'recruitment' && !empty($conf->recruitment->dir_output)) {
3680 // Wrapping for recruitment module
3681 $accessallowed = $user->hasRight('recruitment', 'recruitmentjobposition', 'read');
3682 $original_file = $conf->recruitment->dir_output.'/'.$original_file;
3683 } elseif ($modulepart == 'hrm' && !empty($conf->hrm->dir_output)) {
3684 // Wrapping for hrm module
3685 $accessallowed = $user->hasRight('hrm', 'all', 'read');
3686 $original_file = $conf->hrm->dir_output.'/'.$original_file;
3687 } elseif ($modulepart == 'editor' && !empty($conf->fckeditor->dir_output)) {
3688 // Wrapping for wysiwyg editor
3689 $accessallowed = 1;
3690 $original_file = $conf->fckeditor->dir_output.'/'.$original_file;
3691 } elseif ($modulepart == 'systemtools' && !empty($conf->admin->dir_output)) {
3692 // Wrapping for backups
3693 if ($fuser->admin) {
3694 $accessallowed = 1;
3695 }
3696 $original_file = $conf->admin->dir_output.'/'.$original_file;
3697 } elseif ($modulepart == 'admin_temp' && !empty($conf->admin->dir_temp)) {
3698 // Wrapping for upload file test
3699 if ($fuser->admin) {
3700 $accessallowed = 1;
3701 }
3702 $original_file = $conf->admin->dir_temp.'/'.$original_file;
3703 } elseif ($modulepart == 'bittorrent' && !empty($conf->bittorrent->dir_output)) {
3704 // Wrapping pour BitTorrent
3705 $accessallowed = 1;
3706 $dir = 'files';
3707 if (dol_mimetype($original_file) == 'application/x-bittorrent') {
3708 $dir = 'torrents';
3709 }
3710 $original_file = $conf->bittorrent->dir_output.'/'.$dir.'/'.$original_file;
3711 } elseif ($modulepart == 'member' && !empty($conf->member->dir_output)) {
3712 // Wrapping pour Foundation module
3713 if ($fuser->hasRight('adherent', $lire) || preg_match('/^specimen/i', $original_file)) {
3714 $accessallowed = 1;
3715 }
3716 $original_file = $conf->member->dir_output.'/'.$original_file;
3717 } elseif ($modulepart == 'ticket' && !empty($conf->ticket->multidir_output[$entity])) {
3718 // Wrapping for events
3719 if ($fuser->hasRight('ticket', $read)) {
3720 $accessallowed = 1;
3721 }
3722 if (!isset($_SESSION['email_customer'])) {
3723 $sqlprotectagainstexternals = '';
3724 } else {
3725 $email_split = explode('@', $_SESSION['email_customer']);
3726
3727 $sqlprotectagainstexternals = 'SELECT t.rowid, t.fk_soc FROM '.MAIN_DB_PREFIX.'ticket t';
3728 $sqlprotectagainstexternals .= ' LEFT JOIN '.MAIN_DB_PREFIX.'element_contact ec ON ec.element_id = t.rowid';
3729 $sqlprotectagainstexternals .= ' LEFT JOIN '.MAIN_DB_PREFIX.'socpeople c ON c.rowid = ec.fk_socpeople';
3730 $sqlprotectagainstexternals .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_type_contact tc ON tc.element = "ticket" AND tc.rowid = ec.fk_c_type_contact';
3731 $sqlprotectagainstexternals .= ' WHERE t.ref LIKE "'.$db->sanitize($refname).'"';
3732 $sqlprotectagainstexternals .= ' AND (';
3733 $sqlprotectagainstexternals .= ' (';
3734 $sqlprotectagainstexternals .= ' tc.rowid IS NOT NULL';
3735 $sqlprotectagainstexternals .= ' AND c.email = "'.$db->sanitize($email_split[0]).'@'.$db->sanitize($email_split[1]).'"';
3736 $sqlprotectagainstexternals .= ' )';
3737 $sqlprotectagainstexternals .= ' OR t.origin_email = "'.$db->sanitize($email_split[0]).'@'.$db->sanitize($email_split[1]).'"';
3738 $sqlprotectagainstexternals .= ' )';
3739 }
3740 $original_file = $conf->ticket->multidir_output[$entity].'/'.$original_file;
3741 // If modulepart=module_user_temp Allows any module to open a file if file is in directory called DOL_DATA_ROOT/modulepart/temp/iduser
3742 // If modulepart=module_temp Allows any module to open a file if file is in directory called DOL_DATA_ROOT/modulepart/temp
3743 // If modulepart=module_user Allows any module to open a file if file is in directory called DOL_DATA_ROOT/modulepart/iduser
3744 // If modulepart=module Allows any module to open a file if file is in directory called DOL_DATA_ROOT/modulepart
3745 // If modulepart=module-abc Allows any module to open a file if file is in directory called DOL_DATA_ROOT/modulepart
3746 } else {
3747 // GENERIC Wrapping
3748 //var_dump($modulepart);
3749 //var_dump($original_file);
3750 if (preg_match('/^specimen/i', $original_file)) {
3751 $accessallowed = 1; // If link to a file called specimen. Test must be done before changing $original_file int full path.
3752 }
3753 if ($fuser->admin) {
3754 $accessallowed = 1; // If user is admin
3755 }
3756
3757 $tmpmodulepart = explode('-', $modulepart);
3758 if (!empty($tmpmodulepart[1])) {
3759 $modulepart = $tmpmodulepart[0];
3760 $original_file = $tmpmodulepart[1].'/'.$original_file;
3761 }
3762
3763 // Define $accessallowed
3764 $reg = array();
3765 if (preg_match('/^([a-z]+)_user_temp$/i', $modulepart, $reg)) {
3766 $tmpmodule = $reg[1];
3767 if (empty($conf->$tmpmodule->dir_temp)) { // modulepart not supported
3768 dol_print_error(null, 'Error call dol_check_secure_access_document with not supported value for modulepart parameter ('.$modulepart.')');
3769 exit;
3770 }
3771 if ($fuser->hasRight($tmpmodule, $lire) || $fuser->hasRight($tmpmodule, $read) || $fuser->hasRight($tmpmodule, $download)) {
3772 $accessallowed = 1;
3773 }
3774 $original_file = $conf->{$reg[1]}->dir_temp.'/'.$fuser->id.'/'.$original_file;
3775 } elseif (preg_match('/^([a-z]+)_temp$/i', $modulepart, $reg)) {
3776 $tmpmodule = $reg[1];
3777 if (empty($conf->$tmpmodule->dir_temp)) { // modulepart not supported
3778 dol_print_error(null, 'Error call dol_check_secure_access_document with not supported value for modulepart parameter ('.$modulepart.')');
3779 exit;
3780 }
3781 if ($fuser->hasRight($tmpmodule, $lire) || $fuser->hasRight($tmpmodule, $read) || $fuser->hasRight($tmpmodule, $download)) {
3782 $accessallowed = 1;
3783 }
3784 $original_file = $conf->$tmpmodule->dir_temp.'/'.$original_file;
3785 } elseif (preg_match('/^([a-z]+)_user$/i', $modulepart, $reg)) {
3786 $tmpmodule = $reg[1];
3787 if (empty($conf->$tmpmodule->dir_output)) { // modulepart not supported
3788 dol_print_error(null, 'Error call dol_check_secure_access_document with not supported value for modulepart parameter ('.$modulepart.')');
3789 exit;
3790 }
3791 if ($fuser->hasRight($tmpmodule, $lire) || $fuser->hasRight($tmpmodule, $read) || $fuser->hasRight($tmpmodule, $download)) {
3792 $accessallowed = 1;
3793 }
3794 $original_file = $conf->$tmpmodule->dir_output.'/'.$fuser->id.'/'.$original_file;
3795 } elseif (preg_match('/^massfilesarea_([a-z]+)$/i', $modulepart, $reg)) {
3796 $tmpmodule = $reg[1];
3797 if (empty($conf->$tmpmodule->dir_output)) { // modulepart not supported
3798 dol_print_error(null, 'Error call dol_check_secure_access_document with not supported value for modulepart parameter ('.$modulepart.')');
3799 exit;
3800 }
3801
3802 // Check fuser->rights->modulepart->myobject->read and fuser->rights->modulepart->read
3803 $partsofdirinoriginalfile = explode('/', $original_file);
3804 if (!empty($partsofdirinoriginalfile[1])) { // If original_file is xxx/filename (xxx is a part we will use)
3805 $partofdirinoriginalfile = $partsofdirinoriginalfile[0];
3806 if (($partofdirinoriginalfile && $fuser->hasRight($tmpmodule, $partofdirinoriginalfile, 'read')) || preg_match('/^specimen/i', $original_file)) {
3807 $accessallowed = 1;
3808 }
3809 }
3810 if ($fuser->hasRight($tmpmodule, $read) || preg_match('/^specimen/i', $original_file)) {
3811 $accessallowed = 1;
3812 }
3813 $original_file = $conf->$tmpmodule->dir_output.'/temp/massgeneration/'.$user->id.'/'.$original_file;
3814 } else {
3815 if (empty($conf->$modulepart->dir_output)) { // modulepart not supported
3816 dol_print_error(null, 'Error call dol_check_secure_access_document with not supported value for modulepart parameter ('.$modulepart.'). The module for this modulepart value may not be activated.');
3817 exit;
3818 }
3819
3820 // Check fuser->hasRight('modulepart', 'myobject', 'read') and fuser->hasRight('modulepart', 'read')
3821 $partsofdirinoriginalfile = explode('/', $original_file);
3822 if (!empty($partsofdirinoriginalfile[1])) { // If original_file is xxx/filename (xxx is a part we will use)
3823 $partofdirinoriginalfile = $partsofdirinoriginalfile[0];
3824 if ($partofdirinoriginalfile && ($fuser->hasRight($modulepart, $partofdirinoriginalfile, 'lire') || $fuser->hasRight($modulepart, $partofdirinoriginalfile, 'read'))) {
3825 $accessallowed = 1;
3826 }
3827 }
3828 if (($fuser->hasRight($modulepart, $lire) || $fuser->hasRight($modulepart, $read)) || ($fuser->hasRight($modulepart, 'all', $lire) || $fuser->hasRight($modulepart, 'all', $read))) {
3829 $accessallowed = 1;
3830 }
3831
3832 if (is_array($conf->$modulepart->multidir_output) && !empty($conf->$modulepart->multidir_output[$entity])) {
3833 $original_file = $conf->$modulepart->multidir_output[$entity].'/'.$original_file;
3834 } else {
3835 $original_file = $conf->$modulepart->dir_output.'/'.$original_file;
3836 }
3837 }
3838
3839 $parameters = array(
3840 'modulepart' => $modulepart,
3841 'original_file' => $original_file,
3842 'entity' => $entity,
3843 'fuser' => $fuser,
3844 'refname' => '',
3845 'mode' => $mode
3846 );
3847 $reshook = $hookmanager->executeHooks('checkSecureAccess', $parameters, $object);
3848 if ($reshook > 0) {
3849 if (!empty($hookmanager->resArray['original_file'])) {
3850 $original_file = $hookmanager->resArray['original_file'];
3851 }
3852 if (!empty($hookmanager->resArray['accessallowed'])) {
3853 $accessallowed = $hookmanager->resArray['accessallowed'];
3854 }
3855 if (!empty($hookmanager->resArray['sqlprotectagainstexternals'])) {
3856 $sqlprotectagainstexternals = $hookmanager->resArray['sqlprotectagainstexternals'];
3857 }
3858 }
3859 }
3860
3861 $ret = array(
3862 'accessallowed' => ($accessallowed ? 1 : 0),
3863 'sqlprotectagainstexternals' => $sqlprotectagainstexternals,
3864 'original_file' => $original_file
3865 );
3866
3867 return $ret;
3868}
3869
3878function dol_filecache($directory, $filename, $object)
3879{
3880 if (!dol_is_dir($directory)) {
3881 $result = dol_mkdir($directory);
3882 if ($result < -1) {
3883 dol_syslog("Failed to create the cache directory ".$directory, LOG_WARNING);
3884 }
3885 }
3886 $cachefile = $directory.$filename;
3887
3888 file_put_contents($cachefile, json_encode($object), LOCK_EX);
3889 dolChmod($cachefile);
3890}
3891
3900function dol_cache_refresh($directory, $filename, $cachetime)
3901{
3902 $now = dol_now();
3903 $cachefile = $directory.$filename;
3904 $refresh = !file_exists($cachefile) || ($now - $cachetime) > dol_filemtime($cachefile);
3905 return $refresh;
3906}
3907
3915function dol_readcachefile($directory, $filename)
3916{
3917 $cachefile = $directory.$filename;
3918 $object = json_decode(file_get_contents($cachefile));
3919 return $object;
3920}
3921
3928function dirbasename($pathfile)
3929{
3930 return preg_replace('/^'.preg_quote(DOL_DATA_ROOT, '/').'\//', '', $pathfile);
3931}
3932
3933
3945function getFilesUpdated(&$file_list, SimpleXMLElement $dir, $path = '', $pathref = '', &$checksumconcat = array())
3946{
3947 global $conffile;
3948
3949 //$exclude = 'install';
3950
3951 $entry = array();
3952 $algo = '';
3953 if (!empty($dir->md5file)) {
3954 $entry = $dir->md5file;
3955 $algo = 'md5';
3956 } elseif (!empty($dir->sha256file)) {
3957 $entry = $dir->sha256file;
3958 $algo = 'sha256';
3959 }
3960
3961 foreach ($entry as $file) { // $file is a simpleXMLElement
3962 $filename = $path.$file['name'];
3963 $file_list['insignature'][] = $filename;
3964 $expectedsize = (empty($file['size']) ? '' : $file['size']);
3965 $expectedhash = (string) $file;
3966
3967 if (!file_exists($pathref.'/'.$filename)) {
3968 $file_list['missing'][] = array('filename' => $filename, 'expectedhash' => $expectedhash, 'expectedsize' => $expectedsize, 'algo' => (string) $algo);
3969 } else {
3970 $hash_local = hash_file($algo, $pathref.'/'.$filename);
3971
3972 if ($conffile == '/etc/dolibarr/conf.php' && $filename == '/filefunc.inc.php') { // For install with deb or rpm, we ignore test on filefunc.inc.php that was modified by package
3973 $checksumconcat[] = $expectedhash;
3974 } else {
3975 if ($hash_local != $expectedhash) {
3976 $file_list['updated'][] = array('filename' => $filename, 'expectedhash' => $expectedhash, 'expectedsize' => $expectedsize, 'hash' => (string) $hash_local, 'algo' => (string) $algo);
3977 }
3978 $checksumconcat[] = $hash_local;
3979 }
3980 }
3981 }
3982
3983 foreach ($dir->dir as $subdir) { // $subdir['name'] is '' or '/accountancy/admin' for example
3984 getFilesUpdated($file_list, $subdir, $path.$subdir['name'].'/', $pathref, $checksumconcat);
3985 }
3986
3987 return $file_list;
3988}
3989
3997function dragAndDropFileUpload($htmlname)
3998{
3999 global $object, $langs;
4000
4001 $out = "";
4002 $out .= '<div id="'.$htmlname.'Message" class="dragDropAreaMessage hidden"><span>'.img_picto("", 'download').'<br>'.$langs->trans("DropFileToAddItToObject").'</span></div>';
4003 $out .= "\n<!-- JS CODE TO ENABLE DRAG AND DROP OF FILE -->\n";
4004 $out .= "<script>";
4005 $out .= '
4006 jQuery(document).ready(function() {
4007 var enterTargetDragDrop = null;
4008
4009 $("#'.$htmlname.'").addClass("cssDragDropArea");
4010
4011 $(".cssDragDropArea").on("dragenter", function(ev, ui) {
4012 var dataTransfer = ev.originalEvent.dataTransfer;
4013 var dataTypes = dataTransfer.types;
4014 //console.log(dataTransfer);
4015 //console.log(dataTypes);
4016
4017 if (!dataTypes || ($.inArray(\'Files\', dataTypes) === -1)) {
4018 // The element dragged is not a file, so we avoid the "dragenter"
4019 ev.preventDefault();
4020 return false;
4021 }
4022
4023 // Entering drop area. Highlight area
4024 console.log("dragAndDropFileUpload: We add class highlightDragDropArea")
4025 enterTargetDragDrop = ev.target;
4026 $(this).addClass("highlightDragDropArea");
4027 $("#'.$htmlname.'Message").removeClass("hidden");
4028 ev.preventDefault();
4029 });
4030
4031 $(".cssDragDropArea").on("dragleave", function(ev) {
4032 // Going out of drop area. Remove Highlight
4033 if (enterTargetDragDrop == ev.target){
4034 console.log("dragAndDropFileUpload: We remove class highlightDragDropArea")
4035 $("#'.$htmlname.'Message").addClass("hidden");
4036 $(this).removeClass("highlightDragDropArea");
4037 }
4038 });
4039
4040 $(".cssDragDropArea").on("dragover", function(ev) {
4041 ev.preventDefault();
4042 return false;
4043 });
4044
4045 $(".cssDragDropArea").on("drop", function(e) {
4046 console.log("Trigger event file dropped. fk_element='.dol_escape_js((string) $object->id).' element='.dol_escape_js($object->element).'");
4047 e.preventDefault();
4048 fd = new FormData();
4049 fd.append("fk_element", "'.dol_escape_js((string) $object->id).'");
4050 fd.append("element", "'.dol_escape_js($object->element).'");
4051 fd.append("token", "'.currentToken().'");
4052 fd.append("action", "linkit");
4053
4054 var dataTransfer = e.originalEvent.dataTransfer;
4055
4056 if (dataTransfer.files && dataTransfer.files.length){
4057 var droppedFiles = e.originalEvent.dataTransfer.files;
4058 $.each(droppedFiles, function(index,file){
4059 fd.append("files[]", file,file.name)
4060 });
4061 }
4062 $(".cssDragDropArea").removeClass("highlightDragDropArea");
4063 counterdragdrop = 0;
4064 $.ajax({
4065 url: "'.DOL_URL_ROOT.'/core/ajax/fileupload.php",
4066 type: "POST",
4067 processData: false,
4068 contentType: false,
4069 data: fd,
4070 success:function() {
4071 console.log("Uploaded.", arguments);
4072 /* arguments[0] is the json string of files */
4073 /* arguments[1] is the value for variable "success", can be 0 or 1 */
4074 let listoffiles = JSON.parse(arguments[0]);
4075 console.log(listoffiles);
4076 let nboferror = 0;
4077 for (let i = 0; i < listoffiles.length; i++) {
4078 console.log(listoffiles[i].error);
4079 if (listoffiles[i].error) {
4080 nboferror++;
4081 }
4082 }
4083 console.log(nboferror);
4084 if (nboferror > 0) {
4085 window.location.href = "'.$_SERVER["PHP_SELF"].'?id='.dol_escape_js((string) $object->id).'&seteventmessages=ErrorOnAtLeastOneFileUpload:warnings";
4086 } else {
4087 window.location.href = "'.$_SERVER["PHP_SELF"].'?id='.dol_escape_js((string) $object->id).'&seteventmessages=UploadFileDragDropSuccess:mesgs";
4088 }
4089 },
4090 error:function() {
4091 console.log("Error Uploading.", arguments)
4092 if (arguments[0].status == 403) {
4093 window.location.href = "'.$_SERVER["PHP_SELF"].'?id='.dol_escape_js((string) $object->id).'&seteventmessages=ErrorUploadPermissionDenied:errors";
4094 }
4095 window.location.href = "'.$_SERVER["PHP_SELF"].'?id='.dol_escape_js((string) $object->id).'&seteventmessages=ErrorUploadFileDragDropPermissionDenied:errors";
4096 },
4097 })
4098 });
4099 });
4100 ';
4101 $out .= "</script>\n";
4102 return $out;
4103}
4104
4115function archiveOrBackupFile($srcfile, $max_versions = 5, $archivedir = '', $suffix = "v", $moveorcopy = 'move')
4116{
4117 $base_file_pattern = ($archivedir ? $archivedir : dirname($srcfile)).'/'.basename($srcfile).".".$suffix;
4118 $files_in_directory = glob($base_file_pattern . "*");
4119
4120 // Extract the modification timestamps for each file
4121 $files_with_timestamps = [];
4122 foreach ($files_in_directory as $file) {
4123 $files_with_timestamps[] = [
4124 'file' => $file,
4125 'timestamp' => filemtime($file)
4126 ];
4127 }
4128
4129 // Sort the files by modification date
4130 $sorted_files = [];
4131 while (count($files_with_timestamps) > 0) {
4132 $latest_file = null;
4133 $latest_index = null;
4134
4135 // Find the latest file by timestamp
4136 foreach ($files_with_timestamps as $index => $file_info) {
4137 if ($latest_file === null || (is_array($latest_file) && $file_info['timestamp'] > $latest_file['timestamp'])) {
4138 $latest_file = $file_info;
4139 $latest_index = $index;
4140 }
4141 }
4142
4143 // Add the latest file to the sorted list and remove it from the original list
4144 if ($latest_file !== null) {
4145 $sorted_files[] = $latest_file['file'];
4146 unset($files_with_timestamps[$latest_index]);
4147 }
4148 }
4149
4150 // Delete the oldest files to keep only the allowed number of versions
4151 if (count($sorted_files) >= $max_versions) {
4152 $oldest_files = array_slice($sorted_files, $max_versions - 1);
4153 foreach ($oldest_files as $oldest_file) {
4154 dol_delete_file($oldest_file, 0, 0, 0, null, false, 0);
4155 }
4156 }
4157
4158 $timestamp = dol_now('gmt');
4159 $new_backup = $srcfile . ".v" . $timestamp;
4160
4161 // Move or copy the original file to the new backup with the timestamp
4162 if ($moveorcopy == 'move') {
4163 $result = dol_move($srcfile, $new_backup, '0', 1, 0, 0);
4164 } else {
4165 $result = dol_copy($srcfile, $new_backup, '0', 1, 0, 0);
4166 }
4167
4168 if (!$result) {
4169 return false;
4170 }
4171
4172 return true;
4173}
4174
4181function dolDocToText($filetoprocess, $useFullTextIndexation = 'pdftotext', $options = 'html')
4182{
4183 global $conf, $db, $user;
4184
4185 $error = 0;
4186 $keywords = array();
4187 $textforfulltextindex = '';
4188 $cmd = '';
4189
4190 if (empty($useFullTextIndexation)) {
4191 $useFullTextIndexation = 'pdftotext';
4192 }
4193
4194 // TODO Move this into external submodule files
4195
4196 // TODO Develop a native PHP parser using sample code in https://github.com/adeel/php-pdf-parser or https://github.com/smalot/pdfparser
4197 // Use the method pdftotext to generate a HTML
4198 if (preg_match('/pdftotext/i', $useFullTextIndexation)) {
4199 include_once DOL_DOCUMENT_ROOT.'/core/class/utils.class.php';
4200 $utils = new Utils($db);
4201 $outputfile = $conf->admin->dir_temp.'/tmppdftotext.'.$user->id.'.out'; // File used with popen method
4202
4203 // We also exclude '/temp/' dir and 'documents/admin/documents'
4204 // We make escapement here and call executeCLI without escapement because we don't want to have the '*.log' escaped.
4205 if ($options == 'fulltext') {
4206 $params = '-nodiag -layout';
4207 } else {
4208 $params = '-htmlmeta';
4209 }
4210 $cmd = getDolGlobalString('MAIN_SAVE_FILE_CONTENT_AS_TEXT_PDFTOTEXT', 'pdftotext') . " " . $params ." '".escapeshellcmd($filetoprocess)."' - ";
4211 $resultexec = $utils->executeCLI($cmd, $outputfile, 0, null, 1);
4212
4213 if (empty($resultexec['error'])) {
4214 $matches = array();
4215 if ($options == 'fulltext') {
4216 $textforfulltextindex = $resultexec['output'];
4217 }
4218 if ($options == 'html') {
4219 $txt = $resultexec['output'];
4220 if (preg_match('/<meta name="keywords" content="([^\/]+)"\s*\/>/i', $txt, $matches)) {
4221 $keywords = $matches[1];
4222 }
4223 if (preg_match('/<pre>(.*)<\/pre>/si', $txt, $matches)) {
4224 $textforfulltextindex = dol_string_nounprintableascii($matches[1], 0);
4225 }
4226 }
4227 } else {
4228 dol_syslog($resultexec['error']);
4229 $error++;
4230 }
4231 }
4232
4233
4234 // Use the method docling to generate a .md (https://ds4sd.github.io/docling/)
4235 if (preg_match('/docling/i', $useFullTextIndexation)) {
4236 include_once DOL_DOCUMENT_ROOT.'/core/class/utils.class.php';
4237 $utils = new Utils($db);
4238 $outputfile = $conf->admin->dir_temp.'/tmpdocling.'.$user->id.'.out'; // File used with popen method
4239
4240 // We also exclude '/temp/' dir and 'documents/admin/documents'
4241 // We make escapement here and call executeCLI without escapement because we don't want to have the '*.log' escaped.
4242 $cmd = getDolGlobalString('MAIN_SAVE_FILE_CONTENT_AS_TEXT_DOCLING', 'docling')." --from pdf --to text '".escapeshellcmd($filetoprocess)."'";
4243 $resultexec = $utils->executeCLI($cmd, $outputfile, 0, null, 1);
4244
4245 if (!$resultexec['error']) {
4246 $txt = $resultexec['output'];
4247 //$matches = array();
4248 //if (preg_match('/<meta name="Keywords" content="([^\/]+)"\s*\/>/i', $txt, $matches)) {
4249 // $keywords = $matches[1];
4250 //}
4251 //if (preg_match('/<pre>(.*)<\/pre>/si', $txt, $matches)) {
4252 // $textforfulltextindex = dol_string_nounprintableascii($matches[1], 0);
4253 //}
4254 $textforfulltextindex = $txt;
4255 } else {
4256 dol_syslog($resultexec['error']);
4257 $error++;
4258 }
4259 }
4260
4261 return array('error' => $error, 'keywords' => $keywords, 'content' => $textforfulltextindex, 'cmd' => $cmd);
4262}
4263
4270function removeLastLine($fullpath)
4271{
4272 // Generate tmp file content without the last line
4273 $fp = fopen($fullpath, "r");
4274 fseek($fp, -1, SEEK_END);
4275 $pos = -1;
4276 $char = fgetc($fp);
4277 while ($char === "\n" || $char === "\r") { // Go to last real char of last line
4278 fseek($fp, $pos--, SEEK_END);
4279 $char = fgetc($fp);
4280 }
4281 while ($char !== "\n" && $char !== false) {
4282 fseek($fp, $pos--, SEEK_END);
4283 $char = fgetc($fp);
4284 }
4285 /*
4286 while ($char === "\n" || $char === "\r") { // Go to last real char of last-1 line
4287 fseek($fp, $pos--, SEEK_END);
4288 $char = fgetc($fp);
4289 }
4290 */
4291 $truncatePos = ftell($fp);
4292 fclose($fp);
4293 // Truncate the tmp file to remove the last line
4294 $fp = fopen($fullpath, "c+");
4295 ftruncate($fp, $truncatePos);
4296 fclose($fp);
4297
4298 return 1;
4299}
if(! $sortfield) if(! $sortorder) $object
Definition account.php:100
Class to manage agenda events (actions)
Class to scan for virus.
Class to manage ECM files.
Class to manage Trips and Expenses.
Class to manage a HTML form to send a unitary email Usage: $formail = new FormMail($db) $formmail->pr...
Class of the module paid holiday.
Class to manage hooks.
Class to manage projects.
Class to manage tasks.
Class to manage Dolibarr users.
Class to manage utility methods.
if(!isModEnabled('ai')||!getDolGlobalString('AI_ASSISTANT_ENABLED')) global $conf
The main.inc.php has been included so the following variable are now defined:
if(!isModEnabled('ai')||!getDolGlobalString('AI_ASSISTANT_ENABLED')) global $db
API class for accounts.
$conffile
dirbasename($pathfile)
Return the relative dirname (relative to DOL_DATA_ROOT) of a full path string.
dol_move($srcfile, $destfile, $newmask='0', $overwriteifexists=1, $testvirus=0, $indexdatabase=1, $moreinfo=array(), $entity=null)
Move a file into another name.
dol_dir_list_in_database($path, $filter="", $excludefilter=null, $sortcriteria="name", $sortorder=SORT_ASC, $mode=0, $sqlfilters="", $object=null)
Scan a directory and return a list of files/directories.
dol_is_link($pathoffile)
Return if path is a symbolic link.
dol_compare_file($a, $b)
Fast compare of 2 files identified by their properties ->name, ->date and ->size.
removePatternFromFile(string $filePath, string $pattern)
Removes content from a file that matches a given pattern.
dol_meta_create($object)
Create a meta file with document file into same directory.
dol_is_url($uri)
Return if path is an URI (the name of the method is misleading).
dol_basename($pathfile)
Make a basename working with all page code (default PHP basenamed fails with cyrillic).
Definition files.lib.php:39
getFilesUpdated(&$file_list, SimpleXMLElement $dir, $path='', $pathref='', &$checksumconcat=array())
Function to get list of updated or modified files.
dol_filemtime($pathoffile)
Return time of a file.
dol_filesize($pathoffile)
Return size of a file.
dol_copy($srcfile, $destfile, $newmask='0', $overwriteifexists=1, $testvirus=0, $indexdatabase=0)
Copy a file to another file.
dol_add_file_process($upload_dir, $allowoverwrite=0, $updatesessionordb=0, $keyforsourcefile='addedfile', $savingdocmask='', $link=null, $trackid='', $generatethumbs=1, $object=null, $forceFullTextIndexation='', $mode=0)
Get and save an upload file (for example after submitting a new file in a mail form).
completeFileArrayWithDatabaseInfo(&$filearray, $relativedir, $object=null)
Complete $filearray with data from database.
archiveOrBackupFile($srcfile, $max_versions=5, $archivedir='', $suffix="v", $moveorcopy='move')
Manage backup versions for a given file, ensuring only a maximum number of versions are kept.
dol_delete_file($file, $disableglob=0, $nophperrors=0, $nohook=0, $object=null, $allowdotdot=false, $indexdatabase=1, $nolog=0)
Remove a file or several files with a mask.
dol_move_dir($srcdir, $destdir, $overwriteifexists=1, $indexdatabase=1, $renamedircontent=1)
Move a directory into another name.
addFileIntoDatabaseIndex($dir, $file, $fullpathorig='', $mode='uploaded', $setsharekey=0, $object=null, $forceFullTextIndexation='')
Add a file into database index.
dol_fileperm($pathoffile)
Return permissions of a file.
dol_is_writable($folderorfile)
Test if directory or filename is writable.
dol_delete_dir($dir, $nophperrors=0)
Remove a directory (not recursive, so content must be empty).
dol_delete_dir_recursive($dir, $count=0, $nophperrors=0, $onlysub=0, &$countdeleted=0, $indexdatabase=1, $nolog=0, $level=0)
Remove a directory $dir and its subdirectories (or only files and subdirectories)
isRealPdf(string $filePath)
Check if a file is a real PDF file by checking its signature and its MIME type.
dol_uncompress($inputfile, $outputdir)
Uncompress a file.
dol_check_secure_access_document($modulepart, $original_file, $entity, $fuser=null, $refname='', $mode='read')
Security check when accessing to a document (used by document.php, viewimage.php and webservices to g...
dol_init_file_process($pathtoscan='', $trackid='')
Scan a directory and init $_SESSION to manage uploaded files with list of all found files.
dol_convert_file($fileinput, $ext='png', $fileoutput='', $page='')
Convert a PDF file into another image format.
removeLastLine($fullpath)
Remove the last line of a text file.
dol_filecache($directory, $filename, $object)
Store object in file.
dolCopyDir($srcfile, $destfile, $newmask, $overwriteifexists, $arrayreplacement=null, $excludesubdir=0, $excludefileext=null, $excludearchivefiles=0)
Copy a dir to another dir.
dragAndDropFileUpload($htmlname)
Function to manage the drag and drop of a file.
dol_is_file($pathoffile)
Return if path is a file.
dol_count_nb_of_line($file)
Count number of lines in a file.
dolCheckVirus($src_file, $dest_file='')
Check virus into a file.
dol_unescapefile($filename)
Unescape a file submitted by upload.
dolDocToText($filetoprocess, $useFullTextIndexation='pdftotext', $options='html')
dol_dir_is_emtpy($folder)
Test if a folder is empty.
dol_remove_file_process($filenb, $donotupdatesession=0, $donotdeletefile=1, $trackid='')
Remove an uploaded file (for example after submitting a new file a mail form).
dolCheckOnFileName($src_file, $dest_file='')
Check virus into a file.
dol_dir_list($utf8_path, $types="all", $recursive=0, $filter="", $excludefilter=null, $sortcriteria="name", $sortorder=SORT_ASC, $mode=0, $nohook=0, $relativename="", $donotfollowsymlinks=0, $nbsecondsold=0)
Scan a directory and return a list of files/directories.
Definition files.lib.php:64
dol_readcachefile($directory, $filename)
Read object from cachefile.
dol_most_recent_file($dir, $regexfilter='', $excludefilter=array('(\.meta|_preview.*\.png) $', '^\.'), $nohook=0, $mode=0)
Return file(s) into a directory (by default most recent)
dol_is_dir($folder)
Test if filename is a directory.
dol_cache_refresh($directory, $filename, $cachetime)
Test if Refresh needed.
dolReplaceInFile($srcfile, $arrayreplacement, $destfile='', $newmask='0', $indexdatabase=0, $arrayreplacementisregex=0)
Make replacement of strings into a file.
dol_delete_preview($object)
Delete all preview files linked to object instance.
dol_is_dir_empty($dir)
Return if path is empty.
dol_move_uploaded_file($src_file, $dest_file, $allowoverwrite, $disablevirusscan=0, $uploaderrorcode=0, $nohook=0, $keyforsourcefile='addedfile', $upload_dir='', $mode=0)
Check validity of a file upload from an GUI page, and move it to its final destination.
deleteFilesIntoDatabaseIndex($dir, $file, $mode='uploaded', $object=null)
Delete files into database index using search criteria.
dol_now($mode='gmt')
Return date for now.
setEventMessages($mesg, $mesgs, $style='mesgs', $messagekey='', $noduplicate=0, $attop=0)
Set event messages in dol_events session object.
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2, $allowothertags=array())
Show picto whatever it's its name (generic function)
GETPOSTINT($paramname, $method=0)
Return the value of a $_GET or $_POST supervariable, converted into integer.
dolGetFirstLineOfText($text, $nboflines=1, $charset='UTF-8')
Return first line of text.
getDolUserInt($key, $default=0, $tmpuser=null)
Return Dolibarr user constant int value.
dol_osencode($str)
Return a string encoded into OS filesystem encoding.
dol_string_nohtmltag($stringtoclean, $removelinefeed=1, $pagecodeto='UTF-8', $strip_tags=0, $removedoublespaces=1)
Clean a string from all HTML tags and entities.
dol_sanitizePathName($str, $newstr='_', $unaccent=0, $allowdash=0)
Clean a string to use it as a path name.
dol_sanitizeFileName($str, $newstr='_', $unaccent=1, $includequotes=0, $allowdash=0)
Clean a string to use it as a file name.
dolChmod($filepath, $newmask='')
Change mod of a file.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
dol_escape_js($stringtoescape, $mode=0, $noescapebackslashn=0)
Returns text escaped for inclusion into JavaScript code.
dol_sort_array(&$array, $index, $order='asc', $natsort=0, $case_sensitive=0, $keepindex=0)
Advanced sort array by the value of a given key, which produces ascending (default) or descending out...
make_substitutions($text, $substitutionarray, $outputlangs=null, $converttextinhtmlifnecessary=0)
Make substitution into a text string, replacing keys with vals from $substitutionarray (oldval=>newva...
GETPOST($paramname, $check='alphanohtml', $method=0, $filter=null, $options=null, $noreplace=0)
Return value of a param into GET or POST supervariable.
dol_string_nounprintableascii($str, $removetabcrlf=1)
Clean a string from all non printable ASCII chars (0x00-0x1F and 0x7F).
dol_print_date($time, $format='', $tzoutput='auto', $outputlangs=null, $encodetooutput=false, $decorate=0)
Output date in a string format according to outputlangs (or langs if not defined).
dol_print_error($db=null, $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
isModEnabled($module)
Is Dolibarr module enabled.
utf8_check($str)
Check if a string is in UTF8.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
getEntity($element, $shared=1, $currentobject=null)
Get list of entity id to use.
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).
if(!defined( 'IMAGETYPE_WEBP')) getDefaultImageSizes()
Return default values for image sizes.
image_format_supported($file, $acceptsvg=0)
Return if a filename is file name of a supported image format.
print $langs trans("Show") . '< td style="' . $timeColor . '" align="center"> s</td > badge status0 badge status4 badge status3 Error badge status8< td align="center">< span class="badge ' . $badge . '"></span ></td >< td align="center">< a href="#" class="button button-small" onclick="openLogModal(this)" data-req="' . dol_escape_htmltag($reqSafe) . '" data-res="' . dol_escape_htmltag($resSafe) . '" data-err="' . dol_escape_htmltag($errSafe) . '">< span class="fa fa-search-plus"></span ></a ></td ></tr >< tr >< td colspan="' . $colspan . '" class="opacitymedium"></td ></tr ></table ></div ></form > logModal none logModal none s a JSON string
buildzip.php
getRandomPassword($generic=false, $replaceambiguouschars=null, $length=32)
Return a generated password using default module.
checkUserAccessToObject($user, array $featuresarray, $object=0, $tableandshare='', $feature2='', $dbt_keyfield='', $dbt_select='rowid', $parenttableforentity='')
Check that access by a given user to an object is ok.
dol_hash($chain, $type='0', $nosalt=0, $mode=0)
Returns a hash (non reversible encryption) of a string.