MediaWiki REL1_33
SpecialVersion.php
Go to the documentation of this file.
1<?php
32 protected $firstExtOpened = false;
33
37 protected $coreId = '';
38
39 protected static $extensionTypes = false;
40
41 public function __construct() {
42 parent::__construct( 'Version' );
43 }
44
49 public function execute( $par ) {
51
52 $this->setHeaders();
53 $this->outputHeader();
54 $out = $this->getOutput();
55 $out->allowClickjacking();
56
57 // Explode the sub page information into useful bits
58 $parts = explode( '/', (string)$par );
59 $extNode = null;
60 if ( isset( $parts[1] ) ) {
61 $extName = str_replace( '_', ' ', $parts[1] );
62 // Find it!
63 foreach ( $wgExtensionCredits as $group => $extensions ) {
64 foreach ( $extensions as $ext ) {
65 if ( isset( $ext['name'] ) && ( $ext['name'] === $extName ) ) {
66 $extNode = &$ext;
67 break 2;
68 }
69 }
70 }
71 if ( !$extNode ) {
72 $out->setStatusCode( 404 );
73 }
74 } else {
75 $extName = 'MediaWiki';
76 }
77
78 // Now figure out what to do
79 switch ( strtolower( $parts[0] ) ) {
80 case 'credits':
81 $out->addModuleStyles( 'mediawiki.special.version' );
82
83 $wikiText = '{{int:version-credits-not-found}}';
84 if ( $extName === 'MediaWiki' ) {
85 $wikiText = file_get_contents( $IP . '/CREDITS' );
86 // Put the contributor list into columns
87 $wikiText = str_replace(
88 [ '<!-- BEGIN CONTRIBUTOR LIST -->', '<!-- END CONTRIBUTOR LIST -->' ],
89 [ '<div class="mw-version-credits">', '</div>' ],
90 $wikiText );
91 } elseif ( ( $extNode !== null ) && isset( $extNode['path'] ) ) {
92 $file = $this->getExtAuthorsFileName( dirname( $extNode['path'] ) );
93 if ( $file ) {
94 $wikiText = file_get_contents( $file );
95 if ( substr( $file, -4 ) === '.txt' ) {
96 $wikiText = Html::element(
97 'pre',
98 [
99 'lang' => 'en',
100 'dir' => 'ltr',
101 ],
102 $wikiText
103 );
104 }
105 }
106 }
107
108 $out->setPageTitle( $this->msg( 'version-credits-title', $extName ) );
109 $out->addWikiTextAsInterface( $wikiText );
110 break;
111
112 case 'license':
113 $wikiText = '{{int:version-license-not-found}}';
114 if ( $extName === 'MediaWiki' ) {
115 $wikiText = file_get_contents( $IP . '/COPYING' );
116 } elseif ( ( $extNode !== null ) && isset( $extNode['path'] ) ) {
117 $file = $this->getExtLicenseFileName( dirname( $extNode['path'] ) );
118 if ( $file ) {
119 $wikiText = file_get_contents( $file );
120 $wikiText = Html::element(
121 'pre',
122 [
123 'lang' => 'en',
124 'dir' => 'ltr',
125 ],
126 $wikiText
127 );
128 }
129 }
130
131 $out->setPageTitle( $this->msg( 'version-license-title', $extName ) );
132 $out->addWikiTextAsInterface( $wikiText );
133 break;
134
135 default:
136 $out->addModuleStyles( 'mediawiki.special.version' );
137 $out->addWikiTextAsInterface(
138 $this->getMediaWikiCredits() .
139 $this->softwareInformation() .
140 $this->getEntryPointInfo()
141 );
142 $out->addHTML(
143 $this->getSkinCredits() .
144 $this->getExtensionCredits() .
145 $this->getExternalLibraries() .
146 $this->getParserTags() .
148 );
149 $out->addWikiTextAsInterface( $this->getWgHooks() );
150 $out->addHTML( $this->IPInfo() );
151
152 break;
153 }
154 }
155
161 private static function getMediaWikiCredits() {
162 $ret = Xml::element(
163 'h2',
164 [ 'id' => 'mw-version-license' ],
165 wfMessage( 'version-license' )->text()
166 );
167
168 // This text is always left-to-right.
169 $ret .= '<div class="plainlinks">';
170 $ret .= "__NOTOC__
172 " . '<div class="mw-version-license-info">' .
173 wfMessage( 'version-license-info' )->text() .
174 '</div>';
175 $ret .= '</div>';
176
177 return str_replace( "\t\t", '', $ret ) . "\n";
178 }
179
185 public static function getCopyrightAndAuthorList() {
186 global $wgLang;
187
188 if ( defined( 'MEDIAWIKI_INSTALL' ) ) {
189 $othersLink = '[https://www.mediawiki.org/wiki/Special:Version/Credits ' .
190 wfMessage( 'version-poweredby-others' )->text() . ']';
191 } else {
192 $othersLink = '[[Special:Version/Credits|' .
193 wfMessage( 'version-poweredby-others' )->text() . ']]';
194 }
195
196 $translatorsLink = '[https://translatewiki.net/wiki/Translating:MediaWiki/Credits ' .
197 wfMessage( 'version-poweredby-translators' )->text() . ']';
198
199 $authorList = [
200 'Magnus Manske', 'Brion Vibber', 'Lee Daniel Crocker',
201 'Tim Starling', 'Erik Möller', 'Gabriel Wicke', 'Ævar Arnfjörð Bjarmason',
202 'Niklas Laxström', 'Domas Mituzas', 'Rob Church', 'Yuri Astrakhan',
203 'Aryeh Gregor', 'Aaron Schulz', 'Andrew Garrett', 'Raimond Spekking',
204 'Alexandre Emsenhuber', 'Siebrand Mazeland', 'Chad Horohoe',
205 'Roan Kattouw', 'Trevor Parscal', 'Bryan Tong Minh', 'Sam Reed',
206 'Victor Vasiliev', 'Rotem Liss', 'Platonides', 'Antoine Musso',
207 'Timo Tijhof', 'Daniel Kinzler', 'Jeroen De Dauw', 'Brad Jorsch',
208 'Bartosz Dziewoński', 'Ed Sanders', 'Moriel Schottlender',
209 $othersLink, $translatorsLink
210 ];
211
212 return wfMessage( 'version-poweredby-credits', MWTimestamp::getLocalInstance()->format( 'Y' ),
213 $wgLang->listToText( $authorList ) )->text();
214 }
215
221 public static function softwareInformation() {
223
224 // Put the software in an array of form 'name' => 'version'. All messages should
225 // be loaded here, so feel free to use wfMessage in the 'name'. Raw HTML or
226 // wikimarkup can be used.
227 $software = [];
228 $software['[https://www.mediawiki.org/ MediaWiki]'] = self::getVersionLinked();
229 if ( wfIsHHVM() ) {
230 $software['[https://hhvm.com/ HHVM]'] = HHVM_VERSION . " (" . PHP_SAPI . ")";
231 } else {
232 $software['[https://php.net/ PHP]'] = PHP_VERSION . " (" . PHP_SAPI . ")";
233 }
234 $software[$dbr->getSoftwareLink()] = $dbr->getServerInfo();
235
236 if ( defined( 'INTL_ICU_VERSION' ) ) {
237 $software['[http://site.icu-project.org/ ICU]'] = INTL_ICU_VERSION;
238 }
239
240 // Allow a hook to add/remove items.
241 Hooks::run( 'SoftwareInfo', [ &$software ] );
242
243 $out = Xml::element(
244 'h2',
245 [ 'id' => 'mw-version-software' ],
246 wfMessage( 'version-software' )->text()
247 ) .
248 Xml::openElement( 'table', [ 'class' => 'wikitable plainlinks', 'id' => 'sv-software' ] ) .
249 "<tr>
250 <th>" . wfMessage( 'version-software-product' )->text() . "</th>
251 <th>" . wfMessage( 'version-software-version' )->text() . "</th>
252 </tr>\n";
253
254 foreach ( $software as $name => $version ) {
255 $out .= "<tr>
256 <td>" . $name . "</td>
257 <td dir=\"ltr\">" . $version . "</td>
258 </tr>\n";
259 }
260
261 return $out . Xml::closeElement( 'table' );
262 }
263
271 public static function getVersion( $flags = '', $lang = null ) {
272 global $wgVersion, $IP;
273
274 $gitInfo = self::getGitHeadSha1( $IP );
275 if ( !$gitInfo ) {
276 $version = $wgVersion;
277 } elseif ( $flags === 'nodb' ) {
278 $shortSha1 = substr( $gitInfo, 0, 7 );
279 $version = "$wgVersion ($shortSha1)";
280 } else {
281 $shortSha1 = substr( $gitInfo, 0, 7 );
282 $msg = wfMessage( 'parentheses' );
283 if ( $lang !== null ) {
284 $msg->inLanguage( $lang );
285 }
286 $shortSha1 = $msg->params( $shortSha1 )->escaped();
287 $version = "$wgVersion $shortSha1";
288 }
289
290 return $version;
291 }
292
300 public static function getVersionLinked() {
301 global $wgVersion;
302
303 $gitVersion = self::getVersionLinkedGit();
304 if ( $gitVersion ) {
305 $v = $gitVersion;
306 } else {
307 $v = $wgVersion; // fallback
308 }
309
310 return $v;
311 }
312
316 private static function getwgVersionLinked() {
317 global $wgVersion;
318 $versionUrl = "";
319 if ( Hooks::run( 'SpecialVersionVersionUrl', [ $wgVersion, &$versionUrl ] ) ) {
320 $versionParts = [];
321 preg_match( "/^(\d+\.\d+)/", $wgVersion, $versionParts );
322 $versionUrl = "https://www.mediawiki.org/wiki/MediaWiki_{$versionParts[1]}";
323 }
324
325 return "[$versionUrl $wgVersion]";
326 }
327
333 private static function getVersionLinkedGit() {
334 global $IP, $wgLang;
335
336 $gitInfo = new GitInfo( $IP );
337 $headSHA1 = $gitInfo->getHeadSHA1();
338 if ( !$headSHA1 ) {
339 return false;
340 }
341
342 $shortSHA1 = '(' . substr( $headSHA1, 0, 7 ) . ')';
343
344 $gitHeadUrl = $gitInfo->getHeadViewUrl();
345 if ( $gitHeadUrl !== false ) {
346 $shortSHA1 = "[$gitHeadUrl $shortSHA1]";
347 }
348
349 $gitHeadCommitDate = $gitInfo->getHeadCommitDate();
350 if ( $gitHeadCommitDate ) {
351 $shortSHA1 .= Html::element( 'br' ) . $wgLang->timeanddate( $gitHeadCommitDate, true );
352 }
353
354 return self::getwgVersionLinked() . " $shortSHA1";
355 }
356
367 public static function getExtensionTypes() {
368 if ( self::$extensionTypes === false ) {
369 self::$extensionTypes = [
370 'specialpage' => wfMessage( 'version-specialpages' )->text(),
371 'editor' => wfMessage( 'version-editors' )->text(),
372 'parserhook' => wfMessage( 'version-parserhooks' )->text(),
373 'variable' => wfMessage( 'version-variables' )->text(),
374 'media' => wfMessage( 'version-mediahandlers' )->text(),
375 'antispam' => wfMessage( 'version-antispam' )->text(),
376 'skin' => wfMessage( 'version-skins' )->text(),
377 'api' => wfMessage( 'version-api' )->text(),
378 'other' => wfMessage( 'version-other' )->text(),
379 ];
380
381 Hooks::run( 'ExtensionTypes', [ &self::$extensionTypes ] );
382 }
383
385 }
386
396 public static function getExtensionTypeName( $type ) {
397 $types = self::getExtensionTypes();
398
399 return $types[$type] ?? $types['other'];
400 }
401
407 public function getExtensionCredits() {
408 global $wgExtensionCredits;
409
410 if (
411 count( $wgExtensionCredits ) === 0 ||
412 // Skins are displayed separately, see getSkinCredits()
413 ( count( $wgExtensionCredits ) === 1 && isset( $wgExtensionCredits['skin'] ) )
414 ) {
415 return '';
416 }
417
419
420 $out = Xml::element(
421 'h2',
422 [ 'id' => 'mw-version-ext' ],
423 $this->msg( 'version-extensions' )->text()
424 ) .
425 Xml::openElement( 'table', [ 'class' => 'wikitable plainlinks', 'id' => 'sv-ext' ] );
426
427 // Make sure the 'other' type is set to an array.
428 if ( !array_key_exists( 'other', $wgExtensionCredits ) ) {
429 $wgExtensionCredits['other'] = [];
430 }
431
432 // Find all extensions that do not have a valid type and give them the type 'other'.
433 foreach ( $wgExtensionCredits as $type => $extensions ) {
434 if ( !array_key_exists( $type, $extensionTypes ) ) {
435 $wgExtensionCredits['other'] = array_merge( $wgExtensionCredits['other'], $extensions );
436 }
437 }
438
439 $this->firstExtOpened = false;
440 // Loop through the extension categories to display their extensions in the list.
441 foreach ( $extensionTypes as $type => $message ) {
442 // Skins have a separate section
443 if ( $type !== 'other' && $type !== 'skin' ) {
444 $out .= $this->getExtensionCategory( $type, $message );
445 }
446 }
447
448 // We want the 'other' type to be last in the list.
449 $out .= $this->getExtensionCategory( 'other', $extensionTypes['other'] );
450
451 $out .= Xml::closeElement( 'table' );
452
453 return $out;
454 }
455
461 public function getSkinCredits() {
462 global $wgExtensionCredits;
463 if ( !isset( $wgExtensionCredits['skin'] ) || count( $wgExtensionCredits['skin'] ) === 0 ) {
464 return '';
465 }
466
467 $out = Xml::element(
468 'h2',
469 [ 'id' => 'mw-version-skin' ],
470 $this->msg( 'version-skins' )->text()
471 ) .
472 Xml::openElement( 'table', [ 'class' => 'wikitable plainlinks', 'id' => 'sv-skin' ] );
473
474 $this->firstExtOpened = false;
475 $out .= $this->getExtensionCategory( 'skin', null );
476
477 $out .= Xml::closeElement( 'table' );
478
479 return $out;
480 }
481
487 protected function getExternalLibraries() {
488 global $IP;
489 $path = "$IP/vendor/composer/installed.json";
490 if ( !file_exists( $path ) ) {
491 return '';
492 }
493
494 $installed = new ComposerInstalled( $path );
495 $out = Html::element(
496 'h2',
497 [ 'id' => 'mw-version-libraries' ],
498 $this->msg( 'version-libraries' )->text()
499 );
500 $out .= Html::openElement(
501 'table',
502 [ 'class' => 'wikitable plainlinks', 'id' => 'sv-libraries' ]
503 );
504 $out .= Html::openElement( 'tr' )
505 . Html::element( 'th', [], $this->msg( 'version-libraries-library' )->text() )
506 . Html::element( 'th', [], $this->msg( 'version-libraries-version' )->text() )
507 . Html::element( 'th', [], $this->msg( 'version-libraries-license' )->text() )
508 . Html::element( 'th', [], $this->msg( 'version-libraries-description' )->text() )
509 . Html::element( 'th', [], $this->msg( 'version-libraries-authors' )->text() )
510 . Html::closeElement( 'tr' );
511
512 foreach ( $installed->getInstalledDependencies() as $name => $info ) {
513 if ( strpos( $info['type'], 'mediawiki-' ) === 0 ) {
514 // Skip any extensions or skins since they'll be listed
515 // in their proper section
516 continue;
517 }
518 $authors = array_map( function ( $arr ) {
519 // If a homepage is set, link to it
520 if ( isset( $arr['homepage'] ) ) {
521 return "[{$arr['homepage']} {$arr['name']}]";
522 }
523 return $arr['name'];
524 }, $info['authors'] );
525 $authors = $this->listAuthors( $authors, false, "$IP/vendor/$name" );
526
527 // We can safely assume that the libraries' names and descriptions
528 // are written in English and aren't going to be translated,
529 // so set appropriate lang and dir attributes
530 $out .= Html::openElement( 'tr' )
531 . Html::rawElement(
532 'td',
533 [],
535 "https://packagist.org/packages/$name", $name,
536 true, '',
537 [ 'class' => 'mw-version-library-name' ]
538 )
539 )
540 . Html::element( 'td', [ 'dir' => 'auto' ], $info['version'] )
541 . Html::element( 'td', [ 'dir' => 'auto' ], $this->listToText( $info['licenses'] ) )
542 . Html::element( 'td', [ 'lang' => 'en', 'dir' => 'ltr' ], $info['description'] )
543 . Html::rawElement( 'td', [], $authors )
544 . Html::closeElement( 'tr' );
545 }
546 $out .= Html::closeElement( 'table' );
547
548 return $out;
549 }
550
556 protected function getParserTags() {
557 global $wgParser;
558
559 $tags = $wgParser->getTags();
560
561 if ( count( $tags ) ) {
562 $out = Html::rawElement(
563 'h2',
564 [
565 'class' => 'mw-headline plainlinks',
566 'id' => 'mw-version-parser-extensiontags',
567 ],
569 'https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Tag_extensions',
570 $this->msg( 'version-parser-extensiontags' )->parse(),
571 false /* msg()->parse() already escapes */
572 )
573 );
574
575 array_walk( $tags, function ( &$value ) {
576 // Bidirectional isolation improves readability in RTL wikis
577 $value = Html::element(
578 'bdi',
579 // Prevent < and > from slipping to another line
580 [
581 'style' => 'white-space: nowrap;',
582 ],
583 "<$value>"
584 );
585 } );
586
587 $out .= $this->listToText( $tags );
588 } else {
589 $out = '';
590 }
591
592 return $out;
593 }
594
600 protected function getParserFunctionHooks() {
601 global $wgParser;
602
603 $fhooks = $wgParser->getFunctionHooks();
604 if ( count( $fhooks ) ) {
605 $out = Html::rawElement(
606 'h2',
607 [
608 'class' => 'mw-headline plainlinks',
609 'id' => 'mw-version-parser-function-hooks',
610 ],
612 'https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Parser_functions',
613 $this->msg( 'version-parser-function-hooks' )->parse(),
614 false /* msg()->parse() already escapes */
615 )
616 );
617
618 $out .= $this->listToText( $fhooks );
619 } else {
620 $out = '';
621 }
622
623 return $out;
624 }
625
636 protected function getExtensionCategory( $type, $message ) {
637 global $wgExtensionCredits;
638
639 $out = '';
640
641 if ( array_key_exists( $type, $wgExtensionCredits ) && count( $wgExtensionCredits[$type] ) > 0 ) {
642 $out .= $this->openExtType( $message, 'credits-' . $type );
643
644 usort( $wgExtensionCredits[$type], [ $this, 'compare' ] );
645
646 foreach ( $wgExtensionCredits[$type] as $extension ) {
647 $out .= $this->getCreditsForExtension( $type, $extension );
648 }
649 }
650
651 return $out;
652 }
653
660 public function compare( $a, $b ) {
661 return $this->getLanguage()->lc( $a['name'] ) <=> $this->getLanguage()->lc( $b['name'] );
662 }
663
682 public function getCreditsForExtension( $type, array $extension ) {
683 $out = $this->getOutput();
684
685 // We must obtain the information for all the bits and pieces!
686 // ... such as extension names and links
687 if ( isset( $extension['namemsg'] ) ) {
688 // Localized name of extension
689 $extensionName = $this->msg( $extension['namemsg'] )->text();
690 } elseif ( isset( $extension['name'] ) ) {
691 // Non localized version
692 $extensionName = $extension['name'];
693 } else {
694 $extensionName = $this->msg( 'version-no-ext-name' )->text();
695 }
696
697 if ( isset( $extension['url'] ) ) {
698 $extensionNameLink = Linker::makeExternalLink(
699 $extension['url'],
700 $extensionName,
701 true,
702 '',
703 [ 'class' => 'mw-version-ext-name' ]
704 );
705 } else {
706 $extensionNameLink = htmlspecialchars( $extensionName );
707 }
708
709 // ... and the version information
710 // If the extension path is set we will check that directory for GIT
711 // metadata in an attempt to extract date and vcs commit metadata.
712 $canonicalVersion = '&ndash;';
713 $extensionPath = null;
714 $vcsVersion = null;
715 $vcsLink = null;
716 $vcsDate = null;
717
718 if ( isset( $extension['version'] ) ) {
719 $canonicalVersion = $out->parseInlineAsInterface( $extension['version'] );
720 }
721
722 if ( isset( $extension['path'] ) ) {
723 global $IP;
724 $extensionPath = dirname( $extension['path'] );
725 if ( $this->coreId == '' ) {
726 wfDebug( 'Looking up core head id' );
727 $coreHeadSHA1 = self::getGitHeadSha1( $IP );
728 if ( $coreHeadSHA1 ) {
729 $this->coreId = $coreHeadSHA1;
730 }
731 }
733 $memcKey = $cache->makeKey(
734 'specialversion-ext-version-text', $extension['path'], $this->coreId
735 );
736 list( $vcsVersion, $vcsLink, $vcsDate ) = $cache->get( $memcKey );
737
738 if ( !$vcsVersion ) {
739 wfDebug( "Getting VCS info for extension {$extension['name']}" );
740 $gitInfo = new GitInfo( $extensionPath );
741 $vcsVersion = $gitInfo->getHeadSHA1();
742 if ( $vcsVersion !== false ) {
743 $vcsVersion = substr( $vcsVersion, 0, 7 );
744 $vcsLink = $gitInfo->getHeadViewUrl();
745 $vcsDate = $gitInfo->getHeadCommitDate();
746 }
747 $cache->set( $memcKey, [ $vcsVersion, $vcsLink, $vcsDate ], 60 * 60 * 24 );
748 } else {
749 wfDebug( "Pulled VCS info for extension {$extension['name']} from cache" );
750 }
751 }
752
753 $versionString = Html::rawElement(
754 'span',
755 [ 'class' => 'mw-version-ext-version' ],
756 $canonicalVersion
757 );
758
759 if ( $vcsVersion ) {
760 if ( $vcsLink ) {
761 $vcsVerString = Linker::makeExternalLink(
762 $vcsLink,
763 $this->msg( 'version-version', $vcsVersion ),
764 true,
765 '',
766 [ 'class' => 'mw-version-ext-vcs-version' ]
767 );
768 } else {
769 $vcsVerString = Html::element( 'span',
770 [ 'class' => 'mw-version-ext-vcs-version' ],
771 "({$vcsVersion})"
772 );
773 }
774 $versionString .= " {$vcsVerString}";
775
776 if ( $vcsDate ) {
777 $vcsTimeString = Html::element( 'span',
778 [ 'class' => 'mw-version-ext-vcs-timestamp' ],
779 $this->getLanguage()->timeanddate( $vcsDate, true )
780 );
781 $versionString .= " {$vcsTimeString}";
782 }
783 $versionString = Html::rawElement( 'span',
784 [ 'class' => 'mw-version-ext-meta-version' ],
785 $versionString
786 );
787 }
788
789 // ... and license information; if a license file exists we
790 // will link to it
791 $licenseLink = '';
792 if ( isset( $extension['name'] ) ) {
793 $licenseName = null;
794 if ( isset( $extension['license-name'] ) ) {
795 $licenseName = new HtmlArmor( $out->parseInlineAsInterface( $extension['license-name'] ) );
796 } elseif ( $this->getExtLicenseFileName( $extensionPath ) ) {
797 $licenseName = $this->msg( 'version-ext-license' )->text();
798 }
799 if ( $licenseName !== null ) {
800 $licenseLink = $this->getLinkRenderer()->makeLink(
801 $this->getPageTitle( 'License/' . $extension['name'] ),
802 $licenseName,
803 [
804 'class' => 'mw-version-ext-license',
805 'dir' => 'auto',
806 ]
807 );
808 }
809 }
810
811 // ... and generate the description; which can be a parameterized l10n message
812 // in the form array( <msgname>, <parameter>, <parameter>... ) or just a straight
813 // up string
814 if ( isset( $extension['descriptionmsg'] ) ) {
815 // Localized description of extension
816 $descriptionMsg = $extension['descriptionmsg'];
817
818 if ( is_array( $descriptionMsg ) ) {
819 $descriptionMsgKey = $descriptionMsg[0]; // Get the message key
820 array_shift( $descriptionMsg ); // Shift out the message key to get the parameters only
821 array_map( "htmlspecialchars", $descriptionMsg ); // For sanity
822 $description = $this->msg( $descriptionMsgKey, $descriptionMsg )->text();
823 } else {
824 $description = $this->msg( $descriptionMsg )->text();
825 }
826 } elseif ( isset( $extension['description'] ) ) {
827 // Non localized version
828 $description = $extension['description'];
829 } else {
830 $description = '';
831 }
832 $description = $out->parseInlineAsInterface( $description );
833
834 // ... now get the authors for this extension
835 $authors = $extension['author'] ?? [];
836 $authors = $this->listAuthors( $authors, $extension['name'], $extensionPath );
837
838 // Finally! Create the table
839 $html = Html::openElement( 'tr', [
840 'class' => 'mw-version-ext',
841 'id' => Sanitizer::escapeIdForAttribute( 'mw-version-ext-' . $type . '-' . $extension['name'] )
842 ]
843 );
844
845 $html .= Html::rawElement( 'td', [], $extensionNameLink );
846 $html .= Html::rawElement( 'td', [], $versionString );
847 $html .= Html::rawElement( 'td', [], $licenseLink );
848 $html .= Html::rawElement( 'td', [ 'class' => 'mw-version-ext-description' ], $description );
849 $html .= Html::rawElement( 'td', [ 'class' => 'mw-version-ext-authors' ], $authors );
850
851 $html .= Html::closeElement( 'tr' );
852
853 return $html;
854 }
855
861 private function getWgHooks() {
863
864 if ( $wgSpecialVersionShowHooks && count( $wgHooks ) ) {
865 $myWgHooks = $wgHooks;
866 ksort( $myWgHooks );
867
868 $ret = [];
869 $ret[] = '== {{int:version-hooks}} ==';
870 $ret[] = Html::openElement( 'table', [ 'class' => 'wikitable', 'id' => 'sv-hooks' ] );
871 $ret[] = Html::openElement( 'tr' );
872 $ret[] = Html::element( 'th', [], $this->msg( 'version-hook-name' )->text() );
873 $ret[] = Html::element( 'th', [], $this->msg( 'version-hook-subscribedby' )->text() );
874 $ret[] = Html::closeElement( 'tr' );
875
876 foreach ( $myWgHooks as $hook => $hooks ) {
877 $ret[] = Html::openElement( 'tr' );
878 $ret[] = Html::element( 'td', [], $hook );
879 $ret[] = Html::element( 'td', [], $this->listToText( $hooks ) );
880 $ret[] = Html::closeElement( 'tr' );
881 }
882
883 $ret[] = Html::closeElement( 'table' );
884
885 return implode( "\n", $ret );
886 } else {
887 return '';
888 }
889 }
890
891 private function openExtType( $text = null, $name = null ) {
892 $out = '';
893
894 $opt = [ 'colspan' => 5 ];
895 if ( $this->firstExtOpened ) {
896 // Insert a spacing line
897 $out .= Html::rawElement( 'tr', [ 'class' => 'sv-space' ],
898 Html::element( 'td', $opt )
899 );
900 }
901 $this->firstExtOpened = true;
902
903 if ( $name ) {
904 $opt['id'] = "sv-$name";
905 }
906
907 if ( $text !== null ) {
908 $out .= Html::rawElement( 'tr', [],
909 Html::element( 'th', $opt, $text )
910 );
911 }
912
913 $firstHeadingMsg = ( $name === 'credits-skin' )
914 ? 'version-skin-colheader-name'
915 : 'version-ext-colheader-name';
916 $out .= Html::openElement( 'tr' );
917 $out .= Html::element( 'th', [ 'class' => 'mw-version-ext-col-label' ],
918 $this->msg( $firstHeadingMsg )->text() );
919 $out .= Html::element( 'th', [ 'class' => 'mw-version-ext-col-label' ],
920 $this->msg( 'version-ext-colheader-version' )->text() );
921 $out .= Html::element( 'th', [ 'class' => 'mw-version-ext-col-label' ],
922 $this->msg( 'version-ext-colheader-license' )->text() );
923 $out .= Html::element( 'th', [ 'class' => 'mw-version-ext-col-label' ],
924 $this->msg( 'version-ext-colheader-description' )->text() );
925 $out .= Html::element( 'th', [ 'class' => 'mw-version-ext-col-label' ],
926 $this->msg( 'version-ext-colheader-credits' )->text() );
927 $out .= Html::closeElement( 'tr' );
928
929 return $out;
930 }
931
937 private function IPInfo() {
938 $ip = str_replace( '--', ' - ', htmlspecialchars( $this->getRequest()->getIP() ) );
939
940 return "<!-- visited from $ip -->\n<span style='display:none'>visited from $ip</span>";
941 }
942
964 public function listAuthors( $authors, $extName, $extDir ) {
965 $hasOthers = false;
967
968 $list = [];
969 foreach ( (array)$authors as $item ) {
970 if ( $item == '...' ) {
971 $hasOthers = true;
972
973 if ( $extName && $this->getExtAuthorsFileName( $extDir ) ) {
974 $text = $linkRenderer->makeLink(
975 $this->getPageTitle( "Credits/$extName" ),
976 $this->msg( 'version-poweredby-others' )->text()
977 );
978 } else {
979 $text = $this->msg( 'version-poweredby-others' )->escaped();
980 }
981 $list[] = $text;
982 } elseif ( substr( $item, -5 ) == ' ...]' ) {
983 $hasOthers = true;
984 $list[] = $this->getOutput()->parseInlineAsInterface(
985 substr( $item, 0, -4 ) . $this->msg( 'version-poweredby-others' )->text() . "]"
986 );
987 } else {
988 $list[] = $this->getOutput()->parseInlineAsInterface( $item );
989 }
990 }
991
992 if ( $extName && !$hasOthers && $this->getExtAuthorsFileName( $extDir ) ) {
993 $list[] = $text = $linkRenderer->makeLink(
994 $this->getPageTitle( "Credits/$extName" ),
995 $this->msg( 'version-poweredby-others' )->text()
996 );
997 }
998
999 return $this->listToText( $list, false );
1000 }
1001
1013 public static function getExtAuthorsFileName( $extDir ) {
1014 if ( !$extDir ) {
1015 return false;
1016 }
1017
1018 foreach ( scandir( $extDir ) as $file ) {
1019 $fullPath = $extDir . DIRECTORY_SEPARATOR . $file;
1020 if ( preg_match( '/^((AUTHORS)|(CREDITS))(\.txt|\.wiki|\.mediawiki)?$/', $file ) &&
1021 is_readable( $fullPath ) &&
1022 is_file( $fullPath )
1023 ) {
1024 return $fullPath;
1025 }
1026 }
1027
1028 return false;
1029 }
1030
1042 public static function getExtLicenseFileName( $extDir ) {
1043 if ( !$extDir ) {
1044 return false;
1045 }
1046
1047 foreach ( scandir( $extDir ) as $file ) {
1048 $fullPath = $extDir . DIRECTORY_SEPARATOR . $file;
1049 if ( preg_match( '/^((COPYING)|(LICENSE))(\.txt)?$/', $file ) &&
1050 is_readable( $fullPath ) &&
1051 is_file( $fullPath )
1052 ) {
1053 return $fullPath;
1054 }
1055 }
1056
1057 return false;
1058 }
1059
1068 public function listToText( $list, $sort = true ) {
1069 if ( !count( $list ) ) {
1070 return '';
1071 }
1072 if ( $sort ) {
1073 sort( $list );
1074 }
1075
1076 return $this->getLanguage()
1077 ->listToText( array_map( [ __CLASS__, 'arrayToString' ], $list ) );
1078 }
1079
1088 public static function arrayToString( $list ) {
1089 if ( is_array( $list ) && count( $list ) == 1 ) {
1090 $list = $list[0];
1091 }
1092 if ( $list instanceof Closure ) {
1093 // Don't output stuff like "Closure$;1028376090#8$48499d94fe0147f7c633b365be39952b$"
1094 return 'Closure';
1095 } elseif ( is_object( $list ) ) {
1096 $class = wfMessage( 'parentheses' )->params( get_class( $list ) )->escaped();
1097
1098 return $class;
1099 } elseif ( !is_array( $list ) ) {
1100 return $list;
1101 } else {
1102 if ( is_object( $list[0] ) ) {
1103 $class = get_class( $list[0] );
1104 } else {
1105 $class = $list[0];
1106 }
1107
1108 return wfMessage( 'parentheses' )->params( "$class, {$list[1]}" )->escaped();
1109 }
1110 }
1111
1116 public static function getGitHeadSha1( $dir ) {
1117 $repo = new GitInfo( $dir );
1118
1119 return $repo->getHeadSHA1();
1120 }
1121
1126 public static function getGitCurrentBranch( $dir ) {
1127 $repo = new GitInfo( $dir );
1128 return $repo->getCurrentBranch();
1129 }
1130
1135 public function getEntryPointInfo() {
1137 $scriptPath = $wgScriptPath ?: "/";
1138 $entryPoints = [
1139 'version-entrypoints-articlepath' => $wgArticlePath,
1140 'version-entrypoints-scriptpath' => $scriptPath,
1141 'version-entrypoints-index-php' => wfScript( 'index' ),
1142 'version-entrypoints-api-php' => wfScript( 'api' ),
1143 'version-entrypoints-load-php' => wfScript( 'load' ),
1144 ];
1145
1146 $language = $this->getLanguage();
1147 $thAttribures = [
1148 'dir' => $language->getDir(),
1149 'lang' => $language->getHtmlCode()
1150 ];
1151 $out = Html::element(
1152 'h2',
1153 [ 'id' => 'mw-version-entrypoints' ],
1154 $this->msg( 'version-entrypoints' )->text()
1155 ) .
1156 Html::openElement( 'table',
1157 [
1158 'class' => 'wikitable plainlinks',
1159 'id' => 'mw-version-entrypoints-table',
1160 'dir' => 'ltr',
1161 'lang' => 'en'
1162 ]
1163 ) .
1164 Html::openElement( 'tr' ) .
1165 Html::element(
1166 'th',
1167 $thAttribures,
1168 $this->msg( 'version-entrypoints-header-entrypoint' )->text()
1169 ) .
1170 Html::element(
1171 'th',
1172 $thAttribures,
1173 $this->msg( 'version-entrypoints-header-url' )->text()
1174 ) .
1175 Html::closeElement( 'tr' );
1176
1177 foreach ( $entryPoints as $message => $value ) {
1179 $out .= Html::openElement( 'tr' ) .
1180 // ->plain() looks like it should be ->parse(), but this function
1181 // returns wikitext, not HTML, boo
1182 Html::rawElement( 'td', [], $this->msg( $message )->plain() ) .
1183 Html::rawElement( 'td', [], Html::rawElement( 'code', [], "[$url $value]" ) ) .
1184 Html::closeElement( 'tr' );
1185 }
1186
1187 $out .= Html::closeElement( 'table' );
1188
1189 return $out;
1190 }
1191
1192 protected function getGroupName() {
1193 return 'wiki';
1194 }
1195}
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
$wgVersion
MediaWiki version number.
$wgScriptPath
The path we should point to.
$wgSpecialVersionShowHooks
Show the contents of $wgHooks in Special:Version.
$wgExtensionCredits
An array of information about installed extensions keyed by their type.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfGetCache( $cacheType)
Get a specific cache object.
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
wfIsHHVM()
Check if we are running under HHVM.
$wgParser
Definition Setup.php:886
$wgLang
Definition Setup.php:875
$IP
Definition WebStart.php:41
Reads an installed.json file and provides accessors to get what is installed.
Marks HTML that shouldn't be escaped.
Definition HtmlArmor.php:28
static makeExternalLink( $url, $text, $escape=true, $linktype='', $attribs=[], $title=null)
Make an external link.
Definition Linker.php:842
Parent class for all special pages.
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
getOutput()
Get the OutputPage being used for this instance.
msg( $key)
Wrapper around wfMessage that sets the current context.
getRequest()
Get the WebRequest being used for this instance.
getPageTitle( $subpage=false)
Get a self-referential title object.
getLanguage()
Shortcut to get user's language.
MediaWiki Linker LinkRenderer null $linkRenderer
Give information about the version of MediaWiki, PHP, the DB and extensions.
static getVersionLinked()
Return a wikitext-formatted string of the MediaWiki version with a link to the Git SHA1 of head if av...
static getExtensionTypeName( $type)
Returns the internationalized name for an extension type.
IPInfo()
Get information about client's IP address.
static getGitHeadSha1( $dir)
getParserFunctionHooks()
Obtains a list of installed parser function hooks and the associated H2 header.
execute( $par)
main()
listToText( $list, $sort=true)
Convert an array of items into a list for display.
getEntryPointInfo()
Get the list of entry points and their URLs.
getWgHooks()
Generate wikitext showing hooks in $wgHooks.
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
listAuthors( $authors, $extName, $extDir)
Return a formatted unsorted list of authors.
$coreId
Stores the current rev id/SHA hash of MediaWiki core.
static softwareInformation()
Returns wiki text showing the third party software versions (apache, php, mysql).
getExtensionCategory( $type, $message)
Creates and returns the HTML for a single extension category.
static getVersionLinkedGit()
static getExtensionTypes()
Returns an array with the base extension types.
openExtType( $text=null, $name=null)
getCreditsForExtension( $type, array $extension)
Creates and formats a version line for a single extension.
static getwgVersionLinked()
static getExtLicenseFileName( $extDir)
Obtains the full path of an extensions copying or license file if one exists.
static getMediaWikiCredits()
Returns wiki text showing the license information.
getParserTags()
Obtains a list of installed parser tags and the associated H2 header.
static getExtAuthorsFileName( $extDir)
Obtains the full path of an extensions authors or credits file if one exists.
getSkinCredits()
Generate wikitext showing the name, URL, author and description of each skin.
getExtensionCredits()
Generate wikitext showing the name, URL, author and description of each extension.
compare( $a, $b)
Callback to sort extensions by type.
static getVersion( $flags='', $lang=null)
Return a string of the MediaWiki version with Git revision if available.
static getCopyrightAndAuthorList()
Get the "MediaWiki is copyright 2001-20xx by lots of cool guys" text.
getExternalLibraries()
Generate an HTML table for external libraries that are installed.
static getGitCurrentBranch( $dir)
static arrayToString( $list)
Convert an array or object to a string for display.
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
const CACHE_ANYTHING
Definition Defines.php:110
const PROTO_RELATIVE
Definition Defines.php:230
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 $out
Definition hooks.txt:855
either a plain
Definition hooks.txt:2054
if the prop value should be in the metadata multi language array format
Definition hooks.txt:1651
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
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 and may include noclasses & $html
Definition hooks.txt:2011
$wgHooks['ArticleShow'][]
Definition hooks.txt:108
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:271
$wgArticlePath
Definition img_auth.php:46
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
$cache
Definition mcc.php:33
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))
$sort
const DB_REPLICA
Definition defines.php:25
if(!is_readable( $file)) $ext
Definition router.php:48
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition router.php:42
if(!isset( $args[0])) $lang