3 * Implements Special:Version
5 * Copyright © 2005 Ævar Arnfjörð Bjarmason
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * http://www.gnu.org/copyleft/gpl.html
23 * @ingroup SpecialPage
27 * Give information about the version of MediaWiki, PHP, the DB and extensions
29 * @ingroup SpecialPage
31 class SpecialVersion
extends SpecialPage
{
32 protected $firstExtOpened = false;
35 * Stores the current rev id/SHA hash of MediaWiki core
37 protected $coreId = '';
39 protected static $extensionTypes = false;
41 public function __construct() {
42 parent
::__construct( 'Version' );
47 * @param string|null $par
49 public function execute( $par ) {
50 global $IP, $wgExtensionCredits;
53 $this->outputHeader();
54 $out = $this->getOutput();
55 $out->allowClickjacking();
57 // Explode the sub page information into useful bits
58 $parts = explode( '/', (string)$par );
60 if ( isset( $parts[1] ) ) {
61 $extName = str_replace( '_', ' ', $parts[1] );
63 foreach ( $wgExtensionCredits as $group => $extensions ) {
64 foreach ( $extensions as $ext ) {
65 if ( isset( $ext['name'] ) && ( $ext['name'] === $extName ) ) {
72 $out->setStatusCode( 404 );
75 $extName = 'MediaWiki';
78 // Now figure out what to do
79 switch ( strtolower( $parts[0] ) ) {
81 $out->addModuleStyles( 'mediawiki.special.version' );
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>' ],
91 } elseif ( ( $extNode !== null ) && isset( $extNode['path'] ) ) {
92 $file = $this->getExtAuthorsFileName( dirname( $extNode['path'] ) );
94 $wikiText = file_get_contents( $file );
95 if ( substr( $file, -4 ) === '.txt' ) {
96 $wikiText = Html
::element(
108 $out->setPageTitle( $this->msg( 'version-credits-title', $extName ) );
109 $out->addWikiText( $wikiText );
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'] ) );
119 $wikiText = file_get_contents( $file );
120 $wikiText = Html
::element(
131 $out->setPageTitle( $this->msg( 'version-license-title', $extName ) );
132 $out->addWikiText( $wikiText );
136 $out->addModuleStyles( 'mediawiki.special.version' );
138 $this->getMediaWikiCredits() .
139 $this->softwareInformation() .
140 $this->getEntryPointInfo()
143 $this->getSkinCredits() .
144 $this->getExtensionCredits() .
145 $this->getExternalLibraries() .
146 $this->getParserTags() .
147 $this->getParserFunctionHooks()
149 $out->addWikiText( $this->getWgHooks() );
150 $out->addHTML( $this->IPInfo() );
157 * Returns wiki text showing the license information.
161 private static function getMediaWikiCredits() {
164 [ 'id' => 'mw-version-license' ],
165 wfMessage( 'version-license' )->text()
168 // This text is always left-to-right.
169 $ret .= '<div class="plainlinks">';
171 " . self
::getCopyrightAndAuthorList() . "\n
172 " . wfMessage( 'version-license-info' )->text();
175 return str_replace( "\t\t", '', $ret ) . "\n";
179 * Get the "MediaWiki is copyright 2001-20xx by lots of cool guys" text
183 public static function getCopyrightAndAuthorList() {
186 if ( defined( 'MEDIAWIKI_INSTALL' ) ) {
187 $othersLink = '[https://www.mediawiki.org/wiki/Special:Version/Credits ' .
188 wfMessage( 'version-poweredby-others' )->text() . ']';
190 $othersLink = '[[Special:Version/Credits|' .
191 wfMessage( 'version-poweredby-others' )->text() . ']]';
194 $translatorsLink = '[https://translatewiki.net/wiki/Translating:MediaWiki/Credits ' .
195 wfMessage( 'version-poweredby-translators' )->text() . ']';
198 'Magnus Manske', 'Brion Vibber', 'Lee Daniel Crocker',
199 'Tim Starling', 'Erik Möller', 'Gabriel Wicke', 'Ævar Arnfjörð Bjarmason',
200 'Niklas Laxström', 'Domas Mituzas', 'Rob Church', 'Yuri Astrakhan',
201 'Aryeh Gregor', 'Aaron Schulz', 'Andrew Garrett', 'Raimond Spekking',
202 'Alexandre Emsenhuber', 'Siebrand Mazeland', 'Chad Horohoe',
203 'Roan Kattouw', 'Trevor Parscal', 'Bryan Tong Minh', 'Sam Reed',
204 'Victor Vasiliev', 'Rotem Liss', 'Platonides', 'Antoine Musso',
205 'Timo Tijhof', 'Daniel Kinzler', 'Jeroen De Dauw', 'Brad Jorsch',
206 'Bartosz Dziewoński', 'Ed Sanders', 'Moriel Schottlender',
207 $othersLink, $translatorsLink
210 return wfMessage( 'version-poweredby-credits', MWTimestamp
::getLocalInstance()->format( 'Y' ),
211 $wgLang->listToText( $authorList ) )->text();
215 * Returns wiki text showing the third party software versions (apache, php, mysql).
219 public static function softwareInformation() {
220 $dbr = wfGetDB( DB_REPLICA
);
222 // Put the software in an array of form 'name' => 'version'. All messages should
223 // be loaded here, so feel free to use wfMessage in the 'name'. Raw HTML or
224 // wikimarkup can be used.
226 $software['[https://www.mediawiki.org/ MediaWiki]'] = self
::getVersionLinked();
228 $software['[http://hhvm.com/ HHVM]'] = HHVM_VERSION
. " (" . PHP_SAPI
. ")";
230 $software['[https://php.net/ PHP]'] = PHP_VERSION
. " (" . PHP_SAPI
. ")";
232 $software[$dbr->getSoftwareLink()] = $dbr->getServerInfo();
234 if ( IcuCollation
::getICUVersion() ) {
235 $software['[http://site.icu-project.org/ ICU]'] = IcuCollation
::getICUVersion();
238 // Allow a hook to add/remove items.
239 Hooks
::run( 'SoftwareInfo', [ &$software ] );
243 [ 'id' => 'mw-version-software' ],
244 wfMessage( 'version-software' )->text()
246 Xml
::openElement( 'table', [ 'class' => 'wikitable plainlinks', 'id' => 'sv-software' ] ) .
248 <th>" . wfMessage( 'version-software-product' )->text() . "</th>
249 <th>" . wfMessage( 'version-software-version' )->text() . "</th>
252 foreach ( $software as $name => $version ) {
254 <td>" . $name . "</td>
255 <td dir=\"ltr\">" . $version . "</td>
259 return $out . Xml
::closeElement( 'table' );
263 * Return a string of the MediaWiki version with Git revision if available.
265 * @param string $flags
266 * @param Language|string|null $lang
269 public static function getVersion( $flags = '', $lang = null ) {
270 global $wgVersion, $IP;
272 $gitInfo = self
::getGitHeadSha1( $IP );
274 $version = $wgVersion;
275 } elseif ( $flags === 'nodb' ) {
276 $shortSha1 = substr( $gitInfo, 0, 7 );
277 $version = "$wgVersion ($shortSha1)";
279 $shortSha1 = substr( $gitInfo, 0, 7 );
280 $msg = wfMessage( 'parentheses' );
281 if ( $lang !== null ) {
282 $msg->inLanguage( $lang );
284 $shortSha1 = $msg->params( $shortSha1 )->escaped();
285 $version = "$wgVersion $shortSha1";
292 * Return a wikitext-formatted string of the MediaWiki version with a link to
293 * the Git SHA1 of head if available.
294 * The fallback is just $wgVersion
298 public static function getVersionLinked() {
301 $gitVersion = self
::getVersionLinkedGit();
305 $v = $wgVersion; // fallback
314 private static function getwgVersionLinked() {
317 if ( Hooks
::run( 'SpecialVersionVersionUrl', [ $wgVersion, &$versionUrl ] ) ) {
319 preg_match( "/^(\d+\.\d+)/", $wgVersion, $versionParts );
320 $versionUrl = "https://www.mediawiki.org/wiki/MediaWiki_{$versionParts[1]}";
323 return "[$versionUrl $wgVersion]";
327 * @since 1.22 Returns the HEAD date in addition to the sha1 and link
328 * @return bool|string Global wgVersion + HEAD sha1 stripped to the first 7 chars
329 * with link and date, or false on failure
331 private static function getVersionLinkedGit() {
334 $gitInfo = new GitInfo( $IP );
335 $headSHA1 = $gitInfo->getHeadSHA1();
340 $shortSHA1 = '(' . substr( $headSHA1, 0, 7 ) . ')';
342 $gitHeadUrl = $gitInfo->getHeadViewUrl();
343 if ( $gitHeadUrl !== false ) {
344 $shortSHA1 = "[$gitHeadUrl $shortSHA1]";
347 $gitHeadCommitDate = $gitInfo->getHeadCommitDate();
348 if ( $gitHeadCommitDate ) {
349 $shortSHA1 .= Html
::element( 'br' ) . $wgLang->timeanddate( $gitHeadCommitDate, true );
352 return self
::getwgVersionLinked() . " $shortSHA1";
356 * Returns an array with the base extension types.
357 * Type is stored as array key, the message as array value.
359 * TODO: ideally this would return all extension types.
365 public static function getExtensionTypes() {
366 if ( self
::$extensionTypes === false ) {
367 self
::$extensionTypes = [
368 'specialpage' => wfMessage( 'version-specialpages' )->text(),
369 'parserhook' => wfMessage( 'version-parserhooks' )->text(),
370 'variable' => wfMessage( 'version-variables' )->text(),
371 'media' => wfMessage( 'version-mediahandlers' )->text(),
372 'antispam' => wfMessage( 'version-antispam' )->text(),
373 'skin' => wfMessage( 'version-skins' )->text(),
374 'api' => wfMessage( 'version-api' )->text(),
375 'other' => wfMessage( 'version-other' )->text(),
378 Hooks
::run( 'ExtensionTypes', [ &self
::$extensionTypes ] );
381 return self
::$extensionTypes;
385 * Returns the internationalized name for an extension type.
389 * @param string $type
393 public static function getExtensionTypeName( $type ) {
394 $types = self
::getExtensionTypes();
396 return isset( $types[$type] ) ?
$types[$type] : $types['other'];
400 * Generate wikitext showing the name, URL, author and description of each extension.
402 * @return string Wikitext
404 public function getExtensionCredits() {
405 global $wgExtensionCredits;
408 count( $wgExtensionCredits ) === 0 ||
409 // Skins are displayed separately, see getSkinCredits()
410 ( count( $wgExtensionCredits ) === 1 && isset( $wgExtensionCredits['skin'] ) )
415 $extensionTypes = self
::getExtensionTypes();
419 [ 'id' => 'mw-version-ext' ],
420 $this->msg( 'version-extensions' )->text()
422 Xml
::openElement( 'table', [ 'class' => 'wikitable plainlinks', 'id' => 'sv-ext' ] );
424 // Make sure the 'other' type is set to an array.
425 if ( !array_key_exists( 'other', $wgExtensionCredits ) ) {
426 $wgExtensionCredits['other'] = [];
429 // Find all extensions that do not have a valid type and give them the type 'other'.
430 foreach ( $wgExtensionCredits as $type => $extensions ) {
431 if ( !array_key_exists( $type, $extensionTypes ) ) {
432 $wgExtensionCredits['other'] = array_merge( $wgExtensionCredits['other'], $extensions );
436 $this->firstExtOpened
= false;
437 // Loop through the extension categories to display their extensions in the list.
438 foreach ( $extensionTypes as $type => $message ) {
439 // Skins have a separate section
440 if ( $type !== 'other' && $type !== 'skin' ) {
441 $out .= $this->getExtensionCategory( $type, $message );
445 // We want the 'other' type to be last in the list.
446 $out .= $this->getExtensionCategory( 'other', $extensionTypes['other'] );
448 $out .= Xml
::closeElement( 'table' );
454 * Generate wikitext showing the name, URL, author and description of each skin.
456 * @return string Wikitext
458 public function getSkinCredits() {
459 global $wgExtensionCredits;
460 if ( !isset( $wgExtensionCredits['skin'] ) ||
count( $wgExtensionCredits['skin'] ) === 0 ) {
466 [ 'id' => 'mw-version-skin' ],
467 $this->msg( 'version-skins' )->text()
469 Xml
::openElement( 'table', [ 'class' => 'wikitable plainlinks', 'id' => 'sv-skin' ] );
471 $this->firstExtOpened
= false;
472 $out .= $this->getExtensionCategory( 'skin', null );
474 $out .= Xml
::closeElement( 'table' );
480 * Generate an HTML table for external libraries that are installed
484 protected function getExternalLibraries() {
486 $path = "$IP/vendor/composer/installed.json";
487 if ( !file_exists( $path ) ) {
491 $installed = new ComposerInstalled( $path );
492 $out = Html
::element(
494 [ 'id' => 'mw-version-libraries' ],
495 $this->msg( 'version-libraries' )->text()
497 $out .= Html
::openElement(
499 [ 'class' => 'wikitable plainlinks', 'id' => 'sv-libraries' ]
501 $out .= Html
::openElement( 'tr' )
502 . Html
::element( 'th', [], $this->msg( 'version-libraries-library' )->text() )
503 . Html
::element( 'th', [], $this->msg( 'version-libraries-version' )->text() )
504 . Html
::element( 'th', [], $this->msg( 'version-libraries-license' )->text() )
505 . Html
::element( 'th', [], $this->msg( 'version-libraries-description' )->text() )
506 . Html
::element( 'th', [], $this->msg( 'version-libraries-authors' )->text() )
507 . Html
::closeElement( 'tr' );
509 foreach ( $installed->getInstalledDependencies() as $name => $info ) {
510 if ( strpos( $info['type'], 'mediawiki-' ) === 0 ) {
511 // Skip any extensions or skins since they'll be listed
512 // in their proper section
515 $authors = array_map( function ( $arr ) {
516 // If a homepage is set, link to it
517 if ( isset( $arr['homepage'] ) ) {
518 return "[{$arr['homepage']} {$arr['name']}]";
521 }, $info['authors'] );
522 $authors = $this->listAuthors( $authors, false, "$IP/vendor/$name" );
524 // We can safely assume that the libraries' names and descriptions
525 // are written in English and aren't going to be translated,
526 // so set appropriate lang and dir attributes
527 $out .= Html
::openElement( 'tr' )
531 Linker
::makeExternalLink(
532 "https://packagist.org/packages/$name", $name,
534 [ 'class' => 'mw-version-library-name' ]
537 . Html
::element( 'td', [ 'dir' => 'auto' ], $info['version'] )
538 . Html
::element( 'td', [ 'dir' => 'auto' ], $this->listToText( $info['licenses'] ) )
539 . Html
::element( 'td', [ 'lang' => 'en', 'dir' => 'ltr' ], $info['description'] )
540 . Html
::rawElement( 'td', [], $authors )
541 . Html
::closeElement( 'tr' );
543 $out .= Html
::closeElement( 'table' );
549 * Obtains a list of installed parser tags and the associated H2 header
551 * @return string HTML output
553 protected function getParserTags() {
556 $tags = $wgParser->getTags();
558 if ( count( $tags ) ) {
559 $out = Html
::rawElement(
562 'class' => 'mw-headline plainlinks',
563 'id' => 'mw-version-parser-extensiontags',
565 Linker
::makeExternalLink(
566 'https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Tag_extensions',
567 $this->msg( 'version-parser-extensiontags' )->parse(),
568 false /* msg()->parse() already escapes */
572 array_walk( $tags, function ( &$value ) {
573 // Bidirectional isolation improves readability in RTL wikis
574 $value = Html
::element(
576 // Prevent < and > from slipping to another line
578 'style' => 'white-space: nowrap;',
584 $out .= $this->listToText( $tags );
593 * Obtains a list of installed parser function hooks and the associated H2 header
595 * @return string HTML output
597 protected function getParserFunctionHooks() {
600 $fhooks = $wgParser->getFunctionHooks();
601 if ( count( $fhooks ) ) {
602 $out = Html
::rawElement(
605 'class' => 'mw-headline plainlinks',
606 'id' => 'mw-version-parser-function-hooks',
608 Linker
::makeExternalLink(
609 'https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Parser_functions',
610 $this->msg( 'version-parser-function-hooks' )->parse(),
611 false /* msg()->parse() already escapes */
615 $out .= $this->listToText( $fhooks );
624 * Creates and returns the HTML for a single extension category.
628 * @param string $type
629 * @param string $message
633 protected function getExtensionCategory( $type, $message ) {
634 global $wgExtensionCredits;
638 if ( array_key_exists( $type, $wgExtensionCredits ) && count( $wgExtensionCredits[$type] ) > 0 ) {
639 $out .= $this->openExtType( $message, 'credits-' . $type );
641 usort( $wgExtensionCredits[$type], [ $this, 'compare' ] );
643 foreach ( $wgExtensionCredits[$type] as $extension ) {
644 $out .= $this->getCreditsForExtension( $type, $extension );
652 * Callback to sort extensions by type.
657 public function compare( $a, $b ) {
658 if ( $a['name'] === $b['name'] ) {
661 return $this->getLanguage()->lc( $a['name'] ) > $this->getLanguage()->lc( $b['name'] )
668 * Creates and formats a version line for a single extension.
670 * Information for five columns will be created. Parameters required in the
671 * $extension array for part rendering are indicated in ()
672 * - The name of (name), and URL link to (url), the extension
673 * - Official version number (version) and if available version control system
674 * revision (path), link, and date
675 * - If available the short name of the license (license-name) and a link
676 * to ((LICENSE)|(COPYING))(\.txt)? if it exists.
677 * - Description of extension (descriptionmsg or description)
678 * - List of authors (author) and link to a ((AUTHORS)|(CREDITS))(\.txt)? file if it exists
680 * @param string $type Category name of the extension
681 * @param array $extension
683 * @return string Raw HTML
685 public function getCreditsForExtension( $type, array $extension ) {
686 $out = $this->getOutput();
688 // We must obtain the information for all the bits and pieces!
689 // ... such as extension names and links
690 if ( isset( $extension['namemsg'] ) ) {
691 // Localized name of extension
692 $extensionName = $this->msg( $extension['namemsg'] )->text();
693 } elseif ( isset( $extension['name'] ) ) {
694 // Non localized version
695 $extensionName = $extension['name'];
697 $extensionName = $this->msg( 'version-no-ext-name' )->text();
700 if ( isset( $extension['url'] ) ) {
701 $extensionNameLink = Linker
::makeExternalLink(
706 [ 'class' => 'mw-version-ext-name' ]
709 $extensionNameLink = $extensionName;
712 // ... and the version information
713 // If the extension path is set we will check that directory for GIT
714 // metadata in an attempt to extract date and vcs commit metadata.
715 $canonicalVersion = '–';
716 $extensionPath = null;
721 if ( isset( $extension['version'] ) ) {
722 $canonicalVersion = $out->parseInline( $extension['version'] );
725 if ( isset( $extension['path'] ) ) {
727 $extensionPath = dirname( $extension['path'] );
728 if ( $this->coreId
== '' ) {
729 wfDebug( 'Looking up core head id' );
730 $coreHeadSHA1 = self
::getGitHeadSha1( $IP );
731 if ( $coreHeadSHA1 ) {
732 $this->coreId
= $coreHeadSHA1;
735 $cache = wfGetCache( CACHE_ANYTHING
);
736 $memcKey = $cache->makeKey(
737 'specialversion-ext-version-text', $extension['path'], $this->coreId
739 list( $vcsVersion, $vcsLink, $vcsDate ) = $cache->get( $memcKey );
741 if ( !$vcsVersion ) {
742 wfDebug( "Getting VCS info for extension {$extension['name']}" );
743 $gitInfo = new GitInfo( $extensionPath );
744 $vcsVersion = $gitInfo->getHeadSHA1();
745 if ( $vcsVersion !== false ) {
746 $vcsVersion = substr( $vcsVersion, 0, 7 );
747 $vcsLink = $gitInfo->getHeadViewUrl();
748 $vcsDate = $gitInfo->getHeadCommitDate();
750 $cache->set( $memcKey, [ $vcsVersion, $vcsLink, $vcsDate ], 60 * 60 * 24 );
752 wfDebug( "Pulled VCS info for extension {$extension['name']} from cache" );
756 $versionString = Html
::rawElement(
758 [ 'class' => 'mw-version-ext-version' ],
764 $vcsVerString = Linker
::makeExternalLink(
766 $this->msg( 'version-version', $vcsVersion ),
769 [ 'class' => 'mw-version-ext-vcs-version' ]
772 $vcsVerString = Html
::element( 'span',
773 [ 'class' => 'mw-version-ext-vcs-version' ],
777 $versionString .= " {$vcsVerString}";
780 $vcsTimeString = Html
::element( 'span',
781 [ 'class' => 'mw-version-ext-vcs-timestamp' ],
782 $this->getLanguage()->timeanddate( $vcsDate, true )
784 $versionString .= " {$vcsTimeString}";
786 $versionString = Html
::rawElement( 'span',
787 [ 'class' => 'mw-version-ext-meta-version' ],
792 // ... and license information; if a license file exists we
795 if ( isset( $extension['name'] ) ) {
797 if ( isset( $extension['license-name'] ) ) {
798 $licenseName = new HtmlArmor( $out->parseInline( $extension['license-name'] ) );
799 } elseif ( $this->getExtLicenseFileName( $extensionPath ) ) {
800 $licenseName = $this->msg( 'version-ext-license' )->text();
802 if ( $licenseName !== null ) {
803 $licenseLink = $this->getLinkRenderer()->makeLink(
804 $this->getPageTitle( 'License/' . $extension['name'] ),
807 'class' => 'mw-version-ext-license',
814 // ... and generate the description; which can be a parameterized l10n message
815 // in the form array( <msgname>, <parameter>, <parameter>... ) or just a straight
817 if ( isset( $extension['descriptionmsg'] ) ) {
818 // Localized description of extension
819 $descriptionMsg = $extension['descriptionmsg'];
821 if ( is_array( $descriptionMsg ) ) {
822 $descriptionMsgKey = $descriptionMsg[0]; // Get the message key
823 array_shift( $descriptionMsg ); // Shift out the message key to get the parameters only
824 array_map( "htmlspecialchars", $descriptionMsg ); // For sanity
825 $description = $this->msg( $descriptionMsgKey, $descriptionMsg )->text();
827 $description = $this->msg( $descriptionMsg )->text();
829 } elseif ( isset( $extension['description'] ) ) {
830 // Non localized version
831 $description = $extension['description'];
835 $description = $out->parseInline( $description );
837 // ... now get the authors for this extension
838 $authors = isset( $extension['author'] ) ?
$extension['author'] : [];
839 $authors = $this->listAuthors( $authors, $extension['name'], $extensionPath );
841 // Finally! Create the table
842 $html = Html
::openElement( 'tr', [
843 'class' => 'mw-version-ext',
844 'id' => Sanitizer
::escapeIdForAttribute( 'mw-version-ext-' . $type . '-' . $extension['name'] )
848 $html .= Html
::rawElement( 'td', [], $extensionNameLink );
849 $html .= Html
::rawElement( 'td', [], $versionString );
850 $html .= Html
::rawElement( 'td', [], $licenseLink );
851 $html .= Html
::rawElement( 'td', [ 'class' => 'mw-version-ext-description' ], $description );
852 $html .= Html
::rawElement( 'td', [ 'class' => 'mw-version-ext-authors' ], $authors );
854 $html .= Html
::closeElement( 'tr' );
860 * Generate wikitext showing hooks in $wgHooks.
862 * @return string Wikitext
864 private function getWgHooks() {
865 global $wgSpecialVersionShowHooks, $wgHooks;
867 if ( $wgSpecialVersionShowHooks && count( $wgHooks ) ) {
868 $myWgHooks = $wgHooks;
872 $ret[] = '== {{int:version-hooks}} ==';
873 $ret[] = Html
::openElement( 'table', [ 'class' => 'wikitable', 'id' => 'sv-hooks' ] );
874 $ret[] = Html
::openElement( 'tr' );
875 $ret[] = Html
::element( 'th', [], $this->msg( 'version-hook-name' )->text() );
876 $ret[] = Html
::element( 'th', [], $this->msg( 'version-hook-subscribedby' )->text() );
877 $ret[] = Html
::closeElement( 'tr' );
879 foreach ( $myWgHooks as $hook => $hooks ) {
880 $ret[] = Html
::openElement( 'tr' );
881 $ret[] = Html
::element( 'td', [], $hook );
882 $ret[] = Html
::element( 'td', [], $this->listToText( $hooks ) );
883 $ret[] = Html
::closeElement( 'tr' );
886 $ret[] = Html
::closeElement( 'table' );
888 return implode( "\n", $ret );
894 private function openExtType( $text = null, $name = null ) {
897 $opt = [ 'colspan' => 5 ];
898 if ( $this->firstExtOpened
) {
899 // Insert a spacing line
900 $out .= Html
::rawElement( 'tr', [ 'class' => 'sv-space' ],
901 Html
::element( 'td', $opt )
904 $this->firstExtOpened
= true;
907 $opt['id'] = "sv-$name";
910 if ( $text !== null ) {
911 $out .= Html
::rawElement( 'tr', [],
912 Html
::element( 'th', $opt, $text )
916 $firstHeadingMsg = ( $name === 'credits-skin' )
917 ?
'version-skin-colheader-name'
918 : 'version-ext-colheader-name';
919 $out .= Html
::openElement( 'tr' );
920 $out .= Html
::element( 'th', [ 'class' => 'mw-version-ext-col-label' ],
921 $this->msg( $firstHeadingMsg )->text() );
922 $out .= Html
::element( 'th', [ 'class' => 'mw-version-ext-col-label' ],
923 $this->msg( 'version-ext-colheader-version' )->text() );
924 $out .= Html
::element( 'th', [ 'class' => 'mw-version-ext-col-label' ],
925 $this->msg( 'version-ext-colheader-license' )->text() );
926 $out .= Html
::element( 'th', [ 'class' => 'mw-version-ext-col-label' ],
927 $this->msg( 'version-ext-colheader-description' )->text() );
928 $out .= Html
::element( 'th', [ 'class' => 'mw-version-ext-col-label' ],
929 $this->msg( 'version-ext-colheader-credits' )->text() );
930 $out .= Html
::closeElement( 'tr' );
936 * Get information about client's IP address.
938 * @return string HTML fragment
940 private function IPInfo() {
941 $ip = str_replace( '--', ' - ', htmlspecialchars( $this->getRequest()->getIP() ) );
943 return "<!-- visited from $ip -->\n<span style='display:none'>visited from $ip</span>";
947 * Return a formatted unsorted list of authors
950 * If an item in the $authors array is '...' it is assumed to indicate an
951 * 'and others' string which will then be linked to an ((AUTHORS)|(CREDITS))(\.txt)?
952 * file if it exists in $dir.
954 * Similarly an entry ending with ' ...]' is assumed to be a link to an
957 * If no '...' string variant is found, but an authors file is found an
958 * 'and others' will be added to the end of the credits.
960 * @param string|array $authors
961 * @param string|bool $extName Name of the extension for link creation,
962 * false if no links should be created
963 * @param string $extDir Path to the extension root directory
965 * @return string HTML fragment
967 public function listAuthors( $authors, $extName, $extDir ) {
969 $linkRenderer = $this->getLinkRenderer();
972 foreach ( (array)$authors as $item ) {
973 if ( $item == '...' ) {
976 if ( $extName && $this->getExtAuthorsFileName( $extDir ) ) {
977 $text = $linkRenderer->makeLink(
978 $this->getPageTitle( "Credits/$extName" ),
979 $this->msg( 'version-poweredby-others' )->text()
982 $text = $this->msg( 'version-poweredby-others' )->escaped();
985 } elseif ( substr( $item, -5 ) == ' ...]' ) {
987 $list[] = $this->getOutput()->parseInline(
988 substr( $item, 0, -4 ) . $this->msg( 'version-poweredby-others' )->text() . "]"
991 $list[] = $this->getOutput()->parseInline( $item );
995 if ( $extName && !$hasOthers && $this->getExtAuthorsFileName( $extDir ) ) {
996 $list[] = $text = $linkRenderer->makeLink(
997 $this->getPageTitle( "Credits/$extName" ),
998 $this->msg( 'version-poweredby-others' )->text()
1002 return $this->listToText( $list, false );
1006 * Obtains the full path of an extensions authors or credits file if
1009 * @param string $extDir Path to the extensions root directory
1013 * @return bool|string False if no such file exists, otherwise returns
1016 public static function getExtAuthorsFileName( $extDir ) {
1021 foreach ( scandir( $extDir ) as $file ) {
1022 $fullPath = $extDir . DIRECTORY_SEPARATOR
. $file;
1023 if ( preg_match( '/^((AUTHORS)|(CREDITS))(\.txt|\.wiki|\.mediawiki)?$/', $file ) &&
1024 is_readable( $fullPath ) &&
1025 is_file( $fullPath )
1035 * Obtains the full path of an extensions copying or license file if
1038 * @param string $extDir Path to the extensions root directory
1042 * @return bool|string False if no such file exists, otherwise returns
1045 public static function getExtLicenseFileName( $extDir ) {
1050 foreach ( scandir( $extDir ) as $file ) {
1051 $fullPath = $extDir . DIRECTORY_SEPARATOR
. $file;
1052 if ( preg_match( '/^((COPYING)|(LICENSE))(\.txt)?$/', $file ) &&
1053 is_readable( $fullPath ) &&
1054 is_file( $fullPath )
1064 * Convert an array of items into a list for display.
1066 * @param array $list List of elements to display
1067 * @param bool $sort Whether to sort the items in $list
1071 public function listToText( $list, $sort = true ) {
1072 if ( !count( $list ) ) {
1079 return $this->getLanguage()
1080 ->listToText( array_map( [ __CLASS__
, 'arrayToString' ], $list ) );
1084 * Convert an array or object to a string for display.
1086 * @param mixed $list Will convert an array to string if given and return
1087 * the parameter unaltered otherwise
1091 public static function arrayToString( $list ) {
1092 if ( is_array( $list ) && count( $list ) == 1 ) {
1095 if ( $list instanceof Closure
) {
1096 // Don't output stuff like "Closure$;1028376090#8$48499d94fe0147f7c633b365be39952b$"
1098 } elseif ( is_object( $list ) ) {
1099 $class = wfMessage( 'parentheses' )->params( get_class( $list ) )->escaped();
1102 } elseif ( !is_array( $list ) ) {
1105 if ( is_object( $list[0] ) ) {
1106 $class = get_class( $list[0] );
1111 return wfMessage( 'parentheses' )->params( "$class, {$list[1]}" )->escaped();
1116 * @param string $dir Directory of the git checkout
1117 * @return bool|string Sha1 of commit HEAD points to
1119 public static function getGitHeadSha1( $dir ) {
1120 $repo = new GitInfo( $dir );
1122 return $repo->getHeadSHA1();
1126 * @param string $dir Directory of the git checkout
1127 * @return bool|string Branch currently checked out
1129 public static function getGitCurrentBranch( $dir ) {
1130 $repo = new GitInfo( $dir );
1131 return $repo->getCurrentBranch();
1135 * Get the list of entry points and their URLs
1136 * @return string Wikitext
1138 public function getEntryPointInfo() {
1139 global $wgArticlePath, $wgScriptPath;
1140 $scriptPath = $wgScriptPath ?
$wgScriptPath : "/";
1142 'version-entrypoints-articlepath' => $wgArticlePath,
1143 'version-entrypoints-scriptpath' => $scriptPath,
1144 'version-entrypoints-index-php' => wfScript( 'index' ),
1145 'version-entrypoints-api-php' => wfScript( 'api' ),
1146 'version-entrypoints-load-php' => wfScript( 'load' ),
1149 $language = $this->getLanguage();
1151 'dir' => $language->getDir(),
1152 'lang' => $language->getHtmlCode()
1154 $out = Html
::element(
1156 [ 'id' => 'mw-version-entrypoints' ],
1157 $this->msg( 'version-entrypoints' )->text()
1159 Html
::openElement( 'table',
1161 'class' => 'wikitable plainlinks',
1162 'id' => 'mw-version-entrypoints-table',
1167 Html
::openElement( 'tr' ) .
1171 $this->msg( 'version-entrypoints-header-entrypoint' )->text()
1176 $this->msg( 'version-entrypoints-header-url' )->text()
1178 Html
::closeElement( 'tr' );
1180 foreach ( $entryPoints as $message => $value ) {
1181 $url = wfExpandUrl( $value, PROTO_RELATIVE
);
1182 $out .= Html
::openElement( 'tr' ) .
1183 // ->text() looks like it should be ->parse(), but this function
1184 // returns wikitext, not HTML, boo
1185 Html
::rawElement( 'td', [], $this->msg( $message )->text() ) .
1186 Html
::rawElement( 'td', [], Html
::rawElement( 'code', [], "[$url $value]" ) ) .
1187 Html
::closeElement( 'tr' );
1190 $out .= Html
::closeElement( 'table' );
1195 protected function getGroupName() {