import re
import distutils.version
import os
+import lxml.cssselect
+import lxml.etree
+import StringIO
+import logging
-from wizard import app, install, resolve, shell, util
+from wizard import app, install, resolve, shell, sql, util
from wizard.app import php
+# 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, {
})
class Application(app.Application):
- parametrized_files = ['LocalSettings.php', 'php.ini']
+ 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("mysql", "admin", "email", "title")
+ install_schema = install.ArgSchema("db", "admin", "email", "title")
+ 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):
- contents = deployment.read("includes/DefaultSettings.php")
- regex = php.re_var("wgVersion")
- match = regex.search(contents)
- if not match: return None
- return distutils.version.LooseVersion(match.group(2)[1:-1])
- def checkWeb(self, deployment, out=None):
- page = deployment.fetch("/index.php?title=Main_Page")
- if type(out) is list:
- out.append(page)
- return page.find("<!-- Served") != -1
- def prepareMerge(self, deployment):
- resolve.fix_newlines("LocalSettings.php")
+ 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):
+ 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")
try:
- os.unlink("LocalSettings.php")
- except OSError:
- pass
+ result = shell.eval(
+ "php", "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,
+ 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.mysql_host,
- 'DBname': options.mysql_db,
- 'DBuser': options.mysql_user,
- 'DBpassword': options.mysql_password,
- 'DBpassword2': options.mysql_password,
+ '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)
- if options.verbose or options.debug: print result
+ 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:
- raise install.Failure()
+ if not error_messages:
+ raise app.InstallFailure()
+ else:
+ raise app.RecoverableInstallFailure(error_messages)
os.rename('config/LocalSettings.php', 'LocalSettings.php')
+ php.ini_replace_vars()
+
def upgrade(self, d, version, options):
- sh = shell.Shell()
if not os.path.isfile("AdminSettings.php"):
- sh.call("git", "checkout", "-q", "mediawiki-" + str(version), "--", "AdminSettings.php")
+ shell.call("git", "checkout", "-q", "mediawiki-" + str(version), "--", "AdminSettings.php")
try:
- result = sh.eval("php", "maintenance/update.php", "--quick", log=True)
+ 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):
- app.backup_database(backup_dir, deployment)
+ sql.backup(backup_dir, deployment)
+ @app.throws_database_errors
def restore(self, deployment, backup_dir, options):
- app.restore_database(backup_dir, deployment)
+ 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': [