includes/api/ApiQuerySiteinfo.php

   1 <?php
   2
   3
   4 /*
   5  * Created on Sep 25, 2006
   6  *
   7  * API for MediaWiki 1.8+
   8  *
   9  * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License along
  22  * with this program; if not, write to the Free Software Foundation, Inc.,
  23  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  24  * http://www.gnu.org/copyleft/gpl.html
  25  */
  26
  27 if (!defined('MEDIAWIKI')) {
  28         // Eclipse helper - will be ignored in production
  29         require_once ('ApiQueryBase.php');
  30 }
  31
  32 class ApiQuerySiteinfo extends ApiQueryBase {
  33
  34         public function __construct($query, $moduleName) {
  35                 parent :: __construct($query, $moduleName);
  36         }
  37
  38         public function execute() {
  39                 $siprop = null;
  40                 extract($this->extractRequestParams());
  41
  42                 foreach ($siprop as $prop) {
  43                         switch ($prop) {
  44
  45                                 case 'general' :
  46
  47                                         global $wgSitename, $wgVersion, $wgCapitalLinks;
  48                                         $data = array ();
  49                                         $mainPage = Title :: newFromText(wfMsgForContent('mainpage'));
  50                                         $data['mainpage'] = $mainPage->getText();
  51                                         $data['base'] = $mainPage->getFullUrl();
  52                                         $data['sitename'] = $wgSitename;
  53                                         $data['generator'] = "MediaWiki $wgVersion";
  54                                         $data['case'] = $wgCapitalLinks ? 'first-letter' : 'case-sensitive'; // 'case-insensitive' option is reserved for future
  55                                         $this->getResult()->addValue('query', $prop, $data);
  56                                         break;
  57
  58                                 case 'namespaces' :
  59
  60                                         global $wgContLang;
  61                                         $data = array ();
  62                                         foreach ($wgContLang->getFormattedNamespaces() as $ns => $title) {
  63                                                 $data[$ns] = array (
  64                                                         'id' => $ns
  65                                                 );
  66                                                 ApiResult :: setContent($data[$ns], $title);
  67                                         }
  68                                         ApiResult :: setIndexedTagName($data, 'ns');
  69                                         $this->getResult()->addValue('query', $prop, $data);
  70                                         break;
  71
  72                                 default :
  73                                         ApiBase :: dieDebug(__METHOD__, "Unknown siprop=$prop");
  74                         }
  75                 }
  76         }
  77
  78         protected function getAllowedParams() {
  79                 return array (
  80                         'siprop' => array (
  81                                 ApiBase :: PARAM_DFLT => 'general',
  82                                 ApiBase :: PARAM_ISMULTI => true,
  83                                 ApiBase :: PARAM_TYPE => array (
  84                                         'general',
  85                                         'namespaces'
  86                                 )
  87                         )
  88                 );
  89         }
  90
  91         protected function getParamDescription() {
  92                 return array (
  93                         'siprop' => array (
  94                                 'Which sysinfo properties to get:',
  95                                 ' "general"    - Overall system information',
  96                                 ' "namespaces" - List of registered namespaces (localized)'
  97                         )
  98                 );
  99         }
 100
 101         protected function getDescription() {
 102                 return 'Return general information about the site.';
 103         }
 104
 105         protected function getExamples() {
 106                 return 'api.php?action=query&meta=siteinfo&siprop=general|namespaces';
 107         }
 108 }
 109 ?>