MediaWiki  1.33.0
MWException.php
Go to the documentation of this file.
1 <?php
26 class 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::class ) {
59  return false;
60  }
61  }
62 
63  return $wgLang instanceof Language;
64  }
65 
75  public function msg( $key, $fallback /*[, params...] */ ) {
76  global $wgSitename;
77  $args = array_slice( func_get_args(), 2 );
78 
79  // FIXME: Keep logic in sync with MWExceptionRenderer::msg.
80  $res = false;
81  if ( $this->useMessageCache() ) {
82  try {
83  $res = wfMessage( $key, $args )->text();
84  } catch ( Exception $e ) {
85  }
86  }
87  if ( $res === false ) {
88  $res = wfMsgReplaceArgs( $fallback, $args );
89  // If an exception happens inside message rendering,
90  // {{SITENAME}} sometimes won't be replaced.
91  $res = strtr( $res, [
92  '{{SITENAME}}' => $wgSitename,
93  ] );
94  }
95  return $res;
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 = static::class;
116  return Html::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()
125  )
126  ) ) .
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  // Manually set the html title, since sometimes
169  // {{SITENAME}} does not get replaced for exceptions
170  // happening inside message rendering.
171  $wgOut->setHTMLTitle(
172  $this->msg(
173  'pagetitle',
174  "$1 - $wgSitename",
175  $this->getPageTitle()
176  )
177  );
178 
179  $wgOut->addHTML( $this->getHTML() );
180 
181  $wgOut->output();
182  } else {
183  self::header( 'Content-Type: text/html; charset=utf-8' );
184  echo "<!DOCTYPE html>\n" .
185  '<html><head>' .
186  // Mimick OutputPage::setPageTitle behaviour
187  '<title>' .
188  htmlspecialchars( $this->msg( 'pagetitle', "$1 - $wgSitename", $this->getPageTitle() ) ) .
189  '</title>' .
190  '<style>body { font-family: sans-serif; margin: 0; padding: 0.5em 2em; }</style>' .
191  "</head><body>\n";
192 
193  echo $this->getHTML();
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_' . static::class );
209  wfHttpError( 500, 'Internal Server Error', $this->getText() );
210  } elseif ( self::isCommandLine() ) {
211  $message = $this->getText();
212  $this->writeToCommandLine( $message );
213  } else {
214  self::statusHeader( 500 );
215  self::header( "Content-Type: $wgMimeType; charset=utf-8" );
216 
217  $this->reportHTML();
218  }
219  }
220 
227  private function writeToCommandLine( $message ) {
228  // T17602: STDERR may not be available
229  if ( !defined( 'MW_PHPUNIT_TEST' ) && defined( 'STDERR' ) ) {
230  fwrite( STDERR, $message );
231  } else {
232  echo $message;
233  }
234  }
235 
242  public static function isCommandLine() {
243  return !empty( $GLOBALS['wgCommandLineMode'] );
244  }
245 
251  private static function header( $header ) {
252  if ( !headers_sent() ) {
253  header( $header );
254  }
255  }
256  private static function statusHeader( $code ) {
257  if ( !headers_sent() ) {
258  HttpStatus::header( $code );
259  }
260  }
261 }
$wgMimeType
$wgMimeType
The default Content-Type header.
Definition: DefaultSettings.php:3207
$fallback
$fallback
Definition: MessagesAb.php:11
wfMsgReplaceArgs
wfMsgReplaceArgs( $message, $args)
Replace message parameter keys on the given formatted output.
Definition: GlobalFunctions.php:1325
$res
$res
Definition: database.txt:21
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:35
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\isCommandLine
static isCommandLine()
Check whether we are in command line mode or not to report the exception in the correct format.
Definition: MWException.php:242
MWException
MediaWiki exception.
Definition: MWException.php:26
MWException\getText
getText()
Get the text to display when reporting the error on the command line.
Definition: MWException.php:140
MWExceptionHandler\getURL
static getURL()
If the exception occurred in the course of responding to a request, returns the requested URL.
Definition: MWExceptionHandler.php:472
MWExceptionHandler\getLogMessage
static getLogMessage( $e)
Get a message formatting the exception message and its origin.
Definition: MWExceptionHandler.php:487
MWException\getPageTitle
getPageTitle()
Return the title of the page when reporting this error in a HTTP response.
Definition: MWException.php:157
MWException\getHTML
getHTML()
If $wgShowExceptionDetails is true, return a HTML message with a backtrace to the error,...
Definition: MWException.php:105
$wgLang
$wgLang
Definition: Setup.php:875
$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 When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:780
MWException\report
report()
Output a report about the exception and takes care of formatting.
Definition: MWException.php:203
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2162
$header
$header
Definition: updateCredits.php:41
MWException\reportHTML
reportHTML()
Output the exception report using HTML.
Definition: MWException.php:164
$wgSitename
$wgSitename
Name of the site.
Definition: DefaultSettings.php:80
MWException\msg
msg( $key, $fallback)
Get a message from i18n.
Definition: MWException.php:75
MWException\header
static header( $header)
Send a header, if we haven't already sent them.
Definition: MWException.php:251
$args
if( $line===false) $args
Definition: cdb.php:64
wfHttpError
wfHttpError( $code, $label, $desc)
Provide a simple HTTP error.
Definition: GlobalFunctions.php:1685
HttpStatus\header
static header( $code)
Output an HTTP status code header.
Definition: HttpStatus.php:96
WebRequest\getRequestId
static getRequestId()
Get the unique request ID.
Definition: WebRequest.php:275
$wgShowExceptionDetails
$wgShowExceptionDetails
If set to true, uncaught exceptions will print the exception message and a complete stack trace to ou...
Definition: DefaultSettings.php:6288
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:9
MWException\writeToCommandLine
writeToCommandLine( $message)
Write a message to stderr falling back to stdout if stderr unavailable.
Definition: MWException.php:227
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
$wgOut
$wgOut
Definition: Setup.php:880
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 use $formDescriptor instead 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
MWExceptionHandler\getRedactedTraceAsString
static getRedactedTraceAsString( $e)
Generate a string representation of an exception's stack trace.
Definition: MWExceptionHandler.php:381
MWException\statusHeader
static statusHeader( $code)
Definition: MWException.php:256
Language
Internationalisation code.
Definition: Language.php:36
$GLOBALS
$GLOBALS['IP']
Definition: ComposerHookHandler.php:6
MWException\useOutputPage
useOutputPage()
Should the exception use $wgOut to output the error?
Definition: MWException.php:32
$type
$type
Definition: testCompression.php:48