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
{
41 // This is the absolute minimum PHP version we can support
42 const MINIMUM_PHP_VERSION
= '5.3.2';
50 * Cached DB installer instances, access using getDBInstaller().
54 protected $dbInstallers = array();
57 * Minimum memory size in MB.
61 protected $minMemorySize = 50;
64 * Cached Title, used by parse().
68 protected $parserTitle;
71 * Cached ParserOptions, used by parse().
75 protected $parserOptions;
78 * Known database types. These correspond to the class names <type>Installer,
79 * and are also MediaWiki database types valid for $wgDBtype.
81 * To add a new type, create a <type>Installer class and a Database<type>
82 * class, and add a config-type-<type> message to MessagesEn.php.
86 protected static $dbTypes = array(
95 * A list of environment check methods called by doEnvironmentChecks().
96 * These may output warnings using showMessage(), and/or abort the
97 * installation process by returning false.
101 protected $envChecks = array(
103 'envCheckRegisterGlobals',
106 'envCheckMagicQuotes',
107 'envCheckMagicSybase',
115 'envCheckModSecurity',
121 'envCheckShellLocale',
122 'envCheckUploadsDirectory',
124 'envCheckSuhosinMaxValueLength',
129 * MediaWiki configuration globals that will eventually be passed through
130 * to LocalSettings.php. The names only are given here, the defaults
131 * typically come from DefaultSettings.php.
135 protected $defaultVarNames = array(
147 'wgEmailAuthentication',
150 'wgImageMagickConvertCommand',
156 'wgDeletedDirectory',
161 'wgUseInstantCommons',
164 'wgResourceLoaderMaxQueryLength',
168 * Variables that are stored alongside globals, and are used for any
169 * configuration of the installation process aside from the MediaWiki
170 * configuration. Map of names to defaults.
174 protected $internalDefaults = array(
176 '_Environment' => false,
177 '_CompiledDBs' => array(),
178 '_SafeMode' => false,
179 '_RaiseMemory' => false,
180 '_UpgradeDone' => false,
181 '_InstallDone' => false,
182 '_Caches' => array(),
183 '_InstallPassword' => '',
184 '_SameAccount' => true,
185 '_CreateDBAccount' => false,
186 '_NamespaceType' => 'site-name',
187 '_AdminName' => '', // will be set later, when the user selects language
188 '_AdminPassword' => '',
189 '_AdminPassword2' => '',
191 '_Subscribe' => false,
192 '_SkipOptional' => 'continue',
193 '_RightsProfile' => 'wiki',
194 '_LicenseCode' => 'none',
196 '_Extensions' => array(),
197 '_MemCachedServers' => '',
198 '_UpgradeKeySupplied' => false,
199 '_ExistingDBSettings' => false,
203 * The actual list of installation steps. This will be initialized by getInstallSteps()
207 private $installSteps = array();
210 * Extra steps for installation, for things like DatabaseInstallers to modify
214 protected $extraInstallSteps = array();
217 * Known object cache types and the functions used to test for their existence.
221 protected $objectCaches = array(
222 'xcache' => 'xcache_get',
223 'apc' => 'apc_fetch',
224 'wincache' => 'wincache_ucache_get'
228 * User rights profiles.
232 public $rightsProfiles = array(
235 '*' => array( 'edit' => false )
239 'createaccount' => false,
245 'createaccount' => false,
257 public $licenses = array(
259 'url' => 'http://creativecommons.org/licenses/by/3.0/',
260 'icon' => '{$wgStylePath}/common/images/cc-by.png',
263 'url' => 'http://creativecommons.org/licenses/by-sa/3.0/',
264 'icon' => '{$wgStylePath}/common/images/cc-by-sa.png',
266 'cc-by-nc-sa' => array(
267 'url' => 'http://creativecommons.org/licenses/by-nc-sa/3.0/',
268 'icon' => '{$wgStylePath}/common/images/cc-by-nc-sa.png',
271 'url' => 'https://creativecommons.org/publicdomain/zero/1.0/',
272 'icon' => '{$wgStylePath}/common/images/cc-0.png',
276 'icon' => '{$wgStylePath}/common/images/public-domain.png',
279 'url' => 'http://www.gnu.org/copyleft/fdl.html',
280 'icon' => '{$wgStylePath}/common/images/gnu-fdl.png',
287 'cc-choose' => array(
288 // Details will be filled in by the selector.
296 * URL to mediawiki-announce subscription
298 protected $mediaWikiAnnounceUrl = 'https://lists.wikimedia.org/mailman/subscribe/mediawiki-announce';
301 * Supported language codes for Mailman
303 protected $mediaWikiAnnounceLanguages = array(
304 'ca', 'cs', 'da', 'de', 'en', 'es', 'et', 'eu', 'fi', 'fr', 'hr', 'hu',
305 'it', 'ja', 'ko', 'lt', 'nl', 'no', 'pl', 'pt', 'pt-br', 'ro', 'ru',
306 'sl', 'sr', 'sv', 'tr', 'uk'
310 * UI interface for displaying a short message
311 * The parameters are like parameters to wfMessage().
312 * The messages will be in wikitext format, which will be converted to an
313 * output format such as HTML or text before being sent to the user.
316 public abstract function showMessage( $msg /*, ... */ );
319 * Same as showMessage(), but for displaying errors
322 public abstract function showError( $msg /*, ... */ );
325 * Show a message to the installing user by using a Status object
326 * @param $status Status
328 public abstract function showStatusMessage( Status
$status );
331 * Constructor, always call this from child classes.
333 public function __construct() {
334 global $wgExtensionMessagesFiles, $wgUser;
336 // Disable the i18n cache and LoadBalancer
337 Language
::getLocalisationCache()->disableBackend();
338 LBFactory
::disableBackend();
340 // Load the installer's i18n file.
341 $wgExtensionMessagesFiles['MediawikiInstaller'] =
342 __DIR__
. '/Installer.i18n.php';
344 // Having a user with id = 0 safeguards us from DB access via User::loadOptions().
345 $wgUser = User
::newFromId( 0 );
347 $this->settings
= $this->internalDefaults
;
349 foreach ( $this->defaultVarNames
as $var ) {
350 $this->settings
[$var] = $GLOBALS[$var];
353 $compiledDBs = array();
354 foreach ( self
::getDBTypes() as $type ) {
355 $installer = $this->getDBInstaller( $type );
357 if ( !$installer->isCompiled() ) {
360 $compiledDBs[] = $type;
362 $defaults = $installer->getGlobalDefaults();
364 foreach ( $installer->getGlobalNames() as $var ) {
365 if ( isset( $defaults[$var] ) ) {
366 $this->settings
[$var] = $defaults[$var];
368 $this->settings
[$var] = $GLOBALS[$var];
372 $this->setVar( '_CompiledDBs', $compiledDBs );
374 $this->parserTitle
= Title
::newFromText( 'Installer' );
375 $this->parserOptions
= new ParserOptions
; // language will be wrong :(
376 $this->parserOptions
->setEditSection( false );
380 * Get a list of known DB types.
384 public static function getDBTypes() {
385 return self
::$dbTypes;
389 * Do initial checks of the PHP environment. Set variables according to
390 * the observed environment.
392 * It's possible that this may be called under the CLI SAPI, not the SAPI
393 * that the wiki will primarily run under. In that case, the subclass should
394 * initialise variables such as wgScriptPath, before calling this function.
396 * Under the web subclass, it can already be assumed that PHP 5+ is in use
397 * and that sessions are working.
401 public function doEnvironmentChecks() {
402 $phpVersion = phpversion();
403 if( version_compare( $phpVersion, self
::MINIMUM_PHP_VERSION
, '>=' ) ) {
404 $this->showMessage( 'config-env-php', $phpVersion );
407 $this->showMessage( 'config-env-php-toolow', $phpVersion, self
::MINIMUM_PHP_VERSION
);
412 foreach ( $this->envChecks
as $check ) {
413 $status = $this->$check();
414 if ( $status === false ) {
420 $this->setVar( '_Environment', $good );
422 return $good ? Status
::newGood() : Status
::newFatal( 'config-env-bad' );
426 * Set a MW configuration variable, or internal installer configuration variable.
428 * @param $name String
429 * @param $value Mixed
431 public function setVar( $name, $value ) {
432 $this->settings
[$name] = $value;
436 * Get an MW configuration variable, or internal installer configuration variable.
437 * The defaults come from $GLOBALS (ultimately DefaultSettings.php).
438 * Installer variables are typically prefixed by an underscore.
440 * @param $name String
441 * @param $default Mixed
445 public function getVar( $name, $default = null ) {
446 if ( !isset( $this->settings
[$name] ) ) {
449 return $this->settings
[$name];
454 * Get an instance of DatabaseInstaller for the specified DB type.
456 * @param $type Mixed: DB installer for which is needed, false to use default.
458 * @return DatabaseInstaller
460 public function getDBInstaller( $type = false ) {
462 $type = $this->getVar( 'wgDBtype' );
465 $type = strtolower( $type );
467 if ( !isset( $this->dbInstallers
[$type] ) ) {
468 $class = ucfirst( $type ). 'Installer';
469 $this->dbInstallers
[$type] = new $class( $this );
472 return $this->dbInstallers
[$type];
476 * Determine if LocalSettings.php exists. If it does, return its variables,
477 * merged with those from AdminSettings.php, as an array.
481 public static function getExistingLocalSettings() {
484 wfSuppressWarnings();
485 $_lsExists = file_exists( "$IP/LocalSettings.php" );
493 require( "$IP/includes/DefaultSettings.php" );
494 require( "$IP/LocalSettings.php" );
495 if ( file_exists( "$IP/AdminSettings.php" ) ) {
496 require( "$IP/AdminSettings.php" );
498 return get_defined_vars();
502 * Get a fake password for sending back to the user in HTML.
503 * This is a security mechanism to avoid compromise of the password in the
504 * event of session ID compromise.
506 * @param $realPassword String
510 public function getFakePassword( $realPassword ) {
511 return str_repeat( '*', strlen( $realPassword ) );
515 * Set a variable which stores a password, except if the new value is a
516 * fake password in which case leave it as it is.
518 * @param $name String
519 * @param $value Mixed
521 public function setPassword( $name, $value ) {
522 if ( !preg_match( '/^\*+$/', $value ) ) {
523 $this->setVar( $name, $value );
528 * On POSIX systems return the primary group of the webserver we're running under.
529 * On other systems just returns null.
531 * This is used to advice the user that he should chgrp his mw-config/data/images directory as the
532 * webserver user before he can install.
534 * Public because SqliteInstaller needs it, and doesn't subclass Installer.
538 public static function maybeGetWebserverPrimaryGroup() {
539 if ( !function_exists( 'posix_getegid' ) ||
!function_exists( 'posix_getpwuid' ) ) {
540 # I don't know this, this isn't UNIX.
544 # posix_getegid() *not* getmygid() because we want the group of the webserver,
545 # not whoever owns the current script.
546 $gid = posix_getegid();
547 $getpwuid = posix_getpwuid( $gid );
548 $group = $getpwuid['name'];
554 * Convert wikitext $text to HTML.
556 * This is potentially error prone since many parser features require a complete
557 * installed MW database. The solution is to just not use those features when you
558 * write your messages. This appears to work well enough. Basic formatting and
559 * external links work just fine.
561 * But in case a translator decides to throw in a "#ifexist" or internal link or
562 * whatever, this function is guarded to catch the attempted DB access and to present
563 * some fallback text.
565 * @param $text String
566 * @param $lineStart Boolean
569 public function parse( $text, $lineStart = false ) {
573 $out = $wgParser->parse( $text, $this->parserTitle
, $this->parserOptions
, $lineStart );
574 $html = $out->getText();
575 } catch ( DBAccessError
$e ) {
576 $html = '<!--DB access attempted during parse--> ' . htmlspecialchars( $text );
578 if ( !empty( $this->debug
) ) {
579 $html .= "<!--\n" . $e->getTraceAsString() . "\n-->";
587 * @return ParserOptions
589 public function getParserOptions() {
590 return $this->parserOptions
;
593 public function disableLinkPopups() {
594 $this->parserOptions
->setExternalLinkTarget( false );
597 public function restoreLinkPopups() {
598 global $wgExternalLinkTarget;
599 $this->parserOptions
->setExternalLinkTarget( $wgExternalLinkTarget );
603 * Install step which adds a row to the site_stats table with appropriate
606 * @param $installer DatabaseInstaller
610 public function populateSiteStats( DatabaseInstaller
$installer ) {
611 $status = $installer->getConnection();
612 if ( !$status->isOK() ) {
615 $status->value
->insert( 'site_stats', array(
617 'ss_total_views' => 0,
618 'ss_total_edits' => 0,
619 'ss_good_articles' => 0,
620 'ss_total_pages' => 0,
623 __METHOD__
, 'IGNORE' );
624 return Status
::newGood();
628 * Exports all wg* variables stored by the installer into global scope.
630 public function exportVars() {
631 foreach ( $this->settings
as $name => $value ) {
632 if ( substr( $name, 0, 2 ) == 'wg' ) {
633 $GLOBALS[$name] = $value;
639 * Environment check for DB types.
642 protected function envCheckDB() {
647 foreach ( self
::getDBTypes() as $name ) {
648 $allNames[] = wfMessage( "config-type-$name" )->text();
651 // cache initially available databases to make sure that everything will be displayed correctly
652 // after a refresh on env checks page
653 $databases = $this->getVar( '_CompiledDBs-preFilter' );
655 $databases = $this->getVar( '_CompiledDBs' );
656 $this->setVar( '_CompiledDBs-preFilter', $databases );
659 $databases = array_flip ( $databases );
660 foreach ( array_keys( $databases ) as $db ) {
661 $installer = $this->getDBInstaller( $db );
662 $status = $installer->checkPrerequisites();
663 if ( !$status->isGood() ) {
664 $this->showStatusMessage( $status );
666 if ( !$status->isOK() ) {
667 unset( $databases[$db] );
670 $databases = array_flip( $databases );
672 $this->showError( 'config-no-db', $wgLang->commaList( $allNames ) );
673 // @todo FIXME: This only works for the web installer!
676 $this->setVar( '_CompiledDBs', $databases );
681 * Environment check for register_globals.
683 protected function envCheckRegisterGlobals() {
684 if( wfIniGetBool( 'register_globals' ) ) {
685 $this->showMessage( 'config-register-globals' );
690 * Some versions of libxml+PHP break < and > encoding horribly
693 protected function envCheckBrokenXML() {
694 $test = new PhpXmlBugTester();
696 $this->showError( 'config-brokenlibxml' );
703 * Test PHP (probably 5.3.1, but it could regress again) to make sure that
704 * reference parameters to __call() are not converted to null
707 protected function envCheckPHP531() {
708 $test = new PhpRefCallBugTester
;
711 $this->showError( 'config-using531', phpversion() );
718 * Environment check for magic_quotes_runtime.
721 protected function envCheckMagicQuotes() {
722 if( wfIniGetBool( "magic_quotes_runtime" ) ) {
723 $this->showError( 'config-magic-quotes-runtime' );
730 * Environment check for magic_quotes_sybase.
733 protected function envCheckMagicSybase() {
734 if ( wfIniGetBool( 'magic_quotes_sybase' ) ) {
735 $this->showError( 'config-magic-quotes-sybase' );
742 * Environment check for mbstring.func_overload.
745 protected function envCheckMbstring() {
746 if ( wfIniGetBool( 'mbstring.func_overload' ) ) {
747 $this->showError( 'config-mbstring' );
754 * Environment check for zend.ze1_compatibility_mode.
757 protected function envCheckZE1() {
758 if ( wfIniGetBool( 'zend.ze1_compatibility_mode' ) ) {
759 $this->showError( 'config-ze1' );
766 * Environment check for safe_mode.
769 protected function envCheckSafeMode() {
770 if ( wfIniGetBool( 'safe_mode' ) ) {
771 $this->setVar( '_SafeMode', true );
772 $this->showMessage( 'config-safe-mode' );
778 * Environment check for the XML module.
781 protected function envCheckXML() {
782 if ( !function_exists( "utf8_encode" ) ) {
783 $this->showError( 'config-xml-bad' );
790 * Environment check for the PCRE module.
792 * @note If this check were to fail, the parser would
793 * probably throw an exception before the result
794 * of this check is shown to the user.
797 protected function envCheckPCRE() {
798 if ( !function_exists( 'preg_match' ) ) {
799 $this->showError( 'config-pcre' );
802 wfSuppressWarnings();
803 $regexd = preg_replace( '/[\x{0430}-\x{04FF}]/iu', '', '-АБВГД-' );
804 // Need to check for \p support too, as PCRE can be compiled
805 // with utf8 support, but not unicode property support.
806 // check that \p{Zs} (space separators) matches
807 // U+3000 (Ideographic space)
808 $regexprop = preg_replace( '/\p{Zs}/u', '', "-\xE3\x80\x80-" );
810 if ( $regexd != '--' ||
$regexprop != '--' ) {
811 $this->showError( 'config-pcre-no-utf8' );
818 * Environment check for available memory.
821 protected function envCheckMemory() {
822 $limit = ini_get( 'memory_limit' );
824 if ( !$limit ||
$limit == -1 ) {
828 $n = wfShorthandToInteger( $limit );
830 if( $n < $this->minMemorySize
* 1024 * 1024 ) {
831 $newLimit = "{$this->minMemorySize}M";
833 if( ini_set( "memory_limit", $newLimit ) === false ) {
834 $this->showMessage( 'config-memory-bad', $limit );
836 $this->showMessage( 'config-memory-raised', $limit, $newLimit );
837 $this->setVar( '_RaiseMemory', true );
844 * Environment check for compiled object cache types.
846 protected function envCheckCache() {
848 foreach ( $this->objectCaches
as $name => $function ) {
849 if ( function_exists( $function ) ) {
850 if ( $name == 'xcache' && !wfIniGetBool( 'xcache.var_size' ) ) {
853 $caches[$name] = true;
858 $this->showMessage( 'config-no-cache' );
861 $this->setVar( '_Caches', $caches );
865 * Scare user to death if they have mod_security
868 protected function envCheckModSecurity() {
869 if ( self
::apacheModulePresent( 'mod_security' ) ) {
870 $this->showMessage( 'config-mod-security' );
876 * Search for GNU diff3.
879 protected function envCheckDiff3() {
880 $names = array( "gdiff3", "diff3", "diff3.exe" );
881 $versionInfo = array( '$1 --version 2>&1', 'GNU diffutils' );
883 $diff3 = self
::locateExecutableInDefaultPaths( $names, $versionInfo );
886 $this->setVar( 'wgDiff3', $diff3 );
888 $this->setVar( 'wgDiff3', false );
889 $this->showMessage( 'config-diff3-bad' );
895 * Environment check for ImageMagick and GD.
898 protected function envCheckGraphics() {
899 $names = array( wfIsWindows() ?
'convert.exe' : 'convert' );
900 $convert = self
::locateExecutableInDefaultPaths( $names, array( '$1 -version', 'ImageMagick' ) );
902 $this->setVar( 'wgImageMagickConvertCommand', '' );
904 $this->setVar( 'wgImageMagickConvertCommand', $convert );
905 $this->showMessage( 'config-imagemagick', $convert );
907 } elseif ( function_exists( 'imagejpeg' ) ) {
908 $this->showMessage( 'config-gd' );
911 $this->showMessage( 'config-no-scaling' );
917 * Environment check for the server hostname.
919 protected function envCheckServer() {
920 $server = $this->envGetDefaultServer();
921 $this->showMessage( 'config-using-server', $server );
922 $this->setVar( 'wgServer', $server );
927 * Helper function to be called from envCheckServer()
930 protected abstract function envGetDefaultServer();
933 * Environment check for setting $IP and $wgScriptPath.
936 protected function envCheckPath() {
938 $IP = dirname( dirname( __DIR__
) );
939 $this->setVar( 'IP', $IP );
941 $this->showMessage( 'config-using-uri', $this->getVar( 'wgServer' ), $this->getVar( 'wgScriptPath' ) );
946 * Environment check for setting the preferred PHP file extension.
948 protected function envCheckExtension() {
949 // @todo FIXME: Detect this properly
950 if ( defined( 'MW_INSTALL_PHP5_EXT' ) ) {
955 $this->setVar( 'wgScriptExtension', ".$ext" );
963 protected function envCheckShellLocale() {
964 $os = php_uname( 's' );
965 $supported = array( 'Linux', 'SunOS', 'HP-UX', 'Darwin' ); # Tested these
967 if ( !in_array( $os, $supported ) ) {
971 # Get a list of available locales.
973 $lines = wfShellExec( '/usr/bin/locale -a', $ret );
979 $lines = wfArrayMap( 'trim', explode( "\n", $lines ) );
980 $candidatesByLocale = array();
981 $candidatesByLang = array();
983 foreach ( $lines as $line ) {
984 if ( $line === '' ) {
988 if ( !preg_match( '/^([a-zA-Z]+)(_[a-zA-Z]+|)\.(utf8|UTF-8)(@[a-zA-Z_]*|)$/i', $line, $m ) ) {
992 list( $all, $lang, $territory, $charset, $modifier ) = $m;
994 $candidatesByLocale[$m[0]] = $m;
995 $candidatesByLang[$lang][] = $m;
998 # Try the current value of LANG.
999 if ( isset( $candidatesByLocale[ getenv( 'LANG' ) ] ) ) {
1000 $this->setVar( 'wgShellLocale', getenv( 'LANG' ) );
1004 # Try the most common ones.
1005 $commonLocales = array( 'en_US.UTF-8', 'en_US.utf8', 'de_DE.UTF-8', 'de_DE.utf8' );
1006 foreach ( $commonLocales as $commonLocale ) {
1007 if ( isset( $candidatesByLocale[$commonLocale] ) ) {
1008 $this->setVar( 'wgShellLocale', $commonLocale );
1013 # Is there an available locale in the Wiki's language?
1014 $wikiLang = $this->getVar( 'wgLanguageCode' );
1016 if ( isset( $candidatesByLang[$wikiLang] ) ) {
1017 $m = reset( $candidatesByLang[$wikiLang] );
1018 $this->setVar( 'wgShellLocale', $m[0] );
1022 # Are there any at all?
1023 if ( count( $candidatesByLocale ) ) {
1024 $m = reset( $candidatesByLocale );
1025 $this->setVar( 'wgShellLocale', $m[0] );
1037 protected function envCheckUploadsDirectory() {
1040 $dir = $IP . '/images/';
1041 $url = $this->getVar( 'wgServer' ) . $this->getVar( 'wgScriptPath' ) . '/images/';
1042 $safe = !$this->dirIsExecutable( $dir, $url );
1045 $this->showMessage( 'config-uploads-not-safe', $dir );
1051 * Checks if suhosin.get.max_value_length is set, and if so, sets
1052 * $wgResourceLoaderMaxQueryLength to that value in the generated
1053 * LocalSettings file
1056 protected function envCheckSuhosinMaxValueLength() {
1057 $maxValueLength = ini_get( 'suhosin.get.max_value_length' );
1058 if ( $maxValueLength > 0 ) {
1059 if( $maxValueLength < 1024 ) {
1060 # Only warn if the value is below the sane 1024
1061 $this->showMessage( 'config-suhosin-max-value-length', $maxValueLength );
1064 $maxValueLength = -1;
1066 $this->setVar( 'wgResourceLoaderMaxQueryLength', $maxValueLength );
1071 * Convert a hex string representing a Unicode code point to that code point.
1075 protected function unicodeChar( $c ) {
1079 } elseif ($c <= 0x7FF) {
1080 return chr(0xC0 |
$c >> 6) . chr(0x80 |
$c & 0x3F);
1081 } elseif ($c <= 0xFFFF) {
1082 return chr(0xE0 |
$c >> 12) . chr(0x80 |
$c >> 6 & 0x3F)
1083 . chr(0x80 |
$c & 0x3F);
1084 } elseif ($c <= 0x10FFFF) {
1085 return chr(0xF0 |
$c >> 18) . chr(0x80 |
$c >> 12 & 0x3F)
1086 . chr(0x80 |
$c >> 6 & 0x3F)
1087 . chr(0x80 |
$c & 0x3F);
1095 * Check the libicu version
1097 protected function envCheckLibicu() {
1098 $utf8 = function_exists( 'utf8_normalize' );
1099 $intl = function_exists( 'normalizer_normalize' );
1102 * This needs to be updated something that the latest libicu
1103 * will properly normalize. This normalization was found at
1104 * http://www.unicode.org/versions/Unicode5.2.0/#Character_Additions
1105 * Note that we use the hex representation to create the code
1106 * points in order to avoid any Unicode-destroying during transit.
1108 $not_normal_c = $this->unicodeChar("FA6C");
1109 $normal_c = $this->unicodeChar("242EE");
1111 $useNormalizer = 'php';
1112 $needsUpdate = false;
1115 * We're going to prefer the pecl extension here unless
1116 * utf8_normalize is more up to date.
1119 $useNormalizer = 'utf8';
1120 $utf8 = utf8_normalize( $not_normal_c, UtfNormal
::UNORM_NFC
);
1121 if ( $utf8 !== $normal_c ) {
1122 $needsUpdate = true;
1126 $useNormalizer = 'intl';
1127 $intl = normalizer_normalize( $not_normal_c, Normalizer
::FORM_C
);
1128 if ( $intl !== $normal_c ) {
1129 $needsUpdate = true;
1133 // Uses messages 'config-unicode-using-php', 'config-unicode-using-utf8', 'config-unicode-using-intl'
1134 if( $useNormalizer === 'php' ) {
1135 $this->showMessage( 'config-unicode-pure-php-warning' );
1137 $this->showMessage( 'config-unicode-using-' . $useNormalizer );
1138 if( $needsUpdate ) {
1139 $this->showMessage( 'config-unicode-update-warning' );
1147 protected function envCheckCtype() {
1148 if ( !function_exists( 'ctype_digit' ) ) {
1149 $this->showError( 'config-ctype' );
1156 * Get an array of likely places we can find executables. Check a bunch
1157 * of known Unix-like defaults, as well as the PATH environment variable
1158 * (which should maybe make it work for Windows?)
1162 protected static function getPossibleBinPaths() {
1164 array( '/usr/bin', '/usr/local/bin', '/opt/csw/bin',
1165 '/usr/gnu/bin', '/usr/sfw/bin', '/sw/bin', '/opt/local/bin' ),
1166 explode( PATH_SEPARATOR
, getenv( 'PATH' ) )
1171 * Search a path for any of the given executable names. Returns the
1172 * executable name if found. Also checks the version string returned
1173 * by each executable.
1175 * Used only by environment checks.
1177 * @param $path String: path to search
1178 * @param $names Array of executable names
1179 * @param $versionInfo Boolean false or array with two members:
1180 * 0 => Command to run for version check, with $1 for the full executable name
1181 * 1 => String to compare the output with
1183 * If $versionInfo is not false, only executables with a version
1184 * matching $versionInfo[1] will be returned.
1185 * @return bool|string
1187 public static function locateExecutable( $path, $names, $versionInfo = false ) {
1188 if ( !is_array( $names ) ) {
1189 $names = array( $names );
1192 foreach ( $names as $name ) {
1193 $command = $path . DIRECTORY_SEPARATOR
. $name;
1195 wfSuppressWarnings();
1196 $file_exists = file_exists( $command );
1197 wfRestoreWarnings();
1199 if ( $file_exists ) {
1200 if ( !$versionInfo ) {
1204 $file = str_replace( '$1', wfEscapeShellArg( $command ), $versionInfo[0] );
1205 if ( strstr( wfShellExec( $file ), $versionInfo[1] ) !== false ) {
1214 * Same as locateExecutable(), but checks in getPossibleBinPaths() by default
1215 * @see locateExecutable()
1217 * @param $versionInfo bool
1218 * @return bool|string
1220 public static function locateExecutableInDefaultPaths( $names, $versionInfo = false ) {
1221 foreach( self
::getPossibleBinPaths() as $path ) {
1222 $exe = self
::locateExecutable( $path, $names, $versionInfo );
1223 if( $exe !== false ) {
1231 * Checks if scripts located in the given directory can be executed via the given URL.
1233 * Used only by environment checks.
1234 * @param $dir string
1235 * @param $url string
1236 * @return bool|int|string
1238 public function dirIsExecutable( $dir, $url ) {
1239 $scriptTypes = array(
1241 "<?php echo 'ex' . 'ec';",
1242 "#!/var/env php5\n<?php echo 'ex' . 'ec';",
1246 // it would be good to check other popular languages here, but it'll be slow.
1248 wfSuppressWarnings();
1250 foreach ( $scriptTypes as $ext => $contents ) {
1251 foreach ( $contents as $source ) {
1252 $file = 'exectest.' . $ext;
1254 if ( !file_put_contents( $dir . $file, $source ) ) {
1259 $text = Http
::get( $url . $file, array( 'timeout' => 3 ) );
1261 catch( MWException
$e ) {
1262 // Http::get throws with allow_url_fopen = false and no curl extension.
1265 unlink( $dir . $file );
1267 if ( $text == 'exec' ) {
1268 wfRestoreWarnings();
1274 wfRestoreWarnings();
1280 * Checks for presence of an Apache module. Works only if PHP is running as an Apache module, too.
1282 * @param $moduleName String: Name of module to check.
1285 public static function apacheModulePresent( $moduleName ) {
1286 if ( function_exists( 'apache_get_modules' ) && in_array( $moduleName, apache_get_modules() ) ) {
1289 // try it the hard way
1291 phpinfo( INFO_MODULES
);
1292 $info = ob_get_clean();
1293 return strpos( $info, $moduleName ) !== false;
1297 * ParserOptions are constructed before we determined the language, so fix it
1299 * @param $lang Language
1301 public function setParserLanguage( $lang ) {
1302 $this->parserOptions
->setTargetLanguage( $lang );
1303 $this->parserOptions
->setUserLang( $lang );
1307 * Overridden by WebInstaller to provide lastPage parameters.
1308 * @param $page string
1311 protected function getDocUrl( $page ) {
1312 return "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1316 * Finds extensions that follow the format /extensions/Name/Name.php,
1317 * and returns an array containing the value for 'Name' for each found extension.
1321 public function findExtensions() {
1322 if( $this->getVar( 'IP' ) === null ) {
1327 $extDir = $this->getVar( 'IP' ) . '/extensions';
1328 $dh = opendir( $extDir );
1330 while ( ( $file = readdir( $dh ) ) !== false ) {
1331 if( !is_dir( "$extDir/$file" ) ) {
1334 if( file_exists( "$extDir/$file/$file.php" ) ) {
1338 natcasesort( $exts );
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://bugzilla.wikimedia.org/show_bug.cgi?id=26857
1361 global $wgAutoloadClasses;
1362 $wgAutoloadClasses = array();
1364 require( "$IP/includes/DefaultSettings.php" );
1366 foreach( $exts as $e ) {
1367 require_once( "$IP/extensions/$e/$e.php" );
1370 $hooksWeWant = isset( $wgHooks['LoadExtensionSchemaUpdates'] ) ?
1371 $wgHooks['LoadExtensionSchemaUpdates'] : array();
1373 // Unset everyone else's hooks. Lord knows what someone might be doing
1374 // in ParserFirstCallInit (see bug 27171)
1375 $GLOBALS['wgHooks'] = array( 'LoadExtensionSchemaUpdates' => $hooksWeWant );
1377 return Status
::newGood();
1381 * Get an array of install steps. Should always be in the format of
1383 * 'name' => 'someuniquename',
1384 * 'callback' => array( $obj, 'method' ),
1386 * There must be a config-install-$name message defined per step, which will
1387 * be shown on install.
1389 * @param $installer DatabaseInstaller so we can make callbacks
1392 protected function getInstallSteps( DatabaseInstaller
$installer ) {
1393 $coreInstallSteps = array(
1394 array( 'name' => 'database', 'callback' => array( $installer, 'setupDatabase' ) ),
1395 array( 'name' => 'tables', 'callback' => array( $installer, 'createTables' ) ),
1396 array( 'name' => 'interwiki', 'callback' => array( $installer, 'populateInterwikiTable' ) ),
1397 array( 'name' => 'stats', 'callback' => array( $this, 'populateSiteStats' ) ),
1398 array( 'name' => 'keys', 'callback' => array( $this, 'generateKeys' ) ),
1399 array( 'name' => 'sysop', 'callback' => array( $this, 'createSysop' ) ),
1400 array( 'name' => 'mainpage', 'callback' => array( $this, 'createMainpage' ) ),
1403 // Build the array of install steps starting from the core install list,
1404 // then adding any callbacks that wanted to attach after a given step
1405 foreach( $coreInstallSteps as $step ) {
1406 $this->installSteps
[] = $step;
1407 if( isset( $this->extraInstallSteps
[ $step['name'] ] ) ) {
1408 $this->installSteps
= array_merge(
1409 $this->installSteps
,
1410 $this->extraInstallSteps
[ $step['name'] ]
1415 // Prepend any steps that want to be at the beginning
1416 if( isset( $this->extraInstallSteps
['BEGINNING'] ) ) {
1417 $this->installSteps
= array_merge(
1418 $this->extraInstallSteps
['BEGINNING'],
1423 // Extensions should always go first, chance to tie into hooks and such
1424 if( count( $this->getVar( '_Extensions' ) ) ) {
1425 array_unshift( $this->installSteps
,
1426 array( 'name' => 'extensions', 'callback' => array( $this, 'includeExtensions' ) )
1428 $this->installSteps
[] = array(
1429 'name' => 'extension-tables',
1430 'callback' => array( $installer, 'createExtensionTables' )
1433 return $this->installSteps
;
1437 * Actually perform the installation.
1439 * @param $startCB Array A callback array for the beginning of each step
1440 * @param $endCB Array A callback array for the end of each step
1442 * @return Array of Status objects
1444 public function performInstallation( $startCB, $endCB ) {
1445 $installResults = array();
1446 $installer = $this->getDBInstaller();
1447 $installer->preInstall();
1448 $steps = $this->getInstallSteps( $installer );
1449 foreach( $steps as $stepObj ) {
1450 $name = $stepObj['name'];
1451 call_user_func_array( $startCB, array( $name ) );
1453 // Perform the callback step
1454 $status = call_user_func( $stepObj['callback'], $installer );
1456 // Output and save the results
1457 call_user_func( $endCB, $name, $status );
1458 $installResults[$name] = $status;
1460 // If we've hit some sort of fatal, we need to bail.
1461 // Callback already had a chance to do output above.
1462 if( !$status->isOk() ) {
1466 if( $status->isOk() ) {
1467 $this->setVar( '_InstallDone', true );
1469 return $installResults;
1473 * Generate $wgSecretKey. Will warn if we had to use an insecure random source.
1477 public function generateKeys() {
1478 $keys = array( 'wgSecretKey' => 64 );
1479 if ( strval( $this->getVar( 'wgUpgradeKey' ) ) === '' ) {
1480 $keys['wgUpgradeKey'] = 16;
1482 return $this->doGenerateKeys( $keys );
1486 * Generate a secret value for variables using our CryptRand generator.
1487 * Produce a warning if the random source was insecure.
1489 * @param $keys Array
1492 protected function doGenerateKeys( $keys ) {
1493 $status = Status
::newGood();
1496 foreach ( $keys as $name => $length ) {
1497 $secretKey = MWCryptRand
::generateHex( $length, true );
1498 if ( !MWCryptRand
::wasStrong() ) {
1502 $this->setVar( $name, $secretKey );
1506 $names = array_keys( $keys );
1507 $names = preg_replace( '/^(.*)$/', '\$$1', $names );
1509 $status->warning( 'config-insecure-keys', $wgLang->listToText( $names ), count( $names ) );
1516 * Create the first user account, grant it sysop and bureaucrat rights
1520 protected function createSysop() {
1521 $name = $this->getVar( '_AdminName' );
1522 $user = User
::newFromName( $name );
1525 // We should've validated this earlier anyway!
1526 return Status
::newFatal( 'config-admin-error-user', $name );
1529 if ( $user->idForName() == 0 ) {
1530 $user->addToDatabase();
1533 $user->setPassword( $this->getVar( '_AdminPassword' ) );
1534 } catch( PasswordError
$pwe ) {
1535 return Status
::newFatal( 'config-admin-error-password', $name, $pwe->getMessage() );
1538 $user->addGroup( 'sysop' );
1539 $user->addGroup( 'bureaucrat' );
1540 if( $this->getVar( '_AdminEmail' ) ) {
1541 $user->setEmail( $this->getVar( '_AdminEmail' ) );
1543 $user->saveSettings();
1545 // Update user count
1546 $ssUpdate = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
1547 $ssUpdate->doUpdate();
1549 $status = Status
::newGood();
1551 if( $this->getVar( '_Subscribe' ) && $this->getVar( '_AdminEmail' ) ) {
1552 $this->subscribeToMediaWikiAnnounce( $status );
1561 private function subscribeToMediaWikiAnnounce( Status
$s ) {
1563 'email' => $this->getVar( '_AdminEmail' ),
1568 // Mailman doesn't support as many languages as we do, so check to make
1569 // sure their selected language is available
1570 $myLang = $this->getVar( '_UserLang' );
1571 if( in_array( $myLang, $this->mediaWikiAnnounceLanguages
) ) {
1572 $myLang = $myLang == 'pt-br' ?
'pt_BR' : $myLang; // rewrite to Mailman's pt_BR
1573 $params['language'] = $myLang;
1576 if( MWHttpRequest
::canMakeRequests() ) {
1577 $res = MWHttpRequest
::factory( $this->mediaWikiAnnounceUrl
,
1578 array( 'method' => 'POST', 'postData' => $params ) )->execute();
1579 if( !$res->isOK() ) {
1580 $s->warning( 'config-install-subscribe-fail', $res->getMessage() );
1583 $s->warning( 'config-install-subscribe-notpossible' );
1588 * Insert Main Page with default content.
1590 * @param $installer DatabaseInstaller
1593 protected function createMainpage( DatabaseInstaller
$installer ) {
1594 $status = Status
::newGood();
1596 $page = WikiPage
::factory( Title
::newMainPage() );
1597 $page->doEdit( wfMessage( 'mainpagetext' )->inContentLanguage()->text() . "\n\n" .
1598 wfMessage( 'mainpagedocfooter' )->inContentLanguage()->text(),
1602 User
::newFromName( 'MediaWiki default' )
1604 } catch (MWException
$e) {
1605 //using raw, because $wgShowExceptionDetails can not be set yet
1606 $status->fatal( 'config-install-mainpage-failed', $e->getMessage() );
1613 * Override the necessary bits of the config to run an installation.
1615 public static function overrideConfig() {
1616 define( 'MW_NO_SESSION', 1 );
1618 // Don't access the database
1619 $GLOBALS['wgUseDatabaseMessages'] = false;
1620 // Don't cache langconv tables
1621 $GLOBALS['wgLanguageConverterCacheType'] = CACHE_NONE
;
1623 $GLOBALS['wgShowExceptionDetails'] = true;
1624 // Don't break forms
1625 $GLOBALS['wgExternalLinkTarget'] = '_blank';
1627 // Extended debugging
1628 $GLOBALS['wgShowSQLErrors'] = true;
1629 $GLOBALS['wgShowDBErrorBacktrace'] = true;
1631 // Allow multiple ob_flush() calls
1632 $GLOBALS['wgDisableOutputCompression'] = true;
1634 // Use a sensible cookie prefix (not my_wiki)
1635 $GLOBALS['wgCookiePrefix'] = 'mw_installer';
1637 // Some of the environment checks make shell requests, remove limits
1638 $GLOBALS['wgMaxShellMemory'] = 0;
1642 * Add an installation step following the given step.
1644 * @param $callback Array A valid installation callback array, in this form:
1645 * array( 'name' => 'some-unique-name', 'callback' => array( $obj, 'function' ) );
1646 * @param $findStep String the step to find. Omit to put the step at the beginning
1648 public function addInstallStep( $callback, $findStep = 'BEGINNING' ) {
1649 $this->extraInstallSteps
[$findStep][] = $callback;
1653 * Disable the time limit for execution.
1654 * Some long-running pages (Install, Upgrade) will want to do this
1656 protected function disableTimeLimit() {
1657 wfSuppressWarnings();
1658 set_time_limit( 0 );
1659 wfRestoreWarnings();