Expose $wgMaxArticleSize in siteinfo query api
[mediawiki.git] / includes / specials / SpecialVersion.php
blob6f71a51e276b491788cc28754fe9fa88ba7f8b67
1 <?php
2 /**
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
22 * @file
23 * @ingroup SpecialPage
26 /**
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;
34 /**
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' );
45 /**
46 * main()
47 * @param string|null $par
49 public function execute( $par ) {
50 global $IP, $wgExtensionCredits;
52 $this->setHeaders();
53 $this->outputHeader();
54 $out = $this->getOutput();
55 $out->allowClickjacking();
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;
71 if ( !$extNode ) {
72 $out->setStatusCode( 404 );
74 } else {
75 $extName = 'MediaWiki';
78 // Now figure out what to do
79 switch ( strtolower( $parts[0] ) ) {
80 case 'credits':
81 $wikiText = '{{int:version-credits-not-found}}';
82 if ( $extName === 'MediaWiki' ) {
83 $wikiText = file_get_contents( $IP . '/CREDITS' );
84 } elseif ( ( $extNode !== null ) && isset( $extNode['path'] ) ) {
85 $file = $this->getExtAuthorsFileName( dirname( $extNode['path'] ) );
86 if ( $file ) {
87 $wikiText = file_get_contents( $file );
88 if ( substr( $file, -4 ) === '.txt' ) {
89 $wikiText = Html::element(
90 'pre',
92 'lang' => 'en',
93 'dir' => 'ltr',
95 $wikiText
101 $out->setPageTitle( $this->msg( 'version-credits-title', $extName ) );
102 $out->addWikiText( $wikiText );
103 break;
105 case 'license':
106 $wikiText = '{{int:version-license-not-found}}';
107 if ( $extName === 'MediaWiki' ) {
108 $wikiText = file_get_contents( $IP . '/COPYING' );
109 } elseif ( ( $extNode !== null ) && isset( $extNode['path'] ) ) {
110 $file = $this->getExtLicenseFileName( dirname( $extNode['path'] ) );
111 if ( $file ) {
112 $wikiText = file_get_contents( $file );
113 $wikiText = Html::element(
114 'pre',
116 'lang' => 'en',
117 'dir' => 'ltr',
119 $wikiText
124 $out->setPageTitle( $this->msg( 'version-license-title', $extName ) );
125 $out->addWikiText( $wikiText );
126 break;
128 default:
129 $out->addModuleStyles( 'mediawiki.special.version' );
130 $out->addWikiText(
131 $this->getMediaWikiCredits() .
132 $this->softwareInformation() .
133 $this->getEntryPointInfo()
135 $out->addHTML(
136 $this->getSkinCredits() .
137 $this->getExtensionCredits() .
138 $this->getExternalLibraries() .
139 $this->getParserTags() .
140 $this->getParserFunctionHooks()
142 $out->addWikiText( $this->getWgHooks() );
143 $out->addHTML( $this->IPInfo() );
145 break;
150 * Returns wiki text showing the license information.
152 * @return string
154 private static function getMediaWikiCredits() {
155 $ret = Xml::element(
156 'h2',
157 [ 'id' => 'mw-version-license' ],
158 wfMessage( 'version-license' )->text()
161 // This text is always left-to-right.
162 $ret .= '<div class="plainlinks">';
163 $ret .= "__NOTOC__
164 " . self::getCopyrightAndAuthorList() . "\n
165 " . wfMessage( 'version-license-info' )->text();
166 $ret .= '</div>';
168 return str_replace( "\t\t", '', $ret ) . "\n";
172 * Get the "MediaWiki is copyright 2001-20xx by lots of cool guys" text
174 * @return string
176 public static function getCopyrightAndAuthorList() {
177 global $wgLang;
179 if ( defined( 'MEDIAWIKI_INSTALL' ) ) {
180 $othersLink = '[https://www.mediawiki.org/wiki/Special:Version/Credits ' .
181 wfMessage( 'version-poweredby-others' )->text() . ']';
182 } else {
183 $othersLink = '[[Special:Version/Credits|' .
184 wfMessage( 'version-poweredby-others' )->text() . ']]';
187 $translatorsLink = '[https://translatewiki.net/wiki/Translating:MediaWiki/Credits ' .
188 wfMessage( 'version-poweredby-translators' )->text() . ']';
190 $authorList = [
191 'Magnus Manske', 'Brion Vibber', 'Lee Daniel Crocker',
192 'Tim Starling', 'Erik Möller', 'Gabriel Wicke', 'Ævar Arnfjörð Bjarmason',
193 'Niklas Laxström', 'Domas Mituzas', 'Rob Church', 'Yuri Astrakhan',
194 'Aryeh Gregor', 'Aaron Schulz', 'Andrew Garrett', 'Raimond Spekking',
195 'Alexandre Emsenhuber', 'Siebrand Mazeland', 'Chad Horohoe',
196 'Roan Kattouw', 'Trevor Parscal', 'Bryan Tong Minh', 'Sam Reed',
197 'Victor Vasiliev', 'Rotem Liss', 'Platonides', 'Antoine Musso',
198 'Timo Tijhof', 'Daniel Kinzler', 'Jeroen De Dauw', 'Brad Jorsch',
199 $othersLink, $translatorsLink
202 return wfMessage( 'version-poweredby-credits', MWTimestamp::getLocalInstance()->format( 'Y' ),
203 $wgLang->listToText( $authorList ) )->text();
207 * Returns wiki text showing the third party software versions (apache, php, mysql).
209 * @return string
211 public static function softwareInformation() {
212 $dbr = wfGetDB( DB_SLAVE );
214 // Put the software in an array of form 'name' => 'version'. All messages should
215 // be loaded here, so feel free to use wfMessage in the 'name'. Raw HTML or
216 // wikimarkup can be used.
217 $software = [];
218 $software['[https://www.mediawiki.org/ MediaWiki]'] = self::getVersionLinked();
219 if ( wfIsHHVM() ) {
220 $software['[http://hhvm.com/ HHVM]'] = HHVM_VERSION . " (" . PHP_SAPI . ")";
221 } else {
222 $software['[https://php.net/ PHP]'] = PHP_VERSION . " (" . PHP_SAPI . ")";
224 $software[$dbr->getSoftwareLink()] = $dbr->getServerInfo();
226 if ( IcuCollation::getICUVersion() ) {
227 $software['[http://site.icu-project.org/ ICU]'] = IcuCollation::getICUVersion();
230 // Allow a hook to add/remove items.
231 Hooks::run( 'SoftwareInfo', [ &$software ] );
233 $out = Xml::element(
234 'h2',
235 [ 'id' => 'mw-version-software' ],
236 wfMessage( 'version-software' )->text()
238 Xml::openElement( 'table', [ 'class' => 'wikitable plainlinks', 'id' => 'sv-software' ] ) .
239 "<tr>
240 <th>" . wfMessage( 'version-software-product' )->text() . "</th>
241 <th>" . wfMessage( 'version-software-version' )->text() . "</th>
242 </tr>\n";
244 foreach ( $software as $name => $version ) {
245 $out .= "<tr>
246 <td>" . $name . "</td>
247 <td dir=\"ltr\">" . $version . "</td>
248 </tr>\n";
251 return $out . Xml::closeElement( 'table' );
255 * Return a string of the MediaWiki version with Git revision if available.
257 * @param string $flags
258 * @param Language|string|null $lang
259 * @return mixed
261 public static function getVersion( $flags = '', $lang = null ) {
262 global $wgVersion, $IP;
264 $gitInfo = self::getGitHeadSha1( $IP );
265 if ( !$gitInfo ) {
266 $version = $wgVersion;
267 } elseif ( $flags === 'nodb' ) {
268 $shortSha1 = substr( $gitInfo, 0, 7 );
269 $version = "$wgVersion ($shortSha1)";
270 } else {
271 $shortSha1 = substr( $gitInfo, 0, 7 );
272 $msg = wfMessage( 'parentheses' );
273 if ( $lang !== null ) {
274 $msg->inLanguage( $lang );
276 $shortSha1 = $msg->params( $shortSha1 )->escaped();
277 $version = "$wgVersion $shortSha1";
280 return $version;
284 * Return a wikitext-formatted string of the MediaWiki version with a link to
285 * the Git SHA1 of head if available.
286 * The fallback is just $wgVersion
288 * @return mixed
290 public static function getVersionLinked() {
291 global $wgVersion;
293 $gitVersion = self::getVersionLinkedGit();
294 if ( $gitVersion ) {
295 $v = $gitVersion;
296 } else {
297 $v = $wgVersion; // fallback
300 return $v;
304 * @return string
306 private static function getwgVersionLinked() {
307 global $wgVersion;
308 $versionUrl = "";
309 if ( Hooks::run( 'SpecialVersionVersionUrl', [ $wgVersion, &$versionUrl ] ) ) {
310 $versionParts = [];
311 preg_match( "/^(\d+\.\d+)/", $wgVersion, $versionParts );
312 $versionUrl = "https://www.mediawiki.org/wiki/MediaWiki_{$versionParts[1]}";
315 return "[$versionUrl $wgVersion]";
319 * @since 1.22 Returns the HEAD date in addition to the sha1 and link
320 * @return bool|string Global wgVersion + HEAD sha1 stripped to the first 7 chars
321 * with link and date, or false on failure
323 private static function getVersionLinkedGit() {
324 global $IP, $wgLang;
326 $gitInfo = new GitInfo( $IP );
327 $headSHA1 = $gitInfo->getHeadSHA1();
328 if ( !$headSHA1 ) {
329 return false;
332 $shortSHA1 = '(' . substr( $headSHA1, 0, 7 ) . ')';
334 $gitHeadUrl = $gitInfo->getHeadViewUrl();
335 if ( $gitHeadUrl !== false ) {
336 $shortSHA1 = "[$gitHeadUrl $shortSHA1]";
339 $gitHeadCommitDate = $gitInfo->getHeadCommitDate();
340 if ( $gitHeadCommitDate ) {
341 $shortSHA1 .= Html::element( 'br' ) . $wgLang->timeanddate( $gitHeadCommitDate, true );
344 return self::getwgVersionLinked() . " $shortSHA1";
348 * Returns an array with the base extension types.
349 * Type is stored as array key, the message as array value.
351 * TODO: ideally this would return all extension types.
353 * @since 1.17
355 * @return array
357 public static function getExtensionTypes() {
358 if ( self::$extensionTypes === false ) {
359 self::$extensionTypes = [
360 'specialpage' => wfMessage( 'version-specialpages' )->text(),
361 'parserhook' => wfMessage( 'version-parserhooks' )->text(),
362 'variable' => wfMessage( 'version-variables' )->text(),
363 'media' => wfMessage( 'version-mediahandlers' )->text(),
364 'antispam' => wfMessage( 'version-antispam' )->text(),
365 'skin' => wfMessage( 'version-skins' )->text(),
366 'api' => wfMessage( 'version-api' )->text(),
367 'other' => wfMessage( 'version-other' )->text(),
370 Hooks::run( 'ExtensionTypes', [ &self::$extensionTypes ] );
373 return self::$extensionTypes;
377 * Returns the internationalized name for an extension type.
379 * @since 1.17
381 * @param string $type
383 * @return string
385 public static function getExtensionTypeName( $type ) {
386 $types = self::getExtensionTypes();
388 return isset( $types[$type] ) ? $types[$type] : $types['other'];
392 * Generate wikitext showing the name, URL, author and description of each extension.
394 * @return string Wikitext
396 public function getExtensionCredits() {
397 global $wgExtensionCredits;
399 if (
400 count( $wgExtensionCredits ) === 0 ||
401 // Skins are displayed separately, see getSkinCredits()
402 ( count( $wgExtensionCredits ) === 1 && isset( $wgExtensionCredits['skin'] ) )
404 return '';
407 $extensionTypes = self::getExtensionTypes();
409 $out = Xml::element(
410 'h2',
411 [ 'id' => 'mw-version-ext' ],
412 $this->msg( 'version-extensions' )->text()
414 Xml::openElement( 'table', [ 'class' => 'wikitable plainlinks', 'id' => 'sv-ext' ] );
416 // Make sure the 'other' type is set to an array.
417 if ( !array_key_exists( 'other', $wgExtensionCredits ) ) {
418 $wgExtensionCredits['other'] = [];
421 // Find all extensions that do not have a valid type and give them the type 'other'.
422 foreach ( $wgExtensionCredits as $type => $extensions ) {
423 if ( !array_key_exists( $type, $extensionTypes ) ) {
424 $wgExtensionCredits['other'] = array_merge( $wgExtensionCredits['other'], $extensions );
428 $this->firstExtOpened = false;
429 // Loop through the extension categories to display their extensions in the list.
430 foreach ( $extensionTypes as $type => $message ) {
431 // Skins have a separate section
432 if ( $type !== 'other' && $type !== 'skin' ) {
433 $out .= $this->getExtensionCategory( $type, $message );
437 // We want the 'other' type to be last in the list.
438 $out .= $this->getExtensionCategory( 'other', $extensionTypes['other'] );
440 $out .= Xml::closeElement( 'table' );
442 return $out;
446 * Generate wikitext showing the name, URL, author and description of each skin.
448 * @return string Wikitext
450 public function getSkinCredits() {
451 global $wgExtensionCredits;
452 if ( !isset( $wgExtensionCredits['skin'] ) || count( $wgExtensionCredits['skin'] ) === 0 ) {
453 return '';
456 $out = Xml::element(
457 'h2',
458 [ 'id' => 'mw-version-skin' ],
459 $this->msg( 'version-skins' )->text()
461 Xml::openElement( 'table', [ 'class' => 'wikitable plainlinks', 'id' => 'sv-skin' ] );
463 $this->firstExtOpened = false;
464 $out .= $this->getExtensionCategory( 'skin', null );
466 $out .= Xml::closeElement( 'table' );
468 return $out;
472 * Generate an HTML table for external libraries that are installed
474 * @return string
476 protected function getExternalLibraries() {
477 global $IP;
478 $path = "$IP/vendor/composer/installed.json";
479 if ( !file_exists( $path ) ) {
480 return '';
483 $installed = new ComposerInstalled( $path );
484 $out = Html::element(
485 'h2',
486 [ 'id' => 'mw-version-libraries' ],
487 $this->msg( 'version-libraries' )->text()
489 $out .= Html::openElement(
490 'table',
491 [ 'class' => 'wikitable plainlinks', 'id' => 'sv-libraries' ]
493 $out .= Html::openElement( 'tr' )
494 . Html::element( 'th', [], $this->msg( 'version-libraries-library' )->text() )
495 . Html::element( 'th', [], $this->msg( 'version-libraries-version' )->text() )
496 . Html::element( 'th', [], $this->msg( 'version-libraries-license' )->text() )
497 . Html::element( 'th', [], $this->msg( 'version-libraries-description' )->text() )
498 . Html::element( 'th', [], $this->msg( 'version-libraries-authors' )->text() )
499 . Html::closeElement( 'tr' );
501 foreach ( $installed->getInstalledDependencies() as $name => $info ) {
502 if ( strpos( $info['type'], 'mediawiki-' ) === 0 ) {
503 // Skip any extensions or skins since they'll be listed
504 // in their proper section
505 continue;
507 $authors = array_map( function( $arr ) {
508 // If a homepage is set, link to it
509 if ( isset( $arr['homepage'] ) ) {
510 return "[{$arr['homepage']} {$arr['name']}]";
512 return $arr['name'];
513 }, $info['authors'] );
514 $authors = $this->listAuthors( $authors, false, "$IP/vendor/$name" );
516 // We can safely assume that the libraries' names and descriptions
517 // are written in English and aren't going to be translated,
518 // so set appropriate lang and dir attributes
519 $out .= Html::openElement( 'tr' )
520 . Html::rawElement(
521 'td',
523 Linker::makeExternalLink(
524 "https://packagist.org/packages/$name", $name,
525 true, '',
526 [ 'class' => 'mw-version-library-name' ]
529 . Html::element( 'td', [ 'dir' => 'auto' ], $info['version'] )
530 . Html::element( 'td', [ 'dir' => 'auto' ], $this->listToText( $info['licenses'] ) )
531 . Html::element( 'td', [ 'lang' => 'en', 'dir' => 'ltr' ], $info['description'] )
532 . Html::rawElement( 'td', [], $authors )
533 . Html::closeElement( 'tr' );
535 $out .= Html::closeElement( 'table' );
537 return $out;
541 * Obtains a list of installed parser tags and the associated H2 header
543 * @return string HTML output
545 protected function getParserTags() {
546 global $wgParser;
548 $tags = $wgParser->getTags();
550 if ( count( $tags ) ) {
551 $out = Html::rawElement(
552 'h2',
554 'class' => 'mw-headline plainlinks',
555 'id' => 'mw-version-parser-extensiontags',
557 Linker::makeExternalLink(
558 'https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Tag_extensions',
559 $this->msg( 'version-parser-extensiontags' )->parse(),
560 false /* msg()->parse() already escapes */
564 array_walk( $tags, function ( &$value ) {
565 // Bidirectional isolation improves readability in RTL wikis
566 $value = Html::element(
567 'bdi',
568 // Prevent < and > from slipping to another line
570 'style' => 'white-space: nowrap;',
572 "<$value>"
574 } );
576 $out .= $this->listToText( $tags );
577 } else {
578 $out = '';
581 return $out;
585 * Obtains a list of installed parser function hooks and the associated H2 header
587 * @return string HTML output
589 protected function getParserFunctionHooks() {
590 global $wgParser;
592 $fhooks = $wgParser->getFunctionHooks();
593 if ( count( $fhooks ) ) {
594 $out = Html::rawElement(
595 'h2',
597 'class' => 'mw-headline plainlinks',
598 'id' => 'mw-version-parser-function-hooks',
600 Linker::makeExternalLink(
601 'https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Parser_functions',
602 $this->msg( 'version-parser-function-hooks' )->parse(),
603 false /* msg()->parse() already escapes */
607 $out .= $this->listToText( $fhooks );
608 } else {
609 $out = '';
612 return $out;
616 * Creates and returns the HTML for a single extension category.
618 * @since 1.17
620 * @param string $type
621 * @param string $message
623 * @return string
625 protected function getExtensionCategory( $type, $message ) {
626 global $wgExtensionCredits;
628 $out = '';
630 if ( array_key_exists( $type, $wgExtensionCredits ) && count( $wgExtensionCredits[$type] ) > 0 ) {
631 $out .= $this->openExtType( $message, 'credits-' . $type );
633 usort( $wgExtensionCredits[$type], [ $this, 'compare' ] );
635 foreach ( $wgExtensionCredits[$type] as $extension ) {
636 $out .= $this->getCreditsForExtension( $extension );
640 return $out;
644 * Callback to sort extensions by type.
645 * @param array $a
646 * @param array $b
647 * @return int
649 public function compare( $a, $b ) {
650 if ( $a['name'] === $b['name'] ) {
651 return 0;
652 } else {
653 return $this->getLanguage()->lc( $a['name'] ) > $this->getLanguage()->lc( $b['name'] )
655 : -1;
660 * Creates and formats a version line for a single extension.
662 * Information for five columns will be created. Parameters required in the
663 * $extension array for part rendering are indicated in ()
664 * - The name of (name), and URL link to (url), the extension
665 * - Official version number (version) and if available version control system
666 * revision (path), link, and date
667 * - If available the short name of the license (license-name) and a link
668 * to ((LICENSE)|(COPYING))(\.txt)? if it exists.
669 * - Description of extension (descriptionmsg or description)
670 * - List of authors (author) and link to a ((AUTHORS)|(CREDITS))(\.txt)? file if it exists
672 * @param array $extension
674 * @return string Raw HTML
676 public function getCreditsForExtension( array $extension ) {
677 $out = $this->getOutput();
679 // We must obtain the information for all the bits and pieces!
680 // ... such as extension names and links
681 if ( isset( $extension['namemsg'] ) ) {
682 // Localized name of extension
683 $extensionName = $this->msg( $extension['namemsg'] )->text();
684 } elseif ( isset( $extension['name'] ) ) {
685 // Non localized version
686 $extensionName = $extension['name'];
687 } else {
688 $extensionName = $this->msg( 'version-no-ext-name' )->text();
691 if ( isset( $extension['url'] ) ) {
692 $extensionNameLink = Linker::makeExternalLink(
693 $extension['url'],
694 $extensionName,
695 true,
697 [ 'class' => 'mw-version-ext-name' ]
699 } else {
700 $extensionNameLink = $extensionName;
703 // ... and the version information
704 // If the extension path is set we will check that directory for GIT
705 // metadata in an attempt to extract date and vcs commit metadata.
706 $canonicalVersion = '&ndash;';
707 $extensionPath = null;
708 $vcsVersion = null;
709 $vcsLink = null;
710 $vcsDate = null;
712 if ( isset( $extension['version'] ) ) {
713 $canonicalVersion = $out->parseInline( $extension['version'] );
716 if ( isset( $extension['path'] ) ) {
717 global $IP;
718 $extensionPath = dirname( $extension['path'] );
719 if ( $this->coreId == '' ) {
720 wfDebug( 'Looking up core head id' );
721 $coreHeadSHA1 = self::getGitHeadSha1( $IP );
722 if ( $coreHeadSHA1 ) {
723 $this->coreId = $coreHeadSHA1;
726 $cache = wfGetCache( CACHE_ANYTHING );
727 $memcKey = wfMemcKey( 'specialversion-ext-version-text', $extension['path'], $this->coreId );
728 list( $vcsVersion, $vcsLink, $vcsDate ) = $cache->get( $memcKey );
730 if ( !$vcsVersion ) {
731 wfDebug( "Getting VCS info for extension {$extension['name']}" );
732 $gitInfo = new GitInfo( $extensionPath );
733 $vcsVersion = $gitInfo->getHeadSHA1();
734 if ( $vcsVersion !== false ) {
735 $vcsVersion = substr( $vcsVersion, 0, 7 );
736 $vcsLink = $gitInfo->getHeadViewUrl();
737 $vcsDate = $gitInfo->getHeadCommitDate();
739 $cache->set( $memcKey, [ $vcsVersion, $vcsLink, $vcsDate ], 60 * 60 * 24 );
740 } else {
741 wfDebug( "Pulled VCS info for extension {$extension['name']} from cache" );
745 $versionString = Html::rawElement(
746 'span',
747 [ 'class' => 'mw-version-ext-version' ],
748 $canonicalVersion
751 if ( $vcsVersion ) {
752 if ( $vcsLink ) {
753 $vcsVerString = Linker::makeExternalLink(
754 $vcsLink,
755 $this->msg( 'version-version', $vcsVersion ),
756 true,
758 [ 'class' => 'mw-version-ext-vcs-version' ]
760 } else {
761 $vcsVerString = Html::element( 'span',
762 [ 'class' => 'mw-version-ext-vcs-version' ],
763 "({$vcsVersion})"
766 $versionString .= " {$vcsVerString}";
768 if ( $vcsDate ) {
769 $vcsTimeString = Html::element( 'span',
770 [ 'class' => 'mw-version-ext-vcs-timestamp' ],
771 $this->getLanguage()->timeanddate( $vcsDate, true )
773 $versionString .= " {$vcsTimeString}";
775 $versionString = Html::rawElement( 'span',
776 [ 'class' => 'mw-version-ext-meta-version' ],
777 $versionString
781 // ... and license information; if a license file exists we
782 // will link to it
783 $licenseLink = '';
784 if ( isset( $extension['name'] ) ) {
785 $licenseName = null;
786 if ( isset( $extension['license-name'] ) ) {
787 $licenseName = $out->parseInline( $extension['license-name'] );
788 } elseif ( $this->getExtLicenseFileName( $extensionPath ) ) {
789 $licenseName = $this->msg( 'version-ext-license' )->escaped();
791 if ( $licenseName !== null ) {
792 $licenseLink = Linker::link(
793 $this->getPageTitle( 'License/' . $extension['name'] ),
794 $licenseName,
796 'class' => 'mw-version-ext-license',
797 'dir' => 'auto',
803 // ... and generate the description; which can be a parameterized l10n message
804 // in the form array( <msgname>, <parameter>, <parameter>... ) or just a straight
805 // up string
806 if ( isset( $extension['descriptionmsg'] ) ) {
807 // Localized description of extension
808 $descriptionMsg = $extension['descriptionmsg'];
810 if ( is_array( $descriptionMsg ) ) {
811 $descriptionMsgKey = $descriptionMsg[0]; // Get the message key
812 array_shift( $descriptionMsg ); // Shift out the message key to get the parameters only
813 array_map( "htmlspecialchars", $descriptionMsg ); // For sanity
814 $description = $this->msg( $descriptionMsgKey, $descriptionMsg )->text();
815 } else {
816 $description = $this->msg( $descriptionMsg )->text();
818 } elseif ( isset( $extension['description'] ) ) {
819 // Non localized version
820 $description = $extension['description'];
821 } else {
822 $description = '';
824 $description = $out->parseInline( $description );
826 // ... now get the authors for this extension
827 $authors = isset( $extension['author'] ) ? $extension['author'] : [];
828 $authors = $this->listAuthors( $authors, $extension['name'], $extensionPath );
830 // Finally! Create the table
831 $html = Html::openElement( 'tr', [
832 'class' => 'mw-version-ext',
833 'id' => Sanitizer::escapeId( 'mw-version-ext-' . $extension['name'] )
837 $html .= Html::rawElement( 'td', [], $extensionNameLink );
838 $html .= Html::rawElement( 'td', [], $versionString );
839 $html .= Html::rawElement( 'td', [], $licenseLink );
840 $html .= Html::rawElement( 'td', [ 'class' => 'mw-version-ext-description' ], $description );
841 $html .= Html::rawElement( 'td', [ 'class' => 'mw-version-ext-authors' ], $authors );
843 $html .= Html::closeElement( 'tr' );
845 return $html;
849 * Generate wikitext showing hooks in $wgHooks.
851 * @return string Wikitext
853 private function getWgHooks() {
854 global $wgSpecialVersionShowHooks, $wgHooks;
856 if ( $wgSpecialVersionShowHooks && count( $wgHooks ) ) {
857 $myWgHooks = $wgHooks;
858 ksort( $myWgHooks );
860 $ret = [];
861 $ret[] = '== {{int:version-hooks}} ==';
862 $ret[] = Html::openElement( 'table', [ 'class' => 'wikitable', 'id' => 'sv-hooks' ] );
863 $ret[] = Html::openElement( 'tr' );
864 $ret[] = Html::element( 'th', [], $this->msg( 'version-hook-name' )->text() );
865 $ret[] = Html::element( 'th', [], $this->msg( 'version-hook-subscribedby' )->text() );
866 $ret[] = Html::closeElement( 'tr' );
868 foreach ( $myWgHooks as $hook => $hooks ) {
869 $ret[] = Html::openElement( 'tr' );
870 $ret[] = Html::element( 'td', [], $hook );
871 $ret[] = Html::element( 'td', [], $this->listToText( $hooks ) );
872 $ret[] = Html::closeElement( 'tr' );
875 $ret[] = Html::closeElement( 'table' );
877 return implode( "\n", $ret );
878 } else {
879 return '';
883 private function openExtType( $text = null, $name = null ) {
884 $out = '';
886 $opt = [ 'colspan' => 5 ];
887 if ( $this->firstExtOpened ) {
888 // Insert a spacing line
889 $out .= Html::rawElement( 'tr', [ 'class' => 'sv-space' ],
890 Html::element( 'td', $opt )
893 $this->firstExtOpened = true;
895 if ( $name ) {
896 $opt['id'] = "sv-$name";
899 if ( $text !== null ) {
900 $out .= Html::rawElement( 'tr', [],
901 Html::element( 'th', $opt, $text )
905 $firstHeadingMsg = ( $name === 'credits-skin' )
906 ? 'version-skin-colheader-name'
907 : 'version-ext-colheader-name';
908 $out .= Html::openElement( 'tr' );
909 $out .= Html::element( 'th', [ 'class' => 'mw-version-ext-col-label' ],
910 $this->msg( $firstHeadingMsg )->text() );
911 $out .= Html::element( 'th', [ 'class' => 'mw-version-ext-col-label' ],
912 $this->msg( 'version-ext-colheader-version' )->text() );
913 $out .= Html::element( 'th', [ 'class' => 'mw-version-ext-col-label' ],
914 $this->msg( 'version-ext-colheader-license' )->text() );
915 $out .= Html::element( 'th', [ 'class' => 'mw-version-ext-col-label' ],
916 $this->msg( 'version-ext-colheader-description' )->text() );
917 $out .= Html::element( 'th', [ 'class' => 'mw-version-ext-col-label' ],
918 $this->msg( 'version-ext-colheader-credits' )->text() );
919 $out .= Html::closeElement( 'tr' );
921 return $out;
925 * Get information about client's IP address.
927 * @return string HTML fragment
929 private function IPInfo() {
930 $ip = str_replace( '--', ' - ', htmlspecialchars( $this->getRequest()->getIP() ) );
932 return "<!-- visited from $ip -->\n<span style='display:none'>visited from $ip</span>";
936 * Return a formatted unsorted list of authors
938 * 'And Others'
939 * If an item in the $authors array is '...' it is assumed to indicate an
940 * 'and others' string which will then be linked to an ((AUTHORS)|(CREDITS))(\.txt)?
941 * file if it exists in $dir.
943 * Similarly an entry ending with ' ...]' is assumed to be a link to an
944 * 'and others' page.
946 * If no '...' string variant is found, but an authors file is found an
947 * 'and others' will be added to the end of the credits.
949 * @param string|array $authors
950 * @param string|bool $extName Name of the extension for link creation,
951 * false if no links should be created
952 * @param string $extDir Path to the extension root directory
954 * @return string HTML fragment
956 public function listAuthors( $authors, $extName, $extDir ) {
957 $hasOthers = false;
959 $list = [];
960 foreach ( (array)$authors as $item ) {
961 if ( $item == '...' ) {
962 $hasOthers = true;
964 if ( $extName && $this->getExtAuthorsFileName( $extDir ) ) {
965 $text = Linker::link(
966 $this->getPageTitle( "Credits/$extName" ),
967 $this->msg( 'version-poweredby-others' )->escaped()
969 } else {
970 $text = $this->msg( 'version-poweredby-others' )->escaped();
972 $list[] = $text;
973 } elseif ( substr( $item, -5 ) == ' ...]' ) {
974 $hasOthers = true;
975 $list[] = $this->getOutput()->parseInline(
976 substr( $item, 0, -4 ) . $this->msg( 'version-poweredby-others' )->text() . "]"
978 } else {
979 $list[] = $this->getOutput()->parseInline( $item );
983 if ( $extName && !$hasOthers && $this->getExtAuthorsFileName( $extDir ) ) {
984 $list[] = $text = Linker::link(
985 $this->getPageTitle( "Credits/$extName" ),
986 $this->msg( 'version-poweredby-others' )->escaped()
990 return $this->listToText( $list, false );
994 * Obtains the full path of an extensions authors or credits file if
995 * one exists.
997 * @param string $extDir Path to the extensions root directory
999 * @since 1.23
1001 * @return bool|string False if no such file exists, otherwise returns
1002 * a path to it.
1004 public static function getExtAuthorsFileName( $extDir ) {
1005 if ( !$extDir ) {
1006 return false;
1009 foreach ( scandir( $extDir ) as $file ) {
1010 $fullPath = $extDir . DIRECTORY_SEPARATOR . $file;
1011 if ( preg_match( '/^((AUTHORS)|(CREDITS))(\.txt|\.wiki|\.mediawiki)?$/', $file ) &&
1012 is_readable( $fullPath ) &&
1013 is_file( $fullPath )
1015 return $fullPath;
1019 return false;
1023 * Obtains the full path of an extensions copying or license file if
1024 * one exists.
1026 * @param string $extDir Path to the extensions root directory
1028 * @since 1.23
1030 * @return bool|string False if no such file exists, otherwise returns
1031 * a path to it.
1033 public static function getExtLicenseFileName( $extDir ) {
1034 if ( !$extDir ) {
1035 return false;
1038 foreach ( scandir( $extDir ) as $file ) {
1039 $fullPath = $extDir . DIRECTORY_SEPARATOR . $file;
1040 if ( preg_match( '/^((COPYING)|(LICENSE))(\.txt)?$/', $file ) &&
1041 is_readable( $fullPath ) &&
1042 is_file( $fullPath )
1044 return $fullPath;
1048 return false;
1052 * Convert an array of items into a list for display.
1054 * @param array $list List of elements to display
1055 * @param bool $sort Whether to sort the items in $list
1057 * @return string
1059 public function listToText( $list, $sort = true ) {
1060 if ( !count( $list ) ) {
1061 return '';
1063 if ( $sort ) {
1064 sort( $list );
1067 return $this->getLanguage()
1068 ->listToText( array_map( [ __CLASS__, 'arrayToString' ], $list ) );
1072 * Convert an array or object to a string for display.
1074 * @param mixed $list Will convert an array to string if given and return
1075 * the parameter unaltered otherwise
1077 * @return mixed
1079 public static function arrayToString( $list ) {
1080 if ( is_array( $list ) && count( $list ) == 1 ) {
1081 $list = $list[0];
1083 if ( $list instanceof Closure ) {
1084 // Don't output stuff like "Closure$;1028376090#8$48499d94fe0147f7c633b365be39952b$"
1085 return 'Closure';
1086 } elseif ( is_object( $list ) ) {
1087 $class = wfMessage( 'parentheses' )->params( get_class( $list ) )->escaped();
1089 return $class;
1090 } elseif ( !is_array( $list ) ) {
1091 return $list;
1092 } else {
1093 if ( is_object( $list[0] ) ) {
1094 $class = get_class( $list[0] );
1095 } else {
1096 $class = $list[0];
1099 return wfMessage( 'parentheses' )->params( "$class, {$list[1]}" )->escaped();
1104 * @param string $dir Directory of the git checkout
1105 * @return bool|string Sha1 of commit HEAD points to
1107 public static function getGitHeadSha1( $dir ) {
1108 $repo = new GitInfo( $dir );
1110 return $repo->getHeadSHA1();
1114 * @param string $dir Directory of the git checkout
1115 * @return bool|string Branch currently checked out
1117 public static function getGitCurrentBranch( $dir ) {
1118 $repo = new GitInfo( $dir );
1119 return $repo->getCurrentBranch();
1123 * Get the list of entry points and their URLs
1124 * @return string Wikitext
1126 public function getEntryPointInfo() {
1127 global $wgArticlePath, $wgScriptPath;
1128 $scriptPath = $wgScriptPath ? $wgScriptPath : "/";
1129 $entryPoints = [
1130 'version-entrypoints-articlepath' => $wgArticlePath,
1131 'version-entrypoints-scriptpath' => $scriptPath,
1132 'version-entrypoints-index-php' => wfScript( 'index' ),
1133 'version-entrypoints-api-php' => wfScript( 'api' ),
1134 'version-entrypoints-load-php' => wfScript( 'load' ),
1137 $language = $this->getLanguage();
1138 $thAttribures = [
1139 'dir' => $language->getDir(),
1140 'lang' => $language->getHtmlCode()
1142 $out = Html::element(
1143 'h2',
1144 [ 'id' => 'mw-version-entrypoints' ],
1145 $this->msg( 'version-entrypoints' )->text()
1147 Html::openElement( 'table',
1149 'class' => 'wikitable plainlinks',
1150 'id' => 'mw-version-entrypoints-table',
1151 'dir' => 'ltr',
1152 'lang' => 'en'
1155 Html::openElement( 'tr' ) .
1156 Html::element(
1157 'th',
1158 $thAttribures,
1159 $this->msg( 'version-entrypoints-header-entrypoint' )->text()
1161 Html::element(
1162 'th',
1163 $thAttribures,
1164 $this->msg( 'version-entrypoints-header-url' )->text()
1166 Html::closeElement( 'tr' );
1168 foreach ( $entryPoints as $message => $value ) {
1169 $url = wfExpandUrl( $value, PROTO_RELATIVE );
1170 $out .= Html::openElement( 'tr' ) .
1171 // ->text() looks like it should be ->parse(), but this function
1172 // returns wikitext, not HTML, boo
1173 Html::rawElement( 'td', [], $this->msg( $message )->text() ) .
1174 Html::rawElement( 'td', [], Html::rawElement( 'code', [], "[$url $value]" ) ) .
1175 Html::closeElement( 'tr' );
1178 $out .= Html::closeElement( 'table' );
1180 return $out;
1183 protected function getGroupName() {
1184 return 'wiki';