3 * Base code for MediaWiki installer.
10 * This documentation group collects source code files with deployment functionality.
12 * @defgroup Deployment Deployment
16 * Base installer class.
18 * This class provides the base for installation and update functionality
19 * for both MediaWiki core and extensions.
24 abstract class Installer
{
26 // This is the absolute minimum PHP version we can support
27 const MINIMUM_PHP_VERSION
= '5.2.3';
35 * Cached DB installer instances, access using getDBInstaller().
39 protected $dbInstallers = array();
42 * Minimum memory size in MB.
46 protected $minMemorySize = 50;
49 * Cached Title, used by parse().
53 protected $parserTitle;
56 * Cached ParserOptions, used by parse().
60 protected $parserOptions;
63 * Known database types. These correspond to the class names <type>Installer,
64 * and are also MediaWiki database types valid for $wgDBtype.
66 * To add a new type, create a <type>Installer class and a Database<type>
67 * class, and add a config-type-<type> message to MessagesEn.php.
71 protected static $dbTypes = array(
80 * A list of environment check methods called by doEnvironmentChecks().
81 * These may output warnings using showMessage(), and/or abort the
82 * installation process by returning false.
86 protected $envChecks = array(
88 'envCheckRegisterGlobals',
91 'envCheckMagicQuotes',
92 'envCheckMagicSybase',
105 'envCheckShellLocale',
106 'envCheckUploadsDirectory',
108 'envCheckSuhosinMaxValueLength',
112 * MediaWiki configuration globals that will eventually be passed through
113 * to LocalSettings.php. The names only are given here, the defaults
114 * typically come from DefaultSettings.php.
118 protected $defaultVarNames = array(
130 'wgEmailAuthentication',
133 'wgImageMagickConvertCommand',
139 'wgDeletedDirectory',
144 'wgUseInstantCommons',
147 'wgResourceLoaderMaxQueryLength',
151 * Variables that are stored alongside globals, and are used for any
152 * configuration of the installation process aside from the MediaWiki
153 * configuration. Map of names to defaults.
157 protected $internalDefaults = array(
159 '_Environment' => false,
160 '_CompiledDBs' => array(),
161 '_SafeMode' => false,
162 '_RaiseMemory' => false,
163 '_UpgradeDone' => false,
164 '_InstallDone' => false,
165 '_Caches' => array(),
166 '_InstallPassword' => '',
167 '_SameAccount' => true,
168 '_CreateDBAccount' => false,
169 '_NamespaceType' => 'site-name',
170 '_AdminName' => '', // will be set later, when the user selects language
171 '_AdminPassword' => '',
172 '_AdminPassword2' => '',
174 '_Subscribe' => false,
175 '_SkipOptional' => 'continue',
176 '_RightsProfile' => 'wiki',
177 '_LicenseCode' => 'none',
179 '_Extensions' => array(),
180 '_MemCachedServers' => '',
181 '_UpgradeKeySupplied' => false,
182 '_ExistingDBSettings' => false,
186 * The actual list of installation steps. This will be initialized by getInstallSteps()
190 private $installSteps = array();
193 * Extra steps for installation, for things like DatabaseInstallers to modify
197 protected $extraInstallSteps = array();
200 * Known object cache types and the functions used to test for their existence.
204 protected $objectCaches = array(
205 'xcache' => 'xcache_get',
206 'apc' => 'apc_fetch',
207 'eaccel' => 'eaccelerator_get',
208 'wincache' => 'wincache_ucache_get'
212 * User rights profiles.
216 public $rightsProfiles = array(
219 '*' => array( 'edit' => false )
223 'createaccount' => false,
229 'createaccount' => false,
241 public $licenses = array(
243 'url' => 'http://creativecommons.org/licenses/by/3.0/',
244 'icon' => '{$wgStylePath}/common/images/cc-by.png',
247 'url' => 'http://creativecommons.org/licenses/by-sa/3.0/',
248 'icon' => '{$wgStylePath}/common/images/cc-by-sa.png',
250 'cc-by-nc-sa' => array(
251 'url' => 'http://creativecommons.org/licenses/by-nc-sa/3.0/',
252 'icon' => '{$wgStylePath}/common/images/cc-by-nc-sa.png',
255 'url' => 'https://creativecommons.org/publicdomain/zero/1.0/',
256 'icon' => '{$wgStylePath}/common/images/cc-0.png',
260 'icon' => '{$wgStylePath}/common/images/public-domain.png',
263 'url' => 'http://www.gnu.org/copyleft/fdl.html',
264 'icon' => '{$wgStylePath}/common/images/gnu-fdl.png',
271 'cc-choose' => array(
272 // Details will be filled in by the selector.
280 * URL to mediawiki-announce subscription
282 protected $mediaWikiAnnounceUrl = 'https://lists.wikimedia.org/mailman/subscribe/mediawiki-announce';
285 * Supported language codes for Mailman
287 protected $mediaWikiAnnounceLanguages = array(
288 'ca', 'cs', 'da', 'de', 'en', 'es', 'et', 'eu', 'fi', 'fr', 'hr', 'hu',
289 'it', 'ja', 'ko', 'lt', 'nl', 'no', 'pl', 'pt', 'pt-br', 'ro', 'ru',
290 'sl', 'sr', 'sv', 'tr', 'uk'
294 * UI interface for displaying a short message
295 * The parameters are like parameters to wfMsg().
296 * The messages will be in wikitext format, which will be converted to an
297 * output format such as HTML or text before being sent to the user.
299 public abstract function showMessage( $msg /*, ... */ );
302 * Same as showMessage(), but for displaying errors
304 public abstract function showError( $msg /*, ... */ );
307 * Show a message to the installing user by using a Status object
308 * @param $status Status
310 public abstract function showStatusMessage( Status
$status );
313 * Constructor, always call this from child classes.
315 public function __construct() {
316 global $wgExtensionMessagesFiles, $wgUser;
318 // Disable the i18n cache and LoadBalancer
319 Language
::getLocalisationCache()->disableBackend();
320 LBFactory
::disableBackend();
322 // Load the installer's i18n file.
323 $wgExtensionMessagesFiles['MediawikiInstaller'] =
324 dirname( __FILE__
) . '/Installer.i18n.php';
326 // Having a user with id = 0 safeguards us from DB access via User::loadOptions().
327 $wgUser = User
::newFromId( 0 );
329 $this->settings
= $this->internalDefaults
;
331 foreach ( $this->defaultVarNames
as $var ) {
332 $this->settings
[$var] = $GLOBALS[$var];
335 foreach ( self
::getDBTypes() as $type ) {
336 $installer = $this->getDBInstaller( $type );
338 if ( !$installer->isCompiled() ) {
342 $defaults = $installer->getGlobalDefaults();
344 foreach ( $installer->getGlobalNames() as $var ) {
345 if ( isset( $defaults[$var] ) ) {
346 $this->settings
[$var] = $defaults[$var];
348 $this->settings
[$var] = $GLOBALS[$var];
353 $this->parserTitle
= Title
::newFromText( 'Installer' );
354 $this->parserOptions
= new ParserOptions
; // language will be wrong :(
355 $this->parserOptions
->setEditSection( false );
359 * Get a list of known DB types.
363 public static function getDBTypes() {
364 return self
::$dbTypes;
368 * Do initial checks of the PHP environment. Set variables according to
369 * the observed environment.
371 * It's possible that this may be called under the CLI SAPI, not the SAPI
372 * that the wiki will primarily run under. In that case, the subclass should
373 * initialise variables such as wgScriptPath, before calling this function.
375 * Under the web subclass, it can already be assumed that PHP 5+ is in use
376 * and that sessions are working.
380 public function doEnvironmentChecks() {
381 $phpVersion = phpversion();
382 if( version_compare( $phpVersion, self
::MINIMUM_PHP_VERSION
, '>=' ) ) {
383 $this->showMessage( 'config-env-php', $phpVersion );
386 $this->showMessage( 'config-env-php-toolow', $phpVersion, self
::MINIMUM_PHP_VERSION
);
391 foreach ( $this->envChecks
as $check ) {
392 $status = $this->$check();
393 if ( $status === false ) {
399 $this->setVar( '_Environment', $good );
401 return $good ? Status
::newGood() : Status
::newFatal( 'config-env-bad' );
405 * Set a MW configuration variable, or internal installer configuration variable.
407 * @param $name String
408 * @param $value Mixed
410 public function setVar( $name, $value ) {
411 $this->settings
[$name] = $value;
415 * Get an MW configuration variable, or internal installer configuration variable.
416 * The defaults come from $GLOBALS (ultimately DefaultSettings.php).
417 * Installer variables are typically prefixed by an underscore.
419 * @param $name String
420 * @param $default Mixed
424 public function getVar( $name, $default = null ) {
425 if ( !isset( $this->settings
[$name] ) ) {
428 return $this->settings
[$name];
433 * Get an instance of DatabaseInstaller for the specified DB type.
435 * @param $type Mixed: DB installer for which is needed, false to use default.
437 * @return DatabaseInstaller
439 public function getDBInstaller( $type = false ) {
441 $type = $this->getVar( 'wgDBtype' );
444 $type = strtolower( $type );
446 if ( !isset( $this->dbInstallers
[$type] ) ) {
447 $class = ucfirst( $type ). 'Installer';
448 $this->dbInstallers
[$type] = new $class( $this );
451 return $this->dbInstallers
[$type];
455 * Determine if LocalSettings.php exists. If it does, return its variables,
456 * merged with those from AdminSettings.php, as an array.
460 public static function getExistingLocalSettings() {
463 wfSuppressWarnings();
464 $_lsExists = file_exists( "$IP/LocalSettings.php" );
472 require( "$IP/includes/DefaultSettings.php" );
473 require( "$IP/LocalSettings.php" );
474 if ( file_exists( "$IP/AdminSettings.php" ) ) {
475 require( "$IP/AdminSettings.php" );
477 return get_defined_vars();
481 * Get a fake password for sending back to the user in HTML.
482 * This is a security mechanism to avoid compromise of the password in the
483 * event of session ID compromise.
485 * @param $realPassword String
489 public function getFakePassword( $realPassword ) {
490 return str_repeat( '*', strlen( $realPassword ) );
494 * Set a variable which stores a password, except if the new value is a
495 * fake password in which case leave it as it is.
497 * @param $name String
498 * @param $value Mixed
500 public function setPassword( $name, $value ) {
501 if ( !preg_match( '/^\*+$/', $value ) ) {
502 $this->setVar( $name, $value );
507 * On POSIX systems return the primary group of the webserver we're running under.
508 * On other systems just returns null.
510 * This is used to advice the user that he should chgrp his mw-config/data/images directory as the
511 * webserver user before he can install.
513 * Public because SqliteInstaller needs it, and doesn't subclass Installer.
517 public static function maybeGetWebserverPrimaryGroup() {
518 if ( !function_exists( 'posix_getegid' ) ||
!function_exists( 'posix_getpwuid' ) ) {
519 # I don't know this, this isn't UNIX.
523 # posix_getegid() *not* getmygid() because we want the group of the webserver,
524 # not whoever owns the current script.
525 $gid = posix_getegid();
526 $getpwuid = posix_getpwuid( $gid );
527 $group = $getpwuid['name'];
533 * Convert wikitext $text to HTML.
535 * This is potentially error prone since many parser features require a complete
536 * installed MW database. The solution is to just not use those features when you
537 * write your messages. This appears to work well enough. Basic formatting and
538 * external links work just fine.
540 * But in case a translator decides to throw in a #ifexist or internal link or
541 * whatever, this function is guarded to catch the attempted DB access and to present
542 * some fallback text.
544 * @param $text String
545 * @param $lineStart Boolean
548 public function parse( $text, $lineStart = false ) {
552 $out = $wgParser->parse( $text, $this->parserTitle
, $this->parserOptions
, $lineStart );
553 $html = $out->getText();
554 } catch ( DBAccessError
$e ) {
555 $html = '<!--DB access attempted during parse--> ' . htmlspecialchars( $text );
557 if ( !empty( $this->debug
) ) {
558 $html .= "<!--\n" . $e->getTraceAsString() . "\n-->";
566 * @return ParserOptions
568 public function getParserOptions() {
569 return $this->parserOptions
;
572 public function disableLinkPopups() {
573 $this->parserOptions
->setExternalLinkTarget( false );
576 public function restoreLinkPopups() {
577 global $wgExternalLinkTarget;
578 $this->parserOptions
->setExternalLinkTarget( $wgExternalLinkTarget );
582 * Install step which adds a row to the site_stats table with appropriate
585 * @param $installer DatabaseInstaller
589 public function populateSiteStats( DatabaseInstaller
$installer ) {
590 $status = $installer->getConnection();
591 if ( !$status->isOK() ) {
594 $status->value
->insert( 'site_stats', array(
596 'ss_total_views' => 0,
597 'ss_total_edits' => 0,
598 'ss_good_articles' => 0,
599 'ss_total_pages' => 0,
603 __METHOD__
, 'IGNORE' );
604 return Status
::newGood();
608 * Exports all wg* variables stored by the installer into global scope.
610 public function exportVars() {
611 foreach ( $this->settings
as $name => $value ) {
612 if ( substr( $name, 0, 2 ) == 'wg' ) {
613 $GLOBALS[$name] = $value;
619 * Environment check for DB types.
621 protected function envCheckDB() {
624 $compiledDBs = array();
627 foreach ( self
::getDBTypes() as $name ) {
628 if ( $this->getDBInstaller( $name )->isCompiled() ) {
629 $compiledDBs[] = $name;
631 $allNames[] = wfMsg( 'config-type-' . $name );
634 $this->setVar( '_CompiledDBs', $compiledDBs );
636 if ( !$compiledDBs ) {
637 $this->showError( 'config-no-db', $wgLang->commaList( $allNames ) );
638 // @todo FIXME: This only works for the web installer!
642 // Check for FTS3 full-text search module
643 $sqlite = $this->getDBInstaller( 'sqlite' );
644 if ( $sqlite->isCompiled() ) {
645 if( DatabaseSqlite
::getFulltextSearchModule() != 'FTS3' ) {
646 $this->showMessage( 'config-no-fts3' );
652 * Environment check for register_globals.
654 protected function envCheckRegisterGlobals() {
655 if( wfIniGetBool( 'register_globals' ) ) {
656 $this->showMessage( 'config-register-globals' );
661 * Some versions of libxml+PHP break < and > encoding horribly
663 protected function envCheckBrokenXML() {
664 $test = new PhpXmlBugTester();
666 $this->showError( 'config-brokenlibxml' );
672 * Test PHP (probably 5.3.1, but it could regress again) to make sure that
673 * reference parameters to __call() are not converted to null
675 protected function envCheckPHP531() {
676 $test = new PhpRefCallBugTester
;
679 $this->showError( 'config-using531', phpversion() );
685 * Environment check for magic_quotes_runtime.
687 protected function envCheckMagicQuotes() {
688 if( wfIniGetBool( "magic_quotes_runtime" ) ) {
689 $this->showError( 'config-magic-quotes-runtime' );
695 * Environment check for magic_quotes_sybase.
697 protected function envCheckMagicSybase() {
698 if ( wfIniGetBool( 'magic_quotes_sybase' ) ) {
699 $this->showError( 'config-magic-quotes-sybase' );
705 * Environment check for mbstring.func_overload.
707 protected function envCheckMbstring() {
708 if ( wfIniGetBool( 'mbstring.func_overload' ) ) {
709 $this->showError( 'config-mbstring' );
715 * Environment check for zend.ze1_compatibility_mode.
717 protected function envCheckZE1() {
718 if ( wfIniGetBool( 'zend.ze1_compatibility_mode' ) ) {
719 $this->showError( 'config-ze1' );
725 * Environment check for safe_mode.
727 protected function envCheckSafeMode() {
728 if ( wfIniGetBool( 'safe_mode' ) ) {
729 $this->setVar( '_SafeMode', true );
730 $this->showMessage( 'config-safe-mode' );
735 * Environment check for the XML module.
737 protected function envCheckXML() {
738 if ( !function_exists( "utf8_encode" ) ) {
739 $this->showError( 'config-xml-bad' );
745 * Environment check for the PCRE module.
747 protected function envCheckPCRE() {
748 if ( !function_exists( 'preg_match' ) ) {
749 $this->showError( 'config-pcre' );
752 wfSuppressWarnings();
753 $regexd = preg_replace( '/[\x{0430}-\x{04FF}]/iu', '', '-АБВГД-' );
755 if ( $regexd != '--' ) {
756 $this->showError( 'config-pcre-no-utf8' );
762 * Environment check for available memory.
764 protected function envCheckMemory() {
765 $limit = ini_get( 'memory_limit' );
767 if ( !$limit ||
$limit == -1 ) {
771 $n = wfShorthandToInteger( $limit );
773 if( $n < $this->minMemorySize
* 1024 * 1024 ) {
774 $newLimit = "{$this->minMemorySize}M";
776 if( ini_set( "memory_limit", $newLimit ) === false ) {
777 $this->showMessage( 'config-memory-bad', $limit );
779 $this->showMessage( 'config-memory-raised', $limit, $newLimit );
780 $this->setVar( '_RaiseMemory', true );
788 * Environment check for compiled object cache types.
790 protected function envCheckCache() {
792 foreach ( $this->objectCaches
as $name => $function ) {
793 if ( function_exists( $function ) ) {
794 if ( $name == 'xcache' && !wfIniGetBool( 'xcache.var_size' ) ) {
797 $caches[$name] = true;
802 $this->showMessage( 'config-no-cache' );
805 $this->setVar( '_Caches', $caches );
809 * Search for GNU diff3.
811 protected function envCheckDiff3() {
812 $names = array( "gdiff3", "diff3", "diff3.exe" );
813 $versionInfo = array( '$1 --version 2>&1', 'GNU diffutils' );
815 $diff3 = self
::locateExecutableInDefaultPaths( $names, $versionInfo );
818 $this->setVar( 'wgDiff3', $diff3 );
820 $this->setVar( 'wgDiff3', false );
821 $this->showMessage( 'config-diff3-bad' );
826 * Environment check for ImageMagick and GD.
828 protected function envCheckGraphics() {
829 $names = array( wfIsWindows() ?
'convert.exe' : 'convert' );
830 $convert = self
::locateExecutableInDefaultPaths( $names, array( '$1 -version', 'ImageMagick' ) );
832 $this->setVar( 'wgImageMagickConvertCommand', '' );
834 $this->setVar( 'wgImageMagickConvertCommand', $convert );
835 $this->showMessage( 'config-imagemagick', $convert );
837 } elseif ( function_exists( 'imagejpeg' ) ) {
838 $this->showMessage( 'config-gd' );
841 $this->showMessage( 'config-no-scaling' );
846 * Environment check for the server hostname.
848 protected function envCheckServer() {
849 $server = WebRequest
::detectServer();
850 $this->showMessage( 'config-using-server', $server );
851 $this->setVar( 'wgServer', $server );
855 * Environment check for setting $IP and $wgScriptPath.
857 protected function envCheckPath() {
859 $IP = dirname( dirname( dirname( __FILE__
) ) );
860 $this->setVar( 'IP', $IP );
862 $this->showMessage( 'config-using-uri', $this->getVar( 'wgServer' ), $this->getVar( 'wgScriptPath' ) );
867 * Environment check for setting the preferred PHP file extension.
869 protected function envCheckExtension() {
870 // @todo FIXME: Detect this properly
871 if ( defined( 'MW_INSTALL_PHP5_EXT' ) ) {
876 $this->setVar( 'wgScriptExtension', ".$ext" );
882 protected function envCheckShellLocale() {
883 $os = php_uname( 's' );
884 $supported = array( 'Linux', 'SunOS', 'HP-UX', 'Darwin' ); # Tested these
886 if ( !in_array( $os, $supported ) ) {
890 # Get a list of available locales.
892 $lines = wfShellExec( '/usr/bin/locale -a', $ret );
898 $lines = wfArrayMap( 'trim', explode( "\n", $lines ) );
899 $candidatesByLocale = array();
900 $candidatesByLang = array();
902 foreach ( $lines as $line ) {
903 if ( $line === '' ) {
907 if ( !preg_match( '/^([a-zA-Z]+)(_[a-zA-Z]+|)\.(utf8|UTF-8)(@[a-zA-Z_]*|)$/i', $line, $m ) ) {
911 list( $all, $lang, $territory, $charset, $modifier ) = $m;
913 $candidatesByLocale[$m[0]] = $m;
914 $candidatesByLang[$lang][] = $m;
917 # Try the current value of LANG.
918 if ( isset( $candidatesByLocale[ getenv( 'LANG' ) ] ) ) {
919 $this->setVar( 'wgShellLocale', getenv( 'LANG' ) );
923 # Try the most common ones.
924 $commonLocales = array( 'en_US.UTF-8', 'en_US.utf8', 'de_DE.UTF-8', 'de_DE.utf8' );
925 foreach ( $commonLocales as $commonLocale ) {
926 if ( isset( $candidatesByLocale[$commonLocale] ) ) {
927 $this->setVar( 'wgShellLocale', $commonLocale );
932 # Is there an available locale in the Wiki's language?
933 $wikiLang = $this->getVar( 'wgLanguageCode' );
935 if ( isset( $candidatesByLang[$wikiLang] ) ) {
936 $m = reset( $candidatesByLang[$wikiLang] );
937 $this->setVar( 'wgShellLocale', $m[0] );
941 # Are there any at all?
942 if ( count( $candidatesByLocale ) ) {
943 $m = reset( $candidatesByLocale );
944 $this->setVar( 'wgShellLocale', $m[0] );
955 protected function envCheckUploadsDirectory() {
958 $dir = $IP . '/images/';
959 $url = $this->getVar( 'wgServer' ) . $this->getVar( 'wgScriptPath' ) . '/images/';
960 $safe = !$this->dirIsExecutable( $dir, $url );
965 $this->showMessage( 'config-uploads-not-safe', $dir );
970 * Checks if suhosin.get.max_value_length is set, and if so, sets
971 * $wgResourceLoaderMaxQueryLength to that value in the generated
974 protected function envCheckSuhosinMaxValueLength() {
975 $maxValueLength = ini_get( 'suhosin.get.max_value_length' );
976 if ( $maxValueLength > 0 ) {
977 $this->showMessage( 'config-suhosin-max-value-length', $maxValueLength );
979 $maxValueLength = -1;
981 $this->setVar( 'wgResourceLoaderMaxQueryLength', $maxValueLength );
985 * Convert a hex string representing a Unicode code point to that code point.
989 protected function unicodeChar( $c ) {
993 } elseif ($c <= 0x7FF) {
994 return chr(0xC0 |
$c >> 6) . chr(0x80 |
$c & 0x3F);
995 } elseif ($c <= 0xFFFF) {
996 return chr(0xE0 |
$c >> 12) . chr(0x80 |
$c >> 6 & 0x3F)
997 . chr(0x80 |
$c & 0x3F);
998 } elseif ($c <= 0x10FFFF) {
999 return chr(0xF0 |
$c >> 18) . chr(0x80 |
$c >> 12 & 0x3F)
1000 . chr(0x80 |
$c >> 6 & 0x3F)
1001 . chr(0x80 |
$c & 0x3F);
1009 * Check the libicu version
1011 protected function envCheckLibicu() {
1012 $utf8 = function_exists( 'utf8_normalize' );
1013 $intl = function_exists( 'normalizer_normalize' );
1016 * This needs to be updated something that the latest libicu
1017 * will properly normalize. This normalization was found at
1018 * http://www.unicode.org/versions/Unicode5.2.0/#Character_Additions
1019 * Note that we use the hex representation to create the code
1020 * points in order to avoid any Unicode-destroying during transit.
1022 $not_normal_c = $this->unicodeChar("FA6C");
1023 $normal_c = $this->unicodeChar("242EE");
1025 $useNormalizer = 'php';
1026 $needsUpdate = false;
1029 * We're going to prefer the pecl extension here unless
1030 * utf8_normalize is more up to date.
1033 $useNormalizer = 'utf8';
1034 $utf8 = utf8_normalize( $not_normal_c, UNORM_NFC
);
1035 if ( $utf8 !== $normal_c ) $needsUpdate = true;
1038 $useNormalizer = 'intl';
1039 $intl = normalizer_normalize( $not_normal_c, Normalizer
::FORM_C
);
1040 if ( $intl !== $normal_c ) $needsUpdate = true;
1043 // Uses messages 'config-unicode-using-php', 'config-unicode-using-utf8', 'config-unicode-using-intl'
1044 if( $useNormalizer === 'php' ) {
1045 $this->showMessage( 'config-unicode-pure-php-warning' );
1047 $this->showMessage( 'config-unicode-using-' . $useNormalizer );
1048 if( $needsUpdate ) {
1049 $this->showMessage( 'config-unicode-update-warning' );
1055 * Get an array of likely places we can find executables. Check a bunch
1056 * of known Unix-like defaults, as well as the PATH environment variable
1057 * (which should maybe make it work for Windows?)
1061 protected static function getPossibleBinPaths() {
1063 array( '/usr/bin', '/usr/local/bin', '/opt/csw/bin',
1064 '/usr/gnu/bin', '/usr/sfw/bin', '/sw/bin', '/opt/local/bin' ),
1065 explode( PATH_SEPARATOR
, getenv( 'PATH' ) )
1070 * Search a path for any of the given executable names. Returns the
1071 * executable name if found. Also checks the version string returned
1072 * by each executable.
1074 * Used only by environment checks.
1076 * @param $path String: path to search
1077 * @param $names Array of executable names
1078 * @param $versionInfo Boolean false or array with two members:
1079 * 0 => Command to run for version check, with $1 for the full executable name
1080 * 1 => String to compare the output with
1082 * If $versionInfo is not false, only executables with a version
1083 * matching $versionInfo[1] will be returned.
1085 public static function locateExecutable( $path, $names, $versionInfo = false ) {
1086 if ( !is_array( $names ) ) {
1087 $names = array( $names );
1090 foreach ( $names as $name ) {
1091 $command = $path . DIRECTORY_SEPARATOR
. $name;
1093 wfSuppressWarnings();
1094 $file_exists = file_exists( $command );
1095 wfRestoreWarnings();
1097 if ( $file_exists ) {
1098 if ( !$versionInfo ) {
1102 $file = str_replace( '$1', wfEscapeShellArg( $command ), $versionInfo[0] );
1103 if ( strstr( wfShellExec( $file ), $versionInfo[1] ) !== false ) {
1112 * Same as locateExecutable(), but checks in getPossibleBinPaths() by default
1113 * @see locateExecutable()
1115 public static function locateExecutableInDefaultPaths( $names, $versionInfo = false ) {
1116 foreach( self
::getPossibleBinPaths() as $path ) {
1117 $exe = self
::locateExecutable( $path, $names, $versionInfo );
1118 if( $exe !== false ) {
1126 * Checks if scripts located in the given directory can be executed via the given URL.
1128 * Used only by environment checks.
1130 public function dirIsExecutable( $dir, $url ) {
1131 $scriptTypes = array(
1133 "<?php echo 'ex' . 'ec';",
1134 "#!/var/env php5\n<?php echo 'ex' . 'ec';",
1138 // it would be good to check other popular languages here, but it'll be slow.
1140 wfSuppressWarnings();
1142 foreach ( $scriptTypes as $ext => $contents ) {
1143 foreach ( $contents as $source ) {
1144 $file = 'exectest.' . $ext;
1146 if ( !file_put_contents( $dir . $file, $source ) ) {
1151 $text = Http
::get( $url . $file, array( 'timeout' => 3 ) );
1153 catch( MWException
$e ) {
1154 // Http::get throws with allow_url_fopen = false and no curl extension.
1157 unlink( $dir . $file );
1159 if ( $text == 'exec' ) {
1160 wfRestoreWarnings();
1166 wfRestoreWarnings();
1172 * ParserOptions are constructed before we determined the language, so fix it
1174 * @param $lang Language
1176 public function setParserLanguage( $lang ) {
1177 $this->parserOptions
->setTargetLanguage( $lang );
1178 $this->parserOptions
->setUserLang( $lang->getCode() );
1182 * Overridden by WebInstaller to provide lastPage parameters.
1184 protected function getDocUrl( $page ) {
1185 return "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1189 * Finds extensions that follow the format /extensions/Name/Name.php,
1190 * and returns an array containing the value for 'Name' for each found extension.
1194 public function findExtensions() {
1195 if( $this->getVar( 'IP' ) === null ) {
1200 $extDir = $this->getVar( 'IP' ) . '/extensions';
1201 $dh = opendir( $extDir );
1203 while ( ( $file = readdir( $dh ) ) !== false ) {
1204 if( !is_dir( "$extDir/$file" ) ) {
1207 if( file_exists( "$extDir/$file/$file.php" ) ) {
1216 * Installs the auto-detected extensions.
1220 protected function includeExtensions() {
1222 $exts = $this->getVar( '_Extensions' );
1223 $IP = $this->getVar( 'IP' );
1226 * We need to include DefaultSettings before including extensions to avoid
1227 * warnings about unset variables. However, the only thing we really
1228 * want here is $wgHooks['LoadExtensionSchemaUpdates']. This won't work
1229 * if the extension has hidden hook registration in $wgExtensionFunctions,
1230 * but we're not opening that can of worms
1231 * @see https://bugzilla.wikimedia.org/show_bug.cgi?id=26857
1233 global $wgAutoloadClasses;
1234 $wgAutoloadClasses = array();
1236 require( "$IP/includes/DefaultSettings.php" );
1238 foreach( $exts as $e ) {
1239 require_once( "$IP/extensions/$e/$e.php" );
1242 $hooksWeWant = isset( $wgHooks['LoadExtensionSchemaUpdates'] ) ?
1243 $wgHooks['LoadExtensionSchemaUpdates'] : array();
1245 // Unset everyone else's hooks. Lord knows what someone might be doing
1246 // in ParserFirstCallInit (see bug 27171)
1247 $GLOBALS['wgHooks'] = array( 'LoadExtensionSchemaUpdates' => $hooksWeWant );
1249 return Status
::newGood();
1253 * Get an array of install steps. Should always be in the format of
1255 * 'name' => 'someuniquename',
1256 * 'callback' => array( $obj, 'method' ),
1258 * There must be a config-install-$name message defined per step, which will
1259 * be shown on install.
1261 * @param $installer DatabaseInstaller so we can make callbacks
1264 protected function getInstallSteps( DatabaseInstaller
$installer ) {
1265 $coreInstallSteps = array(
1266 array( 'name' => 'database', 'callback' => array( $installer, 'setupDatabase' ) ),
1267 array( 'name' => 'tables', 'callback' => array( $installer, 'createTables' ) ),
1268 array( 'name' => 'interwiki', 'callback' => array( $installer, 'populateInterwikiTable' ) ),
1269 array( 'name' => 'stats', 'callback' => array( $this, 'populateSiteStats' ) ),
1270 array( 'name' => 'keys', 'callback' => array( $this, 'generateKeys' ) ),
1271 array( 'name' => 'sysop', 'callback' => array( $this, 'createSysop' ) ),
1272 array( 'name' => 'mainpage', 'callback' => array( $this, 'createMainpage' ) ),
1275 // Build the array of install steps starting from the core install list,
1276 // then adding any callbacks that wanted to attach after a given step
1277 foreach( $coreInstallSteps as $step ) {
1278 $this->installSteps
[] = $step;
1279 if( isset( $this->extraInstallSteps
[ $step['name'] ] ) ) {
1280 $this->installSteps
= array_merge(
1281 $this->installSteps
,
1282 $this->extraInstallSteps
[ $step['name'] ]
1287 // Prepend any steps that want to be at the beginning
1288 if( isset( $this->extraInstallSteps
['BEGINNING'] ) ) {
1289 $this->installSteps
= array_merge(
1290 $this->extraInstallSteps
['BEGINNING'],
1295 // Extensions should always go first, chance to tie into hooks and such
1296 if( count( $this->getVar( '_Extensions' ) ) ) {
1297 array_unshift( $this->installSteps
,
1298 array( 'name' => 'extensions', 'callback' => array( $this, 'includeExtensions' ) )
1300 $this->installSteps
[] = array(
1301 'name' => 'extension-tables',
1302 'callback' => array( $installer, 'createExtensionTables' )
1305 return $this->installSteps
;
1309 * Actually perform the installation.
1311 * @param $startCB Array A callback array for the beginning of each step
1312 * @param $endCB Array A callback array for the end of each step
1314 * @return Array of Status objects
1316 public function performInstallation( $startCB, $endCB ) {
1317 $installResults = array();
1318 $installer = $this->getDBInstaller();
1319 $installer->preInstall();
1320 $steps = $this->getInstallSteps( $installer );
1321 foreach( $steps as $stepObj ) {
1322 $name = $stepObj['name'];
1323 call_user_func_array( $startCB, array( $name ) );
1325 // Perform the callback step
1326 $status = call_user_func( $stepObj['callback'], $installer );
1328 // Output and save the results
1329 call_user_func( $endCB, $name, $status );
1330 $installResults[$name] = $status;
1332 // If we've hit some sort of fatal, we need to bail.
1333 // Callback already had a chance to do output above.
1334 if( !$status->isOk() ) {
1338 if( $status->isOk() ) {
1339 $this->setVar( '_InstallDone', true );
1341 return $installResults;
1345 * Generate $wgSecretKey. Will warn if we had to use mt_rand() instead of
1350 public function generateKeys() {
1351 $keys = array( 'wgSecretKey' => 64 );
1352 if ( strval( $this->getVar( 'wgUpgradeKey' ) ) === '' ) {
1353 $keys['wgUpgradeKey'] = 16;
1355 return $this->doGenerateKeys( $keys );
1359 * Generate a secret value for variables using either
1360 * /dev/urandom or mt_rand(). Produce a warning in the later case.
1362 * @param $keys Array
1365 protected function doGenerateKeys( $keys ) {
1366 $status = Status
::newGood();
1368 wfSuppressWarnings();
1369 $file = fopen( "/dev/urandom", "r" );
1370 wfRestoreWarnings();
1372 foreach ( $keys as $name => $length ) {
1374 $secretKey = bin2hex( fread( $file, $length / 2 ) );
1378 for ( $i = 0; $i < $length / 8; $i++
) {
1379 $secretKey .= dechex( mt_rand( 0, 0x7fffffff ) );
1383 $this->setVar( $name, $secretKey );
1389 $names = array_keys ( $keys );
1390 $names = preg_replace( '/^(.*)$/', '\$$1', $names );
1392 $status->warning( 'config-insecure-keys', $wgLang->listToText( $names ), count( $names ) );
1399 * Create the first user account, grant it sysop and bureaucrat rights
1403 protected function createSysop() {
1404 $name = $this->getVar( '_AdminName' );
1405 $user = User
::newFromName( $name );
1408 // We should've validated this earlier anyway!
1409 return Status
::newFatal( 'config-admin-error-user', $name );
1412 if ( $user->idForName() == 0 ) {
1413 $user->addToDatabase();
1416 $user->setPassword( $this->getVar( '_AdminPassword' ) );
1417 } catch( PasswordError
$pwe ) {
1418 return Status
::newFatal( 'config-admin-error-password', $name, $pwe->getMessage() );
1421 $user->addGroup( 'sysop' );
1422 $user->addGroup( 'bureaucrat' );
1423 if( $this->getVar( '_AdminEmail' ) ) {
1424 $user->setEmail( $this->getVar( '_AdminEmail' ) );
1426 $user->saveSettings();
1428 // Update user count
1429 $ssUpdate = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
1430 $ssUpdate->doUpdate();
1432 $status = Status
::newGood();
1434 if( $this->getVar( '_Subscribe' ) && $this->getVar( '_AdminEmail' ) ) {
1435 $this->subscribeToMediaWikiAnnounce( $status );
1441 private function subscribeToMediaWikiAnnounce( Status
$s ) {
1443 'email' => $this->getVar( '_AdminEmail' ),
1448 // Mailman doesn't support as many languages as we do, so check to make
1449 // sure their selected language is available
1450 $myLang = $this->getVar( '_UserLang' );
1451 if( in_array( $myLang, $this->mediaWikiAnnounceLanguages
) ) {
1452 $myLang = $myLang == 'pt-br' ?
'pt_BR' : $myLang; // rewrite to Mailman's pt_BR
1453 $params['language'] = $myLang;
1456 if( MWHttpRequest
::canMakeRequests() ) {
1457 $res = MWHttpRequest
::factory( $this->mediaWikiAnnounceUrl
,
1458 array( 'method' => 'POST', 'postData' => $params ) )->execute();
1459 if( !$res->isOK() ) {
1460 $s->warning( 'config-install-subscribe-fail', $res->getMessage() );
1463 $s->warning( 'config-install-subscribe-notpossible' );
1468 * Insert Main Page with default content.
1472 protected function createMainpage( DatabaseInstaller
$installer ) {
1473 $status = Status
::newGood();
1475 $article = new Article( Title
::newMainPage() );
1476 $article->doEdit( wfMsgForContent( 'mainpagetext' ) . "\n\n" .
1477 wfMsgForContent( 'mainpagedocfooter' ),
1481 User
::newFromName( 'MediaWiki default' ) );
1482 } catch (MWException
$e) {
1483 //using raw, because $wgShowExceptionDetails can not be set yet
1484 $status->fatal( 'config-install-mainpage-failed', $e->getMessage() );
1491 * Override the necessary bits of the config to run an installation.
1493 public static function overrideConfig() {
1494 define( 'MW_NO_SESSION', 1 );
1496 // Don't access the database
1497 $GLOBALS['wgUseDatabaseMessages'] = false;
1499 $GLOBALS['wgShowExceptionDetails'] = true;
1500 // Don't break forms
1501 $GLOBALS['wgExternalLinkTarget'] = '_blank';
1503 // Extended debugging
1504 $GLOBALS['wgShowSQLErrors'] = true;
1505 $GLOBALS['wgShowDBErrorBacktrace'] = true;
1507 // Allow multiple ob_flush() calls
1508 $GLOBALS['wgDisableOutputCompression'] = true;
1510 // Use a sensible cookie prefix (not my_wiki)
1511 $GLOBALS['wgCookiePrefix'] = 'mw_installer';
1513 // Some of the environment checks make shell requests, remove limits
1514 $GLOBALS['wgMaxShellMemory'] = 0;
1518 * Add an installation step following the given step.
1520 * @param $callback Array A valid installation callback array, in this form:
1521 * array( 'name' => 'some-unique-name', 'callback' => array( $obj, 'function' ) );
1522 * @param $findStep String the step to find. Omit to put the step at the beginning
1524 public function addInstallStep( $callback, $findStep = 'BEGINNING' ) {
1525 $this->extraInstallSteps
[$findStep][] = $callback;
1529 * Disable the time limit for execution.
1530 * Some long-running pages (Install, Upgrade) will want to do this
1532 protected function disableTimeLimit() {
1533 wfSuppressWarnings();
1534 set_time_limit( 0 );
1535 wfRestoreWarnings();