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