diff options
Diffstat (limited to 'overlord/overlays/tar.py')
| -rw-r--r-- | overlord/overlays/tar.py | 214 |
1 files changed, 214 insertions, 0 deletions
diff --git a/overlord/overlays/tar.py b/overlord/overlays/tar.py new file mode 100644 index 0000000..425fe26 --- /dev/null +++ b/overlord/overlays/tar.py @@ -0,0 +1,214 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +################################################################################# +# overlord TAR OVERLAY HANDLER +################################################################################# +# File: tar.py +# +# Handles tar overlays +# +# Copyright: +# (c) 2005 - 2008 Gunnar Wrobel +# Distributed under the terms of the GNU General Public License v2 +# +# Author(s): +# Gunnar Wrobel <wrobel@gentoo.org> +# +''' Tar overlay support.''' + +__version__ = "$Id: tar.py 310 2007-04-09 16:30:40Z wrobel $" + +#=============================================================================== +# +# Dependencies +# +#------------------------------------------------------------------------------- + +import os, os.path, sys, urllib2, shutil, tempfile +import xml.etree.ElementTree as ET # Python 2.5 + +from overlord.utils import path, ensure_unicode +#from overlord.debug import OUT +from overlord.overlays.source import OverlaySource, require_supported + +#=============================================================================== +# +# Class TarOverlay +# +#------------------------------------------------------------------------------- + +class TarOverlay(OverlaySource): + ''' Handles tar overlays. + + >>> from overlord.debug import OUT + >>> import xml.etree.ElementTree as ET # Python 2.5 + >>> repo = ET.Element('repo') + >>> repo_name = ET.Element('name') + >>> repo_name.text = 'dummy' + >>> desc = ET.Element('description') + >>> desc.text = 'Dummy description' + >>> owner = ET.Element('owner') + >>> owner_email = ET.Element('email') + >>> owner_email.text = 'dummy@example.org' + >>> owner[:] = [owner_email] + >>> source = ET.Element('source', type='tar') + >>> here = os.path.dirname(os.path.realpath(__file__)) + >>> source.text = 'file://' + here + '/../tests/testfiles/overlord-test.tar.bz2' + >>> subpath = ET.Element('subpath') + >>> subpath.text = 'overlord-test' + >>> repo[:] = [repo_name, desc, owner, source, subpath] + >>> config = {'tar_command':'/bin/tar'} + >>> testdir = os.tmpnam() + >>> os.mkdir(testdir) + >>> from overlord.overlays.overlay import Overlay + >>> a = Overlay(repo, config, quiet=False) + >>> OUT.color_off() + >>> a.add(testdir) #doctest: +ELLIPSIS + * Running... # /bin/tar -v -x -f... + >>> sorted(os.listdir(testdir + '/dummy')) + ['app-admin', 'app-portage'] + >>> shutil.rmtree(testdir) + ''' + + type = 'Tar' + type_key = 'tar' + + def __init__(self, parent, xml, config, _location, ignore = 0, quiet = False): + + super(TarOverlay, self).__init__(parent, xml, config, _location, ignore, quiet) + + _subpath = xml.find('subpath') + if _subpath != None: + self.subpath = ensure_unicode(_subpath.text.strip()) + elif 'subpath' in xml.attrib: + self.subpath = ensure_unicode(xml.attrib['subpath']) + else: + self.subpath = '' + + self.output = config['output'] + + def __eq__(self, other): + res = super(TarOverlay, self).__eq__(other) \ + and self.subpath == other.subpath + return res + + def __ne__(self, other): + return not self.__eq__(other) + + # overrider + def to_xml_hook(self, repo_elem): + if self.subpath: + _subpath = ET.Element('subpath') + _subpath.text = self.subpath + repo_elem.append(_subpath) + del _subpath + + def _extract(self, base, tar_url, dest_dir): + ext = '.tar.noidea' + for i in [('tar.%s' % e) for e in ('bz2', 'gz', 'lzma', 'xz', 'Z')] \ + + ['tgz', 'tbz', 'taz', 'tlz', 'txz']: + candidate_ext = '.%s' % i + if self.src.endswith(candidate_ext): + ext = candidate_ext + break + + try: + tar = urllib2.urlopen(tar_url).read() + except Exception, error: + raise Exception('Failed to fetch the tar package from: ' + + self.src + '\nError was:' + str(error)) + + pkg = path([base, self.parent.name + ext]) + + try: + out_file = open(pkg, 'w') + out_file.write(tar) + out_file.close() + except Exception, error: + raise Exception('Failed to store tar package in ' + + pkg + '\nError was:' + str(error)) + + # tar -v -x -f SOURCE -C TARGET + args = ['-v', '-x', '-f', pkg, '-C', dest_dir] + result = self.run_command(*args) + + os.unlink(pkg) + return result + + def _add_unchecked(self, base, quiet): + def try_to_wipe(folder): + if not os.path.exists(folder): + return + + try: + self.output.info('Deleting directory "%s"' % folder, 2) + shutil.rmtree(folder) + except Exception, error: + raise Exception('Failed to remove unnecessary tar structure "' + + folder + '"\nError was:' + str(error)) + + final_path = path([base, self.parent.name]) + temp_path = tempfile.mkdtemp(dir=base) + try: + result = self._extract(base=base, tar_url=self.src, dest_dir=temp_path) + except Exception, error: + try_to_wipe(temp_path) + raise error + + if result == 0: + if self.subpath: + source = temp_path + '/' + self.subpath + else: + source = temp_path + + if os.path.exists(source): + if os.path.exists(final_path): + self.delete(base) + + try: + os.rename(source, final_path) + except Exception, error: + raise Exception('Failed to rename tar subdirectory ' + + source + ' to ' + final_path + '\nError was:' + + str(error)) + os.chmod(final_path, 0755) + else: + raise Exception('Given subpath "' + source + '" does not exist ' + ' in the tar package!') + + try_to_wipe(temp_path) + return result + + def add(self, base, quiet = False): + '''Add overlay.''' + + self.supported() + + final_path = path([base, self.parent.name]) + + if os.path.exists(final_path): + raise Exception('Directory ' + final_path + ' already exists. Will not ov' + 'erwrite its contents!') + + return self._add_unchecked(base, quiet) + + def sync(self, base, quiet = False): + '''Sync overlay.''' + self.supported() + self._add_unchecked(base, quiet) + + def supported(self): + '''Overlay type supported?''' + + return require_supported([(self.command(), 'tar', 'app-arch/tar'), ]) + +if __name__ == '__main__': + import doctest + + # Ignore warnings here. We are just testing + from warnings import filterwarnings, resetwarnings + filterwarnings('ignore') + + doctest.testmod(sys.modules[__name__]) + + resetwarnings() |