X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=class%2Ferror.class.php;h=94cd9340ca71dafcd65dfee21d7884f412afc551;hp=49baa571459b4e296c57424d9a90d3fe0eb80edb;hb=69bb88aa7887eb7259926da61d80b123db2a0524;hpb=6b00bba4595fd43e9404647154474638c3d9ad98

diff --git a/class/error.class.php b/class/error.class.php
index 49baa571..94cd9340 100644
--- a/class/error.class.php
+++ b/class/error.class.php
@@ -1,20 +1,22 @@
 <?php
+
 /**
  * error.class.php
  *
- * Copyright (c) 2005 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * This contains the custom error handler for SquirrelMail.
  *
+ * @copyright &copy; 2005-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
  */
 
+/** Used defines */
 define('SQM_NOTICE',0);
 define('SQM_WARNING',1);
 define('SQM_ERROR',2);
 define('SQM_STRICT',3);
+
 // php5 E_STRICT constant (compatibility with php4)
 if (! defined('E_STRICT')) define('E_STRICT',2048);
 // Set docref_root (fixes URLs that link to php manual)
@@ -38,9 +40,13 @@ class ErrorHandler {
      * @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);
     }
 
     /**
@@ -51,6 +57,38 @@ class ErrorHandler {
         $this->TemplateFile = $sTemplateFile;
     }
 
+    /**
+     * Sets if the page header is already sent
+     * @since 1.5.1
+     */
+    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
+     * @param array $aDelayedErrors array with errors stored in the $this->aErrors format.
+     * @since 1.5.1
+     */
+    function AssignDelayedErrors(&$aDelayedErrors) {
+        $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
@@ -71,8 +109,8 @@ class ErrorHandler {
         /**
          * 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 
+         * 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.
          */
         $iCurErrLevel = error_reporting(ini_get('error_reporting'));
@@ -84,7 +122,7 @@ class ErrorHandler {
          * (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 ((bool) $iCurErrLevel) {
+        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
@@ -100,7 +138,7 @@ class ErrorHandler {
                 $aError['message'] = $sErrStr;
                 $aError['extra'] = array(
                                          'FILE' => $sErrFile,
-                                         'LINE' => $iErrLine) ;;
+                                         'LINE' => $iErrLine) ;
                 // what todo with $aContext?
                 break;
             case E_USER_ERROR:
@@ -139,7 +177,7 @@ class ErrorHandler {
                         }
                         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) {
@@ -156,6 +194,17 @@ class ErrorHandler {
             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,
@@ -170,19 +219,71 @@ class ErrorHandler {
 
         // Show the error immediate in case of fatal errors
         if ($iType == SQM_ERROR) {
+            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();
             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
+     */
+    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);
+            }
         }
     }
 }
@@ -203,7 +304,7 @@ function SquirrelMailErrorhandler($iErrNo, $sErrStr, $sErrFile, $iErrLine, $aCon
 
 /**
  * Triggers an imap error. Utility function for sqm_trigger_error()
- * @param  integer $iErrNo error number defined in errors.php
+ * @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
@@ -212,39 +313,43 @@ function SquirrelMailErrorhandler($iErrNo, $sErrStr, $sErrFile, $iErrLine, $aCon
  * @author  Marc Groot Koerkamp
  * @since 1.5.1
  */
-function sqm_trigger_imap_error($iErrNo,$sRequest,$sResponse, $sMessage, $aExtra=array()) {
+function sqm_trigger_imap_error($sErrNo,$sRequest,$sResponse, $sMessage, $aExtra=array()) {
     $aError = array(
                     'REQUEST' => $sRequest,
                     'RESPONSE' => $sResponse,
                     'MESSAGE' => $sMessage);
     $aError = array_merge($aExtra,$aError);
-    sqm_trigger_error($iErrNo,$aError);
+    sqm_trigger_error($sErrNo,$aError);
 }
 
 /**
  * Trigger an error.
- * @param  integer $iErrNo error number defined in errors.php
+ * @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
  */
-function sqm_trigger_error($iErrNo,$aExtra=array()) {
-    // Include the error definition file.
-    include_once(SM_PATH.'include/errors.php');
+function sqm_trigger_error($sErrNo,$aExtra=array()) {
+    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[$iErrNo]['level'])) {
+    if (is_array($aErrors) && isset($aErrors[$sErrNo]['level'])) {
         if (is_array($aExtra) && count($aExtra)) {
-            $aErrors[$iErrNo]['extra'] = $aExtra;
+            $aErrors[$sErrNo]['extra'] = $aExtra;
         }
         // because trigger_error can only handle a string argument for the error description
         // we serialize the result.
-        $sErrString = serialize($aErrors[$iErrNo]);
-        $iPhpErr = $aErrors[$iErrNo]['level'];
+        $sErrString = serialize($aErrors[$sErrNo]);
+        $iPhpErr = $aErrors[$sErrNo]['level'];
     } else {
-        $sErrString = "Error number <$iErrNo> does not exist, fix the code or update the errors.php file";
+        sm_print_r($aErrors);
+        $sErrString = "Error <$sErrNo> does not exist, fix the code or update the errors.php file";
         $iPhpErr = E_USER_ERROR;
     }
     trigger_error($sErrString, $iPhpErr);
 }
-?>
\ No newline at end of file