3 * Base code for MediaWiki installer.
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.
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.
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
25 * This documentation group collects source code files with deployment functionality.
27 * @defgroup Deployment Deployment
31 * Base installer class.
33 * This class provides the base for installation and update functionality
34 * for both MediaWiki core and extensions.
39 abstract class Installer
{
42 * The oldest version of PCRE we can support.
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.
47 const MINIMUM_PCRE_VERSION
= '7.2';
55 * List of detected DBs, access using getCompiledDBs().
59 protected $compiledDBs;
62 * Cached DB installer instances, access using getDBInstaller().
66 protected $dbInstallers = array();
69 * Minimum memory size in MB.
73 protected $minMemorySize = 50;
76 * Cached Title, used by parse().
80 protected $parserTitle;
83 * Cached ParserOptions, used by parse().
87 protected $parserOptions;
90 * Known database types. These correspond to the class names <type>Installer,
91 * and are also MediaWiki database types valid for $wgDBtype.
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.
98 protected static $dbTypes = array(
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.
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.
117 protected $envChecks = array(
119 'envCheckRegisterGlobals',
121 'envCheckMagicQuotes',
128 'envCheckModSecurity',
134 'envCheckShellLocale',
135 'envCheckUploadsDirectory',
137 'envCheckSuhosinMaxValueLength',
144 * A list of environment preparation methods called by doEnvironmentPreps().
148 protected $envPreps = array(
154 * MediaWiki configuration globals that will eventually be passed through
155 * to LocalSettings.php. The names only are given here, the defaults
156 * typically come from DefaultSettings.php.
160 protected $defaultVarNames = array(
171 'wgEmailAuthentication',
174 'wgImageMagickConvertCommand',
179 'wgDeletedDirectory',
183 'wgUseInstantCommons',
189 * Variables that are stored alongside globals, and are used for any
190 * configuration of the installation process aside from the MediaWiki
191 * configuration. Map of names to defaults.
195 protected $internalDefaults = array(
197 '_Environment' => false,
198 '_SafeMode' => false,
199 '_RaiseMemory' => false,
200 '_UpgradeDone' => false,
201 '_InstallDone' => false,
202 '_Caches' => array(),
203 '_InstallPassword' => '',
204 '_SameAccount' => true,
205 '_CreateDBAccount' => false,
206 '_NamespaceType' => 'site-name',
207 '_AdminName' => '', // will be set later, when the user selects language
208 '_AdminPassword' => '',
209 '_AdminPasswordConfirm' => '',
211 '_Subscribe' => false,
212 '_SkipOptional' => 'continue',
213 '_RightsProfile' => 'wiki',
214 '_LicenseCode' => 'none',
216 '_Extensions' => array(),
218 '_MemCachedServers' => '',
219 '_UpgradeKeySupplied' => false,
220 '_ExistingDBSettings' => false,
222 // $wgLogo is probably wrong (bug 48084); set something that will work.
223 // Single quotes work fine here, as LocalSettingsGenerator outputs this unescaped.
224 'wgLogo' => '$wgResourceBasePath/resources/assets/wiki.png',
228 * The actual list of installation steps. This will be initialized by getInstallSteps()
232 private $installSteps = array();
235 * Extra steps for installation, for things like DatabaseInstallers to modify
239 protected $extraInstallSteps = array();
242 * Known object cache types and the functions used to test for their existence.
246 protected $objectCaches = array(
247 'xcache' => 'xcache_get',
248 'apc' => 'apc_fetch',
249 'wincache' => 'wincache_ucache_get'
253 * User rights profiles.
257 public $rightsProfiles = array(
260 '*' => array( 'edit' => false )
264 'createaccount' => false,
270 'createaccount' => false,
282 public $licenses = array(
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',
291 'cc-by-nc-sa' => array(
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',
301 'icon' => '$wgResourceBasePath/resources/assets/licenses/public-domain.png',
304 'url' => 'https://www.gnu.org/copyleft/fdl.html',
305 'icon' => '$wgResourceBasePath/resources/assets/licenses/gnu-fdl.png',
312 'cc-choose' => array(
313 // Details will be filled in by the selector.
321 * URL to mediawiki-announce subscription
323 protected $mediaWikiAnnounceUrl =
324 'https://lists.wikimedia.org/mailman/subscribe/mediawiki-announce';
327 * Supported language codes for Mailman
329 protected $mediaWikiAnnounceLanguages = array(
330 'ca', 'cs', 'da', 'de', 'en', 'es', 'et', 'eu', 'fi', 'fr', 'hr', 'hu',
331 'it', 'ja', 'ko', 'lt', 'nl', 'no', 'pl', 'pt', 'pt-br', 'ro', 'ru',
332 'sl', 'sr', 'sv', 'tr', 'uk'
336 * UI interface for displaying a short message
337 * The parameters are like parameters to wfMessage().
338 * The messages will be in wikitext format, which will be converted to an
339 * output format such as HTML or text before being sent to the user.
342 abstract public function showMessage( $msg /*, ... */ );
345 * Same as showMessage(), but for displaying errors
348 abstract public function showError( $msg /*, ... */ );
351 * Show a message to the installing user by using a Status object
352 * @param Status $status
354 abstract public function showStatusMessage( Status
$status );
357 * Constructor, always call this from child classes.
359 public function __construct() {
360 global $wgMessagesDirs, $wgUser;
362 // Disable the i18n cache
363 Language
::getLocalisationCache()->disableBackend();
364 // Disable LoadBalancer and wfGetDB etc.
365 LBFactory
::disableBackend();
367 // Disable object cache (otherwise CACHE_ANYTHING will try CACHE_DB and
368 // SqlBagOStuff will then throw since we just disabled wfGetDB)
369 $GLOBALS['wgMemc'] = new EmptyBagOStuff
;
370 ObjectCache
::clear();
371 $emptyCache = array( 'class' => 'EmptyBagOStuff' );
372 // disable (problematic) object cache types explicitly, preserving all other (working) ones
374 $GLOBALS['wgObjectCaches'] = array(
375 CACHE_NONE
=> $emptyCache,
376 CACHE_DB
=> $emptyCache,
377 CACHE_ANYTHING
=> $emptyCache,
378 CACHE_MEMCACHED
=> $emptyCache,
379 ) +
$GLOBALS['wgObjectCaches'];
381 // Load the installer's i18n.
382 $wgMessagesDirs['MediawikiInstaller'] = __DIR__
. '/i18n';
384 // Having a user with id = 0 safeguards us from DB access via User::loadOptions().
385 $wgUser = User
::newFromId( 0 );
387 $this->settings
= $this->internalDefaults
;
389 foreach ( $this->defaultVarNames
as $var ) {
390 $this->settings
[$var] = $GLOBALS[$var];
393 $this->doEnvironmentPreps();
395 $this->compiledDBs
= array();
396 foreach ( self
::getDBTypes() as $type ) {
397 $installer = $this->getDBInstaller( $type );
399 if ( !$installer->isCompiled() ) {
402 $this->compiledDBs
[] = $type;
405 $this->parserTitle
= Title
::newFromText( 'Installer' );
406 $this->parserOptions
= new ParserOptions
; // language will be wrong :(
407 $this->parserOptions
->setEditSection( false );
411 * Get a list of known DB types.
415 public static function getDBTypes() {
416 return self
::$dbTypes;
420 * Do initial checks of the PHP environment. Set variables according to
421 * the observed environment.
423 * It's possible that this may be called under the CLI SAPI, not the SAPI
424 * that the wiki will primarily run under. In that case, the subclass should
425 * initialise variables such as wgScriptPath, before calling this function.
427 * Under the web subclass, it can already be assumed that PHP 5+ is in use
428 * and that sessions are working.
432 public function doEnvironmentChecks() {
433 // Php version has already been checked by entry scripts
434 // Show message here for information purposes
436 $this->showMessage( 'config-env-hhvm', HHVM_VERSION
);
438 $this->showMessage( 'config-env-php', PHP_VERSION
);
442 // Must go here because an old version of PCRE can prevent other checks from completing
443 list( $pcreVersion ) = explode( ' ', PCRE_VERSION
, 2 );
444 if ( version_compare( $pcreVersion, self
::MINIMUM_PCRE_VERSION
, '<' ) ) {
445 $this->showError( 'config-pcre-old', self
::MINIMUM_PCRE_VERSION
, $pcreVersion );
448 foreach ( $this->envChecks
as $check ) {
449 $status = $this->$check();
450 if ( $status === false ) {
456 $this->setVar( '_Environment', $good );
458 return $good ? Status
::newGood() : Status
::newFatal( 'config-env-bad' );
461 public function doEnvironmentPreps() {
462 foreach ( $this->envPreps
as $prep ) {
468 * Set a MW configuration variable, or internal installer configuration variable.
470 * @param string $name
471 * @param mixed $value
473 public function setVar( $name, $value ) {
474 $this->settings
[$name] = $value;
478 * Get an MW configuration variable, or internal installer configuration variable.
479 * The defaults come from $GLOBALS (ultimately DefaultSettings.php).
480 * Installer variables are typically prefixed by an underscore.
482 * @param string $name
483 * @param mixed $default
487 public function getVar( $name, $default = null ) {
488 if ( !isset( $this->settings
[$name] ) ) {
491 return $this->settings
[$name];
496 * Get a list of DBs supported by current PHP setup
500 public function getCompiledDBs() {
501 return $this->compiledDBs
;
505 * Get an instance of DatabaseInstaller for the specified DB type.
507 * @param mixed $type DB installer for which is needed, false to use default.
509 * @return DatabaseInstaller
511 public function getDBInstaller( $type = false ) {
513 $type = $this->getVar( 'wgDBtype' );
516 $type = strtolower( $type );
518 if ( !isset( $this->dbInstallers
[$type] ) ) {
519 $class = ucfirst( $type ) . 'Installer';
520 $this->dbInstallers
[$type] = new $class( $this );
523 return $this->dbInstallers
[$type];
527 * Determine if LocalSettings.php exists. If it does, return its variables.
531 public static function getExistingLocalSettings() {
534 // You might be wondering why this is here. Well if you don't do this
535 // then some poorly-formed extensions try to call their own classes
536 // after immediately registering them. We really need to get extension
537 // registration out of the global scope and into a real format.
538 // @see https://phabricator.wikimedia.org/T69440
539 global $wgAutoloadClasses;
540 $wgAutoloadClasses = array();
542 // @codingStandardsIgnoreStart
543 // LocalSettings.php should not call functions, except wfLoadSkin/wfLoadExtensions
544 // Define the required globals here, to ensure, the functions can do it work correctly.
545 global $wgExtensionDirectory, $wgStyleDirectory;
546 // @codingStandardsIgnoreEnd
548 MediaWiki\
suppressWarnings();
549 $_lsExists = file_exists( "$IP/LocalSettings.php" );
550 MediaWiki\restoreWarnings
();
557 require "$IP/includes/DefaultSettings.php";
558 require "$IP/LocalSettings.php";
560 return get_defined_vars();
564 * Get a fake password for sending back to the user in HTML.
565 * This is a security mechanism to avoid compromise of the password in the
566 * event of session ID compromise.
568 * @param string $realPassword
572 public function getFakePassword( $realPassword ) {
573 return str_repeat( '*', strlen( $realPassword ) );
577 * Set a variable which stores a password, except if the new value is a
578 * fake password in which case leave it as it is.
580 * @param string $name
581 * @param mixed $value
583 public function setPassword( $name, $value ) {
584 if ( !preg_match( '/^\*+$/', $value ) ) {
585 $this->setVar( $name, $value );
590 * On POSIX systems return the primary group of the webserver we're running under.
591 * On other systems just returns null.
593 * This is used to advice the user that he should chgrp his mw-config/data/images directory as the
594 * webserver user before he can install.
596 * Public because SqliteInstaller needs it, and doesn't subclass Installer.
600 public static function maybeGetWebserverPrimaryGroup() {
601 if ( !function_exists( 'posix_getegid' ) ||
!function_exists( 'posix_getpwuid' ) ) {
602 # I don't know this, this isn't UNIX.
606 # posix_getegid() *not* getmygid() because we want the group of the webserver,
607 # not whoever owns the current script.
608 $gid = posix_getegid();
609 $getpwuid = posix_getpwuid( $gid );
610 $group = $getpwuid['name'];
616 * Convert wikitext $text to HTML.
618 * This is potentially error prone since many parser features require a complete
619 * installed MW database. The solution is to just not use those features when you
620 * write your messages. This appears to work well enough. Basic formatting and
621 * external links work just fine.
623 * But in case a translator decides to throw in a "#ifexist" or internal link or
624 * whatever, this function is guarded to catch the attempted DB access and to present
625 * some fallback text.
627 * @param string $text
628 * @param bool $lineStart
631 public function parse( $text, $lineStart = false ) {
635 $out = $wgParser->parse( $text, $this->parserTitle
, $this->parserOptions
, $lineStart );
636 $html = $out->getText();
637 } catch ( DBAccessError
$e ) {
638 $html = '<!--DB access attempted during parse--> ' . htmlspecialchars( $text );
640 if ( !empty( $this->debug
) ) {
641 $html .= "<!--\n" . $e->getTraceAsString() . "\n-->";
649 * @return ParserOptions
651 public function getParserOptions() {
652 return $this->parserOptions
;
655 public function disableLinkPopups() {
656 $this->parserOptions
->setExternalLinkTarget( false );
659 public function restoreLinkPopups() {
660 global $wgExternalLinkTarget;
661 $this->parserOptions
->setExternalLinkTarget( $wgExternalLinkTarget );
665 * Install step which adds a row to the site_stats table with appropriate
668 * @param DatabaseInstaller $installer
672 public function populateSiteStats( DatabaseInstaller
$installer ) {
673 $status = $installer->getConnection();
674 if ( !$status->isOK() ) {
677 $status->value
->insert(
681 'ss_total_edits' => 0,
682 'ss_good_articles' => 0,
683 'ss_total_pages' => 0,
690 return Status
::newGood();
694 * Environment check for DB types.
697 protected function envCheckDB() {
702 // Messages: config-type-mysql, config-type-postgres, config-type-oracle,
703 // config-type-sqlite
704 foreach ( self
::getDBTypes() as $name ) {
705 $allNames[] = wfMessage( "config-type-$name" )->text();
708 $databases = $this->getCompiledDBs();
710 $databases = array_flip( $databases );
711 foreach ( array_keys( $databases ) as $db ) {
712 $installer = $this->getDBInstaller( $db );
713 $status = $installer->checkPrerequisites();
714 if ( !$status->isGood() ) {
715 $this->showStatusMessage( $status );
717 if ( !$status->isOK() ) {
718 unset( $databases[$db] );
721 $databases = array_flip( $databases );
723 $this->showError( 'config-no-db', $wgLang->commaList( $allNames ), count( $allNames ) );
725 // @todo FIXME: This only works for the web installer!
733 * Environment check for register_globals.
734 * Prevent installation if enabled
737 protected function envCheckRegisterGlobals() {
738 if ( wfIniGetBool( 'register_globals' ) ) {
739 $this->showMessage( 'config-register-globals-error' );
747 * Some versions of libxml+PHP break < and > encoding horribly
750 protected function envCheckBrokenXML() {
751 $test = new PhpXmlBugTester();
753 $this->showError( 'config-brokenlibxml' );
762 * Environment check for magic_quotes_(gpc|runtime|sybase).
765 protected function envCheckMagicQuotes() {
767 foreach ( array( 'gpc', 'runtime', 'sybase' ) as $magicJunk ) {
768 if ( wfIniGetBool( "magic_quotes_$magicJunk" ) ) {
769 $this->showError( "config-magic-quotes-$magicJunk" );
778 * Environment check for mbstring.func_overload.
781 protected function envCheckMbstring() {
782 if ( wfIniGetBool( 'mbstring.func_overload' ) ) {
783 $this->showError( 'config-mbstring' );
792 * Environment check for safe_mode.
795 protected function envCheckSafeMode() {
796 if ( wfIniGetBool( 'safe_mode' ) ) {
797 $this->setVar( '_SafeMode', true );
798 $this->showMessage( 'config-safe-mode' );
805 * Environment check for the XML module.
808 protected function envCheckXML() {
809 if ( !function_exists( "utf8_encode" ) ) {
810 $this->showError( 'config-xml-bad' );
819 * Environment check for the PCRE module.
821 * @note If this check were to fail, the parser would
822 * probably throw an exception before the result
823 * of this check is shown to the user.
826 protected function envCheckPCRE() {
827 MediaWiki\
suppressWarnings();
828 $regexd = preg_replace( '/[\x{0430}-\x{04FF}]/iu', '', '-АБВГД-' );
829 // Need to check for \p support too, as PCRE can be compiled
830 // with utf8 support, but not unicode property support.
831 // check that \p{Zs} (space separators) matches
832 // U+3000 (Ideographic space)
833 $regexprop = preg_replace( '/\p{Zs}/u', '', "-\xE3\x80\x80-" );
834 MediaWiki\restoreWarnings
();
835 if ( $regexd != '--' ||
$regexprop != '--' ) {
836 $this->showError( 'config-pcre-no-utf8' );
845 * Environment check for available memory.
848 protected function envCheckMemory() {
849 $limit = ini_get( 'memory_limit' );
851 if ( !$limit ||
$limit == -1 ) {
855 $n = wfShorthandToInteger( $limit );
857 if ( $n < $this->minMemorySize
* 1024 * 1024 ) {
858 $newLimit = "{$this->minMemorySize}M";
860 if ( ini_set( "memory_limit", $newLimit ) === false ) {
861 $this->showMessage( 'config-memory-bad', $limit );
863 $this->showMessage( 'config-memory-raised', $limit, $newLimit );
864 $this->setVar( '_RaiseMemory', true );
872 * Environment check for compiled object cache types.
874 protected function envCheckCache() {
876 foreach ( $this->objectCaches
as $name => $function ) {
877 if ( function_exists( $function ) ) {
878 if ( $name == 'xcache' && !wfIniGetBool( 'xcache.var_size' ) ) {
881 $caches[$name] = true;
886 $this->showMessage( 'config-no-cache' );
889 $this->setVar( '_Caches', $caches );
893 * Scare user to death if they have mod_security or mod_security2
896 protected function envCheckModSecurity() {
897 if ( self
::apacheModulePresent( 'mod_security' )
898 || self
::apacheModulePresent( 'mod_security2' ) ) {
899 $this->showMessage( 'config-mod-security' );
906 * Search for GNU diff3.
909 protected function envCheckDiff3() {
910 $names = array( "gdiff3", "diff3", "diff3.exe" );
911 $versionInfo = array( '$1 --version 2>&1', 'GNU diffutils' );
913 $diff3 = self
::locateExecutableInDefaultPaths( $names, $versionInfo );
916 $this->setVar( 'wgDiff3', $diff3 );
918 $this->setVar( 'wgDiff3', false );
919 $this->showMessage( 'config-diff3-bad' );
926 * Environment check for ImageMagick and GD.
929 protected function envCheckGraphics() {
930 $names = array( wfIsWindows() ?
'convert.exe' : 'convert' );
931 $versionInfo = array( '$1 -version', 'ImageMagick' );
932 $convert = self
::locateExecutableInDefaultPaths( $names, $versionInfo );
934 $this->setVar( 'wgImageMagickConvertCommand', '' );
936 $this->setVar( 'wgImageMagickConvertCommand', $convert );
937 $this->showMessage( 'config-imagemagick', $convert );
940 } elseif ( function_exists( 'imagejpeg' ) ) {
941 $this->showMessage( 'config-gd' );
943 $this->showMessage( 'config-no-scaling' );
955 protected function envCheckGit() {
956 $names = array( wfIsWindows() ?
'git.exe' : 'git' );
957 $versionInfo = array( '$1 --version', 'git version' );
959 $git = self
::locateExecutableInDefaultPaths( $names, $versionInfo );
962 $this->setVar( 'wgGitBin', $git );
963 $this->showMessage( 'config-git', $git );
965 $this->setVar( 'wgGitBin', false );
966 $this->showMessage( 'config-git-bad' );
973 * Environment check to inform user which server we've assumed.
977 protected function envCheckServer() {
978 $server = $this->envGetDefaultServer();
979 if ( $server !== null ) {
980 $this->showMessage( 'config-using-server', $server );
986 * Environment check to inform user which paths we've assumed.
990 protected function envCheckPath() {
993 $this->getVar( 'wgServer' ),
994 $this->getVar( 'wgScriptPath' )
1000 * Environment check for preferred locale in shell
1003 protected function envCheckShellLocale() {
1004 $os = php_uname( 's' );
1005 $supported = array( 'Linux', 'SunOS', 'HP-UX', 'Darwin' ); # Tested these
1007 if ( !in_array( $os, $supported ) ) {
1011 # Get a list of available locales.
1013 $lines = wfShellExec( '/usr/bin/locale -a', $ret );
1019 $lines = array_map( 'trim', explode( "\n", $lines ) );
1020 $candidatesByLocale = array();
1021 $candidatesByLang = array();
1023 foreach ( $lines as $line ) {
1024 if ( $line === '' ) {
1028 if ( !preg_match( '/^([a-zA-Z]+)(_[a-zA-Z]+|)\.(utf8|UTF-8)(@[a-zA-Z_]*|)$/i', $line, $m ) ) {
1032 list( , $lang, , , ) = $m;
1034 $candidatesByLocale[$m[0]] = $m;
1035 $candidatesByLang[$lang][] = $m;
1038 # Try the current value of LANG.
1039 if ( isset( $candidatesByLocale[getenv( 'LANG' )] ) ) {
1040 $this->setVar( 'wgShellLocale', getenv( 'LANG' ) );
1045 # Try the most common ones.
1046 $commonLocales = array( 'en_US.UTF-8', 'en_US.utf8', 'de_DE.UTF-8', 'de_DE.utf8' );
1047 foreach ( $commonLocales as $commonLocale ) {
1048 if ( isset( $candidatesByLocale[$commonLocale] ) ) {
1049 $this->setVar( 'wgShellLocale', $commonLocale );
1055 # Is there an available locale in the Wiki's language?
1056 $wikiLang = $this->getVar( 'wgLanguageCode' );
1058 if ( isset( $candidatesByLang[$wikiLang] ) ) {
1059 $m = reset( $candidatesByLang[$wikiLang] );
1060 $this->setVar( 'wgShellLocale', $m[0] );
1065 # Are there any at all?
1066 if ( count( $candidatesByLocale ) ) {
1067 $m = reset( $candidatesByLocale );
1068 $this->setVar( 'wgShellLocale', $m[0] );
1078 * Environment check for the permissions of the uploads directory
1081 protected function envCheckUploadsDirectory() {
1084 $dir = $IP . '/images/';
1085 $url = $this->getVar( 'wgServer' ) . $this->getVar( 'wgScriptPath' ) . '/images/';
1086 $safe = !$this->dirIsExecutable( $dir, $url );
1089 $this->showMessage( 'config-uploads-not-safe', $dir );
1096 * Checks if suhosin.get.max_value_length is set, and if so generate
1097 * a warning because it decreases ResourceLoader performance.
1100 protected function envCheckSuhosinMaxValueLength() {
1101 $maxValueLength = ini_get( 'suhosin.get.max_value_length' );
1102 if ( $maxValueLength > 0 && $maxValueLength < 1024 ) {
1103 // Only warn if the value is below the sane 1024
1104 $this->showMessage( 'config-suhosin-max-value-length', $maxValueLength );
1111 * Convert a hex string representing a Unicode code point to that code point.
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' );
1172 protected function envCheckCtype() {
1173 if ( !function_exists( 'ctype_digit' ) ) {
1174 $this->showError( 'config-ctype' );
1185 protected function envCheckIconv() {
1186 if ( !function_exists( 'iconv' ) ) {
1187 $this->showError( 'config-iconv' );
1198 protected function envCheckJSON() {
1199 if ( !function_exists( 'json_decode' ) ) {
1200 $this->showError( 'config-json' );
1209 * Environment prep for the server hostname.
1211 protected function envPrepServer() {
1212 $server = $this->envGetDefaultServer();
1213 if ( $server !== null ) {
1214 $this->setVar( 'wgServer', $server );
1219 * Helper function to be called from envPrepServer()
1222 abstract protected function envGetDefaultServer();
1225 * Environment prep for setting $IP and $wgScriptPath.
1227 protected function envPrepPath() {
1229 $IP = dirname( dirname( __DIR__
) );
1230 $this->setVar( 'IP', $IP );
1234 * Get an array of likely places we can find executables. Check a bunch
1235 * of known Unix-like defaults, as well as the PATH environment variable
1236 * (which should maybe make it work for Windows?)
1240 protected static function getPossibleBinPaths() {
1242 array( '/usr/bin', '/usr/local/bin', '/opt/csw/bin',
1243 '/usr/gnu/bin', '/usr/sfw/bin', '/sw/bin', '/opt/local/bin' ),
1244 explode( PATH_SEPARATOR
, getenv( 'PATH' ) )
1249 * Search a path for any of the given executable names. Returns the
1250 * executable name if found. Also checks the version string returned
1251 * by each executable.
1253 * Used only by environment checks.
1255 * @param string $path Path to search
1256 * @param array $names Array of executable names
1257 * @param array|bool $versionInfo False or array with two members:
1258 * 0 => Command to run for version check, with $1 for the full executable name
1259 * 1 => String to compare the output with
1261 * If $versionInfo is not false, only executables with a version
1262 * matching $versionInfo[1] will be returned.
1263 * @return bool|string
1265 public static function locateExecutable( $path, $names, $versionInfo = false ) {
1266 if ( !is_array( $names ) ) {
1267 $names = array( $names );
1270 foreach ( $names as $name ) {
1271 $command = $path . DIRECTORY_SEPARATOR
. $name;
1273 MediaWiki\
suppressWarnings();
1274 $file_exists = file_exists( $command );
1275 MediaWiki\restoreWarnings
();
1277 if ( $file_exists ) {
1278 if ( !$versionInfo ) {
1282 $file = str_replace( '$1', wfEscapeShellArg( $command ), $versionInfo[0] );
1283 if ( strstr( wfShellExec( $file ), $versionInfo[1] ) !== false ) {
1293 * Same as locateExecutable(), but checks in getPossibleBinPaths() by default
1294 * @see locateExecutable()
1295 * @param array $names Array of possible names.
1296 * @param array|bool $versionInfo Default: false or array with two members:
1297 * 0 => Command to run for version check, with $1 for the full executable name
1298 * 1 => String to compare the output with
1300 * If $versionInfo is not false, only executables with a version
1301 * matching $versionInfo[1] will be returned.
1302 * @return bool|string
1304 public static function locateExecutableInDefaultPaths( $names, $versionInfo = false ) {
1305 foreach ( self
::getPossibleBinPaths() as $path ) {
1306 $exe = self
::locateExecutable( $path, $names, $versionInfo );
1307 if ( $exe !== false ) {
1316 * Checks if scripts located in the given directory can be executed via the given URL.
1318 * Used only by environment checks.
1319 * @param string $dir
1320 * @param string $url
1321 * @return bool|int|string
1323 public function dirIsExecutable( $dir, $url ) {
1324 $scriptTypes = array(
1326 "<?php echo 'ex' . 'ec';",
1327 "#!/var/env php5\n<?php echo 'ex' . 'ec';",
1331 // it would be good to check other popular languages here, but it'll be slow.
1333 MediaWiki\
suppressWarnings();
1335 foreach ( $scriptTypes as $ext => $contents ) {
1336 foreach ( $contents as $source ) {
1337 $file = 'exectest.' . $ext;
1339 if ( !file_put_contents( $dir . $file, $source ) ) {
1344 $text = Http
::get( $url . $file, array( 'timeout' => 3 ), __METHOD__
);
1345 } catch ( Exception
$e ) {
1346 // Http::get throws with allow_url_fopen = false and no curl extension.
1349 unlink( $dir . $file );
1351 if ( $text == 'exec' ) {
1352 MediaWiki\restoreWarnings
();
1359 MediaWiki\restoreWarnings
();
1365 * Checks for presence of an Apache module. Works only if PHP is running as an Apache module, too.
1367 * @param string $moduleName Name of module to check.
1370 public static function apacheModulePresent( $moduleName ) {
1371 if ( function_exists( 'apache_get_modules' ) && in_array( $moduleName, apache_get_modules() ) ) {
1374 // try it the hard way
1376 phpinfo( INFO_MODULES
);
1377 $info = ob_get_clean();
1379 return strpos( $info, $moduleName ) !== false;
1383 * ParserOptions are constructed before we determined the language, so fix it
1385 * @param Language $lang
1387 public function setParserLanguage( $lang ) {
1388 $this->parserOptions
->setTargetLanguage( $lang );
1389 $this->parserOptions
->setUserLang( $lang );
1393 * Overridden by WebInstaller to provide lastPage parameters.
1394 * @param string $page
1397 protected function getDocUrl( $page ) {
1398 return "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1402 * Finds extensions that follow the format /$directory/Name/Name.php,
1403 * and returns an array containing the value for 'Name' for each found extension.
1405 * Reasonable values for $directory include 'extensions' (the default) and 'skins'.
1407 * @param string $directory Directory to search in
1410 public function findExtensions( $directory = 'extensions' ) {
1411 if ( $this->getVar( 'IP' ) === null ) {
1415 $extDir = $this->getVar( 'IP' ) . '/' . $directory;
1416 if ( !is_readable( $extDir ) ||
!is_dir( $extDir ) ) {
1420 // extensions -> extension.json, skins -> skin.json
1421 $jsonFile = substr( $directory, 0, strlen( $directory ) -1 ) . '.json';
1423 $dh = opendir( $extDir );
1425 while ( ( $file = readdir( $dh ) ) !== false ) {
1426 if ( !is_dir( "$extDir/$file" ) ) {
1429 if ( file_exists( "$extDir/$file/$jsonFile" ) ||
file_exists( "$extDir/$file/$file.php" ) ) {
1434 natcasesort( $exts );
1440 * Returns a default value to be used for $wgDefaultSkin: normally the one set in DefaultSettings,
1441 * but will fall back to another if the default skin is missing and some other one is present
1444 * @param string[] $skinNames Names of installed skins.
1447 public function getDefaultSkin( array $skinNames ) {
1448 $defaultSkin = $GLOBALS['wgDefaultSkin'];
1449 if ( !$skinNames ||
in_array( $defaultSkin, $skinNames ) ) {
1450 return $defaultSkin;
1452 return $skinNames[0];
1457 * Installs the auto-detected extensions.
1461 protected function includeExtensions() {
1463 $exts = $this->getVar( '_Extensions' );
1464 $IP = $this->getVar( 'IP' );
1467 * We need to include DefaultSettings before including extensions to avoid
1468 * warnings about unset variables. However, the only thing we really
1469 * want here is $wgHooks['LoadExtensionSchemaUpdates']. This won't work
1470 * if the extension has hidden hook registration in $wgExtensionFunctions,
1471 * but we're not opening that can of worms
1472 * @see https://phabricator.wikimedia.org/T28857
1474 global $wgAutoloadClasses;
1475 $wgAutoloadClasses = array();
1478 require "$IP/includes/DefaultSettings.php";
1480 foreach ( $exts as $e ) {
1481 if ( file_exists( "$IP/extensions/$e/extension.json" ) ) {
1482 $queue["$IP/extensions/$e/extension.json"] = 1;
1484 require_once "$IP/extensions/$e/$e.php";
1488 $registry = new ExtensionRegistry();
1489 $data = $registry->readFromQueue( $queue );
1490 $wgAutoloadClasses +
= $data['autoload'];
1492 $hooksWeWant = isset( $wgHooks['LoadExtensionSchemaUpdates'] ) ?
1493 $wgHooks['LoadExtensionSchemaUpdates'] : array();
1495 if ( isset( $data['globals']['wgHooks']['LoadExtensionSchemaUpdates'] ) ) {
1496 $hooksWeWant = array_merge_recursive(
1498 $data['globals']['wgHooks']['LoadExtensionSchemaUpdates']
1501 // Unset everyone else's hooks. Lord knows what someone might be doing
1502 // in ParserFirstCallInit (see bug 27171)
1503 $GLOBALS['wgHooks'] = array( 'LoadExtensionSchemaUpdates' => $hooksWeWant );
1505 return Status
::newGood();
1509 * Get an array of install steps. Should always be in the format of
1511 * 'name' => 'someuniquename',
1512 * 'callback' => array( $obj, 'method' ),
1514 * There must be a config-install-$name message defined per step, which will
1515 * be shown on install.
1517 * @param DatabaseInstaller $installer DatabaseInstaller so we can make callbacks
1520 protected function getInstallSteps( DatabaseInstaller
$installer ) {
1521 $coreInstallSteps = array(
1522 array( 'name' => 'database', 'callback' => array( $installer, 'setupDatabase' ) ),
1523 array( 'name' => 'tables', 'callback' => array( $installer, 'createTables' ) ),
1524 array( 'name' => 'interwiki', 'callback' => array( $installer, 'populateInterwikiTable' ) ),
1525 array( 'name' => 'stats', 'callback' => array( $this, 'populateSiteStats' ) ),
1526 array( 'name' => 'keys', 'callback' => array( $this, 'generateKeys' ) ),
1527 array( 'name' => 'updates', 'callback' => array( $installer, 'insertUpdateKeys' ) ),
1528 array( 'name' => 'sysop', 'callback' => array( $this, 'createSysop' ) ),
1529 array( 'name' => 'mainpage', 'callback' => array( $this, 'createMainpage' ) ),
1532 // Build the array of install steps starting from the core install list,
1533 // then adding any callbacks that wanted to attach after a given step
1534 foreach ( $coreInstallSteps as $step ) {
1535 $this->installSteps
[] = $step;
1536 if ( isset( $this->extraInstallSteps
[$step['name']] ) ) {
1537 $this->installSteps
= array_merge(
1538 $this->installSteps
,
1539 $this->extraInstallSteps
[$step['name']]
1544 // Prepend any steps that want to be at the beginning
1545 if ( isset( $this->extraInstallSteps
['BEGINNING'] ) ) {
1546 $this->installSteps
= array_merge(
1547 $this->extraInstallSteps
['BEGINNING'],
1552 // Extensions should always go first, chance to tie into hooks and such
1553 if ( count( $this->getVar( '_Extensions' ) ) ) {
1554 array_unshift( $this->installSteps
,
1555 array( 'name' => 'extensions', 'callback' => array( $this, 'includeExtensions' ) )
1557 $this->installSteps
[] = array(
1558 'name' => 'extension-tables',
1559 'callback' => array( $installer, 'createExtensionTables' )
1563 return $this->installSteps
;
1567 * Actually perform the installation.
1569 * @param callable $startCB A callback array for the beginning of each step
1570 * @param callable $endCB A callback array for the end of each step
1572 * @return array Array of Status objects
1574 public function performInstallation( $startCB, $endCB ) {
1575 $installResults = array();
1576 $installer = $this->getDBInstaller();
1577 $installer->preInstall();
1578 $steps = $this->getInstallSteps( $installer );
1579 foreach ( $steps as $stepObj ) {
1580 $name = $stepObj['name'];
1581 call_user_func_array( $startCB, array( $name ) );
1583 // Perform the callback step
1584 $status = call_user_func( $stepObj['callback'], $installer );
1586 // Output and save the results
1587 call_user_func( $endCB, $name, $status );
1588 $installResults[$name] = $status;
1590 // If we've hit some sort of fatal, we need to bail.
1591 // Callback already had a chance to do output above.
1592 if ( !$status->isOk() ) {
1596 if ( $status->isOk() ) {
1597 $this->setVar( '_InstallDone', true );
1600 return $installResults;
1604 * Generate $wgSecretKey. Will warn if we had to use an insecure random source.
1608 public function generateKeys() {
1609 $keys = array( 'wgSecretKey' => 64 );
1610 if ( strval( $this->getVar( 'wgUpgradeKey' ) ) === '' ) {
1611 $keys['wgUpgradeKey'] = 16;
1614 return $this->doGenerateKeys( $keys );
1618 * Generate a secret value for variables using our CryptRand generator.
1619 * Produce a warning if the random source was insecure.
1621 * @param array $keys
1624 protected function doGenerateKeys( $keys ) {
1625 $status = Status
::newGood();
1628 foreach ( $keys as $name => $length ) {
1629 $secretKey = MWCryptRand
::generateHex( $length, true );
1630 if ( !MWCryptRand
::wasStrong() ) {
1634 $this->setVar( $name, $secretKey );
1638 $names = array_keys( $keys );
1639 $names = preg_replace( '/^(.*)$/', '\$$1', $names );
1641 $status->warning( 'config-insecure-keys', $wgLang->listToText( $names ), count( $names ) );
1648 * Create the first user account, grant it sysop and bureaucrat rights
1652 protected function createSysop() {
1653 $name = $this->getVar( '_AdminName' );
1654 $user = User
::newFromName( $name );
1657 // We should've validated this earlier anyway!
1658 return Status
::newFatal( 'config-admin-error-user', $name );
1661 if ( $user->idForName() == 0 ) {
1662 $user->addToDatabase();
1665 $user->setPassword( $this->getVar( '_AdminPassword' ) );
1666 } catch ( PasswordError
$pwe ) {
1667 return Status
::newFatal( 'config-admin-error-password', $name, $pwe->getMessage() );
1670 $user->addGroup( 'sysop' );
1671 $user->addGroup( 'bureaucrat' );
1672 if ( $this->getVar( '_AdminEmail' ) ) {
1673 $user->setEmail( $this->getVar( '_AdminEmail' ) );
1675 $user->saveSettings();
1677 // Update user count
1678 $ssUpdate = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
1679 $ssUpdate->doUpdate();
1681 $status = Status
::newGood();
1683 if ( $this->getVar( '_Subscribe' ) && $this->getVar( '_AdminEmail' ) ) {
1684 $this->subscribeToMediaWikiAnnounce( $status );
1693 private function subscribeToMediaWikiAnnounce( Status
$s ) {
1695 'email' => $this->getVar( '_AdminEmail' ),
1700 // Mailman doesn't support as many languages as we do, so check to make
1701 // sure their selected language is available
1702 $myLang = $this->getVar( '_UserLang' );
1703 if ( in_array( $myLang, $this->mediaWikiAnnounceLanguages
) ) {
1704 $myLang = $myLang == 'pt-br' ?
'pt_BR' : $myLang; // rewrite to Mailman's pt_BR
1705 $params['language'] = $myLang;
1708 if ( MWHttpRequest
::canMakeRequests() ) {
1709 $res = MWHttpRequest
::factory( $this->mediaWikiAnnounceUrl
,
1710 array( 'method' => 'POST', 'postData' => $params ), __METHOD__
)->execute();
1711 if ( !$res->isOK() ) {
1712 $s->warning( 'config-install-subscribe-fail', $res->getMessage() );
1715 $s->warning( 'config-install-subscribe-notpossible' );
1720 * Insert Main Page with default content.
1722 * @param DatabaseInstaller $installer
1725 protected function createMainpage( DatabaseInstaller
$installer ) {
1726 $status = Status
::newGood();
1728 $page = WikiPage
::factory( Title
::newMainPage() );
1729 $content = new WikitextContent(
1730 wfMessage( 'mainpagetext' )->inContentLanguage()->text() . "\n\n" .
1731 wfMessage( 'mainpagedocfooter' )->inContentLanguage()->text()
1734 $page->doEditContent( $content,
1738 User
::newFromName( 'MediaWiki default' )
1740 } catch ( Exception
$e ) {
1741 // using raw, because $wgShowExceptionDetails can not be set yet
1742 $status->fatal( 'config-install-mainpage-failed', $e->getMessage() );
1749 * Override the necessary bits of the config to run an installation.
1751 public static function overrideConfig() {
1752 define( 'MW_NO_SESSION', 1 );
1754 // Don't access the database
1755 $GLOBALS['wgUseDatabaseMessages'] = false;
1756 // Don't cache langconv tables
1757 $GLOBALS['wgLanguageConverterCacheType'] = CACHE_NONE
;
1759 $GLOBALS['wgShowExceptionDetails'] = true;
1760 // Don't break forms
1761 $GLOBALS['wgExternalLinkTarget'] = '_blank';
1763 // Extended debugging
1764 $GLOBALS['wgShowSQLErrors'] = true;
1765 $GLOBALS['wgShowDBErrorBacktrace'] = true;
1767 // Allow multiple ob_flush() calls
1768 $GLOBALS['wgDisableOutputCompression'] = true;
1770 // Use a sensible cookie prefix (not my_wiki)
1771 $GLOBALS['wgCookiePrefix'] = 'mw_installer';
1773 // Some of the environment checks make shell requests, remove limits
1774 $GLOBALS['wgMaxShellMemory'] = 0;
1778 * Add an installation step following the given step.
1780 * @param callable $callback A valid installation callback array, in this form:
1781 * array( 'name' => 'some-unique-name', 'callback' => array( $obj, 'function' ) );
1782 * @param string $findStep The step to find. Omit to put the step at the beginning
1784 public function addInstallStep( $callback, $findStep = 'BEGINNING' ) {
1785 $this->extraInstallSteps
[$findStep][] = $callback;
1789 * Disable the time limit for execution.
1790 * Some long-running pages (Install, Upgrade) will want to do this
1792 protected function disableTimeLimit() {
1793 MediaWiki\
suppressWarnings();
1794 set_time_limit( 0 );
1795 MediaWiki\restoreWarnings
();