Introduce mediawiki.RegExp module
[mediawiki.git] / includes / specials / SpecialVersion.php
blob4442d811e98d541f1395511f8949bbffe9c4ac74
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 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' );
51 /**
52 * main()
53 * @param string|null $par
55 public function execute( $par ) {
56 global $IP, $wgExtensionCredits;
58 $this->setHeaders();
59 $this->outputHeader();
60 $out = $this->getOutput();
61 $out->allowClickjacking();
63 // Explode the sub page information into useful bits
64 $parts = explode( '/', (string)$par );
65 $extNode = null;
66 if ( isset( $parts[1] ) ) {
67 $extName = str_replace( '_', ' ', $parts[1] );
68 // Find it!
69 foreach ( $wgExtensionCredits as $group => $extensions ) {
70 foreach ( $extensions as $ext ) {
71 if ( isset( $ext['name'] ) && ( $ext['name'] === $extName ) ) {
72 $extNode = &$ext;
73 break 2;
77 if ( !$extNode ) {
78 $out->setStatusCode( 404 );
80 } else {
81 $extName = 'MediaWiki';
84 // Now figure out what to do
85 switch ( strtolower( $parts[0] ) ) {
86 case 'credits':
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'] ) );
92 if ( $file ) {
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 );
102 break;
104 case 'license':
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'] ) );
110 if ( $file ) {
111 $wikiText = file_get_contents( $file );
112 $wikiText = "<pre>$wikiText</pre>";
116 $out->setPageTitle( $this->msg( 'version-license-title', $extName ) );
117 $out->addWikiText( $wikiText );
118 break;
120 default:
121 $out->addModules( 'mediawiki.special.version' );
122 $out->addWikiText(
123 $this->getMediaWikiCredits() .
124 $this->softwareInformation() .
125 $this->getEntryPointInfo()
127 $out->addHtml(
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() );
137 break;
142 * Returns wiki text showing the license information.
144 * @return string
146 private static function getMediaWikiCredits() {
147 $ret = Xml::element(
148 'h2',
149 array( 'id' => 'mw-version-license' ),
150 wfMessage( 'version-license' )->text()
153 // This text is always left-to-right.
154 $ret .= '<div class="plainlinks">';
155 $ret .= "__NOTOC__
156 " . self::getCopyrightAndAuthorList() . "\n
157 " . wfMessage( 'version-license-info' )->text();
158 $ret .= '</div>';
160 return str_replace( "\t\t", '', $ret ) . "\n";
164 * Get the "MediaWiki is copyright 2001-20xx by lots of cool guys" text
166 * @return string
168 public static function getCopyrightAndAuthorList() {
169 global $wgLang;
171 if ( defined( 'MEDIAWIKI_INSTALL' ) ) {
172 $othersLink = '[//www.mediawiki.org/wiki/Special:Version/Credits ' .
173 wfMessage( 'version-poweredby-others' )->text() . ']';
174 } else {
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() . ']';
182 $authorList = array(
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).
201 * @return string
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.
209 $software = array();
210 $software['[https://www.mediawiki.org/ MediaWiki]'] = self::getVersionLinked();
211 if ( wfIsHHVM() ) {
212 $software['[http://hhvm.com/ HHVM]'] = HHVM_VERSION . " (" . PHP_SAPI . ")";
213 } else {
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 ) );
221 $out = Xml::element(
222 'h2',
223 array( 'id' => 'mw-version-software' ),
224 wfMessage( 'version-software' )->text()
226 Xml::openElement( 'table', array( 'class' => 'wikitable plainlinks', 'id' => 'sv-software' ) ) .
227 "<tr>
228 <th>" . wfMessage( 'version-software-product' )->text() . "</th>
229 <th>" . wfMessage( 'version-software-version' )->text() . "</th>
230 </tr>\n";
232 foreach ( $software as $name => $version ) {
233 $out .= "<tr>
234 <td>" . $name . "</td>
235 <td dir=\"ltr\">" . $version . "</td>
236 </tr>\n";
239 return $out . Xml::closeElement( 'table' );
243 * Return a string of the MediaWiki version with SVN revision if available.
245 * @param string $flags
246 * @return mixed
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']})";
264 } else {
265 $version = $wgVersion . ' ' .
266 wfMessage(
267 'version-svn-revision',
268 isset( $svnInfo['directory-rev'] ) ? $svnInfo['directory-rev'] : '',
269 isset( $svnInfo['checkout-rev'] ) ? $svnInfo['checkout-rev'] : ''
270 )->text();
273 return $version;
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
282 * @return mixed
284 public static function getVersionLinked() {
285 global $wgVersion;
287 $gitVersion = self::getVersionLinkedGit();
288 if ( $gitVersion ) {
289 $v = $gitVersion;
290 } else {
291 $svnVersion = self::getVersionLinkedSvn();
292 if ( $svnVersion ) {
293 $v = $svnVersion;
294 } else {
295 $v = $wgVersion; // fallback
299 return $v;
303 * @return string Global wgVersion + a link to subversion revision of svn BASE
305 private static function getVersionLinkedSvn() {
306 global $IP;
308 $info = self::getSvnInfo( $IP );
309 if ( !isset( $info['checkout-rev'] ) ) {
310 return false;
313 $linkText = wfMessage(
314 'version-svn-revision',
315 isset( $info['directory-rev'] ) ? $info['directory-rev'] : '',
316 $info['checkout-rev']
317 )->text();
319 if ( isset( $info['viewvc-url'] ) ) {
320 $version = "[{$info['viewvc-url']} $linkText]";
321 } else {
322 $version = $linkText;
325 return self::getwgVersionLinked() . " $version";
329 * @return string
331 private static function getwgVersionLinked() {
332 global $wgVersion;
333 $versionUrl = "";
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() {
349 global $IP, $wgLang;
351 $gitInfo = new GitInfo( $IP );
352 $headSHA1 = $gitInfo->getHeadSHA1();
353 if ( !$headSHA1 ) {
354 return false;
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.
378 * @since 1.17
380 * @return array
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.
404 * @since 1.17
406 * @param string $type
408 * @return string
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;
424 if (
425 count( $wgExtensionCredits ) === 0 ||
426 // Skins are displayed separately, see getSkinCredits()
427 ( count( $wgExtensionCredits ) === 1 && isset( $wgExtensionCredits['skin'] ) )
429 return '';
432 $extensionTypes = self::getExtensionTypes();
434 $out = Xml::element(
435 'h2',
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' );
467 return $out;
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 ) {
478 return '';
481 $out = Xml::element(
482 'h2',
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' );
493 return $out;
497 * Generate an HTML table for external libraries that are installed
499 * @return string
501 protected function getExternalLibraries() {
502 global $IP;
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 ) ) {
508 return '';
512 $lock = new ComposerLock( $path );
513 $out = Html::element(
514 'h2',
515 array( 'id' => 'mw-version-libraries' ),
516 $this->msg( 'version-libraries' )->text()
518 $out .= Html::openElement(
519 'table',
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::closeElement( 'tr' );
527 foreach ( $lock->getInstalledDependencies() as $name => $info ) {
528 if ( strpos( $info['type'], 'mediawiki-' ) === 0 ) {
529 // Skip any extensions or skins since they'll be listed
530 // in their proper section
531 continue;
533 $out .= Html::openElement( 'tr' )
534 . Html::rawElement(
535 'td',
536 array(),
537 Linker::makeExternalLink( "https://packagist.org/packages/$name", $name )
539 . Html::element( 'td', array(), $info['version'] )
540 . Html::closeElement( 'tr' );
542 $out .= Html::closeElement( 'table' );
544 return $out;
548 * Obtains a list of installed parser tags and the associated H2 header
550 * @return string HTML output
552 protected function getParserTags() {
553 global $wgParser;
555 $tags = $wgParser->getTags();
557 if ( count( $tags ) ) {
558 $out = Html::rawElement(
559 'h2',
560 array( 'class' => 'mw-headline plainlinks' ),
561 Linker::makeExternalLink(
562 '//www.mediawiki.org/wiki/Special:MyLanguage/Manual:Tag_extensions',
563 $this->msg( 'version-parser-extensiontags' )->parse(),
564 false /* msg()->parse() already escapes */
568 array_walk( $tags, function ( &$value ) {
569 // Bidirectional isolation improves readability in RTL wikis
570 $value = Html::element(
571 'bdi',
572 // Prevent < and > from slipping to another line
573 array(
574 'style' => 'white-space: nowrap;',
576 "<$value>"
578 } );
580 $out .= $this->listToText( $tags );
581 } else {
582 $out = '';
585 return $out;
589 * Obtains a list of installed parser function hooks and the associated H2 header
591 * @return string HTML output
593 protected function getParserFunctionHooks() {
594 global $wgParser;
596 $fhooks = $wgParser->getFunctionHooks();
597 if ( count( $fhooks ) ) {
598 $out = Html::rawElement(
599 'h2',
600 array( 'class' => 'mw-headline plainlinks' ),
601 Linker::makeExternalLink(
602 '//www.mediawiki.org/wiki/Special:MyLanguage/Manual:Parser_functions',
603 $this->msg( 'version-parser-function-hooks' )->parse(),
604 false /* msg()->parse() already escapes */
608 $out .= $this->listToText( $fhooks );
609 } else {
610 $out = '';
613 return $out;
617 * Creates and returns the HTML for a single extension category.
619 * @since 1.17
621 * @param string $type
622 * @param string $message
624 * @return string
626 protected function getExtensionCategory( $type, $message ) {
627 global $wgExtensionCredits;
629 $out = '';
631 if ( array_key_exists( $type, $wgExtensionCredits ) && count( $wgExtensionCredits[$type] ) > 0 ) {
632 $out .= $this->openExtType( $message, 'credits-' . $type );
634 usort( $wgExtensionCredits[$type], array( $this, 'compare' ) );
636 foreach ( $wgExtensionCredits[$type] as $extension ) {
637 $out .= $this->getCreditsForExtension( $extension );
641 return $out;
645 * Callback to sort extensions by type.
646 * @param array $a
647 * @param array $b
648 * @return int
650 public function compare( $a, $b ) {
651 if ( $a['name'] === $b['name'] ) {
652 return 0;
653 } else {
654 return $this->getLanguage()->lc( $a['name'] ) > $this->getLanguage()->lc( $b['name'] )
656 : -1;
661 * Creates and formats a version line for a single extension.
663 * Information for five columns will be created. Parameters required in the
664 * $extension array for part rendering are indicated in ()
665 * - The name of (name), and URL link to (url), the extension
666 * - Official version number (version) and if available version control system
667 * revision (path), link, and date
668 * - If available the short name of the license (license-name) and a linke
669 * to ((LICENSE)|(COPYING))(\.txt)? if it exists.
670 * - Description of extension (descriptionmsg or description)
671 * - List of authors (author) and link to a ((AUTHORS)|(CREDITS))(\.txt)? file if it exists
673 * @param array $extension
675 * @return string Raw HTML
677 public function getCreditsForExtension( array $extension ) {
678 $out = $this->getOutput();
680 // We must obtain the information for all the bits and pieces!
681 // ... such as extension names and links
682 if ( isset( $extension['namemsg'] ) ) {
683 // Localized name of extension
684 $extensionName = $this->msg( $extension['namemsg'] )->text();
685 } elseif ( isset( $extension['name'] ) ) {
686 // Non localized version
687 $extensionName = $extension['name'];
688 } else {
689 $extensionName = $this->msg( 'version-no-ext-name' )->text();
692 if ( isset( $extension['url'] ) ) {
693 $extensionNameLink = Linker::makeExternalLink(
694 $extension['url'],
695 $extensionName,
696 true,
698 array( 'class' => 'mw-version-ext-name' )
700 } else {
701 $extensionNameLink = $extensionName;
704 // ... and the version information
705 // If the extension path is set we will check that directory for GIT and SVN
706 // metadata in an attempt to extract date and vcs commit metadata.
707 $canonicalVersion = '&ndash;';
708 $extensionPath = null;
709 $vcsVersion = null;
710 $vcsLink = null;
711 $vcsDate = null;
713 if ( isset( $extension['version'] ) ) {
714 $canonicalVersion = $out->parseInline( $extension['version'] );
717 if ( isset( $extension['path'] ) ) {
718 global $IP;
719 $extensionPath = dirname( $extension['path'] );
720 if ( $this->coreId == '' ) {
721 wfDebug( 'Looking up core head id' );
722 $coreHeadSHA1 = self::getGitHeadSha1( $IP );
723 if ( $coreHeadSHA1 ) {
724 $this->coreId = $coreHeadSHA1;
725 } else {
726 $svnInfo = self::getSvnInfo( $IP );
727 if ( $svnInfo !== false ) {
728 $this->coreId = $svnInfo['checkout-rev'];
732 $cache = wfGetCache( CACHE_ANYTHING );
733 $memcKey = wfMemcKey( 'specialversion-ext-version-text', $extension['path'], $this->coreId );
734 list( $vcsVersion, $vcsLink, $vcsDate ) = $cache->get( $memcKey );
736 if ( !$vcsVersion ) {
737 wfDebug( "Getting VCS info for extension {$extension['name']}" );
738 $gitInfo = new GitInfo( $extensionPath );
739 $vcsVersion = $gitInfo->getHeadSHA1();
740 if ( $vcsVersion !== false ) {
741 $vcsVersion = substr( $vcsVersion, 0, 7 );
742 $vcsLink = $gitInfo->getHeadViewUrl();
743 $vcsDate = $gitInfo->getHeadCommitDate();
744 } else {
745 $svnInfo = self::getSvnInfo( $extensionPath );
746 if ( $svnInfo !== false ) {
747 $vcsVersion = $this->msg( 'version-svn-revision', $svnInfo['checkout-rev'] )->text();
748 $vcsLink = isset( $svnInfo['viewvc-url'] ) ? $svnInfo['viewvc-url'] : '';
751 $cache->set( $memcKey, array( $vcsVersion, $vcsLink, $vcsDate ), 60 * 60 * 24 );
752 } else {
753 wfDebug( "Pulled VCS info for extension {$extension['name']} from cache" );
757 $versionString = Html::rawElement(
758 'span',
759 array( 'class' => 'mw-version-ext-version' ),
760 $canonicalVersion
763 if ( $vcsVersion ) {
764 if ( $vcsLink ) {
765 $vcsVerString = Linker::makeExternalLink(
766 $vcsLink,
767 $this->msg( 'version-version', $vcsVersion ),
768 true,
770 array( 'class' => 'mw-version-ext-vcs-version' )
772 } else {
773 $vcsVerString = Html::element( 'span',
774 array( 'class' => 'mw-version-ext-vcs-version' ),
775 "({$vcsVersion})"
778 $versionString .= " {$vcsVerString}";
780 if ( $vcsDate ) {
781 $vcsTimeString = Html::element( 'span',
782 array( 'class' => 'mw-version-ext-vcs-timestamp' ),
783 $this->getLanguage()->timeanddate( $vcsDate, true )
785 $versionString .= " {$vcsTimeString}";
787 $versionString = Html::rawElement( 'span',
788 array( 'class' => 'mw-version-ext-meta-version' ),
789 $versionString
793 // ... and license information; if a license file exists we
794 // will link to it
795 $licenseLink = '';
796 if ( isset( $extension['name'] ) ) {
797 $licenseName = null;
798 if ( isset( $extension['license-name'] ) ) {
799 $licenseName = $out->parseInline( $extension['license-name'] );
800 } elseif ( $this->getExtLicenseFileName( $extensionPath ) ) {
801 $licenseName = $this->msg( 'version-ext-license' );
803 if ( $licenseName !== null ) {
804 $licenseLink = Linker::link(
805 $this->getPageTitle( 'License/' . $extension['name'] ),
806 $licenseName,
807 array(
808 'class' => 'mw-version-ext-license',
809 'dir' => 'auto',
815 // ... and generate the description; which can be a parameterized l10n message
816 // in the form array( <msgname>, <parameter>, <parameter>... ) or just a straight
817 // up string
818 if ( isset( $extension['descriptionmsg'] ) ) {
819 // Localized description of extension
820 $descriptionMsg = $extension['descriptionmsg'];
822 if ( is_array( $descriptionMsg ) ) {
823 $descriptionMsgKey = $descriptionMsg[0]; // Get the message key
824 array_shift( $descriptionMsg ); // Shift out the message key to get the parameters only
825 array_map( "htmlspecialchars", $descriptionMsg ); // For sanity
826 $description = $this->msg( $descriptionMsgKey, $descriptionMsg )->text();
827 } else {
828 $description = $this->msg( $descriptionMsg )->text();
830 } elseif ( isset( $extension['description'] ) ) {
831 // Non localized version
832 $description = $extension['description'];
833 } else {
834 $description = '';
836 $description = $out->parseInline( $description );
838 // ... now get the authors for this extension
839 $authors = isset( $extension['author'] ) ? $extension['author'] : array();
840 $authors = $this->listAuthors( $authors, $extension['name'], $extensionPath );
842 // Finally! Create the table
843 $html = Html::openElement( 'tr', array(
844 'class' => 'mw-version-ext',
845 'id' => Sanitizer::escapeId( 'mw-version-ext-' . $extension['name'] )
849 $html .= Html::rawElement( 'td', array(), $extensionNameLink );
850 $html .= Html::rawElement( 'td', array(), $versionString );
851 $html .= Html::rawElement( 'td', array(), $licenseLink );
852 $html .= Html::rawElement( 'td', array( 'class' => 'mw-version-ext-description' ), $description );
853 $html .= Html::rawElement( 'td', array( 'class' => 'mw-version-ext-authors' ), $authors );
855 $html .= Html::closeElement( 'tr' );
857 return $html;
861 * Generate wikitext showing hooks in $wgHooks.
863 * @return string Wikitext
865 private function getWgHooks() {
866 global $wgSpecialVersionShowHooks, $wgHooks;
868 if ( $wgSpecialVersionShowHooks && count( $wgHooks ) ) {
869 $myWgHooks = $wgHooks;
870 ksort( $myWgHooks );
872 $ret = array();
873 $ret[] = '== {{int:version-hooks}} ==';
874 $ret[] = Html::openElement( 'table', array( 'class' => 'wikitable', 'id' => 'sv-hooks' ) );
875 $ret[] = Html::openElement( 'tr' );
876 $ret[] = Html::element( 'th', array(), $this->msg( 'version-hook-name' )->text() );
877 $ret[] = Html::element( 'th', array(), $this->msg( 'version-hook-subscribedby' )->text() );
878 $ret[] = Html::closeElement( 'tr' );
880 foreach ( $myWgHooks as $hook => $hooks ) {
881 $ret[] = Html::openElement( 'tr' );
882 $ret[] = Html::element( 'td', array(), $hook );
883 $ret[] = Html::element( 'td', array(), $this->listToText( $hooks ) );
884 $ret[] = Html::closeElement( 'tr' );
887 $ret[] = Html::closeElement( 'table' );
889 return implode( "\n", $ret );
890 } else {
891 return '';
895 private function openExtType( $text = null, $name = null ) {
896 $out = '';
898 $opt = array( 'colspan' => 5 );
899 if ( $this->firstExtOpened ) {
900 // Insert a spacing line
901 $out .= Html::rawElement( 'tr', array( 'class' => 'sv-space' ),
902 Html::element( 'td', $opt )
905 $this->firstExtOpened = true;
907 if ( $name ) {
908 $opt['id'] = "sv-$name";
911 if ( $text !== null ) {
912 $out .= Html::rawElement( 'tr', array(),
913 Html::element( 'th', $opt, $text )
917 $firstHeadingMsg = ( $name === 'credits-skin' )
918 ? 'version-skin-colheader-name'
919 : 'version-ext-colheader-name';
920 $out .= Html::openElement( 'tr' );
921 $out .= Html::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
922 $this->msg( $firstHeadingMsg )->text() );
923 $out .= Html::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
924 $this->msg( 'version-ext-colheader-version' )->text() );
925 $out .= Html::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
926 $this->msg( 'version-ext-colheader-license' )->text() );
927 $out .= Html::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
928 $this->msg( 'version-ext-colheader-description' )->text() );
929 $out .= Html::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
930 $this->msg( 'version-ext-colheader-credits' )->text() );
931 $out .= Html::closeElement( 'tr' );
933 return $out;
937 * Get information about client's IP address.
939 * @return string HTML fragment
941 private function IPInfo() {
942 $ip = str_replace( '--', ' - ', htmlspecialchars( $this->getRequest()->getIP() ) );
944 return "<!-- visited from $ip -->\n<span style='display:none'>visited from $ip</span>";
948 * Return a formatted unsorted list of authors
950 * 'And Others'
951 * If an item in the $authors array is '...' it is assumed to indicate an
952 * 'and others' string which will then be linked to an ((AUTHORS)|(CREDITS))(\.txt)?
953 * file if it exists in $dir.
955 * Similarly an entry ending with ' ...]' is assumed to be a link to an
956 * 'and others' page.
958 * If no '...' string variant is found, but an authors file is found an
959 * 'and others' will be added to the end of the credits.
961 * @param string|array $authors
962 * @param string $extName Name of the extension for link creation
963 * @param string $extDir Path to the extension root directory
965 * @return string HTML fragment
967 public function listAuthors( $authors, $extName, $extDir ) {
968 $hasOthers = false;
970 $list = array();
971 foreach ( (array)$authors as $item ) {
972 if ( $item == '...' ) {
973 $hasOthers = true;
975 if ( $this->getExtAuthorsFileName( $extDir ) ) {
976 $text = Linker::link(
977 $this->getPageTitle( "Credits/$extName" ),
978 $this->msg( 'version-poweredby-others' )->escaped()
980 } else {
981 $text = $this->msg( 'version-poweredby-others' )->escaped();
983 $list[] = $text;
984 } elseif ( substr( $item, -5 ) == ' ...]' ) {
985 $hasOthers = true;
986 $list[] = $this->getOutput()->parseInline(
987 substr( $item, 0, -4 ) . $this->msg( 'version-poweredby-others' )->text() . "]"
989 } else {
990 $list[] = $this->getOutput()->parseInline( $item );
994 if ( !$hasOthers && $this->getExtAuthorsFileName( $extDir ) ) {
995 $list[] = $text = Linker::link(
996 $this->getPageTitle( "Credits/$extName" ),
997 $this->msg( 'version-poweredby-others' )->escaped()
1001 return $this->listToText( $list, false );
1005 * Obtains the full path of an extensions authors or credits file if
1006 * one exists.
1008 * @param string $extDir Path to the extensions root directory
1010 * @since 1.23
1012 * @return bool|string False if no such file exists, otherwise returns
1013 * a path to it.
1015 public static function getExtAuthorsFileName( $extDir ) {
1016 if ( !$extDir ) {
1017 return false;
1020 foreach ( scandir( $extDir ) as $file ) {
1021 $fullPath = $extDir . DIRECTORY_SEPARATOR . $file;
1022 if ( preg_match( '/^((AUTHORS)|(CREDITS))(\.txt)?$/', $file ) &&
1023 is_readable( $fullPath ) &&
1024 is_file( $fullPath )
1026 return $fullPath;
1030 return false;
1034 * Obtains the full path of an extensions copying or license file if
1035 * one exists.
1037 * @param string $extDir Path to the extensions root directory
1039 * @since 1.23
1041 * @return bool|string False if no such file exists, otherwise returns
1042 * a path to it.
1044 public static function getExtLicenseFileName( $extDir ) {
1045 if ( !$extDir ) {
1046 return false;
1049 foreach ( scandir( $extDir ) as $file ) {
1050 $fullPath = $extDir . DIRECTORY_SEPARATOR . $file;
1051 if ( preg_match( '/^((COPYING)|(LICENSE))(\.txt)?$/', $file ) &&
1052 is_readable( $fullPath ) &&
1053 is_file( $fullPath )
1055 return $fullPath;
1059 return false;
1063 * Convert an array of items into a list for display.
1065 * @param array $list List of elements to display
1066 * @param bool $sort Whether to sort the items in $list
1068 * @return string
1070 public function listToText( $list, $sort = true ) {
1071 if ( !count( $list ) ) {
1072 return '';
1074 if ( $sort ) {
1075 sort( $list );
1078 return $this->getLanguage()
1079 ->listToText( array_map( array( __CLASS__, 'arrayToString' ), $list ) );
1083 * Convert an array or object to a string for display.
1085 * @param mixed $list Will convert an array to string if given and return
1086 * the parameter unaltered otherwise
1088 * @return mixed
1090 public static function arrayToString( $list ) {
1091 if ( is_array( $list ) && count( $list ) == 1 ) {
1092 $list = $list[0];
1094 if ( is_object( $list ) ) {
1095 $class = wfMessage( 'parentheses' )->params( get_class( $list ) )->escaped();
1097 return $class;
1098 } elseif ( !is_array( $list ) ) {
1099 return $list;
1100 } else {
1101 if ( is_object( $list[0] ) ) {
1102 $class = get_class( $list[0] );
1103 } else {
1104 $class = $list[0];
1107 return wfMessage( 'parentheses' )->params( "$class, {$list[1]}" )->escaped();
1112 * Get an associative array of information about a given path, from its .svn
1113 * subdirectory. Returns false on error, such as if the directory was not
1114 * checked out with subversion.
1116 * Returned keys are:
1117 * Required:
1118 * checkout-rev The revision which was checked out
1119 * Optional:
1120 * directory-rev The revision when the directory was last modified
1121 * url The subversion URL of the directory
1122 * repo-url The base URL of the repository
1123 * viewvc-url A ViewVC URL pointing to the checked-out revision
1124 * @param string $dir
1125 * @return array|bool
1127 public static function getSvnInfo( $dir ) {
1128 // http://svnbook.red-bean.com/nightly/en/svn.developer.insidewc.html
1129 $entries = $dir . '/.svn/entries';
1131 if ( !file_exists( $entries ) ) {
1132 return false;
1135 $lines = file( $entries );
1136 if ( !count( $lines ) ) {
1137 return false;
1140 // check if file is xml (subversion release <= 1.3) or not (subversion release = 1.4)
1141 if ( preg_match( '/^<\?xml/', $lines[0] ) ) {
1142 // subversion is release <= 1.3
1143 if ( !function_exists( 'simplexml_load_file' ) ) {
1144 // We could fall back to expat... YUCK
1145 return false;
1148 // SimpleXml whines about the xmlns...
1149 MediaWiki\suppressWarnings();
1150 $xml = simplexml_load_file( $entries );
1151 MediaWiki\restoreWarnings();
1153 if ( $xml ) {
1154 foreach ( $xml->entry as $entry ) {
1155 if ( $xml->entry[0]['name'] == '' ) {
1156 // The directory entry should always have a revision marker.
1157 if ( $entry['revision'] ) {
1158 return array( 'checkout-rev' => intval( $entry['revision'] ) );
1164 return false;
1167 // Subversion is release 1.4 or above.
1168 if ( count( $lines ) < 11 ) {
1169 return false;
1172 $info = array(
1173 'checkout-rev' => intval( trim( $lines[3] ) ),
1174 'url' => trim( $lines[4] ),
1175 'repo-url' => trim( $lines[5] ),
1176 'directory-rev' => intval( trim( $lines[10] ) )
1179 if ( isset( self::$viewvcUrls[$info['repo-url']] ) ) {
1180 $viewvc = str_replace(
1181 $info['repo-url'],
1182 self::$viewvcUrls[$info['repo-url']],
1183 $info['url']
1186 $viewvc .= '/?pathrev=';
1187 $viewvc .= urlencode( $info['checkout-rev'] );
1188 $info['viewvc-url'] = $viewvc;
1191 return $info;
1195 * Retrieve the revision number of a Subversion working directory.
1197 * @param string $dir Directory of the svn checkout
1199 * @return int Revision number
1201 public static function getSvnRevision( $dir ) {
1202 $info = self::getSvnInfo( $dir );
1204 if ( $info === false ) {
1205 return false;
1206 } elseif ( isset( $info['checkout-rev'] ) ) {
1207 return $info['checkout-rev'];
1208 } else {
1209 return false;
1214 * @param string $dir Directory of the git checkout
1215 * @return bool|string Sha1 of commit HEAD points to
1217 public static function getGitHeadSha1( $dir ) {
1218 $repo = new GitInfo( $dir );
1220 return $repo->getHeadSHA1();
1224 * @param string $dir Directory of the git checkout
1225 * @return bool|string Branch currently checked out
1227 public static function getGitCurrentBranch( $dir ) {
1228 $repo = new GitInfo( $dir );
1229 return $repo->getCurrentBranch();
1233 * Get the list of entry points and their URLs
1234 * @return string Wikitext
1236 public function getEntryPointInfo() {
1237 global $wgArticlePath, $wgScriptPath;
1238 $scriptPath = $wgScriptPath ? $wgScriptPath : "/";
1239 $entryPoints = array(
1240 'version-entrypoints-articlepath' => $wgArticlePath,
1241 'version-entrypoints-scriptpath' => $scriptPath,
1242 'version-entrypoints-index-php' => wfScript( 'index' ),
1243 'version-entrypoints-api-php' => wfScript( 'api' ),
1244 'version-entrypoints-load-php' => wfScript( 'load' ),
1247 $language = $this->getLanguage();
1248 $thAttribures = array(
1249 'dir' => $language->getDir(),
1250 'lang' => $language->getHtmlCode()
1252 $out = Html::element(
1253 'h2',
1254 array( 'id' => 'mw-version-entrypoints' ),
1255 $this->msg( 'version-entrypoints' )->text()
1257 Html::openElement( 'table',
1258 array(
1259 'class' => 'wikitable plainlinks',
1260 'id' => 'mw-version-entrypoints-table',
1261 'dir' => 'ltr',
1262 'lang' => 'en'
1265 Html::openElement( 'tr' ) .
1266 Html::element(
1267 'th',
1268 $thAttribures,
1269 $this->msg( 'version-entrypoints-header-entrypoint' )->text()
1271 Html::element(
1272 'th',
1273 $thAttribures,
1274 $this->msg( 'version-entrypoints-header-url' )->text()
1276 Html::closeElement( 'tr' );
1278 foreach ( $entryPoints as $message => $value ) {
1279 $url = wfExpandUrl( $value, PROTO_RELATIVE );
1280 $out .= Html::openElement( 'tr' ) .
1281 // ->text() looks like it should be ->parse(), but this function
1282 // returns wikitext, not HTML, boo
1283 Html::rawElement( 'td', array(), $this->msg( $message )->text() ) .
1284 Html::rawElement( 'td', array(), Html::rawElement( 'code', array(), "[$url $value]" ) ) .
1285 Html::closeElement( 'tr' );
1288 $out .= Html::closeElement( 'table' );
1290 return $out;
1293 protected function getGroupName() {
1294 return 'wiki';