X-Git-Url: http://git.cyclocoop.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiQuerySiteinfo.php;h=eff3dc600f0a9c981f27bf7a212c11bfa9e99dd9;hb=f64888e85345931047904c1360f57cd9e97d8235;hp=54d3a5cfb41fc7fe4a1a150874d7a30478128f31;hpb=f97b323e003ff8007bff05f30156f38bc1a93b5a;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/api/ApiQuerySiteinfo.php b/includes/api/ApiQuerySiteinfo.php index 54d3a5cfb4..eff3dc600f 100644 --- a/includes/api/ApiQuerySiteinfo.php +++ b/includes/api/ApiQuerySiteinfo.php @@ -1,12 +1,11 @@ + * Copyright (C) 2006 Yuri Astrakhan @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 @@ -29,81 +28,278 @@ if (!defined('MEDIAWIKI')) { 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); + parent :: __construct($query, $moduleName, 'si'); } public function execute() { - $siprop = null; - extract($this->extractRequestParams()); - foreach ($siprop as $prop) { - switch ($prop) { + $params = $this->extractRequestParams(); + foreach ($params['prop'] as $p) { + switch ($p) { + default : + ApiBase :: dieDebug(__METHOD__, "Unknown prop=$p"); case 'general' : - - global $wgSitename, $wgVersion, $wgCapitalLinks; - $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 - $this->getResult()->addValue('query', $prop, $data); + $this->appendGeneralInfo($p); break; - case 'namespaces' : - - global $wgContLang; - $data = array (); - foreach ($wgContLang->getFormattedNamespaces() as $ns => $title) { - $data[$ns] = array ( - 'id' => $ns - ); - ApiResult :: addContent($data[$ns], $title); - } - ApiResult :: setIndexedTagName($data, 'ns'); - $this->getResult()->addValue('query', $prop, $data); + $this->appendNamespaces($p); + break; + case 'namespacealiases' : + $this->appendNamespaceAliases($p); + break; + case 'specialpagealiases' : + $this->appendSpecialPageAliases($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; + case 'usergroups' : + $this->appendUserGroups($p); break; + } + } + } - default : - ApiBase :: dieDebug("Unknown siprop=$prop"); + protected function appendGeneralInfo($property) { + global $wgSitename, $wgVersion, $wgCapitalLinks, $wgRightsCode, $wgRightsText, $wgLanguageCode, $IP, $wgEnableWriteAPI, $wgLang; + + $data = array (); + $mainPage = Title :: newFromText(wfMsgForContent('mainpage')); + $data['mainpage'] = $mainPage->getPrefixedText(); + $data['base'] = $mainPage->getFullUrl(); + $data['sitename'] = $wgSitename; + $data['generator'] = "MediaWiki $wgVersion"; + + $svn = SpecialVersion::getSvnRevision ( $IP ); + if ( $svn ) $data['rev'] = $svn; + + $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; + $data['fallback8bitEncoding'] = $wgLang->fallback8bitEncoding(); + + if ( $wgEnableWriteAPI ) + $data['writeapi'] = ''; + + $this->getResult()->addValue('query', $property, $data); + } + + protected function appendNamespaces($property) { + global $wgContLang, $wgNamespacesWithSubpages; + + $data = array (); + foreach ($wgContLang->getFormattedNamespaces() as $ns => $title) { + $data[$ns] = array ( + 'id' => $ns + ); + ApiResult :: setContent($data[$ns], $title); + if(@$wgNamespacesWithSubpages[$ns]) + $data[$ns]['subpages'] = ''; + } + + $this->getResult()->setIndexedTagName($data, 'ns'); + $this->getResult()->addValue('query', $property, $data); + } + + protected function appendNamespaceAliases($property) { + global $wgNamespaceAliases; + + $data = array (); + foreach ($wgNamespaceAliases as $title => $ns) { + $item = array ( + 'id' => $ns + ); + ApiResult :: setContent($item, strtr($title, '_', ' ')); + $data[] = $item; + } + + $this->getResult()->setIndexedTagName($data, 'ns'); + $this->getResult()->addValue('query', $property, $data); + } + + protected function appendSpecialPageAliases($property) + { + global $wgLang; + $data = array(); + foreach($wgLang->getSpecialPageAliases() as $specialpage => $aliases) + { + $arr = array('realname' => $specialpage, 'aliases' => $aliases); + $this->getResult()->setIndexedTagName($arr['aliases'], 'alias'); + $data[] = $arr; + } + $this->getResult()->setIndexedTagName($data, 'specialpage'); + $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 = array(); + $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 $wgShowHostnames; + + $data = array(); + + if ($includeAll) { + if (!$wgShowHostnames) + $this->dieUsage('Cannot view all servers info unless $wgShowHostnames is true', 'includeAllDenied'); + + $lb = wfGetLB(); + $lags = $lb->getLagTimes(); + foreach( $lags as $i => $lag ) { + $data[] = array ( + 'host' => $lb->getServerName( $i ), + 'lag' => $lag); } + } else { + list( $host, $lag ) = wfGetLB()->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 appendUserGroups($property) { + global $wgGroupPermissions; + + $data = array (); + foreach ($wgGroupPermissions as $group => $permissions) { + $arr = array ('name' => $group, 'rights' => array_keys($permissions, true)); + $this->getResult()->setIndexedTagName($arr['rights'], 'permission'); + $data[] = $arr; } + + $this->getResult()->setIndexedTagName($data, 'group'); + $this->getResult()->addValue('query', $property, $data); } - protected function getAllowedParams() { + public function getAllowedParams() { return array ( - 'siprop' => array ( - GN_ENUM_DFLT => 'general', - GN_ENUM_ISMULTI => true, - GN_ENUM_TYPE => array ( + + 'prop' => array ( + ApiBase :: PARAM_DFLT => 'general', + ApiBase :: PARAM_ISMULTI => true, + ApiBase :: PARAM_TYPE => array ( 'general', - 'namespaces' - ) - ) + 'namespaces', + 'namespacealiases', + 'specialpagealiases', + 'interwikimap', + 'dbrepllag', + 'statistics', + 'usergroups', + )), + + 'filteriw' => array ( + ApiBase :: PARAM_TYPE => array ( + 'local', + '!local', + )), + + 'showalldb' => false, ); } - protected function getParamDescription() { + public function getParamDescription() { return array ( - 'siprop' => array ( + 'prop' => array ( 'Which sysinfo properties to get:', - ' "general" - Overall system information', - ' "namespaces" - List of registered namespaces (localized)' - ) + ' "general" - Overall system information', + ' "namespaces" - List of registered namespaces (localized)', + ' "namespacealiases" - List of registered namespace aliases', + ' "specialpagealiases" - List of special page aliases', + ' "statistics" - Returns site statistics', + ' "interwikimap" - Returns interwiki map (optionally filtered)', + ' "dbrepllag" - Returns database server with the highest replication lag', + ' "usergroups" - Returns user groups and the associated permissions', + ), + '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() { + public function getDescription() { return 'Return general information about the site.'; } protected function getExamples() { - return 'api.php?action=query&meta=siteinfo&siprop=general|namespaces'; + return array( + 'api.php?action=query&meta=siteinfo&siprop=general|namespaces|namespacealiases|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$'; } } -?> \ No newline at end of file