MediaWiki REL1_28
MWException.php
Go to the documentation of this file.
1<?php
26class MWException extends Exception {
32 public function useOutputPage() {
33 return $this->useMessageCache() &&
34 !empty( $GLOBALS['wgFullyInitialised'] ) &&
35 !empty( $GLOBALS['wgOut'] ) &&
36 !defined( 'MEDIAWIKI_INSTALL' );
37 }
38
45 public function isLoggable() {
46 return true;
47 }
48
54 public function useMessageCache() {
55 global $wgLang;
56
57 foreach ( $this->getTrace() as $frame ) {
58 if ( isset( $frame['class'] ) && $frame['class'] === 'LocalisationCache' ) {
59 return false;
60 }
61 }
62
63 return $wgLang instanceof Language;
64 }
65
73 public function runHooks( $name, $args = [] ) {
74 return MWExceptionRenderer::runHooks( $this, $name, $args );
75 }
76
86 public function msg( $key, $fallback /*[, params...] */ ) {
87 $args = array_slice( func_get_args(), 2 );
88
89 if ( $this->useMessageCache() ) {
90 try {
91 return wfMessage( $key, $args )->text();
92 } catch ( Exception $e ) {
93 }
94 }
95 return wfMsgReplaceArgs( $fallback, $args );
96 }
97
105 public function getHTML() {
106 global $wgShowExceptionDetails;
107
108 if ( $wgShowExceptionDetails ) {
109 return '<p>' . nl2br( htmlspecialchars( MWExceptionHandler::getLogMessage( $this ) ) ) .
110 '</p><p>Backtrace:</p><p>' .
111 nl2br( htmlspecialchars( MWExceptionHandler::getRedactedTraceAsString( $this ) ) ) .
112 "</p>\n";
113 } else {
114 $logId = WebRequest::getRequestId();
115 $type = get_class( $this );
116 return "<div class=\"errorbox\">" .
117 htmlspecialchars(
118 '[' . $logId . '] ' .
119 gmdate( 'Y-m-d H:i:s' ) . ": " .
120 $this->msg( "internalerror-fatal-exception",
121 "Fatal exception of type $1",
122 $type,
123 $logId,
124 MWExceptionHandler::getURL( $this )
125 )
126 ) . "</div>\n" .
127 "<!-- Set \$wgShowExceptionDetails = true; " .
128 "at the bottom of LocalSettings.php to show detailed " .
129 "debugging information. -->";
130 }
131 }
132
140 public function getText() {
141 global $wgShowExceptionDetails;
142
143 if ( $wgShowExceptionDetails ) {
144 return MWExceptionHandler::getLogMessage( $this ) .
145 "\nBacktrace:\n" . MWExceptionHandler::getRedactedTraceAsString( $this ) . "\n";
146 } else {
147 return "Set \$wgShowExceptionDetails = true; " .
148 "in LocalSettings.php to show detailed debugging information.\n";
149 }
150 }
151
157 public function getPageTitle() {
158 return $this->msg( 'internalerror', 'Internal error' );
159 }
160
164 public function reportHTML() {
165 global $wgOut, $wgSitename;
166 if ( $this->useOutputPage() ) {
167 $wgOut->prepareErrorPage( $this->getPageTitle() );
168
169 $hookResult = $this->runHooks( get_class( $this ) );
170 if ( $hookResult ) {
171 $wgOut->addHTML( $hookResult );
172 } else {
173 $wgOut->addHTML( $this->getHTML() );
174 }
175
176 $wgOut->output();
177 } else {
178 self::header( 'Content-Type: text/html; charset=utf-8' );
179 echo "<!DOCTYPE html>\n" .
180 '<html><head>' .
181 // Mimick OutputPage::setPageTitle behaviour
182 '<title>' .
183 htmlspecialchars( $this->msg( 'pagetitle', "$1 - $wgSitename", $this->getPageTitle() ) ) .
184 '</title>' .
185 '<style>body { font-family: sans-serif; margin: 0; padding: 0.5em 2em; }</style>' .
186 "</head><body>\n";
187
188 $hookResult = $this->runHooks( get_class( $this ) . 'Raw' );
189 if ( $hookResult ) {
190 echo $hookResult;
191 } else {
192 echo $this->getHTML();
193 }
194
195 echo "</body></html>\n";
196 }
197 }
198
203 public function report() {
204 global $wgMimeType;
205
206 if ( defined( 'MW_API' ) ) {
207 // Unhandled API exception, we can't be sure that format printer is alive
208 self::header( 'MediaWiki-API-Error: internal_api_error_' . get_class( $this ) );
209 wfHttpError( 500, 'Internal Server Error', $this->getText() );
210 } elseif ( self::isCommandLine() ) {
211 $message = $this->getText();
212 // T17602: STDERR may not be available
213 if ( defined( 'STDERR' ) ) {
214 fwrite( STDERR, $message );
215 } else {
216 echo $message;
217 }
218 } else {
219 self::statusHeader( 500 );
220 self::header( "Content-Type: $wgMimeType; charset=utf-8" );
221
222 $this->reportHTML();
223 }
224 }
225
232 public static function isCommandLine() {
233 return !empty( $GLOBALS['wgCommandLineMode'] );
234 }
235
241 private static function header( $header ) {
242 if ( !headers_sent() ) {
243 header( $header );
244 }
245 }
246 private static function statusHeader( $code ) {
247 if ( !headers_sent() ) {
248 HttpStatus::header( $code );
249 }
250 }
251}
$GLOBALS
$GLOBALS['IP']
Definition ComposerHookHandler.php:6
$wgMimeType
$wgMimeType
The default Content-Type header.
Definition DefaultSettings.php:3147
$wgSitename
$wgSitename
Name of the site.
Definition DefaultSettings.php:83
$wgShowExceptionDetails
$wgShowExceptionDetails
If set to true, uncaught exceptions will print a complete stack trace to output.
Definition DefaultSettings.php:6134
wfHttpError
wfHttpError( $code, $label, $desc)
Provide a simple HTTP error.
Definition GlobalFunctions.php:1776
wfMsgReplaceArgs
wfMsgReplaceArgs( $message, $args)
Replace message parameter keys on the given formatted output.
Definition GlobalFunctions.php:1421
$fallback
$fallback
Definition MessagesAb.php:11
$wgOut
$wgOut
Definition Setup.php:816
$args
if( $line===false) $args
Definition cdb.php:64
HttpStatus\header
static header( $code)
Output an HTTP status code header.
Definition HttpStatus.php:96
Language
Internationalisation code.
Definition Language.php:35
MWExceptionRenderer\runHooks
static runHooks( $e, $name, $args=[])
Run hook to allow extensions to modify the text of the exception.
Definition MWExceptionRenderer.php:94
MWException
MediaWiki exception.
Definition MWException.php:26
MWException\statusHeader
static statusHeader( $code)
Definition MWException.php:246
MWException\isLoggable
isLoggable()
Whether to log this exception in the exception debug log.
Definition MWException.php:45
MWException\useMessageCache
useMessageCache()
Can the extension use the Message class/wfMessage to get i18n-ed messages?
Definition MWException.php:54
MWException\header
static header( $header)
Send a header, if we haven't already sent them.
Definition MWException.php:241
MWException\getHTML
getHTML()
If $wgShowExceptionDetails is true, return a HTML message with a backtrace to the error,...
Definition MWException.php:105
MWException\isCommandLine
static isCommandLine()
Check whether we are in command line mode or not to report the exception in the correct format.
Definition MWException.php:232
MWException\useOutputPage
useOutputPage()
Should the exception use $wgOut to output the error?
Definition MWException.php:32
MWException\report
report()
Output a report about the exception and takes care of formatting.
Definition MWException.php:203
MWException\getPageTitle
getPageTitle()
Return the title of the page when reporting this error in a HTTP response.
Definition MWException.php:157
MWException\reportHTML
reportHTML()
Output the exception report using HTML.
Definition MWException.php:164
MWException\runHooks
runHooks( $name, $args=[])
Run hook to allow extensions to modify the text of the exception.
Definition MWException.php:73
MWException\getText
getText()
Get the text to display when reporting the error on the command line.
Definition MWException.php:140
MWException\msg
msg( $key, $fallback)
Get a message from i18n.
Definition MWException.php:86
global
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
$wgLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
Definition design.txt:56
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition distributors.txt:22
$type
namespace are movable Hooks may change this value to override the return value of MWNamespace::isMovable(). 'NewDifferenceEngine' do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition hooks.txt:2568
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
$name
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:304
$e
returning false will NOT prevent logging $e
Definition hooks.txt:2110
$code
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition hooks.txt:887
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
$header
$header
Definition updateCredits.php:37