4 * Created on Sep 25, 2006
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
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.
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.
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
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ('ApiQueryBase.php');
32 * A query action to return meta information about the wiki site.
36 class ApiQuerySiteinfo
extends ApiQueryBase
{
38 public function __construct($query, $moduleName) {
39 parent
:: __construct($query, $moduleName, 'si');
42 public function execute() {
44 $params = $this->extractRequestParams();
46 foreach ($params['prop'] as $p) {
49 ApiBase
:: dieDebug(__METHOD__
, "Unknown prop=$p");
51 $this->appendGeneralInfo($p);
54 $this->appendNamespaces($p);
57 $filteriw = isset($params['filteriw']) ?
$params['filteriw'] : false;
58 $this->appendInterwikiMap($p, $filteriw);
61 $this->appendDbReplLagInfo($p, $params['showalldb']);
67 protected function appendGeneralInfo($property) {
68 global $wgSitename, $wgVersion, $wgCapitalLinks, $wgRightsCode, $wgRightsText, $wgLanguageCode;
71 $mainPage = Title
:: newFromText(wfMsgForContent('mainpage'));
72 $data['mainpage'] = $mainPage->getText();
73 $data['base'] = $mainPage->getFullUrl();
74 $data['sitename'] = $wgSitename;
75 $data['generator'] = "MediaWiki $wgVersion";
76 $data['case'] = $wgCapitalLinks ?
'first-letter' : 'case-sensitive'; // 'case-insensitive' option is reserved for future
77 if (isset($wgRightsCode))
78 $data['rightscode'] = $wgRightsCode;
79 $data['rights'] = $wgRightsText;
80 $data['lang'] = $wgLanguageCode;
82 $this->getResult()->addValue('query', $property, $data);
85 protected function appendNamespaces($property) {
89 foreach ($wgContLang->getFormattedNamespaces() as $ns => $title) {
93 ApiResult
:: setContent($data[$ns], $title);
96 $this->getResult()->setIndexedTagName($data, 'ns');
97 $this->getResult()->addValue('query', $property, $data);
100 protected function appendInterwikiMap($property, $filter) {
102 $this->addTables('interwiki');
103 $this->addFields(array('iw_prefix', 'iw_local', 'iw_url'));
105 if($filter === 'local')
106 $this->addWhere('iw_local = 1');
107 else if($filter === '!local')
108 $this->addWhere('iw_local = 0');
109 else if($filter !== false)
110 ApiBase
:: dieDebug(__METHOD__
, "Unknown filter=$filter");
112 $this->addOption('ORDER BY', 'iw_prefix');
114 $db = $this->getDB();
115 $res = $this->select(__METHOD__
);
118 while($row = $db->fetchObject($res))
120 $val['prefix'] = $row->iw_prefix
;
121 if ($row->iw_local
== '1')
123 // $val['trans'] = intval($row->iw_trans); // should this be exposed?
124 $val['url'] = $row->iw_url
;
128 $db->freeResult($res);
130 $this->getResult()->setIndexedTagName($data, 'iw');
131 $this->getResult()->addValue('query', $property, $data);
134 protected function appendDbReplLagInfo($property, $includeAll) {
135 global $wgLoadBalancer, $wgShowHostnames;
140 if (!$wgShowHostnames)
141 $this->dieUsage('Cannot view all servers info unless $wgShowHostnames is true', 'includeAllDenied');
144 $lags = $wgLoadBalancer->getLagTimes();
145 foreach( $lags as $i => $lag ) {
147 'host' => $wgDBservers[$i]['host'],
151 list( $host, $lag ) = $wgLoadBalancer->getMaxLag();
153 'host' => $wgShowHostnames ?
$host : '',
157 $result = $this->getResult();
158 $result->setIndexedTagName($data, 'db');
159 $result->addValue('query', $property, $data);
162 protected function getAllowedParams() {
166 ApiBase
:: PARAM_DFLT
=> 'general',
167 ApiBase
:: PARAM_ISMULTI
=> true,
168 ApiBase
:: PARAM_TYPE
=> array (
175 'filteriw' => array (
176 ApiBase
:: PARAM_TYPE
=> array (
181 'showalldb' => false,
185 protected function getParamDescription() {
188 'Which sysinfo properties to get:',
189 ' "general" - Overall system information',
190 ' "namespaces" - List of registered namespaces (localized)',
191 ' "interwikimap" - Return interwiki map (optionally filtered)',
192 ' "dbrepllag" - Returns DB server with the highest replication lag',
194 'filteriw' => 'Return only local or only nonlocal entries of the interwiki map',
195 'showalldb' => 'List all DB servers, not just the one lagging the most',
199 protected function getDescription() {
200 return 'Return general information about the site.';
203 protected function getExamples() {
205 'api.php?action=query&meta=siteinfo&siprop=general|namespaces',
206 'api.php?action=query&meta=siteinfo&siprop=interwikimap&sifilteriw=local',
207 'api.php?action=query&meta=siteinfo&siprop=dbrepllag&sishowalldb',
211 public function getVersion() {
212 return __CLASS__
. ': $Id$';