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