4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 * http://www.gnu.org/copyleft/gpl.html
21 * Give information about the version of MediaWiki, PHP, the DB and extensions
23 * @ingroup SpecialPage
25 * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
26 * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason
27 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
29 class SpecialVersion
extends SpecialPage
{
30 private $firstExtOpened = true;
32 static $viewvcUrls = array(
33 'svn+ssh://svn.wikimedia.org/svnroot/mediawiki' => 'http://svn.wikimedia.org/viewvc/mediawiki',
34 'http://svn.wikimedia.org/svnroot/mediawiki' => 'http://svn.wikimedia.org/viewvc/mediawiki',
35 # Doesn't work at the time of writing but maybe some day:
36 'https://svn.wikimedia.org/viewvc/mediawiki' => 'http://svn.wikimedia.org/viewvc/mediawiki',
39 function __construct(){
40 parent
::__construct( 'Version' );
46 function execute( $par ) {
47 global $wgOut, $wgMessageCache, $wgSpecialVersionShowHooks, $wgContLang;
48 $wgMessageCache->loadAllMessages();
51 $this->outputHeader();
53 $wgOut->addHTML( Xml
::openElement( 'div',
54 array( 'dir' => $wgContLang->getDir() ) ) );
56 $this->MediaWikiCredits() .
57 $this->softwareInformation() .
58 $this->extensionCredits();
59 if ( $wgSpecialVersionShowHooks ) {
60 $text .= $this->wgHooks();
62 $wgOut->addWikiText( $text );
63 $wgOut->addHTML( $this->IPInfo() );
64 $wgOut->addHTML( '</div>' );
72 * @return wiki text showing the license information
74 static function MediaWikiCredits() {
77 $ret = Xml
::element( 'h2', array( 'id' => 'mw-version-license' ), wfMsg( 'version-license' ) );
79 // This text is always left-to-right.
80 $ret .= '<div dir="ltr">';
82 This wiki is powered by '''[http://www.mediawiki.org/ MediaWiki]''',
83 copyright © 2001-2010 Magnus Manske, Brion Vibber, Lee Daniel Crocker,
84 Tim Starling, Erik Möller, Gabriel Wicke, Ævar Arnfjörð Bjarmason,
85 Niklas Laxström, Domas Mituzas, Rob Church, Yuri Astrakhan, Aryeh Gregor,
86 Aaron Schulz, Andrew Garrett, Raimond Spekking, Alexandre Emsenhuber,
87 Siebrand Mazeland, Chad Horohoe and others.
89 MediaWiki is free software; you can redistribute it and/or modify
90 it under the terms of the GNU General Public License as published by
91 the Free Software Foundation; either version 2 of the License, or
92 (at your option) any later version.
94 MediaWiki is distributed in the hope that it will be useful,
95 but WITHOUT ANY WARRANTY; without even the implied warranty of
96 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
97 GNU General Public License for more details.
99 You should have received [{{SERVER}}{{SCRIPTPATH}}/COPYING a copy of the GNU General Public License]
100 along with this program; if not, write to the Free Software
101 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
102 or [http://www.gnu.org/licenses/old-licenses/gpl-2.0.html read it online].
106 return str_replace( "\t\t", '', $ret ) . "\n";
110 * @return wiki text showing the third party software versions (apache, php, mysql).
112 static function softwareInformation() {
113 $dbr = wfGetDB( DB_SLAVE
);
115 // Put the software in an array of form 'name' => 'version'. All messages should
116 // be loaded here, so feel free to use wfMsg*() in the 'name'. Raw HTML or wikimarkup
119 $software['[http://www.mediawiki.org/ MediaWiki]'] = self
::getVersionLinked();
120 $software['[http://www.php.net/ PHP]'] = phpversion() . " (" . php_sapi_name() . ")";
121 $software[$dbr->getSoftwareLink()] = $dbr->getServerVersion();
123 // Allow a hook to add/remove items
124 wfRunHooks( 'SoftwareInfo', array( &$software ) );
126 $out = Xml
::element( 'h2', array( 'id' => 'mw-version-software' ), wfMsg( 'version-software' ) ) .
127 Xml
::openElement( 'table', array( 'class' => 'wikitable', 'id' => 'sv-software' ) ) .
129 <th>" . wfMsg( 'version-software-product' ) . "</th>
130 <th>" . wfMsg( 'version-software-version' ) . "</th>
132 foreach( $software as $name => $version ) {
134 <td>" . $name . "</td>
135 <td>" . $version . "</td>
138 return $out . Xml
::closeElement( 'table' );
142 * Return a string of the MediaWiki version with SVN revision if available
146 public static function getVersion( $flags = '' ) {
147 global $wgVersion, $IP;
148 wfProfileIn( __METHOD__
);
150 $info = self
::getSvnInfo( $IP );
152 $version = $wgVersion;
153 } elseif( $flags === 'nodb' ) {
154 $version = "$wgVersion (r{$info['checkout-rev']})";
156 $version = $wgVersion . ' ' .
158 'version-svn-revision',
159 isset( $info['directory-rev'] ) ?
$info['directory-rev'] : '',
160 $info['checkout-rev']
164 wfProfileOut( __METHOD__
);
169 * Return a wikitext-formatted string of the MediaWiki version with a link to
170 * the SVN revision if available
174 public static function getVersionLinked() {
175 global $wgVersion, $IP;
176 wfProfileIn( __METHOD__
);
177 $info = self
::getSvnInfo( $IP );
178 if ( isset( $info['checkout-rev'] ) ) {
180 'version-svn-revision',
181 isset( $info['directory-rev'] ) ?
$info['directory-rev'] : '',
182 $info['checkout-rev']
184 if ( isset( $info['viewvc-url'] ) ) {
185 $version = "$wgVersion [{$info['viewvc-url']} $linkText]";
187 $version = "$wgVersion $linkText";
190 $version = $wgVersion;
192 wfProfileOut( __METHOD__
);
197 * Generate wikitext showing extensions name, URL, author and description
199 * @return String: Wikitext
201 function extensionCredits() {
202 global $wgExtensionCredits, $wgExtensionFunctions, $wgParser, $wgSkinExtensionFunctions;
204 if ( ! count( $wgExtensionCredits ) && ! count( $wgExtensionFunctions ) && ! count( $wgSkinExtensionFunctions ) )
207 $extensionTypes = array(
208 'specialpage' => wfMsg( 'version-specialpages' ),
209 'parserhook' => wfMsg( 'version-parserhooks' ),
210 'variable' => wfMsg( 'version-variables' ),
211 'media' => wfMsg( 'version-mediahandlers' ),
212 'other' => wfMsg( 'version-other' ),
214 wfRunHooks( 'SpecialVersionExtensionTypes', array( &$this, &$extensionTypes ) );
216 $out = Xml
::element( 'h2', array( 'id' => 'mw-version-ext' ), wfMsg( 'version-extensions' ) ) .
217 Xml
::openElement( 'table', array( 'class' => 'wikitable', 'id' => 'sv-ext' ) );
219 foreach ( $extensionTypes as $type => $text ) {
220 if ( isset ( $wgExtensionCredits[$type] ) && count ( $wgExtensionCredits[$type] ) ) {
221 $out .= $this->openExtType( $text, 'credits-' . $type );
223 usort( $wgExtensionCredits[$type], array( $this, 'compare' ) );
225 foreach ( $wgExtensionCredits[$type] as $extension ) {
226 $out .= $this->formatCredits( $extension );
231 if ( count( $wgExtensionFunctions ) ) {
232 $out .= $this->openExtType( wfMsg( 'version-extension-functions' ), 'extension-functions' );
233 $out .= '<tr><td colspan="4">' . $this->listToText( $wgExtensionFunctions ) . "</td></tr>\n";
236 if ( $cnt = count( $tags = $wgParser->getTags() ) ) {
237 for ( $i = 0; $i < $cnt; ++
$i )
238 $tags[$i] = "<{$tags[$i]}>";
239 $out .= $this->openExtType( wfMsg( 'version-parser-extensiontags' ), 'parser-tags' );
240 $out .= '<tr><td colspan="4">' . $this->listToText( $tags ). "</td></tr>\n";
243 if( $cnt = count( $fhooks = $wgParser->getFunctionHooks() ) ) {
244 $out .= $this->openExtType( wfMsg( 'version-parser-function-hooks' ), 'parser-function-hooks' );
245 $out .= '<tr><td colspan="4">' . $this->listToText( $fhooks ) . "</td></tr>\n";
248 if ( count( $wgSkinExtensionFunctions ) ) {
249 $out .= $this->openExtType( wfMsg( 'version-skin-extension-functions' ), 'skin-extension-functions' );
250 $out .= '<tr><td colspan="4">' . $this->listToText( $wgSkinExtensionFunctions ) . "</td></tr>\n";
252 $out .= Xml
::closeElement( 'table' );
256 /** Callback to sort extensions by type */
257 function compare( $a, $b ) {
259 if( $a['name'] === $b['name'] ) {
262 return $wgLang->lc( $a['name'] ) > $wgLang->lc( $b['name'] )
268 function formatCredits( $extension ) {
269 $name = isset( $extension['name'] ) ?
$extension['name'] : '[no name]';
270 if ( isset( $extension['path'] ) ) {
271 $svnInfo = self
::getSvnInfo( dirname($extension['path']) );
272 $directoryRev = isset( $svnInfo['directory-rev'] ) ?
$svnInfo['directory-rev'] : null;
273 $checkoutRev = isset( $svnInfo['checkout-rev'] ) ?
$svnInfo['checkout-rev'] : null;
274 $viewvcUrl = isset( $svnInfo['viewvc-url'] ) ?
$svnInfo['viewvc-url'] : null;
276 $directoryRev = null;
281 # Make main link (or just the name if there is no URL)
282 if ( isset( $extension['url'] ) ) {
283 $mainLink = "[{$extension['url']} $name]";
287 if ( isset( $extension['version'] ) ) {
288 $versionText = '<span class="mw-version-ext-version">' .
289 wfMsg( 'version-version', $extension['version'] ) .
295 # Make subversion text/link
296 if ( $checkoutRev ) {
297 $svnText = wfMsg( 'version-svn-revision', $directoryRev, $checkoutRev );
298 $svnText = isset( $viewvcUrl ) ?
"[$viewvcUrl $svnText]" : $svnText;
303 # Make description text
304 $description = isset ( $extension['description'] ) ?
$extension['description'] : '';
305 if( isset ( $extension['descriptionmsg'] ) ) {
306 # Look for a localized description
307 $descriptionMsg = $extension['descriptionmsg'];
308 if( is_array( $descriptionMsg ) ) {
309 $descriptionMsgKey = $descriptionMsg[0]; // Get the message key
310 array_shift( $descriptionMsg ); // Shift out the message key to get the parameters only
311 array_map( "htmlspecialchars", $descriptionMsg ); // For sanity
312 $msg = wfMsg( $descriptionMsgKey, $descriptionMsg );
314 $msg = wfMsg( $descriptionMsg );
316 if ( !wfEmptyMsg( $descriptionMsg, $msg ) && $msg != '' ) {
321 if ( $svnText !== false ) {
323 <td><em>$mainLink $versionText</em></td>
324 <td><em>$svnText</em></td>";
327 <td colspan=\"2\"><em>$mainLink $versionText</em></td>";
329 $author = isset ( $extension['author'] ) ?
$extension['author'] : array();
330 $extDescAuthor = "<td>$description</td>
331 <td>" . $this->listToText( (array)$author, false ) . "</td>
333 return $extNameVer . $extDescAuthor;
337 * Generate wikitext showing hooks in $wgHooks
339 * @return String: wikitext
344 if ( count( $wgHooks ) ) {
345 $myWgHooks = $wgHooks;
348 $ret = Xml
::element( 'h2', array( 'id' => 'mw-version-hooks' ), wfMsg( 'version-hooks' ) ) .
349 Xml
::openElement( 'table', array( 'class' => 'wikitable', 'id' => 'sv-hooks' ) ) .
351 <th>" . wfMsg( 'version-hook-name' ) . "</th>
352 <th>" . wfMsg( 'version-hook-subscribedby' ) . "</th>
355 foreach ( $myWgHooks as $hook => $hooks )
358 <td>" . $this->listToText( $hooks ) . "</td>
361 $ret .= Xml
::closeElement( 'table' );
367 private function openExtType( $text, $name = null ) {
368 $opt = array( 'colspan' => 4 );
371 if( !$this->firstExtOpened
) {
372 // Insert a spacing line
373 $out .= '<tr class="sv-space">' . Html
::element( 'td', $opt ) . "</tr>\n";
375 $this->firstExtOpened
= false;
378 $opt['id'] = "sv-$name";
380 $out .= "<tr>" . Xml
::element( 'th', $opt, $text ) . "</tr>\n";
385 * Get information about client's IP address
387 * @return String: HTML fragment
390 $ip = str_replace( '--', ' - ', htmlspecialchars( wfGetIP() ) );
391 return "<!-- visited from $ip -->\n" .
392 "<span style='display:none'>visited from $ip</span>";
396 * Convert an array of items into a list for display
398 * @param $list Array of elements to display
399 * @param $sort Boolean: whether to sort the items in $list
402 function listToText( $list, $sort = true ) {
403 $cnt = count( $list );
406 // Enforce always returning a string
407 return (string)self
::arrayToString( $list[0] );
408 } elseif ( $cnt == 0 ) {
415 return $wgLang->listToText( array_map( array( __CLASS__
, 'arrayToString' ), $list ) );
420 * Convert an array or object to a string for display
422 * @param $list Mixed: will convert an array to string if given and return
423 * the paramater unaltered otherwise
426 static function arrayToString( $list ) {
427 if( is_array( $list ) && count( $list ) == 1 )
429 if( is_object( $list ) ) {
430 $class = get_class( $list );
432 } elseif ( !is_array( $list ) ) {
435 if( is_object( $list[0] ) )
436 $class = get_class( $list[0] );
439 return "($class, {$list[1]})";
444 * Get an associative array of information about a given path, from its .svn
445 * subdirectory. Returns false on error, such as if the directory was not
446 * checked out with subversion.
450 * checkout-rev The revision which was checked out
452 * directory-rev The revision when the directory was last modified
453 * url The subversion URL of the directory
454 * repo-url The base URL of the repository
455 * viewvc-url A ViewVC URL pointing to the checked-out revision
457 public static function getSvnInfo( $dir ) {
458 // http://svnbook.red-bean.com/nightly/en/svn.developer.insidewc.html
459 $entries = $dir . '/.svn/entries';
461 if( !file_exists( $entries ) ) {
465 $lines = file( $entries );
466 if ( !count( $lines ) ) {
470 // check if file is xml (subversion release <= 1.3) or not (subversion release = 1.4)
471 if( preg_match( '/^<\?xml/', $lines[0] ) ) {
472 // subversion is release <= 1.3
473 if( !function_exists( 'simplexml_load_file' ) ) {
474 // We could fall back to expat... YUCK
478 // SimpleXml whines about the xmlns...
479 wfSuppressWarnings();
480 $xml = simplexml_load_file( $entries );
484 foreach( $xml->entry
as $entry ) {
485 if( $xml->entry
[0]['name'] == '' ) {
486 // The directory entry should always have a revision marker.
487 if( $entry['revision'] ) {
488 return array( 'checkout-rev' => intval( $entry['revision'] ) );
496 // subversion is release 1.4 or above
497 if ( count( $lines ) < 11 ) {
501 'checkout-rev' => intval( trim( $lines[3] ) ),
502 'url' => trim( $lines[4] ),
503 'repo-url' => trim( $lines[5] ),
504 'directory-rev' => intval( trim( $lines[10] ) )
506 if ( isset( self
::$viewvcUrls[$info['repo-url']] ) ) {
507 $viewvc = str_replace(
509 self
::$viewvcUrls[$info['repo-url']],
512 $pathRelativeToRepo = substr( $info['url'], strlen( $info['repo-url'] ) );
513 $viewvc .= '/?pathrev=';
514 $viewvc .= urlencode( $info['checkout-rev'] );
515 $info['viewvc-url'] = $viewvc;
521 * Retrieve the revision number of a Subversion working directory.
523 * @param $dir String: directory of the svn checkout
524 * @return Integer: revision number as int
526 public static function getSvnRevision( $dir ) {
527 $info = self
::getSvnInfo( $dir );
528 if ( $info === false ) {
530 } elseif ( isset( $info['checkout-rev'] ) ) {
531 return $info['checkout-rev'];