(bug 12718) Added action=paraminfo module that provides information about API modules...

diff --git a/RELEASE-NOTES b/RELEASE-NOTES
index be15196..b5f152d 100644 (file)
--- a/RELEASE-NOTES
+++ b/RELEASE-NOTES
@@ -459,6 +459,7 @@ Full API documentation is available at http://www.mediawiki.org/wiki/API
 * prop=imageinfo interface changed: iihistory replaced by iilimit, iistart and iiend parameters
 * Added amlang parameter to meta=allmessages
 * Added apfilterlanglinks parameter to list=allpages, replacing query.php?what=nolanglinks
+* (bug 12718) Added action=paraminfo module that provides information about API modules and their parameters 
 
 === Languages updated in 1.12 ===
 

diff --git a/includes/AutoLoader.php b/includes/AutoLoader.php
index 819fbd7..8509c61 100644 (file)
--- a/includes/AutoLoader.php
+++ b/includes/AutoLoader.php
@@ -328,6 +328,7 @@ function __autoload($className) {
                'ApiMain' => 'includes/api/ApiMain.php',
                'ApiOpenSearch' => 'includes/api/ApiOpenSearch.php',
                'ApiPageSet' => 'includes/api/ApiPageSet.php',
+               'ApiParamInfo' => 'includes/api/ApiParamInfo.php',
                'ApiParse' => 'includes/api/ApiParse.php',
                'ApiQuery' => 'includes/api/ApiQuery.php',
                'ApiQueryAllpages' => 'includes/api/ApiQueryAllpages.php',

diff --git a/includes/api/ApiMain.php b/includes/api/ApiMain.php
index 4c294a4..dff4ab9 100644 (file)
--- a/includes/api/ApiMain.php
+++ b/includes/api/ApiMain.php
@@ -60,6 +60,7 @@ class ApiMain extends ApiBase {
                'opensearch' => 'ApiOpenSearch',
                'feedwatchlist' => 'ApiFeedWatchlist',
                'help' => 'ApiHelp',
+               'paraminfo' => 'ApiParamInfo',
        );
        
        private static $WriteModules = array (

diff --git a/includes/api/ApiParamInfo.php b/includes/api/ApiParamInfo.php
new file mode 100644 (file)
index 0000000..cc52702
--- /dev/null
+++ b/includes/api/ApiParamInfo.php
@@ -0,0 +1,152 @@
+<?php\r
+\r
+/*\r
+ * Created on Dec 01, 2007\r
+ *\r
+ * API for MediaWiki 1.8+\r
+ *\r
+ * Copyright (C) 2008 Roan Kattouw <Firstname>.<Lastname>@home.nl\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
+ * @addtogroup API\r
+ */\r
+class ApiParamInfo extends ApiBase {\r
+\r
+       public function __construct($main, $action) {\r
+               parent :: __construct($main, $action);\r
+       }\r
+\r
+       public function execute() {\r
+               // Get parameters\r
+               $params = $this->extractRequestParams();\r
+               $result = $this->getResult();\r
+               $r = array();\r
+               if(is_array($params['modules']))\r
+                       foreach($params['modules'] as $m)\r
+                       {\r
+                               $className = "Api$m";\r
+                               if(!class_exists($className))\r
+                               {\r
+                                       $mods[$m] = array('missing' => '');\r
+                                       continue;\r
+                               }\r
+                               $obj = new $className($this->getMain(), $m);\r
+                               $r['modules'][$m] = $this->getClassInfo($obj);                          \r
+                       }\r
+               if(is_array($params['querymodules']))\r
+                       foreach($params['querymodules'] as $qm)\r
+                       {\r
+                               $className = "ApiQuery$qm";\r
+                               if(!class_exists($className))\r
+                               {\r
+                                       $qmods[$qm] = array('missing' => '');\r
+                                       continue;\r
+                               }\r
+                               $obj = new $className($this, 'query');\r
+                               $r['querymodules'][$qm] = $this->getClassInfo($obj);\r
+                       }\r
+               $result->addValue( null, $this->getModuleName(), $r );\r
+       }\r
+\r
+       function getClassInfo($obj)\r
+       {\r
+               $result = $this->getResult();\r
+               $retval['classname'] = get_class($obj);\r
+               $retval['description'] = (is_array($obj->getDescription()) ? implode("\n", $obj->getDescription()) : $obj->getDescription());\r
+               $allowedParams = $obj->getAllowedParams();\r
+               if(!is_array($allowedParams))\r
+                       return $retval;\r
+               $retval['parameters'] = array();\r
+               foreach($obj->getAllowedParams() as $n => $p)\r
+               {\r
+                       $a = array('name' => $n);\r
+                       if(!is_array($p))\r
+                       {\r
+                               if(is_bool($p))\r
+                               {\r
+                                       $a['type'] = 'bool';\r
+                                       $a['default'] = ($p ? 'true' : 'false');\r
+                               }\r
+                               if(is_string($p))\r
+                                       $a['default'] = $p;\r
+                               $retval['parameters'][] = $a;\r
+                               continue;\r
+                       }\r
+                                       \r
+                       if(isset($p[ApiBase::PARAM_DFLT]))\r
+                               $a['default'] = $p[ApiBase::PARAM_DFLT];\r
+                       if(isset($p[ApiBase::PARAM_ISMULTI]))\r
+                               if($p[ApiBase::PARAM_ISMULTI])\r
+                                       $a['multi'] = '';\r
+                       if(isset($p[ApiBase::PARAM_TYPE]))\r
+                       {\r
+                               $a['type'] = $p[ApiBase::PARAM_TYPE];\r
+                               if(is_array($a['type']))\r
+                                       $result->setIndexedTagName($a['type'], 't');\r
+                       }\r
+                       if(isset($p[ApiBase::PARAM_MAX]))\r
+                               $a['max'] = $p[ApiBase::PARAM_MAX];\r
+                       if(isset($p[ApiBase::PARAM_MAX2]))\r
+                               $a['highmax'] = $p[ApiBase::PARAM_MAX2];\r
+                       if(isset($p[ApiBase::PARAM_MIN]))\r
+                               $a['min'] = $p[ApiBase::PARAM_MIN];\r
+                       $retval['parameters'][] = $a;\r
+               }\r
+               $result->setIndexedTagName($retval['parameters'], 'param');\r
+               return $retval;\r
+       }\r
+       \r
+       protected function getAllowedParams() {\r
+               return array (\r
+                       'modules' => array(\r
+                               ApiBase :: PARAM_ISMULTI => true\r
+                       ),\r
+                       'querymodules' => array(\r
+                               ApiBase :: PARAM_ISMULTI => true\r
+                       )\r
+               );\r
+       }\r
+\r
+       protected function getParamDescription() {\r
+               return array (\r
+                       'modules' => 'List of module names (value of the action= parameter)',\r
+                       'querymodules' => 'List of query module names (value of prop=, meta= or list= parameter)',\r
+               );\r
+       }\r
+\r
+       protected function getDescription() {\r
+               return 'Obtain information about certain API parameters';\r
+       }\r
+\r
+       protected function getExamples() {\r
+               return array (\r
+                       'api.php?action=paraminfo&modules=parse&querymodules=allpages|siteinfo'\r
+               );\r
+       }\r
+\r
+       public function getVersion() {\r
+               return __CLASS__ . ': $Id: ApiParse.php 29810 2008-01-15 21:33:08Z catrope $';\r
+       }\r
+}\r
+\r