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.
386 public static function getExtensionTypes() {
387 if ( self
::$extensionTypes === false ) {
388 self
::$extensionTypes = array(
389 'specialpage' => wfMessage( 'version-specialpages' )->text(),
390 'parserhook' => wfMessage( 'version-parserhooks' )->text(),
391 'variable' => wfMessage( 'version-variables' )->text(),
392 'media' => wfMessage( 'version-mediahandlers' )->text(),
393 'antispam' => wfMessage( 'version-antispam' )->text(),
394 'skin' => wfMessage( 'version-skins' )->text(),
395 'api' => wfMessage( 'version-api' )->text(),
396 'other' => wfMessage( 'version-other' )->text(),
399 wfRunHooks( 'ExtensionTypes', array( &self
::$extensionTypes ) );
402 return self
::$extensionTypes;
406 * Returns the internationalized name for an extension type.
410 * @param string $type
414 public static function getExtensionTypeName( $type ) {
415 $types = self
::getExtensionTypes();
417 return isset( $types[$type] ) ?
$types[$type] : $types['other'];
421 * Generate wikitext showing extensions name, URL, author and description.
423 * @return string Wikitext
425 function getExtensionCredits() {
426 global $wgExtensionCredits;
428 if ( !count( $wgExtensionCredits ) ) {
432 $extensionTypes = self
::getExtensionTypes();
436 array( 'id' => 'mw-version-ext' ),
437 $this->msg( 'version-extensions' )->text()
439 Xml
::openElement( 'table', array( 'class' => 'wikitable plainlinks', 'id' => 'sv-ext' ) );
441 // Make sure the 'other' type is set to an array.
442 if ( !array_key_exists( 'other', $wgExtensionCredits ) ) {
443 $wgExtensionCredits['other'] = array();
446 // Find all extensions that do not have a valid type and give them the type 'other'.
447 foreach ( $wgExtensionCredits as $type => $extensions ) {
448 if ( !array_key_exists( $type, $extensionTypes ) ) {
449 $wgExtensionCredits['other'] = array_merge( $wgExtensionCredits['other'], $extensions );
453 // Loop through the extension categories to display their extensions in the list.
454 foreach ( $extensionTypes as $type => $message ) {
455 if ( $type != 'other' ) {
456 $out .= $this->getExtensionCategory( $type, $message );
460 // We want the 'other' type to be last in the list.
461 $out .= $this->getExtensionCategory( 'other', $extensionTypes['other'] );
463 $out .= Xml
::closeElement( 'table' );
469 * Obtains a list of installed parser tags and the associated H2 header
471 * @return string HTML output
473 protected function getParserTags() {
476 $tags = $wgParser->getTags();
478 if ( count( $tags ) ) {
479 $out = Html
::rawElement(
481 array( 'class' => 'mw-headline' ),
482 Linker
::makeExternalLink(
483 '//www.mediawiki.org/wiki/Special:MyLanguage/Manual:Tag_extensions',
484 $this->msg( 'version-parser-extensiontags' )->parse(),
485 false /* msg()->parse() already escapes */
489 array_walk( $tags, function ( &$value ) {
490 $value = '<' . htmlentities( $value ) . '>';
492 $out .= $this->listToText( $tags );
501 * Obtains a list of installed parser function hooks and the associated H2 header
503 * @return string HTML output
505 protected function getParserFunctionHooks() {
508 $fhooks = $wgParser->getFunctionHooks();
509 if ( count( $fhooks ) ) {
510 $out = Html
::rawElement( 'h2', array( 'class' => 'mw-headline' ), Linker
::makeExternalLink(
511 '//www.mediawiki.org/wiki/Special:MyLanguage/Manual:Parser_functions',
512 $this->msg( 'version-parser-function-hooks' )->parse(),
513 false /* msg()->parse() already escapes */
516 $out .= $this->listToText( $fhooks );
525 * Creates and returns the HTML for a single extension category.
529 * @param string $type
530 * @param string $message
534 protected function getExtensionCategory( $type, $message ) {
535 global $wgExtensionCredits;
539 if ( array_key_exists( $type, $wgExtensionCredits ) && count( $wgExtensionCredits[$type] ) > 0 ) {
540 $out .= $this->openExtType( $message, 'credits-' . $type );
542 usort( $wgExtensionCredits[$type], array( $this, 'compare' ) );
544 foreach ( $wgExtensionCredits[$type] as $extension ) {
545 $out .= $this->getCreditsForExtension( $extension );
553 * Callback to sort extensions by type.
558 function compare( $a, $b ) {
559 if ( $a['name'] === $b['name'] ) {
562 return $this->getLanguage()->lc( $a['name'] ) > $this->getLanguage()->lc( $b['name'] )
569 * Creates and formats a version line for a single extension.
571 * Information for five columns will be created. Parameters required in the
572 * $extension array for part rendering are indicated in ()
573 * - The name of (name), and URL link to (url), the extension
574 * - Official version number (version) and if available version control system
575 * revision (path), link, and date
576 * - If available the short name of the license (license-name) and a linke
577 * to ((LICENSE)|(COPYING))(\.txt)? if it exists.
578 * - Description of extension (descriptionmsg or description)
579 * - List of authors (author) and link to a ((AUTHORS)|(CREDITS))(\.txt)? file if it exists
581 * @param array $extension
583 * @return string Raw HTML
585 function getCreditsForExtension( array $extension ) {
586 $out = $this->getOutput();
588 // We must obtain the information for all the bits and pieces!
589 // ... such as extension names and links
590 $extensionName = isset( $extension['name'] ) ?
$extension['name'] : '[no name]';
591 if ( isset( $extension['url'] ) ) {
592 $extensionNameLink = Linker
::makeExternalLink(
597 array( 'class' => 'mw-version-ext-name' )
600 $extensionNameLink = $extensionName;
603 // ... and the version information
604 // If the extension path is set we will check that directory for GIT and SVN
605 // metadata in an attempt to extract date and vcs commit metadata.
606 $canonicalVersion = '–';
607 $extensionPath = null;
612 if ( isset( $extension['version'] ) ) {
613 $canonicalVersion = $out->parseInline( $extension['version'] );
616 if ( isset( $extension['path'] ) ) {
618 if ( $this->coreId
== '' ) {
619 wfDebug( 'Looking up core head id' );
620 $coreHeadSHA1 = self
::getGitHeadSha1( $IP );
621 if ( $coreHeadSHA1 ) {
622 $this->coreId
= $coreHeadSHA1;
624 $svnInfo = self
::getSvnInfo( $IP );
625 if ( $svnInfo !== false ) {
626 $this->coreId
= $svnInfo['checkout-rev'];
630 $cache = wfGetCache( CACHE_ANYTHING
);
631 $memcKey = wfMemcKey( 'specialversion-ext-version-text', $extension['path'], $this->coreId
);
632 list( $vcsVersion, $vcsLink, $vcsDate ) = $cache->get( $memcKey );
634 if ( !$vcsVersion ) {
635 wfDebug( "Getting VCS info for extension $extensionName" );
636 $extensionPath = dirname( $extension['path'] );
637 $gitInfo = new GitInfo( $extensionPath );
638 $vcsVersion = $gitInfo->getHeadSHA1();
639 if ( $vcsVersion !== false ) {
640 $vcsVersion = substr( $vcsVersion, 0, 7 );
641 $vcsLink = $gitInfo->getHeadViewUrl();
642 $vcsDate = $gitInfo->getHeadCommitDate();
644 $svnInfo = self
::getSvnInfo( $extensionPath );
645 if ( $svnInfo !== false ) {
646 $vcsVersion = $this->msg( 'version-svn-revision', $svnInfo['checkout-rev'] )->text();
647 $vcsLink = isset( $svnInfo['viewvc-url'] ) ?
$svnInfo['viewvc-url'] : '';
650 $cache->set( $memcKey, array( $vcsVersion, $vcsLink, $vcsDate ), 60 * 60 * 24 );
652 wfDebug( "Pulled VCS info for extension $extensionName from cache" );
656 $versionString = Html
::rawElement(
658 array( 'class' => 'mw-version-ext-version' ),
664 $vcsVerString = Linker
::makeExternalLink(
666 $this->msg( 'version-version', $vcsVersion ),
669 array( 'class' => 'mw-version-ext-vcs-version' )
672 $vcsVerString = Html
::element( 'span',
673 array( 'class' => 'mw-version-ext-vcs-version' ),
677 $versionString .= " {$vcsVerString}";
680 $vcsTimeString = Html
::element( 'span',
681 array( 'class' => 'mw-version-ext-vcs-timestamp' ),
682 $this->getLanguage()->timeanddate( $vcsDate )
684 $versionString .= " {$vcsTimeString}";
686 $versionString = Html
::rawElement( 'span',
687 array( 'class' => 'mw-version-ext-meta-version' ),
692 // ... and license information; if a license file exists we
695 if ( isset( $extension['license-name'] ) ) {
696 $licenseLink = Linker
::link(
697 $this->getPageTitle( 'License/' . $extensionName ),
698 $out->parseInline( $extension['license-name'] ),
699 array( 'class' => 'mw-version-ext-license' )
701 } elseif ( $this->getExtLicenseFileName( $extensionPath ) ) {
702 $licenseLink = Linker
::link(
703 $this->getPageTitle( 'License/' . $extensionName ),
704 $this->msg( 'version-ext-license' ),
705 array( 'class' => 'mw-version-ext-license' )
709 // ... and generate the description; which can be a parameterized l10n message
710 // in the form array( <msgname>, <parameter>, <parameter>... ) or just a straight
712 if ( isset( $extension['descriptionmsg'] ) ) {
713 // Localized description of extension
714 $descriptionMsg = $extension['descriptionmsg'];
716 if ( is_array( $descriptionMsg ) ) {
717 $descriptionMsgKey = $descriptionMsg[0]; // Get the message key
718 array_shift( $descriptionMsg ); // Shift out the message key to get the parameters only
719 array_map( "htmlspecialchars", $descriptionMsg ); // For sanity
720 $description = $this->msg( $descriptionMsgKey, $descriptionMsg )->text();
722 $description = $this->msg( $descriptionMsg )->text();
724 } elseif ( isset( $extension['description'] ) ) {
725 // Non localized version
726 $description = $extension['description'];
730 $description = $out->parseInline( $description );
732 // ... now get the authors for this extension
733 $authors = isset( $extension['author'] ) ?
$extension['author'] : array();
734 $authors = $this->listAuthors( $authors, $extensionName, $extensionPath );
736 // Finally! Create the table
737 $html = Html
::openElement( 'tr', array(
738 'class' => 'mw-version-ext',
739 'id' => "mw-version-ext-{$extensionName}"
743 $html .= Html
::rawElement( 'td', array(), $extensionNameLink );
744 $html .= Html
::rawElement( 'td', array(), $versionString );
745 $html .= Html
::rawElement( 'td', array(), $licenseLink );
746 $html .= Html
::rawElement( 'td', array( 'class' => 'mw-version-ext-description' ), $description );
747 $html .= Html
::rawElement( 'td', array( 'class' => 'mw-version-ext-authors' ), $authors );
749 $html .= Html
::closeElement( 'td' );
755 * Generate wikitext showing hooks in $wgHooks.
757 * @return string Wikitext
759 private function getWgHooks() {
760 global $wgSpecialVersionShowHooks, $wgHooks;
762 if ( $wgSpecialVersionShowHooks && count( $wgHooks ) ) {
763 $myWgHooks = $wgHooks;
767 $ret[] = '== {{int:version-hooks}} ==';
768 $ret[] = Html
::openElement( 'table', array( 'class' => 'wikitable', 'id' => 'sv-hooks' ) );
769 $ret[] = Html
::openElement( 'tr' );
770 $ret[] = Html
::element( 'th', array(), $this->msg( 'version-hook-name' )->text() );
771 $ret[] = Html
::element( 'th', array(), $this->msg( 'version-hook-subscribedby' )->text() );
772 $ret[] = Html
::closeElement( 'tr' );
774 foreach ( $myWgHooks as $hook => $hooks ) {
775 $ret[] = Html
::openElement( 'tr' );
776 $ret[] = Html
::element( 'td', array(), $hook );
777 $ret[] = Html
::element( 'td', array(), $this->listToText( $hooks ) );
778 $ret[] = Html
::closeElement( 'tr' );
781 $ret[] = Html
::closeElement( 'table' );
783 return implode( "\n", $ret );
789 private function openExtType( $text, $name = null ) {
792 $opt = array( 'colspan' => 5 );
793 if ( $this->firstExtOpened
) {
794 // Insert a spacing line
795 $out .= Html
::rawElement( 'tr', array( 'class' => 'sv-space' ),
796 Html
::element( 'td', $opt )
799 $this->firstExtOpened
= true;
802 $opt['id'] = "sv-$name";
805 $out .= Html
::rawElement( 'tr', array(),
806 Html
::element( 'th', $opt, $text )
809 $out .= Html
::openElement( 'tr' );
810 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
811 $this->msg( 'version-ext-colheader-name' )->text() );
812 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
813 $this->msg( 'version-ext-colheader-version' )->text() );
814 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
815 $this->msg( 'version-ext-colheader-license' )->text() );
816 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
817 $this->msg( 'version-ext-colheader-description' )->text() );
818 $out .= Html
::element( 'th', array( 'class' => 'mw-version-ext-col-label' ),
819 $this->msg( 'version-ext-colheader-credits' )->text() );
820 $out .= Html
::closeElement( 'tr' );
826 * Get information about client's IP address.
828 * @return string HTML fragment
830 private function IPInfo() {
831 $ip = str_replace( '--', ' - ', htmlspecialchars( $this->getRequest()->getIP() ) );
833 return "<!-- visited from $ip -->\n<span style='display:none'>visited from $ip</span>";
837 * Return a formatted unsorted list of authors
840 * If an item in the $authors array is '...' it is assumed to indicate an
841 * 'and others' string which will then be linked to an ((AUTHORS)|(CREDITS))(\.txt)?
842 * file if it exists in $dir.
844 * Similarly an entry ending with ' ...]' is assumed to be a link to an
847 * If no '...' string variant is found, but an authors file is found an
848 * 'and others' will be added to the end of the credits.
850 * @param string|array $authors
851 * @param string $extName Name of the extension for link creation
852 * @param string $extDir Path to the extension root directory
854 * @return string HTML fragment
856 function listAuthors( $authors, $extName, $extDir ) {
860 foreach ( (array)$authors as $item ) {
861 if ( $item == '...' ) {
864 if ( $this->getExtAuthorsFileName( $extDir ) ) {
865 $text = Linker
::link(
866 $this->getPageTitle( "Credits/$extName" ),
867 $this->msg( 'version-poweredby-others' )->text()
870 $text = $this->msg( 'version-poweredby-others' )->text();
873 } elseif ( substr( $item, -5 ) == ' ...]' ) {
875 $list[] = $this->getOutput()->parseInline(
876 substr( $item, 0, -4 ) . $this->msg( 'version-poweredby-others' )->text() . "]"
879 $list[] = $this->getOutput()->parseInline( $item );
883 if ( !$hasOthers && $this->getExtAuthorsFileName( $extDir ) ) {
884 $list[] = $text = Linker
::link(
885 $this->getPageTitle( "Credits/$extName" ),
886 $this->msg( 'version-poweredby-others' )->text()
890 return $this->listToText( $list, false );
894 * Obtains the full path of an extensions authors or credits file if
897 * @param string $extDir Path to the extensions root directory
901 * @return bool|string False if no such file exists, otherwise returns
904 public static function getExtAuthorsFileName( $extDir ) {
909 foreach ( scandir( $extDir ) as $file ) {
910 $fullPath = $extDir . DIRECTORY_SEPARATOR
. $file;
911 if ( preg_match( '/^((AUTHORS)|(CREDITS))(\.txt)?$/', $file ) &&
912 is_readable( $fullPath ) &&
923 * Obtains the full path of an extensions copying or license file if
926 * @param string $extDir Path to the extensions root directory
930 * @return bool|string False if no such file exists, otherwise returns
933 public static function getExtLicenseFileName( $extDir ) {
938 foreach ( scandir( $extDir ) as $file ) {
939 $fullPath = $extDir . DIRECTORY_SEPARATOR
. $file;
940 if ( preg_match( '/^((COPYING)|(LICENSE))(\.txt)?$/', $file ) &&
941 is_readable( $fullPath ) &&
952 * Convert an array of items into a list for display.
954 * @param array $list List of elements to display
955 * @param bool $sort Whether to sort the items in $list
959 function listToText( $list, $sort = true ) {
960 if ( !count( $list ) ) {
967 return $this->getLanguage()
968 ->listToText( array_map( array( __CLASS__
, 'arrayToString' ), $list ) );
972 * Convert an array or object to a string for display.
974 * @param mixed $list Will convert an array to string if given and return
975 * the paramater unaltered otherwise
979 public static function arrayToString( $list ) {
980 if ( is_array( $list ) && count( $list ) == 1 ) {
983 if ( is_object( $list ) ) {
984 $class = wfMessage( 'parentheses' )->params( get_class( $list ) )->escaped();
987 } elseif ( !is_array( $list ) ) {
990 if ( is_object( $list[0] ) ) {
991 $class = get_class( $list[0] );
996 return wfMessage( 'parentheses' )->params( "$class, {$list[1]}" )->escaped();
1001 * Get an associative array of information about a given path, from its .svn
1002 * subdirectory. Returns false on error, such as if the directory was not
1003 * checked out with subversion.
1005 * Returned keys are:
1007 * checkout-rev The revision which was checked out
1009 * directory-rev The revision when the directory was last modified
1010 * url The subversion URL of the directory
1011 * repo-url The base URL of the repository
1012 * viewvc-url A ViewVC URL pointing to the checked-out revision
1013 * @param string $dir
1014 * @return array|bool
1016 public static function getSvnInfo( $dir ) {
1017 // http://svnbook.red-bean.com/nightly/en/svn.developer.insidewc.html
1018 $entries = $dir . '/.svn/entries';
1020 if ( !file_exists( $entries ) ) {
1024 $lines = file( $entries );
1025 if ( !count( $lines ) ) {
1029 // check if file is xml (subversion release <= 1.3) or not (subversion release = 1.4)
1030 if ( preg_match( '/^<\?xml/', $lines[0] ) ) {
1031 // subversion is release <= 1.3
1032 if ( !function_exists( 'simplexml_load_file' ) ) {
1033 // We could fall back to expat... YUCK
1037 // SimpleXml whines about the xmlns...
1038 wfSuppressWarnings();
1039 $xml = simplexml_load_file( $entries );
1040 wfRestoreWarnings();
1043 foreach ( $xml->entry
as $entry ) {
1044 if ( $xml->entry
[0]['name'] == '' ) {
1045 // The directory entry should always have a revision marker.
1046 if ( $entry['revision'] ) {
1047 return array( 'checkout-rev' => intval( $entry['revision'] ) );
1056 // Subversion is release 1.4 or above.
1057 if ( count( $lines ) < 11 ) {
1062 'checkout-rev' => intval( trim( $lines[3] ) ),
1063 'url' => trim( $lines[4] ),
1064 'repo-url' => trim( $lines[5] ),
1065 'directory-rev' => intval( trim( $lines[10] ) )
1068 if ( isset( self
::$viewvcUrls[$info['repo-url']] ) ) {
1069 $viewvc = str_replace(
1071 self
::$viewvcUrls[$info['repo-url']],
1075 $viewvc .= '/?pathrev=';
1076 $viewvc .= urlencode( $info['checkout-rev'] );
1077 $info['viewvc-url'] = $viewvc;
1084 * Retrieve the revision number of a Subversion working directory.
1086 * @param string $dir Directory of the svn checkout
1088 * @return int Revision number
1090 public static function getSvnRevision( $dir ) {
1091 $info = self
::getSvnInfo( $dir );
1093 if ( $info === false ) {
1095 } elseif ( isset( $info['checkout-rev'] ) ) {
1096 return $info['checkout-rev'];
1103 * @param string $dir Directory of the git checkout
1104 * @return bool|string Sha1 of commit HEAD points to
1106 public static function getGitHeadSha1( $dir ) {
1107 $repo = new GitInfo( $dir );
1109 return $repo->getHeadSHA1();
1113 * @param string $dir Directory of the git checkout
1114 * @return bool|string Branch currently checked out
1116 public static function getGitCurrentBranch( $dir ) {
1117 $repo = new GitInfo( $dir );
1118 return $repo->getCurrentBranch();
1122 * Get the list of entry points and their URLs
1123 * @return string Wikitext
1125 public function getEntryPointInfo() {
1126 global $wgArticlePath, $wgScriptPath;
1127 $scriptPath = $wgScriptPath ?
$wgScriptPath : "/";
1128 $entryPoints = array(
1129 'version-entrypoints-articlepath' => $wgArticlePath,
1130 'version-entrypoints-scriptpath' => $scriptPath,
1131 'version-entrypoints-index-php' => wfScript( 'index' ),
1132 'version-entrypoints-api-php' => wfScript( 'api' ),
1133 'version-entrypoints-load-php' => wfScript( 'load' ),
1136 $language = $this->getLanguage();
1137 $thAttribures = array(
1138 'dir' => $language->getDir(),
1139 'lang' => $language->getCode()
1141 $out = Html
::element(
1143 array( 'id' => 'mw-version-entrypoints' ),
1144 $this->msg( 'version-entrypoints' )->text()
1146 Html
::openElement( 'table',
1148 'class' => 'wikitable plainlinks',
1149 'id' => 'mw-version-entrypoints-table',
1154 Html
::openElement( 'tr' ) .
1158 $this->msg( 'version-entrypoints-header-entrypoint' )->text()
1163 $this->msg( 'version-entrypoints-header-url' )->text()
1165 Html
::closeElement( 'tr' );
1167 foreach ( $entryPoints as $message => $value ) {
1168 $url = wfExpandUrl( $value, PROTO_RELATIVE
);
1169 $out .= Html
::openElement( 'tr' ) .
1170 // ->text() looks like it should be ->parse(), but this function
1171 // returns wikitext, not HTML, boo
1172 Html
::rawElement( 'td', array(), $this->msg( $message )->text() ) .
1173 Html
::rawElement( 'td', array(), Html
::rawElement( 'code', array(), "[$url $value]" ) ) .
1174 Html
::closeElement( 'tr' );
1177 $out .= Html
::closeElement( 'table' );
1182 protected function getGroupName() {