MediaWiki  1.23.2
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  }
45  public function isLoggable() {
46  return true;
47  }
54  public function useMessageCache() {
57  foreach ( $this->getTrace() as $frame ) {
58  if ( isset( $frame['class'] ) && $frame['class'] === 'LocalisationCache' ) {
59  return false;
60  }
61  }
63  return $wgLang instanceof Language;
64  }
73  public function runHooks( $name, $args = array() ) {
74  global $wgExceptionHooks;
76  if ( !isset( $wgExceptionHooks ) || !is_array( $wgExceptionHooks ) ) {
77  return null; // Just silently ignore
78  }
80  if ( !array_key_exists( $name, $wgExceptionHooks ) ||
81  !is_array( $wgExceptionHooks[$name] )
82  ) {
83  return null;
84  }
86  $hooks = $wgExceptionHooks[$name];
87  $callargs = array_merge( array( $this ), $args );
89  foreach ( $hooks as $hook ) {
90  if (
91  is_string( $hook ) ||
92  ( is_array( $hook ) && count( $hook ) >= 2 && is_string( $hook[0] ) )
93  ) {
94  // 'function' or array( 'class', hook' )
95  $result = call_user_func_array( $hook, $callargs );
96  } else {
97  $result = null;
98  }
100  if ( is_string( $result ) ) {
101  return $result;
102  }
103  }
104  return null;
105  }
116  public function msg( $key, $fallback /*[, params...] */ ) {
117  $args = array_slice( func_get_args(), 2 );
119  if ( $this->useMessageCache() ) {
120  return wfMessage( $key, $args )->text();
121  } else {
122  return wfMsgReplaceArgs( $fallback, $args );
123  }
124  }
133  public function getHTML() {
134  global $wgShowExceptionDetails;
136  if ( $wgShowExceptionDetails ) {
137  return '<p>' . nl2br( htmlspecialchars( MWExceptionHandler::getLogMessage( $this ) ) ) .
138  '</p><p>Backtrace:</p><p>' . nl2br( htmlspecialchars( MWExceptionHandler::getRedactedTraceAsString( $this ) ) ) .
139  "</p>\n";
140  } else {
141  return "<div class=\"errorbox\">" .
142  '[' . MWExceptionHandler::getLogId( $this ) . '] ' .
143  gmdate( 'Y-m-d H:i:s' ) .
144  ": Fatal exception of type " . get_class( $this ) . "</div>\n" .
145  "<!-- Set \$wgShowExceptionDetails = true; " .
146  "at the bottom of LocalSettings.php to show detailed " .
147  "debugging information. -->";
148  }
149  }
158  public function getText() {
159  global $wgShowExceptionDetails;
161  if ( $wgShowExceptionDetails ) {
162  return MWExceptionHandler::getLogMessage( $this ) .
163  "\nBacktrace:\n" . MWExceptionHandler::getRedactedTraceAsString( $this ) . "\n";
164  } else {
165  return "Set \$wgShowExceptionDetails = true; " .
166  "in LocalSettings.php to show detailed debugging information.\n";
167  }
168  }
175  public function getPageTitle() {
176  return $this->msg( 'internalerror', 'Internal error' );
177  }
186  public function getLogId() {
187  wfDeprecated( __METHOD__, '1.22' );
188  return MWExceptionHandler::getLogId( $this );
189  }
199  public function getLogMessage() {
200  wfDeprecated( __METHOD__, '1.22' );
201  return MWExceptionHandler::getLogMessage( $this );
202  }
207  public function reportHTML() {
208  global $wgOut, $wgSitename;
209  if ( $this->useOutputPage() ) {
210  $wgOut->prepareErrorPage( $this->getPageTitle() );
212  $hookResult = $this->runHooks( get_class( $this ) );
213  if ( $hookResult ) {
214  $wgOut->addHTML( $hookResult );
215  } else {
216  $wgOut->addHTML( $this->getHTML() );
217  }
219  $wgOut->output();
220  } else {
221  header( 'Content-Type: text/html; charset=utf-8' );
222  echo "<!DOCTYPE html>\n" .
223  '<html><head>' .
224  // Mimick OutputPage::setPageTitle behaviour
225  '<title>' . htmlspecialchars( $this->msg( 'pagetitle', "$1 - $wgSitename", $this->getPageTitle() ) ) . '</title>' .
226  '<style>body { font-family: sans-serif; margin: 0; padding: 0.5em 2em; }</style>' .
227  "</head><body>\n";
229  $hookResult = $this->runHooks( get_class( $this ) . 'Raw' );
230  if ( $hookResult ) {
231  echo $hookResult;
232  } else {
233  echo $this->getHTML();
234  }
236  echo "</body></html>\n";
237  }
238  }
244  public function report() {
245  global $wgMimeType;
249  if ( defined( 'MW_API' ) ) {
250  // Unhandled API exception, we can't be sure that format printer is alive
251  header( 'MediaWiki-API-Error: internal_api_error_' . get_class( $this ) );
252  wfHttpError( 500, 'Internal Server Error', $this->getText() );
253  } elseif ( self::isCommandLine() ) {
255  } else {
256  header( 'HTTP/1.1 500 MediaWiki exception' );
257  header( 'Status: 500 MediaWiki exception', true );
258  header( "Content-Type: $wgMimeType; charset=utf-8", true );
260  $this->reportHTML();
261  }
262  }
270  public static function isCommandLine() {
271  return !empty( $GLOBALS['wgCommandLineMode'] );
272  }
273 }
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. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag '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 '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. '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 '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 '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 wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() '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 User::isValidEmailAddr(), 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. '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 '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) '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. 'LinkBegin':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:1528
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
Definition: MessagesAb.php:12
static getLogMessage(Exception $e)
Return the requested URL and point to file and line number from which the exception occurred.
Definition: MWExceptionHandler.php:257
wfMsgReplaceArgs( $message, $args)
Replace message parameter keys on the given formatted output.
Definition: GlobalFunctions.php:1590
Get a the ID for this error.
Definition: MWException.php:186
static printError( $message)
Print a message, if possible to STDERR.
Definition: MWExceptionHandler.php:93
Whether to log this exception in the exception debug log.
Definition: MWException.php:45
Can the extension use the Message class/wfMessage to get i18n-ed messages?
Definition: MWException.php:54
static isCommandLine()
Check whether we are in command line mode or not to report the exception in the correct format.
Definition: MWException.php:270
static getRedactedTraceAsString(Exception $e)
Generate a string representation of an exception's stack trace.
Definition: MWExceptionHandler.php:163
MediaWiki exception.
Definition: MWException.php:26
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Definition: GlobalFunctions.php:1127
Get the text to display when reporting the error on the command line.
Definition: MWException.php:158
Return the title of the page when reporting this error in a HTTP response.
Definition: MWException.php:175
If $wgShowExceptionDetails is true, return a HTML message with a backtrace to the error,...
Definition: MWException.php:133
Definition: Setup.php:562
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 after processing after in associative array form externallinks including delete and has completed for all link tables 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
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
Output a report about the exception and takes care of formatting.
Definition: MWException.php:244
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:336
static getLogId(Exception $e)
Get the ID for this error.
Definition: MWExceptionHandler.php:227
Output the exception report using HTML.
Definition: MWException.php:207
msg( $key, $fallback)
Get a message from i18n.
Definition: MWException.php:116
if( $line===false) $args
Definition: cdb.php:62
runHooks( $name, $args=array())
Run hook to allow extensions to modify the text of the exception.
Definition: MWException.php:73
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
wfHttpError( $code, $label, $desc)
Provide a simple HTTP error.
Definition: GlobalFunctions.php:2191
Return the requested URL and point to file and line number from which the exception occurred.
Definition: MWException.php:199
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
static logException(Exception $e)
Log an exception to the exception log (if enabled).
Definition: MWExceptionHandler.php:351
Internationalisation code.
Definition: Language.php:74
Definition: ComposerHookHandler.php:6
Should the exception use $wgOut to output the error?
Definition: MWException.php:32