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(
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.
161 protected $defaultVarNames = array(
173 'wgEmailAuthentication',
176 'wgImageMagickConvertCommand',
182 'wgDeletedDirectory',
186 'wgUseInstantCommons',
189 'wgResourceLoaderMaxQueryLength',
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.
199 protected $internalDefaults = array(
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' => '',
215 '_Subscribe' => false,
216 '_SkipOptional' => 'continue',
217 '_RightsProfile' => 'wiki',
218 '_LicenseCode' => 'none',
220 '_Extensions' => array(),
222 '_MemCachedServers' => '',
223 '_UpgradeKeySupplied' => false,
224 '_ExistingDBSettings' => false,
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' => '$wgStylePath/common/images/wiki.png',
232 * The actual list of installation steps. This will be initialized by getInstallSteps()
236 private $installSteps = array();
239 * Extra steps for installation, for things like DatabaseInstallers to modify
243 protected $extraInstallSteps = array();
246 * Known object cache types and the functions used to test for their existence.
250 protected $objectCaches = array(
251 'xcache' => 'xcache_get',
252 'apc' => 'apc_fetch',
253 'wincache' => 'wincache_ucache_get'
257 * User rights profiles.
261 public $rightsProfiles = array(
264 '*' => array( 'edit' => false )
268 'createaccount' => false,
274 'createaccount' => false,
286 public $licenses = array(
288 'url' => 'http://creativecommons.org/licenses/by/3.0/',
289 'icon' => '{$wgStylePath}/common/images/cc-by.png',
292 'url' => 'http://creativecommons.org/licenses/by-sa/3.0/',
293 'icon' => '{$wgStylePath}/common/images/cc-by-sa.png',
295 'cc-by-nc-sa' => array(
296 'url' => 'http://creativecommons.org/licenses/by-nc-sa/3.0/',
297 'icon' => '{$wgStylePath}/common/images/cc-by-nc-sa.png',
300 'url' => 'https://creativecommons.org/publicdomain/zero/1.0/',
301 'icon' => '{$wgStylePath}/common/images/cc-0.png',
305 'icon' => '{$wgStylePath}/common/images/public-domain.png',
308 'url' => 'http://www.gnu.org/copyleft/fdl.html',
309 'icon' => '{$wgStylePath}/common/images/gnu-fdl.png',
316 'cc-choose' => array(
317 // Details will be filled in by the selector.
325 * URL to mediawiki-announce subscription
327 protected $mediaWikiAnnounceUrl =
328 'https://lists.wikimedia.org/mailman/subscribe/mediawiki-announce';
331 * Supported language codes for Mailman
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'
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.
346 abstract public function showMessage( $msg /*, ... */ );
349 * Same as showMessage(), but for displaying errors
352 abstract public function showError( $msg /*, ... */ );
355 * Show a message to the installing user by using a Status object
356 * @param Status $status
358 abstract public function showStatusMessage( Status
$status );
361 * Constructor, always call this from child classes.
363 public function __construct() {
364 global $wgMessagesDirs, $wgUser;
366 // Disable the i18n cache
367 Language
::getLocalisationCache()->disableBackend();
368 // Disable LoadBalancer and wfGetDB etc.
369 LBFactory
::disableBackend();
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,
383 // Load the installer's i18n.
384 $wgMessagesDirs['MediawikiInstaller'] = __DIR__
. '/i18n';
386 // Having a user with id = 0 safeguards us from DB access via User::loadOptions().
387 $wgUser = User
::newFromId( 0 );
389 $this->settings
= $this->internalDefaults
;
391 foreach ( $this->defaultVarNames
as $var ) {
392 $this->settings
[$var] = $GLOBALS[$var];
395 $this->doEnvironmentPreps();
397 $this->compiledDBs
= array();
398 foreach ( self
::getDBTypes() as $type ) {
399 $installer = $this->getDBInstaller( $type );
401 if ( !$installer->isCompiled() ) {
404 $this->compiledDBs
[] = $type;
407 $this->parserTitle
= Title
::newFromText( 'Installer' );
408 $this->parserOptions
= new ParserOptions
; // language will be wrong :(
409 $this->parserOptions
->setEditSection( false );
413 * Get a list of known DB types.
417 public static function getDBTypes() {
418 return self
::$dbTypes;
422 * Do initial checks of the PHP environment. Set variables according to
423 * the observed environment.
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.
429 * Under the web subclass, it can already be assumed that PHP 5+ is in use
430 * and that sessions are working.
434 public function doEnvironmentChecks() {
435 // Php version has already been checked by entry scripts
436 // Show message here for information purposes
437 $this->showMessage( 'config-env-php', PHP_VERSION
);
440 // Must go here because an old version of PCRE can prevent other checks from completing
441 list( $pcreVersion ) = explode( ' ', PCRE_VERSION
, 2 );
442 if ( version_compare( $pcreVersion, self
::MINIMUM_PCRE_VERSION
, '<' ) ) {
443 $this->showError( 'config-pcre-old', self
::MINIMUM_PCRE_VERSION
, $pcreVersion );
446 foreach ( $this->envChecks
as $check ) {
447 $status = $this->$check();
448 if ( $status === false ) {
454 $this->setVar( '_Environment', $good );
456 return $good ? Status
::newGood() : Status
::newFatal( 'config-env-bad' );
459 public function doEnvironmentPreps() {
460 foreach ( $this->envPreps
as $prep ) {
466 * Set a MW configuration variable, or internal installer configuration variable.
468 * @param string $name
469 * @param mixed $value
471 public function setVar( $name, $value ) {
472 $this->settings
[$name] = $value;
476 * Get an MW configuration variable, or internal installer configuration variable.
477 * The defaults come from $GLOBALS (ultimately DefaultSettings.php).
478 * Installer variables are typically prefixed by an underscore.
480 * @param string $name
481 * @param mixed $default
485 public function getVar( $name, $default = null ) {
486 if ( !isset( $this->settings
[$name] ) ) {
489 return $this->settings
[$name];
494 * Get a list of DBs supported by current PHP setup
498 public function getCompiledDBs() {
499 return $this->compiledDBs
;
503 * Get an instance of DatabaseInstaller for the specified DB type.
505 * @param mixed $type DB installer for which is needed, false to use default.
507 * @return DatabaseInstaller
509 public function getDBInstaller( $type = false ) {
511 $type = $this->getVar( 'wgDBtype' );
514 $type = strtolower( $type );
516 if ( !isset( $this->dbInstallers
[$type] ) ) {
517 $class = ucfirst( $type ) . 'Installer';
518 $this->dbInstallers
[$type] = new $class( $this );
521 return $this->dbInstallers
[$type];
525 * Determine if LocalSettings.php exists. If it does, return its variables.
529 public static function getExistingLocalSettings() {
532 wfSuppressWarnings();
533 $_lsExists = file_exists( "$IP/LocalSettings.php" );
541 require "$IP/includes/DefaultSettings.php";
542 require "$IP/LocalSettings.php";
544 return get_defined_vars();
548 * Get a fake password for sending back to the user in HTML.
549 * This is a security mechanism to avoid compromise of the password in the
550 * event of session ID compromise.
552 * @param string $realPassword
556 public function getFakePassword( $realPassword ) {
557 return str_repeat( '*', strlen( $realPassword ) );
561 * Set a variable which stores a password, except if the new value is a
562 * fake password in which case leave it as it is.
564 * @param string $name
565 * @param mixed $value
567 public function setPassword( $name, $value ) {
568 if ( !preg_match( '/^\*+$/', $value ) ) {
569 $this->setVar( $name, $value );
574 * On POSIX systems return the primary group of the webserver we're running under.
575 * On other systems just returns null.
577 * This is used to advice the user that he should chgrp his mw-config/data/images directory as the
578 * webserver user before he can install.
580 * Public because SqliteInstaller needs it, and doesn't subclass Installer.
584 public static function maybeGetWebserverPrimaryGroup() {
585 if ( !function_exists( 'posix_getegid' ) ||
!function_exists( 'posix_getpwuid' ) ) {
586 # I don't know this, this isn't UNIX.
590 # posix_getegid() *not* getmygid() because we want the group of the webserver,
591 # not whoever owns the current script.
592 $gid = posix_getegid();
593 $getpwuid = posix_getpwuid( $gid );
594 $group = $getpwuid['name'];
600 * Convert wikitext $text to HTML.
602 * This is potentially error prone since many parser features require a complete
603 * installed MW database. The solution is to just not use those features when you
604 * write your messages. This appears to work well enough. Basic formatting and
605 * external links work just fine.
607 * But in case a translator decides to throw in a "#ifexist" or internal link or
608 * whatever, this function is guarded to catch the attempted DB access and to present
609 * some fallback text.
611 * @param string $text
612 * @param bool $lineStart
615 public function parse( $text, $lineStart = false ) {
619 $out = $wgParser->parse( $text, $this->parserTitle
, $this->parserOptions
, $lineStart );
620 $html = $out->getText();
621 } catch ( DBAccessError
$e ) {
622 $html = '<!--DB access attempted during parse--> ' . htmlspecialchars( $text );
624 if ( !empty( $this->debug
) ) {
625 $html .= "<!--\n" . $e->getTraceAsString() . "\n-->";
633 * @return ParserOptions
635 public function getParserOptions() {
636 return $this->parserOptions
;
639 public function disableLinkPopups() {
640 $this->parserOptions
->setExternalLinkTarget( false );
643 public function restoreLinkPopups() {
644 global $wgExternalLinkTarget;
645 $this->parserOptions
->setExternalLinkTarget( $wgExternalLinkTarget );
649 * Install step which adds a row to the site_stats table with appropriate
652 * @param DatabaseInstaller $installer
656 public function populateSiteStats( DatabaseInstaller
$installer ) {
657 $status = $installer->getConnection();
658 if ( !$status->isOK() ) {
661 $status->value
->insert(
665 'ss_total_views' => 0,
666 'ss_total_edits' => 0,
667 'ss_good_articles' => 0,
668 'ss_total_pages' => 0,
675 return Status
::newGood();
679 * Exports all wg* variables stored by the installer into global scope.
681 public function exportVars() {
682 foreach ( $this->settings
as $name => $value ) {
683 if ( substr( $name, 0, 2 ) == 'wg' ) {
684 $GLOBALS[$name] = $value;
690 * Environment check for DB types.
693 protected function envCheckDB() {
698 // Messages: config-type-mysql, config-type-postgres, config-type-oracle,
699 // config-type-sqlite
700 foreach ( self
::getDBTypes() as $name ) {
701 $allNames[] = wfMessage( "config-type-$name" )->text();
704 $databases = $this->getCompiledDBs();
706 $databases = array_flip( $databases );
707 foreach ( array_keys( $databases ) as $db ) {
708 $installer = $this->getDBInstaller( $db );
709 $status = $installer->checkPrerequisites();
710 if ( !$status->isGood() ) {
711 $this->showStatusMessage( $status );
713 if ( !$status->isOK() ) {
714 unset( $databases[$db] );
717 $databases = array_flip( $databases );
719 $this->showError( 'config-no-db', $wgLang->commaList( $allNames ) );
721 // @todo FIXME: This only works for the web installer!
729 * Environment check for register_globals.
730 * Prevent installation if enabled
732 protected function envCheckRegisterGlobals() {
733 if ( wfIniGetBool( 'register_globals' ) ) {
734 $this->showMessage( 'config-register-globals-error' );
742 * Some versions of libxml+PHP break < and > encoding horribly
745 protected function envCheckBrokenXML() {
746 $test = new PhpXmlBugTester();
748 $this->showError( 'config-brokenlibxml' );
757 * Environment check for magic_quotes_(gpc|runtime|sybase).
760 protected function envCheckMagicQuotes() {
762 foreach ( array( 'gpc', 'runtime', 'sybase' ) as $magicJunk ) {
763 if ( wfIniGetBool( "magic_quotes_$magicJunk" ) ) {
764 $this->showError( "config-magic-quotes-$magicJunk" );
773 * Environment check for mbstring.func_overload.
776 protected function envCheckMbstring() {
777 if ( wfIniGetBool( 'mbstring.func_overload' ) ) {
778 $this->showError( 'config-mbstring' );
787 * Environment check for safe_mode.
790 protected function envCheckSafeMode() {
791 if ( wfIniGetBool( 'safe_mode' ) ) {
792 $this->setVar( '_SafeMode', true );
793 $this->showMessage( 'config-safe-mode' );
800 * Environment check for the XML module.
803 protected function envCheckXML() {
804 if ( !function_exists( "utf8_encode" ) ) {
805 $this->showError( 'config-xml-bad' );
814 * Environment check for the PCRE module.
816 * @note If this check were to fail, the parser would
817 * probably throw an exception before the result
818 * of this check is shown to the user.
821 protected function envCheckPCRE() {
822 wfSuppressWarnings();
823 $regexd = preg_replace( '/[\x{0430}-\x{04FF}]/iu', '', '-АБВГД-' );
824 // Need to check for \p support too, as PCRE can be compiled
825 // with utf8 support, but not unicode property support.
826 // check that \p{Zs} (space separators) matches
827 // U+3000 (Ideographic space)
828 $regexprop = preg_replace( '/\p{Zs}/u', '', "-\xE3\x80\x80-" );
830 if ( $regexd != '--' ||
$regexprop != '--' ) {
831 $this->showError( 'config-pcre-no-utf8' );
840 * Environment check for available memory.
843 protected function envCheckMemory() {
844 $limit = ini_get( 'memory_limit' );
846 if ( !$limit ||
$limit == -1 ) {
850 $n = wfShorthandToInteger( $limit );
852 if ( $n < $this->minMemorySize
* 1024 * 1024 ) {
853 $newLimit = "{$this->minMemorySize}M";
855 if ( ini_set( "memory_limit", $newLimit ) === false ) {
856 $this->showMessage( 'config-memory-bad', $limit );
858 $this->showMessage( 'config-memory-raised', $limit, $newLimit );
859 $this->setVar( '_RaiseMemory', true );
867 * Environment check for compiled object cache types.
869 protected function envCheckCache() {
871 foreach ( $this->objectCaches
as $name => $function ) {
872 if ( function_exists( $function ) ) {
873 if ( $name == 'xcache' && !wfIniGetBool( 'xcache.var_size' ) ) {
876 $caches[$name] = true;
881 $this->showMessage( 'config-no-cache' );
884 $this->setVar( '_Caches', $caches );
888 * Scare user to death if they have mod_security
891 protected function envCheckModSecurity() {
892 if ( self
::apacheModulePresent( 'mod_security' ) ) {
893 $this->showMessage( 'config-mod-security' );
900 * Search for GNU diff3.
903 protected function envCheckDiff3() {
904 $names = array( "gdiff3", "diff3", "diff3.exe" );
905 $versionInfo = array( '$1 --version 2>&1', 'GNU diffutils' );
907 $diff3 = self
::locateExecutableInDefaultPaths( $names, $versionInfo );
910 $this->setVar( 'wgDiff3', $diff3 );
912 $this->setVar( 'wgDiff3', false );
913 $this->showMessage( 'config-diff3-bad' );
920 * Environment check for ImageMagick and GD.
923 protected function envCheckGraphics() {
924 $names = array( wfIsWindows() ?
'convert.exe' : 'convert' );
925 $versionInfo = array( '$1 -version', 'ImageMagick' );
926 $convert = self
::locateExecutableInDefaultPaths( $names, $versionInfo );
928 $this->setVar( 'wgImageMagickConvertCommand', '' );
930 $this->setVar( 'wgImageMagickConvertCommand', $convert );
931 $this->showMessage( 'config-imagemagick', $convert );
934 } elseif ( function_exists( 'imagejpeg' ) ) {
935 $this->showMessage( 'config-gd' );
937 $this->showMessage( 'config-no-scaling' );
949 protected function envCheckGit() {
950 $names = array( wfIsWindows() ?
'git.exe' : 'git' );
951 $versionInfo = array( '$1 --version', 'git version' );
953 $git = self
::locateExecutableInDefaultPaths( $names, $versionInfo );
956 $this->setVar( 'wgGitBin', $git );
957 $this->showMessage( 'config-git', $git );
959 $this->setVar( 'wgGitBin', false );
960 $this->showMessage( 'config-git-bad' );
967 * Environment check to inform user which server we've assumed.
971 protected function envCheckServer() {
972 $server = $this->envGetDefaultServer();
973 if ( $server !== null ) {
974 $this->showMessage( 'config-using-server', $server );
980 * Environment check to inform user which paths we've assumed.
984 protected function envCheckPath() {
987 $this->getVar( 'wgServer' ),
988 $this->getVar( 'wgScriptPath' )
994 * Environment check for preferred locale in shell
997 protected function envCheckShellLocale() {
998 $os = php_uname( 's' );
999 $supported = array( 'Linux', 'SunOS', 'HP-UX', 'Darwin' ); # Tested these
1001 if ( !in_array( $os, $supported ) ) {
1005 # Get a list of available locales.
1007 $lines = wfShellExec( '/usr/bin/locale -a', $ret );
1013 $lines = array_map( 'trim', explode( "\n", $lines ) );
1014 $candidatesByLocale = array();
1015 $candidatesByLang = array();
1017 foreach ( $lines as $line ) {
1018 if ( $line === '' ) {
1022 if ( !preg_match( '/^([a-zA-Z]+)(_[a-zA-Z]+|)\.(utf8|UTF-8)(@[a-zA-Z_]*|)$/i', $line, $m ) ) {
1026 list( , $lang, , , ) = $m;
1028 $candidatesByLocale[$m[0]] = $m;
1029 $candidatesByLang[$lang][] = $m;
1032 # Try the current value of LANG.
1033 if ( isset( $candidatesByLocale[getenv( 'LANG' )] ) ) {
1034 $this->setVar( 'wgShellLocale', getenv( 'LANG' ) );
1039 # Try the most common ones.
1040 $commonLocales = array( 'en_US.UTF-8', 'en_US.utf8', 'de_DE.UTF-8', 'de_DE.utf8' );
1041 foreach ( $commonLocales as $commonLocale ) {
1042 if ( isset( $candidatesByLocale[$commonLocale] ) ) {
1043 $this->setVar( 'wgShellLocale', $commonLocale );
1049 # Is there an available locale in the Wiki's language?
1050 $wikiLang = $this->getVar( 'wgLanguageCode' );
1052 if ( isset( $candidatesByLang[$wikiLang] ) ) {
1053 $m = reset( $candidatesByLang[$wikiLang] );
1054 $this->setVar( 'wgShellLocale', $m[0] );
1059 # Are there any at all?
1060 if ( count( $candidatesByLocale ) ) {
1061 $m = reset( $candidatesByLocale );
1062 $this->setVar( 'wgShellLocale', $m[0] );
1072 * Environment check for the permissions of the uploads directory
1075 protected function envCheckUploadsDirectory() {
1078 $dir = $IP . '/images/';
1079 $url = $this->getVar( 'wgServer' ) . $this->getVar( 'wgScriptPath' ) . '/images/';
1080 $safe = !$this->dirIsExecutable( $dir, $url );
1083 $this->showMessage( 'config-uploads-not-safe', $dir );
1090 * Checks if suhosin.get.max_value_length is set, and if so generate
1091 * a warning because it decreases ResourceLoader performance.
1094 protected function envCheckSuhosinMaxValueLength() {
1095 $maxValueLength = ini_get( 'suhosin.get.max_value_length' );
1096 if ( $maxValueLength > 0 && $maxValueLength < 1024 ) {
1097 // Only warn if the value is below the sane 1024
1098 $this->showMessage( 'config-suhosin-max-value-length', $maxValueLength );
1105 * Convert a hex string representing a Unicode code point to that code point.
1109 protected function unicodeChar( $c ) {
1113 } elseif ( $c <= 0x7FF ) {
1114 return chr( 0xC0 |
$c >> 6 ) . chr( 0x80 |
$c & 0x3F );
1115 } elseif ( $c <= 0xFFFF ) {
1116 return chr( 0xE0 |
$c >> 12 ) . chr( 0x80 |
$c >> 6 & 0x3F )
1117 . chr( 0x80 |
$c & 0x3F );
1118 } elseif ( $c <= 0x10FFFF ) {
1119 return chr( 0xF0 |
$c >> 18 ) . chr( 0x80 |
$c >> 12 & 0x3F )
1120 . chr( 0x80 |
$c >> 6 & 0x3F )
1121 . chr( 0x80 |
$c & 0x3F );
1128 * Check the libicu version
1130 protected function envCheckLibicu() {
1131 $utf8 = function_exists( 'utf8_normalize' );
1132 $intl = function_exists( 'normalizer_normalize' );
1135 * This needs to be updated something that the latest libicu
1136 * will properly normalize. This normalization was found at
1137 * http://www.unicode.org/versions/Unicode5.2.0/#Character_Additions
1138 * Note that we use the hex representation to create the code
1139 * points in order to avoid any Unicode-destroying during transit.
1141 $not_normal_c = $this->unicodeChar( "FA6C" );
1142 $normal_c = $this->unicodeChar( "242EE" );
1144 $useNormalizer = 'php';
1145 $needsUpdate = false;
1148 * We're going to prefer the pecl extension here unless
1149 * utf8_normalize is more up to date.
1152 $useNormalizer = 'utf8';
1153 $utf8 = utf8_normalize( $not_normal_c, UtfNormal
::UNORM_NFC
);
1154 if ( $utf8 !== $normal_c ) {
1155 $needsUpdate = true;
1159 $useNormalizer = 'intl';
1160 $intl = normalizer_normalize( $not_normal_c, Normalizer
::FORM_C
);
1161 if ( $intl !== $normal_c ) {
1162 $needsUpdate = true;
1166 // Uses messages 'config-unicode-using-php', 'config-unicode-using-utf8',
1167 // 'config-unicode-using-intl'
1168 if ( $useNormalizer === 'php' ) {
1169 $this->showMessage( 'config-unicode-pure-php-warning' );
1171 $this->showMessage( 'config-unicode-using-' . $useNormalizer );
1172 if ( $needsUpdate ) {
1173 $this->showMessage( 'config-unicode-update-warning' );
1181 protected function envCheckCtype() {
1182 if ( !function_exists( 'ctype_digit' ) ) {
1183 $this->showError( 'config-ctype' );
1194 protected function envCheckIconv() {
1195 if ( !function_exists( 'iconv' ) ) {
1196 $this->showError( 'config-iconv' );
1207 protected function envCheckJSON() {
1208 if ( !function_exists( 'json_decode' ) ) {
1209 $this->showError( 'config-json' );
1218 * Environment prep for the server hostname.
1220 protected function envPrepServer() {
1221 $server = $this->envGetDefaultServer();
1222 if ( $server !== null ) {
1223 $this->setVar( 'wgServer', $server );
1228 * Helper function to be called from envPrepServer()
1231 abstract protected function envGetDefaultServer();
1234 * Environment prep for setting the preferred PHP file extension.
1236 protected function envPrepExtension() {
1237 // @todo FIXME: Detect this properly
1238 if ( defined( 'MW_INSTALL_PHP5_EXT' ) ) {
1243 $this->setVar( 'wgScriptExtension', $ext );
1247 * Environment prep for setting $IP and $wgScriptPath.
1249 protected function envPrepPath() {
1251 $IP = dirname( dirname( __DIR__
) );
1252 $this->setVar( 'IP', $IP );
1256 * Get an array of likely places we can find executables. Check a bunch
1257 * of known Unix-like defaults, as well as the PATH environment variable
1258 * (which should maybe make it work for Windows?)
1262 protected static function getPossibleBinPaths() {
1264 array( '/usr/bin', '/usr/local/bin', '/opt/csw/bin',
1265 '/usr/gnu/bin', '/usr/sfw/bin', '/sw/bin', '/opt/local/bin' ),
1266 explode( PATH_SEPARATOR
, getenv( 'PATH' ) )
1271 * Search a path for any of the given executable names. Returns the
1272 * executable name if found. Also checks the version string returned
1273 * by each executable.
1275 * Used only by environment checks.
1277 * @param string $path Path to search
1278 * @param array $names Array of executable names
1279 * @param array|bool $versionInfo False or array with two members:
1280 * 0 => Command to run for version check, with $1 for the full executable name
1281 * 1 => String to compare the output with
1283 * If $versionInfo is not false, only executables with a version
1284 * matching $versionInfo[1] will be returned.
1285 * @return bool|string
1287 public static function locateExecutable( $path, $names, $versionInfo = false ) {
1288 if ( !is_array( $names ) ) {
1289 $names = array( $names );
1292 foreach ( $names as $name ) {
1293 $command = $path . DIRECTORY_SEPARATOR
. $name;
1295 wfSuppressWarnings();
1296 $file_exists = file_exists( $command );
1297 wfRestoreWarnings();
1299 if ( $file_exists ) {
1300 if ( !$versionInfo ) {
1304 $file = str_replace( '$1', wfEscapeShellArg( $command ), $versionInfo[0] );
1305 if ( strstr( wfShellExec( $file ), $versionInfo[1] ) !== false ) {
1315 * Same as locateExecutable(), but checks in getPossibleBinPaths() by default
1316 * @see locateExecutable()
1317 * @param array $names Array of possible names.
1318 * @param array|bool $versionInfo Default: false or array with two members:
1319 * 0 => Command to run for version check, with $1 for the full executable name
1320 * 1 => String to compare the output with
1322 * If $versionInfo is not false, only executables with a version
1323 * matching $versionInfo[1] will be returned.
1324 * @return bool|string
1326 public static function locateExecutableInDefaultPaths( $names, $versionInfo = false ) {
1327 foreach ( self
::getPossibleBinPaths() as $path ) {
1328 $exe = self
::locateExecutable( $path, $names, $versionInfo );
1329 if ( $exe !== false ) {
1338 * Checks if scripts located in the given directory can be executed via the given URL.
1340 * Used only by environment checks.
1341 * @param string $dir
1342 * @param string $url
1343 * @return bool|int|string
1345 public function dirIsExecutable( $dir, $url ) {
1346 $scriptTypes = array(
1348 "<?php echo 'ex' . 'ec';",
1349 "#!/var/env php5\n<?php echo 'ex' . 'ec';",
1353 // it would be good to check other popular languages here, but it'll be slow.
1355 wfSuppressWarnings();
1357 foreach ( $scriptTypes as $ext => $contents ) {
1358 foreach ( $contents as $source ) {
1359 $file = 'exectest.' . $ext;
1361 if ( !file_put_contents( $dir . $file, $source ) ) {
1366 $text = Http
::get( $url . $file, array( 'timeout' => 3 ) );
1367 } catch ( MWException
$e ) {
1368 // Http::get throws with allow_url_fopen = false and no curl extension.
1371 unlink( $dir . $file );
1373 if ( $text == 'exec' ) {
1374 wfRestoreWarnings();
1381 wfRestoreWarnings();
1387 * Checks for presence of an Apache module. Works only if PHP is running as an Apache module, too.
1389 * @param string $moduleName Name of module to check.
1392 public static function apacheModulePresent( $moduleName ) {
1393 if ( function_exists( 'apache_get_modules' ) && in_array( $moduleName, apache_get_modules() ) ) {
1396 // try it the hard way
1398 phpinfo( INFO_MODULES
);
1399 $info = ob_get_clean();
1401 return strpos( $info, $moduleName ) !== false;
1405 * ParserOptions are constructed before we determined the language, so fix it
1407 * @param Language $lang
1409 public function setParserLanguage( $lang ) {
1410 $this->parserOptions
->setTargetLanguage( $lang );
1411 $this->parserOptions
->setUserLang( $lang );
1415 * Overridden by WebInstaller to provide lastPage parameters.
1416 * @param string $page
1419 protected function getDocUrl( $page ) {
1420 return "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1424 * Finds extensions that follow the format /$directory/Name/Name.php,
1425 * and returns an array containing the value for 'Name' for each found extension.
1427 * Reasonable values for $directory include 'extensions' (the default) and 'skins'.
1429 * @param string $directory Directory to search in
1432 public function findExtensions( $directory = 'extensions' ) {
1433 if ( $this->getVar( 'IP' ) === null ) {
1437 $extDir = $this->getVar( 'IP' ) . '/' . $directory;
1438 if ( !is_readable( $extDir ) ||
!is_dir( $extDir ) ) {
1442 $dh = opendir( $extDir );
1444 while ( ( $file = readdir( $dh ) ) !== false ) {
1445 if ( !is_dir( "$extDir/$file" ) ) {
1448 if ( file_exists( "$extDir/$file/$file.php" ) ) {
1453 natcasesort( $exts );
1459 * Installs the auto-detected extensions.
1463 protected function includeExtensions() {
1465 $exts = $this->getVar( '_Extensions' );
1466 $IP = $this->getVar( 'IP' );
1469 * We need to include DefaultSettings before including extensions to avoid
1470 * warnings about unset variables. However, the only thing we really
1471 * want here is $wgHooks['LoadExtensionSchemaUpdates']. This won't work
1472 * if the extension has hidden hook registration in $wgExtensionFunctions,
1473 * but we're not opening that can of worms
1474 * @see https://bugzilla.wikimedia.org/show_bug.cgi?id=26857
1476 global $wgAutoloadClasses;
1477 $wgAutoloadClasses = array();
1479 require "$IP/includes/DefaultSettings.php";
1481 foreach ( $exts as $e ) {
1482 require_once "$IP/extensions/$e/$e.php";
1485 $hooksWeWant = isset( $wgHooks['LoadExtensionSchemaUpdates'] ) ?
1486 $wgHooks['LoadExtensionSchemaUpdates'] : array();
1488 // Unset everyone else's hooks. Lord knows what someone might be doing
1489 // in ParserFirstCallInit (see bug 27171)
1490 $GLOBALS['wgHooks'] = array( 'LoadExtensionSchemaUpdates' => $hooksWeWant );
1492 return Status
::newGood();
1496 * Get an array of install steps. Should always be in the format of
1498 * 'name' => 'someuniquename',
1499 * 'callback' => array( $obj, 'method' ),
1501 * There must be a config-install-$name message defined per step, which will
1502 * be shown on install.
1504 * @param DatabaseInstaller $installer DatabaseInstaller so we can make callbacks
1507 protected function getInstallSteps( DatabaseInstaller
$installer ) {
1508 $coreInstallSteps = array(
1509 array( 'name' => 'database', 'callback' => array( $installer, 'setupDatabase' ) ),
1510 array( 'name' => 'tables', 'callback' => array( $installer, 'createTables' ) ),
1511 array( 'name' => 'interwiki', 'callback' => array( $installer, 'populateInterwikiTable' ) ),
1512 array( 'name' => 'stats', 'callback' => array( $this, 'populateSiteStats' ) ),
1513 array( 'name' => 'keys', 'callback' => array( $this, 'generateKeys' ) ),
1514 array( 'name' => 'sysop', 'callback' => array( $this, 'createSysop' ) ),
1515 array( 'name' => 'mainpage', 'callback' => array( $this, 'createMainpage' ) ),
1518 // Build the array of install steps starting from the core install list,
1519 // then adding any callbacks that wanted to attach after a given step
1520 foreach ( $coreInstallSteps as $step ) {
1521 $this->installSteps
[] = $step;
1522 if ( isset( $this->extraInstallSteps
[$step['name']] ) ) {
1523 $this->installSteps
= array_merge(
1524 $this->installSteps
,
1525 $this->extraInstallSteps
[$step['name']]
1530 // Prepend any steps that want to be at the beginning
1531 if ( isset( $this->extraInstallSteps
['BEGINNING'] ) ) {
1532 $this->installSteps
= array_merge(
1533 $this->extraInstallSteps
['BEGINNING'],
1538 // Extensions should always go first, chance to tie into hooks and such
1539 if ( count( $this->getVar( '_Extensions' ) ) ) {
1540 array_unshift( $this->installSteps
,
1541 array( 'name' => 'extensions', 'callback' => array( $this, 'includeExtensions' ) )
1543 $this->installSteps
[] = array(
1544 'name' => 'extension-tables',
1545 'callback' => array( $installer, 'createExtensionTables' )
1549 return $this->installSteps
;
1553 * Actually perform the installation.
1555 * @param callable $startCB A callback array for the beginning of each step
1556 * @param callable $endCB A callback array for the end of each step
1558 * @return array Array of Status objects
1560 public function performInstallation( $startCB, $endCB ) {
1561 $installResults = array();
1562 $installer = $this->getDBInstaller();
1563 $installer->preInstall();
1564 $steps = $this->getInstallSteps( $installer );
1565 foreach ( $steps as $stepObj ) {
1566 $name = $stepObj['name'];
1567 call_user_func_array( $startCB, array( $name ) );
1569 // Perform the callback step
1570 $status = call_user_func( $stepObj['callback'], $installer );
1572 // Output and save the results
1573 call_user_func( $endCB, $name, $status );
1574 $installResults[$name] = $status;
1576 // If we've hit some sort of fatal, we need to bail.
1577 // Callback already had a chance to do output above.
1578 if ( !$status->isOk() ) {
1582 if ( $status->isOk() ) {
1583 $this->setVar( '_InstallDone', true );
1586 return $installResults;
1590 * Generate $wgSecretKey. Will warn if we had to use an insecure random source.
1594 public function generateKeys() {
1595 $keys = array( 'wgSecretKey' => 64 );
1596 if ( strval( $this->getVar( 'wgUpgradeKey' ) ) === '' ) {
1597 $keys['wgUpgradeKey'] = 16;
1600 return $this->doGenerateKeys( $keys );
1604 * Generate a secret value for variables using our CryptRand generator.
1605 * Produce a warning if the random source was insecure.
1607 * @param array $keys
1610 protected function doGenerateKeys( $keys ) {
1611 $status = Status
::newGood();
1614 foreach ( $keys as $name => $length ) {
1615 $secretKey = MWCryptRand
::generateHex( $length, true );
1616 if ( !MWCryptRand
::wasStrong() ) {
1620 $this->setVar( $name, $secretKey );
1624 $names = array_keys( $keys );
1625 $names = preg_replace( '/^(.*)$/', '\$$1', $names );
1627 $status->warning( 'config-insecure-keys', $wgLang->listToText( $names ), count( $names ) );
1634 * Create the first user account, grant it sysop and bureaucrat rights
1638 protected function createSysop() {
1639 $name = $this->getVar( '_AdminName' );
1640 $user = User
::newFromName( $name );
1643 // We should've validated this earlier anyway!
1644 return Status
::newFatal( 'config-admin-error-user', $name );
1647 if ( $user->idForName() == 0 ) {
1648 $user->addToDatabase();
1651 $user->setPassword( $this->getVar( '_AdminPassword' ) );
1652 } catch ( PasswordError
$pwe ) {
1653 return Status
::newFatal( 'config-admin-error-password', $name, $pwe->getMessage() );
1656 $user->addGroup( 'sysop' );
1657 $user->addGroup( 'bureaucrat' );
1658 if ( $this->getVar( '_AdminEmail' ) ) {
1659 $user->setEmail( $this->getVar( '_AdminEmail' ) );
1661 $user->saveSettings();
1663 // Update user count
1664 $ssUpdate = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
1665 $ssUpdate->doUpdate();
1667 $status = Status
::newGood();
1669 if ( $this->getVar( '_Subscribe' ) && $this->getVar( '_AdminEmail' ) ) {
1670 $this->subscribeToMediaWikiAnnounce( $status );
1679 private function subscribeToMediaWikiAnnounce( Status
$s ) {
1681 'email' => $this->getVar( '_AdminEmail' ),
1686 // Mailman doesn't support as many languages as we do, so check to make
1687 // sure their selected language is available
1688 $myLang = $this->getVar( '_UserLang' );
1689 if ( in_array( $myLang, $this->mediaWikiAnnounceLanguages
) ) {
1690 $myLang = $myLang == 'pt-br' ?
'pt_BR' : $myLang; // rewrite to Mailman's pt_BR
1691 $params['language'] = $myLang;
1694 if ( MWHttpRequest
::canMakeRequests() ) {
1695 $res = MWHttpRequest
::factory( $this->mediaWikiAnnounceUrl
,
1696 array( 'method' => 'POST', 'postData' => $params ) )->execute();
1697 if ( !$res->isOK() ) {
1698 $s->warning( 'config-install-subscribe-fail', $res->getMessage() );
1701 $s->warning( 'config-install-subscribe-notpossible' );
1706 * Insert Main Page with default content.
1708 * @param DatabaseInstaller $installer
1711 protected function createMainpage( DatabaseInstaller
$installer ) {
1712 $status = Status
::newGood();
1714 $page = WikiPage
::factory( Title
::newMainPage() );
1715 $content = new WikitextContent(
1716 wfMessage( 'mainpagetext' )->inContentLanguage()->text() . "\n\n" .
1717 wfMessage( 'mainpagedocfooter' )->inContentLanguage()->text()
1720 $page->doEditContent( $content,
1724 User
::newFromName( 'MediaWiki default' )
1726 } catch ( MWException
$e ) {
1727 //using raw, because $wgShowExceptionDetails can not be set yet
1728 $status->fatal( 'config-install-mainpage-failed', $e->getMessage() );
1735 * Override the necessary bits of the config to run an installation.
1737 public static function overrideConfig() {
1738 define( 'MW_NO_SESSION', 1 );
1740 // Don't access the database
1741 $GLOBALS['wgUseDatabaseMessages'] = false;
1742 // Don't cache langconv tables
1743 $GLOBALS['wgLanguageConverterCacheType'] = CACHE_NONE
;
1745 $GLOBALS['wgShowExceptionDetails'] = true;
1746 // Don't break forms
1747 $GLOBALS['wgExternalLinkTarget'] = '_blank';
1749 // Extended debugging
1750 $GLOBALS['wgShowSQLErrors'] = true;
1751 $GLOBALS['wgShowDBErrorBacktrace'] = true;
1753 // Allow multiple ob_flush() calls
1754 $GLOBALS['wgDisableOutputCompression'] = true;
1756 // Use a sensible cookie prefix (not my_wiki)
1757 $GLOBALS['wgCookiePrefix'] = 'mw_installer';
1759 // Some of the environment checks make shell requests, remove limits
1760 $GLOBALS['wgMaxShellMemory'] = 0;
1762 // Don't bother embedding images into generated CSS, which is not cached
1763 $GLOBALS['wgResourceLoaderLESSFunctions']['embeddable'] = function ( $frame, $less ) {
1764 return $less->toBool( false );
1769 * Add an installation step following the given step.
1771 * @param callable $callback A valid installation callback array, in this form:
1772 * array( 'name' => 'some-unique-name', 'callback' => array( $obj, 'function' ) );
1773 * @param string $findStep The step to find. Omit to put the step at the beginning
1775 public function addInstallStep( $callback, $findStep = 'BEGINNING' ) {
1776 $this->extraInstallSteps
[$findStep][] = $callback;
1780 * Disable the time limit for execution.
1781 * Some long-running pages (Install, Upgrade) will want to do this
1783 protected function disableTimeLimit() {
1784 wfSuppressWarnings();
1785 set_time_limit( 0 );
1786 wfRestoreWarnings();