MediaWiki  master
LocalSettingsGenerator.php
Go to the documentation of this file.
1 <?php
31 
32  protected $extensions = [];
33  protected $values = [];
34  protected $groupPermissions = [];
35  protected $dbSettings = '';
36  protected $IP;
37 
41  protected $installer;
42 
46  public function __construct( Installer $installer ) {
47  $this->installer = $installer;
48 
49  $this->extensions = $installer->getVar( '_Extensions' );
50  $this->skins = $installer->getVar( '_Skins' );
51  $this->IP = $installer->getVar( 'IP' );
52 
53  $db = $installer->getDBInstaller( $installer->getVar( 'wgDBtype' ) );
54 
55  $confItems = array_merge(
56  [
57  'wgServer', 'wgScriptPath',
58  'wgPasswordSender', 'wgImageMagickConvertCommand', 'wgShellLocale',
59  'wgLanguageCode', 'wgEnableEmail', 'wgEnableUserEmail', 'wgDiff3',
60  'wgEnotifUserTalk', 'wgEnotifWatchlist', 'wgEmailAuthentication',
61  'wgDBtype', 'wgSecretKey', 'wgRightsUrl', 'wgSitename', 'wgRightsIcon',
62  'wgRightsText', '_MainCacheType', 'wgEnableUploads',
63  '_MemCachedServers', 'wgDBserver', 'wgDBuser',
64  'wgDBpassword', 'wgUseInstantCommons', 'wgUpgradeKey', 'wgDefaultSkin',
65  'wgMetaNamespace', 'wgLogo', 'wgAuthenticationTokenVersion', 'wgPingback',
66  ],
67  $db->getGlobalNames()
68  );
69 
70  $unescaped = [ 'wgRightsIcon', 'wgLogo', '_Caches' ];
71  $boolItems = [
72  'wgEnableEmail', 'wgEnableUserEmail', 'wgEnotifUserTalk',
73  'wgEnotifWatchlist', 'wgEmailAuthentication', 'wgEnableUploads', 'wgUseInstantCommons',
74  'wgPingback',
75  ];
76 
77  foreach ( $confItems as $c ) {
78  $val = $installer->getVar( $c );
79 
80  if ( in_array( $c, $boolItems ) ) {
81  $val = wfBoolToStr( $val );
82  }
83 
84  if ( !in_array( $c, $unescaped ) && $val !== null ) {
85  $val = self::escapePhpString( $val );
86  }
87 
88  $this->values[$c] = $val;
89  }
90 
91  $this->dbSettings = $db->getLocalSettings();
92  $this->values['wgEmergencyContact'] = $this->values['wgPasswordSender'];
93  }
94 
101  public function setGroupRights( $group, $rightsArr ) {
102  $this->groupPermissions[$group] = $rightsArr;
103  }
104 
112  public static function escapePhpString( $string ) {
113  if ( is_array( $string ) || is_object( $string ) ) {
114  return false;
115  }
116 
117  return strtr(
118  $string,
119  [
120  "\n" => "\\n",
121  "\r" => "\\r",
122  "\t" => "\\t",
123  "\\" => "\\\\",
124  "\$" => "\\\$",
125  "\"" => "\\\""
126  ]
127  );
128  }
129 
136  public function getText() {
137  $localSettings = $this->getDefaultText();
138 
139  if ( count( $this->skins ) ) {
140  $localSettings .= "
141 # Enabled skins.
142 # The following skins were automatically enabled:\n";
143 
144  foreach ( $this->skins as $skinName ) {
145  $localSettings .= $this->generateExtEnableLine( 'skins', $skinName );
146  }
147 
148  $localSettings .= "\n";
149  }
150 
151  if ( count( $this->extensions ) ) {
152  $localSettings .= "
153 # Enabled extensions. Most of the extensions are enabled by adding
154 # wfLoadExtensions('ExtensionName');
155 # to LocalSettings.php. Check specific extension documentation for more details.
156 # The following extensions were automatically enabled:\n";
157 
158  foreach ( $this->extensions as $extName ) {
159  $localSettings .= $this->generateExtEnableLine( 'extensions', $extName );
160  }
161 
162  $localSettings .= "\n";
163  }
164 
165  $localSettings .= "
166 # End of automatically generated settings.
167 # Add more configuration options below.\n\n";
168 
169  return $localSettings;
170  }
171 
180  private function generateExtEnableLine( $dir, $name ) {
181  if ( $dir === 'extensions' ) {
182  $jsonFile = 'extension.json';
183  $function = 'wfLoadExtension';
184  } elseif ( $dir === 'skins' ) {
185  $jsonFile = 'skin.json';
186  $function = 'wfLoadSkin';
187  } else {
188  throw new InvalidArgumentException( '$dir was not "extensions" or "skins"' );
189  }
190 
191  $encName = self::escapePhpString( $name );
192 
193  if ( file_exists( "{$this->IP}/$dir/$encName/$jsonFile" ) ) {
194  return "$function( '$encName' );\n";
195  } else {
196  return "require_once \"\$IP/$dir/$encName/$encName.php\";\n";
197  }
198  }
199 
205  public function writeFile( $fileName ) {
206  file_put_contents( $fileName, $this->getText() );
207  }
208 
212  protected function buildMemcachedServerList() {
213  $servers = $this->values['_MemCachedServers'];
214 
215  if ( !$servers ) {
216  return '[]';
217  } else {
218  $ret = '[ ';
219  $servers = explode( ',', $servers );
220 
221  foreach ( $servers as $srv ) {
222  $srv = trim( $srv );
223  $ret .= "'$srv', ";
224  }
225 
226  return rtrim( $ret, ', ' ) . ' ]';
227  }
228  }
229 
233  protected function getDefaultText() {
234  if ( !$this->values['wgImageMagickConvertCommand'] ) {
235  $this->values['wgImageMagickConvertCommand'] = '/usr/bin/convert';
236  $magic = '#';
237  } else {
238  $magic = '';
239  }
240 
241  if ( !$this->values['wgShellLocale'] ) {
242  $this->values['wgShellLocale'] = 'C.UTF-8';
243  $locale = '#';
244  } else {
245  $locale = '';
246  }
247 
248  $metaNamespace = '';
249  if ( $this->values['wgMetaNamespace'] !== $this->values['wgSitename'] ) {
250  $metaNamespace = "\$wgMetaNamespace = \"{$this->values['wgMetaNamespace']}\";\n";
251  }
252 
253  $groupRights = '';
254  $noFollow = '';
255  if ( $this->groupPermissions ) {
256  $groupRights .= "# The following permissions were set based on your choice in the installer\n";
257  foreach ( $this->groupPermissions as $group => $rightArr ) {
258  $group = self::escapePhpString( $group );
259  foreach ( $rightArr as $right => $perm ) {
260  $right = self::escapePhpString( $right );
261  $groupRights .= "\$wgGroupPermissions['$group']['$right'] = " .
262  wfBoolToStr( $perm ) . ";\n";
263  }
264  }
265  $groupRights .= "\n";
266 
267  if ( ( isset( $this->groupPermissions['*']['edit'] ) &&
268  $this->groupPermissions['*']['edit'] === false )
269  && ( isset( $this->groupPermissions['*']['createaccount'] ) &&
270  $this->groupPermissions['*']['createaccount'] === false )
271  && ( isset( $this->groupPermissions['*']['read'] ) &&
272  $this->groupPermissions['*']['read'] !== false )
273  ) {
274  $noFollow = "# Set \$wgNoFollowLinks to true if you open up your wiki to editing by\n"
275  . "# the general public and wish to apply nofollow to external links as a\n"
276  . "# deterrent to spammers. Nofollow is not a comprehensive anti-spam solution\n"
277  . "# and open wikis will generally require other anti-spam measures; for more\n"
278  . "# information, see https://www.mediawiki.org/wiki/Manual:Combating_spam\n"
279  . "\$wgNoFollowLinks = false;\n\n";
280  }
281  }
282 
283  $serverSetting = "";
284  if ( array_key_exists( 'wgServer', $this->values ) && $this->values['wgServer'] !== null ) {
285  $serverSetting = "\n## The protocol and server name to use in fully-qualified URLs\n";
286  $serverSetting .= "\$wgServer = \"{$this->values['wgServer']}\";";
287  }
288 
289  switch ( $this->values['_MainCacheType'] ) {
290  case 'anything':
291  case 'db':
292  case 'memcached':
293  case 'accel':
294  $cacheType = 'CACHE_' . strtoupper( $this->values['_MainCacheType'] );
295  break;
296  case 'none':
297  default:
298  $cacheType = 'CACHE_NONE';
299  }
300 
301  $mcservers = $this->buildMemcachedServerList();
302  if ( file_exists( dirname( __DIR__ ) . '/PlatformSettings.php' ) ) {
303  $platformSettings = "\n## Include platform/distribution defaults";
304  $platformSettings .= "\nrequire_once \"\$IP/includes/PlatformSettings.php\";";
305  } else {
306  $platformSettings = '';
307  }
308 
309  return "<?php
310 # This file was automatically generated by the MediaWiki {$GLOBALS['wgVersion']}
311 # installer. If you make manual changes, please keep track in case you
312 # need to recreate them later.
313 #
314 # See includes/DefaultSettings.php for all configurable settings
315 # and their default values, but don't forget to make changes in _this_
316 # file, not there.
317 #
318 # Further documentation for configuration settings may be found at:
319 # https://www.mediawiki.org/wiki/Manual:Configuration_settings
320 
321 # Protect against web entry
322 if ( !defined( 'MEDIAWIKI' ) ) {
323  exit;
324 }
325 {$platformSettings}
326 
327 ## Uncomment this to disable output compression
328 # \$wgDisableOutputCompression = true;
329 
330 \$wgSitename = \"{$this->values['wgSitename']}\";
331 {$metaNamespace}
332 ## The URL base path to the directory containing the wiki;
333 ## defaults for all runtime URL paths are based off of this.
334 ## For more information on customizing the URLs
335 ## (like /w/index.php/Page_title to /wiki/Page_title) please see:
336 ## https://www.mediawiki.org/wiki/Manual:Short_URL
337 \$wgScriptPath = \"{$this->values['wgScriptPath']}\";
338 ${serverSetting}
339 
340 ## The URL path to static resources (images, scripts, etc.)
341 \$wgResourceBasePath = \$wgScriptPath;
342 
343 ## The URL path to the logo. Make sure you change this from the default,
344 ## or else you'll overwrite your logo when you upgrade!
345 \$wgLogo = \"{$this->values['wgLogo']}\";
346 
347 ## UPO means: this is also a user preference option
348 
349 \$wgEnableEmail = {$this->values['wgEnableEmail']};
350 \$wgEnableUserEmail = {$this->values['wgEnableUserEmail']}; # UPO
351 
352 \$wgEmergencyContact = \"{$this->values['wgEmergencyContact']}\";
353 \$wgPasswordSender = \"{$this->values['wgPasswordSender']}\";
354 
355 \$wgEnotifUserTalk = {$this->values['wgEnotifUserTalk']}; # UPO
356 \$wgEnotifWatchlist = {$this->values['wgEnotifWatchlist']}; # UPO
357 \$wgEmailAuthentication = {$this->values['wgEmailAuthentication']};
358 
359 ## Database settings
360 \$wgDBtype = \"{$this->values['wgDBtype']}\";
361 \$wgDBserver = \"{$this->values['wgDBserver']}\";
362 \$wgDBname = \"{$this->values['wgDBname']}\";
363 \$wgDBuser = \"{$this->values['wgDBuser']}\";
364 \$wgDBpassword = \"{$this->values['wgDBpassword']}\";
365 
366 {$this->dbSettings}
367 
368 ## Shared memory settings
369 \$wgMainCacheType = $cacheType;
370 \$wgMemCachedServers = $mcservers;
371 
372 ## To enable image uploads, make sure the 'images' directory
373 ## is writable, then set this to true:
374 \$wgEnableUploads = {$this->values['wgEnableUploads']};
375 {$magic}\$wgUseImageMagick = true;
376 {$magic}\$wgImageMagickConvertCommand = \"{$this->values['wgImageMagickConvertCommand']}\";
377 
378 # InstantCommons allows wiki to use images from https://commons.wikimedia.org
379 \$wgUseInstantCommons = {$this->values['wgUseInstantCommons']};
380 
381 # Periodically send a pingback to https://www.mediawiki.org/ with basic data
382 # about this MediaWiki instance. The Wikimedia Foundation shares this data
383 # with MediaWiki developers to help guide future development efforts.
384 \$wgPingback = {$this->values['wgPingback']};
385 
386 ## If you use ImageMagick (or any other shell command) on a
387 ## Linux server, this will need to be set to the name of an
388 ## available UTF-8 locale
389 {$locale}\$wgShellLocale = \"{$this->values['wgShellLocale']}\";
390 
391 ## Set \$wgCacheDirectory to a writable directory on the web server
392 ## to make your wiki go slightly faster. The directory should not
393 ## be publicly accessible from the web.
394 #\$wgCacheDirectory = \"\$IP/cache\";
395 
396 # Site language code, should be one of the list in ./languages/data/Names.php
397 \$wgLanguageCode = \"{$this->values['wgLanguageCode']}\";
398 
399 \$wgSecretKey = \"{$this->values['wgSecretKey']}\";
400 
401 # Changing this will log out all existing sessions.
402 \$wgAuthenticationTokenVersion = \"{$this->values['wgAuthenticationTokenVersion']}\";
403 
404 # Site upgrade key. Must be set to a string (default provided) to turn on the
405 # web installer while LocalSettings.php is in place
406 \$wgUpgradeKey = \"{$this->values['wgUpgradeKey']}\";
407 
408 ## For attaching licensing metadata to pages, and displaying an
409 ## appropriate copyright notice / icon. GNU Free Documentation
410 ## License and Creative Commons licenses are supported so far.
411 \$wgRightsPage = \"\"; # Set to the title of a wiki page that describes your license/copyright
412 \$wgRightsUrl = \"{$this->values['wgRightsUrl']}\";
413 \$wgRightsText = \"{$this->values['wgRightsText']}\";
414 \$wgRightsIcon = \"{$this->values['wgRightsIcon']}\";
415 
416 # Path to the GNU diff3 utility. Used for conflict resolution.
417 \$wgDiff3 = \"{$this->values['wgDiff3']}\";
418 
419 {$groupRights}{$noFollow}## Default skin: you can change the default skin. Use the internal symbolic
420 ## names, ie 'vector', 'monobook':
421 \$wgDefaultSkin = \"{$this->values['wgDefaultSkin']}\";
422 ";
423  }
424 }
writeFile( $fileName)
Write the generated LocalSettings to a file.
Class for generating LocalSettings.php file.
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
Definition: hooks.txt:1982
skin txt MediaWiki includes four core skins
Definition: skin.txt:5
__construct(Installer $installer)
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
getDBInstaller( $type=false)
Get an instance of DatabaseInstaller for the specified DB type.
Definition: Installer.php:572
setGroupRights( $group, $rightsArr)
For $wgGroupPermissions, set a given [&#39;group&#39;][&#39;permission&#39;] value.
getVar( $name, $default=null)
Get an MW configuration variable, or internal installer configuration variable.
Definition: Installer.php:541
wfBoolToStr( $value)
Convenience function converts boolean values into "true" or "false" (string) values.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
generateExtEnableLine( $dir, $name)
Generate the appropriate line to enable the given extension or skin.
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
Definition: injection.txt:35
Base installer class.
Definition: Installer.php:46
static escapePhpString( $string)
Returns the escaped version of a string of php code.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
getText()
Return the full text of the generated LocalSettings.php file, including the extensions and skins...
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible values
Definition: hooks.txt:175