<?php
/**
* error.class.php
*
* This contains the custom error handler for SquirrelMail.
*
* @copyright 2005-2020 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id: error.class.php 14845 2020年01月07日 08:09:34Z pdontthink $
* @package squirrelmail
*/
/** Used defines */
// php5 E_STRICT constant (compatibility with php4)
// Set docref_root (fixes URLs that link to php manual)
if (ini_get ('docref_root')==
'') ini_set ('docref_root','http://www.php.net/');
/**
* Error Handler class
*
* This class contains a custom error handler in order to display
* user notices/warnings/errors and php notices and warnings in a template
*
* @author Marc Groot Koerkamp
* @package squirrelmail
*/
/**
* Constructor
* @param object $oTemplate Template object
* @param string $sTemplateFile Template containing the error template
* @since 1.5.1
*/
# echo 'init error handler...';
$this->TemplateName = $sTemplateFile;
$this->Template =& $oTemplate;
$this->aErrors = array();
$this->header_sent = false;
$this->delayed_errors = false;
$this->Template->assign('delayed_errors', $this->delayed_errors);
}
/**
* Sets the error template
* @since 1.5.1
*/
$this->TemplateFile = $sTemplateFile;
}
/**
* Sets if the page header is already sent
* @since 1.5.1
*/
$this->header_sent = true;
$this->Template->assign('header_sent', true);
}
/**
* Turn on/off delayed error handling
* @since 1.5.2
*/
$this->delayed_errors = $val===true;
$this->Template->assign('delayed_errors', $this->delayed_errors);
}
/**
* Store errors generated in a previous script but couldn't be displayed
* due to a header redirect. This requires storing of aDelayedErrors in the session
* @param array $aDelayedErrors array with errors stored in the $this->aErrors format.
* @since 1.5.1
*/
$aErrors =
array_merge ($this->aErrors,$aDelayedErrors); $this->aErrors = $aErrors;
$this->Template->assign('aErrors',$this->aErrors);
$aDelayedErrors = false;
}
/**
* Custom Error handler (set with set_error_handler() )
* @private
* @since 1.5.1
*/
$aError = array(
'type' =>
SQM_NOTICE ,// Error type, notice, warning or fatal error; 'category' => NULL, // SquirrelMail error category;
'message' => NULL, // Error display message;
'extra' => NULL, // Key value based array with extra error info;
'link' => NULL, // Link to help location;
'tip' => NULL // User tip.
);
$iType = NULL;
$aErrorCategory = array();
/**
* Get current error reporting level.
*
* PHP 4.1.2 does not return current error reporting level in ini_get (php 5.1b3 and
* 4.3.10 does). Retrieve current error reporting level while setting error reporting
* to ini value and reset it to retrieved value.
*/
/**
* Check error_reporting value before logging error.
* Don't log errors that are disabled by @ (error_reporting = 0). Some SquirrelMail scripts
* (sq_mb_list_encodings(), ldap function calls in functions/abook_ldap_server.php)
* handle errors themselves and @ is used to disable generic php error messages.
*/
if ($iErrNo & $iCurErrLevel) {
/*
* The following errors cannot be handled by a user defined error handler:
* E_ERROR, E_PARSE, E_CORE_ERROR, E_CORE_WARNING, E_COMPILE_ERROR, E_COMPILE_WARNING
*/
switch ($iErrNo) {
case E_NOTICE:
case E_WARNING:
$aErrorCategory[] = 'PHP';
$aError['message'] = $sErrStr;
$aError['extra'] = array(
'FILE' => $sErrFile,
'LINE' => $iErrLine) ;
// what todo with $aContext?
break;
case E_USER_ERROR:
case E_USER_NOTICE:
case E_USER_WARNING:
if ($sErrFile == __FILE__) { // Error is triggered in this file and probably by sqm_trigger_error
$aError['message'] = $sErrStr;
$aErrorCategory[] = 'UNDEFINED';
} else {
// special error handling below
$aErrorCategory[] = 'IMAP';
// imap related error handling inside
}
$aErrorCategory[] = 'FILESYSTEM';
// filesystem related error handling inside
}
$aErrorCategory[] = 'SMTP';
// smtp related error handling inside
}
$aErrorCategory[] = 'LDAP';
// ldap related error handling inside
}
$aErrorCategory[] = 'DATABASE';
// db related error handling inside
}
$aErrorCategory[] = 'PLUGIN';
do_hook ('error_handler_plugin', $aError); // plugin related error handling inside
}
//if ($aError['category'] & SQM_ERROR_X) {
// $aErrorCategory[] = 'X';
// place holder for a new category
//}
}
unset($aErrorTemp);
} else {
$aError['message'] = $sErrStr;
$aErrorCategory[] = 'SQM_NOTICE';
}
break;
default: break;
}
/**
* If delayed error handling is enabled, always record the location
* and tag the error is delayed to make debugging easier.
*/
if (isset($this->Template->values['delayed_errors']) && $this->Template->values['delayed_errors']) {
$aErrorCategory[] = 'Delayed';
$aError['extra'] = array(
'FILE' => $sErrFile,
'LINE' => $iErrLine) ;
}
$aErrorTpl = array(
'type' => $iType,
'category' => $aErrorCategory,
'message' => $aError['message'],
'link' => $aError['link'],
'tip' => $aError['tip'],
'extra' => $aError['extra']);
// Add the notice/warning/error to the existing list of notices/warnings
$this->aErrors[] = $aErrorTpl;
$this->Template->assign('aErrors',$this->aErrors);
}
// Show the error immediate in case of fatal errors
if (isset($this->Template->values['header_sent']) && !$this->Template->values['header_sent']) {
// TODO replace this with template that can be assigned
// UPDATE: displayHtmlHeader() no longer sends anything
// directly to the browser itself and instead
// displays all output through the template file
// "protocol_header" as well as calls to the
// template's header() method, so perhaps the
// above TODO is alleviated?? (however, I don't fully
// understand the problem behind the TODO comment myself (Paul))
}
exit(_ ("Terminating SquirrelMail due to a fatal error")); }
}
/**
* Force the delayed errors to be stored in the session in case
* $this->displayErrors() never gets called, e.g. in compose.php
*/
if($this->delayed_errors) {
// Check for previous delayed errors...
}
if (count ($this->aErrors) >
0) { }
}
}
/**
* Display the error array in the error template
* @return void
* @since 1.5.1
*/
// Check for delayed errors...
if (!$this->delayed_errors) {
}
}
if (isset
($this->Template->values['aErrors']) &&
count ($this->Template->values['aErrors']) >
0) { foreach ($this->Template->values['aErrors'] as $err) {
if (!in_array ($err, $this->aErrors, true)) { $this->aErrors[] = $err;
}
}
$this->Template->assign('aErrors',$this->aErrors);
}
if (count ($this->aErrors) >
0) { if ($this->delayed_errors) {
} else {
$this->Template->display($this->TemplateName);
}
}
}
}
/**
* Custom Error handler for PHP version < 4.3.0 (set with set_error_handler() )
* @author Marc Groot Koerkamp
* @since 1.5.1
*/
global $oTemplate;
static $oErrorHandler;
if (!isset($oErrorHandler)) {
$oErrorHandler =
new ErrorHandler ($oTemplate,'error_message.tpl'); }
}
/**
* Triggers an imap error. Utility function for sqm_trigger_error()
* @param string $sErrNo error string defined in errors.php
* @param string $sRequest imap request string
* @param string $sResponse tagged imap response
* @param string $sMessage tagged imap response message
* @param array $aExtra optional associative array with extra error info
* @return void
* @author Marc Groot Koerkamp
* @since 1.5.1
*/
$aError = array(
'REQUEST' => $sRequest,
'RESPONSE' => $sResponse,
'MESSAGE' => $sMessage);
}
/**
* Trigger an error.
* @param string $sErrNo error string defined in errors.php
* @param array $aExtra optional associative array with extra error info
* @return void
* @author Marc Groot Koerkamp
* @since 1.5.1
*/
static $aErrors;
if (!isset($aErrors)) {
// Include the error definition file.
include_once(SM_PATH .
'include/errors.php'); }
$iPhpErr = E_USER_NOTICE;
if (is_array ($aErrors) && isset
($aErrors[$sErrNo]['level'])) { $aErrors[$sErrNo]['extra'] = $aExtra;
}
// because trigger_error can only handle a string argument for the error description
// we serialize the result.
$iPhpErr = $aErrors[$sErrNo]['level'];
} else {
$sErrString = "Error <$sErrNo> does not exist, fix the code or update the errors.php file";
$iPhpErr = E_USER_ERROR;
}
}