MediaWiki REL1_33
Installer.php
Go to the documentation of this file.
1<?php
30
46abstract class Installer {
47
54 const MINIMUM_PCRE_VERSION = '7.2';
55
59 protected $settings;
60
66 protected $compiledDBs;
67
73 protected $dbInstallers = [];
74
80 protected $minMemorySize = 50;
81
87 protected $parserTitle;
88
94 protected $parserOptions;
95
105 protected static $dbTypes = [
106 'mysql',
107 'postgres',
108 'oracle',
109 'mssql',
110 'sqlite',
111 ];
112
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
148 protected $envPreps = [
149 'envPrepServer',
150 'envPrepPath',
151 ];
152
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
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
234 private $installSteps = [];
235
241 protected $extraInstallSteps = [];
242
248 protected $objectCaches = [
249 'apc' => 'apc_fetch',
250 'apcu' => 'apcu_fetch',
251 'wincache' => 'wincache_ucache_get'
252 ];
253
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
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
322 'https://lists.wikimedia.org/mailman/subscribe/mediawiki-announce';
323
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
340 abstract public function showMessage( $msg /*, ... */ );
341
346 abstract public function showError( $msg /*, ... */ );
347
352 abstract public function showStatusMessage( Status $status );
353
364 public static function getInstallerConfig( Config $baseConfig ) {
365 $configOverrides = new HashConfig();
366
367 // disable (problematic) object cache types explicitly, preserving all other (working) ones
368 // bug T113843
369 $emptyCache = [ 'class' => EmptyBagOStuff::class ];
370
371 $objectCaches = [
372 CACHE_NONE => $emptyCache,
373 CACHE_DB => $emptyCache,
374 CACHE_ANYTHING => $emptyCache,
375 CACHE_MEMCACHED => $emptyCache,
376 ] + $baseConfig->get( 'ObjectCaches' );
377
378 $configOverrides->set( 'ObjectCaches', $objectCaches );
379
380 // Load the installer's i18n.
381 $messageDirs = $baseConfig->get( 'MessagesDirs' );
382 $messageDirs['MediawikiInstaller'] = __DIR__ . '/i18n';
383
384 $configOverrides->set( 'MessagesDirs', $messageDirs );
385
386 $installerConfig = new MultiConfig( [ $configOverrides, $baseConfig ] );
387
388 // make sure we use the installer config as the main config
389 $configRegistry = $baseConfig->get( 'ConfigRegistry' );
390 $configRegistry['main'] = function () use ( $installerConfig ) {
391 return $installerConfig;
392 };
393
394 $configOverrides->set( 'ConfigRegistry', $configRegistry );
395
396 return $installerConfig;
397 }
398
402 public function __construct() {
403 global $wgMemc, $wgUser, $wgObjectCaches;
404
405 $defaultConfig = new GlobalVarConfig(); // all the stuff from DefaultSettings.php
406 $installerConfig = self::getInstallerConfig( $defaultConfig );
407
408 // Reset all services and inject config overrides
409 MediaWikiServices::resetGlobalInstance( $installerConfig );
410
411 // Don't attempt to load user language options (T126177)
412 // This will be overridden in the web installer with the user-specified language
413 RequestContext::getMain()->setLanguage( 'en' );
414
415 // Disable the i18n cache
416 // TODO: manage LocalisationCache singleton in MediaWikiServices
417 Language::getLocalisationCache()->disableBackend();
418
419 // Disable all global services, since we don't have any configuration yet!
420 MediaWikiServices::disableStorageBackend();
421
422 $mwServices = MediaWikiServices::getInstance();
423 // Disable object cache (otherwise CACHE_ANYTHING will try CACHE_DB and
424 // SqlBagOStuff will then throw since we just disabled wfGetDB)
425 $wgObjectCaches = $mwServices->getMainConfig()->get( 'ObjectCaches' );
426 $wgMemc = ObjectCache::getInstance( CACHE_NONE );
427
428 // Disable interwiki lookup, to avoid database access during parses
429 $mwServices->redefineService( 'InterwikiLookup', function () {
430 return new NullInterwikiLookup();
431 } );
432
433 // Having a user with id = 0 safeguards us from DB access via User::loadOptions().
434 $wgUser = User::newFromId( 0 );
435 RequestContext::getMain()->setUser( $wgUser );
436
438
439 foreach ( $this->defaultVarNames as $var ) {
440 $this->settings[$var] = $GLOBALS[$var];
441 }
442
443 $this->doEnvironmentPreps();
444
445 $this->compiledDBs = [];
446 foreach ( self::getDBTypes() as $type ) {
447 $installer = $this->getDBInstaller( $type );
448
449 if ( !$installer->isCompiled() ) {
450 continue;
451 }
452 $this->compiledDBs[] = $type;
453 }
454
455 $this->parserTitle = Title::newFromText( 'Installer' );
456 $this->parserOptions = new ParserOptions( $wgUser ); // language will be wrong :(
457 $this->parserOptions->setTidy( true );
458 // Don't try to access DB before user language is initialised
459 $this->setParserLanguage( Language::factory( 'en' ) );
460 }
461
467 public static function getDBTypes() {
468 return self::$dbTypes;
469 }
470
484 public function doEnvironmentChecks() {
485 // Php version has already been checked by entry scripts
486 // Show message here for information purposes
487 if ( wfIsHHVM() ) {
488 $this->showMessage( 'config-env-hhvm', HHVM_VERSION );
489 } else {
490 $this->showMessage( 'config-env-php', PHP_VERSION );
491 }
492
493 $good = true;
494 // Must go here because an old version of PCRE can prevent other checks from completing
495 list( $pcreVersion ) = explode( ' ', PCRE_VERSION, 2 );
496 if ( version_compare( $pcreVersion, self::MINIMUM_PCRE_VERSION, '<' ) ) {
497 $this->showError( 'config-pcre-old', self::MINIMUM_PCRE_VERSION, $pcreVersion );
498 $good = false;
499 } else {
500 foreach ( $this->envChecks as $check ) {
501 $status = $this->$check();
502 if ( $status === false ) {
503 $good = false;
504 }
505 }
506 }
507
508 $this->setVar( '_Environment', $good );
509
510 return $good ? Status::newGood() : Status::newFatal( 'config-env-bad' );
511 }
512
513 public function doEnvironmentPreps() {
514 foreach ( $this->envPreps as $prep ) {
515 $this->$prep();
516 }
517 }
518
525 public function setVar( $name, $value ) {
526 $this->settings[$name] = $value;
527 }
528
539 public function getVar( $name, $default = null ) {
540 return $this->settings[$name] ?? $default;
541 }
542
548 public function getCompiledDBs() {
549 return $this->compiledDBs;
550 }
551
559 public static function getDBInstallerClass( $type ) {
560 return ucfirst( $type ) . 'Installer';
561 }
562
570 public function getDBInstaller( $type = false ) {
571 if ( !$type ) {
572 $type = $this->getVar( 'wgDBtype' );
573 }
574
575 $type = strtolower( $type );
576
577 if ( !isset( $this->dbInstallers[$type] ) ) {
579 $this->dbInstallers[$type] = new $class( $this );
580 }
581
582 return $this->dbInstallers[$type];
583 }
584
590 public static function getExistingLocalSettings() {
591 global $IP;
592
593 // You might be wondering why this is here. Well if you don't do this
594 // then some poorly-formed extensions try to call their own classes
595 // after immediately registering them. We really need to get extension
596 // registration out of the global scope and into a real format.
597 // @see https://phabricator.wikimedia.org/T69440
598 global $wgAutoloadClasses;
600
601 // LocalSettings.php should not call functions, except wfLoadSkin/wfLoadExtensions
602 // Define the required globals here, to ensure, the functions can do it work correctly.
603 // phpcs:ignore MediaWiki.VariableAnalysis.UnusedGlobalVariables
605
606 Wikimedia\suppressWarnings();
607 $_lsExists = file_exists( "$IP/LocalSettings.php" );
608 Wikimedia\restoreWarnings();
609
610 if ( !$_lsExists ) {
611 return false;
612 }
613 unset( $_lsExists );
614
615 require "$IP/includes/DefaultSettings.php";
616 require "$IP/LocalSettings.php";
617
618 return get_defined_vars();
619 }
620
630 public function getFakePassword( $realPassword ) {
631 return str_repeat( '*', strlen( $realPassword ) );
632 }
633
641 public function setPassword( $name, $value ) {
642 if ( !preg_match( '/^\*+$/', $value ) ) {
643 $this->setVar( $name, $value );
644 }
645 }
646
658 public static function maybeGetWebserverPrimaryGroup() {
659 if ( !function_exists( 'posix_getegid' ) || !function_exists( 'posix_getpwuid' ) ) {
660 # I don't know this, this isn't UNIX.
661 return null;
662 }
663
664 # posix_getegid() *not* getmygid() because we want the group of the webserver,
665 # not whoever owns the current script.
666 $gid = posix_getegid();
667 $group = posix_getpwuid( $gid )['name'];
668
669 return $group;
670 }
671
688 public function parse( $text, $lineStart = false ) {
689 $parser = MediaWikiServices::getInstance()->getParser();
690
691 try {
692 $out = $parser->parse( $text, $this->parserTitle, $this->parserOptions, $lineStart );
693 $html = $out->getText( [
694 'enableSectionEditLinks' => false,
695 'unwrap' => true,
696 ] );
697 $html = Parser::stripOuterParagraph( $html );
698 } catch ( Wikimedia\Services\ServiceDisabledException $e ) {
699 $html = '<!--DB access attempted during parse--> ' . htmlspecialchars( $text );
700 }
701
702 return $html;
703 }
704
708 public function getParserOptions() {
710 }
711
712 public function disableLinkPopups() {
713 $this->parserOptions->setExternalLinkTarget( false );
714 }
715
716 public function restoreLinkPopups() {
718 $this->parserOptions->setExternalLinkTarget( $wgExternalLinkTarget );
719 }
720
729 public function populateSiteStats( DatabaseInstaller $installer ) {
730 $status = $installer->getConnection();
731 if ( !$status->isOK() ) {
732 return $status;
733 }
734 $status->value->insert(
735 'site_stats',
736 [
737 'ss_row_id' => 1,
738 'ss_total_edits' => 0,
739 'ss_good_articles' => 0,
740 'ss_total_pages' => 0,
741 'ss_users' => 0,
742 'ss_active_users' => 0,
743 'ss_images' => 0
744 ],
745 __METHOD__, 'IGNORE'
746 );
747
748 return Status::newGood();
749 }
750
755 protected function envCheckDB() {
756 global $wgLang;
757
758 $allNames = [];
759
760 // Messages: config-type-mysql, config-type-postgres, config-type-oracle,
761 // config-type-sqlite
762 foreach ( self::getDBTypes() as $name ) {
763 $allNames[] = wfMessage( "config-type-$name" )->text();
764 }
765
766 $databases = $this->getCompiledDBs();
767
768 $databases = array_flip( $databases );
769 foreach ( array_keys( $databases ) as $db ) {
770 $installer = $this->getDBInstaller( $db );
771 $status = $installer->checkPrerequisites();
772 if ( !$status->isGood() ) {
773 $this->showStatusMessage( $status );
774 }
775 if ( !$status->isOK() ) {
776 unset( $databases[$db] );
777 }
778 }
779 $databases = array_flip( $databases );
780 if ( !$databases ) {
781 $this->showError( 'config-no-db', $wgLang->commaList( $allNames ), count( $allNames ) );
782
783 // @todo FIXME: This only works for the web installer!
784 return false;
785 }
786
787 return true;
788 }
789
794 protected function envCheckBrokenXML() {
795 $test = new PhpXmlBugTester();
796 if ( !$test->ok ) {
797 $this->showError( 'config-brokenlibxml' );
798
799 return false;
800 }
801
802 return true;
803 }
804
813 protected function envCheckPCRE() {
814 Wikimedia\suppressWarnings();
815 $regexd = preg_replace( '/[\x{0430}-\x{04FF}]/iu', '', '-АБВГД-' );
816 // Need to check for \p support too, as PCRE can be compiled
817 // with utf8 support, but not unicode property support.
818 // check that \p{Zs} (space separators) matches
819 // U+3000 (Ideographic space)
820 $regexprop = preg_replace( '/\p{Zs}/u', '', "-\u{3000}-" );
821 Wikimedia\restoreWarnings();
822 if ( $regexd != '--' || $regexprop != '--' ) {
823 $this->showError( 'config-pcre-no-utf8' );
824
825 return false;
826 }
827
828 return true;
829 }
830
835 protected function envCheckMemory() {
836 $limit = ini_get( 'memory_limit' );
837
838 if ( !$limit || $limit == -1 ) {
839 return true;
840 }
841
842 $n = wfShorthandToInteger( $limit );
843
844 if ( $n < $this->minMemorySize * 1024 * 1024 ) {
845 $newLimit = "{$this->minMemorySize}M";
846
847 if ( ini_set( "memory_limit", $newLimit ) === false ) {
848 $this->showMessage( 'config-memory-bad', $limit );
849 } else {
850 $this->showMessage( 'config-memory-raised', $limit, $newLimit );
851 $this->setVar( '_RaiseMemory', true );
852 }
853 }
854
855 return true;
856 }
857
861 protected function envCheckCache() {
862 $caches = [];
863 foreach ( $this->objectCaches as $name => $function ) {
864 if ( function_exists( $function ) ) {
865 $caches[$name] = true;
866 }
867 }
868
869 if ( !$caches ) {
870 $this->showMessage( 'config-no-cache-apcu' );
871 }
872
873 $this->setVar( '_Caches', $caches );
874 }
875
880 protected function envCheckModSecurity() {
881 if ( self::apacheModulePresent( 'mod_security' )
882 || self::apacheModulePresent( 'mod_security2' ) ) {
883 $this->showMessage( 'config-mod-security' );
884 }
885
886 return true;
887 }
888
893 protected function envCheckDiff3() {
894 $names = [ "gdiff3", "diff3" ];
895 if ( wfIsWindows() ) {
896 $names[] = 'diff3.exe';
897 }
898 $versionInfo = [ '--version', 'GNU diffutils' ];
899
900 $diff3 = ExecutableFinder::findInDefaultPaths( $names, $versionInfo );
901
902 if ( $diff3 ) {
903 $this->setVar( 'wgDiff3', $diff3 );
904 } else {
905 $this->setVar( 'wgDiff3', false );
906 $this->showMessage( 'config-diff3-bad' );
907 }
908
909 return true;
910 }
911
916 protected function envCheckGraphics() {
917 $names = wfIsWindows() ? 'convert.exe' : 'convert';
918 $versionInfo = [ '-version', 'ImageMagick' ];
919 $convert = ExecutableFinder::findInDefaultPaths( $names, $versionInfo );
920
921 $this->setVar( 'wgImageMagickConvertCommand', '' );
922 if ( $convert ) {
923 $this->setVar( 'wgImageMagickConvertCommand', $convert );
924 $this->showMessage( 'config-imagemagick', $convert );
925
926 return true;
927 } elseif ( function_exists( 'imagejpeg' ) ) {
928 $this->showMessage( 'config-gd' );
929 } else {
930 $this->showMessage( 'config-no-scaling' );
931 }
932
933 return true;
934 }
935
942 protected function envCheckGit() {
943 $names = wfIsWindows() ? 'git.exe' : 'git';
944 $versionInfo = [ '--version', 'git version' ];
945
946 $git = ExecutableFinder::findInDefaultPaths( $names, $versionInfo );
947
948 if ( $git ) {
949 $this->setVar( 'wgGitBin', $git );
950 $this->showMessage( 'config-git', $git );
951 } else {
952 $this->setVar( 'wgGitBin', false );
953 $this->showMessage( 'config-git-bad' );
954 }
955
956 return true;
957 }
958
964 protected function envCheckServer() {
965 $server = $this->envGetDefaultServer();
966 if ( $server !== null ) {
967 $this->showMessage( 'config-using-server', $server );
968 }
969 return true;
970 }
971
977 protected function envCheckPath() {
978 $this->showMessage(
979 'config-using-uri',
980 $this->getVar( 'wgServer' ),
981 $this->getVar( 'wgScriptPath' )
982 );
983 return true;
984 }
985
990 protected function envCheckShellLocale() {
991 $os = php_uname( 's' );
992 $supported = [ 'Linux', 'SunOS', 'HP-UX', 'Darwin' ]; # Tested these
993
994 if ( !in_array( $os, $supported ) ) {
995 return true;
996 }
997
998 if ( Shell::isDisabled() ) {
999 return true;
1000 }
1001
1002 # Get a list of available locales.
1003 $result = Shell::command( '/usr/bin/locale', '-a' )
1004 ->execute();
1005
1006 if ( $result->getExitCode() != 0 ) {
1007 return true;
1008 }
1009
1010 $lines = $result->getStdout();
1011 $lines = array_map( 'trim', explode( "\n", $lines ) );
1012 $candidatesByLocale = [];
1013 $candidatesByLang = [];
1014 foreach ( $lines as $line ) {
1015 if ( $line === '' ) {
1016 continue;
1017 }
1018
1019 if ( !preg_match( '/^([a-zA-Z]+)(_[a-zA-Z]+|)\.(utf8|UTF-8)(@[a-zA-Z_]*|)$/i', $line, $m ) ) {
1020 continue;
1021 }
1022
1023 list( , $lang, , , ) = $m;
1024
1025 $candidatesByLocale[$m[0]] = $m;
1026 $candidatesByLang[$lang][] = $m;
1027 }
1028
1029 # Try the current value of LANG.
1030 if ( isset( $candidatesByLocale[getenv( 'LANG' )] ) ) {
1031 $this->setVar( 'wgShellLocale', getenv( 'LANG' ) );
1032
1033 return true;
1034 }
1035
1036 # Try the most common ones.
1037 $commonLocales = [ 'C.UTF-8', 'en_US.UTF-8', 'en_US.utf8', 'de_DE.UTF-8', 'de_DE.utf8' ];
1038 foreach ( $commonLocales as $commonLocale ) {
1039 if ( isset( $candidatesByLocale[$commonLocale] ) ) {
1040 $this->setVar( 'wgShellLocale', $commonLocale );
1041
1042 return true;
1043 }
1044 }
1045
1046 # Is there an available locale in the Wiki's language?
1047 $wikiLang = $this->getVar( 'wgLanguageCode' );
1048
1049 if ( isset( $candidatesByLang[$wikiLang] ) ) {
1050 $m = reset( $candidatesByLang[$wikiLang] );
1051 $this->setVar( 'wgShellLocale', $m[0] );
1052
1053 return true;
1054 }
1055
1056 # Are there any at all?
1057 if ( count( $candidatesByLocale ) ) {
1058 $m = reset( $candidatesByLocale );
1059 $this->setVar( 'wgShellLocale', $m[0] );
1060
1061 return true;
1062 }
1063
1064 # Give up.
1065 return true;
1066 }
1067
1072 protected function envCheckUploadsDirectory() {
1073 global $IP;
1074
1075 $dir = $IP . '/images/';
1076 $url = $this->getVar( 'wgServer' ) . $this->getVar( 'wgScriptPath' ) . '/images/';
1077 $safe = !$this->dirIsExecutable( $dir, $url );
1078
1079 if ( !$safe ) {
1080 $this->showMessage( 'config-uploads-not-safe', $dir );
1081 }
1082
1083 return true;
1084 }
1085
1091 protected function envCheckSuhosinMaxValueLength() {
1092 $maxValueLength = ini_get( 'suhosin.get.max_value_length' );
1093 if ( $maxValueLength > 0 && $maxValueLength < 1024 ) {
1094 // Only warn if the value is below the sane 1024
1095 $this->showMessage( 'config-suhosin-max-value-length', $maxValueLength );
1096 }
1097
1098 return true;
1099 }
1100
1107 protected function envCheck64Bit() {
1108 if ( PHP_INT_SIZE == 4 ) {
1109 $this->showMessage( 'config-using-32bit' );
1110 }
1111
1112 return true;
1113 }
1114
1118 protected function envCheckLibicu() {
1126 $not_normal_c = "\u{FA6C}";
1127 $normal_c = "\u{242EE}";
1128
1129 $useNormalizer = 'php';
1130 $needsUpdate = false;
1131
1132 if ( function_exists( 'normalizer_normalize' ) ) {
1133 $useNormalizer = 'intl';
1134 $intl = normalizer_normalize( $not_normal_c, Normalizer::FORM_C );
1135 if ( $intl !== $normal_c ) {
1136 $needsUpdate = true;
1137 }
1138 }
1139
1140 // Uses messages 'config-unicode-using-php' and 'config-unicode-using-intl'
1141 if ( $useNormalizer === 'php' ) {
1142 $this->showMessage( 'config-unicode-pure-php-warning' );
1143 } else {
1144 $this->showMessage( 'config-unicode-using-' . $useNormalizer );
1145 if ( $needsUpdate ) {
1146 $this->showMessage( 'config-unicode-update-warning' );
1147 }
1148 }
1149 }
1150
1154 protected function envPrepServer() {
1155 $server = $this->envGetDefaultServer();
1156 if ( $server !== null ) {
1157 $this->setVar( 'wgServer', $server );
1158 }
1159 }
1160
1165 abstract protected function envGetDefaultServer();
1166
1170 protected function envPrepPath() {
1171 global $IP;
1172 $IP = dirname( dirname( __DIR__ ) );
1173 $this->setVar( 'IP', $IP );
1174 }
1175
1184 public function dirIsExecutable( $dir, $url ) {
1185 $scriptTypes = [
1186 'php' => [
1187 "<?php echo 'exec';",
1188 "#!/var/env php\n<?php echo 'exec';",
1189 ],
1190 ];
1191
1192 // it would be good to check other popular languages here, but it'll be slow.
1193
1194 Wikimedia\suppressWarnings();
1195
1196 foreach ( $scriptTypes as $ext => $contents ) {
1197 foreach ( $contents as $source ) {
1198 $file = 'exectest.' . $ext;
1199
1200 if ( !file_put_contents( $dir . $file, $source ) ) {
1201 break;
1202 }
1203
1204 try {
1205 $text = Http::get( $url . $file, [ 'timeout' => 3 ], __METHOD__ );
1206 } catch ( Exception $e ) {
1207 // Http::get throws with allow_url_fopen = false and no curl extension.
1208 $text = null;
1209 }
1210 unlink( $dir . $file );
1211
1212 if ( $text == 'exec' ) {
1213 Wikimedia\restoreWarnings();
1214
1215 return $ext;
1216 }
1217 }
1218 }
1219
1220 Wikimedia\restoreWarnings();
1221
1222 return false;
1223 }
1224
1231 public static function apacheModulePresent( $moduleName ) {
1232 if ( function_exists( 'apache_get_modules' ) && in_array( $moduleName, apache_get_modules() ) ) {
1233 return true;
1234 }
1235 // try it the hard way
1236 ob_start();
1237 phpinfo( INFO_MODULES );
1238 $info = ob_get_clean();
1239
1240 return strpos( $info, $moduleName ) !== false;
1241 }
1242
1248 public function setParserLanguage( $lang ) {
1249 $this->parserOptions->setTargetLanguage( $lang );
1250 $this->parserOptions->setUserLang( $lang );
1251 }
1252
1258 protected function getDocUrl( $page ) {
1259 return "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1260 }
1261
1270 public function findExtensions( $directory = 'extensions' ) {
1271 switch ( $directory ) {
1272 case 'extensions':
1273 return $this->findExtensionsByType( 'extension', 'extensions' );
1274 case 'skins':
1275 return $this->findExtensionsByType( 'skin', 'skins' );
1276 default:
1277 throw new InvalidArgumentException( "Invalid extension type" );
1278 }
1279 }
1280
1289 protected function findExtensionsByType( $type = 'extension', $directory = 'extensions' ) {
1290 if ( $this->getVar( 'IP' ) === null ) {
1291 return [];
1292 }
1293
1294 $extDir = $this->getVar( 'IP' ) . '/' . $directory;
1295 if ( !is_readable( $extDir ) || !is_dir( $extDir ) ) {
1296 return [];
1297 }
1298
1299 $dh = opendir( $extDir );
1300 $exts = [];
1301 while ( ( $file = readdir( $dh ) ) !== false ) {
1302 if ( !is_dir( "$extDir/$file" ) ) {
1303 continue;
1304 }
1305 $status = $this->getExtensionInfo( $type, $directory, $file );
1306 if ( $status->isOK() ) {
1307 $exts[$file] = $status->value;
1308 }
1309 }
1310 closedir( $dh );
1311 uksort( $exts, 'strnatcasecmp' );
1312
1313 return $exts;
1314 }
1315
1323 protected function getExtensionInfo( $type, $parentRelPath, $name ) {
1324 if ( $this->getVar( 'IP' ) === null ) {
1325 throw new Exception( 'Cannot find extensions since the IP variable is not yet set' );
1326 }
1327 if ( $type !== 'extension' && $type !== 'skin' ) {
1328 throw new InvalidArgumentException( "Invalid extension type" );
1329 }
1330 $absDir = $this->getVar( 'IP' ) . "/$parentRelPath/$name";
1331 $relDir = "../$parentRelPath/$name";
1332 if ( !is_dir( $absDir ) ) {
1333 return Status::newFatal( 'config-extension-not-found', $name );
1334 }
1335 $jsonFile = $type . '.json';
1336 $fullJsonFile = "$absDir/$jsonFile";
1337 $isJson = file_exists( $fullJsonFile );
1338 $isPhp = false;
1339 if ( !$isJson ) {
1340 // Only fallback to PHP file if JSON doesn't exist
1341 $fullPhpFile = "$absDir/$name.php";
1342 $isPhp = file_exists( $fullPhpFile );
1343 }
1344 if ( !$isJson && !$isPhp ) {
1345 return Status::newFatal( 'config-extension-not-found', $name );
1346 }
1347
1348 // Extension exists. Now see if there are screenshots
1349 $info = [];
1350 if ( is_dir( "$absDir/screenshots" ) ) {
1351 $paths = glob( "$absDir/screenshots/*.png" );
1352 foreach ( $paths as $path ) {
1353 $info['screenshots'][] = str_replace( $absDir, $relDir, $path );
1354 }
1355 }
1356
1357 if ( $isJson ) {
1358 $jsonStatus = $this->readExtension( $fullJsonFile );
1359 if ( !$jsonStatus->isOK() ) {
1360 return $jsonStatus;
1361 }
1362 $info += $jsonStatus->value;
1363 }
1364
1365 return Status::newGood( $info );
1366 }
1367
1376 private function readExtension( $fullJsonFile, $extDeps = [], $skinDeps = [] ) {
1377 $load = [
1378 $fullJsonFile => 1
1379 ];
1380 if ( $extDeps ) {
1381 $extDir = $this->getVar( 'IP' ) . '/extensions';
1382 foreach ( $extDeps as $dep ) {
1383 $fname = "$extDir/$dep/extension.json";
1384 if ( !file_exists( $fname ) ) {
1385 return Status::newFatal( 'config-extension-not-found', $dep );
1386 }
1387 $load[$fname] = 1;
1388 }
1389 }
1390 if ( $skinDeps ) {
1391 $skinDir = $this->getVar( 'IP' ) . '/skins';
1392 foreach ( $skinDeps as $dep ) {
1393 $fname = "$skinDir/$dep/skin.json";
1394 if ( !file_exists( $fname ) ) {
1395 return Status::newFatal( 'config-extension-not-found', $dep );
1396 }
1397 $load[$fname] = 1;
1398 }
1399 }
1400 $registry = new ExtensionRegistry();
1401 try {
1402 $info = $registry->readFromQueue( $load );
1403 } catch ( ExtensionDependencyError $e ) {
1404 if ( $e->incompatibleCore || $e->incompatibleSkins
1405 || $e->incompatibleExtensions
1406 ) {
1407 // If something is incompatible with a dependency, we have no real
1408 // option besides skipping it
1409 return Status::newFatal( 'config-extension-dependency',
1410 basename( dirname( $fullJsonFile ) ), $e->getMessage() );
1411 } elseif ( $e->missingExtensions || $e->missingSkins ) {
1412 // There's an extension missing in the dependency tree,
1413 // so add those to the dependency list and try again
1414 return $this->readExtension(
1415 $fullJsonFile,
1416 array_merge( $extDeps, $e->missingExtensions ),
1417 array_merge( $skinDeps, $e->missingSkins )
1418 );
1419 }
1420 // Some other kind of dependency error?
1421 return Status::newFatal( 'config-extension-dependency',
1422 basename( dirname( $fullJsonFile ) ), $e->getMessage() );
1423 }
1424 $ret = [];
1425 // The order of credits will be the order of $load,
1426 // so the first extension is the one we want to load,
1427 // everything else is a dependency
1428 $i = 0;
1429 foreach ( $info['credits'] as $name => $credit ) {
1430 $i++;
1431 if ( $i == 1 ) {
1432 // Extension we want to load
1433 continue;
1434 }
1435 $type = basename( $credit['path'] ) === 'skin.json' ? 'skins' : 'extensions';
1436 $ret['requires'][$type][] = $credit['name'];
1437 }
1438 $credits = array_values( $info['credits'] )[0];
1439 if ( isset( $credits['url'] ) ) {
1440 $ret['url'] = $credits['url'];
1441 }
1442 $ret['type'] = $credits['type'];
1443
1444 return Status::newGood( $ret );
1445 }
1446
1455 public function getDefaultSkin( array $skinNames ) {
1456 $defaultSkin = $GLOBALS['wgDefaultSkin'];
1457 if ( !$skinNames || in_array( $defaultSkin, $skinNames ) ) {
1458 return $defaultSkin;
1459 } else {
1460 return $skinNames[0];
1461 }
1462 }
1463
1470 protected function includeExtensions() {
1471 global $IP;
1472 $exts = $this->getVar( '_Extensions' );
1473 $IP = $this->getVar( 'IP' );
1474
1475 // Marker for DatabaseUpdater::loadExtensions so we don't
1476 // double load extensions
1477 define( 'MW_EXTENSIONS_LOADED', true );
1478
1487 global $wgAutoloadClasses;
1488 $wgAutoloadClasses = [];
1489 $queue = [];
1490
1491 require "$IP/includes/DefaultSettings.php";
1492
1493 foreach ( $exts as $e ) {
1494 if ( file_exists( "$IP/extensions/$e/extension.json" ) ) {
1495 $queue["$IP/extensions/$e/extension.json"] = 1;
1496 } else {
1497 require_once "$IP/extensions/$e/$e.php";
1498 }
1499 }
1500
1501 $registry = new ExtensionRegistry();
1502 $data = $registry->readFromQueue( $queue );
1503 $wgAutoloadClasses += $data['autoload'];
1504
1505 // @phan-suppress-next-line PhanUndeclaredVariable $wgHooks is set by DefaultSettings
1506 $hooksWeWant = $wgHooks['LoadExtensionSchemaUpdates'] ?? [];
1507
1508 if ( isset( $data['globals']['wgHooks']['LoadExtensionSchemaUpdates'] ) ) {
1509 $hooksWeWant = array_merge_recursive(
1510 $hooksWeWant,
1511 $data['globals']['wgHooks']['LoadExtensionSchemaUpdates']
1512 );
1513 }
1514 // Unset everyone else's hooks. Lord knows what someone might be doing
1515 // in ParserFirstCallInit (see T29171)
1516 $GLOBALS['wgHooks'] = [ 'LoadExtensionSchemaUpdates' => $hooksWeWant ];
1517
1518 return Status::newGood();
1519 }
1520
1533 protected function getInstallSteps( DatabaseInstaller $installer ) {
1534 $coreInstallSteps = [
1535 [ 'name' => 'database', 'callback' => [ $installer, 'setupDatabase' ] ],
1536 [ 'name' => 'tables', 'callback' => [ $installer, 'createTables' ] ],
1537 [ 'name' => 'interwiki', 'callback' => [ $installer, 'populateInterwikiTable' ] ],
1538 [ 'name' => 'stats', 'callback' => [ $this, 'populateSiteStats' ] ],
1539 [ 'name' => 'keys', 'callback' => [ $this, 'generateKeys' ] ],
1540 [ 'name' => 'updates', 'callback' => [ $installer, 'insertUpdateKeys' ] ],
1541 [ 'name' => 'sysop', 'callback' => [ $this, 'createSysop' ] ],
1542 [ 'name' => 'mainpage', 'callback' => [ $this, 'createMainpage' ] ],
1543 ];
1544
1545 // Build the array of install steps starting from the core install list,
1546 // then adding any callbacks that wanted to attach after a given step
1547 foreach ( $coreInstallSteps as $step ) {
1548 $this->installSteps[] = $step;
1549 if ( isset( $this->extraInstallSteps[$step['name']] ) ) {
1550 $this->installSteps = array_merge(
1551 $this->installSteps,
1552 $this->extraInstallSteps[$step['name']]
1553 );
1554 }
1555 }
1556
1557 // Prepend any steps that want to be at the beginning
1558 if ( isset( $this->extraInstallSteps['BEGINNING'] ) ) {
1559 $this->installSteps = array_merge(
1560 $this->extraInstallSteps['BEGINNING'],
1561 $this->installSteps
1562 );
1563 }
1564
1565 // Extensions should always go first, chance to tie into hooks and such
1566 if ( count( $this->getVar( '_Extensions' ) ) ) {
1567 array_unshift( $this->installSteps,
1568 [ 'name' => 'extensions', 'callback' => [ $this, 'includeExtensions' ] ]
1569 );
1570 $this->installSteps[] = [
1571 'name' => 'extension-tables',
1572 'callback' => [ $installer, 'createExtensionTables' ]
1573 ];
1574 }
1575
1576 return $this->installSteps;
1577 }
1578
1587 public function performInstallation( $startCB, $endCB ) {
1588 $installResults = [];
1589 $installer = $this->getDBInstaller();
1590 $installer->preInstall();
1591 $steps = $this->getInstallSteps( $installer );
1592 foreach ( $steps as $stepObj ) {
1593 $name = $stepObj['name'];
1594 call_user_func_array( $startCB, [ $name ] );
1595
1596 // Perform the callback step
1597 $status = call_user_func( $stepObj['callback'], $installer );
1598
1599 // Output and save the results
1600 call_user_func( $endCB, $name, $status );
1601 $installResults[$name] = $status;
1602
1603 // If we've hit some sort of fatal, we need to bail.
1604 // Callback already had a chance to do output above.
1605 if ( !$status->isOk() ) {
1606 break;
1607 }
1608 }
1609 if ( $status->isOk() ) {
1610 $this->showMessage(
1611 'config-install-db-success'
1612 );
1613 $this->setVar( '_InstallDone', true );
1614 }
1615
1616 return $installResults;
1617 }
1618
1624 public function generateKeys() {
1625 $keys = [ 'wgSecretKey' => 64 ];
1626 if ( strval( $this->getVar( 'wgUpgradeKey' ) ) === '' ) {
1627 $keys['wgUpgradeKey'] = 16;
1628 }
1629
1630 return $this->doGenerateKeys( $keys );
1631 }
1632
1639 protected function doGenerateKeys( $keys ) {
1640 $status = Status::newGood();
1641
1642 foreach ( $keys as $name => $length ) {
1643 $secretKey = MWCryptRand::generateHex( $length );
1644 $this->setVar( $name, $secretKey );
1645 }
1646
1647 return $status;
1648 }
1649
1655 protected function createSysop() {
1656 $name = $this->getVar( '_AdminName' );
1658
1659 if ( !$user ) {
1660 // We should've validated this earlier anyway!
1661 return Status::newFatal( 'config-admin-error-user', $name );
1662 }
1663
1664 if ( $user->idForName() == 0 ) {
1665 $user->addToDatabase();
1666
1667 try {
1668 $user->setPassword( $this->getVar( '_AdminPassword' ) );
1669 } catch ( PasswordError $pwe ) {
1670 return Status::newFatal( 'config-admin-error-password', $name, $pwe->getMessage() );
1671 }
1672
1673 $user->addGroup( 'sysop' );
1674 $user->addGroup( 'bureaucrat' );
1675 $user->addGroup( 'interface-admin' );
1676 if ( $this->getVar( '_AdminEmail' ) ) {
1677 $user->setEmail( $this->getVar( '_AdminEmail' ) );
1678 }
1679 $user->saveSettings();
1680
1681 // Update user count
1682 $ssUpdate = SiteStatsUpdate::factory( [ 'users' => 1 ] );
1683 $ssUpdate->doUpdate();
1684 }
1685 $status = Status::newGood();
1686
1687 if ( $this->getVar( '_Subscribe' ) && $this->getVar( '_AdminEmail' ) ) {
1689 }
1690
1691 return $status;
1692 }
1693
1698 $params = [
1699 'email' => $this->getVar( '_AdminEmail' ),
1700 'language' => 'en',
1701 'digest' => 0
1702 ];
1703
1704 // Mailman doesn't support as many languages as we do, so check to make
1705 // sure their selected language is available
1706 $myLang = $this->getVar( '_UserLang' );
1707 if ( in_array( $myLang, $this->mediaWikiAnnounceLanguages ) ) {
1708 $myLang = $myLang == 'pt-br' ? 'pt_BR' : $myLang; // rewrite to Mailman's pt_BR
1709 $params['language'] = $myLang;
1710 }
1711
1712 if ( MWHttpRequest::canMakeRequests() ) {
1713 $res = MWHttpRequest::factory( $this->mediaWikiAnnounceUrl,
1714 [ 'method' => 'POST', 'postData' => $params ], __METHOD__ )->execute();
1715 if ( !$res->isOK() ) {
1716 $s->warning( 'config-install-subscribe-fail', $res->getMessage() );
1717 }
1718 } else {
1719 $s->warning( 'config-install-subscribe-notpossible' );
1720 }
1721 }
1722
1729 protected function createMainpage( DatabaseInstaller $installer ) {
1730 $status = Status::newGood();
1731 $title = Title::newMainPage();
1732 if ( $title->exists() ) {
1733 $status->warning( 'config-install-mainpage-exists' );
1734 return $status;
1735 }
1736 try {
1737 $page = WikiPage::factory( $title );
1739 wfMessage( 'mainpagetext' )->inContentLanguage()->text() . "\n\n" .
1740 wfMessage( 'mainpagedocfooter' )->inContentLanguage()->text()
1741 );
1742
1743 $status = $page->doEditContent( $content,
1744 '',
1745 EDIT_NEW,
1746 false,
1747 User::newFromName( 'MediaWiki default' )
1748 );
1749 } catch ( Exception $e ) {
1750 // using raw, because $wgShowExceptionDetails can not be set yet
1751 $status->fatal( 'config-install-mainpage-failed', $e->getMessage() );
1752 }
1753
1754 return $status;
1755 }
1756
1760 public static function overrideConfig() {
1761 // Use PHP's built-in session handling, since MediaWiki's
1762 // SessionHandler can't work before we have an object cache set up.
1763 define( 'MW_NO_SESSION_HANDLER', 1 );
1764
1765 // Don't access the database
1766 $GLOBALS['wgUseDatabaseMessages'] = false;
1767 // Don't cache langconv tables
1768 $GLOBALS['wgLanguageConverterCacheType'] = CACHE_NONE;
1769 // Debug-friendly
1770 $GLOBALS['wgShowExceptionDetails'] = true;
1771 $GLOBALS['wgShowHostnames'] = true;
1772 // Don't break forms
1773 $GLOBALS['wgExternalLinkTarget'] = '_blank';
1774
1775 // Allow multiple ob_flush() calls
1776 $GLOBALS['wgDisableOutputCompression'] = true;
1777
1778 // Use a sensible cookie prefix (not my_wiki)
1779 $GLOBALS['wgCookiePrefix'] = 'mw_installer';
1780
1781 // Some of the environment checks make shell requests, remove limits
1782 $GLOBALS['wgMaxShellMemory'] = 0;
1783
1784 // Override the default CookieSessionProvider with a dummy
1785 // implementation that won't stomp on PHP's cookies.
1786 $GLOBALS['wgSessionProviders'] = [
1787 [
1788 'class' => InstallerSessionProvider::class,
1789 'args' => [ [
1790 'priority' => 1,
1791 ] ]
1792 ]
1793 ];
1794
1795 // Don't try to use any object cache for SessionManager either.
1796 $GLOBALS['wgSessionCacheType'] = CACHE_NONE;
1797 }
1798
1806 public function addInstallStep( $callback, $findStep = 'BEGINNING' ) {
1807 $this->extraInstallSteps[$findStep][] = $callback;
1808 }
1809
1814 protected function disableTimeLimit() {
1815 Wikimedia\suppressWarnings();
1816 set_time_limit( 0 );
1817 Wikimedia\restoreWarnings();
1818 }
1819}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
$GLOBALS['IP']
$wgObjectCaches
Advanced object cache configuration.
$wgStyleDirectory
Filesystem stylesheets directory.
$wgAutoloadClasses
Array mapping class names to filenames, for autoloading.
$wgExtensionDirectory
Filesystem extensions directory.
$wgExternalLinkTarget
Set a default target for external links, e.g.
wfIsWindows()
Check if the operating system is Windows.
wfShorthandToInteger( $string='', $default=-1)
Converts shorthand byte notation to integer form.
wfIsHHVM()
Check if we are running under HHVM.
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings,...
Definition Setup.php:123
$wgLang
Definition Setup.php:875
$IP
Definition WebStart.php:41
$line
Definition cdb.php:59
Base class for DBMS-specific installation helper classes.
getConnection()
Connect to the database using the administrative user/password currently defined in the session.
Copyright (C) 2018 Kunal Mehta legoktm@member.fsf.org
ExtensionRegistry class.
Accesses configuration settings from $GLOBALS.
A Config instance which stores all settings as a member variable.
static get( $url, array $options=[], $caller=__METHOD__)
Simple wrapper for Http::request( 'GET' )
Definition Http.php:98
Base installer class.
Definition Installer.php:46
envPrepServer()
Environment prep for the server hostname.
parse( $text, $lineStart=false)
Convert wikitext $text to HTML.
array $compiledDBs
List of detected DBs, access using getCompiledDBs().
Definition Installer.php:66
getExtensionInfo( $type, $parentRelPath, $name)
Title $parserTitle
Cached Title, used by parse().
Definition Installer.php:87
includeExtensions()
Installs the auto-detected extensions.
createMainpage(DatabaseInstaller $installer)
Insert Main Page with default content.
const MINIMUM_PCRE_VERSION
The oldest version of PCRE we can support.
Definition Installer.php:54
getDefaultSkin(array $skinNames)
Returns a default value to be used for $wgDefaultSkin: normally the one set in DefaultSettings,...
envCheckLibicu()
Check the libicu version.
getDBInstaller( $type=false)
Get an instance of DatabaseInstaller for the specified DB type.
envCheckDB()
Environment check for DB types.
envCheckSuhosinMaxValueLength()
Checks if suhosin.get.max_value_length is set, and if so generate a warning because it decreases Reso...
setVar( $name, $value)
Set a MW configuration variable, or internal installer configuration variable.
array $internalDefaults
Variables that are stored alongside globals, and are used for any configuration of the installation p...
envCheckModSecurity()
Scare user to death if they have mod_security or mod_security2.
getFakePassword( $realPassword)
Get a fake password for sending back to the user in HTML.
envCheckServer()
Environment check to inform user which server we've assumed.
disableTimeLimit()
Disable the time limit for execution.
$mediaWikiAnnounceUrl
URL to mediawiki-announce subscription.
static apacheModulePresent( $moduleName)
Checks for presence of an Apache module.
array $rightsProfiles
User rights profiles.
addInstallStep( $callback, $findStep='BEGINNING')
Add an installation step following the given step.
getParserOptions()
getCompiledDBs()
Get a list of DBs supported by current PHP setup.
envCheckBrokenXML()
Some versions of libxml+PHP break < and > encoding horribly.
array $installSteps
The actual list of installation steps.
ParserOptions $parserOptions
Cached ParserOptions, used by parse().
Definition Installer.php:94
dirIsExecutable( $dir, $url)
Checks if scripts located in the given directory can be executed via the given URL.
doEnvironmentPreps()
envCheckGit()
Search for git.
getDocUrl( $page)
Overridden by WebInstaller to provide lastPage parameters.
array $defaultVarNames
MediaWiki configuration globals that will eventually be passed through to LocalSettings....
showMessage( $msg)
UI interface for displaying a short message The parameters are like parameters to wfMessage().
static getExistingLocalSettings()
Determine if LocalSettings.php exists.
showError( $msg)
Same as showMessage(), but for displaying errors.
static getInstallerConfig(Config $baseConfig)
Constructs a Config object that contains configuration settings that should be overwritten for the in...
array $settings
Definition Installer.php:59
envCheckMemory()
Environment check for available memory.
array $objectCaches
Known object cache types and the functions used to test for their existence.
array $licenses
License types.
static maybeGetWebserverPrimaryGroup()
On POSIX systems return the primary group of the webserver we're running under.
doEnvironmentChecks()
Do initial checks of the PHP environment.
disableLinkPopups()
performInstallation( $startCB, $endCB)
Actually perform the installation.
envCheck64Bit()
Checks if we're running on 64 bit or not.
generateKeys()
Generate $wgSecretKey.
populateSiteStats(DatabaseInstaller $installer)
Install step which adds a row to the site_stats table with appropriate initial values.
subscribeToMediaWikiAnnounce(Status $s)
envCheckCache()
Environment check for compiled object cache types.
__construct()
Constructor, always call this from child classes.
int $minMemorySize
Minimum memory size in MB.
Definition Installer.php:80
findExtensionsByType( $type='extension', $directory='extensions')
Find extensions or skins, and return an array containing the value for 'Name' for each found extensio...
doGenerateKeys( $keys)
Generate a secret value for variables using a secure generator.
showStatusMessage(Status $status)
Show a message to the installing user by using a Status object.
readExtension( $fullJsonFile, $extDeps=[], $skinDeps=[])
envCheckPath()
Environment check to inform user which paths we've assumed.
array $envPreps
A list of environment preparation methods called by doEnvironmentPreps().
$mediaWikiAnnounceLanguages
Supported language codes for Mailman.
setPassword( $name, $value)
Set a variable which stores a password, except if the new value is a fake password in which case leav...
envPrepPath()
Environment prep for setting $IP and $wgScriptPath.
static getDBTypes()
Get a list of known DB types.
createSysop()
Create the first user account, grant it sysop, bureaucrat and interface-admin rights.
envCheckPCRE()
Environment check for the PCRE module.
getVar( $name, $default=null)
Get an MW configuration variable, or internal installer configuration variable.
static getDBInstallerClass( $type)
Get the DatabaseInstaller class name for this type.
static overrideConfig()
Override the necessary bits of the config to run an installation.
restoreLinkPopups()
array $extraInstallSteps
Extra steps for installation, for things like DatabaseInstallers to modify.
static array $dbTypes
Known database types.
envCheckDiff3()
Search for GNU diff3.
envCheckShellLocale()
Environment check for preferred locale in shell.
envGetDefaultServer()
Helper function to be called from envPrepServer()
getInstallSteps(DatabaseInstaller $installer)
Get an array of install steps.
array $dbInstallers
Cached DB installer instances, access using getDBInstaller().
Definition Installer.php:73
array $envChecks
A list of environment check methods called by doEnvironmentChecks().
envCheckGraphics()
Environment check for ImageMagick and GD.
envCheckUploadsDirectory()
Environment check for the permissions of the uploads directory.
setParserLanguage( $lang)
ParserOptions are constructed before we determined the language, so fix it.
findExtensions( $directory='extensions')
Find extensions or skins in a subdirectory of $IP.
static generateHex( $chars)
Generate a run of cryptographically random data and return it in hexadecimal string format.
An interwiki lookup that has no data, intended for use in the installer.
MediaWikiServices is the service locator for the application scope of MediaWiki.
Executes shell commands.
Definition Shell.php:44
Provides a fallback sequence for Config objects.
Set options of the Parser.
Show an error when any operation involving passwords fails to run.
Test for PHP+libxml2 bug which breaks XML input subtly with certain versions.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition Status.php:40
Represents a title within MediaWiki.
Definition Title.php:40
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition User.php:585
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition User.php:609
Content object for wiki text pages.
$res
Definition database.txt:21
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining however some of the most important ones are listed below They are typically initialised either in index php or in Setup php $wgTitle Title object created from the request URL $wgOut OutputPage object for HTTP response $wgUser User object for the user associated with the current request $wgLang Language object selected by user preferences $wgContLang Language object associated with the wiki being viewed $wgParser Parser object Parser extensions register their hooks here $wgRequest WebRequest to get request data $wgMemc
Definition globals.txt:64
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration settings
Definition globals.txt:37
const CACHE_NONE
Definition Defines.php:111
const CACHE_ANYTHING
Definition Defines.php:110
const CACHE_MEMCACHED
Definition Defines.php:113
const CACHE_DB
Definition Defines.php:112
const EDIT_NEW
Definition Defines.php:161
see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false $parser
Definition hooks.txt:1834
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:1991
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition hooks.txt:855
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition hooks.txt:1266
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:955
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition hooks.txt:2003
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition hooks.txt:2011
$wgHooks['ArticleShow'][]
Definition hooks.txt:108
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:271
return true to allow those checks to and false if checking is done & $user
Definition hooks.txt:1510
processing should stop and the error should be shown to the user * false
Definition hooks.txt:187
returning false will NOT prevent logging $e
Definition hooks.txt:2175
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
Interface for configuration instances.
Definition Config.php:28
get( $name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
$source
This program is free software; you can redistribute it and/or modify it under the terms of the GNU Ge...
$content
$lines
Definition router.php:61
if(!is_readable( $file)) $ext
Definition router.php:48
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition router.php:42
$params
if(!isset( $args[0])) $lang