<?php
-
/*
* Created on Sep 4, 2006
*
require_once ('ApiBase.php');
}
-
/**
- * This is the main API class, used for both external and internal processing.
+ * This is the main API class, used for both external and internal processing.
+ * When executed, it will create the requested formatter object,
+ * instantiate and execute an object associated with the needed action,
+ * and use formatter to print results.
+ * In case of an exception, an error message will be printed using the same formatter.
+ *
+ * To use API from another application, run it using FauxRequest object, in which
+ * case any internal exceptions will not be handled but passed up to the caller.
+ * After successful execution, use getResult() for the resulting data.
+ *
+ * @addtogroup API
*/
class ApiMain extends ApiBase {
* List of available modules: action name => module class
*/
private static $Modules = array (
- 'help' => 'ApiHelp',
- 'login' => 'ApiLogin',
+// 'login' => 'ApiLogin', // LOGIN is temporarily disabled until it becomes more secure
+ 'query' => 'ApiQuery',
'opensearch' => 'ApiOpenSearch',
'feedwatchlist' => 'ApiFeedWatchlist',
- 'query' => 'ApiQuery'
+ 'help' => 'ApiHelp',
);
/**
private static $Formats = array (
'json' => 'ApiFormatJson',
'jsonfm' => 'ApiFormatJson',
- 'raw' => 'ApiFormatJson',
- 'rawfm' => 'ApiFormatJson',
+ 'php' => 'ApiFormatPhp',
+ 'phpfm' => 'ApiFormatPhp',
+ 'wddx' => 'ApiFormatWddx',
+ 'wddxfm' => 'ApiFormatWddx',
'xml' => 'ApiFormatXml',
'xmlfm' => 'ApiFormatXml',
'yaml' => 'ApiFormatYaml',
- 'yamlfm' => 'ApiFormatYaml'
+ 'yamlfm' => 'ApiFormatYaml',
+ 'rawfm' => 'ApiFormatJson'
);
private $mPrinter, $mModules, $mModuleNames, $mFormats, $mFormatNames;
- private $mResult, $mShowVersions, $mEnableWrite, $mRequest, $mInternalMode;
+ private $mResult, $mShowVersions, $mEnableWrite, $mRequest, $mInternalMode, $mSquidMaxage;
/**
* Constructor
* @param $enableWrite bool should be set to true if the api may modify data
*/
public function __construct($request, $enableWrite = false) {
+
+ $this->mInternalMode = ($request instanceof FauxRequest);
+
// Special handling for the main module: $parent === $this
- parent :: __construct($this, 'main');
+ parent :: __construct($this, $this->mInternalMode ? 'main_int' : 'main');
+
+ $this->mModules = self :: $Modules;
+ $this->mModuleNames = array_keys($this->mModules); // todo: optimize
+ $this->mFormats = self :: $Formats;
+ $this->mFormatNames = array_keys($this->mFormats); // todo: optimize
- $this->mModules =& self::$Modules;
- $this->mModuleNames = array_keys($this->mModules); // todo: optimize
- $this->mFormats =& self::$Formats;
- $this->mFormatNames = array_keys($this->mFormats); // todo: optimize
-
$this->mResult = new ApiResult($this);
$this->mShowVersions = false;
$this->mEnableWrite = $enableWrite;
-
- $this->mRequest =& $request;
- $this->mInternalMode = ($request instanceof FauxRequest);
+ $this->mRequest = & $request;
+
+ $this->mSquidMaxage = 0;
}
- public function & getRequest() {
+ /**
+ * Return the request object that contains client's request
+ */
+ public function getRequest() {
return $this->mRequest;
}
- public function & getResult() {
+ /**
+ * Get the ApiResult object asscosiated with current request
+ */
+ public function getResult() {
return $this->mResult;
}
+ /**
+ * This method will simply cause an error if the write mode was disabled for this api.
+ */
public function requestWriteMode() {
if (!$this->mEnableWrite)
$this->dieUsage('Editing of this site is disabled. Make sure the $wgEnableWriteAPI=true; ' .
'statement is included in the site\'s LocalSettings.php file', 'readonly');
}
-
+
+ /**
+ * Set how long the response should be cached.
+ */
+ public function setCacheMaxAge($maxage) {
+ $this->mSquidMaxage = $maxage;
+ }
+
+ /**
+ * Create an instance of an output formatter by its name
+ */
public function createPrinterByName($format) {
return new $this->mFormats[$format] ($this, $format);
}
+ /**
+ * Execute api request. Any errors will be handled if the API was called by the remote client.
+ */
public function execute() {
$this->profileIn();
- if($this->mInternalMode)
+ if ($this->mInternalMode)
$this->executeAction();
else
$this->executeActionWithErrorHandling();
$this->profileOut();
}
-
+
+ /**
+ * Execute an action, and in case of an error, erase whatever partial results
+ * have been accumulated, and replace it with an error message and a help screen.
+ */
protected function executeActionWithErrorHandling() {
// In case an error occurs during data output,
- // this clear the output buffer and print just the error information
+ // clear the output buffer and print just the error information
ob_start();
try {
// If this fails, an unhandled exception should be thrown so that global error
// handler will process and log it.
//
-
+
+ // Error results should not be cached
+ $this->setCacheMaxAge(0);
+
// Printer may not be initialized if the extractRequestParams() fails for the main module
if (!isset ($this->mPrinter)) {
$this->mPrinter = $this->createPrinterByName(self :: API_DEFAULT_FORMAT);
+ if ($this->mPrinter->getNeedsRawData())
+ $this->getResult()->setRawMode();
}
-
+
if ($e instanceof UsageException) {
//
// User entered incorrect parameters - print usage screen
//
$errMessage = array (
- 'code' => $e->getCodeString(),
- 'info' => $e->getMessage()
- );
+ 'code' => $e->getCodeString(), 'info' => $e->getMessage());
ApiResult :: setContent($errMessage, $this->makeHelpMsg());
-
+
} else {
//
// Something is seriously wrong
);
ApiResult :: setContent($errMessage, "\n\n{$e->getTraceAsString()}\n\n");
}
-
+
$headerStr = 'MediaWiki-API-Error: ' . $errMessage['code'];
if ($e->getCode() === 0)
header($headerStr, true);
// Reset and print just the error message
ob_clean();
- $this->mResult->Reset();
- $this->mResult->addValue(null, 'error', $errMessage);
+ $this->getResult()->reset();
+ $this->getResult()->addValue(null, 'error', $errMessage);
// If the error occured during printing, do a printer->profileOut()
$this->mPrinter->safeProfileOut();
$this->printResult(true);
}
-
+
+ // Set the cache expiration at the last moment, as any errors may change the expiration.
+ // if $this->mSquidMaxage == 0, the expiry time is set to the first second of unix epoch
+ $expires = $this->mSquidMaxage == 0 ? 1 : time() + $this->mSquidMaxage;
+ header('Expires: ' . wfTimestamp(TS_RFC2822, $expires));
+ header('Cache-Control: s-maxage=' . $this->mSquidMaxage . ', must-revalidate, max-age=0');
+
+ if($this->mPrinter->getIsHtml())
+ echo wfReportTime();
+
ob_end_flush();
}
$module = new $this->mModules[$action] ($this, $action);
if (!$this->mInternalMode) {
-
+
// See if custom printer is used
- $this->mPrinter = $module->getCustomPrinter();
-
+ $this->mPrinter = $module->getCustomPrinter();
if (is_null($this->mPrinter)) {
// Create an appropriate printer
$this->mPrinter = $this->createPrinterByName($format);
}
+
+ if ($this->mPrinter->getNeedsRawData())
+ $this->getResult()->setRawMode();
}
-
+
// Execute
$module->profileIn();
$module->execute();
$module->profileOut();
-
+
if (!$this->mInternalMode) {
// Print result data
$this->printResult(false);
}
}
-
+
/**
- * Internal printer
+ * Print results using the current printer
*/
protected function printResult($isError) {
$printer = $this->mPrinter;
$printer->profileIn();
$printer->initPrinter($isError);
- if (!$printer->getNeedsRawData())
- $this->getResult()->SanitizeData();
$printer->execute();
$printer->closePrinter();
$printer->profileOut();
}
+ /**
+ * See ApiBase for description.
+ */
protected function getAllowedParams() {
return array (
'format' => array (
);
}
+ /**
+ * See ApiBase for description.
+ */
protected function getParamDescription() {
return array (
'format' => 'The format of the output',
);
}
+ /**
+ * See ApiBase for description.
+ */
protected function getDescription() {
return array (
'',
'This API allows programs to access various functions of MediaWiki software.',
- 'For more details see API Home Page @ http://meta.wikimedia.org/wiki/API',
+ 'For more details see API Home Page @ http://www.mediawiki.org/wiki/API',
+ '',
+ 'Status: ALPHA -- all features shown on this page should be working,',
+ ' but the API is still in active development, and may change at any time.',
+ ' Make sure you monitor changes to this page, wikitech-l mailing list,',
+ ' or the source code in the includes/api directory for any changes.',
''
);
}
+
+ /**
+ * Returns an array of strings with credits for the API
+ */
+ protected function getCredits() {
+ return array(
+ 'This API is being implemented by Yuri Astrakhan [[User:Yurik]] / <FirstnameLastname>@gmail.com',
+ 'Please leave your comments and suggestions at http://www.mediawiki.org/wiki/API'
+ );
+ }
/**
* Override the parent to generate help messages for all available modules.
$astriks = str_repeat('*** ', 10);
$msg .= "\n\n$astriks Modules $astriks\n\n";
- foreach ($this->mModules as $moduleName => $moduleClass) {
+ foreach( $this->mModules as $moduleName => $unused ) {
$msg .= "* action=$moduleName *";
$module = new $this->mModules[$moduleName] ($this, $moduleName);
$msg2 = $module->makeHelpMsg();
}
$msg .= "\n$astriks Formats $astriks\n\n";
- foreach ($this->mFormats as $formatName => $moduleClass) {
+ foreach( $this->mFormats as $formatName => $unused ) {
$msg .= "* format=$formatName *";
$module = $this->createPrinterByName($formatName);
$msg2 = $module->makeHelpMsg();
$msg .= $msg2;
$msg .= "\n";
}
+
+ $msg .= "\n*** Credits: ***\n " . implode("\n ", $this->getCredits()) . "\n";
+
return $msg;
}
private $mIsBot = null;
+
+ /**
+ * Returns true if the currently logged in user is a bot, false otherwise
+ */
public function isBot() {
if (!isset ($this->mIsBot)) {
global $wgUser;
return $this->mShowVersions;
}
+ /**
+ * Returns the version information of this file, plus it includes
+ * the versions for all files that are not callable proper API modules
+ */
public function getVersion() {
$vers = array ();
$vers[] = __CLASS__ . ': $Id$';
$vers[] = ApiBase :: getBaseVersion();
$vers[] = ApiFormatBase :: getBaseVersion();
$vers[] = ApiQueryBase :: getBaseVersion();
- $vers[] = ApiFormatFeedWrapper :: getVersion(); // not accessible with format=xxx
+ $vers[] = ApiFormatFeedWrapper :: getVersion(); // not accessible with format=xxx
return $vers;
}
}
/**
-* @desc This exception will be thrown when dieUsage is called to stop module execution.
-*/
+ * This exception will be thrown when dieUsage is called to stop module execution.
+ * The exception handling code will print a help screen explaining how this API may be used.
+ *
+ * @addtogroup API
+ */
class UsageException extends Exception {
private $mCodestr;
return "{$this->getCodeString()}: {$this->getMessage()}";
}
}
-?>
\ No newline at end of file
+?>
dépôts / lhc / web / wiklou.git / blobdiff