-<?php\r
-\r
-\r
-/*\r
- * Created on Sep 4, 2006\r
- *\r
- * API for MediaWiki 1.8+\r
- *\r
- * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>\r
- *\r
- * This program is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; either version 2 of the License, or\r
- * (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License along\r
- * with this program; if not, write to the Free Software Foundation, Inc.,\r
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
- * http://www.gnu.org/copyleft/gpl.html\r
- */\r
-\r
-if (!defined('MEDIAWIKI')) {\r
- // Eclipse helper - will be ignored in production\r
- require_once ("ApiBase.php");\r
-}\r
-\r
-/**\r
-* @desc This exception will be thrown when DieUsage is called to stop module execution.\r
-*/\r
-class UsageException extends Exception {\r
- var $codestr;\r
-\r
- public function __construct($message, $codestr) {\r
- parent :: __construct($message);\r
- $this->codestr = $codestr;\r
- }\r
- public function __toString() {\r
- return "{$this->codestr}: {$this->message}";\r
- }\r
-}\r
-\r
-class ApiMain extends ApiBase {\r
-\r
- private $mPrinter, $mModules, $mModuleNames, $mFormats, $mFormatNames, $mApiStartTime, $mResult;\r
-\r
- /**\r
- * Constructor\r
- * $apiStartTime - time of the originating call for profiling purposes\r
- * $modules - an array of actions (keys) and classes that handle them (values) \r
- */\r
- public function __construct($apiStartTime, $modules, $formats) {\r
- // Special handling for the main module: $parent === $this\r
- parent :: __construct($this);\r
-\r
- $this->mModules = $modules;\r
- $this->mModuleNames = array_keys($modules);\r
- $this->mFormats = $formats;\r
- $this->mFormatNames = array_keys($formats);\r
- $this->mApiStartTime = $apiStartTime;\r
- $this->mResult = new ApiResult($this);\r
- }\r
-\r
- public function GetResult() {\r
- return $this->mResult;\r
- }\r
-\r
- protected function GetAllowedParams() {\r
- return array (\r
- 'format' => array (\r
- GN_ENUM_DFLT => API_DEFAULT_FORMAT,\r
- GN_ENUM_CHOICES => $this->mFormatNames\r
- ),\r
- 'action' => array (\r
- GN_ENUM_DFLT => 'help',\r
- GN_ENUM_CHOICES => $this->mModuleNames\r
- )\r
- );\r
- }\r
-\r
- protected function GetParamDescription() {\r
- return array (\r
- 'format' => 'The format of the output',\r
- 'action' => 'What action you would like to perform'\r
- );\r
- }\r
-\r
- public function Execute() {\r
- $action = $format = null;\r
- try {\r
- extract($this->ExtractRequestParams());\r
-\r
- // Create an appropriate printer\r
- $this->mPrinter = new $this->mFormats[$format] ($this, $format);\r
-\r
- // Instantiate and execute module requested by the user\r
- $module = new $this->mModules[$action] ($this, $action);\r
- $module->Execute();\r
- $this->PrintResult(false);\r
- } catch (UsageException $e) {\r
- // Printer may not be initialized if the ExtractRequestParams() fails for the main module\r
- if (!isset ($this->mPrinter))\r
- $this->mPrinter = new $this->mFormats[API_DEFAULT_FORMAT] ($this, API_DEFAULT_FORMAT);\r
- $this->PrintResult(true);\r
- }\r
- }\r
-\r
- /**\r
- * Internal printer\r
- */\r
- private function PrintResult($isError) {\r
- $this->mPrinter->InitPrinter($isError);\r
- if (!$this->mPrinter->GetNeedsRawData())\r
- $this->GetResult()->SanitizeData();\r
- $this->mPrinter->Execute();\r
- $this->mPrinter->ClosePrinter();\r
- }\r
-\r
- protected function GetDescription() {\r
- return array (\r
- '',\r
- 'This API allows programs to access various functions of MediaWiki software.',\r
- ''\r
- );\r
- }\r
-\r
- public function MainDieUsage($description, $errorCode, $httpRespCode = 0) {\r
- $this->mResult->Reset();\r
- $this->mResult->addMessage('error', null, $errorCode);\r
- if ($httpRespCode === 0)\r
- header($errorCode, true);\r
- else\r
- header($errorCode, true, $httpRespCode);\r
-\r
- $this->mResult->addMessage('usage', null, $this->MakeHelpMsg());\r
-\r
- throw new UsageException($description, $errorCode);\r
- }\r
-\r
- /**\r
- * Override the parent to generate help messages for all available modules.\r
- */\r
- public function MakeHelpMsg() {\r
-\r
- // Use parent to make default message for the main module\r
- $msg = parent :: MakeHelpMsg();\r
-\r
- $astriks = str_repeat('*** ', 10);\r
- $msg .= "\n\n$astriks Modules $astriks\n\n";\r
- foreach ($this->mModules as $moduleName => $moduleClass) {\r
- $msg .= "* action=$moduleName *";\r
- $module = new $this->mModules[$moduleName] ($this, $moduleName);\r
- $msg2 = $module->MakeHelpMsg();\r
- if ($msg2 !== false)\r
- $msg .= $msg2;\r
- $msg .= "\n";\r
- }\r
-\r
- $msg .= "\n$astriks Formats $astriks\n\n";\r
- foreach ($this->mFormats as $moduleName => $moduleClass) {\r
- $msg .= "* format=$moduleName *";\r
- $module = new $this->mFormats[$moduleName] ($this, $moduleName);\r
- $msg2 = $module->MakeHelpMsg();\r
- if ($msg2 !== false)\r
- $msg .= $msg2;\r
- $msg .= "\n";\r
- }\r
-\r
- return $msg;\r
- }\r
-}\r
+<?php
+
+
+/*
+ * Created on Sep 4, 2006
+ *
+ * API for MediaWiki 1.8+
+ *
+ * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ */
+
+if (!defined('MEDIAWIKI')) {
+ // Eclipse helper - will be ignored in production
+ require_once ('ApiBase.php');
+}
+
+class ApiMain extends ApiBase {
+
+ private $mPrinter, $mModules, $mModuleNames, $mFormats, $mFormatNames, $mApiStartTime, $mResult, $mShowVersions;
+
+ /**
+ * Constructor
+ * $apiStartTime - time of the originating call for profiling purposes
+ * $modules - an array of actions (keys) and classes that handle them (values)
+ */
+ public function __construct($apiStartTime, $modules, $formats) {
+ // Special handling for the main module: $parent === $this
+ parent :: __construct($this);
+
+ $this->mModules = $modules;
+ $this->mModuleNames = array_keys($modules);
+ $this->mFormats = $formats;
+ $this->mFormatNames = array_keys($formats);
+ $this->mApiStartTime = $apiStartTime;
+ $this->mResult = new ApiResult($this);
+ $this->mShowVersions = false;
+ }
+
+ public function & getResult() {
+ return $this->mResult;
+ }
+
+ public function getShowVersions() {
+ return $this->mShowVersions;
+ }
+
+ 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
+ );
+ }
+
+ 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'
+ );
+ }
+
+ public function execute() {
+ $this->profileIn();
+ $action = $format = $version = null;
+ try {
+ extract($this->extractRequestParams());
+ $this->mShowVersions = $version;
+
+ // Create an appropriate printer
+ $this->mPrinter = new $this->mFormats[$format] ($this, $format);
+
+ // Instantiate and execute module requested by the user
+ $module = new $this->mModules[$action] ($this, $action);
+ $module->profileIn();
+ $module->execute();
+ $module->profileOut();
+ $this->printResult(false);
+
+ } catch (UsageException $e) {
+
+ // 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);
+
+ }
+ $this->profileOut();
+ }
+
+ /**
+ * Internal printer
+ */
+ private function printResult($isError) {
+ $printer = $this->mPrinter;
+ $printer->profileIn();
+ $printer->initPrinter($isError);
+ if (!$printer->getNeedsRawData())
+ $this->getResult()->SanitizeData();
+ $printer->execute();
+ $printer->closePrinter();
+ $printer->profileOut();
+ }
+
+ 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',
+ ''
+ );
+ }
+
+ public function mainDieUsage($description, $errorCode, $httpRespCode = 0) {
+ $this->mResult->Reset();
+ if ($httpRespCode === 0)
+ header($errorCode, true);
+ else
+ header($errorCode, true, $httpRespCode);
+
+ $data = array (
+ 'code' => $errorCode
+ );
+ ApiResult :: setContent($data, $this->makeHelpMsg());
+ $this->mResult->addValue(null, 'error', $data);
+
+ throw new UsageException($description, $errorCode);
+ }
+
+ /**
+ * Override the parent to generate help messages for all available modules.
+ */
+ public function makeHelpMsg() {
+
+ // Use parent to make default message for the main module
+ $msg = parent :: makeHelpMsg();
+
+ $astriks = str_repeat('*** ', 10);
+ $msg .= "\n\n$astriks Modules $astriks\n\n";
+ foreach ($this->mModules as $moduleName => $moduleClass) {
+ $msg .= "* action=$moduleName *";
+ $module = new $this->mModules[$moduleName] ($this, $moduleName);
+ $msg2 = $module->makeHelpMsg();
+ if ($msg2 !== false)
+ $msg .= $msg2;
+ $msg .= "\n";
+ }
+
+ $msg .= "\n$astriks Formats $astriks\n\n";
+ foreach ($this->mFormats as $moduleName => $moduleClass) {
+ $msg .= "* format=$moduleName *";
+ $module = new $this->mFormats[$moduleName] ($this, $moduleName);
+ $msg2 = $module->makeHelpMsg();
+ if ($msg2 !== false)
+ $msg .= $msg2;
+ $msg .= "\n";
+ }
+
+ return $msg;
+ }
+
+ private $mIsBot = null;
+ public function isBot() {
+ if (!isset ($this->mIsBot)) {
+ global $wgUser;
+ $this->mIsBot = $wgUser->isAllowed('bot');
+ }
+ return $this->mIsBot;
+ }
+
+ public function getVersion() {
+
+ return array (
+ parent :: getVersion(), __CLASS__ . ': $Id$', ApiFormatBase :: getBaseVersion());
+ }
+}
+
+/**
+* @desc This exception will be thrown when dieUsage is called to stop module execution.
+*/
+class UsageException extends Exception {
+
+ private $codestr;
+
+ public function __construct($message, $codestr) {
+ parent :: __construct($message);
+ $this->codestr = $codestr;
+ }
+ public function __toString() {
+ return "{$this->codestr}: {$this->message}";
+ }
+}
?>
\ No newline at end of file