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