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() {
43 $params = $this->extractRequestParams();
44 foreach( $params['prop'] as $p )
49 $this->appendGeneralInfo( $p );
52 $this->appendNamespaces( $p );
54 case 'namespacealiases':
55 $this->appendNamespaceAliases( $p );
57 case 'specialpagealiases':
58 $this->appendSpecialPageAliases( $p );
61 $this->appendMagicWords( $p );
64 $filteriw = isset( $params['filteriw'] ) ?
$params['filteriw'] : false;
65 $this->appendInterwikiMap( $p, $filteriw );
68 $this->appendDbReplLagInfo( $p, $params['showalldb'] );
71 $this->appendStatistics( $p );
74 $this->appendUserGroups( $p );
77 $this->appendExtensions( $p );
80 ApiBase
:: dieDebug( __METHOD__
, "Unknown prop=$p" );
85 protected function appendGeneralInfo( $property ) {
86 global $wgSitename, $wgVersion, $wgCapitalLinks, $wgRightsCode, $wgRightsText, $wgContLang;
87 global $wgLanguageCode, $IP, $wgEnableWriteAPI, $wgLang, $wgLocaltimezone, $wgLocalTZoffset;
90 $mainPage = Title
:: newFromText(wfMsgForContent('mainpage'));
91 $data['mainpage'] = $mainPage->getPrefixedText();
92 $data['base'] = $mainPage->getFullUrl();
93 $data['sitename'] = $wgSitename;
94 $data['generator'] = "MediaWiki $wgVersion";
96 $svn = SpecialVersion
::getSvnRevision( $IP );
100 $data['case'] = $wgCapitalLinks ?
'first-letter' : 'case-sensitive'; // 'case-insensitive' option is reserved for future
102 if( isset( $wgRightsCode ) )
103 $data['rightscode'] = $wgRightsCode;
104 $data['rights'] = $wgRightsText;
105 $data['lang'] = $wgLanguageCode;
106 if( $wgContLang->isRTL() )
108 $data['fallback8bitEncoding'] = $wgLang->fallback8bitEncoding();
111 $data['readonly'] = '';
112 if( $wgEnableWriteAPI )
113 $data['writeapi'] = '';
115 $tz = $wgLocaltimezone;
116 $offset = $wgLocalTZoffset;
117 if( is_null( $tz ) ) {
120 } elseif( is_null( $offset ) ) {
123 $data['timezone'] = $tz;
124 $data['timeoffset'] = $offset;
126 $this->getResult()->addValue( 'query', $property, $data );
129 protected function appendNamespaces( $property ) {
132 foreach( $wgContLang->getFormattedNamespaces() as $ns => $title )
137 ApiResult
:: setContent( $data[$ns], $title );
138 if( MWNamespace
::hasSubpages($ns) )
139 $data[$ns]['subpages'] = '';
142 $this->getResult()->setIndexedTagName( $data, 'ns' );
143 $this->getResult()->addValue( 'query', $property, $data );
146 protected function appendNamespaceAliases( $property ) {
147 global $wgNamespaceAliases;
149 foreach( $wgNamespaceAliases as $title => $ns ) {
153 ApiResult
:: setContent( $item, strtr( $title, '_', ' ' ) );
157 $this->getResult()->setIndexedTagName( $data, 'ns' );
158 $this->getResult()->addValue( 'query', $property, $data );
161 protected function appendSpecialPageAliases( $property ) {
164 foreach( $wgLang->getSpecialPageAliases() as $specialpage => $aliases )
166 $arr = array( 'realname' => $specialpage, 'aliases' => $aliases );
167 $this->getResult()->setIndexedTagName( $arr['aliases'], 'alias' );
170 $this->getResult()->setIndexedTagName( $data, 'specialpage' );
171 $this->getResult()->addValue( 'query', $property, $data );
174 protected function appendMagicWords( $property ) {
177 foreach($wgContLang->getMagicWords() as $magicword => $aliases)
179 $caseSensitive = array_shift($aliases);
180 $arr = array('name' => $magicword, 'aliases' => $aliases);
182 $arr['case-sensitive'] = '';
183 $this->getResult()->setIndexedTagName($arr['aliases'], 'alias');
186 $this->getResult()->setIndexedTagName($data, 'magicword');
187 $this->getResult()->addValue('query', $property, $data);
190 protected function appendInterwikiMap( $property, $filter ) {
191 $this->resetQueryParams();
192 $this->addTables( 'interwiki' );
193 $this->addFields( array( 'iw_prefix', 'iw_local', 'iw_url' ) );
195 if( $filter === 'local' )
196 $this->addWhere( 'iw_local = 1' );
197 elseif( $filter === '!local' )
198 $this->addWhere( 'iw_local = 0' );
200 ApiBase
:: dieDebug( __METHOD__
, "Unknown filter=$filter" );
202 $this->addOption( 'ORDER BY', 'iw_prefix' );
204 $db = $this->getDB();
205 $res = $this->select( __METHOD__
);
208 $langNames = Language
::getLanguageNames();
209 while( $row = $db->fetchObject($res) )
212 $val['prefix'] = $row->iw_prefix
;
213 if( $row->iw_local
== '1' )
215 // $val['trans'] = intval($row->iw_trans); // should this be exposed?
216 if( isset( $langNames[$row->iw_prefix
] ) )
217 $val['language'] = $langNames[$row->iw_prefix
];
218 $val['url'] = $row->iw_url
;
222 $db->freeResult( $res );
224 $this->getResult()->setIndexedTagName( $data, 'iw' );
225 $this->getResult()->addValue( 'query', $property, $data );
228 protected function appendDbReplLagInfo( $property, $includeAll ) {
229 global $wgShowHostnames;
232 if ( !$wgShowHostnames )
233 $this->dieUsage('Cannot view all servers info unless $wgShowHostnames is true', 'includeAllDenied');
236 $lags = $lb->getLagTimes();
237 foreach( $lags as $i => $lag ) {
239 'host' => $lb->getServerName( $i ),
244 list( $host, $lag ) = wfGetLB()->getMaxLag();
246 'host' => $wgShowHostnames ?
$host : '',
251 $result = $this->getResult();
252 $result->setIndexedTagName( $data, 'db' );
253 $result->addValue( 'query', $property, $data );
256 protected function appendStatistics( $property ) {
258 $data['pages'] = intval( SiteStats
::pages() );
259 $data['articles'] = intval( SiteStats
::articles() );
260 $data['views'] = intval( SiteStats
::views() );
261 $data['edits'] = intval( SiteStats
::edits() );
262 $data['images'] = intval( SiteStats
::images() );
263 $data['users'] = intval( SiteStats
::users() );
264 $data['activeusers'] = intval( SiteStats
::activeUsers() );
265 $data['admins'] = intval( SiteStats
::numberingroup('sysop') );
266 $data['jobs'] = intval( SiteStats
::jobs() );
267 $this->getResult()->addValue( 'query', $property, $data );
270 protected function appendUserGroups( $property ) {
271 global $wgGroupPermissions;
273 foreach( $wgGroupPermissions as $group => $permissions ) {
274 $arr = array( 'name' => $group, 'rights' => array_keys( $permissions, true ) );
275 $this->getResult()->setIndexedTagName( $arr['rights'], 'permission' );
279 $this->getResult()->setIndexedTagName( $data, 'group' );
280 $this->getResult()->addValue( 'query', $property, $data );
283 protected function appendExtensions( $property ) {
284 global $wgExtensionCredits;
286 foreach ( $wgExtensionCredits as $type => $extensions ) {
287 foreach ( $extensions as $ext ) {
289 $ret['type'] = $type;
290 if ( isset( $ext['name'] ) )
291 $ret['name'] = $ext['name'];
292 if ( isset( $ext['description'] ) )
293 $ret['description'] = $ext['description'];
294 if ( isset( $ext['descriptionmsg'] ) )
295 $ret['descriptionmsg'] = $ext['descriptionmsg'];
296 if ( isset( $ext['author'] ) ) {
297 $ret['author'] = is_array( $ext['author'] ) ?
298 implode( ', ', $ext['author' ] ) : $ext['author'];
300 if ( isset( $ext['version'] ) ) {
301 $ret['version'] = $ext['version'];
302 } elseif ( isset( $ext['svn-revision'] ) &&
303 preg_match( '/\$(?:Rev|LastChangedRevision|Revision): *(\d+)/',
304 $ext['svn-revision'], $m ) )
306 $ret['version'] = 'r' . $m[1];
312 $this->getResult()->setIndexedTagName( $data, 'ext' );
313 $this->getResult()->addValue( 'query', $property, $data );
317 public function getAllowedParams() {
320 ApiBase
:: PARAM_DFLT
=> 'general',
321 ApiBase
:: PARAM_ISMULTI
=> true,
322 ApiBase
:: PARAM_TYPE
=> array(
326 'specialpagealiases',
336 ApiBase
:: PARAM_TYPE
=> array(
341 'showalldb' => false,
345 public function getParamDescription() {
348 'Which sysinfo properties to get:',
349 ' "general" - Overall system information',
350 ' "namespaces" - List of registered namespaces (localized)',
351 ' "namespacealiases" - List of registered namespace aliases',
352 ' "specialpagealiases" - List of special page aliases',
353 ' "magicwords" - List of magic words and their aliases',
354 ' "statistics" - Returns site statistics',
355 ' "interwikimap" - Returns interwiki map (optionally filtered)',
356 ' "dbrepllag" - Returns database server with the highest replication lag',
357 ' "usergroups" - Returns user groups and the associated permissions',
358 ' "extensions" - Returns extensions installed on the wiki',
360 'filteriw' => 'Return only local or only nonlocal entries of the interwiki map',
361 'showalldb' => 'List all database servers, not just the one lagging the most',
365 public function getDescription() {
366 return 'Return general information about the site.';
369 protected function getExamples() {
371 'api.php?action=query&meta=siteinfo&siprop=general|namespaces|namespacealiases|statistics',
372 'api.php?action=query&meta=siteinfo&siprop=interwikimap&sifilteriw=local',
373 'api.php?action=query&meta=siteinfo&siprop=dbrepllag&sishowalldb',
377 public function getVersion() {
378 return __CLASS__
. ': $Id$';