a6d44a3e3466c3918c90b9e692dd6a2abdd8c776
3 * API for MediaWiki 1.8+
5 * Created on Sep 4, 2006
7 * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
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.
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.
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
28 if ( !defined( 'MEDIAWIKI' ) ) {
29 // Eclipse helper - will be ignored in production
30 require_once( 'ApiBase.php' );
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.
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.
46 class ApiMain
extends ApiBase
{
49 * When no format parameter is given, this format will be used
51 const API_DEFAULT_FORMAT
= 'xmlfm';
54 * List of available modules: action name => module class
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',
65 'paraminfo' => 'ApiParamInfo',
68 'purge' => 'ApiPurge',
69 'rollback' => 'ApiRollback',
70 'delete' => 'ApiDelete',
71 'undelete' => 'ApiUndelete',
72 'protect' => 'ApiProtect',
73 'block' => 'ApiBlock',
74 'unblock' => 'ApiUnblock',
76 'edit' => 'ApiEditPage',
77 'upload' => 'ApiUpload',
78 'emailuser' => 'ApiEmailUser',
79 'watch' => 'ApiWatch',
80 'patrol' => 'ApiPatrol',
81 'import' => 'ApiImport',
82 'userrights' => 'ApiUserrights',
86 * List of available formats: format name => format class
88 private static $Formats = array(
89 'json' => 'ApiFormatJson',
90 'jsonfm' => 'ApiFormatJson',
91 'php' => 'ApiFormatPhp',
92 'phpfm' => 'ApiFormatPhp',
93 'wddx' => 'ApiFormatWddx',
94 'wddxfm' => 'ApiFormatWddx',
95 'xml' => 'ApiFormatXml',
96 'xmlfm' => 'ApiFormatXml',
97 'yaml' => 'ApiFormatYaml',
98 'yamlfm' => 'ApiFormatYaml',
99 'rawfm' => 'ApiFormatJson',
100 'txt' => 'ApiFormatTxt',
101 'txtfm' => 'ApiFormatTxt',
102 'dbg' => 'ApiFormatDbg',
103 'dbgfm' => 'ApiFormatDbg',
104 'dump' => 'ApiFormatDump',
105 'dumpfm' => 'ApiFormatDump',
109 * List of user roles that are specifically relevant to the API.
110 * array( 'right' => array ( 'msg' => 'Some message with a $1',
111 * 'params' => array ( $someVarToSubst ) ),
114 private static $mRights = array(
116 'msg' => 'Use of the write API',
119 'apihighlimits' => array(
120 '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.',
121 'params' => array( ApiBase
::LIMIT_SML2
, ApiBase
::LIMIT_BIG2
)
125 private $mPrinter, $mModules, $mModuleNames, $mFormats, $mFormatNames;
126 private $mResult, $mAction, $mShowVersions, $mEnableWrite, $mRequest;
127 private $mInternalMode, $mSquidMaxage, $mModule;
129 private $mCacheMode = 'private';
130 private $mCacheControl = array();
133 * Constructs an instance of ApiMain that utilizes the module and format specified by $request.
135 * @param $request object - if this is an instance of FauxRequest, errors are thrown and no printing occurs
136 * @param $enableWrite bool should be set to true if the api may modify data
138 public function __construct( $request, $enableWrite = false ) {
139 $this->mInternalMode
= ( $request instanceof FauxRequest
);
141 // Special handling for the main module: $parent === $this
142 parent
::__construct( $this, $this->mInternalMode ?
'main_int' : 'main' );
144 if ( !$this->mInternalMode
) {
145 // Impose module restrictions.
146 // If the current user cannot read,
147 // Remove all modules other than login
150 if ( $request->getVal( 'callback' ) !== null ) {
151 // JSON callback allows cross-site reads.
152 // For safety, strip user credentials.
153 wfDebug( "API: stripping user credentials for JSON callback\n" );
154 $wgUser = new User();
158 global $wgAPIModules; // extension modules
159 $this->mModules
= $wgAPIModules + self
::$Modules;
161 $this->mModuleNames
= array_keys( $this->mModules
);
162 $this->mFormats
= self
::$Formats;
163 $this->mFormatNames
= array_keys( $this->mFormats
);
165 $this->mResult
= new ApiResult( $this );
166 $this->mShowVersions
= false;
167 $this->mEnableWrite
= $enableWrite;
169 $this->mRequest
= &$request;
171 $this->mSquidMaxage
= - 1; // flag for executeActionWithErrorHandling()
172 $this->mCommit
= false;
176 * Return true if the API was started by other PHP code using FauxRequest
178 public function isInternalMode() {
179 return $this->mInternalMode
;
183 * Return the request object that contains client's request
185 public function getRequest() {
186 return $this->mRequest
;
190 * Get the ApiResult object associated with current request
192 public function getResult() {
193 return $this->mResult
;
197 * Get the API module object. Only works after executeAction()
199 public function getModule() {
200 return $this->mModule
;
204 * Get the result formatter object. Only works after setupExecuteAction()
206 public function getPrinter() {
207 return $this->mPrinter
;
211 * Set how long the response should be cached.
213 public function setCacheMaxAge( $maxage ) {
214 $this->setCacheControl( array(
215 'max-age' => $maxage,
216 's-maxage' => $maxage
221 * Set the type of caching headers which will be sent.
223 * @param $mode String One of:
224 * - 'public': Cache this object in public caches, if the maxage or smaxage
225 * parameter is set, or if setCacheMaxAge() was called. If a maximum age is
226 * not provided by any of these means, the object will be private.
227 * - 'private': Cache this object only in private client-side caches.
228 * - 'anon-public-user-private': Make this object cacheable for logged-out
229 * users, but private for logged-in users. IMPORTANT: If this is set, it must be
230 * set consistently for a given URL, it cannot be set differently depending on
231 * things like the contents of the database, or whether the user is logged in.
233 * If the wiki does not allow anonymous users to read it, the mode set here
234 * will be ignored, and private caching headers will always be sent. In other words,
235 * the "public" mode is equivalent to saying that the data sent is as public as a page
238 * For user-dependent data, the private mode should generally be used. The
239 * anon-public-user-private mode should only be used where there is a particularly
240 * good performance reason for caching the anonymous response, but where the
241 * response to logged-in users may differ, or may contain private data.
243 * If this function is never called, then the default will be the private mode.
245 public function setCacheMode( $mode ) {
246 if ( !in_array( $mode, array( 'private', 'public', 'anon-public-user-private' ) ) ) {
247 wfDebug( __METHOD__
. ": unrecognised cache mode \"$mode\"\n" );
248 // Ignore for forwards-compatibility
252 if ( !in_array( 'read', User
::getGroupPermissions( array( '*' ) ), true ) ) {
253 // Private wiki, only private headers
254 if ( $mode !== 'private' ) {
255 wfDebug( __METHOD__
. ": ignoring request for $mode cache mode, private wiki\n" );
260 wfDebug( __METHOD__
. ": setting cache mode $mode\n" );
261 $this->mCacheMode
= $mode;
265 * @deprecated Private caching is now the default, so there is usually no
266 * need to call this function. If there is a need, you can use
267 * $this->setCacheMode('private')
269 public function setCachePrivate() {
270 $this->setCacheMode( 'private' );
274 * Set directives (key/value pairs) for the Cache-Control header.
275 * Boolean values will be formatted as such, by including or omitting
276 * without an equals sign.
278 * Cache control values set here will only be used if the cache mode is not
279 * private, see setCacheMode().
281 public function setCacheControl( $directives ) {
282 $this->mCacheControl
= $directives +
$this->mCacheControl
;
286 * Make sure Vary: Cookie and friends are set. Use this when the output of a request
287 * may be cached for anons but may not be cached for logged-in users.
289 * WARNING: This function must be called CONSISTENTLY for a given URL. This means that a
290 * given URL must either always or never call this function; if it sometimes does and
291 * sometimes doesn't, stuff will break.
293 * @deprecated Use setCacheMode( 'anon-public-user-private' )
295 public function setVaryCookie() {
296 $this->setCacheMode( 'anon-public-user-private' );
300 * Create an instance of an output formatter by its name
302 public function createPrinterByName( $format ) {
303 if ( !isset( $this->mFormats
[$format] ) ) {
304 $this->dieUsage( "Unrecognized format: {$format}", 'unknown_format' );
306 return new $this->mFormats
[$format] ( $this, $format );
310 * Execute api request. Any errors will be handled if the API was called by the remote client.
312 public function execute() {
314 if ( $this->mInternalMode
) {
315 $this->executeAction();
317 $this->executeActionWithErrorHandling();
324 * Execute an action, and in case of an error, erase whatever partial results
325 * have been accumulated, and replace it with an error message and a help screen.
327 protected function executeActionWithErrorHandling() {
328 // In case an error occurs during data output,
329 // clear the output buffer and print just the error information
333 $this->executeAction();
334 } catch ( Exception
$e ) {
336 if ( $e instanceof MWException
) {
337 wfDebugLog( 'exception', $e->getLogMessage() );
341 // Handle any kind of exception by outputing properly formatted error message.
342 // If this fails, an unhandled exception should be thrown so that global error
343 // handler will process and log it.
346 $errCode = $this->substituteResultWithError( $e );
348 // Error results should not be cached
349 $this->setCacheMode( 'private' );
351 $headerStr = 'MediaWiki-API-Error: ' . $errCode;
352 if ( $e->getCode() === 0 ) {
353 header( $headerStr );
355 header( $headerStr, true, $e->getCode() );
358 // Reset and print just the error message
361 // If the error occured during printing, do a printer->profileOut()
362 $this->mPrinter
->safeProfileOut();
363 $this->printResult( true );
366 // Send cache headers after any code which might generate an error, to
367 // avoid sending public cache headers for errors.
368 $this->sendCacheHeaders();
370 if ( $this->mPrinter
->getIsHtml() && !$this->mPrinter
->isDisabled() ) {
377 protected function sendCacheHeaders() {
378 if ( $this->mCacheMode
== 'private' ) {
379 header( 'Cache-Control: private' );
383 if ( $this->mCacheMode
== 'anon-public-user-private' ) {
384 global $wgUseXVO, $wgOut;
385 header( 'Vary: Accept-Encoding, Cookie' );
387 header( $wgOut->getXVO() );
388 if ( $wgOut->haveCacheVaryCookies() ) {
389 // Logged in, mark this request private
390 header( 'Cache-Control: private' );
393 // Logged out, send normal public headers below
394 } elseif ( session_id() != '' ) {
395 // Logged in or otherwise has session (e.g. anonymous users who have edited)
396 // Mark request private
397 header( 'Cache-Control: private' );
399 } // else no XVO and anonymous, send public headers below
402 // If nobody called setCacheMaxAge(), use the (s)maxage parameters
403 if ( !isset( $this->mCacheControl
['s-maxage'] ) ) {
404 $this->mCacheControl
['s-maxage'] = $this->getParameter( 'smaxage' );
406 if ( !isset( $this->mCacheControl
['max-age'] ) ) {
407 $this->mCacheControl
['max-age'] = $this->getParameter( 'maxage' );
410 if ( !$this->mCacheControl
['s-maxage'] && !$this->mCacheControl
['max-age'] ) {
411 // Public cache not requested
412 // Sending a Vary header in this case is harmless, and protects us
413 // against conditional calls of setCacheMaxAge().
414 header( 'Cache-Control: private' );
418 $this->mCacheControl
['public'] = true;
420 // Send an Expires header
421 $maxAge = min( $this->mCacheControl
['s-maxage'], $this->mCacheControl
['max-age'] );
422 $expiryUnixTime = ( $maxAge == 0 ?
1 : time() +
$maxAge );
423 header( 'Expires: ' . wfTimestamp( TS_RFC2822
, $expiryUnixTime ) );
425 // Construct the Cache-Control header
428 foreach ( $this->mCacheControl
as $name => $value ) {
429 if ( is_bool( $value ) ) {
431 $ccHeader .= $separator . $name;
435 $ccHeader .= $separator . "$name=$value";
440 header( "Cache-Control: $ccHeader" );
444 * Replace the result data with the information about an exception.
445 * Returns the error code
447 protected function substituteResultWithError( $e ) {
448 // Printer may not be initialized if the extractRequestParams() fails for the main module
449 if ( !isset ( $this->mPrinter
) ) {
450 // The printer has not been created yet. Try to manually get formatter value.
451 $value = $this->getRequest()->getVal( 'format', self
::API_DEFAULT_FORMAT
);
452 if ( !in_array( $value, $this->mFormatNames
) ) {
453 $value = self
::API_DEFAULT_FORMAT
;
456 $this->mPrinter
= $this->createPrinterByName( $value );
457 if ( $this->mPrinter
->getNeedsRawData() ) {
458 $this->getResult()->setRawMode();
462 if ( $e instanceof UsageException
) {
464 // User entered incorrect parameters - print usage screen
466 $errMessage = $e->getMessageArray();
468 // Only print the help message when this is for the developer, not runtime
469 if ( $this->mPrinter
->getWantsHelp() ||
$this->mAction
== 'help' ) {
470 ApiResult
::setContent( $errMessage, $this->makeHelpMsg() );
474 global $wgShowSQLErrors, $wgShowExceptionDetails;
476 // Something is seriously wrong
478 if ( ( $e instanceof DBQueryError
) && !$wgShowSQLErrors ) {
479 $info = 'Database query error';
481 $info = "Exception Caught: {$e->getMessage()}";
485 'code' => 'internal_api_error_' . get_class( $e ),
488 ApiResult
::setContent( $errMessage, $wgShowExceptionDetails ?
"\n\n{$e->getTraceAsString()}\n\n" : '' );
491 $this->getResult()->reset();
492 $this->getResult()->disableSizeCheck();
494 $requestid = $this->getParameter( 'requestid' );
495 if ( !is_null( $requestid ) ) {
496 $this->getResult()->addValue( null, 'requestid', $requestid );
498 // servedby is especially useful when debugging errors
499 $this->getResult()->addValue( null, 'servedby', wfHostName() );
500 $this->getResult()->addValue( null, 'error', $errMessage );
502 return $errMessage['code'];
506 * Set up for the execution.
508 protected function setupExecuteAction() {
509 // First add the id to the top element
510 $requestid = $this->getParameter( 'requestid' );
511 if ( !is_null( $requestid ) ) {
512 $this->getResult()->addValue( null, 'requestid', $requestid );
514 $servedby = $this->getParameter( 'servedby' );
516 $this->getResult()->addValue( null, 'servedby', wfHostName() );
519 $params = $this->extractRequestParams();
521 $this->mShowVersions
= $params['version'];
522 $this->mAction
= $params['action'];
524 if ( !is_string( $this->mAction
) ) {
525 $this->dieUsage( 'The API requires a valid action parameter', 'unknown_action' );
532 * Set up the module for response
533 * @return Object the module that will handle this action
535 protected function setupModule() {
536 // Instantiate the module requested by the user
537 $module = new $this->mModules
[$this->mAction
] ( $this, $this->mAction
);
538 $this->mModule
= $module;
540 $moduleParams = $module->extractRequestParams();
542 // Die if token required, but not provided (unless there is a gettoken parameter)
543 $salt = $module->getTokenSalt();
544 if ( $salt !== false && !isset( $moduleParams['gettoken'] ) ) {
545 if ( !isset( $moduleParams['token'] ) ) {
546 $this->dieUsageMsg( array( 'missingparam', 'token' ) );
549 if ( !$wgUser->matchEditToken( $moduleParams['token'], $salt ) ) {
550 $this->dieUsageMsg( array( 'sessionfailure' ) );
558 * Check the max lag if necessary
559 * @param $module ApiBase object: Api module being used
560 * @param $params Array an array containing the request parameters.
561 * @return boolean True on success, false should exit immediately
563 protected function checkMaxLag( $module, $params ) {
564 if ( $module->shouldCheckMaxlag() && isset( $params['maxlag'] ) ) {
566 global $wgShowHostnames;
567 $maxLag = $params['maxlag'];
568 list( $host, $lag ) = wfGetLB()->getMaxLag();
569 if ( $lag > $maxLag ) {
570 header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
571 header( 'X-Database-Lag: ' . intval( $lag ) );
572 if ( $wgShowHostnames ) {
573 $this->dieUsage( "Waiting for $host: $lag seconds lagged", 'maxlag' );
575 $this->dieUsage( "Waiting for a database server: $lag seconds lagged", 'maxlag' );
585 * Check for sufficient permissions to execute
586 * @param $module object An Api module
588 protected function checkExecutePermissions( $module ) {
590 if ( $module->isReadMode() && !in_array( 'read', User
::getGroupPermissions( array( '*' ) ), true ) &&
591 !$wgUser->isAllowed( 'read' ) )
593 $this->dieUsageMsg( array( 'readrequired' ) );
595 if ( $module->isWriteMode() ) {
596 if ( !$this->mEnableWrite
) {
597 $this->dieUsageMsg( array( 'writedisabled' ) );
599 if ( !$wgUser->isAllowed( 'writeapi' ) ) {
600 $this->dieUsageMsg( array( 'writerequired' ) );
602 if ( wfReadOnly() ) {
603 $this->dieReadOnly();
609 * Check POST for external response and setup result printer
610 * @param $module object An Api module
611 * @param $params Array an array with the request parameters
613 protected function setupExternalResponse( $module, $params ) {
614 // Ignore mustBePosted() for internal calls
615 if ( $module->mustBePosted() && !$this->mRequest
->wasPosted() ) {
616 $this->dieUsageMsg( array( 'mustbeposted', $this->mAction
) );
619 // See if custom printer is used
620 $this->mPrinter
= $module->getCustomPrinter();
621 if ( is_null( $this->mPrinter
) ) {
622 // Create an appropriate printer
623 $this->mPrinter
= $this->createPrinterByName( $params['format'] );
626 if ( $this->mPrinter
->getNeedsRawData() ) {
627 $this->getResult()->setRawMode();
632 * Execute the actual module, without any error handling
634 protected function executeAction() {
635 $params = $this->setupExecuteAction();
636 $module = $this->setupModule();
638 $this->checkExecutePermissions( $module );
640 if ( !$this->checkMaxLag( $module, $params ) ) return;
642 if ( !$this->mInternalMode
) {
643 $this->setupExternalResponse( $module, $params );
647 $module->profileIn();
649 wfRunHooks( 'APIAfterExecute', array( &$module ) );
650 $module->profileOut();
652 if ( !$this->mInternalMode
) {
654 $this->printResult( false );
659 * Print results using the current printer
661 protected function printResult( $isError ) {
662 $this->getResult()->cleanUpUTF8();
663 $printer = $this->mPrinter
;
664 $printer->profileIn();
667 * If the help message is requested in the default (xmlfm) format,
668 * tell the printer not to escape ampersands so that our links do
671 $printer->setUnescapeAmps( ( $this->mAction
== 'help' ||
$isError )
672 && $printer->getFormat() == 'XML' && $printer->getIsHtml() );
674 $printer->initPrinter( $isError );
677 $printer->closePrinter();
678 $printer->profileOut();
681 public function isReadMode() {
686 * See ApiBase for description.
688 public function getAllowedParams() {
691 ApiBase
::PARAM_DFLT
=> ApiMain
::API_DEFAULT_FORMAT
,
692 ApiBase
::PARAM_TYPE
=> $this->mFormatNames
695 ApiBase
::PARAM_DFLT
=> 'help',
696 ApiBase
::PARAM_TYPE
=> $this->mModuleNames
700 ApiBase
::PARAM_TYPE
=> 'integer'
703 ApiBase
::PARAM_TYPE
=> 'integer',
704 ApiBase
::PARAM_DFLT
=> 0
707 ApiBase
::PARAM_TYPE
=> 'integer',
708 ApiBase
::PARAM_DFLT
=> 0
716 * See ApiBase for description.
718 public function getParamDescription() {
720 'format' => 'The format of the output',
721 'action' => 'What action you would like to perform. See below for module help',
722 'version' => 'When showing help, include version for each module',
723 'maxlag' => 'Maximum lag',
724 'smaxage' => 'Set the s-maxage header to this many seconds. Errors are never cached',
725 'maxage' => 'Set the max-age header to this many seconds. Errors are never cached',
726 'requestid' => 'Request ID to distinguish requests. This will just be output back to you',
727 'servedby' => 'Include the hostname that served the request in the results. Unconditionally shown on error',
732 * See ApiBase for description.
734 public function getDescription() {
738 '******************************************************************************************',
740 '** This is an auto-generated MediaWiki API documentation page **',
742 '** Documentation and Examples: **',
743 '** http://www.mediawiki.org/wiki/API **',
745 '******************************************************************************************',
747 'Status: All features shown on this page should be working, but the API',
748 ' is still in active development, and may change at any time.',
749 ' Make sure to monitor our mailing list for any updates',
751 'Documentation: http://www.mediawiki.org/wiki/API',
752 'Mailing list: http://lists.wikimedia.org/mailman/listinfo/mediawiki-api',
753 'Api Announcements: http://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce',
754 'Bugs & Requests: http://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts',
763 public function getPossibleErrors() {
764 return array_merge( parent
::getPossibleErrors(), array(
765 array( 'readonlytext' ),
766 array( 'code' => 'unknown_format', 'info' => 'Unrecognized format: format' ),
767 array( 'code' => 'unknown_action', 'info' => 'The API requires a valid action parameter' ),
768 array( 'code' => 'maxlag', 'info' => 'Waiting for host: x seconds lagged' ),
769 array( 'code' => 'maxlag', 'info' => 'Waiting for a database server: x seconds lagged' ),
774 * Returns an array of strings with credits for the API
776 protected function getCredits() {
779 ' Roan Kattouw <Firstname>.<Lastname>@home.nl (lead developer Sep 2007-present)',
780 ' Victor Vasiliev - vasilvv at gee mail dot com',
781 ' Bryan Tong Minh - bryan . tongminh @ gmail . com',
782 ' Sam Reed - sam @ reedyboy . net',
783 ' Yuri Astrakhan <Firstname><Lastname>@gmail.com (creator, lead developer Sep 2006-Sep 2007)',
785 'Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org',
786 'or file a bug report at http://bugzilla.wikimedia.org/'
790 * Sets whether the pretty-printer should format *bold* and $italics$
792 public function setHelp( $help = true ) {
793 $this->mPrinter
->setHelp( $help );
797 * Override the parent to generate help messages for all available modules.
799 public function makeHelpMsg() {
800 global $wgMemc, $wgAPICacheHelp, $wgAPICacheHelpTimeout;
802 // Get help text from cache if present
803 $key = wfMemcKey( 'apihelp', $this->getModuleName(),
804 SpecialVersion
::getVersion( 'nodb' ) .
805 $this->getMain()->getShowVersions() );
806 if ( $wgAPICacheHelp ) {
807 $cached = $wgMemc->get( $key );
812 $retval = $this->reallyMakeHelpMsg();
813 if ( $wgAPICacheHelp ) {
814 $wgMemc->set( $key, $retval, $wgAPICacheHelpTimeout );
819 public function reallyMakeHelpMsg() {
822 // Use parent to make default message for the main module
823 $msg = parent
::makeHelpMsg();
825 $astriks = str_repeat( '*** ', 10 );
826 $msg .= "\n\n$astriks Modules $astriks\n\n";
827 foreach ( $this->mModules
as $moduleName => $unused ) {
828 $module = new $this->mModules
[$moduleName] ( $this, $moduleName );
829 $msg .= self
::makeHelpMsgHeader( $module, 'action' );
830 $msg2 = $module->makeHelpMsg();
831 if ( $msg2 !== false ) {
837 $msg .= "\n$astriks Permissions $astriks\n\n";
838 foreach ( self
::$mRights as $right => $rightMsg ) {
839 $groups = User
::getGroupsWithPermission( $right );
840 $msg .= "* " . $right . " *\n " . wfMsgReplaceArgs( $rightMsg[ 'msg' ], $rightMsg[ 'params' ] ) .
841 "\nGranted to:\n " . str_replace( '*', 'all', implode( ', ', $groups ) ) . "\n\n";
845 $msg .= "\n$astriks Formats $astriks\n\n";
846 foreach ( $this->mFormats
as $formatName => $unused ) {
847 $module = $this->createPrinterByName( $formatName );
848 $msg .= self
::makeHelpMsgHeader( $module, 'format' );
849 $msg2 = $module->makeHelpMsg();
850 if ( $msg2 !== false ) {
856 $msg .= "\n*** Credits: ***\n " . implode( "\n ", $this->getCredits() ) . "\n";
861 public static function makeHelpMsgHeader( $module, $paramName ) {
862 $modulePrefix = $module->getModulePrefix();
863 if ( strval( $modulePrefix ) !== '' ) {
864 $modulePrefix = "($modulePrefix) ";
867 return "* $paramName={$module->getModuleName()} $modulePrefix*";
870 private $mIsBot = null;
871 private $mIsSysop = null;
872 private $mCanApiHighLimits = null;
875 * Returns true if the currently logged in user is a bot, false otherwise
876 * OBSOLETE, use canApiHighLimits() instead
878 public function isBot() {
879 if ( !isset( $this->mIsBot
) ) {
881 $this->mIsBot
= $wgUser->isAllowed( 'bot' );
883 return $this->mIsBot
;
887 * Similar to isBot(), this method returns true if the logged in user is
888 * a sysop, and false if not.
889 * OBSOLETE, use canApiHighLimits() instead
891 public function isSysop() {
892 if ( !isset( $this->mIsSysop
) ) {
894 $this->mIsSysop
= in_array( 'sysop', $wgUser->getGroups() );
897 return $this->mIsSysop
;
901 * Check whether the current user is allowed to use high limits
904 public function canApiHighLimits() {
905 if ( !isset( $this->mCanApiHighLimits
) ) {
907 $this->mCanApiHighLimits
= $wgUser->isAllowed( 'apihighlimits' );
910 return $this->mCanApiHighLimits
;
914 * Check whether the user wants us to show version information in the API help
917 public function getShowVersions() {
918 return $this->mShowVersions
;
922 * Returns the version information of this file, plus it includes
923 * the versions for all files that are not callable proper API modules
925 public function getVersion() {
927 $vers[] = 'MediaWiki: ' . SpecialVersion
::getVersion() . "\n http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/";
928 $vers[] = __CLASS__
. ': $Id$';
929 $vers[] = ApiBase
::getBaseVersion();
930 $vers[] = ApiFormatBase
::getBaseVersion();
931 $vers[] = ApiQueryBase
::getBaseVersion();
936 * Add or overwrite a module in this ApiMain instance. Intended for use by extending
937 * classes who wish to add their own modules to their lexicon or override the
938 * behavior of inherent ones.
940 * @param $mdlName String The identifier for this module.
941 * @param $mdlClass String The class where this module is implemented.
943 protected function addModule( $mdlName, $mdlClass ) {
944 $this->mModules
[$mdlName] = $mdlClass;
948 * Add or overwrite an output format for this ApiMain. Intended for use by extending
949 * classes who wish to add to or modify current formatters.
951 * @param $fmtName The identifier for this format.
952 * @param $fmtClass The class implementing this format.
954 protected function addFormat( $fmtName, $fmtClass ) {
955 $this->mFormats
[$fmtName] = $fmtClass;
959 * Get the array mapping module names to class names
961 function getModules() {
962 return $this->mModules
;
967 * This exception will be thrown when dieUsage is called to stop module execution.
968 * The exception handling code will print a help screen explaining how this API may be used.
972 class UsageException
extends Exception
{
977 public function __construct( $message, $codestr, $code = 0, $extradata = null ) {
978 parent
::__construct( $message, $code );
979 $this->mCodestr
= $codestr;
980 $this->mExtraData
= $extradata;
983 public function getCodeString() {
984 return $this->mCodestr
;
987 public function getMessageArray() {
989 'code' => $this->mCodestr
,
990 'info' => $this->getMessage()
992 if ( is_array( $this->mExtraData
) ) {
993 $result = array_merge( $result, $this->mExtraData
);
998 public function __toString() {
999 return "{$this->getCodeString()}: {$this->getMessage()}";