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;
47 * @param Installer $installer
49 public function __construct( Installer
$installer ) {
50 $this->installer
= $installer;
52 $this->extensions
= $installer->getVar( '_Extensions' );
53 $this->skins
= $installer->getVar( '_Skins' );
54 $this->IP
= $installer->getVar( 'IP' );
56 $db = $installer->getDBInstaller( $installer->getVar( 'wgDBtype' ) );
58 $confItems = array_merge(
60 'wgServer', 'wgScriptPath',
61 'wgPasswordSender', 'wgImageMagickConvertCommand', 'wgShellLocale',
62 'wgLanguageCode', 'wgEnableEmail', 'wgEnableUserEmail', 'wgDiff3',
63 'wgEnotifUserTalk', 'wgEnotifWatchlist', 'wgEmailAuthentication',
64 'wgDBtype', 'wgSecretKey', 'wgRightsUrl', 'wgSitename', 'wgRightsIcon',
65 'wgRightsText', 'wgMainCacheType', 'wgEnableUploads',
66 'wgMainCacheType', '_MemCachedServers', 'wgDBserver', 'wgDBuser',
67 'wgDBpassword', 'wgUseInstantCommons', 'wgUpgradeKey', 'wgDefaultSkin',
68 'wgMetaNamespace', 'wgLogo',
73 $unescaped = array( 'wgRightsIcon', 'wgLogo' );
75 'wgEnableEmail', 'wgEnableUserEmail', 'wgEnotifUserTalk',
76 'wgEnotifWatchlist', 'wgEmailAuthentication', 'wgEnableUploads', 'wgUseInstantCommons'
79 foreach ( $confItems as $c ) {
80 $val = $installer->getVar( $c );
82 if ( in_array( $c, $boolItems ) ) {
83 $val = wfBoolToStr( $val );
86 if ( !in_array( $c, $unescaped ) && $val !== null ) {
87 $val = self
::escapePhpString( $val );
90 $this->values
[$c] = $val;
93 $this->dbSettings
= $db->getLocalSettings();
94 $this->safeMode
= $installer->getVar( '_SafeMode' );
95 $this->values
['wgEmergencyContact'] = $this->values
['wgPasswordSender'];
99 * For $wgGroupPermissions, set a given ['group']['permission'] value.
100 * @param string $group Group name
101 * @param array $rightsArr An array of permissions, in the form of:
102 * array( 'right' => true, 'right2' => false )
104 public function setGroupRights( $group, $rightsArr ) {
105 $this->groupPermissions
[$group] = $rightsArr;
109 * Returns the escaped version of a string of php code.
111 * @param string $string
115 public static function escapePhpString( $string ) {
116 if ( is_array( $string ) ||
is_object( $string ) ) {
134 * Return the full text of the generated LocalSettings.php file,
135 * including the extensions and skins.
139 public function getText() {
140 $localSettings = $this->getDefaultText();
142 if ( count( $this->skins
) ) {
145 # The following skins were automatically enabled:\n";
147 foreach ( $this->skins
as $skinName ) {
148 $localSettings .= $this->generateExtEnableLine( 'skins', $skinName );
151 $localSettings .= "\n";
154 if ( count( $this->extensions
) ) {
156 # Enabled Extensions. Most extensions are enabled by including the base extension file here
157 # but check specific extension documentation for more details
158 # The following extensions were automatically enabled:\n";
160 foreach ( $this->extensions
as $extName ) {
161 $localSettings .= $this->generateExtEnableLine( 'extensions', $extName );
164 $localSettings .= "\n";
168 # End of automatically generated settings.
169 # Add more configuration options below.\n\n";
171 return $localSettings;
175 * Generate the appropriate line to enable the given extension or skin
177 * @param string $dir Either "extensions" or "skins"
178 * @param string $name Name of extension/skin
179 * @throws InvalidArgumentException
182 private function generateExtEnableLine( $dir, $name ) {
183 if ( $dir === 'extensions' ) {
184 $jsonFile = 'extension.json';
185 $function = 'wfLoadExtension';
186 } elseif ( $dir === 'skins' ) {
187 $jsonFile = 'skin.json';
188 $function = 'wfLoadSkin';
190 throw new InvalidArgumentException( '$dir was not "extensions" or "skins' );
193 $encName = self
::escapePhpString( $name );
195 if ( file_exists( "{$this->IP}/$dir/$encName/$jsonFile" ) ) {
196 return "$function( '$encName' );\n";
198 return "require_once \"\$IP/$dir/$encName/$encName.php\";\n";
203 * Write the generated LocalSettings to a file
205 * @param string $fileName Full path to filename to write to
207 public function writeFile( $fileName ) {
208 file_put_contents( $fileName, $this->getText() );
214 protected function buildMemcachedServerList() {
215 $servers = $this->values
['_MemCachedServers'];
221 $servers = explode( ',', $servers );
223 foreach ( $servers as $srv ) {
228 return rtrim( $ret, ', ' ) . ' )';
235 protected function getDefaultText() {
236 if ( !$this->values
['wgImageMagickConvertCommand'] ) {
237 $this->values
['wgImageMagickConvertCommand'] = '/usr/bin/convert';
243 if ( !$this->values
['wgShellLocale'] ) {
244 $this->values
['wgShellLocale'] = 'en_US.UTF-8';
250 $hashedUploads = $this->safeMode ?
'' : '#';
252 if ( $this->values
['wgMetaNamespace'] !== $this->values
['wgSitename'] ) {
253 $metaNamespace = "\$wgMetaNamespace = \"{$this->values['wgMetaNamespace']}\";\n";
258 if ( $this->groupPermissions
) {
259 $groupRights .= "# The following permissions were set based on your choice in the installer\n";
260 foreach ( $this->groupPermissions
as $group => $rightArr ) {
261 $group = self
::escapePhpString( $group );
262 foreach ( $rightArr as $right => $perm ) {
263 $right = self
::escapePhpString( $right );
264 $groupRights .= "\$wgGroupPermissions['$group']['$right'] = " .
265 wfBoolToStr( $perm ) . ";\n";
268 $groupRights .= "\n";
270 if ( ( isset( $this->groupPermissions
['*']['edit'] ) &&
271 $this->groupPermissions
['*']['edit'] === false )
272 && ( isset( $this->groupPermissions
['*']['createaccount'] ) &&
273 $this->groupPermissions
['*']['createaccount'] === false )
274 && ( isset( $this->groupPermissions
['*']['read'] ) &&
275 $this->groupPermissions
['*']['read'] !== false )
277 $noFollow = "# Set \$wgNoFollowLinks to true if you open up your wiki to editing by\n"
278 . "# the general public and wish to apply nofollow to external links as a\n"
279 . "# deterrent to spammers. Nofollow is not a comprehensive anti-spam solution\n"
280 . "# and open wikis will generally require other anti-spam measures; for more\n"
281 . "# information, see https://www.mediawiki.org/wiki/Manual:Combating_spam\n"
282 . "\$wgNoFollowLinks = false;\n\n";
287 if ( array_key_exists( 'wgServer', $this->values
) && $this->values
['wgServer'] !== null ) {
288 $serverSetting = "\n## The protocol and server name to use in fully-qualified URLs\n";
289 $serverSetting .= "\$wgServer = \"{$this->values['wgServer']}\";\n";
292 switch ( $this->values
['wgMainCacheType'] ) {
297 $cacheType = 'CACHE_' . strtoupper( $this->values
['wgMainCacheType'] );
301 $cacheType = 'CACHE_NONE';
304 $mcservers = $this->buildMemcachedServerList();
307 # This file was automatically generated by the MediaWiki {$GLOBALS['wgVersion']}
308 # installer. If you make manual changes, please keep track in case you
309 # need to recreate them later.
311 # See includes/DefaultSettings.php for all configurable settings
312 # and their default values, but don't forget to make changes in _this_
315 # Further documentation for configuration settings may be found at:
316 # https://www.mediawiki.org/wiki/Manual:Configuration_settings
318 # Protect against web entry
319 if ( !defined( 'MEDIAWIKI' ) ) {
323 ## Uncomment this to disable output compression
324 # \$wgDisableOutputCompression = true;
326 \$wgSitename = \"{$this->values['wgSitename']}\";
328 ## The URL base path to the directory containing the wiki;
329 ## defaults for all runtime URL paths are based off of this.
330 ## For more information on customizing the URLs
331 ## (like /w/index.php/Page_title to /wiki/Page_title) please see:
332 ## https://www.mediawiki.org/wiki/Manual:Short_URL
333 \$wgScriptPath = \"{$this->values['wgScriptPath']}\";
335 ## The relative URL path to the skins directory
336 \$wgStylePath = \"\$wgScriptPath/skins\";
337 \$wgResourceBasePath = \$wgScriptPath;
339 ## The relative URL path to the logo. Make sure you change this from the default,
340 ## or else you'll overwrite your logo when you upgrade!
341 \$wgLogo = \"{$this->values['wgLogo']}\";
343 ## UPO means: this is also a user preference option
345 \$wgEnableEmail = {$this->values['wgEnableEmail']};
346 \$wgEnableUserEmail = {$this->values['wgEnableUserEmail']}; # UPO
348 \$wgEmergencyContact = \"{$this->values['wgEmergencyContact']}\";
349 \$wgPasswordSender = \"{$this->values['wgPasswordSender']}\";
351 \$wgEnotifUserTalk = {$this->values['wgEnotifUserTalk']}; # UPO
352 \$wgEnotifWatchlist = {$this->values['wgEnotifWatchlist']}; # UPO
353 \$wgEmailAuthentication = {$this->values['wgEmailAuthentication']};
356 \$wgDBtype = \"{$this->values['wgDBtype']}\";
357 \$wgDBserver = \"{$this->values['wgDBserver']}\";
358 \$wgDBname = \"{$this->values['wgDBname']}\";
359 \$wgDBuser = \"{$this->values['wgDBuser']}\";
360 \$wgDBpassword = \"{$this->values['wgDBpassword']}\";
364 ## Shared memory settings
365 \$wgMainCacheType = $cacheType;
366 \$wgMemCachedServers = $mcservers;
368 ## To enable image uploads, make sure the 'images' directory
369 ## is writable, then set this to true:
370 \$wgEnableUploads = {$this->values['wgEnableUploads']};
371 {$magic}\$wgUseImageMagick = true;
372 {$magic}\$wgImageMagickConvertCommand = \"{$this->values['wgImageMagickConvertCommand']}\";
374 # InstantCommons allows wiki to use images from https://commons.wikimedia.org
375 \$wgUseInstantCommons = {$this->values['wgUseInstantCommons']};
377 ## If you use ImageMagick (or any other shell command) on a
378 ## Linux server, this will need to be set to the name of an
379 ## available UTF-8 locale
380 {$locale}\$wgShellLocale = \"{$this->values['wgShellLocale']}\";
382 ## If you want to use image uploads under safe mode,
383 ## create the directories images/archive, images/thumb and
384 ## images/temp, and make them all writable. Then uncomment
385 ## this, if it's not already uncommented:
386 {$hashedUploads}\$wgHashedUploadDirectory = false;
388 ## Set \$wgCacheDirectory to a writable directory on the web server
389 ## to make your wiki go slightly faster. The directory should not
390 ## be publically accessible from the web.
391 #\$wgCacheDirectory = \"\$IP/cache\";
393 # Site language code, should be one of the list in ./languages/Names.php
394 \$wgLanguageCode = \"{$this->values['wgLanguageCode']}\";
396 \$wgSecretKey = \"{$this->values['wgSecretKey']}\";
398 # Site upgrade key. Must be set to a string (default provided) to turn on the
399 # web installer while LocalSettings.php is in place
400 \$wgUpgradeKey = \"{$this->values['wgUpgradeKey']}\";
402 ## For attaching licensing metadata to pages, and displaying an
403 ## appropriate copyright notice / icon. GNU Free Documentation
404 ## License and Creative Commons licenses are supported so far.
405 \$wgRightsPage = \"\"; # Set to the title of a wiki page that describes your license/copyright
406 \$wgRightsUrl = \"{$this->values['wgRightsUrl']}\";
407 \$wgRightsText = \"{$this->values['wgRightsText']}\";
408 \$wgRightsIcon = \"{$this->values['wgRightsIcon']}\";
410 # Path to the GNU diff3 utility. Used for conflict resolution.
411 \$wgDiff3 = \"{$this->values['wgDiff3']}\";
413 {$groupRights}{$noFollow}## Default skin: you can change the default skin. Use the internal symbolic
414 ## names, ie 'vector', 'monobook':
415 \$wgDefaultSkin = \"{$this->values['wgDefaultSkin']}\";