1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
<?php
/*
* Created on Sep 25, 2006
*
* API for MediaWiki 1.8+
*
* Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* http://www.gnu.org/copyleft/gpl.html
*/
if (!defined('MEDIAWIKI')) {
// Eclipse helper - will be ignored in production
require_once ('ApiQueryBase.php');
}
/**
* A query action to return meta information about the wiki site.
*
* @addtogroup API
*/
class ApiQuerySiteinfo extends ApiQueryBase {
public function __construct($query, $moduleName) {
parent :: __construct($query, $moduleName, 'si');
}
public function execute() {
$params = $this->extractRequestParams();
foreach ($params['prop'] as $p) {
switch ($p) {
default :
ApiBase :: dieDebug(__METHOD__, "Unknown prop=$p");
case 'general' :
$this->appendGeneralInfo($p);
break;
case 'namespaces' :
$this->appendNamespaces($p);
break;
case 'interwikimap' :
$filteriw = isset($params['filteriw']) ? $params['filteriw'] : false;
$this->appendInterwikiMap($p, $filteriw);
break;
case 'dbrepllag' :
$this->appendDbReplLagInfo($p, $params['showalldb']);
break;
case 'statistics' :
$this->appendStatistics($p);
break;
}
}
}
protected function appendGeneralInfo($property) {
global $wgSitename, $wgVersion, $wgCapitalLinks, $wgRightsCode, $wgRightsText, $wgLanguageCode;
$data = array ();
$mainPage = Title :: newFromText(wfMsgForContent('mainpage'));
$data['mainpage'] = $mainPage->getText();
$data['base'] = $mainPage->getFullUrl();
$data['sitename'] = $wgSitename;
$data['generator'] = "MediaWiki $wgVersion";
$data['case'] = $wgCapitalLinks ? 'first-letter' : 'case-sensitive'; // 'case-insensitive' option is reserved for future
if (isset($wgRightsCode))
$data['rightscode'] = $wgRightsCode;
$data['rights'] = $wgRightsText;
$data['lang'] = $wgLanguageCode;
$this->getResult()->addValue('query', $property, $data);
}
protected function appendNamespaces($property) {
global $wgContLang;
$data = array ();
foreach ($wgContLang->getFormattedNamespaces() as $ns => $title) {
$data[$ns] = array (
'id' => $ns
);
ApiResult :: setContent($data[$ns], $title);
}
$this->getResult()->setIndexedTagName($data, 'ns');
$this->getResult()->addValue('query', $property, $data);
}
protected function appendInterwikiMap($property, $filter) {
$this->resetQueryParams();
$this->addTables('interwiki');
$this->addFields(array('iw_prefix', 'iw_local', 'iw_url'));
if($filter === 'local') {
$this->addWhere('iw_local = 1');
} elseif($filter === '!local') {
$this->addWhere('iw_local = 0');
} elseif($filter !== false) {
ApiBase :: dieDebug(__METHOD__, "Unknown filter=$filter");
}
$this->addOption('ORDER BY', 'iw_prefix');
$db = $this->getDB();
$res = $this->select(__METHOD__);
$data = array();
while($row = $db->fetchObject($res))
{
$val['prefix'] = $row->iw_prefix;
if ($row->iw_local == '1')
$val['local'] = '';
// $val['trans'] = intval($row->iw_trans); // should this be exposed?
$val['url'] = $row->iw_url;
$data[] = $val;
}
$db->freeResult($res);
$this->getResult()->setIndexedTagName($data, 'iw');
$this->getResult()->addValue('query', $property, $data);
}
protected function appendDbReplLagInfo($property, $includeAll) {
global $wgLoadBalancer, $wgShowHostnames;
$data = array();
if ($includeAll) {
if (!$wgShowHostnames)
$this->dieUsage('Cannot view all servers info unless $wgShowHostnames is true', 'includeAllDenied');
global $wgDBservers;
$lags = $wgLoadBalancer->getLagTimes();
foreach( $lags as $i => $lag ) {
$data[] = array (
'host' => $wgDBservers[$i]['host'],
'lag' => $lag);
}
} else {
list( $host, $lag ) = $wgLoadBalancer->getMaxLag();
$data[] = array (
'host' => $wgShowHostnames ? $host : '',
'lag' => $lag);
}
$result = $this->getResult();
$result->setIndexedTagName($data, 'db');
$result->addValue('query', $property, $data);
}
protected function appendStatistics($property) {
$data = array ();
$data['pages'] = intval(SiteStats::pages());
$data['articles'] = intval(SiteStats::articles());
$data['views'] = intval(SiteStats::views());
$data['edits'] = intval(SiteStats::edits());
$data['images'] = intval(SiteStats::images());
$data['users'] = intval(SiteStats::users());
$data['admins'] = intval(SiteStats::admins());
$data['jobs'] = intval(SiteStats::jobs());
$this->getResult()->addValue('query', $property, $data);
}
protected function getAllowedParams() {
return array (
'prop' => array (
ApiBase :: PARAM_DFLT => 'general',
ApiBase :: PARAM_ISMULTI => true,
ApiBase :: PARAM_TYPE => array (
'general',
'namespaces',
'interwikimap',
'dbrepllag',
'statistics',
)),
'filteriw' => array (
ApiBase :: PARAM_TYPE => array (
'local',
'!local',
)),
'showalldb' => false,
);
}
protected function getParamDescription() {
return array (
'prop' => array (
'Which sysinfo properties to get:',
' "general" - Overall system information',
' "namespaces" - List of registered namespaces (localized)',
' "statistics" - Returns site statistics',
' "interwikimap" - Returns interwiki map (optionally filtered)',
' "dbrepllag" - Returns database server with the highest replication lag',
),
'filteriw' => 'Return only local or only nonlocal entries of the interwiki map',
'showalldb' => 'List all database servers, not just the one lagging the most',
);
}
protected function getDescription() {
return 'Return general information about the site.';
}
protected function getExamples() {
return array(
'api.php?action=query&meta=siteinfo&siprop=general|namespaces|statistics',
'api.php?action=query&meta=siteinfo&siprop=interwikimap&sifilteriw=local',
'api.php?action=query&meta=siteinfo&siprop=dbrepllag&sishowalldb',
);
}
public function getVersion() {
return __CLASS__ . ': $Id: ApiQuerySiteinfo.php 25238 2007-08-28 15:37:31Z robchurch $';
}
}
|
