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