includes/installer/LocalSettingsGenerator.php

   1 <?php
   2 /**
   3  * Generator for LocalSettings.php file.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup Deployment
  22  */
  23
  24 /**
  25  * Class for generating LocalSettings.php file.
  26  *
  27  * @ingroup Deployment
  28  * @since 1.17
  29  */
  30 class LocalSettingsGenerator {
  31
  32         protected $extensions = [];
  33         protected $values = [];
  34         protected $groupPermissions = [];
  35         protected $dbSettings = '';
  36         protected $IP;
  37
  38         /**
  39          * @var Installer
  40          */
  41         protected $installer;
  42
  43         /**
  44          * @param Installer $installer
  45          */
  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
  95         /**
  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          *   [ 'right' => true, 'right2' => false ]
 100          */
 101         public function setGroupRights( $group, $rightsArr ) {
 102                 $this->groupPermissions[$group] = $rightsArr;
 103         }
 104
 105         /**
 106          * Returns the escaped version of a string of php code.
 107          *
 108          * @param string $string
 109          *
 110          * @return string|false
 111          */
 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
 130         /**
 131          * Return the full text of the generated LocalSettings.php file,
 132          * including the extensions and skins.
 133          *
 134          * @return string
 135          */
 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
 172         /**
 173          * Generate the appropriate line to enable the given extension or skin
 174          *
 175          * @param string $dir Either "extensions" or "skins"
 176          * @param string $name Name of extension/skin
 177          * @throws InvalidArgumentException
 178          * @return string
 179          */
 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
 200         /**
 201          * Write the generated LocalSettings to a file
 202          *
 203          * @param string $fileName Full path to filename to write to
 204          */
 205         public function writeFile( $fileName ) {
 206                 file_put_contents( $fileName, $this->getText() );
 207         }
 208
 209         /**
 210          * @return string
 211          */
 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
 230         /**
 231          * @return string
 232          */
 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
 303                 return "<?php
 304 # This file was automatically generated by the MediaWiki {$GLOBALS['wgVersion']}
 305 # installer. If you make manual changes, please keep track in case you
 306 # need to recreate them later.
 307 #
 308 # See includes/DefaultSettings.php for all configurable settings
 309 # and their default values, but don't forget to make changes in _this_
 310 # file, not there.
 311 #
 312 # Further documentation for configuration settings may be found at:
 313 # https://www.mediawiki.org/wiki/Manual:Configuration_settings
 314
 315 # Protect against web entry
 316 if ( !defined( 'MEDIAWIKI' ) ) {
 317         exit;
 318 }
 319
 320 ## Uncomment this to disable output compression
 321 # \$wgDisableOutputCompression = true;
 322
 323 \$wgSitename = \"{$this->values['wgSitename']}\";
 324 {$metaNamespace}
 325 ## The URL base path to the directory containing the wiki;
 326 ## defaults for all runtime URL paths are based off of this.
 327 ## For more information on customizing the URLs
 328 ## (like /w/index.php/Page_title to /wiki/Page_title) please see:
 329 ## https://www.mediawiki.org/wiki/Manual:Short_URL
 330 \$wgScriptPath = \"{$this->values['wgScriptPath']}\";
 331 ${serverSetting}
 332
 333 ## The URL path to static resources (images, scripts, etc.)
 334 \$wgResourceBasePath = \$wgScriptPath;
 335
 336 ## The URL path to the logo.  Make sure you change this from the default,
 337 ## or else you'll overwrite your logo when you upgrade!
 338 \$wgLogo = \"{$this->values['wgLogo']}\";
 339
 340 ## UPO means: this is also a user preference option
 341
 342 \$wgEnableEmail = {$this->values['wgEnableEmail']};
 343 \$wgEnableUserEmail = {$this->values['wgEnableUserEmail']}; # UPO
 344
 345 \$wgEmergencyContact = \"{$this->values['wgEmergencyContact']}\";
 346 \$wgPasswordSender = \"{$this->values['wgPasswordSender']}\";
 347
 348 \$wgEnotifUserTalk = {$this->values['wgEnotifUserTalk']}; # UPO
 349 \$wgEnotifWatchlist = {$this->values['wgEnotifWatchlist']}; # UPO
 350 \$wgEmailAuthentication = {$this->values['wgEmailAuthentication']};
 351
 352 ## Database settings
 353 \$wgDBtype = \"{$this->values['wgDBtype']}\";
 354 \$wgDBserver = \"{$this->values['wgDBserver']}\";
 355 \$wgDBname = \"{$this->values['wgDBname']}\";
 356 \$wgDBuser = \"{$this->values['wgDBuser']}\";
 357 \$wgDBpassword = \"{$this->values['wgDBpassword']}\";
 358
 359 {$this->dbSettings}
 360
 361 ## Shared memory settings
 362 \$wgMainCacheType = $cacheType;
 363 \$wgMemCachedServers = $mcservers;
 364
 365 ## To enable image uploads, make sure the 'images' directory
 366 ## is writable, then set this to true:
 367 \$wgEnableUploads = {$this->values['wgEnableUploads']};
 368 {$magic}\$wgUseImageMagick = true;
 369 {$magic}\$wgImageMagickConvertCommand = \"{$this->values['wgImageMagickConvertCommand']}\";
 370
 371 # InstantCommons allows wiki to use images from https://commons.wikimedia.org
 372 \$wgUseInstantCommons = {$this->values['wgUseInstantCommons']};
 373
 374 # Periodically send a pingback to https://www.mediawiki.org/ with basic data
 375 # about this MediaWiki instance. The Wikimedia Foundation shares this data
 376 # with MediaWiki developers to help guide future development efforts.
 377 \$wgPingback = {$this->values['wgPingback']};
 378
 379 ## If you use ImageMagick (or any other shell command) on a
 380 ## Linux server, this will need to be set to the name of an
 381 ## available UTF-8 locale
 382 {$locale}\$wgShellLocale = \"{$this->values['wgShellLocale']}\";
 383
 384 ## Set \$wgCacheDirectory to a writable directory on the web server
 385 ## to make your wiki go slightly faster. The directory should not
 386 ## be publically accessible from the web.
 387 #\$wgCacheDirectory = \"\$IP/cache\";
 388
 389 # Site language code, should be one of the list in ./languages/data/Names.php
 390 \$wgLanguageCode = \"{$this->values['wgLanguageCode']}\";
 391
 392 \$wgSecretKey = \"{$this->values['wgSecretKey']}\";
 393
 394 # Changing this will log out all existing sessions.
 395 \$wgAuthenticationTokenVersion = \"{$this->values['wgAuthenticationTokenVersion']}\";
 396
 397 # Site upgrade key. Must be set to a string (default provided) to turn on the
 398 # web installer while LocalSettings.php is in place
 399 \$wgUpgradeKey = \"{$this->values['wgUpgradeKey']}\";
 400
 401 ## For attaching licensing metadata to pages, and displaying an
 402 ## appropriate copyright notice / icon. GNU Free Documentation
 403 ## License and Creative Commons licenses are supported so far.
 404 \$wgRightsPage = \"\"; # Set to the title of a wiki page that describes your license/copyright
 405 \$wgRightsUrl = \"{$this->values['wgRightsUrl']}\";
 406 \$wgRightsText = \"{$this->values['wgRightsText']}\";
 407 \$wgRightsIcon = \"{$this->values['wgRightsIcon']}\";
 408
 409 # Path to the GNU diff3 utility. Used for conflict resolution.
 410 \$wgDiff3 = \"{$this->values['wgDiff3']}\";
 411
 412 {$groupRights}{$noFollow}## Default skin: you can change the default skin. Use the internal symbolic
 413 ## names, ie 'vector', 'monobook':
 414 \$wgDefaultSkin = \"{$this->values['wgDefaultSkin']}\";
 415 ";
 416         }
 417 }