Fix unreference variable.
[cdist.git] / cdist
diff --git a/cdist b/cdist
index 45a1573e5b0d9501f7b03e66431287340ec42cf4..682924413cc5f5001a300873ac20e38cff882ab6 100755 (executable)
--- a/cdist
+++ b/cdist
@@ -1,6 +1,6 @@
-#!/usr/bin/python
+#!/usr/bin/python3
 
-#    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+#    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
 #
 #    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
@@ -28,6 +28,9 @@ import subprocess
 import re
 import copy
 import inspect
+import getpass
+import shlex
+import multiprocessing
 
 TEMPORARY_DIRECTORY = '/var/tmp'
 
@@ -48,20 +51,27 @@ class Trees:
     def __init__(self):
         self.trees = []
 
-    def get(self, name, specifier, target):
+    def get(self, name, specifier, target, required_by=None):
         for t in self.trees:
             if t.name == name and t.specifier == specifier and t.target == target:
                 return t
             elif t.name == name and t.specifier != specifier:
-                raise Error('conflicting versions of %s requested (%s and %s)' % (name, specifier, t.specifier))
-
-        nt = Tree(name, specifier, target)
+                a = specifier if specifier is not None else "[Any]"
+                if required_by is not None:
+                    a += ' by %s' % required_by
+                b = t.specifier if t.specifier is not None else "[Any]"
+                if t.required_by is not None:
+                    b += ' by %s' % t.required_by
+                raise Error('conflicting versions of %s required (%s versus %s)' % (name, a, b))
+
+        nt = Tree(name, specifier, target, required_by)
         self.trees.append(nt)
         return nt
 
 class Globals:
     quiet = False
     command = None
+    dry_run = False
     trees = Trees()
 
 globals = Globals()
@@ -91,15 +101,31 @@ class BoolOption(object):
 
 class Config:
     def __init__(self):
-        self.options = [ Option('linux_chroot_prefix'),
-                         Option('windows_environment_prefix'),
-                         Option('mingw_prefix'),
+        self.options = [ Option('mxe_prefix'),
                          Option('git_prefix'),
-                         Option('osx_build_host'),
+                         Option('git_reference'),
                          Option('osx_environment_prefix'),
                          Option('osx_sdk_prefix'),
                          Option('osx_sdk'),
-                         Option('parallel', 4) ]
+                         Option('apple_id'),
+                         Option('apple_password'),
+                         BoolOption('docker_sudo'),
+                         BoolOption('docker_no_user'),
+                         Option('docker_hub_repository'),
+                         Option('flatpak_state_dir'),
+                         Option('parallel', multiprocessing.cpu_count()) ]
+
+        config_dir = '%s/.config' % os.path.expanduser('~')
+        if not os.path.exists(config_dir):
+            os.mkdir(config_dir)
+        config_file = '%s/cdist' % config_dir
+        if not os.path.exists(config_file):
+            f = open(config_file, 'w')
+            for o in self.options:
+                print('# %s ' % o.key, file=f)
+            f.close()
+            print('Template config file written to %s; please edit and try again.' % config_file, file=sys.stderr)
+            sys.exit(1)
 
         try:
             f = open('%s/.config/cdist' % os.path.expanduser('~'), 'r')
@@ -118,6 +144,12 @@ class Config:
         except:
             raise
 
+    def has(self, k):
+        for o in self.options:
+            if o.key == k and o.value is not None:
+                return True
+        return False
+
     def get(self, k):
         for o in self.options:
             if o.key == k:
@@ -129,17 +161,31 @@ class Config:
         for o in self.options:
             o.offer(k, v)
 
+    def docker(self):
+        if self.get('docker_sudo'):
+            return 'sudo docker'
+        else:
+            return 'docker'
+
 config = Config()
 
 #
 # Utility bits
 #
 
-def log(m):
+def log_normal(m):
     if not globals.quiet:
         print('\x1b[33m* %s\x1b[0m' % m)
 
+def log_verbose(m):
+    if globals.verbose:
+        print('\x1b[35m* %s\x1b[0m' % m)
+
+def escape_spaces(s):
+    return s.replace(' ', '\\ ')
+
 def scp_escape(n):
+    """Escape a host:filename string for use with an scp command"""
     s = n.split(':')
     assert(len(s) == 1 or len(s) == 2)
     if len(s) == 2:
@@ -147,40 +193,71 @@ def scp_escape(n):
     else:
         return '\"%s\"' % s[0]
 
+def mv_escape(n):
+    return '\"%s\"' % n.substr(' ', '\\ ')
+
 def copytree(a, b):
-    log('copy %s -> %s' % (scp_escape(b), scp_escape(b)))
-    command('scp -r %s %s' % (scp_escape(a), scp_escape(b)))
+    log_normal('copy %s -> %s' % (scp_escape(a), scp_escape(b)))
+    if b.startswith('s3://'):
+        command('s3cmd -P -r put "%s" "%s"' % (a, b))
+    else:
+        command('scp -r %s %s' % (scp_escape(a), scp_escape(b)))
 
 def copyfile(a, b):
-    log('copy %s -> %s' % (scp_escape(a), scp_escape(b)))
-    command('scp %s %s' % (scp_escape(a), scp_escape(b)))
+    log_normal('copy %s -> %s' % (scp_escape(a), scp_escape(b)))
+    if b.startswith('s3://'):
+        command('s3cmd -P put "%s" "%s"' % (a, b))
+    else:
+        bc = b.find(":")
+        if bc != -1:
+            host = b[:bc]
+            path = b[bc+1:]
+            temp_path = os.path.join(os.path.dirname(path), ".tmp." + os.path.basename(path))
+            command('scp %s %s' % (scp_escape(a), scp_escape(host + ":" + temp_path)))
+            command('ssh %s -- mv "%s" "%s"' % (host, escape_spaces(temp_path), escape_spaces(path)))
+        else:
+            command('scp %s %s' % (scp_escape(a), scp_escape(b)))
 
 def makedirs(d):
+    """
+    Make directories either locally or on a remote host; remotely if
+    d includes a colon, otherwise locally.
+    """
+    if d.startswith('s3://'):
+        # No need to create folders on S3
+        return
+
     if d.find(':') == -1:
-        os.makedirs(d)
+        try:
+            os.makedirs(d)
+        except OSError as e:
+            if e.errno != 17:
+                raise e
     else:
         s = d.split(':')
         command('ssh %s -- mkdir -p %s' % (s[0], s[1]))
 
 def rmdir(a):
-    log('remove %s' % a)
+    log_normal('remove %s' % a)
     os.rmdir(a)
 
 def rmtree(a):
-    log('remove %s' % a)
+    log_normal('remove %s' % a)
     shutil.rmtree(a, ignore_errors=True)
 
 def command(c):
-    log(c)
+    log_normal(c)
     r = os.system(c)
     if (r >> 8):
         raise Error('command %s failed' % c)
 
 def command_and_read(c):
-    log(c)
-    p = subprocess.Popen(c.split(), stdout=subprocess.PIPE)
-    f = os.fdopen(os.dup(p.stdout.fileno()))
-    return f
+    log_normal(c)
+    p = subprocess.Popen(c.split(), stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+    (out, err) = p.communicate()
+    if p.returncode != 0:
+        raise Error('command %s failed (%s)' % (c, err))
+    return str(out, 'utf-8').splitlines()
 
 def read_wscript_variable(directory, variable):
     f = open('%s/wscript' % directory, 'r')
@@ -207,7 +284,6 @@ def set_version_in_wscript(version):
 
         s = l.split()
         if len(s) == 3 and s[0] == "VERSION":
-            print("Writing %s" % version)
             print("VERSION = '%s'" % version, file=o)
         else:
             print(l, file=o, end="")
@@ -220,7 +296,7 @@ def append_version_to_changelog(version):
     try:
         f = open('ChangeLog', 'r')
     except:
-        log('Could not open ChangeLog')
+        log_normal('Could not open ChangeLog')
         return
 
     c = f.read()
@@ -233,7 +309,7 @@ def append_version_to_changelog(version):
 
 def append_version_to_debian_changelog(version):
     if not os.path.exists('debian'):
-        log('Could not find debian directory')
+        log_normal('Could not find debian directory')
         return
 
     command('dch -b -v %s-1 "New upstream release."' % version)
@@ -243,6 +319,24 @@ def devel_to_git(git_commit, filename):
         filename = filename.replace('devel', '-%s' % git_commit)
     return filename
 
+
+def get_command_line_options(args):
+    """Get the options specified by --option on the command line"""
+    options = dict()
+    if args.option is not None:
+        for o in args.option:
+            b = o.split(':')
+            if len(b) != 2:
+                raise Error("Bad option `%s'" % o)
+            if b[1] == 'False':
+                options[b[0]] = False
+            elif b[1] == 'True':
+                options[b[0]] = True
+            else:
+                options[b[0]] = b[1]
+    return options
+
+
 class TreeDirectory:
     def __init__(self, tree):
         self.tree = tree
@@ -280,6 +374,14 @@ class Version:
         else:
             self.micro = 0
 
+    @classmethod
+    def from_git_tag(cls, tag):
+        bits = tag.split('-')
+        c = cls(bits[0])
+        if len(bits) > 1 and int(bits[1]) > 0:
+            c.devel = True
+        return c
+
     def bump_minor(self):
         self.minor += 1
         self.micro = 0
@@ -314,6 +416,7 @@ class Target(object):
     directory: directory to work in
     variables: dict of environment variables
     debug: True to build a debug version, otherwise False
+    ccache: True to use ccache, False to not
     set(a, b): set the value of variable 'a' to 'b'
     unset(a): unset the value of variable 'a'
     command(c): run the command 'c' in the build environment
@@ -329,28 +432,54 @@ class Target(object):
         self.platform = platform
         self.parallel = int(config.get('parallel'))
 
-        # self.directory is the working directory
+        # Environment variables that we will use when we call cscripts
+        self.variables = {}
+        self.debug = False
+        self._ccache = False
+        # True to build our dependencies ourselves; False if this is taken care
+        # of in some other way
+        self.build_dependencies = True
+
         if directory is None:
             self.directory = tempfile.mkdtemp('', 'tmp', TEMPORARY_DIRECTORY)
             self.rmdir = True
+            self.set('CCACHE_BASEDIR', os.path.realpath(self.directory))
+            self.set('CCACHE_NOHASHDIR', '')
         else:
             self.directory = directory
             self.rmdir = False
 
-        # Environment variables that we will use when we call cscripts
-        self.variables = {}
-        self.debug = False
 
-    def package(self, project, checkout, dry_run):
+    def setup(self):
+        pass
+
+    def package(self, project, checkout, output_dir, options):
+        tree = self.build(project, checkout, options)
+        tree.add_defaults(options)
+        if len(inspect.getfullargspec(tree.cscript['package']).args) == 3:
+            packages = tree.call('package', tree.version, options)
+        else:
+            log_normal("Deprecated cscript package() method with no options parameter")
+            packages = tree.call('package', tree.version)
+
+        if isinstance(packages, list):
+            for p in packages:
+                copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, p))))
+        else:
+            copyfile(packages, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, packages))))
+
+    def build(self, project, checkout, options):
         tree = globals.trees.get(project, checkout, self)
-        tree.build_dependencies(dry_run)
-        tree.build(dry_run)
-        return tree.call('package', tree.version), tree.git_commit
+        if self.build_dependencies:
+            tree.build_dependencies(options)
+        tree.build(options)
+        return tree
 
-    def test(self, tree, test):
+    def test(self, tree, test, options):
         """test is the test case to run, or None"""
-        tree.build_dependencies(args.dry_run)
-        tree.build(args.dry_run)
+        if self.build_dependencies:
+            tree.build_dependencies(options)
+        tree.build(options)
         return tree.call('test', test)
 
     def set(self, a, b):
@@ -362,15 +491,21 @@ class Target(object):
     def get(self, a):
         return self.variables[a]
 
-    def append_with_space(self, k, v):
+    def append(self, k, v, s):
         if (not k in self.variables) or len(self.variables[k]) == 0:
             self.variables[k] = '"%s"' % v
         else:
             e = self.variables[k]
             if e[0] == '"' and e[-1] == '"':
-                self.variables[k] = '"%s %s"' % (e[1:-1], v)
+                self.variables[k] = '"%s%s%s"' % (e[1:-1], s, v)
             else:
-                self.variables[k] = '"%s %s"' % (e, v)
+                self.variables[k] = '"%s%s%s"' % (e, s, v)
+
+    def append_with_space(self, k, v):
+        return self.append(k, v, ' ')
+
+    def append_with_colon(self, k, v):
+        return self.append(k, v, ':')
 
     def variables_string(self, escaped_quotes=False):
         e = ''
@@ -384,66 +519,162 @@ class Target(object):
         if self.rmdir:
             rmtree(self.directory)
 
+    def mount(self, m):
+        pass
+
+    @property
+    def ccache(self):
+        return self._ccache
+
+    @ccache.setter
+    def ccache(self, v):
+        self._ccache = v
+
+
+class DockerTarget(Target):
+    def __init__(self, platform, directory):
+        super(DockerTarget, self).__init__(platform, directory)
+        self.mounts = []
+        self.privileged = False
+
+    def _user_tag(self):
+        if config.get('docker_no_user'):
+            return ''
+        return '-u %s' % getpass.getuser()
+
+    def setup(self):
+        opts = '-v %s:%s ' % (self.directory, self.directory)
+        for m in self.mounts:
+            opts += '-v %s:%s ' % (m, m)
+        if self.privileged:
+            opts += '--privileged=true '
+        if config.has('git_reference'):
+            opts += '-v %s:%s ' % (config.get('git_reference'), config.get('git_reference'))
+        if self.ccache:
+            opts += "-e CCACHE_DIR=/ccache/%s --mount source=ccache,target=/ccache" % self.image
+
+        tag = self.image
+        if config.has('docker_hub_repository'):
+            tag = '%s:%s' % (config.get('docker_hub_repository'), tag)
+
+        self.container = command_and_read('%s run %s %s -itd %s /bin/bash' % (config.docker(), self._user_tag(), opts, tag))[0].strip()
+
+    def command(self, cmd):
+        dir = os.path.join(self.directory, os.path.relpath(os.getcwd(), self.directory))
+        interactive_flag = '-i ' if sys.stdin.isatty() else ''
+        command('%s exec %s %s -t %s /bin/bash -c \'export %s; cd %s; %s\'' % (config.docker(), self._user_tag(), interactive_flag, self.container, self.variables_string(), dir, cmd))
+
+    def cleanup(self):
+        super(DockerTarget, self).cleanup()
+        command('%s kill %s' % (config.docker(), self.container))
+
+    def mount(self, m):
+        self.mounts.append(m)
+
 
-class WindowsTarget(Target):
+class FlatpakTarget(Target):
+    def __init__(self, project, checkout):
+        super(FlatpakTarget, self).__init__('flatpak')
+        self.build_dependencies = False
+        self.project = project
+        self.checkout = checkout
+
+    def setup(self):
+        pass
+
+    def command(self, cmd):
+        command(cmd)
+
+    def checkout_dependencies(self):
+        tree = globals.trees.get(self.project, self.checkout, self)
+        return tree.checkout_dependencies()
+
+    def flatpak(self):
+        return 'flatpak'
+
+    def flatpak_builder(self):
+        b = 'flatpak-builder'
+        if config.has('flatpak_state_dir'):
+            b += ' --state-dir=%s' % config.get('flatpak_state_dir')
+        return b
+
+
+class WindowsTarget(DockerTarget):
     """
     This target exposes the following additional API:
 
     version: Windows version ('xp' or None)
     bits: bitness of Windows (32 or 64)
-    environment_prefix: path to Windows environment
-    mingw_path: path to mingw binaries
+    name: name of our target e.g. x86_64-w64-mingw32.shared
+    environment_prefix: path to Windows environment for the appropriate target (libraries and some tools)
+    tool_path: path to 32- and 64-bit tools
     """
-    def __init__(self, version, bits, directory=None):
+    def __init__(self, windows_version, bits, directory, environment_version):
         super(WindowsTarget, self).__init__('windows', directory)
-        self.version = version
+        self.version = windows_version
         self.bits = bits
 
-        self.environment_prefix = '%s/%d' % (config.get('windows_environment_prefix'), self.bits)
-        if not os.path.exists(self.environment_prefix):
-            raise Error('environment prefix %s does not exist' % self.environment_prefix)
-
+        self.tool_path = '%s/usr/bin' % config.get('mxe_prefix')
         if self.bits == 32:
-            self.mingw_name = 'i686'
+            self.name = 'i686-w64-mingw32.shared'
         else:
-            self.mingw_name = 'x86_64'
-
-        self.mingw_path = '%s/%d/bin' % (config.get('mingw_prefix'), self.bits)
-        self.mingw_prefixes = ['/%s/%d' % (config.get('mingw_prefix'), self.bits), '%s/%d/%s-w64-mingw32' % (config.get('mingw_prefix'), bits, self.mingw_name)]
+            self.name = 'x86_64-w64-mingw32.shared'
+        self.environment_prefix = '%s/usr/%s' % (config.get('mxe_prefix'), self.name)
 
         self.set('PKG_CONFIG_LIBDIR', '%s/lib/pkgconfig' % self.environment_prefix)
         self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/bin/pkgconfig' % (self.directory, self.directory))
-        self.set('PATH', '%s/bin:%s:%s' % (self.environment_prefix, self.mingw_path, os.environ['PATH']))
-        self.set('CC', '%s-w64-mingw32-gcc' % self.mingw_name)
-        self.set('CXX', '%s-w64-mingw32-g++' % self.mingw_name)
-        self.set('LD', '%s-w64-mingw32-ld' % self.mingw_name)
-        self.set('RANLIB', '%s-w64-mingw32-ranlib' % self.mingw_name)
-        self.set('WINRC', '%s-w64-mingw32-windres' % self.mingw_name)
+        self.set('PATH', '%s/bin:%s:%s' % (self.environment_prefix, self.tool_path, os.environ['PATH']))
+        self.set('CC', '%s-gcc' % self.name)
+        self.set('CXX', '%s-g++' % self.name)
+        self.set('LD', '%s-ld' % self.name)
+        self.set('RANLIB', '%s-ranlib' % self.name)
+        self.set('WINRC', '%s-windres' % self.name)
         cxx = '-I%s/include -I%s/include' % (self.environment_prefix, self.directory)
         link = '-L%s/lib -L%s/lib' % (self.environment_prefix, self.directory)
-        for p in self.mingw_prefixes:
-            cxx += ' -I%s/include' % p
-            link += ' -L%s/lib' % p
         self.set('CXXFLAGS', '"%s"' % cxx)
         self.set('CPPFLAGS', '')
         self.set('LINKFLAGS', '"%s"' % link)
         self.set('LDFLAGS', '"%s"' % link)
 
-        # This is for backwards-compatibility
-        self.windows_prefix = self.environment_prefix
+        self.image = 'windows'
+        if environment_version is not None:
+            self.image += '_%s' % environment_version
 
-    def command(self, c):
-        log('host -> %s' % c)
-        command('%s %s' % (self.variables_string(), c))
+    @property
+    def library_prefix(self):
+        log_normal('Deprecated property library_prefix: use environment_prefix')
+        return self.environment_prefix
+
+    @property
+    def windows_prefix(self):
+        log_normal('Deprecated property windows_prefix: use environment_prefix')
+        return self.environment_prefix
+
+    @property
+    def mingw_prefixes(self):
+        log_normal('Deprecated property mingw_prefixes: use environment_prefix')
+        return [self.environment_prefix]
+
+    @property
+    def mingw_path(self):
+        log_normal('Deprecated property mingw_path: use tool_path')
+        return self.tool_path
+
+    @property
+    def mingw_name(self):
+        log_normal('Deprecated property mingw_name: use name')
+        return self.name
 
-class LinuxTarget(Target):
+
+class LinuxTarget(DockerTarget):
     """
-    Parent for Linux targets.
+    Build for Linux in a docker container.
     This target exposes the following additional API:
 
     distro: distribution ('debian', 'ubuntu', 'centos' or 'fedora')
     version: distribution version (e.g. '12.04', '8', '6.5')
     bits: bitness of the distribution (32 or 64)
+    detail: None or 'appimage' if we are building for appimage
     """
 
     def __init__(self, distro, version, bits, directory=None):
@@ -451,6 +682,7 @@ class LinuxTarget(Target):
         self.distro = distro
         self.version = version
         self.bits = bits
+        self.detail = None
 
         self.set('CXXFLAGS', '-I%s/include' % self.directory)
         self.set('CPPFLAGS', '')
@@ -459,50 +691,28 @@ class LinuxTarget(Target):
                  '%s/lib/pkgconfig:%s/lib64/pkgconfig:/usr/local/lib64/pkgconfig:/usr/local/lib/pkgconfig' % (self.directory, self.directory))
         self.set('PATH', '/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin')
 
-class ChrootTarget(LinuxTarget):
-    """Build in a chroot"""
-    def __init__(self, distro, version, bits, directory=None):
-        super(ChrootTarget, self).__init__(distro, version, bits, directory)
-        # e.g. ubuntu-14.04-64
-        if self.version is not None and self.bits is not None:
-            self.chroot = '%s-%s-%d' % (self.distro, self.version, self.bits)
+        if self.version is None:
+            self.image = '%s-%s' % (self.distro, self.bits)
         else:
-            self.chroot = self.distro
-        # e.g. /home/carl/Environments/ubuntu-14.04-64
-        self.chroot_prefix = '%s/%s' % (config.get('linux_chroot_prefix'), self.chroot)
-
-    def command(self, c):
-        command('%s schroot -c %s -p -- %s' % (self.variables_string(), self.chroot, c))
-
-
-class HostTarget(LinuxTarget):
-    """Build directly on the host"""
-    def __init__(self, distro, version, bits, directory=None):
-        super(HostTarget, self).__init__(distro, version, bits, directory)
-
-    def command(self, c):
-        command('%s %s' % (self.variables_string(), c))
-
-
-class DockerTarget(Target):
-    """
-    Build a Docker image.
+            self.image = '%s-%s-%s' % (self.distro, self.version, self.bits)
 
-    This target exposes the following additional API:
+    def setup(self):
+        super(LinuxTarget, self).setup()
+        if self.ccache:
+            self.set('CC', '"ccache gcc"')
+            self.set('CXX', '"ccache g++"')
 
-    deb: path to Debian 8 .deb
-    """
-    def __init__(self, directory=None):
-        super(DockerTarget, self).__init__('docker', directory)
-        self.debian = ChrootTarget('debian', '8', 64, directory)
+    def test(self, tree, test, options):
+        self.append_with_colon('PATH', '%s/bin' % self.directory)
+        self.append_with_colon('LD_LIBRARY_PATH', '%s/lib' % self.directory)
+        super(LinuxTarget, self).test(tree, test, options)
 
-    def command(self, c):
-        log('host -> %s' % c)
-        command('%s %s' % (self.variables_string(), c))
 
-    def package(self, project, checkout, dry_run):
-        self.deb = self.debian.package(project, checkout, dry_run)
-        return globals.trees.get(project, checkout, self).call('package', tree.version), tree.git_commit
+class AppImageTarget(LinuxTarget):
+    def __init__(self, work):
+        super(AppImageTarget, self).__init__('ubuntu', '18.04', 64, work)
+        self.detail = 'appimage'
+        self.privileged = True
 
 
 class OSXTarget(Target):
@@ -511,6 +721,8 @@ class OSXTarget(Target):
         self.sdk = config.get('osx_sdk')
         self.sdk_prefix = config.get('osx_sdk_prefix')
         self.environment_prefix = config.get('osx_environment_prefix')
+        self.apple_id = config.get('apple_id')
+        self.apple_password = config.get('apple_password')
 
     def command(self, c):
         command('%s %s' % (self.variables_string(False), c))
@@ -538,26 +750,39 @@ class OSXSingleTarget(OSXTarget):
         self.set('PKG_CONFIG_PATH', '%s/lib/pkgconfig:%s/lib/pkgconfig:/usr/lib/pkgconfig' % (self.directory, enviro))
         self.set('PATH', '$PATH:/usr/bin:/sbin:/usr/local/bin:%s/bin' % enviro)
         self.set('MACOSX_DEPLOYMENT_TARGET', config.get('osx_sdk'))
+        self.set('CCACHE_BASEDIR', self.directory)
 
-    def package(self, project, checkout, dry_run):
-        raise Error('cannot package non-universal OS X versions')
+    @Target.ccache.setter
+    def ccache(self, v):
+        Target.ccache.fset(self, v)
+        if v:
+            self.set('CC', '"ccache gcc"')
+            self.set('CXX', '"ccache g++"')
 
 
 class OSXUniversalTarget(OSXTarget):
     def __init__(self, directory=None):
         super(OSXUniversalTarget, self).__init__(directory)
+        self.bits = None
 
-    def package(self, project, checkout, dry_run):
+    def package(self, project, checkout, output_dir, options):
 
         for b in [32, 64]:
             target = OSXSingleTarget(b, os.path.join(self.directory, '%d' % b))
+            target.ccache = self.ccache
             tree = globals.trees.get(project, checkout, target)
-            tree.build_dependencies(dry_run)
-            tree.build(dry_run)
+            tree.build_dependencies(options)
+            tree.build(options)
 
         tree = globals.trees.get(project, checkout, self)
         with TreeDirectory(tree):
-            return tree.call('package', tree.version), tree.git_commit
+            if len(inspect.getfullargspec(tree.cscript['package']).args) == 3:
+                packages = tree.call('package', tree.version, options)
+            else:
+                log_normal("Deprecated cscript package() method with no options parameter")
+                packages = tree.call('package', tree.version)
+            for p in packages:
+                copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, p))))
 
 class SourceTarget(Target):
     """Build a source .tar.bz2"""
@@ -565,80 +790,84 @@ class SourceTarget(Target):
         super(SourceTarget, self).__init__('source')
 
     def command(self, c):
-        log('host -> %s' % c)
+        log_normal('host -> %s' % c)
         command('%s %s' % (self.variables_string(), c))
 
     def cleanup(self):
         rmtree(self.directory)
 
-    def package(self, project, checkout, dry_run):
+    def package(self, project, checkout, output_dir, options):
         tree = globals.trees.get(project, checkout, self)
         with TreeDirectory(tree):
             name = read_wscript_variable(os.getcwd(), 'APPNAME')
             command('./waf dist')
-            return os.path.abspath('%s-%s.tar.bz2' % (name, tree.version)), tree.git_commit
-
+            p = os.path.abspath('%s-%s.tar.bz2' % (name, tree.version))
+            copyfile(p, os.path.join(output_dir, os.path.basename(devel_to_git(tree.git_commit, p))))
 
 # @param s Target string:
 #       windows-{32,64}
 #    or ubuntu-version-{32,64}
 #    or debian-version-{32,64}
 #    or centos-version-{32,64}
+#    or fedora-version-{32,64}
+#    or mageia-version-{32,64}
 #    or osx-{32,64}
 #    or source
+#    or flatpak
+#    or appimage
 # @param debug True to build with debugging symbols (where possible)
-def target_factory(s, debug, work):
+def target_factory(args):
+    s = args.target
     target = None
     if s.startswith('windows-'):
         x = s.split('-')
         if len(x) == 2:
-            target = WindowsTarget(None, int(x[1]), work)
+            target = WindowsTarget(None, int(x[1]), args.work, args.environment_version)
         elif len(x) == 3:
-            target = WindowsTarget(x[1], int(x[2]), work)
+            target = WindowsTarget(x[1], int(x[2]), args.work, args.environment_version)
         else:
             raise Error("Bad Windows target name `%s'")
-    elif s.startswith('ubuntu-') or s.startswith('debian-') or s.startswith('centos-'):
+    elif s.startswith('ubuntu-') or s.startswith('debian-') or s.startswith('centos-') or s.startswith('fedora-') or s.startswith('mageia-'):
         p = s.split('-')
         if len(p) != 3:
-            raise Error("Bad Linux target name `%s'; must be something like ubuntu-12.04-32 (i.e. distro-version-bits)" % s)
-        target = ChrootTarget(p[0], p[1], int(p[2]), work)
+            raise Error("Bad Linux target name `%s'; must be something like ubuntu-16.04-32 (i.e. distro-version-bits)" % s)
+        target = LinuxTarget(p[0], p[1], int(p[2]), args.work)
     elif s.startswith('arch-'):
         p = s.split('-')
         if len(p) != 2:
             raise Error("Bad Arch target name `%s'; must be arch-32 or arch-64")
-        target = ChrootTarget(p[0], None, p[1], work)
+        target = LinuxTarget(p[0], None, int(p[1]), args.work)
     elif s == 'raspbian':
-        target = ChrootTarget(s, None, None, work)
-    elif s == 'host':
-        if command_and_read('uname -m').read().strip() == 'x86_64':
-            bits = 64
-        else:
-            bits = 32
-        try:
-            f = open('/etc/fedora-release', 'r')
-            l = f.readline().strip().split()
-            target = HostTarget("fedora", l[2], bits, work)
-        except Exception as e:
-            if os.path.exists('/etc/arch-release'):
-                target = HostTarget("arch", None, bits, work)
-            else:
-                raise Error("could not identify distribution for `host' target (%s)" % e)
+        target = LinuxTarget(s, None, None, args.work)
     elif s.startswith('osx-'):
-        target = OSXSingleTarget(int(s.split('-')[1]), work)
+        target = OSXSingleTarget(int(s.split('-')[1]), args.work)
     elif s == 'osx':
         if globals.command == 'build':
-            target = OSXSingleTarget(64, work)
+            target = OSXSingleTarget(64, args.work)
         else:
-            target = OSXUniversalTarget(work)
+            target = OSXUniversalTarget(args.work)
     elif s == 'source':
         target = SourceTarget()
-    elif s == 'docker':
-        target = DockerTarget()
+    elif s == 'flatpak':
+        target = FlatpakTarget(args.project, args.checkout)
+    elif s == 'appimage':
+        target = AppImageTarget(args.work)
 
     if target is None:
         raise Error("Bad target `%s'" % s)
 
-    target.debug = debug
+    target.debug = args.debug
+    target.ccache = args.ccache
+
+    if args.environment is not None:
+        for e in args.environment:
+            target.set(e, os.environ[e])
+
+    if args.mount is not None:
+        for m in args.mount:
+            target.mount(m)
+
+    target.setup()
     return target
 
 
@@ -652,19 +881,21 @@ class Tree(object):
        Attributes:
            name -- name of git repository (without the .git)
            specifier -- git tag or revision to use
-           target --- target object that we are using
-           version --- version from the wscript (if one is present)
+           target -- target object that we are using
+           version -- version from the wscript (if one is present)
            git_commit -- git revision that is actually being used
-           built --- true if the tree has been built yet in this run
+           built -- true if the tree has been built yet in this run
+           required_by -- name of the tree that requires this one
     """
 
-    def __init__(self, name, specifier, target):
+    def __init__(self, name, specifier, target, required_by):
         self.name = name
         self.specifier = specifier
         self.target = target
         self.version = None
         self.git_commit = None
         self.built = False
+        self.required_by = required_by
 
         cwd = os.getcwd()
 
@@ -673,7 +904,11 @@ class Tree(object):
         if globals.quiet:
             flags = '-q'
             redirect = '>/dev/null'
-        command('git clone %s %s/%s.git %s/src/%s' % (flags, config.get('git_prefix'), self.name, target.directory, self.name))
+        if config.has('git_reference'):
+            ref = '--reference-if-able %s/%s.git' % (config.get('git_reference'), self.name)
+        else:
+            ref = ''
+        command('git clone %s %s %s/%s.git %s/src/%s' % (flags, ref, config.get('git_prefix'), self.name, target.directory, self.name))
         os.chdir('%s/src/%s' % (target.directory, self.name))
 
         spec = self.specifier
@@ -681,19 +916,36 @@ class Tree(object):
             spec = 'master'
 
         command('git checkout %s %s %s' % (flags, spec, redirect))
-        self.git_commit = command_and_read('git rev-parse --short=7 HEAD').readline().strip()
-        command('git submodule init --quiet')
-        command('git submodule update --quiet')
+        self.git_commit = command_and_read('git rev-parse --short=7 HEAD')[0].strip()
 
         proj = '%s/src/%s' % (target.directory, self.name)
 
         self.cscript = {}
         exec(open('%s/cscript' % proj).read(), self.cscript)
 
+        # cscript can include submodules = False to stop submodules being fetched
+        if (not 'submodules' in self.cscript or self.cscript['submodules'] == True) and os.path.exists('.gitmodules'):
+            command('git submodule --quiet init')
+            paths = command_and_read('git config --file .gitmodules --get-regexp path')
+            urls = command_and_read('git config --file .gitmodules --get-regexp url')
+            for path, url in zip(paths, urls):
+                path = path.split(' ')[1]
+                url = url.split(' ')[1]
+            ref = ''
+            if config.has('git_reference'):
+                ref_path = os.path.join(config.get('git_reference'), os.path.basename(url))
+                if os.path.exists(ref_path):
+                    ref = '--reference %s' % ref_path
+            command('git submodule --quiet update %s %s' % (ref, path))
+
         if os.path.exists('%s/wscript' % proj):
             v = read_wscript_variable(proj, "VERSION");
             if v is not None:
-                self.version = Version(v)
+                try:
+                    self.version = Version(v)
+                except:
+                    tag = command_and_read('git -C %s describe --tags' % proj)[0][1:]
+                    self.version = Version.from_git_tag(tag)
 
         os.chdir(cwd)
 
@@ -701,43 +953,71 @@ class Tree(object):
         with TreeDirectory(self):
             return self.cscript[function](self.target, *args)
 
-    def build_dependencies(self, dry_run, options=None):
-        if 'dependencies' in self.cscript:
-            if len(inspect.getargspec(self.cscript['dependencies']).args) == 2:
-                deps = self.call('dependencies', options)
+    def add_defaults(self, options):
+        """Add the defaults from self into a dict options"""
+        if 'option_defaults' in self.cscript:
+            from_cscript = self.cscript['option_defaults']
+            if isinstance(from_cscript, dict):
+                defaults_dict = from_cscript
             else:
-                deps = self.call('dependencies')
+                log_normal("Deprecated cscript option_defaults method; replace with a dict")
+                defaults_dict = from_cscript()
+            for k, v in defaults_dict.items():
+                if not k in options:
+                    options[k] = v
 
-            to = options
-            if to is None:
-                to = dict()
+    def dependencies(self, options):
+        """
+        yield details of the dependencies of this tree.  Each dependency is returned
+        as a tuple of (tree, options).  The 'options' parameter are the options that
+        we want to force for 'self'.
+        """
+        if not 'dependencies' in self.cscript:
+            return
 
-            for d in deps:
-                log('Building dependency %s %s of %s' % (d[0], d[1], self.name))
-                dep = globals.trees.get(d[0], d[1], self.target)
+        if len(inspect.getfullargspec(self.cscript['dependencies']).args) == 2:
+            self_options = copy.copy(options)
+            self.add_defaults(self_options)
+            deps = self.call('dependencies', self_options)
+        else:
+            log_normal("Deprecated cscript dependencies() method with no options parameter")
+            deps = self.call('dependencies')
 
-                # Make the options to pass in from the option_defaults of the thing
-                # we are building and any options specified by the parent.
+        # Loop over our immediate dependencies
+        for d in deps:
+            dep = globals.trees.get(d[0], d[1], self.target, self.name)
 
-                if 'option_defaults' in dep.cscript:
-                    for k, v in dep.cscript['option_defaults']().items():
-                        to[k] = v
+            # deps only get their options from the parent's cscript
+            dep_options = d[2] if len(d) > 2 else {}
+            for i in dep.dependencies(dep_options):
+                yield i
+            yield (dep, dep_options)
 
-                if len(d) > 2:
-                    for k, v in d[2].items():
-                        to[k] = v
+    def checkout_dependencies(self, options={}):
+        for i in self.dependencies(options):
+            pass
 
-                dep.build_dependencies(dry_run, to)
-                dep.build(dry_run, to)
+    def build_dependencies(self, options):
+        """
+        Called on the 'main' project tree (-p on the command line) to build all dependencies.
+        'options' will be the ones from the command line.
+        """
+        for i in self.dependencies(options):
+            i[0].build(i[1])
 
-    def build(self, dry_run, options=None):
+    def build(self, options):
         if self.built:
             return
 
+        log_verbose("Building %s %s %s with %s" % (self.name, self.specifier, self.version, options))
+
         variables = copy.copy(self.target.variables)
 
-        if not dry_run:
-            if len(inspect.getargspec(self.cscript['build']).args) == 2:
+        options = copy.copy(options)
+        self.add_defaults(options)
+
+        if not globals.dry_run:
+            if len(inspect.getfullargspec(self.cscript['build']).args) == 2:
                 self.call('build', options)
             else:
                 self.call('build')
@@ -756,12 +1036,11 @@ def main():
         "package": "package and build project",
         "release": "release a project using its next version number (changing wscript and tagging)",
         "pot": "build the project's .pot files",
-        "changelog": "generate a simple HTML changelog",
         "manual": "build the project's manual",
         "doxygen": "build the project's Doxygen documentation",
         "latest": "print out the latest version",
         "test": "run the project's unit tests",
-        "shell": "build the project then start a shell in its chroot",
+        "shell": "build the project then start a shell",
         "checkout": "check out the project",
         "revision": "print the head git revision number"
     }
@@ -777,19 +1056,36 @@ def main():
     parser.add_argument('-p', '--project', help='project name')
     parser.add_argument('--minor', help='minor version number bump', action='store_true')
     parser.add_argument('--micro', help='micro version number bump', action='store_true')
-    parser.add_argument('--major', help='major version to return with latest', type=int)
+    parser.add_argument('--latest-major', help='major version to return with latest', type=int)
+    parser.add_argument('--latest-minor', help='minor version to return with latest', type=int)
     parser.add_argument('-c', '--checkout', help='string to pass to git for checkout')
     parser.add_argument('-o', '--output', help='output directory', default='.')
     parser.add_argument('-q', '--quiet', help='be quiet', action='store_true')
-    parser.add_argument('-t', '--target', help='target')
+    parser.add_argument('-t', '--target', help='target', action='append')
+    parser.add_argument('--environment-version', help='version of environment to use')
     parser.add_argument('-k', '--keep', help='keep working tree', action='store_true')
     parser.add_argument('--debug', help='build with debugging symbols where possible', action='store_true')
     parser.add_argument('-w', '--work', help='override default work directory')
     parser.add_argument('-g', '--git-prefix', help='override configured git prefix')
-    parser.add_argument('--test', help='name of test to run (with `test''), defaults to all')
+    parser.add_argument('--test', help="name of test to run (with `test'), defaults to all")
     parser.add_argument('-n', '--dry-run', help='run the process without building anything', action='store_true')
+    parser.add_argument('-e', '--environment', help='pass the value of the named environment variable into the build', action='append')
+    parser.add_argument('-m', '--mount', help='mount a given directory in the build environment', action='append')
+    parser.add_argument('--no-version-commit', help="use just tags for versioning, don't modify wscript, ChangeLog etc.", action='store_true')
+    parser.add_argument('--option', help='set an option for the build (use --option key:value)', action='append')
+    parser.add_argument('--ccache', help='use ccache', action='store_true')
+    parser.add_argument('--verbose', help='be verbose', action='store_true')
+    global args
     args = parser.parse_args()
 
+    # Check for incorrect multiple parameters
+    if args.target is not None:
+        if len(args.target) > 1:
+            parser.error('multiple -t options specified')
+            sys.exit(1)
+        else:
+            args.target = args.target[0]
+
     # Override configured stuff
     if args.git_prefix is not None:
         config.set('git_prefix', args.git_prefix)
@@ -805,12 +1101,16 @@ def main():
 
     if args.work is not None:
         args.work = os.path.abspath(args.work)
+        if not os.path.exists(args.work):
+            os.makedirs(args.work)
 
     if args.project is None and args.command != 'shell':
         raise Error('you must specify -p or --project')
 
     globals.quiet = args.quiet
+    globals.verbose = args.verbose
     globals.command = args.command
+    globals.dry_run = args.dry_run
 
     if not globals.command in commands:
         e = 'command must be one of:\n' + one_of
@@ -820,10 +1120,8 @@ def main():
         if args.target is None:
             raise Error('you must specify -t or --target')
 
-        target = target_factory(args.target, args.debug, args.work)
-        tree = globals.trees.get(args.project, args.checkout, target)
-        tree.build_dependencies(dry_run)
-        tree.build(dry_run)
+        target = target_factory(args)
+        target.build(args.project, args.checkout, get_command_line_options(args))
         if not args.keep:
             target.cleanup()
 
@@ -831,28 +1129,26 @@ def main():
         if args.target is None:
             raise Error('you must specify -t or --target')
 
-        target = target_factory(args.target, args.debug, args.work)
-        packages, git_commit = target.package(args.project, args.checkout, args.dry_run)
-        if hasattr(packages, 'strip') or (not hasattr(packages, '__getitem__') and not hasattr(packages, '__iter__')):
-            packages = [packages]
-
-        if target.platform == 'linux':
-            out = '%s%s-%s-%d' % (args.output, target.distro, target.version, target.bits)
-            try:
-                makedirs(out)
-            except:
-                pass
-            for p in packages:
-                copyfile(p, '%s/%s' % (out, os.path.basename(devel_to_git(git_commit, p))))
-        else:
-            try:
-                makedirs(args.output)
-            except:
-                pass
-            for p in packages:
-                copyfile(p, '%s%s' % (args.output, os.path.basename(devel_to_git(git_commit, p))))
+        target = None
+        try:
+            target = target_factory(args)
 
-        if not args.keep:
+            if target.platform == 'linux' and target.detail != "appimage":
+                if target.distro != 'arch':
+                    output_dir = os.path.join(args.output, '%s-%s-%d' % (target.distro, target.version, target.bits))
+                else:
+                    output_dir = os.path.join(args.output, '%s-%d' % (target.distro, target.bits))
+            else:
+                output_dir = args.output
+
+            makedirs(output_dir)
+            target.package(args.project, args.checkout, output_dir, get_command_line_options(args))
+        except Error as e:
+            if target is not None and not args.keep:
+                target.cleanup()
+            raise
+
+        if target is not None and not args.keep:
             target.cleanup()
 
     elif globals.command == 'release':
@@ -869,18 +1165,22 @@ def main():
         else:
             version.bump_micro()
 
-        set_version_in_wscript(version)
-        append_version_to_changelog(version)
-        append_version_to_debian_changelog(version)
+        with TreeDirectory(tree):
+            if not args.no_version_commit:
+                set_version_in_wscript(version)
+                append_version_to_changelog(version)
+                append_version_to_debian_changelog(version)
+                command('git commit -a -m "Bump version"')
+
+            command('git tag -m "v%s" v%s' % (version, version))
 
-        command('git commit -a -m "Bump version"')
-        command('git tag -m "v%s" v%s' % (version, version))
+            if not args.no_version_commit:
+                version.to_devel()
+                set_version_in_wscript(version)
+                command('git commit -a -m "Bump version"')
+                command('git push')
 
-        version.to_devel()
-        set_version_in_wscript(version)
-        command('git commit -a -m "Bump version"')
-        command('git push')
-        command('git push --tags')
+            command('git push --tags')
 
         target.cleanup()
 
@@ -894,52 +1194,6 @@ def main():
 
         target.cleanup()
 
-    elif globals.command == 'changelog':
-        target = SourceTarget()
-        tree = globals.trees.get(args.project, args.checkout, target)
-
-        with TreeDirectory(tree):
-            text = open('ChangeLog', 'r')
-
-        html = tempfile.NamedTemporaryFile()
-        versions = 8
-
-        last = None
-        changes = []
-
-        while True:
-            l = text.readline()
-            if l == '':
-                break
-
-            if len(l) > 0 and l[0] == "\t":
-                s = l.split()
-                if len(s) == 4 and s[1] == "Version" and s[3] == "released.":
-                    v = Version(s[2])
-                    if v.micro == 0:
-                        if last is not None and len(changes) > 0:
-                            print("<h2>Changes between version %s and %s</h2>" % (s[2], last), file=html)
-                            print("<ul>", file=html)
-                            for c in changes:
-                                print("<li>%s" % c, file=html)
-                            print("</ul>", file=html)
-                        last = s[2]
-                        changes = []
-                        versions -= 1
-                        if versions < 0:
-                            break
-                else:
-                    c = l.strip()
-                    if len(c) > 0:
-                        if c[0] == '*':
-                            changes.append(c[2:])
-                        else:
-                            changes[-1] += " " + c
-
-        copyfile(html.file, '%schangelog.html' % args.output)
-        html.close()
-        target.cleanup()
-
     elif globals.command == 'manual':
         target = SourceTarget()
         tree = globals.trees.get(args.project, args.checkout, target)
@@ -973,8 +1227,10 @@ def main():
         with TreeDirectory(tree):
             f = command_and_read('git log --tags --simplify-by-decoration --pretty="%d"')
             latest = None
+            line = 0
             while latest is None:
-                t = f.readline()
+                t = f[line]
+                line += 1
                 m = re.compile(".*\((.*)\).*").match(t)
                 if m:
                     tags = m.group(1).split(', ')
@@ -984,7 +1240,7 @@ def main():
                             t = s[1]
                         if len(t) > 0 and t[0] == 'v':
                             v = Version(t[1:])
-                            if args.major is None or v.major == args.major:
+                            if (args.latest_major is None or v.major == args.latest_major) and (args.latest_minor is None or v.minor == args.latest_minor):
                                 latest = v
 
         print(latest)
@@ -996,23 +1252,23 @@ def main():
 
         target = None
         try:
-            target = target_factory(args.target, args.debug, args.work)
+            target = target_factory(args)
             tree = globals.trees.get(args.project, args.checkout, target)
             with TreeDirectory(tree):
-                target.test(tree, args.test)
+                target.test(tree, args.test, get_command_line_options(args))
         except Error as e:
-            if target is not None:
+            if target is not None and not args.keep:
                 target.cleanup()
             raise
 
-        if target is not None:
+        if target is not None and not args.keep:
             target.cleanup()
 
     elif globals.command == 'shell':
         if args.target is None:
             raise Error('you must specify -t or --target')
 
-        target = target_factory(args.target, args.debug, args.work)
+        target = target_factory(args)
         target.command('bash')
 
     elif globals.command == 'revision':
@@ -1020,7 +1276,7 @@ def main():
         target = SourceTarget()
         tree = globals.trees.get(args.project, args.checkout, target)
         with TreeDirectory(tree):
-            print(command_and_read('git rev-parse HEAD').readline().strip()[:7])
+            print(command_and_read('git rev-parse HEAD')[0].strip()[:7])
         target.cleanup()
 
     elif globals.command == 'checkout':