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
{
27 * TODO: make protected?
34 * Cached DB installer instances, access using getDBInstaller().
38 protected $dbInstallers = array();
41 * Minimum memory size in MB.
45 protected $minMemorySize = 50;
48 * Cached Title, used by parse().
52 protected $parserTitle;
55 * Cached ParserOptions, used by parse().
59 protected $parserOptions;
62 * Known database types. These correspond to the class names <type>Installer,
63 * and are also MediaWiki database types valid for $wgDBtype.
65 * To add a new type, create a <type>Installer class and a Database<type>
66 * class, and add a config-type-<type> message to MessagesEn.php.
70 protected static $dbTypes = array(
78 * A list of environment check methods called by doEnvironmentChecks().
79 * These may output warnings using showMessage(), and/or abort the
80 * installation process by returning false.
84 protected $envChecks = array(
87 'envCheckRegisterGlobals',
88 'envCheckMagicQuotes',
89 'envCheckMagicSybase',
100 'envCheckWriteableDir',
102 'envCheckShellLocale',
103 'envCheckUploadsDirectory',
108 * UI interface for displaying a short message
109 * The parameters are like parameters to wfMsg().
110 * The messages will be in wikitext format, which will be converted to an
111 * output format such as HTML or text before being sent to the user.
113 public abstract function showMessage( $msg /*, ... */ );
116 * Constructor, always call this from child classes.
118 public function __construct() {
119 // Disable the i18n cache and LoadBalancer
120 Language
::getLocalisationCache()->disableBackend();
121 LBFactory
::disableBackend();
125 * Get a list of known DB types.
127 public static function getDBTypes() {
128 return self
::$dbTypes;
132 * Do initial checks of the PHP environment. Set variables according to
133 * the observed environment.
135 * It's possible that this may be called under the CLI SAPI, not the SAPI
136 * that the wiki will primarily run under. In that case, the subclass should
137 * initialise variables such as wgScriptPath, before calling this function.
139 * Under the web subclass, it can already be assumed that PHP 5+ is in use
140 * and that sessions are working.
144 public function doEnvironmentChecks() {
145 $this->showMessage( 'config-env-php', phpversion() );
149 foreach ( $this->envChecks
as $check ) {
150 $status = $this->$check();
151 if ( $status === false ) {
156 $this->setVar( '_Environment', $good );
159 $this->showMessage( 'config-env-good' );
161 $this->showMessage( 'config-env-bad' );
168 * Set a MW configuration variable, or internal installer configuration variable.
170 * @param $name String
171 * @param $value Mixed
173 public function setVar( $name, $value ) {
174 $this->settings
[$name] = $value;
178 * Get an MW configuration variable, or internal installer configuration variable.
179 * The defaults come from $GLOBALS (ultimately DefaultSettings.php).
180 * Installer variables are typically prefixed by an underscore.
182 * @param $name String
183 * @param $default Mixed
187 public function getVar( $name, $default = null ) {
188 if ( !isset( $this->settings
[$name] ) ) {
191 return $this->settings
[$name];
196 * Get an instance of DatabaseInstaller for the specified DB type.
198 * @param $type Mixed: DB installer for which is needed, false to use default.
200 * @return DatabaseInstaller
202 public function getDBInstaller( $type = false ) {
204 $type = $this->getVar( 'wgDBtype' );
207 $type = strtolower( $type );
209 if ( !isset( $this->dbInstallers
[$type] ) ) {
210 $class = ucfirst( $type ). 'Installer';
211 $this->dbInstallers
[$type] = new $class( $this );
214 return $this->dbInstallers
[$type];
218 * Determine if LocalSettings exists. If it does, return an appropriate
219 * status for whether we should can upgrade or not.
223 public function getLocalSettingsStatus() {
226 $status = Status
::newGood();
228 wfSuppressWarnings();
229 $ls = file_exists( "$IP/LocalSettings.php" );
233 if( $this->getDBInstaller()->needsUpgrade() ) {
234 $status->warning( 'config-localsettings-upgrade' );
237 $status->fatal( 'config-localsettings-noupgrade' );
245 * Get a fake password for sending back to the user in HTML.
246 * This is a security mechanism to avoid compromise of the password in the
247 * event of session ID compromise.
249 * @param $realPassword String
253 public function getFakePassword( $realPassword ) {
254 return str_repeat( '*', strlen( $realPassword ) );
258 * Set a variable which stores a password, except if the new value is a
259 * fake password in which case leave it as it is.
261 * @param $name String
262 * @param $value Mixed
264 public function setPassword( $name, $value ) {
265 if ( !preg_match( '/^\*+$/', $value ) ) {
266 $this->setVar( $name, $value );
271 * On POSIX systems return the primary group of the webserver we're running under.
272 * On other systems just returns null.
274 * This is used to advice the user that he should chgrp his config/data/images directory as the
275 * webserver user before he can install.
277 * Public because SqliteInstaller needs it, and doesn't subclass Installer.
281 public static function maybeGetWebserverPrimaryGroup() {
282 if ( !function_exists( 'posix_getegid' ) ||
!function_exists( 'posix_getpwuid' ) ) {
283 # I don't know this, this isn't UNIX.
287 # posix_getegid() *not* getmygid() because we want the group of the webserver,
288 # not whoever owns the current script.
289 $gid = posix_getegid();
290 $getpwuid = posix_getpwuid( $gid );
291 $group = $getpwuid['name'];
297 * Convert wikitext $text to HTML.
299 * This is potentially error prone since many parser features require a complete
300 * installed MW database. The solution is to just not use those features when you
301 * write your messages. This appears to work well enough. Basic formatting and
302 * external links work just fine.
304 * But in case a translator decides to throw in a #ifexist or internal link or
305 * whatever, this function is guarded to catch attempted DB access and to present
306 * some fallback text.
308 * @param $text String
309 * @param $lineStart Boolean
312 public function parse( $text, $lineStart = false ) {
316 $out = $wgParser->parse( $text, $this->parserTitle
, $this->parserOptions
, $lineStart );
317 $html = $out->getText();
318 } catch ( DBAccessError
$e ) {
319 $html = '<!--DB access attempted during parse--> ' . htmlspecialchars( $text );
321 if ( !empty( $this->debug
) ) {
322 $html .= "<!--\n" . $e->getTraceAsString() . "\n-->";
332 * @param $installer DatabaseInstaller
336 public function installDatabase( DatabaseInstaller
&$installer ) {
338 $type = $this->getVar( 'wgDBtype' );
339 $status = Status
::newFatal( "config-no-db", $type );
341 $status = $installer->setupDatabase();
350 * @param $installer DatabaseInstaller
354 public function installTables( DatabaseInstaller
&$installer ) {
355 $status = $installer->createTables();
357 if( $status->isOK() ) {
358 LBFactory
::enableBackend();
367 * @param $installer DatabaseInstaller
371 public function installInterwiki( DatabaseInstaller
&$installer ) {
372 return $installer->populateInterwikiTable();
378 * @param $installer DatabaseInstaller
382 public function installMainpage( DatabaseInstaller
&$installer ) {
383 return $installer->createMainpage();
387 * Exports all wg* variables stored by the installer into global scope.
389 public function exportVars() {
390 foreach ( $this->settings
as $name => $value ) {
391 if ( substr( $name, 0, 2 ) == 'wg' ) {
392 $GLOBALS[$name] = $value;
398 * Check if we're installing the latest version.
400 public function envLatestVersion() {
403 $repository = wfGetRepository();
404 $currentVersion = $repository->getLatestCoreVersion();
406 $this->setVar( '_ExternalHTTP', true );
408 if ( $currentVersion === false ) {
409 # For when the request is successful but there's e.g. some silly man in
410 # the middle firewall blocking us, e.g. one of those annoying airport ones
411 $this->showMessage( 'config-env-latest-can-not-check', $repository->getLocation() );
415 if( version_compare( $wgVersion, $currentVersion, '<' ) ) {
416 $this->showMessage( 'config-env-latest-old' );
417 // FIXME: this only works for the web installer!
418 $this->showHelpBox( 'config-env-latest-help', $wgVersion, $currentVersion );
419 } elseif( version_compare( $wgVersion, $currentVersion, '>' ) ) {
420 $this->showMessage( 'config-env-latest-new' );
423 $this->showMessage( 'config-env-latest-ok' );
427 * Environment check for DB types.
429 public function envCheckDB() {
432 $compiledDBs = array();
433 $goodNames = array();
436 foreach ( self
::getDBTypes() as $name ) {
437 $db = $this->getDBInstaller( $name );
438 $readableName = wfMsg( 'config-type-' . $name );
440 if ( $db->isCompiled() ) {
441 $compiledDBs[] = $name;
442 $goodNames[] = $readableName;
445 $allNames[] = $readableName;
448 $this->setVar( '_CompiledDBs', $compiledDBs );
450 if ( !$compiledDBs ) {
451 $this->showMessage( 'config-no-db' );
452 // FIXME: this only works for the web installer!
453 $this->showHelpBox( 'config-no-db-help', $wgLang->commaList( $allNames ) );
457 $this->showMessage( 'config-have-db', $wgLang->listToText( $goodNames ), count( $goodNames ) );
459 // Check for FTS3 full-text search module
460 $sqlite = $this->getDBInstaller( 'sqlite' );
461 if ( $sqlite->isCompiled() ) {
462 $db = new DatabaseSqliteStandalone( ':memory:' );
463 $this->showMessage( $db->getFulltextSearchModule() == 'FTS3'
471 * Environment check for register_globals.
473 public function envCheckRegisterGlobals() {
474 if( wfIniGetBool( "magic_quotes_runtime" ) ) {
475 $this->showMessage( 'config-register-globals' );
480 * Environment check for magic_quotes_runtime.
482 public function envCheckMagicQuotes() {
483 if( wfIniGetBool( "magic_quotes_runtime" ) ) {
484 $this->showMessage( 'config-magic-quotes-runtime' );
490 * Environment check for magic_quotes_sybase.
492 public function envCheckMagicSybase() {
493 if ( wfIniGetBool( 'magic_quotes_sybase' ) ) {
494 $this->showMessage( 'config-magic-quotes-sybase' );
500 * Environment check for mbstring.func_overload.
502 public function envCheckMbstring() {
503 if ( wfIniGetBool( 'mbstring.func_overload' ) ) {
504 $this->showMessage( 'config-mbstring' );
510 * Environment check for zend.ze1_compatibility_mode.
512 public function envCheckZE1() {
513 if ( wfIniGetBool( 'zend.ze1_compatibility_mode' ) ) {
514 $this->showMessage( 'config-ze1' );
520 * Environment check for safe_mode.
522 public function envCheckSafeMode() {
523 if ( wfIniGetBool( 'safe_mode' ) ) {
524 $this->setVar( '_SafeMode', true );
525 $this->showMessage( 'config-safe-mode' );
530 * Environment check for the XML module.
532 public function envCheckXML() {
533 if ( !function_exists( "utf8_encode" ) ) {
534 $this->showMessage( 'config-xml-bad' );
537 $this->showMessage( 'config-xml-good' );
541 * Environment check for the PCRE module.
543 public function envCheckPCRE() {
544 if ( !function_exists( 'preg_match' ) ) {
545 $this->showMessage( 'config-pcre' );
551 * Environment check for available memory.
553 public function envCheckMemory() {
554 $limit = ini_get( 'memory_limit' );
556 if ( !$limit ||
$limit == -1 ) {
557 $this->showMessage( 'config-memory-none' );
561 $n = intval( $limit );
563 if( preg_match( '/^([0-9]+)[Mm]$/', trim( $limit ), $m ) ) {
564 $n = intval( $m[1] * ( 1024 * 1024 ) );
567 if( $n < $this->minMemorySize
* 1024 * 1024 ) {
568 $newLimit = "{$this->minMemorySize}M";
570 if( ini_set( "memory_limit", $newLimit ) === false ) {
571 $this->showMessage( 'config-memory-bad', $limit );
573 $this->showMessage( 'config-memory-raised', $limit, $newLimit );
574 $this->setVar( '_RaiseMemory', true );
577 $this->showMessage( 'config-memory-ok', $limit );
582 * Environment check for compiled object cache types.
584 public function envCheckCache() {
587 foreach ( $this->objectCaches
as $name => $function ) {
588 if ( function_exists( $function ) ) {
589 $caches[$name] = true;
590 $this->showMessage( 'config-' . $name );
595 $this->showMessage( 'config-no-cache' );
598 $this->setVar( '_Caches', $caches );
602 * Search for GNU diff3.
604 public function envCheckDiff3() {
605 $names = array( "gdiff3", "diff3", "diff3.exe" );
606 $versionInfo = array( '$1 --version 2>&1', 'diff3 (GNU diffutils)' );
608 $diff3 = $this->locateExecutableInDefaultPaths( $names, $versionInfo );
611 $this->showMessage( 'config-diff3-good', $diff3 );
612 $this->setVar( 'wgDiff3', $diff3 );
614 $this->setVar( 'wgDiff3', false );
615 $this->showMessage( 'config-diff3-bad' );
620 * Environment check for ImageMagick and GD.
622 public function envCheckGraphics() {
623 $names = array( wfIsWindows() ?
'convert.exe' : 'convert' );
624 $convert = $this->locateExecutableInDefaultPaths( $names, array( '$1 -version', 'ImageMagick' ) );
627 $this->setVar( 'wgImageMagickConvertCommand', $convert );
628 $this->showMessage( 'config-imagemagick', $convert );
630 } elseif ( function_exists( 'imagejpeg' ) ) {
631 $this->showMessage( 'config-gd' );
634 $this->showMessage( 'no-scaling' );
639 * Environment check for setting $IP and $wgScriptPath.
641 public function envCheckPath() {
643 $IP = dirname( dirname( dirname( __FILE__
) ) );
645 $this->setVar( 'IP', $IP );
646 $this->showMessage( 'config-dir', $IP );
648 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
649 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
650 // to get the path to the current script... hopefully it's reliable. SIGH
651 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
652 $path = $_SERVER['PHP_SELF'];
653 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
654 $path = $_SERVER['SCRIPT_NAME'];
655 } elseif ( $this->getVar( 'wgScriptPath' ) ) {
656 // Some kind soul has set it for us already (e.g. debconf)
659 $this->showMessage( 'config-no-uri' );
663 $uri = preg_replace( '{^(.*)/config.*$}', '$1', $path );
664 $this->setVar( 'wgScriptPath', $uri );
665 $this->showMessage( 'config-uri', $uri );
669 * Environment check for writable config/ directory.
671 public function envCheckWriteableDir() {
672 $ipDir = $this->getVar( 'IP' );
673 $configDir = $ipDir . '/config';
675 if( !is_writeable( $configDir ) ) {
676 $webserverGroup = self
::maybeGetWebserverPrimaryGroup();
678 if ( $webserverGroup !== null ) {
679 $this->showMessage( 'config-dir-not-writable-group', $ipDir, $webserverGroup );
681 $this->showMessage( 'config-dir-not-writable-nogroup', $ipDir, $webserverGroup );
689 * Environment check for setting the preferred PHP file extension.
691 public function envCheckExtension() {
692 // FIXME: detect this properly
693 if ( defined( 'MW_INSTALL_PHP5_EXT' ) ) {
699 $this->setVar( 'wgScriptExtension', ".$ext" );
700 $this->showMessage( 'config-file-extension', $ext );
706 public function envCheckShellLocale() {
707 $os = php_uname( 's' );
708 $supported = array( 'Linux', 'SunOS', 'HP-UX', 'Darwin' ); # Tested these
710 if ( !in_array( $os, $supported ) ) {
714 # Get a list of available locales.
715 $lines = $ret = false;
716 $lines = wfShellExec( '/usr/bin/locale -a', $ret );
722 $lines = wfArrayMap( 'trim', explode( "\n", $lines ) );
723 $candidatesByLocale = array();
724 $candidatesByLang = array();
726 foreach ( $lines as $line ) {
727 if ( $line === '' ) {
731 if ( !preg_match( '/^([a-zA-Z]+)(_[a-zA-Z]+|)\.(utf8|UTF-8)(@[a-zA-Z_]*|)$/i', $line, $m ) ) {
735 list( $all, $lang, $territory, $charset, $modifier ) = $m;
737 $candidatesByLocale[$m[0]] = $m;
738 $candidatesByLang[$lang][] = $m;
741 # Try the current value of LANG.
742 if ( isset( $candidatesByLocale[ getenv( 'LANG' ) ] ) ) {
743 $this->setVar( 'wgShellLocale', getenv( 'LANG' ) );
744 $this->showMessage( 'config-shell-locale', getenv( 'LANG' ) );
748 # Try the most common ones.
749 $commonLocales = array( 'en_US.UTF-8', 'en_US.utf8', 'de_DE.UTF-8', 'de_DE.utf8' );
750 foreach ( $commonLocales as $commonLocale ) {
751 if ( isset( $candidatesByLocale[$commonLocale] ) ) {
752 $this->setVar( 'wgShellLocale', $commonLocale );
753 $this->showMessage( 'config-shell-locale', $commonLocale );
758 # Is there an available locale in the Wiki's language?
759 $wikiLang = $this->getVar( 'wgLanguageCode' );
761 if ( isset( $candidatesByLang[$wikiLang] ) ) {
762 $m = reset( $candidatesByLang[$wikiLang] );
763 $this->setVar( 'wgShellLocale', $m[0] );
764 $this->showMessage( 'config-shell-locale', $m[0] );
768 # Are there any at all?
769 if ( count( $candidatesByLocale ) ) {
770 $m = reset( $candidatesByLocale );
771 $this->setVar( 'wgShellLocale', $m[0] );
772 $this->showMessage( 'config-shell-locale', $m[0] );
783 public function envCheckUploadsDirectory() {
784 global $IP, $wgServer;
786 $dir = $IP . '/images/';
787 $url = $wgServer . $this->getVar( 'wgScriptPath' ) . '/images/';
788 $safe = !$this->dirIsExecutable( $dir, $url );
791 $this->showMessage( 'config-uploads-safe' );
793 $this->showMessage( 'config-uploads-not-safe', $dir );
798 * Convert a hex string representing a Unicode code point to that code point.
802 protected function unicodeChar( $c ) {
806 } else if ($c <= 0x7FF) {
807 return chr(0xC0 |
$c >> 6) . chr(0x80 |
$c & 0x3F);
808 } else if ($c <= 0xFFFF) {
809 return chr(0xE0 |
$c >> 12) . chr(0x80 |
$c >> 6 & 0x3F)
810 . chr(0x80 |
$c & 0x3F);
811 } else if ($c <= 0x10FFFF) {
812 return chr(0xF0 |
$c >> 18) . chr(0x80 |
$c >> 12 & 0x3F)
813 . chr(0x80 |
$c >> 6 & 0x3F)
814 . chr(0x80 |
$c & 0x3F);
822 * Check the libicu version
824 public function envCheckLibicu() {
825 $utf8 = function_exists( 'utf8_normalize' );
826 $intl = function_exists( 'normalizer_normalize' );
829 * This needs to be updated something that the latest libicu
830 * will properly normalize. This normalization was found at
831 * http://www.unicode.org/versions/Unicode5.2.0/#Character_Additions
832 * Note that we use the hex representation to create the code
833 * points in order to avoid any Unicode-destroying during transit.
835 $not_normal_c = $this->unicodeChar("FA6C");
836 $normal_c = $this->unicodeChar("242EE");
838 $useNormalizer = 'php';
839 $needsUpdate = false;
842 * We're going to prefer the pecl extension here unless
843 * utf8_normalize is more up to date.
846 $useNormalizer = 'utf8';
847 $utf8 = utf8_normalize( $not_normal_c, UNORM_NFC
);
848 if ( $utf8 !== $normal_c ) $needsUpdate = true;
851 $useNormalizer = 'intl';
852 $intl = normalizer_normalize( $not_normal_c, Normalizer
::FORM_C
);
853 if ( $intl !== $normal_c ) $needsUpdate = true;
856 // Uses messages 'config-unicode-using-php', 'config-unicode-using-utf8', 'config-unicode-using-intl'
857 $this->showMessage( 'config-unicode-using-' . $useNormalizer );
858 if( $useNormalizer === 'php' ) {
859 $this->showMessage( 'config-unicode-pure-php-warning' );
860 } elseif( $needsUpdate ) {
861 $this->showMessage( 'config-unicode-update-warning' );
866 * Get an array of likely places we can find executables. Check a bunch
867 * of known Unix-like defaults, as well as the PATH environment variable
868 * (which should maybe make it work for Windows?)
872 protected function getPossibleBinPaths() {
874 array( '/usr/bin', '/usr/local/bin', '/opt/csw/bin',
875 '/usr/gnu/bin', '/usr/sfw/bin', '/sw/bin', '/opt/local/bin' ),
876 explode( PATH_SEPARATOR
, getenv( 'PATH' ) )
881 * Search a path for any of the given executable names. Returns the
882 * executable name if found. Also checks the version string returned
883 * by each executable.
885 * Used only by environment checks.
887 * @param $path String: path to search
888 * @param $names Array of executable names
889 * @param $versionInfo Boolean false or array with two members:
890 * 0 => Command to run for version check, with $1 for the path
891 * 1 => String to compare the output with
893 * If $versionInfo is not false, only executables with a version
894 * matching $versionInfo[1] will be returned.
896 protected function locateExecutable( $path, $names, $versionInfo = false ) {
897 if ( !is_array( $names ) ) {
898 $names = array( $names );
901 foreach ( $names as $name ) {
902 $command = $path . DIRECTORY_SEPARATOR
. $name;
904 wfSuppressWarnings();
905 $file_exists = file_exists( $command );
908 if ( $file_exists ) {
909 if ( !$versionInfo ) {
913 if ( wfIsWindows() ) {
914 $command = "\"$command\"";
916 $file = str_replace( '$1', $command, $versionInfo[0] );
917 if ( strstr( wfShellExec( $file ), $versionInfo[1]) !== false ) {
926 * Same as locateExecutable(), but checks in getPossibleBinPaths() by default
927 * @see locateExecutable()
929 protected function locateExecutableInDefaultPaths( $names, $versionInfo = false ) {
930 foreach( $this->getPossibleBinPaths() as $path ) {
931 $exe = $this->locateExecutable( $path, $names, $versionInfo );
932 if( $exe !== false ) {
940 * Checks if scripts located in the given directory can be executed via the given URL.
942 * Used only by environment checks.
944 public function dirIsExecutable( $dir, $url ) {
945 $scriptTypes = array(
947 "<?php echo 'ex' . 'ec';",
948 "#!/var/env php5\n<?php echo 'ex' . 'ec';",
952 // it would be good to check other popular languages here, but it'll be slow.
954 wfSuppressWarnings();
956 foreach ( $scriptTypes as $ext => $contents ) {
957 foreach ( $contents as $source ) {
958 $file = 'exectest.' . $ext;
960 if ( !file_put_contents( $dir . $file, $source ) ) {
964 $text = Http
::get( $url . $file );
965 unlink( $dir . $file );
967 if ( $text == 'exec' ) {