Change the way installer overrides work
authorMax Semenik <maxsem.wiki@gmail.com>
Thu, 19 May 2016 00:40:56 +0000 (17:40 -0700)
committerLegoktm <legoktm.wikipedia@gmail.com>
Thu, 9 Jun 2016 17:05:35 +0000 (17:05 +0000)
Instead of "don't edit this file, edit that file", do it settings.d
style where packagers can drop their stuff in mw-config/overrides.

I propose to backport it to 1.27 because LTS.

Bug: T135695
Change-Id: I2661ba2036b2887d31ab356751d731cc8b499f26

RELEASE-NOTES-1.27
autoload.php
includes/installer/Installer.php
includes/installer/InstallerOverrides.php [new file with mode: 0644]
mw-config/overrides.php [deleted file]
mw-config/overrides/README [new file with mode: 0644]

index e644ae4..3aa5d7c 100644 (file)
@@ -536,6 +536,8 @@ changes to languages because of Phabricator reports.
 * User::isPasswordReminderThrottled() was deprecated.
 * Bot-oriented parameters to Special:UserLogin (wpCookieCheck, wpSkipCookieCheck)
   were removed.
+* Installer can now be customized without patching MediaWiki code, see
+  mw-config/overrides/README for details.
 
 == Compatibility ==
 
index 27da2ca..f40cc89 100644 (file)
@@ -603,7 +603,7 @@ $wgAutoloadLocalClasses = [
        'InitSiteStats' => __DIR__ . '/maintenance/initSiteStats.php',
        'InstallDocFormatter' => __DIR__ . '/includes/installer/InstallDocFormatter.php',
        'Installer' => __DIR__ . '/includes/installer/Installer.php',
-       'InstallerOverrides' => __DIR__ . '/mw-config/overrides.php',
+       'InstallerOverrides' => __DIR__ . '/includes/installer/InstallerOverrides.php',
        'InstallerSessionProvider' => __DIR__ . '/includes/installer/InstallerSessionProvider.php',
        'Interwiki' => __DIR__ . '/includes/interwiki/Interwiki.php',
        'InvalidPassword' => __DIR__ . '/includes/password/InvalidPassword.php',
@@ -936,7 +936,6 @@ $wgAutoloadLocalClasses = [
        'MutableConfig' => __DIR__ . '/includes/config/MutableConfig.php',
        'MutableContext' => __DIR__ . '/includes/context/MutableContext.php',
        'MwSql' => __DIR__ . '/maintenance/sql.php',
-       'MyLocalSettingsGenerator' => __DIR__ . '/mw-config/overrides.php',
        'MySQLField' => __DIR__ . '/includes/db/DatabaseMysqlBase.php',
        'MySQLMasterPos' => __DIR__ . '/includes/db/DatabaseMysqlBase.php',
        'MySqlLockManager' => __DIR__ . '/includes/filebackend/lockmanager/DBLockManager.php',
index ae1a2a7..7c161ca 100644 (file)
@@ -2,6 +2,9 @@
 /**
  * Base code for MediaWiki installer.
  *
+ * DO NOT PATCH THIS FILE IF YOU NEED TO CHANGE INSTALLER BEHAVIOR IN YOUR PACKAGE!
+ * See mw-config/overrides/README for details.
+ *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
diff --git a/includes/installer/InstallerOverrides.php b/includes/installer/InstallerOverrides.php
new file mode 100644 (file)
index 0000000..eba3a20
--- /dev/null
@@ -0,0 +1,76 @@
+<?php
+/**
+ * MediaWiki installer overrides. See mw-config/overrides/README for details.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * @since 1.20
+ */
+class InstallerOverrides {
+       private static function getOverrides() {
+               global $IP;
+               static $overrides;
+
+               if ( !$overrides ) {
+                       $overrides = [
+                               'LocalSettingsGenerator' => 'LocalSettingsGenerator',
+                               'WebInstaller' => 'WebInstaller',
+                               'CliInstaller' => 'CliInstaller',
+                       ];
+                       foreach ( glob( "$IP/mw-config/overrides/*.php" ) as $file ) {
+                               require $file;
+                       }
+               }
+
+               return $overrides;
+       }
+
+       /**
+        * Instantiates and returns an instance of LocalSettingsGenerator or its descendant classes
+        * @param Installer $installer
+        * @return LocalSettingsGenerator
+        */
+       public static function getLocalSettingsGenerator( Installer $installer ) {
+               $className = self::getOverrides()['LocalSettingsGenerator'];
+               return new $className( $installer );
+       }
+
+       /**
+        * Instantiates and returns an instance of WebInstaller or its descendant classes
+        * @param WebRequest $request
+        * @return WebInstaller
+        */
+       public static function getWebInstaller( WebRequest $request ) {
+               $className = self::getOverrides()['WebInstaller'];
+               return new $className( $request );
+       }
+
+       /**
+        * Instantiates and returns an instance of CliInstaller or its descendant classes
+        * @param string $siteName
+        * @param string|null $admin
+        * @param array $options
+        * @return CliInstaller
+        */
+       public static function getCliInstaller( $siteName, $admin = null, array $options = [] ) {
+               $className = self::getOverrides()['CliInstaller'];
+               return new $className( $siteName, $admin, $options );
+       }
+}
diff --git a/mw-config/overrides.php b/mw-config/overrides.php
deleted file mode 100644 (file)
index 3dfecaa..0000000
+++ /dev/null
@@ -1,81 +0,0 @@
-<?php
-/**
- * MediaWiki installer overrides.
- * Modify this file if you are a packager who needs to modify the behavior of
- * the MediaWiki installer. Altering it is preferred over changing anything in
- * /includes.
- *
- * Note: this file doesn't gets included from a global scope, don't use globals directly.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * http://www.gnu.org/copyleft/gpl.html
- *
- * @file
- */
-
-/*
-
-Example of modifications:
-
-       public static function getLocalSettingsGenerator( Installer $installer ) {
-               return new MyLocalSettingsGenerator( $installer );
-       }
-
-Then add the following to the bottom of this file:
-
-class MyLocalSettingsGenerator extends LocalSettingsGenerator {
-       function getText() {
-               // Modify an existing setting
-               $this->values['wgDefaultSkin'] = 'vector';
-               // add a new setting
-               $ls = parent::getText();
-               return $ls . "\n\$wgUseTex = true;\n";
-       }
-}
-*/
-
-/**
- * @since 1.20
- */
-class InstallerOverrides {
-       /**
-        * Instantiates and returns an instance of LocalSettingsGenerator or its descendant classes
-        * @param Installer $installer
-        * @return LocalSettingsGenerator
-        */
-       public static function getLocalSettingsGenerator( Installer $installer ) {
-               return new LocalSettingsGenerator( $installer );
-       }
-
-       /**
-        * Instantiates and returns an instance of WebInstaller or its descendant classes
-        * @param WebRequest $request
-        * @return WebInstaller
-        */
-       public static function getWebInstaller( WebRequest $request ) {
-               return new WebInstaller( $request );
-       }
-
-       /**
-        * Instantiates and returns an instance of CliInstaller or its descendant classes
-        * @param string $siteName
-        * @param string|null $admin
-        * @param array $options
-        * @return CliInstaller
-        */
-       public static function getCliInstaller( $siteName, $admin = null, array $options = [] ) {
-               return new CliInstaller( $siteName, $admin, $options );
-       }
-}
diff --git a/mw-config/overrides/README b/mw-config/overrides/README
new file mode 100644 (file)
index 0000000..f251330
--- /dev/null
@@ -0,0 +1,22 @@
+Don't modify the installer if you want to alter its behavior, including
+the contents of generated LocalSettings.php in your package. Instead,
+you can override classes used by the installer.
+
+You can override 3 classes:
+* LocalSettingsGenerator - generates LocalSettings.php
+* WebInstaller - web instller UI
+* CliInstaller - command line installer
+
+Example override:
+
+$overrides['LocalSettingsGenerator'] = 'MyLocalSettingsGenerator';
+
+class MyLocalSettingsGenerator extends LocalSettingsGenerator {
+       function getText() {
+               // Modify an existing setting
+               $this->values['wgDefaultSkin'] = 'vector';
+               // add a new setting
+               $ls = parent::getText();
+               return $ls . "\n\$wgMiserMode = true;\n";
+       }
+}