3 if (isset($GLOBALS['ErrorManager'])) return;
5 // php5: ignore E_STRICT (var warnings)
7 if (defined('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);
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);
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
25 //also turn it on if phpwiki_version notes no release
26 if (defined('DEBUG') and DEBUG)
27 assert_options (ASSERT_ACTIVE, 1);
29 assert_options (ASSERT_ACTIVE, 0);
30 assert_options (ASSERT_CALLBACK, 'wiki_assert_handler');
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);
37 * A class which allows custom handling of PHP errors.
39 * This is a singleton class. There should only be one instance
40 * of it --- you can access the one instance via $GLOBALS['ErrorManager'].
49 * As this is a singleton class, you should never call this.
52 function ErrorManager() {
53 $this->_handlers = array();
54 $this->_fatal_handler = false;
55 $this->_postpone_mask = 0;
56 $this->_postponed_errors = array();
58 set_error_handler('ErrorManager_errorHandler');
62 * Get mask indicating which errors are currently being postponed.
64 * @return int The current postponed error mask.
66 function getPostponedErrorMask() {
67 return $this->_postpone_mask;
71 * Set mask indicating which errors to postpone.
73 * The default value of the postpone mask is zero (no errors postponed.)
75 * When you set this mask, any queue errors which do not match the new
79 * @param $newmask int The new value for the mask.
81 function setPostponedErrorMask($newmask) {
82 $this->_postpone_mask = $newmask;
83 if (function_exists('PrintXML'))
84 PrintXML($this->_flush_errors($newmask));
86 echo($this->_flush_errors($newmask));
91 * Report any queued error messages.
94 function flushPostponedErrors() {
95 if (function_exists('PrintXML'))
96 PrintXML($this->_flush_errors());
98 echo $this->_flush_errors();
102 * Get rid of all pending error messages in case of all non-html
103 * - pdf or image - output.
106 function destroyPostponedErrors () {
107 $this->_postponed_errors = array();
111 * Get postponed errors, formatted as HTML.
113 * This also flushes the postponed error queue.
115 * @return object HTML describing any queued errors (or false, if none).
117 function getPostponedErrorsAsHTML() {
118 $flushed = $this->_flush_errors();
121 if ($flushed->isEmpty())
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) {
130 if ($worst_err->isNotice())
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);
141 * Push a custom error handler on the handler stack.
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
149 * An error handler installed via this method should be either a
150 * function or an object method taking one argument: a PhpError
153 * The error handler should return either:
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
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.)
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.
178 * @param $handler WikiCallback Handler to call.
180 function pushErrorHandler($handler) {
181 array_unshift($this->_handlers, $handler);
185 * Pop an error handler off the handler stack.
188 function popErrorHandler() {
189 return array_shift($this->_handlers);
193 * Set a termination handler.
195 * This handler will be called upon fatal errors. The handler
196 * gets passed one argument: a PhpError object describing the
200 * @param $handler WikiCallback Callback to call on fatal errors.
202 function setFatalHandler($handler) {
203 $this->_fatal_handler = $handler;
209 * The error is passed through any registered error handlers, and
210 * then either reported or postponed.
213 * @param $error object A PhpError object.
215 function handleError($error) {
218 if (!empty($in_handler)) {
219 $msg = $error->_getDetail();
220 $msg->unshiftContent(HTML::h2(fmt("%s: error while handling error:",
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;
234 foreach ($this->_handlers as $handler) {
235 if (!$handler) continue;
236 $result = $handler->call($error);
238 continue; // Handler did not handle error.
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;
250 // Handler handled error.
251 if (!$error->isFatal()) {
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());
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
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;
283 $this->_postponed_errors[] = $error;
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());
300 function warning($msg, $errno = E_USER_NOTICE) {
301 $this->handleError(new PhpWikiError($errno, $msg, '?', '?'));
307 function _die($error) {
309 //echo "\n\n<html><body>";
311 PrintXML($this->_flush_errors());
312 if ($this->_fatal_handler)
313 $this->_fatal_handler->call($error);
314 if (!$WikiTheme->DUMP_MODE)
321 function _flush_errors($keep_mask = 0) {
322 $errors = &$this->_postponed_errors;
323 if (empty($errors)) return '';
325 for ($i=0; $i<count($errors); $i++) {
326 $error =& $errors[$i];
327 if (!is_object($error)) {
330 if (($error->errno & $keep_mask) != 0)
333 $flushed->pushContent($error);
338 function _noCacheHeaders() {
340 static $already = false;
342 if (isset($request) and isset($request->_validators)) {
343 $request->_validators->_tag = false;
344 $request->_validators->_mtime = false;
346 if ($already) return;
348 // FIXME: Howto announce that to Request->cacheControl()?
349 if (!headers_sent()) {
350 header( "Cache-control: no-cache" );
351 header( "Pragma: nocache" );
358 * Global error handler for class ErrorManager.
360 * This is necessary since PHP's set_error_handler() does not allow
361 * one to set an object method as a handler.
365 function ErrorManager_errorHandler($errno, $errstr, $errfile, $errline)
367 if (!isset($GLOBALS['ErrorManager'])) {
368 $GLOBALS['ErrorManager'] = new ErrorManager;
371 if (defined('DEBUG') and DEBUG) {
372 $error = new PhpError($errno, $errstr, $errfile, $errline);
374 $error = new PhpErrorOnce($errno, $errstr, $errfile, $errline);
376 $GLOBALS['ErrorManager']->handleError($error);
381 * A class representing a PHP error report.
383 * @see The PHP documentation for set_error_handler at
384 * http://php.net/manual/en/function.set-error-handler.php .
393 * The PHP error message.
398 * The source file where the error occurred.
403 * The line number (in $this->errfile) where the error occured.
408 * Construct a new PhpError.
410 * @param $errstr string
411 * @param $errfile string
412 * @param $errline int
414 function PhpError($errno, $errstr, $errfile, $errline) {
415 $this->errno = $errno;
416 $this->errstr = $errstr;
417 $this->errfile = $errfile;
418 $this->errline = $errline;
422 * Determine whether this is a fatal error.
423 * @return boolean True if this is a fatal error.
426 return ($this->errno & (2048|EM_WARNING_ERRORS|EM_NOTICE_ERRORS)) == 0;
430 * Determine whether this is a warning level error.
433 function isWarning() {
434 return ($this->errno & EM_WARNING_ERRORS) != 0;
438 * Determine whether this is a notice level error.
441 function isNotice() {
442 return ($this->errno & EM_NOTICE_ERRORS) != 0;
444 function getHtmlClass() {
445 if ($this->isNotice()) {
447 } elseif ($this->isWarning()) {
454 function getDescription() {
455 if ($this->isNotice()) {
457 } elseif ($this->isWarning()) {
465 * Get a printable, HTML, message detailing this error.
466 * @return object The detailed error message.
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);
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));
489 $msg = sprintf("%s:%d %s: \"%s\"",
490 $errfile, $this->errline,
491 $this->getDescription(),
492 array_shift($lines));
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));
500 foreach ($lines as $line)
501 $list->pushContent(HTML::li($line));
502 $html->pushContent($list);
509 * Print an HTMLified version of this error.
512 function printXML() {
513 PrintXML($this->_getDetail());
517 * Return an HTMLified version of this error.
520 return AsXML($this->_getDetail());
524 * Return a plain-text version of this error.
526 function asString() {
527 return AsString($this->_getDetail());
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)) {
538 print " " . $elem['file'] . ':' . $elem['line'] . $nl;
545 * A class representing a PhpWiki warning.
547 * This is essentially the same as a PhpError, except that the
548 * error message is quieter: no source line, etc...
550 class PhpWikiError extends PhpError {
552 * Construct a new PhpError.
554 * @param $errstr string
556 function PhpWikiError($errno, $errstr, $errfile, $errline) {
557 $this->PhpError($errno, $errstr, $errfile, $errline);
560 function _getDetail() {
561 return HTML::div(array('class' => $this->getHtmlClass()),
562 HTML::p($this->getDescription() . ": $this->errstr"));
567 * A class representing a Php warning, printed only the first time.
569 * Similar to PhpError, except only the first same error message is printed,
570 * with number of occurences.
572 class PhpErrorOnce extends PhpError {
574 function PhpErrorOnce($errno, $errstr, $errfile, $errline) {
576 $this->PhpError($errno, $errstr, $errfile, $errline);
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);
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++;
593 if ($i) unset($errors[$i]);
596 return $this->_count;
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);
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,
620 $count > 1 ? sprintf(" (...repeated %d times)",$count) : ""
623 $msg = sprintf("%s: \"%s\" %s",
626 $count > 1 ? sprintf(" (...repeated %d times)",$count) : "");
628 $html = HTML::div(array('class' => $this->getHtmlClass()),
632 foreach ($lines as $line)
633 $list->pushContent(HTML::li($line));
634 $html->pushContent($list);
641 require_once(dirname(__FILE__).'/HtmlElement.php');
643 if (!isset($GLOBALS['ErrorManager'])) {
644 $GLOBALS['ErrorManager'] = new ErrorManager;
647 // (c-file-style: "gnu")
652 // c-hanging-comment-ender-p: nil
653 // indent-tabs-mode: nil