lib/ErrorManager.php

   1 <?php rcs_id('$Id$');
   2
   3 if (isset($GLOBALS['ErrorManager'])) return;
   4
   5 // php5: ignore E_STRICT (var warnings)
   6 /*
   7 if (defined('E_STRICT')
   8     and (E_ALL & E_STRICT)
   9     and (error_reporting() & E_STRICT)) {
  10     echo " errormgr: error_reporting=", error_reporting();
  11     echo "\nplease fix that in your php.ini!";
  12     error_reporting(E_ALL & ~E_STRICT);
  13 }
  14 */
  15 define ('EM_FATAL_ERRORS', E_ERROR | E_PARSE | E_CORE_ERROR | E_COMPILE_ERROR | E_USER_ERROR | ~2048);
  16 define ('EM_WARNING_ERRORS',
  17         E_WARNING | E_CORE_WARNING | E_COMPILE_WARNING | E_USER_WARNING);
  18 define ('EM_NOTICE_ERRORS', E_NOTICE | E_USER_NOTICE);
  19
  20 /* It is recommended to leave assertions on.
  21    You can simply comment the two lines below to leave them on.
  22    Only where absolute speed is necessary you might want to turn
  23    them off.
  24 */
  25 //also turn it on if phpwiki_version notes no release
  26 if (defined('DEBUG') and DEBUG)
  27     assert_options (ASSERT_ACTIVE, 1);
  28 else
  29     assert_options (ASSERT_ACTIVE, 0);
  30 assert_options (ASSERT_CALLBACK, 'wiki_assert_handler');
  31
  32 function wiki_assert_handler ($file, $line, $code) {
  33     ErrorManager_errorHandler( $code, sprintf("<br />%s:%s: %s: Assertion failed <br />", $file, $line, $code), $file, $line);
  34 }
  35
  36 /**
  37  * A class which allows custom handling of PHP errors.
  38  *
  39  * This is a singleton class. There should only be one instance
  40  * of it --- you can access the one instance via $GLOBALS['ErrorManager'].
  41  *
  42  * FIXME: more docs.
  43  */
  44 class ErrorManager
  45 {
  46     /**
  47      * Constructor.
  48      *
  49      * As this is a singleton class, you should never call this.
  50      * @access private
  51      */
  52     function ErrorManager() {
  53         $this->_handlers = array();
  54         $this->_fatal_handler = false;
  55         $this->_postpone_mask = 0;
  56         $this->_postponed_errors = array();
  57
  58         set_error_handler('ErrorManager_errorHandler');
  59     }
  60
  61     /**
  62      * Get mask indicating which errors are currently being postponed.
  63      * @access public
  64      * @return int The current postponed error mask.
  65      */
  66     function getPostponedErrorMask() {
  67         return $this->_postpone_mask;
  68     }
  69
  70     /**
  71      * Set mask indicating which errors to postpone.
  72      *
  73      * The default value of the postpone mask is zero (no errors postponed.)
  74      *
  75      * When you set this mask, any queue errors which do not match the new
  76      * mask are reported.
  77      *
  78      * @access public
  79      * @param $newmask int The new value for the mask.
  80      */
  81     function setPostponedErrorMask($newmask) {
  82         $this->_postpone_mask = $newmask;
  83         if (function_exists('PrintXML'))
  84             PrintXML($this->_flush_errors($newmask));
  85         else
  86             echo($this->_flush_errors($newmask));
  87
  88     }
  89
  90     /**
  91      * Report any queued error messages.
  92      * @access public
  93      */
  94     function flushPostponedErrors() {
  95         if (function_exists('PrintXML'))
  96             PrintXML($this->_flush_errors());
  97         else
  98             echo $this->_flush_errors();
  99     }
 100
 101     /**
 102      * Get rid of all pending error messages in case of all non-html
 103      * - pdf or image - output.
 104      * @access public
 105      */
 106     function destroyPostponedErrors () {
 107         $this->_postponed_errors = array();
 108     }
 109
 110     /**
 111      * Get postponed errors, formatted as HTML.
 112      *
 113      * This also flushes the postponed error queue.
 114      *
 115      * @return object HTML describing any queued errors (or false, if none).
 116      */
 117     function getPostponedErrorsAsHTML() {
 118         $flushed = $this->_flush_errors();
 119         if (!$flushed)
 120             return false;
 121         if ($flushed->isEmpty())
 122             return false;
 123         // format it with the worst class (error, warning, notice)
 124         $worst_err = $flushed->_content[0];
 125         foreach ($flushed->_content as $err) {
 126             if ($err and isa($err, 'PhpError') and $err->errno > $worst_err->errno) {
 127                 $worst_err = $err;
 128             }
 129         }
 130         if ($worst_err->isNotice())
 131             return $flushed;
 132         $class = $worst_err->getHtmlClass();
 133         $html = HTML::div(array('style' => 'border: none', 'class' => $class),
 134                           HTML::h4(array('class' => 'errors'),
 135                                    "PHP " . $worst_err->getDescription()));
 136         $html->pushContent($flushed);
 137         return $html;
 138     }
 139
 140     /**
 141      * Push a custom error handler on the handler stack.
 142      *
 143      * Sometimes one is performing an operation where one expects
 144      * certain errors or warnings. In this case, one might not want
 145      * these errors reported in the normal manner. Installing a custom
 146      * error handler via this method allows one to intercept such
 147      * errors.
 148      *
 149      * An error handler installed via this method should be either a
 150      * function or an object method taking one argument: a PhpError
 151      * object.
 152      *
 153      * The error handler should return either:
 154      * <dl>
 155      * <dt> False <dd> If it has not handled the error. In this case,
 156      *                 error processing will proceed as if the handler
 157      *                 had never been called: the error will be passed
 158      *                 to the next handler in the stack, or the
 159      *                 default handler, if there are no more handlers
 160      *                 in the stack.
 161      *
 162      * <dt> True <dd> If the handler has handled the error. If the
 163      *                error was a non-fatal one, no further processing
 164      *                will be done. If it was a fatal error, the
 165      *                ErrorManager will still terminate the PHP
 166      *                process (see setFatalHandler.)
 167      *
 168      * <dt> A PhpError object <dd> The error is not considered
 169      *                             handled, and will be passed on to
 170      *                             the next handler(s) in the stack
 171      *                             (or the default handler). The
 172      *                             returned PhpError need not be the
 173      *                             same as the one passed to the
 174      *                             handler. This allows the handler to
 175      *                             "adjust" the error message.
 176      * </dl>
 177      * @access public
 178      * @param $handler WikiCallback  Handler to call.
 179      */
 180     function pushErrorHandler($handler) {
 181         array_unshift($this->_handlers, $handler);
 182     }
 183
 184     /**
 185      * Pop an error handler off the handler stack.
 186      * @access public
 187      */
 188     function popErrorHandler() {
 189         return array_shift($this->_handlers);
 190     }
 191
 192     /**
 193      * Set a termination handler.
 194      *
 195      * This handler will be called upon fatal errors. The handler
 196      * gets passed one argument: a PhpError object describing the
 197      * fatal error.
 198      *
 199      * @access public
 200      * @param $handler WikiCallback  Callback to call on fatal errors.
 201      */
 202     function setFatalHandler($handler) {
 203         $this->_fatal_handler = $handler;
 204     }
 205
 206     /**
 207      * Handle an error.
 208      *
 209      * The error is passed through any registered error handlers, and
 210      * then either reported or postponed.
 211      *
 212      * @access public
 213      * @param $error object A PhpError object.
 214      */
 215     function handleError($error) {
 216         static $in_handler;
 217
 218         if (!empty($in_handler)) {
 219             $msg = $error->_getDetail();
 220             $msg->unshiftContent(HTML::h2(fmt("%s: error while handling error:",
 221                                               "ErrorManager")));
 222             $msg->printXML();
 223             return;
 224         }
 225
 226         // template which flushed the pending errors already handled,
 227         // so display now all errors directly.
 228         if (!empty($GLOBALS['request']->_finishing)) {
 229             $this->_postpone_mask = 0;
 230         }
 231
 232         $in_handler = true;
 233
 234         foreach ($this->_handlers as $handler) {
 235             if (!$handler) continue;
 236             $result = $handler->call($error);
 237             if (!$result) {
 238                 continue;       // Handler did not handle error.
 239             }
 240             elseif (is_object($result)) {
 241                 // handler filtered the result. Still should pass to
 242                 // the rest of the chain.
 243                 if ($error->isFatal()) {
 244                     // Don't let handlers make fatal errors non-fatal.
 245                     $result->errno = $error->errno;
 246                 }
 247                 $error = $result;
 248             }
 249             else {
 250                 // Handler handled error.
 251                 if (!$error->isFatal()) {
 252                     $in_handler = false;
 253                     return;
 254                 }
 255                 break;
 256             }
 257         }
 258
 259         // Error was either fatal, or was not handled by a handler.
 260         // Handle it ourself.
 261         if ($error->isFatal()) {
 262             $this->_noCacheHeaders();
 263             echo "<html><body><div style=\"font-weight:bold; color:red\">Fatal Error:</div>\n";
 264             if (defined('DEBUG') and (DEBUG & _DEBUG_TRACE)) {
 265                 echo "error_reporting=",error_reporting(),"\n<br>";
 266                 if (function_exists("debug_backtrace")) // >= 4.3.0
 267                     $error->printSimpleTrace(debug_backtrace());
 268             }
 269             $this->_die($error);
 270         }
 271         else if (($error->errno & error_reporting()) != 0) {
 272             if  (($error->errno & $this->_postpone_mask) != 0) {
 273                 if ((function_exists('isa') and isa($error, 'PhpErrorOnce'))
 274                     or (!function_exists('isa') and
 275                     (
 276                      // stdlib independent isa()
 277                      (strtolower(get_class($error)) == 'phperroronce')
 278                      or (is_subclass_of($error, 'PhpErrorOnce'))))) {
 279                     $error->removeDoublettes($this->_postponed_errors);
 280                     if ( $error->_count < 2 )
 281                         $this->_postponed_errors[] = $error;
 282                 } else {
 283                     $this->_postponed_errors[] = $error;
 284                 }
 285             }
 286             else {
 287                 //echo "postponed errors: ";
 288                 $this->_noCacheHeaders();
 289                 if (defined('DEBUG') and (DEBUG & _DEBUG_TRACE)) {
 290                     echo "error_reporting=",error_reporting(),"\n";
 291                     if (function_exists("debug_backtrace")) // >= 4.3.0
 292                         $error->printSimpleTrace(debug_backtrace());
 293                 }
 294                 $error->printXML();
 295             }
 296         }
 297         $in_handler = false;
 298     }
 299
 300     function warning($msg, $errno = E_USER_NOTICE) {
 301         $this->handleError(new PhpWikiError($errno, $msg, '?', '?'));
 302     }
 303
 304     /**
 305      * @access private
 306      */
 307     function _die($error) {
 308         global $WikiTheme;
 309         //echo "\n\n<html><body>";
 310         $error->printXML();
 311         PrintXML($this->_flush_errors());
 312         if ($this->_fatal_handler)
 313             $this->_fatal_handler->call($error);
 314         if (!$WikiTheme->DUMP_MODE)
 315             exit -1;
 316     }
 317
 318     /**
 319      * @access private
 320      */
 321     function _flush_errors($keep_mask = 0) {
 322         $errors = &$this->_postponed_errors;
 323         if (empty($errors)) return '';
 324         $flushed = HTML();
 325         for ($i=0; $i<count($errors); $i++) {
 326             $error =& $errors[$i];
 327             if (!is_object($error)) {
 328                 continue;
 329             }
 330             if (($error->errno & $keep_mask) != 0)
 331                 continue;
 332             unset($errors[$i]);
 333             $flushed->pushContent($error);
 334         }
 335         return $flushed;
 336     }
 337
 338     function _noCacheHeaders() {
 339         global $request;
 340         static $already = false;
 341
 342         if (isset($request) and isset($request->_validators)) {
 343             $request->_validators->_tag = false;
 344             $request->_validators->_mtime = false;
 345         }
 346         if ($already) return;
 347
 348         // FIXME: Howto announce that to Request->cacheControl()?
 349         if (!headers_sent()) {
 350             header( "Cache-control: no-cache" );
 351             header( "Pragma: nocache" );
 352         }
 353         $already = true;
 354     }
 355 }
 356
 357 /**
 358  * Global error handler for class ErrorManager.
 359  *
 360  * This is necessary since PHP's set_error_handler() does not allow
 361  * one to set an object method as a handler.
 362  *
 363  * @access private
 364  */
 365 function ErrorManager_errorHandler($errno, $errstr, $errfile, $errline)
 366 {
 367     if (!isset($GLOBALS['ErrorManager'])) {
 368       $GLOBALS['ErrorManager'] = new ErrorManager;
 369     }
 370
 371     if (defined('DEBUG') and DEBUG) {
 372         $error = new PhpError($errno, $errstr, $errfile, $errline);
 373     } else {
 374         $error = new PhpErrorOnce($errno, $errstr, $errfile, $errline);
 375     }
 376     $GLOBALS['ErrorManager']->handleError($error);
 377 }
 378
 379
 380 /**
 381  * A class representing a PHP error report.
 382  *
 383  * @see The PHP documentation for set_error_handler at
 384  *      http://php.net/manual/en/function.set-error-handler.php .
 385  */
 386 class PhpError {
 387     /**
 388      * The PHP errno
 389      */
 390     //var $errno;
 391
 392     /**
 393      * The PHP error message.
 394      */
 395     //var $errstr;
 396
 397     /**
 398      * The source file where the error occurred.
 399      */
 400     //var $errfile;
 401
 402     /**
 403      * The line number (in $this->errfile) where the error occured.
 404      */
 405     //var $errline;
 406
 407     /**
 408      * Construct a new PhpError.
 409      * @param $errno   int
 410      * @param $errstr  string
 411      * @param $errfile string
 412      * @param $errline int
 413      */
 414     function PhpError($errno, $errstr, $errfile, $errline) {
 415         $this->errno   = $errno;
 416         $this->errstr  = $errstr;
 417         $this->errfile = $errfile;
 418         $this->errline = $errline;
 419     }
 420
 421     /**
 422      * Determine whether this is a fatal error.
 423      * @return boolean True if this is a fatal error.
 424      */
 425     function isFatal() {
 426         return ($this->errno & (2048|EM_WARNING_ERRORS|EM_NOTICE_ERRORS)) == 0;
 427     }
 428
 429     /**
 430      * Determine whether this is a warning level error.
 431      * @return boolean
 432      */
 433     function isWarning() {
 434         return ($this->errno & EM_WARNING_ERRORS) != 0;
 435     }
 436
 437     /**
 438      * Determine whether this is a notice level error.
 439      * @return boolean
 440      */
 441     function isNotice() {
 442         return ($this->errno & EM_NOTICE_ERRORS) != 0;
 443     }
 444     function getHtmlClass() {
 445         if ($this->isNotice()) {
 446             return 'hint';
 447         } elseif ($this->isWarning()) {
 448             return 'warning';
 449         } else {
 450             return 'errors';
 451         }
 452     }
 453
 454     function getDescription() {
 455         if ($this->isNotice()) {
 456             return 'Notice';
 457         } elseif ($this->isWarning()) {
 458             return 'Warning';
 459         } else {
 460             return 'Error';
 461         }
 462     }
 463
 464     /**
 465      * Get a printable, HTML, message detailing this error.
 466      * @return object The detailed error message.
 467      */
 468     function _getDetail() {
 469         $dir = defined('PHPWIKI_DIR') ? PHPWIKI_DIR : substr(dirname(__FILE__),0,-4);
 470         if (substr(PHP_OS,0,3) == 'WIN') {
 471            $dir = str_replace('/','\\',$dir);
 472            $this->errfile = str_replace('/','\\',$this->errfile);
 473            $dir .= "\\";
 474         } else
 475            $dir .= '/';
 476         $errfile = preg_replace('|^' . preg_quote($dir) . '|', '', $this->errfile);
 477         $lines = explode("\n", $this->errstr);
 478         if (DEBUG & _DEBUG_VERBOSE) {
 479           $msg = sprintf("%s:%d %s[%d]: %s",
 480                          $errfile, $this->errline,
 481                          $this->getDescription(), $this->errno,
 482                          array_shift($lines));
 483         }/* elseif (! $this->isFatal()) {
 484           $msg = sprintf("%s:%d %s: \"%s\"",
 485                          $errfile, $this->errline,
 486                          $this->getDescription(),
 487                          array_shift($lines));
 488         }*/ else {
 489           $msg = sprintf("%s:%d %s: \"%s\"",
 490                          $errfile, $this->errline,
 491                          $this->getDescription(),
 492                          array_shift($lines));
 493         }
 494
 495         $html = HTML::div(array('class' => $this->getHtmlClass()), HTML::p($msg));
 496         // The class is now used for the div container.
 497         // $html = HTML::div(HTML::p($msg));
 498         if ($lines) {
 499             $list = HTML::ul();
 500             foreach ($lines as $line)
 501                 $list->pushContent(HTML::li($line));
 502             $html->pushContent($list);
 503         }
 504
 505         return $html;
 506     }
 507
 508     /**
 509      * Print an HTMLified version of this error.
 510      * @see asXML()
 511      */
 512     function printXML() {
 513         PrintXML($this->_getDetail());
 514     }
 515
 516     /**
 517      * Return an HTMLified version of this error.
 518      */
 519     function asXML() {
 520         return AsXML($this->_getDetail());
 521     }
 522
 523     /**
 524      * Return a plain-text version of this error.
 525      */
 526     function asString() {
 527         return AsString($this->_getDetail());
 528     }
 529
 530     function printSimpleTrace($bt) {
 531         global $HTTP_SERVER_VARS;
 532         $nl = isset($HTTP_SERVER_VARS['REQUEST_METHOD']) ? "<br />" : "\n";
 533         echo $nl."Traceback:".$nl;
 534         foreach ($bt as $i => $elem) {
 535             if (!array_key_exists('file', $elem)) {
 536                 continue;
 537             }
 538             print "  " . $elem['file'] . ':' . $elem['line'] . $nl;
 539         }
 540         flush();
 541     }
 542 }
 543
 544 /**
 545  * A class representing a PhpWiki warning.
 546  *
 547  * This is essentially the same as a PhpError, except that the
 548  * error message is quieter: no source line, etc...
 549  */
 550 class PhpWikiError extends PhpError {
 551     /**
 552      * Construct a new PhpError.
 553      * @param $errno   int
 554      * @param $errstr  string
 555      */
 556     function PhpWikiError($errno, $errstr, $errfile, $errline) {
 557         $this->PhpError($errno, $errstr, $errfile, $errline);
 558     }
 559
 560     function _getDetail() {
 561         return HTML::div(array('class' => $this->getHtmlClass()),
 562                          HTML::p($this->getDescription() . ": $this->errstr"));
 563     }
 564 }
 565
 566 /**
 567  * A class representing a Php warning, printed only the first time.
 568  *
 569  * Similar to PhpError, except only the first same error message is printed,
 570  * with number of occurences.
 571  */
 572 class PhpErrorOnce extends PhpError {
 573
 574     function PhpErrorOnce($errno, $errstr, $errfile, $errline) {
 575         $this->_count = 1;
 576         $this->PhpError($errno, $errstr, $errfile, $errline);
 577     }
 578
 579     function _sameError($error) {
 580         if (!$error) return false;
 581         return ($this->errno == $error->errno and
 582                 $this->errfile == $error->errfile and
 583                 $this->errline == $error->errline);
 584     }
 585
 586     // count similar handlers, increase _count and remove the rest
 587     function removeDoublettes(&$errors) {
 588         for ($i=0; $i < count($errors); $i++) {
 589             if (!isset($errors[$i])) continue;
 590             if ($this->_sameError($errors[$i])) {
 591                 $errors[$i]->_count++;
 592                 $this->_count++;
 593                 if ($i) unset($errors[$i]);
 594             }
 595         }
 596         return $this->_count;
 597     }
 598
 599     function _getDetail($count=0) {
 600         if (!$count) $count = $this->_count;
 601         $dir = defined('PHPWIKI_DIR') ? PHPWIKI_DIR : substr(dirname(__FILE__),0,-4);
 602         if (substr(PHP_OS,0,3) == 'WIN') {
 603            $dir = str_replace('/','\\',$dir);
 604            $this->errfile = str_replace('/','\\',$this->errfile);
 605            $dir .= "\\";
 606         } else
 607            $dir .= '/';
 608         $errfile = preg_replace('|^' . preg_quote($dir) . '|', '', $this->errfile);
 609         if (is_string($this->errstr))
 610                 $lines = explode("\n", $this->errstr);
 611         elseif (is_object($this->errstr))
 612                 $lines = array($this->errstr->asXML());
 613         $errtype = (DEBUG & _DEBUG_VERBOSE) ? sprintf("%s[%d]", $this->getDescription(), $this->errno)
 614                                             : sprintf("%s", $this->getDescription());
 615         if ((DEBUG & _DEBUG_VERBOSE) or $this->isFatal()) {
 616             $msg = sprintf("%s:%d %s: %s %s",
 617                        $errfile, $this->errline,
 618                        $errtype,
 619                        array_shift($lines),
 620                        $count > 1 ? sprintf(" (...repeated %d times)",$count) : ""
 621                        );
 622         } else {
 623           $msg = sprintf("%s: \"%s\" %s",
 624                          $errtype,
 625                          array_shift($lines),
 626                          $count > 1 ? sprintf(" (...repeated %d times)",$count) : "");
 627         }
 628         $html = HTML::div(array('class' => $this->getHtmlClass()),
 629                           HTML::p($msg));
 630         if ($lines) {
 631             $list = HTML::ul();
 632             foreach ($lines as $line)
 633                 $list->pushContent(HTML::li($line));
 634             $html->pushContent($list);
 635         }
 636
 637         return $html;
 638     }
 639 }
 640
 641 require_once(dirname(__FILE__).'/HtmlElement.php');
 642
 643 if (!isset($GLOBALS['ErrorManager'])) {
 644     $GLOBALS['ErrorManager'] = new ErrorManager;
 645 }
 646
 647 // (c-file-style: "gnu")
 648 // Local Variables:
 649 // mode: php
 650 // tab-width: 8
 651 // c-basic-offset: 4
 652 // c-hanging-comment-ender-p: nil
 653 // indent-tabs-mode: nil
 654 // End:
 655 ?>