Fixing E_NOTICE

[lhc/web/wiklou.git] / includes / Exception.php

diff --git a/includes/Exception.php b/includes/Exception.php
index 81cf12f..742a8de 100644 (file)
--- a/includes/Exception.php
+++ b/includes/Exception.php
@@ -1,20 +1,65 @@
 <?php
 
 /**
+ * MediaWiki exception
  * @addtogroup Exception
  */
-class MWException extends 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['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() ) {
@@ -24,6 +69,13 @@ class MWException extends Exception
                }
        }
 
+       /**
+        * 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 ) {
@@ -32,10 +84,15 @@ class MWException extends Exception
                                "</p>\n";
                } else {
                        return "<p>Set <b><tt>\$wgShowExceptionDetails = true;</tt></b> " .
-                               "in LocalSettings.php to show detailed debugging information.</p>";
+                               "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 ) {
@@ -46,7 +103,8 @@ class MWException extends Exception
                                "in LocalSettings.php to show detailed debugging information.</p>";
                }
        }
-       
+
+       /* Return titles of this error page */
        function getPageTitle() {
                if ( $this->useMessageCache() ) {
                        return wfMsg( 'internalerror' );
@@ -55,7 +113,13 @@ class MWException extends Exception
                        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();
@@ -63,7 +127,8 @@ class MWException extends Exception
                $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() ) {
@@ -73,23 +138,30 @@ class MWException extends Exception
                        $wgOut->enableClientCache( false );
                        $wgOut->redirect( '' );
                        $wgOut->clearHTML();
-                       $wgOut->addHTML( $this->getHTML() );
+                       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();
                }
        }
-       
-       function reportText() {
-               echo $this->getText();
-       }
 
+       /**
+        * 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;
                if ( $wgCommandLineMode ) {
-                       $this->reportText();
+                       fwrite( STDERR, $this->getText() );
                } else {
                        $log = $this->getLogMessage();
                        if ( $log ) {
@@ -99,6 +171,10 @@ class MWException extends Exception
                }
        }
 
+       /**
+        * Send headers and output the beginning of the html page if not using
+        * $wgOut to output the exception.
+        */
        function htmlHeader() {
                global $wgLogo, $wgSitename, $wgOutputEncoding;
 
@@ -119,10 +195,12 @@ class MWException extends Exception
                ";
        }
 
+       /**
+        * print the end of the html page if not using $wgOut.
+        */
        function htmlFooter() {
                echo "</body></html>";
        }
-
 }
 
 /**
@@ -186,7 +264,7 @@ function wfReportException( Exception $e ) {
                         $e2->__toString() . "\n";
 
                         if ( !empty( $GLOBALS['wgCommandLineMode'] ) ) {
-                                echo $message;
+                                fwrite( STDERR, $message );
                         } else {
                                 echo nl2br( htmlspecialchars( $message ) ). "\n";
                         }
@@ -210,7 +288,7 @@ function wfReportException( Exception $e ) {
 function wfExceptionHandler( $e ) {
        global $wgFullyInitialised;
        wfReportException( $e );
-       
+
        // Final cleanup, similar to wfErrorExit()
        if ( $wgFullyInitialised ) {
                try {
@@ -222,4 +300,4 @@ function wfExceptionHandler( $e ) {
        exit( 1 );
 }
 
-?>
+