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' );
54 public function execute( $par ) {
55 global $IP, $wgExtensionCredits;
58 $this->outputHeader();
59 $out = $this->getOutput();
60 $out->allowClickjacking();
62 // Explode the sub page information into useful bits
63 $parts = explode( '/', (string)$par );
65 if ( isset( $parts[1] ) ) {
66 $extName = str_replace( '_', ' ', $parts[1] );
68 foreach ( $wgExtensionCredits as $group => $extensions ) {
69 foreach ( $extensions as $ext ) {
70 if ( isset( $ext['name'] ) && ( $ext['name'] === $extName ) ) {
77 $out->setStatusCode( 404 );
80 $extName = 'MediaWiki';
83 // Now figure out what to do
84 switch ( strtolower( $parts[0] ) ) {
86 $wikiText = '{{int:version-credits-not-found}}';
87 if ( $extName === 'MediaWiki' ) {
88 $wikiText = file_get_contents( $IP . '/CREDITS' );
89 } elseif ( ( $extNode !== null ) && isset( $extNode['path'] ) ) {
90 $file = $this->getExtAuthorsFileName( dirname( $extNode['path'] ) );
92 $wikiText = file_get_contents( $file );
93 if ( substr( $file, -4 ) === '.txt' ) {
94 $wikiText = Html
::element( 'pre', array(), $wikiText );
99 $out->setPageTitle( $this->msg( 'version-credits-title', $extName ) );
100 $out->addWikiText( $wikiText );
104 $wikiText = '{{int:version-license-not-found}}';
105 if ( $extName === 'MediaWiki' ) {
106 $wikiText = file_get_contents( $IP . '/COPYING' );
107 } elseif ( ( $extNode !== null ) && isset( $extNode['path'] ) ) {
108 $file = $this->getExtLicenseFileName( dirname( $extNode['path'] ) );
110 $wikiText = file_get_contents( $file );
111 if ( !isset( $extNode['license-name'] ) ) {
112 // If the developer did not explicitly set license-name they probably
113 // are unaware that we're now sucking this file in and thus it's probably
114 // not wikitext friendly.
115 $wikiText = "<pre>$wikiText</pre>";
120 $out->setPageTitle( $this->msg( 'version-license-title', $extName ) );
121 $out->addWikiText( $wikiText );
125 $out->addModules( 'mediawiki.special.version' );
127 $this->getMediaWikiCredits() .
128 $this->softwareInformation() .
129 $this->getEntryPointInfo()
132 $this->getExtensionCredits() .
133 $this->getParserTags() .
134 $this->getParserFunctionHooks()
136 $out->addWikiText( $this->getWgHooks() );
137 $out->addHTML( $this->IPInfo() );
144 * Returns wiki text showing the license information.
148 private static function getMediaWikiCredits() {
151 array( 'id' => 'mw-version-license' ),
152 wfMessage( 'version-license' )->text()
155 // This text is always left-to-right.
156 $ret .= '<div class="plainlinks">';
158 " . self
::getCopyrightAndAuthorList() . "\n
159 " . wfMessage( 'version-license-info' )->text();
162 return str_replace( "\t\t", '', $ret ) . "\n";
166 * Get the "MediaWiki is copyright 2001-20xx by lots of cool guys" text
170 public static function getCopyrightAndAuthorList() {
173 if ( defined( 'MEDIAWIKI_INSTALL' ) ) {
174 $othersLink = '[//www.mediawiki.org/wiki/Special:Version/Credits ' .
175 wfMessage( 'version-poweredby-others' )->text() . ']';
177 $othersLink = '[[Special:Version/Credits|' .
178 wfMessage( 'version-poweredby-others' )->text() . ']]';
181 $translatorsLink = '[//translatewiki.net/wiki/Translating:MediaWiki/Credits ' .
182 wfMessage( 'version-poweredby-translators' )->text() . ']';
185 'Magnus Manske', 'Brion Vibber', 'Lee Daniel Crocker',
186 'Tim Starling', 'Erik Möller', 'Gabriel Wicke', 'Ævar Arnfjörð Bjarmason',
187 'Niklas Laxström', 'Domas Mituzas', 'Rob Church', 'Yuri Astrakhan',
188 'Aryeh Gregor', 'Aaron Schulz', 'Andrew Garrett', 'Raimond Spekking',
189 'Alexandre Emsenhuber', 'Siebrand Mazeland', 'Chad Horohoe',
190 'Roan Kattouw', 'Trevor Parscal', 'Bryan Tong Minh', 'Sam Reed',
191 'Victor Vasiliev', 'Rotem Liss', 'Platonides', 'Antoine Musso',
192 'Timo Tijhof', 'Daniel Kinzler', 'Jeroen De Dauw', $othersLink,
196 return wfMessage( 'version-poweredby-credits', MWTimestamp
::getLocalInstance()->format( 'Y' ),
197 $wgLang->listToText( $authorList ) )->text();
201 * Returns wiki text showing the third party software versions (apache, php, mysql).
205 static function softwareInformation() {
206 $dbr = wfGetDB( DB_SLAVE
);
208 // Put the software in an array of form 'name' => 'version'. All messages should
209 // be loaded here, so feel free to use wfMessage in the 'name'. Raw HTML or
210 // wikimarkup can be used.
212 $software['[https://www.mediawiki.org/ MediaWiki]'] = self
::getVersionLinked();
213 $software['[http://www.php.net/ PHP]'] = phpversion() . " (" . PHP_SAPI
. ")";
214 $software[$dbr->getSoftwareLink()] = $dbr->getServerInfo();
216 // Allow a hook to add/remove items.
217 wfRunHooks( 'SoftwareInfo', array( &$software ) );
221 array( 'id' => 'mw-version-software' ),
222 wfMessage( 'version-software' )->text()
224 Xml
::openElement( 'table', array( 'class' => 'wikitable plainlinks', 'id' => 'sv-software' ) ) .
226 <th>" . wfMessage( 'version-software-product' )->text() . "</th>
227 <th>" . wfMessage( 'version-software-version' )->text() . "</th>
230 foreach ( $software as $name => $version ) {
232 <td>" . $name . "</td>
233 <td dir=\"ltr\">" . $version . "</td>
237 return $out . Xml
::closeElement( 'table' );
241 * Return a string of the MediaWiki version with SVN revision if available.
243 * @param string $flags
246 public static function getVersion( $flags = '' ) {
247 global $wgVersion, $IP;
248 wfProfileIn( __METHOD__
);
250 $gitInfo = self
::getGitHeadSha1( $IP );
251 $svnInfo = self
::getSvnInfo( $IP );
252 if ( !$svnInfo && !$gitInfo ) {
253 $version = $wgVersion;
254 } elseif ( $gitInfo && $flags === 'nodb' ) {
255 $shortSha1 = substr( $gitInfo, 0, 7 );
256 $version = "$wgVersion ($shortSha1)";
257 } elseif ( $gitInfo ) {
258 $shortSha1 = substr( $gitInfo, 0, 7 );
259 $shortSha1 = wfMessage( 'parentheses' )->params( $shortSha1 )->escaped();
260 $version = "$wgVersion $shortSha1";
261 } elseif ( $flags === 'nodb' ) {
262 $version = "$wgVersion (r{$svnInfo['checkout-rev']})";
264 $version = $wgVersion . ' ' .
266 'version-svn-revision',
267 isset( $info['directory-rev'] ) ?
$info['directory-rev'] : '',
268 $info['checkout-rev']
272 wfProfileOut( __METHOD__
);
278 * Return a wikitext-formatted string of the MediaWiki version with a link to
279 * the SVN revision or the git SHA1 of head if available.
280 * Git is prefered over Svn
281 * The fallback is just $wgVersion
285 public static function getVersionLinked() {
287 wfProfileIn( __METHOD__
);
289 $gitVersion = self
::getVersionLinkedGit();
293 $svnVersion = self
::getVersionLinkedSvn();
297 $v = $wgVersion; // fallback
301 wfProfileOut( __METHOD__
);
307 * @return string wgVersion + a link to subversion revision of svn BASE
309 private static function getVersionLinkedSvn() {
312 $info = self
::getSvnInfo( $IP );
313 if ( !isset( $info['checkout-rev'] ) ) {
317 $linkText = wfMessage(
318 'version-svn-revision',
319 isset( $info['directory-rev'] ) ?
$info['directory-rev'] : '',
320 $info['checkout-rev']
323 if ( isset( $info['viewvc-url'] ) ) {
324 $version = "[{$info['viewvc-url']} $linkText]";
326 $version = $linkText;
329 return self
::getwgVersionLinked() . " $version";
335 private static function getwgVersionLinked() {
338 if ( wfRunHooks( 'SpecialVersionVersionUrl', array( $wgVersion, &$versionUrl ) ) ) {
339 $versionParts = array();
340 preg_match( "/^(\d+\.\d+)/", $wgVersion, $versionParts );
341 $versionUrl = "https://www.mediawiki.org/wiki/MediaWiki_{$versionParts[1]}";
344 return "[$versionUrl $wgVersion]";
348 * @since 1.22 Returns the HEAD date in addition to the sha1 and link
349 * @return bool|string wgVersion + HEAD sha1 stripped to the first 7 chars
350 * with link and date, or false on failure
352 private static function getVersionLinkedGit() {
355 $gitInfo = new GitInfo( $IP );
356 $headSHA1 = $gitInfo->getHeadSHA1();
361 $shortSHA1 = '(' . substr( $headSHA1, 0, 7 ) . ')';
363 $gitHeadUrl = $gitInfo->getHeadViewUrl();
364 if ( $gitHeadUrl !== false ) {
365 $shortSHA1 = "[$gitHeadUrl $shortSHA1]";
368 $gitHeadCommitDate = $gitInfo->getHeadCommitDate();
369 if ( $gitHeadCommitDate ) {
370 $shortSHA1 .= Html
::element( 'br' ) . $wgLang->timeanddate( $gitHeadCommitDate, true );
373 return self
::getwgVersionLinked() . " $shortSHA1";
377 * Returns an array with the base extension types.
378 * Type is stored as array key, the message as array value.
380 * TODO: ideally this would return all extension types, including
381 * those added by SpecialVersionExtensionTypes. This is not possible
382 * since this hook is passing along $this though.
388 public static function getExtensionTypes() {
389 if ( self
::$extensionTypes === false ) {
390 self
::$extensionTypes = array(
391 'specialpage' => wfMessage( 'version-specialpages' )->text(),
392 'parserhook' => wfMessage( 'version-parserhooks' )->text(),
393 'variable' => wfMessage( 'version-variables' )->text(),
394 'media' => wfMessage( 'version-mediahandlers' )->text(),
395 'antispam' => wfMessage( 'version-antispam' )->text(),
396 'skin' => wfMessage( 'version-skins' )->text(),
397 'api' => wfMessage( 'version-api' )->text(),
398 'other' => wfMessage( 'version-other' )->text(),
401 wfRunHooks( 'ExtensionTypes', array( &self
::$extensionTypes ) );
404 return self
::$extensionTypes;
408 * Returns the internationalized name for an extension type.
412 * @param string $type
416 public static function getExtensionTypeName( $type ) {
417 $types = self
::getExtensionTypes();
419 return isset( $types[$type] ) ?
$types[$type] : $types['other'];
423 * Generate wikitext showing extensions name, URL, author and description.
425 * @return string Wikitext
427 function getExtensionCredits() {
428 global $wgExtensionCredits;
430 if ( !count( $wgExtensionCredits ) ) {
434 $extensionTypes = self
::getExtensionTypes();
436 wfRunHooks( 'SpecialVersionExtensionTypes', array( &$this, &$extensionTypes ), '1.17' );
440 array( 'id' => 'mw-version-ext' ),
441 $this->msg( 'version-extensions' )->text()
443 Xml
::openElement( 'table', array( 'class' => 'wikitable plainlinks', 'id' => 'sv-ext' ) );
445 // Make sure the 'other' type is set to an array.
446 if ( !array_key_exists( 'other', $wgExtensionCredits ) ) {
447 $wgExtensionCredits['other'] = array();
450 // Find all extensions that do not have a valid type and give them the type 'other'.
451 foreach ( $wgExtensionCredits as $type => $extensions ) {
452 if ( !array_key_exists( $type, $extensionTypes ) ) {
453 $wgExtensionCredits['other'] = array_merge( $wgExtensionCredits['other'], $extensions );
457 // Loop through the extension categories to display their extensions in the list.
458 foreach ( $extensionTypes as $type => $message ) {
459 if ( $type != 'other' ) {
460 $out .= $this->getExtensionCategory( $type, $message );
464 // We want the 'other' type to be last in the list.
465 $out .= $this->getExtensionCategory( 'other', $extensionTypes['other'] );
467 $out .= Xml
::closeElement( 'table' );
473 * Obtains a list of installed parser tags and the associated H2 header
475 * @return string HTML output
477 protected function getParserTags() {
480 $tags = $wgParser->getTags();
482 if ( count( $tags ) ) {
483 $out = Html
::rawElement(
485 array( 'class' => 'mw-headline' ),
486 Linker
::makeExternalLink(
487 '//www.mediawiki.org/wiki/Special:MyLanguage/Manual:Tag_extensions',
488 $this->msg( 'version-parser-extensiontags' )->parse(),
489 false /* msg()->parse() already escapes */
493 array_walk( $tags, function ( &$value ) {
494 $value = '<' . htmlentities( $value ) . '>';
496 $out .= $this->listToText( $tags );
505 * Obtains a list of installed parser function hooks and the associated H2 header
507 * @return string HTML output
509 protected function getParserFunctionHooks() {
512 $fhooks = $wgParser->getFunctionHooks();
513 if ( count( $fhooks ) ) {
514 $out = Html
::rawElement( 'h2', array( 'class' => 'mw-headline' ), Linker
::makeExternalLink(
515 '//www.mediawiki.org/wiki/Special:MyLanguage/Manual:Parser_functions',
516 $this->msg( 'version-parser-function-hooks' )->parse(),
517 false /* msg()->parse() already escapes */
520 $out .= $this->listToText( $fhooks );
529 * Creates and returns the HTML for a single extension category.
533 * @param string $type
534 * @param string $message
538 protected function getExtensionCategory( $type, $message ) {
539 global $wgExtensionCredits;
543 if ( array_key_exists( $type, $wgExtensionCredits ) && count( $wgExtensionCredits[$type] ) > 0 ) {
544 $out .= $this->openExtType( $message, 'credits-' . $type );
546 usort( $wgExtensionCredits[$type], array( $this, 'compare' ) );
548 foreach ( $wgExtensionCredits[$type] as $extension ) {
549 $out .= $this->getCreditsForExtension( $extension );
557 * Callback to sort extensions by type.
562 function compare( $a, $b ) {
563 if ( $a['name'] === $b['name'] ) {
566 return $this->getLanguage()->lc( $a['name'] ) > $this->getLanguage()->lc( $b['name'] )
573 * Creates and formats a version line for a single extension.
575 * Information for five columns will be created. Parameters required in the
576 * $extension array for part rendering are indicated in ()
577 * - The name of (name), and URL link to (url), the extension
578 * - Official version number (version) and if available version control system
579 * revision (path), link, and date
580 * - If available the short name of the license (license-name) and a linke
581 * to ((LICENSE)|(COPYING))(\.txt)? if it exists.
582 * - Description of extension (descriptionmsg or description)
583 * - List of authors (author) and link to a ((AUTHORS)|(CREDITS))(\.txt)? file if it exists
585 * @param array $extension
587 * @return string Raw HTML
589 function getCreditsForExtension( array $extension ) {
590 $out = $this->getOutput();
592 // We must obtain the information for all the bits and pieces!
593 // ... such as extension names and links
594 $extensionName = isset( $extension['name'] ) ?
$extension['name'] : '[no name]';
595 if ( isset( $extension['url'] ) ) {
596 $extensionNameLink = Linker
::makeExternalLink(
601 array( 'class' => 'mw-version-ext-name' )
604 $extensionNameLink = $extensionName;
607 // ... and the version information
608 // If the extension path is set we will check that directory for GIT and SVN
609 // metadata in an attempt to extract date and vcs commit metadata.
610 $canonicalVersion = '–';
611 $extensionPath = null;
616 if ( isset( $extension['version'] ) ) {
617 $canonicalVersion = $out->parseInline( $extension['version'] );
620 if ( isset( $extension['path'] ) ) {
622 if ( $this->coreId
== '' ) {
623 wfDebug( 'Looking up core head id' );
624 $coreHeadSHA1 = self
::getGitHeadSha1( $IP );
625 if ( $coreHeadSHA1 ) {
626 $this->coreId
= $coreHeadSHA1;
628 $svnInfo = self
::getSvnInfo( $IP );
629 if ( $svnInfo !== false ) {
630 $this->coreId
= $svnInfo['checkout-rev'];
634 $cache = wfGetCache( CACHE_ANYTHING
);
635 $memcKey = wfMemcKey( 'specialversion-ext-version-text', $extension['path'], $this->coreId
);
636 list( $vcsVersion, $vcsLink, $vcsDate ) = $cache->get( $memcKey );
638 if ( !$vcsVersion ) {
639 wfDebug( "Getting VCS info for extension $extensionName" );
640 $extensionPath = dirname( $extension['path'] );
641 $gitInfo = new GitInfo( $extensionPath );
642 $vcsVersion = $gitInfo->getHeadSHA1();
643 if ( $vcsVersion !== false ) {
644 $vcsVersion = substr( $vcsVersion, 0, 7 );
645 $vcsLink = $gitInfo->getHeadViewUrl();
646 $vcsDate = $gitInfo->getHeadCommitDate();
648 $svnInfo = self
::getSvnInfo( $extensionPath );
649 if ( $svnInfo !== false ) {
650 $vcsVersion = $this->msg( 'version-svn-revision', $svnInfo['checkout-rev'] )->text();
651 $vcsLink = isset( $svnInfo['viewvc-url'] ) ?
$svnInfo['viewvc-url'] : '';
654 $cache->set( $memcKey, array( $vcsVersion, $vcsLink, $vcsDate ), 60 * 60 * 24 );
656 wfDebug( "Pulled VCS info for extension $extensionName from cache" );
660 $versionString = Html
::rawElement(
662 array( 'class' => 'mw-version-ext-version' ),
668 $vcsVerString = Linker
::makeExternalLink(
670 $this->msg( 'version-version', $vcsVersion ),
673 array( 'class' => 'mw-version-ext-vcs-version' )
676 $vcsVerString = Html
::element( 'span',
677 array( 'class' => 'mw-version-ext-vcs-version' ),
681 $versionString .= " {$vcsVerString}";
684 $vcsTimeString = Html
::element( 'span',
685 array( 'class' => 'mw-version-ext-vcs-timestamp' ),
686 $this->getLanguage()->timeanddate( $vcsDate )
688 $versionString .= " {$vcsTimeString}";
690 $versionString = Html
::rawElement( 'span',
691 array( 'class' => 'mw-version-ext-meta-version' ),
696 // ... and license information; if a license file exists we
699 if ( isset( $extension['license-name'] ) ) {
700 $licenseLink = Linker
::link(
701 $this->getPageTitle( 'License/' . $extensionName ),
702 $out->parseInline( $extension['license-name'] ),
703 array( 'class' => 'mw-version-ext-license' )
705 } elseif ( $this->getExtLicenseFileName( $extensionPath ) ) {
706 $licenseLink = Linker
::link(
707 $this->getPageTitle( 'License/' . $extensionName ),
708 $this->msg( 'version-ext-license' ),
709 array( 'class' => 'mw-version-ext-license' )
713 // ... and generate the description; which can be a parameterized l10n message
714 // in the form array( <msgname>, <parameter>, <parameter>... ) or just a straight
716 if ( isset( $extension['descriptionmsg'] ) ) {
717 // Localized description of extension
718 $descriptionMsg = $extension['descriptionmsg'];
720 if ( is_array( $descriptionMsg ) ) {
721 $descriptionMsgKey = $descriptionMsg[0]; // Get the message key
722 array_shift( $descriptionMsg ); // Shift out the message key to get the parameters only
723 array_map( "htmlspecialchars", $descriptionMsg ); // For sanity
724 $description = $this->msg( $descriptionMsgKey, $descriptionMsg )->text();
726 $description = $this->msg( $descriptionMsg )->text();
728 } elseif ( isset( $extension['description'] ) ) {
729 // Non localized version
730 $description = $extension['description'];
734 $description = $out->parseInline( $description );
736 // ... now get the authors for this extension
737 $authors = isset( $extension['author'] ) ?
$extension['author'] : array();
738 $authors = $this->listAuthors( $authors, $extensionName, $extensionPath );
740 // Finally! Create the table
741 $html = Html
::openElement( 'tr', array(
742 'class' => 'mw-version-ext',
743 'id' => "mw-version-ext-{$extensionName}"
747 $html .= Html
::rawElement( 'td', array(), $extensionNameLink );
748 $html .= Html
::rawElement( 'td', array(), $versionString );
749 $html .= Html
::rawElement( 'td', array(), $licenseLink );
750 $html .= Html
::rawElement( 'td', array( 'class' => 'mw-version-ext-description' ), $description );
751 $html .= Html
::rawElement( 'td', array( 'class' => 'mw-version-ext-authors' ), $authors );
753 $html .= Html
::closeElement( 'td' );
759 * Generate wikitext showing hooks in $wgHooks.
761 * @return string Wikitext
763 private function getWgHooks() {
764 global $wgSpecialVersionShowHooks, $wgHooks;
766 if ( $wgSpecialVersionShowHooks && count( $wgHooks ) ) {
767 $myWgHooks = $wgHooks;
771 $ret[] = '== {{int:version-hooks}} ==';
772 $ret[] = Html
::openElement( 'table', array( 'class' => 'wikitable', 'id' => 'sv-hooks' ) );
773 $ret[] = Html
::openElement( 'tr' );
774 $ret[] = Html
::element( 'th', array(), $this->msg( 'version-hook-name' )->text() );
775 $ret[] = Html
::element( 'th', array(), $this->msg( 'version-hook-subscribedby' )->text() );
776 $ret[] = Html
::closeElement( 'tr' );
778 foreach ( $myWgHooks as $hook => $hooks ) {
779 $ret[] = Html
::openElement( 'tr' );
780 $ret[] = Html
::element( 'td', array(), $hook );
781 $ret[] = Html
::element( 'td', array(), $this->listToText( $hooks ) );
782 $ret[] = Html
::closeElement( 'tr' );
785 $ret[] = Html
::closeElement( 'table' );
787 return implode( "\n", $ret );
793 private function openExtType( $text, $name = null ) {
796 $opt = array( 'colspan' => 5 );
797 if ( $this->firstExtOpened
) {
798 // Insert a spacing line
799 $out .= Html
::rawElement( 'tr', array( 'class' => 'sv-space' ),
800 Html
::element( 'td', $opt )
803 $this->firstExtOpened
= true;
806 $opt['id'] = "sv-$name";
809 $out .= Html
::rawElement( 'tr', array(),
810 Html
::element( 'th', $opt, $text )
813 $out .= Html
::openElement( 'tr' );
814 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
815 $this->msg( 'version-ext-colheader-name' )->text() );
816 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
817 $this->msg( 'version-ext-colheader-version' )->text() );
818 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
819 $this->msg( 'version-ext-colheader-license' )->text() );
820 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
821 $this->msg( 'version-ext-colheader-description' )->text() );
822 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
823 $this->msg( 'version-ext-colheader-credits' )->text() );
824 $out .= Html
::closeElement( 'tr' );
830 * Get information about client's IP address.
832 * @return string HTML fragment
834 private function IPInfo() {
835 $ip = str_replace( '--', ' - ', htmlspecialchars( $this->getRequest()->getIP() ) );
837 return "<!-- visited from $ip -->\n<span style='display:none'>visited from $ip</span>";
841 * Return a formatted unsorted list of authors
844 * If an item in the $authors array is '...' it is assumed to indicate an
845 * 'and others' string which will then be linked to an ((AUTHORS)|(CREDITS))(\.txt)?
846 * file if it exists in $dir.
848 * Similarly an entry ending with ' ...]' is assumed to be a link to an
851 * If no '...' string variant is found, but an authors file is found an
852 * 'and others' will be added to the end of the credits.
854 * @param string|array $authors
855 * @param string $extName Name of the extension for link creation
856 * @param string $extDir Path to the extension root directory
858 * @return string HTML fragment
860 function listAuthors( $authors, $extName, $extDir ) {
864 foreach ( (array)$authors as $item ) {
865 if ( $item == '...' ) {
868 if ( $this->getExtAuthorsFileName( $extDir ) ) {
869 $text = Linker
::link(
870 $this->getPageTitle( "Credits/$extName" ),
871 $this->msg( 'version-poweredby-others' )->text()
874 $text = $this->msg( 'version-poweredby-others' )->text();
877 } elseif ( substr( $item, -5 ) == ' ...]' ) {
879 $list[] = $this->getOutput()->parseInline(
880 substr( $item, 0, -4 ) . $this->msg( 'version-poweredby-others' )->text() . "]"
883 $list[] = $this->getOutput()->parseInline( $item );
887 if ( !$hasOthers && $this->getExtAuthorsFileName( $extDir ) ) {
888 $list[] = $text = Linker
::link(
889 $this->getPageTitle( "Credits/$extName" ),
890 $this->msg( 'version-poweredby-others' )->text()
894 return $this->listToText( $list, false );
898 * Obtains the full path of an extensions authors or credits file if
901 * @param string $extDir Path to the extensions root directory
905 * @return bool|string False if no such file exists, otherwise returns
908 public static function getExtAuthorsFileName( $extDir ) {
913 foreach ( scandir( $extDir ) as $file ) {
914 $fullPath = $extDir . DIRECTORY_SEPARATOR
. $file;
915 if ( preg_match( '/^((AUTHORS)|(CREDITS))(\.txt)?$/', $file ) &&
916 is_readable( $fullPath ) &&
927 * Obtains the full path of an extensions copying or license file if
930 * @param string $extDir Path to the extensions root directory
934 * @return bool|string False if no such file exists, otherwise returns
937 public static function getExtLicenseFileName( $extDir ) {
942 foreach ( scandir( $extDir ) as $file ) {
943 $fullPath = $extDir . DIRECTORY_SEPARATOR
. $file;
944 if ( preg_match( '/^((COPYING)|(LICENSE))(\.txt)?$/', $file ) &&
945 is_readable( $fullPath ) &&
956 * Convert an array of items into a list for display.
958 * @param array $list List of elements to display
959 * @param bool $sort Whether to sort the items in $list
963 function listToText( $list, $sort = true ) {
964 if ( !count( $list ) ) {
971 return $this->getLanguage()
972 ->listToText( array_map( array( __CLASS__
, 'arrayToString' ), $list ) );
976 * Convert an array or object to a string for display.
978 * @param mixed $list Will convert an array to string if given and return
979 * the paramater unaltered otherwise
983 public static function arrayToString( $list ) {
984 if ( is_array( $list ) && count( $list ) == 1 ) {
987 if ( is_object( $list ) ) {
988 $class = wfMessage( 'parentheses' )->params( get_class( $list ) )->escaped();
991 } elseif ( !is_array( $list ) ) {
994 if ( is_object( $list[0] ) ) {
995 $class = get_class( $list[0] );
1000 return wfMessage( 'parentheses' )->params( "$class, {$list[1]}" )->escaped();
1005 * Get an associative array of information about a given path, from its .svn
1006 * subdirectory. Returns false on error, such as if the directory was not
1007 * checked out with subversion.
1009 * Returned keys are:
1011 * checkout-rev The revision which was checked out
1013 * directory-rev The revision when the directory was last modified
1014 * url The subversion URL of the directory
1015 * repo-url The base URL of the repository
1016 * viewvc-url A ViewVC URL pointing to the checked-out revision
1017 * @param string $dir
1018 * @return array|bool
1020 public static function getSvnInfo( $dir ) {
1021 // http://svnbook.red-bean.com/nightly/en/svn.developer.insidewc.html
1022 $entries = $dir . '/.svn/entries';
1024 if ( !file_exists( $entries ) ) {
1028 $lines = file( $entries );
1029 if ( !count( $lines ) ) {
1033 // check if file is xml (subversion release <= 1.3) or not (subversion release = 1.4)
1034 if ( preg_match( '/^<\?xml/', $lines[0] ) ) {
1035 // subversion is release <= 1.3
1036 if ( !function_exists( 'simplexml_load_file' ) ) {
1037 // We could fall back to expat... YUCK
1041 // SimpleXml whines about the xmlns...
1042 wfSuppressWarnings();
1043 $xml = simplexml_load_file( $entries );
1044 wfRestoreWarnings();
1047 foreach ( $xml->entry
as $entry ) {
1048 if ( $xml->entry
[0]['name'] == '' ) {
1049 // The directory entry should always have a revision marker.
1050 if ( $entry['revision'] ) {
1051 return array( 'checkout-rev' => intval( $entry['revision'] ) );
1060 // Subversion is release 1.4 or above.
1061 if ( count( $lines ) < 11 ) {
1066 'checkout-rev' => intval( trim( $lines[3] ) ),
1067 'url' => trim( $lines[4] ),
1068 'repo-url' => trim( $lines[5] ),
1069 'directory-rev' => intval( trim( $lines[10] ) )
1072 if ( isset( self
::$viewvcUrls[$info['repo-url']] ) ) {
1073 $viewvc = str_replace(
1075 self
::$viewvcUrls[$info['repo-url']],
1079 $viewvc .= '/?pathrev=';
1080 $viewvc .= urlencode( $info['checkout-rev'] );
1081 $info['viewvc-url'] = $viewvc;
1088 * Retrieve the revision number of a Subversion working directory.
1090 * @param string $dir Directory of the svn checkout
1092 * @return int Revision number
1094 public static function getSvnRevision( $dir ) {
1095 $info = self
::getSvnInfo( $dir );
1097 if ( $info === false ) {
1099 } elseif ( isset( $info['checkout-rev'] ) ) {
1100 return $info['checkout-rev'];
1107 * @param string $dir Directory of the git checkout
1108 * @return bool|string Sha1 of commit HEAD points to
1110 public static function getGitHeadSha1( $dir ) {
1111 $repo = new GitInfo( $dir );
1113 return $repo->getHeadSHA1();
1117 * Get the list of entry points and their URLs
1118 * @return string Wikitext
1120 public function getEntryPointInfo() {
1121 global $wgArticlePath, $wgScriptPath;
1122 $scriptPath = $wgScriptPath ?
$wgScriptPath : "/";
1123 $entryPoints = array(
1124 'version-entrypoints-articlepath' => $wgArticlePath,
1125 'version-entrypoints-scriptpath' => $scriptPath,
1126 'version-entrypoints-index-php' => wfScript( 'index' ),
1127 'version-entrypoints-api-php' => wfScript( 'api' ),
1128 'version-entrypoints-load-php' => wfScript( 'load' ),
1131 $language = $this->getLanguage();
1132 $thAttribures = array(
1133 'dir' => $language->getDir(),
1134 'lang' => $language->getCode()
1136 $out = Html
::element(
1138 array( 'id' => 'mw-version-entrypoints' ),
1139 $this->msg( 'version-entrypoints' )->text()
1141 Html
::openElement( 'table',
1143 'class' => 'wikitable plainlinks',
1144 'id' => 'mw-version-entrypoints-table',
1149 Html
::openElement( 'tr' ) .
1153 $this->msg( 'version-entrypoints-header-entrypoint' )->text()
1158 $this->msg( 'version-entrypoints-header-url' )->text()
1160 Html
::closeElement( 'tr' );
1162 foreach ( $entryPoints as $message => $value ) {
1163 $url = wfExpandUrl( $value, PROTO_RELATIVE
);
1164 $out .= Html
::openElement( 'tr' ) .
1165 // ->text() looks like it should be ->parse(), but this function
1166 // returns wikitext, not HTML, boo
1167 Html
::rawElement( 'td', array(), $this->msg( $message )->text() ) .
1168 Html
::rawElement( 'td', array(), Html
::rawElement( 'code', array(), "[$url $value]" ) ) .
1169 Html
::closeElement( 'tr' );
1172 $out .= Html
::closeElement( 'table' );
1177 protected function getGroupName() {