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 protected static $viewvcUrls = array(
42 'svn+ssh://svn.wikimedia.org/svnroot/mediawiki' => 'http://svn.wikimedia.org/viewvc/mediawiki',
43 'http://svn.wikimedia.org/svnroot/mediawiki' => 'http://svn.wikimedia.org/viewvc/mediawiki',
44 'https://svn.wikimedia.org/svnroot/mediawiki' => 'https://svn.wikimedia.org/viewvc/mediawiki',
47 public function __construct() {
48 parent
::__construct( 'Version' );
53 * @param string|null $par
55 public function execute( $par ) {
56 global $IP, $wgExtensionCredits;
59 $this->outputHeader();
60 $out = $this->getOutput();
61 $out->allowClickjacking();
63 // Explode the sub page information into useful bits
64 $parts = explode( '/', (string)$par );
66 if ( isset( $parts[1] ) ) {
67 $extName = str_replace( '_', ' ', $parts[1] );
69 foreach ( $wgExtensionCredits as $group => $extensions ) {
70 foreach ( $extensions as $ext ) {
71 if ( isset( $ext['name'] ) && ( $ext['name'] === $extName ) ) {
78 $out->setStatusCode( 404 );
81 $extName = 'MediaWiki';
84 // Now figure out what to do
85 switch ( strtolower( $parts[0] ) ) {
87 $wikiText = '{{int:version-credits-not-found}}';
88 if ( $extName === 'MediaWiki' ) {
89 $wikiText = file_get_contents( $IP . '/CREDITS' );
90 } elseif ( ( $extNode !== null ) && isset( $extNode['path'] ) ) {
91 $file = $this->getExtAuthorsFileName( dirname( $extNode['path'] ) );
93 $wikiText = file_get_contents( $file );
94 if ( substr( $file, -4 ) === '.txt' ) {
95 $wikiText = Html
::element( 'pre', array(), $wikiText );
100 $out->setPageTitle( $this->msg( 'version-credits-title', $extName ) );
101 $out->addWikiText( $wikiText );
105 $wikiText = '{{int:version-license-not-found}}';
106 if ( $extName === 'MediaWiki' ) {
107 $wikiText = file_get_contents( $IP . '/COPYING' );
108 } elseif ( ( $extNode !== null ) && isset( $extNode['path'] ) ) {
109 $file = $this->getExtLicenseFileName( dirname( $extNode['path'] ) );
111 $wikiText = file_get_contents( $file );
112 $wikiText = "<pre>$wikiText</pre>";
116 $out->setPageTitle( $this->msg( 'version-license-title', $extName ) );
117 $out->addWikiText( $wikiText );
121 $out->addModules( 'mediawiki.special.version' );
123 $this->getMediaWikiCredits() .
124 $this->softwareInformation() .
125 $this->getEntryPointInfo()
128 $this->getSkinCredits() .
129 $this->getExtensionCredits() .
130 $this->getExternalLibraries() .
131 $this->getParserTags() .
132 $this->getParserFunctionHooks()
134 $out->addWikiText( $this->getWgHooks() );
135 $out->addHTML( $this->IPInfo() );
142 * Returns wiki text showing the license information.
146 private static function getMediaWikiCredits() {
149 array( 'id' => 'mw-version-license' ),
150 wfMessage( 'version-license' )->text()
153 // This text is always left-to-right.
154 $ret .= '<div class="plainlinks">';
156 " . self
::getCopyrightAndAuthorList() . "\n
157 " . wfMessage( 'version-license-info' )->text();
160 return str_replace( "\t\t", '', $ret ) . "\n";
164 * Get the "MediaWiki is copyright 2001-20xx by lots of cool guys" text
168 public static function getCopyrightAndAuthorList() {
171 if ( defined( 'MEDIAWIKI_INSTALL' ) ) {
172 $othersLink = '[//www.mediawiki.org/wiki/Special:Version/Credits ' .
173 wfMessage( 'version-poweredby-others' )->text() . ']';
175 $othersLink = '[[Special:Version/Credits|' .
176 wfMessage( 'version-poweredby-others' )->text() . ']]';
179 $translatorsLink = '[//translatewiki.net/wiki/Translating:MediaWiki/Credits ' .
180 wfMessage( 'version-poweredby-translators' )->text() . ']';
183 'Magnus Manske', 'Brion Vibber', 'Lee Daniel Crocker',
184 'Tim Starling', 'Erik Möller', 'Gabriel Wicke', 'Ævar Arnfjörð Bjarmason',
185 'Niklas Laxström', 'Domas Mituzas', 'Rob Church', 'Yuri Astrakhan',
186 'Aryeh Gregor', 'Aaron Schulz', 'Andrew Garrett', 'Raimond Spekking',
187 'Alexandre Emsenhuber', 'Siebrand Mazeland', 'Chad Horohoe',
188 'Roan Kattouw', 'Trevor Parscal', 'Bryan Tong Minh', 'Sam Reed',
189 'Victor Vasiliev', 'Rotem Liss', 'Platonides', 'Antoine Musso',
190 'Timo Tijhof', 'Daniel Kinzler', 'Jeroen De Dauw', 'Brad Jorsch',
191 $othersLink, $translatorsLink
194 return wfMessage( 'version-poweredby-credits', MWTimestamp
::getLocalInstance()->format( 'Y' ),
195 $wgLang->listToText( $authorList ) )->text();
199 * Returns wiki text showing the third party software versions (apache, php, mysql).
203 public static function softwareInformation() {
204 $dbr = wfGetDB( DB_SLAVE
);
206 // Put the software in an array of form 'name' => 'version'. All messages should
207 // be loaded here, so feel free to use wfMessage in the 'name'. Raw HTML or
208 // wikimarkup can be used.
210 $software['[https://www.mediawiki.org/ MediaWiki]'] = self
::getVersionLinked();
212 $software['[http://hhvm.com/ HHVM]'] = HHVM_VERSION
. " (" . PHP_SAPI
. ")";
214 $software['[https://php.net/ PHP]'] = PHP_VERSION
. " (" . PHP_SAPI
. ")";
216 $software[$dbr->getSoftwareLink()] = $dbr->getServerInfo();
218 // Allow a hook to add/remove items.
219 Hooks
::run( 'SoftwareInfo', array( &$software ) );
223 array( 'id' => 'mw-version-software' ),
224 wfMessage( 'version-software' )->text()
226 Xml
::openElement( 'table', array( 'class' => 'wikitable plainlinks', 'id' => 'sv-software' ) ) .
228 <th>" . wfMessage( 'version-software-product' )->text() . "</th>
229 <th>" . wfMessage( 'version-software-version' )->text() . "</th>
232 foreach ( $software as $name => $version ) {
234 <td>" . $name . "</td>
235 <td dir=\"ltr\">" . $version . "</td>
239 return $out . Xml
::closeElement( 'table' );
243 * Return a string of the MediaWiki version with SVN revision if available.
245 * @param string $flags
248 public static function getVersion( $flags = '' ) {
249 global $wgVersion, $IP;
251 $gitInfo = self
::getGitHeadSha1( $IP );
252 $svnInfo = self
::getSvnInfo( $IP );
253 if ( !$svnInfo && !$gitInfo ) {
254 $version = $wgVersion;
255 } elseif ( $gitInfo && $flags === 'nodb' ) {
256 $shortSha1 = substr( $gitInfo, 0, 7 );
257 $version = "$wgVersion ($shortSha1)";
258 } elseif ( $gitInfo ) {
259 $shortSha1 = substr( $gitInfo, 0, 7 );
260 $shortSha1 = wfMessage( 'parentheses' )->params( $shortSha1 )->escaped();
261 $version = "$wgVersion $shortSha1";
262 } elseif ( $flags === 'nodb' ) {
263 $version = "$wgVersion (r{$svnInfo['checkout-rev']})";
265 $version = $wgVersion . ' ' .
267 'version-svn-revision',
268 isset( $svnInfo['directory-rev'] ) ?
$svnInfo['directory-rev'] : '',
269 isset( $svnInfo['checkout-rev'] ) ?
$svnInfo['checkout-rev'] : ''
277 * Return a wikitext-formatted string of the MediaWiki version with a link to
278 * the SVN revision or the git SHA1 of head if available.
279 * Git is prefered over Svn
280 * The fallback is just $wgVersion
284 public static function getVersionLinked() {
287 $gitVersion = self
::getVersionLinkedGit();
291 $svnVersion = self
::getVersionLinkedSvn();
295 $v = $wgVersion; // fallback
303 * @return string Global wgVersion + a link to subversion revision of svn BASE
305 private static function getVersionLinkedSvn() {
308 $info = self
::getSvnInfo( $IP );
309 if ( !isset( $info['checkout-rev'] ) ) {
313 $linkText = wfMessage(
314 'version-svn-revision',
315 isset( $info['directory-rev'] ) ?
$info['directory-rev'] : '',
316 $info['checkout-rev']
319 if ( isset( $info['viewvc-url'] ) ) {
320 $version = "[{$info['viewvc-url']} $linkText]";
322 $version = $linkText;
325 return self
::getwgVersionLinked() . " $version";
331 private static function getwgVersionLinked() {
334 if ( Hooks
::run( 'SpecialVersionVersionUrl', array( $wgVersion, &$versionUrl ) ) ) {
335 $versionParts = array();
336 preg_match( "/^(\d+\.\d+)/", $wgVersion, $versionParts );
337 $versionUrl = "https://www.mediawiki.org/wiki/MediaWiki_{$versionParts[1]}";
340 return "[$versionUrl $wgVersion]";
344 * @since 1.22 Returns the HEAD date in addition to the sha1 and link
345 * @return bool|string Global wgVersion + HEAD sha1 stripped to the first 7 chars
346 * with link and date, or false on failure
348 private static function getVersionLinkedGit() {
351 $gitInfo = new GitInfo( $IP );
352 $headSHA1 = $gitInfo->getHeadSHA1();
357 $shortSHA1 = '(' . substr( $headSHA1, 0, 7 ) . ')';
359 $gitHeadUrl = $gitInfo->getHeadViewUrl();
360 if ( $gitHeadUrl !== false ) {
361 $shortSHA1 = "[$gitHeadUrl $shortSHA1]";
364 $gitHeadCommitDate = $gitInfo->getHeadCommitDate();
365 if ( $gitHeadCommitDate ) {
366 $shortSHA1 .= Html
::element( 'br' ) . $wgLang->timeanddate( $gitHeadCommitDate, true );
369 return self
::getwgVersionLinked() . " $shortSHA1";
373 * Returns an array with the base extension types.
374 * Type is stored as array key, the message as array value.
376 * TODO: ideally this would return all extension types.
382 public static function getExtensionTypes() {
383 if ( self
::$extensionTypes === false ) {
384 self
::$extensionTypes = array(
385 'specialpage' => wfMessage( 'version-specialpages' )->text(),
386 'parserhook' => wfMessage( 'version-parserhooks' )->text(),
387 'variable' => wfMessage( 'version-variables' )->text(),
388 'media' => wfMessage( 'version-mediahandlers' )->text(),
389 'antispam' => wfMessage( 'version-antispam' )->text(),
390 'skin' => wfMessage( 'version-skins' )->text(),
391 'api' => wfMessage( 'version-api' )->text(),
392 'other' => wfMessage( 'version-other' )->text(),
395 Hooks
::run( 'ExtensionTypes', array( &self
::$extensionTypes ) );
398 return self
::$extensionTypes;
402 * Returns the internationalized name for an extension type.
406 * @param string $type
410 public static function getExtensionTypeName( $type ) {
411 $types = self
::getExtensionTypes();
413 return isset( $types[$type] ) ?
$types[$type] : $types['other'];
417 * Generate wikitext showing the name, URL, author and description of each extension.
419 * @return string Wikitext
421 public function getExtensionCredits() {
422 global $wgExtensionCredits;
425 count( $wgExtensionCredits ) === 0 ||
426 // Skins are displayed separately, see getSkinCredits()
427 ( count( $wgExtensionCredits ) === 1 && isset( $wgExtensionCredits['skin'] ) )
432 $extensionTypes = self
::getExtensionTypes();
436 array( 'id' => 'mw-version-ext' ),
437 $this->msg( 'version-extensions' )->text()
439 Xml
::openElement( 'table', array( 'class' => 'wikitable plainlinks', 'id' => 'sv-ext' ) );
441 // Make sure the 'other' type is set to an array.
442 if ( !array_key_exists( 'other', $wgExtensionCredits ) ) {
443 $wgExtensionCredits['other'] = array();
446 // Find all extensions that do not have a valid type and give them the type 'other'.
447 foreach ( $wgExtensionCredits as $type => $extensions ) {
448 if ( !array_key_exists( $type, $extensionTypes ) ) {
449 $wgExtensionCredits['other'] = array_merge( $wgExtensionCredits['other'], $extensions );
453 $this->firstExtOpened
= false;
454 // Loop through the extension categories to display their extensions in the list.
455 foreach ( $extensionTypes as $type => $message ) {
456 // Skins have a separate section
457 if ( $type !== 'other' && $type !== 'skin' ) {
458 $out .= $this->getExtensionCategory( $type, $message );
462 // We want the 'other' type to be last in the list.
463 $out .= $this->getExtensionCategory( 'other', $extensionTypes['other'] );
465 $out .= Xml
::closeElement( 'table' );
471 * Generate wikitext showing the name, URL, author and description of each skin.
473 * @return string Wikitext
475 public function getSkinCredits() {
476 global $wgExtensionCredits;
477 if ( !isset( $wgExtensionCredits['skin'] ) ||
count( $wgExtensionCredits['skin'] ) === 0 ) {
483 array( 'id' => 'mw-version-skin' ),
484 $this->msg( 'version-skins' )->text()
486 Xml
::openElement( 'table', array( 'class' => 'wikitable plainlinks', 'id' => 'sv-skin' ) );
488 $this->firstExtOpened
= false;
489 $out .= $this->getExtensionCategory( 'skin', null );
491 $out .= Xml
::closeElement( 'table' );
497 * Generate an HTML table for external libraries that are installed
501 protected function getExternalLibraries() {
503 $path = "$IP/composer.lock";
504 if ( !file_exists( $path ) ) {
505 // Maybe they're using mediawiki/vendor?
506 $path = "$IP/vendor/composer.lock";
507 if ( !file_exists( $path ) ) {
512 $lock = new ComposerLock( $path );
513 $out = Html
::element(
515 array( 'id' => 'mw-version-libraries' ),
516 $this->msg( 'version-libraries' )->text()
518 $out .= Html
::openElement(
520 array( 'class' => 'wikitable plainlinks', 'id' => 'sv-libraries' )
522 $out .= Html
::openElement( 'tr' )
523 . Html
::element( 'th', array(), $this->msg( 'version-libraries-library' )->text() )
524 . Html
::element( 'th', array(), $this->msg( 'version-libraries-version' )->text() )
525 . Html
::element( 'th', array(), $this->msg( 'version-libraries-license' )->text() )
526 . Html
::element( 'th', array(), $this->msg( 'version-libraries-description' )->text() )
527 . Html
::element( 'th', array(), $this->msg( 'version-libraries-authors' )->text() )
528 . Html
::closeElement( 'tr' );
530 foreach ( $lock->getInstalledDependencies() as $name => $info ) {
531 if ( strpos( $info['type'], 'mediawiki-' ) === 0 ) {
532 // Skip any extensions or skins since they'll be listed
533 // in their proper section
536 $authors = array_map( function( $arr ) {
537 // If a homepage is set, link to it
538 if ( isset( $arr['homepage'] ) ) {
539 return "[{$arr['homepage']} {$arr['name']}]";
542 }, $info['authors'] );
543 $authors = $this->listAuthors( $authors, false, "$IP/vendor/$name" );
544 $out .= Html
::openElement( 'tr' )
548 Linker
::makeExternalLink(
549 "https://packagist.org/packages/$name", $name,
551 array( 'class' => 'mw-version-library-name' )
554 . Html
::element( 'td', array(), $info['version'] )
555 . Html
::element( 'td', array(), $this->listToText( $info['licenses'] ) )
556 . Html
::element( 'td', array(), $info['description'] )
557 . Html
::rawElement( 'td', array(), $authors )
558 . Html
::closeElement( 'tr' );
560 $out .= Html
::closeElement( 'table' );
566 * Obtains a list of installed parser tags and the associated H2 header
568 * @return string HTML output
570 protected function getParserTags() {
573 $tags = $wgParser->getTags();
575 if ( count( $tags ) ) {
576 $out = Html
::rawElement(
578 array( 'class' => 'mw-headline plainlinks' ),
579 Linker
::makeExternalLink(
580 '//www.mediawiki.org/wiki/Special:MyLanguage/Manual:Tag_extensions',
581 $this->msg( 'version-parser-extensiontags' )->parse(),
582 false /* msg()->parse() already escapes */
586 array_walk( $tags, function ( &$value ) {
587 // Bidirectional isolation improves readability in RTL wikis
588 $value = Html
::element(
590 // Prevent < and > from slipping to another line
592 'style' => 'white-space: nowrap;',
598 $out .= $this->listToText( $tags );
607 * Obtains a list of installed parser function hooks and the associated H2 header
609 * @return string HTML output
611 protected function getParserFunctionHooks() {
614 $fhooks = $wgParser->getFunctionHooks();
615 if ( count( $fhooks ) ) {
616 $out = Html
::rawElement(
618 array( 'class' => 'mw-headline plainlinks' ),
619 Linker
::makeExternalLink(
620 '//www.mediawiki.org/wiki/Special:MyLanguage/Manual:Parser_functions',
621 $this->msg( 'version-parser-function-hooks' )->parse(),
622 false /* msg()->parse() already escapes */
626 $out .= $this->listToText( $fhooks );
635 * Creates and returns the HTML for a single extension category.
639 * @param string $type
640 * @param string $message
644 protected function getExtensionCategory( $type, $message ) {
645 global $wgExtensionCredits;
649 if ( array_key_exists( $type, $wgExtensionCredits ) && count( $wgExtensionCredits[$type] ) > 0 ) {
650 $out .= $this->openExtType( $message, 'credits-' . $type );
652 usort( $wgExtensionCredits[$type], array( $this, 'compare' ) );
654 foreach ( $wgExtensionCredits[$type] as $extension ) {
655 $out .= $this->getCreditsForExtension( $extension );
663 * Callback to sort extensions by type.
668 public function compare( $a, $b ) {
669 if ( $a['name'] === $b['name'] ) {
672 return $this->getLanguage()->lc( $a['name'] ) > $this->getLanguage()->lc( $b['name'] )
679 * Creates and formats a version line for a single extension.
681 * Information for five columns will be created. Parameters required in the
682 * $extension array for part rendering are indicated in ()
683 * - The name of (name), and URL link to (url), the extension
684 * - Official version number (version) and if available version control system
685 * revision (path), link, and date
686 * - If available the short name of the license (license-name) and a linke
687 * to ((LICENSE)|(COPYING))(\.txt)? if it exists.
688 * - Description of extension (descriptionmsg or description)
689 * - List of authors (author) and link to a ((AUTHORS)|(CREDITS))(\.txt)? file if it exists
691 * @param array $extension
693 * @return string Raw HTML
695 public function getCreditsForExtension( array $extension ) {
696 $out = $this->getOutput();
698 // We must obtain the information for all the bits and pieces!
699 // ... such as extension names and links
700 if ( isset( $extension['namemsg'] ) ) {
701 // Localized name of extension
702 $extensionName = $this->msg( $extension['namemsg'] )->text();
703 } elseif ( isset( $extension['name'] ) ) {
704 // Non localized version
705 $extensionName = $extension['name'];
707 $extensionName = $this->msg( 'version-no-ext-name' )->text();
710 if ( isset( $extension['url'] ) ) {
711 $extensionNameLink = Linker
::makeExternalLink(
716 array( 'class' => 'mw-version-ext-name' )
719 $extensionNameLink = $extensionName;
722 // ... and the version information
723 // If the extension path is set we will check that directory for GIT and SVN
724 // metadata in an attempt to extract date and vcs commit metadata.
725 $canonicalVersion = '–';
726 $extensionPath = null;
731 if ( isset( $extension['version'] ) ) {
732 $canonicalVersion = $out->parseInline( $extension['version'] );
735 if ( isset( $extension['path'] ) ) {
737 $extensionPath = dirname( $extension['path'] );
738 if ( $this->coreId
== '' ) {
739 wfDebug( 'Looking up core head id' );
740 $coreHeadSHA1 = self
::getGitHeadSha1( $IP );
741 if ( $coreHeadSHA1 ) {
742 $this->coreId
= $coreHeadSHA1;
744 $svnInfo = self
::getSvnInfo( $IP );
745 if ( $svnInfo !== false ) {
746 $this->coreId
= $svnInfo['checkout-rev'];
750 $cache = wfGetCache( CACHE_ANYTHING
);
751 $memcKey = wfMemcKey( 'specialversion-ext-version-text', $extension['path'], $this->coreId
);
752 list( $vcsVersion, $vcsLink, $vcsDate ) = $cache->get( $memcKey );
754 if ( !$vcsVersion ) {
755 wfDebug( "Getting VCS info for extension {$extension['name']}" );
756 $gitInfo = new GitInfo( $extensionPath );
757 $vcsVersion = $gitInfo->getHeadSHA1();
758 if ( $vcsVersion !== false ) {
759 $vcsVersion = substr( $vcsVersion, 0, 7 );
760 $vcsLink = $gitInfo->getHeadViewUrl();
761 $vcsDate = $gitInfo->getHeadCommitDate();
763 $svnInfo = self
::getSvnInfo( $extensionPath );
764 if ( $svnInfo !== false ) {
765 $vcsVersion = $this->msg( 'version-svn-revision', $svnInfo['checkout-rev'] )->text();
766 $vcsLink = isset( $svnInfo['viewvc-url'] ) ?
$svnInfo['viewvc-url'] : '';
769 $cache->set( $memcKey, array( $vcsVersion, $vcsLink, $vcsDate ), 60 * 60 * 24 );
771 wfDebug( "Pulled VCS info for extension {$extension['name']} from cache" );
775 $versionString = Html
::rawElement(
777 array( 'class' => 'mw-version-ext-version' ),
783 $vcsVerString = Linker
::makeExternalLink(
785 $this->msg( 'version-version', $vcsVersion ),
788 array( 'class' => 'mw-version-ext-vcs-version' )
791 $vcsVerString = Html
::element( 'span',
792 array( 'class' => 'mw-version-ext-vcs-version' ),
796 $versionString .= " {$vcsVerString}";
799 $vcsTimeString = Html
::element( 'span',
800 array( 'class' => 'mw-version-ext-vcs-timestamp' ),
801 $this->getLanguage()->timeanddate( $vcsDate, true )
803 $versionString .= " {$vcsTimeString}";
805 $versionString = Html
::rawElement( 'span',
806 array( 'class' => 'mw-version-ext-meta-version' ),
811 // ... and license information; if a license file exists we
814 if ( isset( $extension['name'] ) ) {
816 if ( isset( $extension['license-name'] ) ) {
817 $licenseName = $out->parseInline( $extension['license-name'] );
818 } elseif ( $this->getExtLicenseFileName( $extensionPath ) ) {
819 $licenseName = $this->msg( 'version-ext-license' );
821 if ( $licenseName !== null ) {
822 $licenseLink = Linker
::link(
823 $this->getPageTitle( 'License/' . $extension['name'] ),
826 'class' => 'mw-version-ext-license',
833 // ... and generate the description; which can be a parameterized l10n message
834 // in the form array( <msgname>, <parameter>, <parameter>... ) or just a straight
836 if ( isset( $extension['descriptionmsg'] ) ) {
837 // Localized description of extension
838 $descriptionMsg = $extension['descriptionmsg'];
840 if ( is_array( $descriptionMsg ) ) {
841 $descriptionMsgKey = $descriptionMsg[0]; // Get the message key
842 array_shift( $descriptionMsg ); // Shift out the message key to get the parameters only
843 array_map( "htmlspecialchars", $descriptionMsg ); // For sanity
844 $description = $this->msg( $descriptionMsgKey, $descriptionMsg )->text();
846 $description = $this->msg( $descriptionMsg )->text();
848 } elseif ( isset( $extension['description'] ) ) {
849 // Non localized version
850 $description = $extension['description'];
854 $description = $out->parseInline( $description );
856 // ... now get the authors for this extension
857 $authors = isset( $extension['author'] ) ?
$extension['author'] : array();
858 $authors = $this->listAuthors( $authors, $extension['name'], $extensionPath );
860 // Finally! Create the table
861 $html = Html
::openElement( 'tr', array(
862 'class' => 'mw-version-ext',
863 'id' => Sanitizer
::escapeId( 'mw-version-ext-' . $extension['name'] )
867 $html .= Html
::rawElement( 'td', array(), $extensionNameLink );
868 $html .= Html
::rawElement( 'td', array(), $versionString );
869 $html .= Html
::rawElement( 'td', array(), $licenseLink );
870 $html .= Html
::rawElement( 'td', array( 'class' => 'mw-version-ext-description' ), $description );
871 $html .= Html
::rawElement( 'td', array( 'class' => 'mw-version-ext-authors' ), $authors );
873 $html .= Html
::closeElement( 'tr' );
879 * Generate wikitext showing hooks in $wgHooks.
881 * @return string Wikitext
883 private function getWgHooks() {
884 global $wgSpecialVersionShowHooks, $wgHooks;
886 if ( $wgSpecialVersionShowHooks && count( $wgHooks ) ) {
887 $myWgHooks = $wgHooks;
891 $ret[] = '== {{int:version-hooks}} ==';
892 $ret[] = Html
::openElement( 'table', array( 'class' => 'wikitable', 'id' => 'sv-hooks' ) );
893 $ret[] = Html
::openElement( 'tr' );
894 $ret[] = Html
::element( 'th', array(), $this->msg( 'version-hook-name' )->text() );
895 $ret[] = Html
::element( 'th', array(), $this->msg( 'version-hook-subscribedby' )->text() );
896 $ret[] = Html
::closeElement( 'tr' );
898 foreach ( $myWgHooks as $hook => $hooks ) {
899 $ret[] = Html
::openElement( 'tr' );
900 $ret[] = Html
::element( 'td', array(), $hook );
901 $ret[] = Html
::element( 'td', array(), $this->listToText( $hooks ) );
902 $ret[] = Html
::closeElement( 'tr' );
905 $ret[] = Html
::closeElement( 'table' );
907 return implode( "\n", $ret );
913 private function openExtType( $text = null, $name = null ) {
916 $opt = array( 'colspan' => 5 );
917 if ( $this->firstExtOpened
) {
918 // Insert a spacing line
919 $out .= Html
::rawElement( 'tr', array( 'class' => 'sv-space' ),
920 Html
::element( 'td', $opt )
923 $this->firstExtOpened
= true;
926 $opt['id'] = "sv-$name";
929 if ( $text !== null ) {
930 $out .= Html
::rawElement( 'tr', array(),
931 Html
::element( 'th', $opt, $text )
935 $firstHeadingMsg = ( $name === 'credits-skin' )
936 ?
'version-skin-colheader-name'
937 : 'version-ext-colheader-name';
938 $out .= Html
::openElement( 'tr' );
939 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
940 $this->msg( $firstHeadingMsg )->text() );
941 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
942 $this->msg( 'version-ext-colheader-version' )->text() );
943 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
944 $this->msg( 'version-ext-colheader-license' )->text() );
945 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
946 $this->msg( 'version-ext-colheader-description' )->text() );
947 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
948 $this->msg( 'version-ext-colheader-credits' )->text() );
949 $out .= Html
::closeElement( 'tr' );
955 * Get information about client's IP address.
957 * @return string HTML fragment
959 private function IPInfo() {
960 $ip = str_replace( '--', ' - ', htmlspecialchars( $this->getRequest()->getIP() ) );
962 return "<!-- visited from $ip -->\n<span style='display:none'>visited from $ip</span>";
966 * Return a formatted unsorted list of authors
969 * If an item in the $authors array is '...' it is assumed to indicate an
970 * 'and others' string which will then be linked to an ((AUTHORS)|(CREDITS))(\.txt)?
971 * file if it exists in $dir.
973 * Similarly an entry ending with ' ...]' is assumed to be a link to an
976 * If no '...' string variant is found, but an authors file is found an
977 * 'and others' will be added to the end of the credits.
979 * @param string|array $authors
980 * @param string|bool $extName Name of the extension for link creation,
981 * false if no links should be created
982 * @param string $extDir Path to the extension root directory
984 * @return string HTML fragment
986 public function listAuthors( $authors, $extName, $extDir ) {
990 foreach ( (array)$authors as $item ) {
991 if ( $item == '...' ) {
994 if ( $extName && $this->getExtAuthorsFileName( $extDir ) ) {
995 $text = Linker
::link(
996 $this->getPageTitle( "Credits/$extName" ),
997 $this->msg( 'version-poweredby-others' )->escaped()
1000 $text = $this->msg( 'version-poweredby-others' )->escaped();
1003 } elseif ( substr( $item, -5 ) == ' ...]' ) {
1005 $list[] = $this->getOutput()->parseInline(
1006 substr( $item, 0, -4 ) . $this->msg( 'version-poweredby-others' )->text() . "]"
1009 $list[] = $this->getOutput()->parseInline( $item );
1013 if ( $extName && !$hasOthers && $this->getExtAuthorsFileName( $extDir ) ) {
1014 $list[] = $text = Linker
::link(
1015 $this->getPageTitle( "Credits/$extName" ),
1016 $this->msg( 'version-poweredby-others' )->escaped()
1020 return $this->listToText( $list, false );
1024 * Obtains the full path of an extensions authors or credits file if
1027 * @param string $extDir Path to the extensions root directory
1031 * @return bool|string False if no such file exists, otherwise returns
1034 public static function getExtAuthorsFileName( $extDir ) {
1039 foreach ( scandir( $extDir ) as $file ) {
1040 $fullPath = $extDir . DIRECTORY_SEPARATOR
. $file;
1041 if ( preg_match( '/^((AUTHORS)|(CREDITS))(\.txt)?$/', $file ) &&
1042 is_readable( $fullPath ) &&
1043 is_file( $fullPath )
1053 * Obtains the full path of an extensions copying or license file if
1056 * @param string $extDir Path to the extensions root directory
1060 * @return bool|string False if no such file exists, otherwise returns
1063 public static function getExtLicenseFileName( $extDir ) {
1068 foreach ( scandir( $extDir ) as $file ) {
1069 $fullPath = $extDir . DIRECTORY_SEPARATOR
. $file;
1070 if ( preg_match( '/^((COPYING)|(LICENSE))(\.txt)?$/', $file ) &&
1071 is_readable( $fullPath ) &&
1072 is_file( $fullPath )
1082 * Convert an array of items into a list for display.
1084 * @param array $list List of elements to display
1085 * @param bool $sort Whether to sort the items in $list
1089 public function listToText( $list, $sort = true ) {
1090 if ( !count( $list ) ) {
1097 return $this->getLanguage()
1098 ->listToText( array_map( array( __CLASS__
, 'arrayToString' ), $list ) );
1102 * Convert an array or object to a string for display.
1104 * @param mixed $list Will convert an array to string if given and return
1105 * the parameter unaltered otherwise
1109 public static function arrayToString( $list ) {
1110 if ( is_array( $list ) && count( $list ) == 1 ) {
1113 if ( is_object( $list ) ) {
1114 $class = wfMessage( 'parentheses' )->params( get_class( $list ) )->escaped();
1117 } elseif ( !is_array( $list ) ) {
1120 if ( is_object( $list[0] ) ) {
1121 $class = get_class( $list[0] );
1126 return wfMessage( 'parentheses' )->params( "$class, {$list[1]}" )->escaped();
1131 * Get an associative array of information about a given path, from its .svn
1132 * subdirectory. Returns false on error, such as if the directory was not
1133 * checked out with subversion.
1135 * Returned keys are:
1137 * checkout-rev The revision which was checked out
1139 * directory-rev The revision when the directory was last modified
1140 * url The subversion URL of the directory
1141 * repo-url The base URL of the repository
1142 * viewvc-url A ViewVC URL pointing to the checked-out revision
1143 * @param string $dir
1144 * @return array|bool
1146 public static function getSvnInfo( $dir ) {
1147 // http://svnbook.red-bean.com/nightly/en/svn.developer.insidewc.html
1148 $entries = $dir . '/.svn/entries';
1150 if ( !file_exists( $entries ) ) {
1154 $lines = file( $entries );
1155 if ( !count( $lines ) ) {
1159 // check if file is xml (subversion release <= 1.3) or not (subversion release = 1.4)
1160 if ( preg_match( '/^<\?xml/', $lines[0] ) ) {
1161 // subversion is release <= 1.3
1162 if ( !function_exists( 'simplexml_load_file' ) ) {
1163 // We could fall back to expat... YUCK
1167 // SimpleXml whines about the xmlns...
1168 MediaWiki\
suppressWarnings();
1169 $xml = simplexml_load_file( $entries );
1170 MediaWiki\restoreWarnings
();
1173 foreach ( $xml->entry
as $entry ) {
1174 if ( $xml->entry
[0]['name'] == '' ) {
1175 // The directory entry should always have a revision marker.
1176 if ( $entry['revision'] ) {
1177 return array( 'checkout-rev' => intval( $entry['revision'] ) );
1186 // Subversion is release 1.4 or above.
1187 if ( count( $lines ) < 11 ) {
1192 'checkout-rev' => intval( trim( $lines[3] ) ),
1193 'url' => trim( $lines[4] ),
1194 'repo-url' => trim( $lines[5] ),
1195 'directory-rev' => intval( trim( $lines[10] ) )
1198 if ( isset( self
::$viewvcUrls[$info['repo-url']] ) ) {
1199 $viewvc = str_replace(
1201 self
::$viewvcUrls[$info['repo-url']],
1205 $viewvc .= '/?pathrev=';
1206 $viewvc .= urlencode( $info['checkout-rev'] );
1207 $info['viewvc-url'] = $viewvc;
1214 * Retrieve the revision number of a Subversion working directory.
1216 * @param string $dir Directory of the svn checkout
1218 * @return int Revision number
1220 public static function getSvnRevision( $dir ) {
1221 $info = self
::getSvnInfo( $dir );
1223 if ( $info === false ) {
1225 } elseif ( isset( $info['checkout-rev'] ) ) {
1226 return $info['checkout-rev'];
1233 * @param string $dir Directory of the git checkout
1234 * @return bool|string Sha1 of commit HEAD points to
1236 public static function getGitHeadSha1( $dir ) {
1237 $repo = new GitInfo( $dir );
1239 return $repo->getHeadSHA1();
1243 * @param string $dir Directory of the git checkout
1244 * @return bool|string Branch currently checked out
1246 public static function getGitCurrentBranch( $dir ) {
1247 $repo = new GitInfo( $dir );
1248 return $repo->getCurrentBranch();
1252 * Get the list of entry points and their URLs
1253 * @return string Wikitext
1255 public function getEntryPointInfo() {
1256 global $wgArticlePath, $wgScriptPath;
1257 $scriptPath = $wgScriptPath ?
$wgScriptPath : "/";
1258 $entryPoints = array(
1259 'version-entrypoints-articlepath' => $wgArticlePath,
1260 'version-entrypoints-scriptpath' => $scriptPath,
1261 'version-entrypoints-index-php' => wfScript( 'index' ),
1262 'version-entrypoints-api-php' => wfScript( 'api' ),
1263 'version-entrypoints-load-php' => wfScript( 'load' ),
1266 $language = $this->getLanguage();
1267 $thAttribures = array(
1268 'dir' => $language->getDir(),
1269 'lang' => $language->getHtmlCode()
1271 $out = Html
::element(
1273 array( 'id' => 'mw-version-entrypoints' ),
1274 $this->msg( 'version-entrypoints' )->text()
1276 Html
::openElement( 'table',
1278 'class' => 'wikitable plainlinks',
1279 'id' => 'mw-version-entrypoints-table',
1284 Html
::openElement( 'tr' ) .
1288 $this->msg( 'version-entrypoints-header-entrypoint' )->text()
1293 $this->msg( 'version-entrypoints-header-url' )->text()
1295 Html
::closeElement( 'tr' );
1297 foreach ( $entryPoints as $message => $value ) {
1298 $url = wfExpandUrl( $value, PROTO_RELATIVE
);
1299 $out .= Html
::openElement( 'tr' ) .
1300 // ->text() looks like it should be ->parse(), but this function
1301 // returns wikitext, not HTML, boo
1302 Html
::rawElement( 'td', array(), $this->msg( $message )->text() ) .
1303 Html
::rawElement( 'td', array(), Html
::rawElement( 'code', array(), "[$url $value]" ) ) .
1304 Html
::closeElement( 'tr' );
1307 $out .= Html
::closeElement( 'table' );
1312 protected function getGroupName() {