* 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);
+ $done = array();
+ foreach( $params['prop'] as $p )
+ {
+ switch ( $p )
+ {
+ case 'general':
+ $fit = $this->appendGeneralInfo( $p );
+ break;
+ case 'namespaces':
+ $fit = $this->appendNamespaces( $p );
+ break;
+ case 'namespacealiases':
+ $fit = $this->appendNamespaceAliases( $p );
+ break;
+ case 'specialpagealiases':
+ $fit = $this->appendSpecialPageAliases( $p );
+ break;
+ case 'magicwords':
+ $fit = $this->appendMagicWords( $p );
break;
- case 'namespaces' :
- $this->appendNamespaces($p);
+ case 'interwikimap':
+ $filteriw = isset( $params['filteriw'] ) ? $params['filteriw'] : false;
+ $fit = $this->appendInterwikiMap( $p, $filteriw );
break;
- case 'namespacealiases' :
- $this->appendNamespaceAliases($p);
+ case 'dbrepllag':
+ $fit = $this->appendDbReplLagInfo( $p, $params['showalldb'] );
break;
- case 'specialpagealiases' :
- $this->appendSpecialPageAliases($p);
+ case 'statistics':
+ $fit = $this->appendStatistics( $p );
break;
- case 'interwikimap' :
- $filteriw = isset($params['filteriw']) ? $params['filteriw'] : false;
- $this->appendInterwikiMap($p, $filteriw);
+ case 'usergroups':
+ $fit = $this->appendUserGroups( $p );
break;
- case 'dbrepllag' :
- $this->appendDbReplLagInfo($p, $params['showalldb']);
+ case 'extensions':
+ $fit = $this->appendExtensions( $p );
break;
- case 'statistics' :
- $this->appendStatistics($p);
+ case 'fileextensions':
+ $fit = $this->appendFileExtensions( $p );
break;
- case 'usergroups' :
- $this->appendUserGroups($p);
+ case 'rightsinfo':
+ $fit = $this->appendRightsInfo( $p );
break;
+ default :
+ ApiBase :: dieDebug( __METHOD__, "Unknown prop=$p" );
+ }
+ if(!$fit)
+ {
+ # Abuse siprop as a query-continue parameter
+ # and set it to all unprocessed props
+ $this->setContinueEnumParameter('prop', implode('|',
+ array_diff($params['prop'], $done)));
+ break;
}
+ $done[] = $p;
}
}
- protected function appendGeneralInfo($property) {
- global $wgSitename, $wgVersion, $wgCapitalLinks, $wgRightsCode, $wgRightsText, $wgLanguageCode, $IP, $wgEnableWriteAPI, $wgLang;
+ protected function appendGeneralInfo( $property ) {
+ global $wgContLang;
+ global $wgLang;
- $data = array ();
+ $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['sitename'] = $GLOBALS['wgSitename'];
+ $data['generator'] = "MediaWiki {$GLOBALS['wgVersion']}";
+ $data['phpversion'] = phpversion();
+ $data['phpsapi'] = php_sapi_name();
+ $data['dbclass'] = get_class($this->getDB());
+ $data['dbversion'] = $this->getDB()->getServerVersion();
+
+ $svn = SpecialVersion::getSvnRevision( $GLOBALS['IP'] );
+ if( $svn )
+ $data['rev'] = $svn;
+
+ // 'case-insensitive' option is reserved for future
+ $data['case'] = $GLOBALS['wgCapitalLinks'] ? 'first-letter' : 'case-sensitive';
+
+ if( isset( $GLOBALS['wgRightsCode'] ) )
+ $data['rightscode'] = $GLOBALS['wgRightsCode'];
+ $data['rights'] = $GLOBALS['wgRightsText'];
+ $data['lang'] = $GLOBALS['wgLanguageCode'];
+ if( $wgContLang->isRTL() )
+ $data['rtl'] = '';
$data['fallback8bitEncoding'] = $wgLang->fallback8bitEncoding();
-
- if ( $wgEnableWriteAPI )
+
+ if( wfReadOnly() ) {
+ $data['readonly'] = '';
+ $data['readonlyreason'] = wfReadOnlyReason();
+ }
+ if( $GLOBALS['wgEnableWriteAPI'] )
$data['writeapi'] = '';
- $this->getResult()->addValue('query', $property, $data);
+ $tz = $GLOBALS['wgLocaltimezone'];
+ $offset = $GLOBALS['wgLocalTZoffset'];
+ if( is_null( $tz ) ) {
+ $tz = 'UTC';
+ $offset = 0;
+ } elseif( is_null( $offset ) ) {
+ $offset = 0;
+ }
+ $data['timezone'] = $tz;
+ $data['timeoffset'] = intval($offset);
+ $data['articlepath'] = $GLOBALS['wgArticlePath'];
+ $data['scriptpath'] = $GLOBALS['wgScriptPath'];
+ $data['script'] = $GLOBALS['wgScript'];
+ $data['variantarticlepath'] = $GLOBALS['wgVariantArticlePath'];
+ $data['server'] = $GLOBALS['wgServer'];
+ $data['wikiid'] = wfWikiID();
+
+ return $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
+ protected function appendNamespaces( $property ) {
+ global $wgContLang;
+ $data = array();
+ foreach( $wgContLang->getFormattedNamespaces() as $ns => $title )
+ {
+ $data[$ns] = array(
+ 'id' => intval($ns)
);
- ApiResult :: setContent($data[$ns], $title);
- if(@$wgNamespacesWithSubpages[$ns])
+ ApiResult :: setContent( $data[$ns], $title );
+ $canonical = MWNamespace::getCanonicalName( $ns );
+
+ if( MWNamespace::hasSubpages( $ns ) )
$data[$ns]['subpages'] = '';
+
+ if( $canonical )
+ $data[$ns]['canonical'] = strtr($canonical, '_', ' ');
}
- $this->getResult()->setIndexedTagName($data, 'ns');
- $this->getResult()->addValue('query', $property, $data);
+ $this->getResult()->setIndexedTagName( $data, 'ns' );
+ return $this->getResult()->addValue( 'query', $property, $data );
}
- protected function appendNamespaceAliases($property) {
- global $wgNamespaceAliases;
-
- $data = array ();
- foreach ($wgNamespaceAliases as $title => $ns) {
- $item = array (
- 'id' => $ns
+ protected function appendNamespaceAliases( $property ) {
+ global $wgNamespaceAliases, $wgContLang;
+ $wgContLang->load();
+ $aliases = array_merge( $wgNamespaceAliases, $wgContLang->namespaceAliases );
+ $namespaces = $wgContLang->getNamespaces();
+ $data = array();
+ foreach( $aliases as $title => $ns ) {
+ if( $namespaces[$ns] == $title ) {
+ // Don't list duplicates
+ continue;
+ }
+ $item = array(
+ 'id' => intval($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' );
+ return $this->getResult()->addValue( 'query', $property, $data );
}
- protected function appendSpecialPageAliases($property)
- {
+ protected function appendSpecialPageAliases( $property ) {
global $wgLang;
$data = array();
- foreach($wgLang->getSpecialPageAliases() as $specialpage => $aliases)
+ foreach( $wgLang->getSpecialPageAliases() as $specialpage => $aliases )
{
- $arr = array('realname' => $specialpage, 'aliases' => $aliases);
+ $arr = array( 'realname' => $specialpage, 'aliases' => $aliases );
+ $this->getResult()->setIndexedTagName( $arr['aliases'], 'alias' );
+ $data[] = $arr;
+ }
+ $this->getResult()->setIndexedTagName( $data, 'specialpage' );
+ return $this->getResult()->addValue( 'query', $property, $data );
+ }
+
+ protected function appendMagicWords( $property ) {
+ global $wgContLang;
+ $data = array();
+ foreach($wgContLang->getMagicWords() as $magicword => $aliases)
+ {
+ $caseSensitive = array_shift($aliases);
+ $arr = array('name' => $magicword, 'aliases' => $aliases);
+ if($caseSensitive)
+ $arr['case-sensitive'] = '';
$this->getResult()->setIndexedTagName($arr['aliases'], 'alias');
$data[] = $arr;
}
- $this->getResult()->setIndexedTagName($data, 'specialpage');
- $this->getResult()->addValue('query', $property, $data);
+ $this->getResult()->setIndexedTagName($data, 'magicword');
+ return $this->getResult()->addValue( 'query', $property, $data );
}
- protected function appendInterwikiMap($property, $filter) {
-
+ 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->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 )
+ 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);
+ $db->freeResult( $res );
- $this->getResult()->setIndexedTagName($data, 'iw');
- $this->getResult()->addValue('query', $property, $data);
+ $this->getResult()->setIndexedTagName( $data, 'iw' );
+ return $this->getResult()->addValue( 'query', $property, $data );
}
- protected function appendDbReplLagInfo($property, $includeAll) {
+ 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');
$lb = wfGetLB();
$lags = $lb->getLagTimes();
foreach( $lags as $i => $lag ) {
- $data[] = array (
+ $data[] = array(
'host' => $lb->getServerName( $i ),
- 'lag' => $lag);
+ 'lag' => $lag
+ );
}
} else {
list( $host, $lag ) = wfGetLB()->getMaxLag();
- $data[] = array (
+ $data[] = array(
'host' => $wgShowHostnames ? $host : '',
- 'lag' => $lag);
+ 'lag' => intval( $lag )
+ );
}
$result = $this->getResult();
- $result->setIndexedTagName($data, 'db');
- $result->addValue('query', $property, $data);
+ $result->setIndexedTagName( $data, 'db' );
+ return $this->getResult()->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 appendStatistics( $property ) {
+ global $wgDisableCounters;
+ $data = array();
+ $data['pages'] = intval( SiteStats::pages() );
+ $data['articles'] = intval( SiteStats::articles() );
+ if ( !$wgDisableCounters ) {
+ $data['views'] = intval( SiteStats::views() );
+ }
+ $data['edits'] = intval( SiteStats::edits() );
+ $data['images'] = intval( SiteStats::images() );
+ $data['users'] = intval( SiteStats::users() );
+ $data['activeusers'] = intval( SiteStats::activeUsers() );
+ $data['admins'] = intval( SiteStats::numberingroup('sysop') );
+ $data['jobs'] = intval( SiteStats::jobs() );
+ return $this->getResult()->addValue( 'query', $property, $data );
}
- protected function appendUserGroups($property) {
+ 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 = 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);
+ $this->getResult()->setIndexedTagName( $data, 'group' );
+ return $this->getResult()->addValue( 'query', $property, $data );
+ }
+
+ protected function appendFileExtensions( $property ) {
+ global $wgFileExtensions;
+
+ $data = array();
+ foreach( $wgFileExtensions as $ext ) {
+ $data[] = array( 'ext' => $ext );
+ }
+ $this->getResult()->setIndexedTagName( $data, 'fe' );
+ return $this->getResult()->addValue( 'query', $property, $data );
}
- public function getAllowedParams() {
- return array (
+ protected function appendExtensions( $property ) {
+ global $wgExtensionCredits;
+ $data = array();
+ foreach ( $wgExtensionCredits as $type => $extensions ) {
+ foreach ( $extensions as $ext ) {
+ $ret = array();
+ $ret['type'] = $type;
+ if ( isset( $ext['name'] ) )
+ $ret['name'] = $ext['name'];
+ if ( isset( $ext['description'] ) )
+ $ret['description'] = $ext['description'];
+ if ( isset( $ext['descriptionmsg'] ) )
+ $ret['descriptionmsg'] = $ext['descriptionmsg'];
+ if ( isset( $ext['author'] ) ) {
+ $ret['author'] = is_array( $ext['author'] ) ?
+ implode( ', ', $ext['author' ] ) : $ext['author'];
+ }
+ if ( isset( $ext['version'] ) ) {
+ $ret['version'] = $ext['version'];
+ } elseif ( isset( $ext['svn-revision'] ) &&
+ preg_match( '/\$(?:Rev|LastChangedRevision|Revision): *(\d+)/',
+ $ext['svn-revision'], $m ) )
+ {
+ $ret['version'] = 'r' . $m[1];
+ }
+ $data[] = $ret;
+ }
+ }
+
+ $this->getResult()->setIndexedTagName( $data, 'ext' );
+ return $this->getResult()->addValue( 'query', $property, $data );
+ }
- 'prop' => array (
+
+ protected function appendRightsInfo( $property ) {
+ global $wgRightsPage, $wgRightsUrl, $wgRightsText;
+ $title = Title::newFromText( $wgRightsPage );
+ $url = $title ? $title->getFullURL() : $wgRightsUrl;
+ $text = $wgRightsText;
+ if( !$text && $title ) {
+ $text = $title->getPrefixedText();
+ }
+
+ $data = array(
+ 'url' => $url ? $url : '',
+ 'text' => $text ? $text : ''
+ );
+
+ return $this->getResult()->addValue( 'query', $property, $data );
+ }
+
+
+ public function getAllowedParams() {
+ return array(
+ 'prop' => array(
ApiBase :: PARAM_DFLT => 'general',
ApiBase :: PARAM_ISMULTI => true,
- ApiBase :: PARAM_TYPE => array (
+ ApiBase :: PARAM_TYPE => array(
'general',
'namespaces',
'namespacealiases',
'specialpagealiases',
+ 'magicwords',
'interwikimap',
'dbrepllag',
'statistics',
'usergroups',
- )),
-
- 'filteriw' => array (
- ApiBase :: PARAM_TYPE => array (
+ 'extensions',
+ 'fileextensions',
+ 'rightsinfo',
+ )
+ ),
+ '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',
+ ' general - Overall system information',
+ ' namespaces - List of registered namespaces and their canonical names',
+ ' namespacealiases - List of registered namespace aliases',
+ ' specialpagealiases - List of special page aliases',
+ ' magicwords - List of magic words and their 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',
+ ' extensions - Returns extensions installed on the wiki',
+ ' fileextensions - Returns list of file extensions allowed to be uploaded',
+ ' rightsinfo - Returns wiki rights (license) information if available',
),
'filteriw' => 'Return only local or only nonlocal entries of the interwiki map',
'showalldb' => 'List all database servers, not just the one lagging the most',
dépôts / lhc / web / wiklou.git / blobdiff