X-Git-Url: https://scripts.mit.edu/gitweb/wizard.git/blobdiff_plain/bf58b59267060bdb462476d824b086131b444cd4..5f835f44034f079fe644879e8c27580a48e937cd:/wizard/app/mediawiki.py

diff --git a/wizard/app/mediawiki.py b/wizard/app/mediawiki.py
index 7ae7583..83018ce 100644
--- a/wizard/app/mediawiki.py
+++ b/wizard/app/mediawiki.py
@@ -1,26 +1,248 @@
 import re
+import distutils.version
+import os
+import lxml.cssselect
+import lxml.etree
+import StringIO
+import logging
 
-from wizard import app, deploy, util
+from wizard import app, install, resolve, shell, sql, util
 from wizard.app import php
 
-@app.filename_regex_extractor
-def make_extractor(var):
-    return 'LocalSettings.php', re.compile('^\$' + re.escape(var) + r'''\s*=\s*((["\']).*\2);$''', re.M)
-
-class Application(deploy.Application):
-    @property
-    def extractors(self):
-        if not self._extractors:
-            self._extractors = util.dictmap(make_extractor,
-                {'WIZARD_IP': 'IP' # obsolete
-                ,'WIZARD_SITENAME': 'wgSitename'
-                ,'WIZARD_SCRIPTPATH': 'wgScriptPath'
-                ,'WIZARD_EMERGENCYCONTACT': 'wgEmergencyContact'
-                ,'WIZARD_DBSERVER': 'wgDBserver'
-                ,'WIZARD_DBNAME': 'wgDBname'
-                ,'WIZARD_DBUSER': 'wgDBuser'
-                ,'WIZARD_DBPASSWORD': 'wgDBpassword'
-                ,'WIZARD_PROXYKEY': 'wgProxyKey'
-                })
-            self._extractors.update(php.extractors)
-        return self._extractors
+# Note: Maintenance script exit codes
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# MediaWiki has notoriously spotty support for exit codes.  It has
+# gotten better, but there are still always cases that slip through,
+# such as <https://bugzilla.wikimedia.org/show_bug.cgi?id=29588>.
+# As a result, we check both for exit codes AND for the "success"
+# message in stdout.
+
+def make_filename_regex(var):
+    """See :ref:`versioning config <seed>` for more information."""
+    return 'LocalSettings.php', php.re_var(var)
+
+seed = util.dictmap(make_filename_regex, {
+        'WIZARD_IP': 'IP', # obsolete, remove after we're done
+        'WIZARD_SITENAME': 'wgSitename',
+        'WIZARD_META_NAMESPACE': 'wgMetaNamespace',
+        'WIZARD_SCRIPTPATH': 'wgScriptPath',
+        'WIZARD_SERVER': 'wgServer',
+        'WIZARD_EMERGENCYCONTACT': ('wgEmergencyContact', 'wgPasswordSender'),
+        'WIZARD_DBSERVER': 'wgDBserver',
+        'WIZARD_DBNAME': 'wgDBname',
+        'WIZARD_DBUSER': 'wgDBuser',
+        'WIZARD_DBPASSWORD': 'wgDBpassword',
+        'WIZARD_SECRETKEY': ('wgSecretKey', 'wgProxyKey'),
+        'WIZARD_UPGRADEKEY': 'wgUpgradeKey',
+        })
+
+class Application(app.Application):
+    fullname = "MediaWiki"
+    database = "mysql"
+    parametrized_files = ['LocalSettings.php'] + php.parametrized_files
+    deprecated_keys = set(['WIZARD_IP']) | php.deprecated_keys
+    extractors = app.make_extractors(seed)
+    extractors.update(php.extractors)
+    substitutions = app.make_substitutions(seed)
+    substitutions.update(php.substitutions)
+    install_schema = install.ArgSchema("db", "admin", "email", "title")
+    random_keys = set(['WIZARD_SECRETKEY', 'WIZARD_UPGRADEKEY'])
+    def download(self, version):
+        series = ".".join(str(version).split(".")[:2])
+        return "http://download.wikimedia.org/mediawiki/%s/mediawiki-%s.tar.gz" % (series, version)
+    def checkConfig(self, deployment):
+        return os.path.isfile("LocalSettings.php")
+    def detectVersion(self, deployment):
+        return self.detectVersionFromFile("includes/DefaultSettings.php", php.re_var("wgVersion"))
+    def checkWeb(self, deployment):
+        return self.checkWebPage(deployment, "/index.php?title=Main_Page", outputs=["<!-- Served"])
+    def install(self, version, options):
+        php.ini_replace_vars()
+        if version >= distutils.version.LooseVersion("1.17.0"):
+            self.install_1_17_0(options)
+        else:
+            self.install_old(options)
+    def install_1_17_0(self, options):
+        util.soft_unlink("LocalSettings.php")
+        if os.path.exists("math"):
+            with util.ChangeDirectory("math"):
+                shell.call("make")
+        try:
+            result = shell.eval(
+                    "php", "-c", ".", "maintenance/install.php",
+                    "--dbname", options.dsn.database,
+                    "--dbpass", options.dsn.password,
+                    "--dbserver", options.dsn.host,
+                    "--dbuser", options.dsn.username,
+                    "--email", options.email,
+                    "--pass", options.admin_password,
+                    "--server", "https://" + options.web_host,
+                    "--scriptpath", options.web_path,
+                    options.title, options.admin_name,
+                    log=True)
+        except shell.CallError as e:
+            raise app.RecoverableInstallFailure(["Install script returned non-zero exit code\nSTDOUT: %s\nSTDERR: %s" % (e.stdout, e.stderr)])
+        logging.debug("Install script output:\n\n" + result)
+        # See [Note: Maintenance script exit codes]
+        results = result.rstrip().split()
+        if not results or not results[-1] == "done":
+            raise app.RecoverableInstallFailure([result])
+
+    def install_old(self, options):
+        util.soft_unlink("LocalSettings.php")
+        os.chmod("config", 0777) # XXX: vaguely sketchy
+
+        postdata = {
+            'Sitename': options.title,
+            'EmergencyContact': options.email,
+            'LanguageCode': 'en',
+            'DBserver': options.dsn.host,
+            'DBname': options.dsn.database,
+            'DBuser': options.dsn.username,
+            'DBpassword': options.dsn.password,
+            'DBpassword2': options.dsn.password,
+            'defaultEmail': options.email,
+            'SysopName': options.admin_name,
+            'SysopPass': options.admin_password,
+            'SysopPass2': options.admin_password,
+            }
+        result = install.fetch(options, '/config/index.php', post=postdata)
+        result_etree = lxml.etree.parse(StringIO.StringIO(result), lxml.etree.HTMLParser())
+        selector = lxml.cssselect.CSSSelector(".error")
+        error_messages = [e.text for e in selector(result_etree)]
+        logging.debug("Installation output:\n\n" + result)
+        if result.find("Installation successful") == -1:
+            if not error_messages:
+                raise app.InstallFailure()
+            else:
+                raise app.RecoverableInstallFailure(error_messages)
+        os.rename('config/LocalSettings.php', 'LocalSettings.php')
+
+    def upgrade(self, d, version, options):
+        if not os.path.isfile("AdminSettings.php"):
+            shell.call("git", "checkout", "-q", "mediawiki-" + str(version), "--", "AdminSettings.php")
+        if os.path.exists("math"):
+            with util.ChangeDirectory("math"):
+                shell.call("make")
+        try:
+            result = shell.eval("php", "maintenance/update.php", "--quick", log=True)
+        except shell.CallError as e:
+            raise app.UpgradeFailure("Update script returned non-zero exit code\nSTDOUT: %s\nSTDERR: %s" % (e.stdout, e.stderr))
+        logging.debug("Upgrade script output:\n\n" + result)
+        # See [Note: Maintenance script exit codes]
+        results = result.rstrip().split()
+        if not results or not results[-1] == "Done.":
+            raise app.UpgradeFailure(result)
+    @app.throws_database_errors
+    def backup(self, deployment, backup_dir, options):
+        sql.backup(backup_dir, deployment)
+    @app.throws_database_errors
+    def restore(self, deployment, backup_dir, options):
+        sql.restore(backup_dir, deployment)
+    @app.throws_database_errors
+    def remove(self, deployment, options):
+        sql.drop(deployment.dsn)
+    def researchFilter(self, filename, added, deleted):
+        if filename == "LocalSettings.php":
+            return added == deleted == 10 or added == deleted == 9
+        elif filename == "AdminSettings.php":
+            return added == 0 and deleted == 20
+        elif filename == "config/index.php" or filename == "config/index.php5":
+            return added == 0
+        return False
+
+Application.resolutions = {
+'LocalSettings.php': [
+    ("""
+<<<<<<<
+***1***
+=======
+## The URL base path to the directory containing the wiki;
+## defaults for all runtime URL paths are based off of this.
+## For more information on customizing the URLs please see:
+## http://www.mediawiki.org/wiki/Manual:Short_URL
+***2***
+$wgScriptExtension  = ".php";
+
+## UPO means: this is also a user preference option
+>>>>>>>
+""", [-1]),
+    ("""
+<<<<<<<
+***1***
+=======
+
+# MySQL specific settings
+$wgDBprefix         = "";
+>>>>>>>
+""", ["\n# MySQL specific settings", 1]),
+    ("""
+<<<<<<<
+## is writable, then uncomment this:
+***1***
+=======
+## is writable, then set this to true:
+$wgEnableUploads       = false;
+>>>>>>>
+""", [-1]),
+    ("""
+<<<<<<<
+***1***
+$wgMathPath         = "{$wgUploadPath}/math";
+$wgMathDirectory    = "{$wgUploadDirectory}/math";
+$wgTmpDirectory     = "{$wgUploadDirectory}/tmp";
+=======
+$wgUseTeX           = false;
+>>>>>>>
+""", [1]),
+    # order of these rules is important
+    ("""
+<<<<<<<
+$configdate = gmdate( 'YmdHis', @filemtime( __FILE__ ) );
+$wgCacheEpoch = max( $wgCacheEpoch, $configdate );
+***1***
+?>
+=======
+$wgCacheEpoch = max( $wgCacheEpoch, gmdate( 'YmdHis', @filemtime( __FILE__ ) ) );
+>>>>>>>
+""", [0, 1]),
+    ("""
+<<<<<<<
+$configdate = gmdate( 'YmdHis', @filemtime( __FILE__ ) );
+$wgCacheEpoch = max( $wgCacheEpoch, $configdate );
+***1***
+=======
+$wgCacheEpoch = max( $wgCacheEpoch, gmdate( 'YmdHis', @filemtime( __FILE__ ) ) );
+>>>>>>>
+""", [0, 1]),
+    ("""
+<<<<<<<
+?>
+=======
+# When you make changes to this configuration file, this will make
+# sure that cached pages are cleared.
+$wgCacheEpoch = max( $wgCacheEpoch, gmdate( 'YmdHis', @filemtime( __FILE__ ) ) );
+>>>>>>>
+""", [0]),
+    ("""
+<<<<<<<
+***1***
+?>
+=======
+# When you make changes to this configuration file, this will make
+# sure that cached pages are cleared.
+$wgCacheEpoch = max( $wgCacheEpoch, gmdate( 'YmdHis', @filemtime( __FILE__ ) ) );
+>>>>>>>
+""", [1, 0]),
+    ("""
+<<<<<<<
+***1***
+=======
+# When you make changes to this configuration file, this will make
+# sure that cached pages are cleared.
+$wgCacheEpoch = max( $wgCacheEpoch, gmdate( 'YmdHis', @filemtime( __FILE__ ) ) );
+>>>>>>>
+""", [1, 0]),
+    ]
+}
+