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, 'si');
  36         }
  37
  38         public function execute() {
  39                 $prop = null;
  40                 extract($this->extractRequestParams());
  41
  42                 foreach ($prop as $p) {
  43                         switch ($p) {
  44
  45                                 case 'general' :
  46
  47                                         global $wgSitename, $wgVersion, $wgCapitalLinks, $wgRightsCode, $wgRightsText;
  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                                         if (isset($wgRightsCode))
  56                                                 $data['rightscode'] = $wgRightsCode;
  57                                         $data['rights'] = $wgRightsText;
  58                                         $this->getResult()->addValue('query', $p, $data);
  59                                         break;
  60
  61                                 case 'namespaces' :
  62
  63                                         global $wgContLang;
  64                                         $data = array ();
  65                                         foreach ($wgContLang->getFormattedNamespaces() as $ns => $title) {
  66                                                 $data[$ns] = array (
  67                                                         'id' => $ns
  68                                                 );
  69                                                 ApiResult :: setContent($data[$ns], $title);
  70                                         }
  71                                         $this->getResult()->setIndexedTagName($data, 'ns');
  72                                         $this->getResult()->addValue('query', $p, $data);
  73                                         break;
  74
  75                                 default :
  76                                         ApiBase :: dieDebug(__METHOD__, "Unknown prop=$p");
  77                         }
  78                 }
  79         }
  80
  81         protected function getAllowedParams() {
  82                 return array (
  83                         'prop' => array (
  84                                 ApiBase :: PARAM_DFLT => 'general',
  85                                 ApiBase :: PARAM_ISMULTI => true,
  86                                 ApiBase :: PARAM_TYPE => array (
  87                                         'general',
  88                                         'namespaces'
  89                                 )
  90                         )
  91                 );
  92         }
  93
  94         protected function getParamDescription() {
  95                 return array (
  96                         'prop' => array (
  97                                 'Which sysinfo properties to get:',
  98                                 ' "general"    - Overall system information',
  99                                 ' "namespaces" - List of registered namespaces (localized)'
 100                         )
 101                 );
 102         }
 103
 104         protected function getDescription() {
 105                 return 'Return general information about the site.';
 106         }
 107
 108         protected function getExamples() {
 109                 return 'api.php?action=query&meta=siteinfo&siprop=general|namespaces';
 110         }
 111
 112         public function getVersion() {
 113                 return __CLASS__ . ': $Id$';
 114         }
 115 }
 116 ?>