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
  69                 // Write modules
  70                 'purge' => 'ApiPurge',
  71                 'rollback' => 'ApiRollback',
  72                 'delete' => 'ApiDelete',
  73                 'undelete' => 'ApiUndelete',
  74                 'protect' => 'ApiProtect',
  75                 'block' => 'ApiBlock',
  76                 'unblock' => 'ApiUnblock',
  77                 'move' => 'ApiMove',
  78                 'edit' => 'ApiEditPage',
  79                 'upload' => 'ApiUpload',
  80                 'emailuser' => 'ApiEmailUser',
  81                 'watch' => 'ApiWatch',
  82                 'patrol' => 'ApiPatrol',
  83                 'import' => 'ApiImport',
  84                 'userrights' => 'ApiUserrights',
  85         );
  86
  87         /**
  88          * List of available formats: format name => format class
  89          */
  90         private static $Formats = array (
  91                 'json' => 'ApiFormatJson',
  92                 'jsonfm' => 'ApiFormatJson',
  93                 'php' => 'ApiFormatPhp',
  94                 'phpfm' => 'ApiFormatPhp',
  95                 'wddx' => 'ApiFormatWddx',
  96                 'wddxfm' => 'ApiFormatWddx',
  97                 'xml' => 'ApiFormatXml',
  98                 'xmlfm' => 'ApiFormatXml',
  99                 'yaml' => 'ApiFormatYaml',
 100                 'yamlfm' => 'ApiFormatYaml',
 101                 'rawfm' => 'ApiFormatJson',
 102                 'txt' => 'ApiFormatTxt',
 103                 'txtfm' => 'ApiFormatTxt',
 104                 'dbg' => 'ApiFormatDbg',
 105                 'dbgfm' => 'ApiFormatDbg'
 106         );
 107
 108         /**
 109          * List of user roles that are specifically relevant to the API.
 110          * array( 'right' => array ( 'msg'    => 'Some message with a $1',
 111          *                           'params' => array ( $someVarToSubst ) ),
 112          *                          );
 113          */
 114         private static $mRights = array( 'writeapi' => array(
 115                                                 'msg' => 'Use of the write API',
 116                                                 'params' => array()
 117                                         ),
 118                                         'apihighlimits' => array(
 119                                                 '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.',
 120                                                 'params' => array ( ApiMain::LIMIT_SML2, ApiMain::LIMIT_BIG2 )
 121                                         )
 122         );
 123
 124
 125         private $mPrinter, $mModules, $mModuleNames, $mFormats, $mFormatNames;
 126         private $mResult, $mAction, $mShowVersions, $mEnableWrite, $mRequest;
 127         private $mInternalMode, $mSquidMaxage, $mModule;
 128
 129         private $mCacheControl = array( 'must-revalidate' => true );
 130
 131         /**
 132         * Constructs an instance of ApiMain that utilizes the module and format specified by $request.
 133         *
 134         * @param $request object - if this is an instance of FauxRequest, errors are thrown and no printing occurs
 135         * @param $enableWrite bool should be set to true if the api may modify data
 136         */
 137         public function __construct( $request, $enableWrite = false ) {
 138
 139                 $this->mInternalMode = ( $request instanceof FauxRequest );
 140
 141                 // Special handling for the main module: $parent === $this
 142                 parent :: __construct( $this, $this->mInternalMode ? 'main_int' : 'main' );
 143
 144                 if ( !$this->mInternalMode ) {
 145
 146                         // Impose module restrictions.
 147                         // If the current user cannot read,
 148                         // Remove all modules other than login
 149                         global $wgUser;
 150
 151                         if ( $request->getVal( 'callback' ) !== null ) {
 152                                 // JSON callback allows cross-site reads.
 153                                 // For safety, strip user credentials.
 154                                 wfDebug( "API: stripping user credentials for JSON callback\n" );
 155                                 $wgUser = new User();
 156                         }
 157                 }
 158
 159                 global $wgAPIModules; // extension modules
 160                 $this->mModules = $wgAPIModules + self :: $Modules;
 161
 162                 $this->mModuleNames = array_keys( $this->mModules );
 163                 $this->mFormats = self :: $Formats;
 164                 $this->mFormatNames = array_keys( $this->mFormats );
 165
 166                 $this->mResult = new ApiResult( $this );
 167                 $this->mShowVersions = false;
 168                 $this->mEnableWrite = $enableWrite;
 169
 170                 $this->mRequest = & $request;
 171
 172                 $this->mSquidMaxage = - 1; // flag for executeActionWithErrorHandling()
 173                 $this->mCommit = false;
 174         }
 175
 176         /**
 177          * Return true if the API was started by other PHP code using FauxRequest
 178          */
 179         public function isInternalMode() {
 180                 return $this->mInternalMode;
 181         }
 182
 183         /**
 184          * Return the request object that contains client's request
 185          */
 186         public function getRequest() {
 187                 return $this->mRequest;
 188         }
 189
 190         /**
 191          * Get the ApiResult object associated with current request
 192          */
 193         public function getResult() {
 194                 return $this->mResult;
 195         }
 196
 197         /**
 198          * Get the API module object. Only works after executeAction()
 199          */
 200         public function getModule() {
 201                 return $this->mModule;
 202         }
 203
 204         /**
 205          * Only kept for backwards compatibility
 206          * @deprecated Use isWriteMode() instead
 207          */
 208         public function requestWriteMode() {
 209                 if ( !$this->mEnableWrite )
 210                         $this->dieUsageMsg( array( 'writedisabled' ) );
 211                 if ( wfReadOnly() )
 212                         $this->dieUsageMsg( array( 'readonlytext' ) );
 213         }
 214
 215         /**
 216          * Set how long the response should be cached.
 217          */
 218         public function setCacheMaxAge( $maxage ) {
 219                 $this->setCacheControl( array(
 220                         'max-age' => $maxage,
 221                         's-maxage' => $maxage
 222                 ) );
 223         }
 224
 225         /**
 226          * Set directives (key/value pairs) for the Cache-Control header.
 227          * Boolean values will be formatted as such, by including or omitting
 228          * without an equals sign.
 229          */
 230         public function setCacheControl( $directives ) {
 231                 $this->mCacheControl = $directives + $this->mCacheControl;
 232         }
 233
 234         /**
 235          * Create an instance of an output formatter by its name
 236          */
 237         public function createPrinterByName( $format ) {
 238                 if ( !isset( $this->mFormats[$format] ) )
 239                         $this->dieUsage( "Unrecognized format: {$format}", 'unknown_format' );
 240                 return new $this->mFormats[$format] ( $this, $format );
 241         }
 242
 243         /**
 244          * Execute api request. Any errors will be handled if the API was called by the remote client.
 245          */
 246         public function execute() {
 247                 $this->profileIn();
 248                 if ( $this->mInternalMode )
 249                         $this->executeAction();
 250                 else
 251                         $this->executeActionWithErrorHandling();
 252
 253                 $this->profileOut();
 254         }
 255
 256         /**
 257          * Execute an action, and in case of an error, erase whatever partial results
 258          * have been accumulated, and replace it with an error message and a help screen.
 259          */
 260         protected function executeActionWithErrorHandling() {
 261
 262                 // In case an error occurs during data output,
 263                 // clear the output buffer and print just the error information
 264                 ob_start();
 265
 266                 try {
 267                         $this->executeAction();
 268                 } catch ( Exception $e ) {
 269                         // Log it
 270                         if ( $e instanceof MWException ) {
 271                                 wfDebugLog( 'exception', $e->getLogMessage() );
 272                         }
 273
 274                         //
 275                         // Handle any kind of exception by outputing properly formatted error message.
 276                         // If this fails, an unhandled exception should be thrown so that global error
 277                         // handler will process and log it.
 278                         //
 279
 280                         $errCode = $this->substituteResultWithError( $e );
 281
 282                         // Error results should not be cached
 283                         $this->setCacheMaxAge( 0 );
 284
 285                         $headerStr = 'MediaWiki-API-Error: ' . $errCode;
 286                         if ( $e->getCode() === 0 )
 287                                 header( $headerStr );
 288                         else
 289                                 header( $headerStr, true, $e->getCode() );
 290
 291                         // Reset and print just the error message
 292                         ob_clean();
 293
 294                         // If the error occured during printing, do a printer->profileOut()
 295                         $this->mPrinter->safeProfileOut();
 296                         $this->printResult( true );
 297                 }
 298
 299                 // If nobody called setCacheMaxAge(), use the (s)maxage parameters
 300                 if ( !isset( $this->mCacheControl['s-maxage'] ) ) {
 301                         $this->mCacheControl['s-maxage'] = $this->getParameter( 'smaxage' );
 302                 }
 303                 if ( !isset( $this->mCacheControl['max-age'] ) ) {
 304                         $this->mCacheControl['max-age'] = $this->getParameter( 'maxage' );
 305                 }
 306
 307                 // Set the cache expiration at the last moment, as any errors may change the expiration.
 308                 // if $this->mSquidMaxage == 0, the expiry time is set to the first second of unix epoch
 309                 $exp = min( $this->mCacheControl['s-maxage'], $this->mCacheControl['max-age'] );
 310                 $expires = ( $exp == 0 ? 1 : time() + $exp );
 311                 header( 'Expires: ' . wfTimestamp( TS_RFC2822, $expires ) );
 312
 313                 // Construct the Cache-Control header
 314                 $ccHeader = '';
 315                 $separator = '';
 316                 foreach ( $this->mCacheControl as $name => $value ) {
 317                         if ( is_bool( $value ) ) {
 318                                 if ( $value ) {
 319                                         $ccHeader .= $separator . $name;
 320                                 }
 321                         } else {
 322                                 $ccHeader .= $separator . "$name=$value";
 323                         }
 324                         $separator = ', ';
 325                 }
 326
 327                 header( "Cache-Control: $ccHeader" );
 328
 329                 if ( $this->mPrinter->getIsHtml() )
 330                         echo wfReportTime();
 331
 332                 ob_end_flush();
 333         }
 334
 335         /**
 336          * Replace the result data with the information about an exception.
 337          * Returns the error code
 338          */
 339         protected function substituteResultWithError( $e ) {
 340
 341                         // Printer may not be initialized if the extractRequestParams() fails for the main module
 342                         if ( !isset ( $this->mPrinter ) ) {
 343                                 // The printer has not been created yet. Try to manually get formatter value.
 344                                 $value = $this->getRequest()->getVal( 'format', self::API_DEFAULT_FORMAT );
 345                                 if ( !in_array( $value, $this->mFormatNames ) )
 346                                         $value = self::API_DEFAULT_FORMAT;
 347
 348                                 $this->mPrinter = $this->createPrinterByName( $value );
 349                                 if ( $this->mPrinter->getNeedsRawData() )
 350                                         $this->getResult()->setRawMode();
 351                         }
 352
 353                         if ( $e instanceof UsageException ) {
 354                                 //
 355                                 // User entered incorrect parameters - print usage screen
 356                                 //
 357                                 $errMessage = $e->getMessageArray();
 358
 359                                 // Only print the help message when this is for the developer, not runtime
 360                                 if ( $this->mPrinter->getWantsHelp() || $this->mAction == 'help' )
 361                                         ApiResult :: setContent( $errMessage, $this->makeHelpMsg() );
 362
 363                         } else {
 364                                 global $wgShowSQLErrors, $wgShowExceptionDetails;
 365                                 //
 366                                 // Something is seriously wrong
 367                                 //
 368                                 if ( ( $e instanceof DBQueryError ) && !$wgShowSQLErrors ) {
 369                                         $info = "Database query error";
 370                                 } else {
 371                                         $info = "Exception Caught: {$e->getMessage()}";
 372                                 }
 373
 374                                 $errMessage = array (
 375                                         'code' => 'internal_api_error_' . get_class( $e ),
 376                                         'info' => $info,
 377                                 );
 378                                 ApiResult :: setContent( $errMessage, $wgShowExceptionDetails ? "\n\n{$e->getTraceAsString()}\n\n" : "" );
 379                         }
 380
 381                         $this->getResult()->reset();
 382                         $this->getResult()->disableSizeCheck();
 383                         // Re-add the id
 384                         $requestid = $this->getParameter( 'requestid' );
 385                         if ( !is_null( $requestid ) )
 386                                 $this->getResult()->addValue( null, 'requestid', $requestid );
 387                         $this->getResult()->addValue( null, 'error', $errMessage );
 388
 389                 return $errMessage['code'];
 390         }
 391
 392         /**
 393          * Execute the actual module, without any error handling
 394          */
 395         protected function executeAction() {
 396                 // First add the id to the top element
 397                 $requestid = $this->getParameter( 'requestid' );
 398                 if ( !is_null( $requestid ) )
 399                         $this->getResult()->addValue( null, 'requestid', $requestid );
 400
 401                 $params = $this->extractRequestParams();
 402
 403                 $this->mShowVersions = $params['version'];
 404                 $this->mAction = $params['action'];
 405
 406                 if ( !is_string( $this->mAction ) ) {
 407                         $this->dieUsage( "The API requires a valid action parameter", 'unknown_action' );
 408                 }
 409
 410                 // Instantiate the module requested by the user
 411                 $module = new $this->mModules[$this->mAction] ( $this, $this->mAction );
 412                 $this->mModule = $module;
 413
 414                 //Die if token required, but not provided (unless there is a gettoken parameter)
 415                 if ( $module->requiresToken() && is_null( $params['token'] ) && !is_null( $params['gettoken'] ) )
 416                         $this->dieUsageMsg( array( 'missingparam', 'token' ) );
 417
 418                 if ( $module->shouldCheckMaxlag() && isset( $params['maxlag'] ) ) {
 419                         // Check for maxlag
 420                         global $wgShowHostnames;
 421                         $maxLag = $params['maxlag'];
 422                         list( $host, $lag ) = wfGetLB()->getMaxLag();
 423                         if ( $lag > $maxLag ) {
 424                                 header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
 425                                 header( 'X-Database-Lag: ' . intval( $lag ) );
 426                                 if ( $wgShowHostnames ) {
 427                                         $this->dieUsage( "Waiting for $host: $lag seconds lagged", 'maxlag' );
 428                                 } else {
 429                                         $this->dieUsage( "Waiting for a database server: $lag seconds lagged", 'maxlag' );
 430                                 }
 431                                 return;
 432                         }
 433                 }
 434
 435                 global $wgUser;
 436                 if ( $module->isReadMode() && !$wgUser->isAllowed( 'read' ) )
 437                         $this->dieUsageMsg( array( 'readrequired' ) );
 438                 if ( $module->isWriteMode() ) {
 439                         if ( !$this->mEnableWrite )
 440                                 $this->dieUsageMsg( array( 'writedisabled' ) );
 441                         if ( !$wgUser->isAllowed( 'writeapi' ) )
 442                                 $this->dieUsageMsg( array( 'writerequired' ) );
 443                         if ( wfReadOnly() )
 444                                 $this->dieReadOnly();
 445                 }
 446
 447                 if ( !$this->mInternalMode ) {
 448                         // Ignore mustBePosted() for internal calls
 449                         if ( $module->mustBePosted() && !$this->mRequest->wasPosted() )
 450                                 $this->dieUsageMsg( array ( 'mustbeposted', $this->mAction ) );
 451
 452                         // See if custom printer is used
 453                         $this->mPrinter = $module->getCustomPrinter();
 454                         if ( is_null( $this->mPrinter ) ) {
 455                                 // Create an appropriate printer
 456                                 $this->mPrinter = $this->createPrinterByName( $params['format'] );
 457                         }
 458
 459                         if ( $this->mPrinter->getNeedsRawData() )
 460                                 $this->getResult()->setRawMode();
 461                 }
 462
 463                 // Execute
 464                 $module->profileIn();
 465                 $module->execute();
 466                 wfRunHooks( 'APIAfterExecute', array( &$module ) );
 467                 $module->profileOut();
 468
 469                 if ( !$this->mInternalMode ) {
 470                         // Print result data
 471                         $this->printResult( false );
 472                 }
 473         }
 474
 475         /**
 476          * Print results using the current printer
 477          */
 478         protected function printResult( $isError ) {
 479                 $this->getResult()->cleanUpUTF8();
 480                 $printer = $this->mPrinter;
 481                 $printer->profileIn();
 482
 483                 /* If the help message is requested in the default (xmlfm) format,
 484                  * tell the printer not to escape ampersands so that our links do
 485                  * not break. */
 486                 $printer->setUnescapeAmps ( ( $this->mAction == 'help' || $isError )
 487                                 && $printer->getFormat() == 'XML' && $printer->getIsHtml() );
 488
 489                 $printer->initPrinter( $isError );
 490
 491                 $printer->execute();
 492                 $printer->closePrinter();
 493                 $printer->profileOut();
 494         }
 495
 496         public function isReadMode() {
 497                 return false;
 498         }
 499
 500         /**
 501          * See ApiBase for description.
 502          */
 503         public function getAllowedParams() {
 504                 return array (
 505                         'format' => array (
 506                                 ApiBase :: PARAM_DFLT => ApiMain :: API_DEFAULT_FORMAT,
 507                                 ApiBase :: PARAM_TYPE => $this->mFormatNames
 508                         ),
 509                         'action' => array (
 510                                 ApiBase :: PARAM_DFLT => 'help',
 511                                 ApiBase :: PARAM_TYPE => $this->mModuleNames
 512                         ),
 513                         'version' => false,
 514                         'maxlag'  => array (
 515                                 ApiBase :: PARAM_TYPE => 'integer'
 516                         ),
 517                         'smaxage' => array (
 518                                 ApiBase :: PARAM_TYPE => 'integer',
 519                                 ApiBase :: PARAM_DFLT => 0
 520                         ),
 521                         'maxage' => array (
 522                                 ApiBase :: PARAM_TYPE => 'integer',
 523                                 ApiBase :: PARAM_DFLT => 0
 524                         ),
 525                         'requestid' => null,
 526                 );
 527         }
 528
 529         /**
 530          * See ApiBase for description.
 531          */
 532         public function getParamDescription() {
 533                 return array (
 534                         'format' => 'The format of the output',
 535                         'action' => 'What action you would like to perform',
 536                         'version' => 'When showing help, include version for each module',
 537                         'maxlag' => 'Maximum lag',
 538                         'smaxage' => 'Set the s-maxage header to this many seconds. Errors are never cached',
 539                         'maxage' => 'Set the max-age header to this many seconds. Errors are never cached',
 540                         'requestid' => 'Request ID to distinguish requests. This will just be output back to you',
 541                 );
 542         }
 543
 544         /**
 545          * See ApiBase for description.
 546          */
 547         public function getDescription() {
 548                 return array (
 549                         '',
 550                         '',
 551                         '******************************************************************',
 552                         '**                                                              **',
 553                         '**  This is an auto-generated MediaWiki API documentation page  **',
 554                         '**                                                              **',
 555                         '**                  Documentation and Examples:                 **',
 556                         '**               http://www.mediawiki.org/wiki/API              **',
 557                         '**                                                              **',
 558                         '******************************************************************',
 559                         '',
 560                         'Status:          All features shown on this page should be working, but the API',
 561                         '                 is still in active development, and  may change at any time.',
 562                         '                 Make sure to monitor our mailing list for any updates.',
 563                         '',
 564                         'Documentation:   http://www.mediawiki.org/wiki/API',
 565                         'Mailing list:    http://lists.wikimedia.org/mailman/listinfo/mediawiki-api',
 566                         'Bugs & Requests: http://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts',
 567                         '',
 568                         '',
 569                         '',
 570                         '',
 571                         '',
 572                 );
 573         }
 574
 575     public function getPossibleErrors() {
 576                 return array_merge( parent::getPossibleErrors(), array(
 577                         array( 'readonlytext' ),
 578                         array( 'code' => 'unknown_format', 'info' => 'Unrecognized format: format' ),
 579                         array( 'code' => 'unknown_action', 'info' => 'The API requires a valid action parameter' ),
 580                         array( 'code' => 'maxlag', 'info' => 'Waiting for host: x seconds lagged' ),
 581                         array( 'code' => 'maxlag', 'info' => 'Waiting for a database server: x seconds lagged' ),
 582         ) );
 583         }
 584
 585         /**
 586          * Returns an array of strings with credits for the API
 587          */
 588         protected function getCredits() {
 589                 return array(
 590                         'API developers:',
 591                         '    Roan Kattouw <Firstname>.<Lastname>@home.nl (lead developer Sep 2007-present)',
 592                         '    Victor Vasiliev - vasilvv at gee mail dot com',
 593                         '    Bryan Tong Minh - bryan . tongminh @ gmail . com',
 594                         '    Sam Reed - sam @ reedyboy . net',
 595                         '    Yuri Astrakhan <Firstname><Lastname>@gmail.com (creator, lead developer Sep 2006-Sep 2007)',
 596                         '',
 597                         'Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org',
 598                         'or file a bug report at http://bugzilla.wikimedia.org/'
 599                 );
 600         }
 601
 602         /**
 603          * Override the parent to generate help messages for all available modules.
 604          */
 605         public function makeHelpMsg() {
 606                 global $wgMemc, $wgAPICacheHelp, $wgAPICacheHelpTimeout;
 607                 $this->mPrinter->setHelp();
 608                 // Get help text from cache if present
 609                 $key = wfMemcKey( 'apihelp', $this->getModuleName(),
 610                         SpecialVersion::getVersion( 'nodb' ) .
 611                         $this->getMain()->getShowVersions() );
 612                 if ( $wgAPICacheHelp ) {
 613                         $cached = $wgMemc->get( $key );
 614                         if ( $cached )
 615                                 return $cached;
 616                 }
 617                 $retval = $this->reallyMakeHelpMsg();
 618                 if ( $wgAPICacheHelp )
 619                         $wgMemc->set( $key, $retval, $wgAPICacheHelpTimeout );
 620                 return $retval;
 621         }
 622
 623         public function reallyMakeHelpMsg() {
 624
 625                 $this->mPrinter->setHelp();
 626
 627                 // Use parent to make default message for the main module
 628                 $msg = parent :: makeHelpMsg();
 629
 630                 $astriks = str_repeat( '*** ', 10 );
 631                 $msg .= "\n\n$astriks Modules  $astriks\n\n";
 632                 foreach ( $this->mModules as $moduleName => $unused ) {
 633                         $module = new $this->mModules[$moduleName] ( $this, $moduleName );
 634                         $msg .= self::makeHelpMsgHeader( $module, 'action' );
 635                         $msg2 = $module->makeHelpMsg();
 636                         if ( $msg2 !== false )
 637                                 $msg .= $msg2;
 638                         $msg .= "\n";
 639                 }
 640
 641                 $msg .= "\n$astriks Permissions $astriks\n\n";
 642                 foreach ( self :: $mRights as $right => $rightMsg ) {
 643                         $groups = User::getGroupsWithPermission( $right );
 644                         $msg .= "* " . $right . " *\n  " . wfMsgReplaceArgs( $rightMsg[ 'msg' ], $rightMsg[ 'params' ] ) .
 645                                                 "\nGranted to:\n  " . str_replace( "*", "all", implode( ", ", $groups ) ) . "\n";
 646
 647                 }
 648
 649                 $msg .= "\n$astriks Formats  $astriks\n\n";
 650                 foreach ( $this->mFormats as $formatName => $unused ) {
 651                         $module = $this->createPrinterByName( $formatName );
 652                         $msg .= self::makeHelpMsgHeader( $module, 'format' );
 653                         $msg2 = $module->makeHelpMsg();
 654                         if ( $msg2 !== false )
 655                                 $msg .= $msg2;
 656                         $msg .= "\n";
 657                 }
 658
 659                 $msg .= "\n*** Credits: ***\n   " . implode( "\n   ", $this->getCredits() ) . "\n";
 660
 661
 662                 return $msg;
 663         }
 664
 665         public static function makeHelpMsgHeader( $module, $paramName ) {
 666                 $modulePrefix = $module->getModulePrefix();
 667                 if ( strval( $modulePrefix ) !== '' )
 668                         $modulePrefix = "($modulePrefix) ";
 669
 670                 return "* $paramName={$module->getModuleName()} $modulePrefix*";
 671         }
 672
 673         private $mIsBot = null;
 674         private $mIsSysop = null;
 675         private $mCanApiHighLimits = null;
 676
 677         /**
 678          * Returns true if the currently logged in user is a bot, false otherwise
 679          * OBSOLETE, use canApiHighLimits() instead
 680          */
 681         public function isBot() {
 682                 if ( !isset ( $this->mIsBot ) ) {
 683                         global $wgUser;
 684                         $this->mIsBot = $wgUser->isAllowed( 'bot' );
 685                 }
 686                 return $this->mIsBot;
 687         }
 688
 689         /**
 690          * Similar to isBot(), this method returns true if the logged in user is
 691          * a sysop, and false if not.
 692          * OBSOLETE, use canApiHighLimits() instead
 693          */
 694         public function isSysop() {
 695                 if ( !isset ( $this->mIsSysop ) ) {
 696                         global $wgUser;
 697                         $this->mIsSysop = in_array( 'sysop', $wgUser->getGroups() );
 698                 }
 699
 700                 return $this->mIsSysop;
 701         }
 702
 703         /**
 704          * Check whether the current user is allowed to use high limits
 705          * @return bool
 706          */
 707         public function canApiHighLimits() {
 708                 if ( !isset( $this->mCanApiHighLimits ) ) {
 709                         global $wgUser;
 710                         $this->mCanApiHighLimits = $wgUser->isAllowed( 'apihighlimits' );
 711                 }
 712
 713                 return $this->mCanApiHighLimits;
 714         }
 715
 716         /**
 717          * Check whether the user wants us to show version information in the API help
 718          * @return bool
 719          */
 720         public function getShowVersions() {
 721                 return $this->mShowVersions;
 722         }
 723
 724         /**
 725          * Returns the version information of this file, plus it includes
 726          * the versions for all files that are not callable proper API modules
 727          */
 728         public function getVersion() {
 729                 $vers = array ();
 730                 $vers[] = 'MediaWiki: ' . SpecialVersion::getVersion() . "\n    http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/";
 731                 $vers[] = __CLASS__ . ': $Id$';
 732                 $vers[] = ApiBase :: getBaseVersion();
 733                 $vers[] = ApiFormatBase :: getBaseVersion();
 734                 $vers[] = ApiQueryBase :: getBaseVersion();
 735                 return $vers;
 736         }
 737
 738         /**
 739          * Add or overwrite a module in this ApiMain instance. Intended for use by extending
 740          * classes who wish to add their own modules to their lexicon or override the
 741          * behavior of inherent ones.
 742          *
 743          * @access protected
 744          * @param $mdlName String The identifier for this module.
 745          * @param $mdlClass String The class where this module is implemented.
 746          */
 747         protected function addModule( $mdlName, $mdlClass ) {
 748                 $this->mModules[$mdlName] = $mdlClass;
 749         }
 750
 751         /**
 752          * Add or overwrite an output format for this ApiMain. Intended for use by extending
 753          * classes who wish to add to or modify current formatters.
 754          *
 755          * @access protected
 756          * @param $fmtName The identifier for this format.
 757          * @param $fmtClass The class implementing this format.
 758          */
 759         protected function addFormat( $fmtName, $fmtClass ) {
 760                 $this->mFormats[$fmtName] = $fmtClass;
 761         }
 762
 763         /**
 764          * Get the array mapping module names to class names
 765          */
 766         function getModules() {
 767                 return $this->mModules;
 768         }
 769 }
 770
 771 /**
 772  * This exception will be thrown when dieUsage is called to stop module execution.
 773  * The exception handling code will print a help screen explaining how this API may be used.
 774  *
 775  * @ingroup API
 776  */
 777 class UsageException extends Exception {
 778
 779         private $mCodestr;
 780         private $mExtraData;
 781
 782         public function __construct( $message, $codestr, $code = 0, $extradata = null ) {
 783                 parent :: __construct( $message, $code );
 784                 $this->mCodestr = $codestr;
 785                 $this->mExtraData = $extradata;
 786         }
 787         public function getCodeString() {
 788                 return $this->mCodestr;
 789         }
 790         public function getMessageArray() {
 791                 $result = array (
 792                                 'code' => $this->mCodestr,
 793                                 'info' => $this->getMessage()
 794                 );
 795                 if ( is_array( $this->mExtraData ) )
 796                         $result = array_merge( $result, $this->mExtraData );
 797                 return $result;
 798         }
 799         public function __toString() {
 800                 return "{$this->getCodeString()}: {$this->getMessage()}";
 801         }
 802 }