* (bug 18634) Create API to fetch MediaWiki's language fallback tree structure
[lhc/web/wiklou.git] / includes / api / ApiQuerySiteinfo.php
index 7b6bc39..4749610 100644 (file)
@@ -1,9 +1,8 @@
 <?php
-
 /**
- * Created on Sep 25, 2006
  *
- * API for MediaWiki 1.8+
+ *
+ * Created on Sep 25, 2006
  *
  * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
  *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
 if ( !defined( 'MEDIAWIKI' ) ) {
@@ -84,6 +85,18 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                                case 'languages':
                                        $fit = $this->appendLanguages( $p );
                                        break;
+                               case 'skins':
+                                       $fit = $this->appendSkins( $p );
+                                       break;
+                               case 'extensiontags':
+                                       $fit = $this->appendExtensionTags( $p );
+                                       break;
+                               case 'functionhooks':
+                                       $fit = $this->appendFunctionHooks( $p );
+                                       break;
+                               case 'showhooks':
+                                       $fit = $this->appendSubscribedHooks( $p );
+                                       break;
                                default:
                                        ApiBase::dieDebug( __METHOD__, "Unknown prop=$p" );
                        }
@@ -99,12 +112,12 @@ class ApiQuerySiteinfo extends ApiQueryBase {
        }
 
        protected function appendGeneralInfo( $property ) {
-               global $wgContLang, $wgLang;
+               global $wgContLang;
 
                $data = array();
-               $mainPage = Title::newFromText( wfMsgForContent( 'mainpage' ) );
+               $mainPage = Title::newMainPage();
                $data['mainpage'] = $mainPage->getPrefixedText();
-               $data['base'] = $mainPage->getFullUrl();
+               $data['base'] = wfExpandUrl( $mainPage->getFullUrl() );
                $data['sitename'] = $GLOBALS['wgSitename'];
                $data['generator'] = "MediaWiki {$GLOBALS['wgVersion']}";
                $data['phpversion'] = phpversion();
@@ -125,10 +138,20 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                }
                $data['rights'] = $GLOBALS['wgRightsText'];
                $data['lang'] = $GLOBALS['wgLanguageCode'];
+
+               $fallbackLang = $wgContLang->getFallbackLanguageCode();
+               $fallbackLangArray = array();
+               while( $fallbackLang ) {
+                       $fallbackLangArray[] = array( 'code' => $fallbackLang );
+                       $fallbackLang = Language::getFallbackFor( $fallbackLang );
+               }
+               $data['fallback'] = $fallbackLangArray;
+               $this->getResult()->setIndexedTagName( $data['fallback'], 'lang' );
+
                if ( $wgContLang->isRTL() ) {
                        $data['rtl'] = '';
                }
-               $data['fallback8bitEncoding'] = $wgLang->fallback8bitEncoding();
+               $data['fallback8bitEncoding'] = $wgContLang->fallback8bitEncoding();
 
                if ( wfReadOnly() ) {
                        $data['readonly'] = '';
@@ -156,6 +179,12 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                $data['wikiid'] = wfWikiID();
                $data['time'] = wfTimestamp( TS_ISO_8601, time() );
 
+               if ( $GLOBALS['wgMiserMode'] ) {
+                       $data['misermode'] = '';
+               }
+
+               wfRunHooks( 'APIQuerySiteInfoGeneralInfo', array( $this, &$data ) );
+
                return $this->getResult()->addValue( 'query', $property, $data );
        }
 
@@ -209,10 +238,9 @@ class ApiQuerySiteinfo extends ApiQueryBase {
        }
 
        protected function appendSpecialPageAliases( $property ) {
-               global $wgLang;
+               global $wgContLang;
                $data = array();
-               foreach ( $wgLang->getSpecialPageAliases() as $specialpage => $aliases )
-               {
+               foreach ( $wgContLang->getSpecialPageAliases() as $specialpage => $aliases ) {
                        $arr = array( 'realname' => $specialpage, 'aliases' => $aliases );
                        $this->getResult()->setIndexedTagName( $arr['aliases'], 'alias' );
                        $data[] = $arr;
@@ -238,40 +266,48 @@ class ApiQuerySiteinfo extends ApiQueryBase {
        }
 
        protected function appendInterwikiMap( $property, $filter ) {
-               $this->resetQueryParams();
-               $this->addTables( 'interwiki' );
-               $this->addFields( array( 'iw_prefix', 'iw_local', 'iw_url' ) );
-
+               $local = null;
                if ( $filter === 'local' ) {
-                       $this->addWhere( 'iw_local = 1' );
+                       $local = 1;
                } elseif ( $filter === '!local' ) {
-                       $this->addWhere( 'iw_local = 0' );
+                       $local = 0;
                } elseif ( $filter ) {
                        ApiBase::dieDebug( __METHOD__, "Unknown filter=$filter" );
                }
 
-               $this->addOption( 'ORDER BY', 'iw_prefix' );
+               $params = $this->extractRequestParams();
+               $langCode = isset( $params['inlanguagecode '] ) ? $params['inlanguagecode '] : '';
 
-               $db = $this->getDB();
-               $res = $this->select( __METHOD__ );
+               if( $langCode ) {
+                       $langNames = Language::getTranslatedLanguageNames( $langCode );
+               } else {
+                       $langNames = Language::getLanguageNames();
+               }
 
+               $getPrefixes = Interwiki::getAllPrefixes( $local );
                $data = array();
-               $langNames = Language::getLanguageNames();
-               while ( $row = $db->fetchObject( $res ) ) {
+
+               foreach ( $getPrefixes as $row ) {
+                       $prefix = $row['iw_prefix'];
                        $val = array();
-                       $val['prefix'] = $row->iw_prefix;
-                       if ( $row->iw_local == '1' ) {
+                       $val['prefix'] = $prefix;
+                       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['trans'] = intval( $row['iw_trans'] ); // should this be exposed?
+                       if ( isset( $langNames[$prefix] ) ) {
+                               $val['language'] = $langNames[$prefix];
+                       }
+                       $val['url'] = wfExpandUrl( $row['iw_url'] );
+                       if( isset( $row['iw_wikiid'] ) ) {
+                               $val['wikiid'] = $row['iw_wikiid'];
+                       }
+                       if( isset( $row['iw_api'] ) ) {
+                               $val['api'] = $row['iw_api'];
                        }
-                       $val['url'] = $row->iw_url;
 
                        $data[] = $val;
                }
-               $db->freeResult( $res );
 
                $this->getResult()->setIndexedTagName( $data, 'iw' );
                return $this->getResult()->addValue( 'query', $property, $data );
@@ -280,12 +316,12 @@ class ApiQuerySiteinfo extends ApiQueryBase {
        protected function appendDbReplLagInfo( $property, $includeAll ) {
                global $wgShowHostnames;
                $data = array();
+               $lb = wfGetLB();
                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(
@@ -294,9 +330,11 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                                );
                        }
                } else {
-                       list( $host, $lag ) = wfGetLB()->getMaxLag();
+                       list( $host, $lag, $index ) = $lb->getMaxLag();
                        $data[] = array(
-                               'host' => $wgShowHostnames ? $host : '',
+                               'host' => $wgShowHostnames
+                                               ? $lb->getServerName( $index )
+                                               : '',
                                'lag' => intval( $lag )
                        );
                }
@@ -324,23 +362,48 @@ class ApiQuerySiteinfo extends ApiQueryBase {
        }
 
        protected function appendUserGroups( $property, $numberInGroup ) {
-               global $wgGroupPermissions;
+               global $wgGroupPermissions, $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
+
                $data = array();
+               $result = $this->getResult();
                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];
+                                       $result->setIndexedTagName( $arr[$type], 'group' );
+                               }
                        }
 
-                       $this->getResult()->setIndexedTagName( $arr['rights'], 'permission' );
+                       $result->setIndexedTagName( $arr['rights'], 'permission' );
                        $data[] = $arr;
                }
 
-               $this->getResult()->setIndexedTagName( $data, 'group' );
-               return $this->getResult()->addValue( 'query', $property, $data );
+               $result->setIndexedTagName( $data, 'group' );
+               return $result->addValue( 'query', $property, $data );
        }
 
        protected function appendFileExtensions( $property ) {
@@ -400,11 +463,10 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                return $this->getResult()->addValue( 'query', $property, $data );
        }
 
-
        protected function appendRightsInfo( $property ) {
                global $wgRightsPage, $wgRightsUrl, $wgRightsText;
                $title = Title::newFromText( $wgRightsPage );
-               $url = $title ? $title->getFullURL() : $wgRightsUrl;
+               $url = $title ? wfExpandUrl( $title->getFullURL() ) : $wgRightsUrl;
                $text = $wgRightsText;
                if ( !$text && $title ) {
                        $text = $title->getPrefixedText();
@@ -419,8 +481,18 @@ class ApiQuerySiteinfo extends ApiQueryBase {
        }
 
        public function appendLanguages( $property ) {
+               $params = $this->extractRequestParams();
+               $langCode = isset( $params['inlanguagecode '] ) ? $params['inlanguagecode '] : '';
+
+               if( $langCode ) {
+                       $langNames = Language::getTranslatedLanguageNames( $langCode );
+               } else {
+                       $langNames = Language::getLanguageNames();
+               }
+
                $data = array();
-               foreach ( Language::getLanguageNames() as $code => $name ) {
+
+               foreach ( $langNames as $code => $name ) {
                        $lang = array( 'code' => $code );
                        ApiResult::setContent( $lang, $name );
                        $data[] = $lang;
@@ -429,6 +501,61 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                return $this->getResult()->addValue( 'query', $property, $data );
        }
 
+       public function appendSkins( $property ) {
+               $data = array();
+               foreach ( Skin::getSkinNames() as $name => $displayName ) {
+                       $skin = array( 'code' => $name );
+                       ApiResult::setContent( $skin, $displayName );
+                       $data[] = $skin;
+               }
+               $this->getResult()->setIndexedTagName( $data, 'skin' );
+               return $this->getResult()->addValue( 'query', $property, $data );
+       }
+
+       public function appendExtensionTags( $property ) {
+               global $wgParser;
+               $wgParser->firstCallInit();
+               $tags = array_map( array( $this, 'formatParserTags'), $wgParser->getTags() );
+               $this->getResult()->setIndexedTagName( $tags, 't' );
+               return $this->getResult()->addValue( 'query', $property, $tags );
+       }
+
+       public function appendFunctionHooks( $property ) {
+               global $wgParser;
+               $wgParser->firstCallInit();
+               $hooks = $wgParser->getFunctionHooks();
+               $this->getResult()->setIndexedTagName( $hooks, 'h' );
+               return $this->getResult()->addValue( 'query', $property, $hooks );
+       }
+
+       private function formatParserTags( $item ) {
+               return "<{$item}>";
+       }
+
+       public function appendSubscribedHooks( $property ) {
+               global $wgHooks;
+               $myWgHooks = $wgHooks;
+               ksort( $myWgHooks );
+
+               $data = array();
+               foreach ( $myWgHooks as $hook => $hooks )  {
+                       $arr = array(
+                               'name' => $hook,
+                               'subscribers' => array_map( array( 'SpecialVersion', 'arrayToString' ), $hooks ),
+                       );
+
+                       $this->getResult()->setIndexedTagName( $arr['subscribers'], 's' );
+                       $data[] = $arr;
+               }
+
+               $this->getResult()->setIndexedTagName( $data, 'hook' );
+               return $this->getResult()->addValue( 'query', $property, $data );
+       }
+
+       public function getCacheMode( $params ) {
+               return 'public';
+       }
+
        public function getAllowedParams() {
                return array(
                        'prop' => array(
@@ -448,6 +575,10 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                                        'fileextensions',
                                        'rightsinfo',
                                        'languages',
+                                       'skins',
+                                       'extensiontags',
+                                       'functionhooks',
+                                       'showhooks',
                                )
                        ),
                        'filteriw' => array(
@@ -458,35 +589,42 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                        ),
                        'showalldb' => false,
                        'numberingroup' => false,
+                       'inlanguagecode ' => null,
                );
        }
 
        public function getParamDescription() {
+               $p = $this->getModulePrefix();
                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, (optionally localised by using {$p}inlanguagecode))",
+                               ' 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 (optionally localised by using {$p}inlanguagecode)",
+                               ' skins                 - Returns a list of all enabled skins',
+                               ' extensiontags         - Returns a list of parser extension tags',
+                               ' functionhooks         - Returns a list of parser function hooks',
+                               ' showhooks             - Returns a list of all subscribed hooks (contents of $wgHooks)'
                        ),
                        'filteriw' =>  'Return only local or only nonlocal entries of the interwiki map',
                        'showalldb' => 'List all database servers, not just the one lagging the most',
                        'numberingroup' => 'Lists the number of users in user groups',
+                       'inlanguagecode ' => 'Language code for localised language names (best effort, use CLDR extension)',
                );
        }
 
        public function getDescription() {
-               return 'Return general information about the site.';
+               return 'Return general information about the site';
        }
 
        public function getPossibleErrors() {
@@ -499,10 +637,14 @@ class ApiQuerySiteinfo extends ApiQueryBase {
                return array(
                        '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',
+                       'api.php?action=query&meta=siteinfo&siprop=dbrepllag&sishowalldb=',
                );
        }
 
+       public function getHelpUrls() {
+               return 'http://www.mediawiki.org/wiki/API:Meta#siteinfo_.2F_si';
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }