Merge "resources: Remove the deprecated 'jquery.badge' module"
[lhc/web/wiklou.git] / includes / installer / Installer.php
1 <?php
2 /**
3 * Base code for MediaWiki installer.
4 *
5 * DO NOT PATCH THIS FILE IF YOU NEED TO CHANGE INSTALLER BEHAVIOR IN YOUR PACKAGE!
6 * See mw-config/overrides/README for details.
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
22 *
23 * @file
24 * @ingroup Deployment
25 */
26 use MediaWiki\MediaWikiServices;
27
28 /**
29 * This documentation group collects source code files with deployment functionality.
30 *
31 * @defgroup Deployment Deployment
32 */
33
34 /**
35 * Base installer class.
36 *
37 * This class provides the base for installation and update functionality
38 * for both MediaWiki core and extensions.
39 *
40 * @ingroup Deployment
41 * @since 1.17
42 */
43 abstract class Installer {
44
45 /**
46 * The oldest version of PCRE we can support.
47 *
48 * Defining this is necessary because PHP may be linked with a system version
49 * of PCRE, which may be older than that bundled with the minimum PHP version.
50 */
51 const MINIMUM_PCRE_VERSION = '7.2';
52
53 /**
54 * @var array
55 */
56 protected $settings;
57
58 /**
59 * List of detected DBs, access using getCompiledDBs().
60 *
61 * @var array
62 */
63 protected $compiledDBs;
64
65 /**
66 * Cached DB installer instances, access using getDBInstaller().
67 *
68 * @var array
69 */
70 protected $dbInstallers = [];
71
72 /**
73 * Minimum memory size in MB.
74 *
75 * @var int
76 */
77 protected $minMemorySize = 50;
78
79 /**
80 * Cached Title, used by parse().
81 *
82 * @var Title
83 */
84 protected $parserTitle;
85
86 /**
87 * Cached ParserOptions, used by parse().
88 *
89 * @var ParserOptions
90 */
91 protected $parserOptions;
92
93 /**
94 * Known database types. These correspond to the class names <type>Installer,
95 * and are also MediaWiki database types valid for $wgDBtype.
96 *
97 * To add a new type, create a <type>Installer class and a Database<type>
98 * class, and add a config-type-<type> message to MessagesEn.php.
99 *
100 * @var array
101 */
102 protected static $dbTypes = [
103 'mysql',
104 'postgres',
105 'oracle',
106 'mssql',
107 'sqlite',
108 ];
109
110 /**
111 * A list of environment check methods called by doEnvironmentChecks().
112 * These may output warnings using showMessage(), and/or abort the
113 * installation process by returning false.
114 *
115 * For the WebInstaller these are only called on the Welcome page,
116 * if these methods have side-effects that should affect later page loads
117 * (as well as the generated stylesheet), use envPreps instead.
118 *
119 * @var array
120 */
121 protected $envChecks = [
122 'envCheckDB',
123 'envCheckBrokenXML',
124 'envCheckPCRE',
125 'envCheckMemory',
126 'envCheckCache',
127 'envCheckModSecurity',
128 'envCheckDiff3',
129 'envCheckGraphics',
130 'envCheckGit',
131 'envCheckServer',
132 'envCheckPath',
133 'envCheckShellLocale',
134 'envCheckUploadsDirectory',
135 'envCheckLibicu',
136 'envCheckSuhosinMaxValueLength',
137 'envCheck64Bit',
138 ];
139
140 /**
141 * A list of environment preparation methods called by doEnvironmentPreps().
142 *
143 * @var array
144 */
145 protected $envPreps = [
146 'envPrepServer',
147 'envPrepPath',
148 ];
149
150 /**
151 * MediaWiki configuration globals that will eventually be passed through
152 * to LocalSettings.php. The names only are given here, the defaults
153 * typically come from DefaultSettings.php.
154 *
155 * @var array
156 */
157 protected $defaultVarNames = [
158 'wgSitename',
159 'wgPasswordSender',
160 'wgLanguageCode',
161 'wgRightsIcon',
162 'wgRightsText',
163 'wgRightsUrl',
164 'wgEnableEmail',
165 'wgEnableUserEmail',
166 'wgEnotifUserTalk',
167 'wgEnotifWatchlist',
168 'wgEmailAuthentication',
169 'wgDBname',
170 'wgDBtype',
171 'wgDiff3',
172 'wgImageMagickConvertCommand',
173 'wgGitBin',
174 'IP',
175 'wgScriptPath',
176 'wgMetaNamespace',
177 'wgDeletedDirectory',
178 'wgEnableUploads',
179 'wgShellLocale',
180 'wgSecretKey',
181 'wgUseInstantCommons',
182 'wgUpgradeKey',
183 'wgDefaultSkin',
184 'wgPingback',
185 ];
186
187 /**
188 * Variables that are stored alongside globals, and are used for any
189 * configuration of the installation process aside from the MediaWiki
190 * configuration. Map of names to defaults.
191 *
192 * @var array
193 */
194 protected $internalDefaults = [
195 '_UserLang' => 'en',
196 '_Environment' => false,
197 '_RaiseMemory' => false,
198 '_UpgradeDone' => false,
199 '_InstallDone' => false,
200 '_Caches' => [],
201 '_InstallPassword' => '',
202 '_SameAccount' => true,
203 '_CreateDBAccount' => false,
204 '_NamespaceType' => 'site-name',
205 '_AdminName' => '', // will be set later, when the user selects language
206 '_AdminPassword' => '',
207 '_AdminPasswordConfirm' => '',
208 '_AdminEmail' => '',
209 '_Subscribe' => false,
210 '_SkipOptional' => 'continue',
211 '_RightsProfile' => 'wiki',
212 '_LicenseCode' => 'none',
213 '_CCDone' => false,
214 '_Extensions' => [],
215 '_Skins' => [],
216 '_MemCachedServers' => '',
217 '_UpgradeKeySupplied' => false,
218 '_ExistingDBSettings' => false,
219
220 // $wgLogo is probably wrong (T50084); set something that will work.
221 // Single quotes work fine here, as LocalSettingsGenerator outputs this unescaped.
222 'wgLogo' => '$wgResourceBasePath/resources/assets/wiki.png',
223 'wgAuthenticationTokenVersion' => 1,
224 ];
225
226 /**
227 * The actual list of installation steps. This will be initialized by getInstallSteps()
228 *
229 * @var array
230 */
231 private $installSteps = [];
232
233 /**
234 * Extra steps for installation, for things like DatabaseInstallers to modify
235 *
236 * @var array
237 */
238 protected $extraInstallSteps = [];
239
240 /**
241 * Known object cache types and the functions used to test for their existence.
242 *
243 * @var array
244 */
245 protected $objectCaches = [
246 'xcache' => 'xcache_get',
247 'apc' => 'apc_fetch',
248 'apcu' => 'apcu_fetch',
249 'wincache' => 'wincache_ucache_get'
250 ];
251
252 /**
253 * User rights profiles.
254 *
255 * @var array
256 */
257 public $rightsProfiles = [
258 'wiki' => [],
259 'no-anon' => [
260 '*' => [ 'edit' => false ]
261 ],
262 'fishbowl' => [
263 '*' => [
264 'createaccount' => false,
265 'edit' => false,
266 ],
267 ],
268 'private' => [
269 '*' => [
270 'createaccount' => false,
271 'edit' => false,
272 'read' => false,
273 ],
274 ],
275 ];
276
277 /**
278 * License types.
279 *
280 * @var array
281 */
282 public $licenses = [
283 'cc-by' => [
284 'url' => 'https://creativecommons.org/licenses/by/4.0/',
285 'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-by.png',
286 ],
287 'cc-by-sa' => [
288 'url' => 'https://creativecommons.org/licenses/by-sa/4.0/',
289 'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-by-sa.png',
290 ],
291 'cc-by-nc-sa' => [
292 'url' => 'https://creativecommons.org/licenses/by-nc-sa/4.0/',
293 'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-by-nc-sa.png',
294 ],
295 'cc-0' => [
296 'url' => 'https://creativecommons.org/publicdomain/zero/1.0/',
297 'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-0.png',
298 ],
299 'gfdl' => [
300 'url' => 'https://www.gnu.org/copyleft/fdl.html',
301 'icon' => '$wgResourceBasePath/resources/assets/licenses/gnu-fdl.png',
302 ],
303 'none' => [
304 'url' => '',
305 'icon' => '',
306 'text' => ''
307 ],
308 'cc-choose' => [
309 // Details will be filled in by the selector.
310 'url' => '',
311 'icon' => '',
312 'text' => '',
313 ],
314 ];
315
316 /**
317 * URL to mediawiki-announce subscription
318 */
319 protected $mediaWikiAnnounceUrl =
320 'https://lists.wikimedia.org/mailman/subscribe/mediawiki-announce';
321
322 /**
323 * Supported language codes for Mailman
324 */
325 protected $mediaWikiAnnounceLanguages = [
326 'ca', 'cs', 'da', 'de', 'en', 'es', 'et', 'eu', 'fi', 'fr', 'hr', 'hu',
327 'it', 'ja', 'ko', 'lt', 'nl', 'no', 'pl', 'pt', 'pt-br', 'ro', 'ru',
328 'sl', 'sr', 'sv', 'tr', 'uk'
329 ];
330
331 /**
332 * UI interface for displaying a short message
333 * The parameters are like parameters to wfMessage().
334 * The messages will be in wikitext format, which will be converted to an
335 * output format such as HTML or text before being sent to the user.
336 * @param string $msg
337 */
338 abstract public function showMessage( $msg /*, ... */ );
339
340 /**
341 * Same as showMessage(), but for displaying errors
342 * @param string $msg
343 */
344 abstract public function showError( $msg /*, ... */ );
345
346 /**
347 * Show a message to the installing user by using a Status object
348 * @param Status $status
349 */
350 abstract public function showStatusMessage( Status $status );
351
352 /**
353 * Constructs a Config object that contains configuration settings that should be
354 * overwritten for the installation process.
355 *
356 * @since 1.27
357 *
358 * @param Config $baseConfig
359 *
360 * @return Config The config to use during installation.
361 */
362 public static function getInstallerConfig( Config $baseConfig ) {
363 $configOverrides = new HashConfig();
364
365 // disable (problematic) object cache types explicitly, preserving all other (working) ones
366 // bug T113843
367 $emptyCache = [ 'class' => 'EmptyBagOStuff' ];
368
369 $objectCaches = [
370 CACHE_NONE => $emptyCache,
371 CACHE_DB => $emptyCache,
372 CACHE_ANYTHING => $emptyCache,
373 CACHE_MEMCACHED => $emptyCache,
374 ] + $baseConfig->get( 'ObjectCaches' );
375
376 $configOverrides->set( 'ObjectCaches', $objectCaches );
377
378 // Load the installer's i18n.
379 $messageDirs = $baseConfig->get( 'MessagesDirs' );
380 $messageDirs['MediawikiInstaller'] = __DIR__ . '/i18n';
381
382 $configOverrides->set( 'MessagesDirs', $messageDirs );
383
384 $installerConfig = new MultiConfig( [ $configOverrides, $baseConfig ] );
385
386 // make sure we use the installer config as the main config
387 $configRegistry = $baseConfig->get( 'ConfigRegistry' );
388 $configRegistry['main'] = function () use ( $installerConfig ) {
389 return $installerConfig;
390 };
391
392 $configOverrides->set( 'ConfigRegistry', $configRegistry );
393
394 return $installerConfig;
395 }
396
397 /**
398 * Constructor, always call this from child classes.
399 */
400 public function __construct() {
401 global $wgMemc, $wgUser, $wgObjectCaches;
402
403 $defaultConfig = new GlobalVarConfig(); // all the stuff from DefaultSettings.php
404 $installerConfig = self::getInstallerConfig( $defaultConfig );
405
406 // Reset all services and inject config overrides
407 MediaWiki\MediaWikiServices::resetGlobalInstance( $installerConfig );
408
409 // Don't attempt to load user language options (T126177)
410 // This will be overridden in the web installer with the user-specified language
411 RequestContext::getMain()->setLanguage( 'en' );
412
413 // Disable the i18n cache
414 // TODO: manage LocalisationCache singleton in MediaWikiServices
415 Language::getLocalisationCache()->disableBackend();
416
417 // Disable all global services, since we don't have any configuration yet!
418 MediaWiki\MediaWikiServices::disableStorageBackend();
419
420 // Disable object cache (otherwise CACHE_ANYTHING will try CACHE_DB and
421 // SqlBagOStuff will then throw since we just disabled wfGetDB)
422 $wgObjectCaches = MediaWikiServices::getInstance()->getMainConfig()->get( 'ObjectCaches' );
423 $wgMemc = ObjectCache::getInstance( CACHE_NONE );
424
425 // Having a user with id = 0 safeguards us from DB access via User::loadOptions().
426 $wgUser = User::newFromId( 0 );
427 RequestContext::getMain()->setUser( $wgUser );
428
429 $this->settings = $this->internalDefaults;
430
431 foreach ( $this->defaultVarNames as $var ) {
432 $this->settings[$var] = $GLOBALS[$var];
433 }
434
435 $this->doEnvironmentPreps();
436
437 $this->compiledDBs = [];
438 foreach ( self::getDBTypes() as $type ) {
439 $installer = $this->getDBInstaller( $type );
440
441 if ( !$installer->isCompiled() ) {
442 continue;
443 }
444 $this->compiledDBs[] = $type;
445 }
446
447 $this->parserTitle = Title::newFromText( 'Installer' );
448 $this->parserOptions = new ParserOptions( $wgUser ); // language will be wrong :(
449 $this->parserOptions->setEditSection( false );
450 $this->parserOptions->setWrapOutputClass( false );
451 // Don't try to access DB before user language is initialised
452 $this->setParserLanguage( Language::factory( 'en' ) );
453 }
454
455 /**
456 * Get a list of known DB types.
457 *
458 * @return array
459 */
460 public static function getDBTypes() {
461 return self::$dbTypes;
462 }
463
464 /**
465 * Do initial checks of the PHP environment. Set variables according to
466 * the observed environment.
467 *
468 * It's possible that this may be called under the CLI SAPI, not the SAPI
469 * that the wiki will primarily run under. In that case, the subclass should
470 * initialise variables such as wgScriptPath, before calling this function.
471 *
472 * Under the web subclass, it can already be assumed that PHP 5+ is in use
473 * and that sessions are working.
474 *
475 * @return Status
476 */
477 public function doEnvironmentChecks() {
478 // Php version has already been checked by entry scripts
479 // Show message here for information purposes
480 if ( wfIsHHVM() ) {
481 $this->showMessage( 'config-env-hhvm', HHVM_VERSION );
482 } else {
483 $this->showMessage( 'config-env-php', PHP_VERSION );
484 }
485
486 $good = true;
487 // Must go here because an old version of PCRE can prevent other checks from completing
488 list( $pcreVersion ) = explode( ' ', PCRE_VERSION, 2 );
489 if ( version_compare( $pcreVersion, self::MINIMUM_PCRE_VERSION, '<' ) ) {
490 $this->showError( 'config-pcre-old', self::MINIMUM_PCRE_VERSION, $pcreVersion );
491 $good = false;
492 } else {
493 foreach ( $this->envChecks as $check ) {
494 $status = $this->$check();
495 if ( $status === false ) {
496 $good = false;
497 }
498 }
499 }
500
501 $this->setVar( '_Environment', $good );
502
503 return $good ? Status::newGood() : Status::newFatal( 'config-env-bad' );
504 }
505
506 public function doEnvironmentPreps() {
507 foreach ( $this->envPreps as $prep ) {
508 $this->$prep();
509 }
510 }
511
512 /**
513 * Set a MW configuration variable, or internal installer configuration variable.
514 *
515 * @param string $name
516 * @param mixed $value
517 */
518 public function setVar( $name, $value ) {
519 $this->settings[$name] = $value;
520 }
521
522 /**
523 * Get an MW configuration variable, or internal installer configuration variable.
524 * The defaults come from $GLOBALS (ultimately DefaultSettings.php).
525 * Installer variables are typically prefixed by an underscore.
526 *
527 * @param string $name
528 * @param mixed $default
529 *
530 * @return mixed
531 */
532 public function getVar( $name, $default = null ) {
533 if ( !isset( $this->settings[$name] ) ) {
534 return $default;
535 } else {
536 return $this->settings[$name];
537 }
538 }
539
540 /**
541 * Get a list of DBs supported by current PHP setup
542 *
543 * @return array
544 */
545 public function getCompiledDBs() {
546 return $this->compiledDBs;
547 }
548
549 /**
550 * Get the DatabaseInstaller class name for this type
551 *
552 * @param string $type database type ($wgDBtype)
553 * @return string Class name
554 * @since 1.30
555 */
556 public static function getDBInstallerClass( $type ) {
557 return ucfirst( $type ) . 'Installer';
558 }
559
560 /**
561 * Get an instance of DatabaseInstaller for the specified DB type.
562 *
563 * @param mixed $type DB installer for which is needed, false to use default.
564 *
565 * @return DatabaseInstaller
566 */
567 public function getDBInstaller( $type = false ) {
568 if ( !$type ) {
569 $type = $this->getVar( 'wgDBtype' );
570 }
571
572 $type = strtolower( $type );
573
574 if ( !isset( $this->dbInstallers[$type] ) ) {
575 $class = self::getDBInstallerClass( $type );
576 $this->dbInstallers[$type] = new $class( $this );
577 }
578
579 return $this->dbInstallers[$type];
580 }
581
582 /**
583 * Determine if LocalSettings.php exists. If it does, return its variables.
584 *
585 * @return array|false
586 */
587 public static function getExistingLocalSettings() {
588 global $IP;
589
590 // You might be wondering why this is here. Well if you don't do this
591 // then some poorly-formed extensions try to call their own classes
592 // after immediately registering them. We really need to get extension
593 // registration out of the global scope and into a real format.
594 // @see https://phabricator.wikimedia.org/T69440
595 global $wgAutoloadClasses;
596 $wgAutoloadClasses = [];
597
598 // @codingStandardsIgnoreStart
599 // LocalSettings.php should not call functions, except wfLoadSkin/wfLoadExtensions
600 // Define the required globals here, to ensure, the functions can do it work correctly.
601 global $wgExtensionDirectory, $wgStyleDirectory;
602 // @codingStandardsIgnoreEnd
603
604 MediaWiki\suppressWarnings();
605 $_lsExists = file_exists( "$IP/LocalSettings.php" );
606 MediaWiki\restoreWarnings();
607
608 if ( !$_lsExists ) {
609 return false;
610 }
611 unset( $_lsExists );
612
613 require "$IP/includes/DefaultSettings.php";
614 require "$IP/LocalSettings.php";
615
616 return get_defined_vars();
617 }
618
619 /**
620 * Get a fake password for sending back to the user in HTML.
621 * This is a security mechanism to avoid compromise of the password in the
622 * event of session ID compromise.
623 *
624 * @param string $realPassword
625 *
626 * @return string
627 */
628 public function getFakePassword( $realPassword ) {
629 return str_repeat( '*', strlen( $realPassword ) );
630 }
631
632 /**
633 * Set a variable which stores a password, except if the new value is a
634 * fake password in which case leave it as it is.
635 *
636 * @param string $name
637 * @param mixed $value
638 */
639 public function setPassword( $name, $value ) {
640 if ( !preg_match( '/^\*+$/', $value ) ) {
641 $this->setVar( $name, $value );
642 }
643 }
644
645 /**
646 * On POSIX systems return the primary group of the webserver we're running under.
647 * On other systems just returns null.
648 *
649 * This is used to advice the user that he should chgrp his mw-config/data/images directory as the
650 * webserver user before he can install.
651 *
652 * Public because SqliteInstaller needs it, and doesn't subclass Installer.
653 *
654 * @return mixed
655 */
656 public static function maybeGetWebserverPrimaryGroup() {
657 if ( !function_exists( 'posix_getegid' ) || !function_exists( 'posix_getpwuid' ) ) {
658 # I don't know this, this isn't UNIX.
659 return null;
660 }
661
662 # posix_getegid() *not* getmygid() because we want the group of the webserver,
663 # not whoever owns the current script.
664 $gid = posix_getegid();
665 $group = posix_getpwuid( $gid )['name'];
666
667 return $group;
668 }
669
670 /**
671 * Convert wikitext $text to HTML.
672 *
673 * This is potentially error prone since many parser features require a complete
674 * installed MW database. The solution is to just not use those features when you
675 * write your messages. This appears to work well enough. Basic formatting and
676 * external links work just fine.
677 *
678 * But in case a translator decides to throw in a "#ifexist" or internal link or
679 * whatever, this function is guarded to catch the attempted DB access and to present
680 * some fallback text.
681 *
682 * @param string $text
683 * @param bool $lineStart
684 * @return string
685 */
686 public function parse( $text, $lineStart = false ) {
687 global $wgParser;
688
689 try {
690 $out = $wgParser->parse( $text, $this->parserTitle, $this->parserOptions, $lineStart );
691 $html = $out->getText();
692 } catch ( MediaWiki\Services\ServiceDisabledException $e ) {
693 $html = '<!--DB access attempted during parse--> ' . htmlspecialchars( $text );
694
695 if ( !empty( $this->debug ) ) {
696 $html .= "<!--\n" . $e->getTraceAsString() . "\n-->";
697 }
698 }
699
700 return $html;
701 }
702
703 /**
704 * @return ParserOptions
705 */
706 public function getParserOptions() {
707 return $this->parserOptions;
708 }
709
710 public function disableLinkPopups() {
711 $this->parserOptions->setExternalLinkTarget( false );
712 }
713
714 public function restoreLinkPopups() {
715 global $wgExternalLinkTarget;
716 $this->parserOptions->setExternalLinkTarget( $wgExternalLinkTarget );
717 }
718
719 /**
720 * Install step which adds a row to the site_stats table with appropriate
721 * initial values.
722 *
723 * @param DatabaseInstaller $installer
724 *
725 * @return Status
726 */
727 public function populateSiteStats( DatabaseInstaller $installer ) {
728 $status = $installer->getConnection();
729 if ( !$status->isOK() ) {
730 return $status;
731 }
732 $status->value->insert(
733 'site_stats',
734 [
735 'ss_row_id' => 1,
736 'ss_total_edits' => 0,
737 'ss_good_articles' => 0,
738 'ss_total_pages' => 0,
739 'ss_users' => 0,
740 'ss_active_users' => 0,
741 'ss_images' => 0
742 ],
743 __METHOD__, 'IGNORE'
744 );
745
746 return Status::newGood();
747 }
748
749 /**
750 * Environment check for DB types.
751 * @return bool
752 */
753 protected function envCheckDB() {
754 global $wgLang;
755
756 $allNames = [];
757
758 // Messages: config-type-mysql, config-type-postgres, config-type-oracle,
759 // config-type-sqlite
760 foreach ( self::getDBTypes() as $name ) {
761 $allNames[] = wfMessage( "config-type-$name" )->text();
762 }
763
764 $databases = $this->getCompiledDBs();
765
766 $databases = array_flip( $databases );
767 foreach ( array_keys( $databases ) as $db ) {
768 $installer = $this->getDBInstaller( $db );
769 $status = $installer->checkPrerequisites();
770 if ( !$status->isGood() ) {
771 $this->showStatusMessage( $status );
772 }
773 if ( !$status->isOK() ) {
774 unset( $databases[$db] );
775 }
776 }
777 $databases = array_flip( $databases );
778 if ( !$databases ) {
779 $this->showError( 'config-no-db', $wgLang->commaList( $allNames ), count( $allNames ) );
780
781 // @todo FIXME: This only works for the web installer!
782 return false;
783 }
784
785 return true;
786 }
787
788 /**
789 * Some versions of libxml+PHP break < and > encoding horribly
790 * @return bool
791 */
792 protected function envCheckBrokenXML() {
793 $test = new PhpXmlBugTester();
794 if ( !$test->ok ) {
795 $this->showError( 'config-brokenlibxml' );
796
797 return false;
798 }
799
800 return true;
801 }
802
803 /**
804 * Environment check for the PCRE module.
805 *
806 * @note If this check were to fail, the parser would
807 * probably throw an exception before the result
808 * of this check is shown to the user.
809 * @return bool
810 */
811 protected function envCheckPCRE() {
812 MediaWiki\suppressWarnings();
813 $regexd = preg_replace( '/[\x{0430}-\x{04FF}]/iu', '', '-АБВГД-' );
814 // Need to check for \p support too, as PCRE can be compiled
815 // with utf8 support, but not unicode property support.
816 // check that \p{Zs} (space separators) matches
817 // U+3000 (Ideographic space)
818 $regexprop = preg_replace( '/\p{Zs}/u', '', "-\xE3\x80\x80-" );
819 MediaWiki\restoreWarnings();
820 if ( $regexd != '--' || $regexprop != '--' ) {
821 $this->showError( 'config-pcre-no-utf8' );
822
823 return false;
824 }
825
826 return true;
827 }
828
829 /**
830 * Environment check for available memory.
831 * @return bool
832 */
833 protected function envCheckMemory() {
834 $limit = ini_get( 'memory_limit' );
835
836 if ( !$limit || $limit == -1 ) {
837 return true;
838 }
839
840 $n = wfShorthandToInteger( $limit );
841
842 if ( $n < $this->minMemorySize * 1024 * 1024 ) {
843 $newLimit = "{$this->minMemorySize}M";
844
845 if ( ini_set( "memory_limit", $newLimit ) === false ) {
846 $this->showMessage( 'config-memory-bad', $limit );
847 } else {
848 $this->showMessage( 'config-memory-raised', $limit, $newLimit );
849 $this->setVar( '_RaiseMemory', true );
850 }
851 }
852
853 return true;
854 }
855
856 /**
857 * Environment check for compiled object cache types.
858 */
859 protected function envCheckCache() {
860 $caches = [];
861 foreach ( $this->objectCaches as $name => $function ) {
862 if ( function_exists( $function ) ) {
863 if ( $name == 'xcache' && !wfIniGetBool( 'xcache.var_size' ) ) {
864 continue;
865 }
866 $caches[$name] = true;
867 }
868 }
869
870 if ( !$caches ) {
871 $key = 'config-no-cache-apcu';
872 $this->showMessage( $key );
873 }
874
875 $this->setVar( '_Caches', $caches );
876 }
877
878 /**
879 * Scare user to death if they have mod_security or mod_security2
880 * @return bool
881 */
882 protected function envCheckModSecurity() {
883 if ( self::apacheModulePresent( 'mod_security' )
884 || self::apacheModulePresent( 'mod_security2' ) ) {
885 $this->showMessage( 'config-mod-security' );
886 }
887
888 return true;
889 }
890
891 /**
892 * Search for GNU diff3.
893 * @return bool
894 */
895 protected function envCheckDiff3() {
896 $names = [ "gdiff3", "diff3" ];
897 if ( wfIsWindows() ) {
898 $names[] = 'diff3.exe';
899 }
900 $versionInfo = [ '--version', 'GNU diffutils' ];
901
902 $diff3 = ExecutableFinder::findInDefaultPaths( $names, $versionInfo );
903
904 if ( $diff3 ) {
905 $this->setVar( 'wgDiff3', $diff3 );
906 } else {
907 $this->setVar( 'wgDiff3', false );
908 $this->showMessage( 'config-diff3-bad' );
909 }
910
911 return true;
912 }
913
914 /**
915 * Environment check for ImageMagick and GD.
916 * @return bool
917 */
918 protected function envCheckGraphics() {
919 $names = wfIsWindows() ? 'convert.exe' : 'convert';
920 $versionInfo = [ '-version', 'ImageMagick' ];
921 $convert = ExecutableFinder::findInDefaultPaths( $names, $versionInfo );
922
923 $this->setVar( 'wgImageMagickConvertCommand', '' );
924 if ( $convert ) {
925 $this->setVar( 'wgImageMagickConvertCommand', $convert );
926 $this->showMessage( 'config-imagemagick', $convert );
927
928 return true;
929 } elseif ( function_exists( 'imagejpeg' ) ) {
930 $this->showMessage( 'config-gd' );
931 } else {
932 $this->showMessage( 'config-no-scaling' );
933 }
934
935 return true;
936 }
937
938 /**
939 * Search for git.
940 *
941 * @since 1.22
942 * @return bool
943 */
944 protected function envCheckGit() {
945 $names = wfIsWindows() ? 'git.exe' : 'git';
946 $versionInfo = [ '--version', 'git version' ];
947
948 $git = ExecutableFinder::findInDefaultPaths( $names, $versionInfo );
949
950 if ( $git ) {
951 $this->setVar( 'wgGitBin', $git );
952 $this->showMessage( 'config-git', $git );
953 } else {
954 $this->setVar( 'wgGitBin', false );
955 $this->showMessage( 'config-git-bad' );
956 }
957
958 return true;
959 }
960
961 /**
962 * Environment check to inform user which server we've assumed.
963 *
964 * @return bool
965 */
966 protected function envCheckServer() {
967 $server = $this->envGetDefaultServer();
968 if ( $server !== null ) {
969 $this->showMessage( 'config-using-server', $server );
970 }
971 return true;
972 }
973
974 /**
975 * Environment check to inform user which paths we've assumed.
976 *
977 * @return bool
978 */
979 protected function envCheckPath() {
980 $this->showMessage(
981 'config-using-uri',
982 $this->getVar( 'wgServer' ),
983 $this->getVar( 'wgScriptPath' )
984 );
985 return true;
986 }
987
988 /**
989 * Environment check for preferred locale in shell
990 * @return bool
991 */
992 protected function envCheckShellLocale() {
993 $os = php_uname( 's' );
994 $supported = [ 'Linux', 'SunOS', 'HP-UX', 'Darwin' ]; # Tested these
995
996 if ( !in_array( $os, $supported ) ) {
997 return true;
998 }
999
1000 # Get a list of available locales.
1001 $ret = false;
1002 $lines = wfShellExec( '/usr/bin/locale -a', $ret );
1003
1004 if ( $ret ) {
1005 return true;
1006 }
1007
1008 $lines = array_map( 'trim', explode( "\n", $lines ) );
1009 $candidatesByLocale = [];
1010 $candidatesByLang = [];
1011
1012 foreach ( $lines as $line ) {
1013 if ( $line === '' ) {
1014 continue;
1015 }
1016
1017 if ( !preg_match( '/^([a-zA-Z]+)(_[a-zA-Z]+|)\.(utf8|UTF-8)(@[a-zA-Z_]*|)$/i', $line, $m ) ) {
1018 continue;
1019 }
1020
1021 list( , $lang, , , ) = $m;
1022
1023 $candidatesByLocale[$m[0]] = $m;
1024 $candidatesByLang[$lang][] = $m;
1025 }
1026
1027 # Try the current value of LANG.
1028 if ( isset( $candidatesByLocale[getenv( 'LANG' )] ) ) {
1029 $this->setVar( 'wgShellLocale', getenv( 'LANG' ) );
1030
1031 return true;
1032 }
1033
1034 # Try the most common ones.
1035 $commonLocales = [ 'C.UTF-8', 'en_US.UTF-8', 'en_US.utf8', 'de_DE.UTF-8', 'de_DE.utf8' ];
1036 foreach ( $commonLocales as $commonLocale ) {
1037 if ( isset( $candidatesByLocale[$commonLocale] ) ) {
1038 $this->setVar( 'wgShellLocale', $commonLocale );
1039
1040 return true;
1041 }
1042 }
1043
1044 # Is there an available locale in the Wiki's language?
1045 $wikiLang = $this->getVar( 'wgLanguageCode' );
1046
1047 if ( isset( $candidatesByLang[$wikiLang] ) ) {
1048 $m = reset( $candidatesByLang[$wikiLang] );
1049 $this->setVar( 'wgShellLocale', $m[0] );
1050
1051 return true;
1052 }
1053
1054 # Are there any at all?
1055 if ( count( $candidatesByLocale ) ) {
1056 $m = reset( $candidatesByLocale );
1057 $this->setVar( 'wgShellLocale', $m[0] );
1058
1059 return true;
1060 }
1061
1062 # Give up.
1063 return true;
1064 }
1065
1066 /**
1067 * Environment check for the permissions of the uploads directory
1068 * @return bool
1069 */
1070 protected function envCheckUploadsDirectory() {
1071 global $IP;
1072
1073 $dir = $IP . '/images/';
1074 $url = $this->getVar( 'wgServer' ) . $this->getVar( 'wgScriptPath' ) . '/images/';
1075 $safe = !$this->dirIsExecutable( $dir, $url );
1076
1077 if ( !$safe ) {
1078 $this->showMessage( 'config-uploads-not-safe', $dir );
1079 }
1080
1081 return true;
1082 }
1083
1084 /**
1085 * Checks if suhosin.get.max_value_length is set, and if so generate
1086 * a warning because it decreases ResourceLoader performance.
1087 * @return bool
1088 */
1089 protected function envCheckSuhosinMaxValueLength() {
1090 $maxValueLength = ini_get( 'suhosin.get.max_value_length' );
1091 if ( $maxValueLength > 0 && $maxValueLength < 1024 ) {
1092 // Only warn if the value is below the sane 1024
1093 $this->showMessage( 'config-suhosin-max-value-length', $maxValueLength );
1094 }
1095
1096 return true;
1097 }
1098
1099 /**
1100 * Checks if we're running on 64 bit or not. 32 bit is becoming increasingly
1101 * hard to support, so let's at least warn people.
1102 *
1103 * @return bool
1104 */
1105 protected function envCheck64Bit() {
1106 if ( PHP_INT_SIZE == 4 ) {
1107 $this->showMessage( 'config-using-32bit' );
1108 }
1109
1110 return true;
1111 }
1112
1113 /**
1114 * Convert a hex string representing a Unicode code point to that code point.
1115 * @param string $c
1116 * @return string|false
1117 */
1118 protected function unicodeChar( $c ) {
1119 $c = hexdec( $c );
1120 if ( $c <= 0x7F ) {
1121 return chr( $c );
1122 } elseif ( $c <= 0x7FF ) {
1123 return chr( 0xC0 | $c >> 6 ) . chr( 0x80 | $c & 0x3F );
1124 } elseif ( $c <= 0xFFFF ) {
1125 return chr( 0xE0 | $c >> 12 ) . chr( 0x80 | $c >> 6 & 0x3F ) .
1126 chr( 0x80 | $c & 0x3F );
1127 } elseif ( $c <= 0x10FFFF ) {
1128 return chr( 0xF0 | $c >> 18 ) . chr( 0x80 | $c >> 12 & 0x3F ) .
1129 chr( 0x80 | $c >> 6 & 0x3F ) .
1130 chr( 0x80 | $c & 0x3F );
1131 } else {
1132 return false;
1133 }
1134 }
1135
1136 /**
1137 * Check the libicu version
1138 */
1139 protected function envCheckLibicu() {
1140 /**
1141 * This needs to be updated something that the latest libicu
1142 * will properly normalize. This normalization was found at
1143 * http://www.unicode.org/versions/Unicode5.2.0/#Character_Additions
1144 * Note that we use the hex representation to create the code
1145 * points in order to avoid any Unicode-destroying during transit.
1146 */
1147 $not_normal_c = $this->unicodeChar( "FA6C" );
1148 $normal_c = $this->unicodeChar( "242EE" );
1149
1150 $useNormalizer = 'php';
1151 $needsUpdate = false;
1152
1153 if ( function_exists( 'normalizer_normalize' ) ) {
1154 $useNormalizer = 'intl';
1155 $intl = normalizer_normalize( $not_normal_c, Normalizer::FORM_C );
1156 if ( $intl !== $normal_c ) {
1157 $needsUpdate = true;
1158 }
1159 }
1160
1161 // Uses messages 'config-unicode-using-php' and 'config-unicode-using-intl'
1162 if ( $useNormalizer === 'php' ) {
1163 $this->showMessage( 'config-unicode-pure-php-warning' );
1164 } else {
1165 $this->showMessage( 'config-unicode-using-' . $useNormalizer );
1166 if ( $needsUpdate ) {
1167 $this->showMessage( 'config-unicode-update-warning' );
1168 }
1169 }
1170 }
1171
1172 /**
1173 * Environment prep for the server hostname.
1174 */
1175 protected function envPrepServer() {
1176 $server = $this->envGetDefaultServer();
1177 if ( $server !== null ) {
1178 $this->setVar( 'wgServer', $server );
1179 }
1180 }
1181
1182 /**
1183 * Helper function to be called from envPrepServer()
1184 * @return string
1185 */
1186 abstract protected function envGetDefaultServer();
1187
1188 /**
1189 * Environment prep for setting $IP and $wgScriptPath.
1190 */
1191 protected function envPrepPath() {
1192 global $IP;
1193 $IP = dirname( dirname( __DIR__ ) );
1194 $this->setVar( 'IP', $IP );
1195 }
1196
1197 /**
1198 * Checks if scripts located in the given directory can be executed via the given URL.
1199 *
1200 * Used only by environment checks.
1201 * @param string $dir
1202 * @param string $url
1203 * @return bool|int|string
1204 */
1205 public function dirIsExecutable( $dir, $url ) {
1206 $scriptTypes = [
1207 'php' => [
1208 "<?php echo 'ex' . 'ec';",
1209 "#!/var/env php5\n<?php echo 'ex' . 'ec';",
1210 ],
1211 ];
1212
1213 // it would be good to check other popular languages here, but it'll be slow.
1214
1215 MediaWiki\suppressWarnings();
1216
1217 foreach ( $scriptTypes as $ext => $contents ) {
1218 foreach ( $contents as $source ) {
1219 $file = 'exectest.' . $ext;
1220
1221 if ( !file_put_contents( $dir . $file, $source ) ) {
1222 break;
1223 }
1224
1225 try {
1226 $text = Http::get( $url . $file, [ 'timeout' => 3 ], __METHOD__ );
1227 } catch ( Exception $e ) {
1228 // Http::get throws with allow_url_fopen = false and no curl extension.
1229 $text = null;
1230 }
1231 unlink( $dir . $file );
1232
1233 if ( $text == 'exec' ) {
1234 MediaWiki\restoreWarnings();
1235
1236 return $ext;
1237 }
1238 }
1239 }
1240
1241 MediaWiki\restoreWarnings();
1242
1243 return false;
1244 }
1245
1246 /**
1247 * Checks for presence of an Apache module. Works only if PHP is running as an Apache module, too.
1248 *
1249 * @param string $moduleName Name of module to check.
1250 * @return bool
1251 */
1252 public static function apacheModulePresent( $moduleName ) {
1253 if ( function_exists( 'apache_get_modules' ) && in_array( $moduleName, apache_get_modules() ) ) {
1254 return true;
1255 }
1256 // try it the hard way
1257 ob_start();
1258 phpinfo( INFO_MODULES );
1259 $info = ob_get_clean();
1260
1261 return strpos( $info, $moduleName ) !== false;
1262 }
1263
1264 /**
1265 * ParserOptions are constructed before we determined the language, so fix it
1266 *
1267 * @param Language $lang
1268 */
1269 public function setParserLanguage( $lang ) {
1270 $this->parserOptions->setTargetLanguage( $lang );
1271 $this->parserOptions->setUserLang( $lang );
1272 }
1273
1274 /**
1275 * Overridden by WebInstaller to provide lastPage parameters.
1276 * @param string $page
1277 * @return string
1278 */
1279 protected function getDocUrl( $page ) {
1280 return "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1281 }
1282
1283 /**
1284 * Finds extensions that follow the format /$directory/Name/Name.php,
1285 * and returns an array containing the value for 'Name' for each found extension.
1286 *
1287 * Reasonable values for $directory include 'extensions' (the default) and 'skins'.
1288 *
1289 * @param string $directory Directory to search in
1290 * @return array [ $extName => [ 'screenshots' => [ '...' ] ]
1291 */
1292 public function findExtensions( $directory = 'extensions' ) {
1293 if ( $this->getVar( 'IP' ) === null ) {
1294 return [];
1295 }
1296
1297 $extDir = $this->getVar( 'IP' ) . '/' . $directory;
1298 if ( !is_readable( $extDir ) || !is_dir( $extDir ) ) {
1299 return [];
1300 }
1301
1302 // extensions -> extension.json, skins -> skin.json
1303 $jsonFile = substr( $directory, 0, strlen( $directory ) - 1 ) . '.json';
1304
1305 $dh = opendir( $extDir );
1306 $exts = [];
1307 while ( ( $file = readdir( $dh ) ) !== false ) {
1308 if ( !is_dir( "$extDir/$file" ) ) {
1309 continue;
1310 }
1311 if ( file_exists( "$extDir/$file/$jsonFile" ) || file_exists( "$extDir/$file/$file.php" ) ) {
1312 // Extension exists. Now see if there are screenshots
1313 $exts[$file] = [];
1314 if ( is_dir( "$extDir/$file/screenshots" ) ) {
1315 $paths = glob( "$extDir/$file/screenshots/*.png" );
1316 foreach ( $paths as $path ) {
1317 $exts[$file]['screenshots'][] = str_replace( $extDir, "../$directory", $path );
1318 }
1319
1320 }
1321 }
1322 }
1323 closedir( $dh );
1324 uksort( $exts, 'strnatcasecmp' );
1325
1326 return $exts;
1327 }
1328
1329 /**
1330 * Returns a default value to be used for $wgDefaultSkin: normally the one set in DefaultSettings,
1331 * but will fall back to another if the default skin is missing and some other one is present
1332 * instead.
1333 *
1334 * @param string[] $skinNames Names of installed skins.
1335 * @return string
1336 */
1337 public function getDefaultSkin( array $skinNames ) {
1338 $defaultSkin = $GLOBALS['wgDefaultSkin'];
1339 if ( !$skinNames || in_array( $defaultSkin, $skinNames ) ) {
1340 return $defaultSkin;
1341 } else {
1342 return $skinNames[0];
1343 }
1344 }
1345
1346 /**
1347 * Installs the auto-detected extensions.
1348 *
1349 * @return Status
1350 */
1351 protected function includeExtensions() {
1352 global $IP;
1353 $exts = $this->getVar( '_Extensions' );
1354 $IP = $this->getVar( 'IP' );
1355
1356 /**
1357 * We need to include DefaultSettings before including extensions to avoid
1358 * warnings about unset variables. However, the only thing we really
1359 * want here is $wgHooks['LoadExtensionSchemaUpdates']. This won't work
1360 * if the extension has hidden hook registration in $wgExtensionFunctions,
1361 * but we're not opening that can of worms
1362 * @see https://phabricator.wikimedia.org/T28857
1363 */
1364 global $wgAutoloadClasses;
1365 $wgAutoloadClasses = [];
1366 $queue = [];
1367
1368 require "$IP/includes/DefaultSettings.php";
1369
1370 foreach ( $exts as $e ) {
1371 if ( file_exists( "$IP/extensions/$e/extension.json" ) ) {
1372 $queue["$IP/extensions/$e/extension.json"] = 1;
1373 } else {
1374 require_once "$IP/extensions/$e/$e.php";
1375 }
1376 }
1377
1378 $registry = new ExtensionRegistry();
1379 $data = $registry->readFromQueue( $queue );
1380 $wgAutoloadClasses += $data['autoload'];
1381
1382 $hooksWeWant = isset( $wgHooks['LoadExtensionSchemaUpdates'] ) ?
1383 /** @suppress PhanUndeclaredVariable $wgHooks is set by DefaultSettings */
1384 $wgHooks['LoadExtensionSchemaUpdates'] : [];
1385
1386 if ( isset( $data['globals']['wgHooks']['LoadExtensionSchemaUpdates'] ) ) {
1387 $hooksWeWant = array_merge_recursive(
1388 $hooksWeWant,
1389 $data['globals']['wgHooks']['LoadExtensionSchemaUpdates']
1390 );
1391 }
1392 // Unset everyone else's hooks. Lord knows what someone might be doing
1393 // in ParserFirstCallInit (see T29171)
1394 $GLOBALS['wgHooks'] = [ 'LoadExtensionSchemaUpdates' => $hooksWeWant ];
1395
1396 return Status::newGood();
1397 }
1398
1399 /**
1400 * Get an array of install steps. Should always be in the format of
1401 * [
1402 * 'name' => 'someuniquename',
1403 * 'callback' => [ $obj, 'method' ],
1404 * ]
1405 * There must be a config-install-$name message defined per step, which will
1406 * be shown on install.
1407 *
1408 * @param DatabaseInstaller $installer DatabaseInstaller so we can make callbacks
1409 * @return array
1410 */
1411 protected function getInstallSteps( DatabaseInstaller $installer ) {
1412 $coreInstallSteps = [
1413 [ 'name' => 'database', 'callback' => [ $installer, 'setupDatabase' ] ],
1414 [ 'name' => 'tables', 'callback' => [ $installer, 'createTables' ] ],
1415 [ 'name' => 'interwiki', 'callback' => [ $installer, 'populateInterwikiTable' ] ],
1416 [ 'name' => 'stats', 'callback' => [ $this, 'populateSiteStats' ] ],
1417 [ 'name' => 'keys', 'callback' => [ $this, 'generateKeys' ] ],
1418 [ 'name' => 'updates', 'callback' => [ $installer, 'insertUpdateKeys' ] ],
1419 [ 'name' => 'sysop', 'callback' => [ $this, 'createSysop' ] ],
1420 [ 'name' => 'mainpage', 'callback' => [ $this, 'createMainpage' ] ],
1421 ];
1422
1423 // Build the array of install steps starting from the core install list,
1424 // then adding any callbacks that wanted to attach after a given step
1425 foreach ( $coreInstallSteps as $step ) {
1426 $this->installSteps[] = $step;
1427 if ( isset( $this->extraInstallSteps[$step['name']] ) ) {
1428 $this->installSteps = array_merge(
1429 $this->installSteps,
1430 $this->extraInstallSteps[$step['name']]
1431 );
1432 }
1433 }
1434
1435 // Prepend any steps that want to be at the beginning
1436 if ( isset( $this->extraInstallSteps['BEGINNING'] ) ) {
1437 $this->installSteps = array_merge(
1438 $this->extraInstallSteps['BEGINNING'],
1439 $this->installSteps
1440 );
1441 }
1442
1443 // Extensions should always go first, chance to tie into hooks and such
1444 if ( count( $this->getVar( '_Extensions' ) ) ) {
1445 array_unshift( $this->installSteps,
1446 [ 'name' => 'extensions', 'callback' => [ $this, 'includeExtensions' ] ]
1447 );
1448 $this->installSteps[] = [
1449 'name' => 'extension-tables',
1450 'callback' => [ $installer, 'createExtensionTables' ]
1451 ];
1452 }
1453
1454 return $this->installSteps;
1455 }
1456
1457 /**
1458 * Actually perform the installation.
1459 *
1460 * @param callable $startCB A callback array for the beginning of each step
1461 * @param callable $endCB A callback array for the end of each step
1462 *
1463 * @return array Array of Status objects
1464 */
1465 public function performInstallation( $startCB, $endCB ) {
1466 $installResults = [];
1467 $installer = $this->getDBInstaller();
1468 $installer->preInstall();
1469 $steps = $this->getInstallSteps( $installer );
1470 foreach ( $steps as $stepObj ) {
1471 $name = $stepObj['name'];
1472 call_user_func_array( $startCB, [ $name ] );
1473
1474 // Perform the callback step
1475 $status = call_user_func( $stepObj['callback'], $installer );
1476
1477 // Output and save the results
1478 call_user_func( $endCB, $name, $status );
1479 $installResults[$name] = $status;
1480
1481 // If we've hit some sort of fatal, we need to bail.
1482 // Callback already had a chance to do output above.
1483 if ( !$status->isOk() ) {
1484 break;
1485 }
1486 }
1487 if ( $status->isOk() ) {
1488 $this->setVar( '_InstallDone', true );
1489 }
1490
1491 return $installResults;
1492 }
1493
1494 /**
1495 * Generate $wgSecretKey. Will warn if we had to use an insecure random source.
1496 *
1497 * @return Status
1498 */
1499 public function generateKeys() {
1500 $keys = [ 'wgSecretKey' => 64 ];
1501 if ( strval( $this->getVar( 'wgUpgradeKey' ) ) === '' ) {
1502 $keys['wgUpgradeKey'] = 16;
1503 }
1504
1505 return $this->doGenerateKeys( $keys );
1506 }
1507
1508 /**
1509 * Generate a secret value for variables using our CryptRand generator.
1510 * Produce a warning if the random source was insecure.
1511 *
1512 * @param array $keys
1513 * @return Status
1514 */
1515 protected function doGenerateKeys( $keys ) {
1516 $status = Status::newGood();
1517
1518 $strong = true;
1519 foreach ( $keys as $name => $length ) {
1520 $secretKey = MWCryptRand::generateHex( $length, true );
1521 if ( !MWCryptRand::wasStrong() ) {
1522 $strong = false;
1523 }
1524
1525 $this->setVar( $name, $secretKey );
1526 }
1527
1528 if ( !$strong ) {
1529 $names = array_keys( $keys );
1530 $names = preg_replace( '/^(.*)$/', '\$$1', $names );
1531 global $wgLang;
1532 $status->warning( 'config-insecure-keys', $wgLang->listToText( $names ), count( $names ) );
1533 }
1534
1535 return $status;
1536 }
1537
1538 /**
1539 * Create the first user account, grant it sysop and bureaucrat rights
1540 *
1541 * @return Status
1542 */
1543 protected function createSysop() {
1544 $name = $this->getVar( '_AdminName' );
1545 $user = User::newFromName( $name );
1546
1547 if ( !$user ) {
1548 // We should've validated this earlier anyway!
1549 return Status::newFatal( 'config-admin-error-user', $name );
1550 }
1551
1552 if ( $user->idForName() == 0 ) {
1553 $user->addToDatabase();
1554
1555 try {
1556 $user->setPassword( $this->getVar( '_AdminPassword' ) );
1557 } catch ( PasswordError $pwe ) {
1558 return Status::newFatal( 'config-admin-error-password', $name, $pwe->getMessage() );
1559 }
1560
1561 $user->addGroup( 'sysop' );
1562 $user->addGroup( 'bureaucrat' );
1563 if ( $this->getVar( '_AdminEmail' ) ) {
1564 $user->setEmail( $this->getVar( '_AdminEmail' ) );
1565 }
1566 $user->saveSettings();
1567
1568 // Update user count
1569 $ssUpdate = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
1570 $ssUpdate->doUpdate();
1571 }
1572 $status = Status::newGood();
1573
1574 if ( $this->getVar( '_Subscribe' ) && $this->getVar( '_AdminEmail' ) ) {
1575 $this->subscribeToMediaWikiAnnounce( $status );
1576 }
1577
1578 return $status;
1579 }
1580
1581 /**
1582 * @param Status $s
1583 */
1584 private function subscribeToMediaWikiAnnounce( Status $s ) {
1585 $params = [
1586 'email' => $this->getVar( '_AdminEmail' ),
1587 'language' => 'en',
1588 'digest' => 0
1589 ];
1590
1591 // Mailman doesn't support as many languages as we do, so check to make
1592 // sure their selected language is available
1593 $myLang = $this->getVar( '_UserLang' );
1594 if ( in_array( $myLang, $this->mediaWikiAnnounceLanguages ) ) {
1595 $myLang = $myLang == 'pt-br' ? 'pt_BR' : $myLang; // rewrite to Mailman's pt_BR
1596 $params['language'] = $myLang;
1597 }
1598
1599 if ( MWHttpRequest::canMakeRequests() ) {
1600 $res = MWHttpRequest::factory( $this->mediaWikiAnnounceUrl,
1601 [ 'method' => 'POST', 'postData' => $params ], __METHOD__ )->execute();
1602 if ( !$res->isOK() ) {
1603 $s->warning( 'config-install-subscribe-fail', $res->getMessage() );
1604 }
1605 } else {
1606 $s->warning( 'config-install-subscribe-notpossible' );
1607 }
1608 }
1609
1610 /**
1611 * Insert Main Page with default content.
1612 *
1613 * @param DatabaseInstaller $installer
1614 * @return Status
1615 */
1616 protected function createMainpage( DatabaseInstaller $installer ) {
1617 $status = Status::newGood();
1618 $title = Title::newMainPage();
1619 if ( $title->exists() ) {
1620 $status->warning( 'config-install-mainpage-exists' );
1621 return $status;
1622 }
1623 try {
1624 $page = WikiPage::factory( $title );
1625 $content = new WikitextContent(
1626 wfMessage( 'mainpagetext' )->inContentLanguage()->text() . "\n\n" .
1627 wfMessage( 'mainpagedocfooter' )->inContentLanguage()->text()
1628 );
1629
1630 $status = $page->doEditContent( $content,
1631 '',
1632 EDIT_NEW,
1633 false,
1634 User::newFromName( 'MediaWiki default' )
1635 );
1636 } catch ( Exception $e ) {
1637 // using raw, because $wgShowExceptionDetails can not be set yet
1638 $status->fatal( 'config-install-mainpage-failed', $e->getMessage() );
1639 }
1640
1641 return $status;
1642 }
1643
1644 /**
1645 * Override the necessary bits of the config to run an installation.
1646 */
1647 public static function overrideConfig() {
1648 // Use PHP's built-in session handling, since MediaWiki's
1649 // SessionHandler can't work before we have an object cache set up.
1650 define( 'MW_NO_SESSION_HANDLER', 1 );
1651
1652 // Don't access the database
1653 $GLOBALS['wgUseDatabaseMessages'] = false;
1654 // Don't cache langconv tables
1655 $GLOBALS['wgLanguageConverterCacheType'] = CACHE_NONE;
1656 // Debug-friendly
1657 $GLOBALS['wgShowExceptionDetails'] = true;
1658 // Don't break forms
1659 $GLOBALS['wgExternalLinkTarget'] = '_blank';
1660
1661 // Extended debugging
1662 $GLOBALS['wgShowSQLErrors'] = true;
1663 $GLOBALS['wgShowDBErrorBacktrace'] = true;
1664
1665 // Allow multiple ob_flush() calls
1666 $GLOBALS['wgDisableOutputCompression'] = true;
1667
1668 // Use a sensible cookie prefix (not my_wiki)
1669 $GLOBALS['wgCookiePrefix'] = 'mw_installer';
1670
1671 // Some of the environment checks make shell requests, remove limits
1672 $GLOBALS['wgMaxShellMemory'] = 0;
1673
1674 // Override the default CookieSessionProvider with a dummy
1675 // implementation that won't stomp on PHP's cookies.
1676 $GLOBALS['wgSessionProviders'] = [
1677 [
1678 'class' => 'InstallerSessionProvider',
1679 'args' => [ [
1680 'priority' => 1,
1681 ] ]
1682 ]
1683 ];
1684
1685 // Don't try to use any object cache for SessionManager either.
1686 $GLOBALS['wgSessionCacheType'] = CACHE_NONE;
1687 }
1688
1689 /**
1690 * Add an installation step following the given step.
1691 *
1692 * @param callable $callback A valid installation callback array, in this form:
1693 * [ 'name' => 'some-unique-name', 'callback' => [ $obj, 'function' ] ];
1694 * @param string $findStep The step to find. Omit to put the step at the beginning
1695 */
1696 public function addInstallStep( $callback, $findStep = 'BEGINNING' ) {
1697 $this->extraInstallSteps[$findStep][] = $callback;
1698 }
1699
1700 /**
1701 * Disable the time limit for execution.
1702 * Some long-running pages (Install, Upgrade) will want to do this
1703 */
1704 protected function disableTimeLimit() {
1705 MediaWiki\suppressWarnings();
1706 set_time_limit( 0 );
1707 MediaWiki\restoreWarnings();
1708 }
1709 }