includes/api/ApiParamInfo.php

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