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']);
64 $this->appendStatistics($p);
70 protected function appendGeneralInfo($property) {
71 global $wgSitename, $wgVersion, $wgCapitalLinks, $wgRightsCode, $wgRightsText, $wgLanguageCode;
74 $mainPage = Title
:: newFromText(wfMsgForContent('mainpage'));
75 $data['mainpage'] = $mainPage->getText();
76 $data['base'] = $mainPage->getFullUrl();
77 $data['sitename'] = $wgSitename;
78 $data['generator'] = "MediaWiki $wgVersion";
79 $data['case'] = $wgCapitalLinks ?
'first-letter' : 'case-sensitive'; // 'case-insensitive' option is reserved for future
80 if (isset($wgRightsCode))
81 $data['rightscode'] = $wgRightsCode;
82 $data['rights'] = $wgRightsText;
83 $data['lang'] = $wgLanguageCode;
85 $this->getResult()->addValue('query', $property, $data);
88 protected function appendNamespaces($property) {
92 foreach ($wgContLang->getFormattedNamespaces() as $ns => $title) {
96 ApiResult
:: setContent($data[$ns], $title);
99 $this->getResult()->setIndexedTagName($data, 'ns');
100 $this->getResult()->addValue('query', $property, $data);
103 protected function appendInterwikiMap($property, $filter) {
105 $this->resetQueryParams();
106 $this->addTables('interwiki');
107 $this->addFields(array('iw_prefix', 'iw_local', 'iw_url'));
109 if($filter === 'local') {
110 $this->addWhere('iw_local = 1');
111 } elseif($filter === '!local') {
112 $this->addWhere('iw_local = 0');
113 } elseif($filter !== false) {
114 ApiBase
:: dieDebug(__METHOD__
, "Unknown filter=$filter");
117 $this->addOption('ORDER BY', 'iw_prefix');
119 $db = $this->getDB();
120 $res = $this->select(__METHOD__
);
123 while($row = $db->fetchObject($res))
125 $val['prefix'] = $row->iw_prefix
;
126 if ($row->iw_local
== '1')
128 // $val['trans'] = intval($row->iw_trans); // should this be exposed?
129 $val['url'] = $row->iw_url
;
133 $db->freeResult($res);
135 $this->getResult()->setIndexedTagName($data, 'iw');
136 $this->getResult()->addValue('query', $property, $data);
139 protected function appendDbReplLagInfo($property, $includeAll) {
140 global $wgLoadBalancer, $wgShowHostnames;
145 if (!$wgShowHostnames)
146 $this->dieUsage('Cannot view all servers info unless $wgShowHostnames is true', 'includeAllDenied');
149 $lags = $wgLoadBalancer->getLagTimes();
150 foreach( $lags as $i => $lag ) {
152 'host' => $wgDBservers[$i]['host'],
156 list( $host, $lag ) = $wgLoadBalancer->getMaxLag();
158 'host' => $wgShowHostnames ?
$host : '',
162 $result = $this->getResult();
163 $result->setIndexedTagName($data, 'db');
164 $result->addValue('query', $property, $data);
167 protected function appendStatistics($property) {
169 $data['pages'] = intval(SiteStats
::pages());
170 $data['articles'] = intval(SiteStats
::articles());
171 $data['views'] = intval(SiteStats
::views());
172 $data['edits'] = intval(SiteStats
::edits());
173 $data['images'] = intval(SiteStats
::images());
174 $data['users'] = intval(SiteStats
::users());
175 $data['admins'] = intval(SiteStats
::admins());
176 $data['jobs'] = intval(SiteStats
::jobs());
177 $this->getResult()->addValue('query', $property, $data);
180 protected function getAllowedParams() {
184 ApiBase
:: PARAM_DFLT
=> 'general',
185 ApiBase
:: PARAM_ISMULTI
=> true,
186 ApiBase
:: PARAM_TYPE
=> array (
194 'filteriw' => array (
195 ApiBase
:: PARAM_TYPE
=> array (
200 'showalldb' => false,
204 protected function getParamDescription() {
207 'Which sysinfo properties to get:',
208 ' "general" - Overall system information',
209 ' "namespaces" - List of registered namespaces (localized)',
210 ' "statistics" - Returns site statistics',
211 ' "interwikimap" - Returns interwiki map (optionally filtered)',
212 ' "dbrepllag" - Returns database server with the highest replication lag',
214 'filteriw' => 'Return only local or only nonlocal entries of the interwiki map',
215 'showalldb' => 'List all database servers, not just the one lagging the most',
219 protected function getDescription() {
220 return 'Return general information about the site.';
223 protected function getExamples() {
225 'api.php?action=query&meta=siteinfo&siprop=general|namespaces|statistics',
226 'api.php?action=query&meta=siteinfo&siprop=interwikimap&sifilteriw=local',
227 'api.php?action=query&meta=siteinfo&siprop=dbrepllag&sishowalldb',
231 public function getVersion() {
232 return __CLASS__
. ': $Id$';