MediaWiki  1.33.0
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 
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' );
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] ) ) {
578  $class = self::getDBInstallerClass( $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;
599  $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  } catch ( Wikimedia\Services\ServiceDisabledException $e ) {
698  $html = '<!--DB access attempted during parse--> ' . htmlspecialchars( $text );
699  }
700 
701  return $html;
702  }
703 
707  public function getParserOptions() {
708  return $this->parserOptions;
709  }
710 
711  public function disableLinkPopups() {
712  $this->parserOptions->setExternalLinkTarget( false );
713  }
714 
715  public function restoreLinkPopups() {
716  global $wgExternalLinkTarget;
717  $this->parserOptions->setExternalLinkTarget( $wgExternalLinkTarget );
718  }
719 
728  public function populateSiteStats( DatabaseInstaller $installer ) {
729  $status = $installer->getConnection();
730  if ( !$status->isOK() ) {
731  return $status;
732  }
733  $status->value->insert(
734  'site_stats',
735  [
736  'ss_row_id' => 1,
737  'ss_total_edits' => 0,
738  'ss_good_articles' => 0,
739  'ss_total_pages' => 0,
740  'ss_users' => 0,
741  'ss_active_users' => 0,
742  'ss_images' => 0
743  ],
744  __METHOD__, 'IGNORE'
745  );
746 
747  return Status::newGood();
748  }
749 
754  protected function envCheckDB() {
755  global $wgLang;
756 
757  $allNames = [];
758 
759  // Messages: config-type-mysql, config-type-postgres, config-type-oracle,
760  // config-type-sqlite
761  foreach ( self::getDBTypes() as $name ) {
762  $allNames[] = wfMessage( "config-type-$name" )->text();
763  }
764 
765  $databases = $this->getCompiledDBs();
766 
767  $databases = array_flip( $databases );
768  foreach ( array_keys( $databases ) as $db ) {
769  $installer = $this->getDBInstaller( $db );
770  $status = $installer->checkPrerequisites();
771  if ( !$status->isGood() ) {
772  $this->showStatusMessage( $status );
773  }
774  if ( !$status->isOK() ) {
775  unset( $databases[$db] );
776  }
777  }
778  $databases = array_flip( $databases );
779  if ( !$databases ) {
780  $this->showError( 'config-no-db', $wgLang->commaList( $allNames ), count( $allNames ) );
781 
782  // @todo FIXME: This only works for the web installer!
783  return false;
784  }
785 
786  return true;
787  }
788 
793  protected function envCheckBrokenXML() {
794  $test = new PhpXmlBugTester();
795  if ( !$test->ok ) {
796  $this->showError( 'config-brokenlibxml' );
797 
798  return false;
799  }
800 
801  return true;
802  }
803 
812  protected function envCheckPCRE() {
813  Wikimedia\suppressWarnings();
814  $regexd = preg_replace( '/[\x{0430}-\x{04FF}]/iu', '', '-АБВГД-' );
815  // Need to check for \p support too, as PCRE can be compiled
816  // with utf8 support, but not unicode property support.
817  // check that \p{Zs} (space separators) matches
818  // U+3000 (Ideographic space)
819  $regexprop = preg_replace( '/\p{Zs}/u', '', "-\u{3000}-" );
820  Wikimedia\restoreWarnings();
821  if ( $regexd != '--' || $regexprop != '--' ) {
822  $this->showError( 'config-pcre-no-utf8' );
823 
824  return false;
825  }
826 
827  return true;
828  }
829 
834  protected function envCheckMemory() {
835  $limit = ini_get( 'memory_limit' );
836 
837  if ( !$limit || $limit == -1 ) {
838  return true;
839  }
840 
841  $n = wfShorthandToInteger( $limit );
842 
843  if ( $n < $this->minMemorySize * 1024 * 1024 ) {
844  $newLimit = "{$this->minMemorySize}M";
845 
846  if ( ini_set( "memory_limit", $newLimit ) === false ) {
847  $this->showMessage( 'config-memory-bad', $limit );
848  } else {
849  $this->showMessage( 'config-memory-raised', $limit, $newLimit );
850  $this->setVar( '_RaiseMemory', true );
851  }
852  }
853 
854  return true;
855  }
856 
860  protected function envCheckCache() {
861  $caches = [];
862  foreach ( $this->objectCaches as $name => $function ) {
863  if ( function_exists( $function ) ) {
864  $caches[$name] = true;
865  }
866  }
867 
868  if ( !$caches ) {
869  $this->showMessage( 'config-no-cache-apcu' );
870  }
871 
872  $this->setVar( '_Caches', $caches );
873  }
874 
879  protected function envCheckModSecurity() {
880  if ( self::apacheModulePresent( 'mod_security' )
881  || self::apacheModulePresent( 'mod_security2' ) ) {
882  $this->showMessage( 'config-mod-security' );
883  }
884 
885  return true;
886  }
887 
892  protected function envCheckDiff3() {
893  $names = [ "gdiff3", "diff3" ];
894  if ( wfIsWindows() ) {
895  $names[] = 'diff3.exe';
896  }
897  $versionInfo = [ '--version', 'GNU diffutils' ];
898 
899  $diff3 = ExecutableFinder::findInDefaultPaths( $names, $versionInfo );
900 
901  if ( $diff3 ) {
902  $this->setVar( 'wgDiff3', $diff3 );
903  } else {
904  $this->setVar( 'wgDiff3', false );
905  $this->showMessage( 'config-diff3-bad' );
906  }
907 
908  return true;
909  }
910 
915  protected function envCheckGraphics() {
916  $names = wfIsWindows() ? 'convert.exe' : 'convert';
917  $versionInfo = [ '-version', 'ImageMagick' ];
918  $convert = ExecutableFinder::findInDefaultPaths( $names, $versionInfo );
919 
920  $this->setVar( 'wgImageMagickConvertCommand', '' );
921  if ( $convert ) {
922  $this->setVar( 'wgImageMagickConvertCommand', $convert );
923  $this->showMessage( 'config-imagemagick', $convert );
924 
925  return true;
926  } elseif ( function_exists( 'imagejpeg' ) ) {
927  $this->showMessage( 'config-gd' );
928  } else {
929  $this->showMessage( 'config-no-scaling' );
930  }
931 
932  return true;
933  }
934 
941  protected function envCheckGit() {
942  $names = wfIsWindows() ? 'git.exe' : 'git';
943  $versionInfo = [ '--version', 'git version' ];
944 
945  $git = ExecutableFinder::findInDefaultPaths( $names, $versionInfo );
946 
947  if ( $git ) {
948  $this->setVar( 'wgGitBin', $git );
949  $this->showMessage( 'config-git', $git );
950  } else {
951  $this->setVar( 'wgGitBin', false );
952  $this->showMessage( 'config-git-bad' );
953  }
954 
955  return true;
956  }
957 
963  protected function envCheckServer() {
964  $server = $this->envGetDefaultServer();
965  if ( $server !== null ) {
966  $this->showMessage( 'config-using-server', $server );
967  }
968  return true;
969  }
970 
976  protected function envCheckPath() {
977  $this->showMessage(
978  'config-using-uri',
979  $this->getVar( 'wgServer' ),
980  $this->getVar( 'wgScriptPath' )
981  );
982  return true;
983  }
984 
989  protected function envCheckShellLocale() {
990  $os = php_uname( 's' );
991  $supported = [ 'Linux', 'SunOS', 'HP-UX', 'Darwin' ]; # Tested these
992 
993  if ( !in_array( $os, $supported ) ) {
994  return true;
995  }
996 
997  if ( Shell::isDisabled() ) {
998  return true;
999  }
1000 
1001  # Get a list of available locales.
1002  $result = Shell::command( '/usr/bin/locale', '-a' )
1003  ->execute();
1004 
1005  if ( $result->getExitCode() != 0 ) {
1006  return true;
1007  }
1008 
1009  $lines = $result->getStdout();
1010  $lines = array_map( 'trim', explode( "\n", $lines ) );
1011  $candidatesByLocale = [];
1012  $candidatesByLang = [];
1013  foreach ( $lines as $line ) {
1014  if ( $line === '' ) {
1015  continue;
1016  }
1017 
1018  if ( !preg_match( '/^([a-zA-Z]+)(_[a-zA-Z]+|)\.(utf8|UTF-8)(@[a-zA-Z_]*|)$/i', $line, $m ) ) {
1019  continue;
1020  }
1021 
1022  list( , $lang, , , ) = $m;
1023 
1024  $candidatesByLocale[$m[0]] = $m;
1025  $candidatesByLang[$lang][] = $m;
1026  }
1027 
1028  # Try the current value of LANG.
1029  if ( isset( $candidatesByLocale[getenv( 'LANG' )] ) ) {
1030  $this->setVar( 'wgShellLocale', getenv( 'LANG' ) );
1031 
1032  return true;
1033  }
1034 
1035  # Try the most common ones.
1036  $commonLocales = [ 'C.UTF-8', 'en_US.UTF-8', 'en_US.utf8', 'de_DE.UTF-8', 'de_DE.utf8' ];
1037  foreach ( $commonLocales as $commonLocale ) {
1038  if ( isset( $candidatesByLocale[$commonLocale] ) ) {
1039  $this->setVar( 'wgShellLocale', $commonLocale );
1040 
1041  return true;
1042  }
1043  }
1044 
1045  # Is there an available locale in the Wiki's language?
1046  $wikiLang = $this->getVar( 'wgLanguageCode' );
1047 
1048  if ( isset( $candidatesByLang[$wikiLang] ) ) {
1049  $m = reset( $candidatesByLang[$wikiLang] );
1050  $this->setVar( 'wgShellLocale', $m[0] );
1051 
1052  return true;
1053  }
1054 
1055  # Are there any at all?
1056  if ( count( $candidatesByLocale ) ) {
1057  $m = reset( $candidatesByLocale );
1058  $this->setVar( 'wgShellLocale', $m[0] );
1059 
1060  return true;
1061  }
1062 
1063  # Give up.
1064  return true;
1065  }
1066 
1071  protected function envCheckUploadsDirectory() {
1072  global $IP;
1073 
1074  $dir = $IP . '/images/';
1075  $url = $this->getVar( 'wgServer' ) . $this->getVar( 'wgScriptPath' ) . '/images/';
1076  $safe = !$this->dirIsExecutable( $dir, $url );
1077 
1078  if ( !$safe ) {
1079  $this->showMessage( 'config-uploads-not-safe', $dir );
1080  }
1081 
1082  return true;
1083  }
1084 
1090  protected function envCheckSuhosinMaxValueLength() {
1091  $maxValueLength = ini_get( 'suhosin.get.max_value_length' );
1092  if ( $maxValueLength > 0 && $maxValueLength < 1024 ) {
1093  // Only warn if the value is below the sane 1024
1094  $this->showMessage( 'config-suhosin-max-value-length', $maxValueLength );
1095  }
1096 
1097  return true;
1098  }
1099 
1106  protected function envCheck64Bit() {
1107  if ( PHP_INT_SIZE == 4 ) {
1108  $this->showMessage( 'config-using-32bit' );
1109  }
1110 
1111  return true;
1112  }
1113 
1117  protected function envCheckLibicu() {
1125  $not_normal_c = "\u{FA6C}";
1126  $normal_c = "\u{242EE}";
1127 
1128  $useNormalizer = 'php';
1129  $needsUpdate = false;
1130 
1131  if ( function_exists( 'normalizer_normalize' ) ) {
1132  $useNormalizer = 'intl';
1133  $intl = normalizer_normalize( $not_normal_c, Normalizer::FORM_C );
1134  if ( $intl !== $normal_c ) {
1135  $needsUpdate = true;
1136  }
1137  }
1138 
1139  // Uses messages 'config-unicode-using-php' and 'config-unicode-using-intl'
1140  if ( $useNormalizer === 'php' ) {
1141  $this->showMessage( 'config-unicode-pure-php-warning' );
1142  } else {
1143  $this->showMessage( 'config-unicode-using-' . $useNormalizer );
1144  if ( $needsUpdate ) {
1145  $this->showMessage( 'config-unicode-update-warning' );
1146  }
1147  }
1148  }
1149 
1153  protected function envPrepServer() {
1154  $server = $this->envGetDefaultServer();
1155  if ( $server !== null ) {
1156  $this->setVar( 'wgServer', $server );
1157  }
1158  }
1159 
1164  abstract protected function envGetDefaultServer();
1165 
1169  protected function envPrepPath() {
1170  global $IP;
1171  $IP = dirname( dirname( __DIR__ ) );
1172  $this->setVar( 'IP', $IP );
1173  }
1174 
1183  public function dirIsExecutable( $dir, $url ) {
1184  $scriptTypes = [
1185  'php' => [
1186  "<?php echo 'exec';",
1187  "#!/var/env php\n<?php echo 'exec';",
1188  ],
1189  ];
1190 
1191  // it would be good to check other popular languages here, but it'll be slow.
1192 
1193  Wikimedia\suppressWarnings();
1194 
1195  foreach ( $scriptTypes as $ext => $contents ) {
1196  foreach ( $contents as $source ) {
1197  $file = 'exectest.' . $ext;
1198 
1199  if ( !file_put_contents( $dir . $file, $source ) ) {
1200  break;
1201  }
1202 
1203  try {
1204  $text = Http::get( $url . $file, [ 'timeout' => 3 ], __METHOD__ );
1205  } catch ( Exception $e ) {
1206  // Http::get throws with allow_url_fopen = false and no curl extension.
1207  $text = null;
1208  }
1209  unlink( $dir . $file );
1210 
1211  if ( $text == 'exec' ) {
1212  Wikimedia\restoreWarnings();
1213 
1214  return $ext;
1215  }
1216  }
1217  }
1218 
1219  Wikimedia\restoreWarnings();
1220 
1221  return false;
1222  }
1223 
1230  public static function apacheModulePresent( $moduleName ) {
1231  if ( function_exists( 'apache_get_modules' ) && in_array( $moduleName, apache_get_modules() ) ) {
1232  return true;
1233  }
1234  // try it the hard way
1235  ob_start();
1236  phpinfo( INFO_MODULES );
1237  $info = ob_get_clean();
1238 
1239  return strpos( $info, $moduleName ) !== false;
1240  }
1241 
1247  public function setParserLanguage( $lang ) {
1248  $this->parserOptions->setTargetLanguage( $lang );
1249  $this->parserOptions->setUserLang( $lang );
1250  }
1251 
1257  protected function getDocUrl( $page ) {
1258  return "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1259  }
1260 
1269  public function findExtensions( $directory = 'extensions' ) {
1270  switch ( $directory ) {
1271  case 'extensions':
1272  return $this->findExtensionsByType( 'extension', 'extensions' );
1273  case 'skins':
1274  return $this->findExtensionsByType( 'skin', 'skins' );
1275  default:
1276  throw new InvalidArgumentException( "Invalid extension type" );
1277  }
1278  }
1279 
1288  protected function findExtensionsByType( $type = 'extension', $directory = 'extensions' ) {
1289  if ( $this->getVar( 'IP' ) === null ) {
1290  return [];
1291  }
1292 
1293  $extDir = $this->getVar( 'IP' ) . '/' . $directory;
1294  if ( !is_readable( $extDir ) || !is_dir( $extDir ) ) {
1295  return [];
1296  }
1297 
1298  $dh = opendir( $extDir );
1299  $exts = [];
1300  while ( ( $file = readdir( $dh ) ) !== false ) {
1301  if ( !is_dir( "$extDir/$file" ) ) {
1302  continue;
1303  }
1304  $status = $this->getExtensionInfo( $type, $directory, $file );
1305  if ( $status->isOK() ) {
1306  $exts[$file] = $status->value;
1307  }
1308  }
1309  closedir( $dh );
1310  uksort( $exts, 'strnatcasecmp' );
1311 
1312  return $exts;
1313  }
1314 
1322  protected function getExtensionInfo( $type, $parentRelPath, $name ) {
1323  if ( $this->getVar( 'IP' ) === null ) {
1324  throw new Exception( 'Cannot find extensions since the IP variable is not yet set' );
1325  }
1326  if ( $type !== 'extension' && $type !== 'skin' ) {
1327  throw new InvalidArgumentException( "Invalid extension type" );
1328  }
1329  $absDir = $this->getVar( 'IP' ) . "/$parentRelPath/$name";
1330  $relDir = "../$parentRelPath/$name";
1331  if ( !is_dir( $absDir ) ) {
1332  return Status::newFatal( 'config-extension-not-found', $name );
1333  }
1334  $jsonFile = $type . '.json';
1335  $fullJsonFile = "$absDir/$jsonFile";
1336  $isJson = file_exists( $fullJsonFile );
1337  $isPhp = false;
1338  if ( !$isJson ) {
1339  // Only fallback to PHP file if JSON doesn't exist
1340  $fullPhpFile = "$absDir/$name.php";
1341  $isPhp = file_exists( $fullPhpFile );
1342  }
1343  if ( !$isJson && !$isPhp ) {
1344  return Status::newFatal( 'config-extension-not-found', $name );
1345  }
1346 
1347  // Extension exists. Now see if there are screenshots
1348  $info = [];
1349  if ( is_dir( "$absDir/screenshots" ) ) {
1350  $paths = glob( "$absDir/screenshots/*.png" );
1351  foreach ( $paths as $path ) {
1352  $info['screenshots'][] = str_replace( $absDir, $relDir, $path );
1353  }
1354  }
1355 
1356  if ( $isJson ) {
1357  $jsonStatus = $this->readExtension( $fullJsonFile );
1358  if ( !$jsonStatus->isOK() ) {
1359  return $jsonStatus;
1360  }
1361  $info += $jsonStatus->value;
1362  }
1363 
1364  return Status::newGood( $info );
1365  }
1366 
1375  private function readExtension( $fullJsonFile, $extDeps = [], $skinDeps = [] ) {
1376  $load = [
1377  $fullJsonFile => 1
1378  ];
1379  if ( $extDeps ) {
1380  $extDir = $this->getVar( 'IP' ) . '/extensions';
1381  foreach ( $extDeps as $dep ) {
1382  $fname = "$extDir/$dep/extension.json";
1383  if ( !file_exists( $fname ) ) {
1384  return Status::newFatal( 'config-extension-not-found', $dep );
1385  }
1386  $load[$fname] = 1;
1387  }
1388  }
1389  if ( $skinDeps ) {
1390  $skinDir = $this->getVar( 'IP' ) . '/skins';
1391  foreach ( $skinDeps as $dep ) {
1392  $fname = "$skinDir/$dep/skin.json";
1393  if ( !file_exists( $fname ) ) {
1394  return Status::newFatal( 'config-extension-not-found', $dep );
1395  }
1396  $load[$fname] = 1;
1397  }
1398  }
1399  $registry = new ExtensionRegistry();
1400  try {
1401  $info = $registry->readFromQueue( $load );
1402  } catch ( ExtensionDependencyError $e ) {
1403  if ( $e->incompatibleCore || $e->incompatibleSkins
1404  || $e->incompatibleExtensions
1405  ) {
1406  // If something is incompatible with a dependency, we have no real
1407  // option besides skipping it
1408  return Status::newFatal( 'config-extension-dependency',
1409  basename( dirname( $fullJsonFile ) ), $e->getMessage() );
1410  } elseif ( $e->missingExtensions || $e->missingSkins ) {
1411  // There's an extension missing in the dependency tree,
1412  // so add those to the dependency list and try again
1413  return $this->readExtension(
1414  $fullJsonFile,
1415  array_merge( $extDeps, $e->missingExtensions ),
1416  array_merge( $skinDeps, $e->missingSkins )
1417  );
1418  }
1419  // Some other kind of dependency error?
1420  return Status::newFatal( 'config-extension-dependency',
1421  basename( dirname( $fullJsonFile ) ), $e->getMessage() );
1422  }
1423  $ret = [];
1424  // The order of credits will be the order of $load,
1425  // so the first extension is the one we want to load,
1426  // everything else is a dependency
1427  $i = 0;
1428  foreach ( $info['credits'] as $name => $credit ) {
1429  $i++;
1430  if ( $i == 1 ) {
1431  // Extension we want to load
1432  continue;
1433  }
1434  $type = basename( $credit['path'] ) === 'skin.json' ? 'skins' : 'extensions';
1435  $ret['requires'][$type][] = $credit['name'];
1436  }
1437  $credits = array_values( $info['credits'] )[0];
1438  if ( isset( $credits['url'] ) ) {
1439  $ret['url'] = $credits['url'];
1440  }
1441  $ret['type'] = $credits['type'];
1442 
1443  return Status::newGood( $ret );
1444  }
1445 
1454  public function getDefaultSkin( array $skinNames ) {
1455  $defaultSkin = $GLOBALS['wgDefaultSkin'];
1456  if ( !$skinNames || in_array( $defaultSkin, $skinNames ) ) {
1457  return $defaultSkin;
1458  } else {
1459  return $skinNames[0];
1460  }
1461  }
1462 
1469  protected function includeExtensions() {
1470  global $IP;
1471  $exts = $this->getVar( '_Extensions' );
1472  $IP = $this->getVar( 'IP' );
1473 
1474  // Marker for DatabaseUpdater::loadExtensions so we don't
1475  // double load extensions
1476  define( 'MW_EXTENSIONS_LOADED', true );
1477 
1486  global $wgAutoloadClasses;
1487  $wgAutoloadClasses = [];
1488  $queue = [];
1489 
1490  require "$IP/includes/DefaultSettings.php";
1491 
1492  foreach ( $exts as $e ) {
1493  if ( file_exists( "$IP/extensions/$e/extension.json" ) ) {
1494  $queue["$IP/extensions/$e/extension.json"] = 1;
1495  } else {
1496  require_once "$IP/extensions/$e/$e.php";
1497  }
1498  }
1499 
1500  $registry = new ExtensionRegistry();
1501  $data = $registry->readFromQueue( $queue );
1502  $wgAutoloadClasses += $data['autoload'];
1503 
1504  // @phan-suppress-next-line PhanUndeclaredVariable $wgHooks is set by DefaultSettings
1505  $hooksWeWant = $wgHooks['LoadExtensionSchemaUpdates'] ?? [];
1506 
1507  if ( isset( $data['globals']['wgHooks']['LoadExtensionSchemaUpdates'] ) ) {
1508  $hooksWeWant = array_merge_recursive(
1509  $hooksWeWant,
1510  $data['globals']['wgHooks']['LoadExtensionSchemaUpdates']
1511  );
1512  }
1513  // Unset everyone else's hooks. Lord knows what someone might be doing
1514  // in ParserFirstCallInit (see T29171)
1515  $GLOBALS['wgHooks'] = [ 'LoadExtensionSchemaUpdates' => $hooksWeWant ];
1516 
1517  return Status::newGood();
1518  }
1519 
1532  protected function getInstallSteps( DatabaseInstaller $installer ) {
1533  $coreInstallSteps = [
1534  [ 'name' => 'database', 'callback' => [ $installer, 'setupDatabase' ] ],
1535  [ 'name' => 'tables', 'callback' => [ $installer, 'createTables' ] ],
1536  [ 'name' => 'interwiki', 'callback' => [ $installer, 'populateInterwikiTable' ] ],
1537  [ 'name' => 'stats', 'callback' => [ $this, 'populateSiteStats' ] ],
1538  [ 'name' => 'keys', 'callback' => [ $this, 'generateKeys' ] ],
1539  [ 'name' => 'updates', 'callback' => [ $installer, 'insertUpdateKeys' ] ],
1540  [ 'name' => 'sysop', 'callback' => [ $this, 'createSysop' ] ],
1541  [ 'name' => 'mainpage', 'callback' => [ $this, 'createMainpage' ] ],
1542  ];
1543 
1544  // Build the array of install steps starting from the core install list,
1545  // then adding any callbacks that wanted to attach after a given step
1546  foreach ( $coreInstallSteps as $step ) {
1547  $this->installSteps[] = $step;
1548  if ( isset( $this->extraInstallSteps[$step['name']] ) ) {
1549  $this->installSteps = array_merge(
1550  $this->installSteps,
1551  $this->extraInstallSteps[$step['name']]
1552  );
1553  }
1554  }
1555 
1556  // Prepend any steps that want to be at the beginning
1557  if ( isset( $this->extraInstallSteps['BEGINNING'] ) ) {
1558  $this->installSteps = array_merge(
1559  $this->extraInstallSteps['BEGINNING'],
1560  $this->installSteps
1561  );
1562  }
1563 
1564  // Extensions should always go first, chance to tie into hooks and such
1565  if ( count( $this->getVar( '_Extensions' ) ) ) {
1566  array_unshift( $this->installSteps,
1567  [ 'name' => 'extensions', 'callback' => [ $this, 'includeExtensions' ] ]
1568  );
1569  $this->installSteps[] = [
1570  'name' => 'extension-tables',
1571  'callback' => [ $installer, 'createExtensionTables' ]
1572  ];
1573  }
1574 
1575  return $this->installSteps;
1576  }
1577 
1586  public function performInstallation( $startCB, $endCB ) {
1587  $installResults = [];
1588  $installer = $this->getDBInstaller();
1589  $installer->preInstall();
1590  $steps = $this->getInstallSteps( $installer );
1591  foreach ( $steps as $stepObj ) {
1592  $name = $stepObj['name'];
1593  call_user_func_array( $startCB, [ $name ] );
1594 
1595  // Perform the callback step
1596  $status = call_user_func( $stepObj['callback'], $installer );
1597 
1598  // Output and save the results
1599  call_user_func( $endCB, $name, $status );
1600  $installResults[$name] = $status;
1601 
1602  // If we've hit some sort of fatal, we need to bail.
1603  // Callback already had a chance to do output above.
1604  if ( !$status->isOk() ) {
1605  break;
1606  }
1607  }
1608  if ( $status->isOk() ) {
1609  $this->showMessage(
1610  'config-install-db-success'
1611  );
1612  $this->setVar( '_InstallDone', true );
1613  }
1614 
1615  return $installResults;
1616  }
1617 
1623  public function generateKeys() {
1624  $keys = [ 'wgSecretKey' => 64 ];
1625  if ( strval( $this->getVar( 'wgUpgradeKey' ) ) === '' ) {
1626  $keys['wgUpgradeKey'] = 16;
1627  }
1628 
1629  return $this->doGenerateKeys( $keys );
1630  }
1631 
1638  protected function doGenerateKeys( $keys ) {
1640 
1641  foreach ( $keys as $name => $length ) {
1642  $secretKey = MWCryptRand::generateHex( $length );
1643  $this->setVar( $name, $secretKey );
1644  }
1645 
1646  return $status;
1647  }
1648 
1654  protected function createSysop() {
1655  $name = $this->getVar( '_AdminName' );
1657 
1658  if ( !$user ) {
1659  // We should've validated this earlier anyway!
1660  return Status::newFatal( 'config-admin-error-user', $name );
1661  }
1662 
1663  if ( $user->idForName() == 0 ) {
1664  $user->addToDatabase();
1665 
1666  try {
1667  $user->setPassword( $this->getVar( '_AdminPassword' ) );
1668  } catch ( PasswordError $pwe ) {
1669  return Status::newFatal( 'config-admin-error-password', $name, $pwe->getMessage() );
1670  }
1671 
1672  $user->addGroup( 'sysop' );
1673  $user->addGroup( 'bureaucrat' );
1674  $user->addGroup( 'interface-admin' );
1675  if ( $this->getVar( '_AdminEmail' ) ) {
1676  $user->setEmail( $this->getVar( '_AdminEmail' ) );
1677  }
1678  $user->saveSettings();
1679 
1680  // Update user count
1681  $ssUpdate = SiteStatsUpdate::factory( [ 'users' => 1 ] );
1682  $ssUpdate->doUpdate();
1683  }
1685 
1686  if ( $this->getVar( '_Subscribe' ) && $this->getVar( '_AdminEmail' ) ) {
1688  }
1689 
1690  return $status;
1691  }
1692 
1697  $params = [
1698  'email' => $this->getVar( '_AdminEmail' ),
1699  'language' => 'en',
1700  'digest' => 0
1701  ];
1702 
1703  // Mailman doesn't support as many languages as we do, so check to make
1704  // sure their selected language is available
1705  $myLang = $this->getVar( '_UserLang' );
1706  if ( in_array( $myLang, $this->mediaWikiAnnounceLanguages ) ) {
1707  $myLang = $myLang == 'pt-br' ? 'pt_BR' : $myLang; // rewrite to Mailman's pt_BR
1708  $params['language'] = $myLang;
1709  }
1710 
1712  $res = MWHttpRequest::factory( $this->mediaWikiAnnounceUrl,
1713  [ 'method' => 'POST', 'postData' => $params ], __METHOD__ )->execute();
1714  if ( !$res->isOK() ) {
1715  $s->warning( 'config-install-subscribe-fail', $res->getMessage() );
1716  }
1717  } else {
1718  $s->warning( 'config-install-subscribe-notpossible' );
1719  }
1720  }
1721 
1728  protected function createMainpage( DatabaseInstaller $installer ) {
1731  if ( $title->exists() ) {
1732  $status->warning( 'config-install-mainpage-exists' );
1733  return $status;
1734  }
1735  try {
1736  $page = WikiPage::factory( $title );
1737  $content = new WikitextContent(
1738  wfMessage( 'mainpagetext' )->inContentLanguage()->text() . "\n\n" .
1739  wfMessage( 'mainpagedocfooter' )->inContentLanguage()->text()
1740  );
1741 
1742  $status = $page->doEditContent( $content,
1743  '',
1744  EDIT_NEW,
1745  false,
1746  User::newFromName( 'MediaWiki default' )
1747  );
1748  } catch ( Exception $e ) {
1749  // using raw, because $wgShowExceptionDetails can not be set yet
1750  $status->fatal( 'config-install-mainpage-failed', $e->getMessage() );
1751  }
1752 
1753  return $status;
1754  }
1755 
1759  public static function overrideConfig() {
1760  // Use PHP's built-in session handling, since MediaWiki's
1761  // SessionHandler can't work before we have an object cache set up.
1762  define( 'MW_NO_SESSION_HANDLER', 1 );
1763 
1764  // Don't access the database
1765  $GLOBALS['wgUseDatabaseMessages'] = false;
1766  // Don't cache langconv tables
1767  $GLOBALS['wgLanguageConverterCacheType'] = CACHE_NONE;
1768  // Debug-friendly
1769  $GLOBALS['wgShowExceptionDetails'] = true;
1770  $GLOBALS['wgShowHostnames'] = true;
1771  // Don't break forms
1772  $GLOBALS['wgExternalLinkTarget'] = '_blank';
1773 
1774  // Allow multiple ob_flush() calls
1775  $GLOBALS['wgDisableOutputCompression'] = true;
1776 
1777  // Use a sensible cookie prefix (not my_wiki)
1778  $GLOBALS['wgCookiePrefix'] = 'mw_installer';
1779 
1780  // Some of the environment checks make shell requests, remove limits
1781  $GLOBALS['wgMaxShellMemory'] = 0;
1782 
1783  // Override the default CookieSessionProvider with a dummy
1784  // implementation that won't stomp on PHP's cookies.
1785  $GLOBALS['wgSessionProviders'] = [
1786  [
1788  'args' => [ [
1789  'priority' => 1,
1790  ] ]
1791  ]
1792  ];
1793 
1794  // Don't try to use any object cache for SessionManager either.
1795  $GLOBALS['wgSessionCacheType'] = CACHE_NONE;
1796  }
1797 
1805  public function addInstallStep( $callback, $findStep = 'BEGINNING' ) {
1806  $this->extraInstallSteps[$findStep][] = $callback;
1807  }
1808 
1813  protected function disableTimeLimit() {
1814  Wikimedia\suppressWarnings();
1815  set_time_limit( 0 );
1816  Wikimedia\restoreWarnings();
1817  }
1818 }
Installer\envCheckBrokenXML
envCheckBrokenXML()
Some versions of libxml+PHP break < and > encoding horribly.
Definition: Installer.php:793
$status
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
ParserOptions
Set options of the Parser.
Definition: ParserOptions.php:42
MediaWiki\Shell\Shell
Executes shell commands.
Definition: Shell.php:44
$user
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1476
Installer\__construct
__construct()
Constructor, always call this from child classes.
Definition: Installer.php:402
User\newFromId
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:609
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:306
$file
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
Installer\createMainpage
createMainpage(DatabaseInstaller $installer)
Insert Main Page with default content.
Definition: Installer.php:1728
Installer\showMessage
showMessage( $msg)
UI interface for displaying a short message The parameters are like parameters to wfMessage().
Installer\parse
parse( $text, $lineStart=false)
Convert wikitext $text to HTML.
Definition: Installer.php:688
ExtensionDependencyError
Copyright (C) 2018 Kunal Mehta legoktm@member.fsf.org
Definition: ExtensionDependencyError.php:24
MultiConfig
Provides a fallback sequence for Config objects.
Definition: MultiConfig.php:28
$wgAutoloadClasses
$wgAutoloadClasses['ReplaceTextHooks']
Definition: ReplaceText.php:61
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
HashConfig
A Config instance which stores all settings as a member variable.
Definition: HashConfig.php:28
captcha-old.count
count
Definition: captcha-old.py:249
Installer\showStatusMessage
showStatusMessage(Status $status)
Show a message to the installing user by using a Status object.
Installer\dirIsExecutable
dirIsExecutable( $dir, $url)
Checks if scripts located in the given directory can be executed via the given URL.
Definition: Installer.php:1183
CACHE_NONE
const CACHE_NONE
Definition: Defines.php:102
Installer\envCheckLibicu
envCheckLibicu()
Check the libicu version.
Definition: Installer.php:1117
Title\newMainPage
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:632
$result
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:1983
ExtensionRegistry
ExtensionRegistry class.
Definition: ExtensionRegistry.php:17
CACHE_MEMCACHED
const CACHE_MEMCACHED
Definition: Defines.php:104
Installer\populateSiteStats
populateSiteStats(DatabaseInstaller $installer)
Install step which adds a row to the site_stats table with appropriate initial values.
Definition: Installer.php:728
$out
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
Installer\$extraInstallSteps
array $extraInstallSteps
Extra steps for installation, for things like DatabaseInstallers to modify.
Definition: Installer.php:241
DatabaseInstaller\getConnection
getConnection()
Connect to the database using the administrative user/password currently defined in the session.
Definition: DatabaseInstaller.php:181
Installer\$rightsProfiles
array $rightsProfiles
User rights profiles.
Definition: Installer.php:259
Installer\envCheckShellLocale
envCheckShellLocale()
Environment check for preferred locale in shell.
Definition: Installer.php:989
$wgMemc
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
Installer\envCheckUploadsDirectory
envCheckUploadsDirectory()
Environment check for the permissions of the uploads directory.
Definition: Installer.php:1071
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
Installer\$settings
array $settings
Definition: Installer.php:59
Installer\envPrepServer
envPrepServer()
Environment prep for the server hostname.
Definition: Installer.php:1153
$params
$params
Definition: styleTest.css.php:44
Installer\performInstallation
performInstallation( $startCB, $endCB)
Actually perform the installation.
Definition: Installer.php:1586
Installer\$mediaWikiAnnounceLanguages
$mediaWikiAnnounceLanguages
Supported language codes for Mailman.
Definition: Installer.php:327
PasswordError
Show an error when any operation involving passwords fails to run.
Definition: PasswordError.php:26
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:585
MediaWiki\Interwiki\NullInterwikiLookup
An interwiki lookup that has no data, intended for use in the installer.
Definition: NullInterwikiLookup.php:29
$s
$s
Definition: mergeMessageFileList.php:186
$res
$res
Definition: database.txt:21
Installer\$dbInstallers
array $dbInstallers
Cached DB installer instances, access using getDBInstaller().
Definition: Installer.php:73
Installer\setParserLanguage
setParserLanguage( $lang)
ParserOptions are constructed before we determined the language, so fix it.
Definition: Installer.php:1247
Installer\addInstallStep
addInstallStep( $callback, $findStep='BEGINNING')
Add an installation step following the given step.
Definition: Installer.php:1805
Installer\$internalDefaults
array $internalDefaults
Variables that are stored alongside globals, and are used for any configuration of the installation p...
Definition: Installer.php:197
Installer\setPassword
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:641
Installer\envGetDefaultServer
envGetDefaultServer()
Helper function to be called from envPrepServer()
php
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
Installer\setVar
setVar( $name, $value)
Set a MW configuration variable, or internal installer configuration variable.
Definition: Installer.php:525
Installer\$parserTitle
Title $parserTitle
Cached Title, used by parse().
Definition: Installer.php:87
Installer\$objectCaches
array $objectCaches
Known object cache types and the functions used to test for their existence.
Definition: Installer.php:248
Installer\$minMemorySize
int $minMemorySize
Minimum memory size in MB.
Definition: Installer.php:80
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:40
Installer\overrideConfig
static overrideConfig()
Override the necessary bits of the config to run an installation.
Definition: Installer.php:1759
Installer\createSysop
createSysop()
Create the first user account, grant it sysop, bureaucrat and interface-admin rights.
Definition: Installer.php:1654
Installer\getFakePassword
getFakePassword( $realPassword)
Get a fake password for sending back to the user in HTML.
Definition: Installer.php:630
Config
Interface for configuration instances.
Definition: Config.php:28
$data
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
Definition: generatePhpCharToUpperMappings.php:13
Installer\envCheckSuhosinMaxValueLength
envCheckSuhosinMaxValueLength()
Checks if suhosin.get.max_value_length is set, and if so generate a warning because it decreases Reso...
Definition: Installer.php:1090
Language\getLocalisationCache
static getLocalisationCache()
Get the LocalisationCache instance.
Definition: Language.php:447
Installer\showError
showError( $msg)
Same as showMessage(), but for displaying errors.
$html
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:1985
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
Installer\envPrepPath
envPrepPath()
Environment prep for setting $IP and $wgScriptPath.
Definition: Installer.php:1169
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:138
Installer\envCheckDiff3
envCheckDiff3()
Search for GNU diff3.
Definition: Installer.php:892
Config\get
get( $name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
Installer\generateKeys
generateKeys()
Generate $wgSecretKey.
Definition: Installer.php:1623
Http\get
static get( $url, array $options=[], $caller=__METHOD__)
Simple wrapper for Http::request( 'GET' )
Definition: Http.php:98
Installer\envCheckMemory
envCheckMemory()
Environment check for available memory.
Definition: Installer.php:834
$wgLang
$wgLang
Definition: Setup.php:875
$IP
$IP
Definition: update.php:3
$wgObjectCaches
$wgObjectCaches
Advanced object cache configuration.
Definition: DefaultSettings.php:2384
Installer\getCompiledDBs
getCompiledDBs()
Get a list of DBs supported by current PHP setup.
Definition: Installer.php:548
ObjectCache\getInstance
static getInstance( $id)
Get a cached instance of the specified type of cache object.
Definition: ObjectCache.php:92
$queue
$queue
Definition: mergeMessageFileList.php:159
Installer\envCheckCache
envCheckCache()
Environment check for compiled object cache types.
Definition: Installer.php:860
Installer\getExistingLocalSettings
static getExistingLocalSettings()
Determine if LocalSettings.php exists.
Definition: Installer.php:590
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
Installer\envCheckPath
envCheckPath()
Environment check to inform user which paths we've assumed.
Definition: Installer.php:976
Installer\doGenerateKeys
doGenerateKeys( $keys)
Generate a secret value for variables using a secure generator.
Definition: Installer.php:1638
$lines
$lines
Definition: router.php:61
$parser
see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false $parser
Definition: hooks.txt:1802
Installer\$parserOptions
ParserOptions $parserOptions
Cached ParserOptions, used by parse().
Definition: Installer.php:94
SiteStatsUpdate\factory
static factory(array $deltas)
Definition: SiteStatsUpdate.php:66
GlobalVarConfig
Accesses configuration settings from $GLOBALS.
Definition: GlobalVarConfig.php:28
settings
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
$wgExternalLinkTarget
$wgExternalLinkTarget
Set a default target for external links, e.g.
Definition: DefaultSettings.php:4261
Installer\$dbTypes
static array $dbTypes
Known database types.
Definition: Installer.php:105
Installer\getVar
getVar( $name, $default=null)
Get an MW configuration variable, or internal installer configuration variable.
Definition: Installer.php:539
WikitextContent
Content object for wiki text pages.
Definition: WikitextContent.php:36
array
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))
list
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
Installer\restoreLinkPopups
restoreLinkPopups()
Definition: Installer.php:715
Installer\getDefaultSkin
getDefaultSkin(array $skinNames)
Returns a default value to be used for $wgDefaultSkin: normally the one set in DefaultSettings,...
Definition: Installer.php:1454
$fname
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings,...
Definition: Setup.php:123
Installer\findExtensions
findExtensions( $directory='extensions')
Find extensions or skins in a subdirectory of $IP.
Definition: Installer.php:1269
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
Installer\getInstallerConfig
static getInstallerConfig(Config $baseConfig)
Constructs a Config object that contains configuration settings that should be overwritten for the in...
Definition: Installer.php:364
$line
$line
Definition: cdb.php:59
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2162
$value
$value
Definition: styleTest.css.php:49
Installer\$envPreps
array $envPreps
A list of environment preparation methods called by doEnvironmentPreps().
Definition: Installer.php:148
$wgExtensionDirectory
$wgExtensionDirectory
Filesystem extensions directory.
Definition: DefaultSettings.php:223
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
Installer\$installSteps
array $installSteps
The actual list of installation steps.
Definition: Installer.php:234
wfIsWindows
wfIsWindows()
Check if the operating system is Windows.
Definition: GlobalFunctions.php:1951
Installer\doEnvironmentPreps
doEnvironmentPreps()
Definition: Installer.php:513
Installer\readExtension
readExtension( $fullJsonFile, $extDeps=[], $skinDeps=[])
Definition: Installer.php:1375
CACHE_ANYTHING
const CACHE_ANYTHING
Definition: Defines.php:101
Installer\getDBInstaller
getDBInstaller( $type=false)
Get an instance of DatabaseInstaller for the specified DB type.
Definition: Installer.php:570
DatabaseInstaller
Base class for DBMS-specific installation helper classes.
Definition: DatabaseInstaller.php:35
$ret
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:1985
Installer\envCheckDB
envCheckDB()
Environment check for DB types.
Definition: Installer.php:754
Installer\getInstallSteps
getInstallSteps(DatabaseInstaller $installer)
Get an array of install steps.
Definition: Installer.php:1532
MWCryptRand\generateHex
static generateHex( $chars)
Generate a run of cryptographically random data and return it in hexadecimal string format.
Definition: MWCryptRand.php:74
RequestContext\getMain
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:430
Installer\$compiledDBs
array $compiledDBs
List of detected DBs, access using getCompiledDBs().
Definition: Installer.php:66
Installer\doEnvironmentChecks
doEnvironmentChecks()
Do initial checks of the PHP environment.
Definition: Installer.php:484
EDIT_NEW
const EDIT_NEW
Definition: Defines.php:152
Installer\envCheckGraphics
envCheckGraphics()
Environment check for ImageMagick and GD.
Definition: Installer.php:915
text
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
Definition: All_system_messages.txt:1267
wfShorthandToInteger
wfShorthandToInteger( $string='', $default=-1)
Converts shorthand byte notation to integer form.
Definition: GlobalFunctions.php:2916
Installer\apacheModulePresent
static apacheModulePresent( $moduleName)
Checks for presence of an Apache module.
Definition: Installer.php:1230
PhpXmlBugTester
Test for PHP+libxml2 bug which breaks XML input subtly with certain versions.
Definition: PhpBugTests.php:32
Title
Represents a title within MediaWiki.
Definition: Title.php:40
Installer\envCheckPCRE
envCheckPCRE()
Environment check for the PCRE module.
Definition: Installer.php:812
$wgHooks
$wgHooks['ArticleShow'][]
Definition: hooks.txt:108
Installer\getParserOptions
getParserOptions()
Definition: Installer.php:707
MWHttpRequest\canMakeRequests
static canMakeRequests()
Simple function to test if we can make any sort of requests at all, using cURL or fopen()
Definition: MWHttpRequest.php:169
$path
$path
Definition: NoLocalSettings.php:25
Installer\envCheck64Bit
envCheck64Bit()
Checks if we're running on 64 bit or not.
Definition: Installer.php:1106
as
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
Installer\$licenses
array $licenses
License types.
Definition: Installer.php:284
Installer\disableTimeLimit
disableTimeLimit()
Disable the time limit for execution.
Definition: Installer.php:1813
Wikimedia
This program is free software; you can redistribute it and/or modify it under the terms of the GNU Ge...
$keys
$keys
Definition: testCompression.php:67
$source
$source
Definition: mwdoc-filter.php:46
Installer\envCheckServer
envCheckServer()
Environment check to inform user which server we've assumed.
Definition: Installer.php:963
Installer
Base installer class.
Definition: Installer.php:46
$content
$content
Definition: pageupdater.txt:72
$ext
if(!is_readable( $file)) $ext
Definition: router.php:48
Installer\MINIMUM_PCRE_VERSION
const MINIMUM_PCRE_VERSION
The oldest version of PCRE we can support.
Definition: Installer.php:54
Language\factory
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:215
Installer\findExtensionsByType
findExtensionsByType( $type='extension', $directory='extensions')
Find extensions or skins, and return an array containing the value for 'Name' for each found extensio...
Definition: Installer.php:1288
class
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
ExecutableFinder\findInDefaultPaths
static findInDefaultPaths( $names, $versionInfo=false)
Same as locateExecutable(), but checks in getPossibleBinPaths() by default.
Definition: ExecutableFinder.php:96
Installer\getDBTypes
static getDBTypes()
Get a list of known DB types.
Definition: Installer.php:467
Installer\disableLinkPopups
disableLinkPopups()
Definition: Installer.php:711
MediaWikiServices
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
wfMessage
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
Installer\$mediaWikiAnnounceUrl
$mediaWikiAnnounceUrl
URL to mediawiki-announce subscription.
Definition: Installer.php:321
wfIsHHVM
wfIsHHVM()
Check if we are running under HHVM.
Definition: GlobalFunctions.php:1964
Installer\includeExtensions
includeExtensions()
Installs the auto-detected extensions.
Definition: Installer.php:1469
$wgStyleDirectory
$wgStyleDirectory
Filesystem stylesheets directory.
Definition: DefaultSettings.php:230
Installer\envCheckGit
envCheckGit()
Search for git.
Definition: Installer.php:941
Installer\getDocUrl
getDocUrl( $page)
Overridden by WebInstaller to provide lastPage parameters.
Definition: Installer.php:1257
$GLOBALS
$GLOBALS['IP']
Definition: ComposerHookHandler.php:6
Installer\subscribeToMediaWikiAnnounce
subscribeToMediaWikiAnnounce(Status $s)
Definition: Installer.php:1696
CACHE_DB
const CACHE_DB
Definition: Defines.php:103
MWHttpRequest\factory
static factory( $url, array $options=null, $caller=__METHOD__)
Generate a new request object Deprecated:
Definition: MWHttpRequest.php:183
Installer\maybeGetWebserverPrimaryGroup
static maybeGetWebserverPrimaryGroup()
On POSIX systems return the primary group of the webserver we're running under.
Definition: Installer.php:658
Installer\getExtensionInfo
getExtensionInfo( $type, $parentRelPath, $name)
Definition: Installer.php:1322
Installer\$defaultVarNames
array $defaultVarNames
MediaWiki configuration globals that will eventually be passed through to LocalSettings....
Definition: Installer.php:160
Installer\getDBInstallerClass
static getDBInstallerClass( $type)
Get the DatabaseInstaller class name for this type.
Definition: Installer.php:559
Installer\$envChecks
array $envChecks
A list of environment check methods called by doEnvironmentChecks().
Definition: Installer.php:124
$type
$type
Definition: testCompression.php:48
Installer\envCheckModSecurity
envCheckModSecurity()
Scare user to death if they have mod_security or mod_security2.
Definition: Installer.php:879