4 * Created on Sep 4, 2006
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ('ApiBase.php');
32 * This is the main API class, used for both external and internal processing.
33 * When executed, it will create the requested formatter object,
34 * instantiate and execute an object associated with the needed action,
35 * and use formatter to print results.
36 * In case of an exception, an error message will be printed using the same formatter.
38 * To use API from another application, run it using FauxRequest object, in which
39 * case any internal exceptions will not be handled but passed up to the caller.
40 * After successful execution, use getResult() for the resulting data.
44 class ApiMain
extends ApiBase
{
47 * When no format parameter is given, this format will be used
49 const API_DEFAULT_FORMAT
= 'xmlfm';
52 * List of available modules: action name => module class
54 private static $Modules = array (
55 'login' => 'ApiLogin',
56 'query' => 'ApiQuery',
57 'expandtemplates' => 'ApiExpandTemplates',
58 'render' => 'ApiRender',
59 'parse' => 'ApiParse',
60 'rollback' => 'ApiRollback',
61 'delete' => 'ApiDelete',
62 'undelete' => 'ApiUndelete',
63 'protect' => 'ApiProtect',
64 'block' => 'ApiBlock',
65 'unblock' => 'ApiUnblock',
66 'changerights' => 'ApiChangeRights',
68 'opensearch' => 'ApiOpenSearch',
69 'feedwatchlist' => 'ApiFeedWatchlist',
74 * List of available formats: format name => format class
76 private static $Formats = array (
77 'json' => 'ApiFormatJson',
78 'jsonfm' => 'ApiFormatJson',
79 'php' => 'ApiFormatPhp',
80 'phpfm' => 'ApiFormatPhp',
81 'wddx' => 'ApiFormatWddx',
82 'wddxfm' => 'ApiFormatWddx',
83 'xml' => 'ApiFormatXml',
84 'xmlfm' => 'ApiFormatXml',
85 'yaml' => 'ApiFormatYaml',
86 'yamlfm' => 'ApiFormatYaml',
87 'rawfm' => 'ApiFormatJson'
90 private $mPrinter, $mModules, $mModuleNames, $mFormats, $mFormatNames;
91 private $mResult, $mAction, $mShowVersions, $mEnableWrite, $mRequest, $mInternalMode, $mSquidMaxage;
94 * Constructs an instance of ApiMain that utilizes the module and format specified by $request.
96 * @param $request object - if this is an instance of FauxRequest, errors are thrown and no printing occurs
97 * @param $enableWrite bool should be set to true if the api may modify data
99 public function __construct($request, $enableWrite = false) {
101 $this->mInternalMode
= ($request instanceof FauxRequest
);
103 // Special handling for the main module: $parent === $this
104 parent
:: __construct($this, $this->mInternalMode ?
'main_int' : 'main');
106 if (!$this->mInternalMode
) {
108 // Impose module restrictions.
109 // If the current user cannot read,
110 // Remove all modules other than login
112 if (!$wgUser->isAllowed('read')) {
113 self
::$Modules = array(
114 'login' => self
::$Modules['login'],
115 'help' => self
::$Modules['help']
120 global $wgAPIModules; // extension modules
121 $this->mModules
= $wgAPIModules + self
:: $Modules;
123 $this->mModuleNames
= array_keys($this->mModules
); // todo: optimize
124 $this->mFormats
= self
:: $Formats;
125 $this->mFormatNames
= array_keys($this->mFormats
); // todo: optimize
127 $this->mResult
= new ApiResult($this);
128 $this->mShowVersions
= false;
129 $this->mEnableWrite
= $enableWrite;
131 $this->mRequest
= & $request;
133 $this->mSquidMaxage
= 0;
137 * Return true if the API was started by other PHP code using FauxRequest
139 public function isInternalMode() {
140 return $this->mInternalMode
;
144 * Return the request object that contains client's request
146 public function getRequest() {
147 return $this->mRequest
;
151 * Get the ApiResult object asscosiated with current request
153 public function getResult() {
154 return $this->mResult
;
158 * This method will simply cause an error if the write mode was disabled for this api.
160 public function requestWriteMode() {
161 if (!$this->mEnableWrite
)
162 $this->dieUsage('Editing of this site is disabled. Make sure the $wgEnableWriteAPI=true; ' .
163 'statement is included in the site\'s LocalSettings.php file', 'readonly');
167 * Set how long the response should be cached.
169 public function setCacheMaxAge($maxage) {
170 $this->mSquidMaxage
= $maxage;
174 * Create an instance of an output formatter by its name
176 public function createPrinterByName($format) {
177 return new $this->mFormats
[$format] ($this, $format);
181 * Execute api request. Any errors will be handled if the API was called by the remote client.
183 public function execute() {
185 if ($this->mInternalMode
)
186 $this->executeAction();
188 $this->executeActionWithErrorHandling();
193 * Execute an action, and in case of an error, erase whatever partial results
194 * have been accumulated, and replace it with an error message and a help screen.
196 protected function executeActionWithErrorHandling() {
198 // In case an error occurs during data output,
199 // clear the output buffer and print just the error information
203 $this->executeAction();
204 } catch (Exception
$e) {
206 // Handle any kind of exception by outputing properly formatted error message.
207 // If this fails, an unhandled exception should be thrown so that global error
208 // handler will process and log it.
211 $errCode = $this->substituteResultWithError($e);
213 // Error results should not be cached
214 $this->setCacheMaxAge(0);
216 $headerStr = 'MediaWiki-API-Error: ' . $errCode;
217 if ($e->getCode() === 0)
218 header($headerStr, true);
220 header($headerStr, true, $e->getCode());
222 // Reset and print just the error message
225 // If the error occured during printing, do a printer->profileOut()
226 $this->mPrinter
->safeProfileOut();
227 $this->printResult(true);
230 // Set the cache expiration at the last moment, as any errors may change the expiration.
231 // if $this->mSquidMaxage == 0, the expiry time is set to the first second of unix epoch
232 $expires = $this->mSquidMaxage
== 0 ?
1 : time() +
$this->mSquidMaxage
;
233 header('Expires: ' . wfTimestamp(TS_RFC2822
, $expires));
234 header('Cache-Control: s-maxage=' . $this->mSquidMaxage
. ', must-revalidate, max-age=0');
236 if($this->mPrinter
->getIsHtml())
243 * Replace the result data with the information about an exception.
244 * Returns the error code
246 protected function substituteResultWithError($e) {
248 // Printer may not be initialized if the extractRequestParams() fails for the main module
249 if (!isset ($this->mPrinter
)) {
250 // The printer has not been created yet. Try to manually get formatter value.
251 $value = $this->getRequest()->getVal('format', self
::API_DEFAULT_FORMAT
);
252 if (!in_array($value, $this->mFormatNames
))
253 $value = self
::API_DEFAULT_FORMAT
;
255 $this->mPrinter
= $this->createPrinterByName($value);
256 if ($this->mPrinter
->getNeedsRawData())
257 $this->getResult()->setRawMode();
260 if ($e instanceof UsageException
) {
262 // User entered incorrect parameters - print usage screen
264 $errMessage = array (
265 'code' => $e->getCodeString(),
266 'info' => $e->getMessage());
268 // Only print the help message when this is for the developer, not runtime
269 if ($this->mPrinter
->getIsHtml() ||
$this->mAction
== 'help')
270 ApiResult
:: setContent($errMessage, $this->makeHelpMsg());
274 // Something is seriously wrong
276 $errMessage = array (
277 'code' => 'internal_api_error_'. get_class($e),
278 'info' => "Exception Caught: {$e->getMessage()}"
280 ApiResult
:: setContent($errMessage, "\n\n{$e->getTraceAsString()}\n\n");
283 $this->getResult()->reset();
284 $this->getResult()->addValue(null, 'error', $errMessage);
286 return $errMessage['code'];
290 * Execute the actual module, without any error handling
292 protected function executeAction() {
294 $params = $this->extractRequestParams();
296 $this->mShowVersions
= $params['version'];
297 $this->mAction
= $params['action'];
299 // Instantiate the module requested by the user
300 $module = new $this->mModules
[$this->mAction
] ($this, $this->mAction
);
302 if( $module->shouldCheckMaxlag() && isset( $params['maxlag'] ) ) {
304 global $wgLoadBalancer, $wgShowHostnames;
305 $maxLag = $params['maxlag'];
306 list( $host, $lag ) = $wgLoadBalancer->getMaxLag();
307 if ( $lag > $maxLag ) {
308 if( $wgShowHostnames ) {
309 ApiBase
:: dieUsage( "Waiting for $host: $lag seconds lagged", 'maxlag' );
311 ApiBase
:: dieUsage( "Waiting for a database server: $lag seconds lagged", 'maxlag' );
317 if (!$this->mInternalMode
) {
319 // See if custom printer is used
320 $this->mPrinter
= $module->getCustomPrinter();
321 if (is_null($this->mPrinter
)) {
322 // Create an appropriate printer
323 $this->mPrinter
= $this->createPrinterByName($params['format']);
326 if ($this->mPrinter
->getNeedsRawData())
327 $this->getResult()->setRawMode();
329 if( $this->mAction
== 'help' )
330 $this->mPrinter
->setHelp();
334 $module->profileIn();
336 $module->profileOut();
338 if (!$this->mInternalMode
) {
340 $this->printResult(false);
345 * Print results using the current printer
347 protected function printResult($isError) {
348 $printer = $this->mPrinter
;
349 $printer->profileIn();
351 /* If the help message is requested in the default (xmlfm) format,
352 * tell the printer not to escape ampersands so that our links do
354 $params = $this->extractRequestParams();
355 $printer->setUnescapeAmps ( ( $this->mAction
== 'help' ||
$isError )
356 && $params['format'] == ApiMain
::API_DEFAULT_FORMAT
);
358 $printer->initPrinter($isError);
361 $printer->closePrinter();
362 $printer->profileOut();
366 * See ApiBase for description.
368 protected function getAllowedParams() {
371 ApiBase
:: PARAM_DFLT
=> ApiMain
:: API_DEFAULT_FORMAT
,
372 ApiBase
:: PARAM_TYPE
=> $this->mFormatNames
375 ApiBase
:: PARAM_DFLT
=> 'help',
376 ApiBase
:: PARAM_TYPE
=> $this->mModuleNames
380 ApiBase
:: PARAM_TYPE
=> 'integer'
386 * See ApiBase for description.
388 protected function getParamDescription() {
390 'format' => 'The format of the output',
391 'action' => 'What action you would like to perform',
392 'version' => 'When showing help, include version for each module',
393 'maxlag' => 'Maximum lag'
398 * See ApiBase for description.
400 protected function getDescription() {
404 '******************************************************************',
406 '** This is an auto-generated MediaWiki API documentation page **',
408 '** Documentation and Examples: **',
409 '** http://www.mediawiki.org/wiki/API **',
411 '******************************************************************',
413 'Status: All features shown on this page should be working, but the API',
414 ' is still in active development, and may change at any time.',
415 ' Make sure to monitor our mailing list for any updates.',
417 'Documentation: http://www.mediawiki.org/wiki/API',
418 'Mailing list: http://lists.wikimedia.org/mailman/listinfo/mediawiki-api',
419 'Bugs & Requests: http://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts',
429 * Returns an array of strings with credits for the API
431 protected function getCredits() {
433 'This API is being implemented by Yuri Astrakhan [[User:Yurik]] / <Firstname><Lastname>@gmail.com',
434 'Please leave your comments and suggestions at http://www.mediawiki.org/wiki/API'
439 * Override the parent to generate help messages for all available modules.
441 public function makeHelpMsg() {
443 // Use parent to make default message for the main module
444 $msg = parent
:: makeHelpMsg();
446 $astriks = str_repeat('*** ', 10);
447 $msg .= "\n\n$astriks Modules $astriks\n\n";
448 foreach( $this->mModules
as $moduleName => $unused ) {
449 $module = new $this->mModules
[$moduleName] ($this, $moduleName);
450 $msg .= self
::makeHelpMsgHeader($module, 'action');
451 $msg2 = $module->makeHelpMsg();
457 $msg .= "\n$astriks Formats $astriks\n\n";
458 foreach( $this->mFormats
as $formatName => $unused ) {
459 $module = $this->createPrinterByName($formatName);
460 $msg .= self
::makeHelpMsgHeader($module, 'format');
461 $msg2 = $module->makeHelpMsg();
467 $msg .= "\n*** Credits: ***\n " . implode("\n ", $this->getCredits()) . "\n";
473 public static function makeHelpMsgHeader($module, $paramName) {
474 $modulePrefix = $module->getModulePrefix();
475 if (!empty($modulePrefix))
476 $modulePrefix = "($modulePrefix) ";
478 return "* $paramName={$module->getModuleName()} $modulePrefix*";
481 private $mIsBot = null;
482 private $mIsSysop = null;
483 private $mCanApiHighLimits = null;
486 * Returns true if the currently logged in user is a bot, false otherwise
487 * OBSOLETE, use canApiHighLimits() instead
489 public function isBot() {
490 if (!isset ($this->mIsBot
)) {
492 $this->mIsBot
= $wgUser->isAllowed('bot');
494 return $this->mIsBot
;
498 * Similar to isBot(), this method returns true if the logged in user is
499 * a sysop, and false if not.
500 * OBSOLETE, use canApiHighLimits() instead
502 public function isSysop() {
503 if (!isset ($this->mIsSysop
)) {
505 $this->mIsSysop
= in_array( 'sysop', $wgUser->getGroups());
508 return $this->mIsSysop
;
511 public function canApiHighLimits() {
512 if (!isset($this->mCanApiHighLimits
)) {
514 $this->mCanApiHighLimits
= $wgUser->isAllowed('apihighlimits');
517 return $this->mCanApiHighLimits
;
520 public function getShowVersions() {
521 return $this->mShowVersions
;
525 * Returns the version information of this file, plus it includes
526 * the versions for all files that are not callable proper API modules
528 public function getVersion() {
530 $vers[] = 'MediaWiki ' . SpecialVersion
::getVersion();
531 $vers[] = __CLASS__
. ': $Id$';
532 $vers[] = ApiBase
:: getBaseVersion();
533 $vers[] = ApiFormatBase
:: getBaseVersion();
534 $vers[] = ApiQueryBase
:: getBaseVersion();
535 $vers[] = ApiFormatFeedWrapper
:: getVersion(); // not accessible with format=xxx
540 * Add or overwrite a module in this ApiMain instance. Intended for use by extending
541 * classes who wish to add their own modules to their lexicon or override the
542 * behavior of inherent ones.
545 * @param $mdlName String The identifier for this module.
546 * @param $mdlClass String The class where this module is implemented.
548 protected function addModule( $mdlName, $mdlClass ) {
549 $this->mModules
[$mdlName] = $mdlClass;
553 * Add or overwrite an output format for this ApiMain. Intended for use by extending
554 * classes who wish to add to or modify current formatters.
557 * @param $fmtName The identifier for this format.
558 * @param $fmtClass The class implementing this format.
560 protected function addFormat( $fmtName, $fmtClass ) {
561 $this->mFormats
[$fmtName] = $fmtClass;
566 * This exception will be thrown when dieUsage is called to stop module execution.
567 * The exception handling code will print a help screen explaining how this API may be used.
571 class UsageException
extends Exception
{
575 public function __construct($message, $codestr, $code = 0) {
576 parent
:: __construct($message, $code);
577 $this->mCodestr
= $codestr;
579 public function getCodeString() {
580 return $this->mCodestr
;
582 public function __toString() {
583 return "{$this->getCodeString()}: {$this->getMessage()}";