document.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2004-2007 Rodolphe Quiedeville <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2013 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2005      Simon Tosser         <simon@kornog-computing.com>
 * Copyright (C) 2005-2012 Regis Houssin        <regis.houssin@inodbox.com>
 * Copyright (C) 2010    Pierre Morin         <pierre.morin@auguria.net>
 * Copyright (C) 2010    Juanjo Menent        <jmenent@2byte.es>
 * Copyright (C) 2022     Ferran Marcet           <fmarcet@2byte.es>
 * Copyright (C) 2024-2026  Frédéric France         <frederic.france@free.fr>
 * Copyright (C) 2025   MDW           <mdeweerd@users.noreply.github.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 * or see https://www.gnu.org/
 */
 
define('MAIN_SECURITY_FORCECSP', "default-src 'none'; form-action 'none'; frame-ancestors 'self'");
 
//if (! defined('NOREQUIREUSER')) define('NOREQUIREUSER','1');  // Not disabled cause need to load personalized language
//if (! defined('NOREQUIREDB'))   define('NOREQUIREDB','1');    // Not disabled cause need to load personalized language
if (!defined('NOTOKENRENEWAL')) {
  define('NOTOKENRENEWAL', '1');
}
if (!defined('NOREQUIREMENU')) {
  define('NOREQUIREMENU', '1');
}
if (!defined('NOREQUIREHTML')) {
  define('NOREQUIREHTML', '1');
}
if (!defined('NOREQUIREAJAX')) {
  define('NOREQUIREAJAX', '1');
}
 
// For direct external download link, we don't need to load/check we are into a login session
if (isset($_GET["hashp"]) && !defined("NOLOGIN")) {
  if (!defined("NOLOGIN")) {
    define("NOLOGIN", 1);
  }
  if (!defined("NOCSRFCHECK")) {
    define("NOCSRFCHECK", 1); // We accept to go on this page from external web site.
  }
  if (!defined("NOIPCHECK")) {
    define("NOIPCHECK", 1); // Do not check IP defined into conf $dolibarr_main_restrict_ip
  }
}
// Some value of modulepart can be used to get resources that are public so no login are required.
// Keep $_GET here, GETPOST is not available yet
if ((isset($_GET["modulepart"]) && $_GET["modulepart"] == 'medias')) {
  if (!defined("NOLOGIN")) {
    define("NOLOGIN", 1);
  }
  if (!defined("NOCSRFCHECK")) {
    define("NOCSRFCHECK", 1); // We accept to go on this page from external web site.
  }
  if (!defined("NOIPCHECK")) {
    define("NOIPCHECK", 1); // Do not check IP defined into conf $dolibarr_main_restrict_ip
  }
}
 
// For MultiCompany modules, if an entity is set in query parameters (required to point an object because a ref can exists
// in 2 entities), then if user is not already into a session, the user must be loaded on this entity, so permission will
// be the one of this entity.
// Do not use GETPOST here, function is not defined and define must be done before including main.inc.php
$entity = (!empty($_GET['entity']) ? (int) $_GET['entity'] : (!empty($_POST['entity']) ? (int) $_POST['entity'] : 0));
if ($entity > 0) {
  // An entity was forced on param, so we force the constant to allow master.inc.php to use this entity if not already logged.
  // It has no effect if already logged.
  define("DOLENTITY", $entity);
}
 
function llxHeader($head = '', $title = '', $help_url = '', $target = '', $disablejs = 0, $disablehead = 0, $arrayofjs = '', $arrayofcss = '', $morequerystring = '', $morecssonbody = '', $replacemainareaby = '', $disablenofollow = 0, $disablenoindex = 0)
{
}
function llxFooter($comment = '', $zone = 'private', $disabledoutputofmessages = 0)
{
}
 
require 'main.inc.php'; // Load $user and permissions
require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/images.lib.php';
 
$encoding = '';
$action = GETPOST('action', 'aZ09');
$original_file = GETPOST('file', 'alphanohtml');
$hashp = GETPOST('hashp', 'aZ09');
$modulepart = GETPOST('modulepart', 'alpha');
$urlsource = GETPOST('urlsource', 'alpha');
$entity = ($entity > 0 ? $entity : $conf->entity);
 
// Security check
if (empty($modulepart) && empty($hashp)) {
  httponly_accessforbidden('Bad link. Bad value for parameter modulepart', 400);
}
if (empty($original_file) && empty($hashp)) {
  httponly_accessforbidden('Bad link. Missing identification to find file (original_file or hashp)', 400);
}
if ($hashp == 'shared') {
  httponly_accessforbidden('Bad link. Bad value for parameter hashp', 400);
}
if ($modulepart == 'fckeditor') {
  $modulepart = 'medias'; // For backward compatibility
}
 
$socid = 0;
if ($user->socid > 0) {
  $socid = $user->socid;
}
 
// For some module part, dir may be privates
if (in_array($modulepart, array('facture_paiement', 'unpaid'))) {
  if (!$user->hasRight('societe', 'client', 'voir')) {
    $original_file = 'private/'.$user->id.'/'.$original_file; // If user has no permission to see all, output dir is specific to user
  }
}
 
 
/*
 * Actions
 */
 
// None
 
 
 
/*
 * View
 */
 
// If we have a hash public (hashp), we guess the original_file.
$ecmfile = '';
if (!empty($hashp) && $hashp != 'shared') {
  if (GETPOST('type', 'alpha') == 'link') {
    // If we request a link
    require_once DOL_DOCUMENT_ROOT.'/core/class/link.class.php';
    $link = new Link($db);
    $result = $link->fetch(0, $hashp);
    if ($result > 0 && !empty($link->url)) {
      if (preg_match('/^(http|dav)/', $link->url)) {
        header('Location: '.$link->url);        // Return the shared link we found in db
        exit;
      }
    } else {
      $langs->load("errors");
      httponly_accessforbidden($langs->trans("ErrorLinkNotFoundWithSharedLink"), 403, 1);
    }
  } else {
    // If we request a file
    include_once DOL_DOCUMENT_ROOT . '/ecm/class/ecmfiles.class.php';
    $ecmfile = new EcmFiles($db);
    $result = $ecmfile->fetch(0, '', '', '', $hashp);
    if ($result > 0) {
      $tmp = explode('/', $ecmfile->filepath, 2); // $ecmfile->filepath is relative to document directory
      // filepath can be 'users/X' or 'X/propale/PR11111'
      if (is_numeric($tmp[0])) { // If first tmp is numeric, it is subdir of company for multicompany, we take next part.
        $tmp = explode('/', $tmp[1], 2);
      }
      $moduleparttocheck = $tmp[0]; // moduleparttocheck is first part of path
 
      if ($modulepart) {    // Not required, so often not defined, for link using public hashp parameter.
        if ($moduleparttocheck == $modulepart) {
          // We remove first level of directory
          $original_file = (($tmp[1] ? $tmp[1] . '/' : '') . $ecmfile->filename); // this is relative to module dir
          //var_dump($original_file); exit;
        } else {
          httponly_accessforbidden('Bad entry found. File has a path from another module part.', 403);
        }
      } else {
        $modulepart = $moduleparttocheck;
        $original_file = (($tmp[1] ? $tmp[1] . '/' : '') . $ecmfile->filename); // this is relative to module dir
      }
 
      $entity = $ecmfile->entity;
      if (isModEnabled('multicompany') && !empty($ecmfile->src_object_type) && $ecmfile->src_object_id > 0) {
        $object = fetchObjectByElement($ecmfile->src_object_id, $ecmfile->src_object_type);
        if (is_object($object) && $object->id > 0) {
          $entity = $object->entity;
        }
      }
 
      if ($entity != $conf->entity) {
        $conf->entity = $entity;
        $conf->setValues($db);
        // Multicompany: Here we are switching entity and later we will check the requested object is in this entity but may be that user is not allowed to log/see entity
        // but we don't mind, we are using the public hash to get file.
      }
    } else {
      $langs->load("errors");
      httponly_accessforbidden($langs->trans("ErrorFileNotFoundWithSharedLink"), 403, 1);
    }
  }
}
 
// Define attachment (attachment=true to force choice popup 'open'/'save as')
$attachment = true;
if (preg_match('/\.(html|htm)$/i', $original_file)) {
  $attachment = false;
}
if (isset($_GET["attachment"])) {
  $attachment = GETPOST("attachment", 'alpha') ? true : false;
}
if (getDolGlobalString('MAIN_DISABLE_FORCE_SAVEAS')) {
  $attachment = false;
}
 
// Define mime type
$type = 'application/octet-stream'; // By default
if (GETPOST('type', 'alpha')) {
  $type = GETPOST('type', 'alpha');
} else {
  $type = dol_mimetype($original_file);
}
// Security: Force to octet-stream if file is a dangerous file. For example when it is a .noexe file
// We do not force if file is a javascript to be able to get js from website module with <script src="
// Note: Force whatever is $modulepart seems ok.
if (!in_array($type, array('text/x-javascript')) && !dolIsAllowedForPreview($original_file)) {
  $type = 'application/octet-stream';
}
 
// Security: Delete string ../ or ..\ into $original_file
$original_file = preg_replace('/\.\.+/', '..', $original_file); // Replace '... or more' with '..'
$original_file = str_replace('../', '/', $original_file);
$original_file = str_replace('..\\', '/', $original_file);
 
// Security check
if (empty($modulepart)) {
  accessforbidden('Bad value for parameter modulepart');
}
 
// Check security and set return info with full path of file
$check_access = dol_check_secure_access_document($modulepart, $original_file, (int) $entity, $user, '', 'read');
$accessallowed              = $check_access['accessallowed'];
$sqlprotectagainstexternals = $check_access['sqlprotectagainstexternals'];
$fullpath_original_file     = $check_access['original_file']; // $fullpath_original_file is now a full path name
//var_dump($modulepart.' '.$entity.' '.$fullpath_original_file.' '.$original_file.' '.$accessallowed);exit;
 
if (!empty($hashp) && $hashp != 'shared') {
  $accessallowed = 1; // When using hashp, link is public so we force $accessallowed
  $sqlprotectagainstexternals = '';
} else {
  // Basic protection (against external users only)
  if ($user->socid > 0) {
    if ($sqlprotectagainstexternals) {
      $resql = $db->query($sqlprotectagainstexternals);
      if ($resql) {
        $num = $db->num_rows($resql);
        $i = 0;
        while ($i < $num) {
          $obj = $db->fetch_object($resql);
          if ($user->socid != $obj->fk_soc) {
            $accessallowed = 0;
            break;
          }
          $i++;
        }
      }
    }
  } /*
  TODO Why this else ? Which use case does it cover ?
  TICKET_EMAIL_MUST_EXISTS means a visitor can create a ticket from public interface even if email does not exists yet as a contact.
  Public interface means no login and unknown user (ticket are found by email submiter / id).
  Disabled as this looks a security bypass
  elseif ($modulepart == 'ticket' && !getDolGlobalString('TICKET_EMAIL_MUST_EXISTS')) {
    if ($sqlprotectagainstexternals) {
      $resql = $db->query($sqlprotectagainstexternals);
      if ($resql) {
        $num = $db->num_rows($resql);
        if ($num > 0) {
          $accessallowed = 1;
        }
      }
    }
  }
  */
}
 
// Security:
// Limit access if permissions are wrong
if (!$accessallowed) {
  accessforbidden();
}
 
// Security:
// We refuse directory transversal change and pipes in file names
if (preg_match('/\.\./', $fullpath_original_file) || preg_match('/[<>|]/', $fullpath_original_file)) {
  dol_syslog("Refused to deliver file ".$fullpath_original_file);
  print "ErrorFileNameInvalid: ".dol_escape_htmltag($original_file);
  exit;
}
 
 
clearstatcache();
 
$filename = basename($fullpath_original_file);
$filename = preg_replace('/\.noexe$/i', '', $filename);
 
// Output file on browser
dol_syslog("document.php download $fullpath_original_file filename=$filename content-type=$type");
$fullpath_original_file_osencoded = dol_osencode($fullpath_original_file); // New file name encoded in OS encoding charset
 
// This test if file exists should be useless. We keep it to find bug more easily
if (!file_exists($fullpath_original_file_osencoded)) {
  dol_syslog("ErrorFileDoesNotExists: ".$fullpath_original_file);
  print $langs->trans("ErrorFileDoesNotExists") . ' : ' . dol_escape_htmltag($original_file);
  exit;
}
 
// Hooks
$hookmanager->initHooks(array('document'));
$parameters = array('ecmfile' => $ecmfile, 'modulepart' => $modulepart, 'original_file' => $original_file,
  'entity' => $entity, 'fullpath_original_file' => $fullpath_original_file,
  'filename' => $filename, 'fullpath_original_file_osencoded' => $fullpath_original_file_osencoded);
$object = new stdClass();
$reshook = $hookmanager->executeHooks('downloadDocument', $parameters, $object, $action); // Note that $action and $object may have been
if ($reshook < 0) {
  $errors = $hookmanager->error.(is_array($hookmanager->errors) ? (!empty($hookmanager->error) ? ', ' : '').implode(', ', $hookmanager->errors) : '');
  dol_syslog("document.php - Errors when executing the hook 'downloadDocument' : ".$errors);
  print "ErrorDownloadDocumentHooks: ".$errors;
  exit;
}
 
// Set this for test
//$type = 'text/html'; $attachment = -1;
 
 
// If we show an invoice, we test if we must regenerate the PDF
if ($modulepart == 'facture') {
  $refname = basename(dirname($original_file)."/");
  if ($refname == 'thumbs' || $refname == 'temp') {
    // If we get the thumbs directory, we must go one step higher. For example original_file='10/thumbs/myfile_small.jpg' -> refname='10'
    $refname = basename(dirname(dirname($original_file))."/");
  }
 
  $invoice = fetchObjectByElement(0, $modulepart, $refname);
 
  if ($original_file == preg_replace('/facture\//', '', $invoice->last_main_doc)) {
    // We are on the download or print of the main document
    if ($invoice instanceOf Facture && $invoice->status > Facture::STATUS_DRAFT) {
      $action = 'DOC_DOWNLOAD';
      if (GETPOSTISSET('attachement') || GETPOST('preview')) {
        $action = 'DOC_PREVIEW';
      }
 
      dol_syslog("Print for action=".$action.". Current counter of this non draft invoice is already ".$invoice->id.", so file was already printed, so we regenerate the PDF to add mention DUPLICATA", LOG_DEBUG);
 
      // $object->pos_print_counter is current value. We increase it here.
      if ($invoice->status == Facture::STATUS_CLOSED) {
        // Increase counter by 1
        $sql = "UPDATE ".MAIN_DB_PREFIX."facture SET pos_print_counter = pos_print_counter + 1";
        $sql .= " WHERE rowid = ".((int) $invoice->id);
        $db->query($sql);
 
        $invoice->pos_print_counter += 1;
        //$invoice->update($user, 1); // disabled update, we already did a direct sql update before. We disable trigger here because we already call the trigger $action = DOC_PREVIEW or DOC_DOWNLOAD just after.
      }
 
      // When we reach the second print, we must regenerate the document to have the mention duplicata on PDF)
      // No need if we are at print 3, 4 or more. The PDF was regenerated when counter was 2,
      if ($invoice->pos_print_counter == 2) {
        $outputlangs = new Translate('', $conf);
        $outputlangs->setDefaultLang(GETPOST('lang'));
        $outputlangs->loadLangs(array("admin", "blockedlog"));
 
        $hidedetails = 0;
        $hidedesc = 0;
        $hideref = 0;
        $moreparams = '';
        $hidedetails = isset($hidedetails) ? $hidedetails : (getDolGlobalString('MAIN_GENERATE_DOCUMENTS_HIDE_DETAILS') ? 1 : 0); // @phpstan-ignore-line as variable $hidedetails is forced
        $hidedesc = isset($hidedesc) ? $hidedesc : (getDolGlobalString('MAIN_GENERATE_DOCUMENTS_HIDE_DESC') ? 1 : 0); // @phpstan-ignore-line as variable $hidedesc is forced
        $hideref = isset($hideref) ? $hideref : (getDolGlobalString('MAIN_GENERATE_DOCUMENTS_HIDE_REF') ? 1 : 0); // @phpstan-ignore-line as variable $hideref is forced
        $moreparams = isset($moreparams) ? $moreparams : null; // @phpstan-ignore-line as variable $moreparams is forced
 
        $result = $invoice->generateDocument($invoice->model_pdf, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams);
        if ($result < 0) {
          dol_syslog("Failed to regenerate PDF", LOG_WARNING);
        }
      }
 
      // Call trigger
      $result = $invoice->call_trigger($action, $user);
      if ($result < 0) {
        top_httphead();
 
        http_response_code(500);
        print 'Error in trigger: '.$invoice->errorsToString();
        exit;
      }
    }
  }
}
 
 
 
// Permissions are ok and file found, so we return it
top_httphead($type);
 
header('Content-Description: File Transfer');
if ($encoding) {
  header('Content-Encoding: '.$encoding);
}
// Add MIME Content-Disposition from RFC 2183 (inline=automatically displayed, attachment=need user action to open)
 
if ($attachment > 0) {
  header('Content-Disposition: attachment; filename="'.$filename.'"');
} elseif (empty($attachment)) {
  header('Content-Disposition: inline; filename="'.$filename.'"');
}
// Ajout directives pour resoudre bug IE
header('Cache-Control: Public, must-revalidate');
header('Pragma: public');
$readfile = true;
 
// on view document, can output images with good orientation according to exif infos
// TODO Why this on document.php and not in viewimage.php ?
if (!$attachment && getDolGlobalString('MAIN_USE_EXIF_ROTATION') && image_format_supported($fullpath_original_file_osencoded) == 1) {
  $imgres = correctExifImageOrientation($fullpath_original_file_osencoded, null);
  $readfile = !$imgres;
}
 
if (is_object($db)) {
  $db->close();
}
 
// Send file now
if ($readfile) {
  header('Content-Length: '.dol_filesize($fullpath_original_file));
 
  readfileLowMemory($fullpath_original_file_osencoded);
}