*
* This contains the custom error handler for SquirrelMail.
*
- * @copyright © 2005-2006 The SquirrelMail Project Team
+ * @copyright © 2005-2009 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
* @since 1.5.1
*/
function ErrorHandler(&$oTemplate, $sTemplateFile) {
+# 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);
}
/**
*/
function HeaderSent() {
$this->header_sent = true;
+ $this->Template->assign('header_sent', true);
}
+ /**
+ * Turn on/off delayed error handling
+ * @since 1.5.2
+ */
+ function setDelayedErrors ($val = true) {
+ $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
$aError['message'] = $sErrStr;
$aError['extra'] = array(
'FILE' => $sErrFile,
- 'LINE' => $iErrLine) ;;
+ 'LINE' => $iErrLine) ;
// what todo with $aContext?
break;
case E_USER_ERROR:
}
if ($aError['category'] & SQM_ERROR_PLUGIN) {
$aErrorCategory[] = 'PLUGIN';
- do_hook_function('error_handler_plugin',$aError);
+ do_hook('error_handler_plugin', $aError);
// plugin related error handling inside
}
//if ($aError['category'] & SQM_ERROR_X) {
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,
// Show the error immediate in case of fatal errors
if ($iType == SQM_ERROR) {
- if (!$this->header_sent) {
- // TODO replace this with template that can be assigned
+ 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))
displayHtmlHeader(_("Error"),'',false);
}
$this->DisplayErrors();
}
}
+ /**
+ * Force the delayed errors to be stored in the session in case
+ * $this->displayErrors() never gets called, e.g. in compose.php
+ */
+ function saveDelayedErrors () {
+ if($this->delayed_errors) {
+ // Check for previous delayed errors...
+ sqgetGlobalVar('delayed_errors', $delayed_errors, SQ_SESSION);
+ if (is_array($delayed_errors)) {
+ $this->AssignDelayedErrors($delayed_errors);
+ sqsession_unregister("delayed_errors");
+ }
+
+ if (count($this->aErrors) > 0) {
+ sqsession_register($this->aErrors,"delayed_errors");
+ }
+ }
+ }
+
/**
* Display the error array in the error template
* @return void
* @since 1.5.1
*/
function DisplayErrors() {
- if (count($this->aErrors)) {
- $this->Template->display($this->TemplateName);
+ // Check for delayed errors...
+ if (!$this->delayed_errors) {
+ sqgetGlobalVar('delayed_errors', $delayed_errors, SQ_SESSION);
+ if (is_array($delayed_errors)) {
+ $this->AssignDelayedErrors($delayed_errors);
+ sqsession_unregister("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) {
+ sqsession_register($this->aErrors,"delayed_errors");
+ } else {
+ $this->Template->display($this->TemplateName);
+ }
}
}
}