mod_syslog_file.php

<?php
/* Copyright (C) 2024-2026  MDW             <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024       Frédéric France             <frederic.france@free.fr>
 */
 
// File ignore as individual 'suppress' is not extremely effective.
// @phan-file-suppress PhanPluginDuplicateArrayKey
 
require_once DOL_DOCUMENT_ROOT.'/core/modules/syslog/logHandler.php';
 
class mod_syslog_file extends LogHandler
{
  // @phan-suppress-next-line PhanPluginDuplicateArrayKey
  const DOL_LOG_LEVELS = array(
    LOG_EMERG => 'EMERG',
    LOG_ALERT => 'ALERT',
    LOG_CRIT => 'CRIT',
    LOG_ERR => 'ERR',
    LOG_WARNING => 'WARNING',
    LOG_NOTICE => 'NOTICE',
    LOG_INFO => 'INFO',
    LOG_DEBUG => 'DEBUG'
  );
 
  public $code = 'file';
  public $lastTime = 0;
 
  public function getName()
  {
    global $langs;
 
    return $langs->trans('File');
  }
 
  public function getVersion()
  {
    return 'dolibarr';
  }
 
  public function getInfo()
  {
    global $langs;
 
    return $langs->trans('YouCanUseDOL_DATA_ROOT');
  }
 
  public function isActive()
  {
    return !getDolGlobalString('SYSLOG_DISABLE_LOGHANDLER_FILE') ? 1 : 0; // Set SYSLOG_DISABLE_LOGHANDLER_FILE to 1 to disable this loghandler
  }
 
  public function configure()
  {
    global $langs;
 
    return array(
      array(
        'name' => $langs->trans('SyslogFilename'),
        'constant' => 'SYSLOG_FILE',
        'default' => 'DOL_DATA_ROOT/dolibarr.log',
        'css' => 'minwidth300 maxwidth500'
      )
    );
  }
 
  public function checkConfiguration()
  {
    global $langs;
 
    $filename = $this->getFilename();
 
    if (file_exists($filename) && is_writable($filename)) {
      dol_syslog('admin/syslog: file '.$filename);
      return true;
    } else {
      $this->errors[] = $langs->trans("ErrorFailedToOpenFile", $filename);
      return false;
    }
  }
 
  private function getFilename($suffixinfilename = '')
  {
    global $conf;
 
    if (!getDolGlobalString('SYSLOG_FILE')) {
      $tmp = DOL_DATA_ROOT.'/dolibarr.log';
    } else {
      $tmp = str_replace('DOL_DATA_ROOT', DOL_DATA_ROOT, $conf->global->SYSLOG_FILE);
    }
 
    // Deprecated, use instead the constant 'SYSLOG_FILE_ADDSUFFIX' and/or 'SYSLOG_FILE_ONEPERIP'
    if (getDolGlobalString('SYSLOG_FILE_ONEPERSESSION')) {
      if (is_numeric(getDolGlobalString('SYSLOG_FILE_ONEPERSESSION'))) {
        if (getDolGlobalInt('SYSLOG_FILE_ONEPERSESSION') == 1) {  // file depend on instance session key name (Note that session name is same for the instance so for all users and is not a per user value)
          $suffixinfilename .= '_'.session_name();
        }
        if (getDolGlobalInt('SYSLOG_FILE_ONEPERSESSION') == 2) {  // file depend on instance session key name + ip so nearly per user
          $suffixinfilename .= '_'.session_name().'_'.getUserRemoteIP();
        }
      } else {
        $suffixinfilename .= '_' . getDolGlobalString('SYSLOG_FILE_ONEPERSESSION');
      }
    }
 
    if (defined('SYSLOG_FILE_ADDSUFFIX')) {
      $suffixinfilename .= '_' . constant('SYSLOG_FILE_ADDSUFFIX');
    }
    if (defined('SYSLOG_FILE_ADDIP')) {
      $suffixinfilename .= '_'.getUserRemoteIP();
    }
 
    return $suffixinfilename ? preg_replace('/\.log$/i', $suffixinfilename.'.log', $tmp) : $tmp;
  }
 
  public function export($content, $suffixinfilename = '')
  {
    if (getDolGlobalString('MAIN_SYSLOG_DISABLE_FILE')) {
      return; // Global option to disable output of this handler
    }
 
 
    // Prepare log message
 
    $delay = "";
    if (getDolGlobalString('MAIN_SYSLOG_SHOW_DELAY')) {
      $now = microtime(true);
      $delay = " ".sprintf("%05.3f", $this->lastTime != 0 ? $now - $this->lastTime : 0);
      $this->lastTime = $now;
    }
    $message = dol_print_date(dol_now('gmt'), 'standard', 'gmt').$delay." ".sprintf("%-7s", self::DOL_LOG_LEVELS[$content['level']])." ".sprintf("%-15s", $content['ip']);
    $message .= " ".sprintf("%7s", dol_trunc($content['ospid'], 7, 'right', 'UTF-8', 1));
    $message .= " ".sprintf("%6s", dol_trunc($content['osuser'], 6, 'right', 'UTF-8', 1));
    // @phan-suppress-next-line PhanParamSuspiciousOrder
    $message .= " ".($this->ident > 0 ? str_pad('', ((int) $this->ident), ' ') : '').$content['message'];
    $message .= "\n";
 
 
    // Write log message
 
    $logfile = $this->getFilename($suffixinfilename);
 
    $result = false;
    if (defined('SYSLOG_FILE_NO_ERROR') || !empty($suffixinfilename)) {
      $filefd = @fopen($logfile, "a");
    } else {
      $filefd = fopen($logfile, "a");
    }
 
    if ($filefd !== false) {
      $result = fwrite($filefd, $message);
      fclose($filefd);
      dolChmod($logfile);
    }
    if ($result === false && empty($suffixinfilename) && (!defined('SYSLOG_FILE_NO_ERROR') || !constant('SYSLOG_FILE_NO_ERROR'))) {
      global $dolibarr_main_prod;
      // Do not break dolibarr usage if log fails
      //throw new Exception('Failed to open log file '.basename($logfile));
      print 'Failed to write to log file '.($dolibarr_main_prod ? basename($logfile) : $logfile)."\n";
    }
  }
}