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 /**
  29  * This is the main API class, used for both external and internal processing.
  30  * When executed, it will create the requested formatter object,
  31  * instantiate and execute an object associated with the needed action,
  32  * and use formatter to print results.
  33  * In case of an exception, an error message will be printed using the same formatter.
  34  *
  35  * To use API from another application, run it using FauxRequest object, in which
  36  * case any internal exceptions will not be handled but passed up to the caller.
  37  * After successful execution, use getResult() for the resulting data.
  38  *
  39  * @ingroup API
  40  */
  41 class ApiMain extends ApiBase {
  42
  43         /**
  44          * When no format parameter is given, this format will be used
  45          */
  46         const API_DEFAULT_FORMAT = 'xmlfm';
  47
  48         /**
  49          * List of available modules: action name => module class
  50          */
  51         private static $Modules = array(
  52                 'login' => 'ApiLogin',
  53                 'logout' => 'ApiLogout',
  54                 'query' => 'ApiQuery',
  55                 'expandtemplates' => 'ApiExpandTemplates',
  56                 'parse' => 'ApiParse',
  57                 'opensearch' => 'ApiOpenSearch',
  58                 'feedcontributions' => 'ApiFeedContributions',
  59                 'feedwatchlist' => 'ApiFeedWatchlist',
  60                 'help' => 'ApiHelp',
  61                 'paraminfo' => 'ApiParamInfo',
  62                 'rsd' => 'ApiRsd',
  63                 'compare' => 'ApiComparePages',
  64                 'tokens' => 'ApiTokens',
  65
  66                 // Write modules
  67                 'purge' => 'ApiPurge',
  68                 'setnotificationtimestamp' => 'ApiSetNotificationTimestamp',
  69                 'rollback' => 'ApiRollback',
  70                 'delete' => 'ApiDelete',
  71                 'undelete' => 'ApiUndelete',
  72                 'protect' => 'ApiProtect',
  73                 'block' => 'ApiBlock',
  74                 'unblock' => 'ApiUnblock',
  75                 'move' => 'ApiMove',
  76                 'edit' => 'ApiEditPage',
  77                 'upload' => 'ApiUpload',
  78                 'filerevert' => 'ApiFileRevert',
  79                 'emailuser' => 'ApiEmailUser',
  80                 'watch' => 'ApiWatch',
  81                 'patrol' => 'ApiPatrol',
  82                 'import' => 'ApiImport',
  83                 'userrights' => 'ApiUserrights',
  84                 'options' => 'ApiOptions',
  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                 'dump' => 'ApiFormatDump',
 107                 'dumpfm' => 'ApiFormatDump',
 108         );
 109
 110         /**
 111          * List of user roles that are specifically relevant to the API.
 112          * array( 'right' => array ( 'msg'    => 'Some message with a $1',
 113          *                           'params' => array ( $someVarToSubst ) ),
 114          *                          );
 115          */
 116         private static $mRights = array(
 117                 'writeapi' => array(
 118                         'msg' => 'Use of the write API',
 119                         'params' => array()
 120                 ),
 121                 'apihighlimits' => array(
 122                         '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.',
 123                         'params' => array( ApiBase::LIMIT_SML2, ApiBase::LIMIT_BIG2 )
 124                 )
 125         );
 126
 127         /**
 128          * @var ApiFormatBase
 129          */
 130         private $mPrinter;
 131
 132         private $mModules, $mModuleNames, $mFormats, $mFormatNames;
 133         private $mResult, $mAction, $mShowVersions, $mEnableWrite;
 134         private $mInternalMode, $mSquidMaxage, $mModule;
 135
 136         private $mCacheMode = 'private';
 137         private $mCacheControl = array();
 138         private $mParamsUsed = array();
 139
 140         /**
 141          * Constructs an instance of ApiMain that utilizes the module and format specified by $request.
 142          *
 143          * @param $context IContextSource|WebRequest - if this is an instance of FauxRequest, errors are thrown and no printing occurs
 144          * @param $enableWrite bool should be set to true if the api may modify data
 145          */
 146         public function __construct( $context = null, $enableWrite = false ) {
 147                 if ( $context === null ) {
 148                         $context = RequestContext::getMain();
 149                 } elseif ( $context instanceof WebRequest ) {
 150                         // BC for pre-1.19
 151                         $request = $context;
 152                         $context = RequestContext::getMain();
 153                 }
 154                 // We set a derivative context so we can change stuff later
 155                 $this->setContext( new DerivativeContext( $context ) );
 156
 157                 if ( isset( $request ) ) {
 158                         $this->getContext()->setRequest( $request );
 159                 }
 160
 161                 $this->mInternalMode = ( $this->getRequest() instanceof FauxRequest );
 162
 163                 // Special handling for the main module: $parent === $this
 164                 parent::__construct( $this, $this->mInternalMode ? 'main_int' : 'main' );
 165
 166                 if ( !$this->mInternalMode ) {
 167                         // Impose module restrictions.
 168                         // If the current user cannot read,
 169                         // Remove all modules other than login
 170                         global $wgUser;
 171
 172                         if ( $this->getVal( 'callback' ) !== null ) {
 173                                 // JSON callback allows cross-site reads.
 174                                 // For safety, strip user credentials.
 175                                 wfDebug( "API: stripping user credentials for JSON callback\n" );
 176                                 $wgUser = new User();
 177                                 $this->getContext()->setUser( $wgUser );
 178                         }
 179                 }
 180
 181                 global $wgAPIModules; // extension modules
 182                 $this->mModules = $wgAPIModules + self::$Modules;
 183
 184                 $this->mModuleNames = array_keys( $this->mModules );
 185                 $this->mFormats = self::$Formats;
 186                 $this->mFormatNames = array_keys( $this->mFormats );
 187
 188                 $this->mResult = new ApiResult( $this );
 189                 $this->mShowVersions = false;
 190                 $this->mEnableWrite = $enableWrite;
 191
 192                 $this->mSquidMaxage = - 1; // flag for executeActionWithErrorHandling()
 193                 $this->mCommit = false;
 194         }
 195
 196         /**
 197          * Return true if the API was started by other PHP code using FauxRequest
 198          * @return bool
 199          */
 200         public function isInternalMode() {
 201                 return $this->mInternalMode;
 202         }
 203
 204         /**
 205          * Get the ApiResult object associated with current request
 206          *
 207          * @return ApiResult
 208          */
 209         public function getResult() {
 210                 return $this->mResult;
 211         }
 212
 213         /**
 214          * Get the API module object. Only works after executeAction()
 215          *
 216          * @return ApiBase
 217          */
 218         public function getModule() {
 219                 return $this->mModule;
 220         }
 221
 222         /**
 223          * Get the result formatter object. Only works after setupExecuteAction()
 224          *
 225          * @return ApiFormatBase
 226          */
 227         public function getPrinter() {
 228                 return $this->mPrinter;
 229         }
 230
 231         /**
 232          * Set how long the response should be cached.
 233          *
 234          * @param $maxage
 235          */
 236         public function setCacheMaxAge( $maxage ) {
 237                 $this->setCacheControl( array(
 238                         'max-age' => $maxage,
 239                         's-maxage' => $maxage
 240                 ) );
 241         }
 242
 243         /**
 244          * Set the type of caching headers which will be sent.
 245          *
 246          * @param $mode String One of:
 247          *    - 'public':     Cache this object in public caches, if the maxage or smaxage
 248          *         parameter is set, or if setCacheMaxAge() was called. If a maximum age is
 249          *         not provided by any of these means, the object will be private.
 250          *    - 'private':    Cache this object only in private client-side caches.
 251          *    - 'anon-public-user-private': Make this object cacheable for logged-out
 252          *         users, but private for logged-in users. IMPORTANT: If this is set, it must be
 253          *         set consistently for a given URL, it cannot be set differently depending on
 254          *         things like the contents of the database, or whether the user is logged in.
 255          *
 256          *  If the wiki does not allow anonymous users to read it, the mode set here
 257          *  will be ignored, and private caching headers will always be sent. In other words,
 258          *  the "public" mode is equivalent to saying that the data sent is as public as a page
 259          *  view.
 260          *
 261          *  For user-dependent data, the private mode should generally be used. The
 262          *  anon-public-user-private mode should only be used where there is a particularly
 263          *  good performance reason for caching the anonymous response, but where the
 264          *  response to logged-in users may differ, or may contain private data.
 265          *
 266          *  If this function is never called, then the default will be the private mode.
 267          */
 268         public function setCacheMode( $mode ) {
 269                 if ( !in_array( $mode, array( 'private', 'public', 'anon-public-user-private' ) ) ) {
 270                         wfDebug( __METHOD__ . ": unrecognised cache mode \"$mode\"\n" );
 271                         // Ignore for forwards-compatibility
 272                         return;
 273                 }
 274
 275                 if ( !in_array( 'read', User::getGroupPermissions( array( '*' ) ), true ) ) {
 276                         // Private wiki, only private headers
 277                         if ( $mode !== 'private' ) {
 278                                 wfDebug( __METHOD__ . ": ignoring request for $mode cache mode, private wiki\n" );
 279                                 return;
 280                         }
 281                 }
 282
 283                 wfDebug( __METHOD__ . ": setting cache mode $mode\n" );
 284                 $this->mCacheMode = $mode;
 285         }
 286
 287         /**
 288          * @deprecated since 1.17 Private caching is now the default, so there is usually no
 289          * need to call this function. If there is a need, you can use
 290          * $this->setCacheMode('private')
 291          */
 292         public function setCachePrivate() {
 293                 wfDeprecated( __METHOD__, '1.17' );
 294                 $this->setCacheMode( 'private' );
 295         }
 296
 297         /**
 298          * Set directives (key/value pairs) for the Cache-Control header.
 299          * Boolean values will be formatted as such, by including or omitting
 300          * without an equals sign.
 301          *
 302          * Cache control values set here will only be used if the cache mode is not
 303          * private, see setCacheMode().
 304          *
 305          * @param $directives array
 306          */
 307         public function setCacheControl( $directives ) {
 308                 $this->mCacheControl = $directives + $this->mCacheControl;
 309         }
 310
 311         /**
 312          * Make sure Vary: Cookie and friends are set. Use this when the output of a request
 313          * may be cached for anons but may not be cached for logged-in users.
 314          *
 315          * WARNING: This function must be called CONSISTENTLY for a given URL. This means that a
 316          * given URL must either always or never call this function; if it sometimes does and
 317          * sometimes doesn't, stuff will break.
 318          *
 319          * @deprecated since 1.17 Use setCacheMode( 'anon-public-user-private' )
 320          */
 321         public function setVaryCookie() {
 322                 wfDeprecated( __METHOD__, '1.17' );
 323                 $this->setCacheMode( 'anon-public-user-private' );
 324         }
 325
 326         /**
 327          * Create an instance of an output formatter by its name
 328          *
 329          * @param $format string
 330          *
 331          * @return ApiFormatBase
 332          */
 333         public function createPrinterByName( $format ) {
 334                 if ( !isset( $this->mFormats[$format] ) ) {
 335                         $this->dieUsage( "Unrecognized format: {$format}", 'unknown_format' );
 336                 }
 337                 return new $this->mFormats[$format] ( $this, $format );
 338         }
 339
 340         /**
 341          * Execute api request. Any errors will be handled if the API was called by the remote client.
 342          */
 343         public function execute() {
 344                 $this->profileIn();
 345                 if ( $this->mInternalMode ) {
 346                         $this->executeAction();
 347                 } else {
 348                         $this->executeActionWithErrorHandling();
 349                 }
 350
 351                 $this->profileOut();
 352         }
 353
 354         /**
 355          * Execute an action, and in case of an error, erase whatever partial results
 356          * have been accumulated, and replace it with an error message and a help screen.
 357          */
 358         protected function executeActionWithErrorHandling() {
 359                 // Verify the CORS header before executing the action
 360                 if ( !$this->handleCORS() ) {
 361                         // handleCORS() has sent a 403, abort
 362                         return;
 363                 }
 364
 365                 // In case an error occurs during data output,
 366                 // clear the output buffer and print just the error information
 367                 ob_start();
 368
 369                 $t = microtime( true );
 370                 try {
 371                         $this->executeAction();
 372                 } catch ( Exception $e ) {
 373                         // Allow extra cleanup and logging
 374                         wfRunHooks( 'ApiMain::onException', array( $this, $e ) );
 375
 376                         // Log it
 377                         if ( !( $e instanceof UsageException ) ) {
 378                                 wfDebugLog( 'exception', $e->getLogMessage() );
 379                         }
 380
 381                         // Handle any kind of exception by outputing properly formatted error message.
 382                         // If this fails, an unhandled exception should be thrown so that global error
 383                         // handler will process and log it.
 384
 385                         $errCode = $this->substituteResultWithError( $e );
 386
 387                         // Error results should not be cached
 388                         $this->setCacheMode( 'private' );
 389
 390                         $response = $this->getRequest()->response();
 391                         $headerStr = 'MediaWiki-API-Error: ' . $errCode;
 392                         if ( $e->getCode() === 0 ) {
 393                                 $response->header( $headerStr );
 394                         } else {
 395                                 $response->header( $headerStr, true, $e->getCode() );
 396                         }
 397
 398                         // Reset and print just the error message
 399                         ob_clean();
 400
 401                         // If the error occurred during printing, do a printer->profileOut()
 402                         $this->mPrinter->safeProfileOut();
 403                         $this->printResult( true );
 404                 }
 405
 406                 // Log the request whether or not there was an error
 407                 $this->logRequest( microtime( true ) - $t);
 408
 409                 // Send cache headers after any code which might generate an error, to
 410                 // avoid sending public cache headers for errors.
 411                 $this->sendCacheHeaders();
 412
 413                 if ( $this->mPrinter->getIsHtml() && !$this->mPrinter->isDisabled() ) {
 414                         echo wfReportTime();
 415                 }
 416
 417                 ob_end_flush();
 418         }
 419
 420         /**
 421          * Check the &origin= query parameter against the Origin: HTTP header and respond appropriately.
 422          *
 423          * If no origin parameter is present, nothing happens.
 424          * If an origin parameter is present but doesn't match the Origin header, a 403 status code
 425          * is set and false is returned.
 426          * If the parameter and the header do match, the header is checked against $wgCrossSiteAJAXdomains
 427          * and $wgCrossSiteAJAXdomainExceptions, and if the origin qualifies, the appropriate CORS
 428          * headers are set.
 429          *
 430          * @return bool False if the caller should abort (403 case), true otherwise (all other cases)
 431          */
 432         protected function handleCORS() {
 433                 global $wgCrossSiteAJAXdomains, $wgCrossSiteAJAXdomainExceptions;
 434
 435                 $originParam = $this->getParameter( 'origin' ); // defaults to null
 436                 if ( $originParam === null ) {
 437                         // No origin parameter, nothing to do
 438                         return true;
 439                 }
 440
 441                 $request = $this->getRequest();
 442                 $response = $request->response();
 443                 // Origin: header is a space-separated list of origins, check all of them
 444                 $originHeader = $request->getHeader( 'Origin' );
 445                 if ( $originHeader === false ) {
 446                         $origins = array();
 447                 } else {
 448                         $origins = explode( ' ', $originHeader );
 449                 }
 450                 if ( !in_array( $originParam, $origins ) ) {
 451                         // origin parameter set but incorrect
 452                         // Send a 403 response
 453                         $message = HttpStatus::getMessage( 403 );
 454                         $response->header( "HTTP/1.1 403 $message", true, 403 );
 455                         $response->header( 'Cache-Control: no-cache' );
 456                         echo "'origin' parameter does not match Origin header\n";
 457                         return false;
 458                 }
 459                 if ( self::matchOrigin( $originParam, $wgCrossSiteAJAXdomains, $wgCrossSiteAJAXdomainExceptions ) ) {
 460                         $response->header( "Access-Control-Allow-Origin: $originParam" );
 461                         $response->header( 'Access-Control-Allow-Credentials: true' );
 462                         $this->getOutput()->addVaryHeader( 'Origin' );
 463                 }
 464                 return true;
 465         }
 466
 467         /**
 468          * Attempt to match an Origin header against a set of rules and a set of exceptions
 469          * @param $value string Origin header
 470          * @param $rules array Set of wildcard rules
 471          * @param $exceptions array Set of wildcard rules
 472          * @return bool True if $value matches a rule in $rules and doesn't match any rules in $exceptions, false otherwise
 473          */
 474         protected static function matchOrigin( $value, $rules, $exceptions ) {
 475                 foreach ( $rules as $rule ) {
 476                         if ( preg_match( self::wildcardToRegex( $rule ), $value ) ) {
 477                                 // Rule matches, check exceptions
 478                                 foreach ( $exceptions as $exc ) {
 479                                         if ( preg_match( self::wildcardToRegex( $exc ), $value ) ) {
 480                                                 return false;
 481                                         }
 482                                 }
 483                                 return true;
 484                         }
 485                 }
 486                 return false;
 487         }
 488
 489         /**
 490          * Helper function to convert wildcard string into a regex
 491          * '*' => '.*?'
 492          * '?' => '.'
 493          *
 494          * @param $wildcard string String with wildcards
 495          * @return string Regular expression
 496          */
 497         protected static function wildcardToRegex( $wildcard ) {
 498                 $wildcard = preg_quote( $wildcard, '/' );
 499                 $wildcard = str_replace(
 500                         array( '\*', '\?' ),
 501                         array( '.*?', '.' ),
 502                         $wildcard
 503                 );
 504                 return "/https?:\/\/$wildcard/";
 505         }
 506
 507         protected function sendCacheHeaders() {
 508                 global $wgUseXVO, $wgVaryOnXFP;
 509                 $response = $this->getRequest()->response();
 510                 $out = $this->getOutput();
 511
 512                 if ( $wgVaryOnXFP ) {
 513                         $out->addVaryHeader( 'X-Forwarded-Proto' );
 514                 }
 515
 516                 if ( $this->mCacheMode == 'private' ) {
 517                         $response->header( 'Cache-Control: private' );
 518                         return;
 519                 }
 520
 521                 if ( $this->mCacheMode == 'anon-public-user-private' ) {
 522                         $out->addVaryHeader( 'Cookie' );
 523                         $response->header( $out->getVaryHeader() );
 524                         if ( $wgUseXVO ) {
 525                                 $response->header( $out->getXVO() );
 526                                 if ( $out->haveCacheVaryCookies() ) {
 527                                         // Logged in, mark this request private
 528                                         $response->header( 'Cache-Control: private' );
 529                                         return;
 530                                 }
 531                                 // Logged out, send normal public headers below
 532                         } elseif ( session_id() != '' ) {
 533                                 // Logged in or otherwise has session (e.g. anonymous users who have edited)
 534                                 // Mark request private
 535                                 $response->header( 'Cache-Control: private' );
 536                                 return;
 537                         } // else no XVO and anonymous, send public headers below
 538                 }
 539
 540                 // Send public headers
 541                 $response->header( $out->getVaryHeader() );
 542                 if ( $wgUseXVO ) {
 543                         $response->header( $out->getXVO() );
 544                 }
 545
 546                 // If nobody called setCacheMaxAge(), use the (s)maxage parameters
 547                 if ( !isset( $this->mCacheControl['s-maxage'] ) ) {
 548                         $this->mCacheControl['s-maxage'] = $this->getParameter( 'smaxage' );
 549                 }
 550                 if ( !isset( $this->mCacheControl['max-age'] ) ) {
 551                         $this->mCacheControl['max-age'] = $this->getParameter( 'maxage' );
 552                 }
 553
 554                 if ( !$this->mCacheControl['s-maxage'] && !$this->mCacheControl['max-age'] ) {
 555                         // Public cache not requested
 556                         // Sending a Vary header in this case is harmless, and protects us
 557                         // against conditional calls of setCacheMaxAge().
 558                         $response->header( 'Cache-Control: private' );
 559                         return;
 560                 }
 561
 562                 $this->mCacheControl['public'] = true;
 563
 564                 // Send an Expires header
 565                 $maxAge = min( $this->mCacheControl['s-maxage'], $this->mCacheControl['max-age'] );
 566                 $expiryUnixTime = ( $maxAge == 0 ? 1 : time() + $maxAge );
 567                 $response->header( 'Expires: ' . wfTimestamp( TS_RFC2822, $expiryUnixTime ) );
 568
 569                 // Construct the Cache-Control header
 570                 $ccHeader = '';
 571                 $separator = '';
 572                 foreach ( $this->mCacheControl as $name => $value ) {
 573                         if ( is_bool( $value ) ) {
 574                                 if ( $value ) {
 575                                         $ccHeader .= $separator . $name;
 576                                         $separator = ', ';
 577                                 }
 578                         } else {
 579                                 $ccHeader .= $separator . "$name=$value";
 580                                 $separator = ', ';
 581                         }
 582                 }
 583
 584                 $response->header( "Cache-Control: $ccHeader" );
 585         }
 586
 587         /**
 588          * Replace the result data with the information about an exception.
 589          * Returns the error code
 590          * @param $e Exception
 591          * @return string
 592          */
 593         protected function substituteResultWithError( $e ) {
 594                 global $wgShowHostnames;
 595
 596                 $result = $this->getResult();
 597                 // Printer may not be initialized if the extractRequestParams() fails for the main module
 598                 if ( !isset ( $this->mPrinter ) ) {
 599                         // The printer has not been created yet. Try to manually get formatter value.
 600                         $value = $this->getRequest()->getVal( 'format', self::API_DEFAULT_FORMAT );
 601                         if ( !in_array( $value, $this->mFormatNames ) ) {
 602                                 $value = self::API_DEFAULT_FORMAT;
 603                         }
 604
 605                         $this->mPrinter = $this->createPrinterByName( $value );
 606                         if ( $this->mPrinter->getNeedsRawData() ) {
 607                                 $result->setRawMode();
 608                         }
 609                 }
 610
 611                 if ( $e instanceof UsageException ) {
 612                         // User entered incorrect parameters - print usage screen
 613                         $errMessage = $e->getMessageArray();
 614
 615                         // Only print the help message when this is for the developer, not runtime
 616                         if ( $this->mPrinter->getWantsHelp() || $this->mAction == 'help' ) {
 617                                 ApiResult::setContent( $errMessage, $this->makeHelpMsg() );
 618                         }
 619
 620                 } else {
 621                         global $wgShowSQLErrors, $wgShowExceptionDetails;
 622                         // Something is seriously wrong
 623                         if ( ( $e instanceof DBQueryError ) && !$wgShowSQLErrors ) {
 624                                 $info = 'Database query error';
 625                         } else {
 626                                 $info = "Exception Caught: {$e->getMessage()}";
 627                         }
 628
 629                         $errMessage = array(
 630                                 'code' => 'internal_api_error_' . get_class( $e ),
 631                                 'info' => $info,
 632                         );
 633                         ApiResult::setContent( $errMessage, $wgShowExceptionDetails ? "\n\n{$e->getTraceAsString()}\n\n" : '' );
 634                 }
 635
 636                 $result->reset();
 637                 $result->disableSizeCheck();
 638                 // Re-add the id
 639                 $requestid = $this->getParameter( 'requestid' );
 640                 if ( !is_null( $requestid ) ) {
 641                         $result->addValue( null, 'requestid', $requestid );
 642                 }
 643
 644                 if ( $wgShowHostnames ) {
 645                         // servedby is especially useful when debugging errors
 646                         $result->addValue( null, 'servedby', wfHostName() );
 647                 }
 648
 649                 $result->addValue( null, 'error', $errMessage );
 650
 651                 return $errMessage['code'];
 652         }
 653
 654         /**
 655          * Set up for the execution.
 656          * @return array
 657          */
 658         protected function setupExecuteAction() {
 659                 global $wgShowHostnames;
 660
 661                 // First add the id to the top element
 662                 $result = $this->getResult();
 663                 $requestid = $this->getParameter( 'requestid' );
 664                 if ( !is_null( $requestid ) ) {
 665                         $result->addValue( null, 'requestid', $requestid );
 666                 }
 667
 668                 if ( $wgShowHostnames ) {
 669                         $servedby = $this->getParameter( 'servedby' );
 670                         if ( $servedby ) {
 671                                 $result->addValue( null, 'servedby', wfHostName() );
 672                         }
 673                 }
 674
 675                 $params = $this->extractRequestParams();
 676
 677                 $this->mShowVersions = $params['version'];
 678                 $this->mAction = $params['action'];
 679
 680                 if ( !is_string( $this->mAction ) ) {
 681                         $this->dieUsage( 'The API requires a valid action parameter', 'unknown_action' );
 682                 }
 683
 684                 return $params;
 685         }
 686
 687         /**
 688          * Set up the module for response
 689          * @return ApiBase The module that will handle this action
 690          */
 691         protected function setupModule() {
 692                 // Instantiate the module requested by the user
 693                 $module = new $this->mModules[$this->mAction] ( $this, $this->mAction );
 694                 $this->mModule = $module;
 695
 696                 $moduleParams = $module->extractRequestParams();
 697
 698                 // Die if token required, but not provided (unless there is a gettoken parameter)
 699                 if ( isset( $moduleParams['gettoken'] ) ) {
 700                         $gettoken = $moduleParams['gettoken'];
 701                 } else {
 702                         $gettoken = false;
 703                 }
 704
 705                 $salt = $module->getTokenSalt();
 706                 if ( $salt !== false && !$gettoken ) {
 707                         if ( !isset( $moduleParams['token'] ) ) {
 708                                 $this->dieUsageMsg( array( 'missingparam', 'token' ) );
 709                         } else {
 710                                 if ( !$this->getUser()->matchEditToken( $moduleParams['token'], $salt, $this->getContext()->getRequest() ) ) {
 711                                         $this->dieUsageMsg( 'sessionfailure' );
 712                                 }
 713                         }
 714                 }
 715                 return $module;
 716         }
 717
 718         /**
 719          * Check the max lag if necessary
 720          * @param $module ApiBase object: Api module being used
 721          * @param $params Array an array containing the request parameters.
 722          * @return boolean True on success, false should exit immediately
 723          */
 724         protected function checkMaxLag( $module, $params ) {
 725                 if ( $module->shouldCheckMaxlag() && isset( $params['maxlag'] ) ) {
 726                         // Check for maxlag
 727                         global $wgShowHostnames;
 728                         $maxLag = $params['maxlag'];
 729                         list( $host, $lag ) = wfGetLB()->getMaxLag();
 730                         if ( $lag > $maxLag ) {
 731                                 $response = $this->getRequest()->response();
 732
 733                                 $response->header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
 734                                 $response->header( 'X-Database-Lag: ' . intval( $lag ) );
 735
 736                                 if ( $wgShowHostnames ) {
 737                                         $this->dieUsage( "Waiting for $host: $lag seconds lagged", 'maxlag' );
 738                                 } else {
 739                                         $this->dieUsage( "Waiting for a database server: $lag seconds lagged", 'maxlag' );
 740                                 }
 741                                 return false;
 742                         }
 743                 }
 744                 return true;
 745         }
 746
 747         /**
 748          * Check for sufficient permissions to execute
 749          * @param $module ApiBase An Api module
 750          */
 751         protected function checkExecutePermissions( $module ) {
 752                 $user = $this->getUser();
 753                 if ( $module->isReadMode() && !in_array( 'read', User::getGroupPermissions( array( '*' ) ), true ) &&
 754                         !$user->isAllowed( 'read' ) )
 755                 {
 756                         $this->dieUsageMsg( 'readrequired' );
 757                 }
 758                 if ( $module->isWriteMode() ) {
 759                         if ( !$this->mEnableWrite ) {
 760                                 $this->dieUsageMsg( 'writedisabled' );
 761                         }
 762                         if ( !$user->isAllowed( 'writeapi' ) ) {
 763                                 $this->dieUsageMsg( 'writerequired' );
 764                         }
 765                         if ( wfReadOnly() ) {
 766                                 $this->dieReadOnly();
 767                         }
 768                 }
 769
 770                 // Allow extensions to stop execution for arbitrary reasons.
 771                 $message = false;
 772                 if( !wfRunHooks( 'ApiCheckCanExecute', array( $module, $user, &$message ) ) ) {
 773                         $this->dieUsageMsg( $message );
 774                 }
 775         }
 776
 777         /**
 778          * Check POST for external response and setup result printer
 779          * @param $module ApiBase An Api module
 780          * @param $params Array an array with the request parameters
 781          */
 782         protected function setupExternalResponse( $module, $params ) {
 783                 // Ignore mustBePosted() for internal calls
 784                 if ( $module->mustBePosted() && !$this->getRequest()->wasPosted() ) {
 785                         $this->dieUsageMsg( array( 'mustbeposted', $this->mAction ) );
 786                 }
 787
 788                 // See if custom printer is used
 789                 $this->mPrinter = $module->getCustomPrinter();
 790                 if ( is_null( $this->mPrinter ) ) {
 791                         // Create an appropriate printer
 792                         $this->mPrinter = $this->createPrinterByName( $params['format'] );
 793                 }
 794
 795                 if ( $this->mPrinter->getNeedsRawData() ) {
 796                         $this->getResult()->setRawMode();
 797                 }
 798         }
 799
 800         /**
 801          * Execute the actual module, without any error handling
 802          */
 803         protected function executeAction() {
 804                 $params = $this->setupExecuteAction();
 805                 $module = $this->setupModule();
 806
 807                 $this->checkExecutePermissions( $module );
 808
 809                 if ( !$this->checkMaxLag( $module, $params ) ) {
 810                         return;
 811                 }
 812
 813                 if ( !$this->mInternalMode ) {
 814                         $this->setupExternalResponse( $module, $params );
 815                 }
 816
 817                 // Execute
 818                 $module->profileIn();
 819                 $module->execute();
 820                 wfRunHooks( 'APIAfterExecute', array( &$module ) );
 821                 $module->profileOut();
 822
 823                 if ( !$this->mInternalMode ) {
 824
 825                         //append Debug information
 826                         MWDebug::appendDebugInfoToApiResult( $this->getContext(), $this->getResult() );
 827
 828                         // Print result data
 829                         $this->printResult( false );
 830                 }
 831         }
 832
 833         /**
 834          * Log the preceding request
 835          * @param $time Time in seconds
 836          */
 837         protected function logRequest( $time ) {
 838                 $request = $this->getRequest();
 839                 $milliseconds = $time === null ? '?' : round( $time * 1000 );
 840                 $s = 'API' .
 841                         ' ' . $request->getMethod() .
 842                         ' ' . wfUrlencode( str_replace( ' ', '_', $this->getUser()->getName() ) ) .
 843                         ' ' . $request->getIP() .
 844                         ' T=' . $milliseconds .'ms';
 845                 foreach ( $this->getParamsUsed() as $name ) {
 846                         $value = $request->getVal( $name );
 847                         if ( $value === null ) {
 848                                 continue;
 849                         }
 850                         $s .= ' ' . $name . '=';
 851                         if ( strlen( $value ) > 256 ) {
 852                                 $encValue = $this->encodeRequestLogValue( substr( $value, 0, 256 ) );
 853                                 $s .= $encValue . '[...]';
 854                         } else {
 855                                 $s .= $this->encodeRequestLogValue( $value );
 856                         }
 857                 }
 858                 $s .= "\n";
 859                 wfDebugLog( 'api', $s, false );
 860         }
 861
 862         /**
 863          * Encode a value in a format suitable for a space-separated log line.
 864          */
 865         protected function encodeRequestLogValue( $s ) {
 866                 static $table;
 867                 if ( !$table ) {
 868                         $chars = ';@$!*(),/:';
 869                         for ( $i = 0; $i < strlen( $chars ); $i++ ) {
 870                                 $table[ rawurlencode( $chars[$i] ) ] = $chars[$i];
 871                         }
 872                 }
 873                 return strtr( rawurlencode( $s ), $table );
 874         }
 875
 876         /**
 877          * Get the request parameters used in the course of the preceding execute() request
 878          */
 879         protected function getParamsUsed() {
 880                 return array_keys( $this->mParamsUsed );
 881         }
 882
 883         /**
 884          * Get a request value, and register the fact that it was used, for logging.
 885          */
 886         public function getVal( $name, $default = null ) {
 887                 $this->mParamsUsed[$name] = true;
 888                 return $this->getRequest()->getVal( $name, $default );
 889         }
 890
 891         /**
 892          * Get a boolean request value, and register the fact that the parameter
 893          * was used, for logging.
 894          */
 895         public function getCheck( $name ) {
 896                 $this->mParamsUsed[$name] = true;
 897                 return $this->getRequest()->getCheck( $name );
 898         }
 899
 900         /**
 901          * Print results using the current printer
 902          *
 903          * @param $isError bool
 904          */
 905         protected function printResult( $isError ) {
 906                 $this->getResult()->cleanUpUTF8();
 907                 $printer = $this->mPrinter;
 908                 $printer->profileIn();
 909
 910                 /**
 911                  * If the help message is requested in the default (xmlfm) format,
 912                  * tell the printer not to escape ampersands so that our links do
 913                  * not break.
 914                  */
 915                 $printer->setUnescapeAmps( ( $this->mAction == 'help' || $isError )
 916                                 && $printer->getFormat() == 'XML' && $printer->getIsHtml() );
 917
 918                 $printer->initPrinter( $isError );
 919
 920                 $printer->execute();
 921                 $printer->closePrinter();
 922                 $printer->profileOut();
 923         }
 924
 925         /**
 926          * @return bool
 927          */
 928         public function isReadMode() {
 929                 return false;
 930         }
 931
 932         /**
 933          * See ApiBase for description.
 934          *
 935          * @return array
 936          */
 937         public function getAllowedParams() {
 938                 return array(
 939                         'format' => array(
 940                                 ApiBase::PARAM_DFLT => ApiMain::API_DEFAULT_FORMAT,
 941                                 ApiBase::PARAM_TYPE => $this->mFormatNames
 942                         ),
 943                         'action' => array(
 944                                 ApiBase::PARAM_DFLT => 'help',
 945                                 ApiBase::PARAM_TYPE => $this->mModuleNames
 946                         ),
 947                         'version' => false,
 948                         'maxlag'  => array(
 949                                 ApiBase::PARAM_TYPE => 'integer'
 950                         ),
 951                         'smaxage' => array(
 952                                 ApiBase::PARAM_TYPE => 'integer',
 953                                 ApiBase::PARAM_DFLT => 0
 954                         ),
 955                         'maxage' => array(
 956                                 ApiBase::PARAM_TYPE => 'integer',
 957                                 ApiBase::PARAM_DFLT => 0
 958                         ),
 959                         'requestid' => null,
 960                         'servedby'  => false,
 961                         'origin' => null,
 962                 );
 963         }
 964
 965         /**
 966          * See ApiBase for description.
 967          *
 968          * @return array
 969          */
 970         public function getParamDescription() {
 971                 return array(
 972                         'format' => 'The format of the output',
 973                         'action' => 'What action you would like to perform. See below for module help',
 974                         'version' => 'When showing help, include version for each module',
 975                         'maxlag' => array(
 976                                 'Maximum lag can be used when MediaWiki is installed on a database replicated cluster.',
 977                                 'To save actions causing any more site replication lag, this parameter can make the client',
 978                                 'wait until the replication lag is less than the specified value.',
 979                                 'In case of a replag error, a HTTP 503 error is returned, with the message like',
 980                                 '"Waiting for $host: $lag seconds lagged\n".',
 981                                 'See https://www.mediawiki.org/wiki/Manual:Maxlag_parameter for more information',
 982                         ),
 983                         'smaxage' => 'Set the s-maxage header to this many seconds. Errors are never cached',
 984                         'maxage' => 'Set the max-age header to this many seconds. Errors are never cached',
 985                         'requestid' => 'Request ID to distinguish requests. This will just be output back to you',
 986                         'servedby' => 'Include the hostname that served the request in the results. Unconditionally shown on error',
 987                         'origin' => array(
 988                                 'When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain.',
 989                                 'This must match one of the origins in the Origin: header exactly, so it has to be set to something like http://en.wikipedia.org or https://meta.wikimedia.org .',
 990                                 'If this parameter does not match the Origin: header, a 403 response will be returned.',
 991                                 'If this parameter matches the Origin: header and the origin is whitelisted, an Access-Control-Allow-Origin header will be set.',
 992                         ),
 993                 );
 994         }
 995
 996         /**
 997          * See ApiBase for description.
 998          *
 999          * @return array
1000          */
1001         public function getDescription() {
1002                 return array(
1003                         '',
1004                         '',
1005                         '**********************************************************************************************************',
1006                         '**                                                                                                      **',
1007                         '**                      This is an auto-generated MediaWiki API documentation page                      **',
1008                         '**                                                                                                      **',
1009                         '**                                     Documentation and Examples:                                      **',
1010                         '**                                  https://www.mediawiki.org/wiki/API                                  **',
1011                         '**                                                                                                      **',
1012                         '**********************************************************************************************************',
1013                         '',
1014                         'Status:                All features shown on this page should be working, but the API',
1015                         '                       is still in active development, and may change at any time.',
1016                         '                       Make sure to monitor our mailing list for any updates',
1017                         '',
1018                         'Erroneous requests:    When erroneous requests are sent to the API, a HTTP header will be sent',
1019                         '                       with the key "MediaWiki-API-Error" and then both the value of the',
1020                         '                       header and the error code sent back will be set to the same value',
1021                         '',
1022                         '                       In the case of an invalid action being passed, these will have a value',
1023                         '                       of "unknown_action"',
1024                         '',
1025                         '                       For more information see https://www.mediawiki.org/wiki/API:Errors_and_warnings',
1026                         '',
1027                         'Documentation:         https://www.mediawiki.org/wiki/API:Main_page',
1028                         'FAQ                    https://www.mediawiki.org/wiki/API:FAQ',
1029                         'Mailing list:          https://lists.wikimedia.org/mailman/listinfo/mediawiki-api',
1030                         'Api Announcements:     https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce',
1031                         'Bugs & Requests:       https://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts',
1032                         '',
1033                         '',
1034                         '',
1035                         '',
1036                         '',
1037                 );
1038         }
1039
1040         /**
1041          * @return array
1042          */
1043         public function getPossibleErrors() {
1044                 return array_merge( parent::getPossibleErrors(), array(
1045                         array( 'readonlytext' ),
1046                         array( 'code' => 'unknown_format', 'info' => 'Unrecognized format: format' ),
1047                         array( 'code' => 'unknown_action', 'info' => 'The API requires a valid action parameter' ),
1048                         array( 'code' => 'maxlag', 'info' => 'Waiting for host: x seconds lagged' ),
1049                         array( 'code' => 'maxlag', 'info' => 'Waiting for a database server: x seconds lagged' ),
1050                 ) );
1051         }
1052
1053         /**
1054          * Returns an array of strings with credits for the API
1055          * @return array
1056          */
1057         protected function getCredits() {
1058                 return array(
1059                         'API developers:',
1060                         '    Roan Kattouw "<Firstname>.<Lastname>@gmail.com" (lead developer Sep 2007-present)',
1061                         '    Victor Vasiliev - vasilvv at gee mail dot com',
1062                         '    Bryan Tong Minh - bryan . tongminh @ gmail . com',
1063                         '    Sam Reed - sam @ reedyboy . net',
1064                         '    Yuri Astrakhan "<Firstname><Lastname>@gmail.com" (creator, lead developer Sep 2006-Sep 2007)',
1065                         '',
1066                         'Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org',
1067                         'or file a bug report at https://bugzilla.wikimedia.org/'
1068                 );
1069         }
1070
1071         /**
1072          * Sets whether the pretty-printer should format *bold* and $italics$
1073          *
1074          * @param $help bool
1075          */
1076         public function setHelp( $help = true ) {
1077                 $this->mPrinter->setHelp( $help );
1078         }
1079
1080         /**
1081          * Override the parent to generate help messages for all available modules.
1082          *
1083          * @return string
1084          */
1085         public function makeHelpMsg() {
1086                 global $wgMemc, $wgAPICacheHelpTimeout;
1087                 $this->setHelp();
1088                 // Get help text from cache if present
1089                 $key = wfMemcKey( 'apihelp', $this->getModuleName(),
1090                         SpecialVersion::getVersion( 'nodb' ) .
1091                         $this->getShowVersions() );
1092                 if ( $wgAPICacheHelpTimeout > 0 ) {
1093                         $cached = $wgMemc->get( $key );
1094                         if ( $cached ) {
1095                                 return $cached;
1096                         }
1097                 }
1098                 $retval = $this->reallyMakeHelpMsg();
1099                 if ( $wgAPICacheHelpTimeout > 0 ) {
1100                         $wgMemc->set( $key, $retval, $wgAPICacheHelpTimeout );
1101                 }
1102                 return $retval;
1103         }
1104
1105         /**
1106          * @return mixed|string
1107          */
1108         public function reallyMakeHelpMsg() {
1109                 $this->setHelp();
1110
1111                 // Use parent to make default message for the main module
1112                 $msg = parent::makeHelpMsg();
1113
1114                 $astriks = str_repeat( '*** ', 14 );
1115                 $msg .= "\n\n$astriks Modules  $astriks\n\n";
1116                 foreach ( array_keys( $this->mModules ) as $moduleName ) {
1117                         $module = new $this->mModules[$moduleName] ( $this, $moduleName );
1118                         $msg .= self::makeHelpMsgHeader( $module, 'action' );
1119                         $msg2 = $module->makeHelpMsg();
1120                         if ( $msg2 !== false ) {
1121                                 $msg .= $msg2;
1122                         }
1123                         $msg .= "\n";
1124                 }
1125
1126                 $msg .= "\n$astriks Permissions $astriks\n\n";
1127                 foreach ( self::$mRights as $right => $rightMsg ) {
1128                         $groups = User::getGroupsWithPermission( $right );
1129                         $msg .= "* " . $right . " *\n  " . wfMsgReplaceArgs( $rightMsg[ 'msg' ], $rightMsg[ 'params' ] ) .
1130                                                 "\nGranted to:\n  " . str_replace( '*', 'all', implode( ', ', $groups ) ) . "\n\n";
1131
1132                 }
1133
1134                 $msg .= "\n$astriks Formats  $astriks\n\n";
1135                 foreach ( array_keys( $this->mFormats ) as $formatName ) {
1136                         $module = $this->createPrinterByName( $formatName );
1137                         $msg .= self::makeHelpMsgHeader( $module, 'format' );
1138                         $msg2 = $module->makeHelpMsg();
1139                         if ( $msg2 !== false ) {
1140                                 $msg .= $msg2;
1141                         }
1142                         $msg .= "\n";
1143                 }
1144
1145                 $msg .= "\n*** Credits: ***\n   " . implode( "\n   ", $this->getCredits() ) . "\n";
1146
1147                 return $msg;
1148         }
1149
1150         /**
1151          * @param $module ApiBase
1152          * @param $paramName String What type of request is this? e.g. action, query, list, prop, meta, format
1153          * @return string
1154          */
1155         public static function makeHelpMsgHeader( $module, $paramName ) {
1156                 $modulePrefix = $module->getModulePrefix();
1157                 if ( strval( $modulePrefix ) !== '' ) {
1158                         $modulePrefix = "($modulePrefix) ";
1159                 }
1160
1161                 return "* $paramName={$module->getModuleName()} $modulePrefix*";
1162         }
1163
1164         private $mCanApiHighLimits = null;
1165
1166         /**
1167          * Check whether the current user is allowed to use high limits
1168          * @return bool
1169          */
1170         public function canApiHighLimits() {
1171                 if ( !isset( $this->mCanApiHighLimits ) ) {
1172                         $this->mCanApiHighLimits = $this->getUser()->isAllowed( 'apihighlimits' );
1173                 }
1174
1175                 return $this->mCanApiHighLimits;
1176         }
1177
1178         /**
1179          * Check whether the user wants us to show version information in the API help
1180          * @return bool
1181          */
1182         public function getShowVersions() {
1183                 return $this->mShowVersions;
1184         }
1185
1186         /**
1187          * Returns the version information of this file, plus it includes
1188          * the versions for all files that are not callable proper API modules
1189          *
1190          * @return array
1191          */
1192         public function getVersion() {
1193                 $vers = array();
1194                 $vers[] = 'MediaWiki: ' . SpecialVersion::getVersion() . "\n    https://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/";
1195                 $vers[] = __CLASS__ . ': $Id$';
1196                 $vers[] = ApiBase::getBaseVersion();
1197                 $vers[] = ApiFormatBase::getBaseVersion();
1198                 $vers[] = ApiQueryBase::getBaseVersion();
1199                 return $vers;
1200         }
1201
1202         /**
1203          * Add or overwrite a module in this ApiMain instance. Intended for use by extending
1204          * classes who wish to add their own modules to their lexicon or override the
1205          * behavior of inherent ones.
1206          *
1207          * @param $mdlName String The identifier for this module.
1208          * @param $mdlClass String The class where this module is implemented.
1209          */
1210         protected function addModule( $mdlName, $mdlClass ) {
1211                 $this->mModules[$mdlName] = $mdlClass;
1212         }
1213
1214         /**
1215          * Add or overwrite an output format for this ApiMain. Intended for use by extending
1216          * classes who wish to add to or modify current formatters.
1217          *
1218          * @param $fmtName string The identifier for this format.
1219          * @param $fmtClass ApiFormatBase The class implementing this format.
1220          */
1221         protected function addFormat( $fmtName, $fmtClass ) {
1222                 $this->mFormats[$fmtName] = $fmtClass;
1223         }
1224
1225         /**
1226          * Get the array mapping module names to class names
1227          * @return array
1228          */
1229         function getModules() {
1230                 return $this->mModules;
1231         }
1232
1233         /**
1234          * Returns the list of supported formats in form ( 'format' => 'ClassName' )
1235          *
1236          * @since 1.18
1237          * @return array
1238          */
1239         public function getFormats() {
1240                 return $this->mFormats;
1241         }
1242 }
1243
1244 /**
1245  * This exception will be thrown when dieUsage is called to stop module execution.
1246  * The exception handling code will print a help screen explaining how this API may be used.
1247  *
1248  * @ingroup API
1249  */
1250 class UsageException extends MWException {
1251
1252         private $mCodestr;
1253
1254         /**
1255          * @var null|array
1256          */
1257         private $mExtraData;
1258
1259         /**
1260          * @param $message string
1261          * @param $codestr string
1262          * @param $code int
1263          * @param $extradata array|null
1264          */
1265         public function __construct( $message, $codestr, $code = 0, $extradata = null ) {
1266                 parent::__construct( $message, $code );
1267                 $this->mCodestr = $codestr;
1268                 $this->mExtraData = $extradata;
1269         }
1270
1271         /**
1272          * @return string
1273          */
1274         public function getCodeString() {
1275                 return $this->mCodestr;
1276         }
1277
1278         /**
1279          * @return array
1280          */
1281         public function getMessageArray() {
1282                 $result = array(
1283                         'code' => $this->mCodestr,
1284                         'info' => $this->getMessage()
1285                 );
1286                 if ( is_array( $this->mExtraData ) ) {
1287                         $result = array_merge( $result, $this->mExtraData );
1288                 }
1289                 return $result;
1290         }
1291
1292         /**
1293          * @return string
1294          */
1295         public function __toString() {
1296                 return "{$this->getCodeString()}: {$this->getMessage()}";
1297         }
1298 }