includes/exception/MWException.php

   1 <?php
   2 /**
   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.
   7  *
   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.
  12  *
  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
  17  *
  18  * @file
  19  */
  20
  21 /**
  22  * MediaWiki exception
  23  *
  24  * @ingroup Exception
  25  */
  26 class MWException extends Exception {
  27         /**
  28          * Should the exception use $wgOut to output the error?
  29          *
  30          * @return bool
  31          */
  32         public function useOutputPage() {
  33                 return $this->useMessageCache() &&
  34                 !empty( $GLOBALS['wgFullyInitialised'] ) &&
  35                 !empty( $GLOBALS['wgOut'] ) &&
  36                 !defined( 'MEDIAWIKI_INSTALL' );
  37         }
  38
  39         /**
  40          * Whether to log this exception in the exception debug log.
  41          *
  42          * @since 1.23
  43          * @return bool
  44          */
  45         public function isLoggable() {
  46                 return true;
  47         }
  48
  49         /**
  50          * Can the extension use the Message class/wfMessage to get i18n-ed messages?
  51          *
  52          * @return bool
  53          */
  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
  66         /**
  67          * Run hook to allow extensions to modify the text of the exception
  68          *
  69          * @param string $name Class name of the exception
  70          * @param array $args Arguments to pass to the callback functions
  71          * @return string|null String to output or null if any hook has been called
  72          */
  73         public function runHooks( $name, $args = array() ) {
  74                 global $wgExceptionHooks;
  75
  76                 if ( !isset( $wgExceptionHooks ) || !is_array( $wgExceptionHooks ) ) {
  77                         return null; // Just silently ignore
  78                 }
  79
  80                 if ( !array_key_exists( $name, $wgExceptionHooks ) ||
  81                         !is_array( $wgExceptionHooks[$name] )
  82                 ) {
  83                         return null;
  84                 }
  85
  86                 $hooks = $wgExceptionHooks[$name];
  87                 $callargs = array_merge( array( $this ), $args );
  88
  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                         }
  99
 100                         if ( is_string( $result ) ) {
 101                                 return $result;
 102                         }
 103                 }
 104                 return null;
 105         }
 106
 107         /**
 108          * Get a message from i18n
 109          *
 110          * @param string $key Message name
 111          * @param string $fallback Default message if the message cache can't be
 112          *                  called by the exception
 113          * The function also has other parameters that are arguments for the message
 114          * @return string Message with arguments replaced
 115          */
 116         public function msg( $key, $fallback /*[, params...] */ ) {
 117                 $args = array_slice( func_get_args(), 2 );
 118
 119                 if ( $this->useMessageCache() ) {
 120                         return wfMessage( $key, $args )->text();
 121                 } else {
 122                         return wfMsgReplaceArgs( $fallback, $args );
 123                 }
 124         }
 125
 126         /**
 127          * If $wgShowExceptionDetails is true, return a HTML message with a
 128          * backtrace to the error, otherwise show a message to ask to set it to true
 129          * to show that information.
 130          *
 131          * @return string Html to output
 132          */
 133         public function getHTML() {
 134                 global $wgShowExceptionDetails;
 135
 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         }
 150
 151         /**
 152          * Get the text to display when reporting the error on the command line.
 153          * If $wgShowExceptionDetails is true, return a text message with a
 154          * backtrace to the error.
 155          *
 156          * @return string
 157          */
 158         public function getText() {
 159                 global $wgShowExceptionDetails;
 160
 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         }
 169
 170         /**
 171          * Return the title of the page when reporting this error in a HTTP response.
 172          *
 173          * @return string
 174          */
 175         public function getPageTitle() {
 176                 return $this->msg( 'internalerror', 'Internal error' );
 177         }
 178
 179         /**
 180          * Get a the ID for this error.
 181          *
 182          * @since 1.20
 183          * @deprecated since 1.22 Use MWExceptionHandler::getLogId instead.
 184          * @return string
 185          */
 186         public function getLogId() {
 187                 wfDeprecated( __METHOD__, '1.22' );
 188                 return MWExceptionHandler::getLogId( $this );
 189         }
 190
 191         /**
 192          * Return the requested URL and point to file and line number from which the
 193          * exception occurred
 194          *
 195          * @since 1.8
 196          * @deprecated since 1.22 Use MWExceptionHandler::getLogMessage instead.
 197          * @return string
 198          */
 199         public function getLogMessage() {
 200                 wfDeprecated( __METHOD__, '1.22' );
 201                 return MWExceptionHandler::getLogMessage( $this );
 202         }
 203
 204         /**
 205          * Output the exception report using HTML.
 206          */
 207         public function reportHTML() {
 208                 global $wgOut, $wgSitename;
 209                 if ( $this->useOutputPage() ) {
 210                         $wgOut->prepareErrorPage( $this->getPageTitle() );
 211
 212                         $hookResult = $this->runHooks( get_class( $this ) );
 213                         if ( $hookResult ) {
 214                                 $wgOut->addHTML( $hookResult );
 215                         } else {
 216                                 $wgOut->addHTML( $this->getHTML() );
 217                         }
 218
 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";
 228
 229                         $hookResult = $this->runHooks( get_class( $this ) . 'Raw' );
 230                         if ( $hookResult ) {
 231                                 echo $hookResult;
 232                         } else {
 233                                 echo $this->getHTML();
 234                         }
 235
 236                         echo "</body></html>\n";
 237                 }
 238         }
 239
 240         /**
 241          * Output a report about the exception and takes care of formatting.
 242          * It will be either HTML or plain text based on isCommandLine().
 243          */
 244         public function report() {
 245                 global $wgMimeType;
 246
 247                 MWExceptionHandler::logException( $this );
 248
 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() ) {
 254                         MWExceptionHandler::printError( $this->getText() );
 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 );
 259
 260                         $this->reportHTML();
 261                 }
 262         }
 263
 264         /**
 265          * Check whether we are in command line mode or not to report the exception
 266          * in the correct format.
 267          *
 268          * @return bool
 269          */
 270         public static function isCommandLine() {
 271                 return !empty( $GLOBALS['wgCommandLineMode'] );
 272         }
 273 }