<?php
-
+/**
+ * Generator for LocalSettings.php file.
+ *
+ * @file
+ * @ingroup Deployment
+ */
+
+/**
+ * Class for generating LocalSettings.php file.
+ *
+ * @ingroup Deployment
+ * @since 1.17
+ */
class LocalSettingsGenerator {
- private $extensions, $values = array();
- private $configPath, $dbSettings = '';
+
+ private $extensions = array();
+ private $values = array();
+ private $dbSettings = '';
private $safeMode = false;
+
+ /**
+ * @var Installer
+ */
private $installer;
/**
* Constructor.
+ *
* @param $installer Installer subclass
*/
public function __construct( Installer $installer ) {
$this->installer = $installer;
- $this->configPath = $installer->getVar( 'IP' ) . '/config';
+
$this->extensions = $installer->getVar( '_Extensions' );
+
$db = $installer->getDBInstaller( $installer->getVar( 'wgDBtype' ) );
- $confItems = array_merge( array( 'wgScriptPath', 'wgScriptExtension',
- 'wgPasswordSender', 'wgImageMagickConvertCommand', 'wgShellLocale',
- 'wgLanguageCode', 'wgEnableEmail', 'wgEnableUserEmail', 'wgDiff3',
- 'wgEnotifUserTalk', 'wgEnotifWatchlist', 'wgEmailAuthentication',
- 'wgDBtype', 'wgSecretKey', 'wgRightsUrl', 'wgSitename', 'wgRightsIcon',
- 'wgRightsText', 'wgRightsCode', 'wgMainCacheType', 'wgEnableUploads',
- 'wgMainCacheType', '_MemCachedServers', 'wgDBserver', 'wgDBuser',
- 'wgDBpassword' ), $db->getGlobalNames() );
+ $confItems = array_merge(
+ array(
+ 'wgScriptPath', 'wgScriptExtension',
+ 'wgPasswordSender', 'wgImageMagickConvertCommand', 'wgShellLocale',
+ 'wgLanguageCode', 'wgEnableEmail', 'wgEnableUserEmail', 'wgDiff3',
+ 'wgEnotifUserTalk', 'wgEnotifWatchlist', 'wgEmailAuthentication',
+ 'wgDBtype', 'wgSecretKey', 'wgRightsUrl', 'wgSitename', 'wgRightsIcon',
+ 'wgRightsText', 'wgRightsCode', 'wgMainCacheType', 'wgEnableUploads',
+ 'wgMainCacheType', '_MemCachedServers', 'wgDBserver', 'wgDBuser',
+ 'wgDBpassword', 'wgUseInstantCommons', 'wgUpgradeKey', 'wgDefaultSkin',
+ 'wgMetaNamespace'
+ ),
+ $db->getGlobalNames()
+ );
+
$unescaped = array( 'wgRightsIcon' );
- $boolItems = array( 'wgEnableEmail', 'wgEnableUserEmail', 'wgEnotifUserTalk',
- 'wgEnotifWatchlist', 'wgEmailAuthentication', 'wgEnableUploads' );
+ $boolItems = array(
+ 'wgEnableEmail', 'wgEnableUserEmail', 'wgEnotifUserTalk',
+ 'wgEnotifWatchlist', 'wgEmailAuthentication', 'wgEnableUploads', 'wgUseInstantCommons'
+ );
+
foreach( $confItems as $c ) {
$val = $installer->getVar( $c );
+
if( in_array( $c, $boolItems ) ) {
$val = wfBoolToStr( $val );
}
+
if ( !in_array( $c, $unescaped ) ) {
$val = self::escapePhpString( $val );
}
+
$this->values[$c] = $val;
}
+
$this->dbSettings = $db->getLocalSettings();
$this->safeMode = $installer->getVar( '_SafeMode' );
$this->values['wgEmergencyContact'] = $this->values['wgPasswordSender'];
}
+ /**
+ * Returns the escaped version of a string of php code.
+ *
+ * @param $string String
+ *
+ * @return String
+ */
public static function escapePhpString( $string ) {
if ( is_array( $string ) || is_object( $string ) ) {
return false;
}
- return strtr( $string,
+
+ return strtr(
+ $string,
array(
"\n" => "\\n",
"\r" => "\\r",
"\\" => "\\\\",
"\$" => "\\\$",
"\"" => "\\\""
- ));
+ )
+ );
}
/**
* Return the full text of the generated LocalSettings.php file,
* including the extensions
- * @returns String
+ *
+ * @return String
*/
public function getText() {
$localSettings = $this->getDefaultText();
+
if( count( $this->extensions ) ) {
- $localSettings .= "\n# The following extensions were automatically enabled:\n";
- foreach( $this->extensions as $ext ) {
- $localSettings .= "require( 'extensions/$ext/$ext.php' );\n";
+ $localSettings .= "
+# Enabled Extensions. Most extensions are enabled by including the base extension file here
+# but check specific extension documentation for more details
+# The following extensions were automatically enabled:\n";
+
+ foreach( $this->extensions as $extName ) {
+ $encExtName = self::escapePhpString( $extName );
+ $localSettings .= "require( \"extensions/$encExtName/$encExtName.php\" );\n";
}
}
+ $localSettings .= "\n\n# End of automatically generated settings.
+# Add more configuration options below.\n\n";
+
return $localSettings;
}
/**
- * Write the file
- * @param $secretKey String A random string to
- * @return boolean On successful file write
+ * Write the generated LocalSettings to a file
+ *
+ * @param $fileName String Full path to filename to write to
*/
- public function writeLocalSettings() {
- $localSettings = $this->getText();
- wfSuppressWarnings();
- $ret = file_put_contents( $this->configPath . '/LocalSettings.php', $localSettings );
- wfRestoreWarnings();
-
- $status = Status::newGood();
-
- if ( !$ret ) {
- $status->fatal( 'config-install-localsettings-unwritable', $localSettings );
- }
-
- return $status;
+ public function writeFile( $fileName ) {
+ file_put_contents( $fileName, $this->getText() );
}
+ /**
+ * @return String
+ */
private function buildMemcachedServerList() {
$servers = $this->values['_MemCachedServers'];
+
if( !$servers ) {
return 'array()';
} else {
$ret = 'array( ';
$servers = explode( ',', $servers );
+
foreach( $servers as $srv ) {
$srv = trim( $srv );
$ret .= "'$srv', ";
}
+
return rtrim( $ret, ', ' ) . ' )';
}
}
+ /**
+ * @return String
+ */
private function getDefaultText() {
if( !$this->values['wgImageMagickConvertCommand'] ) {
$this->values['wgImageMagickConvertCommand'] = '/usr/bin/convert';
} else {
$magic = '';
}
+
if( !$this->values['wgShellLocale'] ) {
$this->values['wgShellLocale'] = 'en_US.UTF-8';
$locale = '#';
} else {
$locale = '';
}
+
$rights = $this->values['wgRightsUrl'] ? '' : '#';
- $hashedUploads = $this->safeMode ? '#' : '';
+ $hashedUploads = $this->safeMode ? '' : '#';
+ $metaNamespace = '';
+ if( $this->values['wgMetaNamespace'] !== $this->values['wgSitename'] ) {
+ $metaNamespace = "\$wgMetaNamespace = \"{$this->values['wgMetaNamespace']}\";\n";
+ }
+
switch( $this->values['wgMainCacheType'] ) {
case 'anything':
case 'db':
default:
$cacheType = 'CACHE_NONE';
}
+
$mcservers = $this->buildMemcachedServerList();
return "<?php
# This file was automatically generated by the MediaWiki {$GLOBALS['wgVersion']}
# Further documentation for configuration settings may be found at:
# http://www.mediawiki.org/wiki/Manual:Configuration_settings
-# If you customize your file layout, set \$IP to the directory that contains
-# the other MediaWiki files. It will be used as a base to locate files.
-if( defined( 'MW_INSTALL_PATH' ) ) {
- \$IP = MW_INSTALL_PATH;
-} else {
- \$IP = dirname( __FILE__ );
+# Protect against web entry
+if ( !defined( 'MEDIAWIKI' ) ) {
+ exit;
}
-\$path = array( \$IP, \"\$IP/includes\", \"\$IP/languages\" );
-set_include_path( implode( PATH_SEPARATOR, \$path ) . PATH_SEPARATOR . get_include_path() );
-
-require_once( \"\$IP/includes/DefaultSettings.php\" );
-
-if ( \$wgCommandLineMode ) {
- if ( isset( \$_SERVER ) && array_key_exists( 'REQUEST_METHOD', \$_SERVER ) ) {
- die( \"This script must be run from the command line\\n\" );
- }
-}
## Uncomment this to disable output compression
# \$wgDisableOutputCompression = true;
-\$wgSitename = \"{$this->values['wgSitename']}\";
-
+\$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 please see:
{$magic}\$wgUseImageMagick = true;
{$magic}\$wgImageMagickConvertCommand = \"{$this->values['wgImageMagickConvertCommand']}\";
+# InstantCommons allows wiki to use images from http://commons.wikimedia.org
+\$wgUseInstantCommons = {$this->values['wgUseInstantCommons']};
+
## If you use ImageMagick (or any other shell command) on a
## Linux server, this will need to be set to the name of an
## available UTF-8 locale
## be publically accessible from the web.
#\$wgCacheDirectory = \"\$IP/cache\";
-\$wgLocalInterwiki = strtolower( \$wgSitename );
-
# Site language code, should be one of ./languages/Language(.*).php
\$wgLanguageCode = \"{$this->values['wgLanguageCode']}\";
\$wgSecretKey = \"{$this->values['wgSecretKey']}\";
+# 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']}\";
+
## Default skin: you can change the default skin. Use the internal symbolic
## names, ie 'standard', 'nostalgia', 'cologneblue', 'monobook', 'vector':
-\$wgDefaultSkin = 'vector';
+\$wgDefaultSkin = \"{$this->values['wgDefaultSkin']}\";
## For attaching licensing metadata to pages, and displaying an
## appropriate copyright notice / icon. GNU Free Documentation
# Path to the GNU diff3 utility. Used for conflict resolution.
\$wgDiff3 = \"{$this->values['wgDiff3']}\";
-
-# When you make changes to this configuration file, this will make
-# sure that cached pages are cleared.
-\$wgCacheEpoch = max( \$wgCacheEpoch, gmdate( 'YmdHis', @filemtime( __FILE__ ) ) );
";
}
+
}
dépôts / lhc / web / wiklou.git / blobdiff