127 'envCheckModSecurity',
133 'envCheckShellLocale',
134 'envCheckUploadsDirectory',
136 'envCheckSuhosinMaxValueLength',
167 'wgEmailAuthentication',
171 'wgImageMagickConvertCommand',
176 'wgDeletedDirectory',
180 'wgUseInstantCommons',
195 '_Environment' =>
false,
196 '_RaiseMemory' =>
false,
197 '_UpgradeDone' =>
false,
198 '_InstallDone' =>
false,
200 '_InstallPassword' =>
'',
201 '_SameAccount' =>
true,
202 '_CreateDBAccount' =>
false,
203 '_NamespaceType' =>
'site-name',
205 '_AdminPassword' =>
'',
206 '_AdminPasswordConfirm' =>
'',
208 '_Subscribe' =>
false,
209 '_SkipOptional' =>
'continue',
210 '_RightsProfile' =>
'wiki',
211 '_LicenseCode' =>
'none',
215 '_MemCachedServers' =>
'',
216 '_UpgradeKeySupplied' =>
false,
217 '_ExistingDBSettings' =>
false,
221 'wgLogo' =>
'$wgResourceBasePath/resources/assets/wiki.png',
222 'wgAuthenticationTokenVersion' => 1,
245 'xcache' =>
'xcache_get',
246 'apc' =>
'apc_fetch',
247 'apcu' =>
'apcu_fetch',
248 'wincache' =>
'wincache_ucache_get'
259 '*' => [
'edit' =>
false ]
263 'createaccount' =>
false,
269 'createaccount' =>
false,
283 'url' =>
'https://creativecommons.org/licenses/by/4.0/',
284 'icon' =>
'$wgResourceBasePath/resources/assets/licenses/cc-by.png',
287 'url' =>
'https://creativecommons.org/licenses/by-sa/4.0/',
288 'icon' =>
'$wgResourceBasePath/resources/assets/licenses/cc-by-sa.png',
291 'url' =>
'https://creativecommons.org/licenses/by-nc-sa/4.0/',
292 'icon' =>
'$wgResourceBasePath/resources/assets/licenses/cc-by-nc-sa.png',
295 'url' =>
'https://creativecommons.org/publicdomain/zero/1.0/',
296 'icon' =>
'$wgResourceBasePath/resources/assets/licenses/cc-0.png',
299 'url' =>
'https://www.gnu.org/copyleft/fdl.html',
300 'icon' =>
'$wgResourceBasePath/resources/assets/licenses/gnu-fdl.png',
319 'https://lists.wikimedia.org/mailman/subscribe/mediawiki-announce';
325 'ca',
'cs',
'da',
'de',
'en',
'es',
'et',
'eu',
'fi',
'fr',
'hr',
'hu',
326 'it',
'ja',
'ko',
'lt',
'nl',
'no',
'pl',
'pt',
'pt-br',
'ro',
'ru',
327 'sl',
'sr',
'sv',
'tr',
'uk'
343 abstract public function showError( $msg );
366 $emptyCache = [
'class' =>
'EmptyBagOStuff' ];
373 ] + $baseConfig->
get(
'ObjectCaches' );
378 $messageDirs = $baseConfig->
get(
'MessagesDirs' );
379 $messageDirs[
'MediawikiInstaller'] = __DIR__ .
'/i18n';
381 $configOverrides->set(
'MessagesDirs', $messageDirs );
383 $installerConfig =
new MultiConfig( [ $configOverrides, $baseConfig ] );
386 $configRegistry = $baseConfig->
get(
'ConfigRegistry' );
387 $configRegistry[
'main'] =
function()
use ( $installerConfig ) {
388 return $installerConfig;
391 $configOverrides->set(
'ConfigRegistry', $configRegistry );
393 return $installerConfig;
403 $installerConfig = self::getInstallerConfig( $defaultConfig );
421 $wgObjectCaches = MediaWikiServices::getInstance()->getMainConfig()->get(
'ObjectCaches' );
430 foreach ( $this->defaultVarNames
as $var ) {
436 $this->compiledDBs = [];
437 foreach ( self::getDBTypes()
as $type ) {
440 if ( !$installer->isCompiled() ) {
443 $this->compiledDBs[] =
$type;
448 $this->parserOptions->setEditSection(
false );
457 return self::$dbTypes;
477 $this->
showMessage(
'config-env-hhvm', HHVM_VERSION );
479 $this->
showMessage(
'config-env-php', PHP_VERSION );
484 list( $pcreVersion ) = explode(
' ', PCRE_VERSION, 2 );
485 if ( version_compare( $pcreVersion, self::MINIMUM_PCRE_VERSION,
'<' ) ) {
486 $this->
showError(
'config-pcre-old', self::MINIMUM_PCRE_VERSION, $pcreVersion );
489 foreach ( $this->envChecks
as $check ) {
497 $this->
setVar(
'_Environment', $good );
503 foreach ( $this->envPreps
as $prep ) {
559 if ( !isset( $this->dbInstallers[
$type] ) ) {
560 $class = ucfirst( $type ) .
'Installer';
561 $this->dbInstallers[
$type] =
new $class( $this );
564 return $this->dbInstallers[
$type];
581 $wgAutoloadClasses = [];
589 MediaWiki\suppressWarnings();
590 $_lsExists = file_exists(
"$IP/LocalSettings.php" );
591 MediaWiki\restoreWarnings();
598 require
"$IP/includes/DefaultSettings.php";
599 require
"$IP/LocalSettings.php";
601 return get_defined_vars();
614 return str_repeat(
'*', strlen( $realPassword ) );
625 if ( !preg_match(
'/^\*+$/',
$value ) ) {
642 if ( !function_exists(
'posix_getegid' ) || !function_exists(
'posix_getpwuid' ) ) {
643 # I don't know this, this isn't UNIX.
647 # posix_getegid() *not* getmygid() because we want the group of the webserver,
648 # not whoever owns the current script.
649 $gid = posix_getegid();
650 $group = posix_getpwuid( $gid )[
'name'];
671 public function parse( $text, $lineStart =
false ) {
675 $out = $wgParser->parse( $text, $this->parserTitle, $this->parserOptions, $lineStart );
678 $html =
'<!--DB access attempted during parse--> ' . htmlspecialchars( $text );
680 if ( !empty( $this->debug ) ) {
681 $html .=
"<!--\n" . $e->getTraceAsString() .
"\n-->";
696 $this->parserOptions->setExternalLinkTarget(
false );
700 global $wgExternalLinkTarget;
701 $this->parserOptions->setExternalLinkTarget( $wgExternalLinkTarget );
721 'ss_total_edits' => 0,
722 'ss_good_articles' => 0,
723 'ss_total_pages' => 0,
744 foreach ( self::getDBTypes()
as $name ) {
745 $allNames[] =
wfMessage(
"config-type-$name" )->text();
750 $databases = array_flip( $databases );
751 foreach ( array_keys( $databases )
as $db ) {
753 $status = $installer->checkPrerequisites();
758 unset( $databases[$db] );
761 $databases = array_flip( $databases );
763 $this->
showError(
'config-no-db', $wgLang->commaList( $allNames ), count( $allNames ) );
779 $this->
showError(
'config-brokenlibxml' );
796 MediaWiki\suppressWarnings();
797 $regexd = preg_replace(
'/[\x{0430}-\x{04FF}]/iu',
'',
'-АБВГД-' );
802 $regexprop = preg_replace(
'/\p{Zs}/u',
'',
"-\xE3\x80\x80-" );
803 MediaWiki\restoreWarnings();
804 if ( $regexd !=
'--' || $regexprop !=
'--' ) {
805 $this->
showError(
'config-pcre-no-utf8' );
818 $limit = ini_get(
'memory_limit' );
826 if ( $n < $this->minMemorySize * 1024 * 1024 ) {
827 $newLimit =
"{$this->minMemorySize}M";
829 if ( ini_set(
"memory_limit", $newLimit ) ===
false ) {
833 $this->
setVar(
'_RaiseMemory',
true );
845 foreach ( $this->objectCaches
as $name => $function ) {
846 if ( function_exists( $function ) ) {
850 $caches[
$name] =
true;
855 $key =
'config-no-cache-apcu';
859 $this->
setVar(
'_Caches', $caches );
867 if ( self::apacheModulePresent(
'mod_security' )
868 || self::apacheModulePresent(
'mod_security2' ) ) {
880 $names = [
"gdiff3",
"diff3",
"diff3.exe" ];
881 $versionInfo = [
'$1 --version 2>&1',
'GNU diffutils' ];
883 $diff3 = self::locateExecutableInDefaultPaths( $names, $versionInfo );
886 $this->
setVar(
'wgDiff3', $diff3 );
888 $this->
setVar(
'wgDiff3',
false );
900 $names = [
wfIsWindows() ?
'convert.exe' :
'convert' ];
901 $versionInfo = [
'$1 -version',
'ImageMagick' ];
902 $convert = self::locateExecutableInDefaultPaths( $names, $versionInfo );
904 $this->
setVar(
'wgImageMagickConvertCommand',
'' );
906 $this->
setVar(
'wgImageMagickConvertCommand', $convert );
907 $this->
showMessage(
'config-imagemagick', $convert );
910 } elseif ( function_exists(
'imagejpeg' ) ) {
927 $versionInfo = [
'$1 --version',
'git version' ];
929 $git = self::locateExecutableInDefaultPaths( $names, $versionInfo );
932 $this->
setVar(
'wgGitBin', $git );
935 $this->
setVar(
'wgGitBin',
false );
949 if ( $server !== null ) {
950 $this->
showMessage(
'config-using-server', $server );
963 $this->
getVar(
'wgServer' ),
964 $this->
getVar(
'wgScriptPath' )
974 $os = php_uname(
's' );
975 $supported = [
'Linux',
'SunOS',
'HP-UX',
'Darwin' ]; # Tested these
977 if ( !in_array( $os, $supported ) ) {
981 # Get a list of available locales.
990 $candidatesByLocale = [];
991 $candidatesByLang = [];
994 if ( $line ===
'' ) {
998 if ( !preg_match(
'/^([a-zA-Z]+)(_[a-zA-Z]+|)\.(utf8|UTF-8)(@[a-zA-Z_]*|)$/i', $line, $m ) ) {
1004 $candidatesByLocale[$m[0]] = $m;
1005 $candidatesByLang[
$lang][] = $m;
1008 # Try the current value of LANG.
1009 if ( isset( $candidatesByLocale[getenv(
'LANG' )] ) ) {
1010 $this->
setVar(
'wgShellLocale', getenv(
'LANG' ) );
1015 # Try the most common ones.
1016 $commonLocales = [
'en_US.UTF-8',
'en_US.utf8',
'de_DE.UTF-8',
'de_DE.utf8' ];
1017 foreach ( $commonLocales
as $commonLocale ) {
1018 if ( isset( $candidatesByLocale[$commonLocale] ) ) {
1019 $this->
setVar(
'wgShellLocale', $commonLocale );
1025 # Is there an available locale in the Wiki's language?
1026 $wikiLang = $this->
getVar(
'wgLanguageCode' );
1028 if ( isset( $candidatesByLang[$wikiLang] ) ) {
1029 $m = reset( $candidatesByLang[$wikiLang] );
1030 $this->
setVar(
'wgShellLocale', $m[0] );
1035 # Are there any at all?
1036 if ( count( $candidatesByLocale ) ) {
1037 $m = reset( $candidatesByLocale );
1038 $this->
setVar(
'wgShellLocale', $m[0] );
1054 $dir = $IP .
'/images/';
1055 $url = $this->
getVar(
'wgServer' ) . $this->
getVar(
'wgScriptPath' ) .
'/images/';
1071 $maxValueLength = ini_get(
'suhosin.get.max_value_length' );
1072 if ( $maxValueLength > 0 && $maxValueLength < 1024 ) {
1074 $this->
showMessage(
'config-suhosin-max-value-length', $maxValueLength );
1089 } elseif ( $c <= 0x7FF ) {
1090 return chr( 0xC0 | $c >> 6 ) . chr( 0x80 | $c & 0x3F );
1091 } elseif ( $c <= 0xFFFF ) {
1092 return chr( 0xE0 | $c >> 12 ) . chr( 0x80 | $c >> 6 & 0x3F ) .
1093 chr( 0x80 | $c & 0x3F );
1094 } elseif ( $c <= 0x10FFFF ) {
1095 return chr( 0xF0 | $c >> 18 ) . chr( 0x80 | $c >> 12 & 0x3F ) .
1096 chr( 0x80 | $c >> 6 & 0x3F ) .
1097 chr( 0x80 | $c & 0x3F );
1117 $useNormalizer =
'php';
1118 $needsUpdate =
false;
1120 if ( function_exists(
'normalizer_normalize' ) ) {
1121 $useNormalizer =
'intl';
1122 $intl = normalizer_normalize( $not_normal_c, Normalizer::FORM_C );
1123 if ( $intl !== $normal_c ) {
1124 $needsUpdate =
true;
1129 if ( $useNormalizer ===
'php' ) {
1130 $this->
showMessage(
'config-unicode-pure-php-warning' );
1132 $this->
showMessage(
'config-unicode-using-' . $useNormalizer );
1133 if ( $needsUpdate ) {
1134 $this->
showMessage(
'config-unicode-update-warning' );
1144 if ( $server !== null ) {
1145 $this->
setVar(
'wgServer', $server );
1160 $IP = dirname( dirname( __DIR__ ) );
1161 $this->
setVar(
'IP', $IP );
1173 [
'/usr/bin',
'/usr/local/bin',
'/opt/csw/bin',
1174 '/usr/gnu/bin',
'/usr/sfw/bin',
'/sw/bin',
'/opt/local/bin' ],
1175 explode( PATH_SEPARATOR, getenv(
'PATH' ) )
1197 if ( !is_array( $names ) ) {
1198 $names = [ $names ];
1204 MediaWiki\suppressWarnings();
1205 $file_exists = is_executable(
$command );
1206 MediaWiki\restoreWarnings();
1208 if ( $file_exists ) {
1209 if ( !$versionInfo ) {
1214 if ( strstr(
wfShellExec( $file ), $versionInfo[1] ) !==
false ) {
1236 foreach ( self::getPossibleBinPaths()
as $path ) {
1237 $exe = self::locateExecutable( $path, $names, $versionInfo );
1238 if ( $exe !==
false ) {
1257 "<?php echo 'ex' . 'ec';",
1258 "#!/var/env php5\n<?php echo 'ex' . 'ec';",
1264 MediaWiki\suppressWarnings();
1266 foreach ( $scriptTypes
as $ext => $contents ) {
1268 $file =
'exectest.' .
$ext;
1270 if ( !file_put_contents(
$dir . $file, $source ) ) {
1275 $text =
Http::get( $url . $file, [
'timeout' => 3 ], __METHOD__ );
1280 unlink(
$dir . $file );
1282 if ( $text ==
'exec' ) {
1283 MediaWiki\restoreWarnings();
1290 MediaWiki\restoreWarnings();
1302 if ( function_exists(
'apache_get_modules' ) && in_array( $moduleName, apache_get_modules() ) ) {
1307 phpinfo( INFO_MODULES );
1308 $info = ob_get_clean();
1310 return strpos( $info, $moduleName ) !==
false;
1319 $this->parserOptions->setTargetLanguage(
$lang );
1320 $this->parserOptions->setUserLang(
$lang );
1329 return "{$_SERVER['PHP_SELF']}?page=" . urlencode(
$page );
1342 if ( $this->
getVar(
'IP' ) === null ) {
1346 $extDir = $this->
getVar(
'IP' ) .
'/' . $directory;
1347 if ( !is_readable( $extDir ) || !is_dir( $extDir ) ) {
1352 $jsonFile = substr( $directory, 0, strlen( $directory ) -1 ) .
'.json';
1354 $dh = opendir( $extDir );
1356 while ( ( $file = readdir( $dh ) ) !==
false ) {
1357 if ( !is_dir(
"$extDir/$file" ) ) {
1360 if ( file_exists(
"$extDir/$file/$jsonFile" ) || file_exists(
"$extDir/$file/$file.php" ) ) {
1365 natcasesort( $exts );
1379 $defaultSkin =
$GLOBALS[
'wgDefaultSkin'];
1380 if ( !$skinNames || in_array( $defaultSkin, $skinNames ) ) {
1381 return $defaultSkin;
1383 return $skinNames[0];
1394 $exts = $this->
getVar(
'_Extensions' );
1395 $IP = $this->
getVar(
'IP' );
1406 $wgAutoloadClasses = [];
1409 require
"$IP/includes/DefaultSettings.php";
1411 foreach ( $exts
as $e ) {
1412 if ( file_exists(
"$IP/extensions/$e/extension.json" ) ) {
1413 $queue[
"$IP/extensions/$e/extension.json"] = 1;
1415 require_once
"$IP/extensions/$e/$e.php";
1420 $data = $registry->readFromQueue(
$queue );
1421 $wgAutoloadClasses += $data[
'autoload'];
1423 $hooksWeWant = isset(
$wgHooks[
'LoadExtensionSchemaUpdates'] ) ?
1424 $wgHooks[
'LoadExtensionSchemaUpdates'] : [];
1426 if ( isset( $data[
'globals'][
'wgHooks'][
'LoadExtensionSchemaUpdates'] ) ) {
1427 $hooksWeWant = array_merge_recursive(
1429 $data[
'globals'][
'wgHooks'][
'LoadExtensionSchemaUpdates']
1434 $GLOBALS[
'wgHooks'] = [
'LoadExtensionSchemaUpdates' => $hooksWeWant ];
1452 $coreInstallSteps = [
1453 [
'name' =>
'database',
'callback' => [ $installer,
'setupDatabase' ] ],
1454 [
'name' =>
'tables',
'callback' => [ $installer,
'createTables' ] ],
1455 [
'name' =>
'interwiki',
'callback' => [ $installer,
'populateInterwikiTable' ] ],
1456 [
'name' =>
'stats',
'callback' => [ $this,
'populateSiteStats' ] ],
1457 [
'name' =>
'keys',
'callback' => [ $this,
'generateKeys' ] ],
1458 [
'name' =>
'updates',
'callback' => [ $installer,
'insertUpdateKeys' ] ],
1459 [
'name' =>
'sysop',
'callback' => [ $this,
'createSysop' ] ],
1460 [
'name' =>
'mainpage',
'callback' => [ $this,
'createMainpage' ] ],
1465 foreach ( $coreInstallSteps
as $step ) {
1466 $this->installSteps[] = $step;
1467 if ( isset( $this->extraInstallSteps[$step[
'name']] ) ) {
1468 $this->installSteps = array_merge(
1469 $this->installSteps,
1470 $this->extraInstallSteps[$step[
'name']]
1476 if ( isset( $this->extraInstallSteps[
'BEGINNING'] ) ) {
1477 $this->installSteps = array_merge(
1478 $this->extraInstallSteps[
'BEGINNING'],
1484 if ( count( $this->
getVar(
'_Extensions' ) ) ) {
1485 array_unshift( $this->installSteps,
1486 [
'name' =>
'extensions',
'callback' => [ $this,
'includeExtensions' ] ]
1488 $this->installSteps[] = [
1489 'name' =>
'extension-tables',
1490 'callback' => [ $installer,
'createExtensionTables' ]
1506 $installResults = [];
1508 $installer->preInstall();
1510 foreach ( $steps
as $stepObj ) {
1511 $name = $stepObj[
'name'];
1512 call_user_func_array( $startCB, [
$name ] );
1515 $status = call_user_func( $stepObj[
'callback'], $installer );
1528 $this->
setVar(
'_InstallDone',
true );
1531 return $installResults;
1540 $keys = [
'wgSecretKey' => 64 ];
1541 if ( strval( $this->
getVar(
'wgUpgradeKey' ) ) ===
'' ) {
1542 $keys[
'wgUpgradeKey'] = 16;
1569 $names = array_keys(
$keys );
1570 $names = preg_replace(
'/^(.*)$/',
'\$$1', $names );
1572 $status->warning(
'config-insecure-keys', $wgLang->listToText( $names ), count( $names ) );
1592 if (
$user->idForName() == 0 ) {
1593 $user->addToDatabase();
1596 $user->setPassword( $this->
getVar(
'_AdminPassword' ) );
1601 $user->addGroup(
'sysop' );
1602 $user->addGroup(
'bureaucrat' );
1603 if ( $this->
getVar(
'_AdminEmail' ) ) {
1604 $user->setEmail( $this->
getVar(
'_AdminEmail' ) );
1606 $user->saveSettings();
1610 $ssUpdate->doUpdate();
1614 if ( $this->
getVar(
'_Subscribe' ) && $this->
getVar(
'_AdminEmail' ) ) {
1626 'email' => $this->
getVar(
'_AdminEmail' ),
1633 $myLang = $this->
getVar(
'_UserLang' );
1634 if ( in_array( $myLang, $this->mediaWikiAnnounceLanguages ) ) {
1635 $myLang = $myLang ==
'pt-br' ?
'pt_BR' : $myLang;
1636 $params[
'language'] = $myLang;
1641 [
'method' =>
'POST',
'postData' =>
$params ], __METHOD__ )->execute();
1642 if ( !
$res->isOK() ) {
1643 $s->
warning(
'config-install-subscribe-fail',
$res->getMessage() );
1646 $s->
warning(
'config-install-subscribe-notpossible' );
1661 wfMessage(
'mainpagetext' )->inContentLanguage()->
text() .
"\n\n" .
1662 wfMessage(
'mainpagedocfooter' )->inContentLanguage()->
text()
1673 $status->fatal(
'config-install-mainpage-failed', $e->getMessage() );
1685 define(
'MW_NO_SESSION_HANDLER', 1 );
1688 $GLOBALS[
'wgUseDatabaseMessages'] =
false;
1692 $GLOBALS[
'wgShowExceptionDetails'] =
true;
1694 $GLOBALS[
'wgExternalLinkTarget'] =
'_blank';
1697 $GLOBALS[
'wgShowSQLErrors'] =
true;
1698 $GLOBALS[
'wgShowDBErrorBacktrace'] =
true;
1701 $GLOBALS[
'wgDisableOutputCompression'] =
true;
1704 $GLOBALS[
'wgCookiePrefix'] =
'mw_installer';
1713 'class' =>
'InstallerSessionProvider',
1732 $this->extraInstallSteps[$findStep][] = $callback;
1740 MediaWiki\suppressWarnings();
1741 set_time_limit( 0 );
1742 MediaWiki\restoreWarnings();
static newFromName($name, $validate= 'valid')
Static factory method for creation from username.
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
envCheckServer()
Environment check to inform user which server we've assumed.
array $internalDefaults
Variables that are stored alongside globals, and are used for any configuration of the installation p...
warning($message)
Add a new warning.
envCheckBrokenXML()
Some versions of libxml+PHP break < and > encoding horribly.
static getLocalisationCache()
Get the LocalisationCache instance.
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
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
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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
the array() calling protocol came about after MediaWiki 1.4rc1.
Title $parserTitle
Cached Title, used by parse().
performInstallation($startCB, $endCB)
Actually perform the installation.
array $dbInstallers
Cached DB installer instances, access using getDBInstaller().
wfIsHHVM()
Check if we are running under HHVM.
processing should stop and the error should be shown to the user * false
static newMainPage()
Create a new Title for the Main Page.
dirIsExecutable($dir, $url)
Checks if scripts located in the given directory can be executed via the given URL.
setVar($name, $value)
Set a MW configuration variable, or internal installer configuration variable.
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
wfShorthandToInteger($string= '', $default=-1)
Converts shorthand byte notation to integer form.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
static newFatal($message)
Factory function for fatal errors.
envPrepPath()
Environment prep for setting $IP and $wgScriptPath.
static getInstallerConfig(Config $baseConfig)
Constructs a Config object that contains configuration settings that should be overwritten for the in...
Set options of the Parser.
if(!isset($args[0])) $lang
envCheckShellLocale()
Environment check for preferred locale in shell.
includeExtensions()
Installs the auto-detected extensions.
static getInstance($id)
Get a cached instance of the specified type of cache object.
envCheckGraphics()
Environment check for ImageMagick and GD.
static newFromId($id)
Static factory method for creation from a given user ID.
envCheckGit()
Search for git.
static wasStrong()
Return a boolean indicating whether or not the source used for cryptographic random bytes generation ...
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
$wgHooks['ArticleShow'][]
static locateExecutableInDefaultPaths($names, $versionInfo=false)
Same as locateExecutable(), but checks in getPossibleBinPaths() by default.
envCheckDiff3()
Search for GNU diff3.
ParserOptions $parserOptions
Cached ParserOptions, used by parse().
wfShellExec($cmd, &$retval=null, $environ=[], $limits=[], $options=[])
Execute a shell command, with time and memory limits mirrored from the PHP configuration if supported...
envCheckModSecurity()
Scare user to death if they have mod_security or mod_security2.
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
doGenerateKeys($keys)
Generate a secret value for variables using our CryptRand generator.
when a variable name is used in a it is silently declared as a new local masking the global
addInstallStep($callback, $findStep= 'BEGINNING')
Add an installation step following the given step.
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() ...
get($name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
getConnection()
Connect to the database using the administrative user/password currently defined in the session...
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
getDocUrl($page)
Overridden by WebInstaller to provide lastPage parameters.
array $objectCaches
Known object cache types and the functions used to test for their existence.
$wgExtensionDirectory
Filesystem extensions directory.
findExtensions($directory= 'extensions')
Finds extensions that follow the format /$directory/Name/Name.php, and returns an array containing th...
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...
$mediaWikiAnnounceLanguages
Supported language codes for Mailman.
static getMain()
Static methods.
generateKeys()
Generate $wgSecretKey.
static maybeGetWebserverPrimaryGroup()
On POSIX systems return the primary group of the webserver we're running under.
array $envPreps
A list of environment preparation methods called by doEnvironmentPreps().
array $envChecks
A list of environment check methods called by doEnvironmentChecks().
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 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 unsetoffset-wrap String Wrap the message in html(usually something like"<
wfIniGetBool($setting)
Safety wrapper around ini_get() for boolean settings.
showMessage($msg)
UI interface for displaying a short message The parameters are like parameters to wfMessage()...
static locateExecutable($path, $names, $versionInfo=false)
Search a path for any of the given executable names.
Class for handling updates to the site_stats table.
array array $installSteps
The actual list of installation steps.
parse($text, $lineStart=false)
Convert wikitext $text to HTML.
static getExistingLocalSettings()
Determine if LocalSettings.php exists.
Exception class for attempted DB access.
int $minMemorySize
Minimum memory size in MB.
getInstallSteps(DatabaseInstaller $installer)
Get an array of install steps.
array $compiledDBs
List of detected DBs, access using getCompiledDBs().
showError($msg)
Same as showMessage(), but for displaying errors.
static newGood($value=null)
Factory function for good results.
global $wgAutoloadClasses
disableTimeLimit()
Disable the time limit for execution.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
static apacheModulePresent($moduleName)
Checks for presence of an Apache module.
Content object for wiki text pages.
Test for PHP+libxml2 bug which breaks XML input subtly with certain versions.
Provides a fallback sequence for Config objects.
array array $rightsProfiles
User rights profiles.
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
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
createMainpage(DatabaseInstaller $installer)
Insert Main Page with default content.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
setPassword($name, $value)
Set a variable which stores a password, except if the new value is a fake password in which case leav...
unicodeChar($c)
Convert a hex string representing a Unicode code point to that code point.
envCheckCache()
Environment check for compiled object cache types.
envCheckUploadsDirectory()
Environment check for the permissions of the uploads directory.
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
const MINIMUM_PCRE_VERSION
The oldest version of PCRE we can support.
envCheckDB()
Environment check for DB types.
populateSiteStats(DatabaseInstaller $installer)
Install step which adds a row to the site_stats table with appropriate initial values.
Show an error when any operation involving passwords fails to run.
array $extraInstallSteps
Extra steps for installation, for things like DatabaseInstallers to modify.
getCompiledDBs()
Get a list of DBs supported by current PHP setup.
array array array $licenses
License types.
envGetDefaultServer()
Helper function to be called from envPrepServer()
getDBInstaller($type=false)
Get an instance of DatabaseInstaller for the specified DB type.
envCheckPCRE()
Environment check for the PCRE module.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
envCheckPath()
Environment check to inform user which paths we've assumed.
static generateHex($chars, $forceStrong=false)
Generate a run of (ideally) cryptographically random data and return it in hexadecimal string format...
__construct()
Constructor, always call this from child classes.
$wgStyleDirectory
Filesystem stylesheets directory.
static array $dbTypes
Known database types.
Base class for DBMS-specific installation helper classes.
static overrideConfig()
Override the necessary bits of the config to run an installation.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired 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 inclusive $limit
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
wfEscapeShellArg()
Version of escapeshellarg() that works better on Windows.
$wgObjectCaches
Advanced object cache configuration.
static factory($url, $options=null, $caller=__METHOD__)
Generate a new request object.
static getDBTypes()
Get a list of known DB types.
setParserLanguage($lang)
ParserOptions are constructed before we determined the language, so fix it.
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 For a description of the see design txt $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
getFakePassword($realPassword)
Get a fake password for sending back to the user in HTML.
static get($url, $options=[], $caller=__METHOD__)
Simple wrapper for Http::request( 'GET' )
getVar($name, $default=null)
Get an MW configuration variable, or internal installer configuration variable.
envCheckLibicu()
Check the libicu version.
envCheckMemory()
Environment check for available memory.
doEnvironmentChecks()
Do initial checks of the PHP environment.
createSysop()
Create the first user account, grant it sysop and bureaucrat rights.
A Config instance which stores all settings as a member variable.
static getPossibleBinPaths()
Get an array of likely places we can find executables.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
envPrepServer()
Environment prep for the server hostname.
array array array $mediaWikiAnnounceUrl
URL to mediawiki-announce subscription.
array $defaultVarNames
MediaWiki configuration globals that will eventually be passed through to LocalSettings.php.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
subscribeToMediaWikiAnnounce(Status $s)
Allows to change the fields on the form that will be generated $name
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.