includes/installer/Installer.php

   1 <?php
   2 /**
   3  * Base code for MediaWiki installer.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Deployment
  22  */
  23
  24 /**
  25  * This documentation group collects source code files with deployment functionality.
  26  *
  27  * @defgroup Deployment Deployment
  28  */
  29
  30 /**
  31  * Base installer class.
  32  *
  33  * This class provides the base for installation and update functionality
  34  * for both MediaWiki core and extensions.
  35  *
  36  * @ingroup Deployment
  37  * @since 1.17
  38  */
  39 abstract class Installer {
  40
  41         /**
  42          * The oldest version of PCRE we can support.
  43          *
  44          * Defining this is necessary because PHP may be linked with a system version
  45          * of PCRE, which may be older than that bundled with the minimum PHP version.
  46          */
  47         const MINIMUM_PCRE_VERSION = '7.2';
  48
  49         /**
  50          * @var array
  51          */
  52         protected $settings;
  53
  54         /**
  55          * List of detected DBs, access using getCompiledDBs().
  56          *
  57          * @var array
  58          */
  59         protected $compiledDBs;
  60
  61         /**
  62          * Cached DB installer instances, access using getDBInstaller().
  63          *
  64          * @var array
  65          */
  66         protected $dbInstallers = array();
  67
  68         /**
  69          * Minimum memory size in MB.
  70          *
  71          * @var int
  72          */
  73         protected $minMemorySize = 50;
  74
  75         /**
  76          * Cached Title, used by parse().
  77          *
  78          * @var Title
  79          */
  80         protected $parserTitle;
  81
  82         /**
  83          * Cached ParserOptions, used by parse().
  84          *
  85          * @var ParserOptions
  86          */
  87         protected $parserOptions;
  88
  89         /**
  90          * Known database types. These correspond to the class names <type>Installer,
  91          * and are also MediaWiki database types valid for $wgDBtype.
  92          *
  93          * To add a new type, create a <type>Installer class and a Database<type>
  94          * class, and add a config-type-<type> message to MessagesEn.php.
  95          *
  96          * @var array
  97          */
  98         protected static $dbTypes = array(
  99                 'mysql',
 100                 'postgres',
 101                 'oracle',
 102                 'mssql',
 103                 'sqlite',
 104         );
 105
 106         /**
 107          * A list of environment check methods called by doEnvironmentChecks().
 108          * These may output warnings using showMessage(), and/or abort the
 109          * installation process by returning false.
 110          *
 111          * For the WebInstaller these are only called on the Welcome page,
 112          * if these methods have side-effects that should affect later page loads
 113          * (as well as the generated stylesheet), use envPreps instead.
 114          *
 115          * @var array
 116          */
 117         protected $envChecks = array(
 118                 'envCheckDB',
 119                 'envCheckRegisterGlobals',
 120                 'envCheckBrokenXML',
 121                 'envCheckMagicQuotes',
 122                 'envCheckMbstring',
 123                 'envCheckSafeMode',
 124                 'envCheckXML',
 125                 'envCheckPCRE',
 126                 'envCheckMemory',
 127                 'envCheckCache',
 128                 'envCheckModSecurity',
 129                 'envCheckDiff3',
 130                 'envCheckGraphics',
 131                 'envCheckGit',
 132                 'envCheckServer',
 133                 'envCheckPath',
 134                 'envCheckShellLocale',
 135                 'envCheckUploadsDirectory',
 136                 'envCheckLibicu',
 137                 'envCheckSuhosinMaxValueLength',
 138                 'envCheckCtype',
 139                 'envCheckIconv',
 140                 'envCheckJSON',
 141         );
 142
 143         /**
 144          * A list of environment preparation methods called by doEnvironmentPreps().
 145          *
 146          * @var array
 147          */
 148         protected $envPreps = array(
 149                 'envPrepExtension',
 150                 'envPrepServer',
 151                 'envPrepPath',
 152         );
 153
 154         /**
 155          * MediaWiki configuration globals that will eventually be passed through
 156          * to LocalSettings.php. The names only are given here, the defaults
 157          * typically come from DefaultSettings.php.
 158          *
 159          * @var array
 160          */
 161         protected $defaultVarNames = array(
 162                 'wgSitename',
 163                 'wgPasswordSender',
 164                 'wgLanguageCode',
 165                 'wgRightsIcon',
 166                 'wgRightsText',
 167                 'wgRightsUrl',
 168                 'wgMainCacheType',
 169                 'wgEnableEmail',
 170                 'wgEnableUserEmail',
 171                 'wgEnotifUserTalk',
 172                 'wgEnotifWatchlist',
 173                 'wgEmailAuthentication',
 174                 'wgDBtype',
 175                 'wgDiff3',
 176                 'wgImageMagickConvertCommand',
 177                 'wgGitBin',
 178                 'IP',
 179                 'wgScriptPath',
 180                 'wgScriptExtension',
 181                 'wgMetaNamespace',
 182                 'wgDeletedDirectory',
 183                 'wgEnableUploads',
 184                 'wgShellLocale',
 185                 'wgSecretKey',
 186                 'wgUseInstantCommons',
 187                 'wgUpgradeKey',
 188                 'wgDefaultSkin',
 189                 'wgResourceLoaderMaxQueryLength',
 190         );
 191
 192         /**
 193          * Variables that are stored alongside globals, and are used for any
 194          * configuration of the installation process aside from the MediaWiki
 195          * configuration. Map of names to defaults.
 196          *
 197          * @var array
 198          */
 199         protected $internalDefaults = array(
 200                 '_UserLang' => 'en',
 201                 '_Environment' => false,
 202                 '_SafeMode' => false,
 203                 '_RaiseMemory' => false,
 204                 '_UpgradeDone' => false,
 205                 '_InstallDone' => false,
 206                 '_Caches' => array(),
 207                 '_InstallPassword' => '',
 208                 '_SameAccount' => true,
 209                 '_CreateDBAccount' => false,
 210                 '_NamespaceType' => 'site-name',
 211                 '_AdminName' => '', // will be set later, when the user selects language
 212                 '_AdminPassword' => '',
 213                 '_AdminPasswordConfirm' => '',
 214                 '_AdminEmail' => '',
 215                 '_Subscribe' => false,
 216                 '_SkipOptional' => 'continue',
 217                 '_RightsProfile' => 'wiki',
 218                 '_LicenseCode' => 'none',
 219                 '_CCDone' => false,
 220                 '_Extensions' => array(),
 221                 '_Skins' => array(),
 222                 '_MemCachedServers' => '',
 223                 '_UpgradeKeySupplied' => false,
 224                 '_ExistingDBSettings' => false,
 225
 226                 // $wgLogo is probably wrong (bug 48084); set something that will work.
 227                 // Single quotes work fine here, as LocalSettingsGenerator outputs this unescaped.
 228                 'wgLogo' => '$wgScriptPath/resources/assets/wiki.png',
 229         );
 230
 231         /**
 232          * The actual list of installation steps. This will be initialized by getInstallSteps()
 233          *
 234          * @var array
 235          */
 236         private $installSteps = array();
 237
 238         /**
 239          * Extra steps for installation, for things like DatabaseInstallers to modify
 240          *
 241          * @var array
 242          */
 243         protected $extraInstallSteps = array();
 244
 245         /**
 246          * Known object cache types and the functions used to test for their existence.
 247          *
 248          * @var array
 249          */
 250         protected $objectCaches = array(
 251                 'xcache' => 'xcache_get',
 252                 'apc' => 'apc_fetch',
 253                 'wincache' => 'wincache_ucache_get'
 254         );
 255
 256         /**
 257          * User rights profiles.
 258          *
 259          * @var array
 260          */
 261         public $rightsProfiles = array(
 262                 'wiki' => array(),
 263                 'no-anon' => array(
 264                         '*' => array( 'edit' => false )
 265                 ),
 266                 'fishbowl' => array(
 267                         '*' => array(
 268                                 'createaccount' => false,
 269                                 'edit' => false,
 270                         ),
 271                 ),
 272                 'private' => array(
 273                         '*' => array(
 274                                 'createaccount' => false,
 275                                 'edit' => false,
 276                                 'read' => false,
 277                         ),
 278                 ),
 279         );
 280
 281         /**
 282          * License types.
 283          *
 284          * @var array
 285          */
 286         public $licenses = array(
 287                 'cc-by' => array(
 288                         'url' => 'http://creativecommons.org/licenses/by/3.0/',
 289                         'icon' => '{$wgResourceBasePath}/resources/assets/licenses/cc-by.png',
 290                 ),
 291                 'cc-by-sa' => array(
 292                         'url' => 'http://creativecommons.org/licenses/by-sa/3.0/',
 293                         'icon' => '{$wgResourceBasePath}/resources/assets/licenses/cc-by-sa.png',
 294                 ),
 295                 'cc-by-nc-sa' => array(
 296                         'url' => 'http://creativecommons.org/licenses/by-nc-sa/3.0/',
 297                         'icon' => '{$wgResourceBasePath}/resources/assets/licenses/cc-by-nc-sa.png',
 298                 ),
 299                 'cc-0' => array(
 300                         'url' => 'https://creativecommons.org/publicdomain/zero/1.0/',
 301                         'icon' => '{$wgResourceBasePath}/resources/assets/licenses/cc-0.png',
 302                 ),
 303                 'pd' => array(
 304                         'url' => '',
 305                         'icon' => '{$wgResourceBasePath}/resources/assets/licenses/public-domain.png',
 306                 ),
 307                 'gfdl' => array(
 308                         'url' => 'http://www.gnu.org/copyleft/fdl.html',
 309                         'icon' => '{$wgResourceBasePath}/resources/assets/licenses/gnu-fdl.png',
 310                 ),
 311                 'none' => array(
 312                         'url' => '',
 313                         'icon' => '',
 314                         'text' => ''
 315                 ),
 316                 'cc-choose' => array(
 317                         // Details will be filled in by the selector.
 318                         'url' => '',
 319                         'icon' => '',
 320                         'text' => '',
 321                 ),
 322         );
 323
 324         /**
 325          * URL to mediawiki-announce subscription
 326          */
 327         protected $mediaWikiAnnounceUrl =
 328                 'https://lists.wikimedia.org/mailman/subscribe/mediawiki-announce';
 329
 330         /**
 331          * Supported language codes for Mailman
 332          */
 333         protected $mediaWikiAnnounceLanguages = array(
 334                 'ca', 'cs', 'da', 'de', 'en', 'es', 'et', 'eu', 'fi', 'fr', 'hr', 'hu',
 335                 'it', 'ja', 'ko', 'lt', 'nl', 'no', 'pl', 'pt', 'pt-br', 'ro', 'ru',
 336                 'sl', 'sr', 'sv', 'tr', 'uk'
 337         );
 338
 339         /**
 340          * UI interface for displaying a short message
 341          * The parameters are like parameters to wfMessage().
 342          * The messages will be in wikitext format, which will be converted to an
 343          * output format such as HTML or text before being sent to the user.
 344          * @param string $msg
 345          */
 346         abstract public function showMessage( $msg /*, ... */ );
 347
 348         /**
 349          * Same as showMessage(), but for displaying errors
 350          * @param string $msg
 351          */
 352         abstract public function showError( $msg /*, ... */ );
 353
 354         /**
 355          * Show a message to the installing user by using a Status object
 356          * @param Status $status
 357          */
 358         abstract public function showStatusMessage( Status $status );
 359
 360         /**
 361          * Constructor, always call this from child classes.
 362          */
 363         public function __construct() {
 364                 global $wgMessagesDirs, $wgUser;
 365
 366                 // Disable the i18n cache
 367                 Language::getLocalisationCache()->disableBackend();
 368                 // Disable LoadBalancer and wfGetDB etc.
 369                 LBFactory::disableBackend();
 370
 371                 // Disable object cache (otherwise CACHE_ANYTHING will try CACHE_DB and
 372                 // SqlBagOStuff will then throw since we just disabled wfGetDB)
 373                 $GLOBALS['wgMemc'] = new EmptyBagOStuff;
 374                 ObjectCache::clear();
 375                 $emptyCache = array( 'class' => 'EmptyBagOStuff' );
 376                 $GLOBALS['wgObjectCaches'] = array(
 377                         CACHE_NONE => $emptyCache,
 378                         CACHE_DB => $emptyCache,
 379                         CACHE_ANYTHING => $emptyCache,
 380                         CACHE_MEMCACHED => $emptyCache,
 381                 );
 382
 383                 // Load the installer's i18n.
 384                 $wgMessagesDirs['MediawikiInstaller'] = __DIR__ . '/i18n';
 385
 386                 // Having a user with id = 0 safeguards us from DB access via User::loadOptions().
 387                 $wgUser = User::newFromId( 0 );
 388
 389                 $this->settings = $this->internalDefaults;
 390
 391                 foreach ( $this->defaultVarNames as $var ) {
 392                         $this->settings[$var] = $GLOBALS[$var];
 393                 }
 394
 395                 $this->doEnvironmentPreps();
 396
 397                 $this->compiledDBs = array();
 398                 foreach ( self::getDBTypes() as $type ) {
 399                         $installer = $this->getDBInstaller( $type );
 400
 401                         if ( !$installer->isCompiled() ) {
 402                                 continue;
 403                         }
 404                         $this->compiledDBs[] = $type;
 405                 }
 406
 407                 $this->parserTitle = Title::newFromText( 'Installer' );
 408                 $this->parserOptions = new ParserOptions; // language will be wrong :(
 409                 $this->parserOptions->setEditSection( false );
 410         }
 411
 412         /**
 413          * Get a list of known DB types.
 414          *
 415          * @return array
 416          */
 417         public static function getDBTypes() {
 418                 return self::$dbTypes;
 419         }
 420
 421         /**
 422          * Do initial checks of the PHP environment. Set variables according to
 423          * the observed environment.
 424          *
 425          * It's possible that this may be called under the CLI SAPI, not the SAPI
 426          * that the wiki will primarily run under. In that case, the subclass should
 427          * initialise variables such as wgScriptPath, before calling this function.
 428          *
 429          * Under the web subclass, it can already be assumed that PHP 5+ is in use
 430          * and that sessions are working.
 431          *
 432          * @return Status
 433          */
 434         public function doEnvironmentChecks() {
 435                 // Php version has already been checked by entry scripts
 436                 // Show message here for information purposes
 437                 if ( wfIsHHVM() ) {
 438                         $this->showMessage( 'config-env-hhvm', HHVM_VERSION );
 439                 } else {
 440                         $this->showMessage( 'config-env-php', PHP_VERSION );
 441                 }
 442
 443                 $good = true;
 444                 // Must go here because an old version of PCRE can prevent other checks from completing
 445                 list( $pcreVersion ) = explode( ' ', PCRE_VERSION, 2 );
 446                 if ( version_compare( $pcreVersion, self::MINIMUM_PCRE_VERSION, '<' ) ) {
 447                         $this->showError( 'config-pcre-old', self::MINIMUM_PCRE_VERSION, $pcreVersion );
 448                         $good = false;
 449                 } else {
 450                         foreach ( $this->envChecks as $check ) {
 451                                 $status = $this->$check();
 452                                 if ( $status === false ) {
 453                                         $good = false;
 454                                 }
 455                         }
 456                 }
 457
 458                 $this->setVar( '_Environment', $good );
 459
 460                 return $good ? Status::newGood() : Status::newFatal( 'config-env-bad' );
 461         }
 462
 463         public function doEnvironmentPreps() {
 464                 foreach ( $this->envPreps as $prep ) {
 465                         $this->$prep();
 466                 }
 467         }
 468
 469         /**
 470          * Set a MW configuration variable, or internal installer configuration variable.
 471          *
 472          * @param string $name
 473          * @param mixed $value
 474          */
 475         public function setVar( $name, $value ) {
 476                 $this->settings[$name] = $value;
 477         }
 478
 479         /**
 480          * Get an MW configuration variable, or internal installer configuration variable.
 481          * The defaults come from $GLOBALS (ultimately DefaultSettings.php).
 482          * Installer variables are typically prefixed by an underscore.
 483          *
 484          * @param string $name
 485          * @param mixed $default
 486          *
 487          * @return mixed
 488          */
 489         public function getVar( $name, $default = null ) {
 490                 if ( !isset( $this->settings[$name] ) ) {
 491                         return $default;
 492                 } else {
 493                         return $this->settings[$name];
 494                 }
 495         }
 496
 497         /**
 498          * Get a list of DBs supported by current PHP setup
 499          *
 500          * @return array
 501          */
 502         public function getCompiledDBs() {
 503                 return $this->compiledDBs;
 504         }
 505
 506         /**
 507          * Get an instance of DatabaseInstaller for the specified DB type.
 508          *
 509          * @param mixed $type DB installer for which is needed, false to use default.
 510          *
 511          * @return DatabaseInstaller
 512          */
 513         public function getDBInstaller( $type = false ) {
 514                 if ( !$type ) {
 515                         $type = $this->getVar( 'wgDBtype' );
 516                 }
 517
 518                 $type = strtolower( $type );
 519
 520                 if ( !isset( $this->dbInstallers[$type] ) ) {
 521                         $class = ucfirst( $type ) . 'Installer';
 522                         $this->dbInstallers[$type] = new $class( $this );
 523                 }
 524
 525                 return $this->dbInstallers[$type];
 526         }
 527
 528         /**
 529          * Determine if LocalSettings.php exists. If it does, return its variables.
 530          *
 531          * @return array
 532          */
 533         public static function getExistingLocalSettings() {
 534                 global $IP;
 535
 536                 // You might be wondering why this is here. Well if you don't do this
 537                 // then some poorly-formed extensions try to call their own classes
 538                 // after immediately registering them. We really need to get extension
 539                 // registration out of the global scope and into a real format.
 540                 // @see https://bugzilla.wikimedia.org/67440
 541                 global $wgAutoloadClasses;
 542                 $wgAutoloadClasses = array();
 543
 544                 wfSuppressWarnings();
 545                 $_lsExists = file_exists( "$IP/LocalSettings.php" );
 546                 wfRestoreWarnings();
 547
 548                 if ( !$_lsExists ) {
 549                         return false;
 550                 }
 551                 unset( $_lsExists );
 552
 553                 require "$IP/includes/DefaultSettings.php";
 554                 require "$IP/LocalSettings.php";
 555
 556                 return get_defined_vars();
 557         }
 558
 559         /**
 560          * Get a fake password for sending back to the user in HTML.
 561          * This is a security mechanism to avoid compromise of the password in the
 562          * event of session ID compromise.
 563          *
 564          * @param string $realPassword
 565          *
 566          * @return string
 567          */
 568         public function getFakePassword( $realPassword ) {
 569                 return str_repeat( '*', strlen( $realPassword ) );
 570         }
 571
 572         /**
 573          * Set a variable which stores a password, except if the new value is a
 574          * fake password in which case leave it as it is.
 575          *
 576          * @param string $name
 577          * @param mixed $value
 578          */
 579         public function setPassword( $name, $value ) {
 580                 if ( !preg_match( '/^\*+$/', $value ) ) {
 581                         $this->setVar( $name, $value );
 582                 }
 583         }
 584
 585         /**
 586          * On POSIX systems return the primary group of the webserver we're running under.
 587          * On other systems just returns null.
 588          *
 589          * This is used to advice the user that he should chgrp his mw-config/data/images directory as the
 590          * webserver user before he can install.
 591          *
 592          * Public because SqliteInstaller needs it, and doesn't subclass Installer.
 593          *
 594          * @return mixed
 595          */
 596         public static function maybeGetWebserverPrimaryGroup() {
 597                 if ( !function_exists( 'posix_getegid' ) || !function_exists( 'posix_getpwuid' ) ) {
 598                         # I don't know this, this isn't UNIX.
 599                         return null;
 600                 }
 601
 602                 # posix_getegid() *not* getmygid() because we want the group of the webserver,
 603                 # not whoever owns the current script.
 604                 $gid = posix_getegid();
 605                 $getpwuid = posix_getpwuid( $gid );
 606                 $group = $getpwuid['name'];
 607
 608                 return $group;
 609         }
 610
 611         /**
 612          * Convert wikitext $text to HTML.
 613          *
 614          * This is potentially error prone since many parser features require a complete
 615          * installed MW database. The solution is to just not use those features when you
 616          * write your messages. This appears to work well enough. Basic formatting and
 617          * external links work just fine.
 618          *
 619          * But in case a translator decides to throw in a "#ifexist" or internal link or
 620          * whatever, this function is guarded to catch the attempted DB access and to present
 621          * some fallback text.
 622          *
 623          * @param string $text
 624          * @param bool $lineStart
 625          * @return string
 626          */
 627         public function parse( $text, $lineStart = false ) {
 628                 global $wgParser;
 629
 630                 try {
 631                         $out = $wgParser->parse( $text, $this->parserTitle, $this->parserOptions, $lineStart );
 632                         $html = $out->getText();
 633                 } catch ( DBAccessError $e ) {
 634                         $html = '<!--DB access attempted during parse-->  ' . htmlspecialchars( $text );
 635
 636                         if ( !empty( $this->debug ) ) {
 637                                 $html .= "<!--\n" . $e->getTraceAsString() . "\n-->";
 638                         }
 639                 }
 640
 641                 return $html;
 642         }
 643
 644         /**
 645          * @return ParserOptions
 646          */
 647         public function getParserOptions() {
 648                 return $this->parserOptions;
 649         }
 650
 651         public function disableLinkPopups() {
 652                 $this->parserOptions->setExternalLinkTarget( false );
 653         }
 654
 655         public function restoreLinkPopups() {
 656                 global $wgExternalLinkTarget;
 657                 $this->parserOptions->setExternalLinkTarget( $wgExternalLinkTarget );
 658         }
 659
 660         /**
 661          * Install step which adds a row to the site_stats table with appropriate
 662          * initial values.
 663          *
 664          * @param DatabaseInstaller $installer
 665          *
 666          * @return Status
 667          */
 668         public function populateSiteStats( DatabaseInstaller $installer ) {
 669                 $status = $installer->getConnection();
 670                 if ( !$status->isOK() ) {
 671                         return $status;
 672                 }
 673                 $status->value->insert(
 674                         'site_stats',
 675                         array(
 676                                 'ss_row_id' => 1,
 677                                 'ss_total_views' => 0,
 678                                 'ss_total_edits' => 0,
 679                                 'ss_good_articles' => 0,
 680                                 'ss_total_pages' => 0,
 681                                 'ss_users' => 0,
 682                                 'ss_images' => 0
 683                         ),
 684                         __METHOD__, 'IGNORE'
 685                 );
 686
 687                 return Status::newGood();
 688         }
 689
 690         /**
 691          * Exports all wg* variables stored by the installer into global scope.
 692          */
 693         public function exportVars() {
 694                 foreach ( $this->settings as $name => $value ) {
 695                         if ( substr( $name, 0, 2 ) == 'wg' ) {
 696                                 $GLOBALS[$name] = $value;
 697                         }
 698                 }
 699         }
 700
 701         /**
 702          * Environment check for DB types.
 703          * @return bool
 704          */
 705         protected function envCheckDB() {
 706                 global $wgLang;
 707
 708                 $allNames = array();
 709
 710                 // Messages: config-type-mysql, config-type-postgres, config-type-oracle,
 711                 // config-type-sqlite
 712                 foreach ( self::getDBTypes() as $name ) {
 713                         $allNames[] = wfMessage( "config-type-$name" )->text();
 714                 }
 715
 716                 $databases = $this->getCompiledDBs();
 717
 718                 $databases = array_flip( $databases );
 719                 foreach ( array_keys( $databases ) as $db ) {
 720                         $installer = $this->getDBInstaller( $db );
 721                         $status = $installer->checkPrerequisites();
 722                         if ( !$status->isGood() ) {
 723                                 $this->showStatusMessage( $status );
 724                         }
 725                         if ( !$status->isOK() ) {
 726                                 unset( $databases[$db] );
 727                         }
 728                 }
 729                 $databases = array_flip( $databases );
 730                 if ( !$databases ) {
 731                         $this->showError( 'config-no-db', $wgLang->commaList( $allNames ) );
 732
 733                         // @todo FIXME: This only works for the web installer!
 734                         return false;
 735                 }
 736
 737                 return true;
 738         }
 739
 740         /**
 741          * Environment check for register_globals.
 742          * Prevent installation if enabled
 743          * @return bool
 744          */
 745         protected function envCheckRegisterGlobals() {
 746                 if ( wfIniGetBool( 'register_globals' ) ) {
 747                         $this->showMessage( 'config-register-globals-error' );
 748                         return false;
 749                 }
 750
 751                 return true;
 752         }
 753
 754         /**
 755          * Some versions of libxml+PHP break < and > encoding horribly
 756          * @return bool
 757          */
 758         protected function envCheckBrokenXML() {
 759                 $test = new PhpXmlBugTester();
 760                 if ( !$test->ok ) {
 761                         $this->showError( 'config-brokenlibxml' );
 762
 763                         return false;
 764                 }
 765
 766                 return true;
 767         }
 768
 769         /**
 770          * Environment check for magic_quotes_(gpc|runtime|sybase).
 771          * @return bool
 772          */
 773         protected function envCheckMagicQuotes() {
 774                 $status = true;
 775                 foreach ( array( 'gpc', 'runtime', 'sybase' ) as $magicJunk ) {
 776                         if ( wfIniGetBool( "magic_quotes_$magicJunk" ) ) {
 777                                 $this->showError( "config-magic-quotes-$magicJunk" );
 778                                 $status = false;
 779                         }
 780                 }
 781
 782                 return $status;
 783         }
 784
 785         /**
 786          * Environment check for mbstring.func_overload.
 787          * @return bool
 788          */
 789         protected function envCheckMbstring() {
 790                 if ( wfIniGetBool( 'mbstring.func_overload' ) ) {
 791                         $this->showError( 'config-mbstring' );
 792
 793                         return false;
 794                 }
 795
 796                 return true;
 797         }
 798
 799         /**
 800          * Environment check for safe_mode.
 801          * @return bool
 802          */
 803         protected function envCheckSafeMode() {
 804                 if ( wfIniGetBool( 'safe_mode' ) ) {
 805                         $this->setVar( '_SafeMode', true );
 806                         $this->showMessage( 'config-safe-mode' );
 807                 }
 808
 809                 return true;
 810         }
 811
 812         /**
 813          * Environment check for the XML module.
 814          * @return bool
 815          */
 816         protected function envCheckXML() {
 817                 if ( !function_exists( "utf8_encode" ) ) {
 818                         $this->showError( 'config-xml-bad' );
 819
 820                         return false;
 821                 }
 822
 823                 return true;
 824         }
 825
 826         /**
 827          * Environment check for the PCRE module.
 828          *
 829          * @note If this check were to fail, the parser would
 830          *   probably throw an exception before the result
 831          *   of this check is shown to the user.
 832          * @return bool
 833          */
 834         protected function envCheckPCRE() {
 835                 wfSuppressWarnings();
 836                 $regexd = preg_replace( '/[\x{0430}-\x{04FF}]/iu', '', '-АБВГД-' );
 837                 // Need to check for \p support too, as PCRE can be compiled
 838                 // with utf8 support, but not unicode property support.
 839                 // check that \p{Zs} (space separators) matches
 840                 // U+3000 (Ideographic space)
 841                 $regexprop = preg_replace( '/\p{Zs}/u', '', "-\xE3\x80\x80-" );
 842                 wfRestoreWarnings();
 843                 if ( $regexd != '--' || $regexprop != '--' ) {
 844                         $this->showError( 'config-pcre-no-utf8' );
 845
 846                         return false;
 847                 }
 848
 849                 return true;
 850         }
 851
 852         /**
 853          * Environment check for available memory.
 854          * @return bool
 855          */
 856         protected function envCheckMemory() {
 857                 $limit = ini_get( 'memory_limit' );
 858
 859                 if ( !$limit || $limit == -1 ) {
 860                         return true;
 861                 }
 862
 863                 $n = wfShorthandToInteger( $limit );
 864
 865                 if ( $n < $this->minMemorySize * 1024 * 1024 ) {
 866                         $newLimit = "{$this->minMemorySize}M";
 867
 868                         if ( ini_set( "memory_limit", $newLimit ) === false ) {
 869                                 $this->showMessage( 'config-memory-bad', $limit );
 870                         } else {
 871                                 $this->showMessage( 'config-memory-raised', $limit, $newLimit );
 872                                 $this->setVar( '_RaiseMemory', true );
 873                         }
 874                 }
 875
 876                 return true;
 877         }
 878
 879         /**
 880          * Environment check for compiled object cache types.
 881          */
 882         protected function envCheckCache() {
 883                 $caches = array();
 884                 foreach ( $this->objectCaches as $name => $function ) {
 885                         if ( function_exists( $function ) ) {
 886                                 if ( $name == 'xcache' && !wfIniGetBool( 'xcache.var_size' ) ) {
 887                                         continue;
 888                                 }
 889                                 $caches[$name] = true;
 890                         }
 891                 }
 892
 893                 if ( !$caches ) {
 894                         $this->showMessage( 'config-no-cache' );
 895                 }
 896
 897                 $this->setVar( '_Caches', $caches );
 898         }
 899
 900         /**
 901          * Scare user to death if they have mod_security or mod_security2
 902          * @return bool
 903          */
 904         protected function envCheckModSecurity() {
 905                 if ( self::apacheModulePresent( 'mod_security' )
 906                         || self::apacheModulePresent( 'mod_security2' ) ) {
 907                         $this->showMessage( 'config-mod-security' );
 908                 }
 909
 910                 return true;
 911         }
 912
 913         /**
 914          * Search for GNU diff3.
 915          * @return bool
 916          */
 917         protected function envCheckDiff3() {
 918                 $names = array( "gdiff3", "diff3", "diff3.exe" );
 919                 $versionInfo = array( '$1 --version 2>&1', 'GNU diffutils' );
 920
 921                 $diff3 = self::locateExecutableInDefaultPaths( $names, $versionInfo );
 922
 923                 if ( $diff3 ) {
 924                         $this->setVar( 'wgDiff3', $diff3 );
 925                 } else {
 926                         $this->setVar( 'wgDiff3', false );
 927                         $this->showMessage( 'config-diff3-bad' );
 928                 }
 929
 930                 return true;
 931         }
 932
 933         /**
 934          * Environment check for ImageMagick and GD.
 935          * @return bool
 936          */
 937         protected function envCheckGraphics() {
 938                 $names = array( wfIsWindows() ? 'convert.exe' : 'convert' );
 939                 $versionInfo = array( '$1 -version', 'ImageMagick' );
 940                 $convert = self::locateExecutableInDefaultPaths( $names, $versionInfo );
 941
 942                 $this->setVar( 'wgImageMagickConvertCommand', '' );
 943                 if ( $convert ) {
 944                         $this->setVar( 'wgImageMagickConvertCommand', $convert );
 945                         $this->showMessage( 'config-imagemagick', $convert );
 946
 947                         return true;
 948                 } elseif ( function_exists( 'imagejpeg' ) ) {
 949                         $this->showMessage( 'config-gd' );
 950                 } else {
 951                         $this->showMessage( 'config-no-scaling' );
 952                 }
 953
 954                 return true;
 955         }
 956
 957         /**
 958          * Search for git.
 959          *
 960          * @since 1.22
 961          * @return bool
 962          */
 963         protected function envCheckGit() {
 964                 $names = array( wfIsWindows() ? 'git.exe' : 'git' );
 965                 $versionInfo = array( '$1 --version', 'git version' );
 966
 967                 $git = self::locateExecutableInDefaultPaths( $names, $versionInfo );
 968
 969                 if ( $git ) {
 970                         $this->setVar( 'wgGitBin', $git );
 971                         $this->showMessage( 'config-git', $git );
 972                 } else {
 973                         $this->setVar( 'wgGitBin', false );
 974                         $this->showMessage( 'config-git-bad' );
 975                 }
 976
 977                 return true;
 978         }
 979
 980         /**
 981          * Environment check to inform user which server we've assumed.
 982          *
 983          * @return bool
 984          */
 985         protected function envCheckServer() {
 986                 $server = $this->envGetDefaultServer();
 987                 if ( $server !== null ) {
 988                         $this->showMessage( 'config-using-server', $server );
 989                 }
 990                 return true;
 991         }
 992
 993         /**
 994          * Environment check to inform user which paths we've assumed.
 995          *
 996          * @return bool
 997          */
 998         protected function envCheckPath() {
 999                 $this->showMessage(
1000                         'config-using-uri',
1001                         $this->getVar( 'wgServer' ),
1002                         $this->getVar( 'wgScriptPath' )
1003                 );
1004                 return true;
1005         }
1006
1007         /**
1008          * Environment check for preferred locale in shell
1009          * @return bool
1010          */
1011         protected function envCheckShellLocale() {
1012                 $os = php_uname( 's' );
1013                 $supported = array( 'Linux', 'SunOS', 'HP-UX', 'Darwin' ); # Tested these
1014
1015                 if ( !in_array( $os, $supported ) ) {
1016                         return true;
1017                 }
1018
1019                 # Get a list of available locales.
1020                 $ret = false;
1021                 $lines = wfShellExec( '/usr/bin/locale -a', $ret );
1022
1023                 if ( $ret ) {
1024                         return true;
1025                 }
1026
1027                 $lines = array_map( 'trim', explode( "\n", $lines ) );
1028                 $candidatesByLocale = array();
1029                 $candidatesByLang = array();
1030
1031                 foreach ( $lines as $line ) {
1032                         if ( $line === '' ) {
1033                                 continue;
1034                         }
1035
1036                         if ( !preg_match( '/^([a-zA-Z]+)(_[a-zA-Z]+|)\.(utf8|UTF-8)(@[a-zA-Z_]*|)$/i', $line, $m ) ) {
1037                                 continue;
1038                         }
1039
1040                         list( , $lang, , , ) = $m;
1041
1042                         $candidatesByLocale[$m[0]] = $m;
1043                         $candidatesByLang[$lang][] = $m;
1044                 }
1045
1046                 # Try the current value of LANG.
1047                 if ( isset( $candidatesByLocale[getenv( 'LANG' )] ) ) {
1048                         $this->setVar( 'wgShellLocale', getenv( 'LANG' ) );
1049
1050                         return true;
1051                 }
1052
1053                 # Try the most common ones.
1054                 $commonLocales = array( 'en_US.UTF-8', 'en_US.utf8', 'de_DE.UTF-8', 'de_DE.utf8' );
1055                 foreach ( $commonLocales as $commonLocale ) {
1056                         if ( isset( $candidatesByLocale[$commonLocale] ) ) {
1057                                 $this->setVar( 'wgShellLocale', $commonLocale );
1058
1059                                 return true;
1060                         }
1061                 }
1062
1063                 # Is there an available locale in the Wiki's language?
1064                 $wikiLang = $this->getVar( 'wgLanguageCode' );
1065
1066                 if ( isset( $candidatesByLang[$wikiLang] ) ) {
1067                         $m = reset( $candidatesByLang[$wikiLang] );
1068                         $this->setVar( 'wgShellLocale', $m[0] );
1069
1070                         return true;
1071                 }
1072
1073                 # Are there any at all?
1074                 if ( count( $candidatesByLocale ) ) {
1075                         $m = reset( $candidatesByLocale );
1076                         $this->setVar( 'wgShellLocale', $m[0] );
1077
1078                         return true;
1079                 }
1080
1081                 # Give up.
1082                 return true;
1083         }
1084
1085         /**
1086          * Environment check for the permissions of the uploads directory
1087          * @return bool
1088          */
1089         protected function envCheckUploadsDirectory() {
1090                 global $IP;
1091
1092                 $dir = $IP . '/images/';
1093                 $url = $this->getVar( 'wgServer' ) . $this->getVar( 'wgScriptPath' ) . '/images/';
1094                 $safe = !$this->dirIsExecutable( $dir, $url );
1095
1096                 if ( !$safe ) {
1097                         $this->showMessage( 'config-uploads-not-safe', $dir );
1098                 }
1099
1100                 return true;
1101         }
1102
1103         /**
1104          * Checks if suhosin.get.max_value_length is set, and if so generate
1105          * a warning because it decreases ResourceLoader performance.
1106          * @return bool
1107          */
1108         protected function envCheckSuhosinMaxValueLength() {
1109                 $maxValueLength = ini_get( 'suhosin.get.max_value_length' );
1110                 if ( $maxValueLength > 0 && $maxValueLength < 1024 ) {
1111                         // Only warn if the value is below the sane 1024
1112                         $this->showMessage( 'config-suhosin-max-value-length', $maxValueLength );
1113                 }
1114
1115                 return true;
1116         }
1117
1118         /**
1119          * Convert a hex string representing a Unicode code point to that code point.
1120          * @param string $c
1121          * @return string
1122          */
1123         protected function unicodeChar( $c ) {
1124                 $c = hexdec( $c );
1125                 if ( $c <= 0x7F ) {
1126                         return chr( $c );
1127                 } elseif ( $c <= 0x7FF ) {
1128                         return chr( 0xC0 | $c >> 6 ) . chr( 0x80 | $c & 0x3F );
1129                 } elseif ( $c <= 0xFFFF ) {
1130                         return chr( 0xE0 | $c >> 12 ) . chr( 0x80 | $c >> 6 & 0x3F )
1131                         . chr( 0x80 | $c & 0x3F );
1132                 } elseif ( $c <= 0x10FFFF ) {
1133                         return chr( 0xF0 | $c >> 18 ) . chr( 0x80 | $c >> 12 & 0x3F )
1134                         . chr( 0x80 | $c >> 6 & 0x3F )
1135                         . chr( 0x80 | $c & 0x3F );
1136                 } else {
1137                         return false;
1138                 }
1139         }
1140
1141         /**
1142          * Check the libicu version
1143          */
1144         protected function envCheckLibicu() {
1145                 $utf8 = function_exists( 'utf8_normalize' );
1146                 $intl = function_exists( 'normalizer_normalize' );
1147
1148                 /**
1149                  * This needs to be updated something that the latest libicu
1150                  * will properly normalize.  This normalization was found at
1151                  * http://www.unicode.org/versions/Unicode5.2.0/#Character_Additions
1152                  * Note that we use the hex representation to create the code
1153                  * points in order to avoid any Unicode-destroying during transit.
1154                  */
1155                 $not_normal_c = $this->unicodeChar( "FA6C" );
1156                 $normal_c = $this->unicodeChar( "242EE" );
1157
1158                 $useNormalizer = 'php';
1159                 $needsUpdate = false;
1160
1161                 /**
1162                  * We're going to prefer the pecl extension here unless
1163                  * utf8_normalize is more up to date.
1164                  */
1165                 if ( $utf8 ) {
1166                         $useNormalizer = 'utf8';
1167                         $utf8 = utf8_normalize( $not_normal_c, UtfNormal::UNORM_NFC );
1168                         if ( $utf8 !== $normal_c ) {
1169                                 $needsUpdate = true;
1170                         }
1171                 }
1172                 if ( $intl ) {
1173                         $useNormalizer = 'intl';
1174                         $intl = normalizer_normalize( $not_normal_c, Normalizer::FORM_C );
1175                         if ( $intl !== $normal_c ) {
1176                                 $needsUpdate = true;
1177                         }
1178                 }
1179
1180                 // Uses messages 'config-unicode-using-php', 'config-unicode-using-utf8',
1181                 // 'config-unicode-using-intl'
1182                 if ( $useNormalizer === 'php' ) {
1183                         $this->showMessage( 'config-unicode-pure-php-warning' );
1184                 } else {
1185                         $this->showMessage( 'config-unicode-using-' . $useNormalizer );
1186                         if ( $needsUpdate ) {
1187                                 $this->showMessage( 'config-unicode-update-warning' );
1188                         }
1189                 }
1190         }
1191
1192         /**
1193          * @return bool
1194          */
1195         protected function envCheckCtype() {
1196                 if ( !function_exists( 'ctype_digit' ) ) {
1197                         $this->showError( 'config-ctype' );
1198
1199                         return false;
1200                 }
1201
1202                 return true;
1203         }
1204
1205         /**
1206          * @return bool
1207          */
1208         protected function envCheckIconv() {
1209                 if ( !function_exists( 'iconv' ) ) {
1210                         $this->showError( 'config-iconv' );
1211
1212                         return false;
1213                 }
1214
1215                 return true;
1216         }
1217
1218         /**
1219          * @return bool
1220          */
1221         protected function envCheckJSON() {
1222                 if ( !function_exists( 'json_decode' ) ) {
1223                         $this->showError( 'config-json' );
1224
1225                         return false;
1226                 }
1227
1228                 return true;
1229         }
1230
1231         /**
1232          * Environment prep for the server hostname.
1233          */
1234         protected function envPrepServer() {
1235                 $server = $this->envGetDefaultServer();
1236                 if ( $server !== null ) {
1237                         $this->setVar( 'wgServer', $server );
1238                 }
1239         }
1240
1241         /**
1242          * Helper function to be called from envPrepServer()
1243          * @return string
1244          */
1245         abstract protected function envGetDefaultServer();
1246
1247         /**
1248          * Environment prep for setting the preferred PHP file extension.
1249          */
1250         protected function envPrepExtension() {
1251                 // @todo FIXME: Detect this properly
1252                 if ( defined( 'MW_INSTALL_PHP5_EXT' ) ) {
1253                         $ext = '.php5';
1254                 } else {
1255                         $ext = '.php';
1256                 }
1257                 $this->setVar( 'wgScriptExtension', $ext );
1258         }
1259
1260         /**
1261          * Environment prep for setting $IP and $wgScriptPath.
1262          */
1263         protected function envPrepPath() {
1264                 global $IP;
1265                 $IP = dirname( dirname( __DIR__ ) );
1266                 $this->setVar( 'IP', $IP );
1267         }
1268
1269         /**
1270          * Get an array of likely places we can find executables. Check a bunch
1271          * of known Unix-like defaults, as well as the PATH environment variable
1272          * (which should maybe make it work for Windows?)
1273          *
1274          * @return array
1275          */
1276         protected static function getPossibleBinPaths() {
1277                 return array_merge(
1278                         array( '/usr/bin', '/usr/local/bin', '/opt/csw/bin',
1279                                 '/usr/gnu/bin', '/usr/sfw/bin', '/sw/bin', '/opt/local/bin' ),
1280                         explode( PATH_SEPARATOR, getenv( 'PATH' ) )
1281                 );
1282         }
1283
1284         /**
1285          * Search a path for any of the given executable names. Returns the
1286          * executable name if found. Also checks the version string returned
1287          * by each executable.
1288          *
1289          * Used only by environment checks.
1290          *
1291          * @param string $path Path to search
1292          * @param array $names Array of executable names
1293          * @param array|bool $versionInfo False or array with two members:
1294          *   0 => Command to run for version check, with $1 for the full executable name
1295          *   1 => String to compare the output with
1296          *
1297          * If $versionInfo is not false, only executables with a version
1298          * matching $versionInfo[1] will be returned.
1299          * @return bool|string
1300          */
1301         public static function locateExecutable( $path, $names, $versionInfo = false ) {
1302                 if ( !is_array( $names ) ) {
1303                         $names = array( $names );
1304                 }
1305
1306                 foreach ( $names as $name ) {
1307                         $command = $path . DIRECTORY_SEPARATOR . $name;
1308
1309                         wfSuppressWarnings();
1310                         $file_exists = file_exists( $command );
1311                         wfRestoreWarnings();
1312
1313                         if ( $file_exists ) {
1314                                 if ( !$versionInfo ) {
1315                                         return $command;
1316                                 }
1317
1318                                 $file = str_replace( '$1', wfEscapeShellArg( $command ), $versionInfo[0] );
1319                                 if ( strstr( wfShellExec( $file ), $versionInfo[1] ) !== false ) {
1320                                         return $command;
1321                                 }
1322                         }
1323                 }
1324
1325                 return false;
1326         }
1327
1328         /**
1329          * Same as locateExecutable(), but checks in getPossibleBinPaths() by default
1330          * @see locateExecutable()
1331          * @param array $names Array of possible names.
1332          * @param array|bool $versionInfo Default: false or array with two members:
1333          *   0 => Command to run for version check, with $1 for the full executable name
1334          *   1 => String to compare the output with
1335          *
1336          * If $versionInfo is not false, only executables with a version
1337          * matching $versionInfo[1] will be returned.
1338          * @return bool|string
1339          */
1340         public static function locateExecutableInDefaultPaths( $names, $versionInfo = false ) {
1341                 foreach ( self::getPossibleBinPaths() as $path ) {
1342                         $exe = self::locateExecutable( $path, $names, $versionInfo );
1343                         if ( $exe !== false ) {
1344                                 return $exe;
1345                         }
1346                 }
1347
1348                 return false;
1349         }
1350
1351         /**
1352          * Checks if scripts located in the given directory can be executed via the given URL.
1353          *
1354          * Used only by environment checks.
1355          * @param string $dir
1356          * @param string $url
1357          * @return bool|int|string
1358          */
1359         public function dirIsExecutable( $dir, $url ) {
1360                 $scriptTypes = array(
1361                         'php' => array(
1362                                 "<?php echo 'ex' . 'ec';",
1363                                 "#!/var/env php5\n<?php echo 'ex' . 'ec';",
1364                         ),
1365                 );
1366
1367                 // it would be good to check other popular languages here, but it'll be slow.
1368
1369                 wfSuppressWarnings();
1370
1371                 foreach ( $scriptTypes as $ext => $contents ) {
1372                         foreach ( $contents as $source ) {
1373                                 $file = 'exectest.' . $ext;
1374
1375                                 if ( !file_put_contents( $dir . $file, $source ) ) {
1376                                         break;
1377                                 }
1378
1379                                 try {
1380                                         $text = Http::get( $url . $file, array( 'timeout' => 3 ) );
1381                                 } catch ( MWException $e ) {
1382                                         // Http::get throws with allow_url_fopen = false and no curl extension.
1383                                         $text = null;
1384                                 }
1385                                 unlink( $dir . $file );
1386
1387                                 if ( $text == 'exec' ) {
1388                                         wfRestoreWarnings();
1389
1390                                         return $ext;
1391                                 }
1392                         }
1393                 }
1394
1395                 wfRestoreWarnings();
1396
1397                 return false;
1398         }
1399
1400         /**
1401          * Checks for presence of an Apache module. Works only if PHP is running as an Apache module, too.
1402          *
1403          * @param string $moduleName Name of module to check.
1404          * @return bool
1405          */
1406         public static function apacheModulePresent( $moduleName ) {
1407                 if ( function_exists( 'apache_get_modules' ) && in_array( $moduleName, apache_get_modules() ) ) {
1408                         return true;
1409                 }
1410                 // try it the hard way
1411                 ob_start();
1412                 phpinfo( INFO_MODULES );
1413                 $info = ob_get_clean();
1414
1415                 return strpos( $info, $moduleName ) !== false;
1416         }
1417
1418         /**
1419          * ParserOptions are constructed before we determined the language, so fix it
1420          *
1421          * @param Language $lang
1422          */
1423         public function setParserLanguage( $lang ) {
1424                 $this->parserOptions->setTargetLanguage( $lang );
1425                 $this->parserOptions->setUserLang( $lang );
1426         }
1427
1428         /**
1429          * Overridden by WebInstaller to provide lastPage parameters.
1430          * @param string $page
1431          * @return string
1432          */
1433         protected function getDocUrl( $page ) {
1434                 return "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1435         }
1436
1437         /**
1438          * Finds extensions that follow the format /$directory/Name/Name.php,
1439          * and returns an array containing the value for 'Name' for each found extension.
1440          *
1441          * Reasonable values for $directory include 'extensions' (the default) and 'skins'.
1442          *
1443          * @param string $directory Directory to search in
1444          * @return array
1445          */
1446         public function findExtensions( $directory = 'extensions' ) {
1447                 if ( $this->getVar( 'IP' ) === null ) {
1448                         return array();
1449                 }
1450
1451                 $extDir = $this->getVar( 'IP' ) . '/' . $directory;
1452                 if ( !is_readable( $extDir ) || !is_dir( $extDir ) ) {
1453                         return array();
1454                 }
1455
1456                 $dh = opendir( $extDir );
1457                 $exts = array();
1458                 while ( ( $file = readdir( $dh ) ) !== false ) {
1459                         if ( !is_dir( "$extDir/$file" ) ) {
1460                                 continue;
1461                         }
1462                         if ( file_exists( "$extDir/$file/$file.php" ) ) {
1463                                 $exts[] = $file;
1464                         }
1465                 }
1466                 closedir( $dh );
1467                 natcasesort( $exts );
1468
1469                 return $exts;
1470         }
1471
1472         /**
1473          * Returns a default value to be used for $wgDefaultSkin: the preferred skin, if available among
1474          * the installed skins, or any other one otherwise.
1475          *
1476          * @param string[] $skinNames Names of installed skins.
1477          * @return string
1478          */
1479         public function getDefaultSkin( array $skinNames ) {
1480                 $defaultSkin = $GLOBALS['wgDefaultSkin'];
1481                 if ( in_array( $defaultSkin, $skinNames ) ) {
1482                         return $defaultSkin;
1483                 } else {
1484                         return $skinNames[0];
1485                 }
1486         }
1487
1488         /**
1489          * Installs the auto-detected extensions.
1490          *
1491          * @return Status
1492          */
1493         protected function includeExtensions() {
1494                 global $IP;
1495                 $exts = $this->getVar( '_Extensions' );
1496                 $IP = $this->getVar( 'IP' );
1497
1498                 /**
1499                  * We need to include DefaultSettings before including extensions to avoid
1500                  * warnings about unset variables. However, the only thing we really
1501                  * want here is $wgHooks['LoadExtensionSchemaUpdates']. This won't work
1502                  * if the extension has hidden hook registration in $wgExtensionFunctions,
1503                  * but we're not opening that can of worms
1504                  * @see https://bugzilla.wikimedia.org/show_bug.cgi?id=26857
1505                  */
1506                 global $wgAutoloadClasses;
1507                 $wgAutoloadClasses = array();
1508
1509                 require "$IP/includes/DefaultSettings.php";
1510
1511                 foreach ( $exts as $e ) {
1512                         require_once "$IP/extensions/$e/$e.php";
1513                 }
1514
1515                 $hooksWeWant = isset( $wgHooks['LoadExtensionSchemaUpdates'] ) ?
1516                         $wgHooks['LoadExtensionSchemaUpdates'] : array();
1517
1518                 // Unset everyone else's hooks. Lord knows what someone might be doing
1519                 // in ParserFirstCallInit (see bug 27171)
1520                 $GLOBALS['wgHooks'] = array( 'LoadExtensionSchemaUpdates' => $hooksWeWant );
1521
1522                 return Status::newGood();
1523         }
1524
1525         /**
1526          * Get an array of install steps. Should always be in the format of
1527          * array(
1528          *   'name'     => 'someuniquename',
1529          *   'callback' => array( $obj, 'method' ),
1530          * )
1531          * There must be a config-install-$name message defined per step, which will
1532          * be shown on install.
1533          *
1534          * @param DatabaseInstaller $installer DatabaseInstaller so we can make callbacks
1535          * @return array
1536          */
1537         protected function getInstallSteps( DatabaseInstaller $installer ) {
1538                 $coreInstallSteps = array(
1539                         array( 'name' => 'database', 'callback' => array( $installer, 'setupDatabase' ) ),
1540                         array( 'name' => 'tables', 'callback' => array( $installer, 'createTables' ) ),
1541                         array( 'name' => 'interwiki', 'callback' => array( $installer, 'populateInterwikiTable' ) ),
1542                         array( 'name' => 'stats', 'callback' => array( $this, 'populateSiteStats' ) ),
1543                         array( 'name' => 'keys', 'callback' => array( $this, 'generateKeys' ) ),
1544                         array( 'name' => 'updates', 'callback' => array( $installer, 'insertUpdateKeys' ) ),
1545                         array( 'name' => 'sysop', 'callback' => array( $this, 'createSysop' ) ),
1546                         array( 'name' => 'mainpage', 'callback' => array( $this, 'createMainpage' ) ),
1547                 );
1548
1549                 // Build the array of install steps starting from the core install list,
1550                 // then adding any callbacks that wanted to attach after a given step
1551                 foreach ( $coreInstallSteps as $step ) {
1552                         $this->installSteps[] = $step;
1553                         if ( isset( $this->extraInstallSteps[$step['name']] ) ) {
1554                                 $this->installSteps = array_merge(
1555                                         $this->installSteps,
1556                                         $this->extraInstallSteps[$step['name']]
1557                                 );
1558                         }
1559                 }
1560
1561                 // Prepend any steps that want to be at the beginning
1562                 if ( isset( $this->extraInstallSteps['BEGINNING'] ) ) {
1563                         $this->installSteps = array_merge(
1564                                 $this->extraInstallSteps['BEGINNING'],
1565                                 $this->installSteps
1566                         );
1567                 }
1568
1569                 // Extensions should always go first, chance to tie into hooks and such
1570                 if ( count( $this->getVar( '_Extensions' ) ) ) {
1571                         array_unshift( $this->installSteps,
1572                                 array( 'name' => 'extensions', 'callback' => array( $this, 'includeExtensions' ) )
1573                         );
1574                         $this->installSteps[] = array(
1575                                 'name' => 'extension-tables',
1576                                 'callback' => array( $installer, 'createExtensionTables' )
1577                         );
1578                 }
1579
1580                 return $this->installSteps;
1581         }
1582
1583         /**
1584          * Actually perform the installation.
1585          *
1586          * @param callable $startCB A callback array for the beginning of each step
1587          * @param callable $endCB A callback array for the end of each step
1588          *
1589          * @return array Array of Status objects
1590          */
1591         public function performInstallation( $startCB, $endCB ) {
1592                 $installResults = array();
1593                 $installer = $this->getDBInstaller();
1594                 $installer->preInstall();
1595                 $steps = $this->getInstallSteps( $installer );
1596                 foreach ( $steps as $stepObj ) {
1597                         $name = $stepObj['name'];
1598                         call_user_func_array( $startCB, array( $name ) );
1599
1600                         // Perform the callback step
1601                         $status = call_user_func( $stepObj['callback'], $installer );
1602
1603                         // Output and save the results
1604                         call_user_func( $endCB, $name, $status );
1605                         $installResults[$name] = $status;
1606
1607                         // If we've hit some sort of fatal, we need to bail.
1608                         // Callback already had a chance to do output above.
1609                         if ( !$status->isOk() ) {
1610                                 break;
1611                         }
1612                 }
1613                 if ( $status->isOk() ) {
1614                         $this->setVar( '_InstallDone', true );
1615                 }
1616
1617                 return $installResults;
1618         }
1619
1620         /**
1621          * Generate $wgSecretKey. Will warn if we had to use an insecure random source.
1622          *
1623          * @return Status
1624          */
1625         public function generateKeys() {
1626                 $keys = array( 'wgSecretKey' => 64 );
1627                 if ( strval( $this->getVar( 'wgUpgradeKey' ) ) === '' ) {
1628                         $keys['wgUpgradeKey'] = 16;
1629                 }
1630
1631                 return $this->doGenerateKeys( $keys );
1632         }
1633
1634         /**
1635          * Generate a secret value for variables using our CryptRand generator.
1636          * Produce a warning if the random source was insecure.
1637          *
1638          * @param array $keys
1639          * @return Status
1640          */
1641         protected function doGenerateKeys( $keys ) {
1642                 $status = Status::newGood();
1643
1644                 $strong = true;
1645                 foreach ( $keys as $name => $length ) {
1646                         $secretKey = MWCryptRand::generateHex( $length, true );
1647                         if ( !MWCryptRand::wasStrong() ) {
1648                                 $strong = false;
1649                         }
1650
1651                         $this->setVar( $name, $secretKey );
1652                 }
1653
1654                 if ( !$strong ) {
1655                         $names = array_keys( $keys );
1656                         $names = preg_replace( '/^(.*)$/', '\$$1', $names );
1657                         global $wgLang;
1658                         $status->warning( 'config-insecure-keys', $wgLang->listToText( $names ), count( $names ) );
1659                 }
1660
1661                 return $status;
1662         }
1663
1664         /**
1665          * Create the first user account, grant it sysop and bureaucrat rights
1666          *
1667          * @return Status
1668          */
1669         protected function createSysop() {
1670                 $name = $this->getVar( '_AdminName' );
1671                 $user = User::newFromName( $name );
1672
1673                 if ( !$user ) {
1674                         // We should've validated this earlier anyway!
1675                         return Status::newFatal( 'config-admin-error-user', $name );
1676                 }
1677
1678                 if ( $user->idForName() == 0 ) {
1679                         $user->addToDatabase();
1680
1681                         try {
1682                                 $user->setPassword( $this->getVar( '_AdminPassword' ) );
1683                         } catch ( PasswordError $pwe ) {
1684                                 return Status::newFatal( 'config-admin-error-password', $name, $pwe->getMessage() );
1685                         }
1686
1687                         $user->addGroup( 'sysop' );
1688                         $user->addGroup( 'bureaucrat' );
1689                         if ( $this->getVar( '_AdminEmail' ) ) {
1690                                 $user->setEmail( $this->getVar( '_AdminEmail' ) );
1691                         }
1692                         $user->saveSettings();
1693
1694                         // Update user count
1695                         $ssUpdate = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
1696                         $ssUpdate->doUpdate();
1697                 }
1698                 $status = Status::newGood();
1699
1700                 if ( $this->getVar( '_Subscribe' ) && $this->getVar( '_AdminEmail' ) ) {
1701                         $this->subscribeToMediaWikiAnnounce( $status );
1702                 }
1703
1704                 return $status;
1705         }
1706
1707         /**
1708          * @param Status $s
1709          */
1710         private function subscribeToMediaWikiAnnounce( Status $s ) {
1711                 $params = array(
1712                         'email' => $this->getVar( '_AdminEmail' ),
1713                         'language' => 'en',
1714                         'digest' => 0
1715                 );
1716
1717                 // Mailman doesn't support as many languages as we do, so check to make
1718                 // sure their selected language is available
1719                 $myLang = $this->getVar( '_UserLang' );
1720                 if ( in_array( $myLang, $this->mediaWikiAnnounceLanguages ) ) {
1721                         $myLang = $myLang == 'pt-br' ? 'pt_BR' : $myLang; // rewrite to Mailman's pt_BR
1722                         $params['language'] = $myLang;
1723                 }
1724
1725                 if ( MWHttpRequest::canMakeRequests() ) {
1726                         $res = MWHttpRequest::factory( $this->mediaWikiAnnounceUrl,
1727                                 array( 'method' => 'POST', 'postData' => $params ) )->execute();
1728                         if ( !$res->isOK() ) {
1729                                 $s->warning( 'config-install-subscribe-fail', $res->getMessage() );
1730                         }
1731                 } else {
1732                         $s->warning( 'config-install-subscribe-notpossible' );
1733                 }
1734         }
1735
1736         /**
1737          * Insert Main Page with default content.
1738          *
1739          * @param DatabaseInstaller $installer
1740          * @return Status
1741          */
1742         protected function createMainpage( DatabaseInstaller $installer ) {
1743                 $status = Status::newGood();
1744                 try {
1745                         $page = WikiPage::factory( Title::newMainPage() );
1746                         $content = new WikitextContent(
1747                                 wfMessage( 'mainpagetext' )->inContentLanguage()->text() . "\n\n" .
1748                                 wfMessage( 'mainpagedocfooter' )->inContentLanguage()->text()
1749                         );
1750
1751                         $page->doEditContent( $content,
1752                                 '',
1753                                 EDIT_NEW,
1754                                 false,
1755                                 User::newFromName( 'MediaWiki default' )
1756                         );
1757                 } catch ( MWException $e ) {
1758                         //using raw, because $wgShowExceptionDetails can not be set yet
1759                         $status->fatal( 'config-install-mainpage-failed', $e->getMessage() );
1760                 }
1761
1762                 return $status;
1763         }
1764
1765         /**
1766          * Override the necessary bits of the config to run an installation.
1767          */
1768         public static function overrideConfig() {
1769                 define( 'MW_NO_SESSION', 1 );
1770
1771                 // Don't access the database
1772                 $GLOBALS['wgUseDatabaseMessages'] = false;
1773                 // Don't cache langconv tables
1774                 $GLOBALS['wgLanguageConverterCacheType'] = CACHE_NONE;
1775                 // Debug-friendly
1776                 $GLOBALS['wgShowExceptionDetails'] = true;
1777                 // Don't break forms
1778                 $GLOBALS['wgExternalLinkTarget'] = '_blank';
1779
1780                 // Extended debugging
1781                 $GLOBALS['wgShowSQLErrors'] = true;
1782                 $GLOBALS['wgShowDBErrorBacktrace'] = true;
1783
1784                 // Allow multiple ob_flush() calls
1785                 $GLOBALS['wgDisableOutputCompression'] = true;
1786
1787                 // Use a sensible cookie prefix (not my_wiki)
1788                 $GLOBALS['wgCookiePrefix'] = 'mw_installer';
1789
1790                 // Some of the environment checks make shell requests, remove limits
1791                 $GLOBALS['wgMaxShellMemory'] = 0;
1792         }
1793
1794         /**
1795          * Add an installation step following the given step.
1796          *
1797          * @param callable $callback A valid installation callback array, in this form:
1798          *    array( 'name' => 'some-unique-name', 'callback' => array( $obj, 'function' ) );
1799          * @param string $findStep The step to find. Omit to put the step at the beginning
1800          */
1801         public function addInstallStep( $callback, $findStep = 'BEGINNING' ) {
1802                 $this->extraInstallSteps[$findStep][] = $callback;
1803         }
1804
1805         /**
1806          * Disable the time limit for execution.
1807          * Some long-running pages (Install, Upgrade) will want to do this
1808          */
1809         protected function disableTimeLimit() {
1810                 wfSuppressWarnings();
1811                 set_time_limit( 0 );
1812                 wfRestoreWarnings();
1813         }
1814 }