class/error.class.php

   1 <?php
   2
   3 /**
   4  * error.class.php
   5  *
   6  * This contains the custom error handler for SquirrelMail.
   7  *
   8  * @copyright &copy; 2005-2006 The SquirrelMail Project Team
   9  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10  * @version $Id$
  11  * @package squirrelmail
  12  */
  13
  14 /** Used defines */
  15 define('SQM_NOTICE',0);
  16 define('SQM_WARNING',1);
  17 define('SQM_ERROR',2);
  18 define('SQM_STRICT',3);
  19
  20 // php5 E_STRICT constant (compatibility with php4)
  21 if (! defined('E_STRICT')) define('E_STRICT',2048);
  22 // Set docref_root (fixes URLs that link to php manual)
  23 if (ini_get('docref_root')=='') ini_set('docref_root','http://www.php.net/');
  24
  25 /**
  26  * Error Handler class
  27  *
  28  * This class contains a custom error handler in order to display
  29  * user notices/warnings/errors and php notices and warnings in a template
  30  *
  31  * @author  Marc Groot Koerkamp
  32  * @package squirrelmail
  33  */
  34 class ErrorHandler {
  35
  36     /**
  37      * Constructor
  38      * @param  object $oTemplate Template object
  39      * @param  string $sTemplateFile Template containing the error template
  40      * @since 1.5.1
  41      */
  42     function ErrorHandler(&$oTemplate, $sTemplateFile) {
  43 #        echo 'init error handler...';
  44         $this->TemplateName = $sTemplateFile;
  45         $this->Template =& $oTemplate;
  46         $this->aErrors = array();
  47         $this->header_sent = false;
  48         $this->delayed_errors = false;
  49         $this->Template->assign('delayed_errors', $this->delayed_errors);
  50     }
  51
  52     /**
  53      * Sets the error template
  54      * @since 1.5.1
  55      */
  56     function SetTemplateFile($sTemplateFile) {
  57         $this->TemplateFile = $sTemplateFile;
  58     }
  59
  60     /**
  61      * Sets if the page header is already sent
  62      * @since 1.5.1
  63      */
  64     function HeaderSent() {
  65         $this->header_sent = true;
  66         $this->Template->assign('header_sent', true);
  67     }
  68
  69     /**
  70      * Turn on/off delayed error handling
  71      * @since 1.5.2
  72      */
  73     function setDelayedErrors ($val = true) {
  74         $this->delayed_errors = $val===true;
  75         $this->Template->assign('delayed_errors', $this->delayed_errors);
  76     }
  77
  78     /**
  79      * Store errors generated in a previous script but couldn't be displayed
  80      * due to a header redirect. This requires storing of aDelayedErrors in the session
  81      * @param array $aDelayedErrors array with errors stored in the $this->aErrors format.
  82      * @since 1.5.1
  83      */
  84     function AssignDelayedErrors(&$aDelayedErrors) {
  85         $aErrors = array_merge($this->aErrors,$aDelayedErrors);
  86         $this->aErrors = $aErrors;
  87         $this->Template->assign('aErrors',$this->aErrors);
  88         $aDelayedErrors = false;
  89     }
  90
  91
  92     /**
  93      * Custom Error handler (set with set_error_handler() )
  94      * @private
  95      * @since 1.5.1
  96      */
  97     function SquirrelMailErrorhandler($iErrNo, $sErrStr, $sErrFile, $iErrLine, $aContext) {
  98         $aError = array(
  99                         'type'     => SQM_NOTICE,// Error type, notice, warning or fatal error;
 100                         'category' => NULL,      // SquirrelMail error category;
 101                         'message'  => NULL,      // Error display message;
 102                         'extra'    => NULL,      // Key value based array with extra error info;
 103                         'link'     => NULL,      // Link to help location;
 104                         'tip'      => NULL       // User tip.
 105                   );
 106         $iType = NULL;
 107         $aErrorCategory = array();
 108
 109         /**
 110          * Get current error reporting level.
 111          *
 112          * PHP 4.1.2 does not return current error reporting level in ini_get (php 5.1b3 and
 113          * 4.3.10 does). Retrieve current error reporting level while setting error reporting
 114          * to ini value and reset it to retrieved value.
 115          */
 116         $iCurErrLevel = error_reporting(ini_get('error_reporting'));
 117         error_reporting($iCurErrLevel);
 118
 119         /**
 120          * Check error_reporting value before logging error.
 121          * Don't log errors that are disabled by @ (error_reporting = 0). Some SquirrelMail scripts
 122          * (sq_mb_list_encodings(), ldap function calls in functions/abook_ldap_server.php)
 123          * handle errors themselves and @ is used to disable generic php error messages.
 124          */
 125         if ($iErrNo & $iCurErrLevel) {
 126             /*
 127              * The following errors cannot be handled by a user defined error handler:
 128              * E_ERROR, E_PARSE, E_CORE_ERROR, E_CORE_WARNING, E_COMPILE_ERROR, E_COMPILE_WARNING
 129              */
 130             switch ($iErrNo) {
 131             case E_STRICT:
 132                 $iType = (is_null($iType)) ? SQM_STRICT : $iType;
 133             case E_NOTICE:
 134                 $iType = (is_null($iType)) ? SQM_NOTICE : $iType;
 135             case E_WARNING:
 136                 $iType = (is_null($iType)) ? SQM_WARNING : $iType;
 137                 $aErrorCategory[] = 'PHP';
 138                 $aError['message'] = $sErrStr;
 139                 $aError['extra'] = array(
 140                                          'FILE' => $sErrFile,
 141                                          'LINE' => $iErrLine) ;
 142                 // what todo with $aContext?
 143                 break;
 144             case E_USER_ERROR:
 145                 $iType = (is_null($iType)) ? SQM_ERROR : $iType;
 146             case E_USER_NOTICE:
 147                 $iType = (is_null($iType)) ? SQM_NOTICE : $iType;
 148             case E_USER_WARNING:
 149                 $iType = (is_null($iType)) ? SQM_WARNING : $iType;
 150                 if ($sErrFile == __FILE__) { // Error is triggered in this file and probably by sqm_trigger_error
 151                     $aErrorTemp = @unserialize($sErrStr);
 152                     if (!is_array($aErrorTemp)) {
 153                         $aError['message'] = $sErrStr;
 154                         $aErrorCategory[] = 'UNDEFINED';
 155                     } else {
 156                         $aError = array_merge($aError,$aErrorTemp);
 157                         // special error handling below
 158                         if ($aError['category'] & SQM_ERROR_IMAP) {
 159                             $aErrorCategory[] = 'IMAP';
 160                             // imap related error handling inside
 161                         }
 162                         if ($aError['category'] & SQM_ERROR_FS) {
 163                             $aErrorCategory[] = 'FILESYSTEM';
 164                             // filesystem related error handling inside
 165                         }
 166                         if ($aError['category'] & SQM_ERROR_SMTP) {
 167                             $aErrorCategory[] = 'SMTP';
 168                             // smtp related error handling inside
 169                         }
 170                         if ($aError['category'] & SQM_ERROR_LDAP) {
 171                             $aErrorCategory[] = 'LDAP';
 172                             // ldap related error handling inside
 173                         }
 174                         if ($aError['category'] & SQM_ERROR_DB) {
 175                             $aErrorCategory[] = 'DATABASE';
 176                             // db related error handling inside
 177                         }
 178                         if ($aError['category'] & SQM_ERROR_PLUGIN) {
 179                             $aErrorCategory[] = 'PLUGIN';
 180                             do_hook_function('error_handler_plugin',$aError);
 181                             // plugin related error handling inside
 182                         }
 183                         //if ($aError['category'] & SQM_ERROR_X) {
 184                         //     $aErrorCategory[] = 'X';
 185                         // place holder for a new category
 186                         //}
 187                     }
 188                     unset($aErrorTemp);
 189                 } else {
 190                     $aError['message'] = $sErrStr;
 191                     $aErrorCategory[] = 'SQM_NOTICE';
 192                 }
 193                 break;
 194             default: break;
 195             }
 196
 197             /**
 198              * If delayed error handling is enabled, always record the location
 199              * and tag the error is delayed to make debugging easier.
 200              */
 201             if (isset($this->Template->values['delayed_errors']) && $this->Template->values['delayed_errors']) {
 202                 $aErrorCategory[] = 'Delayed';
 203                 $aError['extra'] = array(
 204                                          'FILE' => $sErrFile,
 205                                          'LINE' => $iErrLine) ;
 206             }
 207
 208             $aErrorTpl = array(
 209                 'type'      => $iType,
 210                 'category'  => $aErrorCategory,
 211                 'message'   => $aError['message'],
 212                 'link'      => $aError['link'],
 213                 'tip'       => $aError['tip'],
 214                 'extra'     => $aError['extra']);
 215             // Add the notice/warning/error to the existing list of notices/warnings
 216             $this->aErrors[] = $aErrorTpl;
 217             $this->Template->assign('aErrors',$this->aErrors);
 218         }
 219
 220         // Show the error immediate in case of fatal errors
 221         if ($iType == SQM_ERROR) {
 222             if (isset($this->Template->values['header_sent']) && !$this->Template->values['header_sent']) {
 223                 // TODO replace this with template that can be assigned
 224                 displayHtmlHeader(_("Error"),'',false);
 225             }
 226             $this->DisplayErrors();
 227             exit(_("Terminating SquirrelMail due to a fatal error"));
 228         }
 229     }
 230
 231     /**
 232      * Display the error array in the error template
 233      * @return void
 234      * @since 1.5.1
 235      */
 236     function DisplayErrors() {
 237         // Check for delayed errors...
 238         if (!$this->delayed_errors) {
 239             sqgetGlobalVar('delayed_errors',  $delayed_errors,  SQ_SESSION);
 240             if (is_array($delayed_errors)) {
 241                 $this->AssignDelayedErrors($delayed_errors);
 242                 sqsession_unregister("delayed_errors");
 243             }
 244         }
 245
 246         if (isset($this->Template->values['aErrors']) && count($this->Template->values['aErrors']) > 0) {
 247             $this->aErrors = array_merge($this->aErrors, $this->Template->values['aErrors']);
 248             $this->Template->assign('aErrors',$this->aErrors);
 249         }
 250
 251         if (count($this->aErrors) > 0) {
 252             if ($this->delayed_errors) {
 253                 sqsession_register($this->aErrors,"delayed_errors");
 254             } else {
 255                 $this->Template->display($this->TemplateName);
 256             }
 257         }
 258     }
 259 }
 260
 261 /**
 262  * Custom Error handler for PHP version < 4.3.0 (set with set_error_handler() )
 263  * @author  Marc Groot Koerkamp
 264  * @since 1.5.1
 265  */
 266 function SquirrelMailErrorhandler($iErrNo, $sErrStr, $sErrFile, $iErrLine, $aContext) {
 267     global $oTemplate;
 268     static $oErrorHandler;
 269     if (!isset($oErrorHandler)) {
 270         $oErrorHandler = new ErrorHandler($oTemplate,'error_message.tpl');
 271     }
 272     $oErrorHandler->SquirrelMailErrorhandler($iErrNo, $sErrStr, $sErrFile, $iErrLine, $aContext);
 273 }
 274
 275 /**
 276  * Triggers an imap error. Utility function for sqm_trigger_error()
 277  * @param  string $sErrNo error string defined in errors.php
 278  * @param  string $sRequest imap request string
 279  * @param  string $sResponse tagged imap response
 280  * @param  string $sMessage tagged imap response message
 281  * @param  array  $aExtra optional associative array with extra error info
 282  * @return void
 283  * @author  Marc Groot Koerkamp
 284  * @since 1.5.1
 285  */
 286 function sqm_trigger_imap_error($sErrNo,$sRequest,$sResponse, $sMessage, $aExtra=array()) {
 287     $aError = array(
 288                     'REQUEST' => $sRequest,
 289                     'RESPONSE' => $sResponse,
 290                     'MESSAGE' => $sMessage);
 291     $aError = array_merge($aExtra,$aError);
 292     sqm_trigger_error($sErrNo,$aError);
 293 }
 294
 295 /**
 296  * Trigger an error.
 297  * @param  string $sErrNo error string defined in errors.php
 298  * @param  array   $aExtra optional associative array with extra error info
 299  * @return void
 300  * @author  Marc Groot Koerkamp
 301  * @since 1.5.1
 302  */
 303 function sqm_trigger_error($sErrNo,$aExtra=array()) {
 304     static $aErrors;
 305     if (!isset($aErrors)) {
 306         // Include the error definition file.
 307         include_once(SM_PATH.'include/errors.php');
 308     }
 309
 310     $iPhpErr = E_USER_NOTICE;
 311     if (is_array($aErrors) && isset($aErrors[$sErrNo]['level'])) {
 312         if (is_array($aExtra) && count($aExtra)) {
 313             $aErrors[$sErrNo]['extra'] = $aExtra;
 314         }
 315         // because trigger_error can only handle a string argument for the error description
 316         // we serialize the result.
 317         $sErrString = serialize($aErrors[$sErrNo]);
 318         $iPhpErr = $aErrors[$sErrNo]['level'];
 319     } else {
 320         sm_print_r($aErrors);
 321         $sErrString = "Error <$sErrNo> does not exist, fix the code or update the errors.php file";
 322         $iPhpErr = E_USER_ERROR;
 323     }
 324     trigger_error($sErrString, $iPhpErr);
 325 }