Update documentation
[squirrelmail.git] / class / error.class.php
index 44b7b6d..af241e3 100644 (file)
@@ -1,19 +1,26 @@
 <?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-2006 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)
+if (ini_get('docref_root')=='') ini_set('docref_root','http://www.php.net/');
 
 /**
  * Error Handler class
@@ -36,6 +43,7 @@ class ErrorHandler {
         $this->TemplateName = $sTemplateFile;
         $this->Template =& $oTemplate;
         $this->aErrors = array();
+        $this->header_sent = false;
     }
 
     /**
@@ -47,6 +55,28 @@ class ErrorHandler {
     }
 
     /**
+     * Sets if the page header is already sent
+     * @since 1.5.1
+     */
+    function HeaderSent() {
+        $this->header_sent = true;
+    }
+
+    /**
+     * 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
      * @since 1.5.1
@@ -62,11 +92,31 @@ class ErrorHandler {
                   );
         $iType = NULL;
         $aErrorCategory = array();
-        /*
-         * 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
+
+        /**
+         * 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.
+         */
+        $iCurErrLevel = error_reporting(ini_get('error_reporting'));
+        error_reporting($iCurErrLevel);
+
+        /**
+         * 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.
          */
-        switch ($iErrNo) {
+        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_STRICT:
+                $iType = (is_null($iType)) ? SQM_STRICT : $iType;
             case E_NOTICE:
                 $iType = (is_null($iType)) ? SQM_NOTICE : $iType;
             case E_WARNING:
@@ -74,8 +124,8 @@ class ErrorHandler {
                 $aErrorCategory[] = 'PHP';
                 $aError['message'] = $sErrStr;
                 $aError['extra'] = array(
-                                          'FILE' => $sErrFile,
-                                          'LINE' => $iErrLine) ;;
+                                         'FILE' => $sErrFile,
+                                         'LINE' => $iErrLine) ;;
                 // what todo with $aContext?
                 break;
             case E_USER_ERROR:
@@ -93,29 +143,29 @@ class ErrorHandler {
                         $aError = array_merge($aError,$aErrorTemp);
                         // special error handling below
                         if ($aError['category'] & SQM_ERROR_IMAP) {
-                             $aErrorCategory[] = 'IMAP';
-                             // imap related error handling inside
+                            $aErrorCategory[] = 'IMAP';
+                            // imap related error handling inside
                         }
                         if ($aError['category'] & SQM_ERROR_FS) {
-                             $aErrorCategory[] = 'FILESYSTEM';
-                             // filesystem related error handling inside
+                            $aErrorCategory[] = 'FILESYSTEM';
+                            // filesystem related error handling inside
                         }
                         if ($aError['category'] & SQM_ERROR_SMTP) {
-                             $aErrorCategory[] = 'SMTP';
-                             // smtp related error handling inside
+                            $aErrorCategory[] = 'SMTP';
+                            // smtp related error handling inside
                         }
                         if ($aError['category'] & SQM_ERROR_LDAP) {
-                             $aErrorCategory[] = 'LDAP';
-                             // ldap related error handling inside
+                            $aErrorCategory[] = 'LDAP';
+                            // ldap related error handling inside
                         }
                         if ($aError['category'] & SQM_ERROR_DB) {
-                             $aErrorCategory[] = 'DATABASE';
-                             // db related error handling inside
+                            $aErrorCategory[] = 'DATABASE';
+                            // db related error handling inside
                         }
                         if ($aError['category'] & SQM_ERROR_PLUGIN) {
-                             $aErrorCategory[] = 'PLUGIN';
-                             do_hook_function('error_handler_plugin',$aError);
-                             // plugin related error handling inside
+                            $aErrorCategory[] = 'PLUGIN';
+                            do_hook_function('error_handler_plugin',$aError);
+                            // plugin related error handling inside
                         }
                         //if ($aError['category'] & SQM_ERROR_X) {
                         //     $aErrorCategory[] = 'X';
@@ -129,19 +179,26 @@ class ErrorHandler {
                 }
                 break;
             default: break;
+            }
+
+            $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);
         }
-        $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 ($iType == SQM_ERROR) {
+            if (!$this->header_sent) {
+                // TODO replace this with template that can be assigned
+                displayHtmlHeader(_("Error"),'',false);
+            }
             $this->DisplayErrors();
             exit(_("Terminating SquirrelMail due to a fatal error"));
         }
@@ -175,7 +232,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
@@ -184,37 +241,42 @@ 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);