cleanly abort on unknown archive type (issue966)

mercurial/archival.py

@@ -1,220 +1,222 b''
 # archival.py - revision archival for mercurial
 #
 # Copyright 2006 Vadim Gelfer <[e-mail]>
 #
 # This software may be used and distributed according to the terms of
 # the GNU General Public License, incorporated herein by reference.
 
 from i18n import _
 from node import *
 import cStringIO, os, stat, tarfile, time, util, zipfile
 import zlib, gzip
 
 def tidyprefix(dest, prefix, suffixes):
     '''choose prefix to use for names in archive.  make sure prefix is
     safe for consumers.'''
 
     if prefix:
         prefix = prefix.replace('\\', '/')
     else:
         if not isinstance(dest, str):
             raise ValueError('dest must be string if no prefix')
         prefix = os.path.basename(dest)
         lower = prefix.lower()
         for sfx in suffixes:
             if lower.endswith(sfx):
                 prefix = prefix[:-len(sfx)]
                 break
     lpfx = os.path.normpath(util.localpath(prefix))
     prefix = util.pconvert(lpfx)
     if not prefix.endswith('/'):
         prefix += '/'
     if prefix.startswith('../') or os.path.isabs(lpfx) or '/../' in prefix:
         raise util.Abort(_('archive prefix contains illegal components'))
     return prefix
 
 class tarit:
     '''write archive to tar file or stream.  can write uncompressed,
     or compress with gzip or bzip2.'''
 
     class GzipFileWithTime(gzip.GzipFile):
 
         def __init__(self, *args, **kw):
             timestamp = None
             if 'timestamp' in kw:
                 timestamp = kw.pop('timestamp')
             if timestamp == None:
                 self.timestamp = time.time()
             else:
                 self.timestamp = timestamp
             gzip.GzipFile.__init__(self, *args, **kw)
 
         def _write_gzip_header(self):
             self.fileobj.write('\037\213')             # magic header
             self.fileobj.write('\010')                 # compression method
             fname = self.filename[:-3]
             flags = 0
             if fname:
                 flags = gzip.FNAME
             self.fileobj.write(chr(flags))
             gzip.write32u(self.fileobj, long(self.timestamp))
             self.fileobj.write('\002')
             self.fileobj.write('\377')
             if fname:
                 self.fileobj.write(fname + '\000')
 
     def __init__(self, dest, prefix, mtime, kind=''):
         self.prefix = tidyprefix(dest, prefix, ['.tar', '.tar.bz2', '.tar.gz',
                                                 '.tgz', '.tbz2'])
         self.mtime = mtime
 
         def taropen(name, mode, fileobj=None):
             if kind == 'gz':
                 mode = mode[0]
                 if not fileobj:
                     fileobj = open(name, mode + 'b')
                 gzfileobj = self.GzipFileWithTime(name, mode + 'b',
                                                   zlib.Z_BEST_COMPRESSION,
                                                   fileobj, timestamp=mtime)
                 return tarfile.TarFile.taropen(name, mode, gzfileobj)
             else:
                 return tarfile.open(name, mode + kind, fileobj)
 
         if isinstance(dest, str):
             self.z = taropen(dest, mode='w:')
         else:
             # Python 2.5-2.5.1 have a regression that requires a name arg
             self.z = taropen(name='', mode='w|', fileobj=dest)
 
     def addfile(self, name, mode, islink, data):
         i = tarfile.TarInfo(self.prefix + name)
         i.mtime = self.mtime
         i.size = len(data)
         if islink:
             i.type = tarfile.SYMTYPE
             i.mode = 0777
             i.linkname = data
             data = None
         else:
             i.mode = mode
             data = cStringIO.StringIO(data)
         self.z.addfile(i, data)
 
     def done(self):
         self.z.close()
 
 class tellable:
     '''provide tell method for zipfile.ZipFile when writing to http
     response file object.'''
 
     def __init__(self, fp):
         self.fp = fp
         self.offset = 0
 
     def __getattr__(self, key):
         return getattr(self.fp, key)
 
     def write(self, s):
         self.fp.write(s)
         self.offset += len(s)
 
     def tell(self):
         return self.offset
 
 class zipit:
     '''write archive to zip file or stream.  can write uncompressed,
     or compressed with deflate.'''
 
     def __init__(self, dest, prefix, mtime, compress=True):
         self.prefix = tidyprefix(dest, prefix, ('.zip',))
         if not isinstance(dest, str):
             try:
                 dest.tell()
             except (AttributeError, IOError):
                 dest = tellable(dest)
         self.z = zipfile.ZipFile(dest, 'w',
                                  compress and zipfile.ZIP_DEFLATED or
                                  zipfile.ZIP_STORED)
         self.date_time = time.gmtime(mtime)[:6]
 
     def addfile(self, name, mode, islink, data):
         i = zipfile.ZipInfo(self.prefix + name, self.date_time)
         i.compress_type = self.z.compression
         # unzip will not honor unix file modes unless file creator is
         # set to unix (id 3).
         i.create_system = 3
         ftype = stat.S_IFREG
         if islink:
             mode = 0777
             ftype = stat.S_IFLNK
         i.external_attr = (mode | ftype) << 16L
         self.z.writestr(i, data)
 
     def done(self):
         self.z.close()
 
 class fileit:
     '''write archive as files in directory.'''
 
     def __init__(self, name, prefix, mtime):
         if prefix:
             raise util.Abort(_('cannot give prefix when archiving to files'))
         self.basedir = name
         self.opener = util.opener(self.basedir)
 
     def addfile(self, name, mode, islink, data):
         if islink:
             self.opener.symlink(data, name)
             return
         f = self.opener(name, "w", atomictemp=True)
         f.write(data)
         f.rename()
         destfile = os.path.join(self.basedir, name)
         os.chmod(destfile, mode)
 
     def done(self):
         pass
 
 archivers = {
     'files': fileit,
     'tar': tarit,
     'tbz2': lambda name, prefix, mtime: tarit(name, prefix, mtime, 'bz2'),
     'tgz': lambda name, prefix, mtime: tarit(name, prefix, mtime, 'gz'),
     'uzip': lambda name, prefix, mtime: zipit(name, prefix, mtime, False),
     'zip': zipit,
     }
 
 def archive(repo, dest, node, kind, decode=True, matchfn=None,
             prefix=None, mtime=None):
     '''create archive of repo as it was at node.
 
     dest can be name of directory, name of archive file, or file
     object to write archive to.
 
     kind is type of archive to create.
 
     decode tells whether to put files through decode filters from
     hgrc.
 
     matchfn is function to filter names of files to write to archive.
 
     prefix is name of path to put before every archive member.'''
 
     def write(name, mode, islink, getdata):
         if matchfn and not matchfn(name): return
         data = getdata()
         if decode:
             data = repo.wwritedata(name, data)
         archiver.addfile(name, mode, islink, data)
 
     ctx = repo.changectx(node)
+    if kind not in archivers:
+        raise util.Abort(_("unknown archive type '%s'" % kind))
     archiver = archivers[kind](dest, prefix, mtime or ctx.date()[0])
     m = ctx.manifest()
     items = m.items()
     items.sort()
     write('.hg_archival.txt', 0644, False,
           lambda: 'repo: %s\nnode: %s\n' % (hex(repo.changelog.node(0)), hex(node)))
     for filename, filenode in items:
         write(filename, m.execf(filename) and 0755 or 0644, m.linkf(filename),
               lambda: repo.file(filename).read(filenode))
     archiver.done()

tests/test-archive

@@ -1,76 +1,78 b''
 #!/bin/sh
 
 mkdir test
 cd test
 hg init
 echo foo>foo
 hg commit -Am 1 -d '1 0'
 echo bar>bar
 hg commit -Am 2 -d '2 0'
 mkdir baz
 echo bletch>baz/bletch
 hg commit -Am 3 -d '1000000000 0'
 echo "[web]" >> .hg/hgrc
 echo "name = test-archive" >> .hg/hgrc
 echo "allow_archive = gz bz2, zip" >> .hg/hgrc
 hg serve -p $HGPORT -d --pid-file=hg.pid
 cat hg.pid >> $DAEMON_PIDS
 
 TIP=`hg id -v | cut -f1 -d' '`
 QTIP=`hg id -q`
 cat > getarchive.py <<EOF
 import os, sys, urllib2
 node, archive = sys.argv[1:]
 f = urllib2.urlopen('http://127.0.0.1:%s/?cmd=archive;node=%s;type=%s'
                     % (os.environ['HGPORT'], node, archive))
 sys.stdout.write(f.read())
 EOF
 http_proxy= python getarchive.py "$TIP" gz | gunzip | tar tf - | sed "s/$QTIP/TIP/"
 http_proxy= python getarchive.py "$TIP" bz2 | bunzip2 | tar tf - | sed "s/$QTIP/TIP/"
 http_proxy= python getarchive.py "$TIP" zip > archive.zip
 unzip -t archive.zip | sed "s/$QTIP/TIP/"
 
 hg archive -t tar test.tar
 tar tf test.tar
 
 hg archive -t tbz2 -X baz test.tar.bz2
 bunzip2 -dc test.tar.bz2 | tar tf -
 
 hg archive -t tgz -p %b-%h test-%h.tar.gz
 gzip -dc test-$QTIP.tar.gz | tar tf - | sed "s/$QTIP/TIP/"
 
 cat > md5comp.py <<EOF
 import md5, sys
 f1, f2 = sys.argv[1:3]
 h1 = md5.md5(file(f1, 'rb').read()).hexdigest()
 h2 = md5.md5(file(f2, 'rb').read()).hexdigest()
 print h1 == h2 or "md5 differ: " + repr((h1, h2))
 EOF
 
 # archive name is stored in the archive, so create similar
 # archives and rename them afterwards.
 hg archive -t tgz tip.tar.gz
 mv tip.tar.gz tip1.tar.gz
 sleep 1
 hg archive -t tgz tip.tar.gz
 mv tip.tar.gz tip2.tar.gz
 python md5comp.py tip1.tar.gz tip2.tar.gz
 
 hg archive -t zip -p /illegal test.zip
 hg archive -t zip -p very/../bad test.zip
 
 hg archive -t zip -r 2 test.zip
 unzip -t test.zip
 
 hg archive -t tar - | tar tf - | sed "s/$QTIP/TIP/"
 
 hg archive -r 0 -t tar rev-%r.tar
 if [ -f rev-0.tar ]; then
     echo 'rev-0.tar created'
 fi
 
+hg archive -t bogus test.bogus
+
 echo '% empty repo'
 hg init ../empty
 cd ../empty
 hg archive ../test-empty
 exit 0

tests/test-archive.out

@@ -1,43 +1,44 b''
 adding foo
 adding bar
 adding baz/bletch
 test-archive-TIP/.hg_archival.txt
 test-archive-TIP/bar
 test-archive-TIP/baz/bletch
 test-archive-TIP/foo
 test-archive-TIP/.hg_archival.txt
 test-archive-TIP/bar
 test-archive-TIP/baz/bletch
 test-archive-TIP/foo
 Archive:  archive.zip
     testing: test-archive-TIP/.hg_archival.txt   OK
     testing: test-archive-TIP/bar   OK
     testing: test-archive-TIP/baz/bletch   OK
     testing: test-archive-TIP/foo   OK
 No errors detected in compressed data of archive.zip.
 test/.hg_archival.txt
 test/bar
 test/baz/bletch
 test/foo
 test/.hg_archival.txt
 test/bar
 test/foo
 test-TIP/.hg_archival.txt
 test-TIP/bar
 test-TIP/baz/bletch
 test-TIP/foo
 True
 abort: archive prefix contains illegal components
 Archive:  test.zip
     testing: test/.hg_archival.txt    OK
     testing: test/bar                 OK
     testing: test/baz/bletch          OK
     testing: test/foo                 OK
 No errors detected in compressed data of test.zip.
 test-TIP/.hg_archival.txt
 test-TIP/bar
 test-TIP/baz/bletch
 test-TIP/foo
 rev-0.tar created
+abort: unknown archive type 'bogus'
 % empty repo
 abort: repository has no revisions