3 * Base code for MediaWiki installer.
5 * DO NOT PATCH THIS FILE IF YOU NEED TO CHANGE INSTALLER BEHAVIOR IN YOUR PACKAGE!
6 * See mw-config/overrides/README for details.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
26 use MediaWiki\MediaWikiServices
;
29 * This documentation group collects source code files with deployment functionality.
31 * @defgroup Deployment Deployment
35 * Base installer class.
37 * This class provides the base for installation and update functionality
38 * for both MediaWiki core and extensions.
43 abstract class Installer
{
46 * The oldest version of PCRE we can support.
48 * Defining this is necessary because PHP may be linked with a system version
49 * of PCRE, which may be older than that bundled with the minimum PHP version.
51 const MINIMUM_PCRE_VERSION
= '7.2';
59 * List of detected DBs, access using getCompiledDBs().
63 protected $compiledDBs;
66 * Cached DB installer instances, access using getDBInstaller().
70 protected $dbInstallers = [];
73 * Minimum memory size in MB.
77 protected $minMemorySize = 50;
80 * Cached Title, used by parse().
84 protected $parserTitle;
87 * Cached ParserOptions, used by parse().
91 protected $parserOptions;
94 * Known database types. These correspond to the class names <type>Installer,
95 * and are also MediaWiki database types valid for $wgDBtype.
97 * To add a new type, create a <type>Installer class and a Database<type>
98 * class, and add a config-type-<type> message to MessagesEn.php.
102 protected static $dbTypes = [
111 * A list of environment check methods called by doEnvironmentChecks().
112 * These may output warnings using showMessage(), and/or abort the
113 * installation process by returning false.
115 * For the WebInstaller these are only called on the Welcome page,
116 * if these methods have side-effects that should affect later page loads
117 * (as well as the generated stylesheet), use envPreps instead.
121 protected $envChecks = [
127 'envCheckModSecurity',
133 'envCheckShellLocale',
134 'envCheckUploadsDirectory',
136 'envCheckSuhosinMaxValueLength',
141 * A list of environment preparation methods called by doEnvironmentPreps().
145 protected $envPreps = [
151 * MediaWiki configuration globals that will eventually be passed through
152 * to LocalSettings.php. The names only are given here, the defaults
153 * typically come from DefaultSettings.php.
157 protected $defaultVarNames = [
168 'wgEmailAuthentication',
172 'wgImageMagickConvertCommand',
177 'wgDeletedDirectory',
181 'wgUseInstantCommons',
188 * Variables that are stored alongside globals, and are used for any
189 * configuration of the installation process aside from the MediaWiki
190 * configuration. Map of names to defaults.
194 protected $internalDefaults = [
196 '_Environment' => false,
197 '_RaiseMemory' => false,
198 '_UpgradeDone' => false,
199 '_InstallDone' => false,
201 '_InstallPassword' => '',
202 '_SameAccount' => true,
203 '_CreateDBAccount' => false,
204 '_NamespaceType' => 'site-name',
205 '_AdminName' => '', // will be set later, when the user selects language
206 '_AdminPassword' => '',
207 '_AdminPasswordConfirm' => '',
209 '_Subscribe' => false,
210 '_SkipOptional' => 'continue',
211 '_RightsProfile' => 'wiki',
212 '_LicenseCode' => 'none',
216 '_MemCachedServers' => '',
217 '_UpgradeKeySupplied' => false,
218 '_ExistingDBSettings' => false,
220 // $wgLogo is probably wrong (T50084); set something that will work.
221 // Single quotes work fine here, as LocalSettingsGenerator outputs this unescaped.
222 'wgLogo' => '$wgResourceBasePath/resources/assets/wiki.png',
223 'wgAuthenticationTokenVersion' => 1,
227 * The actual list of installation steps. This will be initialized by getInstallSteps()
231 private $installSteps = [];
234 * Extra steps for installation, for things like DatabaseInstallers to modify
238 protected $extraInstallSteps = [];
241 * Known object cache types and the functions used to test for their existence.
245 protected $objectCaches = [
246 'xcache' => 'xcache_get',
247 'apc' => 'apc_fetch',
248 'apcu' => 'apcu_fetch',
249 'wincache' => 'wincache_ucache_get'
253 * User rights profiles.
257 public $rightsProfiles = [
260 '*' => [ 'edit' => false ]
264 'createaccount' => false,
270 'createaccount' => false,
284 'url' => 'https://creativecommons.org/licenses/by/4.0/',
285 'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-by.png',
288 'url' => 'https://creativecommons.org/licenses/by-sa/4.0/',
289 'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-by-sa.png',
292 'url' => 'https://creativecommons.org/licenses/by-nc-sa/4.0/',
293 'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-by-nc-sa.png',
296 'url' => 'https://creativecommons.org/publicdomain/zero/1.0/',
297 'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-0.png',
300 'url' => 'https://www.gnu.org/copyleft/fdl.html',
301 'icon' => '$wgResourceBasePath/resources/assets/licenses/gnu-fdl.png',
309 // Details will be filled in by the selector.
317 * URL to mediawiki-announce subscription
319 protected $mediaWikiAnnounceUrl =
320 'https://lists.wikimedia.org/mailman/subscribe/mediawiki-announce';
323 * Supported language codes for Mailman
325 protected $mediaWikiAnnounceLanguages = [
326 'ca', 'cs', 'da', 'de', 'en', 'es', 'et', 'eu', 'fi', 'fr', 'hr', 'hu',
327 'it', 'ja', 'ko', 'lt', 'nl', 'no', 'pl', 'pt', 'pt-br', 'ro', 'ru',
328 'sl', 'sr', 'sv', 'tr', 'uk'
332 * UI interface for displaying a short message
333 * The parameters are like parameters to wfMessage().
334 * The messages will be in wikitext format, which will be converted to an
335 * output format such as HTML or text before being sent to the user.
338 abstract public function showMessage( $msg /*, ... */ );
341 * Same as showMessage(), but for displaying errors
344 abstract public function showError( $msg /*, ... */ );
347 * Show a message to the installing user by using a Status object
348 * @param Status $status
350 abstract public function showStatusMessage( Status
$status );
353 * Constructs a Config object that contains configuration settings that should be
354 * overwritten for the installation process.
358 * @param Config $baseConfig
360 * @return Config The config to use during installation.
362 public static function getInstallerConfig( Config
$baseConfig ) {
363 $configOverrides = new HashConfig();
365 // disable (problematic) object cache types explicitly, preserving all other (working) ones
367 $emptyCache = [ 'class' => EmptyBagOStuff
::class ];
370 CACHE_NONE
=> $emptyCache,
371 CACHE_DB
=> $emptyCache,
372 CACHE_ANYTHING
=> $emptyCache,
373 CACHE_MEMCACHED
=> $emptyCache,
374 ] +
$baseConfig->get( 'ObjectCaches' );
376 $configOverrides->set( 'ObjectCaches', $objectCaches );
378 // Load the installer's i18n.
379 $messageDirs = $baseConfig->get( 'MessagesDirs' );
380 $messageDirs['MediawikiInstaller'] = __DIR__
. '/i18n';
382 $configOverrides->set( 'MessagesDirs', $messageDirs );
384 $installerConfig = new MultiConfig( [ $configOverrides, $baseConfig ] );
386 // make sure we use the installer config as the main config
387 $configRegistry = $baseConfig->get( 'ConfigRegistry' );
388 $configRegistry['main'] = function () use ( $installerConfig ) {
389 return $installerConfig;
392 $configOverrides->set( 'ConfigRegistry', $configRegistry );
394 return $installerConfig;
398 * Constructor, always call this from child classes.
400 public function __construct() {
401 global $wgMemc, $wgUser, $wgObjectCaches;
403 $defaultConfig = new GlobalVarConfig(); // all the stuff from DefaultSettings.php
404 $installerConfig = self
::getInstallerConfig( $defaultConfig );
406 // Reset all services and inject config overrides
407 MediaWiki\MediaWikiServices
::resetGlobalInstance( $installerConfig );
409 // Don't attempt to load user language options (T126177)
410 // This will be overridden in the web installer with the user-specified language
411 RequestContext
::getMain()->setLanguage( 'en' );
413 // Disable the i18n cache
414 // TODO: manage LocalisationCache singleton in MediaWikiServices
415 Language
::getLocalisationCache()->disableBackend();
417 // Disable all global services, since we don't have any configuration yet!
418 MediaWiki\MediaWikiServices
::disableStorageBackend();
420 // Disable object cache (otherwise CACHE_ANYTHING will try CACHE_DB and
421 // SqlBagOStuff will then throw since we just disabled wfGetDB)
422 $wgObjectCaches = MediaWikiServices
::getInstance()->getMainConfig()->get( 'ObjectCaches' );
423 $wgMemc = ObjectCache
::getInstance( CACHE_NONE
);
425 // Having a user with id = 0 safeguards us from DB access via User::loadOptions().
426 $wgUser = User
::newFromId( 0 );
427 RequestContext
::getMain()->setUser( $wgUser );
429 $this->settings
= $this->internalDefaults
;
431 foreach ( $this->defaultVarNames
as $var ) {
432 $this->settings
[$var] = $GLOBALS[$var];
435 $this->doEnvironmentPreps();
437 $this->compiledDBs
= [];
438 foreach ( self
::getDBTypes() as $type ) {
439 $installer = $this->getDBInstaller( $type );
441 if ( !$installer->isCompiled() ) {
444 $this->compiledDBs
[] = $type;
447 $this->parserTitle
= Title
::newFromText( 'Installer' );
448 $this->parserOptions
= new ParserOptions( $wgUser ); // language will be wrong :(
449 $this->parserOptions
->setEditSection( false );
450 // Don't try to access DB before user language is initialised
451 $this->setParserLanguage( Language
::factory( 'en' ) );
455 * Get a list of known DB types.
459 public static function getDBTypes() {
460 return self
::$dbTypes;
464 * Do initial checks of the PHP environment. Set variables according to
465 * the observed environment.
467 * It's possible that this may be called under the CLI SAPI, not the SAPI
468 * that the wiki will primarily run under. In that case, the subclass should
469 * initialise variables such as wgScriptPath, before calling this function.
471 * Under the web subclass, it can already be assumed that PHP 5+ is in use
472 * and that sessions are working.
476 public function doEnvironmentChecks() {
477 // Php version has already been checked by entry scripts
478 // Show message here for information purposes
480 $this->showMessage( 'config-env-hhvm', HHVM_VERSION
);
482 $this->showMessage( 'config-env-php', PHP_VERSION
);
486 // Must go here because an old version of PCRE can prevent other checks from completing
487 list( $pcreVersion ) = explode( ' ', PCRE_VERSION
, 2 );
488 if ( version_compare( $pcreVersion, self
::MINIMUM_PCRE_VERSION
, '<' ) ) {
489 $this->showError( 'config-pcre-old', self
::MINIMUM_PCRE_VERSION
, $pcreVersion );
492 foreach ( $this->envChecks
as $check ) {
493 $status = $this->$check();
494 if ( $status === false ) {
500 $this->setVar( '_Environment', $good );
502 return $good ? Status
::newGood() : Status
::newFatal( 'config-env-bad' );
505 public function doEnvironmentPreps() {
506 foreach ( $this->envPreps
as $prep ) {
512 * Set a MW configuration variable, or internal installer configuration variable.
514 * @param string $name
515 * @param mixed $value
517 public function setVar( $name, $value ) {
518 $this->settings
[$name] = $value;
522 * Get an MW configuration variable, or internal installer configuration variable.
523 * The defaults come from $GLOBALS (ultimately DefaultSettings.php).
524 * Installer variables are typically prefixed by an underscore.
526 * @param string $name
527 * @param mixed $default
531 public function getVar( $name, $default = null ) {
532 if ( !isset( $this->settings
[$name] ) ) {
535 return $this->settings
[$name];
540 * Get a list of DBs supported by current PHP setup
544 public function getCompiledDBs() {
545 return $this->compiledDBs
;
549 * Get the DatabaseInstaller class name for this type
551 * @param string $type database type ($wgDBtype)
552 * @return string Class name
555 public static function getDBInstallerClass( $type ) {
556 return ucfirst( $type ) . 'Installer';
560 * Get an instance of DatabaseInstaller for the specified DB type.
562 * @param mixed $type DB installer for which is needed, false to use default.
564 * @return DatabaseInstaller
566 public function getDBInstaller( $type = false ) {
568 $type = $this->getVar( 'wgDBtype' );
571 $type = strtolower( $type );
573 if ( !isset( $this->dbInstallers
[$type] ) ) {
574 $class = self
::getDBInstallerClass( $type );
575 $this->dbInstallers
[$type] = new $class( $this );
578 return $this->dbInstallers
[$type];
582 * Determine if LocalSettings.php exists. If it does, return its variables.
584 * @return array|false
586 public static function getExistingLocalSettings() {
589 // You might be wondering why this is here. Well if you don't do this
590 // then some poorly-formed extensions try to call their own classes
591 // after immediately registering them. We really need to get extension
592 // registration out of the global scope and into a real format.
593 // @see https://phabricator.wikimedia.org/T69440
594 global $wgAutoloadClasses;
595 $wgAutoloadClasses = [];
597 // LocalSettings.php should not call functions, except wfLoadSkin/wfLoadExtensions
598 // Define the required globals here, to ensure, the functions can do it work correctly.
599 // phpcs:ignore MediaWiki.VariableAnalysis.UnusedGlobalVariables
600 global $wgExtensionDirectory, $wgStyleDirectory;
602 MediaWiki\
suppressWarnings();
603 $_lsExists = file_exists( "$IP/LocalSettings.php" );
604 MediaWiki\restoreWarnings
();
611 require "$IP/includes/DefaultSettings.php";
612 require "$IP/LocalSettings.php";
614 return get_defined_vars();
618 * Get a fake password for sending back to the user in HTML.
619 * This is a security mechanism to avoid compromise of the password in the
620 * event of session ID compromise.
622 * @param string $realPassword
626 public function getFakePassword( $realPassword ) {
627 return str_repeat( '*', strlen( $realPassword ) );
631 * Set a variable which stores a password, except if the new value is a
632 * fake password in which case leave it as it is.
634 * @param string $name
635 * @param mixed $value
637 public function setPassword( $name, $value ) {
638 if ( !preg_match( '/^\*+$/', $value ) ) {
639 $this->setVar( $name, $value );
644 * On POSIX systems return the primary group of the webserver we're running under.
645 * On other systems just returns null.
647 * This is used to advice the user that he should chgrp his mw-config/data/images directory as the
648 * webserver user before he can install.
650 * Public because SqliteInstaller needs it, and doesn't subclass Installer.
654 public static function maybeGetWebserverPrimaryGroup() {
655 if ( !function_exists( 'posix_getegid' ) ||
!function_exists( 'posix_getpwuid' ) ) {
656 # I don't know this, this isn't UNIX.
660 # posix_getegid() *not* getmygid() because we want the group of the webserver,
661 # not whoever owns the current script.
662 $gid = posix_getegid();
663 $group = posix_getpwuid( $gid )['name'];
669 * Convert wikitext $text to HTML.
671 * This is potentially error prone since many parser features require a complete
672 * installed MW database. The solution is to just not use those features when you
673 * write your messages. This appears to work well enough. Basic formatting and
674 * external links work just fine.
676 * But in case a translator decides to throw in a "#ifexist" or internal link or
677 * whatever, this function is guarded to catch the attempted DB access and to present
678 * some fallback text.
680 * @param string $text
681 * @param bool $lineStart
684 public function parse( $text, $lineStart = false ) {
688 $out = $wgParser->parse( $text, $this->parserTitle
, $this->parserOptions
, $lineStart );
689 $html = $out->getText( [
690 'enableSectionEditLinks' => false,
693 } catch ( MediaWiki\Services\ServiceDisabledException
$e ) {
694 $html = '<!--DB access attempted during parse--> ' . htmlspecialchars( $text );
701 * @return ParserOptions
703 public function getParserOptions() {
704 return $this->parserOptions
;
707 public function disableLinkPopups() {
708 $this->parserOptions
->setExternalLinkTarget( false );
711 public function restoreLinkPopups() {
712 global $wgExternalLinkTarget;
713 $this->parserOptions
->setExternalLinkTarget( $wgExternalLinkTarget );
717 * Install step which adds a row to the site_stats table with appropriate
720 * @param DatabaseInstaller $installer
724 public function populateSiteStats( DatabaseInstaller
$installer ) {
725 $status = $installer->getConnection();
726 if ( !$status->isOK() ) {
729 $status->value
->insert(
733 'ss_total_edits' => 0,
734 'ss_good_articles' => 0,
735 'ss_total_pages' => 0,
737 'ss_active_users' => 0,
743 return Status
::newGood();
747 * Environment check for DB types.
750 protected function envCheckDB() {
755 // Messages: config-type-mysql, config-type-postgres, config-type-oracle,
756 // config-type-sqlite
757 foreach ( self
::getDBTypes() as $name ) {
758 $allNames[] = wfMessage( "config-type-$name" )->text();
761 $databases = $this->getCompiledDBs();
763 $databases = array_flip( $databases );
764 foreach ( array_keys( $databases ) as $db ) {
765 $installer = $this->getDBInstaller( $db );
766 $status = $installer->checkPrerequisites();
767 if ( !$status->isGood() ) {
768 $this->showStatusMessage( $status );
770 if ( !$status->isOK() ) {
771 unset( $databases[$db] );
774 $databases = array_flip( $databases );
776 $this->showError( 'config-no-db', $wgLang->commaList( $allNames ), count( $allNames ) );
778 // @todo FIXME: This only works for the web installer!
786 * Some versions of libxml+PHP break < and > encoding horribly
789 protected function envCheckBrokenXML() {
790 $test = new PhpXmlBugTester();
792 $this->showError( 'config-brokenlibxml' );
801 * Environment check for the PCRE module.
803 * @note If this check were to fail, the parser would
804 * probably throw an exception before the result
805 * of this check is shown to the user.
808 protected function envCheckPCRE() {
809 MediaWiki\
suppressWarnings();
810 $regexd = preg_replace( '/[\x{0430}-\x{04FF}]/iu', '', '-АБВГД-' );
811 // Need to check for \p support too, as PCRE can be compiled
812 // with utf8 support, but not unicode property support.
813 // check that \p{Zs} (space separators) matches
814 // U+3000 (Ideographic space)
815 $regexprop = preg_replace( '/\p{Zs}/u', '', "-\xE3\x80\x80-" );
816 MediaWiki\restoreWarnings
();
817 if ( $regexd != '--' ||
$regexprop != '--' ) {
818 $this->showError( 'config-pcre-no-utf8' );
827 * Environment check for available memory.
830 protected function envCheckMemory() {
831 $limit = ini_get( 'memory_limit' );
833 if ( !$limit ||
$limit == -1 ) {
837 $n = wfShorthandToInteger( $limit );
839 if ( $n < $this->minMemorySize
* 1024 * 1024 ) {
840 $newLimit = "{$this->minMemorySize}M";
842 if ( ini_set( "memory_limit", $newLimit ) === false ) {
843 $this->showMessage( 'config-memory-bad', $limit );
845 $this->showMessage( 'config-memory-raised', $limit, $newLimit );
846 $this->setVar( '_RaiseMemory', true );
854 * Environment check for compiled object cache types.
856 protected function envCheckCache() {
858 foreach ( $this->objectCaches
as $name => $function ) {
859 if ( function_exists( $function ) ) {
860 if ( $name == 'xcache' && !wfIniGetBool( 'xcache.var_size' ) ) {
863 $caches[$name] = true;
868 $key = 'config-no-cache-apcu';
869 $this->showMessage( $key );
872 $this->setVar( '_Caches', $caches );
876 * Scare user to death if they have mod_security or mod_security2
879 protected function envCheckModSecurity() {
880 if ( self
::apacheModulePresent( 'mod_security' )
881 || self
::apacheModulePresent( 'mod_security2' ) ) {
882 $this->showMessage( 'config-mod-security' );
889 * Search for GNU diff3.
892 protected function envCheckDiff3() {
893 $names = [ "gdiff3", "diff3" ];
894 if ( wfIsWindows() ) {
895 $names[] = 'diff3.exe';
897 $versionInfo = [ '--version', 'GNU diffutils' ];
899 $diff3 = ExecutableFinder
::findInDefaultPaths( $names, $versionInfo );
902 $this->setVar( 'wgDiff3', $diff3 );
904 $this->setVar( 'wgDiff3', false );
905 $this->showMessage( 'config-diff3-bad' );
912 * Environment check for ImageMagick and GD.
915 protected function envCheckGraphics() {
916 $names = wfIsWindows() ?
'convert.exe' : 'convert';
917 $versionInfo = [ '-version', 'ImageMagick' ];
918 $convert = ExecutableFinder
::findInDefaultPaths( $names, $versionInfo );
920 $this->setVar( 'wgImageMagickConvertCommand', '' );
922 $this->setVar( 'wgImageMagickConvertCommand', $convert );
923 $this->showMessage( 'config-imagemagick', $convert );
926 } elseif ( function_exists( 'imagejpeg' ) ) {
927 $this->showMessage( 'config-gd' );
929 $this->showMessage( 'config-no-scaling' );
941 protected function envCheckGit() {
942 $names = wfIsWindows() ?
'git.exe' : 'git';
943 $versionInfo = [ '--version', 'git version' ];
945 $git = ExecutableFinder
::findInDefaultPaths( $names, $versionInfo );
948 $this->setVar( 'wgGitBin', $git );
949 $this->showMessage( 'config-git', $git );
951 $this->setVar( 'wgGitBin', false );
952 $this->showMessage( 'config-git-bad' );
959 * Environment check to inform user which server we've assumed.
963 protected function envCheckServer() {
964 $server = $this->envGetDefaultServer();
965 if ( $server !== null ) {
966 $this->showMessage( 'config-using-server', $server );
972 * Environment check to inform user which paths we've assumed.
976 protected function envCheckPath() {
979 $this->getVar( 'wgServer' ),
980 $this->getVar( 'wgScriptPath' )
986 * Environment check for preferred locale in shell
989 protected function envCheckShellLocale() {
990 $os = php_uname( 's' );
991 $supported = [ 'Linux', 'SunOS', 'HP-UX', 'Darwin' ]; # Tested these
993 if ( !in_array( $os, $supported ) ) {
997 # Get a list of available locales.
999 $lines = wfShellExec( '/usr/bin/locale -a', $ret );
1005 $lines = array_map( 'trim', explode( "\n", $lines ) );
1006 $candidatesByLocale = [];
1007 $candidatesByLang = [];
1009 foreach ( $lines as $line ) {
1010 if ( $line === '' ) {
1014 if ( !preg_match( '/^([a-zA-Z]+)(_[a-zA-Z]+|)\.(utf8|UTF-8)(@[a-zA-Z_]*|)$/i', $line, $m ) ) {
1018 list( , $lang, , , ) = $m;
1020 $candidatesByLocale[$m[0]] = $m;
1021 $candidatesByLang[$lang][] = $m;
1024 # Try the current value of LANG.
1025 if ( isset( $candidatesByLocale[getenv( 'LANG' )] ) ) {
1026 $this->setVar( 'wgShellLocale', getenv( 'LANG' ) );
1031 # Try the most common ones.
1032 $commonLocales = [ 'C.UTF-8', 'en_US.UTF-8', 'en_US.utf8', 'de_DE.UTF-8', 'de_DE.utf8' ];
1033 foreach ( $commonLocales as $commonLocale ) {
1034 if ( isset( $candidatesByLocale[$commonLocale] ) ) {
1035 $this->setVar( 'wgShellLocale', $commonLocale );
1041 # Is there an available locale in the Wiki's language?
1042 $wikiLang = $this->getVar( 'wgLanguageCode' );
1044 if ( isset( $candidatesByLang[$wikiLang] ) ) {
1045 $m = reset( $candidatesByLang[$wikiLang] );
1046 $this->setVar( 'wgShellLocale', $m[0] );
1051 # Are there any at all?
1052 if ( count( $candidatesByLocale ) ) {
1053 $m = reset( $candidatesByLocale );
1054 $this->setVar( 'wgShellLocale', $m[0] );
1064 * Environment check for the permissions of the uploads directory
1067 protected function envCheckUploadsDirectory() {
1070 $dir = $IP . '/images/';
1071 $url = $this->getVar( 'wgServer' ) . $this->getVar( 'wgScriptPath' ) . '/images/';
1072 $safe = !$this->dirIsExecutable( $dir, $url );
1075 $this->showMessage( 'config-uploads-not-safe', $dir );
1082 * Checks if suhosin.get.max_value_length is set, and if so generate
1083 * a warning because it decreases ResourceLoader performance.
1086 protected function envCheckSuhosinMaxValueLength() {
1087 $maxValueLength = ini_get( 'suhosin.get.max_value_length' );
1088 if ( $maxValueLength > 0 && $maxValueLength < 1024 ) {
1089 // Only warn if the value is below the sane 1024
1090 $this->showMessage( 'config-suhosin-max-value-length', $maxValueLength );
1097 * Checks if we're running on 64 bit or not. 32 bit is becoming increasingly
1098 * hard to support, so let's at least warn people.
1102 protected function envCheck64Bit() {
1103 if ( PHP_INT_SIZE
== 4 ) {
1104 $this->showMessage( 'config-using-32bit' );
1111 * Convert a hex string representing a Unicode code point to that code point.
1113 * @return string|false
1115 protected function unicodeChar( $c ) {
1119 } elseif ( $c <= 0x7FF ) {
1120 return chr( 0xC0 |
$c >> 6 ) . chr( 0x80 |
$c & 0x3F );
1121 } elseif ( $c <= 0xFFFF ) {
1122 return chr( 0xE0 |
$c >> 12 ) . chr( 0x80 |
$c >> 6 & 0x3F ) .
1123 chr( 0x80 |
$c & 0x3F );
1124 } elseif ( $c <= 0x10FFFF ) {
1125 return chr( 0xF0 |
$c >> 18 ) . chr( 0x80 |
$c >> 12 & 0x3F ) .
1126 chr( 0x80 |
$c >> 6 & 0x3F ) .
1127 chr( 0x80 |
$c & 0x3F );
1134 * Check the libicu version
1136 protected function envCheckLibicu() {
1138 * This needs to be updated something that the latest libicu
1139 * will properly normalize. This normalization was found at
1140 * http://www.unicode.org/versions/Unicode5.2.0/#Character_Additions
1141 * Note that we use the hex representation to create the code
1142 * points in order to avoid any Unicode-destroying during transit.
1144 $not_normal_c = $this->unicodeChar( "FA6C" );
1145 $normal_c = $this->unicodeChar( "242EE" );
1147 $useNormalizer = 'php';
1148 $needsUpdate = false;
1150 if ( function_exists( 'normalizer_normalize' ) ) {
1151 $useNormalizer = 'intl';
1152 $intl = normalizer_normalize( $not_normal_c, Normalizer
::FORM_C
);
1153 if ( $intl !== $normal_c ) {
1154 $needsUpdate = true;
1158 // Uses messages 'config-unicode-using-php' and 'config-unicode-using-intl'
1159 if ( $useNormalizer === 'php' ) {
1160 $this->showMessage( 'config-unicode-pure-php-warning' );
1162 $this->showMessage( 'config-unicode-using-' . $useNormalizer );
1163 if ( $needsUpdate ) {
1164 $this->showMessage( 'config-unicode-update-warning' );
1170 * Environment prep for the server hostname.
1172 protected function envPrepServer() {
1173 $server = $this->envGetDefaultServer();
1174 if ( $server !== null ) {
1175 $this->setVar( 'wgServer', $server );
1180 * Helper function to be called from envPrepServer()
1183 abstract protected function envGetDefaultServer();
1186 * Environment prep for setting $IP and $wgScriptPath.
1188 protected function envPrepPath() {
1190 $IP = dirname( dirname( __DIR__
) );
1191 $this->setVar( 'IP', $IP );
1195 * Checks if scripts located in the given directory can be executed via the given URL.
1197 * Used only by environment checks.
1198 * @param string $dir
1199 * @param string $url
1200 * @return bool|int|string
1202 public function dirIsExecutable( $dir, $url ) {
1205 "<?php echo 'ex' . 'ec';",
1206 "#!/var/env php5\n<?php echo 'ex' . 'ec';",
1210 // it would be good to check other popular languages here, but it'll be slow.
1212 MediaWiki\
suppressWarnings();
1214 foreach ( $scriptTypes as $ext => $contents ) {
1215 foreach ( $contents as $source ) {
1216 $file = 'exectest.' . $ext;
1218 if ( !file_put_contents( $dir . $file, $source ) ) {
1223 $text = Http
::get( $url . $file, [ 'timeout' => 3 ], __METHOD__
);
1224 } catch ( Exception
$e ) {
1225 // Http::get throws with allow_url_fopen = false and no curl extension.
1228 unlink( $dir . $file );
1230 if ( $text == 'exec' ) {
1231 MediaWiki\restoreWarnings
();
1238 MediaWiki\restoreWarnings
();
1244 * Checks for presence of an Apache module. Works only if PHP is running as an Apache module, too.
1246 * @param string $moduleName Name of module to check.
1249 public static function apacheModulePresent( $moduleName ) {
1250 if ( function_exists( 'apache_get_modules' ) && in_array( $moduleName, apache_get_modules() ) ) {
1253 // try it the hard way
1255 phpinfo( INFO_MODULES
);
1256 $info = ob_get_clean();
1258 return strpos( $info, $moduleName ) !== false;
1262 * ParserOptions are constructed before we determined the language, so fix it
1264 * @param Language $lang
1266 public function setParserLanguage( $lang ) {
1267 $this->parserOptions
->setTargetLanguage( $lang );
1268 $this->parserOptions
->setUserLang( $lang );
1272 * Overridden by WebInstaller to provide lastPage parameters.
1273 * @param string $page
1276 protected function getDocUrl( $page ) {
1277 return "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1281 * Finds extensions that follow the format /$directory/Name/Name.php,
1282 * and returns an array containing the value for 'Name' for each found extension.
1284 * Reasonable values for $directory include 'extensions' (the default) and 'skins'.
1286 * @param string $directory Directory to search in
1287 * @return array [ $extName => [ 'screenshots' => [ '...' ] ]
1289 public function findExtensions( $directory = 'extensions' ) {
1290 if ( $this->getVar( 'IP' ) === null ) {
1294 $extDir = $this->getVar( 'IP' ) . '/' . $directory;
1295 if ( !is_readable( $extDir ) ||
!is_dir( $extDir ) ) {
1299 // extensions -> extension.json, skins -> skin.json
1300 $jsonFile = substr( $directory, 0, strlen( $directory ) - 1 ) . '.json';
1302 $dh = opendir( $extDir );
1304 while ( ( $file = readdir( $dh ) ) !== false ) {
1305 if ( !is_dir( "$extDir/$file" ) ) {
1308 if ( file_exists( "$extDir/$file/$jsonFile" ) ||
file_exists( "$extDir/$file/$file.php" ) ) {
1309 // Extension exists. Now see if there are screenshots
1311 if ( is_dir( "$extDir/$file/screenshots" ) ) {
1312 $paths = glob( "$extDir/$file/screenshots/*.png" );
1313 foreach ( $paths as $path ) {
1314 $exts[$file]['screenshots'][] = str_replace( $extDir, "../$directory", $path );
1321 uksort( $exts, 'strnatcasecmp' );
1327 * Returns a default value to be used for $wgDefaultSkin: normally the one set in DefaultSettings,
1328 * but will fall back to another if the default skin is missing and some other one is present
1331 * @param string[] $skinNames Names of installed skins.
1334 public function getDefaultSkin( array $skinNames ) {
1335 $defaultSkin = $GLOBALS['wgDefaultSkin'];
1336 if ( !$skinNames ||
in_array( $defaultSkin, $skinNames ) ) {
1337 return $defaultSkin;
1339 return $skinNames[0];
1344 * Installs the auto-detected extensions.
1348 protected function includeExtensions() {
1350 $exts = $this->getVar( '_Extensions' );
1351 $IP = $this->getVar( 'IP' );
1354 * We need to include DefaultSettings before including extensions to avoid
1355 * warnings about unset variables. However, the only thing we really
1356 * want here is $wgHooks['LoadExtensionSchemaUpdates']. This won't work
1357 * if the extension has hidden hook registration in $wgExtensionFunctions,
1358 * but we're not opening that can of worms
1359 * @see https://phabricator.wikimedia.org/T28857
1361 global $wgAutoloadClasses;
1362 $wgAutoloadClasses = [];
1365 require "$IP/includes/DefaultSettings.php";
1367 foreach ( $exts as $e ) {
1368 if ( file_exists( "$IP/extensions/$e/extension.json" ) ) {
1369 $queue["$IP/extensions/$e/extension.json"] = 1;
1371 require_once "$IP/extensions/$e/$e.php";
1375 $registry = new ExtensionRegistry();
1376 $data = $registry->readFromQueue( $queue );
1377 $wgAutoloadClasses +
= $data['autoload'];
1379 $hooksWeWant = isset( $wgHooks['LoadExtensionSchemaUpdates'] ) ?
1380 /** @suppress PhanUndeclaredVariable $wgHooks is set by DefaultSettings */
1381 $wgHooks['LoadExtensionSchemaUpdates'] : [];
1383 if ( isset( $data['globals']['wgHooks']['LoadExtensionSchemaUpdates'] ) ) {
1384 $hooksWeWant = array_merge_recursive(
1386 $data['globals']['wgHooks']['LoadExtensionSchemaUpdates']
1389 // Unset everyone else's hooks. Lord knows what someone might be doing
1390 // in ParserFirstCallInit (see T29171)
1391 $GLOBALS['wgHooks'] = [ 'LoadExtensionSchemaUpdates' => $hooksWeWant ];
1393 return Status
::newGood();
1397 * Get an array of install steps. Should always be in the format of
1399 * 'name' => 'someuniquename',
1400 * 'callback' => [ $obj, 'method' ],
1402 * There must be a config-install-$name message defined per step, which will
1403 * be shown on install.
1405 * @param DatabaseInstaller $installer DatabaseInstaller so we can make callbacks
1408 protected function getInstallSteps( DatabaseInstaller
$installer ) {
1409 $coreInstallSteps = [
1410 [ 'name' => 'database', 'callback' => [ $installer, 'setupDatabase' ] ],
1411 [ 'name' => 'tables', 'callback' => [ $installer, 'createTables' ] ],
1412 [ 'name' => 'interwiki', 'callback' => [ $installer, 'populateInterwikiTable' ] ],
1413 [ 'name' => 'stats', 'callback' => [ $this, 'populateSiteStats' ] ],
1414 [ 'name' => 'keys', 'callback' => [ $this, 'generateKeys' ] ],
1415 [ 'name' => 'updates', 'callback' => [ $installer, 'insertUpdateKeys' ] ],
1416 [ 'name' => 'sysop', 'callback' => [ $this, 'createSysop' ] ],
1417 [ 'name' => 'mainpage', 'callback' => [ $this, 'createMainpage' ] ],
1420 // Build the array of install steps starting from the core install list,
1421 // then adding any callbacks that wanted to attach after a given step
1422 foreach ( $coreInstallSteps as $step ) {
1423 $this->installSteps
[] = $step;
1424 if ( isset( $this->extraInstallSteps
[$step['name']] ) ) {
1425 $this->installSteps
= array_merge(
1426 $this->installSteps
,
1427 $this->extraInstallSteps
[$step['name']]
1432 // Prepend any steps that want to be at the beginning
1433 if ( isset( $this->extraInstallSteps
['BEGINNING'] ) ) {
1434 $this->installSteps
= array_merge(
1435 $this->extraInstallSteps
['BEGINNING'],
1440 // Extensions should always go first, chance to tie into hooks and such
1441 if ( count( $this->getVar( '_Extensions' ) ) ) {
1442 array_unshift( $this->installSteps
,
1443 [ 'name' => 'extensions', 'callback' => [ $this, 'includeExtensions' ] ]
1445 $this->installSteps
[] = [
1446 'name' => 'extension-tables',
1447 'callback' => [ $installer, 'createExtensionTables' ]
1451 return $this->installSteps
;
1455 * Actually perform the installation.
1457 * @param callable $startCB A callback array for the beginning of each step
1458 * @param callable $endCB A callback array for the end of each step
1460 * @return array Array of Status objects
1462 public function performInstallation( $startCB, $endCB ) {
1463 $installResults = [];
1464 $installer = $this->getDBInstaller();
1465 $installer->preInstall();
1466 $steps = $this->getInstallSteps( $installer );
1467 foreach ( $steps as $stepObj ) {
1468 $name = $stepObj['name'];
1469 call_user_func_array( $startCB, [ $name ] );
1471 // Perform the callback step
1472 $status = call_user_func( $stepObj['callback'], $installer );
1474 // Output and save the results
1475 call_user_func( $endCB, $name, $status );
1476 $installResults[$name] = $status;
1478 // If we've hit some sort of fatal, we need to bail.
1479 // Callback already had a chance to do output above.
1480 if ( !$status->isOk() ) {
1484 if ( $status->isOk() ) {
1486 'config-install-success',
1487 $this->getVar( 'wgServer' ),
1488 $this->getVar( 'wgScriptPath' )
1490 $this->setVar( '_InstallDone', true );
1493 return $installResults;
1497 * Generate $wgSecretKey. Will warn if we had to use an insecure random source.
1501 public function generateKeys() {
1502 $keys = [ 'wgSecretKey' => 64 ];
1503 if ( strval( $this->getVar( 'wgUpgradeKey' ) ) === '' ) {
1504 $keys['wgUpgradeKey'] = 16;
1507 return $this->doGenerateKeys( $keys );
1511 * Generate a secret value for variables using our CryptRand generator.
1512 * Produce a warning if the random source was insecure.
1514 * @param array $keys
1517 protected function doGenerateKeys( $keys ) {
1518 $status = Status
::newGood();
1521 foreach ( $keys as $name => $length ) {
1522 $secretKey = MWCryptRand
::generateHex( $length, true );
1523 if ( !MWCryptRand
::wasStrong() ) {
1527 $this->setVar( $name, $secretKey );
1531 $names = array_keys( $keys );
1532 $names = preg_replace( '/^(.*)$/', '\$$1', $names );
1534 $status->warning( 'config-insecure-keys', $wgLang->listToText( $names ), count( $names ) );
1541 * Create the first user account, grant it sysop and bureaucrat rights
1545 protected function createSysop() {
1546 $name = $this->getVar( '_AdminName' );
1547 $user = User
::newFromName( $name );
1550 // We should've validated this earlier anyway!
1551 return Status
::newFatal( 'config-admin-error-user', $name );
1554 if ( $user->idForName() == 0 ) {
1555 $user->addToDatabase();
1558 $user->setPassword( $this->getVar( '_AdminPassword' ) );
1559 } catch ( PasswordError
$pwe ) {
1560 return Status
::newFatal( 'config-admin-error-password', $name, $pwe->getMessage() );
1563 $user->addGroup( 'sysop' );
1564 $user->addGroup( 'bureaucrat' );
1565 if ( $this->getVar( '_AdminEmail' ) ) {
1566 $user->setEmail( $this->getVar( '_AdminEmail' ) );
1568 $user->saveSettings();
1570 // Update user count
1571 $ssUpdate = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
1572 $ssUpdate->doUpdate();
1574 $status = Status
::newGood();
1576 if ( $this->getVar( '_Subscribe' ) && $this->getVar( '_AdminEmail' ) ) {
1577 $this->subscribeToMediaWikiAnnounce( $status );
1586 private function subscribeToMediaWikiAnnounce( Status
$s ) {
1588 'email' => $this->getVar( '_AdminEmail' ),
1593 // Mailman doesn't support as many languages as we do, so check to make
1594 // sure their selected language is available
1595 $myLang = $this->getVar( '_UserLang' );
1596 if ( in_array( $myLang, $this->mediaWikiAnnounceLanguages
) ) {
1597 $myLang = $myLang == 'pt-br' ?
'pt_BR' : $myLang; // rewrite to Mailman's pt_BR
1598 $params['language'] = $myLang;
1601 if ( MWHttpRequest
::canMakeRequests() ) {
1602 $res = MWHttpRequest
::factory( $this->mediaWikiAnnounceUrl
,
1603 [ 'method' => 'POST', 'postData' => $params ], __METHOD__
)->execute();
1604 if ( !$res->isOK() ) {
1605 $s->warning( 'config-install-subscribe-fail', $res->getMessage() );
1608 $s->warning( 'config-install-subscribe-notpossible' );
1613 * Insert Main Page with default content.
1615 * @param DatabaseInstaller $installer
1618 protected function createMainpage( DatabaseInstaller
$installer ) {
1619 $status = Status
::newGood();
1620 $title = Title
::newMainPage();
1621 if ( $title->exists() ) {
1622 $status->warning( 'config-install-mainpage-exists' );
1626 $page = WikiPage
::factory( $title );
1627 $content = new WikitextContent(
1628 wfMessage( 'mainpagetext' )->inContentLanguage()->text() . "\n\n" .
1629 wfMessage( 'mainpagedocfooter' )->inContentLanguage()->text()
1632 $status = $page->doEditContent( $content,
1636 User
::newFromName( 'MediaWiki default' )
1638 } catch ( Exception
$e ) {
1639 // using raw, because $wgShowExceptionDetails can not be set yet
1640 $status->fatal( 'config-install-mainpage-failed', $e->getMessage() );
1647 * Override the necessary bits of the config to run an installation.
1649 public static function overrideConfig() {
1650 // Use PHP's built-in session handling, since MediaWiki's
1651 // SessionHandler can't work before we have an object cache set up.
1652 define( 'MW_NO_SESSION_HANDLER', 1 );
1654 // Don't access the database
1655 $GLOBALS['wgUseDatabaseMessages'] = false;
1656 // Don't cache langconv tables
1657 $GLOBALS['wgLanguageConverterCacheType'] = CACHE_NONE
;
1659 $GLOBALS['wgShowExceptionDetails'] = true;
1660 // Don't break forms
1661 $GLOBALS['wgExternalLinkTarget'] = '_blank';
1663 // Extended debugging
1664 $GLOBALS['wgShowSQLErrors'] = true;
1665 $GLOBALS['wgShowDBErrorBacktrace'] = true;
1667 // Allow multiple ob_flush() calls
1668 $GLOBALS['wgDisableOutputCompression'] = true;
1670 // Use a sensible cookie prefix (not my_wiki)
1671 $GLOBALS['wgCookiePrefix'] = 'mw_installer';
1673 // Some of the environment checks make shell requests, remove limits
1674 $GLOBALS['wgMaxShellMemory'] = 0;
1676 // Override the default CookieSessionProvider with a dummy
1677 // implementation that won't stomp on PHP's cookies.
1678 $GLOBALS['wgSessionProviders'] = [
1680 'class' => InstallerSessionProvider
::class,
1687 // Don't try to use any object cache for SessionManager either.
1688 $GLOBALS['wgSessionCacheType'] = CACHE_NONE
;
1692 * Add an installation step following the given step.
1694 * @param callable $callback A valid installation callback array, in this form:
1695 * [ 'name' => 'some-unique-name', 'callback' => [ $obj, 'function' ] ];
1696 * @param string $findStep The step to find. Omit to put the step at the beginning
1698 public function addInstallStep( $callback, $findStep = 'BEGINNING' ) {
1699 $this->extraInstallSteps
[$findStep][] = $callback;
1703 * Disable the time limit for execution.
1704 * Some long-running pages (Install, Upgrade) will want to do this
1706 protected function disableTimeLimit() {
1707 MediaWiki\
suppressWarnings();
1708 set_time_limit( 0 );
1709 MediaWiki\restoreWarnings
();