MediaWiki REL1_31
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 $filteriw = isset( $params['filteriw'] ) ? $params['filteriw'] : false;
58 $fit = $this->appendInterwikiMap( $p, $filteriw );
59 break;
60 case 'dbrepllag':
61 $fit = $this->appendDbReplLagInfo( $p, $params['showalldb'] );
62 break;
63 case 'statistics':
64 $fit = $this->appendStatistics( $p );
65 break;
66 case 'usergroups':
67 $fit = $this->appendUserGroups( $p, $params['numberingroup'] );
68 break;
69 case 'libraries':
70 $fit = $this->appendInstalledLibraries( $p );
71 break;
72 case 'extensions':
73 $fit = $this->appendExtensions( $p );
74 break;
75 case 'fileextensions':
76 $fit = $this->appendFileExtensions( $p );
77 break;
78 case 'rightsinfo':
79 $fit = $this->appendRightsInfo( $p );
80 break;
81 case 'restrictions':
82 $fit = $this->appendRestrictions( $p );
83 break;
84 case 'languages':
85 $fit = $this->appendLanguages( $p );
86 break;
87 case 'languagevariants':
88 $fit = $this->appendLanguageVariants( $p );
89 break;
90 case 'skins':
91 $fit = $this->appendSkins( $p );
92 break;
93 case 'extensiontags':
94 $fit = $this->appendExtensionTags( $p );
95 break;
96 case 'functionhooks':
97 $fit = $this->appendFunctionHooks( $p );
98 break;
99 case 'showhooks':
100 $fit = $this->appendSubscribedHooks( $p );
101 break;
102 case 'variables':
103 $fit = $this->appendVariables( $p );
104 break;
105 case 'protocols':
106 $fit = $this->appendProtocols( $p );
107 break;
108 case 'defaultoptions':
109 $fit = $this->appendDefaultOptions( $p );
110 break;
111 case 'uploaddialog':
112 $fit = $this->appendUploadDialog( $p );
113 break;
114 default:
115 ApiBase::dieDebug( __METHOD__, "Unknown prop=$p" );
116 }
117 if ( !$fit ) {
118 // Abuse siprop as a query-continue parameter
119 // and set it to all unprocessed props
120 $this->setContinueEnumParameter( 'prop', implode( '|',
121 array_diff( $params['prop'], $done ) ) );
122 break;
123 }
124 $done[] = $p;
125 }
126 }
127
128 protected function appendGeneralInfo( $property ) {
129 global $wgContLang;
130
131 $config = $this->getConfig();
132
133 $data = [];
134 $mainPage = Title::newMainPage();
135 $data['mainpage'] = $mainPage->getPrefixedText();
136 $data['base'] = wfExpandUrl( $mainPage->getFullURL(), PROTO_CURRENT );
137 $data['sitename'] = $config->get( 'Sitename' );
138
139 // wgLogo can either be a relative or an absolute path
140 // make sure we always return an absolute path
141 $data['logo'] = wfExpandUrl( $config->get( 'Logo' ), PROTO_RELATIVE );
142
143 $data['generator'] = "MediaWiki {$config->get( 'Version' )}";
144
145 $data['phpversion'] = PHP_VERSION;
146 $data['phpsapi'] = PHP_SAPI;
147 if ( defined( 'HHVM_VERSION' ) ) {
148 $data['hhvmversion'] = HHVM_VERSION;
149 }
150 $data['dbtype'] = $config->get( 'DBtype' );
151 $data['dbversion'] = $this->getDB()->getServerVersion();
152
153 $allowFrom = [ '' ];
154 $allowException = true;
155 if ( !$config->get( 'AllowExternalImages' ) ) {
156 $data['imagewhitelistenabled'] = (bool)$config->get( 'EnableImageWhitelist' );
157 $allowFrom = $config->get( 'AllowExternalImagesFrom' );
158 $allowException = !empty( $allowFrom );
159 }
160 if ( $allowException ) {
161 $data['externalimages'] = (array)$allowFrom;
162 ApiResult::setIndexedTagName( $data['externalimages'], 'prefix' );
163 }
164
165 $data['langconversion'] = !$config->get( 'DisableLangConversion' );
166 $data['titleconversion'] = !$config->get( 'DisableTitleConversion' );
167
168 if ( $wgContLang->linkPrefixExtension() ) {
169 $linkPrefixCharset = $wgContLang->linkPrefixCharset();
170 $data['linkprefixcharset'] = $linkPrefixCharset;
171 // For backwards compatibility
172 $data['linkprefix'] = "/^((?>.*[^$linkPrefixCharset]|))(.+)$/sDu";
173 } else {
174 $data['linkprefixcharset'] = '';
175 $data['linkprefix'] = '';
176 }
177
178 $linktrail = $wgContLang->linkTrail();
179 $data['linktrail'] = $linktrail ?: '';
180
181 $data['legaltitlechars'] = Title::legalChars();
182 $data['invalidusernamechars'] = $config->get( 'InvalidUsernameCharacters' );
183
184 $data['allunicodefixes'] = (bool)$config->get( 'AllUnicodeFixes' );
185 $data['fixarabicunicode'] = (bool)$config->get( 'FixArabicUnicode' );
186 $data['fixmalayalamunicode'] = (bool)$config->get( 'FixMalayalamUnicode' );
187
188 global $IP;
190 if ( $git ) {
191 $data['git-hash'] = $git;
192 $data['git-branch'] =
194 }
195
196 // 'case-insensitive' option is reserved for future
197 $data['case'] = $config->get( 'CapitalLinks' ) ? 'first-letter' : 'case-sensitive';
198 $data['lang'] = $config->get( 'LanguageCode' );
199
200 $fallbacks = [];
201 foreach ( $wgContLang->getFallbackLanguages() as $code ) {
202 $fallbacks[] = [ 'code' => $code ];
203 }
204 $data['fallback'] = $fallbacks;
205 ApiResult::setIndexedTagName( $data['fallback'], 'lang' );
206
207 if ( $wgContLang->hasVariants() ) {
208 $variants = [];
209 foreach ( $wgContLang->getVariants() as $code ) {
210 $variants[] = [
211 'code' => $code,
212 'name' => $wgContLang->getVariantname( $code ),
213 ];
214 }
215 $data['variants'] = $variants;
216 ApiResult::setIndexedTagName( $data['variants'], 'lang' );
217 }
218
219 $data['rtl'] = $wgContLang->isRTL();
220 $data['fallback8bitEncoding'] = $wgContLang->fallback8bitEncoding();
221
222 $data['readonly'] = wfReadOnly();
223 if ( $data['readonly'] ) {
224 $data['readonlyreason'] = wfReadOnlyReason();
225 }
226 $data['writeapi'] = (bool)$config->get( 'EnableWriteAPI' );
227
228 $data['maxarticlesize'] = $config->get( 'MaxArticleSize' ) * 1024;
229
230 $tz = $config->get( 'Localtimezone' );
231 $offset = $config->get( 'LocalTZoffset' );
232 if ( is_null( $tz ) ) {
233 $tz = 'UTC';
234 $offset = 0;
235 } elseif ( is_null( $offset ) ) {
236 $offset = 0;
237 }
238 $data['timezone'] = $tz;
239 $data['timeoffset'] = intval( $offset );
240 $data['articlepath'] = $config->get( 'ArticlePath' );
241 $data['scriptpath'] = $config->get( 'ScriptPath' );
242 $data['script'] = $config->get( 'Script' );
243 $data['variantarticlepath'] = $config->get( 'VariantArticlePath' );
244 $data[ApiResult::META_BC_BOOLS][] = 'variantarticlepath';
245 $data['server'] = $config->get( 'Server' );
246 $data['servername'] = $config->get( 'ServerName' );
247 $data['wikiid'] = wfWikiID();
248 $data['time'] = wfTimestamp( TS_ISO_8601, time() );
249
250 $data['misermode'] = (bool)$config->get( 'MiserMode' );
251
252 $data['uploadsenabled'] = UploadBase::isEnabled();
253 $data['maxuploadsize'] = UploadBase::getMaxUploadSize();
254 $data['minuploadchunksize'] = (int)$config->get( 'MinUploadChunkSize' );
255
256 $data['galleryoptions'] = $config->get( 'GalleryOptions' );
257
258 $data['thumblimits'] = $config->get( 'ThumbLimits' );
259 ApiResult::setArrayType( $data['thumblimits'], 'BCassoc' );
260 ApiResult::setIndexedTagName( $data['thumblimits'], 'limit' );
261 $data['imagelimits'] = [];
262 ApiResult::setArrayType( $data['imagelimits'], 'BCassoc' );
263 ApiResult::setIndexedTagName( $data['imagelimits'], 'limit' );
264 foreach ( $config->get( 'ImageLimits' ) as $k => $limit ) {
265 $data['imagelimits'][$k] = [ 'width' => $limit[0], 'height' => $limit[1] ];
266 }
267
268 $favicon = $config->get( 'Favicon' );
269 if ( !empty( $favicon ) ) {
270 // wgFavicon can either be a relative or an absolute path
271 // make sure we always return an absolute path
272 $data['favicon'] = wfExpandUrl( $favicon, PROTO_RELATIVE );
273 }
274
275 $data['centralidlookupprovider'] = $config->get( 'CentralIdLookupProvider' );
276 $providerIds = array_keys( $config->get( 'CentralIdLookupProviders' ) );
277 $data['allcentralidlookupproviders'] = $providerIds;
278
279 $data['interwikimagic'] = (bool)$config->get( 'InterwikiMagic' );
280 $data['magiclinks'] = $config->get( 'EnableMagicLinks' );
281
282 $data['categorycollation'] = $config->get( 'CategoryCollation' );
283
284 Hooks::run( 'APIQuerySiteInfoGeneralInfo', [ $this, &$data ] );
285
286 return $this->getResult()->addValue( 'query', $property, $data );
287 }
288
289 protected function appendNamespaces( $property ) {
290 global $wgContLang;
291 $data = [
292 ApiResult::META_TYPE => 'assoc',
293 ];
294 foreach ( $wgContLang->getFormattedNamespaces() as $ns => $title ) {
295 $data[$ns] = [
296 'id' => intval( $ns ),
297 'case' => MWNamespace::isCapitalized( $ns ) ? 'first-letter' : 'case-sensitive',
298 ];
299 ApiResult::setContentValue( $data[$ns], 'name', $title );
300 $canonical = MWNamespace::getCanonicalName( $ns );
301
302 $data[$ns]['subpages'] = MWNamespace::hasSubpages( $ns );
303
304 if ( $canonical ) {
305 $data[$ns]['canonical'] = strtr( $canonical, '_', ' ' );
306 }
307
308 $data[$ns]['content'] = MWNamespace::isContent( $ns );
309 $data[$ns]['nonincludable'] = MWNamespace::isNonincludable( $ns );
310
311 $contentmodel = MWNamespace::getNamespaceContentModel( $ns );
312 if ( $contentmodel ) {
313 $data[$ns]['defaultcontentmodel'] = $contentmodel;
314 }
315 }
316
317 ApiResult::setArrayType( $data, 'assoc' );
318 ApiResult::setIndexedTagName( $data, 'ns' );
319
320 return $this->getResult()->addValue( 'query', $property, $data );
321 }
322
323 protected function appendNamespaceAliases( $property ) {
324 global $wgContLang;
325 $aliases = array_merge( $this->getConfig()->get( 'NamespaceAliases' ),
326 $wgContLang->getNamespaceAliases() );
327 $namespaces = $wgContLang->getNamespaces();
328 $data = [];
329 foreach ( $aliases as $title => $ns ) {
330 if ( $namespaces[$ns] == $title ) {
331 // Don't list duplicates
332 continue;
333 }
334 $item = [
335 'id' => intval( $ns )
336 ];
337 ApiResult::setContentValue( $item, 'alias', strtr( $title, '_', ' ' ) );
338 $data[] = $item;
339 }
340
341 sort( $data );
342
343 ApiResult::setIndexedTagName( $data, 'ns' );
344
345 return $this->getResult()->addValue( 'query', $property, $data );
346 }
347
348 protected function appendSpecialPageAliases( $property ) {
349 global $wgContLang;
350 $data = [];
351 $aliases = $wgContLang->getSpecialPageAliases();
352 foreach ( SpecialPageFactory::getNames() as $specialpage ) {
353 if ( isset( $aliases[$specialpage] ) ) {
354 $arr = [ 'realname' => $specialpage, 'aliases' => $aliases[$specialpage] ];
355 ApiResult::setIndexedTagName( $arr['aliases'], 'alias' );
356 $data[] = $arr;
357 }
358 }
359 ApiResult::setIndexedTagName( $data, 'specialpage' );
360
361 return $this->getResult()->addValue( 'query', $property, $data );
362 }
363
364 protected function appendMagicWords( $property ) {
365 global $wgContLang;
366 $data = [];
367 foreach ( $wgContLang->getMagicWords() as $magicword => $aliases ) {
368 $caseSensitive = array_shift( $aliases );
369 $arr = [ 'name' => $magicword, 'aliases' => $aliases ];
370 $arr['case-sensitive'] = (bool)$caseSensitive;
371 ApiResult::setIndexedTagName( $arr['aliases'], 'alias' );
372 $data[] = $arr;
373 }
374 ApiResult::setIndexedTagName( $data, 'magicword' );
375
376 return $this->getResult()->addValue( 'query', $property, $data );
377 }
378
379 protected function appendInterwikiMap( $property, $filter ) {
380 $local = null;
381 if ( $filter === 'local' ) {
382 $local = 1;
383 } elseif ( $filter === '!local' ) {
384 $local = 0;
385 } elseif ( $filter ) {
386 ApiBase::dieDebug( __METHOD__, "Unknown filter=$filter" );
387 }
388
389 $params = $this->extractRequestParams();
390 $langCode = isset( $params['inlanguagecode'] ) ? $params['inlanguagecode'] : '';
391 $langNames = Language::fetchLanguageNames( $langCode );
392
393 $getPrefixes = MediaWikiServices::getInstance()->getInterwikiLookup()->getAllPrefixes( $local );
394 $extraLangPrefixes = $this->getConfig()->get( 'ExtraInterlanguageLinkPrefixes' );
395 $localInterwikis = $this->getConfig()->get( 'LocalInterwikis' );
396 $data = [];
397
398 foreach ( $getPrefixes as $row ) {
399 $prefix = $row['iw_prefix'];
400 $val = [];
401 $val['prefix'] = $prefix;
402 if ( isset( $row['iw_local'] ) && $row['iw_local'] == '1' ) {
403 $val['local'] = true;
404 }
405 if ( isset( $row['iw_trans'] ) && $row['iw_trans'] == '1' ) {
406 $val['trans'] = true;
407 }
408
409 if ( isset( $langNames[$prefix] ) ) {
410 $val['language'] = $langNames[$prefix];
411 }
412 if ( in_array( $prefix, $localInterwikis ) ) {
413 $val['localinterwiki'] = true;
414 }
415 if ( in_array( $prefix, $extraLangPrefixes ) ) {
416 $val['extralanglink'] = true;
417
418 $linktext = wfMessage( "interlanguage-link-$prefix" );
419 if ( !$linktext->isDisabled() ) {
420 $val['linktext'] = $linktext->text();
421 }
422
423 $sitename = wfMessage( "interlanguage-link-sitename-$prefix" );
424 if ( !$sitename->isDisabled() ) {
425 $val['sitename'] = $sitename->text();
426 }
427 }
428
429 $val['url'] = wfExpandUrl( $row['iw_url'], PROTO_CURRENT );
430 $val['protorel'] = substr( $row['iw_url'], 0, 2 ) == '//';
431 if ( isset( $row['iw_wikiid'] ) && $row['iw_wikiid'] !== '' ) {
432 $val['wikiid'] = $row['iw_wikiid'];
433 }
434 if ( isset( $row['iw_api'] ) && $row['iw_api'] !== '' ) {
435 $val['api'] = $row['iw_api'];
436 }
437
438 $data[] = $val;
439 }
440
441 ApiResult::setIndexedTagName( $data, 'iw' );
442
443 return $this->getResult()->addValue( 'query', $property, $data );
444 }
445
446 protected function appendDbReplLagInfo( $property, $includeAll ) {
447 $data = [];
448 $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
449 $showHostnames = $this->getConfig()->get( 'ShowHostnames' );
450 if ( $includeAll ) {
451 if ( !$showHostnames ) {
452 $this->dieWithError( 'apierror-siteinfo-includealldenied', 'includeAllDenied' );
453 }
454
455 $lags = $lb->getLagTimes();
456 foreach ( $lags as $i => $lag ) {
457 $data[] = [
458 'host' => $lb->getServerName( $i ),
459 'lag' => $lag
460 ];
461 }
462 } else {
463 list( , $lag, $index ) = $lb->getMaxLag();
464 $data[] = [
465 'host' => $showHostnames
466 ? $lb->getServerName( $index )
467 : '',
468 'lag' => $lag
469 ];
470 }
471
472 ApiResult::setIndexedTagName( $data, 'db' );
473
474 return $this->getResult()->addValue( 'query', $property, $data );
475 }
476
477 protected function appendStatistics( $property ) {
478 $data = [];
479 $data['pages'] = intval( SiteStats::pages() );
480 $data['articles'] = intval( SiteStats::articles() );
481 $data['edits'] = intval( SiteStats::edits() );
482 $data['images'] = intval( SiteStats::images() );
483 $data['users'] = intval( SiteStats::users() );
484 $data['activeusers'] = intval( SiteStats::activeUsers() );
485 $data['admins'] = intval( SiteStats::numberingroup( 'sysop' ) );
486 $data['jobs'] = intval( SiteStats::jobs() );
487
488 Hooks::run( 'APIQuerySiteInfoStatisticsInfo', [ &$data ] );
489
490 return $this->getResult()->addValue( 'query', $property, $data );
491 }
492
493 protected function appendUserGroups( $property, $numberInGroup ) {
494 $config = $this->getConfig();
495
496 $data = [];
497 $result = $this->getResult();
498 $allGroups = array_values( User::getAllGroups() );
499 foreach ( $config->get( 'GroupPermissions' ) as $group => $permissions ) {
500 $arr = [
501 'name' => $group,
502 'rights' => array_keys( $permissions, true ),
503 ];
504
505 if ( $numberInGroup ) {
506 $autopromote = $config->get( 'Autopromote' );
507
508 if ( $group == 'user' ) {
509 $arr['number'] = SiteStats::users();
510 // '*' and autopromote groups have no size
511 } elseif ( $group !== '*' && !isset( $autopromote[$group] ) ) {
512 $arr['number'] = SiteStats::numberingroup( $group );
513 }
514 }
515
516 $groupArr = [
517 'add' => $config->get( 'AddGroups' ),
518 'remove' => $config->get( 'RemoveGroups' ),
519 'add-self' => $config->get( 'GroupsAddToSelf' ),
520 'remove-self' => $config->get( 'GroupsRemoveFromSelf' )
521 ];
522
523 foreach ( $groupArr as $type => $rights ) {
524 if ( isset( $rights[$group] ) ) {
525 if ( $rights[$group] === true ) {
526 $groups = $allGroups;
527 } else {
528 $groups = array_intersect( $rights[$group], $allGroups );
529 }
530 if ( $groups ) {
531 $arr[$type] = $groups;
532 ApiResult::setArrayType( $arr[$type], 'BCarray' );
533 ApiResult::setIndexedTagName( $arr[$type], 'group' );
534 }
535 }
536 }
537
538 ApiResult::setIndexedTagName( $arr['rights'], 'permission' );
539 $data[] = $arr;
540 }
541
542 ApiResult::setIndexedTagName( $data, 'group' );
543
544 return $result->addValue( 'query', $property, $data );
545 }
546
547 protected function appendFileExtensions( $property ) {
548 $data = [];
549 foreach ( array_unique( $this->getConfig()->get( 'FileExtensions' ) ) as $ext ) {
550 $data[] = [ 'ext' => $ext ];
551 }
552 ApiResult::setIndexedTagName( $data, 'fe' );
553
554 return $this->getResult()->addValue( 'query', $property, $data );
555 }
556
557 protected function appendInstalledLibraries( $property ) {
558 global $IP;
559 $path = "$IP/vendor/composer/installed.json";
560 if ( !file_exists( $path ) ) {
561 return true;
562 }
563
564 $data = [];
565 $installed = new ComposerInstalled( $path );
566 foreach ( $installed->getInstalledDependencies() as $name => $info ) {
567 if ( strpos( $info['type'], 'mediawiki-' ) === 0 ) {
568 // Skip any extensions or skins since they'll be listed
569 // in their proper section
570 continue;
571 }
572 $data[] = [
573 'name' => $name,
574 'version' => $info['version'],
575 ];
576 }
577 ApiResult::setIndexedTagName( $data, 'library' );
578
579 return $this->getResult()->addValue( 'query', $property, $data );
580 }
581
582 protected function appendExtensions( $property ) {
583 $data = [];
584 foreach ( $this->getConfig()->get( 'ExtensionCredits' ) as $type => $extensions ) {
585 foreach ( $extensions as $ext ) {
586 $ret = [];
587 $ret['type'] = $type;
588 if ( isset( $ext['name'] ) ) {
589 $ret['name'] = $ext['name'];
590 }
591 if ( isset( $ext['namemsg'] ) ) {
592 $ret['namemsg'] = $ext['namemsg'];
593 }
594 if ( isset( $ext['description'] ) ) {
595 $ret['description'] = $ext['description'];
596 }
597 if ( isset( $ext['descriptionmsg'] ) ) {
598 // Can be a string or [ key, param1, param2, ... ]
599 if ( is_array( $ext['descriptionmsg'] ) ) {
600 $ret['descriptionmsg'] = $ext['descriptionmsg'][0];
601 $ret['descriptionmsgparams'] = array_slice( $ext['descriptionmsg'], 1 );
602 ApiResult::setIndexedTagName( $ret['descriptionmsgparams'], 'param' );
603 } else {
604 $ret['descriptionmsg'] = $ext['descriptionmsg'];
605 }
606 }
607 if ( isset( $ext['author'] ) ) {
608 $ret['author'] = is_array( $ext['author'] ) ?
609 implode( ', ', $ext['author'] ) : $ext['author'];
610 }
611 if ( isset( $ext['url'] ) ) {
612 $ret['url'] = $ext['url'];
613 }
614 if ( isset( $ext['version'] ) ) {
615 $ret['version'] = $ext['version'];
616 }
617 if ( isset( $ext['path'] ) ) {
618 $extensionPath = dirname( $ext['path'] );
619 $gitInfo = new GitInfo( $extensionPath );
620 $vcsVersion = $gitInfo->getHeadSHA1();
621 if ( $vcsVersion !== false ) {
622 $ret['vcs-system'] = 'git';
623 $ret['vcs-version'] = $vcsVersion;
624 $ret['vcs-url'] = $gitInfo->getHeadViewUrl();
625 $vcsDate = $gitInfo->getHeadCommitDate();
626 if ( $vcsDate !== false ) {
627 $ret['vcs-date'] = wfTimestamp( TS_ISO_8601, $vcsDate );
628 }
629 }
630
631 if ( SpecialVersion::getExtLicenseFileName( $extensionPath ) ) {
632 $ret['license-name'] = isset( $ext['license-name'] ) ? $ext['license-name'] : '';
633 $ret['license'] = SpecialPage::getTitleFor(
634 'Version',
635 "License/{$ext['name']}"
636 )->getLinkURL();
637 }
638
639 if ( SpecialVersion::getExtAuthorsFileName( $extensionPath ) ) {
640 $ret['credits'] = SpecialPage::getTitleFor(
641 'Version',
642 "Credits/{$ext['name']}"
643 )->getLinkURL();
644 }
645 }
646 $data[] = $ret;
647 }
648 }
649
650 ApiResult::setIndexedTagName( $data, 'ext' );
651
652 return $this->getResult()->addValue( 'query', $property, $data );
653 }
654
655 protected function appendRightsInfo( $property ) {
656 $config = $this->getConfig();
657 $rightsPage = $config->get( 'RightsPage' );
658 if ( is_string( $rightsPage ) ) {
659 $title = Title::newFromText( $rightsPage );
660 $url = wfExpandUrl( $title, PROTO_CURRENT );
661 } else {
662 $title = false;
663 $url = $config->get( 'RightsUrl' );
664 }
665 $text = $config->get( 'RightsText' );
666 if ( !$text && $title ) {
667 $text = $title->getPrefixedText();
668 }
669
670 $data = [
671 'url' => $url ?: '',
672 'text' => $text ?: ''
673 ];
674
675 return $this->getResult()->addValue( 'query', $property, $data );
676 }
677
678 protected function appendRestrictions( $property ) {
679 $config = $this->getConfig();
680 $data = [
681 'types' => $config->get( 'RestrictionTypes' ),
682 'levels' => $config->get( 'RestrictionLevels' ),
683 'cascadinglevels' => $config->get( 'CascadingRestrictionLevels' ),
684 'semiprotectedlevels' => $config->get( 'SemiprotectedRestrictionLevels' ),
685 ];
686
687 ApiResult::setArrayType( $data['types'], 'BCarray' );
688 ApiResult::setArrayType( $data['levels'], 'BCarray' );
689 ApiResult::setArrayType( $data['cascadinglevels'], 'BCarray' );
690 ApiResult::setArrayType( $data['semiprotectedlevels'], 'BCarray' );
691
692 ApiResult::setIndexedTagName( $data['types'], 'type' );
693 ApiResult::setIndexedTagName( $data['levels'], 'level' );
694 ApiResult::setIndexedTagName( $data['cascadinglevels'], 'level' );
695 ApiResult::setIndexedTagName( $data['semiprotectedlevels'], 'level' );
696
697 return $this->getResult()->addValue( 'query', $property, $data );
698 }
699
700 public function appendLanguages( $property ) {
701 $params = $this->extractRequestParams();
702 $langCode = isset( $params['inlanguagecode'] ) ? $params['inlanguagecode'] : '';
703 $langNames = Language::fetchLanguageNames( $langCode );
704
705 $data = [];
706
707 foreach ( $langNames as $code => $name ) {
708 $lang = [ 'code' => $code ];
709 ApiResult::setContentValue( $lang, 'name', $name );
710 $data[] = $lang;
711 }
712 ApiResult::setIndexedTagName( $data, 'lang' );
713
714 return $this->getResult()->addValue( 'query', $property, $data );
715 }
716
717 // Export information about which page languages will trigger
718 // language conversion. (T153341)
720 $langNames = LanguageConverter::$languagesWithVariants;
721 if ( $this->getConfig()->get( 'DisableLangConversion' ) ) {
722 // Ensure result is empty if language conversion is disabled.
723 $langNames = [];
724 }
725 sort( $langNames );
726
727 $data = [];
728 foreach ( $langNames as $langCode ) {
729 $lang = Language::factory( $langCode );
730 if ( $lang->getConverter() instanceof FakeConverter ) {
731 // Only languages which do not return instances of
732 // FakeConverter implement language conversion.
733 continue;
734 }
735 $data[$langCode] = [];
736 ApiResult::setIndexedTagName( $data[$langCode], 'variant' );
737 ApiResult::setArrayType( $data[$langCode], 'kvp', 'code' );
738
739 $variants = $lang->getVariants();
740 sort( $variants );
741 foreach ( $variants as $v ) {
742 $fallbacks = $lang->getConverter()->getVariantFallbacks( $v );
743 if ( !is_array( $fallbacks ) ) {
744 $fallbacks = [ $fallbacks ];
745 }
746 $data[$langCode][$v] = [
747 'fallbacks' => $fallbacks,
748 ];
750 $data[$langCode][$v]['fallbacks'], 'variant'
751 );
752 }
753 }
754 ApiResult::setIndexedTagName( $data, 'lang' );
755 ApiResult::setArrayType( $data, 'kvp', 'code' );
756
757 return $this->getResult()->addValue( 'query', $property, $data );
758 }
759
760 public function appendSkins( $property ) {
761 $data = [];
762 $allowed = Skin::getAllowedSkins();
763 $default = Skin::normalizeKey( 'default' );
764 foreach ( Skin::getSkinNames() as $name => $displayName ) {
765 $msg = $this->msg( "skinname-{$name}" );
766 $code = $this->getParameter( 'inlanguagecode' );
767 if ( $code && Language::isValidCode( $code ) ) {
768 $msg->inLanguage( $code );
769 } else {
770 $msg->inContentLanguage();
771 }
772 if ( $msg->exists() ) {
773 $displayName = $msg->text();
774 }
775 $skin = [ 'code' => $name ];
776 ApiResult::setContentValue( $skin, 'name', $displayName );
777 if ( !isset( $allowed[$name] ) ) {
778 $skin['unusable'] = true;
779 }
780 if ( $name === $default ) {
781 $skin['default'] = true;
782 }
783 $data[] = $skin;
784 }
785 ApiResult::setIndexedTagName( $data, 'skin' );
786
787 return $this->getResult()->addValue( 'query', $property, $data );
788 }
789
790 public function appendExtensionTags( $property ) {
791 global $wgParser;
792 $wgParser->firstCallInit();
793 $tags = array_map( [ $this, 'formatParserTags' ], $wgParser->getTags() );
794 ApiResult::setArrayType( $tags, 'BCarray' );
795 ApiResult::setIndexedTagName( $tags, 't' );
796
797 return $this->getResult()->addValue( 'query', $property, $tags );
798 }
799
800 public function appendFunctionHooks( $property ) {
801 global $wgParser;
802 $wgParser->firstCallInit();
803 $hooks = $wgParser->getFunctionHooks();
804 ApiResult::setArrayType( $hooks, 'BCarray' );
805 ApiResult::setIndexedTagName( $hooks, 'h' );
806
807 return $this->getResult()->addValue( 'query', $property, $hooks );
808 }
809
810 public function appendVariables( $property ) {
811 $variables = MagicWord::getVariableIDs();
812 ApiResult::setArrayType( $variables, 'BCarray' );
813 ApiResult::setIndexedTagName( $variables, 'v' );
814
815 return $this->getResult()->addValue( 'query', $property, $variables );
816 }
817
818 public function appendProtocols( $property ) {
819 // Make a copy of the global so we don't try to set the _element key of it - T47130
820 $protocols = array_values( $this->getConfig()->get( 'UrlProtocols' ) );
821 ApiResult::setArrayType( $protocols, 'BCarray' );
822 ApiResult::setIndexedTagName( $protocols, 'p' );
823
824 return $this->getResult()->addValue( 'query', $property, $protocols );
825 }
826
827 public function appendDefaultOptions( $property ) {
830 return $this->getResult()->addValue( 'query', $property, $options );
831 }
832
833 public function appendUploadDialog( $property ) {
834 $config = $this->getConfig()->get( 'UploadDialog' );
835 return $this->getResult()->addValue( 'query', $property, $config );
836 }
837
838 private function formatParserTags( $item ) {
839 return "<{$item}>";
840 }
841
842 public function appendSubscribedHooks( $property ) {
843 $hooks = $this->getConfig()->get( 'Hooks' );
844 $myWgHooks = $hooks;
845 ksort( $myWgHooks );
846
847 $data = [];
848 foreach ( $myWgHooks as $name => $subscribers ) {
849 $arr = [
850 'name' => $name,
851 'subscribers' => array_map( [ SpecialVersion::class, 'arrayToString' ], $subscribers ),
852 ];
853
854 ApiResult::setArrayType( $arr['subscribers'], 'array' );
855 ApiResult::setIndexedTagName( $arr['subscribers'], 's' );
856 $data[] = $arr;
857 }
858
859 ApiResult::setIndexedTagName( $data, 'hook' );
860
861 return $this->getResult()->addValue( 'query', $property, $data );
862 }
863
864 public function getCacheMode( $params ) {
865 // Messages for $wgExtraInterlanguageLinkPrefixes depend on user language
866 if (
867 count( $this->getConfig()->get( 'ExtraInterlanguageLinkPrefixes' ) ) &&
868 !is_null( $params['prop'] ) &&
869 in_array( 'interwikimap', $params['prop'] )
870 ) {
871 return 'anon-public-user-private';
872 }
873
874 return 'public';
875 }
876
877 public function getAllowedParams() {
878 return [
879 'prop' => [
880 ApiBase::PARAM_DFLT => 'general',
883 'general',
884 'namespaces',
885 'namespacealiases',
886 'specialpagealiases',
887 'magicwords',
888 'interwikimap',
889 'dbrepllag',
890 'statistics',
891 'usergroups',
892 'libraries',
893 'extensions',
894 'fileextensions',
895 'rightsinfo',
896 'restrictions',
897 'languages',
898 'languagevariants',
899 'skins',
900 'extensiontags',
901 'functionhooks',
902 'showhooks',
903 'variables',
904 'protocols',
905 'defaultoptions',
906 'uploaddialog',
907 ],
909 ],
910 'filteriw' => [
912 'local',
913 '!local',
914 ]
915 ],
916 'showalldb' => false,
917 'numberingroup' => false,
918 'inlanguagecode' => null,
919 ];
920 }
921
922 protected function getExamplesMessages() {
923 return [
924 'action=query&meta=siteinfo&siprop=general|namespaces|namespacealiases|statistics'
925 => 'apihelp-query+siteinfo-example-simple',
926 'action=query&meta=siteinfo&siprop=interwikimap&sifilteriw=local'
927 => 'apihelp-query+siteinfo-example-interwiki',
928 'action=query&meta=siteinfo&siprop=dbrepllag&sishowalldb='
929 => 'apihelp-query+siteinfo-example-replag',
930 ];
931 }
932
933 public function getHelpUrls() {
934 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Siteinfo';
935 }
936}
$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.
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
$linkPrefixCharset
$wgParser
Definition Setup.php:917
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
Definition ApiBase.php:773
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:1895
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition ApiBase.php:2078
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
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:749
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:641
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.
static getVariableIDs()
Get an array of parser variable IDs.
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 getNames()
Returns a list of canonical special page names.
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:5099
static getDefaultOptions()
Combine the language default options with any site-specific options and add the default language vari...
Definition User.php:1722
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 class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition design.txt:57
the array() calling protocol came about after MediaWiki 1.4rc1.
namespace and then decline to actually register it & $namespaces
Definition hooks.txt:934
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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:865
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 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
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:2005
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
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:2011
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:1620
$IP
Definition update.php:3
const PROTO_CURRENT
Definition Defines.php:232
const PROTO_RELATIVE
Definition Defines.php:231
if(!is_readable( $file)) $ext
Definition router.php:55
$property
$params
if(!isset( $args[0])) $lang