3 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
22 use MediaWiki\MediaWikiServices
;
25 * A query action to return meta information about the wiki site.
29 class ApiQuerySiteinfo
extends ApiQueryBase
{
31 public function __construct( ApiQuery
$query, $moduleName ) {
32 parent
::__construct( $query, $moduleName, 'si' );
35 public function execute() {
36 $params = $this->extractRequestParams();
39 foreach ( $params['prop'] as $p ) {
42 $fit = $this->appendGeneralInfo( $p );
45 $fit = $this->appendNamespaces( $p );
47 case 'namespacealiases':
48 $fit = $this->appendNamespaceAliases( $p );
50 case 'specialpagealiases':
51 $fit = $this->appendSpecialPageAliases( $p );
54 $fit = $this->appendMagicWords( $p );
57 $fit = $this->appendInterwikiMap( $p, $params['filteriw'] );
60 $fit = $this->appendDbReplLagInfo( $p, $params['showalldb'] );
63 $fit = $this->appendStatistics( $p );
66 $fit = $this->appendUserGroups( $p, $params['numberingroup'] );
69 $fit = $this->appendInstalledLibraries( $p );
72 $fit = $this->appendExtensions( $p );
74 case 'fileextensions':
75 $fit = $this->appendFileExtensions( $p );
78 $fit = $this->appendRightsInfo( $p );
81 $fit = $this->appendRestrictions( $p );
84 $fit = $this->appendLanguages( $p );
86 case 'languagevariants':
87 $fit = $this->appendLanguageVariants( $p );
90 $fit = $this->appendSkins( $p );
93 $fit = $this->appendExtensionTags( $p );
96 $fit = $this->appendFunctionHooks( $p );
99 $fit = $this->appendSubscribedHooks( $p );
102 $fit = $this->appendVariables( $p );
105 $fit = $this->appendProtocols( $p );
107 case 'defaultoptions':
108 $fit = $this->appendDefaultOptions( $p );
111 $fit = $this->appendUploadDialog( $p );
114 ApiBase
::dieDebug( __METHOD__
, "Unknown prop=$p" ); // @codeCoverageIgnore
117 // Abuse siprop as a query-continue parameter
118 // and set it to all unprocessed props
119 $this->setContinueEnumParameter( 'prop', implode( '|',
120 array_diff( $params['prop'], $done ) ) );
127 protected function appendGeneralInfo( $property ) {
128 $config = $this->getConfig();
131 $mainPage = Title
::newMainPage();
132 $data['mainpage'] = $mainPage->getPrefixedText();
133 $data['base'] = wfExpandUrl( $mainPage->getFullURL(), PROTO_CURRENT
);
134 $data['sitename'] = $config->get( 'Sitename' );
136 // wgLogo can either be a relative or an absolute path
137 // make sure we always return an absolute path
138 $data['logo'] = wfExpandUrl( $config->get( 'Logo' ), PROTO_RELATIVE
);
140 $data['generator'] = "MediaWiki {$config->get( 'Version' )}";
142 $data['phpversion'] = PHP_VERSION
;
143 $data['phpsapi'] = PHP_SAPI
;
144 if ( defined( 'HHVM_VERSION' ) ) {
145 $data['hhvmversion'] = HHVM_VERSION
; // @codeCoverageIgnore
147 $data['dbtype'] = $config->get( 'DBtype' );
148 $data['dbversion'] = $this->getDB()->getServerVersion();
151 $allowException = true;
152 if ( !$config->get( 'AllowExternalImages' ) ) {
153 $data['imagewhitelistenabled'] = (bool)$config->get( 'EnableImageWhitelist' );
154 $allowFrom = $config->get( 'AllowExternalImagesFrom' );
155 $allowException = !empty( $allowFrom );
157 if ( $allowException ) {
158 $data['externalimages'] = (array)$allowFrom;
159 ApiResult
::setIndexedTagName( $data['externalimages'], 'prefix' );
162 $data['langconversion'] = !$config->get( 'DisableLangConversion' );
163 $data['titleconversion'] = !$config->get( 'DisableTitleConversion' );
165 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
166 if ( $contLang->linkPrefixExtension() ) {
167 $linkPrefixCharset = $contLang->linkPrefixCharset();
168 $data['linkprefixcharset'] = $linkPrefixCharset;
169 // For backwards compatibility
170 $data['linkprefix'] = "/^((?>.*[^$linkPrefixCharset]|))(.+)$/sDu";
172 $data['linkprefixcharset'] = '';
173 $data['linkprefix'] = '';
176 $linktrail = $contLang->linkTrail();
177 $data['linktrail'] = $linktrail ?
: '';
179 $data['legaltitlechars'] = Title
::legalChars();
180 $data['invalidusernamechars'] = $config->get( 'InvalidUsernameCharacters' );
182 $data['allunicodefixes'] = (bool)$config->get( 'AllUnicodeFixes' );
183 $data['fixarabicunicode'] = (bool)$config->get( 'FixArabicUnicode' );
184 $data['fixmalayalamunicode'] = (bool)$config->get( 'FixMalayalamUnicode' );
187 $git = SpecialVersion
::getGitHeadSha1( $IP );
189 $data['git-hash'] = $git;
190 $data['git-branch'] =
191 SpecialVersion
::getGitCurrentBranch( $GLOBALS['IP'] );
194 // 'case-insensitive' option is reserved for future
195 $data['case'] = $config->get( 'CapitalLinks' ) ?
'first-letter' : 'case-sensitive';
196 $data['lang'] = $config->get( 'LanguageCode' );
199 foreach ( $contLang->getFallbackLanguages() as $code ) {
200 $fallbacks[] = [ 'code' => $code ];
202 $data['fallback'] = $fallbacks;
203 ApiResult
::setIndexedTagName( $data['fallback'], 'lang' );
205 if ( $contLang->hasVariants() ) {
207 foreach ( $contLang->getVariants() as $code ) {
210 'name' => $contLang->getVariantname( $code ),
213 $data['variants'] = $variants;
214 ApiResult
::setIndexedTagName( $data['variants'], 'lang' );
217 $data['rtl'] = $contLang->isRTL();
218 $data['fallback8bitEncoding'] = $contLang->fallback8bitEncoding();
220 $data['readonly'] = wfReadOnly();
221 if ( $data['readonly'] ) {
222 $data['readonlyreason'] = wfReadOnlyReason();
224 $data['writeapi'] = true; // Deprecated since MW 1.32
226 $data['maxarticlesize'] = $config->get( 'MaxArticleSize' ) * 1024;
228 $tz = $config->get( 'Localtimezone' );
229 $offset = $config->get( 'LocalTZoffset' );
230 $data['timezone'] = $tz;
231 $data['timeoffset'] = (int)$offset;
232 $data['articlepath'] = $config->get( 'ArticlePath' );
233 $data['scriptpath'] = $config->get( 'ScriptPath' );
234 $data['script'] = $config->get( 'Script' );
235 $data['variantarticlepath'] = $config->get( 'VariantArticlePath' );
236 $data[ApiResult
::META_BC_BOOLS
][] = 'variantarticlepath';
237 $data['server'] = $config->get( 'Server' );
238 $data['servername'] = $config->get( 'ServerName' );
239 $data['wikiid'] = WikiMap
::getWikiIdFromDbDomain( WikiMap
::getCurrentWikiDbDomain() );
240 $data['time'] = wfTimestamp( TS_ISO_8601
, time() );
242 $data['misermode'] = (bool)$config->get( 'MiserMode' );
244 $data['uploadsenabled'] = UploadBase
::isEnabled();
245 $data['maxuploadsize'] = UploadBase
::getMaxUploadSize();
246 $data['minuploadchunksize'] = (int)$config->get( 'MinUploadChunkSize' );
248 $data['galleryoptions'] = $config->get( 'GalleryOptions' );
250 $data['thumblimits'] = $config->get( 'ThumbLimits' );
251 ApiResult
::setArrayType( $data['thumblimits'], 'BCassoc' );
252 ApiResult
::setIndexedTagName( $data['thumblimits'], 'limit' );
253 $data['imagelimits'] = [];
254 ApiResult
::setArrayType( $data['imagelimits'], 'BCassoc' );
255 ApiResult
::setIndexedTagName( $data['imagelimits'], 'limit' );
256 foreach ( $config->get( 'ImageLimits' ) as $k => $limit ) {
257 $data['imagelimits'][$k] = [ 'width' => $limit[0], 'height' => $limit[1] ];
260 $favicon = $config->get( 'Favicon' );
261 if ( !empty( $favicon ) ) {
262 // wgFavicon can either be a relative or an absolute path
263 // make sure we always return an absolute path
264 $data['favicon'] = wfExpandUrl( $favicon, PROTO_RELATIVE
);
267 $data['centralidlookupprovider'] = $config->get( 'CentralIdLookupProvider' );
268 $providerIds = array_keys( $config->get( 'CentralIdLookupProviders' ) );
269 $data['allcentralidlookupproviders'] = $providerIds;
271 $data['interwikimagic'] = (bool)$config->get( 'InterwikiMagic' );
272 $data['magiclinks'] = $config->get( 'EnableMagicLinks' );
274 $data['categorycollation'] = $config->get( 'CategoryCollation' );
276 Hooks
::run( 'APIQuerySiteInfoGeneralInfo', [ $this, &$data ] );
278 return $this->getResult()->addValue( 'query', $property, $data );
281 protected function appendNamespaces( $property ) {
282 $nsProtection = $this->getConfig()->get( 'NamespaceProtection' );
285 ApiResult
::META_TYPE
=> 'assoc',
287 $nsInfo = MediaWikiServices
::getInstance()->getNamespaceInfo();
289 MediaWikiServices
::getInstance()->getContentLanguage()->getFormattedNamespaces()
294 'case' => $nsInfo->isCapitalized( $ns ) ?
'first-letter' : 'case-sensitive',
296 ApiResult
::setContentValue( $data[$ns], 'name', $title );
297 $canonical = $nsInfo->getCanonicalName( $ns );
299 $data[$ns]['subpages'] = $nsInfo->hasSubpages( $ns );
302 $data[$ns]['canonical'] = strtr( $canonical, '_', ' ' );
305 $data[$ns]['content'] = $nsInfo->isContent( $ns );
306 $data[$ns]['nonincludable'] = $nsInfo->isNonincludable( $ns );
308 if ( isset( $nsProtection[$ns] ) ) {
309 if ( is_array( $nsProtection[$ns] ) ) {
310 $specificNs = implode( "|", array_filter( $nsProtection[$ns] ) );
311 } elseif ( $nsProtection[$ns] !== '' ) {
312 $specificNs = $nsProtection[$ns];
314 if ( isset( $specificNs ) && $specificNs !== '' ) {
315 $data[$ns]['namespaceprotection'] = $specificNs;
319 $contentmodel = $nsInfo->getNamespaceContentModel( $ns );
320 if ( $contentmodel ) {
321 $data[$ns]['defaultcontentmodel'] = $contentmodel;
325 ApiResult
::setArrayType( $data, 'assoc' );
326 ApiResult
::setIndexedTagName( $data, 'ns' );
328 return $this->getResult()->addValue( 'query', $property, $data );
331 protected function appendNamespaceAliases( $property ) {
332 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
333 $aliases = array_merge( $this->getConfig()->get( 'NamespaceAliases' ),
334 $contLang->getNamespaceAliases() );
335 $namespaces = $contLang->getNamespaces();
337 foreach ( $aliases as $title => $ns ) {
338 if ( $namespaces[$ns] == $title ) {
339 // Don't list duplicates
345 ApiResult
::setContentValue( $item, 'alias', strtr( $title, '_', ' ' ) );
351 ApiResult
::setIndexedTagName( $data, 'ns' );
353 return $this->getResult()->addValue( 'query', $property, $data );
356 protected function appendSpecialPageAliases( $property ) {
358 $services = MediaWikiServices
::getInstance();
359 $aliases = $services->getContentLanguage()->getSpecialPageAliases();
360 foreach ( $services->getSpecialPageFactory()->getNames() as $specialpage ) {
361 if ( isset( $aliases[$specialpage] ) ) {
362 $arr = [ 'realname' => $specialpage, 'aliases' => $aliases[$specialpage] ];
363 ApiResult
::setIndexedTagName( $arr['aliases'], 'alias' );
367 ApiResult
::setIndexedTagName( $data, 'specialpage' );
369 return $this->getResult()->addValue( 'query', $property, $data );
372 protected function appendMagicWords( $property ) {
375 MediaWikiServices
::getInstance()->getContentLanguage()->getMagicWords()
376 as $magicword => $aliases
378 $caseSensitive = array_shift( $aliases );
379 $arr = [ 'name' => $magicword, 'aliases' => $aliases ];
380 $arr['case-sensitive'] = (bool)$caseSensitive;
381 ApiResult
::setIndexedTagName( $arr['aliases'], 'alias' );
384 ApiResult
::setIndexedTagName( $data, 'magicword' );
386 return $this->getResult()->addValue( 'query', $property, $data );
389 protected function appendInterwikiMap( $property, $filter ) {
390 if ( $filter === 'local' ) {
392 } elseif ( $filter === '!local' ) {
399 $params = $this->extractRequestParams();
400 $langCode = $params['inlanguagecode'] ??
'';
401 $langNames = Language
::fetchLanguageNames( $langCode );
403 $getPrefixes = MediaWikiServices
::getInstance()->getInterwikiLookup()->getAllPrefixes( $local );
404 $extraLangPrefixes = $this->getConfig()->get( 'ExtraInterlanguageLinkPrefixes' );
405 $localInterwikis = $this->getConfig()->get( 'LocalInterwikis' );
408 foreach ( $getPrefixes as $row ) {
409 $prefix = $row['iw_prefix'];
411 $val['prefix'] = $prefix;
412 if ( isset( $row['iw_local'] ) && $row['iw_local'] == '1' ) {
413 $val['local'] = true;
415 if ( isset( $row['iw_trans'] ) && $row['iw_trans'] == '1' ) {
416 $val['trans'] = true;
419 if ( isset( $langNames[$prefix] ) ) {
420 $val['language'] = $langNames[$prefix];
422 if ( in_array( $prefix, $localInterwikis ) ) {
423 $val['localinterwiki'] = true;
425 if ( in_array( $prefix, $extraLangPrefixes ) ) {
426 $val['extralanglink'] = true;
428 $linktext = wfMessage( "interlanguage-link-$prefix" );
429 if ( !$linktext->isDisabled() ) {
430 $val['linktext'] = $linktext->text();
433 $sitename = wfMessage( "interlanguage-link-sitename-$prefix" );
434 if ( !$sitename->isDisabled() ) {
435 $val['sitename'] = $sitename->text();
439 $val['url'] = wfExpandUrl( $row['iw_url'], PROTO_CURRENT
);
440 $val['protorel'] = substr( $row['iw_url'], 0, 2 ) == '//';
441 if ( isset( $row['iw_wikiid'] ) && $row['iw_wikiid'] !== '' ) {
442 $val['wikiid'] = $row['iw_wikiid'];
444 if ( isset( $row['iw_api'] ) && $row['iw_api'] !== '' ) {
445 $val['api'] = $row['iw_api'];
451 ApiResult
::setIndexedTagName( $data, 'iw' );
453 return $this->getResult()->addValue( 'query', $property, $data );
456 protected function appendDbReplLagInfo( $property, $includeAll ) {
458 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
459 $showHostnames = $this->getConfig()->get( 'ShowHostnames' );
461 if ( !$showHostnames ) {
462 $this->dieWithError( 'apierror-siteinfo-includealldenied', 'includeAllDenied' );
465 $lags = $lb->getLagTimes();
466 foreach ( $lags as $i => $lag ) {
468 'host' => $lb->getServerName( $i ),
473 list( , $lag, $index ) = $lb->getMaxLag();
475 'host' => $showHostnames
476 ?
$lb->getServerName( $index )
482 ApiResult
::setIndexedTagName( $data, 'db' );
484 return $this->getResult()->addValue( 'query', $property, $data );
487 protected function appendStatistics( $property ) {
489 $data['pages'] = (int)SiteStats
::pages();
490 $data['articles'] = (int)SiteStats
::articles();
491 $data['edits'] = (int)SiteStats
::edits();
492 $data['images'] = (int)SiteStats
::images();
493 $data['users'] = (int)SiteStats
::users();
494 $data['activeusers'] = (int)SiteStats
::activeUsers();
495 $data['admins'] = (int)SiteStats
::numberingroup( 'sysop' );
496 $data['jobs'] = (int)SiteStats
::jobs();
498 Hooks
::run( 'APIQuerySiteInfoStatisticsInfo', [ &$data ] );
500 return $this->getResult()->addValue( 'query', $property, $data );
503 protected function appendUserGroups( $property, $numberInGroup ) {
504 $config = $this->getConfig();
507 $result = $this->getResult();
508 $allGroups = array_values( User
::getAllGroups() );
509 foreach ( $config->get( 'GroupPermissions' ) as $group => $permissions ) {
512 'rights' => array_keys( $permissions, true ),
515 if ( $numberInGroup ) {
516 $autopromote = $config->get( 'Autopromote' );
518 if ( $group == 'user' ) {
519 $arr['number'] = SiteStats
::users();
520 // '*' and autopromote groups have no size
521 } elseif ( $group !== '*' && !isset( $autopromote[$group] ) ) {
522 $arr['number'] = SiteStats
::numberingroup( $group );
527 'add' => $config->get( 'AddGroups' ),
528 'remove' => $config->get( 'RemoveGroups' ),
529 'add-self' => $config->get( 'GroupsAddToSelf' ),
530 'remove-self' => $config->get( 'GroupsRemoveFromSelf' )
533 foreach ( $groupArr as $type => $rights ) {
534 if ( isset( $rights[$group] ) ) {
535 if ( $rights[$group] === true ) {
536 $groups = $allGroups;
538 $groups = array_intersect( $rights[$group], $allGroups );
541 $arr[$type] = $groups;
542 ApiResult
::setArrayType( $arr[$type], 'BCarray' );
543 ApiResult
::setIndexedTagName( $arr[$type], 'group' );
548 ApiResult
::setIndexedTagName( $arr['rights'], 'permission' );
552 ApiResult
::setIndexedTagName( $data, 'group' );
554 return $result->addValue( 'query', $property, $data );
557 protected function appendFileExtensions( $property ) {
559 foreach ( array_unique( $this->getConfig()->get( 'FileExtensions' ) ) as $ext ) {
560 $data[] = [ 'ext' => $ext ];
562 ApiResult
::setIndexedTagName( $data, 'fe' );
564 return $this->getResult()->addValue( 'query', $property, $data );
567 protected function appendInstalledLibraries( $property ) {
569 $path = "$IP/vendor/composer/installed.json";
570 if ( !file_exists( $path ) ) {
575 $installed = new ComposerInstalled( $path );
576 foreach ( $installed->getInstalledDependencies() as $name => $info ) {
577 if ( strpos( $info['type'], 'mediawiki-' ) === 0 ) {
578 // Skip any extensions or skins since they'll be listed
579 // in their proper section
584 'version' => $info['version'],
587 ApiResult
::setIndexedTagName( $data, 'library' );
589 return $this->getResult()->addValue( 'query', $property, $data );
592 protected function appendExtensions( $property ) {
594 foreach ( $this->getConfig()->get( 'ExtensionCredits' ) as $type => $extensions ) {
595 foreach ( $extensions as $ext ) {
597 $ret['type'] = $type;
598 if ( isset( $ext['name'] ) ) {
599 $ret['name'] = $ext['name'];
601 if ( isset( $ext['namemsg'] ) ) {
602 $ret['namemsg'] = $ext['namemsg'];
604 if ( isset( $ext['description'] ) ) {
605 $ret['description'] = $ext['description'];
607 if ( isset( $ext['descriptionmsg'] ) ) {
608 // Can be a string or [ key, param1, param2, ... ]
609 if ( is_array( $ext['descriptionmsg'] ) ) {
610 $ret['descriptionmsg'] = $ext['descriptionmsg'][0];
611 $ret['descriptionmsgparams'] = array_slice( $ext['descriptionmsg'], 1 );
612 ApiResult
::setIndexedTagName( $ret['descriptionmsgparams'], 'param' );
614 $ret['descriptionmsg'] = $ext['descriptionmsg'];
617 if ( isset( $ext['author'] ) ) {
618 $ret['author'] = is_array( $ext['author'] ) ?
619 implode( ', ', $ext['author'] ) : $ext['author'];
621 if ( isset( $ext['url'] ) ) {
622 $ret['url'] = $ext['url'];
624 if ( isset( $ext['version'] ) ) {
625 $ret['version'] = $ext['version'];
627 if ( isset( $ext['path'] ) ) {
628 $extensionPath = dirname( $ext['path'] );
629 $gitInfo = new GitInfo( $extensionPath );
630 $vcsVersion = $gitInfo->getHeadSHA1();
631 if ( $vcsVersion !== false ) {
632 $ret['vcs-system'] = 'git';
633 $ret['vcs-version'] = $vcsVersion;
634 $ret['vcs-url'] = $gitInfo->getHeadViewUrl();
635 $vcsDate = $gitInfo->getHeadCommitDate();
636 if ( $vcsDate !== false ) {
637 $ret['vcs-date'] = wfTimestamp( TS_ISO_8601
, $vcsDate );
641 if ( SpecialVersion
::getExtLicenseFileName( $extensionPath ) ) {
642 $ret['license-name'] = $ext['license-name'] ??
'';
643 $ret['license'] = SpecialPage
::getTitleFor(
645 "License/{$ext['name']}"
649 if ( SpecialVersion
::getExtAuthorsFileName( $extensionPath ) ) {
650 $ret['credits'] = SpecialPage
::getTitleFor(
652 "Credits/{$ext['name']}"
660 ApiResult
::setIndexedTagName( $data, 'ext' );
662 return $this->getResult()->addValue( 'query', $property, $data );
665 protected function appendRightsInfo( $property ) {
666 $config = $this->getConfig();
667 $rightsPage = $config->get( 'RightsPage' );
668 if ( is_string( $rightsPage ) ) {
669 $title = Title
::newFromText( $rightsPage );
670 $url = wfExpandUrl( $title, PROTO_CURRENT
);
673 $url = $config->get( 'RightsUrl' );
675 $text = $config->get( 'RightsText' );
676 if ( $title && !strlen( $text ) ) {
677 $text = $title->getPrefixedText();
681 'url' => (string)$url,
682 'text' => (string)$text,
685 return $this->getResult()->addValue( 'query', $property, $data );
688 protected function appendRestrictions( $property ) {
689 $config = $this->getConfig();
691 'types' => $config->get( 'RestrictionTypes' ),
692 'levels' => $config->get( 'RestrictionLevels' ),
693 'cascadinglevels' => $config->get( 'CascadingRestrictionLevels' ),
694 'semiprotectedlevels' => $config->get( 'SemiprotectedRestrictionLevels' ),
697 ApiResult
::setArrayType( $data['types'], 'BCarray' );
698 ApiResult
::setArrayType( $data['levels'], 'BCarray' );
699 ApiResult
::setArrayType( $data['cascadinglevels'], 'BCarray' );
700 ApiResult
::setArrayType( $data['semiprotectedlevels'], 'BCarray' );
702 ApiResult
::setIndexedTagName( $data['types'], 'type' );
703 ApiResult
::setIndexedTagName( $data['levels'], 'level' );
704 ApiResult
::setIndexedTagName( $data['cascadinglevels'], 'level' );
705 ApiResult
::setIndexedTagName( $data['semiprotectedlevels'], 'level' );
707 return $this->getResult()->addValue( 'query', $property, $data );
710 public function appendLanguages( $property ) {
711 $params = $this->extractRequestParams();
712 $langCode = $params['inlanguagecode'] ??
'';
713 $langNames = Language
::fetchLanguageNames( $langCode );
717 foreach ( $langNames as $code => $name ) {
720 'bcp47' => LanguageCode
::bcp47( $code ),
722 ApiResult
::setContentValue( $lang, 'name', $name );
725 ApiResult
::setIndexedTagName( $data, 'lang' );
727 return $this->getResult()->addValue( 'query', $property, $data );
730 // Export information about which page languages will trigger
731 // language conversion. (T153341)
732 public function appendLanguageVariants( $property ) {
733 $langNames = LanguageConverter
::$languagesWithVariants;
734 if ( $this->getConfig()->get( 'DisableLangConversion' ) ) {
735 // Ensure result is empty if language conversion is disabled.
741 foreach ( $langNames as $langCode ) {
742 $lang = Language
::factory( $langCode );
743 if ( $lang->getConverter() instanceof FakeConverter
) {
744 // Only languages which do not return instances of
745 // FakeConverter implement language conversion.
748 $data[$langCode] = [];
749 ApiResult
::setIndexedTagName( $data[$langCode], 'variant' );
750 ApiResult
::setArrayType( $data[$langCode], 'kvp', 'code' );
752 $variants = $lang->getVariants();
754 foreach ( $variants as $v ) {
755 $fallbacks = $lang->getConverter()->getVariantFallbacks( $v );
756 if ( !is_array( $fallbacks ) ) {
757 $fallbacks = [ $fallbacks ];
759 $data[$langCode][$v] = [
760 'fallbacks' => $fallbacks,
762 ApiResult
::setIndexedTagName(
763 $data[$langCode][$v]['fallbacks'], 'variant'
767 ApiResult
::setIndexedTagName( $data, 'lang' );
768 ApiResult
::setArrayType( $data, 'kvp', 'code' );
770 return $this->getResult()->addValue( 'query', $property, $data );
773 public function appendSkins( $property ) {
775 $allowed = Skin
::getAllowedSkins();
776 $default = Skin
::normalizeKey( 'default' );
777 foreach ( Skin
::getSkinNames() as $name => $displayName ) {
778 $msg = $this->msg( "skinname-{$name}" );
779 $code = $this->getParameter( 'inlanguagecode' );
780 if ( $code && Language
::isValidCode( $code ) ) {
781 $msg->inLanguage( $code );
783 $msg->inContentLanguage();
785 if ( $msg->exists() ) {
786 $displayName = $msg->text();
788 $skin = [ 'code' => $name ];
789 ApiResult
::setContentValue( $skin, 'name', $displayName );
790 if ( !isset( $allowed[$name] ) ) {
791 $skin['unusable'] = true;
793 if ( $name === $default ) {
794 $skin['default'] = true;
798 ApiResult
::setIndexedTagName( $data, 'skin' );
800 return $this->getResult()->addValue( 'query', $property, $data );
803 public function appendExtensionTags( $property ) {
808 MediaWikiServices
::getInstance()->getParser()->getTags()
810 ApiResult
::setArrayType( $tags, 'BCarray' );
811 ApiResult
::setIndexedTagName( $tags, 't' );
813 return $this->getResult()->addValue( 'query', $property, $tags );
816 public function appendFunctionHooks( $property ) {
817 $hooks = MediaWikiServices
::getInstance()->getParser()->getFunctionHooks();
818 ApiResult
::setArrayType( $hooks, 'BCarray' );
819 ApiResult
::setIndexedTagName( $hooks, 'h' );
821 return $this->getResult()->addValue( 'query', $property, $hooks );
824 public function appendVariables( $property ) {
825 $variables = MediaWikiServices
::getInstance()->getMagicWordFactory()->getVariableIDs();
826 ApiResult
::setArrayType( $variables, 'BCarray' );
827 ApiResult
::setIndexedTagName( $variables, 'v' );
829 return $this->getResult()->addValue( 'query', $property, $variables );
832 public function appendProtocols( $property ) {
833 // Make a copy of the global so we don't try to set the _element key of it - T47130
834 $protocols = array_values( $this->getConfig()->get( 'UrlProtocols' ) );
835 ApiResult
::setArrayType( $protocols, 'BCarray' );
836 ApiResult
::setIndexedTagName( $protocols, 'p' );
838 return $this->getResult()->addValue( 'query', $property, $protocols );
841 public function appendDefaultOptions( $property ) {
842 $options = User
::getDefaultOptions();
843 $options[ApiResult
::META_BC_BOOLS
] = array_keys( $options );
844 return $this->getResult()->addValue( 'query', $property, $options );
847 public function appendUploadDialog( $property ) {
848 $config = $this->getConfig()->get( 'UploadDialog' );
849 return $this->getResult()->addValue( 'query', $property, $config );
852 public function appendSubscribedHooks( $property ) {
853 $hooks = $this->getConfig()->get( 'Hooks' );
858 foreach ( $myWgHooks as $name => $subscribers ) {
861 'subscribers' => array_map( [ SpecialVersion
::class, 'arrayToString' ], $subscribers ),
864 ApiResult
::setArrayType( $arr['subscribers'], 'array' );
865 ApiResult
::setIndexedTagName( $arr['subscribers'], 's' );
869 ApiResult
::setIndexedTagName( $data, 'hook' );
871 return $this->getResult()->addValue( 'query', $property, $data );
874 public function getCacheMode( $params ) {
875 // Messages for $wgExtraInterlanguageLinkPrefixes depend on user language
877 count( $this->getConfig()->get( 'ExtraInterlanguageLinkPrefixes' ) ) &&
878 !is_null( $params['prop'] ) &&
879 in_array( 'interwikimap', $params['prop'] )
881 return 'anon-public-user-private';
887 public function getAllowedParams() {
890 ApiBase
::PARAM_DFLT
=> 'general',
891 ApiBase
::PARAM_ISMULTI
=> true,
892 ApiBase
::PARAM_TYPE
=> [
896 'specialpagealiases',
918 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [],
921 ApiBase
::PARAM_TYPE
=> [
926 'showalldb' => false,
927 'numberingroup' => false,
928 'inlanguagecode' => null,
932 protected function getExamplesMessages() {
934 'action=query&meta=siteinfo&siprop=general|namespaces|namespacealiases|statistics'
935 => 'apihelp-query+siteinfo-example-simple',
936 'action=query&meta=siteinfo&siprop=interwikimap&sifilteriw=local'
937 => 'apihelp-query+siteinfo-example-interwiki',
938 'action=query&meta=siteinfo&siprop=dbrepllag&sishowalldb='
939 => 'apihelp-query+siteinfo-example-replag',
943 public function getHelpUrls() {
944 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Siteinfo';