3 * Generator for LocalSettings.php file.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
25 * Class for generating LocalSettings.php file.
30 class LocalSettingsGenerator
{
32 protected $extensions = array();
33 protected $values = array();
34 protected $groupPermissions = array();
35 protected $dbSettings = '';
36 protected $safeMode = false;
46 * @param $installer Installer subclass
48 public function __construct( Installer
$installer ) {
49 $this->installer
= $installer;
51 $this->extensions
= $installer->getVar( '_Extensions' );
53 $db = $installer->getDBInstaller( $installer->getVar( 'wgDBtype' ) );
55 $confItems = array_merge(
57 'wgServer', 'wgScriptPath', 'wgScriptExtension',
58 'wgPasswordSender', 'wgImageMagickConvertCommand', 'wgShellLocale',
59 'wgLanguageCode', 'wgEnableEmail', 'wgEnableUserEmail', 'wgDiff3',
60 'wgEnotifUserTalk', 'wgEnotifWatchlist', 'wgEmailAuthentication',
61 'wgDBtype', 'wgSecretKey', 'wgRightsUrl', 'wgSitename', 'wgRightsIcon',
62 'wgRightsText', 'wgMainCacheType', 'wgEnableUploads',
63 'wgMainCacheType', '_MemCachedServers', 'wgDBserver', 'wgDBuser',
64 'wgDBpassword', 'wgUseInstantCommons', 'wgUpgradeKey', 'wgDefaultSkin',
65 'wgMetaNamespace', 'wgResourceLoaderMaxQueryLength', 'wgLogo',
70 $unescaped = array( 'wgRightsIcon', 'wgLogo' );
72 'wgEnableEmail', 'wgEnableUserEmail', 'wgEnotifUserTalk',
73 'wgEnotifWatchlist', 'wgEmailAuthentication', 'wgEnableUploads', 'wgUseInstantCommons'
76 foreach ( $confItems as $c ) {
77 $val = $installer->getVar( $c );
79 if ( in_array( $c, $boolItems ) ) {
80 $val = wfBoolToStr( $val );
83 if ( !in_array( $c, $unescaped ) && $val !== null ) {
84 $val = self
::escapePhpString( $val );
87 $this->values
[$c] = $val;
90 $this->dbSettings
= $db->getLocalSettings();
91 $this->safeMode
= $installer->getVar( '_SafeMode' );
92 $this->values
['wgEmergencyContact'] = $this->values
['wgPasswordSender'];
96 * For $wgGroupPermissions, set a given ['group']['permission'] value.
97 * @param string $group Group name
98 * @param array $rightsArr An array of permissions, in the form of:
99 * array( 'right' => true, 'right2' => false )
101 public function setGroupRights( $group, $rightsArr ) {
102 $this->groupPermissions
[$group] = $rightsArr;
106 * Returns the escaped version of a string of php code.
108 * @param $string String
112 public static function escapePhpString( $string ) {
113 if ( is_array( $string ) ||
is_object( $string ) ) {
131 * Return the full text of the generated LocalSettings.php file,
132 * including the extensions
136 public function getText() {
137 $localSettings = $this->getDefaultText();
139 if ( count( $this->extensions
) ) {
141 # Enabled Extensions. Most extensions are enabled by including the base extension file here
142 # but check specific extension documentation for more details
143 # The following extensions were automatically enabled:\n";
145 foreach ( $this->extensions
as $extName ) {
146 $encExtName = self
::escapePhpString( $extName );
147 $localSettings .= "require_once \"\$IP/extensions/$encExtName/$encExtName.php\";\n";
151 $localSettings .= "\n\n# End of automatically generated settings.
152 # Add more configuration options below.\n\n";
154 return $localSettings;
158 * Write the generated LocalSettings to a file
160 * @param string $fileName Full path to filename to write to
162 public function writeFile( $fileName ) {
163 file_put_contents( $fileName, $this->getText() );
169 protected function buildMemcachedServerList() {
170 $servers = $this->values
['_MemCachedServers'];
176 $servers = explode( ',', $servers );
178 foreach ( $servers as $srv ) {
183 return rtrim( $ret, ', ' ) . ' )';
190 protected function getDefaultText() {
191 if ( !$this->values
['wgImageMagickConvertCommand'] ) {
192 $this->values
['wgImageMagickConvertCommand'] = '/usr/bin/convert';
198 if ( !$this->values
['wgShellLocale'] ) {
199 $this->values
['wgShellLocale'] = 'en_US.UTF-8';
205 //$rightsUrl = $this->values['wgRightsUrl'] ? '' : '#'; // @todo FIXME: I'm unused!
206 $hashedUploads = $this->safeMode ?
'' : '#';
208 if ( $this->values
['wgMetaNamespace'] !== $this->values
['wgSitename'] ) {
209 $metaNamespace = "\$wgMetaNamespace = \"{$this->values['wgMetaNamespace']}\";\n";
213 if ( $this->groupPermissions
) {
214 $groupRights .= "# The following permissions were set based on your choice in the installer\n";
215 foreach ( $this->groupPermissions
as $group => $rightArr ) {
216 $group = self
::escapePhpString( $group );
217 foreach ( $rightArr as $right => $perm ) {
218 $right = self
::escapePhpString( $right );
219 $groupRights .= "\$wgGroupPermissions['$group']['$right'] = " .
220 wfBoolToStr( $perm ) . ";\n";
225 $wgServerSetting = "";
226 if ( array_key_exists( 'wgServer', $this->values
) && $this->values
['wgServer'] !== null ) {
227 $wgServerSetting = "\n## The protocol and server name to use in fully-qualified URLs\n";
228 $wgServerSetting .= "\$wgServer = \"{$this->values['wgServer']}\";\n";
231 switch ( $this->values
['wgMainCacheType'] ) {
236 $cacheType = 'CACHE_' . strtoupper( $this->values
['wgMainCacheType'] );
240 $cacheType = 'CACHE_NONE';
243 $mcservers = $this->buildMemcachedServerList();
246 # This file was automatically generated by the MediaWiki {$GLOBALS['wgVersion']}
247 # installer. If you make manual changes, please keep track in case you
248 # need to recreate them later.
250 # See includes/DefaultSettings.php for all configurable settings
251 # and their default values, but don't forget to make changes in _this_
254 # Further documentation for configuration settings may be found at:
255 # http://www.mediawiki.org/wiki/Manual:Configuration_settings
257 # Protect against web entry
258 if ( !defined( 'MEDIAWIKI' ) ) {
262 ## Uncomment this to disable output compression
263 # \$wgDisableOutputCompression = true;
265 \$wgSitename = \"{$this->values['wgSitename']}\";
267 ## The URL base path to the directory containing the wiki;
268 ## defaults for all runtime URL paths are based off of this.
269 ## For more information on customizing the URLs
270 ## (like /w/index.php/Page_title to /wiki/Page_title) please see:
271 ## http://www.mediawiki.org/wiki/Manual:Short_URL
272 \$wgScriptPath = \"{$this->values['wgScriptPath']}\";
273 \$wgScriptExtension = \"{$this->values['wgScriptExtension']}\";
275 ## The relative URL path to the skins directory
276 \$wgStylePath = \"\$wgScriptPath/skins\";
278 ## The relative URL path to the logo. Make sure you change this from the default,
279 ## or else you'll overwrite your logo when you upgrade!
280 \$wgLogo = \"{$this->values['wgLogo']}\";
282 ## UPO means: this is also a user preference option
284 \$wgEnableEmail = {$this->values['wgEnableEmail']};
285 \$wgEnableUserEmail = {$this->values['wgEnableUserEmail']}; # UPO
287 \$wgEmergencyContact = \"{$this->values['wgEmergencyContact']}\";
288 \$wgPasswordSender = \"{$this->values['wgPasswordSender']}\";
290 \$wgEnotifUserTalk = {$this->values['wgEnotifUserTalk']}; # UPO
291 \$wgEnotifWatchlist = {$this->values['wgEnotifWatchlist']}; # UPO
292 \$wgEmailAuthentication = {$this->values['wgEmailAuthentication']};
295 \$wgDBtype = \"{$this->values['wgDBtype']}\";
296 \$wgDBserver = \"{$this->values['wgDBserver']}\";
297 \$wgDBname = \"{$this->values['wgDBname']}\";
298 \$wgDBuser = \"{$this->values['wgDBuser']}\";
299 \$wgDBpassword = \"{$this->values['wgDBpassword']}\";
303 ## Shared memory settings
304 \$wgMainCacheType = $cacheType;
305 \$wgMemCachedServers = $mcservers;
307 ## To enable image uploads, make sure the 'images' directory
308 ## is writable, then set this to true:
309 \$wgEnableUploads = {$this->values['wgEnableUploads']};
310 {$magic}\$wgUseImageMagick = true;
311 {$magic}\$wgImageMagickConvertCommand = \"{$this->values['wgImageMagickConvertCommand']}\";
313 # InstantCommons allows wiki to use images from http://commons.wikimedia.org
314 \$wgUseInstantCommons = {$this->values['wgUseInstantCommons']};
316 ## If you use ImageMagick (or any other shell command) on a
317 ## Linux server, this will need to be set to the name of an
318 ## available UTF-8 locale
319 {$locale}\$wgShellLocale = \"{$this->values['wgShellLocale']}\";
321 ## If you want to use image uploads under safe mode,
322 ## create the directories images/archive, images/thumb and
323 ## images/temp, and make them all writable. Then uncomment
324 ## this, if it's not already uncommented:
325 {$hashedUploads}\$wgHashedUploadDirectory = false;
327 ## Set \$wgCacheDirectory to a writable directory on the web server
328 ## to make your wiki go slightly faster. The directory should not
329 ## be publically accessible from the web.
330 #\$wgCacheDirectory = \"\$IP/cache\";
332 # Site language code, should be one of the list in ./languages/Names.php
333 \$wgLanguageCode = \"{$this->values['wgLanguageCode']}\";
335 \$wgSecretKey = \"{$this->values['wgSecretKey']}\";
337 # Site upgrade key. Must be set to a string (default provided) to turn on the
338 # web installer while LocalSettings.php is in place
339 \$wgUpgradeKey = \"{$this->values['wgUpgradeKey']}\";
341 ## Default skin: you can change the default skin. Use the internal symbolic
342 ## names, ie 'cologneblue', 'monobook', 'vector':
343 \$wgDefaultSkin = \"{$this->values['wgDefaultSkin']}\";
345 ## For attaching licensing metadata to pages, and displaying an
346 ## appropriate copyright notice / icon. GNU Free Documentation
347 ## License and Creative Commons licenses are supported so far.
348 \$wgRightsPage = \"\"; # Set to the title of a wiki page that describes your license/copyright
349 \$wgRightsUrl = \"{$this->values['wgRightsUrl']}\";
350 \$wgRightsText = \"{$this->values['wgRightsText']}\";
351 \$wgRightsIcon = \"{$this->values['wgRightsIcon']}\";
353 # Path to the GNU diff3 utility. Used for conflict resolution.
354 \$wgDiff3 = \"{$this->values['wgDiff3']}\";