Uh, also I shouldn't introduce syntax errors while fixing regressions.
[lhc/web/wiklou.git] / includes / Exception.php
index 11bb597..34671ff 100644 (file)
-<?php\r
-\r
-class MWException extends Exception\r
-{\r
-       function useOutputPage() {\r
-               return !empty( $GLOBALS['wgFullyInitialised'] );\r
-       }\r
-\r
-       function useMessageCache() {\r
-               global $wgLang;\r
-               return is_object( $wgLang );\r
-       }\r
-\r
-       function msg( $key, $fallback /*[, params...] */ ) {\r
-               $args = array_slice( func_get_args(), 2 );\r
-               if ( $this->useMessageCache() ) {\r
-                       return wfMsgReal( $key, $args );\r
-               } else {\r
-                       return wfMsgReplaceArgs( $fallback, $args );\r
-               }\r
-       }\r
-                       \r
-       function getHTML() {\r
-               return '<p>' . htmlspecialchars( $this->getMessage() ) . \r
-                       '</p><p>Backtrace:</p><p>' . nl2br( htmlspecialchars( $this->getTraceAsString() ) ) .\r
-                       "</p>\n";\r
-       }\r
-\r
-       function getText() {\r
-               return $this->getMessage() .  \r
-                       "\nBacktrace:\n" . $this->getTraceAsString() . "\n";\r
-       }\r
-       \r
-       function getPageTitle() {\r
-               if ( $this->useMessageCache() ) {\r
-                       return wfMsg( 'internalerror' );\r
-               } else {\r
-                       global $wgSitename;\r
-                       return "$wgSitename error";\r
-               }\r
-       }\r
-       \r
-       function reportHTML() {\r
-               global $wgOut;\r
-               if ( $this->useOutputPage() ) {\r
-                       $wgOut->setPageTitle( $this->getPageTitle() );\r
-                       $wgOut->setRobotpolicy( "noindex,nofollow" );\r
-                       $wgOut->setArticleRelated( false );\r
-                       $wgOut->enableClientCache( false );\r
-                       $wgOut->redirect( '' );\r
-                       $wgOut->clearHTML();\r
-                       $wgOut->addHTML( $this->getHTML() );\r
-                       $wgOut->output();\r
-               } else {\r
-                       echo $this->htmlHeader();\r
-                       echo $this->getHTML();\r
-                       echo $this->htmlFooter();\r
-               }\r
-       }\r
-       \r
-       function reportText() {\r
-               echo $this->getText();\r
-       }\r
-\r
-       function report() {\r
-               global $wgCommandLineMode;\r
-               if ( $wgCommandLineMode ) {\r
-                       $this->reportText();\r
-               } else {\r
-                       $this->reportHTML();\r
-               }\r
-       }\r
-\r
-       function htmlHeader() {\r
-               global $wgLogo, $wgSitename, $wgOutputEncoding;\r
-\r
-               if ( !headers_sent() ) {\r
-                       header( 'HTTP/1.0 500 Internal Server Error' );\r
-                       header( 'Content-type: text/html; charset='.$wgOutputEncoding );\r
-                       /* Don't cache error pages!  They cause no end of trouble... */\r
-                       header( 'Cache-control: none' );\r
-                       header( 'Pragma: nocache' );\r
-               }\r
-               $title = $this->getPageTitle();\r
-               echo "<html>\r
-               <head>\r
-               <title>$title</title>\r
-               </head>\r
-               <body>\r
-               <h1><img src='$wgLogo' style='float:left;margin-right:1em' alt=''>$title</h1>\r
-               ";\r
-       }\r
-\r
-       function htmlFooter() {\r
-               echo "</body></html>";\r
-       }               \r
-}\r
-\r
-/**\r
- * Exception class which takes an HTML error message, and does not \r
- * produce a backtrace. Replacement for OutputPage::fatalError().\r
- */\r
-class FatalError extends MWException {\r
-       function getHTML() {\r
-               return $this->getMessage();\r
-       }\r
-\r
-       function getText() {\r
-               return $this->getMessage();\r
-       }\r
-}\r
-\r
-/**\r
- * Install an exception handler for MediaWiki exception types.\r
- */\r
-function wfInstallExceptionHandler() {\r
-       set_exception_handler( 'wfExceptionHandler' );\r
-}\r
-\r
-/**\r
- * Report an exception to the user\r
- */\r
-function wfReportException( Exception $e ) {\r
-        if ( is_a( $e, 'MWException' ) ) {\r
-                try {\r
-                        $e->report();\r
-                } catch ( Exception $e2 ) {\r
-                        // Exception occurred from within exception handler\r
-                        // Show a simpler error message for the original exception, \r
-                        // don't try to invoke report()\r
-                        $message = "MediaWiki internal error.\n\n" .\r
-                        "Original exception: " . $e->__toString() . \r
-                        "\n\nException caught inside exception handler: " . \r
-                        $e2->__toString() . "\n";\r
-\r
-                        if ( !empty( $GLOBALS['wgCommandLineMode'] ) ) {\r
-                                echo $message;\r
-                        } else {\r
-                                echo nl2br( htmlspecialchars( $message ) ). "\n";\r
-                        }\r
-                }\r
-        } else {\r
-                echo $e->__toString();\r
-        }\r
-}\r
-\r
-/**\r
- * Exception handler which simulates the appropriate catch() handling:\r
- * \r
- *   try {\r
- *       ...\r
- *   } catch ( MWException $e ) {\r
- * \r
- *       $e->report();\r
- *   } catch ( Exception $e ) {\r
- *       echo $e->__toString();\r
- *   }\r
- */\r
-function wfExceptionHandler( $e ) {\r
-       wfReportException( $e );\r
-       \r
-       // Final cleanup, similar to wfErrorExit()\r
-       try {\r
-               wfProfileClose();\r
-               logProfilingData();\r
-       } catch ( Exception $e ) {}\r
-\r
-       // Exit value should be nonzero for the benefit of shell jobs\r
-       exit( 1 );\r
-}\r
-\r
-?>\r
+<?php
+/**
+ * @defgroup Exception Exception
+ */
+
+/**
+ * MediaWiki exception
+ * @ingroup Exception
+ */
+class MWException extends Exception {
+
+       /**
+        * Should the exception use $wgOut to output the error ?
+        * @return bool
+        */
+       function useOutputPage() {
+               return !empty( $GLOBALS['wgFullyInitialised'] ) &&
+                       ( !empty( $GLOBALS['wgArticle'] ) || ( !empty( $GLOBALS['wgOut'] ) && !$GLOBALS['wgOut']->isArticle() ) ) &&
+                       !empty( $GLOBALS['wgTitle'] );
+       }
+
+       /**
+        * Can the extension use wfMsg() to get i18n messages ?
+        * @return bool
+        */
+       function useMessageCache() {
+               global $wgLang;
+               return is_object( $wgLang );
+       }
+
+       /**
+        * Run hook to allow extensions to modify the text of the exception
+        *
+        * @param String $name class name of the exception
+        * @param Array $args arguments to pass to the callback functions
+        * @return mixed string to output or null if any hook has been called
+        */
+       function runHooks( $name, $args = array() ) {
+               global $wgExceptionHooks;
+               if( !isset( $wgExceptionHooks ) || !is_array( $wgExceptionHooks ) )
+                       return; // Just silently ignore
+               if( !array_key_exists( $name, $wgExceptionHooks ) || !is_array( $wgExceptionHooks[ $name ] ) )
+                       return;
+               $hooks = $wgExceptionHooks[ $name ];
+               $callargs = array_merge( array( $this ), $args );
+
+               foreach( $hooks as $hook ) {
+                       if( is_string( $hook ) || ( is_array( $hook ) && count( $hook ) >= 2 && is_string( $hook[0] ) ) ) {     //'function' or array( 'class', hook' )
+                               $result = call_user_func_array( $hook, $callargs );
+                       } else {
+                               $result = null;
+                       }
+                       if( is_string( $result ) )
+                               return $result;
+               }
+       }
+
+       /**
+        * Get a message from i18n
+        *
+        * @param String $key message name
+        * @param String $fallback default message if the message cache can't be
+        *                         called by the exception
+        * The function also has other parameters that are arguments for the message
+        * @return String message with arguments replaced
+        */
+       function msg( $key, $fallback /*[, params...] */ ) {
+               $args = array_slice( func_get_args(), 2 );
+               if ( $this->useMessageCache() ) {
+                       return wfMsgReal( $key, $args );
+               } else {
+                       return wfMsgReplaceArgs( $fallback, $args );
+               }
+       }
+
+       /**
+        * If $wgShowExceptionDetails is true, return a HTML message with a
+        * backtrace to the error, otherwise show a message to ask to set it to true
+        * to show that information.
+        *
+        * @return String html to output
+        */
+       function getHTML() {
+               global $wgShowExceptionDetails;
+               if( $wgShowExceptionDetails ) {
+                       return '<p>' . htmlspecialchars( $this->getMessage() ) .
+                               '</p><p>Backtrace:</p><p>' . nl2br( htmlspecialchars( $this->getTraceAsString() ) ) .
+                               "</p>\n";
+               } else {
+                       return "<p>Set <b><tt>\$wgShowExceptionDetails = true;</tt></b> " .
+                               "at the bottom of LocalSettings.php to show detailed " .
+                               "debugging information.</p>";
+               }
+       }
+
+       /**
+        * If $wgShowExceptionDetails is true, return a text message with a
+        * backtrace to the error.
+        */
+       function getText() {
+               global $wgShowExceptionDetails;
+               if( $wgShowExceptionDetails ) {
+                       return $this->getMessage() .
+                               "\nBacktrace:\n" . $this->getTraceAsString() . "\n";
+               } else {
+                       return "Set \$wgShowExceptionDetails = true; " .
+                               "in LocalSettings.php to show detailed debugging information.\n";
+               }
+       }
+
+       /* Return titles of this error page */
+       function getPageTitle() {
+               if ( $this->useMessageCache() ) {
+                       return wfMsg( 'internalerror' );
+               } else {
+                       global $wgSitename;
+                       return "$wgSitename error";
+               }
+       }
+
+       /**
+        * Return the requested URL and point to file and line number from which the
+        * exception occured
+        *
+        * @return string
+        */
+       function getLogMessage() {
+               global $wgRequest;
+               $file = $this->getFile();
+               $line = $this->getLine();
+               $message = $this->getMessage();
+               return $wgRequest->getRequestURL() . " Exception from line $line of $file: $message";
+       }
+
+       /** Output the exception report using HTML */
+       function reportHTML() {
+               global $wgOut;
+               if ( $this->useOutputPage() ) {
+                       $wgOut->setPageTitle( $this->getPageTitle() );
+                       $wgOut->setRobotPolicy( "noindex,nofollow" );
+                       $wgOut->setArticleRelated( false );
+                       $wgOut->enableClientCache( false );
+                       $wgOut->redirect( '' );
+                       $wgOut->clearHTML();
+                       if( $hookResult = $this->runHooks( get_class( $this ) ) ) {
+                               $wgOut->addHTML( $hookResult );
+                       } else {
+                               $wgOut->addHTML( $this->getHTML() );
+                       }
+                       $wgOut->output();
+               } else {
+                       if( $hookResult = $this->runHooks( get_class( $this ) . "Raw" ) ) {
+                               die( $hookResult );
+                       }
+                       echo $this->htmlHeader();
+                       echo $this->getHTML();
+                       echo $this->htmlFooter();
+               }
+       }
+
+       /**
+        * Output a report about the exception and takes care of formatting.
+        * It will be either HTML or plain text based on $wgCommandLineMode.
+        */
+       function report() {
+               global $wgCommandLineMode;
+               $log = $this->getLogMessage();
+               if ( $log ) {
+                       wfDebugLog( 'exception', $log );
+               }
+               if ( $wgCommandLineMode ) {
+                       fwrite( STDERR, $this->getText() );
+               } else {
+                       $this->reportHTML();
+               }
+       }
+
+       /**
+        * Send headers and output the beginning of the html page if not using
+        * $wgOut to output the exception.
+        */
+       function htmlHeader() {
+               global $wgLogo, $wgSitename, $wgOutputEncoding;
+
+               if ( !headers_sent() ) {
+                       header( 'HTTP/1.0 500 Internal Server Error' );
+                       header( 'Content-type: text/html; charset='.$wgOutputEncoding );
+                       /* Don't cache error pages!  They cause no end of trouble... */
+                       header( 'Cache-control: none' );
+                       header( 'Pragma: nocache' );
+               }
+               $title = $this->getPageTitle();
+               echo "<html>
+               <head>
+               <title>$title</title>
+               </head>
+               <body>
+               <h1><img src='$wgLogo' style='float:left;margin-right:1em' alt=''>$title</h1>
+               ";
+       }
+
+       /**
+        * print the end of the html page if not using $wgOut.
+        */
+       function htmlFooter() {
+               echo "</body></html>";
+       }
+}
+
+/**
+ * Exception class which takes an HTML error message, and does not
+ * produce a backtrace. Replacement for OutputPage::fatalError().
+ * @ingroup Exception
+ */
+class FatalError extends MWException {
+       function getHTML() {
+               return $this->getMessage();
+       }
+
+       function getText() {
+               return $this->getMessage();
+       }
+}
+
+/**
+ * @ingroup Exception
+ */
+class ErrorPageError extends MWException {
+       public $title, $msg;
+
+       /**
+        * Note: these arguments are keys into wfMsg(), not text!
+        */
+       function __construct( $title, $msg ) {
+               $this->title = $title;
+               $this->msg = $msg;
+               parent::__construct( wfMsg( $msg ) );
+       }
+
+       function report() {
+               global $wgOut;
+               $wgOut->showErrorPage( $this->title, $this->msg );
+               $wgOut->output();
+       }
+}
+
+/**
+ * Install an exception handler for MediaWiki exception types.
+ */
+function wfInstallExceptionHandler() {
+       set_exception_handler( 'wfExceptionHandler' );
+}
+
+/**
+ * Report an exception to the user
+ */
+function wfReportException( Exception $e ) {
+        if ( $e instanceof MWException ) {
+                try {
+                        $e->report();
+                } catch ( Exception $e2 ) {
+                        // Exception occurred from within exception handler
+                        // Show a simpler error message for the original exception,
+                        // don't try to invoke report()
+                        $message = "MediaWiki internal error.\n\n" .
+                        "Original exception: " . $e->__toString() .
+                        "\n\nException caught inside exception handler: " .
+                        $e2->__toString() . "\n";
+
+                        if ( !empty( $GLOBALS['wgCommandLineMode'] ) ) {
+                                fwrite( STDERR, $message );
+                        } else {
+                                echo nl2br( htmlspecialchars( $message ) ). "\n";
+                        }
+                }
+        } else {
+                echo $e->__toString();
+        }
+}
+
+/**
+ * Exception handler which simulates the appropriate catch() handling:
+ *
+ *   try {
+ *       ...
+ *   } catch ( MWException $e ) {
+ *       $e->report();
+ *   } catch ( Exception $e ) {
+ *       echo $e->__toString();
+ *   }
+ */
+function wfExceptionHandler( $e ) {
+       global $wgFullyInitialised;
+       wfReportException( $e );
+
+       // Final cleanup, similar to wfErrorExit()
+       if ( $wgFullyInitialised ) {
+               try {
+                       wfLogProfilingData(); // uses $wgRequest, hence the $wgFullyInitialised condition
+               } catch ( Exception $e ) {}
+       }
+
+       // Exit value should be nonzero for the benefit of shell jobs
+       exit( 1 );
+}