30class LocalSettingsGenerator {
33 protected $values = [];
34 protected $groupPermissions = [];
35 protected $dbSettings =
'';
48 public function __construct(
Installer $installer ) {
49 $this->installer = $installer;
53 $this->
IP = $installer->
getVar(
'IP' );
57 $confItems = array_merge(
59 'wgServer',
'wgScriptPath',
60 'wgPasswordSender',
'wgImageMagickConvertCommand',
'wgShellLocale',
61 'wgLanguageCode',
'wgEnableEmail',
'wgEnableUserEmail',
'wgDiff3',
62 'wgEnotifUserTalk',
'wgEnotifWatchlist',
'wgEmailAuthentication',
63 'wgDBtype',
'wgSecretKey',
'wgRightsUrl',
'wgSitename',
'wgRightsIcon',
64 'wgRightsText',
'_MainCacheType',
'wgEnableUploads',
65 '_MemCachedServers',
'wgDBserver',
'wgDBuser',
66 'wgDBpassword',
'wgUseInstantCommons',
'wgUpgradeKey',
'wgDefaultSkin',
67 'wgMetaNamespace',
'wgLogo',
'wgAuthenticationTokenVersion',
72 $unescaped = [
'wgRightsIcon',
'wgLogo' ];
74 'wgEnableEmail',
'wgEnableUserEmail',
'wgEnotifUserTalk',
75 'wgEnotifWatchlist',
'wgEmailAuthentication',
'wgEnableUploads',
'wgUseInstantCommons'
78 foreach ( $confItems as $c ) {
79 $val = $installer->
getVar( $c );
81 if ( in_array( $c, $boolItems ) ) {
85 if ( !in_array( $c, $unescaped ) && $val !==
null ) {
86 $val = self::escapePhpString( $val );
92 $this->dbSettings = $db->getLocalSettings();
93 $this->
values[
'wgEmergencyContact'] = $this->
values[
'wgPasswordSender'];
102 public function setGroupRights( $group, $rightsArr ) {
103 $this->groupPermissions[$group] = $rightsArr;
113 public static function escapePhpString( $string ) {
114 if ( is_array( $string ) || is_object( $string ) ) {
137 public function getText() {
138 $localSettings = $this->getDefaultText();
140 if ( count( $this->
skins ) ) {
143# The following skins were automatically enabled:\n";
145 foreach ( $this->
skins as $skinName ) {
146 $localSettings .= $this->generateExtEnableLine(
'skins', $skinName );
149 $localSettings .=
"\n";
154# Enabled extensions. Most of the extensions are enabled by adding
155# wfLoadExtensions('ExtensionName');
156# to LocalSettings.php. Check specific extension documentation for more details.
157# The following extensions were automatically enabled:\n";
160 $localSettings .= $this->generateExtEnableLine(
'extensions', $extName );
163 $localSettings .=
"\n";
167# End of automatically generated settings.
168# Add more configuration options below.\n\n";
170 return $localSettings;
181 private function generateExtEnableLine(
$dir, $name ) {
182 if (
$dir ===
'extensions' ) {
183 $jsonFile =
'extension.json';
184 $function =
'wfLoadExtension';
185 } elseif (
$dir ===
'skins' ) {
186 $jsonFile =
'skin.json';
187 $function =
'wfLoadSkin';
189 throw new InvalidArgumentException(
'$dir was not "extensions" or "skins' );
192 $encName = self::escapePhpString( $name );
194 if ( file_exists(
"{$this->IP}/$dir/$encName/$jsonFile" ) ) {
195 return "$function( '$encName' );\n";
197 return "require_once \"\$IP/$dir/$encName/$encName.php\";\n";
206 public function writeFile( $fileName ) {
207 file_put_contents( $fileName, $this->getText() );
213 protected function buildMemcachedServerList() {
214 $servers = $this->
values[
'_MemCachedServers'];
220 $servers = explode(
',', $servers );
222 foreach ( $servers as $srv ) {
227 return rtrim(
$ret,
', ' ) .
' ]';
234 protected function getDefaultText() {
235 if ( !$this->
values[
'wgImageMagickConvertCommand'] ) {
236 $this->
values[
'wgImageMagickConvertCommand'] =
'/usr/bin/convert';
242 if ( !$this->
values[
'wgShellLocale'] ) {
243 $this->
values[
'wgShellLocale'] =
'en_US.UTF-8';
250 if ( $this->
values[
'wgMetaNamespace'] !== $this->
values[
'wgSitename'] ) {
251 $metaNamespace =
"\$wgMetaNamespace = \"{$this->values['wgMetaNamespace']}\";\n";
256 if ( $this->groupPermissions ) {
257 $groupRights .=
"# The following permissions were set based on your choice in the installer\n";
258 foreach ( $this->groupPermissions as $group => $rightArr ) {
259 $group = self::escapePhpString( $group );
260 foreach ( $rightArr as $right => $perm ) {
261 $right = self::escapePhpString( $right );
262 $groupRights .=
"\$wgGroupPermissions['$group']['$right'] = " .
266 $groupRights .=
"\n";
268 if ( ( isset( $this->groupPermissions[
'*'][
'edit'] ) &&
269 $this->groupPermissions[
'*'][
'edit'] ===
false )
270 && ( isset( $this->groupPermissions[
'*'][
'createaccount'] ) &&
271 $this->groupPermissions[
'*'][
'createaccount'] ===
false )
272 && ( isset( $this->groupPermissions[
'*'][
'read'] ) &&
273 $this->groupPermissions[
'*'][
'read'] !==
false )
275 $noFollow =
"# Set \$wgNoFollowLinks to true if you open up your wiki to editing by\n"
276 .
"# the general public and wish to apply nofollow to external links as a\n"
277 .
"# deterrent to spammers. Nofollow is not a comprehensive anti-spam solution\n"
278 .
"# and open wikis will generally require other anti-spam measures; for more\n"
279 .
"# information, see https://www.mediawiki.org/wiki/Manual:Combating_spam\n"
280 .
"\$wgNoFollowLinks = false;\n\n";
285 if ( array_key_exists(
'wgServer', $this->
values ) && $this->
values[
'wgServer'] !==
null ) {
286 $serverSetting =
"\n## The protocol and server name to use in fully-qualified URLs\n";
287 $serverSetting .=
"\$wgServer = \"{$this->values['wgServer']}\";";
290 switch ( $this->
values[
'_MainCacheType'] ) {
295 $cacheType =
'CACHE_' . strtoupper( $this->
values[
'_MainCacheType'] );
299 $cacheType =
'CACHE_NONE';
302 $mcservers = $this->buildMemcachedServerList();
305# This file was automatically generated by the MediaWiki {$GLOBALS['wgVersion']}
306# installer. If you make manual changes, please keep track in case you
307# need to recreate them later.
309# See includes/DefaultSettings.php for all configurable settings
310# and their default values, but don't forget to make changes in _this_
313# Further documentation for configuration settings may be found at:
314# https://www.mediawiki.org/wiki/Manual:Configuration_settings
316# Protect against web entry
317if ( !defined( 'MEDIAWIKI' ) ) {
321## Uncomment this to disable output compression
322# \$wgDisableOutputCompression = true;
324\$wgSitename = \"{$this->values['wgSitename']}\";
326## The URL base path to the directory containing the wiki;
327## defaults for all runtime URL paths are based off of this.
328## For more information on customizing the URLs
329## (like /w/index.php/Page_title to /wiki/Page_title) please see:
330## https://www.mediawiki.org/wiki/Manual:Short_URL
331\$wgScriptPath = \"{$this->values['wgScriptPath']}\";
334## The URL path to static resources (images, scripts, etc.)
335\$wgResourceBasePath = \$wgScriptPath;
337## The URL path to the logo. Make sure you change this from the default,
338## or else you'll overwrite your logo when you upgrade!
339\$wgLogo = \"{$this->values['wgLogo']}\";
341## UPO means: this is also a user preference option
343\$wgEnableEmail = {$this->values['wgEnableEmail']};
344\$wgEnableUserEmail = {$this->values['wgEnableUserEmail']}; # UPO
346\$wgEmergencyContact = \"{$this->values['wgEmergencyContact']}\";
347\$wgPasswordSender = \"{$this->values['wgPasswordSender']}\";
349\$wgEnotifUserTalk = {$this->values['wgEnotifUserTalk']}; # UPO
350\$wgEnotifWatchlist = {$this->values['wgEnotifWatchlist']}; # UPO
351\$wgEmailAuthentication = {$this->values['wgEmailAuthentication']};
354\$wgDBtype = \"{$this->values['wgDBtype']}\";
355\$wgDBserver = \"{$this->values['wgDBserver']}\";
356\$wgDBname = \"{$this->values['wgDBname']}\";
357\$wgDBuser = \"{$this->values['wgDBuser']}\";
358\$wgDBpassword = \"{$this->values['wgDBpassword']}\";
362## Shared memory settings
363\$wgMainCacheType = $cacheType;
364\$wgMemCachedServers = $mcservers;
366## To enable image uploads, make sure the 'images' directory
367## is writable, then set this to true:
368\$wgEnableUploads = {$this->values['wgEnableUploads']};
369{$magic}\$wgUseImageMagick = true;
370{$magic}\$wgImageMagickConvertCommand = \"{$this->values['wgImageMagickConvertCommand']}\";
372# InstantCommons allows wiki to use images from https://commons.wikimedia.org
373\$wgUseInstantCommons = {$this->values['wgUseInstantCommons']};
375## If you use ImageMagick (or any other shell command) on a
376## Linux server, this will need to be set to the name of an
377## available UTF-8 locale
378{$locale}\$wgShellLocale = \"{$this->values['wgShellLocale']}\";
380## Set \$wgCacheDirectory to a writable directory on the web server
381## to make your wiki go slightly faster. The directory should not
382## be publically accessible from the web.
383#\$wgCacheDirectory = \"\$IP/cache\";
385# Site language code, should be one of the list in ./languages/data/Names.php
386\$wgLanguageCode = \"{$this->values['wgLanguageCode']}\";
388\$wgSecretKey = \"{$this->values['wgSecretKey']}\";
390# Changing this will log out all existing sessions.
391\$wgAuthenticationTokenVersion = \"{$this->values['wgAuthenticationTokenVersion']}\";
393# Site upgrade key. Must be set to a string (default provided) to turn on the
394# web installer while LocalSettings.php is in place
395\$wgUpgradeKey = \"{$this->values['wgUpgradeKey']}\";
397## For attaching licensing metadata to pages, and displaying an
398## appropriate copyright notice / icon. GNU Free Documentation
399## License and Creative Commons licenses are supported so far.
400\$wgRightsPage = \"\"; # Set to the title of a wiki page that describes your license/copyright
401\$wgRightsUrl = \"{$this->values['wgRightsUrl']}\";
402\$wgRightsText = \"{$this->values['wgRightsText']}\";
403\$wgRightsIcon = \"{$this->values['wgRightsIcon']}\";
405# Path to the GNU diff3 utility. Used for conflict resolution.
406\$wgDiff3 = \"{$this->values['wgDiff3']}\";
408{$groupRights}{$noFollow}## Default skin: you can change the default skin. Use the internal symbolic
409## names, ie 'vector', 'monobook':
410\$wgDefaultSkin = \"{$this->values['wgDefaultSkin']}\";
wfBoolToStr( $value)
Convenience function converts boolean values into "true" or "false" (string) values.
A collection of public static functions to play with IP address and IP blocks.
getDBInstaller( $type=false)
Get an instance of DatabaseInstaller for the specified DB type.
getVar( $name, $default=null)
Get an MW configuration variable, or internal installer configuration variable.
The ContentHandler facility adds support for arbitrary content types on wiki instead of relying on wikitext for everything It was introduced in MediaWiki Each kind of and so on Built in content types as usual *javascript user provided javascript code *json simple implementation for use by extensions
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible values
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
if(count( $args)==0) $dir
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
skin txt MediaWiki includes four core skins