Update documentation:
[lhc/web/wiklou.git] / includes / api / ApiQuerySiteinfo.php
index c7a250c..02c8a7c 100644 (file)
@@ -41,51 +41,60 @@ class ApiQuerySiteinfo extends ApiQueryBase {
 
        public function execute() {
                $params = $this->extractRequestParams();
+               $done = array();
                foreach( $params['prop'] as $p )
                {
                        switch ( $p )
                        {
                                case 'general':
-                                       $this->appendGeneralInfo( $p );
+                                       $fit = $this->appendGeneralInfo( $p );
                                        break;
                                case 'namespaces':
-                                       $this->appendNamespaces( $p );
+                                       $fit = $this->appendNamespaces( $p );
                                        break;
                                case 'namespacealiases':
-                                       $this->appendNamespaceAliases( $p );
+                                       $fit = $this->appendNamespaceAliases( $p );
                                        break;
                                case 'specialpagealiases':
-                                       $this->appendSpecialPageAliases( $p );
+                                       $fit = $this->appendSpecialPageAliases( $p );
                                        break;
                                case 'magicwords':
-                                       $this->appendMagicWords( $p );
+                                       $fit = $this->appendMagicWords( $p );
                                        break;
                                case 'interwikimap':
                                        $filteriw = isset( $params['filteriw'] ) ? $params['filteriw'] : false;
-                                       $this->appendInterwikiMap( $p, $filteriw );
+                                       $fit = $this->appendInterwikiMap( $p, $filteriw );
                                        break;
                                case 'dbrepllag':
-                                       $this->appendDbReplLagInfo( $p, $params['showalldb'] );
+                                       $fit = $this->appendDbReplLagInfo( $p, $params['showalldb'] );
                                        break;
                                case 'statistics':
-                                       $this->appendStatistics( $p );
+                                       $fit = $this->appendStatistics( $p );
                                        break;
                                case 'usergroups':
-                                       $this->appendUserGroups( $p );
+                                       $fit = $this->appendUserGroups( $p );
                                        break;
                                case 'extensions':
-                                       $this->appendExtensions( $p );
+                                       $fit = $this->appendExtensions( $p );
                                        break;
                                case 'fileextensions':
-                                       $this->appendFileExtensions( $p );
+                                       $fit = $this->appendFileExtensions( $p );
                                        break;
-                               case 'configvars':
-                                       global $wgAPIReadableConfigVars;
-                                       $this->appendConfigvars( $p, $params['configvars'] );
+                               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;
                }
        }
 
@@ -128,9 +137,9 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                        $offset = 0;
                }
                $data['timezone'] = $tz;
-               $data['timeoffset'] = $offset;
+               $data['timeoffset'] = intval($offset);
 
-               $this->getResult()->addValue( 'query', $property, $data );
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
 
        protected function appendNamespaces( $property ) {
@@ -139,7 +148,7 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                foreach( $wgContLang->getFormattedNamespaces() as $ns => $title )
                {
                        $data[$ns] = array(
-                               'id' => $ns
+                               'id' => intval($ns)
                        );
                        ApiResult :: setContent( $data[$ns], $title );
                        $canonical = MWNamespace::getCanonicalName( $ns );
@@ -152,24 +161,29 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                }
 
                $this->getResult()->setIndexedTagName( $data, 'ns' );
-               $this->getResult()->addValue( 'query', $property, $data );
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
 
        protected function appendNamespaceAliases( $property ) {
                global $wgNamespaceAliases, $wgContLang;
                $wgContLang->load();
-               $aliases = array_merge($wgNamespaceAliases, $wgContLang->namespaceAliases);
+               $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' => $ns
+                               'id' => intval($ns)
                        );
                        ApiResult :: setContent( $item, strtr( $title, '_', ' ' ) );
                        $data[] = $item;
                }
 
                $this->getResult()->setIndexedTagName( $data, 'ns' );
-               $this->getResult()->addValue( 'query', $property, $data );
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
 
        protected function appendSpecialPageAliases( $property ) {
@@ -182,7 +196,7 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                        $data[] = $arr;
                }
                $this->getResult()->setIndexedTagName( $data, 'specialpage' );
-               $this->getResult()->addValue( 'query', $property, $data );
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
        
        protected function appendMagicWords( $property ) {
@@ -198,7 +212,7 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                        $data[] = $arr;
                }
                $this->getResult()->setIndexedTagName($data, 'magicword');
-               $this->getResult()->addValue('query', $property, $data);
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
 
        protected function appendInterwikiMap( $property, $filter ) {
@@ -236,7 +250,7 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                $db->freeResult( $res );
 
                $this->getResult()->setIndexedTagName( $data, 'iw' );
-               $this->getResult()->addValue( 'query', $property, $data );
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
 
        protected function appendDbReplLagInfo( $property, $includeAll ) {
@@ -258,27 +272,30 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                        list( $host, $lag ) = wfGetLB()->getMaxLag();
                        $data[] = array(
                                'host' => $wgShowHostnames ? $host : '',
-                               'lag' => $lag
+                               'lag' => intval( $lag )
                        );
                }
 
                $result = $this->getResult();
                $result->setIndexedTagName( $data, 'db' );
-               $result->addValue( 'query', $property, $data );
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
 
        protected function appendStatistics( $property ) {
+               global $wgDisableCounters;
                $data = array();
                $data['pages'] = intval( SiteStats::pages() );
                $data['articles'] = intval( SiteStats::articles() );
-               $data['views'] = intval( SiteStats::views() );
+               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() );
-               $this->getResult()->addValue( 'query', $property, $data );
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
 
        protected function appendUserGroups( $property ) {
@@ -291,7 +308,7 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                }
 
                $this->getResult()->setIndexedTagName( $data, 'group' );
-               $this->getResult()->addValue( 'query', $property, $data );
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
        
        protected function appendFileExtensions( $property ) {
@@ -302,7 +319,7 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                        $data[] = array( 'ext' => $ext );
                }
                $this->getResult()->setIndexedTagName( $data, 'fe' );
-               $this->getResult()->addValue( 'query', $property, $data );
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
 
        protected function appendExtensions( $property ) {
@@ -335,41 +352,29 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                }
 
                $this->getResult()->setIndexedTagName( $data, 'ext' );
-               $this->getResult()->addValue( 'query', $property, $data );
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
-       
-       protected function appendConfigvars( $property, $vars ) {
-               global $wgAPIReadableConfigVars;
-               if(empty($vars))
-                       $vars = $wgAPIReadableConfigVars;
-               $data = array();
-               foreach((array)$vars as $var)
-               {
-                       $value = $GLOBALS[$var];
-                       $r = array();
-                       $r['name'] = $var;
-                       $r['type'] = gettype($value);
-                       if(is_object($value))
-                               $r['class'] = get_class($value);
-                       elseif(is_bool($value))
-                               $r['value'] = ($value ? 'true' : 'false');
-                       elseif(!is_null($value))
-                       {
-                               $r['value'] = $value;
-                               if(is_array($value))
-                               {
-                                       $this->getResult()->setIndexedTagName($r['value'], 'elem');
-                                       $this->getResult()->setIndexedTagName_recursive($r['value'], 'elem');
-                               }
-                       }
-                       $data[] = $r;
+
+
+       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();
                }
-               $this->getResult()->setIndexedTagName($data, 'config');
-               $this->getResult()->addValue('query', $property, $data);
+
+               $data = array(
+                       'url' => $url ? $url : '',
+                       'text' => $text ?  $text : ''
+               );
+
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
 
+
        public function getAllowedParams() {
-               global $wgAPIReadableConfigVars;
                return array(
                        'prop' => array(
                                ApiBase :: PARAM_DFLT => 'general',
@@ -386,7 +391,7 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                                        'usergroups',
                                        'extensions',
                                        'fileextensions',
-                                       'configvars',
+                                       'rightsinfo',
                                )
                        ),
                        'filteriw' => array(
@@ -396,10 +401,6 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                                )
                        ),
                        'showalldb' => false,
-                       'configvars' => array(
-                               ApiBase :: PARAM_ISMULTI => true,
-                               ApiBase :: PARAM_TYPE => $wgAPIReadableConfigVars,
-                       ),
                );
        }
 
@@ -407,22 +408,21 @@ 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',
-                               ' "configvars"   - Returns the value of certain configuration variables',
+                               ' 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',
-                       'configvars' => 'Configuration variables to get. If empty, all configuration variables will be listed.',
                );
        }
 
@@ -435,10 +435,10 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                        '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