65b1b6b56a
$wgShellLocale was a flawed solution to the problem of locale dependence. MediaWiki has its own concept of locale (the Language hierarchy) and any kind of dependence on the server's libc locale is incorrect and harmful, leading to bugs. Developers have an expectation that functions like strtolower() will work in a certain way, and respecting the locale set in the environment at install time violates this expectation. The problems with using C as a locale, which led to $wgShellLocale, are: * escapeshellarg() will strip non-ASCII characters. This can be worked around by not using it. The security vulnerability it was trying to fix can be prevented in another way. * Shell commands like rsvg will fail to correctly interpret UTF-8 arguments. This is the reason for the putenv(). On Linux, this can be fixed by using C.UTF-8, which we didn't know at the time. On Windows, the problem is not relevant (there are unrelated issues with UTF-8 arguments). Bug: T291234 Change-Id: Ib5ac0e7bc720dcc094303a358ee1c7bbdcfc6447
424 lines
13 KiB
PHP
424 lines
13 KiB
PHP
<?php
|
|
/**
|
|
* Generator for LocalSettings.php file.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @ingroup Installer
|
|
*/
|
|
|
|
/**
|
|
* Class for generating LocalSettings.php file.
|
|
*
|
|
* @ingroup Installer
|
|
* @since 1.17
|
|
*/
|
|
class LocalSettingsGenerator {
|
|
|
|
protected $extensions = [];
|
|
protected $skins = [];
|
|
protected $values = [];
|
|
protected $groupPermissions = [];
|
|
protected $dbSettings = '';
|
|
protected $IP;
|
|
|
|
/**
|
|
* @var Installer
|
|
*/
|
|
protected $installer;
|
|
|
|
/**
|
|
* @param Installer $installer
|
|
*/
|
|
public function __construct( Installer $installer ) {
|
|
$this->installer = $installer;
|
|
|
|
$this->extensions = $installer->getVar( '_Extensions' );
|
|
$this->skins = $installer->getVar( '_Skins' );
|
|
$this->IP = $installer->getVar( 'IP' );
|
|
|
|
$db = $installer->getDBInstaller( $installer->getVar( 'wgDBtype' ) );
|
|
|
|
$confItems = array_merge(
|
|
[
|
|
'wgServer', 'wgScriptPath',
|
|
'wgPasswordSender', 'wgImageMagickConvertCommand',
|
|
'wgLanguageCode', 'wgLocaltimezone', 'wgEnableEmail', 'wgEnableUserEmail',
|
|
'wgDiff3', 'wgEnotifUserTalk', 'wgEnotifWatchlist', 'wgEmailAuthentication',
|
|
'wgDBtype', 'wgSecretKey', 'wgRightsUrl', 'wgSitename', 'wgRightsIcon',
|
|
'wgRightsText', '_MainCacheType', 'wgEnableUploads',
|
|
'_MemCachedServers', 'wgDBserver', 'wgDBuser',
|
|
'wgDBpassword', 'wgUseInstantCommons', 'wgUpgradeKey', 'wgDefaultSkin',
|
|
'wgMetaNamespace', '_Logo', 'wgAuthenticationTokenVersion', 'wgPingback',
|
|
],
|
|
$db->getGlobalNames()
|
|
);
|
|
|
|
// The WebInstaller form field for "Logo" contains a literal "$wgResourceBasePath",
|
|
// and site admins are told in the help text that they can use $wgStylePath and $wgScriptPath
|
|
// within their input, such treat this as raw PHP for now.
|
|
$unescaped = [ 'wgRightsIcon', '_Logo', '_Caches' ];
|
|
$boolItems = [
|
|
'wgEnableEmail', 'wgEnableUserEmail', 'wgEnotifUserTalk',
|
|
'wgEnotifWatchlist', 'wgEmailAuthentication', 'wgEnableUploads', 'wgUseInstantCommons',
|
|
'wgPingback',
|
|
];
|
|
|
|
foreach ( $confItems as $c ) {
|
|
$val = $installer->getVar( $c );
|
|
|
|
if ( in_array( $c, $boolItems ) ) {
|
|
$val = wfBoolToStr( $val );
|
|
}
|
|
|
|
if ( !in_array( $c, $unescaped ) && $val !== null ) {
|
|
$val = self::escapePhpString( $val );
|
|
}
|
|
|
|
$this->values[$c] = $val;
|
|
}
|
|
|
|
$this->dbSettings = $db->getLocalSettings();
|
|
$this->values['wgEmergencyContact'] = $this->values['wgPasswordSender'];
|
|
}
|
|
|
|
/**
|
|
* For $wgGroupPermissions, set a given ['group']['permission'] value.
|
|
* @param string $group Group name
|
|
* @param array $rightsArr An array of permissions, in the form of:
|
|
* [ 'right' => true, 'right2' => false ]
|
|
*/
|
|
public function setGroupRights( $group, $rightsArr ) {
|
|
$this->groupPermissions[$group] = $rightsArr;
|
|
}
|
|
|
|
/**
|
|
* Returns the escaped version of a string of php code.
|
|
*
|
|
* @param string $string
|
|
*
|
|
* @return string|false
|
|
*/
|
|
public static function escapePhpString( $string ) {
|
|
if ( is_array( $string ) || is_object( $string ) ) {
|
|
return false;
|
|
}
|
|
|
|
return strtr(
|
|
$string,
|
|
[
|
|
"\n" => "\\n",
|
|
"\r" => "\\r",
|
|
"\t" => "\\t",
|
|
"\\" => "\\\\",
|
|
"\$" => "\\\$",
|
|
"\"" => "\\\""
|
|
]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Return the full text of the generated LocalSettings.php file,
|
|
* including the extensions and skins.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getText() {
|
|
$localSettings = $this->getDefaultText();
|
|
|
|
if ( count( $this->skins ) ) {
|
|
$localSettings .= "
|
|
# Enabled skins.
|
|
# The following skins were automatically enabled:\n";
|
|
|
|
foreach ( $this->skins as $skinName ) {
|
|
$localSettings .= $this->generateExtEnableLine( 'skins', $skinName );
|
|
}
|
|
|
|
$localSettings .= "\n";
|
|
}
|
|
|
|
if ( count( $this->extensions ) ) {
|
|
$localSettings .= "
|
|
# Enabled extensions. Most of the extensions are enabled by adding
|
|
# wfLoadExtension( 'ExtensionName' );
|
|
# to LocalSettings.php. Check specific extension documentation for more details.
|
|
# The following extensions were automatically enabled:\n";
|
|
|
|
foreach ( $this->extensions as $extName ) {
|
|
$localSettings .= $this->generateExtEnableLine( 'extensions', $extName );
|
|
}
|
|
|
|
$localSettings .= "\n";
|
|
}
|
|
|
|
$localSettings .= "
|
|
# End of automatically generated settings.
|
|
# Add more configuration options below.\n\n";
|
|
|
|
return $localSettings;
|
|
}
|
|
|
|
/**
|
|
* Generate the appropriate line to enable the given extension or skin
|
|
*
|
|
* @param string $dir Either "extensions" or "skins"
|
|
* @param string $name Name of extension/skin
|
|
* @throws InvalidArgumentException
|
|
* @return string
|
|
*/
|
|
private function generateExtEnableLine( $dir, $name ) {
|
|
if ( $dir === 'extensions' ) {
|
|
$jsonFile = 'extension.json';
|
|
$function = 'wfLoadExtension';
|
|
} elseif ( $dir === 'skins' ) {
|
|
$jsonFile = 'skin.json';
|
|
$function = 'wfLoadSkin';
|
|
} else {
|
|
throw new InvalidArgumentException( '$dir was not "extensions" or "skins"' );
|
|
}
|
|
|
|
$encName = self::escapePhpString( $name );
|
|
|
|
if ( file_exists( "{$this->IP}/$dir/$encName/$jsonFile" ) ) {
|
|
return "$function( '$encName' );\n";
|
|
} else {
|
|
return "require_once \"\$IP/$dir/$encName/$encName.php\";\n";
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Write the generated LocalSettings to a file
|
|
*
|
|
* @param string $fileName Full path to filename to write to
|
|
*/
|
|
public function writeFile( $fileName ) {
|
|
file_put_contents( $fileName, $this->getText() );
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
protected function buildMemcachedServerList() {
|
|
$servers = $this->values['_MemCachedServers'];
|
|
|
|
if ( !$servers ) {
|
|
return '[]';
|
|
} else {
|
|
$ret = '[ ';
|
|
$servers = explode( ',', $servers );
|
|
|
|
foreach ( $servers as $srv ) {
|
|
$srv = trim( $srv );
|
|
$ret .= "'$srv', ";
|
|
}
|
|
|
|
return rtrim( $ret, ', ' ) . ' ]';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
protected function getDefaultText() {
|
|
if ( !$this->values['wgImageMagickConvertCommand'] ) {
|
|
$this->values['wgImageMagickConvertCommand'] = '/usr/bin/convert';
|
|
$magic = '#';
|
|
} else {
|
|
$magic = '';
|
|
}
|
|
|
|
$metaNamespace = '';
|
|
if ( $this->values['wgMetaNamespace'] !== $this->values['wgSitename'] ) {
|
|
$metaNamespace = "\$wgMetaNamespace = \"{$this->values['wgMetaNamespace']}\";\n";
|
|
}
|
|
|
|
$groupRights = '';
|
|
$noFollow = '';
|
|
if ( $this->groupPermissions ) {
|
|
$groupRights .= "# The following permissions were set based on your choice in the installer\n";
|
|
foreach ( $this->groupPermissions as $group => $rightArr ) {
|
|
$group = self::escapePhpString( $group );
|
|
foreach ( $rightArr as $right => $perm ) {
|
|
$right = self::escapePhpString( $right );
|
|
$groupRights .= "\$wgGroupPermissions['$group']['$right'] = " .
|
|
wfBoolToStr( $perm ) . ";\n";
|
|
}
|
|
}
|
|
$groupRights .= "\n";
|
|
|
|
if ( ( isset( $this->groupPermissions['*']['edit'] ) &&
|
|
$this->groupPermissions['*']['edit'] === false )
|
|
&& ( isset( $this->groupPermissions['*']['createaccount'] ) &&
|
|
$this->groupPermissions['*']['createaccount'] === false )
|
|
&& ( isset( $this->groupPermissions['*']['read'] ) &&
|
|
$this->groupPermissions['*']['read'] !== false )
|
|
) {
|
|
$noFollow = "# Set \$wgNoFollowLinks to true if you open up your wiki to editing by\n"
|
|
. "# the general public and wish to apply nofollow to external links as a\n"
|
|
. "# deterrent to spammers. Nofollow is not a comprehensive anti-spam solution\n"
|
|
. "# and open wikis will generally require other anti-spam measures; for more\n"
|
|
. "# information, see https://www.mediawiki.org/wiki/Manual:Combating_spam\n"
|
|
. "\$wgNoFollowLinks = false;\n\n";
|
|
}
|
|
}
|
|
|
|
$serverSetting = "";
|
|
if ( array_key_exists( 'wgServer', $this->values ) && $this->values['wgServer'] !== null ) {
|
|
$serverSetting = "\n## The protocol and server name to use in fully-qualified URLs\n";
|
|
$serverSetting .= "\$wgServer = \"{$this->values['wgServer']}\";";
|
|
}
|
|
|
|
switch ( $this->values['_MainCacheType'] ) {
|
|
case 'anything':
|
|
case 'db':
|
|
case 'memcached':
|
|
case 'accel':
|
|
$cacheType = 'CACHE_' . strtoupper( $this->values['_MainCacheType'] );
|
|
break;
|
|
case 'none':
|
|
default:
|
|
$cacheType = 'CACHE_NONE';
|
|
}
|
|
|
|
$mcservers = $this->buildMemcachedServerList();
|
|
if ( file_exists( dirname( __DIR__ ) . '/PlatformSettings.php' ) ) {
|
|
$platformSettings = "\n## Include platform/distribution defaults";
|
|
$platformSettings .= "\nrequire_once \"\$IP/includes/PlatformSettings.php\";";
|
|
} else {
|
|
$platformSettings = '';
|
|
}
|
|
|
|
$version = MW_VERSION;
|
|
return "<?php
|
|
# This file was automatically generated by the MediaWiki {$version}
|
|
# installer. If you make manual changes, please keep track in case you
|
|
# need to recreate them later.
|
|
#
|
|
# See includes/DefaultSettings.php for all configurable settings
|
|
# and their default values, but don't forget to make changes in _this_
|
|
# file, not there.
|
|
#
|
|
# Further documentation for configuration settings may be found at:
|
|
# https://www.mediawiki.org/wiki/Manual:Configuration_settings
|
|
|
|
# Protect against web entry
|
|
if ( !defined( 'MEDIAWIKI' ) ) {
|
|
exit;
|
|
}
|
|
{$platformSettings}
|
|
|
|
## Uncomment this to disable output compression
|
|
# \$wgDisableOutputCompression = true;
|
|
|
|
\$wgSitename = \"{$this->values['wgSitename']}\";
|
|
{$metaNamespace}
|
|
## The URL base path to the directory containing the wiki;
|
|
## defaults for all runtime URL paths are based off of this.
|
|
## For more information on customizing the URLs
|
|
## (like /w/index.php/Page_title to /wiki/Page_title) please see:
|
|
## https://www.mediawiki.org/wiki/Manual:Short_URL
|
|
\$wgScriptPath = \"{$this->values['wgScriptPath']}\";
|
|
${serverSetting}
|
|
|
|
## The URL path to static resources (images, scripts, etc.)
|
|
\$wgResourceBasePath = \$wgScriptPath;
|
|
|
|
## The URL paths to the logo. Make sure you change this from the default,
|
|
## or else you'll overwrite your logo when you upgrade!
|
|
\$wgLogos = [ '1x' => \"{$this->values['_Logo']}\" ];
|
|
|
|
## UPO means: this is also a user preference option
|
|
|
|
\$wgEnableEmail = {$this->values['wgEnableEmail']};
|
|
\$wgEnableUserEmail = {$this->values['wgEnableUserEmail']}; # UPO
|
|
|
|
\$wgEmergencyContact = \"{$this->values['wgEmergencyContact']}\";
|
|
\$wgPasswordSender = \"{$this->values['wgPasswordSender']}\";
|
|
|
|
\$wgEnotifUserTalk = {$this->values['wgEnotifUserTalk']}; # UPO
|
|
\$wgEnotifWatchlist = {$this->values['wgEnotifWatchlist']}; # UPO
|
|
\$wgEmailAuthentication = {$this->values['wgEmailAuthentication']};
|
|
|
|
## Database settings
|
|
\$wgDBtype = \"{$this->values['wgDBtype']}\";
|
|
\$wgDBserver = \"{$this->values['wgDBserver']}\";
|
|
\$wgDBname = \"{$this->values['wgDBname']}\";
|
|
\$wgDBuser = \"{$this->values['wgDBuser']}\";
|
|
\$wgDBpassword = \"{$this->values['wgDBpassword']}\";
|
|
|
|
{$this->dbSettings}
|
|
|
|
# Shared database table
|
|
# This has no effect unless \$wgSharedDB is also set.
|
|
\$wgSharedTables[] = \"actor\";
|
|
|
|
## Shared memory settings
|
|
\$wgMainCacheType = $cacheType;
|
|
\$wgMemCachedServers = $mcservers;
|
|
|
|
## To enable image uploads, make sure the 'images' directory
|
|
## is writable, then set this to true:
|
|
\$wgEnableUploads = {$this->values['wgEnableUploads']};
|
|
{$magic}\$wgUseImageMagick = true;
|
|
{$magic}\$wgImageMagickConvertCommand = \"{$this->values['wgImageMagickConvertCommand']}\";
|
|
|
|
# InstantCommons allows wiki to use images from https://commons.wikimedia.org
|
|
\$wgUseInstantCommons = {$this->values['wgUseInstantCommons']};
|
|
|
|
# Periodically send a pingback to https://www.mediawiki.org/ with basic data
|
|
# about this MediaWiki instance. The Wikimedia Foundation shares this data
|
|
# with MediaWiki developers to help guide future development efforts.
|
|
\$wgPingback = {$this->values['wgPingback']};
|
|
|
|
# Site language code, should be one of the list in ./languages/data/Names.php
|
|
\$wgLanguageCode = \"{$this->values['wgLanguageCode']}\";
|
|
|
|
# Time zone
|
|
\$wgLocaltimezone = \"{$this->values['wgLocaltimezone']}\";
|
|
|
|
## Set \$wgCacheDirectory to a writable directory on the web server
|
|
## to make your wiki go slightly faster. The directory should not
|
|
## be publicly accessible from the web.
|
|
#\$wgCacheDirectory = \"\$IP/cache\";
|
|
|
|
\$wgSecretKey = \"{$this->values['wgSecretKey']}\";
|
|
|
|
# Changing this will log out all existing sessions.
|
|
\$wgAuthenticationTokenVersion = \"{$this->values['wgAuthenticationTokenVersion']}\";
|
|
|
|
# Site upgrade key. Must be set to a string (default provided) to turn on the
|
|
# web installer while LocalSettings.php is in place
|
|
\$wgUpgradeKey = \"{$this->values['wgUpgradeKey']}\";
|
|
|
|
## For attaching licensing metadata to pages, and displaying an
|
|
## appropriate copyright notice / icon. GNU Free Documentation
|
|
## License and Creative Commons licenses are supported so far.
|
|
\$wgRightsPage = \"\"; # Set to the title of a wiki page that describes your license/copyright
|
|
\$wgRightsUrl = \"{$this->values['wgRightsUrl']}\";
|
|
\$wgRightsText = \"{$this->values['wgRightsText']}\";
|
|
\$wgRightsIcon = \"{$this->values['wgRightsIcon']}\";
|
|
|
|
# Path to the GNU diff3 utility. Used for conflict resolution.
|
|
\$wgDiff3 = \"{$this->values['wgDiff3']}\";
|
|
|
|
{$groupRights}{$noFollow}## Default skin: you can change the default skin. Use the internal symbolic
|
|
## names, e.g. 'vector' or 'monobook':
|
|
\$wgDefaultSkin = \"{$this->values['wgDefaultSkin']}\";
|
|
";
|
|
}
|
|
}
|