includes/SpecialVersion.php

   1 <?php
   2 /**#@+
   3  * Give information about the version of MediaWiki, PHP, the DB and extensions
   4  *
   5  * @package MediaWiki
   6  * @subpackage SpecialPage
   7  *
   8  * @bug 2019, 4531
   9  *
  10  * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
  11  * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason
  12  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
  13  */
  14
  15 /**
  16  * constructor
  17  */
  18 function wfSpecialVersion() {
  19         $version = new SpecialVersion;
  20         $version->execute();
  21 }
  22
  23 class SpecialVersion {
  24         private $firstExtOpened = true;
  25
  26         /**
  27          * main()
  28          */
  29         function execute() {
  30                 global $wgOut;
  31
  32                 $wgOut->addHTML( '<div dir="ltr">' );
  33                 $wgOut->addWikiText(
  34                         $this->MediaWikiCredits() .
  35                         $this->extensionCredits() .
  36                         $this->wgHooks()
  37                 );
  38                 $wgOut->addHTML( $this->IPInfo() );
  39                 $wgOut->addHTML( '</div>' );
  40         }
  41
  42         /**#@+
  43          * @private
  44          */
  45
  46         /**
  47          * Return wiki text showing the licence information and third party
  48          * software versions (apache, php, mysql).
  49          * @static
  50          */
  51         function MediaWikiCredits() {
  52                 $version = self::getVersion();
  53                 $dbr =& wfGetDB( DB_SLAVE );
  54
  55                 global $wgLanguageNames, $wgLanguageCode;
  56                 $mwlang = $wgLanguageNames[$wgLanguageCode];
  57
  58                 $ret =
  59                 "__NOTOC__
  60                 This wiki is powered by '''[http://www.mediawiki.org/ MediaWiki]''',
  61                 copyright (C) 2001-2007 Magnus Manske, Brion Vibber, Lee Daniel Crocker,
  62                 Tim Starling, Erik Möller, Gabriel Wicke, Ævar Arnfjörð Bjarmason,
  63                 Niklas Laxström, Domas Mituzas, Rob Church and others.
  64
  65                 MediaWiki is free software; you can redistribute it and/or modify
  66                 it under the terms of the GNU General Public License as published by
  67                 the Free Software Foundation; either version 2 of the License, or
  68                 (at your option) any later version.
  69
  70                 MediaWiki is distributed in the hope that it will be useful,
  71                 but WITHOUT ANY WARRANTY; without even the implied warranty of
  72                 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  73                 GNU General Public License for more details.
  74
  75                 You should have received [{{SERVER}}{{SCRIPTPATH}}/COPYING a copy of the GNU General Public License]
  76                 along with this program; if not, write to the Free Software
  77                 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  78                 or [http://www.gnu.org/copyleft/gpl.html read it online]
  79
  80                 * [http://www.mediawiki.org/ MediaWiki]: $version
  81                 * [http://www.php.net/ PHP]: " . phpversion() . " (" . php_sapi_name() . ")
  82                 * " . $dbr->getSoftwareLink() . ": " . $dbr->getServerVersion();
  83
  84                 return str_replace( "\t\t", '', $ret ) . "\n";
  85         }
  86
  87         /** Return a string of the MediaWiki version with SVN revision if available */
  88         public static function getVersion() {
  89                 global $wgVersion, $IP;
  90                 $svn = self::getSvnRevision( $IP );
  91                 return $svn ? "$wgVersion (r$svn)" : $wgVersion;
  92         }
  93
  94         /** Generate wikitext showing extensions name, URL, author and description */
  95         function extensionCredits() {
  96                 global $wgExtensionCredits, $wgExtensionFunctions, $wgParser, $wgSkinExtensionFunction;
  97
  98                 if ( ! count( $wgExtensionCredits ) && ! count( $wgExtensionFunctions ) && ! count( $wgSkinExtensionFunction ) )
  99                         return '';
 100
 101                 $extensionTypes = array(
 102                         'specialpage' => 'Special pages',
 103                         'parserhook' => 'Parser hooks',
 104                         'variable' => 'Variables',
 105                         'other' => 'Other',
 106                 );
 107                 wfRunHooks( 'SpecialVersionExtensionTypes', array( &$this, &$extensionTypes ) );
 108
 109                 $out = "<h2>Extensions</h2>\n";
 110                 $out .= wfOpenElement('table', array('id' => 'sv-ext') );
 111
 112                 foreach ( $extensionTypes as $type => $text ) {
 113                         if ( count( @$wgExtensionCredits[$type] ) ) {
 114                                 $out .= $this->openExtType( $text );
 115
 116                                 usort( $wgExtensionCredits[$type], array( $this, 'compare' ) );
 117
 118                                 foreach ( $wgExtensionCredits[$type] as $extension ) {
 119                                         wfSuppressWarnings();
 120                                         $out .= $this->formatCredits(
 121                                                 $extension['name'],
 122                                                 $extension['version'],
 123                                                 $extension['author'],
 124                                                 $extension['url'],
 125                                                 $extension['description']
 126                                         );
 127                                         wfRestoreWarnings();
 128                                 }
 129                         }
 130                 }
 131
 132                 if ( count( $wgExtensionFunctions ) ) {
 133                         $out .= $this->openExtType('Extension functions');
 134                         $out .= '<tr><td colspan="3">' . $this->listToText( $wgExtensionFunctions ) . "</td></tr>\n";
 135                 }
 136
 137                 if ( $cnt = count( $tags = $wgParser->getTags() ) ) {
 138                         for ( $i = 0; $i < $cnt; ++$i )
 139                                 $tags[$i] = "&lt;{$tags[$i]}&gt;";
 140                         $out .= $this->openExtType('Parser extension tags');
 141                         $out .= '<tr><td colspan="3">' . $this->listToText( $tags ). "</td></tr>\n";
 142                 }
 143
 144                 if( $cnt = count( $fhooks = $wgParser->getFunctionHooks() ) ) {
 145                         $out .= $this->openExtType('Parser function hooks');
 146                         $out .= '<tr><td colspan="3">' . $this->listToText( $fhooks ) . "</td></tr>\n";
 147                 }
 148
 149                 if ( count( $wgSkinExtensionFunction ) ) {
 150                         $out .= $this->openExtType('Skin extension functions');
 151                         $out .= '<tr><td colspan="3">' . $this->listToText( $wgSkinExtensionFunction ) . "</td></tr>\n";
 152                 }
 153                 $out .= wfCloseElement( 'table' );
 154                 return $out;
 155         }
 156
 157         /** Callback to sort extensions by type */
 158         function compare( $a, $b ) {
 159                 if ( $a['name'] === $b['name'] )
 160                         return 0;
 161                 else
 162                         return Language::lc( $a['name'] ) > Language::lc( $b['name'] ) ? 1 : -1;
 163         }
 164
 165         function formatCredits( $name, $version = null, $author = null, $url = null, $description = null) {
 166                 $ret = '<tr><td>';
 167                 if ( isset( $url ) )
 168                         $ret .= "[$url ";
 169                 $ret .= "''$name";
 170                 if ( isset( $version ) )
 171                         $ret .= " (version $version)";
 172                 $ret .= "''";
 173                 if ( isset( $url ) )
 174                         $ret .= ']';
 175                 $ret .= '</td>';
 176                 $ret .= "<td>$description</td>";
 177                 $ret .= "<td>" . $this->listToText( (array)$author ) . "</td>";
 178                 $ret .= '</tr>';
 179                 return "$ret\n";
 180         }
 181
 182         /**
 183          * @return string
 184          */
 185         function wgHooks() {
 186                 global $wgHooks;
 187
 188                 if ( count( $wgHooks ) ) {
 189                         $myWgHooks = $wgHooks;
 190                         ksort( $myWgHooks );
 191
 192                         $ret = "<h2>Hooks</h2>\n"
 193                                 . wfOpenElement('table', array('id' => 'sv-hooks') )
 194                                 . "<tr><th>Hook name</th><th>Subscribed by</th></tr>\n";
 195
 196                         foreach ($myWgHooks as $hook => $hooks)
 197                                 $ret .= "<tr><td>$hook</td><td>" . $this->listToText( $hooks ) . "</td></tr>\n";
 198
 199                         return $ret;
 200                 } else
 201                         return '';
 202         }
 203
 204         private function openExtType($text, $name = null) {
 205                 $opt = array( 'colspan' => 3 );
 206                 $out = '';
 207
 208                 if(!$this->firstExtOpened) {
 209                         // Insert a spacing line
 210                         $out .= '<tr class="sv-space">' . wfElement( 'td', $opt ) . "</tr>\n";
 211                 }
 212                 $this->firstExtOpened = false;
 213
 214                 if($name) { $opt['id'] = "sv-$name"; }
 215
 216                 $out .= "<tr>" . wfElement( 'th', $opt, $text) . "</tr>\n";
 217                 return $out;
 218         }
 219
 220         /**
 221          * @static
 222          *
 223          * @return string
 224          */
 225         function IPInfo() {
 226                 $ip =  str_replace( '--', ' - ', htmlspecialchars( wfGetIP() ) );
 227                 return "<!-- visited from $ip -->\n" .
 228                         "<span style='display:none'>visited from $ip</span>";
 229         }
 230
 231         /**
 232          * @param array $list
 233          * @return string
 234          */
 235         function listToText( $list ) {
 236                 $cnt = count( $list );
 237
 238             if ( $cnt == 1 )
 239                         // Enforce always returning a string
 240                         return (string)$this->arrayToString( $list[0] );
 241             else {
 242                         $t = array_slice( $list, 0, $cnt - 1 );
 243                         $one = array_map( array( &$this, 'arrayToString' ), $t );
 244                         $two = $this->arrayToString( $list[$cnt - 1] );
 245
 246                         return implode( ', ', $one ) . " and $two";
 247             }
 248         }
 249
 250         /**
 251          * @static
 252          *
 253          * @param mixed $list Will convert an array to string if given and return
 254          *                    the paramater unaltered otherwise
 255          * @return mixed
 256          */
 257         function arrayToString( $list ) {
 258                 if ( ! is_array( $list ) )
 259                         return $list;
 260                 else {
 261                         $class = get_class( $list[0] );
 262                         return "($class, {$list[1]})";
 263                 }
 264         }
 265
 266         /**
 267          * Retrieve the revision number of a Subversion working directory.
 268          *
 269          * @bug 7335
 270          *
 271          * @param string $dir
 272          * @return mixed revision number as int, or false if not a SVN checkout
 273          */
 274         public static function getSvnRevision( $dir ) {
 275                 // http://svnbook.red-bean.com/nightly/en/svn.developer.insidewc.html
 276                 $entries = $dir . '/.svn/entries';
 277
 278                 if( !file_exists( $entries ) ) {
 279                         return false;
 280                 }
 281
 282                 $content = file( $entries );
 283
 284                 // check if file is xml (subversion release <= 1.3) or not (subversion release = 1.4)
 285                 if( preg_match( '/^<\?xml/', $content[0] ) ) {
 286                         // subversion is release <= 1.3
 287                         if( !function_exists( 'simplexml_load_file' ) ) {
 288                                 // We could fall back to expat... YUCK
 289                                 return false;
 290                         }
 291
 292                         // SimpleXml whines about the xmlns...
 293                         wfSuppressWarnings();
 294                         $xml = simplexml_load_file( $entries );
 295                         wfRestoreWarnings();
 296
 297                         if( $xml ) {
 298                                 foreach( $xml->entry as $entry ) {
 299                                         if( $xml->entry[0]['name'] == '' ) {
 300                                                 // The directory entry should always have a revision marker.
 301                                                 if( $entry['revision'] ) {
 302                                                         return intval( $entry['revision'] );
 303                                                 }
 304                                         }
 305                                 }
 306                         }
 307                         return false;
 308                 } else {
 309                         // subversion is release 1.4
 310                         return intval( $content[3] );
 311                 }
 312         }
 313
 314         /**#@-*/
 315 }
 316
 317 /**#@-*/
 318 ?>