import re
import distutils.version
import decorator
+import shlex
import wizard
-from wizard import util
+from wizard import scripts, shell, util
_application_list = [
"mediawiki", "wordpress", "joomla", "e107", "gallery2",
#: Keys that are used in older versions of the application, but
#: not for the most recent version.
deprecated_keys = []
+ #: Dictionary of variable names to extractor functions. These functions
+ #: take a :class:`wizard.deploy.Deployment` as an argument and return the value of
+ #: the variable, or ``None`` if it could not be found.
+ #: See also :func:`filename_regex_extractor`.
+ extractors = {}
+ #: Dictionary of variable names to substitution functions. These functions
+ #: take a :class:`wizard.deploy.Deployment` as an argument and modify the deployment such
+ #: that an explicit instance of the variable is released with the generic
+ #: ``WIZARD_*`` constant. See also :func:`filename_regex_substitution`.
+ substitutions = {}
+ #: Dictionary of file names to a list of resolutions, which are tuples of
+ #: a conflict marker string and a result list. See :mod:`wizard.resolve`
+ #: for more information.
+ resolutions = {}
def __init__(self, name):
self.name = name
self.versions = {}
for k,extractor in self.extractors.items():
result[k] = extractor(deployment)
return result
- def parametrize(self, deployment):
+ def parametrize(self, deployment, ref_deployment):
"""
Takes a generic source checkout and parametrizes it according to the
values of ``deployment``. This function operates on the current
:attr:`parametrized_files` and a simple search and replace on those
files.
"""
- variables = deployment.extract()
+ variables = ref_deployment.extract()
for file in self.parametrized_files:
try:
contents = open(file, "r").read()
"""
Resolves conflicted files in the current working directory. Returns
whether or not all conflicted files were resolved or not. Fully
- resolved files are added to the index, but no commit is made. By
- default this is a no-op and returns ``False``; subclasses should
- replace this with useful behavior.
- """
- return False
+ resolved files are added to the index, but no commit is made. The
+ default implementation uses :attr:`resolutions`.
+ """
+ resolved = True
+ sh = shell.Shell()
+ for status in sh.eval("git", "ls-files", "--unmerged").splitlines():
+ file = status.split()[-1]
+ if file in self.resolutions:
+ contents = open(file, "r").read()
+ for spec, result in self.resolutions[file]:
+ old_contents = contents
+ contents = resolve.resolve(contents, spec, result)
+ if old_contents != contents:
+ logging.info("Did resolution with spec:\n" + spec)
+ open(file, "w").write(contents)
+ if not resolve.is_conflict(contents):
+ sh.call("git", "add", file)
+ else:
+ resolved = False
+ else:
+ resolved = False
+ return resolved
def prepareMerge(self, deployment):
"""
Performs various edits to files in the current working directory in
deployment. Subclasses should provide an implementation.
"""
raise NotImplemented
- def backup(self, deployment, options):
+ def backup(self, deployment, outdir, options):
"""
Run for 'wizard backup' and upgrades to backup database schemas
- and other non-versioned data in an application. This assumes
+ and other non-versioned data in an application. ``outdir`` is
+ the directory that backup files should be placed. This assumes
that the current working directory is the deployment. Subclasses
- should provide an implementation.
+ should provide an implementation, even if it is a no-op.
.. note::
Static user files may not need to be backed up, since in
many applications upgrades do not modify static files.
"""
raise NotImplemented
- def restore(self, deployment, backup, options):
+ def restore(self, deployment, backup_dir, options):
"""
Run for 'wizard restore' and failed upgrades to restore database
and other non-versioned data to a backed up version. This assumes
Subclasses should provide an implementation.
"""
raise NotImplemented
- @property
- def extractors(self):
- """
- Dictionary of variable names to extractor functions. These functions
- take a :class:`wizard.deploy.Deployment` as an argument and return the value of
- the variable, or ``None`` if it could not be found.
- See also :func:`filename_regex_extractor`.
- """
- return {}
- @property
- def substitutions(self):
- """
- Dictionary of variable names to substitution functions. These functions
- take a :class:`wizard.deploy.Deployment` as an argument and modify the deployment such
- that an explicit instance of the variable is released with the generic
- WIZARD_* constant. See also :func:`filename_regex_substitution`.
- """
- return {}
@staticmethod
def make(name):
"""Makes an application, but uses the correct subtype if available."""
return subs
return h
+def backup_database(outdir, deployment):
+ """
+ Generic database backup function. Assumes that ``WIZARD_DBNAME``
+ is extractable, and that :func:`wizard.scripts.get_sql_credentials`
+ works.
+ """
+ sh = shell.Shell()
+ outfile = os.path.join(outdir, "db.sql")
+ try:
+ sh.call("mysqldump", "--compress", "-r", outfile, *get_mysql_args(deployment))
+ sh.call("gzip", "--best", outfile)
+ except shell.CallError as e:
+ shutil.rmtree(outdir)
+ raise BackupFailure(e.stderr)
+
+def restore_database(backup_dir, deployment):
+ sh = shell.Shell()
+ if not os.path.exists(backup_dir):
+ raise RestoreFailure("Backup %s doesn't exist", backup_dir.rpartition("/")[2])
+ sql = open(os.path.join(backup_dir, "db.sql"), 'w+')
+ sh.call("gunzip", "-c", os.path.join(backup_dir, "db.sql.gz"), stdout=sql)
+ sql.seek(0)
+ sh.call("mysql", *get_mysql_args(deployment), stdin=sql)
+ sql.close()
+
+def get_mysql_args(d):
+ # XXX: add support for getting these out of options
+ vars = d.extract()
+ if 'WIZARD_DBNAME' not in vars:
+ raise app.BackupFailure("Could not determine database name")
+ triplet = scripts.get_sql_credentials(vars)
+ args = []
+ if triplet is not None:
+ server, user, password = triplet
+ args += ["-h", server, "-u", user, "-p" + password]
+ name = shlex.split(vars['WIZARD_DBNAME'])[0]
+ args.append(name)
+ return args
+
class Error(wizard.Error):
"""Generic error class for this module."""
pass
'WIZARD_SECRETKEY': ('wgSecretKey', 'wgProxyKey'),
})
-resolutions = {
+class Application(app.Application):
+ parametrized_files = ['LocalSettings.php', 'php.ini']
+ 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)
+ @property
+ def install_handler(self):
+ handler = install.ArgHandler("mysql", "admin", "email")
+ handler.add(install.Arg("title", help="Title of your new MediaWiki install"))
+ return handler
+ def checkConfig(self, deployment):
+ return os.path.isfile(os.path.join(deployment.location, "LocalSettings.php"))
+ def detectVersion(self, deployment):
+ contents = deployment.read("includes/DefaultSettings.php")
+ regex = make_filename_regex("wgVersion")[1]
+ 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")
+ def install(self, version, options):
+ try:
+ os.unlink("LocalSettings.php")
+ except OSError:
+ pass
+
+ 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,
+ '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
+ if result.find("Installation successful") == -1:
+ raise install.Failure()
+ os.rename('config/LocalSettings.php', 'LocalSettings.php')
+ 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")
+ try:
+ result = sh.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))
+ results = result.rstrip().split()
+ if not results or not results[-1] == "Done.":
+ raise app.UpgradeFailure(result)
+ def backup(self, deployment, backup_dir, options):
+ app.backup_database(backup_dir, deployment)
+ def restore(self, deployment, backup_dir, options):
+ app.restore_database(backup_dir, deployment)
+
+Application.resolutions = {
'LocalSettings.php': [
("""
<<<<<<<
]
}
-class Application(app.Application):
- parametrized_files = ['LocalSettings.php', 'php.ini']
- deprecated_keys = set(['WIZARD_IP']) | php.deprecated_keys
- @property
- def extractors(self):
- if not self._extractors:
- self._extractors = app.make_extractors(seed)
- self._extractors.update(php.extractors)
- return self._extractors
- @property
- def substitutions(self):
- if not self._substitutions:
- self._substitutions = app.make_substitutions(seed)
- self._substitutions.update(php.substitutions)
- return self._substitutions
- @property
- def install_handler(self):
- handler = install.ArgHandler("mysql", "admin", "email")
- handler.add(install.Arg("title", help="Title of your new MediaWiki install"))
- return handler
- def checkConfig(self, deployment):
- return os.path.isfile(os.path.join(deployment.location, "LocalSettings.php"))
- def detectVersion(self, deployment):
- contents = deployment.read("includes/DefaultSettings.php")
- regex = make_filename_regex("wgVersion")[1]
- match = regex.search(contents)
- if not match: return None
- return distutils.version.LooseVersion(match.group(2)[1:-1])
- def checkWeb(self, d, out=None):
- page = d.fetch("/index.php?title=Main_Page")
- if type(out) is list:
- out.append(page)
- return page.find("<!-- Served") != -1
- def prepareMerge(self, dir):
- # XXX: this should be factored out
- old_contents = open("LocalSettings.php", "r").read()
- contents = old_contents
- while "\r\n" in contents:
- contents = contents.replace("\r\n", "\n")
- contents = contents.replace("\r", "\n")
- if contents != old_contents:
- logging.info("Converted LocalSettings.php to UNIX file endings")
- open("LocalSettings.php", "w").write(contents)
- def resolveConflicts(self, dir):
- # XXX: this is pretty generic
- resolved = True
- sh = shell.Shell()
- for status in sh.eval("git", "ls-files", "--unmerged").splitlines():
- file = status.split()[-1]
- if file in resolutions:
- contents = open(file, "r").read()
- for spec, result in resolutions[file]:
- old_contents = contents
- contents = resolve.resolve(contents, spec, result)
- if old_contents != contents:
- logging.info("Did resolution with spec:\n" + spec)
- open(file, "w").write(contents)
- if not resolve.is_conflict(contents):
- sh.call("git", "add", file)
- else:
- resolved = False
- else:
- resolved = False
- return resolved
- def install(self, version, options):
- try:
- os.unlink("LocalSettings.php")
- except OSError:
- pass
-
- 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,
- '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: print result
- if result.find("Installation successful") == -1:
- raise install.Failure()
- os.rename('config/LocalSettings.php', 'LocalSettings.php')
- 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")
- try:
- result = sh.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))
- results = result.rstrip().split()
- if not results or not results[-1] == "Done.":
- raise app.UpgradeFailure(result)
- def backup(self, deployment, options):
- sh = shell.Shell()
- # XXX: duplicate code, refactor, also, race condition
- backupdir = os.path.join(".scripts", "backups")
- backup = str(deployment.version) + "-" + datetime.date.today().isoformat()
- outdir = os.path.join(backupdir, backup)
- if not os.path.exists(backupdir):
- os.mkdir(backupdir)
- if os.path.exists(outdir):
- util.safe_unlink(outdir)
- os.mkdir(outdir)
- outfile = os.path.join(outdir, "db.sql")
- try:
- sh.call("mysqldump", "--compress", "-r", outfile, *get_mysql_args(deployment))
- sh.call("gzip", "--best", outfile)
- except shell.CallError as e:
- shutil.rmtree(outdir)
- raise app.BackupFailure(e.stderr)
- return backup
- def restore(self, deployment, backup, options):
- sh = shell.Shell()
- backup_dir = os.path.join(".scripts", "backups", backup)
- if not os.path.exists(backup_dir):
- raise app.RestoreFailure("Backup %s doesn't exist", backup)
- sql = open(os.path.join(backup_dir, "db.sql"), 'w+')
- sh.call("gunzip", "-c", os.path.join(backup_dir, "db.sql.gz"), stdout=sql)
- sql.seek(0)
- sh.call("mysql", *get_mysql_args(deployment), stdin=sql)
- sql.close()
-
-def get_mysql_args(d):
- # XXX: add support for getting these out of options
- vars = d.extract()
- if 'WIZARD_DBNAME' not in vars:
- raise app.BackupFailure("Could not determine database name")
- triplet = scripts.get_sql_credentials(vars)
- args = []
- if triplet is not None:
- server, user, password = triplet
- args += ["-h", server, "-u", user, "-p" + password]
- name = shlex.split(vars['WIZARD_DBNAME'])[0]
- args.append(name)
- return args
scripts.mit.edu / wizard.git / commitdiff
