* Re-applying r34449, r34500 and r34518 which Brion reverted by accident
[lhc/web/wiklou.git] / includes / api / ApiQuerySiteinfo.php
index a05ea12..244a665 100644 (file)
@@ -30,7 +30,7 @@ if (!defined('MEDIAWIKI')) {
 
 /**
  * A query action to return meta information about the wiki site.
- * 
+ *
  * @addtogroup API
  */
 class ApiQuerySiteinfo extends ApiQueryBase {
@@ -53,120 +53,213 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                                case 'namespaces' :
                                        $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; 
+                                       $filteriw = isset($params['filteriw']) ? $params['filteriw'] : false;
                                        $this->appendInterwikiMap($p, $filteriw);
                                        break;
-                               case 'dbserverlag' :
-                                       $this->appendDbServerLagInfo($p, $params['showalldb']);
+                               case 'dbrepllag' :
+                                       $this->appendDbReplLagInfo($p, $params['showalldb']);
+                                       break;
+                               case 'statistics' :
+                                       $this->appendStatistics($p);
+                                       break;
+                               case 'usergroups' :
+                                       $this->appendUserGroups($p);
                                        break;
                        }
                }
        }
 
        protected function appendGeneralInfo($property) {
-               global $wgSitename, $wgVersion, $wgCapitalLinks, $wgRightsCode, $wgRightsText, $wgLanguageCode;
-               
+               global $wgSitename, $wgVersion, $wgCapitalLinks, $wgRightsCode, $wgRightsText, $wgLanguageCode, $IP, $wgEnableWriteAPI, $wgLang;
+
                $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;
+
                $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;
-               
+               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')
+               if($filter === 'local') {
                        $this->addWhere('iw_local = 1');
-               else if($filter === '!local')
+               } elseif($filter === '!local') {
                        $this->addWhere('iw_local = 0');
-               else if($filter !== false)
+               } elseif($filter !== false) {
                        ApiBase :: dieDebug(__METHOD__, "Unknown filter=$filter");
+               }
 
                $this->addOption('ORDER BY', 'iw_prefix');
-               
+
                $db = $this->getDB();
                $res = $this->select(__METHOD__);
 
                $data = array();
+               $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);
        }
-       
-       protected function appendDbServerLagInfo($property, $includeAll) {
-               global $wgLoadBalancer;
+
+       protected function appendDbReplLagInfo($property, $includeAll) {
+               global $wgShowHostnames;
 
                $data = array();
-               
+
                if ($includeAll) {
-                       global $wgDBservers;
-                       $lags = $wgLoadBalancer->getLagTimes();
+                       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' => $wgDBservers[$i]['host'],
+                                       'host' => $lb->getServerName( $i ),
                                        'lag' => $lag);
                        }
                } else {
-                       list( $host, $lag ) = $wgLoadBalancer->getMaxLag();
+                       list( $host, $lag ) = wfGetLB()->getMaxLag();
                        $data[] = array (
-                               'host' => $host,
+                               'host' => $wgShowHostnames ? $host : '',
                                'lag' => $lag);
-               }                                       
+               }
 
                $result = $this->getResult();
                $result->setIndexedTagName($data, 'db');
                $result->addValue('query', $property, $data);
-       }       
+       }
 
-       protected function getAllowedParams() {
+       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 (
                                ApiBase :: PARAM_DFLT => 'general',
                                ApiBase :: PARAM_ISMULTI => true,
                                ApiBase :: PARAM_TYPE => array (
                                        'general',
                                        'namespaces',
+                                       'namespacealiases',
+                                       'specialpagealiases',
                                        'interwikimap',
-                                       'dbserverlag',
+                                       'dbrepllag',
+                                       'statistics',
+                                       'usergroups',
                                )),
 
                        'filteriw' => array (
@@ -174,33 +267,38 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                                        'local',
                                        '!local',
                                )),
-                               
+
                        'showalldb' => false,
                );
        }
 
-       protected function getParamDescription() {
+       public function getParamDescription() {
                return array (
                        'prop' => array (
                                'Which sysinfo properties to get:',
                                ' "general"      - Overall system information',
                                ' "namespaces"   - List of registered namespaces (localized)',
-                               ' "interwikimap" - Return interwiki map (optionally filtered)',
-                               ' "dbserverlag"  - Get highest database replication server lag',
+                               ' "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 DB servers, not just the one lagging the most',
+                       '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 array(
-                       'api.php?action=query&meta=siteinfo&siprop=general|namespaces',
+                       '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',
                        );
        }
 
@@ -208,4 +306,3 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                return __CLASS__ . ': $Id$';
        }
 }
-