wiki.techinc.nl/includes/BootstrapHelperFunctions.php
Timo Tijhof a3406011f6 installer: Simplify wfDetectLocalSettingsFile and document gotchass
Follows-up I7747f83481cb05a6d.

While at it:

* Avoid confusing preg_match, use strpos or str_contains instead.
  If this is not the same, then I have proven my point that it is
  unclear (but also picked the wrong alternative).

* Use silence operator (at) instead of AtEase. Also note that in the
  previous change this was incorrectly expanded to silence errors
  in wfDetectLocalSettingsFile, which I assume was unintentional
  and among the reasons we avoid it in new code (T253461).

Change-Id: I0dda95d3c0f21c872e43697acba192d6a19fb0d5
2022-03-01 17:43:15 +00:00

47 lines
1.8 KiB
PHP

<?php
/**
* Functions that need to be available during bootstrapping.
* Code in this file cannot expect MediaWiki to have been initialized.
* @file
*/
/**
* Decide and remember where to load LocalSettings from.
*
* This is used by Setup.php and will (if not already) store the result
* in the MW_CONFIG_FILE constant.
*
* The primary settings file is traditionally LocalSettings.php under the %MediaWiki
* installation path, but can also be placed differently and specified via the
* MW_CONFIG_FILE constant (from an entrypoint wrapper) or via a `MW_CONFIG_FILE`
* environment variable (from the web server).
*
* Experimental: The settings file can use the `.yaml` or `.json` extension, which
* must use the format described on
* https://www.mediawiki.org/wiki/Manual:YAML_settings_file_format.
*
* @internal Only for use by Setup.php and Installer.
* @since 1.38
* @param string $installationPath The installation's base path, typically global $IP.
* @return string The path to the settings file
*/
function wfDetectLocalSettingsFile( string $installationPath ): string {
if ( defined( 'MW_CONFIG_FILE' ) ) {
return MW_CONFIG_FILE;
}
// We could look for LocalSettings.yaml and LocalSettings.json,
// and use them if they exist. But having them in a web accessible
// place is dangerous, so better not to encourage that.
// In order to use LocalSettings.yaml and LocalSettings.json, they
// will have to be referenced explicitly by MW_CONFIG_FILE.
$configFile = getenv( 'MW_CONFIG_FILE' ) ?: "LocalSettings.php";
// Can't use str_contains because for maintenance scripts (update.php, install.php),
// this is called *before* Setup.php and vendor (polyfill-php80) are included.
if ( strpos( $configFile, '/' ) === false ) {
$configFile = "$installationPath/$configFile";
}
define( 'MW_CONFIG_FILE', $configFile );
return $configFile;
}