includes/installer/Installer.php

   1 <?php
   2 /**
   3  * Base code for MediaWiki installer.
   4  *
   5  * @file
   6  * @ingroup Deployment
   7  */
   8
   9 /**
  10  * This documentation group collects source code files with deployment functionality.
  11  *
  12  * @defgroup Deployment Deployment
  13  */
  14
  15 /**
  16  * Base installer class.
  17  *
  18  * This class provides the base for installation and update functionality
  19  * for both MediaWiki core and extensions.
  20  *
  21  * @ingroup Deployment
  22  * @since 1.17
  23  */
  24 abstract class Installer {
  25
  26         /**
  27          * TODO: make protected?
  28          *
  29          * @var array
  30          */
  31         public $settings;
  32
  33         /**
  34          * Cached DB installer instances, access using getDBInstaller().
  35          *
  36          * @var array
  37          */
  38         protected $dbInstallers = array();
  39
  40         /**
  41          * Minimum memory size in MB.
  42          *
  43          * @var integer
  44          */
  45         protected $minMemorySize = 50;
  46
  47         /**
  48          * Cached Title, used by parse().
  49          *
  50          * @var Title
  51          */
  52         protected $parserTitle;
  53
  54         /**
  55          * Cached ParserOptions, used by parse().
  56          *
  57          * @var ParserOptions
  58          */
  59         protected $parserOptions;
  60
  61         /**
  62          * Known database types. These correspond to the class names <type>Installer,
  63          * and are also MediaWiki database types valid for $wgDBtype.
  64          *
  65          * To add a new type, create a <type>Installer class and a Database<type>
  66          * class, and add a config-type-<type> message to MessagesEn.php.
  67          *
  68          * @var array
  69          */
  70         protected static $dbTypes = array(
  71                 'mysql',
  72                 'postgres',
  73                 'sqlite',
  74                 'oracle'
  75         );
  76
  77         /**
  78          * A list of environment check methods called by doEnvironmentChecks().
  79          * These may output warnings using showMessage(), and/or abort the
  80          * installation process by returning false.
  81          *
  82          * @var array
  83          */
  84         protected $envChecks = array(
  85                 'envLatestVersion',
  86                 'envCheckDB',
  87                 'envCheckRegisterGlobals',
  88                 'envCheckMagicQuotes',
  89                 'envCheckMagicSybase',
  90                 'envCheckMbstring',
  91                 'envCheckZE1',
  92                 'envCheckSafeMode',
  93                 'envCheckXML',
  94                 'envCheckPCRE',
  95                 'envCheckMemory',
  96                 'envCheckCache',
  97                 'envCheckDiff3',
  98                 'envCheckGraphics',
  99                 'envCheckPath',
 100                 'envCheckWriteableDir',
 101                 'envCheckExtension',
 102                 'envCheckShellLocale',
 103                 'envCheckUploadsDirectory',
 104                 'envCheckLibicu'
 105         );
 106
 107         /**
 108          * UI interface for displaying a short message
 109          * The parameters are like parameters to wfMsg().
 110          * The messages will be in wikitext format, which will be converted to an
 111          * output format such as HTML or text before being sent to the user.
 112          */
 113         public abstract function showMessage( $msg /*, ... */ );
 114
 115         /**
 116          * Constructor, always call this from child classes.
 117          */
 118         public function __construct() {
 119                 // Disable the i18n cache and LoadBalancer
 120                 Language::getLocalisationCache()->disableBackend();
 121                 LBFactory::disableBackend();
 122         }
 123
 124         /**
 125          * Get a list of known DB types.
 126          */
 127         public static function getDBTypes() {
 128                 return self::$dbTypes;
 129         }
 130
 131         /**
 132          * Do initial checks of the PHP environment. Set variables according to
 133          * the observed environment.
 134          *
 135          * It's possible that this may be called under the CLI SAPI, not the SAPI
 136          * that the wiki will primarily run under. In that case, the subclass should
 137          * initialise variables such as wgScriptPath, before calling this function.
 138          *
 139          * Under the web subclass, it can already be assumed that PHP 5+ is in use
 140          * and that sessions are working.
 141          *
 142          * @return boolean
 143          */
 144         public function doEnvironmentChecks() {
 145                 $this->showMessage( 'config-env-php', phpversion() );
 146
 147                 $good = true;
 148
 149                 foreach ( $this->envChecks as $check ) {
 150                         $status = $this->$check();
 151                         if ( $status === false ) {
 152                                 $good = false;
 153                         }
 154                 }
 155
 156                 $this->setVar( '_Environment', $good );
 157
 158                 if ( $good ) {
 159                         $this->showMessage( 'config-env-good' );
 160                 } else {
 161                         $this->showMessage( 'config-env-bad' );
 162                 }
 163
 164                 return $good;
 165         }
 166
 167         /**
 168          * Set a MW configuration variable, or internal installer configuration variable.
 169          *
 170          * @param $name String
 171          * @param $value Mixed
 172          */
 173         public function setVar( $name, $value ) {
 174                 $this->settings[$name] = $value;
 175         }
 176
 177         /**
 178          * Get an MW configuration variable, or internal installer configuration variable.
 179          * The defaults come from $GLOBALS (ultimately DefaultSettings.php).
 180          * Installer variables are typically prefixed by an underscore.
 181          *
 182          * @param $name String
 183          * @param $default Mixed
 184          *
 185          * @return mixed
 186          */
 187         public function getVar( $name, $default = null ) {
 188                 if ( !isset( $this->settings[$name] ) ) {
 189                         return $default;
 190                 } else {
 191                         return $this->settings[$name];
 192                 }
 193         }
 194
 195         /**
 196          * Get an instance of DatabaseInstaller for the specified DB type.
 197          *
 198          * @param $type Mixed: DB installer for which is needed, false to use default.
 199          *
 200          * @return DatabaseInstaller
 201          */
 202         public function getDBInstaller( $type = false ) {
 203                 if ( !$type ) {
 204                         $type = $this->getVar( 'wgDBtype' );
 205                 }
 206
 207                 $type = strtolower( $type );
 208
 209                 if ( !isset( $this->dbInstallers[$type] ) ) {
 210                         $class = ucfirst( $type ). 'Installer';
 211                         $this->dbInstallers[$type] = new $class( $this );
 212                 }
 213
 214                 return $this->dbInstallers[$type];
 215         }
 216
 217         /**
 218          * Determine if LocalSettings exists. If it does, return an appropriate
 219          * status for whether we should can upgrade or not.
 220          *
 221          * @return Status
 222          */
 223         public function getLocalSettingsStatus() {
 224                 global $IP;
 225
 226                 $status = Status::newGood();
 227
 228                 wfSuppressWarnings();
 229                 $ls = file_exists( "$IP/LocalSettings.php" );
 230                 wfRestoreWarnings();
 231
 232                 if( $ls ) {
 233                         if( $this->getDBInstaller()->needsUpgrade() ) {
 234                                 $status->warning( 'config-localsettings-upgrade' );
 235                         }
 236                         else {
 237                                 $status->fatal( 'config-localsettings-noupgrade' );
 238                         }
 239                 }
 240
 241                 return $status;
 242         }
 243
 244         /**
 245          * Get a fake password for sending back to the user in HTML.
 246          * This is a security mechanism to avoid compromise of the password in the
 247          * event of session ID compromise.
 248          *
 249          * @param $realPassword String
 250          *
 251          * @return string
 252          */
 253         public function getFakePassword( $realPassword ) {
 254                 return str_repeat( '*', strlen( $realPassword ) );
 255         }
 256
 257         /**
 258          * Set a variable which stores a password, except if the new value is a
 259          * fake password in which case leave it as it is.
 260          *
 261          * @param $name String
 262          * @param $value Mixed
 263          */
 264         public function setPassword( $name, $value ) {
 265                 if ( !preg_match( '/^\*+$/', $value ) ) {
 266                         $this->setVar( $name, $value );
 267                 }
 268         }
 269
 270         /**
 271          * On POSIX systems return the primary group of the webserver we're running under.
 272          * On other systems just returns null.
 273          *
 274          * This is used to advice the user that he should chgrp his config/data/images directory as the
 275          * webserver user before he can install.
 276          *
 277          * Public because SqliteInstaller needs it, and doesn't subclass Installer.
 278          *
 279          * @return mixed
 280          */
 281         public static function maybeGetWebserverPrimaryGroup() {
 282                 if ( !function_exists( 'posix_getegid' ) || !function_exists( 'posix_getpwuid' ) ) {
 283                         # I don't know this, this isn't UNIX.
 284                         return null;
 285                 }
 286
 287                 # posix_getegid() *not* getmygid() because we want the group of the webserver,
 288                 # not whoever owns the current script.
 289                 $gid = posix_getegid();
 290                 $getpwuid = posix_getpwuid( $gid );
 291                 $group = $getpwuid['name'];
 292
 293                 return $group;
 294         }
 295
 296         /**
 297          * Convert wikitext $text to HTML.
 298          *
 299          * This is potentially error prone since many parser features require a complete
 300          * installed MW database. The solution is to just not use those features when you
 301          * write your messages. This appears to work well enough. Basic formatting and
 302          * external links work just fine.
 303          *
 304          * But in case a translator decides to throw in a #ifexist or internal link or
 305          * whatever, this function is guarded to catch attempted DB access and to present
 306          * some fallback text.
 307          *
 308          * @param $text String
 309          * @param $lineStart Boolean
 310          * @return String
 311          */
 312         public function parse( $text, $lineStart = false ) {
 313                 global $wgParser;
 314
 315                 try {
 316                         $out = $wgParser->parse( $text, $this->parserTitle, $this->parserOptions, $lineStart );
 317                         $html = $out->getText();
 318                 } catch ( DBAccessError $e ) {
 319                         $html = '<!--DB access attempted during parse-->  ' . htmlspecialchars( $text );
 320
 321                         if ( !empty( $this->debug ) ) {
 322                                 $html .= "<!--\n" . $e->getTraceAsString() . "\n-->";
 323                         }
 324                 }
 325
 326                 return $html;
 327         }
 328
 329         /**
 330          * TODO: document
 331          *
 332          * @param $installer DatabaseInstaller
 333          *
 334          * @return Status
 335          */
 336         public function installDatabase( DatabaseInstaller &$installer ) {
 337                 if( !$installer ) {
 338                         $type = $this->getVar( 'wgDBtype' );
 339                         $status = Status::newFatal( "config-no-db", $type );
 340                 } else {
 341                         $status = $installer->setupDatabase();
 342                 }
 343
 344                 return $status;
 345         }
 346
 347         /**
 348          * TODO: document
 349          *
 350          * @param $installer DatabaseInstaller
 351          *
 352          * @return Status
 353          */
 354         public function installTables( DatabaseInstaller &$installer ) {
 355                 $status = $installer->createTables();
 356
 357                 if( $status->isOK() ) {
 358                         LBFactory::enableBackend();
 359                 }
 360
 361                 return $status;
 362         }
 363
 364         /**
 365          * TODO: document
 366          *
 367          * @param $installer DatabaseInstaller
 368          *
 369          * @return Status
 370          */
 371         public function installInterwiki( DatabaseInstaller &$installer ) {
 372                 return $installer->populateInterwikiTable();
 373         }
 374
 375         /**
 376          * Exports all wg* variables stored by the installer into global scope.
 377          */
 378         public function exportVars() {
 379                 foreach ( $this->settings as $name => $value ) {
 380                         if ( substr( $name, 0, 2 ) == 'wg' ) {
 381                                 $GLOBALS[$name] = $value;
 382                         }
 383                 }
 384         }
 385
 386         /**
 387          * Check if we're installing the latest version.
 388          */
 389         public function envLatestVersion() {
 390                 global $wgVersion;
 391
 392                 $repository = wfGetRepository();
 393                 $currentVersion = $repository->getLatestCoreVersion();
 394
 395                 $this->setVar( '_ExternalHTTP', true );
 396
 397                 if ( $currentVersion === false ) {
 398                         # For when the request is successful but there's e.g. some silly man in
 399                         # the middle firewall blocking us, e.g. one of those annoying airport ones
 400                         $this->showMessage( 'config-env-latest-can-not-check', $repository->getLocation() );
 401                         return;
 402                 }
 403
 404                 if( version_compare( $wgVersion, $currentVersion, '<' ) ) {
 405                         $this->showMessage( 'config-env-latest-old' );
 406                         // FIXME: this only works for the web installer!
 407                         $this->showHelpBox( 'config-env-latest-help', $wgVersion, $currentVersion );
 408                 } elseif( version_compare( $wgVersion, $currentVersion, '>' ) ) {
 409                         $this->showMessage( 'config-env-latest-new' );
 410                 }
 411
 412                 $this->showMessage( 'config-env-latest-ok' );
 413         }
 414
 415         /**
 416          * Environment check for DB types.
 417          */
 418         public function envCheckDB() {
 419                 global $wgLang;
 420
 421                 $compiledDBs = array();
 422                 $goodNames = array();
 423                 $allNames = array();
 424
 425                 foreach ( self::getDBTypes() as $name ) {
 426                         $db = $this->getDBInstaller( $name );
 427                         $readableName = wfMsg( 'config-type-' . $name );
 428
 429                         if ( $db->isCompiled() ) {
 430                                 $compiledDBs[] = $name;
 431                                 $goodNames[] = $readableName;
 432                         }
 433
 434                         $allNames[] = $readableName;
 435                 }
 436
 437                 $this->setVar( '_CompiledDBs', $compiledDBs );
 438
 439                 if ( !$compiledDBs ) {
 440                         $this->showMessage( 'config-no-db' );
 441                         // FIXME: this only works for the web installer!
 442                         $this->showHelpBox( 'config-no-db-help', $wgLang->commaList( $allNames ) );
 443                         return false;
 444                 }
 445
 446                 $this->showMessage( 'config-have-db', $wgLang->listToText( $goodNames ), count( $goodNames ) );
 447         }
 448
 449         /**
 450          * Environment check for register_globals.
 451          */
 452         public function envCheckRegisterGlobals() {
 453                 if( wfIniGetBool( "magic_quotes_runtime" ) ) {
 454                         $this->showMessage( 'config-register-globals' );
 455                 }
 456         }
 457
 458         /**
 459          * Environment check for magic_quotes_runtime.
 460          */
 461         public function envCheckMagicQuotes() {
 462                 if( wfIniGetBool( "magic_quotes_runtime" ) ) {
 463                         $this->showMessage( 'config-magic-quotes-runtime' );
 464                         return false;
 465                 }
 466         }
 467
 468         /**
 469          * Environment check for magic_quotes_sybase.
 470          */
 471         public function envCheckMagicSybase() {
 472                 if ( wfIniGetBool( 'magic_quotes_sybase' ) ) {
 473                         $this->showMessage( 'config-magic-quotes-sybase' );
 474                         return false;
 475                 }
 476         }
 477
 478         /**
 479          * Environment check for mbstring.func_overload.
 480          */
 481         public function envCheckMbstring() {
 482                 if ( wfIniGetBool( 'mbstring.func_overload' ) ) {
 483                         $this->showMessage( 'config-mbstring' );
 484                         return false;
 485                 }
 486         }
 487
 488         /**
 489          * Environment check for zend.ze1_compatibility_mode.
 490          */
 491         public function envCheckZE1() {
 492                 if ( wfIniGetBool( 'zend.ze1_compatibility_mode' ) ) {
 493                         $this->showMessage( 'config-ze1' );
 494                         return false;
 495                 }
 496         }
 497
 498         /**
 499          * Environment check for safe_mode.
 500          */
 501         public function envCheckSafeMode() {
 502                 if ( wfIniGetBool( 'safe_mode' ) ) {
 503                         $this->setVar( '_SafeMode', true );
 504                         $this->showMessage( 'config-safe-mode' );
 505                 }
 506         }
 507
 508         /**
 509          * Environment check for the XML module.
 510          */
 511         public function envCheckXML() {
 512                 if ( !function_exists( "utf8_encode" ) ) {
 513                         $this->showMessage( 'config-xml-bad' );
 514                         return false;
 515                 }
 516                 $this->showMessage( 'config-xml-good' );
 517         }
 518
 519         /**
 520          * Environment check for the PCRE module.
 521          */
 522         public function envCheckPCRE() {
 523                 if ( !function_exists( 'preg_match' ) ) {
 524                         $this->showMessage( 'config-pcre' );
 525                         return false;
 526                 }
 527         }
 528
 529         /**
 530          * Environment check for available memory.
 531          */
 532         public function envCheckMemory() {
 533                 $limit = ini_get( 'memory_limit' );
 534
 535                 if ( !$limit || $limit == -1 ) {
 536                         $this->showMessage( 'config-memory-none' );
 537                         return true;
 538                 }
 539
 540                 $n = intval( $limit );
 541
 542                 if( preg_match( '/^([0-9]+)[Mm]$/', trim( $limit ), $m ) ) {
 543                         $n = intval( $m[1] * ( 1024 * 1024 ) );
 544                 }
 545
 546                 if( $n < $this->minMemorySize * 1024 * 1024 ) {
 547                         $newLimit = "{$this->minMemorySize}M";
 548
 549                         if( ini_set( "memory_limit", $newLimit ) === false ) {
 550                                 $this->showMessage( 'config-memory-bad', $limit );
 551                         } else {
 552                                 $this->showMessage( 'config-memory-raised', $limit, $newLimit );
 553                                 $this->setVar( '_RaiseMemory', true );
 554                         }
 555                 } else {
 556                         $this->showMessage( 'config-memory-ok', $limit );
 557                 }
 558         }
 559
 560         /**
 561          * Environment check for compiled object cache types.
 562          */
 563         public function envCheckCache() {
 564                 $caches = array();
 565
 566                 foreach ( $this->objectCaches as $name => $function ) {
 567                         if ( function_exists( $function ) ) {
 568                                 $caches[$name] = true;
 569                                 $this->showMessage( 'config-' . $name );
 570                         }
 571                 }
 572
 573                 if ( !$caches ) {
 574                         $this->showMessage( 'config-no-cache' );
 575                 }
 576
 577                 $this->setVar( '_Caches', $caches );
 578         }
 579
 580         /**
 581          * Search for GNU diff3.
 582          */
 583         public function envCheckDiff3() {
 584                 $paths = array_merge(
 585                         array(
 586                                 "/usr/bin",
 587                                 "/usr/local/bin",
 588                                 "/opt/csw/bin",
 589                                 "/usr/gnu/bin",
 590                                 "/usr/sfw/bin"
 591                         ),
 592                         explode( PATH_SEPARATOR, getenv( "PATH" ) )
 593                 );
 594
 595                 $names = array( "gdiff3", "diff3", "diff3.exe" );
 596                 $versionInfo = array( '$1 --version 2>&1', 'diff3 (GNU diffutils)' );
 597
 598                 $haveDiff3 = false;
 599
 600                 foreach ( $paths as $path ) {
 601                         $exe = $this->locateExecutable( $path, $names, $versionInfo );
 602
 603                         if ($exe !== false) {
 604                                 $this->setVar( 'wgDiff3', $exe );
 605                                 $haveDiff3 = true;
 606                                 break;
 607                         }
 608                 }
 609
 610                 if ( $haveDiff3 ) {
 611                         $this->showMessage( 'config-diff3-good', $exe );
 612                 } else {
 613                         $this->setVar( 'wgDiff3', false );
 614                         $this->showMessage( 'config-diff3-bad' );
 615                 }
 616         }
 617
 618         /**
 619          * Environment check for ImageMagick and GD.
 620          */
 621         public function envCheckGraphics() {
 622                 $imcheck = array( "/usr/bin", "/opt/csw/bin", "/usr/local/bin", "/sw/bin", "/opt/local/bin" );
 623
 624                 foreach( $imcheck as $dir ) {
 625                         $im = "$dir/convert";
 626
 627                         wfSuppressWarnings();
 628                         $file_exists = file_exists( $im );
 629                         wfRestoreWarnings();
 630
 631                         if( $file_exists ) {
 632                                 $this->showMessage( 'config-imagemagick', $im );
 633                                 $this->setVar( 'wgImageMagickConvertCommand', $im );
 634                                 return true;
 635                         }
 636                 }
 637
 638                 if ( function_exists( 'imagejpeg' ) ) {
 639                         $this->showMessage( 'config-gd' );
 640                         return true;
 641                 }
 642
 643                 $this->showMessage( 'no-scaling' );
 644         }
 645
 646         /**
 647          * Environment check for setting $IP and $wgScriptPath.
 648          */
 649         public function envCheckPath() {
 650                 global $IP;
 651                 $IP = dirname( dirname( dirname( __FILE__ ) ) );
 652
 653                 $this->setVar( 'IP', $IP );
 654                 $this->showMessage( 'config-dir', $IP );
 655
 656                 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
 657                 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
 658                 // to get the path to the current script... hopefully it's reliable. SIGH
 659                 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
 660                         $path = $_SERVER['PHP_SELF'];
 661                 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
 662                         $path = $_SERVER['SCRIPT_NAME'];
 663                 } elseif ( $this->getVar( 'wgScriptPath' ) ) {
 664                         // Some kind soul has set it for us already (e.g. debconf)
 665                         return true;
 666                 } else {
 667                         $this->showMessage( 'config-no-uri' );
 668                         return false;
 669                 }
 670
 671                 $uri = preg_replace( '{^(.*)/config.*$}', '$1', $path );
 672                 $this->setVar( 'wgScriptPath', $uri );
 673                 $this->showMessage( 'config-uri', $uri );
 674         }
 675
 676         /**
 677          * Environment check for writable config/ directory.
 678          */
 679         public function envCheckWriteableDir() {
 680                 $ipDir = $this->getVar( 'IP' );
 681                 $configDir = $ipDir . '/config';
 682
 683                 if( !is_writeable( $configDir ) ) {
 684                         $webserverGroup = self::maybeGetWebserverPrimaryGroup();
 685
 686                         if ( $webserverGroup !== null ) {
 687                                 $this->showMessage( 'config-dir-not-writable-group', $ipDir, $webserverGroup );
 688                         } else {
 689                                 $this->showMessage( 'config-dir-not-writable-nogroup', $ipDir, $webserverGroup );
 690                         }
 691
 692                         return false;
 693                 }
 694         }
 695
 696         /**
 697          * Environment check for setting the preferred PHP file extension.
 698          */
 699         public function envCheckExtension() {
 700                 // FIXME: detect this properly
 701                 if ( defined( 'MW_INSTALL_PHP5_EXT' ) ) {
 702                         $ext = 'php5';
 703                 } else {
 704                         $ext = 'php';
 705                 }
 706
 707                 $this->setVar( 'wgScriptExtension', ".$ext" );
 708                 $this->showMessage( 'config-file-extension', $ext );
 709         }
 710
 711         /**
 712          * TODO: document
 713          */
 714         public function envCheckShellLocale() {
 715                 # Give up now if we're in safe mode or open_basedir.
 716                 # It's theoretically possible but tricky to work with.
 717                 if ( wfIniGetBool( "safe_mode" ) || ini_get( 'open_basedir' ) || !function_exists( 'exec' ) ) {
 718                         return true;
 719                 }
 720
 721                 $os = php_uname( 's' );
 722                 $supported = array( 'Linux', 'SunOS', 'HP-UX' ); # Tested these
 723
 724                 if ( !in_array( $os, $supported ) ) {
 725                         return true;
 726                 }
 727
 728                 # Get a list of available locales.
 729                 $lines = $ret = false;
 730                 exec( '/usr/bin/locale -a', $lines, $ret );
 731
 732                 if ( $ret ) {
 733                         return true;
 734                 }
 735
 736                 $lines = wfArrayMap( 'trim', $lines );
 737                 $candidatesByLocale = array();
 738                 $candidatesByLang = array();
 739
 740                 foreach ( $lines as $line ) {
 741                         if ( $line === '' ) {
 742                                 continue;
 743                         }
 744
 745                         if ( !preg_match( '/^([a-zA-Z]+)(_[a-zA-Z]+|)\.(utf8|UTF-8)(@[a-zA-Z_]*|)$/i', $line, $m ) ) {
 746                                 continue;
 747                         }
 748
 749                         list( $all, $lang, $territory, $charset, $modifier ) = $m;
 750
 751                         $candidatesByLocale[$m[0]] = $m;
 752                         $candidatesByLang[$lang][] = $m;
 753                 }
 754
 755                 # Try the current value of LANG.
 756                 if ( isset( $candidatesByLocale[ getenv( 'LANG' ) ] ) ) {
 757                         $this->setVar( 'wgShellLocale', getenv( 'LANG' ) );
 758                         $this->showMessage( 'config-shell-locale', getenv( 'LANG' ) );
 759                         return true;
 760                 }
 761
 762                 # Try the most common ones.
 763                 $commonLocales = array( 'en_US.UTF-8', 'en_US.utf8', 'de_DE.UTF-8', 'de_DE.utf8' );
 764                 foreach ( $commonLocales as $commonLocale ) {
 765                         if ( isset( $candidatesByLocale[$commonLocale] ) ) {
 766                                 $this->setVar( 'wgShellLocale', $commonLocale );
 767                                 $this->showMessage( 'config-shell-locale', $commonLocale );
 768                                 return true;
 769                         }
 770                 }
 771
 772                 # Is there an available locale in the Wiki's language?
 773                 $wikiLang = $this->getVar( 'wgLanguageCode' );
 774
 775                 if ( isset( $candidatesByLang[$wikiLang] ) ) {
 776                         $m = reset( $candidatesByLang[$wikiLang] );
 777                         $this->setVar( 'wgShellLocale', $m[0] );
 778                         $this->showMessage( 'config-shell-locale', $m[0] );
 779                         return true;
 780                 }
 781
 782                 # Are there any at all?
 783                 if ( count( $candidatesByLocale ) ) {
 784                         $m = reset( $candidatesByLocale );
 785                         $this->setVar( 'wgShellLocale', $m[0] );
 786                         $this->showMessage( 'config-shell-locale', $m[0] );
 787                         return true;
 788                 }
 789
 790                 # Give up.
 791                 return true;
 792         }
 793
 794         /**
 795          * TODO: document
 796          */
 797         public function envCheckUploadsDirectory() {
 798                 global $IP, $wgServer;
 799
 800                 $dir = $IP . '/images/';
 801                 $url = $wgServer . $this->getVar( 'wgScriptPath' ) . '/images/';
 802                 $safe = !$this->dirIsExecutable( $dir, $url );
 803
 804                 if ( $safe ) {
 805                         $this->showMessage( 'config-uploads-safe' );
 806                 } else {
 807                         $this->showMessage( 'config-uploads-not-safe', $dir );
 808                 }
 809         }
 810
 811         /**
 812          * Convert a hex string representing a Unicode code point to that code point.
 813          * @param $c String
 814          * @return string
 815          */
 816         protected function unicodeChar( $c ) {
 817                 $c = hexdec($c);
 818                 if ($c <= 0x7F) {
 819                         return chr($c);
 820                 } else if ($c <= 0x7FF) {
 821                         return chr(0xC0 | $c >> 6) . chr(0x80 | $c & 0x3F);
 822                 } else if ($c <= 0xFFFF) {
 823                         return chr(0xE0 | $c >> 12) . chr(0x80 | $c >> 6 & 0x3F)
 824                                 . chr(0x80 | $c & 0x3F);
 825                 } else if ($c <= 0x10FFFF) {
 826                         return chr(0xF0 | $c >> 18) . chr(0x80 | $c >> 12 & 0x3F)
 827                                 . chr(0x80 | $c >> 6 & 0x3F)
 828                                 . chr(0x80 | $c & 0x3F);
 829                 } else {
 830                         return false;
 831                 }
 832         }
 833
 834
 835         /**
 836          * Check the libicu version
 837          */
 838         public function envCheckLibicu() {
 839                 $utf8 = function_exists( 'utf8_normalize' );
 840                 $intl = function_exists( 'normalizer_normalize' );
 841
 842                 /**
 843                  * This needs to be updated something that the latest libicu
 844                  * will properly normalize.  This normalization was found at
 845                  * http://www.unicode.org/versions/Unicode5.2.0/#Character_Additions
 846                  * Note that we use the hex representation to create the code
 847                  * points in order to avoid any Unicode-destroying during transit.
 848                  */
 849                 $not_normal_c = $this->unicodeChar("FA6C");
 850                 $normal_c = $this->unicodeChar("242EE");
 851
 852                 $useNormalizer = 'php';
 853                 $needsUpdate = false;
 854
 855                 /**
 856                  * We're going to prefer the pecl extension here unless
 857                  * utf8_normalize is more up to date.
 858                  */
 859                 if( $utf8 ) {
 860                         $useNormalizer = 'utf8';
 861                         $utf8 = utf8_normalize( $not_normal_c, UNORM_NFC );
 862                         if ( $utf8 !== $normal_c ) $needsUpdate = true;
 863                 }
 864                 if( $intl ) {
 865                         $useNormalizer = 'intl';
 866                         $intl = normalizer_normalize( $not_normal_c, Normalizer::FORM_C );
 867                         if ( $intl !== $normal_c ) $needsUpdate = true;
 868                 }
 869
 870                 // Uses messages 'config-unicode-using-php', 'config-unicode-using-utf8', 'config-unicode-using-intl'
 871                 $this->showMessage( 'config-unicode-using-' . $useNormalizer );
 872                 if( $useNormalizer === 'php' ) {
 873                         $this->showMessage( 'config-unicode-pure-php-warning' );
 874                 } elseif( $needsUpdate ) {
 875                         $this->showMessage( 'config-unicode-update-warning' );
 876                 }
 877         }
 878
 879
 880         /**
 881          * Search a path for any of the given executable names. Returns the
 882          * executable name if found. Also checks the version string returned
 883          * by each executable.
 884          *
 885          * Used only by environment checks.
 886          *
 887          * @param $path String: path to search
 888          * @param $names Array of executable names
 889          * @param $versionInfo Boolean false or array with two members:
 890          *               0 => Command to run for version check, with $1 for the path
 891          *               1 => String to compare the output with
 892          *
 893          * If $versionInfo is not false, only executables with a version
 894          * matching $versionInfo[1] will be returned.
 895          */
 896         protected function locateExecutable( $path, $names, $versionInfo = false ) {
 897                 if ( !is_array( $names ) ) {
 898                         $names = array( $names );
 899                 }
 900
 901                 foreach ( $names as $name ) {
 902                         $command = "$path/$name";
 903
 904                         wfSuppressWarnings();
 905                         $file_exists = file_exists( $command );
 906                         wfRestoreWarnings();
 907
 908                         if ( $file_exists ) {
 909                                 if ( !$versionInfo ) {
 910                                         return $command;
 911                                 }
 912
 913                                 $file = str_replace( '$1', $command, $versionInfo[0] );
 914
 915                                 # Should maybe be wfShellExec( $file), but runs into a ulimit, see
 916                                 # http://www.mediawiki.org/w/index.php?title=New-installer_issues&diff=prev&oldid=335456
 917                                 if ( strstr( `$file`, $versionInfo[1]) !== false ) {
 918                                         return $command;
 919                                 }
 920                         }
 921                 }
 922
 923                 return false;
 924         }
 925
 926         /**
 927          * Checks if scripts located in the given directory can be executed via the given URL.
 928          *
 929          * Used only by environment checks.
 930          */
 931         public function dirIsExecutable( $dir, $url ) {
 932                 $scriptTypes = array(
 933                         'php' => array(
 934                                 "<?php echo 'ex' . 'ec';",
 935                                 "#!/var/env php5\n<?php echo 'ex' . 'ec';",
 936                         ),
 937                 );
 938
 939                 // it would be good to check other popular languages here, but it'll be slow.
 940
 941                 wfSuppressWarnings();
 942
 943                 foreach ( $scriptTypes as $ext => $contents ) {
 944                         foreach ( $contents as $source ) {
 945                                 $file = 'exectest.' . $ext;
 946
 947                                 if ( !file_put_contents( $dir . $file, $source ) ) {
 948                                         break;
 949                                 }
 950
 951                                 $text = Http::get( $url . $file );
 952                                 unlink( $dir . $file );
 953
 954                                 if ( $text == 'exec' ) {
 955                                         wfRestoreWarnings();
 956                                         return $ext;
 957                                 }
 958                         }
 959                 }
 960
 961                 wfRestoreWarnings();
 962
 963                 return false;
 964         }
 965
 966 }