Explicit variable definition, tweak documentation

[lhc/web/wiklou.git] / includes / api / ApiQuerySiteinfo.php

diff --git a/includes/api/ApiQuerySiteinfo.php b/includes/api/ApiQuerySiteinfo.php
index 092aaab..5eec4de 100644 (file)
--- a/includes/api/ApiQuerySiteinfo.php
+++ b/includes/api/ApiQuerySiteinfo.php
@@ -1,10 +1,9 @@
 <?php
-
 /**
- * Created on Sep 25, 2006
- *
  * API for MediaWiki 1.8+
  *
+ * Created on Sep 25, 2006
+ *
  * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
  * This program is free software; you can redistribute it and/or modify
@@ -21,6 +20,8 @@
  * with this program; if not, write to the Free Software Foundation, Inc.,
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
 if ( !defined( 'MEDIAWIKI' ) ) {
@@ -252,7 +253,6 @@ class ApiQuerySiteinfo extends ApiQueryBase {
 
                $this->addOption( 'ORDER BY', 'iw_prefix' );
 
-               $db = $this->getDB();
                $res = $this->select( __METHOD__ );
 
                $data = array();
@@ -263,7 +263,7 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                        if ( $row->iw_local == '1' ) {
                                $val['local'] = '';
                        }
-//                     $val['trans'] = intval( $row->iw_trans ); // should this be exposed?
+                       // $val['trans'] = intval( $row->iw_trans ); // should this be exposed?
                        if ( isset( $langNames[$row->iw_prefix] ) ) {
                                $val['language'] = $langNames[$row->iw_prefix];
                        }
@@ -323,21 +323,45 @@ class ApiQuerySiteinfo extends ApiQueryBase {
        }
 
        protected function appendUserGroups( $property, $numberInGroup ) {
-               global $wgGroupPermissions;
+               global $wgGroupPermissions, $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
+               
                $data = array();
                foreach ( $wgGroupPermissions as $group => $permissions ) {
                        $arr = array(
                                'name' => $group,
                                'rights' => array_keys( $permissions, true ),
                        );
+                       
                        if ( $numberInGroup ) {
-                               $arr['number'] = SiteStats::numberInGroup( $group );
+                               global $wgAutopromote;
+                       
+                               if ( $group == 'user' ) {
+                                       $arr['number'] = SiteStats::users();
+                                       
+                               // '*' and autopromote groups have no size
+                               } elseif ( $group !== '*' && !isset( $wgAutopromote[$group] ) ) {
+                                       $arr['number'] = SiteStats::numberInGroup( $group );
+                               }
                        }
-
+                       
+                       $groupArr = array(
+                               'add' => $wgAddGroups,
+                               'remove' => $wgRemoveGroups,
+                               'add-self' => $wgGroupsAddToSelf,
+                               'remove-self' => $wgGroupsRemoveFromSelf
+                       );
+                       
+                       foreach( $groupArr as $type => $rights ) {
+                               if( isset( $rights[$group] ) ) {
+                                       $arr[$type] = $rights[$group];
+                                       $this->getResult()->setIndexedTagName( $arr[$type], 'group' );
+                               }
+                       }
+                       
                        $this->getResult()->setIndexedTagName( $arr['rights'], 'permission' );
                        $data[] = $arr;
                }
-
+               
                $this->getResult()->setIndexedTagName( $data, 'group' );
                return $this->getResult()->addValue( 'query', $property, $data );
        }
@@ -428,6 +452,10 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                return $this->getResult()->addValue( 'query', $property, $data );
        }
 
+       public function getCacheMode( $params ) {
+               return 'public';
+       }
+
        public function getAllowedParams() {
                return array(
                        'prop' => array(
@@ -464,19 +492,19 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                return array(
                        'prop' => array(
                                'Which sysinfo properties to get:',
-                               ' 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',
-                               ' languages    - Returns a list of languages MediaWiki supports',
+                               ' 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',
+                               ' languages             - Returns a list of languages MediaWiki supports',
                        ),
                        'filteriw' =>  'Return only local or only nonlocal entries of the interwiki map',
                        'showalldb' => 'List all database servers, not just the one lagging the most',