MediaWiki  master
Installer.php
Go to the documentation of this file.
1 <?php
30 
46 abstract 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 
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 
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 
341  abstract public function showMessage( $msg, ...$params );
342 
348  abstract public function showError( $msg, ...$params );
349 
354  abstract public function showStatusMessage( Status $status );
355 
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 
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' );
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 
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 
469  public static function getDBTypes() {
470  return self::$dbTypes;
471  }
472 
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  $pcreVersion = explode( ' ', PCRE_VERSION, 2 )[0];
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 
527  public function setVar( $name, $value ) {
528  $this->settings[$name] = $value;
529  }
530 
541  public function getVar( $name, $default = null ) {
542  return $this->settings[$name] ?? $default;
543  }
544 
550  public function getCompiledDBs() {
551  return $this->compiledDBs;
552  }
553 
561  public static function getDBInstallerClass( $type ) {
562  return ucfirst( $type ) . 'Installer';
563  }
564 
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 
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
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 
632  public function getFakePassword( $realPassword ) {
633  return str_repeat( '*', strlen( $realPassword ) );
634  }
635 
643  public function setPassword( $name, $value ) {
644  if ( !preg_match( '/^\*+$/', $value ) ) {
645  $this->setVar( $name, $value );
646  }
647  }
648 
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 
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  ] );
700  } catch ( Wikimedia\Services\ServiceDisabledException $e ) {
701  $html = '<!--DB access attempted during parse--> ' . htmlspecialchars( $text );
702  }
703 
704  return $html;
705  }
706 
710  public function getParserOptions() {
711  return $this->parserOptions;
712  }
713 
714  public function disableLinkPopups() {
715  $this->parserOptions->setExternalLinkTarget( false );
716  }
717 
718  public function restoreLinkPopups() {
719  global $wgExternalLinkTarget;
720  $this->parserOptions->setExternalLinkTarget( $wgExternalLinkTarget );
721  }
722 
731  public function populateSiteStats( DatabaseInstaller $installer ) {
732  $status = $installer->getConnection();
733  if ( !$status->isOK() ) {
734  return $status;
735  }
736  $status->value->insert(
737  'site_stats',
738  [
739  'ss_row_id' => 1,
740  'ss_total_edits' => 0,
741  'ss_good_articles' => 0,
742  'ss_total_pages' => 0,
743  'ss_users' => 0,
744  'ss_active_users' => 0,
745  'ss_images' => 0
746  ],
747  __METHOD__, 'IGNORE'
748  );
749 
750  return Status::newGood();
751  }
752 
757  protected function envCheckDB() {
758  global $wgLang;
759 
760  $allNames = [];
761 
762  // Messages: config-type-mysql, config-type-postgres, config-type-oracle,
763  // config-type-sqlite
764  foreach ( self::getDBTypes() as $name ) {
765  $allNames[] = wfMessage( "config-type-$name" )->text();
766  }
767 
768  $databases = $this->getCompiledDBs();
769 
770  $databases = array_flip( $databases );
771  foreach ( array_keys( $databases ) as $db ) {
772  $installer = $this->getDBInstaller( $db );
773  $status = $installer->checkPrerequisites();
774  if ( !$status->isGood() ) {
775  $this->showStatusMessage( $status );
776  }
777  if ( !$status->isOK() ) {
778  unset( $databases[$db] );
779  }
780  }
781  $databases = array_flip( $databases );
782  if ( !$databases ) {
783  $this->showError( 'config-no-db', $wgLang->commaList( $allNames ), count( $allNames ) );
784 
785  // @todo FIXME: This only works for the web installer!
786  return false;
787  }
788 
789  return true;
790  }
791 
796  protected function envCheckBrokenXML() {
797  $test = new PhpXmlBugTester();
798  if ( !$test->ok ) {
799  $this->showError( 'config-brokenlibxml' );
800 
801  return false;
802  }
803 
804  return true;
805  }
806 
815  protected function envCheckPCRE() {
816  Wikimedia\suppressWarnings();
817  $regexd = preg_replace( '/[\x{0430}-\x{04FF}]/iu', '', '-АБВГД-' );
818  // Need to check for \p support too, as PCRE can be compiled
819  // with utf8 support, but not unicode property support.
820  // check that \p{Zs} (space separators) matches
821  // U+3000 (Ideographic space)
822  $regexprop = preg_replace( '/\p{Zs}/u', '', "-\u{3000}-" );
823  Wikimedia\restoreWarnings();
824  if ( $regexd != '--' || $regexprop != '--' ) {
825  $this->showError( 'config-pcre-no-utf8' );
826 
827  return false;
828  }
829 
830  return true;
831  }
832 
837  protected function envCheckMemory() {
838  $limit = ini_get( 'memory_limit' );
839 
840  if ( !$limit || $limit == -1 ) {
841  return true;
842  }
843 
844  $n = wfShorthandToInteger( $limit );
845 
846  if ( $n < $this->minMemorySize * 1024 * 1024 ) {
847  $newLimit = "{$this->minMemorySize}M";
848 
849  if ( ini_set( "memory_limit", $newLimit ) === false ) {
850  $this->showMessage( 'config-memory-bad', $limit );
851  } else {
852  $this->showMessage( 'config-memory-raised', $limit, $newLimit );
853  $this->setVar( '_RaiseMemory', true );
854  }
855  }
856 
857  return true;
858  }
859 
863  protected function envCheckCache() {
864  $caches = [];
865  foreach ( $this->objectCaches as $name => $function ) {
866  if ( function_exists( $function ) ) {
867  $caches[$name] = true;
868  }
869  }
870 
871  if ( !$caches ) {
872  $this->showMessage( 'config-no-cache-apcu' );
873  }
874 
875  $this->setVar( '_Caches', $caches );
876  }
877 
882  protected function envCheckModSecurity() {
883  if ( self::apacheModulePresent( 'mod_security' )
884  || self::apacheModulePresent( 'mod_security2' ) ) {
885  $this->showMessage( 'config-mod-security' );
886  }
887 
888  return true;
889  }
890 
895  protected function envCheckDiff3() {
896  $names = [ "gdiff3", "diff3" ];
897  if ( wfIsWindows() ) {
898  $names[] = 'diff3.exe';
899  }
900  $versionInfo = [ '--version', 'GNU diffutils' ];
901 
902  $diff3 = ExecutableFinder::findInDefaultPaths( $names, $versionInfo );
903 
904  if ( $diff3 ) {
905  $this->setVar( 'wgDiff3', $diff3 );
906  } else {
907  $this->setVar( 'wgDiff3', false );
908  $this->showMessage( 'config-diff3-bad' );
909  }
910 
911  return true;
912  }
913 
918  protected function envCheckGraphics() {
919  $names = wfIsWindows() ? 'convert.exe' : 'convert';
920  $versionInfo = [ '-version', 'ImageMagick' ];
921  $convert = ExecutableFinder::findInDefaultPaths( $names, $versionInfo );
922 
923  $this->setVar( 'wgImageMagickConvertCommand', '' );
924  if ( $convert ) {
925  $this->setVar( 'wgImageMagickConvertCommand', $convert );
926  $this->showMessage( 'config-imagemagick', $convert );
927 
928  return true;
929  } elseif ( function_exists( 'imagejpeg' ) ) {
930  $this->showMessage( 'config-gd' );
931  } else {
932  $this->showMessage( 'config-no-scaling' );
933  }
934 
935  return true;
936  }
937 
944  protected function envCheckGit() {
945  $names = wfIsWindows() ? 'git.exe' : 'git';
946  $versionInfo = [ '--version', 'git version' ];
947 
948  $git = ExecutableFinder::findInDefaultPaths( $names, $versionInfo );
949 
950  if ( $git ) {
951  $this->setVar( 'wgGitBin', $git );
952  $this->showMessage( 'config-git', $git );
953  } else {
954  $this->setVar( 'wgGitBin', false );
955  $this->showMessage( 'config-git-bad' );
956  }
957 
958  return true;
959  }
960 
966  protected function envCheckServer() {
967  $server = $this->envGetDefaultServer();
968  if ( $server !== null ) {
969  $this->showMessage( 'config-using-server', $server );
970  }
971  return true;
972  }
973 
979  protected function envCheckPath() {
980  $this->showMessage(
981  'config-using-uri',
982  $this->getVar( 'wgServer' ),
983  $this->getVar( 'wgScriptPath' )
984  );
985  return true;
986  }
987 
992  protected function envCheckShellLocale() {
993  $os = php_uname( 's' );
994  $supported = [ 'Linux', 'SunOS', 'HP-UX', 'Darwin' ]; # Tested these
995 
996  if ( !in_array( $os, $supported ) ) {
997  return true;
998  }
999 
1000  if ( Shell::isDisabled() ) {
1001  return true;
1002  }
1003 
1004  # Get a list of available locales.
1005  $result = Shell::command( '/usr/bin/locale', '-a' )
1006  ->execute();
1007 
1008  if ( $result->getExitCode() != 0 ) {
1009  return true;
1010  }
1011 
1012  $lines = $result->getStdout();
1013  $lines = array_map( 'trim', explode( "\n", $lines ) );
1014  $candidatesByLocale = [];
1015  $candidatesByLang = [];
1016  foreach ( $lines as $line ) {
1017  if ( $line === '' ) {
1018  continue;
1019  }
1020 
1021  if ( !preg_match( '/^([a-zA-Z]+)(_[a-zA-Z]+|)\.(utf8|UTF-8)(@[a-zA-Z_]*|)$/i', $line, $m ) ) {
1022  continue;
1023  }
1024 
1025  list( , $lang, , , ) = $m;
1026 
1027  $candidatesByLocale[$m[0]] = $m;
1028  $candidatesByLang[$lang][] = $m;
1029  }
1030 
1031  # Try the current value of LANG.
1032  if ( isset( $candidatesByLocale[getenv( 'LANG' )] ) ) {
1033  $this->setVar( 'wgShellLocale', getenv( 'LANG' ) );
1034 
1035  return true;
1036  }
1037 
1038  # Try the most common ones.
1039  $commonLocales = [ 'C.UTF-8', 'en_US.UTF-8', 'en_US.utf8', 'de_DE.UTF-8', 'de_DE.utf8' ];
1040  foreach ( $commonLocales as $commonLocale ) {
1041  if ( isset( $candidatesByLocale[$commonLocale] ) ) {
1042  $this->setVar( 'wgShellLocale', $commonLocale );
1043 
1044  return true;
1045  }
1046  }
1047 
1048  # Is there an available locale in the Wiki's language?
1049  $wikiLang = $this->getVar( 'wgLanguageCode' );
1050 
1051  if ( isset( $candidatesByLang[$wikiLang] ) ) {
1052  $m = reset( $candidatesByLang[$wikiLang] );
1053  $this->setVar( 'wgShellLocale', $m[0] );
1054 
1055  return true;
1056  }
1057 
1058  # Are there any at all?
1059  if ( count( $candidatesByLocale ) ) {
1060  $m = reset( $candidatesByLocale );
1061  $this->setVar( 'wgShellLocale', $m[0] );
1062 
1063  return true;
1064  }
1065 
1066  # Give up.
1067  return true;
1068  }
1069 
1074  protected function envCheckUploadsDirectory() {
1075  global $IP;
1076 
1077  $dir = $IP . '/images/';
1078  $url = $this->getVar( 'wgServer' ) . $this->getVar( 'wgScriptPath' ) . '/images/';
1079  $safe = !$this->dirIsExecutable( $dir, $url );
1080 
1081  if ( !$safe ) {
1082  $this->showMessage( 'config-uploads-not-safe', $dir );
1083  }
1084 
1085  return true;
1086  }
1087 
1093  protected function envCheckSuhosinMaxValueLength() {
1094  $maxValueLength = ini_get( 'suhosin.get.max_value_length' );
1095  if ( $maxValueLength > 0 && $maxValueLength < 1024 ) {
1096  // Only warn if the value is below the sane 1024
1097  $this->showMessage( 'config-suhosin-max-value-length', $maxValueLength );
1098  }
1099 
1100  return true;
1101  }
1102 
1109  protected function envCheck64Bit() {
1110  if ( PHP_INT_SIZE == 4 ) {
1111  $this->showMessage( 'config-using-32bit' );
1112  }
1113 
1114  return true;
1115  }
1116 
1120  protected function envCheckLibicu() {
1128  $not_normal_c = "\u{FA6C}";
1129  $normal_c = "\u{242EE}";
1130 
1131  $useNormalizer = 'php';
1132  $needsUpdate = false;
1133 
1134  if ( function_exists( 'normalizer_normalize' ) ) {
1135  $useNormalizer = 'intl';
1136  $intl = normalizer_normalize( $not_normal_c, Normalizer::FORM_C );
1137  if ( $intl !== $normal_c ) {
1138  $needsUpdate = true;
1139  }
1140  }
1141 
1142  // Uses messages 'config-unicode-using-php' and 'config-unicode-using-intl'
1143  if ( $useNormalizer === 'php' ) {
1144  $this->showMessage( 'config-unicode-pure-php-warning' );
1145  } else {
1146  $this->showMessage( 'config-unicode-using-' . $useNormalizer );
1147  if ( $needsUpdate ) {
1148  $this->showMessage( 'config-unicode-update-warning' );
1149  }
1150  }
1151  }
1152 
1156  protected function envPrepServer() {
1157  $server = $this->envGetDefaultServer();
1158  if ( $server !== null ) {
1159  $this->setVar( 'wgServer', $server );
1160  }
1161  }
1162 
1167  abstract protected function envGetDefaultServer();
1168 
1172  protected function envPrepPath() {
1173  global $IP;
1174  $IP = dirname( dirname( __DIR__ ) );
1175  $this->setVar( 'IP', $IP );
1176  }
1177 
1186  public function dirIsExecutable( $dir, $url ) {
1187  $scriptTypes = [
1188  'php' => [
1189  "<?php echo 'exec';",
1190  "#!/var/env php\n<?php echo 'exec';",
1191  ],
1192  ];
1193 
1194  // it would be good to check other popular languages here, but it'll be slow.
1195 
1196  Wikimedia\suppressWarnings();
1197 
1198  foreach ( $scriptTypes as $ext => $contents ) {
1199  foreach ( $contents as $source ) {
1200  $file = 'exectest.' . $ext;
1201 
1202  if ( !file_put_contents( $dir . $file, $source ) ) {
1203  break;
1204  }
1205 
1206  try {
1207  $text = MediaWikiServices::getInstance()->getHttpRequestFactory()->
1208  get( $url . $file, [ 'timeout' => 3 ], __METHOD__ );
1209  } catch ( Exception $e ) {
1210  // HttpRequestFactory::get can throw with allow_url_fopen = false and no curl
1211  // extension.
1212  $text = null;
1213  }
1214  unlink( $dir . $file );
1215 
1216  if ( $text == 'exec' ) {
1217  Wikimedia\restoreWarnings();
1218 
1219  return $ext;
1220  }
1221  }
1222  }
1223 
1224  Wikimedia\restoreWarnings();
1225 
1226  return false;
1227  }
1228 
1235  public static function apacheModulePresent( $moduleName ) {
1236  if ( function_exists( 'apache_get_modules' ) && in_array( $moduleName, apache_get_modules() ) ) {
1237  return true;
1238  }
1239  // try it the hard way
1240  ob_start();
1241  phpinfo( INFO_MODULES );
1242  $info = ob_get_clean();
1243 
1244  return strpos( $info, $moduleName ) !== false;
1245  }
1246 
1252  public function setParserLanguage( $lang ) {
1253  $this->parserOptions->setTargetLanguage( $lang );
1254  $this->parserOptions->setUserLang( $lang );
1255  }
1256 
1262  protected function getDocUrl( $page ) {
1263  return "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1264  }
1265 
1274  public function findExtensions( $directory = 'extensions' ) {
1275  switch ( $directory ) {
1276  case 'extensions':
1277  return $this->findExtensionsByType( 'extension', 'extensions' );
1278  case 'skins':
1279  return $this->findExtensionsByType( 'skin', 'skins' );
1280  default:
1281  throw new InvalidArgumentException( "Invalid extension type" );
1282  }
1283  }
1284 
1293  protected function findExtensionsByType( $type = 'extension', $directory = 'extensions' ) {
1294  if ( $this->getVar( 'IP' ) === null ) {
1295  return [];
1296  }
1297 
1298  $extDir = $this->getVar( 'IP' ) . '/' . $directory;
1299  if ( !is_readable( $extDir ) || !is_dir( $extDir ) ) {
1300  return [];
1301  }
1302 
1303  $dh = opendir( $extDir );
1304  $exts = [];
1305  while ( ( $file = readdir( $dh ) ) !== false ) {
1306  if ( !is_dir( "$extDir/$file" ) ) {
1307  continue;
1308  }
1309  $status = $this->getExtensionInfo( $type, $directory, $file );
1310  if ( $status->isOK() ) {
1311  $exts[$file] = $status->value;
1312  }
1313  }
1314  closedir( $dh );
1315  uksort( $exts, 'strnatcasecmp' );
1316 
1317  return $exts;
1318  }
1319 
1327  protected function getExtensionInfo( $type, $parentRelPath, $name ) {
1328  if ( $this->getVar( 'IP' ) === null ) {
1329  throw new Exception( 'Cannot find extensions since the IP variable is not yet set' );
1330  }
1331  if ( $type !== 'extension' && $type !== 'skin' ) {
1332  throw new InvalidArgumentException( "Invalid extension type" );
1333  }
1334  $absDir = $this->getVar( 'IP' ) . "/$parentRelPath/$name";
1335  $relDir = "../$parentRelPath/$name";
1336  if ( !is_dir( $absDir ) ) {
1337  return Status::newFatal( 'config-extension-not-found', $name );
1338  }
1339  $jsonFile = $type . '.json';
1340  $fullJsonFile = "$absDir/$jsonFile";
1341  $isJson = file_exists( $fullJsonFile );
1342  $isPhp = false;
1343  if ( !$isJson ) {
1344  // Only fallback to PHP file if JSON doesn't exist
1345  $fullPhpFile = "$absDir/$name.php";
1346  $isPhp = file_exists( $fullPhpFile );
1347  }
1348  if ( !$isJson && !$isPhp ) {
1349  return Status::newFatal( 'config-extension-not-found', $name );
1350  }
1351 
1352  // Extension exists. Now see if there are screenshots
1353  $info = [];
1354  if ( is_dir( "$absDir/screenshots" ) ) {
1355  $paths = glob( "$absDir/screenshots/*.png" );
1356  foreach ( $paths as $path ) {
1357  $info['screenshots'][] = str_replace( $absDir, $relDir, $path );
1358  }
1359  }
1360 
1361  if ( $isJson ) {
1362  $jsonStatus = $this->readExtension( $fullJsonFile );
1363  if ( !$jsonStatus->isOK() ) {
1364  return $jsonStatus;
1365  }
1366  $info += $jsonStatus->value;
1367  }
1368 
1369  return Status::newGood( $info );
1370  }
1371 
1380  private function readExtension( $fullJsonFile, $extDeps = [], $skinDeps = [] ) {
1381  $load = [
1382  $fullJsonFile => 1
1383  ];
1384  if ( $extDeps ) {
1385  $extDir = $this->getVar( 'IP' ) . '/extensions';
1386  foreach ( $extDeps as $dep ) {
1387  $fname = "$extDir/$dep/extension.json";
1388  if ( !file_exists( $fname ) ) {
1389  return Status::newFatal( 'config-extension-not-found', $dep );
1390  }
1391  $load[$fname] = 1;
1392  }
1393  }
1394  if ( $skinDeps ) {
1395  $skinDir = $this->getVar( 'IP' ) . '/skins';
1396  foreach ( $skinDeps as $dep ) {
1397  $fname = "$skinDir/$dep/skin.json";
1398  if ( !file_exists( $fname ) ) {
1399  return Status::newFatal( 'config-extension-not-found', $dep );
1400  }
1401  $load[$fname] = 1;
1402  }
1403  }
1404  $registry = new ExtensionRegistry();
1405  try {
1406  $info = $registry->readFromQueue( $load );
1407  } catch ( ExtensionDependencyError $e ) {
1408  if ( $e->incompatibleCore || $e->incompatibleSkins
1409  || $e->incompatibleExtensions
1410  ) {
1411  // If something is incompatible with a dependency, we have no real
1412  // option besides skipping it
1413  return Status::newFatal( 'config-extension-dependency',
1414  basename( dirname( $fullJsonFile ) ), $e->getMessage() );
1415  } elseif ( $e->missingExtensions || $e->missingSkins ) {
1416  // There's an extension missing in the dependency tree,
1417  // so add those to the dependency list and try again
1418  return $this->readExtension(
1419  $fullJsonFile,
1420  array_merge( $extDeps, $e->missingExtensions ),
1421  array_merge( $skinDeps, $e->missingSkins )
1422  );
1423  }
1424  // Some other kind of dependency error?
1425  return Status::newFatal( 'config-extension-dependency',
1426  basename( dirname( $fullJsonFile ) ), $e->getMessage() );
1427  }
1428  $ret = [];
1429  // The order of credits will be the order of $load,
1430  // so the first extension is the one we want to load,
1431  // everything else is a dependency
1432  $i = 0;
1433  foreach ( $info['credits'] as $name => $credit ) {
1434  $i++;
1435  if ( $i == 1 ) {
1436  // Extension we want to load
1437  continue;
1438  }
1439  $type = basename( $credit['path'] ) === 'skin.json' ? 'skins' : 'extensions';
1440  $ret['requires'][$type][] = $credit['name'];
1441  }
1442  $credits = array_values( $info['credits'] )[0];
1443  if ( isset( $credits['url'] ) ) {
1444  $ret['url'] = $credits['url'];
1445  }
1446  $ret['type'] = $credits['type'];
1447 
1448  return Status::newGood( $ret );
1449  }
1450 
1459  public function getDefaultSkin( array $skinNames ) {
1460  $defaultSkin = $GLOBALS['wgDefaultSkin'];
1461  if ( !$skinNames || in_array( $defaultSkin, $skinNames ) ) {
1462  return $defaultSkin;
1463  } else {
1464  return $skinNames[0];
1465  }
1466  }
1467 
1474  protected function includeExtensions() {
1475  global $IP;
1476  $exts = $this->getVar( '_Extensions' );
1477  $IP = $this->getVar( 'IP' );
1478 
1479  // Marker for DatabaseUpdater::loadExtensions so we don't
1480  // double load extensions
1481  define( 'MW_EXTENSIONS_LOADED', true );
1482 
1491  global $wgAutoloadClasses;
1492  $wgAutoloadClasses = [];
1493  $queue = [];
1494 
1495  require "$IP/includes/DefaultSettings.php";
1496 
1497  foreach ( $exts as $e ) {
1498  if ( file_exists( "$IP/extensions/$e/extension.json" ) ) {
1499  $queue["$IP/extensions/$e/extension.json"] = 1;
1500  } else {
1501  require_once "$IP/extensions/$e/$e.php";
1502  }
1503  }
1504 
1505  $registry = new ExtensionRegistry();
1506  $data = $registry->readFromQueue( $queue );
1507  $wgAutoloadClasses += $data['autoload'];
1508 
1509  // @phan-suppress-next-line PhanUndeclaredVariable $wgHooks is set by DefaultSettings
1510  $hooksWeWant = $wgHooks['LoadExtensionSchemaUpdates'] ?? [];
1511 
1512  if ( isset( $data['globals']['wgHooks']['LoadExtensionSchemaUpdates'] ) ) {
1513  $hooksWeWant = array_merge_recursive(
1514  $hooksWeWant,
1515  $data['globals']['wgHooks']['LoadExtensionSchemaUpdates']
1516  );
1517  }
1518  // Unset everyone else's hooks. Lord knows what someone might be doing
1519  // in ParserFirstCallInit (see T29171)
1520  $GLOBALS['wgHooks'] = [ 'LoadExtensionSchemaUpdates' => $hooksWeWant ];
1521 
1522  return Status::newGood();
1523  }
1524 
1537  protected function getInstallSteps( DatabaseInstaller $installer ) {
1538  $coreInstallSteps = [
1539  [ 'name' => 'database', 'callback' => [ $installer, 'setupDatabase' ] ],
1540  [ 'name' => 'tables', 'callback' => [ $installer, 'createTables' ] ],
1541  [ 'name' => 'interwiki', 'callback' => [ $installer, 'populateInterwikiTable' ] ],
1542  [ 'name' => 'stats', 'callback' => [ $this, 'populateSiteStats' ] ],
1543  [ 'name' => 'keys', 'callback' => [ $this, 'generateKeys' ] ],
1544  [ 'name' => 'updates', 'callback' => [ $installer, 'insertUpdateKeys' ] ],
1545  [ 'name' => 'sysop', 'callback' => [ $this, 'createSysop' ] ],
1546  [ 'name' => 'mainpage', 'callback' => [ $this, 'createMainpage' ] ],
1547  ];
1548 
1549  // Build the array of install steps starting from the core install list,
1550  // then adding any callbacks that wanted to attach after a given step
1551  foreach ( $coreInstallSteps as $step ) {
1552  $this->installSteps[] = $step;
1553  if ( isset( $this->extraInstallSteps[$step['name']] ) ) {
1554  $this->installSteps = array_merge(
1555  $this->installSteps,
1556  $this->extraInstallSteps[$step['name']]
1557  );
1558  }
1559  }
1560 
1561  // Prepend any steps that want to be at the beginning
1562  if ( isset( $this->extraInstallSteps['BEGINNING'] ) ) {
1563  $this->installSteps = array_merge(
1564  $this->extraInstallSteps['BEGINNING'],
1565  $this->installSteps
1566  );
1567  }
1568 
1569  // Extensions should always go first, chance to tie into hooks and such
1570  if ( count( $this->getVar( '_Extensions' ) ) ) {
1571  array_unshift( $this->installSteps,
1572  [ 'name' => 'extensions', 'callback' => [ $this, 'includeExtensions' ] ]
1573  );
1574  $this->installSteps[] = [
1575  'name' => 'extension-tables',
1576  'callback' => [ $installer, 'createExtensionTables' ]
1577  ];
1578  }
1579 
1580  return $this->installSteps;
1581  }
1582 
1591  public function performInstallation( $startCB, $endCB ) {
1592  $installResults = [];
1593  $installer = $this->getDBInstaller();
1594  $installer->preInstall();
1595  $steps = $this->getInstallSteps( $installer );
1596  foreach ( $steps as $stepObj ) {
1597  $name = $stepObj['name'];
1598  call_user_func_array( $startCB, [ $name ] );
1599 
1600  // Perform the callback step
1601  $status = call_user_func( $stepObj['callback'], $installer );
1602 
1603  // Output and save the results
1604  call_user_func( $endCB, $name, $status );
1605  $installResults[$name] = $status;
1606 
1607  // If we've hit some sort of fatal, we need to bail.
1608  // Callback already had a chance to do output above.
1609  if ( !$status->isOk() ) {
1610  break;
1611  }
1612  }
1613  if ( $status->isOk() ) {
1614  $this->showMessage(
1615  'config-install-db-success'
1616  );
1617  $this->setVar( '_InstallDone', true );
1618  }
1619 
1620  return $installResults;
1621  }
1622 
1628  public function generateKeys() {
1629  $keys = [ 'wgSecretKey' => 64 ];
1630  if ( strval( $this->getVar( 'wgUpgradeKey' ) ) === '' ) {
1631  $keys['wgUpgradeKey'] = 16;
1632  }
1633 
1634  return $this->doGenerateKeys( $keys );
1635  }
1636 
1643  protected function doGenerateKeys( $keys ) {
1645 
1646  foreach ( $keys as $name => $length ) {
1647  $secretKey = MWCryptRand::generateHex( $length );
1648  $this->setVar( $name, $secretKey );
1649  }
1650 
1651  return $status;
1652  }
1653 
1659  protected function createSysop() {
1660  $name = $this->getVar( '_AdminName' );
1662 
1663  if ( !$user ) {
1664  // We should've validated this earlier anyway!
1665  return Status::newFatal( 'config-admin-error-user', $name );
1666  }
1667 
1668  if ( $user->idForName() == 0 ) {
1669  $user->addToDatabase();
1670 
1671  try {
1672  $user->setPassword( $this->getVar( '_AdminPassword' ) );
1673  } catch ( PasswordError $pwe ) {
1674  return Status::newFatal( 'config-admin-error-password', $name, $pwe->getMessage() );
1675  }
1676 
1677  $user->addGroup( 'sysop' );
1678  $user->addGroup( 'bureaucrat' );
1679  $user->addGroup( 'interface-admin' );
1680  if ( $this->getVar( '_AdminEmail' ) ) {
1681  $user->setEmail( $this->getVar( '_AdminEmail' ) );
1682  }
1683  $user->saveSettings();
1684 
1685  // Update user count
1686  $ssUpdate = SiteStatsUpdate::factory( [ 'users' => 1 ] );
1687  $ssUpdate->doUpdate();
1688  }
1690 
1691  if ( $this->getVar( '_Subscribe' ) && $this->getVar( '_AdminEmail' ) ) {
1693  }
1694 
1695  return $status;
1696  }
1697 
1702  $params = [
1703  'email' => $this->getVar( '_AdminEmail' ),
1704  'language' => 'en',
1705  'digest' => 0
1706  ];
1707 
1708  // Mailman doesn't support as many languages as we do, so check to make
1709  // sure their selected language is available
1710  $myLang = $this->getVar( '_UserLang' );
1711  if ( in_array( $myLang, $this->mediaWikiAnnounceLanguages ) ) {
1712  $myLang = $myLang == 'pt-br' ? 'pt_BR' : $myLang; // rewrite to Mailman's pt_BR
1713  $params['language'] = $myLang;
1714  }
1715 
1717  $res = MWHttpRequest::factory( $this->mediaWikiAnnounceUrl,
1718  [ 'method' => 'POST', 'postData' => $params ], __METHOD__ )->execute();
1719  if ( !$res->isOK() ) {
1720  $s->warning( 'config-install-subscribe-fail', $res->getMessage() );
1721  }
1722  } else {
1723  $s->warning( 'config-install-subscribe-notpossible' );
1724  }
1725  }
1726 
1733  protected function createMainpage( DatabaseInstaller $installer ) {
1736  if ( $title->exists() ) {
1737  $status->warning( 'config-install-mainpage-exists' );
1738  return $status;
1739  }
1740  try {
1741  $page = WikiPage::factory( $title );
1742  $content = new WikitextContent(
1743  wfMessage( 'mainpagetext' )->inContentLanguage()->text() . "\n\n" .
1744  wfMessage( 'mainpagedocfooter' )->inContentLanguage()->text()
1745  );
1746 
1747  $status = $page->doEditContent( $content,
1748  '',
1749  EDIT_NEW,
1750  false,
1751  User::newFromName( 'MediaWiki default' )
1752  );
1753  } catch ( Exception $e ) {
1754  // using raw, because $wgShowExceptionDetails can not be set yet
1755  $status->fatal( 'config-install-mainpage-failed', $e->getMessage() );
1756  }
1757 
1758  return $status;
1759  }
1760 
1764  public static function overrideConfig() {
1765  // Use PHP's built-in session handling, since MediaWiki's
1766  // SessionHandler can't work before we have an object cache set up.
1767  define( 'MW_NO_SESSION_HANDLER', 1 );
1768 
1769  // Don't access the database
1770  $GLOBALS['wgUseDatabaseMessages'] = false;
1771  // Don't cache langconv tables
1772  $GLOBALS['wgLanguageConverterCacheType'] = CACHE_NONE;
1773  // Debug-friendly
1774  $GLOBALS['wgShowExceptionDetails'] = true;
1775  $GLOBALS['wgShowHostnames'] = true;
1776  // Don't break forms
1777  $GLOBALS['wgExternalLinkTarget'] = '_blank';
1778 
1779  // Allow multiple ob_flush() calls
1780  $GLOBALS['wgDisableOutputCompression'] = true;
1781 
1782  // Use a sensible cookie prefix (not my_wiki)
1783  $GLOBALS['wgCookiePrefix'] = 'mw_installer';
1784 
1785  // Some of the environment checks make shell requests, remove limits
1786  $GLOBALS['wgMaxShellMemory'] = 0;
1787 
1788  // Override the default CookieSessionProvider with a dummy
1789  // implementation that won't stomp on PHP's cookies.
1790  $GLOBALS['wgSessionProviders'] = [
1791  [
1793  'args' => [ [
1794  'priority' => 1,
1795  ] ]
1796  ]
1797  ];
1798 
1799  // Don't try to use any object cache for SessionManager either.
1800  $GLOBALS['wgSessionCacheType'] = CACHE_NONE;
1801  }
1802 
1810  public function addInstallStep( $callback, $findStep = 'BEGINNING' ) {
1811  $this->extraInstallSteps[$findStep][] = $callback;
1812  }
1813 
1818  protected function disableTimeLimit() {
1819  Wikimedia\suppressWarnings();
1820  set_time_limit( 0 );
1821  Wikimedia\restoreWarnings();
1822  }
1823 }
static getDBInstallerClass( $type)
Get the DatabaseInstaller class name for this type.
Definition: Installer.php:561
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:138
envCheckServer()
Environment check to inform user which server we&#39;ve assumed.
Definition: Installer.php:966
array $internalDefaults
Variables that are stored alongside globals, and are used for any configuration of the installation p...
Definition: Installer.php:197
envCheckBrokenXML()
Some versions of libxml+PHP break < and > encoding horribly.
Definition: Installer.php:796
static getLocalisationCache()
Get the LocalisationCache instance.
Definition: Language.php:448
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:1982
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
static factory( $url, array $options=null, $caller=__METHOD__)
Generate a new request object.
Title $parserTitle
Cached Title, used by parse().
Definition: Installer.php:87
array $dbInstallers
Cached DB installer instances, access using getDBInstaller().
Definition: Installer.php:73
wfIsHHVM()
Check if we are running under HHVM.
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:25
restoreLinkPopups()
Definition: Installer.php:718
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
static newMainPage(MessageLocalizer $localizer=null)
Create a new Title for the Main Page.
Definition: Title.php:653
$IP
Definition: WebStart.php:41
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:1982
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Copyright (C) 2018 Kunal Mehta legoktm@member.fsf.org
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2159
envPrepPath()
Environment prep for setting $IP and $wgScriptPath.
Definition: Installer.php:1172
static getInstallerConfig(Config $baseConfig)
Constructs a Config object that contains configuration settings that should be overwritten for the in...
Definition: Installer.php:366
if(!isset( $args[0])) $lang
envCheckShellLocale()
Environment check for preferred locale in shell.
Definition: Installer.php:992
includeExtensions()
Installs the auto-detected extensions.
Definition: Installer.php:1474
envCheckGraphics()
Environment check for ImageMagick and GD.
Definition: Installer.php:918
$source
$value
doEnvironmentPreps()
Definition: Installer.php:515
envCheckGit()
Search for git.
Definition: Installer.php:944
static getInstance( $id)
Get a cached instance of the specified type of cache object.
Definition: ObjectCache.php:92
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 MediaWikiServices
Definition: injection.txt:23
array $settings
Definition: Installer.php:59
envCheckDiff3()
Search for GNU diff3.
Definition: Installer.php:895
ParserOptions $parserOptions
Cached ParserOptions, used by parse().
Definition: Installer.php:94
envCheckModSecurity()
Scare user to death if they have mod_security or mod_security2.
Definition: Installer.php:882
An interwiki lookup that has no data, intended for use in the installer.
wfIsWindows()
Check if the operating system is Windows.
static canMakeRequests()
Simple function to test if we can make any sort of requests at all, using cURL or fopen() ...
see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false $parser
Definition: hooks.txt:1799
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
setPassword( $name, $value)
Set a variable which stores a password, except if the new value is a fake password in which case leav...
Definition: Installer.php:643
get( $name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
dirIsExecutable( $dir, $url)
Checks if scripts located in the given directory can be executed via the given URL.
Definition: Installer.php:1186
const CACHE_MEMCACHED
Definition: Defines.php:100
getConnection()
Connect to the database using the administrative user/password currently defined in the session...
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. '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:1980
static stripOuterParagraph( $html)
Strip outer.
Definition: Parser.php:6408
array $objectCaches
Known object cache types and the functions used to test for their existence.
Definition: Installer.php:248
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:780
envCheck64Bit()
Checks if we&#39;re running on 64 bit or not.
Definition: Installer.php:1109
showMessage( $msg,... $params)
UI interface for displaying a short message The parameters are like parameters to wfMessage()...
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
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 '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:1263
$wgExtensionDirectory
Filesystem extensions directory.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU Ge...
showStatusMessage(Status $status)
Show a message to the installing user by using a Status object.
envCheckSuhosinMaxValueLength()
Checks if suhosin.get.max_value_length is set, and if so generate a warning because it decreases Reso...
Definition: Installer.php:1093
$mediaWikiAnnounceLanguages
Supported language codes for Mailman.
Definition: Installer.php:327
$wgLang
Definition: Setup.php:931
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
static getMain()
Get the RequestContext object associated with the main request.
generateKeys()
Generate $wgSecretKey.
Definition: Installer.php:1628
Interface for configuration instances.
Definition: Config.php:28
$wgHooks['ArticleShow'][]
Definition: hooks.txt:108
static maybeGetWebserverPrimaryGroup()
On POSIX systems return the primary group of the webserver we&#39;re running under.
Definition: Installer.php:660
warning( $message)
Add a new warning.
getExtensionInfo( $type, $parentRelPath, $name)
Definition: Installer.php:1327
setParserLanguage( $lang)
ParserOptions are constructed before we determined the language, so fix it.
Definition: Installer.php:1252
array $envPreps
A list of environment preparation methods called by doEnvironmentPreps().
Definition: Installer.php:148
array $envChecks
A list of environment check methods called by doEnvironmentChecks().
Definition: Installer.php:124
addInstallStep( $callback, $findStep='BEGINNING')
Add an installation step following the given step.
Definition: Installer.php:1810
static factory(array $deltas)
$res
Definition: database.txt:21
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
array array $installSteps
The actual list of installation steps.
Definition: Installer.php:234
getDBInstaller( $type=false)
Get an instance of DatabaseInstaller for the specified DB type.
Definition: Installer.php:572
static getExistingLocalSettings()
Determine if LocalSettings.php exists.
Definition: Installer.php:592
doGenerateKeys( $keys)
Generate a secret value for variables using a secure generator.
Definition: Installer.php:1643
int $minMemorySize
Minimum memory size in MB.
Definition: Installer.php:80
$params
getInstallSteps(DatabaseInstaller $installer)
Get an array of install steps.
Definition: Installer.php:1537
getFakePassword( $realPassword)
Get a fake password for sending back to the user in HTML.
Definition: Installer.php:632
array $compiledDBs
List of detected DBs, access using getCompiledDBs().
Definition: Installer.php:66
getParserOptions()
Definition: Installer.php:710
static generateHex( $chars)
Generate a run of cryptographically random data and return it in hexadecimal string format...
Definition: MWCryptRand.php:36
getVar( $name, $default=null)
Get an MW configuration variable, or internal installer configuration variable.
Definition: Installer.php:541
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 null
Definition: hooks.txt:780
findExtensions( $directory='extensions')
Find extensions or skins in a subdirectory of $IP.
Definition: Installer.php:1274
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:216
disableTimeLimit()
Disable the time limit for execution.
Definition: Installer.php:1818
static apacheModulePresent( $moduleName)
Checks for presence of an Apache module.
Definition: Installer.php:1235
$GLOBALS['IP']
Test for PHP+libxml2 bug which breaks XML input subtly with certain versions.
Provides a fallback sequence for Config objects.
Definition: MultiConfig.php:28
array array $rightsProfiles
User rights profiles.
Definition: Installer.php:259
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:25
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
Definition: distributors.txt:9
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings, LocalSettings).
Definition: Setup.php:123
createMainpage(DatabaseInstaller $installer)
Insert Main Page with default content.
Definition: Installer.php:1733
static findInDefaultPaths( $names, $versionInfo=false)
Same as locateExecutable(), but checks in getPossibleBinPaths() by default.
disableLinkPopups()
Definition: Installer.php:714
parse( $text, $lineStart=false)
Convert wikitext $text to HTML.
Definition: Installer.php:690
envCheckCache()
Environment check for compiled object cache types.
Definition: Installer.php:863
envCheckUploadsDirectory()
Environment check for the permissions of the uploads directory.
Definition: Installer.php:1074
performInstallation( $startCB, $endCB)
Actually perform the installation.
Definition: Installer.php:1591
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:35
const MINIMUM_PCRE_VERSION
The oldest version of PCRE we can support.
Definition: Installer.php:54
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:618
envCheckDB()
Environment check for DB types.
Definition: Installer.php:757
showError( $msg,... $params)
Same as showMessage(), but for displaying errors.
$lines
Definition: router.php:61
getDocUrl( $page)
Overridden by WebInstaller to provide lastPage parameters.
Definition: Installer.php:1262
populateSiteStats(DatabaseInstaller $installer)
Install step which adds a row to the site_stats table with appropriate initial values.
Definition: Installer.php:731
Show an error when any operation involving passwords fails to run.
array $extraInstallSteps
Extra steps for installation, for things like DatabaseInstallers to modify.
Definition: Installer.php:241
getCompiledDBs()
Get a list of DBs supported by current PHP setup.
Definition: Installer.php:550
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
const EDIT_NEW
Definition: Defines.php:148
array array array $licenses
License types.
Definition: Installer.php:284
envGetDefaultServer()
Helper function to be called from envPrepServer()
envCheckPCRE()
Environment check for the PCRE module.
Definition: Installer.php:815
envCheckPath()
Environment check to inform user which paths we&#39;ve assumed.
Definition: Installer.php:979
$line
Definition: cdb.php:59
const CACHE_ANYTHING
Definition: Defines.php:97
__construct()
Constructor, always call this from child classes.
Definition: Installer.php:404
$wgStyleDirectory
Filesystem stylesheets directory.
static array $dbTypes
Known database types.
Definition: Installer.php:105
if(!is_readable( $file)) $ext
Definition: router.php:48
Base class for DBMS-specific installation helper classes.
static overrideConfig()
Override the necessary bits of the config to run an installation.
Definition: Installer.php:1764
Base installer class.
Definition: Installer.php:46
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
$wgObjectCaches
Advanced object cache configuration.
static getDBTypes()
Get a list of known DB types.
Definition: Installer.php:469
$wgAutoloadClasses
Array mapping class names to filenames, for autoloading.
setVar( $name, $value)
Set a MW configuration variable, or internal installer configuration variable.
Definition: Installer.php:527
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:594
findExtensionsByType( $type='extension', $directory='extensions')
Find extensions or skins, and return an array containing the value for &#39;Name&#39; for each found extensio...
Definition: Installer.php:1293
const CACHE_NONE
Definition: Defines.php:98
envCheckLibicu()
Check the libicu version.
Definition: Installer.php:1120
$wgExternalLinkTarget
Set a default target for external links, e.g.
envCheckMemory()
Environment check for available memory.
Definition: Installer.php:837
doEnvironmentChecks()
Do initial checks of the PHP environment.
Definition: Installer.php:486
createSysop()
Create the first user account, grant it sysop, bureaucrat and interface-admin rights.
Definition: Installer.php:1659
$content
Definition: pageupdater.txt:72
A Config instance which stores all settings as a member variable.
Definition: HashConfig.php:28
readExtension( $fullJsonFile, $extDeps=[], $skinDeps=[])
Definition: Installer.php:1380
envPrepServer()
Environment prep for the server hostname.
Definition: Installer.php:1156
wfShorthandToInteger( $string='', $default=-1)
Converts shorthand byte notation to integer form.
array array array $mediaWikiAnnounceUrl
URL to mediawiki-announce subscription.
Definition: Installer.php:321
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
array $defaultVarNames
MediaWiki configuration globals that will eventually be passed through to LocalSettings.php.
Definition: Installer.php:160
const CACHE_DB
Definition: Defines.php:99
subscribeToMediaWikiAnnounce(Status $s)
Definition: Installer.php:1701
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:319
getDefaultSkin(array $skinNames)
Returns a default value to be used for $wgDefaultSkin: normally the one set in DefaultSettings, but will fall back to another if the default skin is missing and some other one is present instead.
Definition: Installer.php:1459