require_once ('ApiBase.php');
}
+
+/**
+ * This is the main API class, used for both external and internal processing.
+ */
class ApiMain extends ApiBase {
+ /**
+ * When no format parameter is given, this format will be used
+ */
+ const API_DEFAULT_FORMAT = 'xmlfm';
+
+ /**
+ * List of available modules: action name => module class
+ */
+ private static $Modules = array (
+ 'help' => 'ApiHelp',
+ 'login' => 'ApiLogin',
+ 'opensearch' => 'ApiOpenSearch',
+ 'feedwatchlist' => 'ApiFeedWatchlist',
+ 'query' => 'ApiQuery'
+ );
+
+ /**
+ * List of available formats: format name => format class
+ */
+ private static $Formats = array (
+ 'json' => 'ApiFormatJson',
+ 'jsonfm' => 'ApiFormatJson',
+ 'raw' => 'ApiFormatJson',
+ 'rawfm' => 'ApiFormatJson',
+ 'xml' => 'ApiFormatXml',
+ 'xmlfm' => 'ApiFormatXml',
+ 'yaml' => 'ApiFormatYaml',
+ 'yamlfm' => 'ApiFormatYaml'
+ );
+
private $mPrinter, $mModules, $mModuleNames, $mFormats, $mFormatNames;
- private $mApiStartTime, $mResult, $mShowVersions, $mEnableWrite;
+ private $mResult, $mShowVersions, $mEnableWrite, $mRequest, $mInternalMode;
/**
* Constructor
- * $apiStartTime - time of the originating call for profiling purposes
- * $modules - an array of actions (keys) and classes that handle them (values)
+ * @param $request object - if this is an instance of FauxRequest, errors are thrown and no printing occurs
+ * @param $enableWrite bool should be set to true if the api may modify data
*/
- public function __construct($apiStartTime, $modules, $formats, $enableWrite) {
+ public function __construct($request, $enableWrite = false) {
// Special handling for the main module: $parent === $this
parent :: __construct($this, 'main');
- $this->mModules = $modules;
- $this->mModuleNames = array_keys($modules);
- $this->mFormats = $formats;
- $this->mFormatNames = array_keys($formats);
- $this->mApiStartTime = $apiStartTime;
+ $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;
- // Initialize Error handler
- set_exception_handler( array($this, 'exceptionHandler') );
+ $this->mRequest =& $request;
+
+ $this->mInternalMode = ($request instanceof FauxRequest);
}
- public function & getResult() {
- return $this->mResult;
+ public function & getRequest() {
+ return $this->mRequest;
}
- public function getShowVersions() {
- return $this->mShowVersions;
+ public function & getResult() {
+ return $this->mResult;
}
public function requestWriteMode() {
$this->dieUsage('Editing of this site is disabled. Make sure the $wgEnableWriteAPI=true; ' .
'statement is included in the site\'s LocalSettings.php file', 'readonly');
}
+
+ public function createPrinterByName($format) {
+ return new $this->mFormats[$format] ($this, $format);
+ }
- protected function getAllowedParams() {
- return array (
- 'format' => array (
- ApiBase :: PARAM_DFLT => API_DEFAULT_FORMAT,
- ApiBase :: PARAM_TYPE => $this->mFormatNames
- ),
- 'action' => array (
- ApiBase :: PARAM_DFLT => 'help',
- ApiBase :: PARAM_TYPE => $this->mModuleNames
- ),
- 'version' => false
- );
+ public function execute() {
+ $this->profileIn();
+ if($this->mInternalMode)
+ $this->executeAction();
+ else
+ $this->executeActionWithErrorHandling();
+ $this->profileOut();
}
+
+ protected function executeActionWithErrorHandling() {
- protected function getParamDescription() {
- return array (
- 'format' => 'The format of the output',
- 'action' => 'What action you would like to perform',
- 'version' => 'When showing help, include version for each module'
- );
+ // In case an error occurs during data output,
+ // this clear the output buffer and print just the error information
+ ob_start();
+
+ try {
+ $this->executeAction();
+ } catch (Exception $e) {
+ //
+ // Handle any kind of exception by outputing properly formatted error message.
+ // If this fails, an unhandled exception should be thrown so that global error
+ // handler will process and log it.
+ //
+
+ // 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()
+ );
+ ApiResult :: setContent($errMessage, $this->makeHelpMsg());
+
+ } else {
+ //
+ // Something is seriously wrong
+ //
+ $errMessage = array (
+ 'code' => 'internal_api_error',
+ 'info' => "Exception Caught: {$e->getMessage()}"
+ );
+ ApiResult :: setContent($errMessage, "\n\n{$e->getTraceAsString()}\n\n");
+ }
+
+ $headerStr = 'MediaWiki-API-Error: ' . $errMessage['code'];
+ if ($e->getCode() === 0)
+ header($headerStr, true);
+ else
+ header($headerStr, true, $e->getCode());
+
+ // Reset and print just the error message
+ ob_clean();
+ $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);
+ }
+
+ ob_end_flush();
}
- public function execute() {
- $this->profileIn();
+ /**
+ * Execute the actual module, without any error handling
+ */
+ protected function executeAction() {
$action = $format = $version = null;
- try {
- extract($this->extractRequestParams());
- $this->mShowVersions = $version;
+ extract($this->extractRequestParams());
+ $this->mShowVersions = $version;
- // Create an appropriate printer
- $this->mPrinter = new $this->mFormats[$format] ($this, $format);
+ // Instantiate the module requested by the user
+ $module = new $this->mModules[$action] ($this, $action);
- // Instantiate and execute module requested by the user
- $module = new $this->mModules[$action] ($this, $action);
- $module->profileIn();
- $module->execute();
- $module->profileOut();
+ if (!$this->mInternalMode) {
+
+ // See if custom printer is used
+ $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);
-
- } catch (UsageException $e) {
- $this->printError();
}
- $this->profileOut();
}
-
+
/**
* Internal printer
*/
- private function printResult($isError) {
+ protected function printResult($isError) {
$printer = $this->mPrinter;
$printer->profileIn();
$printer->initPrinter($isError);
- if (!$printer->getNeedsRawData())
- $this->getResult()->SanitizeData();
$printer->execute();
$printer->closePrinter();
$printer->profileOut();
}
-
- private function printError() {
- // Printer may not be initialized if the extractRequestParams() fails for the main module
- if (!isset ($this->mPrinter))
- $this->mPrinter = new $this->mFormats[API_DEFAULT_FORMAT] ($this, API_DEFAULT_FORMAT);
- $this->printResult(true);
+
+ protected function getAllowedParams() {
+ return array (
+ 'format' => array (
+ ApiBase :: PARAM_DFLT => ApiMain :: API_DEFAULT_FORMAT,
+ ApiBase :: PARAM_TYPE => $this->mFormatNames
+ ),
+ 'action' => array (
+ ApiBase :: PARAM_DFLT => 'help',
+ ApiBase :: PARAM_TYPE => $this->mModuleNames
+ ),
+ 'version' => false
+ );
+ }
+
+ protected function getParamDescription() {
+ return array (
+ 'format' => 'The format of the output',
+ 'action' => 'What action you would like to perform',
+ 'version' => 'When showing help, include version for each module'
+ );
}
protected function getDescription() {
);
}
- public function mainDieUsage($description, $errorCode, $httpRespCode = 0) {
- if ($httpRespCode === 0)
- header($errorCode, true);
- else
- header($errorCode, true, $httpRespCode);
-
- $this->makeErrorMessage($description, $errorCode);
-
- throw new UsageException($description, $errorCode);
- }
-
- public function makeErrorMessage($description, $errorCode, $customContent = null) {
- $this->mResult->Reset();
- $data = array (
- 'code' => $errorCode,
- 'info' => $description
- );
-
- ApiResult :: setContent($data,
- is_null($customContent) ? $this->makeHelpMsg() : $customContent);
-
- $this->mResult->addValue(null, 'error', $data);
- }
-
/**
* Override the parent to generate help messages for all available modules.
*/
}
$msg .= "\n$astriks Formats $astriks\n\n";
- foreach ($this->mFormats as $moduleName => $moduleClass) {
- $msg .= "* format=$moduleName *";
- $module = new $this->mFormats[$moduleName] ($this, $moduleName);
+ foreach ($this->mFormats as $formatName => $moduleClass) {
+ $msg .= "* format=$formatName *";
+ $module = $this->createPrinterByName($formatName);
$msg2 = $module->makeHelpMsg();
if ($msg2 !== false)
$msg .= $msg2;
return $msg;
}
-
- /**
- * Exception handler which simulates the appropriate catch() handling:
- *
- * try {
- * ...
- * } catch ( MWException $e ) {
- * dieUsage()
- * } catch ( Exception $e ) {
- * echo $e->__toString();
- * }
- *
- *
- *
- *
- * !!!!!!!!!!!!! REVIEW needed !!!!!!!!!!!!!!!!!!
- *
- * this method needs to be reviewed/cleaned up
- *
- *
- *
- */
- public function exceptionHandler( $e ) {
- global $wgFullyInitialised;
- if ( is_a( $e, 'MWException' ) ) {
- try {
- $msg = "Exception Caught: {$e->getMessage()}";
- $this->makeErrorMessage($msg, 'internal_api_error', "\n\n{$e->getTraceAsString()}\n\n");
- $this->printError();
- } catch (Exception $e2) {
- echo $e->__toString();
- }
- } else {
- echo $e->__toString();
- }
-
- // Final cleanup, similar to wfErrorExit()
- if ( $wgFullyInitialised ) {
- try {
- wfLogProfilingData(); // uses $wgRequest, hence the $wgFullyInitialised condition
- } catch ( Exception $e ) {}
- }
-
- // Exit value should be nonzero for the benefit of shell jobs
- exit( 1 );
- }
-
private $mIsBot = null;
public function isBot() {
return $this->mIsBot;
}
+ public function getShowVersions() {
+ return $this->mShowVersions;
+ }
+
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
return $vers;
}
}
*/
class UsageException extends Exception {
- private $codestr;
+ private $mCodestr;
- public function __construct($message, $codestr) {
- parent :: __construct($message);
- $this->codestr = $codestr;
+ public function __construct($message, $codestr, $code = 0) {
+ parent :: __construct($message, $code);
+ $this->mCodestr = $codestr;
+ }
+ public function getCodeString() {
+ return $this->mCodestr;
}
public function __toString() {
- return "{$this->codestr}: {$this->message}";
+ return "{$this->getCodeString()}: {$this->getMessage()}";
}
}
?>
\ No newline at end of file
dépôts / lhc / web / wiklou.git / blobdiff