includes/api/ApiQuerySiteinfo.php

   1 <?php
   2
   3 /*
   4  * Created on Sep 25, 2006
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   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 ('ApiQueryBase.php');
  29 }
  30
  31 /**
  32  * A query action to return meta information about the wiki site.
  33  *
  34  * @addtogroup API
  35  */
  36 class ApiQuerySiteinfo extends ApiQueryBase {
  37
  38         public function __construct($query, $moduleName) {
  39                 parent :: __construct($query, $moduleName, 'si');
  40         }
  41
  42         public function execute() {
  43
  44                 $params = $this->extractRequestParams();
  45
  46                 foreach ($params['prop'] as $p) {
  47                         switch ($p) {
  48                                 default :
  49                                         ApiBase :: dieDebug(__METHOD__, "Unknown prop=$p");
  50                                 case 'general' :
  51                                         $this->appendGeneralInfo($p);
  52                                         break;
  53                                 case 'namespaces' :
  54                                         $this->appendNamespaces($p);
  55                                         break;
  56                                 case 'interwikimap' :
  57                                         $filteriw = isset($params['filteriw']) ? $params['filteriw'] : false;
  58                                         $this->appendInterwikiMap($p, $filteriw);
  59                                         break;
  60                         }
  61                 }
  62         }
  63
  64         protected function appendGeneralInfo($property) {
  65                 global $wgSitename, $wgVersion, $wgCapitalLinks, $wgRightsCode, $wgRightsText, $wgLanguageCode;
  66
  67                 $data = array ();
  68                 $mainPage = Title :: newFromText(wfMsgForContent('mainpage'));
  69                 $data['mainpage'] = $mainPage->getText();
  70                 $data['base'] = $mainPage->getFullUrl();
  71                 $data['sitename'] = $wgSitename;
  72                 $data['generator'] = "MediaWiki $wgVersion";
  73                 $data['case'] = $wgCapitalLinks ? 'first-letter' : 'case-sensitive'; // 'case-insensitive' option is reserved for future
  74                 if (isset($wgRightsCode))
  75                         $data['rightscode'] = $wgRightsCode;
  76                 $data['rights'] = $wgRightsText;
  77                 $data['lang'] = $wgLanguageCode;
  78
  79                 $this->getResult()->addValue('query', $property, $data);
  80         }
  81
  82         protected function appendNamespaces($property) {
  83                 global $wgContLang;
  84
  85                 $data = array ();
  86                 foreach ($wgContLang->getFormattedNamespaces() as $ns => $title) {
  87                         $data[$ns] = array (
  88                                 'id' => $ns
  89                         );
  90                         ApiResult :: setContent($data[$ns], $title);
  91                 }
  92
  93                 $this->getResult()->setIndexedTagName($data, 'ns');
  94                 $this->getResult()->addValue('query', $property, $data);
  95         }
  96
  97         protected function appendInterwikiMap($property, $filter) {
  98
  99                 $this->addTables('interwiki');
 100                 $this->addFields(array('iw_prefix', 'iw_local', 'iw_url'));
 101
 102                 if($filter === 'local')
 103                         $this->addWhere('iw_local = 1');
 104                 else if($filter === '!local')
 105                         $this->addWhere('iw_local = 0');
 106                 else if($filter !== false)
 107                         ApiBase :: dieDebug(__METHOD__, "Unknown filter=$filter");
 108
 109                 $this->addOption('ORDER BY', 'iw_prefix');
 110
 111                 $db = $this->getDB();
 112                 $res = $this->select(__METHOD__);
 113
 114                 $data = array();
 115                 while($row = $db->fetchObject($res))
 116                 {
 117                         $val['prefix'] = $row->iw_prefix;
 118                         if ($row->iw_local == '1')
 119                                 $val['local'] = '';
 120 //                      $val['trans'] = intval($row->iw_trans); // should this be exposed?
 121                         $val['url'] = $row->iw_url;
 122
 123                         $data[] = $val;
 124                 }
 125                 $db->freeResult($res);
 126
 127                 $this->getResult()->setIndexedTagName($data, 'iw');
 128                 $this->getResult()->addValue('query', $property, $data);
 129         }
 130
 131         protected function getAllowedParams() {
 132                 return array (
 133
 134                         'prop' => array (
 135                                 ApiBase :: PARAM_DFLT => 'general',
 136                                 ApiBase :: PARAM_ISMULTI => true,
 137                                 ApiBase :: PARAM_TYPE => array (
 138                                         'general',
 139                                         'namespaces',
 140                                         'interwikimap'
 141                                 )),
 142
 143                         'filteriw' => array (
 144                                 ApiBase :: PARAM_TYPE => array (
 145                                         'local',
 146                                         '!local',
 147                                 )),
 148                 );
 149         }
 150
 151         protected function getParamDescription() {
 152                 return array (
 153                         'prop' => array (
 154                                 'Which sysinfo properties to get:',
 155                                 ' "general"      - Overall system information',
 156                                 ' "namespaces"   - List of registered namespaces (localized)',
 157                                 ' "interwikimap" - Return interwiki map (optionally filtered)'
 158                         ),
 159                         'filteriw' =>  'Return only local or only nonlocal entries of the interwiki map',
 160                 );
 161         }
 162
 163         protected function getDescription() {
 164                 return 'Return general information about the site.';
 165         }
 166
 167         protected function getExamples() {
 168                 return array(
 169                         'api.php?action=query&meta=siteinfo&siprop=general|namespaces',
 170                         'api.php?action=query&meta=siteinfo&siprop=interwikimap&sifilteriw=local',
 171                         );
 172         }
 173
 174         public function getVersion() {
 175                 return __CLASS__ . ': $Id$';
 176         }
 177 }
 178