MediaWiki REL1_33
ApiQuerySiteinfo.php
Go to the documentation of this file.
1<?php
23
30
31 public function __construct( ApiQuery $query, $moduleName ) {
32 parent::__construct( $query, $moduleName, 'si' );
33 }
34
35 public function execute() {
37 $done = [];
38 $fit = false;
39 foreach ( $params['prop'] as $p ) {
40 switch ( $p ) {
41 case 'general':
42 $fit = $this->appendGeneralInfo( $p );
43 break;
44 case 'namespaces':
45 $fit = $this->appendNamespaces( $p );
46 break;
47 case 'namespacealiases':
48 $fit = $this->appendNamespaceAliases( $p );
49 break;
50 case 'specialpagealiases':
51 $fit = $this->appendSpecialPageAliases( $p );
52 break;
53 case 'magicwords':
54 $fit = $this->appendMagicWords( $p );
55 break;
56 case 'interwikimap':
57 $fit = $this->appendInterwikiMap( $p, $params['filteriw'] );
58 break;
59 case 'dbrepllag':
60 $fit = $this->appendDbReplLagInfo( $p, $params['showalldb'] );
61 break;
62 case 'statistics':
63 $fit = $this->appendStatistics( $p );
64 break;
65 case 'usergroups':
66 $fit = $this->appendUserGroups( $p, $params['numberingroup'] );
67 break;
68 case 'libraries':
69 $fit = $this->appendInstalledLibraries( $p );
70 break;
71 case 'extensions':
72 $fit = $this->appendExtensions( $p );
73 break;
74 case 'fileextensions':
75 $fit = $this->appendFileExtensions( $p );
76 break;
77 case 'rightsinfo':
78 $fit = $this->appendRightsInfo( $p );
79 break;
80 case 'restrictions':
81 $fit = $this->appendRestrictions( $p );
82 break;
83 case 'languages':
84 $fit = $this->appendLanguages( $p );
85 break;
86 case 'languagevariants':
87 $fit = $this->appendLanguageVariants( $p );
88 break;
89 case 'skins':
90 $fit = $this->appendSkins( $p );
91 break;
92 case 'extensiontags':
93 $fit = $this->appendExtensionTags( $p );
94 break;
95 case 'functionhooks':
96 $fit = $this->appendFunctionHooks( $p );
97 break;
98 case 'showhooks':
99 $fit = $this->appendSubscribedHooks( $p );
100 break;
101 case 'variables':
102 $fit = $this->appendVariables( $p );
103 break;
104 case 'protocols':
105 $fit = $this->appendProtocols( $p );
106 break;
107 case 'defaultoptions':
108 $fit = $this->appendDefaultOptions( $p );
109 break;
110 case 'uploaddialog':
111 $fit = $this->appendUploadDialog( $p );
112 break;
113 default:
114 ApiBase::dieDebug( __METHOD__, "Unknown prop=$p" ); // @codeCoverageIgnore
115 }
116 if ( !$fit ) {
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 ) ) );
121 break;
122 }
123 $done[] = $p;
124 }
125 }
126
127 protected function appendGeneralInfo( $property ) {
128 $config = $this->getConfig();
129
130 $data = [];
131 $mainPage = Title::newMainPage();
132 $data['mainpage'] = $mainPage->getPrefixedText();
133 $data['base'] = wfExpandUrl( $mainPage->getFullURL(), PROTO_CURRENT );
134 $data['sitename'] = $config->get( 'Sitename' );
135
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 );
139
140 $data['generator'] = "MediaWiki {$config->get( 'Version' )}";
141
142 $data['phpversion'] = PHP_VERSION;
143 $data['phpsapi'] = PHP_SAPI;
144 if ( defined( 'HHVM_VERSION' ) ) {
145 $data['hhvmversion'] = HHVM_VERSION; // @codeCoverageIgnore
146 }
147 $data['dbtype'] = $config->get( 'DBtype' );
148 $data['dbversion'] = $this->getDB()->getServerVersion();
149
150 $allowFrom = [ '' ];
151 $allowException = true;
152 if ( !$config->get( 'AllowExternalImages' ) ) {
153 $data['imagewhitelistenabled'] = (bool)$config->get( 'EnableImageWhitelist' );
154 $allowFrom = $config->get( 'AllowExternalImagesFrom' );
155 $allowException = !empty( $allowFrom );
156 }
157 if ( $allowException ) {
158 $data['externalimages'] = (array)$allowFrom;
159 ApiResult::setIndexedTagName( $data['externalimages'], 'prefix' );
160 }
161
162 $data['langconversion'] = !$config->get( 'DisableLangConversion' );
163 $data['titleconversion'] = !$config->get( 'DisableTitleConversion' );
164
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";
171 } else {
172 $data['linkprefixcharset'] = '';
173 $data['linkprefix'] = '';
174 }
175
176 $linktrail = $contLang->linkTrail();
177 $data['linktrail'] = $linktrail ?: '';
178
179 $data['legaltitlechars'] = Title::legalChars();
180 $data['invalidusernamechars'] = $config->get( 'InvalidUsernameCharacters' );
181
182 $data['allunicodefixes'] = (bool)$config->get( 'AllUnicodeFixes' );
183 $data['fixarabicunicode'] = (bool)$config->get( 'FixArabicUnicode' );
184 $data['fixmalayalamunicode'] = (bool)$config->get( 'FixMalayalamUnicode' );
185
186 global $IP;
188 if ( $git ) {
189 $data['git-hash'] = $git;
190 $data['git-branch'] =
192 }
193
194 // 'case-insensitive' option is reserved for future
195 $data['case'] = $config->get( 'CapitalLinks' ) ? 'first-letter' : 'case-sensitive';
196 $data['lang'] = $config->get( 'LanguageCode' );
197
198 $fallbacks = [];
199 foreach ( $contLang->getFallbackLanguages() as $code ) {
200 $fallbacks[] = [ 'code' => $code ];
201 }
202 $data['fallback'] = $fallbacks;
203 ApiResult::setIndexedTagName( $data['fallback'], 'lang' );
204
205 if ( $contLang->hasVariants() ) {
206 $variants = [];
207 foreach ( $contLang->getVariants() as $code ) {
208 $variants[] = [
209 'code' => $code,
210 'name' => $contLang->getVariantname( $code ),
211 ];
212 }
213 $data['variants'] = $variants;
214 ApiResult::setIndexedTagName( $data['variants'], 'lang' );
215 }
216
217 $data['rtl'] = $contLang->isRTL();
218 $data['fallback8bitEncoding'] = $contLang->fallback8bitEncoding();
219
220 $data['readonly'] = wfReadOnly();
221 if ( $data['readonly'] ) {
222 $data['readonlyreason'] = wfReadOnlyReason();
223 }
224 $data['writeapi'] = true; // Deprecated since MW 1.32
225
226 $data['maxarticlesize'] = $config->get( 'MaxArticleSize' ) * 1024;
227
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() );
241
242 $data['misermode'] = (bool)$config->get( 'MiserMode' );
243
244 $data['uploadsenabled'] = UploadBase::isEnabled();
245 $data['maxuploadsize'] = UploadBase::getMaxUploadSize();
246 $data['minuploadchunksize'] = (int)$config->get( 'MinUploadChunkSize' );
247
248 $data['galleryoptions'] = $config->get( 'GalleryOptions' );
249
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] ];
258 }
259
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 );
265 }
266
267 $data['centralidlookupprovider'] = $config->get( 'CentralIdLookupProvider' );
268 $providerIds = array_keys( $config->get( 'CentralIdLookupProviders' ) );
269 $data['allcentralidlookupproviders'] = $providerIds;
270
271 $data['interwikimagic'] = (bool)$config->get( 'InterwikiMagic' );
272 $data['magiclinks'] = $config->get( 'EnableMagicLinks' );
273
274 $data['categorycollation'] = $config->get( 'CategoryCollation' );
275
276 Hooks::run( 'APIQuerySiteInfoGeneralInfo', [ $this, &$data ] );
277
278 return $this->getResult()->addValue( 'query', $property, $data );
279 }
280
281 protected function appendNamespaces( $property ) {
282 $data = [
283 ApiResult::META_TYPE => 'assoc',
284 ];
285 foreach (
286 MediaWikiServices::getInstance()->getContentLanguage()->getFormattedNamespaces()
287 as $ns => $title
288 ) {
289 $data[$ns] = [
290 'id' => (int)$ns,
291 'case' => MWNamespace::isCapitalized( $ns ) ? 'first-letter' : 'case-sensitive',
292 ];
293 ApiResult::setContentValue( $data[$ns], 'name', $title );
294 $canonical = MWNamespace::getCanonicalName( $ns );
295
296 $data[$ns]['subpages'] = MWNamespace::hasSubpages( $ns );
297
298 if ( $canonical ) {
299 $data[$ns]['canonical'] = strtr( $canonical, '_', ' ' );
300 }
301
302 $data[$ns]['content'] = MWNamespace::isContent( $ns );
303 $data[$ns]['nonincludable'] = MWNamespace::isNonincludable( $ns );
304
305 $contentmodel = MWNamespace::getNamespaceContentModel( $ns );
306 if ( $contentmodel ) {
307 $data[$ns]['defaultcontentmodel'] = $contentmodel;
308 }
309 }
310
311 ApiResult::setArrayType( $data, 'assoc' );
313
314 return $this->getResult()->addValue( 'query', $property, $data );
315 }
316
317 protected function appendNamespaceAliases( $property ) {
318 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
319 $aliases = array_merge( $this->getConfig()->get( 'NamespaceAliases' ),
320 $contLang->getNamespaceAliases() );
321 $namespaces = $contLang->getNamespaces();
322 $data = [];
323 foreach ( $aliases as $title => $ns ) {
324 if ( $namespaces[$ns] == $title ) {
325 // Don't list duplicates
326 continue;
327 }
328 $item = [
329 'id' => (int)$ns
330 ];
331 ApiResult::setContentValue( $item, 'alias', strtr( $title, '_', ' ' ) );
332 $data[] = $item;
333 }
334
335 sort( $data );
336
338
339 return $this->getResult()->addValue( 'query', $property, $data );
340 }
341
342 protected function appendSpecialPageAliases( $property ) {
343 $data = [];
344 $services = MediaWikiServices::getInstance();
345 $aliases = $services->getContentLanguage()->getSpecialPageAliases();
346 foreach ( $services->getSpecialPageFactory()->getNames() as $specialpage ) {
347 if ( isset( $aliases[$specialpage] ) ) {
348 $arr = [ 'realname' => $specialpage, 'aliases' => $aliases[$specialpage] ];
349 ApiResult::setIndexedTagName( $arr['aliases'], 'alias' );
350 $data[] = $arr;
351 }
352 }
353 ApiResult::setIndexedTagName( $data, 'specialpage' );
354
355 return $this->getResult()->addValue( 'query', $property, $data );
356 }
357
358 protected function appendMagicWords( $property ) {
359 $data = [];
360 foreach (
361 MediaWikiServices::getInstance()->getContentLanguage()->getMagicWords()
362 as $magicword => $aliases
363 ) {
364 $caseSensitive = array_shift( $aliases );
365 $arr = [ 'name' => $magicword, 'aliases' => $aliases ];
366 $arr['case-sensitive'] = (bool)$caseSensitive;
367 ApiResult::setIndexedTagName( $arr['aliases'], 'alias' );
368 $data[] = $arr;
369 }
370 ApiResult::setIndexedTagName( $data, 'magicword' );
371
372 return $this->getResult()->addValue( 'query', $property, $data );
373 }
374
375 protected function appendInterwikiMap( $property, $filter ) {
376 if ( $filter === 'local' ) {
377 $local = 1;
378 } elseif ( $filter === '!local' ) {
379 $local = 0;
380 } else {
381 // $filter === null
382 $local = null;
383 }
384
385 $params = $this->extractRequestParams();
386 $langCode = $params['inlanguagecode'] ?? '';
387 $langNames = Language::fetchLanguageNames( $langCode );
388
389 $getPrefixes = MediaWikiServices::getInstance()->getInterwikiLookup()->getAllPrefixes( $local );
390 $extraLangPrefixes = $this->getConfig()->get( 'ExtraInterlanguageLinkPrefixes' );
391 $localInterwikis = $this->getConfig()->get( 'LocalInterwikis' );
392 $data = [];
393
394 foreach ( $getPrefixes as $row ) {
395 $prefix = $row['iw_prefix'];
396 $val = [];
397 $val['prefix'] = $prefix;
398 if ( isset( $row['iw_local'] ) && $row['iw_local'] == '1' ) {
399 $val['local'] = true;
400 }
401 if ( isset( $row['iw_trans'] ) && $row['iw_trans'] == '1' ) {
402 $val['trans'] = true;
403 }
404
405 if ( isset( $langNames[$prefix] ) ) {
406 $val['language'] = $langNames[$prefix];
407 }
408 if ( in_array( $prefix, $localInterwikis ) ) {
409 $val['localinterwiki'] = true;
410 }
411 if ( in_array( $prefix, $extraLangPrefixes ) ) {
412 $val['extralanglink'] = true;
413
414 $linktext = wfMessage( "interlanguage-link-$prefix" );
415 if ( !$linktext->isDisabled() ) {
416 $val['linktext'] = $linktext->text();
417 }
418
419 $sitename = wfMessage( "interlanguage-link-sitename-$prefix" );
420 if ( !$sitename->isDisabled() ) {
421 $val['sitename'] = $sitename->text();
422 }
423 }
424
425 $val['url'] = wfExpandUrl( $row['iw_url'], PROTO_CURRENT );
426 $val['protorel'] = substr( $row['iw_url'], 0, 2 ) == '//';
427 if ( isset( $row['iw_wikiid'] ) && $row['iw_wikiid'] !== '' ) {
428 $val['wikiid'] = $row['iw_wikiid'];
429 }
430 if ( isset( $row['iw_api'] ) && $row['iw_api'] !== '' ) {
431 $val['api'] = $row['iw_api'];
432 }
433
434 $data[] = $val;
435 }
436
438
439 return $this->getResult()->addValue( 'query', $property, $data );
440 }
441
442 protected function appendDbReplLagInfo( $property, $includeAll ) {
443 $data = [];
444 $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
445 $showHostnames = $this->getConfig()->get( 'ShowHostnames' );
446 if ( $includeAll ) {
447 if ( !$showHostnames ) {
448 $this->dieWithError( 'apierror-siteinfo-includealldenied', 'includeAllDenied' );
449 }
450
451 $lags = $lb->getLagTimes();
452 foreach ( $lags as $i => $lag ) {
453 $data[] = [
454 'host' => $lb->getServerName( $i ),
455 'lag' => $lag
456 ];
457 }
458 } else {
459 list( , $lag, $index ) = $lb->getMaxLag();
460 $data[] = [
461 'host' => $showHostnames
462 ? $lb->getServerName( $index )
463 : '',
464 'lag' => $lag
465 ];
466 }
467
469
470 return $this->getResult()->addValue( 'query', $property, $data );
471 }
472
473 protected function appendStatistics( $property ) {
474 $data = [];
475 $data['pages'] = (int)SiteStats::pages();
476 $data['articles'] = (int)SiteStats::articles();
477 $data['edits'] = (int)SiteStats::edits();
478 $data['images'] = (int)SiteStats::images();
479 $data['users'] = (int)SiteStats::users();
480 $data['activeusers'] = (int)SiteStats::activeUsers();
481 $data['admins'] = (int)SiteStats::numberingroup( 'sysop' );
482 $data['jobs'] = (int)SiteStats::jobs();
483
484 Hooks::run( 'APIQuerySiteInfoStatisticsInfo', [ &$data ] );
485
486 return $this->getResult()->addValue( 'query', $property, $data );
487 }
488
489 protected function appendUserGroups( $property, $numberInGroup ) {
490 $config = $this->getConfig();
491
492 $data = [];
493 $result = $this->getResult();
494 $allGroups = array_values( User::getAllGroups() );
495 foreach ( $config->get( 'GroupPermissions' ) as $group => $permissions ) {
496 $arr = [
497 'name' => $group,
498 'rights' => array_keys( $permissions, true ),
499 ];
500
501 if ( $numberInGroup ) {
502 $autopromote = $config->get( 'Autopromote' );
503
504 if ( $group == 'user' ) {
505 $arr['number'] = SiteStats::users();
506 // '*' and autopromote groups have no size
507 } elseif ( $group !== '*' && !isset( $autopromote[$group] ) ) {
508 $arr['number'] = SiteStats::numberingroup( $group );
509 }
510 }
511
512 $groupArr = [
513 'add' => $config->get( 'AddGroups' ),
514 'remove' => $config->get( 'RemoveGroups' ),
515 'add-self' => $config->get( 'GroupsAddToSelf' ),
516 'remove-self' => $config->get( 'GroupsRemoveFromSelf' )
517 ];
518
519 foreach ( $groupArr as $type => $rights ) {
520 if ( isset( $rights[$group] ) ) {
521 if ( $rights[$group] === true ) {
522 $groups = $allGroups;
523 } else {
524 $groups = array_intersect( $rights[$group], $allGroups );
525 }
526 if ( $groups ) {
527 $arr[$type] = $groups;
528 ApiResult::setArrayType( $arr[$type], 'BCarray' );
529 ApiResult::setIndexedTagName( $arr[$type], 'group' );
530 }
531 }
532 }
533
534 ApiResult::setIndexedTagName( $arr['rights'], 'permission' );
535 $data[] = $arr;
536 }
537
539
540 return $result->addValue( 'query', $property, $data );
541 }
542
543 protected function appendFileExtensions( $property ) {
544 $data = [];
545 foreach ( array_unique( $this->getConfig()->get( 'FileExtensions' ) ) as $ext ) {
546 $data[] = [ 'ext' => $ext ];
547 }
549
550 return $this->getResult()->addValue( 'query', $property, $data );
551 }
552
553 protected function appendInstalledLibraries( $property ) {
554 global $IP;
555 $path = "$IP/vendor/composer/installed.json";
556 if ( !file_exists( $path ) ) {
557 return true;
558 }
559
560 $data = [];
561 $installed = new ComposerInstalled( $path );
562 foreach ( $installed->getInstalledDependencies() as $name => $info ) {
563 if ( strpos( $info['type'], 'mediawiki-' ) === 0 ) {
564 // Skip any extensions or skins since they'll be listed
565 // in their proper section
566 continue;
567 }
568 $data[] = [
569 'name' => $name,
570 'version' => $info['version'],
571 ];
572 }
574
575 return $this->getResult()->addValue( 'query', $property, $data );
576 }
577
578 protected function appendExtensions( $property ) {
579 $data = [];
580 foreach ( $this->getConfig()->get( 'ExtensionCredits' ) as $type => $extensions ) {
581 foreach ( $extensions as $ext ) {
582 $ret = [];
583 $ret['type'] = $type;
584 if ( isset( $ext['name'] ) ) {
585 $ret['name'] = $ext['name'];
586 }
587 if ( isset( $ext['namemsg'] ) ) {
588 $ret['namemsg'] = $ext['namemsg'];
589 }
590 if ( isset( $ext['description'] ) ) {
591 $ret['description'] = $ext['description'];
592 }
593 if ( isset( $ext['descriptionmsg'] ) ) {
594 // Can be a string or [ key, param1, param2, ... ]
595 if ( is_array( $ext['descriptionmsg'] ) ) {
596 $ret['descriptionmsg'] = $ext['descriptionmsg'][0];
597 $ret['descriptionmsgparams'] = array_slice( $ext['descriptionmsg'], 1 );
598 ApiResult::setIndexedTagName( $ret['descriptionmsgparams'], 'param' );
599 } else {
600 $ret['descriptionmsg'] = $ext['descriptionmsg'];
601 }
602 }
603 if ( isset( $ext['author'] ) ) {
604 $ret['author'] = is_array( $ext['author'] ) ?
605 implode( ', ', $ext['author'] ) : $ext['author'];
606 }
607 if ( isset( $ext['url'] ) ) {
608 $ret['url'] = $ext['url'];
609 }
610 if ( isset( $ext['version'] ) ) {
611 $ret['version'] = $ext['version'];
612 }
613 if ( isset( $ext['path'] ) ) {
614 $extensionPath = dirname( $ext['path'] );
615 $gitInfo = new GitInfo( $extensionPath );
616 $vcsVersion = $gitInfo->getHeadSHA1();
617 if ( $vcsVersion !== false ) {
618 $ret['vcs-system'] = 'git';
619 $ret['vcs-version'] = $vcsVersion;
620 $ret['vcs-url'] = $gitInfo->getHeadViewUrl();
621 $vcsDate = $gitInfo->getHeadCommitDate();
622 if ( $vcsDate !== false ) {
623 $ret['vcs-date'] = wfTimestamp( TS_ISO_8601, $vcsDate );
624 }
625 }
626
627 if ( SpecialVersion::getExtLicenseFileName( $extensionPath ) ) {
628 $ret['license-name'] = $ext['license-name'] ?? '';
629 $ret['license'] = SpecialPage::getTitleFor(
630 'Version',
631 "License/{$ext['name']}"
632 )->getLinkURL();
633 }
634
635 if ( SpecialVersion::getExtAuthorsFileName( $extensionPath ) ) {
636 $ret['credits'] = SpecialPage::getTitleFor(
637 'Version',
638 "Credits/{$ext['name']}"
639 )->getLinkURL();
640 }
641 }
642 $data[] = $ret;
643 }
644 }
645
647
648 return $this->getResult()->addValue( 'query', $property, $data );
649 }
650
651 protected function appendRightsInfo( $property ) {
652 $config = $this->getConfig();
653 $rightsPage = $config->get( 'RightsPage' );
654 if ( is_string( $rightsPage ) ) {
655 $title = Title::newFromText( $rightsPage );
657 } else {
658 $title = false;
659 $url = $config->get( 'RightsUrl' );
660 }
661 $text = $config->get( 'RightsText' );
662 if ( $title && !strlen( $text ) ) {
663 $text = $title->getPrefixedText();
664 }
665
666 $data = [
667 'url' => (string)$url,
668 'text' => (string)$text,
669 ];
670
671 return $this->getResult()->addValue( 'query', $property, $data );
672 }
673
674 protected function appendRestrictions( $property ) {
675 $config = $this->getConfig();
676 $data = [
677 'types' => $config->get( 'RestrictionTypes' ),
678 'levels' => $config->get( 'RestrictionLevels' ),
679 'cascadinglevels' => $config->get( 'CascadingRestrictionLevels' ),
680 'semiprotectedlevels' => $config->get( 'SemiprotectedRestrictionLevels' ),
681 ];
682
683 ApiResult::setArrayType( $data['types'], 'BCarray' );
684 ApiResult::setArrayType( $data['levels'], 'BCarray' );
685 ApiResult::setArrayType( $data['cascadinglevels'], 'BCarray' );
686 ApiResult::setArrayType( $data['semiprotectedlevels'], 'BCarray' );
687
688 ApiResult::setIndexedTagName( $data['types'], 'type' );
689 ApiResult::setIndexedTagName( $data['levels'], 'level' );
690 ApiResult::setIndexedTagName( $data['cascadinglevels'], 'level' );
691 ApiResult::setIndexedTagName( $data['semiprotectedlevels'], 'level' );
692
693 return $this->getResult()->addValue( 'query', $property, $data );
694 }
695
696 public function appendLanguages( $property ) {
697 $params = $this->extractRequestParams();
698 $langCode = $params['inlanguagecode'] ?? '';
699 $langNames = Language::fetchLanguageNames( $langCode );
700
701 $data = [];
702
703 foreach ( $langNames as $code => $name ) {
704 $lang = [
705 'code' => $code,
706 'bcp47' => LanguageCode::bcp47( $code ),
707 ];
709 $data[] = $lang;
710 }
712
713 return $this->getResult()->addValue( 'query', $property, $data );
714 }
715
716 // Export information about which page languages will trigger
717 // language conversion. (T153341)
719 $langNames = LanguageConverter::$languagesWithVariants;
720 if ( $this->getConfig()->get( 'DisableLangConversion' ) ) {
721 // Ensure result is empty if language conversion is disabled.
722 $langNames = [];
723 }
724 sort( $langNames );
725
726 $data = [];
727 foreach ( $langNames as $langCode ) {
728 $lang = Language::factory( $langCode );
729 if ( $lang->getConverter() instanceof FakeConverter ) {
730 // Only languages which do not return instances of
731 // FakeConverter implement language conversion.
732 continue;
733 }
734 $data[$langCode] = [];
735 ApiResult::setIndexedTagName( $data[$langCode], 'variant' );
736 ApiResult::setArrayType( $data[$langCode], 'kvp', 'code' );
737
738 $variants = $lang->getVariants();
739 sort( $variants );
740 foreach ( $variants as $v ) {
741 $fallbacks = $lang->getConverter()->getVariantFallbacks( $v );
742 if ( !is_array( $fallbacks ) ) {
743 $fallbacks = [ $fallbacks ];
744 }
745 $data[$langCode][$v] = [
746 'fallbacks' => $fallbacks,
747 ];
749 $data[$langCode][$v]['fallbacks'], 'variant'
750 );
751 }
752 }
754 ApiResult::setArrayType( $data, 'kvp', 'code' );
755
756 return $this->getResult()->addValue( 'query', $property, $data );
757 }
758
759 public function appendSkins( $property ) {
760 $data = [];
761 $allowed = Skin::getAllowedSkins();
762 $default = Skin::normalizeKey( 'default' );
763 foreach ( Skin::getSkinNames() as $name => $displayName ) {
764 $msg = $this->msg( "skinname-{$name}" );
765 $code = $this->getParameter( 'inlanguagecode' );
766 if ( $code && Language::isValidCode( $code ) ) {
767 $msg->inLanguage( $code );
768 } else {
769 $msg->inContentLanguage();
770 }
771 if ( $msg->exists() ) {
772 $displayName = $msg->text();
773 }
774 $skin = [ 'code' => $name ];
775 ApiResult::setContentValue( $skin, 'name', $displayName );
776 if ( !isset( $allowed[$name] ) ) {
777 $skin['unusable'] = true;
778 }
779 if ( $name === $default ) {
780 $skin['default'] = true;
781 }
782 $data[] = $skin;
783 }
785
786 return $this->getResult()->addValue( 'query', $property, $data );
787 }
788
789 public function appendExtensionTags( $property ) {
790 global $wgParser;
791 $tags = array_map(
792 function ( $item ) {
793 return "<$item>";
794 },
795 $wgParser->getTags()
796 );
797 ApiResult::setArrayType( $tags, 'BCarray' );
798 ApiResult::setIndexedTagName( $tags, 't' );
799
800 return $this->getResult()->addValue( 'query', $property, $tags );
801 }
802
803 public function appendFunctionHooks( $property ) {
804 global $wgParser;
805 $hooks = $wgParser->getFunctionHooks();
806 ApiResult::setArrayType( $hooks, 'BCarray' );
807 ApiResult::setIndexedTagName( $hooks, 'h' );
808
809 return $this->getResult()->addValue( 'query', $property, $hooks );
810 }
811
812 public function appendVariables( $property ) {
813 $variables = MediaWikiServices::getInstance()->getMagicWordFactory()->getVariableIDs();
814 ApiResult::setArrayType( $variables, 'BCarray' );
815 ApiResult::setIndexedTagName( $variables, 'v' );
816
817 return $this->getResult()->addValue( 'query', $property, $variables );
818 }
819
820 public function appendProtocols( $property ) {
821 // Make a copy of the global so we don't try to set the _element key of it - T47130
822 $protocols = array_values( $this->getConfig()->get( 'UrlProtocols' ) );
823 ApiResult::setArrayType( $protocols, 'BCarray' );
824 ApiResult::setIndexedTagName( $protocols, 'p' );
825
826 return $this->getResult()->addValue( 'query', $property, $protocols );
827 }
828
829 public function appendDefaultOptions( $property ) {
832 return $this->getResult()->addValue( 'query', $property, $options );
833 }
834
835 public function appendUploadDialog( $property ) {
836 $config = $this->getConfig()->get( 'UploadDialog' );
837 return $this->getResult()->addValue( 'query', $property, $config );
838 }
839
840 public function appendSubscribedHooks( $property ) {
841 $hooks = $this->getConfig()->get( 'Hooks' );
842 $myWgHooks = $hooks;
843 ksort( $myWgHooks );
844
845 $data = [];
846 foreach ( $myWgHooks as $name => $subscribers ) {
847 $arr = [
848 'name' => $name,
849 'subscribers' => array_map( [ SpecialVersion::class, 'arrayToString' ], $subscribers ),
850 ];
851
852 ApiResult::setArrayType( $arr['subscribers'], 'array' );
853 ApiResult::setIndexedTagName( $arr['subscribers'], 's' );
854 $data[] = $arr;
855 }
856
858
859 return $this->getResult()->addValue( 'query', $property, $data );
860 }
861
862 public function getCacheMode( $params ) {
863 // Messages for $wgExtraInterlanguageLinkPrefixes depend on user language
864 if (
865 count( $this->getConfig()->get( 'ExtraInterlanguageLinkPrefixes' ) ) &&
866 !is_null( $params['prop'] ) &&
867 in_array( 'interwikimap', $params['prop'] )
868 ) {
869 return 'anon-public-user-private';
870 }
871
872 return 'public';
873 }
874
875 public function getAllowedParams() {
876 return [
877 'prop' => [
878 ApiBase::PARAM_DFLT => 'general',
881 'general',
882 'namespaces',
883 'namespacealiases',
884 'specialpagealiases',
885 'magicwords',
886 'interwikimap',
887 'dbrepllag',
888 'statistics',
889 'usergroups',
890 'libraries',
891 'extensions',
892 'fileextensions',
893 'rightsinfo',
894 'restrictions',
895 'languages',
896 'languagevariants',
897 'skins',
898 'extensiontags',
899 'functionhooks',
900 'showhooks',
901 'variables',
902 'protocols',
903 'defaultoptions',
904 'uploaddialog',
905 ],
907 ],
908 'filteriw' => [
910 'local',
911 '!local',
912 ]
913 ],
914 'showalldb' => false,
915 'numberingroup' => false,
916 'inlanguagecode' => null,
917 ];
918 }
919
920 protected function getExamplesMessages() {
921 return [
922 'action=query&meta=siteinfo&siprop=general|namespaces|namespacealiases|statistics'
923 => 'apihelp-query+siteinfo-example-simple',
924 'action=query&meta=siteinfo&siprop=interwikimap&sifilteriw=local'
925 => 'apihelp-query+siteinfo-example-interwiki',
926 'action=query&meta=siteinfo&siprop=dbrepllag&sishowalldb='
927 => 'apihelp-query+siteinfo-example-replag',
928 ];
929 }
930
931 public function getHelpUrls() {
932 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Siteinfo';
933 }
934}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$GLOBALS['IP']
wfReadOnly()
Check whether the wiki is in read-only mode.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfReadOnlyReason()
Check if the site is in read-only mode and return the message if so.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$linkPrefixCharset
$wgParser
Definition Setup.php:886
$IP
Definition WebStart.php:41
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
Definition ApiBase.php:858
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:1990
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition ApiBase.php:2188
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:87
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:48
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition ApiBase.php:157
getResult()
Get the result object.
Definition ApiBase.php:632
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:743
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:51
This is a base class for all Query modules.
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
getDB()
Get the Query database connection (read-only)
A query action to return meta information about the wiki site.
appendLanguageVariants( $property)
appendLanguages( $property)
appendInterwikiMap( $property, $filter)
appendGeneralInfo( $property)
__construct(ApiQuery $query, $moduleName)
appendRightsInfo( $property)
getExamplesMessages()
Returns usage examples for this module.
appendInstalledLibraries( $property)
appendVariables( $property)
appendUserGroups( $property, $numberInGroup)
appendFileExtensions( $property)
appendNamespaces( $property)
appendDefaultOptions( $property)
appendMagicWords( $property)
getHelpUrls()
Return links to more detailed help pages about the module.
appendExtensions( $property)
getCacheMode( $params)
Get the cache mode for the data generated by this module.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
appendRestrictions( $property)
appendExtensionTags( $property)
appendUploadDialog( $property)
appendProtocols( $property)
appendStatistics( $property)
appendSpecialPageAliases( $property)
appendDbReplLagInfo( $property, $includeAll)
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
appendSubscribedHooks( $property)
appendFunctionHooks( $property)
appendNamespaceAliases( $property)
This is the main query class.
Definition ApiQuery.php:36
const META_TYPE
Key for the 'type' metadata item.
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
const META_BC_BOOLS
Key for the 'BC bools' metadata item.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
Reads an installed.json file and provides accessors to get what is installed.
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
A fake language variant converter.
MediaWikiServices is the service locator for the application scope of MediaWiki.
static articles()
static jobs()
Total number of jobs in the job queue.
static images()
static edits()
Definition SiteStats.php:94
static users()
static pages()
static numberingroup( $group)
Find the number of users in a given user group.
static activeUsers()
static getGitHeadSha1( $dir)
static getExtLicenseFileName( $extDir)
Obtains the full path of an extensions copying or license file if one exists.
static getExtAuthorsFileName( $extDir)
Obtains the full path of an extensions authors or credits file if one exists.
static getGitCurrentBranch( $dir)
static isEnabled()
Returns true if uploads are enabled.
static getMaxUploadSize( $forType=null)
Get the MediaWiki maximum uploaded file size for given type of upload, based on $wgMaxUploadSize.
static getAllGroups()
Return the set of defined explicit groups.
Definition User.php:5131
static getDefaultOptions()
Combine the language default options with any site-specific options and add the default language vari...
Definition User.php:1776
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
const PROTO_CURRENT
Definition Defines.php:231
const PROTO_RELATIVE
Definition Defines.php:230
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:1991
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition hooks.txt:181
namespace and then decline to actually register it & $namespaces
Definition hooks.txt:925
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:955
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition hooks.txt:856
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition hooks.txt:2290
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition hooks.txt:2003
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:271
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned $skin
Definition hooks.txt:2009
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition hooks.txt:1617
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
$filter
if(!is_readable( $file)) $ext
Definition router.php:48
$property
$params
if(!isset( $args[0])) $lang