Enable "System Log" - "System Log" has capability to record PHP Exceptions, Errors, Warnings, Notices, Database/SQL
+ Errors and Warnings, and User defined messages that happened on your website. It has 3 modes - Enabled (logs everything, including user
+ defined messages), User-only (user defined messages only), and Disabled (don't log anything at all - default setting).
+
]]>
Index: core/install/upgrades.sql
===================================================================
--- core/install/upgrades.sql (revision 15550)
+++ core/install/upgrades.sql (working copy)
@@ -2806,3 +2806,53 @@
INSERT INTO EmailEvents (EventId, Event, ReplacementTags, Enabled, FrontEndOnly, Module, Description, Type, AllowChangingSender, AllowChangingRecipient) VALUES(DEFAULT, 'USER.NEW.PASSWORD', NULL, 1, 0, 'Core', 'Sends new password to an existing user', 0, 1, 0);
INSERT INTO EmailEvents (EventId, Event, ReplacementTags, Enabled, FrontEndOnly, Module, Description, Type, AllowChangingSender, AllowChangingRecipient) VALUES(DEFAULT, 'USER.ADD.BYADMIN', NULL, 1, 0, 'Core', 'Sends password to a new user', 0, 1, 0);
+
+CREATE TABLE SystemLog (
+ LogId int(11) NOT NULL AUTO_INCREMENT,
+ LogUniqueId int(11) DEFAULT NULL,
+ LogLevel tinyint(4) NOT NULL DEFAULT '7',
+ LogType tinyint(4) NOT NULL DEFAULT '3',
+ LogCode int(11) DEFAULT NULL,
+ LogMessage longtext,
+ LogTimestamp int(11) DEFAULT NULL,
+ LogDate datetime DEFAULT NULL,
+ LogEventName varchar(100) NOT NULL DEFAULT '',
+ LogHostname varchar(255) NOT NULL DEFAULT '',
+ LogRequestSource tinyint(4) DEFAULT NULL,
+ LogRequestURI varchar(255) NOT NULL DEFAULT '',
+ LogRequestData longtext,
+ LogUserId int(11) DEFAULT NULL,
+ LogInterface tinyint(4) DEFAULT NULL,
+ IpAddress varchar(15) NOT NULL DEFAULT '',
+ LogSessionKey int(11) DEFAULT NULL,
+ LogSessionData longtext,
+ LogBacktrace longtext,
+ LogSourceFilename varchar(255) NOT NULL DEFAULT '',
+ LogSourceFileLine int(11) DEFAULT NULL,
+ LogProcessId bigint(20) unsigned DEFAULT NULL,
+ LogMemoryUsed bigint(20) unsigned NOT NULL,
+ LogUserData longtext NOT NULL,
+ LogNotificationStatus tinyint(4) NOT NULL DEFAULT '0',
+ PRIMARY KEY (LogId),
+ KEY LogLevel (LogLevel),
+ KEY LogType (LogType),
+ KEY LogNotificationStatus (LogNotificationStatus)
+);
+
+INSERT INTO SystemSettings VALUES(DEFAULT, 'EnableEmailLog', '1', 'In-Portal', 'in-portal:configure_advanced', 'la_section_SettingsLogs', 'la_config_EnableEmailLog', 'radio', NULL, '1=la_Yes||0=la_No', 65.01, 0, 1, 'hint:la_config_EnableEmailLog');
+
+UPDATE SystemSettings
+SET DisplayOrder = 65.02, Heading = 'la_section_SettingsLogs', ValueList = '86400=la_opt_OneDay||604800=la_opt_OneWeek||1209600=la_opt_TwoWeeks||2419200=la_opt_OneMonth||7257600=la_opt_ThreeMonths||29030400=la_opt_OneYear||-1=la_opt_EmailLogKeepForever'
+WHERE VariableName = 'EmailLogRotationInterval';
+
+UPDATE LanguageLabels
+SET
+ l<%PRIMARY_LANGUAGE%>_Translation = 'Keep "E-mail Log" for',
+ l<%PRIMARY_LANGUAGE%>_HintTranslation = 'This setting allows you to control for how long "E-mail Log" messages will be stored in the log and then automatically deleted. Use option "Forever" with caution since it will completely disable automatic log cleanup and can lead to large size of database table that stores e-mail messages.'
+WHERE PhraseKey = 'LA_CONFIG_EMAILLOGROTATIONINTERVAL' AND l<%PRIMARY_LANGUAGE%>_Translation = 'Keep Email Log for';
+
+DELETE FROM LanguageLabels WHERE PhraseKey = 'LA_OPT_EMAILLOGKEEPNEVER';
+
+INSERT INTO SystemSettings VALUES(DEFAULT, 'SystemLogRotationInterval', '2419200', 'In-Portal', 'in-portal:configure_advanced', 'la_section_SettingsLogs', 'la_config_SystemLogRotationInterval', 'select', NULL, '86400=la_opt_OneDay||604800=la_opt_OneWeek||1209600=la_opt_TwoWeeks||2419200=la_opt_OneMonth||7257600=la_opt_ThreeMonths||29030400=la_opt_OneYear||-1=la_opt_SystemLogKeepForever', 65.03, 0, 1, 'hint:la_config_SystemLogRotationInterval');
+INSERT INTO SystemSettings VALUES(DEFAULT, 'SystemLogNotificationEmail', '', 'In-Portal', 'in-portal:configure_advanced', 'la_section_SettingsLogs', 'la_config_SystemLogNotificationEmail', 'text', 'a:5:{s:4:"type";s:6:"string";s:9:"formatter";s:10:"kFormatter";s:6:"regexp";s:85:"/^([-a-zA-Z0-9!\\#$%&*+\\/=?^_`{|}~.]+@[a-zA-Z0-9]{1}[-.a-zA-Z0-9_]*\\.[a-zA-Z]{2,6})$/i";s:10:"error_msgs";a:1:{s:14:"invalid_format";s:18:"!la_invalid_email!";}s:7:"default";s:0:"";}', NULL, 65.04, 0, 1, 'hint:la_config_SystemLogNotificationEmail');
+INSERT INTO EmailEvents (EventId, Event, ReplacementTags, Enabled, FrontEndOnly, Module, Description, Type, AllowChangingSender, AllowChangingRecipient) VALUES(DEFAULT, 'SYSTEM.LOG.NOTIFY', NULL, 1, 0, 'Core', 'Notification about message added to System Log', 1, 1, 1);
Index: core/kernel/application.php
===================================================================
--- core/kernel/application.php (revision 15543)
+++ core/kernel/application.php (working copy)
@@ -115,21 +115,13 @@
public $Conn = null;
/**
- * Maintains list of user-defined error handlers
+ * Reference to event log
*
- * @var Array
+ * @var Array|kLogger
* @access public
*/
- public $errorHandlers = Array ();
+ protected $_logger = Array ();
- /**
- * Maintains list of user-defined exception handlers
- *
- * @var Array
- * @access public
- */
- public $exceptionHandlers = Array ();
-
// performance needs:
/**
* Holds a reference to httpquery
@@ -301,31 +293,13 @@
$this->Debugger->appendMemoryUsage('Application before Init:');
}
- if ( !$this->isDebugMode() && !kUtil::constOn('DBG_ZEND_PRESENT') ) {
- error_reporting(0);
- ini_set('display_errors', 0);
- }
-
- if ( !kUtil::constOn('DBG_ZEND_PRESENT') ) {
- $error_handler = set_error_handler(Array (&$this, 'handleError'));
- if ( $error_handler ) {
- // wrap around previous error handler, if any was set
- $this->errorHandlers[] = $error_handler;
- }
-
- $exception_handler = set_exception_handler(Array (&$this, 'handleException'));
- if ( $exception_handler ) {
- // wrap around previous exception handler, if any was set
- $this->exceptionHandlers[] = $exception_handler;
- }
- }
-
+ $this->_logger = new kLogger($this->_logger);
$this->Factory = new $factory_class();
$this->registerDefaultClasses();
$vars = kUtil::parseConfig(true);
$db_class = isset($vars['Databases']) ? 'kDBLoadBalancer' : ($this->isDebugMode() ? 'kDBConnectionDebug' : 'kDBConnection');
- $this->Conn = $this->Factory->makeClass($db_class, Array (SQL_TYPE, Array (&$this, 'handleSQLError')));
+ $this->Conn = $this->Factory->makeClass($db_class, Array (SQL_TYPE, Array ($this->_logger, 'handleSQLError')));
$this->Conn->setup($vars);
$this->cacheManager = $this->makeClass('kCacheManager');
@@ -752,6 +726,7 @@
$this->registerClass('kTempTablesHandler', KERNEL_PATH . '/utility/temp_handler.php');
$this->registerClass('kValidator', KERNEL_PATH . '/utility/validator.php');
$this->registerClass('kOpenerStack', KERNEL_PATH . '/utility/opener_stack.php');
+ $this->registerClass('kLogger', KERNEL_PATH . '/utility/logger.php');
$this->registerClass('kUnitConfigReader', KERNEL_PATH . '/utility/unit_config_reader.php');
@@ -2404,224 +2379,15 @@
* @param string $sql
* @return bool
* @access public
+ * @throws Exception
+ * @deprecated
*/
public function handleSQLError($code, $msg, $sql)
{
- if ( isset($this->Debugger) ) {
- $long_error_msg = '' . $msg . ' (' . $code . ') SQL: ' . $this->Debugger->formatSQL($sql);
- $long_id = $this->Debugger->mapLongError($long_error_msg);
- $error_msg = mb_substr($msg . ' (' . $code . ') [' . $sql . ']', 0, 1000) . ' #' . $long_id;
-
- if ( kUtil::constOn('DBG_SQL_FAILURE') && !defined('IS_INSTALL') ) {
- throw new Exception($error_msg);
- }
- else {
- $this->Debugger->appendTrace();
- }
- }
- else {
- // when not debug mode, then fatal database query won't break anything
- $error_msg = 'SQL Error in sql: ' . $sql . ', code ' . $code . ' (' . $msg . ')';
- }
-
- trigger_error($error_msg, E_USER_WARNING);
-
- return true;
+ return $this->_logger->handleSQLError($code, $msg, $sql);
}
/**
- * Default error handler
- *
- * @param int $errno
- * @param string $errstr
- * @param string $errfile
- * @param int $errline
- * @param Array $errcontext
- * @return bool
- * @access public
- */
- public function handleError($errno, $errstr, $errfile = null, $errline = null, $errcontext = Array ())
- {
- $this->errorLogSilent($errno, $errstr, $errfile, $errline);
-
- $debug_mode = defined('DEBUG_MODE') && DEBUG_MODE;
- $skip_reporting = defined('DBG_SKIP_REPORTING') && DBG_SKIP_REPORTING;
-
- if ( !$this->errorHandlers || ($debug_mode && $skip_reporting) ) {
- // when debugger absent OR it's present, but we actually can't see it's error report (e.g. during ajax request)
- if ( $errno == E_USER_ERROR ) {
- $this->errorDisplayFatal('Fatal Error: ' . "{$errstr} in {$errfile} on line {$errline}");
- }
-
- if ( !$this->errorHandlers ) {
- return true;
- }
- }
-
- $res = false;
- /* @var $handler Closure */
-
- foreach ($this->errorHandlers as $handler) {
- if ( is_array($handler) ) {
- $object =& $handler[0];
- $method = $handler[1];
- $res = $object->$method($errno, $errstr, $errfile, $errline, $errcontext);
- }
- else {
- $res = $handler($errno, $errstr, $errfile, $errline, $errcontext);
- }
- }
-
- return $res;
- }
-
- /**
- * Handles exception
- *
- * @param Exception $exception
- * @return bool
- * @access public
- */
- public function handleException($exception)
- {
- // transform exception to regular error (no need to rewrite existing error handlers)
- $errno = $exception->getCode();
- $errstr = $exception->getMessage();
- $errfile = $exception->getFile();
- $errline = $exception->getLine();
-
- $this->errorLogSilent($errno, $errstr, $errfile, $errline);
-
- $debug_mode = defined('DEBUG_MODE') && DEBUG_MODE;
- $skip_reporting = defined('DBG_SKIP_REPORTING') && DBG_SKIP_REPORTING;
-
- if ( $exception instanceof kRedirectException ) {
- /* @var $exception kRedirectException */
-
- $exception->run();
- }
-
- if ( !$this->exceptionHandlers || ($debug_mode && $skip_reporting) ) {
- // when debugger absent OR it's present, but we actually can't see it's error report (e.g. during ajax request)
- $this->errorDisplayFatal('' . get_class($exception) . ': ' . "{$errstr} in {$errfile} on line {$errline}");
-
- if ( !$this->exceptionHandlers ) {
- return true;
- }
- }
-
- $res = false;
- /* @var $handler Closure */
-
- foreach ($this->exceptionHandlers as $handler) {
- if ( is_array($handler) ) {
- $object =& $handler[0];
- $method = $handler[1];
- $res = $object->$method($exception);
- }
- else {
- $res = $handler($exception);
- }
- }
-
- return $res;
- }
-
- /**
- * Silently saves each given error message to "silent_log.txt" file, when silent log mode is enabled
- * @param int $errno
- * @param string $errstr
- * @param string $errfile
- * @param int $errline
- * @return void
- * @access protected
- */
- protected function errorLogSilent($errno, $errstr = '', $errfile = '', $errline = null)
- {
- if ( !defined('SILENT_LOG') || !SILENT_LOG ) {
- return;
- }
-
- if ( !(defined('DBG_IGNORE_STRICT_ERRORS') && DBG_IGNORE_STRICT_ERRORS && defined('E_STRICT') && ($errno == E_STRICT)) ) {
- $time = adodb_date('d/m/Y H:i:s');
-
- $fp = fopen((defined('RESTRICTED') ? RESTRICTED : FULL_PATH) . '/silent_log.txt', 'a');
- fwrite($fp, '[' . $time . '] #' . $errno . ': ' . strip_tags($errstr) . ' in [' . $errfile . '] on line ' . $errline . "\n");
- fclose($fp);
- }
- }
-
- /**
- * Displays div with given error message
- *
- * @param string $msg
- * @return void
- * @access protected
- */
- protected function errorDisplayFatal($msg)
- {
- $margin = $this->isAdmin ? '8px' : 'auto';
- echo '
' . $msg . '
';
- exit;
- }
-
- /**
- * Prints trace, when debug mode is not available
- *
- * @param bool $return_result
- * @param int $skip_levels
- * @return string
- * @access public
- */
- public function printTrace($return_result = false, $skip_levels = 1)
- {
- $ret = Array ();
- $trace = debug_backtrace(false);
-
- for ($i = 0; $i < $skip_levels; $i++) {
- array_shift($trace);
- }
-
- foreach ($trace as $level => $trace_info) {
- if ( isset($trace_info['class']) ) {
- $object = $trace_info['class'];
- }
- elseif ( isset($trace_info['object']) ) {
- $object = get_class($trace_info['object']);
- }
- else {
- $object = '';
- }
-
- $args = '';
- $type = isset($trace_info['type']) ? $trace_info['type'] : '';
-
- if ( isset($trace_info['args']) ) {
- foreach ($trace_info['args'] as $argument) {
- if ( is_object($argument) ) {
- $args .= get_class($argument) . ' instance, ';
- }
- else {
- $args .= is_array($argument) ? 'Array' : substr($argument, 0, 10) . ' ..., ';
- }
- }
-
- $args = substr($args, 0, -2);
- }
-
- $ret[] = '#' . $level . ' ' . $object . $type . $trace_info['function'] . '(' . $args . ') called at [' . $trace_info['file'] . ':' . $trace_info['line'] . ']';
- }
-
- if ( $return_result ) {
- return implode("\n", $ret);
- }
-
- echo implode("\n", $ret);
-
- return '';
- }
-
- /**
* Returns & blocks next ResourceId available in system
*
* @return int
@@ -3238,4 +3004,38 @@
$already_set = true;
header($header);
}
+
+ /**
+ * Posts message to event log
+ *
+ * @param string $message
+ * @param int $code
+ * @param bool $write_now Allows further customization of log record by returning kLog object
+ * @return bool|int|kLogger
+ * @access public
+ */
+ public function log($message, $code = null, $write_now = false)
+ {
+ $log = $this->_logger->prepare($message, $code)->addSource($this->_logger->createTrace(null, 1));
+
+ if ( $write_now ) {
+ return $log->write();
+ }
+
+ return $log;
+ }
+
+ /**
+ * Deletes log with given id from database or disk, when database isn't available
+ *
+ * @param int $unique_id
+ * @param int $storage_medium
+ * @return void
+ * @access public
+ * @throws InvalidArgumentException
+ */
+ public function deleteLog($unique_id, $storage_medium = kLogger::LS_AUTOMATIC)
+ {
+ $this->_logger->delete($unique_id, $storage_medium);
+ }
}
\ No newline at end of file
Index: core/kernel/db/db_connection.php
===================================================================
--- core/kernel/db/db_connection.php (revision 15518)
+++ core/kernel/db/db_connection.php (working copy)
@@ -314,6 +314,17 @@
}
/**
+ * Checks if connection to database is opened
+ *
+ * @return bool
+ * @access public
+ */
+ public function connectionOpened()
+ {
+ return $this->connectionOpened;
+ }
+
+ /**
* Setups the connection according given configuration
*
* @param Array $config
Index: core/kernel/db/db_load_balancer.php
===================================================================
--- core/kernel/db/db_load_balancer.php (revision 15437)
+++ core/kernel/db/db_load_balancer.php (working copy)
@@ -450,6 +450,20 @@
}
/**
+ * Checks if connection to the server given by the specified index is opened
+ *
+ * @param integer $i Server index
+ * @return bool
+ * @access public
+ */
+ public function connectionOpened($i = null)
+ {
+ $conn =& $this->openConnection(isset($i) ? $i : $this->getMasterIndex());
+
+ return $conn ? $conn->connectionOpened : false;
+ }
+
+ /**
* Really opens a connection.
* Returns a database object whether or not the connection was successful.
*
Index: core/kernel/kbase.php
===================================================================
--- core/kernel/kbase.php (revision 15437)
+++ core/kernel/kbase.php (working copy)
@@ -101,6 +101,17 @@
{
return $this->prefixSpecial;
}
+
+ /**
+ * Creates string representation of a class (for logging)
+ *
+ * @return string
+ * @access public
+ */
+ public function __toString()
+ {
+ return 'ClassName: ' . get_class($this) . '; PrefixSpecial: ' . $this->getPrefixSpecial();
+ }
}
Index: core/kernel/session/session.php
===================================================================
--- core/kernel/session/session.php (revision 15517)
+++ core/kernel/session/session.php (working copy)
@@ -732,45 +732,91 @@
$this->Data->AddParams( $this->Storage->LoadData() );
}
- function PrintSession($comment = '')
+ /**
+ * Returns information about session contents
+ *
+ * @param bool $include_optional
+ * @return array
+ * @access public
+ */
+ public function getSessionData($include_optional = true)
{
- if (defined('DEBUG_MODE') && $this->Application->isDebugMode() && kUtil::constOn('DBG_SHOW_SESSIONDATA')) {
- // dump session data
- $this->Application->Debugger->appendHTML('SessionStorage [' . ($this->RecallVar('admin') == 1 ? 'Admin' : 'Front-End') . '] ('.$comment.'):');
- $session_data = $this->Data->GetParams();
- ksort($session_data);
+ $session_data = $this->Data->GetParams();
+ ksort($session_data);
+
+ foreach ($session_data as $session_key => $session_value) {
+ if ( kUtil::IsSerialized($session_value) ) {
+ $session_data[$session_key] = unserialize($session_value);
+ }
+ }
+
+ if ( !$include_optional ) {
+ $optional_keys = array_keys($this->OptionalData);
+
foreach ($session_data as $session_key => $session_value) {
- if (kUtil::IsSerialized($session_value)) {
- $session_data[$session_key] = unserialize($session_value);
+ if ( in_array($session_key, $optional_keys) ) {
+ unset($session_data[$session_key]);
}
}
+ }
+
+ return $session_data;
+ }
+
+ /**
+ * Returns real session data, that was saved
+ *
+ * @param Array $session_data
+ * @return Array
+ * @access protected
+ */
+ protected function _getRealSessionData($session_data)
+ {
+ $data_keys = array_keys($session_data);
+ $optional_keys = array_keys($this->OptionalData);
+ $real_keys = array_diff($data_keys, $optional_keys);
+
+ if ( !$real_keys ) {
+ return Array ();
+ }
+
+ $ret = Array ();
+
+ foreach ($real_keys as $real_key) {
+ $ret[$real_key] = $session_data[$real_key];
+ }
+
+ return $ret;
+ }
+
+ function PrintSession($comment = '')
+ {
+ if ( defined('DEBUG_MODE') && $this->Application->isDebugMode() && kUtil::constOn('DBG_SHOW_SESSIONDATA') ) {
+ // dump session data
+ $this->Application->Debugger->appendHTML('SessionStorage [' . ($this->RecallVar('admin') == 1 ? 'Admin' : 'Front-End') . '] (' . $comment . '):');
+
+ $session_data = $this->getSessionData();
$this->Application->Debugger->dumpVars($session_data);
- if (!$this->RecallVar('admin')) {
+ if ( !$this->RecallVar('admin') ) {
// dump real keys (only for front-end)
- $data_keys = array_keys($session_data);
- $optional_keys = array_keys($this->OptionalData);
- $real_keys = array_diff($data_keys, $optional_keys);
+ $real_session_data = $this->_getRealSessionData($session_data);
- if ($real_keys) {
- $ret = '';
- foreach ($real_keys as $real_key) {
- $ret .= '[' . $real_key . '] = [' . $session_data[$real_key] . '] ';
- }
-
- $this->Application->Debugger->appendHTML('Real Keys: ' . $ret);
+ if ( $real_session_data ) {
+ $this->Application->Debugger->appendHTML('Real Keys:');
+ $this->Application->Debugger->dumpVars($real_session_data);
}
}
}
- if (defined('DEBUG_MODE') && $this->Application->isDebugMode() && kUtil::constOn('DBG_SHOW_PERSISTENTDATA')) {
+ if ( defined('DEBUG_MODE') && $this->Application->isDebugMode() && kUtil::constOn('DBG_SHOW_PERSISTENTDATA') ) {
// dump persistent session data
- if ($this->Storage->PersistentVars) {
+ if ( $this->Storage->PersistentVars ) {
$this->Application->Debugger->appendHTML('Persistant Session:');
$session_data = $this->Storage->PersistentVars;
ksort($session_data);
foreach ($session_data as $session_key => $session_value) {
- if (kUtil::IsSerialized($session_value)) {
+ if ( kUtil::IsSerialized($session_value) ) {
$session_data[$session_key] = unserialize($session_value);
}
}
Index: core/kernel/startup.php
===================================================================
--- core/kernel/startup.php (revision 15445)
+++ core/kernel/startup.php (working copy)
@@ -178,6 +178,7 @@
KERNEL_PATH . '/db/db_connection.php',
KERNEL_PATH . '/db/db_load_balancer.php',
KERNEL_PATH . '/utility/event.php',
+ KERNEL_PATH . '/utility/logger.php',
KERNEL_PATH . "/utility/factory.php",
KERNEL_PATH . "/languages/phrases_cache.php",
KERNEL_PATH . "/db/dblist.php",
Index: core/kernel/utility/debugger.php
===================================================================
--- core/kernel/utility/debugger.php (revision 15530)
+++ core/kernel/utility/debugger.php (working copy)
@@ -178,6 +178,14 @@
private $IsFatalError = false;
/**
+ * Tells if last error (if any) caught by shutdown function was processed
+ *
+ * @var bool
+ * @access private
+ */
+ private $_lastErrorProcessed = false;
+
+ /**
* Counts warnings on the page
*
* @var int
@@ -250,14 +258,6 @@
private $scrollbarWidth = 0;
/**
- * Long errors are saved here, because trigger_error doesn't support error messages over 1KB in size
- *
- * @var Array
- * @access private
- */
- private $longErrors = Array ();
-
- /**
* Remembers how much memory & time was spent on including files
*
* @var Array
@@ -366,7 +366,7 @@
$this->profileStart('script_runtime', 'Script runtime', $start);
$this->LastMoment = $start;
- error_reporting(E_ALL);
+ error_reporting(E_ALL & ~E_STRICT);
// show errors on screen in case if not in Zend Studio debugging
ini_set('display_errors', DebuggerUtil::constOn('DBG_ZEND_PRESENT') ? 0 : 1);
@@ -403,7 +403,6 @@
'DBG_WINDOW_WIDTH' => 700, // set width of debugger window (in pixels) for better viewing large amount of debug data
'DBG_USE_SHUTDOWN_FUNC' => DBG_ZEND_PRESENT ? 0 : 1, // use shutdown function to include debugger code into output
'DBG_HANDLE_ERRORS' => DBG_ZEND_PRESENT ? 0 : 1, // handle all allowed by php (see php manual) errors instead of default handler
- 'DBG_IGNORE_STRICT_ERRORS' => 0, // ignore PHP5 errors about private/public view modified missing in class declarations
'DBG_DOMVIEWER' => '/temp/domviewer.html', // path to DOMViewer on website
'DOC_ROOT' => str_replace('\\', '/', realpath($_SERVER['DOCUMENT_ROOT']) ), // windows hack
'DBG_LOCAL_BASE_PATH' => 'w:', // replace DOC_ROOT in filenames (in errors) using this path
@@ -481,21 +480,6 @@
}
/**
- * Allows to overcome short error message problem in tigger_error function
- *
- * @param string $msg
- * @return int
- * @access public
- */
- public function mapLongError($msg)
- {
- $key = $this->generateID();
- $this->longErrors[$key] = $msg;
-
- return $key;
- }
-
- /**
* Appends all passed variable values (without variable names) to debug output
*
* @return void
@@ -1337,24 +1321,15 @@
private function getErrorNameByCode($error_code)
{
$error_map = Array (
- 'Fatal Error' => Array (E_USER_ERROR),
- 'Warning' => Array (E_WARNING, E_USER_WARNING),
- 'Notice' => Array (E_NOTICE, E_USER_NOTICE),
+ 'Fatal Error' => Array (E_RECOVERABLE_ERROR, E_USER_ERROR, E_ERROR, E_CORE_ERROR, E_COMPILE_ERROR, E_PARSE),
+ 'Warning' => Array (E_WARNING, E_USER_WARNING, E_CORE_WARNING, E_COMPILE_WARNING),
+ 'Notice' => Array (E_NOTICE, E_USER_NOTICE, E_STRICT),
);
- if ( defined('E_STRICT') ) {
- // since PHP 5
- $error_map['PHP5 Strict'] = Array (E_STRICT);
- }
-
- if ( defined('E_RECOVERABLE_ERROR') ) {
- // since PHP 5.2
- $error_map['Fatal Error (recoverable)'] = Array (E_RECOVERABLE_ERROR);
- }
-
if ( defined('E_DEPRECATED') ) {
// since PHP 5.3
- $error_map['PHP5 Depricated'] = Array (E_DEPRECATED, E_USER_DEPRECATED);
+ $error_map['Notice'][] = E_DEPRECATED;
+ $error_map['Notice'][] = E_USER_DEPRECATED;
}
foreach ($error_map as $error_name => $error_codes) {
@@ -1429,6 +1404,13 @@
return '';
}
+ $last_error = error_get_last();
+
+ if ( !is_null($last_error) && !$this->_lastErrorProcessed ) {
+ $this->_lastErrorProcessed = true;
+ $this->saveError($last_error['type'], $last_error['message'], $last_error['file'], $last_error['line']);
+ }
+
$this->profileFinish('script_runtime');
$this->breakOutofBuffering(!$returnResult);
@@ -1713,10 +1695,6 @@
$this->appendTrace(4);
}
- if ( DebuggerUtil::constOn('DBG_IGNORE_STRICT_ERRORS') && defined('E_STRICT') && ($errno == E_STRICT) ) {
- return false;
- }
-
$this->expandError($errstr, $errfile, $errline);
$this->Data[] = Array (
@@ -1795,11 +1773,11 @@
*/
private function expandError(&$errstr, &$errfile, &$errline)
{
- if ( preg_match('/(.*)#([\d]+)$/', $errstr, $rets) ) {
- // replace short message with long one (due triger_error limitations on message size)
- $long_id = $rets[2];
- $errstr = $this->longErrors[$long_id];
- unset($this->longErrors[$long_id]);
+ $errstr = kLogger::expandMessage($errstr);
+ list ($errno, $errstr, $sql) = kLogger::parseDatabaseError($errstr);
+
+ if ( $errno != 0 ) {
+ $errstr = '' . $errstr . ' (' . $errno . ') SQL: ' . $this->formatSQL($sql);
}
if ( strpos($errfile, 'eval()\'d code') !== false ) {
@@ -1886,20 +1864,14 @@
}
if ( class_exists('kApplication') ) {
- // replace application error/exception handler with own
- restore_error_handler();
- restore_exception_handler();
-
$this->Application =& kApplication::Instance();
- $this->Application->Debugger =& $this;
-
- $this->Application->errorHandlers[] = Array (&$this, 'saveError');
- $this->Application->exceptionHandlers[] = Array (&$this, 'saveException');
+ $this->Application->Debugger = $this;
}
- else {
- set_error_handler( Array (&$this, 'saveError') );
- set_exception_handler( Array (&$this, 'saveException') );
- }
+
+ // kLogger will auto-detect these automatically
+ // error/exception handlers registered before debugger will be removed!
+ set_error_handler( Array ($this, 'saveError') );
+ set_exception_handler( Array ($this, 'saveException') );
}
/**
Index: core/kernel/utility/email.php
===================================================================
--- core/kernel/utility/email.php (revision 15542)
+++ core/kernel/utility/email.php (working copy)
@@ -294,7 +294,7 @@
*/
protected function _storeEmailLog()
{
- return $this->Application->ConfigValue('EmailLogRotationInterval') != '';
+ return $this->Application->ConfigValue('EnableEmailLog');
}
/**
Index: core/kernel/utility/logger.php
===================================================================
--- core/kernel/utility/logger.php (revision 0)
+++ core/kernel/utility/logger.php (revision 0)
@@ -0,0 +1,1364 @@
+_debugMode = $this->Application->isDebugMode();
+ $this->setState(isset($vars['EnableSystemLog']) ? $vars['EnableSystemLog'] : self::STATE_DISABLED);
+ $this->_maxLogLevel = isset($vars['SystemLogMaxLevel']) ? (int)$vars['SystemLogMaxLevel'] : self::LL_NOTICE;
+
+ foreach ($methods_to_call as $method_to_call) {
+ call_user_func_array(Array ($this, $method_to_call[0]), $method_to_call[1]);
+ }
+
+ if ( !kUtil::constOn('DBG_ZEND_PRESENT') && !$this->Application->isDebugMode() ) {
+ // don't report error on screen if debug mode is turned off
+ error_reporting(0);
+ ini_set('display_errors', 0);
+ }
+
+ register_shutdown_function(Array ($this, 'catchLastError'));
+ }
+
+ /**
+ * Sets state of the logged (enabled/user-only/disabled)
+ *
+ * @param $new_state
+ * @return void
+ * @access public
+ */
+ public function setState($new_state = null)
+ {
+ if ( isset($new_state) ) {
+ $this->_state = (int)$new_state;
+ }
+
+ if ( $this->_state === self::STATE_ENABLED ) {
+ $this->_enableErrorHandling();
+ }
+ elseif ( $this->_state === self::STATE_DISABLED ) {
+ $this->_disableErrorHandling();
+ }
+ }
+
+ /**
+ * Enable error/exception handling capabilities
+ *
+ * @return void
+ * @access protected
+ */
+ protected function _enableErrorHandling()
+ {
+ $this->_disableErrorHandling();
+
+ $this->_handlers[self::LL_ERROR] = new kErrorHandlerStack($this);
+ $this->_handlers[self::LL_CRITICAL] = new kExceptionHandlerStack($this);
+ }
+
+ /**
+ * Disables error/exception handling capabilities
+ *
+ * @return void
+ * @access protected
+ */
+ protected function _disableErrorHandling()
+ {
+ foreach ($this->_handlers as $index => $handler) {
+ $this->_handlers[$index]->__destruct();
+ unset($this->_handlers[$index]);
+ }
+ }
+
+ /**
+ * Initializes new log record. Use "kLogger::write" to save to db/disk
+ *
+ * @param string $message
+ * @param int $code
+ * @return kLogger
+ * @access public
+ */
+ public function prepare($message = '', $code = null)
+ {
+ $this->_logRecord = Array (
+ 'LogUniqueId' => kUtil::generateId(),
+ 'LogMessage' => $message,
+ 'LogLevel' => self::LL_INFO,
+ 'LogCode' => $code,
+ 'LogType' => self::LT_OTHER,
+ 'LogHostname' => $_SERVER['HTTP_HOST'],
+ 'LogRequestSource' => php_sapi_name() == 'cli' ? 2 : 1,
+ 'LogRequestURI' => php_sapi_name() == 'cli' ? implode(' ', $GLOBALS['argv']) : $_SERVER['REQUEST_URI'],
+ 'LogUserId' => USER_GUEST,
+ 'IpAddress' => isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : '',
+ 'LogSessionKey' => 0,
+ 'LogProcessId' => getmypid(),
+ 'LogUserData' => '',
+ 'LogNotificationStatus' => self::LNS_DISABLED,
+ );
+
+ if ( $this->Application->isAdmin ) {
+ $this->_logRecord['LogInterface'] = defined('CRON') && CRON ? self::LI_CRON_ADMIN : self::LI_ADMIN;
+ }
+ else {
+ $this->_logRecord['LogInterface'] = defined('CRON') && CRON ? self::LI_CRON_FRONT : self::LI_FRONT;
+ }
+
+ if ( $this->Application->InitDone ) {
+ $this->_logRecord['LogUserId'] = $this->Application->RecallVar('user_id');
+ $this->_logRecord['LogSessionKey'] = $this->Application->GetSID();
+ }
+
+ return $this;
+ }
+
+ /**
+ * Sets one or more fields of log record
+ *
+ * @param string|Array $field_name
+ * @param string|null $field_value
+ * @return kLogger
+ * @access public
+ * @throws UnexpectedValueException
+ */
+ public function setLogField($field_name, $field_value = null)
+ {
+ if ( isset($field_value) ) {
+ $this->_logRecord[$field_name] = $field_value;
+ }
+ elseif ( is_array($field_name) ) {
+ $this->_logRecord = array_merge($this->_logRecord, $field_name);
+ }
+ else {
+ throw new UnexpectedValueException('Invalid arguments');
+ }
+
+ return $this;
+ }
+
+ /**
+ * Sets user data
+ *
+ * @param string $data
+ * @param bool $as_array
+ * @return kLogger
+ * @access public
+ */
+ public function setUserData($data, $as_array = false)
+ {
+ if ( $as_array ) {
+ $data = serialize((array)$data);
+ }
+
+ return $this->setLogField('LogUserData', $data);
+ }
+
+ /**
+ * Add user data
+ *
+ * @param string $data
+ * @param bool $as_array
+ * @return kLogger
+ * @access public
+ */
+ public function addUserData($data, $as_array = false)
+ {
+ $new_data = $this->_logRecord['LogUserData'];
+
+ if ( $as_array ) {
+ $new_data = $new_data ? unserialize($new_data) : Array ();
+ $new_data[] = $data;
+ $new_data = serialize($new_data);
+ }
+ else {
+ $new_data .= ($new_data ? PHP_EOL : '') . $data;
+ }
+
+ return $this->setLogField('LogUserData', $new_data);
+ }
+
+ /**
+ * Adds event to log record
+ *
+ * @param kEvent $event
+ * @return kLogger
+ * @access public
+ */
+ public function addEvent(kEvent $event)
+ {
+ $this->_logRecord['LogEventName'] = (string)$event;
+
+ return $this;
+ }
+
+ /**
+ * Adds log source file & file to log record
+ *
+ * @param string|Array $file_or_trace file path
+ * @param int $line file line
+ * @return kLogger
+ * @access public
+ */
+ public function addSource($file_or_trace = '', $line = 0)
+ {
+ if ( is_array($file_or_trace) ) {
+ $trace_info = $file_or_trace[0];
+ $this->_logRecord['LogSourceFilename'] = $trace_info['file'];
+ $this->_logRecord['LogSourceFileLine'] = $trace_info['line'];
+ }
+ else {
+ $this->_logRecord['LogSourceFilename'] = $file_or_trace;
+ $this->_logRecord['LogSourceFileLine'] = $line;
+ }
+
+ return $this;
+ }
+
+ /**
+ * Adds session contents to log record
+ *
+ * @param bool $include_optional Include optional session variables
+ * @return kLogger
+ * @access public
+ */
+ public function addSessionData($include_optional = false)
+ {
+ if ( $this->Application->InitDone ) {
+ $this->_logRecord['LogSessionData'] = serialize($this->Application->Session->getSessionData($include_optional));
+ }
+
+ return $this;
+ }
+
+ /**
+ * Adds user request information to log record
+ *
+ * @return kLogger
+ * @access public
+ */
+ public function addRequestData()
+ {
+ $request_data = Array ();
+ $request_variables = Array ('_GET' => $_GET, '_POST' => $_POST, '_COOKIE' => $_COOKIE);
+
+ foreach ($request_variables as $title => $data) {
+ if ( !$data ) {
+ continue;
+ }
+
+ $request_data[$title] = $data;
+ }
+
+ $this->_logRecord['LogRequestData'] = serialize($request_data);
+
+ return $this;
+ }
+
+ /**
+ * Adds trace to log record
+ *
+ * @param Array $trace
+ * @param int $skip_levels
+ * @param Array $skip_files
+ * @return kLogger
+ * @access public
+ */
+ public function addTrace($trace = null, $skip_levels = 1, $skip_files = null)
+ {
+ $trace = $this->createTrace($trace, $skip_levels, $skip_files);
+
+ foreach ($trace as $trace_index => $trace_info) {
+ if ( isset($trace_info['args']) ) {
+ $trace[$trace_index]['args'] = $this->_implodeObjects($trace_info['args']);
+ }
+ }
+
+ $this->_logRecord['LogBacktrace'] = serialize($this->_removeObjectsFromTrace($trace));
+
+ return $this;
+ }
+
+ /**
+ * Remove objects from trace, since before PHP 5.2.5 there wasn't possible to remove them initially
+ *
+ * @param Array $trace
+ * @return Array
+ * @access protected
+ */
+ protected function _removeObjectsFromTrace($trace)
+ {
+ if ( version_compare(PHP_VERSION, '5.3', '>=') ) {
+ return $trace;
+ }
+
+ $trace_indexes = array_keys($trace);
+
+ foreach ($trace_indexes as $trace_index) {
+ unset($trace[$trace_index]['object']);
+ }
+
+ return $trace;
+ }
+
+ /**
+ * Implodes object to prevent memory leaks
+ *
+ * @param Array $array
+ * @return Array
+ * @access protected
+ */
+ protected function _implodeObjects($array)
+ {
+ $ret = Array ();
+
+ foreach ($array as $key => $value) {
+ if ( is_array($value) ) {
+ $ret[$key] = $this->_implodeObjects($value);
+ }
+ elseif ( is_object($value) ) {
+ if ( $value instanceof kEvent ) {
+ $ret[$key] = 'Event: ' . (string)$value;
+ }
+ elseif ( $value instanceof kBase ) {
+ $ret[$key] = (string)$value;
+ }
+ else {
+ $ret[$key] = 'Class: ' . get_class($value);
+ }
+ }
+ else {
+ $ret[$key] = $value;
+ }
+ }
+
+ return $ret;
+ }
+
+ /**
+ * Removes first N levels from trace
+ *
+ * @param Array $trace
+ * @param int $levels
+ * @param Array $files
+ * @return Array
+ * @access public
+ */
+ public function createTrace($trace = null, $levels = null, $files = null)
+ {
+ if ( !isset($trace) ) {
+ $trace = debug_backtrace(false);
+ }
+
+ if ( !$trace ) {
+ // no trace information
+ return $trace;
+ }
+
+ if ( isset($levels) && is_numeric($levels) ) {
+ for ($i = 0; $i < $levels; $i++) {
+ array_shift($trace);
+ }
+ }
+
+ if ( isset($files) && is_array($files) ) {
+ while (true) {
+ $trace_info = $trace[0];
+ $file = isset($trace_info['file']) ? basename($trace_info['file']) : '';
+
+ if ( !in_array($file, $files) ) {
+ break;
+ }
+
+ array_shift($trace);
+ }
+ }
+
+ return $trace;
+ }
+
+ /**
+ * Adds PHP error to log record
+ *
+ * @param int $errno
+ * @param string $errstr
+ * @param string $errfile
+ * @param int $errline
+ * @return kLogger
+ * @access public
+ */
+ public function addError($errno, $errstr, $errfile = null, $errline = null)
+ {
+ $errstr = self::expandMessage($errstr, !$this->_debugMode);
+ $this->_logRecord['LogLevel'] = $this->_getLogLevelByErrorNo($errno);
+
+ if ( $this->isLogType(self::LT_DATABASE, $errstr) ) {
+ list ($errno, $errstr, $sql) = self::parseDatabaseError($errstr);
+
+ $this->_logRecord['LogType'] = self::LT_DATABASE;
+ $this->_logRecord['LogUserData'] = $sql;
+
+ $trace = $this->createTrace(null, 4, $this->_ignoreInTrace);
+ $this->addSource($trace);
+ $this->addTrace($trace, 0);
+ }
+ else {
+ $this->_logRecord['LogType'] = self::LT_PHP;
+
+ $this->addSource((string)$errfile, $errline);
+ $this->addTrace(null, 4);
+ }
+
+ $this->_logRecord['LogCode'] = $errno;
+ $this->_logRecord['LogMessage'] = $errstr;
+
+ return $this;
+ }
+
+ /**
+ * Adds PHP exception to log record
+ *
+ * @param Exception $exception
+ * @return kLogger
+ * @access public
+ */
+ public function addException($exception)
+ {
+ $errstr = self::expandMessage($exception->getMessage(), !$this->_debugMode);
+ $this->_logRecord['LogLevel'] = self::LL_CRITICAL;
+
+ if ( $this->isLogType(self::LT_DATABASE, $errstr) ) {
+ list ($errno, $errstr, $sql) = self::parseDatabaseError($errstr);
+
+ $this->_logRecord['LogType'] = self::LT_DATABASE;
+ $this->_logRecord['LogUserData'] = $sql;
+
+ $trace = $this->createTrace($exception->getTrace(), null, $this->_ignoreInTrace);
+ $this->addSource($trace);
+ $this->addTrace($trace, 0);
+ }
+ else {
+ $this->_logRecord['LogType'] = self::LT_PHP;
+ $errno = $exception->getCode();
+
+ $this->addSource((string)$exception->getFile(), $exception->getLine());
+ $this->addTrace($exception->getTrace(), 0);
+ }
+
+ $this->_logRecord['LogCode'] = $errno;
+ $this->_logRecord['LogMessage'] = $errstr;
+
+ return $this;
+ }
+
+ /**
+ * Allows to map PHP error numbers to syslog log level
+ *
+ * @param int $errno
+ * @return int
+ * @access protected
+ */
+ protected function _getLogLevelByErrorNo($errno)
+ {
+ $error_number_mapping = Array (
+ self::LL_ERROR => Array (E_RECOVERABLE_ERROR, E_USER_ERROR, E_ERROR, E_CORE_ERROR, E_COMPILE_ERROR, E_PARSE),
+ self::LL_WARNING => Array (E_WARNING, E_USER_WARNING, E_CORE_WARNING, E_COMPILE_WARNING),
+ self::LL_NOTICE => Array (E_NOTICE, E_USER_NOTICE, E_STRICT),
+ );
+
+ if ( version_compare(PHP_VERSION, '5.3.0', '>=') ) {
+ $error_number_mapping[self::LL_NOTICE][] = E_DEPRECATED;
+ $error_number_mapping[self::LL_NOTICE][] = E_USER_DEPRECATED;
+ }
+
+ foreach ($error_number_mapping as $log_level => $error_numbers) {
+ if ( in_array($errno, $error_numbers) ) {
+ return $log_level;
+ }
+ }
+
+ return self::LL_ERROR;
+ }
+
+ /**
+ * Changes log level of a log record
+ *
+ * @param int $log_level
+ * @return kLogger
+ * @access public
+ */
+ public function setLogLevel($log_level)
+ {
+ $this->_logRecord['LogLevel'] = $log_level;
+
+ return $this;
+ }
+
+ /**
+ * Writes prepared log to database or disk, when database isn't available
+ *
+ * @param int $storage_medium
+ * @return bool|int
+ * @access public
+ * @throws InvalidArgumentException
+ */
+ public function write($storage_medium = self::LS_AUTOMATIC)
+ {
+ if ( !$this->_logRecord || $this->_logRecord['LogLevel'] > $this->_maxLogLevel || $this->_state == self::STATE_DISABLED ) {
+ // nothing to save OR less detailed logging requested OR disabled
+ return true;
+ }
+
+ $this->_logRecord['LogMemoryUsed'] = memory_get_usage();
+ $this->_logRecord['LogTimestamp'] = adodb_mktime();
+ $this->_logRecord['LogDate'] = adodb_date('Y-m-d H:i:s');
+
+ if ( $storage_medium == self::LS_AUTOMATIC ) {
+ $storage_medium = $this->Conn->connectionOpened() ? self::LS_DATABASE : self::LS_DISK;
+ }
+
+ if ( $storage_medium == self::LS_DATABASE ) {
+ $result = $this->Conn->doInsert($this->_logRecord, TABLE_PREFIX . 'SystemLog');
+ }
+ elseif ( $storage_medium == self::LS_DISK ) {
+ $result = $this->_saveToFile(RESTRICTED . '/system.log');
+ }
+ else {
+ throw new InvalidArgumentException('Unknown storage medium "' . $storage_medium . '"');
+ }
+
+ $unique_id = $this->_logRecord['LogUniqueId'];
+
+ if ( $this->_logRecord['LogNotificationStatus'] == self::LNS_SENT ) {
+ $this->_sendNotification($unique_id);
+ }
+
+ $this->_logRecord = Array ();
+
+ return $result ? $unique_id : false;
+ }
+
+ /**
+ * Catches last error happened before script ended
+ *
+ * @return void
+ * @access public
+ */
+ public function catchLastError()
+ {
+ $this->write();
+ $last_error = error_get_last();
+
+ if ( !is_null($last_error) ) {
+ $handler = $this->_handlers[self::LL_ERROR];
+ /* @var $handler kErrorHandlerStack */
+
+ $handler->handle($last_error['type'], $last_error['message'], $last_error['file'], $last_error['line']);
+ }
+ }
+
+ /**
+ * Deletes log with given id from database or disk, when database isn't available
+ *
+ * @param int $unique_id
+ * @param int $storage_medium
+ * @return void
+ * @access public
+ * @throws InvalidArgumentException
+ */
+ public function delete($unique_id, $storage_medium = self::LS_AUTOMATIC)
+ {
+ if ( $storage_medium == self::LS_AUTOMATIC ) {
+ $storage_medium = $this->Conn->connectionOpened ? self::LS_DATABASE : self::LS_DISK;
+ }
+
+ if ( $storage_medium == self::LS_DATABASE ) {
+ $sql = 'DELETE FROM ' . TABLE_PREFIX . 'SystemLog
+ WHERE LogUniqueId = ' . $unique_id;
+ $this->Conn->Query($sql);
+ }
+ elseif ( $storage_medium == self::LS_DISK ) {
+ // TODO: no way to delete a line from a file
+ }
+ else {
+ throw new InvalidArgumentException('Unknown storage medium "' . $storage_medium . '"');
+ }
+ }
+
+ /**
+ * Send notification (delayed or instant) about log record to e-mail from configuration
+ *
+ * @param bool $instant
+ * @return kLogger
+ * @access public
+ */
+ public function notify($instant = false)
+ {
+ $this->_logRecord['LogNotificationStatus'] = $instant ? self::LNS_SENT : self::LNS_PENDING;
+
+ return $this;
+ }
+
+ /**
+ * Sends notification e-mail about message with given $unique_id
+ *
+ * @param int $unique_id
+ * @return void
+ * @access protected
+ */
+ protected function _sendNotification($unique_id)
+ {
+ $notification_email = $this->Application->ConfigValue('SystemLogNotificationEmail');
+
+ if ( !$notification_email ) {
+ trigger_error('System Log notification E-mail not specified', E_USER_NOTICE);
+
+ return;
+ }
+
+ $send_params = Array (
+ 'to_name' => $notification_email,
+ 'to_email' => $notification_email,
+ );
+
+ // initialize list outside of e-mail event with right settings
+ $this->Application->recallObject('system-log.email', 'system-log_List', Array ('unique_id' => $unique_id));
+
+ $this->Application->EmailEventAdmin('SYSTEM.LOG.NOTIFY', null, $send_params);
+ $this->Application->removeObject('system-log.email');
+ }
+
+ /**
+ * Adds error/exception handler
+ *
+ * @param string|Array $handler
+ * @param bool $is_exception
+ * @return void
+ * @access public
+ */
+ public function addErrorHandler($handler, $is_exception = false)
+ {
+ $this->_handlers[$is_exception ? self::LL_CRITICAL : self::LL_ERROR]->add($handler);
+ }
+
+ /**
+ * SQL Error Handler
+ *
+ * When not debug mode, then fatal database query won't break anything.
+ *
+ * @param int $code
+ * @param string $msg
+ * @param string $sql
+ * @return bool
+ * @access public
+ * @throws RuntimeException
+ */
+ public function handleSQLError($code, $msg, $sql)
+ {
+ $error_msg = self::shortenMessage(self::DB_ERROR_PREFIX . ' #' . $code . ' - ' . $msg . '. SQL: ' . trim($sql));
+
+ if ( isset($this->Application->Debugger) ) {
+ if ( kUtil::constOn('DBG_SQL_FAILURE') && !defined('IS_INSTALL') ) {
+ throw new RuntimeException($error_msg);
+ }
+ else {
+ $this->Application->Debugger->appendTrace();
+ }
+ }
+
+ // next line also trigger attached error handlers
+ trigger_error($error_msg, E_USER_WARNING);
+
+ return true;
+ }
+
+ /**
+ * Packs information about error into a single line
+ *
+ * @param string $errno
+ * @param bool $strip_tags
+ * @return string
+ * @access public
+ */
+ public function toString($errno = null, $strip_tags = false)
+ {
+ if ( !isset($errno) ) {
+ $errno = $this->_logRecord['LogCode'];
+ }
+
+ $errstr = $this->_logRecord['LogMessage'];
+ $errfile = $this->_logRecord['LogSourceFilename'];
+ $errline = $this->_logRecord['LogSourceFileLine'];
+
+ $result = '' . $errno . ': ' . "{$errstr} in {$errfile} on line {$errline}";
+
+ return $strip_tags ? strip_tags($result) : $result;
+ }
+
+ /**
+ * Saves log to file (e.g. when not possible to save into database)
+ *
+ * @param $filename
+ * @return bool
+ * @access protected
+ */
+ protected function _saveToFile($filename)
+ {
+ $time = adodb_date('Y-m-d H:i:s');
+ $log_file = new SplFileObject($filename, 'a');
+
+ return $log_file->fwrite('[' . $time . '] #' . $this->toString(null, true) . PHP_EOL) > 0;
+ }
+
+ /**
+ * Checks if log type of current log record matches given one
+ *
+ * @param int $log_type
+ * @param string $log_message
+ * @return bool
+ * @access public
+ */
+ public function isLogType($log_type, $log_message = null)
+ {
+ if ( $this->_logRecord['LogType'] == $log_type ) {
+ return true;
+ }
+
+ if ( $log_type == self::LT_DATABASE ) {
+ if ( !isset($log_message) ) {
+ $log_message = $this->_logRecord['LogMessage'];
+ }
+
+ return strpos($log_message, self::DB_ERROR_PREFIX) !== false;
+ }
+
+ return false;
+ }
+
+ /**
+ * Shortens message
+ *
+ * @param string $message
+ * @return string
+ * @access public
+ */
+ public static function shortenMessage($message)
+ {
+ $max_len = ini_get('log_errors_max_len');
+
+ if ( strlen($message) > $max_len ) {
+ $long_key = kUtil::generateId();
+ self::$_longMessages[$long_key] = $message;
+
+ return mb_substr($message, 0, $max_len - strlen($long_key) - 2) . ' #' . $long_key;
+ }
+
+ return $message;
+ }
+
+ /**
+ * Expands shortened message
+ *
+ * @param string $message
+ * @param bool $clear_cache Allow debugger to expand message after it's been expanded by kLogger
+ * @return string
+ * @access public
+ */
+ public static function expandMessage($message, $clear_cache = true)
+ {
+ if ( preg_match('/(.*)#([\d]+)$/', $message, $regs) ) {
+ $long_key = $regs[2];
+
+ if ( isset(self::$_longMessages[$long_key]) ) {
+ $message = self::$_longMessages[$long_key];
+
+ if ( $clear_cache ) {
+ unset(self::$_longMessages[$long_key]);
+ }
+ }
+ }
+
+ return $message;
+ }
+
+ /**
+ * Parses database error message into error number, error message and sql that caused that error
+ *
+ * @static
+ * @param string $message
+ * @return Array
+ * @access public
+ */
+ public static function parseDatabaseError($message)
+ {
+ $regexp = '/' . preg_quote(self::DB_ERROR_PREFIX) . ' #(.*?) - (.*?)\. SQL: (.*?)$/s';
+
+ if ( preg_match($regexp, $message, $regs) ) {
+ // errno, errstr, sql
+ return Array ($regs[1], $regs[2], $regs[3]);
+ }
+
+ return Array (0, $message, '');
+ }
+}
+
+
+/**
+ * Base class for error or exception handling
+ */
+abstract class kHandlerStack extends kBase {
+
+ /**
+ * List of added handlers
+ *
+ * @var Array
+ * @access protected
+ */
+ protected $_handlers = Array ();
+
+ /**
+ * Reference to event log, which created this object
+ *
+ * @var kLogger
+ * @access protected
+ */
+ protected $_logger;
+
+ /**
+ * Remembers if handler is activated
+ *
+ * @var bool
+ * @access protected
+ */
+ protected $_enabled = false;
+
+ public function __construct(kLogger $logger)
+ {
+ parent::__construct();
+
+ $this->_logger = $logger;
+
+ if ( !kUtil::constOn('DBG_ZEND_PRESENT') ) {
+ $this->attach();
+ $this->_enabled = true;
+ }
+ }
+
+ /**
+ * Detaches from error handling routines on class destruction
+ *
+ * @return void
+ * @access public
+ */
+ public function __destruct()
+ {
+ if ( !$this->_enabled ) {
+ return;
+ }
+
+ $this->detach();
+ $this->_enabled = false;
+ }
+
+ /**
+ * Attach to error handling routines
+ *
+ * @abstract
+ * @return void
+ * @access protected
+ */
+ abstract protected function attach();
+
+ /**
+ * Detach from error handling routines
+ *
+ * @abstract
+ * @return void
+ * @access protected
+ */
+ abstract protected function detach();
+
+ /**
+ * Adds new handler to the stack
+ *
+ * @param callable $handler
+ * @return void
+ * @access public
+ */
+ public function add($handler)
+ {
+ $this->_handlers[] = $handler;
+ }
+
+ protected function _handleFatalError($errno)
+ {
+ $debug_mode = defined('DEBUG_MODE') && DEBUG_MODE;
+ $skip_reporting = defined('DBG_SKIP_REPORTING') && DBG_SKIP_REPORTING;
+
+ if ( !$this->_handlers || ($debug_mode && $skip_reporting) ) {
+ // when debugger absent OR it's present, but we actually can't see it's error report (e.g. during ajax request)
+
+ if ( $this->_isFatalError($errno) ) {
+ $this->_displayFatalError($errno);
+ }
+
+ if ( !$this->_handlers ) {
+ return true;
+ }
+ }
+
+ return null;
+ }
+
+ /**
+ * Determines if given error is a fatal
+ *
+ * @abstract
+ * @param Exception|int $errno
+ * @return bool
+ */
+ abstract protected function _isFatalError($errno);
+
+ /**
+ * Displays div with given error message
+ *
+ * @param string $errno
+ * @return void
+ * @access protected
+ */
+ protected function _displayFatalError($errno)
+ {
+ $errno = $this->_getFatalErrorTitle($errno);
+
+ $margin = $this->Application->isAdmin ? '8px' : 'auto';
+ echo '