3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
26 class MWException
extends Exception
{
28 * Should the exception use $wgOut to output the error?
32 public function useOutputPage() {
33 return $this->useMessageCache() &&
34 !empty( $GLOBALS['wgFullyInitialised'] ) &&
35 !empty( $GLOBALS['wgOut'] ) &&
36 !defined( 'MEDIAWIKI_INSTALL' );
40 * Whether to log this exception in the exception debug log.
45 public function isLoggable() {
50 * Can the extension use the Message class/wfMessage to get i18n-ed messages?
54 public function useMessageCache() {
57 foreach ( $this->getTrace() as $frame ) {
58 if ( isset( $frame['class'] ) && $frame['class'] === LocalisationCache
::class ) {
63 return $wgLang instanceof Language
;
67 * Get a message from i18n
69 * @param string $key Message name
70 * @param string $fallback Default message if the message cache can't be
71 * called by the exception
72 * The function also has other parameters that are arguments for the message
73 * @return string Message with arguments replaced
75 public function msg( $key, $fallback /*[, params...] */ ) {
77 $args = array_slice( func_get_args(), 2 );
79 // FIXME: Keep logic in sync with MWExceptionRenderer::msg.
81 if ( $this->useMessageCache() ) {
83 $res = wfMessage( $key, $args )->text();
84 } catch ( Exception
$e ) {
87 if ( $res === false ) {
88 $res = wfMsgReplaceArgs( $fallback, $args );
89 // If an exception happens inside message rendering,
90 // {{SITENAME}} sometimes won't be replaced.
92 '{{SITENAME}}' => $wgSitename,
99 * If $wgShowExceptionDetails is true, return a HTML message with a
100 * backtrace to the error, otherwise show a message to ask to set it to true
101 * to show that information.
103 * @return string Html to output
105 public function getHTML() {
106 global $wgShowExceptionDetails;
108 if ( $wgShowExceptionDetails ) {
109 return '<p>' . nl2br( htmlspecialchars( MWExceptionHandler
::getLogMessage( $this ) ) ) .
110 '</p><p>Backtrace:</p><p>' .
111 nl2br( htmlspecialchars( MWExceptionHandler
::getRedactedTraceAsString( $this ) ) ) .
114 $logId = WebRequest
::getRequestId();
115 $type = static::class;
116 return Html
::errorBox(
118 '[' . $logId . '] ' .
119 gmdate( 'Y-m-d H:i:s' ) . ": " .
120 $this->msg( "internalerror-fatal-exception",
121 "Fatal exception of type $1",
124 MWExceptionHandler
::getURL()
127 "<!-- Set \$wgShowExceptionDetails = true; " .
128 "at the bottom of LocalSettings.php to show detailed " .
129 "debugging information. -->";
134 * Get the text to display when reporting the error on the command line.
135 * If $wgShowExceptionDetails is true, return a text message with a
136 * backtrace to the error.
140 public function getText() {
141 global $wgShowExceptionDetails;
143 if ( $wgShowExceptionDetails ) {
144 return MWExceptionHandler
::getLogMessage( $this ) .
145 "\nBacktrace:\n" . MWExceptionHandler
::getRedactedTraceAsString( $this ) . "\n";
147 return "Set \$wgShowExceptionDetails = true; " .
148 "in LocalSettings.php to show detailed debugging information.\n";
153 * Return the title of the page when reporting this error in a HTTP response.
157 public function getPageTitle() {
158 return $this->msg( 'internalerror', 'Internal error' );
162 * Output the exception report using HTML.
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(
175 $this->getPageTitle()
179 $wgOut->addHTML( $this->getHTML() );
183 self
::header( 'Content-Type: text/html; charset=utf-8' );
184 echo "<!DOCTYPE html>\n" .
186 // Mimick OutputPage::setPageTitle behaviour
188 htmlspecialchars( $this->msg( 'pagetitle', "$1 - $wgSitename", $this->getPageTitle() ) ) .
190 '<style>body { font-family: sans-serif; margin: 0; padding: 0.5em 2em; }</style>' .
193 echo $this->getHTML();
195 echo "</body></html>\n";
200 * Output a report about the exception and takes care of formatting.
201 * It will be either HTML or plain text based on isCommandLine().
203 public function report() {
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 );
214 self
::statusHeader( 500 );
215 self
::header( "Content-Type: $wgMimeType; charset=utf-8" );
222 * Write a message to stderr falling back to stdout if stderr unavailable
224 * @param string $message
225 * @suppress SecurityCheck-XSS
227 private function writeToCommandLine( $message ) {
228 // T17602: STDERR may not be available
229 if ( !defined( 'MW_PHPUNIT_TEST' ) && defined( 'STDERR' ) ) {
230 fwrite( STDERR
, $message );
237 * Check whether we are in command line mode or not to report the exception
238 * in the correct format.
242 public static function isCommandLine() {
243 return !empty( $GLOBALS['wgCommandLineMode'] );
247 * Send a header, if we haven't already sent them. We shouldn't,
248 * but sometimes we might in a weird case like Export
249 * @param string $header
251 private static function header( $header ) {
252 if ( !headers_sent() ) {
256 private static function statusHeader( $code ) {
257 if ( !headers_sent() ) {
258 HttpStatus
::header( $code );