includes/api/ApiMain.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Sep 4, 2006
   6  *
   7  * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  * @defgroup API API
  26  */
  27
  28 if ( !defined( 'MEDIAWIKI' ) ) {
  29         // Eclipse helper - will be ignored in production
  30         require_once( 'ApiBase.php' );
  31 }
  32
  33 /**
  34  * This is the main API class, used for both external and internal processing.
  35  * When executed, it will create the requested formatter object,
  36  * instantiate and execute an object associated with the needed action,
  37  * and use formatter to print results.
  38  * In case of an exception, an error message will be printed using the same formatter.
  39  *
  40  * To use API from another application, run it using FauxRequest object, in which
  41  * case any internal exceptions will not be handled but passed up to the caller.
  42  * After successful execution, use getResult() for the resulting data.
  43  *
  44  * @ingroup API
  45  */
  46 class ApiMain extends ApiBase {
  47
  48         /**
  49          * When no format parameter is given, this format will be used
  50          */
  51         const API_DEFAULT_FORMAT = 'xmlfm';
  52
  53         /**
  54          * List of available modules: action name => module class
  55          */
  56         private static $Modules = array(
  57                 'login' => 'ApiLogin',
  58                 'logout' => 'ApiLogout',
  59                 'query' => 'ApiQuery',
  60                 'expandtemplates' => 'ApiExpandTemplates',
  61                 'parse' => 'ApiParse',
  62                 'opensearch' => 'ApiOpenSearch',
  63                 'feedwatchlist' => 'ApiFeedWatchlist',
  64                 'help' => 'ApiHelp',
  65                 'paraminfo' => 'ApiParamInfo',
  66                 'rsd' => 'ApiRsd',
  67
  68                 // Write modules
  69                 'purge' => 'ApiPurge',
  70                 'rollback' => 'ApiRollback',
  71                 'delete' => 'ApiDelete',
  72                 'undelete' => 'ApiUndelete',
  73                 'protect' => 'ApiProtect',
  74                 'block' => 'ApiBlock',
  75                 'unblock' => 'ApiUnblock',
  76                 'move' => 'ApiMove',
  77                 'edit' => 'ApiEditPage',
  78                 'upload' => 'ApiUpload',
  79                 'emailuser' => 'ApiEmailUser',
  80                 'watch' => 'ApiWatch',
  81                 'patrol' => 'ApiPatrol',
  82                 'import' => 'ApiImport',
  83                 'userrights' => 'ApiUserrights',
  84         );
  85
  86         /**
  87          * List of available formats: format name => format class
  88          */
  89         private static $Formats = array(
  90                 'json' => 'ApiFormatJson',
  91                 'jsonfm' => 'ApiFormatJson',
  92                 'php' => 'ApiFormatPhp',
  93                 'phpfm' => 'ApiFormatPhp',
  94                 'wddx' => 'ApiFormatWddx',
  95                 'wddxfm' => 'ApiFormatWddx',
  96                 'xml' => 'ApiFormatXml',
  97                 'xmlfm' => 'ApiFormatXml',
  98                 'yaml' => 'ApiFormatYaml',
  99                 'yamlfm' => 'ApiFormatYaml',
 100                 'rawfm' => 'ApiFormatJson',
 101                 'txt' => 'ApiFormatTxt',
 102                 'txtfm' => 'ApiFormatTxt',
 103                 'dbg' => 'ApiFormatDbg',
 104                 'dbgfm' => 'ApiFormatDbg',
 105                 'dump' => 'ApiFormatDump',
 106                 'dumpfm' => 'ApiFormatDump',
 107         );
 108
 109         /**
 110          * List of user roles that are specifically relevant to the API.
 111          * array( 'right' => array ( 'msg'    => 'Some message with a $1',
 112          *                           'params' => array ( $someVarToSubst ) ),
 113          *                          );
 114          */
 115         private static $mRights = array(
 116                 'writeapi' => array(
 117                         'msg' => 'Use of the write API',
 118                         'params' => array()
 119                 ),
 120                 'apihighlimits' => array(
 121                         '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.',
 122                         'params' => array( ApiBase::LIMIT_SML2, ApiBase::LIMIT_BIG2 )
 123                 )
 124         );
 125
 126         /**
 127          * @var ApiFormatBase
 128          */
 129         private $mPrinter;
 130
 131         private $mModules, $mModuleNames, $mFormats, $mFormatNames;
 132         private $mResult, $mAction, $mShowVersions, $mEnableWrite, $mRequest;
 133         private $mInternalMode, $mSquidMaxage, $mModule;
 134
 135         private $mCacheMode = 'private';
 136         private $mCacheControl = array();
 137
 138         /**
 139          * Constructs an instance of ApiMain that utilizes the module and format specified by $request.
 140          *
 141          * @param $request WebRequest - if this is an instance of FauxRequest, errors are thrown and no printing occurs
 142          * @param $enableWrite bool should be set to true if the api may modify data
 143          */
 144         public function __construct( $request, $enableWrite = false ) {
 145                 $this->mInternalMode = ( $request instanceof FauxRequest );
 146
 147                 // Special handling for the main module: $parent === $this
 148                 parent::__construct( $this, $this->mInternalMode ? 'main_int' : 'main' );
 149
 150                 if ( !$this->mInternalMode ) {
 151                         // Impose module restrictions.
 152                         // If the current user cannot read,
 153                         // Remove all modules other than login
 154                         global $wgUser;
 155
 156                         if ( $request->getVal( 'callback' ) !== null ) {
 157                                 // JSON callback allows cross-site reads.
 158                                 // For safety, strip user credentials.
 159                                 wfDebug( "API: stripping user credentials for JSON callback\n" );
 160                                 $wgUser = new User();
 161                         }
 162                 }
 163
 164                 global $wgAPIModules; // extension modules
 165                 $this->mModules = $wgAPIModules + self::$Modules;
 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          * @return WebRequest
 191          */
 192         public function getRequest() {
 193                 return $this->mRequest;
 194         }
 195
 196         /**
 197          * Get the ApiResult object associated with current request
 198          *
 199          * @return ApiResult
 200          */
 201         public function getResult() {
 202                 return $this->mResult;
 203         }
 204
 205         /**
 206          * Get the API module object. Only works after executeAction()
 207          */
 208         public function getModule() {
 209                 return $this->mModule;
 210         }
 211
 212         /**
 213          * Get the result formatter object. Only works after setupExecuteAction()
 214          *
 215          * @return ApiFormatBase
 216          */
 217         public function getPrinter() {
 218                 return $this->mPrinter;
 219         }
 220
 221         /**
 222          * Set how long the response should be cached.
 223          */
 224         public function setCacheMaxAge( $maxage ) {
 225                 $this->setCacheControl( array(
 226                         'max-age' => $maxage,
 227                         's-maxage' => $maxage
 228                 ) );
 229         }
 230
 231         /**
 232          * Set the type of caching headers which will be sent.
 233          *
 234          * @param $mode String One of:
 235          *    - 'public':     Cache this object in public caches, if the maxage or smaxage
 236          *         parameter is set, or if setCacheMaxAge() was called. If a maximum age is
 237          *         not provided by any of these means, the object will be private.
 238          *    - 'private':    Cache this object only in private client-side caches.
 239          *    - 'anon-public-user-private': Make this object cacheable for logged-out
 240          *         users, but private for logged-in users. IMPORTANT: If this is set, it must be
 241          *         set consistently for a given URL, it cannot be set differently depending on
 242          *         things like the contents of the database, or whether the user is logged in.
 243          *
 244          *  If the wiki does not allow anonymous users to read it, the mode set here
 245          *  will be ignored, and private caching headers will always be sent. In other words,
 246          *  the "public" mode is equivalent to saying that the data sent is as public as a page
 247          *  view.
 248          *
 249          *  For user-dependent data, the private mode should generally be used. The
 250          *  anon-public-user-private mode should only be used where there is a particularly
 251          *  good performance reason for caching the anonymous response, but where the
 252          *  response to logged-in users may differ, or may contain private data.
 253          *
 254          *  If this function is never called, then the default will be the private mode.
 255          */
 256         public function setCacheMode( $mode ) {
 257                 if ( !in_array( $mode, array( 'private', 'public', 'anon-public-user-private' ) ) ) {
 258                         wfDebug( __METHOD__ . ": unrecognised cache mode \"$mode\"\n" );
 259                         // Ignore for forwards-compatibility
 260                         return;
 261                 }
 262
 263                 if ( !in_array( 'read', User::getGroupPermissions( array( '*' ) ), true ) ) {
 264                         // Private wiki, only private headers
 265                         if ( $mode !== 'private' ) {
 266                                 wfDebug( __METHOD__ . ": ignoring request for $mode cache mode, private wiki\n" );
 267                                 return;
 268                         }
 269                 }
 270
 271                 wfDebug( __METHOD__ . ": setting cache mode $mode\n" );
 272                 $this->mCacheMode = $mode;
 273         }
 274
 275         /**
 276          * @deprecated Private caching is now the default, so there is usually no
 277          * need to call this function. If there is a need, you can use
 278          * $this->setCacheMode('private')
 279          */
 280         public function setCachePrivate() {
 281                 $this->setCacheMode( 'private' );
 282         }
 283
 284         /**
 285          * Set directives (key/value pairs) for the Cache-Control header.
 286          * Boolean values will be formatted as such, by including or omitting
 287          * without an equals sign.
 288          *
 289          * Cache control values set here will only be used if the cache mode is not
 290          * private, see setCacheMode().
 291          */
 292         public function setCacheControl( $directives ) {
 293                 $this->mCacheControl = $directives + $this->mCacheControl;
 294         }
 295
 296         /**
 297          * Make sure Vary: Cookie and friends are set. Use this when the output of a request
 298          * may be cached for anons but may not be cached for logged-in users.
 299          *
 300          * WARNING: This function must be called CONSISTENTLY for a given URL. This means that a
 301          * given URL must either always or never call this function; if it sometimes does and
 302          * sometimes doesn't, stuff will break.
 303          *
 304          * @deprecated Use setCacheMode( 'anon-public-user-private' )
 305          */
 306         public function setVaryCookie() {
 307                 $this->setCacheMode( 'anon-public-user-private' );
 308         }
 309
 310         /**
 311          * Create an instance of an output formatter by its name
 312          */
 313         public function createPrinterByName( $format ) {
 314                 if ( !isset( $this->mFormats[$format] ) ) {
 315                         $this->dieUsage( "Unrecognized format: {$format}", 'unknown_format' );
 316                 }
 317                 return new $this->mFormats[$format] ( $this, $format );
 318         }
 319
 320         /**
 321          * Execute api request. Any errors will be handled if the API was called by the remote client.
 322          */
 323         public function execute() {
 324                 $this->profileIn();
 325                 if ( $this->mInternalMode ) {
 326                         $this->executeAction();
 327                 } else {
 328                         $this->executeActionWithErrorHandling();
 329                 }
 330
 331                 $this->profileOut();
 332         }
 333
 334         /**
 335          * Execute an action, and in case of an error, erase whatever partial results
 336          * have been accumulated, and replace it with an error message and a help screen.
 337          */
 338         protected function executeActionWithErrorHandling() {
 339                 // In case an error occurs during data output,
 340                 // clear the output buffer and print just the error information
 341                 ob_start();
 342
 343                 try {
 344                         $this->executeAction();
 345                 } catch ( Exception $e ) {
 346                         // Log it
 347                         if ( $e instanceof MWException ) {
 348                                 wfDebugLog( 'exception', $e->getLogMessage() );
 349                         }
 350
 351                         //
 352                         // Handle any kind of exception by outputing properly formatted error message.
 353                         // If this fails, an unhandled exception should be thrown so that global error
 354                         // handler will process and log it.
 355                         //
 356
 357                         $errCode = $this->substituteResultWithError( $e );
 358
 359                         // Error results should not be cached
 360                         $this->setCacheMode( 'private' );
 361
 362                         $headerStr = 'MediaWiki-API-Error: ' . $errCode;
 363                         if ( $e->getCode() === 0 ) {
 364                                 header( $headerStr );
 365                         } else {
 366                                 header( $headerStr, true, $e->getCode() );
 367                         }
 368
 369                         // Reset and print just the error message
 370                         ob_clean();
 371
 372                         // If the error occured during printing, do a printer->profileOut()
 373                         $this->mPrinter->safeProfileOut();
 374                         $this->printResult( true );
 375                 }
 376
 377                 // Send cache headers after any code which might generate an error, to
 378                 // avoid sending public cache headers for errors.
 379                 $this->sendCacheHeaders();
 380
 381                 if ( $this->mPrinter->getIsHtml() && !$this->mPrinter->isDisabled() ) {
 382                         echo wfReportTime();
 383                 }
 384
 385                 ob_end_flush();
 386         }
 387
 388         protected function sendCacheHeaders() {
 389                 if ( $this->mCacheMode == 'private' ) {
 390                         header( 'Cache-Control: private' );
 391                         return;
 392                 }
 393
 394                 if ( $this->mCacheMode == 'anon-public-user-private' ) {
 395                         global $wgUseXVO, $wgOut;
 396                         header( 'Vary: Accept-Encoding, Cookie' );
 397                         if ( $wgUseXVO ) {
 398                                 header( $wgOut->getXVO() );
 399                                 if ( $wgOut->haveCacheVaryCookies() ) {
 400                                         // Logged in, mark this request private
 401                                         header( 'Cache-Control: private' );
 402                                         return;
 403                                 }
 404                                 // Logged out, send normal public headers below
 405                         } elseif ( session_id() != '' ) {
 406                                 // Logged in or otherwise has session (e.g. anonymous users who have edited)
 407                                 // Mark request private
 408                                 header( 'Cache-Control: private' );
 409                                 return;
 410                         } // else no XVO and anonymous, send public headers below
 411                 }
 412
 413                 // If nobody called setCacheMaxAge(), use the (s)maxage parameters
 414                 if ( !isset( $this->mCacheControl['s-maxage'] ) ) {
 415                         $this->mCacheControl['s-maxage'] = $this->getParameter( 'smaxage' );
 416                 }
 417                 if ( !isset( $this->mCacheControl['max-age'] ) ) {
 418                         $this->mCacheControl['max-age'] = $this->getParameter( 'maxage' );
 419                 }
 420
 421                 if ( !$this->mCacheControl['s-maxage'] && !$this->mCacheControl['max-age'] ) {
 422                         // Public cache not requested
 423                         // Sending a Vary header in this case is harmless, and protects us
 424                         // against conditional calls of setCacheMaxAge().
 425                         header( 'Cache-Control: private' );
 426                         return;
 427                 }
 428
 429                 $this->mCacheControl['public'] = true;
 430
 431                 // Send an Expires header
 432                 $maxAge = min( $this->mCacheControl['s-maxage'], $this->mCacheControl['max-age'] );
 433                 $expiryUnixTime = ( $maxAge == 0 ? 1 : time() + $maxAge );
 434                 header( 'Expires: ' . wfTimestamp( TS_RFC2822, $expiryUnixTime ) );
 435
 436                 // Construct the Cache-Control header
 437                 $ccHeader = '';
 438                 $separator = '';
 439                 foreach ( $this->mCacheControl as $name => $value ) {
 440                         if ( is_bool( $value ) ) {
 441                                 if ( $value ) {
 442                                         $ccHeader .= $separator . $name;
 443                                         $separator = ', ';
 444                                 }
 445                         } else {
 446                                 $ccHeader .= $separator . "$name=$value";
 447                                 $separator = ', ';
 448                         }
 449                 }
 450
 451                 header( "Cache-Control: $ccHeader" );
 452         }
 453
 454         /**
 455          * Replace the result data with the information about an exception.
 456          * Returns the error code
 457          * @param $e Exception
 458          */
 459         protected function substituteResultWithError( $e ) {
 460                 // Printer may not be initialized if the extractRequestParams() fails for the main module
 461                 if ( !isset ( $this->mPrinter ) ) {
 462                         // The printer has not been created yet. Try to manually get formatter value.
 463                         $value = $this->getRequest()->getVal( 'format', self::API_DEFAULT_FORMAT );
 464                         if ( !in_array( $value, $this->mFormatNames ) ) {
 465                                 $value = self::API_DEFAULT_FORMAT;
 466                         }
 467
 468                         $this->mPrinter = $this->createPrinterByName( $value );
 469                         if ( $this->mPrinter->getNeedsRawData() ) {
 470                                 $this->getResult()->setRawMode();
 471                         }
 472                 }
 473
 474                 if ( $e instanceof UsageException ) {
 475                         //
 476                         // User entered incorrect parameters - print usage screen
 477                         //
 478                         $errMessage = $e->getMessageArray();
 479
 480                         // Only print the help message when this is for the developer, not runtime
 481                         if ( $this->mPrinter->getWantsHelp() || $this->mAction == 'help' ) {
 482                                 ApiResult::setContent( $errMessage, $this->makeHelpMsg() );
 483                         }
 484
 485                 } else {
 486                         global $wgShowSQLErrors, $wgShowExceptionDetails;
 487                         //
 488                         // Something is seriously wrong
 489                         //
 490                         if ( ( $e instanceof DBQueryError ) && !$wgShowSQLErrors ) {
 491                                 $info = 'Database query error';
 492                         } else {
 493                                 $info = "Exception Caught: {$e->getMessage()}";
 494                         }
 495
 496                         $errMessage = array(
 497                                 'code' => 'internal_api_error_' . get_class( $e ),
 498                                 'info' => $info,
 499                         );
 500                         ApiResult::setContent( $errMessage, $wgShowExceptionDetails ? "\n\n{$e->getTraceAsString()}\n\n" : '' );
 501                 }
 502
 503                 $this->getResult()->reset();
 504                 $this->getResult()->disableSizeCheck();
 505                 // Re-add the id
 506                 $requestid = $this->getParameter( 'requestid' );
 507                 if ( !is_null( $requestid ) ) {
 508                         $this->getResult()->addValue( null, 'requestid', $requestid );
 509                 }
 510                 // servedby is especially useful when debugging errors
 511                 $this->getResult()->addValue( null, 'servedby', wfHostName() );
 512                 $this->getResult()->addValue( null, 'error', $errMessage );
 513
 514                 return $errMessage['code'];
 515         }
 516
 517         /**
 518          * Set up for the execution.
 519          */
 520         protected function setupExecuteAction() {
 521                 // First add the id to the top element
 522                 $requestid = $this->getParameter( 'requestid' );
 523                 if ( !is_null( $requestid ) ) {
 524                         $this->getResult()->addValue( null, 'requestid', $requestid );
 525                 }
 526                 $servedby = $this->getParameter( 'servedby' );
 527                 if ( $servedby ) {
 528                         $this->getResult()->addValue( null, 'servedby', wfHostName() );
 529                 }
 530
 531                 $params = $this->extractRequestParams();
 532
 533                 $this->mShowVersions = $params['version'];
 534                 $this->mAction = $params['action'];
 535
 536                 if ( !is_string( $this->mAction ) ) {
 537                         $this->dieUsage( 'The API requires a valid action parameter', 'unknown_action' );
 538                 }
 539
 540                 return $params;
 541         }
 542
 543         /**
 544          * Set up the module for response
 545          * @return ApiBase The module that will handle this action
 546          */
 547         protected function setupModule() {
 548                 // Instantiate the module requested by the user
 549                 $module = new $this->mModules[$this->mAction] ( $this, $this->mAction );
 550                 $this->mModule = $module;
 551
 552                 $moduleParams = $module->extractRequestParams();
 553
 554                 // Die if token required, but not provided (unless there is a gettoken parameter)
 555                 $salt = $module->getTokenSalt();
 556                 if ( $salt !== false && !isset( $moduleParams['gettoken'] ) ) {
 557                         if ( !isset( $moduleParams['token'] ) ) {
 558                                 $this->dieUsageMsg( array( 'missingparam', 'token' ) );
 559                         } else {
 560                                 global $wgUser;
 561                                 if ( !$wgUser->matchEditToken( $moduleParams['token'], $salt ) ) {
 562                                         $this->dieUsageMsg( array( 'sessionfailure' ) );
 563                                 }
 564                         }
 565                 }
 566                 return $module;
 567         }
 568
 569         /**
 570          * Check the max lag if necessary
 571          * @param $module ApiBase object: Api module being used
 572          * @param $params Array an array containing the request parameters.
 573          * @return boolean True on success, false should exit immediately
 574          */
 575         protected function checkMaxLag( $module, $params ) {
 576                 if ( $module->shouldCheckMaxlag() && isset( $params['maxlag'] ) ) {
 577                         // Check for maxlag
 578                         global $wgShowHostnames;
 579                         $maxLag = $params['maxlag'];
 580                         list( $host, $lag ) = wfGetLB()->getMaxLag();
 581                         if ( $lag > $maxLag ) {
 582                                 header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
 583                                 header( 'X-Database-Lag: ' . intval( $lag ) );
 584                                 if ( $wgShowHostnames ) {
 585                                         $this->dieUsage( "Waiting for $host: $lag seconds lagged", 'maxlag' );
 586                                 } else {
 587                                         $this->dieUsage( "Waiting for a database server: $lag seconds lagged", 'maxlag' );
 588                                 }
 589                                 return false;
 590                         }
 591                 }
 592                 return true;
 593         }
 594
 595
 596         /**
 597          * Check for sufficient permissions to execute
 598          * @param $module ApiBase An Api module
 599          */
 600         protected function checkExecutePermissions( $module ) {
 601                 global $wgUser;
 602                 if ( $module->isReadMode() && !in_array( 'read', User::getGroupPermissions( array( '*' ) ), true ) &&
 603                         !$wgUser->isAllowed( 'read' ) )
 604                 {
 605                         $this->dieUsageMsg( array( 'readrequired' ) );
 606                 }
 607                 if ( $module->isWriteMode() ) {
 608                         if ( !$this->mEnableWrite ) {
 609                                 $this->dieUsageMsg( array( 'writedisabled' ) );
 610                         }
 611                         if ( !$wgUser->isAllowed( 'writeapi' ) ) {
 612                                 $this->dieUsageMsg( array( 'writerequired' ) );
 613                         }
 614                         if ( wfReadOnly() ) {
 615                                 $this->dieReadOnly();
 616                         }
 617                 }
 618         }
 619
 620         /**
 621          * Check POST for external response and setup result printer
 622          * @param $module ApiBase An Api module
 623          * @param $params Array an array with the request parameters
 624          */
 625         protected function setupExternalResponse( $module, $params ) {
 626                 // Ignore mustBePosted() for internal calls
 627                 if ( $module->mustBePosted() && !$this->mRequest->wasPosted() ) {
 628                         $this->dieUsageMsg( array( 'mustbeposted', $this->mAction ) );
 629                 }
 630
 631                 // See if custom printer is used
 632                 $this->mPrinter = $module->getCustomPrinter();
 633                 if ( is_null( $this->mPrinter ) ) {
 634                         // Create an appropriate printer
 635                         $this->mPrinter = $this->createPrinterByName( $params['format'] );
 636                 }
 637
 638                 if ( $this->mPrinter->getNeedsRawData() ) {
 639                         $this->getResult()->setRawMode();
 640                 }
 641         }
 642
 643         /**
 644          * Execute the actual module, without any error handling
 645          */
 646         protected function executeAction() {
 647                 $params = $this->setupExecuteAction();
 648                 $module = $this->setupModule();
 649
 650                 $this->checkExecutePermissions( $module );
 651
 652                 if ( !$this->checkMaxLag( $module, $params ) ) {
 653                         return;
 654                 }
 655
 656                 if ( !$this->mInternalMode ) {
 657                         $this->setupExternalResponse( $module, $params );
 658                 }
 659
 660                 // Execute
 661                 $module->profileIn();
 662                 $module->execute();
 663                 wfRunHooks( 'APIAfterExecute', array( &$module ) );
 664                 $module->profileOut();
 665
 666                 if ( !$this->mInternalMode ) {
 667                         // Print result data
 668                         $this->printResult( false );
 669                 }
 670         }
 671
 672         /**
 673          * Print results using the current printer
 674          */
 675         protected function printResult( $isError ) {
 676                 $this->getResult()->cleanUpUTF8();
 677                 $printer = $this->mPrinter;
 678                 $printer->profileIn();
 679
 680                 /**
 681                  * If the help message is requested in the default (xmlfm) format,
 682                  * tell the printer not to escape ampersands so that our links do
 683                  * not break.
 684                  */
 685                 $printer->setUnescapeAmps( ( $this->mAction == 'help' || $isError )
 686                                 && $printer->getFormat() == 'XML' && $printer->getIsHtml() );
 687
 688                 $printer->initPrinter( $isError );
 689
 690                 $printer->execute();
 691                 $printer->closePrinter();
 692                 $printer->profileOut();
 693         }
 694
 695         public function isReadMode() {
 696                 return false;
 697         }
 698
 699         /**
 700          * See ApiBase for description.
 701          */
 702         public function getAllowedParams() {
 703                 return array(
 704                         'format' => array(
 705                                 ApiBase::PARAM_DFLT => ApiMain::API_DEFAULT_FORMAT,
 706                                 ApiBase::PARAM_TYPE => $this->mFormatNames
 707                         ),
 708                         'action' => array(
 709                                 ApiBase::PARAM_DFLT => 'help',
 710                                 ApiBase::PARAM_TYPE => $this->mModuleNames
 711                         ),
 712                         'version' => false,
 713                         'maxlag'  => array(
 714                                 ApiBase::PARAM_TYPE => 'integer'
 715                         ),
 716                         'smaxage' => array(
 717                                 ApiBase::PARAM_TYPE => 'integer',
 718                                 ApiBase::PARAM_DFLT => 0
 719                         ),
 720                         'maxage' => array(
 721                                 ApiBase::PARAM_TYPE => 'integer',
 722                                 ApiBase::PARAM_DFLT => 0
 723                         ),
 724                         'requestid' => null,
 725                         'servedby'  => false,
 726                 );
 727         }
 728
 729         /**
 730          * See ApiBase for description.
 731          */
 732         public function getParamDescription() {
 733                 return array(
 734                         'format' => 'The format of the output',
 735                         'action' => 'What action you would like to perform. See below for module help',
 736                         'version' => 'When showing help, include version for each module',
 737                         'maxlag' => 'Maximum lag',
 738                         'smaxage' => 'Set the s-maxage header to this many seconds. Errors are never cached',
 739                         'maxage' => 'Set the max-age header to this many seconds. Errors are never cached',
 740                         'requestid' => 'Request ID to distinguish requests. This will just be output back to you',
 741                         'servedby' => 'Include the hostname that served the request in the results. Unconditionally shown on error',
 742                 );
 743         }
 744
 745         /**
 746          * See ApiBase for description.
 747          */
 748         public function getDescription() {
 749                 return array(
 750                         '',
 751                         '',
 752                         '******************************************************************************************',
 753                         '**                                                                                      **',
 754                         '**              This is an auto-generated MediaWiki API documentation page              **',
 755                         '**                                                                                      **',
 756                         '**                            Documentation and Examples:                               **',
 757                         '**                         http://www.mediawiki.org/wiki/API                            **',
 758                         '**                                                                                      **',
 759                         '******************************************************************************************',
 760                         '',
 761                         'Status:                All features shown on this page should be working, but the API',
 762                         '                       is still in active development, and  may change at any time.',
 763                         '                       Make sure to monitor our mailing list for any updates',
 764                         '',
 765                         'Documentation:         http://www.mediawiki.org/wiki/API',
 766                         'Mailing list:          http://lists.wikimedia.org/mailman/listinfo/mediawiki-api',
 767                         'Api Announcements:     http://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce',
 768                         'Bugs & Requests:       http://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts',
 769                         '',
 770                         '',
 771                         '',
 772                         '',
 773                         '',
 774                 );
 775         }
 776
 777         public function getPossibleErrors() {
 778                 return array_merge( parent::getPossibleErrors(), array(
 779                         array( 'readonlytext' ),
 780                         array( 'code' => 'unknown_format', 'info' => 'Unrecognized format: format' ),
 781                         array( 'code' => 'unknown_action', 'info' => 'The API requires a valid action parameter' ),
 782                         array( 'code' => 'maxlag', 'info' => 'Waiting for host: x seconds lagged' ),
 783                         array( 'code' => 'maxlag', 'info' => 'Waiting for a database server: x seconds lagged' ),
 784                 ) );
 785         }
 786
 787         /**
 788          * Returns an array of strings with credits for the API
 789          */
 790         protected function getCredits() {
 791                 return array(
 792                         'API developers:',
 793                         '    Roan Kattouw <Firstname>.<Lastname>@gmail.com (lead developer Sep 2007-present)',
 794                         '    Victor Vasiliev - vasilvv at gee mail dot com',
 795                         '    Bryan Tong Minh - bryan . tongminh @ gmail . com',
 796                         '    Sam Reed - sam @ reedyboy . net',
 797                         '    Yuri Astrakhan <Firstname><Lastname>@gmail.com (creator, lead developer Sep 2006-Sep 2007)',
 798                         '',
 799                         'Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org',
 800                         'or file a bug report at http://bugzilla.wikimedia.org/'
 801                 );
 802         }
 803         /**
 804          * Sets whether the pretty-printer should format *bold* and $italics$
 805          */
 806         public function setHelp( $help = true ) {
 807                 $this->mPrinter->setHelp( $help );
 808         }
 809
 810         /**
 811          * Override the parent to generate help messages for all available modules.
 812          */
 813         public function makeHelpMsg() {
 814                 global $wgMemc, $wgAPICacheHelp, $wgAPICacheHelpTimeout;
 815                 $this->setHelp();
 816                 // Get help text from cache if present
 817                 $key = wfMemcKey( 'apihelp', $this->getModuleName(),
 818                         SpecialVersion::getVersion( 'nodb' ) .
 819                         $this->getMain()->getShowVersions() );
 820                 if ( $wgAPICacheHelp ) {
 821                         $cached = $wgMemc->get( $key );
 822                         if ( $cached ) {
 823                                 return $cached;
 824                         }
 825                 }
 826                 $retval = $this->reallyMakeHelpMsg();
 827                 if ( $wgAPICacheHelp ) {
 828                         $wgMemc->set( $key, $retval, $wgAPICacheHelpTimeout );
 829                 }
 830                 return $retval;
 831         }
 832
 833         public function reallyMakeHelpMsg() {
 834                 $this->setHelp();
 835
 836                 // Use parent to make default message for the main module
 837                 $msg = parent::makeHelpMsg();
 838
 839                 $astriks = str_repeat( '*** ', 10 );
 840                 $msg .= "\n\n$astriks Modules  $astriks\n\n";
 841                 foreach ( array_keys( $this->mModules ) as $moduleName ) {
 842                         $module = new $this->mModules[$moduleName] ( $this, $moduleName );
 843                         $msg .= self::makeHelpMsgHeader( $module, 'action' );
 844                         $msg2 = $module->makeHelpMsg();
 845                         if ( $msg2 !== false ) {
 846                                 $msg .= $msg2;
 847                         }
 848                         $msg .= "\n";
 849                 }
 850
 851                 $msg .= "\n$astriks Permissions $astriks\n\n";
 852                 foreach ( self::$mRights as $right => $rightMsg ) {
 853                         $groups = User::getGroupsWithPermission( $right );
 854                         $msg .= "* " . $right . " *\n  " . wfMsgReplaceArgs( $rightMsg[ 'msg' ], $rightMsg[ 'params' ] ) .
 855                                                 "\nGranted to:\n  " . str_replace( '*', 'all', implode( ', ', $groups ) ) . "\n\n";
 856
 857                 }
 858
 859                 $msg .= "\n$astriks Formats  $astriks\n\n";
 860                 foreach ( array_keys( $this->mFormats ) as $formatName ) {
 861                         $module = $this->createPrinterByName( $formatName );
 862                         $msg .= self::makeHelpMsgHeader( $module, 'format' );
 863                         $msg2 = $module->makeHelpMsg();
 864                         if ( $msg2 !== false ) {
 865                                 $msg .= $msg2;
 866                         }
 867                         $msg .= "\n";
 868                 }
 869
 870                 $msg .= "\n*** Credits: ***\n   " . implode( "\n   ", $this->getCredits() ) . "\n";
 871
 872                 return $msg;
 873         }
 874
 875         /**
 876          * @static
 877          * @param  $module ApiBase
 878          * @param  $paramName String What type of request is this? e.g. action, query, list, prop, meta, format
 879          * @return string
 880          */
 881         public static function makeHelpMsgHeader( $module, $paramName ) {
 882                 $modulePrefix = $module->getModulePrefix();
 883                 if ( strval( $modulePrefix ) !== '' ) {
 884                         $modulePrefix = "($modulePrefix) ";
 885                 }
 886
 887                 return "* $paramName={$module->getModuleName()} $modulePrefix*";
 888         }
 889
 890         private $mIsBot = null;
 891         private $mIsSysop = null;
 892         private $mCanApiHighLimits = null;
 893
 894         /**
 895          * Returns true if the currently logged in user is a bot, false otherwise
 896          * OBSOLETE, use canApiHighLimits() instead
 897          */
 898         public function isBot() {
 899                 if ( !isset( $this->mIsBot ) ) {
 900                         global $wgUser;
 901                         $this->mIsBot = $wgUser->isAllowed( 'bot' );
 902                 }
 903                 return $this->mIsBot;
 904         }
 905
 906         /**
 907          * Similar to isBot(), this method returns true if the logged in user is
 908          * a sysop, and false if not.
 909          * OBSOLETE, use canApiHighLimits() instead
 910          */
 911         public function isSysop() {
 912                 if ( !isset( $this->mIsSysop ) ) {
 913                         global $wgUser;
 914                         $this->mIsSysop = in_array( 'sysop', $wgUser->getGroups() );
 915                 }
 916
 917                 return $this->mIsSysop;
 918         }
 919
 920         /**
 921          * Check whether the current user is allowed to use high limits
 922          * @return bool
 923          */
 924         public function canApiHighLimits() {
 925                 if ( !isset( $this->mCanApiHighLimits ) ) {
 926                         global $wgUser;
 927                         $this->mCanApiHighLimits = $wgUser->isAllowed( 'apihighlimits' );
 928                 }
 929
 930                 return $this->mCanApiHighLimits;
 931         }
 932
 933         /**
 934          * Check whether the user wants us to show version information in the API help
 935          * @return bool
 936          */
 937         public function getShowVersions() {
 938                 return $this->mShowVersions;
 939         }
 940
 941         /**
 942          * Returns the version information of this file, plus it includes
 943          * the versions for all files that are not callable proper API modules
 944          */
 945         public function getVersion() {
 946                 $vers = array ();
 947                 $vers[] = 'MediaWiki: ' . SpecialVersion::getVersion() . "\n    http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/";
 948                 $vers[] = __CLASS__ . ': $Id$';
 949                 $vers[] = ApiBase::getBaseVersion();
 950                 $vers[] = ApiFormatBase::getBaseVersion();
 951                 $vers[] = ApiQueryBase::getBaseVersion();
 952                 return $vers;
 953         }
 954
 955         /**
 956          * Add or overwrite a module in this ApiMain instance. Intended for use by extending
 957          * classes who wish to add their own modules to their lexicon or override the
 958          * behavior of inherent ones.
 959          *
 960          * @param $mdlName String The identifier for this module.
 961          * @param $mdlClass String The class where this module is implemented.
 962          */
 963         protected function addModule( $mdlName, $mdlClass ) {
 964                 $this->mModules[$mdlName] = $mdlClass;
 965         }
 966
 967         /**
 968          * Add or overwrite an output format for this ApiMain. Intended for use by extending
 969          * classes who wish to add to or modify current formatters.
 970          *
 971          * @param $fmtName The identifier for this format.
 972          * @param $fmtClass The class implementing this format.
 973          */
 974         protected function addFormat( $fmtName, $fmtClass ) {
 975                 $this->mFormats[$fmtName] = $fmtClass;
 976         }
 977
 978         /**
 979          * Get the array mapping module names to class names
 980          */
 981         function getModules() {
 982                 return $this->mModules;
 983         }
 984 }
 985
 986 /**
 987  * This exception will be thrown when dieUsage is called to stop module execution.
 988  * The exception handling code will print a help screen explaining how this API may be used.
 989  *
 990  * @ingroup API
 991  */
 992 class UsageException extends Exception {
 993
 994         private $mCodestr;
 995         private $mExtraData;
 996
 997         public function __construct( $message, $codestr, $code = 0, $extradata = null ) {
 998                 parent::__construct( $message, $code );
 999                 $this->mCodestr = $codestr;
1000                 $this->mExtraData = $extradata;
1001         }
1002
1003         public function getCodeString() {
1004                 return $this->mCodestr;
1005         }
1006
1007         public function getMessageArray() {
1008                 $result = array(
1009                         'code' => $this->mCodestr,
1010                         'info' => $this->getMessage()
1011                 );
1012                 if ( is_array( $this->mExtraData ) ) {
1013                         $result = array_merge( $result, $this->mExtraData );
1014                 }
1015                 return $result;
1016         }
1017
1018         public function __toString() {
1019                 return "{$this->getCodeString()}: {$this->getMessage()}";
1020         }
1021 }