includes/Exception.php

   1 <?php
   2 /**
   3  * Exception class and handler.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * @defgroup Exception Exception
  25  */
  26
  27 /**
  28  * MediaWiki exception
  29  *
  30  * @ingroup Exception
  31  */
  32 class MWException extends Exception {
  33         var $logId;
  34
  35         /**
  36          * Should the exception use $wgOut to output the error?
  37          *
  38          * @return bool
  39          */
  40         function useOutputPage() {
  41                 return $this->useMessageCache() &&
  42                         !empty( $GLOBALS['wgFullyInitialised'] ) &&
  43                         !empty( $GLOBALS['wgOut'] ) &&
  44                         !empty( $GLOBALS['wgTitle'] );
  45         }
  46
  47         /**
  48          * Can the extension use the Message class/wfMessage to get i18n-ed messages?
  49          *
  50          * @return bool
  51          */
  52         function useMessageCache() {
  53                 global $wgLang;
  54
  55                 foreach ( $this->getTrace() as $frame ) {
  56                         if ( isset( $frame['class'] ) && $frame['class'] === 'LocalisationCache' ) {
  57                                 return false;
  58                         }
  59                 }
  60
  61                 return $wgLang instanceof Language;
  62         }
  63
  64         /**
  65          * Run hook to allow extensions to modify the text of the exception
  66          *
  67          * @param $name string: class name of the exception
  68          * @param $args array: arguments to pass to the callback functions
  69          * @return string|null string to output or null if any hook has been called
  70          */
  71         function runHooks( $name, $args = array() ) {
  72                 global $wgExceptionHooks;
  73
  74                 if ( !isset( $wgExceptionHooks ) || !is_array( $wgExceptionHooks ) ) {
  75                         return null; // Just silently ignore
  76                 }
  77
  78                 if ( !array_key_exists( $name, $wgExceptionHooks ) || !is_array( $wgExceptionHooks[ $name ] ) ) {
  79                         return null;
  80                 }
  81
  82                 $hooks = $wgExceptionHooks[ $name ];
  83                 $callargs = array_merge( array( $this ), $args );
  84
  85                 foreach ( $hooks as $hook ) {
  86                         if ( is_string( $hook ) || ( is_array( $hook ) && count( $hook ) >= 2 && is_string( $hook[0] ) ) ) {    // 'function' or array( 'class', hook' )
  87                                 $result = call_user_func_array( $hook, $callargs );
  88                         } else {
  89                                 $result = null;
  90                         }
  91
  92                         if ( is_string( $result ) ) {
  93                                 return $result;
  94                         }
  95                 }
  96                 return null;
  97         }
  98
  99         /**
 100          * Get a message from i18n
 101          *
 102          * @param $key string: message name
 103          * @param $fallback string: default message if the message cache can't be
 104          *                  called by the exception
 105          * The function also has other parameters that are arguments for the message
 106          * @return string message with arguments replaced
 107          */
 108         function msg( $key, $fallback /*[, params...] */ ) {
 109                 $args = array_slice( func_get_args(), 2 );
 110
 111                 if ( $this->useMessageCache() ) {
 112                         return wfMessage( $key, $args )->plain();
 113                 } else {
 114                         return wfMsgReplaceArgs( $fallback, $args );
 115                 }
 116         }
 117
 118         /**
 119          * If $wgShowExceptionDetails is true, return a HTML message with a
 120          * backtrace to the error, otherwise show a message to ask to set it to true
 121          * to show that information.
 122          *
 123          * @return string html to output
 124          */
 125         function getHTML() {
 126                 global $wgShowExceptionDetails;
 127
 128                 if ( $wgShowExceptionDetails ) {
 129                         return '<p>' . nl2br( htmlspecialchars( $this->getMessage() ) ) .
 130                                 '</p><p>Backtrace:</p><p>' . nl2br( htmlspecialchars( $this->getTraceAsString() ) ) .
 131                                 "</p>\n";
 132                 } else {
 133                         return
 134                                 "<div class=\"errorbox\">" .
 135                                 '[' . $this->getLogId() . '] ' .
 136                                 gmdate( 'Y-m-d H:i:s' ) .
 137                                 ": Fatal exception of type " . get_class( $this ) . "</div>\n" .
 138                                 "<!-- Set \$wgShowExceptionDetails = true; " .
 139                                 "at the bottom of LocalSettings.php to show detailed " .
 140                                 "debugging information. -->";
 141                 }
 142         }
 143
 144         /**
 145          * Get the text to display when reporting the error on the command line.
 146          * If $wgShowExceptionDetails is true, return a text message with a
 147          * backtrace to the error.
 148          *
 149          * @return string
 150          */
 151         function getText() {
 152                 global $wgShowExceptionDetails;
 153
 154                 if ( $wgShowExceptionDetails ) {
 155                         return $this->getMessage() .
 156                                 "\nBacktrace:\n" . $this->getTraceAsString() . "\n";
 157                 } else {
 158                         return "Set \$wgShowExceptionDetails = true; " .
 159                                 "in LocalSettings.php to show detailed debugging information.\n";
 160                 }
 161         }
 162
 163         /**
 164          * Return the title of the page when reporting this error in a HTTP response.
 165          *
 166          * @return string
 167          */
 168         function getPageTitle() {
 169                 return $this->msg( 'internalerror', "Internal error" );
 170         }
 171
 172         /**
 173          * Get a random ID for this error.
 174          * This allows to link the exception to its correspoding log entry when
 175          * $wgShowExceptionDetails is set to false.
 176          *
 177          * @return string
 178          */
 179         function getLogId() {
 180                 if ( $this->logId === null ) {
 181                         $this->logId = wfRandomString( 8 );
 182                 }
 183                 return $this->logId;
 184         }
 185
 186         /**
 187          * Return the requested URL and point to file and line number from which the
 188          * exception occurred
 189          *
 190          * @return string
 191          */
 192         function getLogMessage() {
 193                 global $wgRequest;
 194
 195                 $id = $this->getLogId();
 196                 $file = $this->getFile();
 197                 $line = $this->getLine();
 198                 $message = $this->getMessage();
 199
 200                 if ( isset( $wgRequest ) && !$wgRequest instanceof FauxRequest ) {
 201                         $url = $wgRequest->getRequestURL();
 202                         if ( !$url ) {
 203                                 $url = '[no URL]';
 204                         }
 205                 } else {
 206                         $url = '[no req]';
 207                 }
 208
 209                 return "[$id] $url   Exception from line $line of $file: $message";
 210         }
 211
 212         /**
 213          * Output the exception report using HTML.
 214          */
 215         function reportHTML() {
 216                 global $wgOut;
 217                 if ( $this->useOutputPage() ) {
 218                         $wgOut->prepareErrorPage( $this->getPageTitle() );
 219
 220                         $hookResult = $this->runHooks( get_class( $this ) );
 221                         if ( $hookResult ) {
 222                                 $wgOut->addHTML( $hookResult );
 223                         } else {
 224                                 $wgOut->addHTML( $this->getHTML() );
 225                         }
 226
 227                         $wgOut->output();
 228                 } else {
 229                         header( "Content-Type: text/html; charset=utf-8" );
 230                         echo "<!doctype html>\n" .
 231                                 '<html><head>' .
 232                                 '<title>' . htmlspecialchars( $this->getPageTitle() ) . '</title>' .
 233                                 "</head><body>\n";
 234
 235                         $hookResult = $this->runHooks( get_class( $this ) . "Raw" );
 236                         if ( $hookResult ) {
 237                                 echo $hookResult;
 238                         } else {
 239                                 echo $this->getHTML();
 240                         }
 241
 242                         echo "</body></html>\n";
 243                         die( 1 );
 244                 }
 245         }
 246
 247         /**
 248          * Output a report about the exception and takes care of formatting.
 249          * It will be either HTML or plain text based on isCommandLine().
 250          */
 251         function report() {
 252                 global $wgLogExceptionBacktrace;
 253                 $log = $this->getLogMessage();
 254
 255                 if ( $log ) {
 256                         if ( $wgLogExceptionBacktrace ) {
 257                                 wfDebugLog( 'exception', $log . "\n" . $this->getTraceAsString() . "\n" );
 258                         } else {
 259                                 wfDebugLog( 'exception', $log );
 260                         }
 261                 }
 262
 263                 if ( defined( 'MW_API' ) ) {
 264                         // Unhandled API exception, we can't be sure that format printer is alive
 265                         header( 'MediaWiki-API-Error: internal_api_error_' . get_class( $this ) );
 266                         wfHttpError(500, 'Internal Server Error', $this->getText() );
 267                 } elseif ( self::isCommandLine() ) {
 268                         MWExceptionHandler::printError( $this->getText() );
 269                 } else {
 270                         header( "HTTP/1.1 500 MediaWiki exception" );
 271                         header( "Status: 500 MediaWiki exception", true );
 272
 273                         $this->reportHTML();
 274                 }
 275         }
 276
 277         /**
 278          * Check whether we are in command line mode or not to report the exception
 279          * in the correct format.
 280          *
 281          * @return bool
 282          */
 283         static function isCommandLine() {
 284                 return !empty( $GLOBALS['wgCommandLineMode'] );
 285         }
 286 }
 287
 288 /**
 289  * Exception class which takes an HTML error message, and does not
 290  * produce a backtrace. Replacement for OutputPage::fatalError().
 291  *
 292  * @since 1.7
 293  * @ingroup Exception
 294  */
 295 class FatalError extends MWException {
 296
 297         /**
 298          * @return string
 299          */
 300         function getHTML() {
 301                 return $this->getMessage();
 302         }
 303
 304         /**
 305          * @return string
 306          */
 307         function getText() {
 308                 return $this->getMessage();
 309         }
 310 }
 311
 312 /**
 313  * An error page which can definitely be safely rendered using the OutputPage.
 314  *
 315  * @since 1.7
 316  * @ingroup Exception
 317  */
 318 class ErrorPageError extends MWException {
 319         public $title, $msg, $params;
 320
 321         /**
 322          * Note: these arguments are keys into wfMessage(), not text!
 323          *
 324          * @param $title string|Message Message key (string) for page title, or a Message object
 325          * @param $msg string|Message Message key (string) for error text, or a Message object
 326          * @param $params array with parameters to wfMessage()
 327          */
 328         function __construct( $title, $msg, $params = null ) {
 329                 $this->title = $title;
 330                 $this->msg = $msg;
 331                 $this->params = $params;
 332
 333                 if( $msg instanceof Message ){
 334                         parent::__construct( $msg );
 335                 } else {
 336                         parent::__construct( wfMessage( $msg )->text() );
 337                 }
 338         }
 339
 340         function report() {
 341                 global $wgOut;
 342
 343                 $wgOut->showErrorPage( $this->title, $this->msg, $this->params );
 344                 $wgOut->output();
 345         }
 346 }
 347
 348 /**
 349  * Show an error page on a badtitle.
 350  * Similar to ErrorPage, but emit a 400 HTTP error code to let mobile
 351  * browser it is not really a valid content.
 352  *
 353  * @since 1.19
 354  * @ingroup Exception
 355  */
 356 class BadTitleError extends ErrorPageError {
 357         /**
 358          * @param $msg string|Message A message key (default: 'badtitletext')
 359          * @param $params Array parameter to wfMessage()
 360          */
 361         function __construct( $msg = 'badtitletext', $params = null ) {
 362                 parent::__construct( 'badtitle', $msg, $params );
 363         }
 364
 365         /**
 366          * Just like ErrorPageError::report() but additionally set
 367          * a 400 HTTP status code (bug 33646).
 368          */
 369         function report() {
 370                 global $wgOut;
 371
 372                 // bug 33646: a badtitle error page need to return an error code
 373                 // to let mobile browser now that it is not a normal page.
 374                 $wgOut->setStatusCode( 400 );
 375                 parent::report();
 376         }
 377
 378 }
 379
 380 /**
 381  * Show an error when a user tries to do something they do not have the necessary
 382  * permissions for.
 383  *
 384  * @since 1.18
 385  * @ingroup Exception
 386  */
 387 class PermissionsError extends ErrorPageError {
 388         public $permission, $errors;
 389
 390         function __construct( $permission, $errors = array() ) {
 391                 global $wgLang;
 392
 393                 $this->permission = $permission;
 394
 395                 if ( !count( $errors ) ) {
 396                         $groups = array_map(
 397                                 array( 'User', 'makeGroupLinkWiki' ),
 398                                 User::getGroupsWithPermission( $this->permission )
 399                         );
 400
 401                         if ( $groups ) {
 402                                 $errors[] = array( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
 403                         } else {
 404                                 $errors[] = array( 'badaccess-group0' );
 405                         }
 406                 }
 407
 408                 $this->errors = $errors;
 409         }
 410
 411         function report() {
 412                 global $wgOut;
 413
 414                 $wgOut->showPermissionsErrorPage( $this->errors, $this->permission );
 415                 $wgOut->output();
 416         }
 417 }
 418
 419 /**
 420  * Show an error when the wiki is locked/read-only and the user tries to do
 421  * something that requires write access.
 422  *
 423  * @since 1.18
 424  * @ingroup Exception
 425  */
 426 class ReadOnlyError extends ErrorPageError {
 427         public function __construct(){
 428                 parent::__construct(
 429                         'readonly',
 430                         'readonlytext',
 431                         wfReadOnlyReason()
 432                 );
 433         }
 434 }
 435
 436 /**
 437  * Show an error when the user hits a rate limit.
 438  *
 439  * @since 1.18
 440  * @ingroup Exception
 441  */
 442 class ThrottledError extends ErrorPageError {
 443         public function __construct(){
 444                 parent::__construct(
 445                         'actionthrottled',
 446                         'actionthrottledtext'
 447                 );
 448         }
 449
 450         public function report(){
 451                 global $wgOut;
 452                 $wgOut->setStatusCode( 503 );
 453                 parent::report();
 454         }
 455 }
 456
 457 /**
 458  * Show an error when the user tries to do something whilst blocked.
 459  *
 460  * @since 1.18
 461  * @ingroup Exception
 462  */
 463 class UserBlockedError extends ErrorPageError {
 464         public function __construct( Block $block ){
 465                 global $wgLang, $wgRequest;
 466
 467                 $blocker = $block->getBlocker();
 468                 if ( $blocker instanceof User ) { // local user
 469                         $blockerUserpage = $block->getBlocker()->getUserPage();
 470                         $link = "[[{$blockerUserpage->getPrefixedText()}|{$blockerUserpage->getText()}]]";
 471                 } else { // foreign user
 472                         $link = $blocker;
 473                 }
 474
 475                 $reason = $block->mReason;
 476                 if( $reason == '' ) {
 477                         $reason = wfMessage( 'blockednoreason' )->text();
 478                 }
 479
 480                 /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked.
 481                  * This could be a username, an IP range, or a single IP. */
 482                 $intended = $block->getTarget();
 483
 484                 parent::__construct(
 485                         'blockedtitle',
 486                         $block->mAuto ? 'autoblockedtext' : 'blockedtext',
 487                         array(
 488                                 $link,
 489                                 $reason,
 490                                 $wgRequest->getIP(),
 491                                 $block->getByName(),
 492                                 $block->getId(),
 493                                 $wgLang->formatExpiry( $block->mExpiry ),
 494                                 $intended,
 495                                 $wgLang->timeanddate( wfTimestamp( TS_MW, $block->mTimestamp ), true )
 496                         )
 497                 );
 498         }
 499 }
 500
 501 /**
 502  * Shows a generic "user is not logged in" error page.
 503  *
 504  * This is essentially an ErrorPageError exception which by default use the
 505  * 'exception-nologin' as a title and 'exception-nologin-text' for the message.
 506  * @see bug 37627
 507  * @since 1.20
 508  *
 509  * @par Example:
 510  * @code
 511  * if( $user->isAnon ) {
 512  *      throw new UserNotLoggedIn();
 513  * }
 514  * @endcode
 515  *
 516  * Please note the parameters are mixed up compared to ErrorPageError, this
 517  * is done to be able to simply specify a reason whitout overriding the default
 518  * title.
 519  *
 520  * @par Example:
 521  * @code
 522  * if( $user->isAnon ) {
 523  *      throw new UserNotLoggedIn( 'action-require-loggedin' );
 524  * }
 525  * @endcode
 526  *
 527  * @ingroup Exception
 528  */
 529 class UserNotLoggedIn extends ErrorPageError {
 530
 531         /**
 532          * @param $reasonMsg A message key containing the reason for the error.
 533          *        Optional, default: 'exception-nologin-text'
 534          * @param $titleMsg A message key to set the page title.
 535          *        Optional, default: 'exception-nologin'
 536          * @param $params Parameters to wfMessage().
 537          *        Optiona, default: null
 538          */
 539         public function __construct(
 540                 $reasonMsg = 'exception-nologin-text',
 541                 $titleMsg  = 'exception-nologin',
 542                 $params = null
 543         ) {
 544                 parent::__construct( $titleMsg, $reasonMsg, $params );
 545         }
 546 }
 547
 548 /**
 549  * Show an error that looks like an HTTP server error.
 550  * Replacement for wfHttpError().
 551  *
 552  * @since 1.19
 553  * @ingroup Exception
 554  */
 555 class HttpError extends MWException {
 556         private $httpCode, $header, $content;
 557
 558         /**
 559          * Constructor
 560          *
 561          * @param $httpCode Integer: HTTP status code to send to the client
 562          * @param $content String|Message: content of the message
 563          * @param $header String|Message: content of the header (\<title\> and \<h1\>)
 564          */
 565         public function __construct( $httpCode, $content, $header = null ){
 566                 parent::__construct( $content );
 567                 $this->httpCode = (int)$httpCode;
 568                 $this->header = $header;
 569                 $this->content = $content;
 570         }
 571
 572         public function report() {
 573                 $httpMessage = HttpStatus::getMessage( $this->httpCode );
 574
 575                 header( "Status: {$this->httpCode} {$httpMessage}" );
 576                 header( 'Content-type: text/html; charset=utf-8' );
 577
 578                 if ( $this->header === null ) {
 579                         $header = $httpMessage;
 580                 } elseif ( $this->header instanceof Message ) {
 581                         $header = $this->header->escaped();
 582                 } else {
 583                         $header = htmlspecialchars( $this->header );
 584                 }
 585
 586                 if ( $this->content instanceof Message ) {
 587                         $content = $this->content->escaped();
 588                 } else {
 589                         $content = htmlspecialchars( $this->content );
 590                 }
 591
 592                 print "<!DOCTYPE html>\n".
 593                         "<html><head><title>$header</title></head>\n" .
 594                         "<body><h1>$header</h1><p>$content</p></body></html>\n";
 595         }
 596 }
 597
 598 /**
 599  * Handler class for MWExceptions
 600  * @ingroup Exception
 601  */
 602 class MWExceptionHandler {
 603         /**
 604          * Install an exception handler for MediaWiki exception types.
 605          */
 606         public static function installHandler() {
 607                 set_exception_handler( array( 'MWExceptionHandler', 'handle' ) );
 608         }
 609
 610         /**
 611          * Report an exception to the user
 612          */
 613         protected static function report( Exception $e ) {
 614                 global $wgShowExceptionDetails;
 615
 616                 $cmdLine = MWException::isCommandLine();
 617
 618                 if ( $e instanceof MWException ) {
 619                         try {
 620                                 // Try and show the exception prettily, with the normal skin infrastructure
 621                                 $e->report();
 622                         } catch ( Exception $e2 ) {
 623                                 // Exception occurred from within exception handler
 624                                 // Show a simpler error message for the original exception,
 625                                 // don't try to invoke report()
 626                                 $message = "MediaWiki internal error.\n\n";
 627
 628                                 if ( $wgShowExceptionDetails ) {
 629                                         $message .= 'Original exception: ' . $e->__toString() . "\n\n" .
 630                                                 'Exception caught inside exception handler: ' . $e2->__toString();
 631                                 } else {
 632                                         $message .= "Exception caught inside exception handler.\n\n" .
 633                                                 "Set \$wgShowExceptionDetails = true; at the bottom of LocalSettings.php " .
 634                                                 "to show detailed debugging information.";
 635                                 }
 636
 637                                 $message .= "\n";
 638
 639                                 if ( $cmdLine ) {
 640                                         self::printError( $message );
 641                                 } else {
 642                                         self::escapeEchoAndDie( $message );
 643                                 }
 644                         }
 645                 } else {
 646                         $message = "Unexpected non-MediaWiki exception encountered, of type \"" . get_class( $e ) . "\"\n" .
 647                                 $e->__toString() . "\n";
 648
 649                         if ( $wgShowExceptionDetails ) {
 650                                 $message .= "\n" . $e->getTraceAsString() . "\n";
 651                         }
 652
 653                         if ( $cmdLine ) {
 654                                 self::printError( $message );
 655                         } else {
 656                                 self::escapeEchoAndDie( $message );
 657                         }
 658                 }
 659         }
 660
 661         /**
 662          * Print a message, if possible to STDERR.
 663          * Use this in command line mode only (see isCommandLine)
 664          *
 665          * @param $message string Failure text
 666          */
 667         public static function printError( $message ) {
 668                 # NOTE: STDERR may not be available, especially if php-cgi is used from the command line (bug #15602).
 669                 #      Try to produce meaningful output anyway. Using echo may corrupt output to STDOUT though.
 670                 if ( defined( 'STDERR' ) ) {
 671                         fwrite( STDERR, $message );
 672                 } else {
 673                         echo( $message );
 674                 }
 675         }
 676
 677         /**
 678          * Print a message after escaping it and converting newlines to <br>
 679          * Use this for non-command line failures.
 680          *
 681          * @param $message string Failure text
 682          */
 683         private static function escapeEchoAndDie( $message ) {
 684                 echo nl2br( htmlspecialchars( $message ) ) . "\n";
 685                 die(1);
 686         }
 687
 688         /**
 689          * Exception handler which simulates the appropriate catch() handling:
 690          *
 691          *   try {
 692          *       ...
 693          *   } catch ( MWException $e ) {
 694          *       $e->report();
 695          *   } catch ( Exception $e ) {
 696          *       echo $e->__toString();
 697          *   }
 698          */
 699         public static function handle( $e ) {
 700                 global $wgFullyInitialised;
 701
 702                 self::report( $e );
 703
 704                 // Final cleanup
 705                 if ( $wgFullyInitialised ) {
 706                         try {
 707                                 wfLogProfilingData(); // uses $wgRequest, hence the $wgFullyInitialised condition
 708                         } catch ( Exception $e ) {}
 709                 }
 710
 711                 // Exit value should be nonzero for the benefit of shell jobs
 712                 exit( 1 );
 713         }
 714 }