3 * Generator for LocalSettings.php file.
10 * Class for generating LocalSettings.php file.
15 class LocalSettingsGenerator
{
17 private $extensions = array();
18 private $values = array();
19 private $dbSettings = '';
20 private $safeMode = false;
30 * @param $installer Installer subclass
32 public function __construct( Installer
$installer ) {
33 $this->installer
= $installer;
35 $this->extensions
= $installer->getVar( '_Extensions' );
37 $db = $installer->getDBInstaller( $installer->getVar( 'wgDBtype' ) );
39 $confItems = array_merge(
41 'wgScriptPath', 'wgScriptExtension',
42 'wgPasswordSender', 'wgImageMagickConvertCommand', 'wgShellLocale',
43 'wgLanguageCode', 'wgEnableEmail', 'wgEnableUserEmail', 'wgDiff3',
44 'wgEnotifUserTalk', 'wgEnotifWatchlist', 'wgEmailAuthentication',
45 'wgDBtype', 'wgSecretKey', 'wgRightsUrl', 'wgSitename', 'wgRightsIcon',
46 'wgRightsText', 'wgRightsCode', 'wgMainCacheType', 'wgEnableUploads',
47 'wgMainCacheType', '_MemCachedServers', 'wgDBserver', 'wgDBuser',
48 'wgDBpassword', 'wgUseInstantCommons', 'wgUpgradeKey', 'wgDefaultSkin',
53 $unescaped = array( 'wgRightsIcon' );
55 'wgEnableEmail', 'wgEnableUserEmail', 'wgEnotifUserTalk',
56 'wgEnotifWatchlist', 'wgEmailAuthentication', 'wgEnableUploads', 'wgUseInstantCommons'
59 foreach( $confItems as $c ) {
60 $val = $installer->getVar( $c );
62 if( in_array( $c, $boolItems ) ) {
63 $val = wfBoolToStr( $val );
66 if ( !in_array( $c, $unescaped ) ) {
67 $val = self
::escapePhpString( $val );
70 $this->values
[$c] = $val;
73 $this->dbSettings
= $db->getLocalSettings();
74 $this->safeMode
= $installer->getVar( '_SafeMode' );
75 $this->values
['wgEmergencyContact'] = $this->values
['wgPasswordSender'];
79 * Returns the escaped version of a string of php code.
81 * @param $string String
85 public static function escapePhpString( $string ) {
86 if ( is_array( $string ) ||
is_object( $string ) ) {
104 * Return the full text of the generated LocalSettings.php file,
105 * including the extensions
109 public function getText() {
110 $localSettings = $this->getDefaultText();
112 if( count( $this->extensions
) ) {
113 $localSettings .= "\n# The following extensions were automatically enabled:\n";
115 foreach( $this->extensions
as $extName ) {
116 $encExtName = self
::escapePhpString( $extName );
117 $localSettings .= "require( \"extensions/$encExtName/$encExtName.php\" );\n";
121 return $localSettings;
125 * Write the generated LocalSettings to a file
127 * @param $fileName String Full path to filename to write to
129 public function writeFile( $fileName ) {
130 file_put_contents( $fileName, $this->getText() );
136 private function buildMemcachedServerList() {
137 $servers = $this->values
['_MemCachedServers'];
143 $servers = explode( ',', $servers );
145 foreach( $servers as $srv ) {
150 return rtrim( $ret, ', ' ) . ' )';
157 private function getDefaultText() {
158 if( !$this->values
['wgImageMagickConvertCommand'] ) {
159 $this->values
['wgImageMagickConvertCommand'] = '/usr/bin/convert';
165 if( !$this->values
['wgShellLocale'] ) {
166 $this->values
['wgShellLocale'] = 'en_US.UTF-8';
172 $rights = $this->values
['wgRightsUrl'] ?
'' : '#';
173 $hashedUploads = $this->safeMode ?
'' : '#';
175 switch( $this->values
['wgMainCacheType'] ) {
180 $cacheType = 'CACHE_' . strtoupper( $this->values
['wgMainCacheType']);
184 $cacheType = 'CACHE_NONE';
187 $mcservers = $this->buildMemcachedServerList();
189 # This file was automatically generated by the MediaWiki {$GLOBALS['wgVersion']}
190 # installer. If you make manual changes, please keep track in case you
191 # need to recreate them later.
193 # See includes/DefaultSettings.php for all configurable settings
194 # and their default values, but don't forget to make changes in _this_
197 # Further documentation for configuration settings may be found at:
198 # http://www.mediawiki.org/wiki/Manual:Configuration_settings
200 # Protect against web entry
201 if ( !defined( 'MEDIAWIKI' ) ) {
205 ## Uncomment this to disable output compression
206 # \$wgDisableOutputCompression = true;
208 \$wgSitename = \"{$this->values['wgSitename']}\";
210 ## The URL base path to the directory containing the wiki;
211 ## defaults for all runtime URL paths are based off of this.
212 ## For more information on customizing the URLs please see:
213 ## http://www.mediawiki.org/wiki/Manual:Short_URL
214 \$wgScriptPath = \"{$this->values['wgScriptPath']}\";
215 \$wgScriptExtension = \"{$this->values['wgScriptExtension']}\";
217 ## The relative URL path to the skins directory
218 \$wgStylePath = \"\$wgScriptPath/skins\";
220 ## The relative URL path to the logo. Make sure you change this from the default,
221 ## or else you'll overwrite your logo when you upgrade!
222 \$wgLogo = \"\$wgStylePath/common/images/wiki.png\";
224 ## UPO means: this is also a user preference option
226 \$wgEnableEmail = {$this->values['wgEnableEmail']};
227 \$wgEnableUserEmail = {$this->values['wgEnableUserEmail']}; # UPO
229 \$wgEmergencyContact = \"{$this->values['wgEmergencyContact']}\";
230 \$wgPasswordSender = \"{$this->values['wgPasswordSender']}\";
232 \$wgEnotifUserTalk = {$this->values['wgEnotifUserTalk']}; # UPO
233 \$wgEnotifWatchlist = {$this->values['wgEnotifWatchlist']}; # UPO
234 \$wgEmailAuthentication = {$this->values['wgEmailAuthentication']};
237 \$wgDBtype = \"{$this->values['wgDBtype']}\";
238 \$wgDBserver = \"{$this->values['wgDBserver']}\";
239 \$wgDBname = \"{$this->values['wgDBname']}\";
240 \$wgDBuser = \"{$this->values['wgDBuser']}\";
241 \$wgDBpassword = \"{$this->values['wgDBpassword']}\";
245 ## Shared memory settings
246 \$wgMainCacheType = $cacheType;
247 \$wgMemCachedServers = $mcservers;
249 ## To enable image uploads, make sure the 'images' directory
250 ## is writable, then set this to true:
251 \$wgEnableUploads = {$this->values['wgEnableUploads']};
252 {$magic}\$wgUseImageMagick = true;
253 {$magic}\$wgImageMagickConvertCommand = \"{$this->values['wgImageMagickConvertCommand']}\";
255 # InstantCommons allows wiki to use images from http://commons.wikimedia.org
256 \$wgUseInstantCommons = {$this->values['wgUseInstantCommons']};
258 ## If you use ImageMagick (or any other shell command) on a
259 ## Linux server, this will need to be set to the name of an
260 ## available UTF-8 locale
261 {$locale}\$wgShellLocale = \"{$this->values['wgShellLocale']}\";
263 ## If you want to use image uploads under safe mode,
264 ## create the directories images/archive, images/thumb and
265 ## images/temp, and make them all writable. Then uncomment
266 ## this, if it's not already uncommented:
267 {$hashedUploads}\$wgHashedUploadDirectory = false;
269 ## If you have the appropriate support software installed
270 ## you can enable inline LaTeX equations:
273 ## Set \$wgCacheDirectory to a writable directory on the web server
274 ## to make your wiki go slightly faster. The directory should not
275 ## be publically accessible from the web.
276 #\$wgCacheDirectory = \"\$IP/cache\";
278 # Site language code, should be one of ./languages/Language(.*).php
279 \$wgLanguageCode = \"{$this->values['wgLanguageCode']}\";
281 \$wgSecretKey = \"{$this->values['wgSecretKey']}\";
283 # Site upgrade key. Must be set to a string (default provided) to turn on the
284 # web installer while LocalSettings.php is in place
285 \$wgUpgradeKey = \"{$this->values['wgUpgradeKey']}\";
287 ## Default skin: you can change the default skin. Use the internal symbolic
288 ## names, ie 'standard', 'nostalgia', 'cologneblue', 'monobook', 'vector':
289 \$wgDefaultSkin = \"{$this->values['wgDefaultSkin']}\";
291 ## For attaching licensing metadata to pages, and displaying an
292 ## appropriate copyright notice / icon. GNU Free Documentation
293 ## License and Creative Commons licenses are supported so far.
294 {$rights}\$wgEnableCreativeCommonsRdf = true;
295 \$wgRightsPage = \"\"; # Set to the title of a wiki page that describes your license/copyright
296 \$wgRightsUrl = \"{$this->values['wgRightsUrl']}\";
297 \$wgRightsText = \"{$this->values['wgRightsText']}\";
298 \$wgRightsIcon = \"{$this->values['wgRightsIcon']}\";
299 # \$wgRightsCode = \"{$this->values['wgRightsCode']}\"; # Not yet used
301 # Path to the GNU diff3 utility. Used for conflict resolution.
302 \$wgDiff3 = \"{$this->values['wgDiff3']}\";
304 # Enabled Extensions. Most extensions are enabled by including the base extension file here
305 # but check specific extension documentation for more details