From 370e83bb0dfd0c70de268c93bf07ad5ee0897192 Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Fri, 15 Aug 2008 01:29:47 +0200 Subject: Update auf 1.13.0 --- includes/api/ApiQuerySiteinfo.php | 304 +++++++++++++++++++++++--------------- 1 file changed, 182 insertions(+), 122 deletions(-) (limited to 'includes/api/ApiQuerySiteinfo.php') diff --git a/includes/api/ApiQuerySiteinfo.php b/includes/api/ApiQuerySiteinfo.php index 81af7997..1fd3b888 100644 --- a/includes/api/ApiQuerySiteinfo.php +++ b/includes/api/ApiQuerySiteinfo.php @@ -23,218 +23,278 @@ * http://www.gnu.org/copyleft/gpl.html */ -if (!defined('MEDIAWIKI')) { +if( !defined('MEDIAWIKI') ) { // Eclipse helper - will be ignored in production - require_once ('ApiQueryBase.php'); + require_once( 'ApiQueryBase.php' ); } /** * A query action to return meta information about the wiki site. - * - * @addtogroup API + * + * @ingroup API */ class ApiQuerySiteinfo extends ApiQueryBase { - public function __construct($query, $moduleName) { - parent :: __construct($query, $moduleName, 'si'); + 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); + foreach( $params['prop'] as $p ) + { + switch ( $p ) + { + case 'general': + $this->appendGeneralInfo( $p ); + break; + case 'namespaces': + $this->appendNamespaces( $p ); break; - case 'namespaces' : - $this->appendNamespaces($p); + case 'namespacealiases': + $this->appendNamespaceAliases( $p ); break; - case 'namespacealiases' : - $this->appendNamespaceAliases($p); + case 'specialpagealiases': + $this->appendSpecialPageAliases( $p ); break; - case 'interwikimap' : - $filteriw = isset($params['filteriw']) ? $params['filteriw'] : false; - $this->appendInterwikiMap($p, $filteriw); + case 'interwikimap': + $filteriw = isset( $params['filteriw'] ) ? $params['filteriw'] : false; + $this->appendInterwikiMap( $p, $filteriw ); break; - case 'dbrepllag' : - $this->appendDbReplLagInfo($p, $params['showalldb']); + case 'dbrepllag': + $this->appendDbReplLagInfo( $p, $params['showalldb'] ); break; - case 'statistics' : - $this->appendStatistics($p); + case 'statistics': + $this->appendStatistics( $p ); break; + case 'usergroups': + $this->appendUserGroups( $p ); + break; + default : + ApiBase :: dieDebug( __METHOD__, "Unknown prop=$p" ); } } } - protected function appendGeneralInfo($property) { - global $wgSitename, $wgVersion, $wgCapitalLinks, $wgRightsCode, $wgRightsText, $wgLanguageCode, $IP; - - $data = array (); + protected function appendGeneralInfo( $property ) { + global $wgSitename, $wgVersion, $wgCapitalLinks, $wgRightsCode, $wgRightsText, $wgContLang; + global $wgLanguageCode, $IP, $wgEnableWriteAPI, $wgLang, $wgLocaltimezone, $wgLocalTZoffset; + + $data = array(); $mainPage = Title :: newFromText(wfMsgForContent('mainpage')); - $data['mainpage'] = $mainPage->getText(); + $data['mainpage'] = $mainPage->getPrefixedText(); $data['base'] = $mainPage->getFullUrl(); $data['sitename'] = $wgSitename; $data['generator'] = "MediaWiki $wgVersion"; - $svn = SpecialVersion::getSvnRevision ( $IP ); - if ( $svn ) $data['rev'] = $svn; + $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)) + + if( isset( $wgRightsCode ) ) $data['rightscode'] = $wgRightsCode; $data['rights'] = $wgRightsText; $data['lang'] = $wgLanguageCode; + if( $wgContLang->isRTL() ) + $data['rtl'] = ''; + $data['fallback8bitEncoding'] = $wgLang->fallback8bitEncoding(); - $this->getResult()->addValue('query', $property, $data); + if( wfReadOnly() ) + $data['readonly'] = ''; + if( $wgEnableWriteAPI ) + $data['writeapi'] = ''; + + $tz = $wgLocaltimezone; + $offset = $wgLocalTZoffset; + if( is_null( $tz ) ) { + $tz = 'UTC'; + $offset = 0; + } elseif( is_null( $offset ) ) { + $offset = 0; + } + $data['timezone'] = $tz; + $data['timeoffset'] = $offset; + + $this->getResult()->addValue( 'query', $property, $data ); } - - protected function appendNamespaces($property) { + + protected function appendNamespaces( $property ) { global $wgContLang; - - $data = array (); - foreach ($wgContLang->getFormattedNamespaces() as $ns => $title) { - $data[$ns] = array ( + $data = array(); + foreach( $wgContLang->getFormattedNamespaces() as $ns => $title ) + { + $data[$ns] = array( 'id' => $ns ); - ApiResult :: setContent($data[$ns], $title); + ApiResult :: setContent( $data[$ns], $title ); + if( MWNamespace::hasSubpages($ns) ) + $data[$ns]['subpages'] = ''; } - - $this->getResult()->setIndexedTagName($data, 'ns'); - $this->getResult()->addValue('query', $property, $data); + + $this->getResult()->setIndexedTagName( $data, 'ns' ); + $this->getResult()->addValue( 'query', $property, $data ); } - - protected function appendNamespaceAliases($property) { + + protected function appendNamespaceAliases( $property ) { global $wgNamespaceAliases; - - $data = array (); - foreach ($wgNamespaceAliases as $title => $ns) { - $item = array ( + $data = array(); + foreach( $wgNamespaceAliases as $title => $ns ) { + $item = array( 'id' => $ns ); - ApiResult :: setContent($item, strtr($title, '_', ' ')); + ApiResult :: setContent( $item, strtr( $title, '_', ' ' ) ); $data[] = $item; } - - $this->getResult()->setIndexedTagName($data, 'ns'); - $this->getResult()->addValue('query', $property, $data); + + $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"); + 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' ); - $this->addOption('ORDER BY', 'iw_prefix'); - $db = $this->getDB(); - $res = $this->select(__METHOD__); + $res = $this->select( __METHOD__ ); $data = array(); - while($row = $db->fetchObject($res)) + $langNames = Language::getLanguageNames(); + while( $row = $db->fetchObject($res) ) { + $val = array(); $val['prefix'] = $row->iw_prefix; - if ($row->iw_local == '1') + if( $row->iw_local == '1' ) $val['local'] = ''; // $val['trans'] = intval($row->iw_trans); // should this be exposed? + if( isset( $langNames[$row->iw_prefix] ) ) + $val['language'] = $langNames[$row->iw_prefix]; $val['url'] = $row->iw_url; - + $data[] = $val; } - $db->freeResult($res); - - $this->getResult()->setIndexedTagName($data, 'iw'); - $this->getResult()->addValue('query', $property, $data); + $db->freeResult( $res ); + + $this->getResult()->setIndexedTagName( $data, 'iw' ); + $this->getResult()->addValue( 'query', $property, $data ); } - - protected function appendDbReplLagInfo($property, $includeAll) { - global $wgLoadBalancer, $wgShowHostnames; + protected function appendDbReplLagInfo( $property, $includeAll ) { + global $wgShowHostnames; $data = array(); - - if ($includeAll) { - if (!$wgShowHostnames) + if( $includeAll ) { + if ( !$wgShowHostnames ) $this->dieUsage('Cannot view all servers info unless $wgShowHostnames is true', 'includeAllDenied'); - - global $wgDBservers; - $lags = $wgLoadBalancer->getLagTimes(); + + $lb = wfGetLB(); + $lags = $lb->getLagTimes(); foreach( $lags as $i => $lag ) { - $data[] = array ( - 'host' => $wgDBservers[$i]['host'], - 'lag' => $lag); + $data[] = array( + 'host' => $lb->getServerName( $i ), + 'lag' => $lag + ); } } else { - list( $host, $lag ) = $wgLoadBalancer->getMaxLag(); - $data[] = array ( + list( $host, $lag ) = wfGetLB()->getMaxLag(); + $data[] = array( 'host' => $wgShowHostnames ? $host : '', - 'lag' => $lag); - } + '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); - } - + $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 ); + } + public function getAllowedParams() { - return array ( - - 'prop' => array ( + return array( + 'prop' => array( ApiBase :: PARAM_DFLT => 'general', ApiBase :: PARAM_ISMULTI => true, - ApiBase :: PARAM_TYPE => array ( + ApiBase :: PARAM_TYPE => array( 'general', 'namespaces', 'namespacealiases', + 'specialpagealiases', 'interwikimap', 'dbrepllag', 'statistics', - )), - - 'filteriw' => array ( - ApiBase :: PARAM_TYPE => array ( + 'usergroups', + ) + ), + 'filteriw' => array( + ApiBase :: PARAM_TYPE => array( 'local', '!local', - )), - + ) + ), 'showalldb' => false, ); } public function getParamDescription() { - return array ( - 'prop' => array ( + return array( + 'prop' => array( 'Which sysinfo properties to get:', ' "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', @@ -254,6 +314,6 @@ class ApiQuerySiteinfo extends ApiQueryBase { } public function getVersion() { - return __CLASS__ . ': $Id: ApiQuerySiteinfo.php 30484 2008-02-03 19:29:59Z btongminh $'; + return __CLASS__ . ': $Id: ApiQuerySiteinfo.php 37034 2008-07-04 09:21:11Z vasilievvv $'; } } -- cgit v1.2.2