MediaWiki  1.28.0
MWExceptionRenderer.php
Go to the documentation of this file.
1 <?php
27  const AS_RAW = 1; // show as text
28  const AS_PRETTY = 2; // show as HTML
29 
35  public static function output( $e, $mode, $eNew = null ) {
37 
38  if ( defined( 'MW_API' ) ) {
39  // Unhandled API exception, we can't be sure that format printer is alive
40  self::header( 'MediaWiki-API-Error: internal_api_error_' . get_class( $e ) );
41  wfHttpError( 500, 'Internal Server Error', self::getText( $e ) );
42  } elseif ( self::isCommandLine() ) {
43  self::printError( self::getText( $e ) );
44  } elseif ( $mode === self::AS_PRETTY ) {
45  if ( $e instanceof DBConnectionError ) {
46  self::reportOutageHTML( $e );
47  } else {
48  self::statusHeader( 500 );
49  self::header( "Content-Type: $wgMimeType; charset=utf-8" );
50  self::reportHTML( $e );
51  }
52  } else {
53  if ( $eNew ) {
54  $message = "MediaWiki internal error.\n\n";
55  if ( self::showBackTrace( $e ) ) {
56  $message .= 'Original exception: ' .
58  "\nBacktrace:\n" . MWExceptionHandler::getRedactedTraceAsString( $e ) .
59  "\n\nException caught inside exception handler: " .
61  "\nBacktrace:\n" . MWExceptionHandler::getRedactedTraceAsString( $eNew );
62  } else {
63  $message .= "Exception caught inside exception handler.\n\n" .
64  self::getShowBacktraceError( $e );
65  }
66  $message .= "\n";
67  } else {
68  if ( self::showBackTrace( $e ) ) {
70  "\nBacktrace:\n" .
72  } else {
74  }
75  }
76  if ( self::isCommandLine() ) {
77  self::printError( $message );
78  } else {
79  echo nl2br( htmlspecialchars( $message ) ) . "\n";
80  }
81  }
82  }
83 
94  public static function runHooks( $e, $name, $args = [] ) {
95  global $wgExceptionHooks;
96 
97  if ( !isset( $wgExceptionHooks ) || !is_array( $wgExceptionHooks ) ) {
98  return null; // Just silently ignore
99  }
100 
101  if ( !array_key_exists( $name, $wgExceptionHooks ) ||
102  !is_array( $wgExceptionHooks[$name] )
103  ) {
104  return null;
105  }
106 
107  $hooks = $wgExceptionHooks[$name];
108  $callargs = array_merge( [ $e ], $args );
109 
110  foreach ( $hooks as $hook ) {
111  if (
112  is_string( $hook ) ||
113  ( is_array( $hook ) && count( $hook ) >= 2 && is_string( $hook[0] ) )
114  ) {
115  // 'function' or [ 'class', 'hook' ]
116  $result = call_user_func_array( $hook, $callargs );
117  } else {
118  $result = null;
119  }
120 
121  if ( is_string( $result ) ) {
122  return $result;
123  }
124  }
125 
126  return null;
127  }
128 
133  private static function useOutputPage( $e ) {
134  // Can the extension use the Message class/wfMessage to get i18n-ed messages?
135  foreach ( $e->getTrace() as $frame ) {
136  if ( isset( $frame['class'] ) && $frame['class'] === 'LocalisationCache' ) {
137  return false;
138  }
139  }
140 
141  return (
142  !empty( $GLOBALS['wgFullyInitialised'] ) &&
143  !empty( $GLOBALS['wgOut'] ) &&
144  !defined( 'MEDIAWIKI_INSTALL' )
145  );
146  }
147 
153  private static function reportHTML( $e ) {
155 
156  if ( self::useOutputPage( $e ) ) {
157  if ( $e instanceof MWException ) {
158  $wgOut->prepareErrorPage( $e->getPageTitle() );
159  } elseif ( $e instanceof DBReadOnlyError ) {
160  $wgOut->prepareErrorPage( self::msg( 'readonly', 'Database is locked' ) );
161  } elseif ( $e instanceof DBExpectedError ) {
162  $wgOut->prepareErrorPage( self::msg( 'databaseerror', 'Database error' ) );
163  } else {
164  $wgOut->prepareErrorPage( self::msg( 'internalerror', 'Internal error' ) );
165  }
166 
167  $hookResult = self::runHooks( $e, get_class( $e ) );
168  if ( $hookResult ) {
169  $wgOut->addHTML( $hookResult );
170  } else {
171  // Show any custom GUI message before the details
172  if ( $e instanceof MessageSpecifier ) {
173  $wgOut->addHTML( Message::newFromSpecifier( $e )->escaped() );
174  }
175  $wgOut->addHTML( self::getHTML( $e ) );
176  }
177 
178  $wgOut->output();
179  } else {
180  self::header( 'Content-Type: text/html; charset=utf-8' );
181  $pageTitle = self::msg( 'internalerror', 'Internal error' );
182  echo "<!DOCTYPE html>\n" .
183  '<html><head>' .
184  // Mimick OutputPage::setPageTitle behaviour
185  '<title>' .
186  htmlspecialchars( self::msg( 'pagetitle', "$1 - $wgSitename", $pageTitle ) ) .
187  '</title>' .
188  '<style>body { font-family: sans-serif; margin: 0; padding: 0.5em 2em; }</style>' .
189  "</head><body>\n";
190 
191  $hookResult = self::runHooks( $e, get_class( $e ) . 'Raw' );
192  if ( $hookResult ) {
193  echo $hookResult;
194  } else {
195  echo self::getHTML( $e );
196  }
197 
198  echo "</body></html>\n";
199  }
200  }
201 
210  public static function getHTML( $e ) {
211  if ( self::showBackTrace( $e ) ) {
212  $html = "<div class=\"errorbox\"><p>" .
213  nl2br( htmlspecialchars( MWExceptionHandler::getLogMessage( $e ) ) ) .
214  '</p><p>Backtrace:</p><p>' .
215  nl2br( htmlspecialchars( MWExceptionHandler::getRedactedTraceAsString( $e ) ) ) .
216  "</p></div>\n";
217  } else {
218  $logId = WebRequest::getRequestId();
219  $html = "<div class=\"errorbox\">" .
220  '[' . $logId . '] ' .
221  gmdate( 'Y-m-d H:i:s' ) . ": " .
222  self::msg( "internalerror-fatal-exception",
223  "Fatal exception of type $1",
224  get_class( $e ),
225  $logId,
227  ) . "</div>\n" .
228  "<!-- " . wordwrap( self::getShowBacktraceError( $e ), 50 ) . " -->";
229  }
230 
231  return $html;
232  }
233 
243  private static function msg( $key, $fallback /*[, params...] */ ) {
244  $args = array_slice( func_get_args(), 2 );
245  try {
246  return wfMessage( $key, $args )->text();
247  } catch ( Exception $e ) {
248  return wfMsgReplaceArgs( $fallback, $args );
249  }
250  }
251 
256  private static function getText( $e ) {
257  if ( self::showBackTrace( $e ) ) {
259  "\nBacktrace:\n" .
261  } else {
262  return self::getShowBacktraceError( $e );
263  }
264  }
265 
270  private static function showBackTrace( $e ) {
271  global $wgShowExceptionDetails, $wgShowDBErrorBacktrace;
272 
273  return (
274  $wgShowExceptionDetails &&
275  ( !( $e instanceof DBError ) || $wgShowDBErrorBacktrace )
276  );
277  }
278 
283  private static function getShowBacktraceError( $e ) {
284  global $wgShowExceptionDetails, $wgShowDBErrorBacktrace;
285  $vars = [];
286  if ( !$wgShowExceptionDetails ) {
287  $vars[] = '$wgShowExceptionDetails = true;';
288  }
289  if ( $e instanceof DBError && !$wgShowDBErrorBacktrace ) {
290  $vars[] = '$wgShowDBErrorBacktrace = true;';
291  }
292  $vars = implode( ' and ', $vars );
293  return "Set $vars at the bottom of LocalSettings.php to show detailed debugging information";
294  }
295 
299  private static function isCommandLine() {
300  return !empty( $GLOBALS['wgCommandLineMode'] );
301  }
302 
306  private static function header( $header ) {
307  if ( !headers_sent() ) {
308  header( $header );
309  }
310  }
311 
315  private static function statusHeader( $code ) {
316  if ( !headers_sent() ) {
318  }
319  }
320 
327  private static function printError( $message ) {
328  // NOTE: STDERR may not be available, especially if php-cgi is used from the
329  // command line (bug #15602). Try to produce meaningful output anyway. Using
330  // echo may corrupt output to STDOUT though.
331  if ( defined( 'STDERR' ) ) {
332  fwrite( STDERR, $message );
333  } else {
334  echo $message;
335  }
336  }
337 
341  private static function reportOutageHTML( $e ) {
342  global $wgShowDBErrorBacktrace, $wgShowHostnames, $wgShowSQLErrors;
343 
344  $sorry = htmlspecialchars( self::msg(
345  'dberr-problems',
346  'Sorry! This site is experiencing technical difficulties.'
347  ) );
348  $again = htmlspecialchars( self::msg(
349  'dberr-again',
350  'Try waiting a few minutes and reloading.'
351  ) );
352 
353  if ( $wgShowHostnames || $wgShowSQLErrors ) {
354  $info = str_replace(
355  '$1',
356  Html::element( 'span', [ 'dir' => 'ltr' ], htmlspecialchars( $e->getMessage() ) ),
357  htmlspecialchars( self::msg( 'dberr-info', '($1)' ) )
358  );
359  } else {
360  $info = htmlspecialchars( self::msg(
361  'dberr-info-hidden',
362  '(Cannot access the database)'
363  ) );
364  }
365 
366  MessageCache::singleton()->disable(); // no DB access
367 
368  $html = "<h1>$sorry</h1><p>$again</p><p><small>$info</small></p>";
369 
370  if ( $wgShowDBErrorBacktrace ) {
371  $html .= '<p>Backtrace:</p><pre>' .
372  htmlspecialchars( $e->getTraceAsString() ) . '</pre>';
373  }
374 
375  $html .= '<hr />';
376  $html .= self::googleSearchForm();
377 
378  echo $html;
379  }
380 
384  private static function googleSearchForm() {
386 
387  $usegoogle = htmlspecialchars( self::msg(
388  'dberr-usegoogle',
389  'You can try searching via Google in the meantime.'
390  ) );
391  $outofdate = htmlspecialchars( self::msg(
392  'dberr-outofdate',
393  'Note that their indexes of our content may be out of date.'
394  ) );
395  $googlesearch = htmlspecialchars( self::msg( 'searchbutton', 'Search' ) );
396  $search = htmlspecialchars( $wgRequest->getVal( 'search' ) );
397  $server = htmlspecialchars( $wgCanonicalServer );
398  $sitename = htmlspecialchars( $wgSitename );
399  $trygoogle = <<<EOT
400 <div style="margin: 1.5em">$usegoogle<br />
401 <small>$outofdate</small>
402 </div>
403 <form method="get" action="//www.google.com/search" id="googlesearch">
404  <input type="hidden" name="domains" value="$server" />
405  <input type="hidden" name="num" value="50" />
406  <input type="hidden" name="ie" value="UTF-8" />
407  <input type="hidden" name="oe" value="UTF-8" />
408  <input type="text" name="q" size="31" maxlength="255" value="$search" />
409  <input type="submit" name="btnG" value="$googlesearch" />
410  <p>
411  <label><input type="radio" name="sitesearch" value="$server" checked="checked" />$sitename</label>
412  <label><input type="radio" name="sitesearch" value="" />WWW</label>
413  </p>
414 </form>
415 EOT;
416  return $trygoogle;
417  }
418 }
null means default in associative array form
Definition: hooks.txt:1936
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:1936
Database error base class.
Definition: DBError.php:26
static getRequestId()
Get the unique request ID.
Definition: WebRequest.php:272
static getLogMessage($e)
Get a message formatting the exception message and its origin.
$wgSitename
Name of the site.
if(!$wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:664
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:2102
$wgMimeType
The default Content-Type header.
static header($code)
Output an HTTP status code header.
Definition: HttpStatus.php:96
static printError($message)
Print a message, if possible to STDERR.
wfHttpError($code, $label, $desc)
Provide a simple HTTP error.
Class to expose exceptions to the client (API bots, users, admins using CLI scripts) ...
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
static runHooks($e, $name, $args=[])
Run hook to allow extensions to modify the text of the exception.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message.Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item.Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page.Return false to stop further processing of the tag $reader:XMLReader object &$pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision.Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag.Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload.Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports.&$fullInterwikiPrefix:Interwiki prefix, may contain colons.&$pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable.Can be used to lazy-load the import sources list.&$importSources:The value of $wgImportSources.Modify as necessary.See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page.$context:IContextSource object &$pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect.&$title:Title object for the current page &$request:WebRequest &$ignoreRedirect:boolean to skip redirect check &$target:Title/string of redirect target &$article:Article object 'InternalParseBeforeLinks':during Parser's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InternalParseBeforeSanitize':during Parser's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings.Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not.Return true without providing an interwiki to continue interwiki search.$prefix:interwiki prefix we are looking for.&$iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user's email has been invalidated successfully.$user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification.Callee may modify $url and $query, URL will be constructed as $url.$query &$url:URL to index.php &$query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) &$article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() &$ip:IP being check &$result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from &$allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn't match your organization.$addr:The e-mail address entered by the user &$result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user &$result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we're looking for a messages file for &$file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces.Do not use this hook to add namespaces.Use CanonicalNamespaces for that.&$namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names.&$names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page's language links.This is called in various places to allow extensions to define the effective language links for a page.$title:The page's Title.&$links:Associative array mapping language codes to prefixed links of the form"language:title".&$linkFlags:Associative array mapping prefixed links to arrays of flags.Currently unused, but planned to provide support for marking individual language links in the UI, e.g.for featured articles. 'LanguageSelector':Hook to change the language selector available on a page.$out:The output page.$cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED!Use HtmlPageLinkRendererBegin instead.Used when generating internal and interwiki links in Linker::link(), before processing starts.Return false to skip default processing and return $ret.See documentation for Linker::link() for details on the expected meanings of parameters.$skin:the Skin object $target:the Title that the link is pointing to &$html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1934
if($line===false) $args
Definition: cdb.php:64
wfMsgReplaceArgs($message, $args)
Replace message parameter keys on the given formatted output.
static getHTML($e)
If $wgShowExceptionDetails is true, return a HTML message with a backtrace to the error...
Base class for the more common types of database errors.
$GLOBALS['IP']
Bar style
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 unsetoffset-wrap String Wrap the message in html(usually something like"&lt
static getURL()
If the exception occurred in the course of responding to a request, returns the requested URL...
static msg($key, $fallback)
Get a message from i18n.
static output($e, $mode, $eNew=null)
$header
static getRedactedTraceAsString($e)
Generate a string representation of an exception's stack trace.
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:9
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:802
static reportHTML($e)
Output the exception report using HTML.
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:35
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres as and are nearing end of but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN type
Definition: postgres.txt:22
$fallback
Definition: MessagesAb.php:11
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at name
Definition: design.txt:12
$wgCanonicalServer
Canonical URL of the server, to use in IRC feeds and notification e-mails.
$wgOut
Definition: Setup.php:816
static element($element, $attribs=[], $contents= '')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:229
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
Definition: hooks.txt:2159
static singleton()
Get the signleton instance of this class.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300
static newFromSpecifier($value)
Transform a MessageSpecifier or a primitive value used interchangeably with specifiers (a message key...
Definition: Message.php:398