dolibarr 21.0.0-alpha
viewimage.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2004-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3 * Copyright (C) 2005-2016 Laurent Destailleur <eldy@users.sourceforge.net>
4 * Copyright (C) 2005-2016 Regis Houssin <regis.houssin@inodbox.com>
5 * Copyright (C) 2024 Frédéric France <frederic.france@free.fr>
6 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <https://www.gnu.org/licenses/>.
20 * or see https://www.gnu.org/
21 */
22
31define('MAIN_SECURITY_FORCECSP', "default-src: 'none'");
32
33//if (! defined('NOREQUIREUSER')) define('NOREQUIREUSER','1'); // Not disabled cause need to load personalized language
34//if (! defined('NOREQUIREDB')) define('NOREQUIREDB','1'); // Not disabled cause need to load personalized language
35if (!defined('NOREQUIRESOC')) {
36 define('NOREQUIRESOC', '1');
37}
38if (!defined('NOREQUIRETRAN')) {
39 define('NOREQUIRETRAN', '1');
40}
41if (!defined('NOCSRFCHECK')) {
42 define('NOCSRFCHECK', '1');
43}
44if (!defined('NOTOKENRENEWAL')) {
45 define('NOTOKENRENEWAL', '1');
46}
47if (!defined('NOREQUIREMENU')) {
48 define('NOREQUIREMENU', '1');
49}
50if (!defined('NOREQUIREHTML')) {
51 define('NOREQUIREHTML', '1');
52}
53if (!defined('NOREQUIREAJAX')) {
54 define('NOREQUIREAJAX', '1');
55}
56
57// Some value of modulepart can be used to get resources that are public so no login are required.
58// Note that only directory logo is free to access without login.
59$needlogin = 1;
60// Keep $_GET here, GETPOST is not available yet
61if (isset($_GET["modulepart"])) {
62 // Some value of modulepart can be used to get resources that are public so no login are required.
63
64 // For logo of company
65 if ($_GET["modulepart"] == 'mycompany' && preg_match('/^\/?logos\//', $_GET['file'])) {
66 $needlogin = 0;
67 }
68 // For barcode live generation
69 if ($_GET["modulepart"] == 'barcode') {
70 $needlogin = 0;
71 }
72 // Medias files
73 if ($_GET["modulepart"] == 'medias') {
74 $needlogin = 0;
75 }
76 // Common files (files into /public/theme/common)
77 if ($_GET["modulepart"] == 'common') {
78 $needlogin = 0;
79 }
80 // User photo when user has made its profile public (for virtual credi card)
81 if ($_GET["modulepart"] == 'userphotopublic') {
82 $needlogin = 0;
83 }
84 // Used by TakePOS Auto Order
85 if ($_GET["modulepart"] == 'product' && isset($_GET["publictakepos"])) {
86 $needlogin = 0;
87 }
88}
89// For direct external download link, we don't need to load/check we are into a login session
90if (isset($_GET["hashp"])) {
91 $needlogin = 0;
92}
93// If nologin required
94if (!$needlogin) {
95 if (!defined("NOLOGIN")) {
96 define("NOLOGIN", 1);
97 }
98 if (!defined("NOCSRFCHECK")) {
99 define("NOCSRFCHECK", 1); // We accept to go on this page from external web site.
100 }
101 if (!defined("NOIPCHECK")) {
102 define("NOIPCHECK", 1); // Do not check IP defined into conf $dolibarr_main_restrict_ip
103 }
104}
105
106// For MultiCompany module.
107// Do not use GETPOST here, function is not defined and define must be done before including main.inc.php
108// Because 2 entities can have the same ref.
109$entity = (!empty($_GET['entity']) ? (int) $_GET['entity'] : (!empty($_POST['entity']) ? (int) $_POST['entity'] : 1));
110if (is_numeric($entity)) {
111 define("DOLENTITY", $entity);
112}
113
134function llxHeader($head = '', $title = '', $help_url = '', $target = '', $disablejs = 0, $disablehead = 0, $arrayofjs = '', $arrayofcss = '', $morequerystring = '', $morecssonbody = '', $replacemainareaby = '', $disablenofollow = 0, $disablenoindex = 0)
135{
136}
145function llxFooter($comment = '', $zone = 'private', $disabledoutputofmessages = 0)
146{
147}
148
149require 'main.inc.php'; // Load $user and permissions
150require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
151
152$action = GETPOST('action', 'aZ09');
153$original_file = GETPOST('file', 'alphanohtml');
154$hashp = GETPOST('hashp', 'aZ09', 1);
155$extname = GETPOST('extname', 'alpha', 1);
156$modulepart = GETPOST('modulepart', 'alpha', 1);
157$urlsource = GETPOST('urlsource', 'alpha');
158$entity = (GETPOSTINT('entity') ? GETPOSTINT('entity') : $conf->entity);
159
160// Security check
161if (empty($modulepart) && empty($hashp)) {
162 httponly_accessforbidden('Bad link. Bad value for parameter modulepart', 400);
163}
164if (empty($original_file) && empty($hashp) && $modulepart != 'barcode') {
165 httponly_accessforbidden('Bad link. Missing identification to find file (param file or hashp)', 400);
166}
167if ($modulepart == 'fckeditor') {
168 $modulepart = 'medias'; // For backward compatibility
169}
170
171
172/*
173 * Actions
174 */
175
176// None
177
178
179
180/*
181 * View
182 */
183
184if (GETPOST("cache", 'alpha')) {
185 // Important: The following code is to avoid a page request by the browser and PHP CPU at each Dolibarr page access.
186 // We are here when param cache=xxx to force a cache policy:
187 // xxx=1 means cache of 3600s
188 // xxx=abcdef or 123456789 means a cache of 1 week (the key will be modified to get break cache use)
189 if (empty($dolibarr_nocache)) {
190 if (GETPOST('cache', 'alpha') != '1') {
191 $delaycache = 3600 * 24 * 7;
192 } else {
193 $delaycache = 3600;
194 }
195 header('Cache-Control: max-age='.$delaycache.', public, must-revalidate');
196 header('Pragma: cache'); // This is to avoid to have Pragma: no-cache set by proxy or web server
197 header('Expires: '.gmdate('D, d M Y H:i:s', time() + $delaycache).' GMT'); // This is to avoid to have Expires set by proxy or web server
198 } else {
199 // If any cache on files were disable by config file (for test purpose)
200 header('Cache-Control: no-cache');
201 }
202 //print $dolibarr_nocache; exit;
203}
204
205// If we have a hash public (hashp), we guess the original_file.
206if (!empty($hashp)) {
207 include_once DOL_DOCUMENT_ROOT.'/ecm/class/ecmfiles.class.php';
208 include_once DOL_DOCUMENT_ROOT.'/core/lib/images.lib.php';
209 $ecmfile = new EcmFiles($db);
210 $result = $ecmfile->fetch(0, '', '', '', $hashp);
211 if ($result > 0) {
212 $tmp = explode('/', $ecmfile->filepath, 2); // $ecmfile->filepath is relative to document directory
213 // filepath can be 'users/X' or 'X/propale/PR11111'
214 if (is_numeric($tmp[0])) { // If first tmp is numeric, it is subdir of company for multicompany, we take next part.
215 $tmp = explode('/', $tmp[1], 2);
216 }
217 $moduleparttocheck = $tmp[0]; // moduleparttocheck is first part of path
218
219 if ($modulepart) { // Not required, so often not defined, for link using public hashp parameter.
220 if ($moduleparttocheck == $modulepart) {
221 // We remove first level of directory
222 $original_file = (($tmp[1] ? $tmp[1].'/' : '').$ecmfile->filename); // this is relative to module dir
223 //var_dump($original_file); exit;
224 } else {
225 httponly_accessforbidden('Bad link. File is from another module part.', 403);
226 }
227 } else {
228 $modulepart = $moduleparttocheck;
229 $original_file = (($tmp[1] ? $tmp[1].'/' : '').$ecmfile->filename); // this is relative to module dir
230 }
231
232 if ($extname) {
233 $original_file = getImageFileNameForSize($original_file, $extname);
234 }
235 } else {
236 httponly_accessforbidden("ErrorFileNotFoundWithSharedLink", 403, 1);
237 }
238}
239
240// Define mime type
241$type = 'application/octet-stream';
242if (GETPOST('type', 'alpha')) {
243 $type = GETPOST('type', 'alpha');
244} else {
245 $type = dol_mimetype($original_file);
246}
247
248// Security: This wrapper is for images. We do not allow type/html
249if (preg_match('/html/i', $type)) {
250 httponly_accessforbidden('Error: Using the image wrapper to output a file with a mime type HTML is not possible.');
251}
252// Security: This wrapper is for images. We do not allow files ending with .noexe
253if (preg_match('/\.noexe$/i', $original_file)) {
254 httponly_accessforbidden('Error: Using the image wrapper to output a file ending with .noexe is not allowed.');
255}
256
257// Security: Delete string ../ or ..\ into $original_file
258$original_file = preg_replace('/\.\.+/', '..', $original_file); // Replace '... or more' with '..'
259$original_file = str_replace('../', '/', $original_file);
260$original_file = str_replace('..\\', '/', $original_file);
261
262// Find the subdirectory name as the reference
263$refname = basename(dirname($original_file)."/");
264if ($refname == 'thumbs') {
265 // If we get the thumbs directory, we must go one step higher. For example original_file='10/thumbs/myfile_small.jpg' -> refname='10'
266 $refname = basename(dirname(dirname($original_file))."/");
267}
268
269// Check that file is allowed for view with viewimage.php
270if (!empty($original_file) && !dolIsAllowedForPreview($original_file)) {
271 httponly_accessforbidden('This file extension is not qualified for preview', 403);
272}
273
274// Security check
275if (empty($modulepart)) {
276 httponly_accessforbidden('Bad value for parameter modulepart', 400);
277}
278
279// When logged in a different entity, medias cannot be accessed because $conf->$module->multidir_output
280// is not set on the requested entity, but they are public documents, so reset entity
281if ($modulepart === 'medias' && $entity != $conf->entity) {
282 $conf->entity = $entity;
283 $conf->setValues($db);
284}
285
286$check_access = dol_check_secure_access_document($modulepart, $original_file, $entity, $user, $refname);
287$accessallowed = $check_access['accessallowed'];
288$sqlprotectagainstexternals = $check_access['sqlprotectagainstexternals'];
289$fullpath_original_file = $check_access['original_file']; // $fullpath_original_file is now a full path name
290
291if (!empty($hashp)) {
292 $accessallowed = 1; // When using hashp, link is public so we force $accessallowed
293 $sqlprotectagainstexternals = '';
294} elseif (GETPOSTINT("publictakepos")) {
295 if (getDolGlobalString('TAKEPOS_AUTO_ORDER') && in_array($modulepart, array('product', 'category'))) {
296 $accessallowed = 1; // When TakePOS Public Auto Order is enabled, we accept to see all images of product and categories with no login
297 // TODO Replace this with a call of getPublicImageOfObject like used by website so
298 // only shared images are visible
299 }
300} else {
301 // Basic protection (against external users only)
302 if ($user->socid > 0) {
303 if ($sqlprotectagainstexternals) {
304 $resql = $db->query($sqlprotectagainstexternals);
305 if ($resql) {
306 $num = $db->num_rows($resql);
307 $i = 0;
308 while ($i < $num) {
309 $obj = $db->fetch_object($resql);
310 if ($user->socid != $obj->fk_soc) {
311 $accessallowed = 0;
312 break;
313 }
314 $i++;
315 }
316 }
317 }
318 }
319}
320
321// Security:
322// Limit access if permissions are wrong
323if (!$accessallowed) {
325}
326
327// Security:
328// On interdit les remontees de repertoire ainsi que les pipe dans les noms de fichiers.
329if (preg_match('/\.\./', $fullpath_original_file) || preg_match('/[<>|]/', $fullpath_original_file)) {
330 dol_syslog("Refused to deliver file ".$fullpath_original_file);
331 print "ErrorFileNameInvalid: ".dol_escape_htmltag($original_file);
332 exit;
333}
334
335
336
337if ($modulepart == 'barcode') {
338 $generator = GETPOST("generator", "aZ09");
339 $encoding = GETPOST("encoding", "aZ09");
340 $readable = GETPOST("readable", 'aZ09') ? GETPOST("readable", "aZ09") : "Y";
341 if (in_array($encoding, array('EAN8', 'EAN13'))) {
342 $code = GETPOST("code", 'alphanohtml');
343 } else {
344 $code = GETPOST("code", 'restricthtml'); // This can be rich content (qrcode, datamatrix, ...)
345 }
346
347 // If $code is virtualcard_xxx_999.vcf, it is a file to read to get code
348 $reg = array();
349 if (preg_match('/^virtualcard_([^_]+)_(\d+)\.vcf$/', $code, $reg)) {
350 $vcffile = '';
351 if ($reg[1] == 'user') {
352 $vcffile = $conf->user->dir_temp.'/'.$code;
353 } elseif ($reg[1] == 'contact') {
354 $vcffile = $conf->contact->dir_temp.'/'.$code;
355 }
356
357 if ($vcffile) {
358 $code = file_get_contents($vcffile);
359 }
360 }
361
362
363 if (empty($generator) || empty($encoding)) {
364 print 'Error: Parameter "generator" or "encoding" not defined';
365 exit;
366 }
367
368 $dirbarcode = array_merge(array("/core/modules/barcode/doc/"), $conf->modules_parts['barcode']);
369
370 $result = 0;
371
372 foreach ($dirbarcode as $reldir) {
373 $dir = dol_buildpath($reldir, 0);
374 $newdir = dol_osencode($dir);
375
376 // Check if directory exists (we do not use dol_is_dir to avoid loading files.lib.php)
377 if (!is_dir($newdir)) {
378 continue;
379 }
380
381 $result = @include_once $newdir.$generator.'.modules.php';
382 if ($result) {
383 break;
384 }
385 }
386
387 // Load barcode class
388 $classname = "mod".ucfirst($generator);
389
390 $module = new $classname($db);
391 '@phan-var-force ModeleBarCode $module';
392 if ($module->encodingIsSupported($encoding)) {
393 $result = $module->buildBarCode($code, $encoding, $readable);
394 }
395} else {
396 // Open and return file
397 clearstatcache();
398
399 $filename = basename($fullpath_original_file);
400
401 // Output files on browser
402 dol_syslog("viewimage.php return file $fullpath_original_file filename=$filename content-type=$type");
403
404 if (!dol_is_file($fullpath_original_file) && !GETPOSTINT("noalt", 1)) {
405 // This test is to replace error images with a nice "notfound image" when image is not available (for example when thumbs not yet generated).
406 $fullpath_original_file = DOL_DOCUMENT_ROOT.'/public/theme/common/nophoto.png';
407 /*$error='Error: File '.$_GET["file"].' does not exists or filesystems permissions are not allowed';
408 print $error;
409 exit;*/
410 }
411
412 // Permissions are ok and file found, so we return it
413 if ($type) {
414 top_httphead($type);
415 header('Content-Disposition: inline; filename="'.basename($fullpath_original_file).'"');
416 } else {
417 top_httphead('image/png');
418 header('Content-Disposition: inline; filename="'.basename($fullpath_original_file).'"');
419 }
420
421 $fullpath_original_file_osencoded = dol_osencode($fullpath_original_file);
422
423 readfile($fullpath_original_file_osencoded);
424}
425
426
427if (is_object($db)) {
428 $db->close();
429}
Class to manage ECM files.
llxFooter()
Footer empty.
Definition document.php:107
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_is_file($pathoffile)
Return if path is a file.
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.
getImageFileNameForSize($file, $extName, $extImgTarget='')
Return the filename of file to get the thumbs.
GETPOST($paramname, $check='alphanohtml', $method=0, $filter=null, $options=null, $noreplace=0)
Return value of a param into GET or POST supervariable.
dolIsAllowedForPreview($file)
Return if a file is qualified for preview.
dol_buildpath($path, $type=0, $returnemptyifnotfound=0)
Return path of url or filesystem.
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.
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.
if(is_numeric( $entity)) llxHeader($head='', $title='', $help_url='', $target='', $disablejs=0, $disablehead=0, $arrayofjs='', $arrayofcss='', $morequerystring='', $morecssonbody='', $replacemainareaby='', $disablenofollow=0, $disablenoindex=0)
Header empty.