dolibarr 21.0.0-alpha
document.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2004-2007 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3 * Copyright (C) 2004-2013 Laurent Destailleur <eldy@users.sourceforge.net>
4 * Copyright (C) 2005 Simon Tosser <simon@kornog-computing.com>
5 * Copyright (C) 2005-2012 Regis Houssin <regis.houssin@inodbox.com>
6 * Copyright (C) 2010 Pierre Morin <pierre.morin@auguria.net>
7 * Copyright (C) 2010 Juanjo Menent <jmenent@2byte.es>
8 * Copyright (C) 2022 Ferran Marcet <fmarcet@2byte.es>
9 * Copyright (C) 2024 Frédéric France <frederic.france@free.fr>
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 3 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <https://www.gnu.org/licenses/>.
23 * or see https://www.gnu.org/
24 */
25
35define('MAIN_SECURITY_FORCECSP', "default-src: 'none'");
36
37//if (! defined('NOREQUIREUSER')) define('NOREQUIREUSER','1'); // Not disabled cause need to load personalized language
38//if (! defined('NOREQUIREDB')) define('NOREQUIREDB','1'); // Not disabled cause need to load personalized language
39if (!defined('NOTOKENRENEWAL')) {
40 define('NOTOKENRENEWAL', '1');
41}
42if (!defined('NOREQUIREMENU')) {
43 define('NOREQUIREMENU', '1');
44}
45if (!defined('NOREQUIREHTML')) {
46 define('NOREQUIREHTML', '1');
47}
48if (!defined('NOREQUIREAJAX')) {
49 define('NOREQUIREAJAX', '1');
50}
51
52// For direct external download link, we don't need to load/check we are into a login session
53if (isset($_GET["hashp"]) && !defined("NOLOGIN")) {
54 if (!defined("NOLOGIN")) {
55 define("NOLOGIN", 1);
56 }
57 if (!defined("NOCSRFCHECK")) {
58 define("NOCSRFCHECK", 1); // We accept to go on this page from external web site.
59 }
60 if (!defined("NOIPCHECK")) {
61 define("NOIPCHECK", 1); // Do not check IP defined into conf $dolibarr_main_restrict_ip
62 }
63}
64// Some value of modulepart can be used to get resources that are public so no login are required.
65// Keep $_GET here, GETPOST is not available yet
66if ((isset($_GET["modulepart"]) && $_GET["modulepart"] == 'medias')) {
67 if (!defined("NOLOGIN")) {
68 define("NOLOGIN", 1);
69 }
70 if (!defined("NOCSRFCHECK")) {
71 define("NOCSRFCHECK", 1); // We accept to go on this page from external web site.
72 }
73 if (!defined("NOIPCHECK")) {
74 define("NOIPCHECK", 1); // Do not check IP defined into conf $dolibarr_main_restrict_ip
75 }
76}
77
98function llxHeader($head = '', $title = '', $help_url = '', $target = '', $disablejs = 0, $disablehead = 0, $arrayofjs = '', $arrayofcss = '', $morequerystring = '', $morecssonbody = '', $replacemainareaby = '', $disablenofollow = 0, $disablenoindex = 0)
99{
100}
107function llxFooter()
108{
109}
110
111require 'main.inc.php'; // Load $user and permissions
112require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
113require_once DOL_DOCUMENT_ROOT.'/core/lib/images.lib.php';
114
115$encoding = '';
116$action = GETPOST('action', 'aZ09');
117$original_file = GETPOST('file', 'alphanohtml');
118$hashp = GETPOST('hashp', 'aZ09');
119$modulepart = GETPOST('modulepart', 'alpha');
120$urlsource = GETPOST('urlsource', 'alpha');
121$entity = GETPOSTINT('entity', $conf->entity);
122
123// Security check
124if (empty($modulepart) && empty($hashp)) {
125 httponly_accessforbidden('Bad link. Bad value for parameter modulepart', 400);
126}
127if (empty($original_file) && empty($hashp)) {
128 httponly_accessforbidden('Bad link. Missing identification to find file (original_file or hashp)', 400);
129}
130if ($modulepart == 'fckeditor') {
131 $modulepart = 'medias'; // For backward compatibility
132}
133
134$socid = 0;
135if ($user->socid > 0) {
136 $socid = $user->socid;
137}
138
139// For some module part, dir may be privates
140if (in_array($modulepart, array('facture_paiement', 'unpaid'))) {
141 if (!$user->hasRight('societe', 'client', 'voir')) {
142 $original_file = 'private/'.$user->id.'/'.$original_file; // If user has no permission to see all, output dir is specific to user
143 }
144}
145
146
147/*
148 * Actions
149 */
150
151// None
152
153
154
155/*
156 * View
157 */
158
159// If we have a hash public (hashp), we guess the original_file.
160$ecmfile='';
161if (!empty($hashp)) {
162 include_once DOL_DOCUMENT_ROOT.'/ecm/class/ecmfiles.class.php';
163 $ecmfile = new EcmFiles($db);
164 $result = $ecmfile->fetch(0, '', '', '', $hashp);
165 if ($result > 0) {
166 $tmp = explode('/', $ecmfile->filepath, 2); // $ecmfile->filepath is relative to document directory
167 // filepath can be 'users/X' or 'X/propale/PR11111'
168 if (is_numeric($tmp[0])) { // If first tmp is numeric, it is subdir of company for multicompany, we take next part.
169 $tmp = explode('/', $tmp[1], 2);
170 }
171 $moduleparttocheck = $tmp[0]; // moduleparttocheck is first part of path
172
173 if ($modulepart) { // Not required, so often not defined, for link using public hashp parameter.
174 if ($moduleparttocheck == $modulepart) {
175 // We remove first level of directory
176 $original_file = (($tmp[1] ? $tmp[1].'/' : '').$ecmfile->filename); // this is relative to module dir
177 //var_dump($original_file); exit;
178 } else {
179 httponly_accessforbidden('Bad link. File is from another module part.', 403);
180 }
181 } else {
182 $modulepart = $moduleparttocheck;
183 $original_file = (($tmp[1] ? $tmp[1].'/' : '').$ecmfile->filename); // this is relative to module dir
184 }
185 $entity = $ecmfile->entity;
186 if ($entity != $conf->entity) {
187 $conf->entity = $entity;
188 $conf->setValues($db);
189 }
190 } else {
191 $langs->load("errors");
192 httponly_accessforbidden($langs->trans("ErrorFileNotFoundWithSharedLink"), 403, 1);
193 }
194}
195
196// Define attachment (attachment=true to force choice popup 'open'/'save as')
197$attachment = true;
198if (preg_match('/\.(html|htm)$/i', $original_file)) {
199 $attachment = false;
200}
201if (isset($_GET["attachment"])) {
202 $attachment = GETPOST("attachment", 'alpha') ?true:false;
203}
204if (getDolGlobalString('MAIN_DISABLE_FORCE_SAVEAS')) {
205 $attachment = false;
206}
207
208// Define mime type
209$type = 'application/octet-stream'; // By default
210if (GETPOST('type', 'alpha')) {
211 $type = GETPOST('type', 'alpha');
212} else {
213 $type = dol_mimetype($original_file);
214}
215// Security: Force to octet-stream if file is a dangerous file. For example when it is a .noexe file
216// We do not force if file is a javascript to be able to get js from website module with <script src="
217// Note: Force whatever is $modulepart seems ok.
218if (!in_array($type, array('text/x-javascript')) && !dolIsAllowedForPreview($original_file)) {
219 $type = 'application/octet-stream';
220}
221
222// Security: Delete string ../ or ..\ into $original_file
223$original_file = preg_replace('/\.\.+/', '..', $original_file); // Replace '... or more' with '..'
224$original_file = str_replace('../', '/', $original_file);
225$original_file = str_replace('..\\', '/', $original_file);
226
227
228// Security check
229if (empty($modulepart)) {
230 accessforbidden('Bad value for parameter modulepart');
231}
232
233// Check security and set return info with full path of file
234$check_access = dol_check_secure_access_document($modulepart, $original_file, $entity, $user, '');
235$accessallowed = $check_access['accessallowed'];
236$sqlprotectagainstexternals = $check_access['sqlprotectagainstexternals'];
237$fullpath_original_file = $check_access['original_file']; // $fullpath_original_file is now a full path name
238//var_dump($modulepart.' '.$fullpath_original_file.' '.$original_file.' '.$accessallowed);exit;
239
240if (!empty($hashp)) {
241 $accessallowed = 1; // When using hashp, link is public so we force $accessallowed
242 $sqlprotectagainstexternals = '';
243} else {
244 // Basic protection (against external users only)
245 if ($user->socid > 0) {
246 if ($sqlprotectagainstexternals) {
247 $resql = $db->query($sqlprotectagainstexternals);
248 if ($resql) {
249 $num = $db->num_rows($resql);
250 $i = 0;
251 while ($i < $num) {
252 $obj = $db->fetch_object($resql);
253 if ($user->socid != $obj->fk_soc) {
254 $accessallowed = 0;
255 break;
256 }
257 $i++;
258 }
259 }
260 }
261 }
262}
263
264// Security:
265// Limit access if permissions are wrong
266if (!$accessallowed) {
268}
269
270// Security:
271// We refuse directory transversal change and pipes in file names
272if (preg_match('/\.\./', $fullpath_original_file) || preg_match('/[<>|]/', $fullpath_original_file)) {
273 dol_syslog("Refused to deliver file ".$fullpath_original_file);
274 print "ErrorFileNameInvalid: ".dol_escape_htmltag($original_file);
275 exit;
276}
277
278
279clearstatcache();
280
281$filename = basename($fullpath_original_file);
282$filename = preg_replace('/\.noexe$/i', '', $filename);
283
284// Output file on browser
285dol_syslog("document.php download $fullpath_original_file filename=$filename content-type=$type");
286$fullpath_original_file_osencoded = dol_osencode($fullpath_original_file); // New file name encoded in OS encoding charset
287
288// This test if file exists should be useless. We keep it to find bug more easily
289if (!file_exists($fullpath_original_file_osencoded)) {
290 dol_syslog("ErrorFileDoesNotExists: ".$fullpath_original_file);
291 print "ErrorFileDoesNotExists: ".dol_escape_htmltag($original_file);
292 exit;
293}
294
295// Hooks
296$hookmanager->initHooks(array('document'));
297$parameters = array('ecmfile' => $ecmfile, 'modulepart' => $modulepart, 'original_file' => $original_file,
298 'entity' => $entity, 'fullpath_original_file' => $fullpath_original_file,
299 'filename' => $filename, 'fullpath_original_file_osencoded' => $fullpath_original_file_osencoded);
300$object = new stdClass();
301$reshook = $hookmanager->executeHooks('downloadDocument', $parameters, $object, $action); // Note that $action and $object may have been
302if ($reshook < 0) {
303 $errors = $hookmanager->error.(is_array($hookmanager->errors) ? (!empty($hookmanager->error) ? ', ' : '').implode(', ', $hookmanager->errors) : '');
304 dol_syslog("document.php - Errors when executing the hook 'downloadDocument' : ".$errors);
305 print "ErrorDownloadDocumentHooks: ".$errors;
306 exit;
307}
308
309
310// Permissions are ok and file found, so we return it
311top_httphead($type);
312
313header('Content-Description: File Transfer');
314if ($encoding) {
315 header('Content-Encoding: '.$encoding);
316}
317// Add MIME Content-Disposition from RFC 2183 (inline=automatically displayed, attachment=need user action to open)
318
319if ($attachment) {
320 header('Content-Disposition: attachment; filename="'.$filename.'"');
321} else {
322 header('Content-Disposition: inline; filename="'.$filename.'"');
323}
324// Ajout directives pour resoudre bug IE
325header('Cache-Control: Public, must-revalidate');
326header('Pragma: public');
327$readfile = true;
328
329// on view document, can output images with good orientation according to exif infos
330// TODO Why this on document.php and not in viewimage.php ?
331if (!$attachment && getDolGlobalString('MAIN_USE_EXIF_ROTATION') && image_format_supported($fullpath_original_file_osencoded) == 1) {
332 $imgres = correctExifImageOrientation($fullpath_original_file_osencoded, null);
333 $readfile = !$imgres;
334}
335
336if (is_object($db)) {
337 $db->close();
338}
339
340// Send file now
341if ($readfile) {
342 header('Content-Length: '.dol_filesize($fullpath_original_file));
343
344 readfileLowMemory($fullpath_original_file_osencoded);
345}
if( $user->socid > 0) if(! $user->hasRight('accounting', 'chartofaccount')) $object
Definition card.php:58
if(!defined('NOREQUIRESOC')) if(!defined( 'NOREQUIRETRAN')) if(!defined('NOTOKENRENEWAL')) if(!defined( 'NOREQUIREMENU')) if(!defined('NOREQUIREHTML')) if(!defined( 'NOREQUIREAJAX')) llxHeader($head='', $title='', $help_url='', $target='', $disablejs=0, $disablehead=0, $arrayofjs='', $arrayofcss='', $morequerystring='', $morecssonbody='', $replacemainareaby='', $disablenofollow=0, $disablenoindex=0)
Empty header.
Definition wrapper.php:70
Class to manage ECM files.
llxFooter()
Footer empty.
Definition document.php:107
dol_filesize($pathoffile)
Return size of 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_mimetype($file, $default='application/octet-stream', $mode=0)
Return MIME type of a file from its name with extension.
GETPOSTINT($paramname, $method=0)
Return the value of a $_GET or $_POST supervariable, converted into integer.
dol_osencode($str)
Return a string encoded into OS filesystem encoding.
GETPOST($paramname, $check='alphanohtml', $method=0, $filter=null, $options=null, $noreplace=0)
Return value of a param into GET or POST supervariable.
readfileLowMemory($fullpath_original_file_osencoded, $method=-1)
Return a file on output using a low memory.
dolIsAllowedForPreview($file)
Return if a file is qualified for preview.
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
correctExifImageOrientation($fileSource, $fileDest, $quality=95)
Add exif orientation correction for image.
image_format_supported($file, $acceptsvg=0)
Return if a filename is file name of a supported image format.
if(!defined( 'NOREQUIREMENU')) if(!empty(GETPOST('seteventmessages', 'alpha'))) if(!function_exists("llxHeader")) top_httphead($contenttype='text/html', $forcenocache=0)
Show HTTP header.
httponly_accessforbidden($message='1', $http_response_code=403, $stringalreadysanitized=0)
Show a message to say access is forbidden and stop program.
accessforbidden($message='', $printheader=1, $printfooter=1, $showonlymessage=0, $params=null)
Show a message to say access is forbidden and stop program.