includes/api/ApiParamInfo.php

   1 <?php
   2
   3 /*
   4  * Created on Dec 01, 2007
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2008 Roan Kattouw <Firstname>.<Lastname>@home.nl
   9  *
  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.
  14  *
  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.
  19  *
  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
  24  */
  25
  26 if (!defined('MEDIAWIKI')) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ("ApiBase.php");
  29 }
  30
  31 /**
  32  * @ingroup API
  33  */
  34 class ApiParamInfo extends ApiBase {
  35
  36         public function __construct($main, $action) {
  37                 parent :: __construct($main, $action);
  38         }
  39
  40         public function execute() {
  41                 // Get parameters
  42                 $params = $this->extractRequestParams();
  43                 $result = $this->getResult();
  44                 $queryObj = new ApiQuery($this->getMain(), 'query');
  45                 $r = array();
  46                 if(is_array($params['modules']))
  47                 {
  48                         $modArr = $this->getMain()->getModules();
  49                         $r['modules'] = array();
  50                         foreach($params['modules'] as $m)
  51                         {
  52                                 if(!isset($modArr[$m]))
  53                                 {
  54                                         $r['modules'][] = array('name' => $m, 'missing' => '');
  55                                         continue;
  56                                 }
  57                                 $obj = new $modArr[$m]($this->getMain(), $m);
  58                                 $a = $this->getClassInfo($obj);
  59                                 $a['name'] = $m;
  60                                 $r['modules'][] = $a;
  61                         }
  62                         $result->setIndexedTagName($r['modules'], 'module');
  63                 }
  64                 if(is_array($params['querymodules']))
  65                 {
  66                         $qmodArr = $queryObj->getModules();
  67                         $r['querymodules'] = array();
  68                         foreach($params['querymodules'] as $qm)
  69                         {
  70                                 if(!isset($qmodArr[$qm]))
  71                                 {
  72                                         $r['querymodules'][] = array('name' => $qm, 'missing' => '');
  73                                         continue;
  74                                 }
  75                                 $obj = new $qmodArr[$qm]($this, $qm);
  76                                 $a = $this->getClassInfo($obj);
  77                                 $a['name'] = $qm;
  78                                 $r['querymodules'][] = $a;
  79                         }
  80                         $result->setIndexedTagName($r['querymodules'], 'module');
  81                 }
  82                 if($params['mainmodule'])
  83                         $r['mainmodule'] = $this->getClassInfo($this->getMain());
  84                 if($params['pagesetmodule'])
  85                 {
  86                         $pageSet = new ApiPageSet($queryObj);
  87                         $r['pagesetmodule'] = $this->getClassInfo($pageSet);
  88                 }
  89                 $result->addValue(null, $this->getModuleName(), $r);
  90         }
  91
  92         function getClassInfo($obj)
  93         {
  94                 $result = $this->getResult();
  95                 $retval['classname'] = get_class($obj);
  96                 $retval['description'] = implode("\n", (array)$obj->getDescription());
  97                 $retval['version'] = implode("\n", (array)$obj->getVersion());
  98                 $retval['prefix'] = $obj->getModulePrefix();
  99                 if($obj->isReadMode())
 100                         $retval['readrights'] = '';
 101                 if($obj->isWriteMode())
 102                         $retval['writerights'] = '';
 103                 if($obj->mustBePosted())
 104                         $retval['mustbeposted'] = '';
 105                 if($obj instanceof ApiQueryGeneratorBase)
 106                         $retval['generator'] = '';
 107                 $allowedParams = $obj->getFinalParams();
 108                 if(!is_array($allowedParams))
 109                         return $retval;
 110                 $retval['parameters'] = array();
 111                 $paramDesc = $obj->getFinalParamDescription();
 112                 foreach($allowedParams as $n => $p)
 113                 {
 114                         $a = array('name' => $n);
 115                         if(isset($paramDesc[$n]))
 116                                 $a['description'] = implode("\n", (array)$paramDesc[$n]);
 117                         if(isset($p[ApiBase::PARAM_DEPRECATED]) && $p[ApiBase::PARAM_DEPRECATED])
 118                                 $a['deprecated'] = '';
 119                         if(!is_array($p))
 120                         {
 121                                 if(is_bool($p))
 122                                 {
 123                                         $a['type'] = 'bool';
 124                                         $a['default'] = ($p ? 'true' : 'false');
 125                                 }
 126                                 else if(is_string($p) || is_null($p))
 127                                 {
 128                                         $a['type'] = 'string';
 129                                         $a['default'] = strval($p);
 130                                 }
 131                                 else if(is_int($p))
 132                                 {
 133                                         $a['type'] = 'integer';
 134                                         $a['default'] = intval($p);
 135                                 }
 136                                 $retval['parameters'][] = $a;
 137                                 continue;
 138                         }
 139
 140                         if(isset($p[ApiBase::PARAM_DFLT]))
 141                                 $a['default'] = $p[ApiBase::PARAM_DFLT];
 142                         if(isset($p[ApiBase::PARAM_ISMULTI]))
 143                                 if($p[ApiBase::PARAM_ISMULTI])
 144                                 {
 145                                         $a['multi'] = '';
 146                                         $a['limit'] = $this->getMain()->canApiHighLimits() ?
 147                                                         ApiBase::LIMIT_SML2 :
 148                                                         ApiBase::LIMIT_SML1;
 149                                 }
 150                         if(isset($p[ApiBase::PARAM_ALLOW_DUPLICATES]))
 151                                 if($p[ApiBase::PARAM_ALLOW_DUPLICATES])
 152                                         $a['allowsduplicates'] = '';
 153                         if(isset($p[ApiBase::PARAM_TYPE]))
 154                         {
 155                                 $a['type'] = $p[ApiBase::PARAM_TYPE];
 156                                 if(is_array($a['type']))
 157                                         $result->setIndexedTagName($a['type'], 't');
 158                         }
 159                         if(isset($p[ApiBase::PARAM_MAX]))
 160                                 $a['max'] = $p[ApiBase::PARAM_MAX];
 161                         if(isset($p[ApiBase::PARAM_MAX2]))
 162                                 $a['highmax'] = $p[ApiBase::PARAM_MAX2];
 163                         if(isset($p[ApiBase::PARAM_MIN]))
 164                                 $a['min'] = $p[ApiBase::PARAM_MIN];
 165                         $retval['parameters'][] = $a;
 166                 }
 167                 $result->setIndexedTagName($retval['parameters'], 'param');
 168                 return $retval;
 169         }
 170
 171         public function isReadMode() {
 172                 return false;
 173         }
 174
 175         public function getAllowedParams() {
 176                 return array (
 177                         'modules' => array(
 178                                 ApiBase :: PARAM_ISMULTI => true
 179                         ),
 180                         'querymodules' => array(
 181                                 ApiBase :: PARAM_ISMULTI => true
 182                         ),
 183                         'mainmodule' => false,
 184                         'pagesetmodule' => false,
 185                 );
 186         }
 187
 188         public function getParamDescription() {
 189                 return array (
 190                         'modules' => 'List of module names (value of the action= parameter)',
 191                         'querymodules' => 'List of query module names (value of prop=, meta= or list= parameter)',
 192                         'mainmodule' => 'Get information about the main (top-level) module as well',
 193                         'pagesetmodule' => 'Get information about the pageset module (providing titles= and friends) as well',
 194                 );
 195         }
 196
 197         public function getDescription() {
 198                 return 'Obtain information about certain API parameters';
 199         }
 200
 201         protected function getExamples() {
 202                 return array (
 203                         'api.php?action=paraminfo&modules=parse&querymodules=allpages|siteinfo'
 204                 );
 205         }
 206
 207         public function getVersion() {
 208                 return __CLASS__ . ': $Id$';
 209         }
 210 }