Follow up r112423, added release note.
[lhc/web/wiklou.git] / includes / Exception.php
index a5e86cd..e7700b5 100644 (file)
@@ -22,7 +22,7 @@ class MWException extends Exception {
        function useOutputPage() {
                return $this->useMessageCache() &&
                        !empty( $GLOBALS['wgFullyInitialised'] ) &&
-                       ( !empty( $GLOBALS['wgArticle'] ) || ( !empty( $GLOBALS['wgOut'] ) && !$GLOBALS['wgOut']->isArticle() ) ) &&
+                       !empty( $GLOBALS['wgOut'] ) &&
                        !empty( $GLOBALS['wgTitle'] );
        }
 
@@ -39,7 +39,7 @@ class MWException extends Exception {
                        }
                }
 
-               return is_object( $wgLang );
+               return $wgLang instanceof Language;
        }
 
        /**
@@ -53,7 +53,7 @@ class MWException extends Exception {
                global $wgExceptionHooks;
 
                if ( !isset( $wgExceptionHooks ) || !is_array( $wgExceptionHooks ) ) {
-                       return; // Just silently ignore
+                       return; // Just silently ignore
                }
 
                if ( !array_key_exists( $name, $wgExceptionHooks ) || !is_array( $wgExceptionHooks[ $name ] ) ) {
@@ -70,8 +70,9 @@ class MWException extends Exception {
                                $result = null;
                        }
 
-                       if ( is_string( $result ) )
+                       if ( is_string( $result ) ) {
                                return $result;
+                       }
                }
        }
 
@@ -88,7 +89,7 @@ class MWException extends Exception {
                $args = array_slice( func_get_args(), 2 );
 
                if ( $this->useMessageCache() ) {
-                       return wfMsgReal( $key, $args );
+                       return wfMsgNoTrans( $key, $args );
                } else {
                        return wfMsgReplaceArgs( $fallback, $args );
                }
@@ -118,6 +119,7 @@ class MWException extends Exception {
        /**
         * If $wgShowExceptionDetails is true, return a text message with a
         * backtrace to the error.
+        * @return string
         */
        function getText() {
                global $wgShowExceptionDetails;
@@ -131,15 +133,12 @@ class MWException extends Exception {
                }
        }
 
-       /* Return titles of this error page */
+       /**
+        * Return titles of this error page
+        * @return String
+        */
        function getPageTitle() {
-               if ( $this->useMessageCache() ) {
-                       return wfMsg( 'internalerror' );
-               } else {
-                       global $wgSitename;
-
-                       return "$wgSitename error";
-               }
+               return $this->msg( 'internalerror', "Internal error" );
        }
 
        /**
@@ -155,7 +154,7 @@ class MWException extends Exception {
                $line = $this->getLine();
                $message = $this->getMessage();
 
-               if ( isset( $wgRequest ) ) {
+               if ( isset( $wgRequest ) && !$wgRequest instanceof FauxRequest ) {
                        $url = $wgRequest->getRequestURL();
                        if ( !$url ) {
                                $url = '[no URL]';
@@ -170,16 +169,11 @@ class MWException extends Exception {
        /** 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->prepareErrorPage( $this->getPageTitle() );
+
+                       $hookResult = $this->runHooks( get_class( $this ) );
+                       if ( $hookResult ) {
                                $wgOut->addHTML( $hookResult );
                        } else {
                                $wgOut->addHTML( $this->getHTML() );
@@ -187,17 +181,14 @@ class MWException extends Exception {
 
                        $wgOut->output();
                } else {
-                       if ( $hookResult = $this->runHooks( get_class( $this ) . "Raw" ) ) {
+                       header( "Content-Type: text/html; charset=utf-8" );
+                       $hookResult = $this->runHooks( get_class( $this ) . "Raw" );
+                       if ( $hookResult ) {
                                die( $hookResult );
                        }
 
-                       if ( defined( 'MEDIAWIKI_INSTALL' ) || $this->htmlBodyOnly() ) {
-                               echo $this->getHTML();
-                       } else {
-                               echo $this->htmlHeader();
-                               echo $this->getHTML();
-                               echo $this->htmlFooter();
-                       }
+                       echo $this->getHTML();
+                       die(1);
                }
        }
 
@@ -212,54 +203,23 @@ class MWException extends Exception {
                        wfDebugLog( 'exception', $log );
                }
 
-               if ( self::isCommandLine() ) {
-                       wfPrintError( $this->getText() );
+               if ( defined( 'MW_API' ) ) {
+                       // Unhandled API exception, we can't be sure that format printer is alive
+                       header( 'MediaWiki-API-Error: internal_api_error_' . get_class( $this ) );
+                       wfHttpError(500, 'Internal Server Error', $this->getText() );
+               } elseif ( self::isCommandLine() ) {
+                       MWExceptionHandler::printError( $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, $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();
-               return "<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() {
-               return "</body></html>";
-       }
-
-       /**
-        * headers handled by subclass?
+        * @static
+        * @return bool
         */
-       function htmlBodyOnly() {
-               return false;
-       }
-
        static function isCommandLine() {
-               return !empty( $GLOBALS['wgCommandLineMode'] ) && !defined( 'MEDIAWIKI_INSTALL' );
+               return !empty( $GLOBALS['wgCommandLineMode'] );
        }
 }
 
@@ -269,132 +229,357 @@ class MWException extends Exception {
  * @ingroup Exception
  */
 class FatalError extends MWException {
+
+       /**
+        * @return string
+        */
        function getHTML() {
                return $this->getMessage();
        }
 
+       /**
+        * @return string
+        */
        function getText() {
                return $this->getMessage();
        }
 }
 
 /**
+ * An error page which can definitely be safely rendered using the OutputPage
  * @ingroup Exception
  */
 class ErrorPageError extends MWException {
-       public $title, $msg;
+       public $title, $msg, $params;
 
        /**
         * Note: these arguments are keys into wfMsg(), not text!
         */
-       function __construct( $title, $msg ) {
+       function __construct( $title, $msg, $params = null ) {
                $this->title = $title;
                $this->msg = $msg;
-               parent::__construct( wfMsg( $msg ) );
+               $this->params = $params;
+
+               if( $msg instanceof Message ){
+                       parent::__construct( $msg );
+               } else {
+                       parent::__construct( wfMsg( $msg ) );
+               }
        }
 
        function report() {
                global $wgOut;
 
-               $wgOut->showErrorPage( $this->title, $this->msg );
+
+               $wgOut->showErrorPage( $this->title, $this->msg, $this->params );
                $wgOut->output();
        }
 }
 
 /**
- * Install an exception handler for MediaWiki exception types.
+ * Show an error page on a badtitle.
+ * Similar to ErrorPage, but emit a 400 HTTP error code to let mobile
+ * browser it is not really a valid content.
  */
-function wfInstallExceptionHandler() {
-       set_exception_handler( 'wfExceptionHandler' );
+class BadTitleError extends ErrorPageError {
+
+       /**
+        * @param $msg string A message key (default: 'badtitletext')
+        * @param $params Array parameter to wfMsg()
+        */
+       function __construct( $msg = 'badtitletext', $params = null ) {
+               parent::__construct( 'badtitle', $msg, $params );
+       }
+
+       /**
+        * Just like ErrorPageError::report() but additionally set
+        * a 400 HTTP status code (bug 33646).
+        */
+       function report() {
+               global $wgOut;
+
+               // bug 33646: a badtitle error page need to return an error code
+               // to let mobile browser now that it is not a normal page.
+               $wgOut->setStatusCode( 400 );
+               parent::report();
+       }
+
 }
 
 /**
- * Report an exception to the user
+ * Show an error when a user tries to do something they do not have the necessary
+ * permissions for.
+ * @ingroup Exception
  */
-function wfReportException( Exception $e ) {
-       global $wgShowExceptionDetails;
+class PermissionsError extends ErrorPageError {
+       public $permission, $errors;
 
-       $cmdLine = MWException::isCommandLine();
-
-       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";
+       function __construct( $permission, $errors = array() ) {
+               global $wgLang;
 
-                       if ( $wgShowExceptionDetails ) {
-                               $message .= 'Original exception: ' . $e->__toString() . "\n\n" .
-                                       'Exception caught inside exception handler: ' . $e2->__toString();
-                       } else {
-                               $message .= "Exception caught inside exception handler.\n\n" .
-                                       "Set \$wgShowExceptionDetails = true; at the bottom of LocalSettings.php " .
-                                       "to show detailed debugging information.";
-                       }
+               $this->permission = $permission;
 
-                       $message .= "\n";
+               if ( !count( $errors ) ) {
+                       $groups = array_map(
+                               array( 'User', 'makeGroupLinkWiki' ),
+                               User::getGroupsWithPermission( $this->permission )
+                       );
 
-                       if ( $cmdLine ) {
-                               wfPrintError( $message );
+                       if ( $groups ) {
+                               $errors[] = array( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
                        } else {
-                               echo nl2br( htmlspecialchars( $message ) ) . "\n";
+                               $errors[] = array( 'badaccess-group0' );
                        }
                }
-       } else {
-               $message = "Unexpected non-MediaWiki exception encountered, of type \"" . get_class( $e ) . "\"\n" .
-                       $e->__toString() . "\n";
 
-               if ( $wgShowExceptionDetails ) {
-                       $message .= "\n" . $e->getTraceAsString() . "\n";
+               $this->errors = $errors;
+       }
+
+       function report() {
+               global $wgOut;
+
+               $wgOut->showPermissionsErrorPage( $this->errors, $this->permission );
+               $wgOut->output();
+       }
+}
+
+/**
+ * Show an error when the wiki is locked/read-only and the user tries to do
+ * something that requires write access
+ * @ingroup Exception
+ */
+class ReadOnlyError extends ErrorPageError {
+       public function __construct(){
+               parent::__construct(
+                       'readonly',
+                       'readonlytext',
+                       wfReadOnlyReason()
+               );
+       }
+}
+
+/**
+ * Show an error when the user hits a rate limit
+ * @ingroup Exception
+ */
+class ThrottledError extends ErrorPageError {
+       public function __construct(){
+               parent::__construct(
+                       'actionthrottled',
+                       'actionthrottledtext'
+               );
+       }
+
+       public function report(){
+               global $wgOut;
+               $wgOut->setStatusCode( 503 );
+               return parent::report();
+       }
+}
+
+/**
+ * Show an error when the user tries to do something whilst blocked
+ * @ingroup Exception
+ */
+class UserBlockedError extends ErrorPageError {
+       public function __construct( Block $block ){
+               global $wgLang, $wgRequest;
+
+               $blocker = $block->getBlocker();
+               if ( $blocker instanceof User ) { // local user
+                       $blockerUserpage = $block->getBlocker()->getUserPage();
+                       $link = "[[{$blockerUserpage->getPrefixedText()}|{$blockerUserpage->getText()}]]";
+               } else { // foreign user
+                       $link = $blocker;
                }
 
-               if ( $cmdLine ) {
-                       wfPrintError( $message );
-               } else {
-                       echo nl2br( htmlspecialchars( $message ) ) . "\n";
+               $reason = $block->mReason;
+               if( $reason == '' ) {
+                       $reason = wfMsg( 'blockednoreason' );
                }
+
+               /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked.
+                * This could be a username, an IP range, or a single IP. */
+               $intended = $block->getTarget();
+
+               parent::__construct(
+                       'blockedtitle',
+                       $block->mAuto ? 'autoblockedtext' : 'blockedtext',
+                       array(
+                               $link,
+                               $reason,
+                               $wgRequest->getIP(),
+                               $block->getByName(),
+                               $block->getId(),
+                               $wgLang->formatExpiry( $block->mExpiry ),
+                               $intended,
+                               $wgLang->timeanddate( wfTimestamp( TS_MW, $block->mTimestamp ), true )
+                       )
+               );
        }
 }
 
 /**
- * Print a message, if possible to STDERR.
- * Use this in command line mode only (see isCommandLine)
+ * Show an error that looks like an HTTP server error.
+ * Replacement for wfHttpError().
+ *
+ * @ingroup Exception
  */
-function wfPrintError( $message ) {
-       # NOTE: STDERR may not be available, especially if php-cgi is used from the command line (bug #15602).
-       #      Try to produce meaningful output anyway. Using echo may corrupt output to STDOUT though.
-       if ( defined( 'STDERR' ) ) {
-               fwrite( STDERR, $message );
-       } else {
-               echo( $message );
+class HttpError extends MWException {
+       private $httpCode, $header, $content;
+
+       /**
+        * Constructor
+        *
+        * @param $httpCode Integer: HTTP status code to send to the client
+        * @param $content String|Message: content of the message
+        * @param $header String|Message: content of the header (\<title\> and \<h1\>)
+        */
+       public function __construct( $httpCode, $content, $header = null ){
+               parent::__construct( $content );
+               $this->httpCode = (int)$httpCode;
+               $this->header = $header;
+               $this->content = $content;
+       }
+
+       public function reportHTML() {
+               $httpMessage = HttpStatus::getMessage( $this->httpCode );
+
+               header( "Status: {$this->httpCode} {$httpMessage}" );
+               header( 'Content-type: text/html; charset=utf-8' );
+
+               if ( $this->header === null ) {
+                       $header = $httpMessage;
+               } elseif ( $this->header instanceof Message ) {
+                       $header = $this->header->escaped();
+               } else {
+                       $header = htmlspecialchars( $this->header );
+               }
+
+               if ( $this->content instanceof Message ) {
+                       $content = $this->content->escaped();
+               } else {
+                       $content = htmlspecialchars( $this->content );
+               }
+
+               print "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">\n".
+                       "<html><head><title>$header</title></head>\n" .
+                       "<body><h1>$header</h1><p>$content</p></body></html>\n";
        }
 }
 
 /**
- * Exception handler which simulates the appropriate catch() handling:
- *
- *   try {
- *       ...
- *   } catch ( MWException $e ) {
- *       $e->report();
- *   } catch ( Exception $e ) {
- *       echo $e->__toString();
- *   }
+ * Handler class for MWExceptions
+ * @ingroup Exception
  */
-function wfExceptionHandler( $e ) {
-       global $wgFullyInitialised;
+class MWExceptionHandler {
+       /**
+        * Install an exception handler for MediaWiki exception types.
+        */
+       public static function installHandler() {
+               set_exception_handler( array( 'MWExceptionHandler', 'handle' ) );
+       }
 
-       wfReportException( $e );
+       /**
+        * Report an exception to the user
+        */
+       protected static function report( Exception $e ) {
+               global $wgShowExceptionDetails;
 
-       // Final cleanup
-       if ( $wgFullyInitialised ) {
-               try {
-                       wfLogProfilingData(); // uses $wgRequest, hence the $wgFullyInitialised condition
-               } catch ( Exception $e ) {}
+               $cmdLine = MWException::isCommandLine();
+
+               if ( $e instanceof MWException ) {
+                       try {
+                               // Try and show the exception prettily, with the normal skin infrastructure
+                               $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";
+
+                               if ( $wgShowExceptionDetails ) {
+                                       $message .= 'Original exception: ' . $e->__toString() . "\n\n" .
+                                               'Exception caught inside exception handler: ' . $e2->__toString();
+                               } else {
+                                       $message .= "Exception caught inside exception handler.\n\n" .
+                                               "Set \$wgShowExceptionDetails = true; at the bottom of LocalSettings.php " .
+                                               "to show detailed debugging information.";
+                               }
+
+                               $message .= "\n";
+
+                               if ( $cmdLine ) {
+                                       self::printError( $message );
+                               } else {
+                                       self::escapeEchoAndDie( $message );
+                               }
+                       }
+               } else {
+                       $message = "Unexpected non-MediaWiki exception encountered, of type \"" . get_class( $e ) . "\"\n" .
+                               $e->__toString() . "\n";
+
+                       if ( $wgShowExceptionDetails ) {
+                               $message .= "\n" . $e->getTraceAsString() . "\n";
+                       }
+
+                       if ( $cmdLine ) {
+                               self::printError( $message );
+                       } else {
+                               self::escapeEchoAndDie( $message );
+                       }
+               }
        }
 
-       // Exit value should be nonzero for the benefit of shell jobs
-       exit( 1 );
+       /**
+        * Print a message, if possible to STDERR.
+        * Use this in command line mode only (see isCommandLine)
+        * @param $message String Failure text
+        */
+       public static function printError( $message ) {
+               # NOTE: STDERR may not be available, especially if php-cgi is used from the command line (bug #15602).
+               #      Try to produce meaningful output anyway. Using echo may corrupt output to STDOUT though.
+               if ( defined( 'STDERR' ) ) {
+                       fwrite( STDERR, $message );
+               } else {
+                       echo( $message );
+               }
+       }
+
+       /**
+        * Print a message after escaping it and converting newlines to <br>
+        * Use this for non-command line failures
+        * @param $message String Failure text
+        */
+       private static function escapeEchoAndDie( $message ) {
+               echo nl2br( htmlspecialchars( $message ) ) . "\n";
+               die(1);
+       }
+
+       /**
+        * Exception handler which simulates the appropriate catch() handling:
+        *
+        *   try {
+        *       ...
+        *   } catch ( MWException $e ) {
+        *       $e->report();
+        *   } catch ( Exception $e ) {
+        *       echo $e->__toString();
+        *   }
+        */
+       public static function handle( $e ) {
+               global $wgFullyInitialised;
+
+               self::report( $e );
+
+               // Final cleanup
+               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 );
+       }
 }