X-Git-Url: http://git.cyclocoop.org/?a=blobdiff_plain;f=includes%2FException.php;h=8cce9a0e56c277fedf5ddce9bd0b278ea9519f5b;hb=b7c7bd3c955a5e8f9c613d777222ed197f0c3c7a;hp=7b7254ffd01fdaeebfdfb722b7b5119ce43cbc21;hpb=79d5225c0e864482269e2315f47b899697681e52;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/Exception.php b/includes/Exception.php index 7b7254ffd0..8cce9a0e56 100644 --- a/includes/Exception.php +++ b/includes/Exception.php @@ -1,18 +1,29 @@ useMessageCache() && + !empty( $GLOBALS['wgFullyInitialised'] ) && + !empty( $GLOBALS['wgOut'] ) && + !empty( $GLOBALS['wgTitle'] ); } /** @@ -21,32 +32,45 @@ class MWException extends Exception { */ function useMessageCache() { global $wgLang; - return is_object( $wgLang ); + + foreach ( $this->getTrace() as $frame ) { + if ( isset( $frame['class'] ) && $frame['class'] === 'LocalisationCache' ) { + return false; + } + } + + return $wgLang instanceof Language; } /** * 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 + * @param $name String: class name of the exception + * @param $args Array: 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 ) ) + + if ( !isset( $wgExceptionHooks ) || !is_array( $wgExceptionHooks ) ) { return; // Just silently ignore - if( !array_key_exists( $name, $wgExceptionHooks ) || !is_array( $wgExceptionHooks[ $name ] ) ) + } + + 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' ) + 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 ) ) + + if ( is_string( $result ) ) return $result; } } @@ -54,16 +78,17 @@ class MWException extends Exception { /** * 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 + * @param $key String: message name + * @param $fallback String: 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 ); + return wfMsgNoTrans( $key, $args ); } else { return wfMsgReplaceArgs( $fallback, $args ); } @@ -78,8 +103,9 @@ class MWException extends Exception { */ function getHTML() { global $wgShowExceptionDetails; - if( $wgShowExceptionDetails ) { - return '

' . htmlspecialchars( $this->getMessage() ) . + + if ( $wgShowExceptionDetails ) { + return '

' . nl2br( htmlspecialchars( $this->getMessage() ) ) . '

Backtrace:

' . nl2br( htmlspecialchars( $this->getTraceAsString() ) ) . "

\n"; } else { @@ -95,37 +121,45 @@ class MWException extends Exception { */ function getText() { global $wgShowExceptionDetails; - if( $wgShowExceptionDetails ) { + + if ( $wgShowExceptionDetails ) { return $this->getMessage() . "\nBacktrace:\n" . $this->getTraceAsString() . "\n"; } else { - return "

Set \$wgShowExceptionDetails = true; " . - "in LocalSettings.php to show detailed debugging information.

"; + 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"; - } + global $wgSitename; + return $this->msg( 'internalerror', "$wgSitename error" ); } /** * Return the requested URL and point to file and line number from which the * exception occured * - * @return string + * @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"; + + if ( isset( $wgRequest ) ) { + $url = $wgRequest->getRequestURL(); + if ( !$url ) { + $url = '[no URL]'; + } + } else { + $url = '[no req]'; + } + + return "$url Exception from line $line of $file: $message"; } /** Output the exception report using HTML */ @@ -133,80 +167,58 @@ class MWException extends Exception { global $wgOut; if ( $this->useOutputPage() ) { $wgOut->setPageTitle( $this->getPageTitle() ); - $wgOut->setRobotpolicy( "noindex,nofollow" ); + $wgOut->setRobotPolicy( "noindex,nofollow" ); $wgOut->setArticleRelated( false ); $wgOut->enableClientCache( false ); $wgOut->redirect( '' ); $wgOut->clearHTML(); - if( $hookResult = $this->runHooks( get_class( $this ) ) ) { + + $hookResult = $this->runHooks( get_class( $this ) ); + if ( $hookResult ) { $wgOut->addHTML( $hookResult ); } else { $wgOut->addHTML( $this->getHTML() ); } + $wgOut->output(); } else { - if( $hookResult = $this->runHooks( get_class( $this ) . "Raw" ) ) { + $hookResult = $this->runHooks( get_class( $this ) . "Raw" ); + if ( $hookResult ) { die( $hookResult ); } - echo $this->htmlHeader(); + echo $this->getHTML(); - echo $this->htmlFooter(); + die(1); } } /** * Output a report about the exception and takes care of formatting. - * It will be either HTML or plain text based on $wgCommandLineMode. + * It will be either HTML or plain text based on isCommandLine(). */ function report() { - global $wgCommandLineMode; - if ( $wgCommandLineMode ) { - fwrite( STDERR, $this->getText() ); - } else { - $log = $this->getLogMessage(); - if ( $log ) { - wfDebugLog( 'exception', $log ); - } - $this->reportHTML(); + $log = $this->getLogMessage(); + + if ( $log ) { + wfDebugLog( 'exception', $log ); } - } - /** - * 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' ); + if ( self::isCommandLine() ) { + MWExceptionHandler::printError( $this->getText() ); + } else { + $this->reportHTML(); } - $title = $this->getPageTitle(); - echo " - - $title - - -

$title

- "; } - /** - * print the end of the html page if not using $wgOut. - */ - function htmlFooter() { - echo ""; + static function isCommandLine() { + return !empty( $GLOBALS['wgCommandLineMode'] ); } } /** * Exception class which takes an HTML error message, and does not * produce a backtrace. Replacement for OutputPage::fatalError(). - * @addtogroup Exception + * @ingroup Exception */ class FatalError extends MWException { function getHTML() { @@ -219,83 +231,270 @@ class FatalError extends MWException { } /** - * @addtogroup Exception + * 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 ); + + if ( $wgOut->getTitle() ) { + $wgOut->debug( 'Original title: ' . $wgOut->getTitle()->getPrefixedText() . "\n" ); + } + $wgOut->setPageTitle( wfMsg( $this->title ) ); + $wgOut->setHTMLTitle( wfMsg( 'errorpagetitle' ) ); + $wgOut->setRobotPolicy( 'noindex,nofollow' ); + $wgOut->setArticleRelated( false ); + $wgOut->enableClientCache( false ); + $wgOut->mRedirect = ''; + $wgOut->clearHTML(); + + if( $this->msg instanceof Message ){ + $wgOut->addHTML( $this->msg->parse() ); + } else { + $wgOut->addWikiMsgArray( $this->msg, $this->params ); + } + + $wgOut->returnToMain(); $wgOut->output(); } } /** - * Install an exception handler for MediaWiki exception types. + * Show an error when a user tries to do something they do not have the necessary + * permissions for. + * @ingroup Exception */ -function wfInstallExceptionHandler() { - set_exception_handler( 'wfExceptionHandler' ); +class PermissionsError extends ErrorPageError { + public $permission; + + function __construct( $permission ) { + global $wgLang; + + $this->permission = $permission; + + $groups = array_map( + array( 'User', 'makeGroupLinkWiki' ), + User::getGroupsWithPermission( $this->permission ) + ); + + if( $groups ) { + parent::__construct( + 'badaccess', + 'badaccess-groups', + array( + $wgLang->commaList( $groups ), + count( $groups ) + ) + ); + } else { + parent::__construct( + 'badaccess', + 'badaccess-group0' + ); + } + } } /** - * Report an exception to the user + * Show an error when the wiki is locked/read-only and the user tries to do + * something that requires write access + * @ingroup Exception */ -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(); - } +class ReadOnlyError extends ErrorPageError { + public function __construct(){ + parent::__construct( + 'readonly', + 'readonlytext', + wfReadOnlyReason() + ); + } } /** - * Exception handler which simulates the appropriate catch() handling: - * - * try { - * ... - * } catch ( MWException $e ) { - * $e->report(); - * } catch ( Exception $e ) { - * echo $e->__toString(); - * } + * 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; + + $blockerUserpage = $block->getBlocker()->getUserPage(); + $link = "[[{$blockerUserpage->getPrefixedText()}|{$blockerUserpage->getText()}]]"; + + $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 ? 'autoblocketext' : 'blockedtext', + array( + $link, + $reason, + wfGetIP(), + $block->getBlocker()->getName(), + $block->getId(), + $wgLang->formatExpiry( $block->mExpiry ), + $intended, + $wgLang->timeanddate( wfTimestamp( TS_MW, $block->mTimestamp ), true ) + ) + ); + } +} + +/** + * Handler class for MWExceptions + * @ingroup Exception */ -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 ) {} +class MWExceptionHandler { + /** + * Install an exception handler for MediaWiki exception types. + */ + public static function installHandler() { + set_exception_handler( array( 'MWExceptionHandler', 'handle' ) ); } - // Exit value should be nonzero for the benefit of shell jobs - exit( 1 ); + /** + * Report an exception to the user + */ + protected static function report( Exception $e ) { + global $wgShowExceptionDetails; + + $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 ); + } + } + } + + /** + * 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
+ * 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 ); + } }