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 if ( !isset( $extNode['license-name'] ) ) {
113 // If the developer did not explicitly set license-name they probably
114 // are unaware that we're now sucking this file in and thus it's probably
115 // not wikitext friendly.
116 $wikiText = "<pre>$wikiText</pre>";
121 $out->setPageTitle( $this->msg( 'version-license-title', $extName ) );
122 $out->addWikiText( $wikiText );
126 $out->addModules( 'mediawiki.special.version' );
128 $this->getMediaWikiCredits() .
129 $this->softwareInformation() .
130 $this->getEntryPointInfo()
133 $this->getSkinCredits() .
134 $this->getExtensionCredits() .
135 $this->getExternalLibraries() .
136 $this->getParserTags() .
137 $this->getParserFunctionHooks()
139 $out->addWikiText( $this->getWgHooks() );
140 $out->addHTML( $this->IPInfo() );
147 * Returns wiki text showing the license information.
151 private static function getMediaWikiCredits() {
154 array( 'id' => 'mw-version-license' ),
155 wfMessage( 'version-license' )->text()
158 // This text is always left-to-right.
159 $ret .= '<div class="plainlinks">';
161 " . self
::getCopyrightAndAuthorList() . "\n
162 " . wfMessage( 'version-license-info' )->text();
165 return str_replace( "\t\t", '', $ret ) . "\n";
169 * Get the "MediaWiki is copyright 2001-20xx by lots of cool guys" text
173 public static function getCopyrightAndAuthorList() {
176 if ( defined( 'MEDIAWIKI_INSTALL' ) ) {
177 $othersLink = '[//www.mediawiki.org/wiki/Special:Version/Credits ' .
178 wfMessage( 'version-poweredby-others' )->text() . ']';
180 $othersLink = '[[Special:Version/Credits|' .
181 wfMessage( 'version-poweredby-others' )->text() . ']]';
184 $translatorsLink = '[//translatewiki.net/wiki/Translating:MediaWiki/Credits ' .
185 wfMessage( 'version-poweredby-translators' )->text() . ']';
188 'Magnus Manske', 'Brion Vibber', 'Lee Daniel Crocker',
189 'Tim Starling', 'Erik Möller', 'Gabriel Wicke', 'Ævar Arnfjörð Bjarmason',
190 'Niklas Laxström', 'Domas Mituzas', 'Rob Church', 'Yuri Astrakhan',
191 'Aryeh Gregor', 'Aaron Schulz', 'Andrew Garrett', 'Raimond Spekking',
192 'Alexandre Emsenhuber', 'Siebrand Mazeland', 'Chad Horohoe',
193 'Roan Kattouw', 'Trevor Parscal', 'Bryan Tong Minh', 'Sam Reed',
194 'Victor Vasiliev', 'Rotem Liss', 'Platonides', 'Antoine Musso',
195 'Timo Tijhof', 'Daniel Kinzler', 'Jeroen De Dauw', 'Brad Jorsch',
196 $othersLink, $translatorsLink
199 return wfMessage( 'version-poweredby-credits', MWTimestamp
::getLocalInstance()->format( 'Y' ),
200 $wgLang->listToText( $authorList ) )->text();
204 * Returns wiki text showing the third party software versions (apache, php, mysql).
208 public static function softwareInformation() {
209 $dbr = wfGetDB( DB_SLAVE
);
211 // Put the software in an array of form 'name' => 'version'. All messages should
212 // be loaded here, so feel free to use wfMessage in the 'name'. Raw HTML or
213 // wikimarkup can be used.
215 $software['[https://www.mediawiki.org/ MediaWiki]'] = self
::getVersionLinked();
217 $software['[http://hhvm.com/ HHVM]'] = HHVM_VERSION
. " (" . PHP_SAPI
. ")";
219 $software['[https://php.net/ PHP]'] = PHP_VERSION
. " (" . PHP_SAPI
. ")";
221 $software[$dbr->getSoftwareLink()] = $dbr->getServerInfo();
223 // Allow a hook to add/remove items.
224 Hooks
::run( 'SoftwareInfo', array( &$software ) );
228 array( 'id' => 'mw-version-software' ),
229 wfMessage( 'version-software' )->text()
231 Xml
::openElement( 'table', array( 'class' => 'wikitable plainlinks', 'id' => 'sv-software' ) ) .
233 <th>" . wfMessage( 'version-software-product' )->text() . "</th>
234 <th>" . wfMessage( 'version-software-version' )->text() . "</th>
237 foreach ( $software as $name => $version ) {
239 <td>" . $name . "</td>
240 <td dir=\"ltr\">" . $version . "</td>
244 return $out . Xml
::closeElement( 'table' );
248 * Return a string of the MediaWiki version with SVN revision if available.
250 * @param string $flags
253 public static function getVersion( $flags = '' ) {
254 global $wgVersion, $IP;
255 wfProfileIn( __METHOD__
);
257 $gitInfo = self
::getGitHeadSha1( $IP );
258 $svnInfo = self
::getSvnInfo( $IP );
259 if ( !$svnInfo && !$gitInfo ) {
260 $version = $wgVersion;
261 } elseif ( $gitInfo && $flags === 'nodb' ) {
262 $shortSha1 = substr( $gitInfo, 0, 7 );
263 $version = "$wgVersion ($shortSha1)";
264 } elseif ( $gitInfo ) {
265 $shortSha1 = substr( $gitInfo, 0, 7 );
266 $shortSha1 = wfMessage( 'parentheses' )->params( $shortSha1 )->escaped();
267 $version = "$wgVersion $shortSha1";
268 } elseif ( $flags === 'nodb' ) {
269 $version = "$wgVersion (r{$svnInfo['checkout-rev']})";
271 $version = $wgVersion . ' ' .
273 'version-svn-revision',
274 isset( $info['directory-rev'] ) ?
$info['directory-rev'] : '',
275 $info['checkout-rev']
279 wfProfileOut( __METHOD__
);
285 * Return a wikitext-formatted string of the MediaWiki version with a link to
286 * the SVN revision or the git SHA1 of head if available.
287 * Git is prefered over Svn
288 * The fallback is just $wgVersion
292 public static function getVersionLinked() {
294 wfProfileIn( __METHOD__
);
296 $gitVersion = self
::getVersionLinkedGit();
300 $svnVersion = self
::getVersionLinkedSvn();
304 $v = $wgVersion; // fallback
308 wfProfileOut( __METHOD__
);
314 * @return string Global wgVersion + a link to subversion revision of svn BASE
316 private static function getVersionLinkedSvn() {
319 $info = self
::getSvnInfo( $IP );
320 if ( !isset( $info['checkout-rev'] ) ) {
324 $linkText = wfMessage(
325 'version-svn-revision',
326 isset( $info['directory-rev'] ) ?
$info['directory-rev'] : '',
327 $info['checkout-rev']
330 if ( isset( $info['viewvc-url'] ) ) {
331 $version = "[{$info['viewvc-url']} $linkText]";
333 $version = $linkText;
336 return self
::getwgVersionLinked() . " $version";
342 private static function getwgVersionLinked() {
345 if ( Hooks
::run( 'SpecialVersionVersionUrl', array( $wgVersion, &$versionUrl ) ) ) {
346 $versionParts = array();
347 preg_match( "/^(\d+\.\d+)/", $wgVersion, $versionParts );
348 $versionUrl = "https://www.mediawiki.org/wiki/MediaWiki_{$versionParts[1]}";
351 return "[$versionUrl $wgVersion]";
355 * @since 1.22 Returns the HEAD date in addition to the sha1 and link
356 * @return bool|string Global wgVersion + HEAD sha1 stripped to the first 7 chars
357 * with link and date, or false on failure
359 private static function getVersionLinkedGit() {
362 $gitInfo = new GitInfo( $IP );
363 $headSHA1 = $gitInfo->getHeadSHA1();
368 $shortSHA1 = '(' . substr( $headSHA1, 0, 7 ) . ')';
370 $gitHeadUrl = $gitInfo->getHeadViewUrl();
371 if ( $gitHeadUrl !== false ) {
372 $shortSHA1 = "[$gitHeadUrl $shortSHA1]";
375 $gitHeadCommitDate = $gitInfo->getHeadCommitDate();
376 if ( $gitHeadCommitDate ) {
377 $shortSHA1 .= Html
::element( 'br' ) . $wgLang->timeanddate( $gitHeadCommitDate, true );
380 return self
::getwgVersionLinked() . " $shortSHA1";
384 * Returns an array with the base extension types.
385 * Type is stored as array key, the message as array value.
387 * TODO: ideally this would return all extension types.
393 public static function getExtensionTypes() {
394 if ( self
::$extensionTypes === false ) {
395 self
::$extensionTypes = array(
396 'specialpage' => wfMessage( 'version-specialpages' )->text(),
397 'parserhook' => wfMessage( 'version-parserhooks' )->text(),
398 'variable' => wfMessage( 'version-variables' )->text(),
399 'media' => wfMessage( 'version-mediahandlers' )->text(),
400 'antispam' => wfMessage( 'version-antispam' )->text(),
401 'skin' => wfMessage( 'version-skins' )->text(),
402 'api' => wfMessage( 'version-api' )->text(),
403 'other' => wfMessage( 'version-other' )->text(),
406 Hooks
::run( 'ExtensionTypes', array( &self
::$extensionTypes ) );
409 return self
::$extensionTypes;
413 * Returns the internationalized name for an extension type.
417 * @param string $type
421 public static function getExtensionTypeName( $type ) {
422 $types = self
::getExtensionTypes();
424 return isset( $types[$type] ) ?
$types[$type] : $types['other'];
428 * Generate wikitext showing the name, URL, author and description of each extension.
430 * @return string Wikitext
432 public function getExtensionCredits() {
433 global $wgExtensionCredits;
436 count( $wgExtensionCredits ) === 0 ||
437 // Skins are displayed separately, see getSkinCredits()
438 ( count( $wgExtensionCredits ) === 1 && isset( $wgExtensionCredits['skin'] ) )
443 $extensionTypes = self
::getExtensionTypes();
447 array( 'id' => 'mw-version-ext' ),
448 $this->msg( 'version-extensions' )->text()
450 Xml
::openElement( 'table', array( 'class' => 'wikitable plainlinks', 'id' => 'sv-ext' ) );
452 // Make sure the 'other' type is set to an array.
453 if ( !array_key_exists( 'other', $wgExtensionCredits ) ) {
454 $wgExtensionCredits['other'] = array();
457 // Find all extensions that do not have a valid type and give them the type 'other'.
458 foreach ( $wgExtensionCredits as $type => $extensions ) {
459 if ( !array_key_exists( $type, $extensionTypes ) ) {
460 $wgExtensionCredits['other'] = array_merge( $wgExtensionCredits['other'], $extensions );
464 $this->firstExtOpened
= false;
465 // Loop through the extension categories to display their extensions in the list.
466 foreach ( $extensionTypes as $type => $message ) {
467 // Skins have a separate section
468 if ( $type !== 'other' && $type !== 'skin' ) {
469 $out .= $this->getExtensionCategory( $type, $message );
473 // We want the 'other' type to be last in the list.
474 $out .= $this->getExtensionCategory( 'other', $extensionTypes['other'] );
476 $out .= Xml
::closeElement( 'table' );
482 * Generate wikitext showing the name, URL, author and description of each skin.
484 * @return string Wikitext
486 public function getSkinCredits() {
487 global $wgExtensionCredits;
488 if ( !isset( $wgExtensionCredits['skin'] ) ||
count( $wgExtensionCredits['skin'] ) === 0 ) {
494 array( 'id' => 'mw-version-skin' ),
495 $this->msg( 'version-skins' )->text()
497 Xml
::openElement( 'table', array( 'class' => 'wikitable plainlinks', 'id' => 'sv-skin' ) );
499 $this->firstExtOpened
= false;
500 $out .= $this->getExtensionCategory( 'skin', null );
502 $out .= Xml
::closeElement( 'table' );
508 * Generate an HTML table for external libraries that are installed
512 protected function getExternalLibraries() {
514 $path = "$IP/composer.lock";
515 if ( !file_exists( $path ) ) {
516 // Maybe they're using mediawiki/vendor?
517 $path = "$IP/vendor/composer.lock";
518 if ( !file_exists( $path ) ) {
523 $lock = new ComposerLock( $path );
524 $out = Html
::element(
526 array( 'id' => 'mw-version-libraries' ),
527 $this->msg( 'version-libraries' )->text()
529 $out .= Html
::openElement( 'table', array( 'class' => 'wikitable plainlinks', 'id' => 'sv-libraries' ) );
530 $out .= Html
::openElement( 'tr' )
531 . Html
::element( 'th', array(), $this->msg( 'version-libraries-library' )->text() )
532 . Html
::element( 'th', array(), $this->msg( 'version-libraries-version' )->text() )
533 . Html
::closeElement( 'tr' );
535 foreach ( $lock->getInstalledDependencies() as $name => $info ) {
536 if ( strpos( $info['type'], 'mediawiki-' ) === 0 ) {
537 // Skip any extensions or skins since they'll be listed
538 // in their proper section
541 $out .= Html
::openElement( 'tr' )
542 . Html
::rawElement( 'td', array(), Linker
::makeExternalLink( "https://packagist.org/packages/$name", $name ) )
543 . Html
::element( 'td', array(), $info['version'] )
544 . Html
::closeElement( 'tr' );
546 $out .= Html
::closeElement( 'table' );
552 * Obtains a list of installed parser tags and the associated H2 header
554 * @return string HTML output
556 protected function getParserTags() {
559 $tags = $wgParser->getTags();
561 if ( count( $tags ) ) {
562 $out = Html
::rawElement(
564 array( 'class' => 'mw-headline' ),
565 Linker
::makeExternalLink(
566 '//www.mediawiki.org/wiki/Special:MyLanguage/Manual:Tag_extensions',
567 $this->msg( 'version-parser-extensiontags' )->parse(),
568 false /* msg()->parse() already escapes */
572 array_walk( $tags, function ( &$value ) {
573 // Bidirectional isolation improves readability in RTL wikis
574 $value = Html
::element(
576 // Prevent < and > from slipping to another line
578 'style' => 'white-space: nowrap;',
584 $out .= $this->listToText( $tags );
593 * Obtains a list of installed parser function hooks and the associated H2 header
595 * @return string HTML output
597 protected function getParserFunctionHooks() {
600 $fhooks = $wgParser->getFunctionHooks();
601 if ( count( $fhooks ) ) {
602 $out = Html
::rawElement( 'h2', array( 'class' => 'mw-headline' ), Linker
::makeExternalLink(
603 '//www.mediawiki.org/wiki/Special:MyLanguage/Manual:Parser_functions',
604 $this->msg( 'version-parser-function-hooks' )->parse(),
605 false /* msg()->parse() already escapes */
608 $out .= $this->listToText( $fhooks );
617 * Creates and returns the HTML for a single extension category.
621 * @param string $type
622 * @param string $message
626 protected function getExtensionCategory( $type, $message ) {
627 global $wgExtensionCredits;
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 );
645 * Callback to sort extensions by type.
650 public function compare( $a, $b ) {
651 if ( $a['name'] === $b['name'] ) {
654 return $this->getLanguage()->lc( $a['name'] ) > $this->getLanguage()->lc( $b['name'] )
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'];
689 $extensionName = $this->msg( 'version-no-ext-name' )->text();
692 if ( isset( $extension['url'] ) ) {
693 $extensionNameLink = Linker
::makeExternalLink(
698 array( 'class' => 'mw-version-ext-name' )
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 = '–';
708 $extensionPath = null;
713 if ( isset( $extension['version'] ) ) {
714 $canonicalVersion = $out->parseInline( $extension['version'] );
717 if ( isset( $extension['path'] ) ) {
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;
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 $extensionName" );
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();
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 );
753 wfDebug( "Pulled VCS info for extension $extensionName from cache" );
757 $versionString = Html
::rawElement(
759 array( 'class' => 'mw-version-ext-version' ),
765 $vcsVerString = Linker
::makeExternalLink(
767 $this->msg( 'version-version', $vcsVersion ),
770 array( 'class' => 'mw-version-ext-vcs-version' )
773 $vcsVerString = Html
::element( 'span',
774 array( 'class' => 'mw-version-ext-vcs-version' ),
778 $versionString .= " {$vcsVerString}";
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' ),
793 // ... and license information; if a license file exists we
796 if ( isset( $extension['license-name'] ) ) {
797 $licenseLink = Linker
::link(
798 $this->getPageTitle( 'License/' . $extensionName ),
799 $out->parseInline( $extension['license-name'] ),
801 'class' => 'mw-version-ext-license',
805 } elseif ( $this->getExtLicenseFileName( $extensionPath ) ) {
806 $licenseLink = Linker
::link(
807 $this->getPageTitle( 'License/' . $extensionName ),
808 $this->msg( 'version-ext-license' ),
810 'class' => 'mw-version-ext-license',
816 // ... and generate the description; which can be a parameterized l10n message
817 // in the form array( <msgname>, <parameter>, <parameter>... ) or just a straight
819 if ( isset( $extension['descriptionmsg'] ) ) {
820 // Localized description of extension
821 $descriptionMsg = $extension['descriptionmsg'];
823 if ( is_array( $descriptionMsg ) ) {
824 $descriptionMsgKey = $descriptionMsg[0]; // Get the message key
825 array_shift( $descriptionMsg ); // Shift out the message key to get the parameters only
826 array_map( "htmlspecialchars", $descriptionMsg ); // For sanity
827 $description = $this->msg( $descriptionMsgKey, $descriptionMsg )->text();
829 $description = $this->msg( $descriptionMsg )->text();
831 } elseif ( isset( $extension['description'] ) ) {
832 // Non localized version
833 $description = $extension['description'];
837 $description = $out->parseInline( $description );
839 // ... now get the authors for this extension
840 $authors = isset( $extension['author'] ) ?
$extension['author'] : array();
841 $authors = $this->listAuthors( $authors, $extensionName, $extensionPath );
843 // Finally! Create the table
844 $html = Html
::openElement( 'tr', array(
845 'class' => 'mw-version-ext',
846 'id' => "mw-version-ext-{$extensionName}"
850 $html .= Html
::rawElement( 'td', array(), $extensionNameLink );
851 $html .= Html
::rawElement( 'td', array(), $versionString );
852 $html .= Html
::rawElement( 'td', array(), $licenseLink );
853 $html .= Html
::rawElement( 'td', array( 'class' => 'mw-version-ext-description' ), $description );
854 $html .= Html
::rawElement( 'td', array( 'class' => 'mw-version-ext-authors' ), $authors );
856 $html .= Html
::closeElement( 'tr' );
862 * Generate wikitext showing hooks in $wgHooks.
864 * @return string Wikitext
866 private function getWgHooks() {
867 global $wgSpecialVersionShowHooks, $wgHooks;
869 if ( $wgSpecialVersionShowHooks && count( $wgHooks ) ) {
870 $myWgHooks = $wgHooks;
874 $ret[] = '== {{int:version-hooks}} ==';
875 $ret[] = Html
::openElement( 'table', array( 'class' => 'wikitable', 'id' => 'sv-hooks' ) );
876 $ret[] = Html
::openElement( 'tr' );
877 $ret[] = Html
::element( 'th', array(), $this->msg( 'version-hook-name' )->text() );
878 $ret[] = Html
::element( 'th', array(), $this->msg( 'version-hook-subscribedby' )->text() );
879 $ret[] = Html
::closeElement( 'tr' );
881 foreach ( $myWgHooks as $hook => $hooks ) {
882 $ret[] = Html
::openElement( 'tr' );
883 $ret[] = Html
::element( 'td', array(), $hook );
884 $ret[] = Html
::element( 'td', array(), $this->listToText( $hooks ) );
885 $ret[] = Html
::closeElement( 'tr' );
888 $ret[] = Html
::closeElement( 'table' );
890 return implode( "\n", $ret );
896 private function openExtType( $text = null, $name = null ) {
899 $opt = array( 'colspan' => 5 );
900 if ( $this->firstExtOpened
) {
901 // Insert a spacing line
902 $out .= Html
::rawElement( 'tr', array( 'class' => 'sv-space' ),
903 Html
::element( 'td', $opt )
906 $this->firstExtOpened
= true;
909 $opt['id'] = "sv-$name";
912 if ( $text !== null ) {
913 $out .= Html
::rawElement( 'tr', array(),
914 Html
::element( 'th', $opt, $text )
918 $firstHeadingMsg = ( $name === 'credits-skin' )
919 ?
'version-skin-colheader-name'
920 : 'version-ext-colheader-name';
921 $out .= Html
::openElement( 'tr' );
922 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
923 $this->msg( $firstHeadingMsg )->text() );
924 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
925 $this->msg( 'version-ext-colheader-version' )->text() );
926 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
927 $this->msg( 'version-ext-colheader-license' )->text() );
928 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
929 $this->msg( 'version-ext-colheader-description' )->text() );
930 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
931 $this->msg( 'version-ext-colheader-credits' )->text() );
932 $out .= Html
::closeElement( 'tr' );
938 * Get information about client's IP address.
940 * @return string HTML fragment
942 private function IPInfo() {
943 $ip = str_replace( '--', ' - ', htmlspecialchars( $this->getRequest()->getIP() ) );
945 return "<!-- visited from $ip -->\n<span style='display:none'>visited from $ip</span>";
949 * Return a formatted unsorted list of authors
952 * If an item in the $authors array is '...' it is assumed to indicate an
953 * 'and others' string which will then be linked to an ((AUTHORS)|(CREDITS))(\.txt)?
954 * file if it exists in $dir.
956 * Similarly an entry ending with ' ...]' is assumed to be a link to an
959 * If no '...' string variant is found, but an authors file is found an
960 * 'and others' will be added to the end of the credits.
962 * @param string|array $authors
963 * @param string $extName Name of the extension for link creation
964 * @param string $extDir Path to the extension root directory
966 * @return string HTML fragment
968 public function listAuthors( $authors, $extName, $extDir ) {
972 foreach ( (array)$authors as $item ) {
973 if ( $item == '...' ) {
976 if ( $this->getExtAuthorsFileName( $extDir ) ) {
977 $text = Linker
::link(
978 $this->getPageTitle( "Credits/$extName" ),
979 $this->msg( 'version-poweredby-others' )->text()
982 $text = $this->msg( 'version-poweredby-others' )->text();
985 } elseif ( substr( $item, -5 ) == ' ...]' ) {
987 $list[] = $this->getOutput()->parseInline(
988 substr( $item, 0, -4 ) . $this->msg( 'version-poweredby-others' )->text() . "]"
991 $list[] = $this->getOutput()->parseInline( $item );
995 if ( !$hasOthers && $this->getExtAuthorsFileName( $extDir ) ) {
996 $list[] = $text = Linker
::link(
997 $this->getPageTitle( "Credits/$extName" ),
998 $this->msg( 'version-poweredby-others' )->text()
1002 return $this->listToText( $list, false );
1006 * Obtains the full path of an extensions authors or credits file if
1009 * @param string $extDir Path to the extensions root directory
1013 * @return bool|string False if no such file exists, otherwise returns
1016 public static function getExtAuthorsFileName( $extDir ) {
1021 foreach ( scandir( $extDir ) as $file ) {
1022 $fullPath = $extDir . DIRECTORY_SEPARATOR
. $file;
1023 if ( preg_match( '/^((AUTHORS)|(CREDITS))(\.txt)?$/', $file ) &&
1024 is_readable( $fullPath ) &&
1025 is_file( $fullPath )
1035 * Obtains the full path of an extensions copying or license file if
1038 * @param string $extDir Path to the extensions root directory
1042 * @return bool|string False if no such file exists, otherwise returns
1045 public static function getExtLicenseFileName( $extDir ) {
1050 foreach ( scandir( $extDir ) as $file ) {
1051 $fullPath = $extDir . DIRECTORY_SEPARATOR
. $file;
1052 if ( preg_match( '/^((COPYING)|(LICENSE))(\.txt)?$/', $file ) &&
1053 is_readable( $fullPath ) &&
1054 is_file( $fullPath )
1064 * Convert an array of items into a list for display.
1066 * @param array $list List of elements to display
1067 * @param bool $sort Whether to sort the items in $list
1071 public function listToText( $list, $sort = true ) {
1072 if ( !count( $list ) ) {
1079 return $this->getLanguage()
1080 ->listToText( array_map( array( __CLASS__
, 'arrayToString' ), $list ) );
1084 * Convert an array or object to a string for display.
1086 * @param mixed $list Will convert an array to string if given and return
1087 * the parameter unaltered otherwise
1091 public static function arrayToString( $list ) {
1092 if ( is_array( $list ) && count( $list ) == 1 ) {
1095 if ( is_object( $list ) ) {
1096 $class = wfMessage( 'parentheses' )->params( get_class( $list ) )->escaped();
1099 } elseif ( !is_array( $list ) ) {
1102 if ( is_object( $list[0] ) ) {
1103 $class = get_class( $list[0] );
1108 return wfMessage( 'parentheses' )->params( "$class, {$list[1]}" )->escaped();
1113 * Get an associative array of information about a given path, from its .svn
1114 * subdirectory. Returns false on error, such as if the directory was not
1115 * checked out with subversion.
1117 * Returned keys are:
1119 * checkout-rev The revision which was checked out
1121 * directory-rev The revision when the directory was last modified
1122 * url The subversion URL of the directory
1123 * repo-url The base URL of the repository
1124 * viewvc-url A ViewVC URL pointing to the checked-out revision
1125 * @param string $dir
1126 * @return array|bool
1128 public static function getSvnInfo( $dir ) {
1129 // http://svnbook.red-bean.com/nightly/en/svn.developer.insidewc.html
1130 $entries = $dir . '/.svn/entries';
1132 if ( !file_exists( $entries ) ) {
1136 $lines = file( $entries );
1137 if ( !count( $lines ) ) {
1141 // check if file is xml (subversion release <= 1.3) or not (subversion release = 1.4)
1142 if ( preg_match( '/^<\?xml/', $lines[0] ) ) {
1143 // subversion is release <= 1.3
1144 if ( !function_exists( 'simplexml_load_file' ) ) {
1145 // We could fall back to expat... YUCK
1149 // SimpleXml whines about the xmlns...
1150 wfSuppressWarnings();
1151 $xml = simplexml_load_file( $entries );
1152 wfRestoreWarnings();
1155 foreach ( $xml->entry
as $entry ) {
1156 if ( $xml->entry
[0]['name'] == '' ) {
1157 // The directory entry should always have a revision marker.
1158 if ( $entry['revision'] ) {
1159 return array( 'checkout-rev' => intval( $entry['revision'] ) );
1168 // Subversion is release 1.4 or above.
1169 if ( count( $lines ) < 11 ) {
1174 'checkout-rev' => intval( trim( $lines[3] ) ),
1175 'url' => trim( $lines[4] ),
1176 'repo-url' => trim( $lines[5] ),
1177 'directory-rev' => intval( trim( $lines[10] ) )
1180 if ( isset( self
::$viewvcUrls[$info['repo-url']] ) ) {
1181 $viewvc = str_replace(
1183 self
::$viewvcUrls[$info['repo-url']],
1187 $viewvc .= '/?pathrev=';
1188 $viewvc .= urlencode( $info['checkout-rev'] );
1189 $info['viewvc-url'] = $viewvc;
1196 * Retrieve the revision number of a Subversion working directory.
1198 * @param string $dir Directory of the svn checkout
1200 * @return int Revision number
1202 public static function getSvnRevision( $dir ) {
1203 $info = self
::getSvnInfo( $dir );
1205 if ( $info === false ) {
1207 } elseif ( isset( $info['checkout-rev'] ) ) {
1208 return $info['checkout-rev'];
1215 * @param string $dir Directory of the git checkout
1216 * @return bool|string Sha1 of commit HEAD points to
1218 public static function getGitHeadSha1( $dir ) {
1219 $repo = new GitInfo( $dir );
1221 return $repo->getHeadSHA1();
1225 * @param string $dir Directory of the git checkout
1226 * @return bool|string Branch currently checked out
1228 public static function getGitCurrentBranch( $dir ) {
1229 $repo = new GitInfo( $dir );
1230 return $repo->getCurrentBranch();
1234 * Get the list of entry points and their URLs
1235 * @return string Wikitext
1237 public function getEntryPointInfo() {
1238 global $wgArticlePath, $wgScriptPath;
1239 $scriptPath = $wgScriptPath ?
$wgScriptPath : "/";
1240 $entryPoints = array(
1241 'version-entrypoints-articlepath' => $wgArticlePath,
1242 'version-entrypoints-scriptpath' => $scriptPath,
1243 'version-entrypoints-index-php' => wfScript( 'index' ),
1244 'version-entrypoints-api-php' => wfScript( 'api' ),
1245 'version-entrypoints-load-php' => wfScript( 'load' ),
1248 $language = $this->getLanguage();
1249 $thAttribures = array(
1250 'dir' => $language->getDir(),
1251 'lang' => $language->getHtmlCode()
1253 $out = Html
::element(
1255 array( 'id' => 'mw-version-entrypoints' ),
1256 $this->msg( 'version-entrypoints' )->text()
1258 Html
::openElement( 'table',
1260 'class' => 'wikitable plainlinks',
1261 'id' => 'mw-version-entrypoints-table',
1266 Html
::openElement( 'tr' ) .
1270 $this->msg( 'version-entrypoints-header-entrypoint' )->text()
1275 $this->msg( 'version-entrypoints-header-url' )->text()
1277 Html
::closeElement( 'tr' );
1279 foreach ( $entryPoints as $message => $value ) {
1280 $url = wfExpandUrl( $value, PROTO_RELATIVE
);
1281 $out .= Html
::openElement( 'tr' ) .
1282 // ->text() looks like it should be ->parse(), but this function
1283 // returns wikitext, not HTML, boo
1284 Html
::rawElement( 'td', array(), $this->msg( $message )->text() ) .
1285 Html
::rawElement( 'td', array(), Html
::rawElement( 'code', array(), "[$url $value]" ) ) .
1286 Html
::closeElement( 'tr' );
1289 $out .= Html
::closeElement( 'table' );
1294 protected function getGroupName() {