mirror of
https://github.com/SuiteCRM/SuiteCRM-Core.git
synced 2026-07-27 23:29:19 +08:00
419 lines
16 KiB
PHP
Executable file
419 lines
16 KiB
PHP
Executable file
<?php
|
|
if (!defined('sugarEntry') || !sugarEntry) {
|
|
die('Not A Valid Entry Point');
|
|
}
|
|
/**
|
|
*
|
|
* SugarCRM Community Edition is a customer relationship management program developed by
|
|
* SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
|
|
*
|
|
* SuiteCRM is an extension to SugarCRM Community Edition developed by SalesAgility Ltd.
|
|
* Copyright (C) 2011 - 2018 SalesAgility Ltd.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify it under
|
|
* the terms of the GNU Affero General Public License version 3 as published by the
|
|
* Free Software Foundation with the addition of the following permission added
|
|
* to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
|
|
* IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
|
|
* OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
|
|
*
|
|
* 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 Affero General Public License for more
|
|
* details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License along with
|
|
* this program; if not, see http://www.gnu.org/licenses or write to the Free
|
|
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
* 02110-1301 USA.
|
|
*
|
|
* You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
|
|
* SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
|
|
*
|
|
* The interactive user interfaces in modified source and object code versions
|
|
* of this program must display Appropriate Legal Notices, as required under
|
|
* Section 5 of the GNU Affero General Public License version 3.
|
|
*
|
|
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
|
|
* these Appropriate Legal Notices must retain the display of the "Powered by
|
|
* SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
|
|
* reasonably feasible for technical reasons, the Appropriate Legal Notices must
|
|
* display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
|
|
*/
|
|
|
|
/*********************************************************************************
|
|
|
|
* Description: Defines the English language pack for the base application.
|
|
* Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
|
|
* All Rights Reserved.
|
|
* Contributor(s): ______________________________________..
|
|
********************************************************************************/
|
|
require_once('include/SugarLogger/LoggerManager.php');
|
|
require_once('include/SugarLogger/LoggerTemplate.php');
|
|
|
|
/**
|
|
* Default SugarCRM Logger
|
|
* @api
|
|
*/
|
|
#[\AllowDynamicProperties]
|
|
class SugarLogger implements LoggerTemplate
|
|
{
|
|
/**
|
|
* properties for the SugarLogger
|
|
*/
|
|
protected $logfile = 'suitecrm';
|
|
protected $ext = '.log';
|
|
protected $dateFormat = '%c';
|
|
protected $logSize = '10MB';
|
|
protected $maxLogs = 10;
|
|
protected $filesuffix = "";
|
|
protected $date_suffix = "";
|
|
protected $log_dir = '../../logs/legacy';
|
|
protected $defaultPerms = 0664;
|
|
|
|
protected $dateFormatter = null;
|
|
|
|
/**
|
|
* used for config screen
|
|
*/
|
|
public static $filename_suffix = array(
|
|
//bug#50265: Added none option for previous version users
|
|
"" => "None",
|
|
"%m_%Y" => "Month_Year",
|
|
"%d_%m" => "Day_Month",
|
|
"%m_%d_%y" => "Month_Day_Year",
|
|
);
|
|
|
|
/**
|
|
* Let's us know if we've initialized the logger file
|
|
*/
|
|
protected $initialized = false;
|
|
|
|
/**
|
|
* Logger file handle
|
|
*/
|
|
protected $fp = false;
|
|
|
|
public function __get(
|
|
$key
|
|
) {
|
|
return $this->$key;
|
|
}
|
|
|
|
/**
|
|
* Used by the diagnostic tools to get SugarLogger log file information
|
|
*/
|
|
public function getLogFileNameWithPath()
|
|
{
|
|
return $this->full_log_file;
|
|
}
|
|
|
|
/**
|
|
* Used by the diagnostic tools to get SugarLogger log file information
|
|
*/
|
|
public function getLogFileName()
|
|
{
|
|
return ltrim($this->full_log_file, "./");
|
|
}
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* Reads the config file for logger settings
|
|
*/
|
|
public function __construct()
|
|
{
|
|
$this->init();
|
|
}
|
|
|
|
protected function init(): void
|
|
{
|
|
$config = SugarConfig::getInstance();
|
|
$this->ext = $config->get('logger.file.ext', $this->ext);
|
|
$this->logfile = $config->get('logger.file.name', $this->logfile);
|
|
$this->dateFormat = $config->get('logger.file.dateFormat', $this->dateFormat);
|
|
$this->logSize = $config->get('logger.file.maxSize', $this->logSize);
|
|
$this->maxLogs = $config->get('logger.file.maxLogs', $this->maxLogs);
|
|
$this->filesuffix = $config->get('logger.file.suffix', $this->filesuffix);
|
|
$this->defaultPerms = $config->get('logger.file.perms', $this->defaultPerms);
|
|
$log_dir = $config->get('log_dir', $this->log_dir);
|
|
$this->log_dir = $log_dir . (empty($log_dir)?'':'/');
|
|
unset($config);
|
|
$this->_doInitialization();
|
|
LoggerManager::setLogger('default', 'SugarLogger');
|
|
}
|
|
|
|
/**
|
|
* Handles the SugarLogger initialization
|
|
*/
|
|
protected function _doInitialization()
|
|
{
|
|
if ($this->filesuffix && array_key_exists($this->filesuffix, self::$filename_suffix)) { //if the global config contains date-format suffix, it will create suffix by parsing datetime
|
|
$this->date_suffix = "_" . date(str_replace("%", "", $this->filesuffix));
|
|
}
|
|
$this->full_log_file = $this->log_dir . $this->logfile . $this->date_suffix . $this->ext;
|
|
$this->setDateFormatter();
|
|
$this->initialized = $this->_fileCanBeCreatedAndWrittenTo();
|
|
$this->rollLog();
|
|
}
|
|
|
|
/**
|
|
* Checks to see if the SugarLogger file can be created and written to
|
|
* @noinspection PhpUndefinedFieldInspection
|
|
* @return bool
|
|
*/
|
|
protected function _fileCanBeCreatedAndWrittenTo()
|
|
{
|
|
if (is_writable($this->full_log_file)) {
|
|
return true;
|
|
}
|
|
|
|
if (!is_file($this->full_log_file)) {
|
|
@touch($this->full_log_file);
|
|
if ($this->defaultPerms !== false) {
|
|
@chmod($this->full_log_file, $this->defaultPerms);
|
|
}
|
|
|
|
return is_writable($this->full_log_file);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* for log() function, it shows a backtrace information in log when
|
|
* the 'show_log_trace' config variable is set and true
|
|
* @return string a readable trace string
|
|
*/
|
|
private function getTraceString()
|
|
{
|
|
$ret = '';
|
|
$trace = debug_backtrace();
|
|
foreach ($trace as $call) {
|
|
$file = isset($call['file']) ? $call['file'] : '???';
|
|
$line = isset($call['line']) ? $call['line'] : '???';
|
|
$class = isset($call['class']) ? $call['class'] : '';
|
|
$type = isset($call['type']) ? $call['type'] : '';
|
|
$function = isset($call['function']) ? $call['function'] : '???';
|
|
$ret .= "\nCall in {$file} at #{$line} from {$class}{$type}{$function}(...)";
|
|
}
|
|
$ret .= "\n";
|
|
return $ret;
|
|
}
|
|
|
|
private function convertStrftimeToIntl(string $strftimeFormat): string {
|
|
$map = [
|
|
'%a' => 'EEE', // Abbreviated weekday name (Mon, Tue)
|
|
'%A' => 'EEEE', // Full weekday name (Monday, Tuesday)
|
|
'%b' => 'MMM', // Abbreviated month name (Jan, Feb)
|
|
'%B' => 'MMMM', // Full month name (January, February)
|
|
'%C' => 'yy', // Century (20 for the year 2024)
|
|
'%d' => 'dd', // Day of the month (01-31)
|
|
'%e' => 'd', // Day of the month without leading zero (1-31)
|
|
'%D' => 'MM/dd/yy', // Short date (equivalent to %m/%d/%y)
|
|
'%F' => 'yyyy-MM-dd', // ISO 8601 date (equivalent to %Y-%m-%d)
|
|
'%H' => 'HH', // Hour (24-hour format, 00-23)
|
|
'%I' => 'hh', // Hour (12-hour format, 01-12)
|
|
'%j' => 'D', // Day of the year (001-366)
|
|
'%m' => 'MM', // Month (01-12)
|
|
'%M' => 'mm', // Minutes (00-59)
|
|
'%n' => "\n", // New line (not applicable in IntlDateFormatter)
|
|
'%p' => 'a', // AM/PM marker
|
|
'%r' => 'hh:mm:ss a', // 12-hour clock time (equivalent to %I:%M:%S %p)
|
|
'%R' => 'HH:mm', // 24-hour time format without seconds
|
|
'%S' => 'ss', // Seconds (00-59)
|
|
'%T' => 'HH:mm:ss', // Full time format (equivalent to %H:%M:%S)
|
|
'%u' => 'e', // ISO-8601 weekday (1=Monday, 7=Sunday)
|
|
'%w' => 'c', // Weekday (0=Sunday, 6=Saturday)
|
|
'%x' => 'dd/MM/yy', // Short date representation (locale-dependent)
|
|
'%X' => 'HH:mm:ss', // Full time representation (locale-dependent)
|
|
'%y' => 'yy', // Year without century (00-99)
|
|
'%Y' => 'yyyy', // Year with century (2024)
|
|
'%z' => 'Z', // Time zone offset (e.g., +0100)
|
|
'%Z' => 'VV', // Time zone name (e.g., Europe/Madrid)
|
|
'%c' => 'EEE MMM dd HH:mm:ss yyyy', // Format for Fri Feb 07 10:00:13 2025
|
|
'%%' => '%', // Literal percent sign
|
|
];
|
|
|
|
// Special processing for unsupported values
|
|
$strftimeFormat = str_replace('%s', time(), $strftimeFormat); // %s → UNIX Timestamp
|
|
$strftimeFormat = str_replace('%U', date('W'), $strftimeFormat); // %U → Week of the year
|
|
|
|
return strtr($strftimeFormat, $map);
|
|
}
|
|
|
|
private function setDateFormatter() {
|
|
$intlFormat = $this->convertStrftimeToIntl($this->dateFormat);
|
|
|
|
$this->dateFormatter = new IntlDateFormatter(
|
|
locale_get_default(),
|
|
IntlDateFormatter::NONE,
|
|
IntlDateFormatter::NONE,
|
|
date_default_timezone_get(),
|
|
IntlDateFormatter::GREGORIAN,
|
|
$intlFormat
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Show log
|
|
* and show a backtrace information in log when
|
|
* the 'show_log_trace' config variable is set and true
|
|
* see LoggerTemplate::log()
|
|
*/
|
|
public function log(
|
|
$level,
|
|
$message
|
|
) {
|
|
global $sugar_config, $timezone;
|
|
|
|
if (!$this->initialized) {
|
|
return;
|
|
}
|
|
//lets get the current user id or default to -none- if it is not set yet
|
|
$userID = (!empty($GLOBALS['current_user']->id))?$GLOBALS['current_user']->id:'-none-';
|
|
|
|
//if we haven't opened a file pointer yet let's do that
|
|
if (! $this->fp) {
|
|
$this->fp = fopen($this->full_log_file, 'ab');
|
|
|
|
// Check if fopen failed and provide clear error message
|
|
if ($this->fp === false) {
|
|
// Try to provide a helpful error message
|
|
$error_msg = "SugarLogger: Unable to open log file '{$this->full_log_file}' for writing. ";
|
|
|
|
if (!file_exists(dirname($this->full_log_file))) {
|
|
$error_msg .= "Directory '" . dirname($this->full_log_file) . "' does not exist.";
|
|
} elseif (!is_writable(dirname($this->full_log_file))) {
|
|
$error_msg .= "Directory '" . dirname($this->full_log_file) . "' is not writable.";
|
|
} elseif (file_exists($this->full_log_file) && !is_writable($this->full_log_file)) {
|
|
$error_msg .= "Log file exists but is not writable.";
|
|
} else {
|
|
$error_msg .= "Check file permissions and disk space.";
|
|
}
|
|
|
|
// Output error to stderr so it doesn't corrupt web responses
|
|
error_log($error_msg);
|
|
}
|
|
}
|
|
|
|
|
|
// change to a string if there is just one entry
|
|
if (is_array($message) && count($message) == 1) {
|
|
$message = array_shift($message);
|
|
}
|
|
// change to a human-readable array output if it's any other array
|
|
if (is_array($message)) {
|
|
$message = print_r($message, true);
|
|
}
|
|
|
|
|
|
if (isset($sugar_config['show_log_trace']) && $sugar_config['show_log_trace']) {
|
|
$trace = $this->getTraceString();
|
|
$message .= ("\n" . $trace);
|
|
}
|
|
|
|
$language = $sugar_config['default_language'];
|
|
|
|
$format = new IntlDateFormatter(
|
|
$language,
|
|
IntlDateFormatter::MEDIUM,
|
|
IntlDateFormatter::MEDIUM,
|
|
$timezone,
|
|
IntlDateFormatter::GREGORIAN,
|
|
$this->getDateFormatString(),
|
|
);
|
|
|
|
//write out to the file including the time in the dateFormat the process id , the user id , and the log level as well as the message
|
|
if (is_resource($this->fp)) {
|
|
fwrite(
|
|
$this->fp,
|
|
$this->formatLog($format, $userID, $level, $message)
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* rolls the logger file to start using a new file
|
|
*/
|
|
protected function rollLog(
|
|
$force = false
|
|
) {
|
|
if (!$this->initialized || empty($this->logSize)) {
|
|
return;
|
|
}
|
|
// bug#50265: Parse the its unit string and get the size properly
|
|
$units = array(
|
|
'b' => 1, //Bytes
|
|
'k' => 1024, //KBytes
|
|
'm' => 1024 * 1024, //MBytes
|
|
'g' => 1024 * 1024 * 1024, //GBytes
|
|
);
|
|
if (preg_match('/^\s*([0-9]+\.[0-9]+|\.?[0-9]+)\s*(k|m|g|b)(b?ytes)?/i', $this->logSize, $match)) {
|
|
$rollAt = ( int ) $match[1] * $units[strtolower($match[2])];
|
|
}
|
|
//check if our log file is greater than that or if we are forcing the log to roll if and only if roll size assigned the value correctly
|
|
if ($force || ($rollAt && filesize($this->full_log_file) >= $rollAt)) {
|
|
//now lets move the logs starting at the oldest and going to the newest
|
|
for ($i = $this->maxLogs - 2; $i > 0; $i --) {
|
|
if (file_exists($this->log_dir . $this->logfile . $this->date_suffix . '_'. $i . $this->ext)) {
|
|
$to = $i + 1;
|
|
$old_name = $this->log_dir . $this->logfile . $this->date_suffix . '_'. $i . $this->ext;
|
|
$new_name = $this->log_dir . $this->logfile . $this->date_suffix . '_'. $to . $this->ext;
|
|
//nsingh- Bug 22548 Win systems fail if new file name already exists. The fix below checks for that.
|
|
//if/else branch is necessary as suggested by someone on php-doc ( see rename function ).
|
|
sugar_rename($old_name, $new_name);
|
|
|
|
//rename ( $this->logfile . $i . $this->ext, $this->logfile . $to . $this->ext );
|
|
}
|
|
}
|
|
//now lets move the current .log file
|
|
sugar_rename($this->full_log_file, $this->log_dir . $this->logfile . $this->date_suffix . '_1' . $this->ext);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* This is needed to prevent unserialize vulnerability
|
|
*/
|
|
public function __wakeup()
|
|
{
|
|
// clean all properties
|
|
foreach (get_object_vars($this) as $k => $v) {
|
|
$this->$k = null;
|
|
}
|
|
throw new Exception("Not a serializable object");
|
|
}
|
|
|
|
/**
|
|
* Destructor
|
|
*
|
|
* Closes the SugarLogger file handle
|
|
*/
|
|
public function __destruct()
|
|
{
|
|
if ($this->fp) {
|
|
fclose($this->fp);
|
|
$this->fp = false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
protected function getDateFormatString(): string
|
|
{
|
|
return "EEE MMM d yyyy 'at' HH:mm:ss";
|
|
}
|
|
|
|
/**
|
|
* @param IntlDateFormatter $format
|
|
* @param string $userID
|
|
* @param $level
|
|
* @param mixed $message
|
|
* @return string
|
|
*/
|
|
protected function formatLog(IntlDateFormatter $format, string $userID, $level, mixed $message): string
|
|
{
|
|
return $format->format(time()) . ' [' . getmypid() . '][' . $userID . '][' . strtoupper($level) . '] ' . $message . "\n";
|
|
}
|
|
}
|
