includes/api/ApiMain.php

   1 <?php
   2
   3 /*
   4  * Created on Sep 4, 2006
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if (!defined('MEDIAWIKI')) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ('ApiBase.php');
  29 }
  30
  31 /**
  32  * @defgroup API API
  33  */
  34
  35 /**
  36  * This is the main API class, used for both external and internal processing.
  37  * When executed, it will create the requested formatter object,
  38  * instantiate and execute an object associated with the needed action,
  39  * and use formatter to print results.
  40  * In case of an exception, an error message will be printed using the same formatter.
  41  *
  42  * To use API from another application, run it using FauxRequest object, in which
  43  * case any internal exceptions will not be handled but passed up to the caller.
  44  * After successful execution, use getResult() for the resulting data.
  45  *
  46  * @ingroup API
  47  */
  48 class ApiMain extends ApiBase {
  49
  50         /**
  51          * When no format parameter is given, this format will be used
  52          */
  53         const API_DEFAULT_FORMAT = 'xmlfm';
  54
  55         /**
  56          * List of available modules: action name => module class
  57          */
  58         private static $Modules = array (
  59                 'login' => 'ApiLogin',
  60                 'logout' => 'ApiLogout',
  61                 'query' => 'ApiQuery',
  62                 'expandtemplates' => 'ApiExpandTemplates',
  63                 'parse' => 'ApiParse',
  64                 'opensearch' => 'ApiOpenSearch',
  65                 'feedwatchlist' => 'ApiFeedWatchlist',
  66                 'help' => 'ApiHelp',
  67                 'paraminfo' => 'ApiParamInfo',
  68                 'purge' => 'ApiPurge',
  69         );
  70
  71         private static $WriteModules = array (
  72                 'rollback' => 'ApiRollback',
  73                 'delete' => 'ApiDelete',
  74                 'undelete' => 'ApiUndelete',
  75                 'protect' => 'ApiProtect',
  76                 'block' => 'ApiBlock',
  77                 'unblock' => 'ApiUnblock',
  78                 'move' => 'ApiMove',
  79                 'edit' => 'ApiEditPage',
  80                 'emailuser' => 'ApiEmailUser',
  81                 'watch' => 'ApiWatch',
  82                 'patrol' => 'ApiPatrol',
  83         );
  84
  85         /**
  86          * List of available formats: format name => format class
  87          */
  88         private static $Formats = array (
  89                 'json' => 'ApiFormatJson',
  90                 'jsonfm' => 'ApiFormatJson',
  91                 'php' => 'ApiFormatPhp',
  92                 'phpfm' => 'ApiFormatPhp',
  93                 'wddx' => 'ApiFormatWddx',
  94                 'wddxfm' => 'ApiFormatWddx',
  95                 'xml' => 'ApiFormatXml',
  96                 'xmlfm' => 'ApiFormatXml',
  97                 'yaml' => 'ApiFormatYaml',
  98                 'yamlfm' => 'ApiFormatYaml',
  99                 'rawfm' => 'ApiFormatJson',
 100                 'txt' => 'ApiFormatTxt',
 101                 'txtfm' => 'ApiFormatTxt',
 102                 'dbg' => 'ApiFormatDbg',
 103                 'dbgfm' => 'ApiFormatDbg'
 104         );
 105
 106         /**
 107          * List of user roles that are specifically relevant to the API.
 108          * array( 'right' => array ( 'msg'    => 'Some message with a $1',
 109          *                           'params' => array ( $someVarToSubst ) ),
 110          *                          );
 111          */
 112         private static $mRights = array('writeapi' => array(
 113                                                 'msg' => 'Use of the write API',
 114                                                 'params' => array()
 115                                         ),
 116                                         'apihighlimits' => array(
 117                                                 'msg' => 'Use higher limits in API queries (Slow queries: $1 results; Fast queries: $2 results). The limits for slow queries also apply to multivalue parameters.',
 118                                                 'params' => array (ApiMain::LIMIT_SML2, ApiMain::LIMIT_BIG2)
 119                                         )
 120         );
 121
 122
 123         private $mPrinter, $mModules, $mModuleNames, $mFormats, $mFormatNames;
 124         private $mResult, $mAction, $mShowVersions, $mEnableWrite, $mRequest, $mInternalMode, $mSquidMaxage;
 125
 126         /**
 127         * Constructs an instance of ApiMain that utilizes the module and format specified by $request.
 128         *
 129         * @param $request object - if this is an instance of FauxRequest, errors are thrown and no printing occurs
 130         * @param $enableWrite bool should be set to true if the api may modify data
 131         */
 132         public function __construct($request, $enableWrite = false) {
 133
 134                 $this->mInternalMode = ($request instanceof FauxRequest);
 135
 136                 // Special handling for the main module: $parent === $this
 137                 parent :: __construct($this, $this->mInternalMode ? 'main_int' : 'main');
 138
 139                 if (!$this->mInternalMode) {
 140
 141                         // Impose module restrictions.
 142                         // If the current user cannot read,
 143                         // Remove all modules other than login
 144                         global $wgUser;
 145
 146                         if( $request->getVal( 'callback' ) !== null ) {
 147                                 // JSON callback allows cross-site reads.
 148                                 // For safety, strip user credentials.
 149                                 wfDebug( "API: stripping user credentials for JSON callback\n" );
 150                                 $wgUser = new User();
 151                         }
 152
 153                         if (!$wgUser->isAllowed('read')) {
 154                                 self::$Modules = array(
 155                                         'login'  => self::$Modules['login'],
 156                                         'logout' => self::$Modules['logout'],
 157                                         'help'   => self::$Modules['help'],
 158                                         );
 159                         }
 160                 }
 161
 162                 global $wgAPIModules, $wgEnableWriteAPI; // extension modules
 163                 $this->mModules = $wgAPIModules + self :: $Modules;
 164                 if($wgEnableWriteAPI)
 165                         $this->mModules += self::$WriteModules;
 166
 167                 $this->mModuleNames = array_keys($this->mModules);
 168                 $this->mFormats = self :: $Formats;
 169                 $this->mFormatNames = array_keys($this->mFormats);
 170
 171                 $this->mResult = new ApiResult($this);
 172                 $this->mShowVersions = false;
 173                 $this->mEnableWrite = $enableWrite;
 174
 175                 $this->mRequest = & $request;
 176
 177                 $this->mSquidMaxage = -1; // flag for executeActionWithErrorHandling()
 178                 $this->mCommit = false;
 179         }
 180
 181         /**
 182          * Return true if the API was started by other PHP code using FauxRequest
 183          */
 184         public function isInternalMode() {
 185                 return $this->mInternalMode;
 186         }
 187
 188         /**
 189          * Return the request object that contains client's request
 190          */
 191         public function getRequest() {
 192                 return $this->mRequest;
 193         }
 194
 195         /**
 196          * Get the ApiResult object asscosiated with current request
 197          */
 198         public function getResult() {
 199                 return $this->mResult;
 200         }
 201
 202         /**
 203          * This method will simply cause an error if the write mode was disabled
 204          * or if the current user doesn't have the right to use it
 205          */
 206         public function requestWriteMode() {
 207                 global $wgUser;
 208                 if (!$this->mEnableWrite)
 209                         $this->dieUsage('Editing of this wiki through the API' .
 210                         ' is disabled. Make sure the $wgEnableWriteAPI=true; ' .
 211                         'statement is included in the wiki\'s ' .
 212                         'LocalSettings.php file', 'noapiwrite');
 213                 if (!$wgUser->isAllowed('writeapi'))
 214                         $this->dieUsage('You\'re not allowed to edit this ' .
 215                         'wiki through the API', 'writeapidenied');
 216                 if (wfReadOnly())
 217                         $this->dieUsageMsg(array('readonlytext'));
 218         }
 219
 220         /**
 221          * Set how long the response should be cached.
 222          */
 223         public function setCacheMaxAge($maxage) {
 224                 $this->mSquidMaxage = $maxage;
 225         }
 226
 227         /**
 228          * Create an instance of an output formatter by its name
 229          */
 230         public function createPrinterByName($format) {
 231                 return new $this->mFormats[$format] ($this, $format);
 232         }
 233
 234         /**
 235          * Execute api request. Any errors will be handled if the API was called by the remote client.
 236          */
 237         public function execute() {
 238                 $this->profileIn();
 239                 if ($this->mInternalMode)
 240                         $this->executeAction();
 241                 else
 242                         $this->executeActionWithErrorHandling();
 243
 244                 $this->profileOut();
 245         }
 246
 247         /**
 248          * Execute an action, and in case of an error, erase whatever partial results
 249          * have been accumulated, and replace it with an error message and a help screen.
 250          */
 251         protected function executeActionWithErrorHandling() {
 252
 253                 // In case an error occurs during data output,
 254                 // clear the output buffer and print just the error information
 255                 ob_start();
 256
 257                 try {
 258                         $this->executeAction();
 259                 } catch (Exception $e) {
 260                         // Log it
 261                         if ( $e instanceof MWException ) {
 262                                 wfDebugLog( 'exception', $e->getLogMessage() );
 263                         }
 264
 265                         //
 266                         // Handle any kind of exception by outputing properly formatted error message.
 267                         // If this fails, an unhandled exception should be thrown so that global error
 268                         // handler will process and log it.
 269                         //
 270
 271                         $errCode = $this->substituteResultWithError($e);
 272
 273                         // Error results should not be cached
 274                         $this->setCacheMaxAge(0);
 275
 276                         $headerStr = 'MediaWiki-API-Error: ' . $errCode;
 277                         if ($e->getCode() === 0)
 278                                 header($headerStr);
 279                         else
 280                                 header($headerStr, true, $e->getCode());
 281
 282                         // Reset and print just the error message
 283                         ob_clean();
 284
 285                         // If the error occured during printing, do a printer->profileOut()
 286                         $this->mPrinter->safeProfileOut();
 287                         $this->printResult(true);
 288                 }
 289
 290                 if($this->mSquidMaxage == -1)
 291                 {
 292                         # Nobody called setCacheMaxAge(), use the (s)maxage parameters
 293                         $smaxage = $this->mRequest->getVal('smaxage', 0);
 294                         $maxage = $this->mRequest->getVal('maxage', 0);
 295                 }
 296                 else
 297                         $smaxage = $maxage = $this->mSquidMaxage;
 298
 299                 // Set the cache expiration at the last moment, as any errors may change the expiration.
 300                 // if $this->mSquidMaxage == 0, the expiry time is set to the first second of unix epoch
 301                 $exp = min($smaxage, $maxage);
 302                 $expires = ($exp == 0 ? 1 : time() + $exp);
 303                 header('Expires: ' . wfTimestamp(TS_RFC2822, $expires));
 304                 header('Cache-Control: s-maxage=' . $smaxage . ', must-revalidate, max-age=' . $maxage);
 305
 306                 if($this->mPrinter->getIsHtml())
 307                         echo wfReportTime();
 308
 309                 ob_end_flush();
 310         }
 311
 312         /**
 313          * Replace the result data with the information about an exception.
 314          * Returns the error code
 315          */
 316         protected function substituteResultWithError($e) {
 317
 318                         // Printer may not be initialized if the extractRequestParams() fails for the main module
 319                         if (!isset ($this->mPrinter)) {
 320                                 // The printer has not been created yet. Try to manually get formatter value.
 321                                 $value = $this->getRequest()->getVal('format', self::API_DEFAULT_FORMAT);
 322                                 if (!in_array($value, $this->mFormatNames))
 323                                         $value = self::API_DEFAULT_FORMAT;
 324
 325                                 $this->mPrinter = $this->createPrinterByName($value);
 326                                 if ($this->mPrinter->getNeedsRawData())
 327                                         $this->getResult()->setRawMode();
 328                         }
 329
 330                         if ($e instanceof UsageException) {
 331                                 //
 332                                 // User entered incorrect parameters - print usage screen
 333                                 //
 334                                 $errMessage = array (
 335                                 'code' => $e->getCodeString(),
 336                                 'info' => $e->getMessage());
 337
 338                                 // Only print the help message when this is for the developer, not runtime
 339                                 if ($this->mPrinter->getIsHtml() || $this->mAction == 'help')
 340                                         ApiResult :: setContent($errMessage, $this->makeHelpMsg());
 341
 342                         } else {
 343                                 global $wgShowSQLErrors, $wgShowExceptionDetails;
 344                                 //
 345                                 // Something is seriously wrong
 346                                 //
 347                                 if ( ( $e instanceof DBQueryError ) && !$wgShowSQLErrors ) {
 348                                         $info = "Database query error";
 349                                 } else {
 350                                         $info = "Exception Caught: {$e->getMessage()}";
 351                                 }
 352
 353                                 $errMessage = array (
 354                                         'code' => 'internal_api_error_'. get_class($e),
 355                                         'info' => $info,
 356                                 );
 357                                 ApiResult :: setContent($errMessage, $wgShowExceptionDetails ? "\n\n{$e->getTraceAsString()}\n\n" : "" );
 358                         }
 359
 360                         $this->getResult()->reset();
 361                         // Re-add the id
 362                         if($this->mRequest->getCheck('requestid'))
 363                                 $this->getResult()->addValue(null, 'requestid', $this->mRequest->getVal('requestid'));
 364                         $this->getResult()->addValue(null, 'error', $errMessage);
 365
 366                 return $errMessage['code'];
 367         }
 368
 369         /**
 370          * Execute the actual module, without any error handling
 371          */
 372         protected function executeAction() {
 373                 // First add the id to the top element
 374                 if($this->mRequest->getCheck('requestid'))
 375                         $this->getResult()->addValue(null, 'requestid', $this->mRequest->getVal('requestid'));
 376
 377                 $params = $this->extractRequestParams();
 378
 379                 $this->mShowVersions = $params['version'];
 380                 $this->mAction = $params['action'];
 381
 382                 if( !is_string( $this->mAction ) ) {
 383                         $this->dieUsage( "The API requires a valid action parameter", 'unknown_action' );
 384                 }
 385
 386                 // Instantiate the module requested by the user
 387                 $module = new $this->mModules[$this->mAction] ($this, $this->mAction);
 388
 389                 if( $module->shouldCheckMaxlag() && isset( $params['maxlag'] ) ) {
 390                         // Check for maxlag
 391                         global $wgShowHostnames;
 392                         $maxLag = $params['maxlag'];
 393                         list( $host, $lag ) = wfGetLB()->getMaxLag();
 394                         if ( $lag > $maxLag ) {
 395                                 if( $wgShowHostnames ) {
 396                                         ApiBase :: dieUsage( "Waiting for $host: $lag seconds lagged", 'maxlag' );
 397                                 } else {
 398                                         ApiBase :: dieUsage( "Waiting for a database server: $lag seconds lagged", 'maxlag' );
 399                                 }
 400                                 return;
 401                         }
 402                 }
 403
 404                 if (!$this->mInternalMode) {
 405                         // Ignore mustBePosted() for internal calls
 406                         if($module->mustBePosted() && !$this->mRequest->wasPosted())
 407                                 $this->dieUsage("The {$this->mAction} module requires a POST request", 'mustbeposted');
 408
 409                         // See if custom printer is used
 410                         $this->mPrinter = $module->getCustomPrinter();
 411                         if (is_null($this->mPrinter)) {
 412                                 // Create an appropriate printer
 413                                 $this->mPrinter = $this->createPrinterByName($params['format']);
 414                         }
 415
 416                         if ($this->mPrinter->getNeedsRawData())
 417                                 $this->getResult()->setRawMode();
 418                 }
 419
 420                 // Execute
 421                 $module->profileIn();
 422                 $module->execute();
 423                 wfRunHooks('APIAfterExecute', array(&$module));
 424                 $module->profileOut();
 425
 426                 if (!$this->mInternalMode) {
 427                         // Print result data
 428                         $this->printResult(false);
 429                 }
 430         }
 431
 432         /**
 433          * Print results using the current printer
 434          */
 435         protected function printResult($isError) {
 436                 $printer = $this->mPrinter;
 437                 $printer->profileIn();
 438
 439                 /* If the help message is requested in the default (xmlfm) format,
 440                  * tell the printer not to escape ampersands so that our links do
 441                  * not break. */
 442                 $printer->setUnescapeAmps ( ( $this->mAction == 'help' || $isError )
 443                                 && $this->getParameter('format') == ApiMain::API_DEFAULT_FORMAT );
 444
 445                 $printer->initPrinter($isError);
 446
 447                 $printer->execute();
 448                 $printer->closePrinter();
 449                 $printer->profileOut();
 450         }
 451
 452         /**
 453          * See ApiBase for description.
 454          */
 455         public function getAllowedParams() {
 456                 return array (
 457                         'format' => array (
 458                                 ApiBase :: PARAM_DFLT => ApiMain :: API_DEFAULT_FORMAT,
 459                                 ApiBase :: PARAM_TYPE => $this->mFormatNames
 460                         ),
 461                         'action' => array (
 462                                 ApiBase :: PARAM_DFLT => 'help',
 463                                 ApiBase :: PARAM_TYPE => $this->mModuleNames
 464                         ),
 465                         'version' => false,
 466                         'maxlag'  => array (
 467                                 ApiBase :: PARAM_TYPE => 'integer'
 468                         ),
 469                         'smaxage' => array (
 470                                 ApiBase :: PARAM_TYPE => 'integer',
 471                                 ApiBase :: PARAM_DFLT => 0
 472                         ),
 473                         'maxage' => array (
 474                                 ApiBase :: PARAM_TYPE => 'integer',
 475                                 ApiBase :: PARAM_DFLT => 0
 476                         ),
 477                         'requestid' => null,
 478                 );
 479         }
 480
 481         /**
 482          * See ApiBase for description.
 483          */
 484         public function getParamDescription() {
 485                 return array (
 486                         'format' => 'The format of the output',
 487                         'action' => 'What action you would like to perform',
 488                         'version' => 'When showing help, include version for each module',
 489                         'maxlag' => 'Maximum lag',
 490                         'smaxage' => 'Set the s-maxage header to this many seconds. Errors are never cached',
 491                         'maxage' => 'Set the max-age header to this many seconds. Errors are never cached',
 492                         'requestid' => 'Request ID to distinguish requests. This will just be output back to you',
 493                 );
 494         }
 495
 496         /**
 497          * See ApiBase for description.
 498          */
 499         public function getDescription() {
 500                 return array (
 501                         '',
 502                         '',
 503                         '******************************************************************',
 504                         '**                                                              **',
 505                         '**  This is an auto-generated MediaWiki API documentation page  **',
 506                         '**                                                              **',
 507                         '**                  Documentation and Examples:                 **',
 508                         '**               http://www.mediawiki.org/wiki/API              **',
 509                         '**                                                              **',
 510                         '******************************************************************',
 511                         '',
 512                         'Status:          All features shown on this page should be working, but the API',
 513                         '                 is still in active development, and  may change at any time.',
 514                         '                 Make sure to monitor our mailing list for any updates.',
 515                         '',
 516                         'Documentation:   http://www.mediawiki.org/wiki/API',
 517                         'Mailing list:    http://lists.wikimedia.org/mailman/listinfo/mediawiki-api',
 518                         'Bugs & Requests: http://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts',
 519                         '',
 520                         '',
 521                         '',
 522                         '',
 523                         '',
 524                 );
 525         }
 526
 527         /**
 528          * Returns an array of strings with credits for the API
 529          */
 530         protected function getCredits() {
 531                 return array(
 532                         'API developers:',
 533                         '    Roan Kattouw <Firstname>.<Lastname>@home.nl (lead developer Sep 2007-present)',
 534                         '    Victor Vasiliev - vasilvv at gee mail dot com',
 535                         '    Bryan Tong Minh - bryan . tongminh @ gmail . com',
 536                         '    Yuri Astrakhan <Firstname><Lastname>@gmail.com (creator, lead developer Sep 2006-Sep 2007)',
 537                         '',
 538                         'Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org',
 539                         'or file a bug report at http://bugzilla.wikimedia.org/'
 540                 );
 541         }
 542
 543         /**
 544          * Override the parent to generate help messages for all available modules.
 545          */
 546         public function makeHelpMsg() {
 547
 548                 $this->mPrinter->setHelp();
 549
 550                 // Use parent to make default message for the main module
 551                 $msg = parent :: makeHelpMsg();
 552
 553                 $astriks = str_repeat('*** ', 10);
 554                 $msg .= "\n\n$astriks Modules  $astriks\n\n";
 555                 foreach( $this->mModules as $moduleName => $unused ) {
 556                         $module = new $this->mModules[$moduleName] ($this, $moduleName);
 557                         $msg .= self::makeHelpMsgHeader($module, 'action');
 558                         $msg2 = $module->makeHelpMsg();
 559                         if ($msg2 !== false)
 560                                 $msg .= $msg2;
 561                         $msg .= "\n";
 562                 }
 563
 564                 $msg .= "\n$astriks Permissions $astriks\n\n";
 565                 foreach ( self :: $mRights as $right => $rightMsg ) {
 566                         $groups = User::getGroupsWithPermission( $right );
 567                         $msg .= "* " . $right . " *\n  " . wfMsgReplaceArgs( $rightMsg[ 'msg' ], $rightMsg[ 'params' ] ) .
 568                                                 "\nGranted to:\n  " . str_replace( "*", "all", implode( ", ", $groups ) ) . "\n";
 569
 570                 }
 571
 572                 $msg .= "\n$astriks Formats  $astriks\n\n";
 573                 foreach( $this->mFormats as $formatName => $unused ) {
 574                         $module = $this->createPrinterByName($formatName);
 575                         $msg .= self::makeHelpMsgHeader($module, 'format');
 576                         $msg2 = $module->makeHelpMsg();
 577                         if ($msg2 !== false)
 578                                 $msg .= $msg2;
 579                         $msg .= "\n";
 580                 }
 581
 582                 $msg .= "\n*** Credits: ***\n   " . implode("\n   ", $this->getCredits()) . "\n";
 583
 584
 585                 return $msg;
 586         }
 587
 588         public static function makeHelpMsgHeader($module, $paramName) {
 589                 $modulePrefix = $module->getModulePrefix();
 590                 if (!empty($modulePrefix))
 591                         $modulePrefix = "($modulePrefix) ";
 592
 593                 return "* $paramName={$module->getModuleName()} $modulePrefix*";
 594         }
 595
 596         private $mIsBot = null;
 597         private $mIsSysop = null;
 598         private $mCanApiHighLimits = null;
 599
 600         /**
 601          * Returns true if the currently logged in user is a bot, false otherwise
 602          * OBSOLETE, use canApiHighLimits() instead
 603          */
 604         public function isBot() {
 605                 if (!isset ($this->mIsBot)) {
 606                         global $wgUser;
 607                         $this->mIsBot = $wgUser->isAllowed('bot');
 608                 }
 609                 return $this->mIsBot;
 610         }
 611
 612         /**
 613          * Similar to isBot(), this method returns true if the logged in user is
 614          * a sysop, and false if not.
 615          * OBSOLETE, use canApiHighLimits() instead
 616          */
 617         public function isSysop() {
 618                 if (!isset ($this->mIsSysop)) {
 619                         global $wgUser;
 620                         $this->mIsSysop = in_array( 'sysop', $wgUser->getGroups());
 621                 }
 622
 623                 return $this->mIsSysop;
 624         }
 625
 626         /**
 627          * Check whether the current user is allowed to use high limits
 628          * @return bool
 629          */
 630         public function canApiHighLimits() {
 631                 if (!isset($this->mCanApiHighLimits)) {
 632                         global $wgUser;
 633                         $this->mCanApiHighLimits = $wgUser->isAllowed('apihighlimits');
 634                 }
 635
 636                 return $this->mCanApiHighLimits;
 637         }
 638
 639         /**
 640          * Check whether the user wants us to show version information in the API help
 641          * @return bool
 642          */
 643         public function getShowVersions() {
 644                 return $this->mShowVersions;
 645         }
 646
 647         /**
 648          * Returns the version information of this file, plus it includes
 649          * the versions for all files that are not callable proper API modules
 650          */
 651         public function getVersion() {
 652                 $vers = array ();
 653                 $vers[] = 'MediaWiki: ' . SpecialVersion::getVersion() . "\n    http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/";
 654                 $vers[] = __CLASS__ . ': $Id$';
 655                 $vers[] = ApiBase :: getBaseVersion();
 656                 $vers[] = ApiFormatBase :: getBaseVersion();
 657                 $vers[] = ApiQueryBase :: getBaseVersion();
 658                 $vers[] = ApiFormatFeedWrapper :: getVersion(); // not accessible with format=xxx
 659                 return $vers;
 660         }
 661
 662         /**
 663          * Add or overwrite a module in this ApiMain instance. Intended for use by extending
 664          * classes who wish to add their own modules to their lexicon or override the
 665          * behavior of inherent ones.
 666          *
 667          * @access protected
 668          * @param $mdlName String The identifier for this module.
 669          * @param $mdlClass String The class where this module is implemented.
 670          */
 671         protected function addModule( $mdlName, $mdlClass ) {
 672                 $this->mModules[$mdlName] = $mdlClass;
 673         }
 674
 675         /**
 676          * Add or overwrite an output format for this ApiMain. Intended for use by extending
 677          * classes who wish to add to or modify current formatters.
 678          *
 679          * @access protected
 680          * @param $fmtName The identifier for this format.
 681          * @param $fmtClass The class implementing this format.
 682          */
 683         protected function addFormat( $fmtName, $fmtClass ) {
 684                 $this->mFormats[$fmtName] = $fmtClass;
 685         }
 686
 687         /**
 688          * Get the array mapping module names to class names
 689          */
 690         function getModules() {
 691                 return $this->mModules;
 692         }
 693 }
 694
 695 /**
 696  * This exception will be thrown when dieUsage is called to stop module execution.
 697  * The exception handling code will print a help screen explaining how this API may be used.
 698  *
 699  * @ingroup API
 700  */
 701 class UsageException extends Exception {
 702
 703         private $mCodestr;
 704
 705         public function __construct($message, $codestr, $code = 0) {
 706                 parent :: __construct($message, $code);
 707                 $this->mCodestr = $codestr;
 708         }
 709         public function getCodeString() {
 710                 return $this->mCodestr;
 711         }
 712         public function __toString() {
 713                 return "{$this->getCodeString()}: {$this->getMessage()}";
 714         }
 715 }