Update documentation:
[lhc/web/wiklou.git] / includes / api / ApiQuerySiteinfo.php
index 5d03994..02c8a7c 100644 (file)
@@ -41,41 +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':
+                                       $fit = $this->appendExtensions( $p );
+                                       break;
+                               case 'fileextensions':
+                                       $fit = $this->appendFileExtensions( $p );
+                                       break;
+                               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;
                }
        }
 
@@ -118,9 +137,9 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                        $offset = 0;
                }
                $data['timezone'] = $tz;
-               $data['timeoffset'] = $offset;
+               $data['timeoffset'] = intval($offset);
 
-               $this->getResult()->addValue( array( 'query', $this->getModuleName() ), $property, $data );
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
 
        protected function appendNamespaces( $property ) {
@@ -129,30 +148,42 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                foreach( $wgContLang->getFormattedNamespaces() as $ns => $title )
                {
                        $data[$ns] = array(
-                               'id' => $ns
+                               'id' => intval($ns)
                        );
                        ApiResult :: setContent( $data[$ns], $title );
-                       if( MWNamespace::hasSubpages($ns) )
+                       $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( array( 'query', $this->getModuleName() ), $property, $data );
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
 
        protected function appendNamespaceAliases( $property ) {
-               global $wgNamespaceAliases;
+               global $wgNamespaceAliases, $wgContLang;
+               $wgContLang->load();
+               $aliases = array_merge( $wgNamespaceAliases, $wgContLang->namespaceAliases );
+               $namespaces = $wgContLang->getNamespaces();
                $data = array();
-               foreach( $wgNamespaceAliases as $title => $ns ) {
+               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( array( 'query', $this->getModuleName() ), $property, $data );
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
 
        protected function appendSpecialPageAliases( $property ) {
@@ -165,7 +196,7 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                        $data[] = $arr;
                }
                $this->getResult()->setIndexedTagName( $data, 'specialpage' );
-               $this->getResult()->addValue( array( 'query', $this->getModuleName() ), $property, $data );
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
        
        protected function appendMagicWords( $property ) {
@@ -181,9 +212,8 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                        $data[] = $arr;
                }
                $this->getResult()->setIndexedTagName($data, 'magicword');
-               $this->getResult()->addValue( array( 'query', $this->getModuleName() ), $property, $data );
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
-                       
 
        protected function appendInterwikiMap( $property, $filter ) {
                $this->resetQueryParams();
@@ -194,7 +224,7 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                        $this->addWhere( 'iw_local = 1' );
                elseif( $filter === '!local' )
                        $this->addWhere( 'iw_local = 0' );
-               elseif( $filter !== false )
+               elseif( $filter )
                        ApiBase :: dieDebug( __METHOD__, "Unknown filter=$filter" );
 
                $this->addOption( 'ORDER BY', 'iw_prefix' );
@@ -220,7 +250,7 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                $db->freeResult( $res );
 
                $this->getResult()->setIndexedTagName( $data, 'iw' );
-               $this->getResult()->addValue( array( 'query', $this->getModuleName() ), $property, $data );
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
 
        protected function appendDbReplLagInfo( $property, $includeAll ) {
@@ -242,26 +272,30 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                        list( $host, $lag ) = wfGetLB()->getMaxLag();
                        $data[] = array(
                                'host' => $wgShowHostnames ? $host : '',
-                               'lag' => $lag
+                               'lag' => intval( $lag )
                        );
                }
 
-               $this->getResult()->setIndexedTagName( $data, 'db' );
-               $this->getResult()->addValue( array( 'query', $this->getModuleName() ), $property, $data );
+               $result = $this->getResult();
+               $result->setIndexedTagName( $data, 'db' );
+               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( array( 'query', $this->getModuleName() ), $property, $data );
+               return $this->getResult()->addValue( 'query', $property, $data );
        }
 
        protected function appendUserGroups( $property ) {
@@ -274,9 +308,72 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                }
 
                $this->getResult()->setIndexedTagName( $data, 'group' );
-               $this->getResult()->addValue( array( 'query', $this->getModuleName() ), $property, $data );
+               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 );
        }
 
+       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 );
+       }
+
+
+       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(
@@ -292,6 +389,9 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                                        'dbrepllag',
                                        'statistics',
                                        'usergroups',
+                                       'extensions',
+                                       'fileextensions',
+                                       'rightsinfo',
                                )
                        ),
                        'filteriw' => array(
@@ -308,15 +408,18 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                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',
-                               ' "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',
+                               ' 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',
@@ -338,4 +441,4 @@ class ApiQuerySiteinfo extends ApiQueryBase {
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
-}
+}
\ No newline at end of file