blob: 2c228395d78a2560c13647699b1705ee77e201ee [file] [log] [blame]
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001#!/usr/bin/env python
2# -*- coding: iso-8859-1 -*-
3#-------------------------------------------------------------------
4# tarfile.py
5#-------------------------------------------------------------------
6# Copyright (C) 2002 Lars Gustäbel <lars@gustaebel.de>
7# All rights reserved.
8#
9# Permission is hereby granted, free of charge, to any person
10# obtaining a copy of this software and associated documentation
11# files (the "Software"), to deal in the Software without
12# restriction, including without limitation the rights to use,
13# copy, modify, merge, publish, distribute, sublicense, and/or sell
14# copies of the Software, and to permit persons to whom the
15# Software is furnished to do so, subject to the following
16# conditions:
17#
18# The above copyright notice and this permission notice shall be
19# included in all copies or substantial portions of the Software.
20#
21# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
23# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
24# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
25# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
26# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
28# OTHER DEALINGS IN THE SOFTWARE.
29#
30"""Read from and write to tar format archives.
31"""
32
33__version__ = "$Revision$"
34# $Source$
35
Lars Gustäbelc64e4022007-03-13 10:47:19 +000036version = "0.9.0"
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +000037__author__ = "Lars Gustäbel (lars@gustaebel.de)"
38__date__ = "$Date$"
39__cvsid__ = "$Id$"
40__credits__ = "Gustavo Niemeyer, Niels Gustäbel, Richard Townsend."
41
42#---------
43# Imports
44#---------
45import sys
46import os
47import shutil
48import stat
49import errno
50import time
51import struct
Georg Brandl3354f282006-10-29 09:16:12 +000052import copy
Lars Gustäbelc64e4022007-03-13 10:47:19 +000053import re
Brett Cannon132fc542008-08-04 21:23:07 +000054import operator
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +000055
Jack Jansencfc49022003-03-07 13:37:32 +000056if sys.platform == 'mac':
57 # This module needs work for MacOS9, especially in the area of pathname
58 # handling. In many places it is assumed a simple substitution of / by the
59 # local os.path.sep is good enough to convert pathnames, but this does not
60 # work with the mac rooted:path:name versus :nonrooted:path:name syntax
61 raise ImportError, "tarfile does not work for platform==mac"
62
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +000063try:
64 import grp, pwd
65except ImportError:
66 grp = pwd = None
67
68# from tarfile import *
69__all__ = ["TarFile", "TarInfo", "is_tarfile", "TarError"]
70
71#---------------------------------------------------------
72# tar constants
73#---------------------------------------------------------
Lars Gustäbelc64e4022007-03-13 10:47:19 +000074NUL = "\0" # the null character
75BLOCKSIZE = 512 # length of processing blocks
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +000076RECORDSIZE = BLOCKSIZE * 20 # length of records
Lars Gustäbelc64e4022007-03-13 10:47:19 +000077GNU_MAGIC = "ustar \0" # magic gnu tar string
78POSIX_MAGIC = "ustar\x0000" # magic posix tar string
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +000079
Lars Gustäbelc64e4022007-03-13 10:47:19 +000080LENGTH_NAME = 100 # maximum length of a filename
81LENGTH_LINK = 100 # maximum length of a linkname
82LENGTH_PREFIX = 155 # maximum length of the prefix field
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +000083
Lars Gustäbelc64e4022007-03-13 10:47:19 +000084REGTYPE = "0" # regular file
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +000085AREGTYPE = "\0" # regular file
Lars Gustäbelc64e4022007-03-13 10:47:19 +000086LNKTYPE = "1" # link (inside tarfile)
87SYMTYPE = "2" # symbolic link
88CHRTYPE = "3" # character special device
89BLKTYPE = "4" # block special device
90DIRTYPE = "5" # directory
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +000091FIFOTYPE = "6" # fifo special device
92CONTTYPE = "7" # contiguous file
93
Lars Gustäbelc64e4022007-03-13 10:47:19 +000094GNUTYPE_LONGNAME = "L" # GNU tar longname
95GNUTYPE_LONGLINK = "K" # GNU tar longlink
96GNUTYPE_SPARSE = "S" # GNU tar sparse file
97
98XHDTYPE = "x" # POSIX.1-2001 extended header
99XGLTYPE = "g" # POSIX.1-2001 global header
100SOLARIS_XHDTYPE = "X" # Solaris extended header
101
102USTAR_FORMAT = 0 # POSIX.1-1988 (ustar) format
103GNU_FORMAT = 1 # GNU tar format
104PAX_FORMAT = 2 # POSIX.1-2001 (pax) format
105DEFAULT_FORMAT = GNU_FORMAT
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000106
107#---------------------------------------------------------
108# tarfile constants
109#---------------------------------------------------------
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000110# File types that tarfile supports:
111SUPPORTED_TYPES = (REGTYPE, AREGTYPE, LNKTYPE,
112 SYMTYPE, DIRTYPE, FIFOTYPE,
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000113 CONTTYPE, CHRTYPE, BLKTYPE,
114 GNUTYPE_LONGNAME, GNUTYPE_LONGLINK,
115 GNUTYPE_SPARSE)
116
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000117# File types that will be treated as a regular file.
118REGULAR_TYPES = (REGTYPE, AREGTYPE,
119 CONTTYPE, GNUTYPE_SPARSE)
120
121# File types that are part of the GNU tar format.
122GNU_TYPES = (GNUTYPE_LONGNAME, GNUTYPE_LONGLINK,
123 GNUTYPE_SPARSE)
124
125# Fields from a pax header that override a TarInfo attribute.
126PAX_FIELDS = ("path", "linkpath", "size", "mtime",
127 "uid", "gid", "uname", "gname")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000128
Lars Gustäbela0fcb932007-05-27 19:49:30 +0000129# Fields in a pax header that are numbers, all other fields
130# are treated as strings.
131PAX_NUMBER_FIELDS = {
132 "atime": float,
133 "ctime": float,
134 "mtime": float,
135 "uid": int,
136 "gid": int,
137 "size": int
138}
139
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000140#---------------------------------------------------------
141# Bits used in the mode field, values in octal.
142#---------------------------------------------------------
143S_IFLNK = 0120000 # symbolic link
144S_IFREG = 0100000 # regular file
145S_IFBLK = 0060000 # block device
146S_IFDIR = 0040000 # directory
147S_IFCHR = 0020000 # character device
148S_IFIFO = 0010000 # fifo
149
150TSUID = 04000 # set UID on execution
151TSGID = 02000 # set GID on execution
152TSVTX = 01000 # reserved
153
154TUREAD = 0400 # read by owner
155TUWRITE = 0200 # write by owner
156TUEXEC = 0100 # execute/search by owner
157TGREAD = 0040 # read by group
158TGWRITE = 0020 # write by group
159TGEXEC = 0010 # execute/search by group
160TOREAD = 0004 # read by other
161TOWRITE = 0002 # write by other
162TOEXEC = 0001 # execute/search by other
163
164#---------------------------------------------------------
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000165# initialization
166#---------------------------------------------------------
167ENCODING = sys.getfilesystemencoding()
168if ENCODING is None:
Lars Gustäbela0fcb932007-05-27 19:49:30 +0000169 ENCODING = sys.getdefaultencoding()
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000170
171#---------------------------------------------------------
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000172# Some useful functions
173#---------------------------------------------------------
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000174
Georg Brandl38c6a222006-05-10 16:26:03 +0000175def stn(s, length):
176 """Convert a python string to a null-terminated string buffer.
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000177 """
Georg Brandla32e0a02006-10-24 16:54:16 +0000178 return s[:length] + (length - len(s)) * NUL
Georg Brandl38c6a222006-05-10 16:26:03 +0000179
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000180def nts(s):
181 """Convert a null-terminated string field to a python string.
182 """
183 # Use the string up to the first null char.
184 p = s.find("\0")
185 if p == -1:
186 return s
187 return s[:p]
188
Georg Brandl38c6a222006-05-10 16:26:03 +0000189def nti(s):
190 """Convert a number field to a python number.
191 """
192 # There are two possible encodings for a number field, see
193 # itn() below.
194 if s[0] != chr(0200):
Georg Brandlded1c4d2006-12-20 11:55:16 +0000195 try:
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000196 n = int(nts(s) or "0", 8)
Georg Brandlded1c4d2006-12-20 11:55:16 +0000197 except ValueError:
198 raise HeaderError("invalid header")
Georg Brandl38c6a222006-05-10 16:26:03 +0000199 else:
200 n = 0L
201 for i in xrange(len(s) - 1):
202 n <<= 8
203 n += ord(s[i + 1])
204 return n
205
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000206def itn(n, digits=8, format=DEFAULT_FORMAT):
Georg Brandl38c6a222006-05-10 16:26:03 +0000207 """Convert a python number to a number field.
208 """
209 # POSIX 1003.1-1988 requires numbers to be encoded as a string of
210 # octal digits followed by a null-byte, this allows values up to
211 # (8**(digits-1))-1. GNU tar allows storing numbers greater than
212 # that if necessary. A leading 0200 byte indicates this particular
213 # encoding, the following digits-1 bytes are a big-endian
214 # representation. This allows values up to (256**(digits-1))-1.
215 if 0 <= n < 8 ** (digits - 1):
216 s = "%0*o" % (digits - 1, n) + NUL
217 else:
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000218 if format != GNU_FORMAT or n >= 256 ** (digits - 1):
Georg Brandle4751e32006-05-18 06:11:19 +0000219 raise ValueError("overflow in number field")
Georg Brandl38c6a222006-05-10 16:26:03 +0000220
221 if n < 0:
222 # XXX We mimic GNU tar's behaviour with negative numbers,
223 # this could raise OverflowError.
224 n = struct.unpack("L", struct.pack("l", n))[0]
225
226 s = ""
227 for i in xrange(digits - 1):
228 s = chr(n & 0377) + s
229 n >>= 8
230 s = chr(0200) + s
231 return s
232
Lars Gustäbela0fcb932007-05-27 19:49:30 +0000233def uts(s, encoding, errors):
234 """Convert a unicode object to a string.
235 """
236 if errors == "utf-8":
237 # An extra error handler similar to the -o invalid=UTF-8 option
238 # in POSIX.1-2001. Replace untranslatable characters with their
239 # UTF-8 representation.
240 try:
241 return s.encode(encoding, "strict")
242 except UnicodeEncodeError:
243 x = []
244 for c in s:
245 try:
246 x.append(c.encode(encoding, "strict"))
247 except UnicodeEncodeError:
248 x.append(c.encode("utf8"))
249 return "".join(x)
250 else:
251 return s.encode(encoding, errors)
252
Georg Brandl38c6a222006-05-10 16:26:03 +0000253def calc_chksums(buf):
254 """Calculate the checksum for a member's header by summing up all
255 characters except for the chksum field which is treated as if
256 it was filled with spaces. According to the GNU tar sources,
257 some tars (Sun and NeXT) calculate chksum with signed char,
258 which will be different if there are chars in the buffer with
259 the high bit set. So we calculate two checksums, unsigned and
260 signed.
261 """
262 unsigned_chksum = 256 + sum(struct.unpack("148B", buf[:148]) + struct.unpack("356B", buf[156:512]))
263 signed_chksum = 256 + sum(struct.unpack("148b", buf[:148]) + struct.unpack("356b", buf[156:512]))
264 return unsigned_chksum, signed_chksum
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000265
266def copyfileobj(src, dst, length=None):
267 """Copy length bytes from fileobj src to fileobj dst.
268 If length is None, copy the entire content.
269 """
270 if length == 0:
271 return
272 if length is None:
273 shutil.copyfileobj(src, dst)
274 return
275
276 BUFSIZE = 16 * 1024
277 blocks, remainder = divmod(length, BUFSIZE)
278 for b in xrange(blocks):
279 buf = src.read(BUFSIZE)
280 if len(buf) < BUFSIZE:
Georg Brandle4751e32006-05-18 06:11:19 +0000281 raise IOError("end of file reached")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000282 dst.write(buf)
283
284 if remainder != 0:
285 buf = src.read(remainder)
286 if len(buf) < remainder:
Georg Brandle4751e32006-05-18 06:11:19 +0000287 raise IOError("end of file reached")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000288 dst.write(buf)
289 return
290
291filemode_table = (
Andrew M. Kuchling8bc462f2004-10-20 11:48:42 +0000292 ((S_IFLNK, "l"),
293 (S_IFREG, "-"),
294 (S_IFBLK, "b"),
295 (S_IFDIR, "d"),
296 (S_IFCHR, "c"),
297 (S_IFIFO, "p")),
298
299 ((TUREAD, "r"),),
300 ((TUWRITE, "w"),),
301 ((TUEXEC|TSUID, "s"),
302 (TSUID, "S"),
303 (TUEXEC, "x")),
304
305 ((TGREAD, "r"),),
306 ((TGWRITE, "w"),),
307 ((TGEXEC|TSGID, "s"),
308 (TSGID, "S"),
309 (TGEXEC, "x")),
310
311 ((TOREAD, "r"),),
312 ((TOWRITE, "w"),),
313 ((TOEXEC|TSVTX, "t"),
314 (TSVTX, "T"),
315 (TOEXEC, "x"))
316)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000317
318def filemode(mode):
319 """Convert a file's mode to a string of the form
320 -rwxrwxrwx.
321 Used by TarFile.list()
322 """
Andrew M. Kuchling8bc462f2004-10-20 11:48:42 +0000323 perm = []
324 for table in filemode_table:
325 for bit, char in table:
326 if mode & bit == bit:
327 perm.append(char)
328 break
329 else:
330 perm.append("-")
331 return "".join(perm)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000332
333if os.sep != "/":
334 normpath = lambda path: os.path.normpath(path).replace(os.sep, "/")
335else:
336 normpath = os.path.normpath
337
338class TarError(Exception):
339 """Base exception."""
340 pass
341class ExtractError(TarError):
342 """General exception for extract errors."""
343 pass
344class ReadError(TarError):
345 """Exception for unreadble tar archives."""
346 pass
347class CompressionError(TarError):
348 """Exception for unavailable compression methods."""
349 pass
350class StreamError(TarError):
351 """Exception for unsupported operations on stream-like TarFiles."""
352 pass
Georg Brandlebbeed72006-12-19 22:06:46 +0000353class HeaderError(TarError):
354 """Exception for invalid headers."""
355 pass
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000356
357#---------------------------
358# internal stream interface
359#---------------------------
360class _LowLevelFile:
361 """Low-level file object. Supports reading and writing.
362 It is used instead of a regular file object for streaming
363 access.
364 """
365
366 def __init__(self, name, mode):
367 mode = {
368 "r": os.O_RDONLY,
369 "w": os.O_WRONLY | os.O_CREAT | os.O_TRUNC,
370 }[mode]
371 if hasattr(os, "O_BINARY"):
372 mode |= os.O_BINARY
373 self.fd = os.open(name, mode)
374
375 def close(self):
376 os.close(self.fd)
377
378 def read(self, size):
379 return os.read(self.fd, size)
380
381 def write(self, s):
382 os.write(self.fd, s)
383
384class _Stream:
385 """Class that serves as an adapter between TarFile and
386 a stream-like object. The stream-like object only
387 needs to have a read() or write() method and is accessed
388 blockwise. Use of gzip or bzip2 compression is possible.
389 A stream-like object could be for example: sys.stdin,
390 sys.stdout, a socket, a tape device etc.
391
392 _Stream is intended to be used only internally.
393 """
394
Martin v. Löwis78be7df2005-03-05 12:47:42 +0000395 def __init__(self, name, mode, comptype, fileobj, bufsize):
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000396 """Construct a _Stream object.
397 """
398 self._extfileobj = True
399 if fileobj is None:
400 fileobj = _LowLevelFile(name, mode)
401 self._extfileobj = False
402
Martin v. Löwis78be7df2005-03-05 12:47:42 +0000403 if comptype == '*':
404 # Enable transparent compression detection for the
405 # stream interface
406 fileobj = _StreamProxy(fileobj)
407 comptype = fileobj.getcomptype()
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000408
Martin v. Löwis78be7df2005-03-05 12:47:42 +0000409 self.name = name or ""
410 self.mode = mode
411 self.comptype = comptype
412 self.fileobj = fileobj
413 self.bufsize = bufsize
414 self.buf = ""
415 self.pos = 0L
416 self.closed = False
417
418 if comptype == "gz":
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000419 try:
420 import zlib
421 except ImportError:
Georg Brandle4751e32006-05-18 06:11:19 +0000422 raise CompressionError("zlib module is not available")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000423 self.zlib = zlib
Gregory P. Smith88440962008-03-25 06:12:45 +0000424 self.crc = zlib.crc32("") & 0xffffffffL
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000425 if mode == "r":
426 self._init_read_gz()
427 else:
428 self._init_write_gz()
429
Martin v. Löwis78be7df2005-03-05 12:47:42 +0000430 if comptype == "bz2":
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000431 try:
432 import bz2
433 except ImportError:
Georg Brandle4751e32006-05-18 06:11:19 +0000434 raise CompressionError("bz2 module is not available")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000435 if mode == "r":
436 self.dbuf = ""
437 self.cmp = bz2.BZ2Decompressor()
438 else:
439 self.cmp = bz2.BZ2Compressor()
440
441 def __del__(self):
Martin v. Löwis78be7df2005-03-05 12:47:42 +0000442 if hasattr(self, "closed") and not self.closed:
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000443 self.close()
444
445 def _init_write_gz(self):
446 """Initialize for writing with gzip compression.
447 """
448 self.cmp = self.zlib.compressobj(9, self.zlib.DEFLATED,
449 -self.zlib.MAX_WBITS,
450 self.zlib.DEF_MEM_LEVEL,
451 0)
452 timestamp = struct.pack("<L", long(time.time()))
453 self.__write("\037\213\010\010%s\002\377" % timestamp)
454 if self.name.endswith(".gz"):
455 self.name = self.name[:-3]
456 self.__write(self.name + NUL)
457
458 def write(self, s):
459 """Write string s to the stream.
460 """
Martin v. Löwis78be7df2005-03-05 12:47:42 +0000461 if self.comptype == "gz":
Gregory P. Smith88440962008-03-25 06:12:45 +0000462 self.crc = self.zlib.crc32(s, self.crc) & 0xffffffffL
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000463 self.pos += len(s)
Martin v. Löwis78be7df2005-03-05 12:47:42 +0000464 if self.comptype != "tar":
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000465 s = self.cmp.compress(s)
466 self.__write(s)
467
468 def __write(self, s):
469 """Write string s to the stream if a whole new block
470 is ready to be written.
471 """
472 self.buf += s
473 while len(self.buf) > self.bufsize:
474 self.fileobj.write(self.buf[:self.bufsize])
475 self.buf = self.buf[self.bufsize:]
476
477 def close(self):
478 """Close the _Stream object. No operation should be
479 done on it afterwards.
480 """
481 if self.closed:
482 return
483
Martin v. Löwis78be7df2005-03-05 12:47:42 +0000484 if self.mode == "w" and self.comptype != "tar":
Martin v. Löwisc234a522004-08-22 21:28:33 +0000485 self.buf += self.cmp.flush()
Martin v. Löwis78be7df2005-03-05 12:47:42 +0000486
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000487 if self.mode == "w" and self.buf:
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000488 self.fileobj.write(self.buf)
489 self.buf = ""
Martin v. Löwis78be7df2005-03-05 12:47:42 +0000490 if self.comptype == "gz":
Tim Petersa05f6e22006-08-02 05:20:08 +0000491 # The native zlib crc is an unsigned 32-bit integer, but
492 # the Python wrapper implicitly casts that to a signed C
493 # long. So, on a 32-bit box self.crc may "look negative",
494 # while the same crc on a 64-bit box may "look positive".
495 # To avoid irksome warnings from the `struct` module, force
496 # it to look positive on all boxes.
497 self.fileobj.write(struct.pack("<L", self.crc & 0xffffffffL))
Andrew M. Kuchling10a44492003-10-24 17:38:34 +0000498 self.fileobj.write(struct.pack("<L", self.pos & 0xffffFFFFL))
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000499
500 if not self._extfileobj:
501 self.fileobj.close()
502
503 self.closed = True
504
505 def _init_read_gz(self):
506 """Initialize for reading a gzip compressed fileobj.
507 """
508 self.cmp = self.zlib.decompressobj(-self.zlib.MAX_WBITS)
509 self.dbuf = ""
510
511 # taken from gzip.GzipFile with some alterations
512 if self.__read(2) != "\037\213":
Georg Brandle4751e32006-05-18 06:11:19 +0000513 raise ReadError("not a gzip file")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000514 if self.__read(1) != "\010":
Georg Brandle4751e32006-05-18 06:11:19 +0000515 raise CompressionError("unsupported compression method")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000516
517 flag = ord(self.__read(1))
518 self.__read(6)
519
520 if flag & 4:
521 xlen = ord(self.__read(1)) + 256 * ord(self.__read(1))
522 self.read(xlen)
523 if flag & 8:
524 while True:
525 s = self.__read(1)
526 if not s or s == NUL:
527 break
528 if flag & 16:
529 while True:
530 s = self.__read(1)
531 if not s or s == NUL:
532 break
533 if flag & 2:
534 self.__read(2)
535
536 def tell(self):
537 """Return the stream's file pointer position.
538 """
539 return self.pos
540
541 def seek(self, pos=0):
542 """Set the stream's file pointer to pos. Negative seeking
543 is forbidden.
544 """
545 if pos - self.pos >= 0:
546 blocks, remainder = divmod(pos - self.pos, self.bufsize)
547 for i in xrange(blocks):
548 self.read(self.bufsize)
549 self.read(remainder)
550 else:
Georg Brandle4751e32006-05-18 06:11:19 +0000551 raise StreamError("seeking backwards is not allowed")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000552 return self.pos
553
554 def read(self, size=None):
555 """Return the next size number of bytes from the stream.
556 If size is not defined, return all bytes of the stream
557 up to EOF.
558 """
559 if size is None:
560 t = []
561 while True:
562 buf = self._read(self.bufsize)
563 if not buf:
564 break
565 t.append(buf)
566 buf = "".join(t)
567 else:
568 buf = self._read(size)
569 self.pos += len(buf)
570 return buf
571
572 def _read(self, size):
573 """Return size bytes from the stream.
574 """
Martin v. Löwis78be7df2005-03-05 12:47:42 +0000575 if self.comptype == "tar":
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000576 return self.__read(size)
577
578 c = len(self.dbuf)
579 t = [self.dbuf]
580 while c < size:
581 buf = self.__read(self.bufsize)
582 if not buf:
583 break
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000584 try:
585 buf = self.cmp.decompress(buf)
586 except IOError:
587 raise ReadError("invalid compressed data")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000588 t.append(buf)
589 c += len(buf)
590 t = "".join(t)
591 self.dbuf = t[size:]
592 return t[:size]
593
594 def __read(self, size):
595 """Return size bytes from stream. If internal buffer is empty,
596 read another block from the stream.
597 """
598 c = len(self.buf)
599 t = [self.buf]
600 while c < size:
601 buf = self.fileobj.read(self.bufsize)
602 if not buf:
603 break
604 t.append(buf)
605 c += len(buf)
606 t = "".join(t)
607 self.buf = t[size:]
608 return t[:size]
609# class _Stream
610
Martin v. Löwis78be7df2005-03-05 12:47:42 +0000611class _StreamProxy(object):
612 """Small proxy class that enables transparent compression
613 detection for the Stream interface (mode 'r|*').
614 """
615
616 def __init__(self, fileobj):
617 self.fileobj = fileobj
618 self.buf = self.fileobj.read(BLOCKSIZE)
619
620 def read(self, size):
621 self.read = self.fileobj.read
622 return self.buf
623
624 def getcomptype(self):
625 if self.buf.startswith("\037\213\010"):
626 return "gz"
627 if self.buf.startswith("BZh91"):
628 return "bz2"
629 return "tar"
630
631 def close(self):
632 self.fileobj.close()
633# class StreamProxy
634
Georg Brandl49c8f4c2006-05-15 19:30:35 +0000635class _BZ2Proxy(object):
636 """Small proxy class that enables external file object
637 support for "r:bz2" and "w:bz2" modes. This is actually
638 a workaround for a limitation in bz2 module's BZ2File
639 class which (unlike gzip.GzipFile) has no support for
640 a file object argument.
641 """
642
643 blocksize = 16 * 1024
644
645 def __init__(self, fileobj, mode):
646 self.fileobj = fileobj
647 self.mode = mode
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000648 self.name = getattr(self.fileobj, "name", None)
Georg Brandl49c8f4c2006-05-15 19:30:35 +0000649 self.init()
650
651 def init(self):
652 import bz2
653 self.pos = 0
654 if self.mode == "r":
655 self.bz2obj = bz2.BZ2Decompressor()
656 self.fileobj.seek(0)
657 self.buf = ""
658 else:
659 self.bz2obj = bz2.BZ2Compressor()
660
661 def read(self, size):
662 b = [self.buf]
663 x = len(self.buf)
664 while x < size:
Lars Gustäbel9e2a09a2009-03-22 20:22:29 +0000665 raw = self.fileobj.read(self.blocksize)
666 if not raw:
Georg Brandl49c8f4c2006-05-15 19:30:35 +0000667 break
Lars Gustäbel4f908dd2009-03-22 21:29:48 +0000668 try:
669 data = self.bz2obj.decompress(raw)
670 except EOFError:
671 break
Lars Gustäbel9e2a09a2009-03-22 20:22:29 +0000672 b.append(data)
Georg Brandl49c8f4c2006-05-15 19:30:35 +0000673 x += len(data)
674 self.buf = "".join(b)
675
676 buf = self.buf[:size]
677 self.buf = self.buf[size:]
678 self.pos += len(buf)
679 return buf
680
681 def seek(self, pos):
682 if pos < self.pos:
683 self.init()
684 self.read(pos - self.pos)
685
686 def tell(self):
687 return self.pos
688
689 def write(self, data):
690 self.pos += len(data)
691 raw = self.bz2obj.compress(data)
692 self.fileobj.write(raw)
693
694 def close(self):
695 if self.mode == "w":
696 raw = self.bz2obj.flush()
697 self.fileobj.write(raw)
Georg Brandl49c8f4c2006-05-15 19:30:35 +0000698# class _BZ2Proxy
699
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000700#------------------------
701# Extraction file object
702#------------------------
Lars Gustäbel6baa5022006-12-23 16:40:13 +0000703class _FileInFile(object):
704 """A thin wrapper around an existing file object that
705 provides a part of its data as an individual file
706 object.
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000707 """
708
Lars Gustäbel6baa5022006-12-23 16:40:13 +0000709 def __init__(self, fileobj, offset, size, sparse=None):
710 self.fileobj = fileobj
711 self.offset = offset
712 self.size = size
713 self.sparse = sparse
714 self.position = 0
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000715
Lars Gustäbel6baa5022006-12-23 16:40:13 +0000716 def tell(self):
717 """Return the current file position.
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000718 """
Lars Gustäbel6baa5022006-12-23 16:40:13 +0000719 return self.position
720
721 def seek(self, position):
722 """Seek to a position in the file.
723 """
724 self.position = position
725
726 def read(self, size=None):
727 """Read data from the file.
728 """
729 if size is None:
730 size = self.size - self.position
731 else:
732 size = min(size, self.size - self.position)
733
734 if self.sparse is None:
735 return self.readnormal(size)
736 else:
737 return self.readsparse(size)
738
739 def readnormal(self, size):
740 """Read operation for regular files.
741 """
742 self.fileobj.seek(self.offset + self.position)
743 self.position += size
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000744 return self.fileobj.read(size)
745
Lars Gustäbel6baa5022006-12-23 16:40:13 +0000746 def readsparse(self, size):
747 """Read operation for sparse files.
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000748 """
Lars Gustäbel6baa5022006-12-23 16:40:13 +0000749 data = []
750 while size > 0:
751 buf = self.readsparsesection(size)
752 if not buf:
753 break
754 size -= len(buf)
755 data.append(buf)
756 return "".join(data)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000757
Lars Gustäbel6baa5022006-12-23 16:40:13 +0000758 def readsparsesection(self, size):
759 """Read a single section of a sparse file.
760 """
761 section = self.sparse.find(self.position)
762
763 if section is None:
764 return ""
765
766 size = min(size, section.offset + section.size - self.position)
767
768 if isinstance(section, _data):
769 realpos = section.realpos + self.position - section.offset
770 self.fileobj.seek(self.offset + realpos)
771 self.position += size
772 return self.fileobj.read(size)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000773 else:
Lars Gustäbel6baa5022006-12-23 16:40:13 +0000774 self.position += size
775 return NUL * size
776#class _FileInFile
777
778
779class ExFileObject(object):
780 """File-like object for reading an archive member.
781 Is returned by TarFile.extractfile().
782 """
783 blocksize = 1024
784
785 def __init__(self, tarfile, tarinfo):
786 self.fileobj = _FileInFile(tarfile.fileobj,
787 tarinfo.offset_data,
788 tarinfo.size,
789 getattr(tarinfo, "sparse", None))
790 self.name = tarinfo.name
791 self.mode = "r"
792 self.closed = False
793 self.size = tarinfo.size
794
795 self.position = 0
796 self.buffer = ""
797
798 def read(self, size=None):
799 """Read at most size bytes from the file. If size is not
800 present or None, read all data until EOF is reached.
801 """
802 if self.closed:
803 raise ValueError("I/O operation on closed file")
804
805 buf = ""
806 if self.buffer:
807 if size is None:
808 buf = self.buffer
809 self.buffer = ""
810 else:
811 buf = self.buffer[:size]
812 self.buffer = self.buffer[size:]
813
814 if size is None:
815 buf += self.fileobj.read()
816 else:
817 buf += self.fileobj.read(size - len(buf))
818
819 self.position += len(buf)
820 return buf
821
822 def readline(self, size=-1):
823 """Read one entire line from the file. If size is present
824 and non-negative, return a string with at most that
825 size, which may be an incomplete line.
826 """
827 if self.closed:
828 raise ValueError("I/O operation on closed file")
829
830 if "\n" in self.buffer:
831 pos = self.buffer.find("\n") + 1
832 else:
833 buffers = [self.buffer]
834 while True:
835 buf = self.fileobj.read(self.blocksize)
836 buffers.append(buf)
837 if not buf or "\n" in buf:
838 self.buffer = "".join(buffers)
839 pos = self.buffer.find("\n") + 1
840 if pos == 0:
841 # no newline found.
842 pos = len(self.buffer)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000843 break
Lars Gustäbel6baa5022006-12-23 16:40:13 +0000844
845 if size != -1:
846 pos = min(size, pos)
847
848 buf = self.buffer[:pos]
849 self.buffer = self.buffer[pos:]
850 self.position += len(buf)
851 return buf
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000852
853 def readlines(self):
Lars Gustäbel6baa5022006-12-23 16:40:13 +0000854 """Return a list with all remaining lines.
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000855 """
856 result = []
857 while True:
858 line = self.readline()
859 if not line: break
860 result.append(line)
861 return result
862
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000863 def tell(self):
864 """Return the current file position.
865 """
Lars Gustäbel6baa5022006-12-23 16:40:13 +0000866 if self.closed:
867 raise ValueError("I/O operation on closed file")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000868
Lars Gustäbel6baa5022006-12-23 16:40:13 +0000869 return self.position
870
871 def seek(self, pos, whence=os.SEEK_SET):
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000872 """Seek to a position in the file.
873 """
Lars Gustäbel6baa5022006-12-23 16:40:13 +0000874 if self.closed:
875 raise ValueError("I/O operation on closed file")
876
877 if whence == os.SEEK_SET:
878 self.position = min(max(pos, 0), self.size)
879 elif whence == os.SEEK_CUR:
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000880 if pos < 0:
Lars Gustäbel6baa5022006-12-23 16:40:13 +0000881 self.position = max(self.position + pos, 0)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000882 else:
Lars Gustäbel6baa5022006-12-23 16:40:13 +0000883 self.position = min(self.position + pos, self.size)
884 elif whence == os.SEEK_END:
885 self.position = max(min(self.size + pos, self.size), 0)
886 else:
887 raise ValueError("Invalid argument")
888
889 self.buffer = ""
890 self.fileobj.seek(self.position)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000891
892 def close(self):
893 """Close the file object.
894 """
895 self.closed = True
Martin v. Löwisdf241532005-03-03 08:17:42 +0000896
897 def __iter__(self):
Lars Gustäbel6baa5022006-12-23 16:40:13 +0000898 """Get an iterator over the file's lines.
Martin v. Löwisdf241532005-03-03 08:17:42 +0000899 """
Lars Gustäbel6baa5022006-12-23 16:40:13 +0000900 while True:
901 line = self.readline()
902 if not line:
903 break
904 yield line
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000905#class ExFileObject
906
907#------------------
908# Exported Classes
909#------------------
910class TarInfo(object):
911 """Informational class which holds the details about an
912 archive member given by a tar header block.
913 TarInfo objects are returned by TarFile.getmember(),
914 TarFile.getmembers() and TarFile.gettarinfo() and are
915 usually created internally.
916 """
917
918 def __init__(self, name=""):
919 """Construct a TarInfo object. name is the optional name
920 of the member.
921 """
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000922 self.name = name # member name
923 self.mode = 0644 # file permissions
Georg Brandl38c6a222006-05-10 16:26:03 +0000924 self.uid = 0 # user id
925 self.gid = 0 # group id
926 self.size = 0 # file size
927 self.mtime = 0 # modification time
928 self.chksum = 0 # header checksum
929 self.type = REGTYPE # member type
930 self.linkname = "" # link name
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000931 self.uname = "root" # user name
932 self.gname = "root" # group name
Georg Brandl38c6a222006-05-10 16:26:03 +0000933 self.devmajor = 0 # device major number
934 self.devminor = 0 # device minor number
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000935
Georg Brandl38c6a222006-05-10 16:26:03 +0000936 self.offset = 0 # the tar header starts here
937 self.offset_data = 0 # the file's data starts here
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000938
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000939 self.pax_headers = {} # pax header information
940
941 # In pax headers the "name" and "linkname" field are called
942 # "path" and "linkpath".
943 def _getpath(self):
944 return self.name
945 def _setpath(self, name):
946 self.name = name
947 path = property(_getpath, _setpath)
948
949 def _getlinkpath(self):
950 return self.linkname
951 def _setlinkpath(self, linkname):
952 self.linkname = linkname
953 linkpath = property(_getlinkpath, _setlinkpath)
954
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +0000955 def __repr__(self):
956 return "<%s %r at %#x>" % (self.__class__.__name__,self.name,id(self))
957
Lars Gustäbela0fcb932007-05-27 19:49:30 +0000958 def get_info(self, encoding, errors):
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000959 """Return the TarInfo's attributes as a dictionary.
960 """
961 info = {
962 "name": normpath(self.name),
963 "mode": self.mode & 07777,
964 "uid": self.uid,
965 "gid": self.gid,
966 "size": self.size,
967 "mtime": self.mtime,
968 "chksum": self.chksum,
969 "type": self.type,
970 "linkname": normpath(self.linkname) if self.linkname else "",
971 "uname": self.uname,
972 "gname": self.gname,
973 "devmajor": self.devmajor,
974 "devminor": self.devminor
975 }
976
977 if info["type"] == DIRTYPE and not info["name"].endswith("/"):
978 info["name"] += "/"
979
Lars Gustäbela0fcb932007-05-27 19:49:30 +0000980 for key in ("name", "linkname", "uname", "gname"):
981 if type(info[key]) is unicode:
982 info[key] = info[key].encode(encoding, errors)
983
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000984 return info
985
Lars Gustäbela0fcb932007-05-27 19:49:30 +0000986 def tobuf(self, format=DEFAULT_FORMAT, encoding=ENCODING, errors="strict"):
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000987 """Return a tar header as a string of 512 byte blocks.
988 """
Lars Gustäbela0fcb932007-05-27 19:49:30 +0000989 info = self.get_info(encoding, errors)
990
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000991 if format == USTAR_FORMAT:
Lars Gustäbela0fcb932007-05-27 19:49:30 +0000992 return self.create_ustar_header(info)
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000993 elif format == GNU_FORMAT:
Lars Gustäbela0fcb932007-05-27 19:49:30 +0000994 return self.create_gnu_header(info)
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000995 elif format == PAX_FORMAT:
Lars Gustäbela0fcb932007-05-27 19:49:30 +0000996 return self.create_pax_header(info, encoding, errors)
Lars Gustäbelc64e4022007-03-13 10:47:19 +0000997 else:
998 raise ValueError("invalid format")
999
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001000 def create_ustar_header(self, info):
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001001 """Return the object as a ustar header block.
1002 """
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001003 info["magic"] = POSIX_MAGIC
1004
1005 if len(info["linkname"]) > LENGTH_LINK:
1006 raise ValueError("linkname is too long")
1007
1008 if len(info["name"]) > LENGTH_NAME:
1009 info["prefix"], info["name"] = self._posix_split_name(info["name"])
1010
1011 return self._create_header(info, USTAR_FORMAT)
1012
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001013 def create_gnu_header(self, info):
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001014 """Return the object as a GNU header block sequence.
1015 """
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001016 info["magic"] = GNU_MAGIC
1017
1018 buf = ""
1019 if len(info["linkname"]) > LENGTH_LINK:
1020 buf += self._create_gnu_long_header(info["linkname"], GNUTYPE_LONGLINK)
1021
1022 if len(info["name"]) > LENGTH_NAME:
1023 buf += self._create_gnu_long_header(info["name"], GNUTYPE_LONGNAME)
1024
1025 return buf + self._create_header(info, GNU_FORMAT)
1026
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001027 def create_pax_header(self, info, encoding, errors):
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001028 """Return the object as a ustar header block. If it cannot be
1029 represented this way, prepend a pax extended header sequence
1030 with supplement information.
1031 """
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001032 info["magic"] = POSIX_MAGIC
1033 pax_headers = self.pax_headers.copy()
1034
1035 # Test string fields for values that exceed the field length or cannot
1036 # be represented in ASCII encoding.
1037 for name, hname, length in (
1038 ("name", "path", LENGTH_NAME), ("linkname", "linkpath", LENGTH_LINK),
1039 ("uname", "uname", 32), ("gname", "gname", 32)):
1040
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001041 if hname in pax_headers:
1042 # The pax header has priority.
1043 continue
1044
1045 val = info[name].decode(encoding, errors)
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001046
1047 # Try to encode the string as ASCII.
1048 try:
1049 val.encode("ascii")
1050 except UnicodeEncodeError:
1051 pax_headers[hname] = val
1052 continue
1053
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001054 if len(info[name]) > length:
1055 pax_headers[hname] = val
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001056
1057 # Test number fields for values that exceed the field limit or values
1058 # that like to be stored as float.
1059 for name, digits in (("uid", 8), ("gid", 8), ("size", 12), ("mtime", 12)):
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001060 if name in pax_headers:
1061 # The pax header has priority. Avoid overflow.
1062 info[name] = 0
1063 continue
1064
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001065 val = info[name]
1066 if not 0 <= val < 8 ** (digits - 1) or isinstance(val, float):
1067 pax_headers[name] = unicode(val)
1068 info[name] = 0
1069
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001070 # Create a pax extended header if necessary.
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001071 if pax_headers:
1072 buf = self._create_pax_generic_header(pax_headers)
1073 else:
1074 buf = ""
1075
1076 return buf + self._create_header(info, USTAR_FORMAT)
1077
1078 @classmethod
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001079 def create_pax_global_header(cls, pax_headers):
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001080 """Return the object as a pax global header block sequence.
1081 """
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001082 return cls._create_pax_generic_header(pax_headers, type=XGLTYPE)
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001083
1084 def _posix_split_name(self, name):
1085 """Split a name longer than 100 chars into a prefix
1086 and a name part.
1087 """
1088 prefix = name[:LENGTH_PREFIX + 1]
1089 while prefix and prefix[-1] != "/":
1090 prefix = prefix[:-1]
1091
1092 name = name[len(prefix):]
1093 prefix = prefix[:-1]
1094
1095 if not prefix or len(name) > LENGTH_NAME:
1096 raise ValueError("name is too long")
1097 return prefix, name
1098
1099 @staticmethod
1100 def _create_header(info, format):
1101 """Return a header block. info is a dictionary with file
1102 information, format must be one of the *_FORMAT constants.
1103 """
1104 parts = [
1105 stn(info.get("name", ""), 100),
1106 itn(info.get("mode", 0) & 07777, 8, format),
1107 itn(info.get("uid", 0), 8, format),
1108 itn(info.get("gid", 0), 8, format),
1109 itn(info.get("size", 0), 12, format),
1110 itn(info.get("mtime", 0), 12, format),
1111 " ", # checksum field
1112 info.get("type", REGTYPE),
1113 stn(info.get("linkname", ""), 100),
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001114 stn(info.get("magic", POSIX_MAGIC), 8),
1115 stn(info.get("uname", "root"), 32),
1116 stn(info.get("gname", "root"), 32),
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001117 itn(info.get("devmajor", 0), 8, format),
1118 itn(info.get("devminor", 0), 8, format),
1119 stn(info.get("prefix", ""), 155)
1120 ]
1121
1122 buf = struct.pack("%ds" % BLOCKSIZE, "".join(parts))
1123 chksum = calc_chksums(buf[-BLOCKSIZE:])[0]
1124 buf = buf[:-364] + "%06o\0" % chksum + buf[-357:]
1125 return buf
1126
1127 @staticmethod
1128 def _create_payload(payload):
1129 """Return the string payload filled with zero bytes
1130 up to the next 512 byte border.
1131 """
1132 blocks, remainder = divmod(len(payload), BLOCKSIZE)
1133 if remainder > 0:
1134 payload += (BLOCKSIZE - remainder) * NUL
1135 return payload
1136
1137 @classmethod
1138 def _create_gnu_long_header(cls, name, type):
1139 """Return a GNUTYPE_LONGNAME or GNUTYPE_LONGLINK sequence
1140 for name.
1141 """
1142 name += NUL
1143
1144 info = {}
1145 info["name"] = "././@LongLink"
1146 info["type"] = type
1147 info["size"] = len(name)
1148 info["magic"] = GNU_MAGIC
1149
1150 # create extended header + name blocks.
1151 return cls._create_header(info, USTAR_FORMAT) + \
1152 cls._create_payload(name)
1153
1154 @classmethod
1155 def _create_pax_generic_header(cls, pax_headers, type=XHDTYPE):
1156 """Return a POSIX.1-2001 extended or global header sequence
1157 that contains a list of keyword, value pairs. The values
1158 must be unicode objects.
1159 """
1160 records = []
1161 for keyword, value in pax_headers.iteritems():
1162 keyword = keyword.encode("utf8")
1163 value = value.encode("utf8")
1164 l = len(keyword) + len(value) + 3 # ' ' + '=' + '\n'
1165 n = p = 0
1166 while True:
1167 n = l + len(str(p))
1168 if n == p:
1169 break
1170 p = n
1171 records.append("%d %s=%s\n" % (p, keyword, value))
1172 records = "".join(records)
1173
1174 # We use a hardcoded "././@PaxHeader" name like star does
1175 # instead of the one that POSIX recommends.
1176 info = {}
1177 info["name"] = "././@PaxHeader"
1178 info["type"] = type
1179 info["size"] = len(records)
1180 info["magic"] = POSIX_MAGIC
1181
1182 # Create pax header + record blocks.
1183 return cls._create_header(info, USTAR_FORMAT) + \
1184 cls._create_payload(records)
1185
Guido van Rossum75b64e62005-01-16 00:16:11 +00001186 @classmethod
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001187 def frombuf(cls, buf):
1188 """Construct a TarInfo object from a 512 byte string buffer.
1189 """
Georg Brandl38c6a222006-05-10 16:26:03 +00001190 if len(buf) != BLOCKSIZE:
Georg Brandlebbeed72006-12-19 22:06:46 +00001191 raise HeaderError("truncated header")
Georg Brandl38c6a222006-05-10 16:26:03 +00001192 if buf.count(NUL) == BLOCKSIZE:
Georg Brandlebbeed72006-12-19 22:06:46 +00001193 raise HeaderError("empty header")
1194
Georg Brandlded1c4d2006-12-20 11:55:16 +00001195 chksum = nti(buf[148:156])
Georg Brandlebbeed72006-12-19 22:06:46 +00001196 if chksum not in calc_chksums(buf):
1197 raise HeaderError("bad checksum")
Georg Brandl38c6a222006-05-10 16:26:03 +00001198
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001199 obj = cls()
1200 obj.buf = buf
1201 obj.name = nts(buf[0:100])
1202 obj.mode = nti(buf[100:108])
1203 obj.uid = nti(buf[108:116])
1204 obj.gid = nti(buf[116:124])
1205 obj.size = nti(buf[124:136])
1206 obj.mtime = nti(buf[136:148])
1207 obj.chksum = chksum
1208 obj.type = buf[156:157]
1209 obj.linkname = nts(buf[157:257])
1210 obj.uname = nts(buf[265:297])
1211 obj.gname = nts(buf[297:329])
1212 obj.devmajor = nti(buf[329:337])
1213 obj.devminor = nti(buf[337:345])
1214 prefix = nts(buf[345:500])
Georg Brandl3354f282006-10-29 09:16:12 +00001215
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001216 # Old V7 tar format represents a directory as a regular
1217 # file with a trailing slash.
1218 if obj.type == AREGTYPE and obj.name.endswith("/"):
1219 obj.type = DIRTYPE
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001220
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001221 # Remove redundant slashes from directories.
1222 if obj.isdir():
1223 obj.name = obj.name.rstrip("/")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001224
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001225 # Reconstruct a ustar longname.
1226 if prefix and obj.type not in GNU_TYPES:
1227 obj.name = prefix + "/" + obj.name
1228 return obj
1229
1230 @classmethod
1231 def fromtarfile(cls, tarfile):
1232 """Return the next TarInfo object from TarFile object
1233 tarfile.
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001234 """
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001235 buf = tarfile.fileobj.read(BLOCKSIZE)
1236 if not buf:
1237 return
1238 obj = cls.frombuf(buf)
1239 obj.offset = tarfile.fileobj.tell() - BLOCKSIZE
1240 return obj._proc_member(tarfile)
Georg Brandl3354f282006-10-29 09:16:12 +00001241
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001242 #--------------------------------------------------------------------------
1243 # The following are methods that are called depending on the type of a
1244 # member. The entry point is _proc_member() which can be overridden in a
1245 # subclass to add custom _proc_*() methods. A _proc_*() method MUST
1246 # implement the following
1247 # operations:
1248 # 1. Set self.offset_data to the position where the data blocks begin,
1249 # if there is data that follows.
1250 # 2. Set tarfile.offset to the position where the next member's header will
1251 # begin.
1252 # 3. Return self or another valid TarInfo object.
1253 def _proc_member(self, tarfile):
1254 """Choose the right processing method depending on
1255 the type and call it.
Georg Brandl3354f282006-10-29 09:16:12 +00001256 """
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001257 if self.type in (GNUTYPE_LONGNAME, GNUTYPE_LONGLINK):
1258 return self._proc_gnulong(tarfile)
1259 elif self.type == GNUTYPE_SPARSE:
1260 return self._proc_sparse(tarfile)
1261 elif self.type in (XHDTYPE, XGLTYPE, SOLARIS_XHDTYPE):
1262 return self._proc_pax(tarfile)
1263 else:
1264 return self._proc_builtin(tarfile)
Georg Brandl3354f282006-10-29 09:16:12 +00001265
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001266 def _proc_builtin(self, tarfile):
1267 """Process a builtin type or an unknown type which
1268 will be treated as a regular file.
1269 """
1270 self.offset_data = tarfile.fileobj.tell()
1271 offset = self.offset_data
1272 if self.isreg() or self.type not in SUPPORTED_TYPES:
1273 # Skip the following data blocks.
1274 offset += self._block(self.size)
1275 tarfile.offset = offset
Georg Brandl3354f282006-10-29 09:16:12 +00001276
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001277 # Patch the TarInfo object with saved global
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001278 # header information.
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001279 self._apply_pax_info(tarfile.pax_headers, tarfile.encoding, tarfile.errors)
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001280
1281 return self
1282
1283 def _proc_gnulong(self, tarfile):
1284 """Process the blocks that hold a GNU longname
1285 or longlink member.
1286 """
1287 buf = tarfile.fileobj.read(self._block(self.size))
1288
1289 # Fetch the next header and process it.
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001290 next = self.fromtarfile(tarfile)
1291 if next is None:
1292 raise HeaderError("missing subsequent header")
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001293
1294 # Patch the TarInfo object from the next header with
1295 # the longname information.
1296 next.offset = self.offset
1297 if self.type == GNUTYPE_LONGNAME:
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001298 next.name = nts(buf)
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001299 elif self.type == GNUTYPE_LONGLINK:
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001300 next.linkname = nts(buf)
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001301
1302 return next
1303
1304 def _proc_sparse(self, tarfile):
1305 """Process a GNU sparse header plus extra headers.
1306 """
1307 buf = self.buf
1308 sp = _ringbuffer()
1309 pos = 386
1310 lastpos = 0L
1311 realpos = 0L
1312 # There are 4 possible sparse structs in the
1313 # first header.
1314 for i in xrange(4):
1315 try:
1316 offset = nti(buf[pos:pos + 12])
1317 numbytes = nti(buf[pos + 12:pos + 24])
1318 except ValueError:
1319 break
1320 if offset > lastpos:
1321 sp.append(_hole(lastpos, offset - lastpos))
1322 sp.append(_data(offset, numbytes, realpos))
1323 realpos += numbytes
1324 lastpos = offset + numbytes
1325 pos += 24
1326
1327 isextended = ord(buf[482])
1328 origsize = nti(buf[483:495])
1329
1330 # If the isextended flag is given,
1331 # there are extra headers to process.
1332 while isextended == 1:
1333 buf = tarfile.fileobj.read(BLOCKSIZE)
1334 pos = 0
1335 for i in xrange(21):
1336 try:
1337 offset = nti(buf[pos:pos + 12])
1338 numbytes = nti(buf[pos + 12:pos + 24])
1339 except ValueError:
1340 break
1341 if offset > lastpos:
1342 sp.append(_hole(lastpos, offset - lastpos))
1343 sp.append(_data(offset, numbytes, realpos))
1344 realpos += numbytes
1345 lastpos = offset + numbytes
1346 pos += 24
1347 isextended = ord(buf[504])
1348
1349 if lastpos < origsize:
1350 sp.append(_hole(lastpos, origsize - lastpos))
1351
1352 self.sparse = sp
1353
1354 self.offset_data = tarfile.fileobj.tell()
1355 tarfile.offset = self.offset_data + self._block(self.size)
1356 self.size = origsize
1357
1358 return self
1359
1360 def _proc_pax(self, tarfile):
1361 """Process an extended or global header as described in
1362 POSIX.1-2001.
1363 """
1364 # Read the header information.
1365 buf = tarfile.fileobj.read(self._block(self.size))
1366
1367 # A pax header stores supplemental information for either
1368 # the following file (extended) or all following files
1369 # (global).
1370 if self.type == XGLTYPE:
1371 pax_headers = tarfile.pax_headers
1372 else:
1373 pax_headers = tarfile.pax_headers.copy()
1374
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001375 # Parse pax header information. A record looks like that:
1376 # "%d %s=%s\n" % (length, keyword, value). length is the size
1377 # of the complete record including the length field itself and
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001378 # the newline. keyword and value are both UTF-8 encoded strings.
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001379 regex = re.compile(r"(\d+) ([^=]+)=", re.U)
1380 pos = 0
1381 while True:
1382 match = regex.match(buf, pos)
1383 if not match:
1384 break
1385
1386 length, keyword = match.groups()
1387 length = int(length)
1388 value = buf[match.end(2) + 1:match.start(1) + length - 1]
1389
1390 keyword = keyword.decode("utf8")
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001391 value = value.decode("utf8")
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001392
1393 pax_headers[keyword] = value
1394 pos += length
1395
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001396 # Fetch the next header.
1397 next = self.fromtarfile(tarfile)
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001398
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001399 if self.type in (XHDTYPE, SOLARIS_XHDTYPE):
1400 if next is None:
1401 raise HeaderError("missing subsequent header")
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001402
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001403 # Patch the TarInfo object with the extended header info.
1404 next._apply_pax_info(pax_headers, tarfile.encoding, tarfile.errors)
1405 next.offset = self.offset
1406
Brett Cannon132fc542008-08-04 21:23:07 +00001407 if "size" in pax_headers:
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001408 # If the extended header replaces the size field,
1409 # we need to recalculate the offset where the next
1410 # header starts.
1411 offset = next.offset_data
1412 if next.isreg() or next.type not in SUPPORTED_TYPES:
1413 offset += next._block(next.size)
1414 tarfile.offset = offset
1415
1416 return next
1417
1418 def _apply_pax_info(self, pax_headers, encoding, errors):
1419 """Replace fields with supplemental information from a previous
1420 pax extended or global header.
1421 """
1422 for keyword, value in pax_headers.iteritems():
1423 if keyword not in PAX_FIELDS:
1424 continue
1425
1426 if keyword == "path":
1427 value = value.rstrip("/")
1428
1429 if keyword in PAX_NUMBER_FIELDS:
1430 try:
1431 value = PAX_NUMBER_FIELDS[keyword](value)
1432 except ValueError:
1433 value = 0
1434 else:
1435 value = uts(value, encoding, errors)
1436
1437 setattr(self, keyword, value)
1438
1439 self.pax_headers = pax_headers.copy()
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001440
1441 def _block(self, count):
1442 """Round up a byte count by BLOCKSIZE and return it,
1443 e.g. _block(834) => 1024.
1444 """
1445 blocks, remainder = divmod(count, BLOCKSIZE)
1446 if remainder:
1447 blocks += 1
1448 return blocks * BLOCKSIZE
Georg Brandl3354f282006-10-29 09:16:12 +00001449
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001450 def isreg(self):
1451 return self.type in REGULAR_TYPES
1452 def isfile(self):
1453 return self.isreg()
1454 def isdir(self):
1455 return self.type == DIRTYPE
1456 def issym(self):
1457 return self.type == SYMTYPE
1458 def islnk(self):
1459 return self.type == LNKTYPE
1460 def ischr(self):
1461 return self.type == CHRTYPE
1462 def isblk(self):
1463 return self.type == BLKTYPE
1464 def isfifo(self):
1465 return self.type == FIFOTYPE
1466 def issparse(self):
1467 return self.type == GNUTYPE_SPARSE
1468 def isdev(self):
1469 return self.type in (CHRTYPE, BLKTYPE, FIFOTYPE)
1470# class TarInfo
1471
1472class TarFile(object):
1473 """The TarFile Class provides an interface to tar archives.
1474 """
1475
1476 debug = 0 # May be set from 0 (no msgs) to 3 (all msgs)
1477
1478 dereference = False # If true, add content of linked file to the
1479 # tar file, else the link.
1480
1481 ignore_zeros = False # If true, skips empty or invalid blocks and
1482 # continues processing.
1483
1484 errorlevel = 0 # If 0, fatal errors only appear in debug
1485 # messages (if debug >= 0). If > 0, errors
1486 # are passed to the caller as exceptions.
1487
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001488 format = DEFAULT_FORMAT # The format to use when creating an archive.
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001489
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001490 encoding = ENCODING # Encoding for 8-bit character strings.
1491
1492 errors = None # Error handler for unicode conversion.
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001493
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001494 tarinfo = TarInfo # The default TarInfo class to use.
1495
1496 fileobject = ExFileObject # The default ExFileObject class to use.
1497
1498 def __init__(self, name=None, mode="r", fileobj=None, format=None,
1499 tarinfo=None, dereference=None, ignore_zeros=None, encoding=None,
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001500 errors=None, pax_headers=None, debug=None, errorlevel=None):
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001501 """Open an (uncompressed) tar archive `name'. `mode' is either 'r' to
1502 read from an existing archive, 'a' to append data to an existing
1503 file or 'w' to create a new file overwriting an existing one. `mode'
1504 defaults to 'r'.
1505 If `fileobj' is given, it is used for reading or writing data. If it
1506 can be determined, `mode' is overridden by `fileobj's mode.
1507 `fileobj' is not closed, when TarFile is closed.
1508 """
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001509 if len(mode) > 1 or mode not in "raw":
Georg Brandle4751e32006-05-18 06:11:19 +00001510 raise ValueError("mode must be 'r', 'a' or 'w'")
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001511 self.mode = mode
1512 self._mode = {"r": "rb", "a": "r+b", "w": "wb"}[mode]
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001513
1514 if not fileobj:
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001515 if self.mode == "a" and not os.path.exists(name):
Lars Gustäbel3f8aca12007-02-06 18:38:13 +00001516 # Create nonexistent files in append mode.
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001517 self.mode = "w"
1518 self._mode = "wb"
Brett Cannon6cef0762007-05-25 20:17:15 +00001519 fileobj = bltn_open(name, self._mode)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001520 self._extfileobj = False
1521 else:
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001522 if name is None and hasattr(fileobj, "name"):
1523 name = fileobj.name
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001524 if hasattr(fileobj, "mode"):
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001525 self._mode = fileobj.mode
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001526 self._extfileobj = True
Lars Gustäbel0f4a14b2007-08-28 12:31:09 +00001527 self.name = os.path.abspath(name) if name else None
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001528 self.fileobj = fileobj
1529
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001530 # Init attributes.
1531 if format is not None:
1532 self.format = format
1533 if tarinfo is not None:
1534 self.tarinfo = tarinfo
1535 if dereference is not None:
1536 self.dereference = dereference
1537 if ignore_zeros is not None:
1538 self.ignore_zeros = ignore_zeros
1539 if encoding is not None:
1540 self.encoding = encoding
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001541
1542 if errors is not None:
1543 self.errors = errors
1544 elif mode == "r":
1545 self.errors = "utf-8"
1546 else:
1547 self.errors = "strict"
1548
1549 if pax_headers is not None and self.format == PAX_FORMAT:
1550 self.pax_headers = pax_headers
1551 else:
1552 self.pax_headers = {}
1553
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001554 if debug is not None:
1555 self.debug = debug
1556 if errorlevel is not None:
1557 self.errorlevel = errorlevel
1558
1559 # Init datastructures.
Georg Brandl38c6a222006-05-10 16:26:03 +00001560 self.closed = False
1561 self.members = [] # list of members as TarInfo objects
1562 self._loaded = False # flag if all members have been read
Lars Gustäbel77b2d632007-12-01 21:02:12 +00001563 self.offset = self.fileobj.tell()
1564 # current position in the archive file
Georg Brandl38c6a222006-05-10 16:26:03 +00001565 self.inodes = {} # dictionary caching the inodes of
1566 # archive members already added
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001567
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001568 if self.mode == "r":
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001569 self.firstmember = None
1570 self.firstmember = self.next()
1571
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001572 if self.mode == "a":
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001573 # Move to the end of the archive,
1574 # before the first empty block.
1575 self.firstmember = None
1576 while True:
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001577 if self.next() is None:
Lars Gustäbel3f8aca12007-02-06 18:38:13 +00001578 if self.offset > 0:
1579 self.fileobj.seek(- BLOCKSIZE, 1)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001580 break
1581
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001582 if self.mode in "aw":
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001583 self._loaded = True
1584
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001585 if self.pax_headers:
1586 buf = self.tarinfo.create_pax_global_header(self.pax_headers.copy())
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001587 self.fileobj.write(buf)
1588 self.offset += len(buf)
1589
1590 def _getposix(self):
1591 return self.format == USTAR_FORMAT
1592 def _setposix(self, value):
1593 import warnings
Philip Jenvey54cea3b2009-05-08 02:47:02 +00001594 warnings.warn("use the format attribute instead", DeprecationWarning,
1595 2)
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001596 if value:
1597 self.format = USTAR_FORMAT
1598 else:
1599 self.format = GNU_FORMAT
1600 posix = property(_getposix, _setposix)
1601
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001602 #--------------------------------------------------------------------------
1603 # Below are the classmethods which act as alternate constructors to the
1604 # TarFile class. The open() method is the only one that is needed for
1605 # public use; it is the "super"-constructor and is able to select an
1606 # adequate "sub"-constructor for a particular compression using the mapping
1607 # from OPEN_METH.
1608 #
1609 # This concept allows one to subclass TarFile without losing the comfort of
1610 # the super-constructor. A sub-constructor is registered and made available
1611 # by adding it to the mapping in OPEN_METH.
1612
Guido van Rossum75b64e62005-01-16 00:16:11 +00001613 @classmethod
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001614 def open(cls, name=None, mode="r", fileobj=None, bufsize=RECORDSIZE, **kwargs):
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001615 """Open a tar archive for reading, writing or appending. Return
1616 an appropriate TarFile class.
1617
1618 mode:
Martin v. Löwis78be7df2005-03-05 12:47:42 +00001619 'r' or 'r:*' open for reading with transparent compression
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001620 'r:' open for reading exclusively uncompressed
1621 'r:gz' open for reading with gzip compression
1622 'r:bz2' open for reading with bzip2 compression
Lars Gustäbel3f8aca12007-02-06 18:38:13 +00001623 'a' or 'a:' open for appending, creating the file if necessary
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001624 'w' or 'w:' open for writing without compression
1625 'w:gz' open for writing with gzip compression
1626 'w:bz2' open for writing with bzip2 compression
Martin v. Löwis78be7df2005-03-05 12:47:42 +00001627
1628 'r|*' open a stream of tar blocks with transparent compression
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001629 'r|' open an uncompressed stream of tar blocks for reading
1630 'r|gz' open a gzip compressed stream of tar blocks
1631 'r|bz2' open a bzip2 compressed stream of tar blocks
1632 'w|' open an uncompressed stream for writing
1633 'w|gz' open a gzip compressed stream for writing
1634 'w|bz2' open a bzip2 compressed stream for writing
1635 """
1636
1637 if not name and not fileobj:
Georg Brandle4751e32006-05-18 06:11:19 +00001638 raise ValueError("nothing to open")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001639
Martin v. Löwis78be7df2005-03-05 12:47:42 +00001640 if mode in ("r", "r:*"):
1641 # Find out which *open() is appropriate for opening the file.
1642 for comptype in cls.OPEN_METH:
1643 func = getattr(cls, cls.OPEN_METH[comptype])
Lars Gustäbela7ba6fc2006-12-27 10:30:46 +00001644 if fileobj is not None:
1645 saved_pos = fileobj.tell()
Martin v. Löwis78be7df2005-03-05 12:47:42 +00001646 try:
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001647 return func(name, "r", fileobj, **kwargs)
1648 except (ReadError, CompressionError), e:
Lars Gustäbela7ba6fc2006-12-27 10:30:46 +00001649 if fileobj is not None:
1650 fileobj.seek(saved_pos)
Martin v. Löwis78be7df2005-03-05 12:47:42 +00001651 continue
Georg Brandle4751e32006-05-18 06:11:19 +00001652 raise ReadError("file could not be opened successfully")
Martin v. Löwis78be7df2005-03-05 12:47:42 +00001653
1654 elif ":" in mode:
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001655 filemode, comptype = mode.split(":", 1)
1656 filemode = filemode or "r"
1657 comptype = comptype or "tar"
1658
1659 # Select the *open() function according to
1660 # given compression.
1661 if comptype in cls.OPEN_METH:
1662 func = getattr(cls, cls.OPEN_METH[comptype])
1663 else:
Georg Brandle4751e32006-05-18 06:11:19 +00001664 raise CompressionError("unknown compression type %r" % comptype)
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001665 return func(name, filemode, fileobj, **kwargs)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001666
1667 elif "|" in mode:
1668 filemode, comptype = mode.split("|", 1)
1669 filemode = filemode or "r"
1670 comptype = comptype or "tar"
1671
1672 if filemode not in "rw":
Georg Brandle4751e32006-05-18 06:11:19 +00001673 raise ValueError("mode must be 'r' or 'w'")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001674
1675 t = cls(name, filemode,
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001676 _Stream(name, filemode, comptype, fileobj, bufsize),
1677 **kwargs)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001678 t._extfileobj = False
1679 return t
1680
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001681 elif mode in "aw":
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001682 return cls.taropen(name, mode, fileobj, **kwargs)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001683
Georg Brandle4751e32006-05-18 06:11:19 +00001684 raise ValueError("undiscernible mode")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001685
Guido van Rossum75b64e62005-01-16 00:16:11 +00001686 @classmethod
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001687 def taropen(cls, name, mode="r", fileobj=None, **kwargs):
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001688 """Open uncompressed tar archive name for reading or writing.
1689 """
1690 if len(mode) > 1 or mode not in "raw":
Georg Brandle4751e32006-05-18 06:11:19 +00001691 raise ValueError("mode must be 'r', 'a' or 'w'")
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001692 return cls(name, mode, fileobj, **kwargs)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001693
Guido van Rossum75b64e62005-01-16 00:16:11 +00001694 @classmethod
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001695 def gzopen(cls, name, mode="r", fileobj=None, compresslevel=9, **kwargs):
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001696 """Open gzip compressed tar archive name for reading or writing.
1697 Appending is not allowed.
1698 """
1699 if len(mode) > 1 or mode not in "rw":
Georg Brandle4751e32006-05-18 06:11:19 +00001700 raise ValueError("mode must be 'r' or 'w'")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001701
1702 try:
1703 import gzip
Neal Norwitz4ec68242003-04-11 03:05:56 +00001704 gzip.GzipFile
1705 except (ImportError, AttributeError):
Georg Brandle4751e32006-05-18 06:11:19 +00001706 raise CompressionError("gzip module is not available")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001707
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001708 if fileobj is None:
Brett Cannon6cef0762007-05-25 20:17:15 +00001709 fileobj = bltn_open(name, mode + "b")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001710
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001711 try:
Lars Gustäbela4b23812006-12-23 17:57:23 +00001712 t = cls.taropen(name, mode,
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001713 gzip.GzipFile(name, mode, compresslevel, fileobj),
1714 **kwargs)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001715 except IOError:
Georg Brandle4751e32006-05-18 06:11:19 +00001716 raise ReadError("not a gzip file")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001717 t._extfileobj = False
1718 return t
1719
Guido van Rossum75b64e62005-01-16 00:16:11 +00001720 @classmethod
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001721 def bz2open(cls, name, mode="r", fileobj=None, compresslevel=9, **kwargs):
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001722 """Open bzip2 compressed tar archive name for reading or writing.
1723 Appending is not allowed.
1724 """
1725 if len(mode) > 1 or mode not in "rw":
Georg Brandle4751e32006-05-18 06:11:19 +00001726 raise ValueError("mode must be 'r' or 'w'.")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001727
1728 try:
1729 import bz2
1730 except ImportError:
Georg Brandle4751e32006-05-18 06:11:19 +00001731 raise CompressionError("bz2 module is not available")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001732
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001733 if fileobj is not None:
Georg Brandl49c8f4c2006-05-15 19:30:35 +00001734 fileobj = _BZ2Proxy(fileobj, mode)
1735 else:
1736 fileobj = bz2.BZ2File(name, mode, compresslevel=compresslevel)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001737
1738 try:
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001739 t = cls.taropen(name, mode, fileobj, **kwargs)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001740 except IOError:
Georg Brandle4751e32006-05-18 06:11:19 +00001741 raise ReadError("not a bzip2 file")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001742 t._extfileobj = False
1743 return t
1744
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001745 # All *open() methods are registered here.
1746 OPEN_METH = {
1747 "tar": "taropen", # uncompressed tar
1748 "gz": "gzopen", # gzip compressed tar
1749 "bz2": "bz2open" # bzip2 compressed tar
1750 }
1751
1752 #--------------------------------------------------------------------------
1753 # The public methods which TarFile provides:
1754
1755 def close(self):
1756 """Close the TarFile. In write-mode, two finishing zero blocks are
1757 appended to the archive.
1758 """
1759 if self.closed:
1760 return
1761
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001762 if self.mode in "aw":
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001763 self.fileobj.write(NUL * (BLOCKSIZE * 2))
1764 self.offset += (BLOCKSIZE * 2)
1765 # fill up the end with zero-blocks
1766 # (like option -b20 for tar does)
1767 blocks, remainder = divmod(self.offset, RECORDSIZE)
1768 if remainder > 0:
1769 self.fileobj.write(NUL * (RECORDSIZE - remainder))
1770
1771 if not self._extfileobj:
1772 self.fileobj.close()
1773 self.closed = True
1774
1775 def getmember(self, name):
1776 """Return a TarInfo object for member `name'. If `name' can not be
1777 found in the archive, KeyError is raised. If a member occurs more
1778 than once in the archive, its last occurence is assumed to be the
1779 most up-to-date version.
1780 """
Martin v. Löwisf3c56112004-09-18 09:08:52 +00001781 tarinfo = self._getmember(name)
1782 if tarinfo is None:
Georg Brandle4751e32006-05-18 06:11:19 +00001783 raise KeyError("filename %r not found" % name)
Martin v. Löwisf3c56112004-09-18 09:08:52 +00001784 return tarinfo
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001785
1786 def getmembers(self):
1787 """Return the members of the archive as a list of TarInfo objects. The
1788 list has the same order as the members in the archive.
1789 """
1790 self._check()
1791 if not self._loaded: # if we want to obtain a list of
1792 self._load() # all members, we first have to
1793 # scan the whole archive.
1794 return self.members
1795
1796 def getnames(self):
1797 """Return the members of the archive as a list of their names. It has
1798 the same order as the list returned by getmembers().
1799 """
Martin v. Löwisf3c56112004-09-18 09:08:52 +00001800 return [tarinfo.name for tarinfo in self.getmembers()]
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001801
1802 def gettarinfo(self, name=None, arcname=None, fileobj=None):
1803 """Create a TarInfo object for either the file `name' or the file
1804 object `fileobj' (using os.fstat on its file descriptor). You can
1805 modify some of the TarInfo's attributes before you add it using
1806 addfile(). If given, `arcname' specifies an alternative name for the
1807 file in the archive.
1808 """
1809 self._check("aw")
1810
1811 # When fileobj is given, replace name by
1812 # fileobj's real name.
1813 if fileobj is not None:
1814 name = fileobj.name
1815
1816 # Building the name of the member in the archive.
1817 # Backward slashes are converted to forward slashes,
1818 # Absolute paths are turned to relative paths.
1819 if arcname is None:
1820 arcname = name
1821 arcname = normpath(arcname)
1822 drv, arcname = os.path.splitdrive(arcname)
1823 while arcname[0:1] == "/":
1824 arcname = arcname[1:]
1825
1826 # Now, fill the TarInfo object with
1827 # information specific for the file.
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001828 tarinfo = self.tarinfo()
1829 tarinfo.tarfile = self
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001830
1831 # Use os.stat or os.lstat, depending on platform
1832 # and if symlinks shall be resolved.
1833 if fileobj is None:
1834 if hasattr(os, "lstat") and not self.dereference:
1835 statres = os.lstat(name)
1836 else:
1837 statres = os.stat(name)
1838 else:
1839 statres = os.fstat(fileobj.fileno())
1840 linkname = ""
1841
1842 stmd = statres.st_mode
1843 if stat.S_ISREG(stmd):
1844 inode = (statres.st_ino, statres.st_dev)
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001845 if not self.dereference and statres.st_nlink > 1 and \
1846 inode in self.inodes and arcname != self.inodes[inode]:
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001847 # Is it a hardlink to an already
1848 # archived file?
1849 type = LNKTYPE
1850 linkname = self.inodes[inode]
1851 else:
1852 # The inode is added only if its valid.
1853 # For win32 it is always 0.
1854 type = REGTYPE
1855 if inode[0]:
1856 self.inodes[inode] = arcname
1857 elif stat.S_ISDIR(stmd):
1858 type = DIRTYPE
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001859 elif stat.S_ISFIFO(stmd):
1860 type = FIFOTYPE
1861 elif stat.S_ISLNK(stmd):
1862 type = SYMTYPE
1863 linkname = os.readlink(name)
1864 elif stat.S_ISCHR(stmd):
1865 type = CHRTYPE
1866 elif stat.S_ISBLK(stmd):
1867 type = BLKTYPE
1868 else:
1869 return None
1870
1871 # Fill the TarInfo object with all
1872 # information we can get.
Martin v. Löwis5dbdc592005-08-27 10:07:56 +00001873 tarinfo.name = arcname
1874 tarinfo.mode = stmd
1875 tarinfo.uid = statres.st_uid
1876 tarinfo.gid = statres.st_gid
1877 if stat.S_ISREG(stmd):
Martin v. Löwis61d77e02004-08-20 06:35:46 +00001878 tarinfo.size = statres.st_size
Martin v. Löwis5dbdc592005-08-27 10:07:56 +00001879 else:
1880 tarinfo.size = 0L
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001881 tarinfo.mtime = statres.st_mtime
Martin v. Löwis5dbdc592005-08-27 10:07:56 +00001882 tarinfo.type = type
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001883 tarinfo.linkname = linkname
1884 if pwd:
1885 try:
1886 tarinfo.uname = pwd.getpwuid(tarinfo.uid)[0]
1887 except KeyError:
1888 pass
1889 if grp:
1890 try:
1891 tarinfo.gname = grp.getgrgid(tarinfo.gid)[0]
1892 except KeyError:
1893 pass
1894
1895 if type in (CHRTYPE, BLKTYPE):
1896 if hasattr(os, "major") and hasattr(os, "minor"):
1897 tarinfo.devmajor = os.major(statres.st_rdev)
1898 tarinfo.devminor = os.minor(statres.st_rdev)
1899 return tarinfo
1900
1901 def list(self, verbose=True):
1902 """Print a table of contents to sys.stdout. If `verbose' is False, only
1903 the names of the members are printed. If it is True, an `ls -l'-like
1904 output is produced.
1905 """
1906 self._check()
1907
1908 for tarinfo in self:
1909 if verbose:
1910 print filemode(tarinfo.mode),
1911 print "%s/%s" % (tarinfo.uname or tarinfo.uid,
1912 tarinfo.gname or tarinfo.gid),
1913 if tarinfo.ischr() or tarinfo.isblk():
1914 print "%10s" % ("%d,%d" \
1915 % (tarinfo.devmajor, tarinfo.devminor)),
1916 else:
1917 print "%10d" % tarinfo.size,
1918 print "%d-%02d-%02d %02d:%02d:%02d" \
1919 % time.localtime(tarinfo.mtime)[:6],
1920
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001921 print tarinfo.name + ("/" if tarinfo.isdir() else ""),
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001922
1923 if verbose:
1924 if tarinfo.issym():
1925 print "->", tarinfo.linkname,
1926 if tarinfo.islnk():
1927 print "link to", tarinfo.linkname,
1928 print
1929
Lars Gustäbel104490e2007-06-18 11:42:11 +00001930 def add(self, name, arcname=None, recursive=True, exclude=None):
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001931 """Add the file `name' to the archive. `name' may be any type of file
1932 (directory, fifo, symbolic link, etc.). If given, `arcname'
1933 specifies an alternative name for the file in the archive.
1934 Directories are added recursively by default. This can be avoided by
Lars Gustäbel104490e2007-06-18 11:42:11 +00001935 setting `recursive' to False. `exclude' is a function that should
1936 return True for each filename to be excluded.
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001937 """
1938 self._check("aw")
1939
1940 if arcname is None:
1941 arcname = name
1942
Lars Gustäbel104490e2007-06-18 11:42:11 +00001943 # Exclude pathnames.
1944 if exclude is not None and exclude(name):
1945 self._dbg(2, "tarfile: Excluded %r" % name)
1946 return
1947
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001948 # Skip if somebody tries to archive the archive...
Lars Gustäbela4b23812006-12-23 17:57:23 +00001949 if self.name is not None and os.path.abspath(name) == self.name:
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001950 self._dbg(2, "tarfile: Skipped %r" % name)
1951 return
1952
1953 # Special case: The user wants to add the current
1954 # working directory.
1955 if name == ".":
1956 if recursive:
1957 if arcname == ".":
1958 arcname = ""
Lars Gustäbelc64e4022007-03-13 10:47:19 +00001959 for f in os.listdir(name):
Lars Gustäbel104490e2007-06-18 11:42:11 +00001960 self.add(f, os.path.join(arcname, f), recursive, exclude)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001961 return
1962
1963 self._dbg(1, name)
1964
1965 # Create a TarInfo object from the file.
1966 tarinfo = self.gettarinfo(name, arcname)
1967
1968 if tarinfo is None:
1969 self._dbg(1, "tarfile: Unsupported type %r" % name)
1970 return
1971
1972 # Append the tar header and data to the archive.
1973 if tarinfo.isreg():
Brett Cannon6cef0762007-05-25 20:17:15 +00001974 f = bltn_open(name, "rb")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001975 self.addfile(tarinfo, f)
1976 f.close()
1977
Martin v. Löwis5dbdc592005-08-27 10:07:56 +00001978 elif tarinfo.isdir():
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001979 self.addfile(tarinfo)
1980 if recursive:
1981 for f in os.listdir(name):
Lars Gustäbel104490e2007-06-18 11:42:11 +00001982 self.add(os.path.join(name, f), os.path.join(arcname, f), recursive, exclude)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001983
Martin v. Löwis5dbdc592005-08-27 10:07:56 +00001984 else:
1985 self.addfile(tarinfo)
1986
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001987 def addfile(self, tarinfo, fileobj=None):
1988 """Add the TarInfo object `tarinfo' to the archive. If `fileobj' is
1989 given, tarinfo.size bytes are read from it and added to the archive.
1990 You can create TarInfo objects using gettarinfo().
1991 On Windows platforms, `fileobj' should always be opened with mode
1992 'rb' to avoid irritation about the file size.
1993 """
1994 self._check("aw")
1995
Georg Brandl3354f282006-10-29 09:16:12 +00001996 tarinfo = copy.copy(tarinfo)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00001997
Lars Gustäbela0fcb932007-05-27 19:49:30 +00001998 buf = tarinfo.tobuf(self.format, self.encoding, self.errors)
Georg Brandl3354f282006-10-29 09:16:12 +00001999 self.fileobj.write(buf)
2000 self.offset += len(buf)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002001
2002 # If there's data to follow, append it.
2003 if fileobj is not None:
2004 copyfileobj(fileobj, self.fileobj, tarinfo.size)
2005 blocks, remainder = divmod(tarinfo.size, BLOCKSIZE)
2006 if remainder > 0:
2007 self.fileobj.write(NUL * (BLOCKSIZE - remainder))
2008 blocks += 1
2009 self.offset += blocks * BLOCKSIZE
2010
Martin v. Löwisf3c56112004-09-18 09:08:52 +00002011 self.members.append(tarinfo)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002012
Martin v. Löwis00a73e72005-03-04 19:40:34 +00002013 def extractall(self, path=".", members=None):
2014 """Extract all members from the archive to the current working
2015 directory and set owner, modification time and permissions on
2016 directories afterwards. `path' specifies a different directory
2017 to extract to. `members' is optional and must be a subset of the
2018 list returned by getmembers().
2019 """
2020 directories = []
2021
2022 if members is None:
2023 members = self
2024
2025 for tarinfo in members:
2026 if tarinfo.isdir():
Lars Gustäbel0192e432008-02-05 11:51:40 +00002027 # Extract directories with a safe mode.
Martin v. Löwis00a73e72005-03-04 19:40:34 +00002028 directories.append(tarinfo)
Lars Gustäbel0192e432008-02-05 11:51:40 +00002029 tarinfo = copy.copy(tarinfo)
2030 tarinfo.mode = 0700
2031 self.extract(tarinfo, path)
Martin v. Löwis00a73e72005-03-04 19:40:34 +00002032
2033 # Reverse sort directories.
Brett Cannon132fc542008-08-04 21:23:07 +00002034 directories.sort(key=operator.attrgetter('name'))
Martin v. Löwis00a73e72005-03-04 19:40:34 +00002035 directories.reverse()
2036
2037 # Set correct owner, mtime and filemode on directories.
2038 for tarinfo in directories:
Lars Gustäbel2ee1c762008-01-04 14:00:33 +00002039 dirpath = os.path.join(path, tarinfo.name)
Martin v. Löwis00a73e72005-03-04 19:40:34 +00002040 try:
Lars Gustäbel2ee1c762008-01-04 14:00:33 +00002041 self.chown(tarinfo, dirpath)
2042 self.utime(tarinfo, dirpath)
2043 self.chmod(tarinfo, dirpath)
Martin v. Löwis00a73e72005-03-04 19:40:34 +00002044 except ExtractError, e:
2045 if self.errorlevel > 1:
2046 raise
2047 else:
2048 self._dbg(1, "tarfile: %s" % e)
2049
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002050 def extract(self, member, path=""):
2051 """Extract a member from the archive to the current working directory,
2052 using its full name. Its file information is extracted as accurately
2053 as possible. `member' may be a filename or a TarInfo object. You can
2054 specify a different directory using `path'.
2055 """
2056 self._check("r")
2057
Lars Gustäbelc64e4022007-03-13 10:47:19 +00002058 if isinstance(member, basestring):
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002059 tarinfo = self.getmember(member)
Lars Gustäbelc64e4022007-03-13 10:47:19 +00002060 else:
2061 tarinfo = member
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002062
Neal Norwitza4f651a2004-07-20 22:07:44 +00002063 # Prepare the link target for makelink().
2064 if tarinfo.islnk():
2065 tarinfo._link_target = os.path.join(path, tarinfo.linkname)
2066
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002067 try:
2068 self._extract_member(tarinfo, os.path.join(path, tarinfo.name))
2069 except EnvironmentError, e:
2070 if self.errorlevel > 0:
2071 raise
2072 else:
2073 if e.filename is None:
2074 self._dbg(1, "tarfile: %s" % e.strerror)
2075 else:
2076 self._dbg(1, "tarfile: %s %r" % (e.strerror, e.filename))
2077 except ExtractError, e:
2078 if self.errorlevel > 1:
2079 raise
2080 else:
2081 self._dbg(1, "tarfile: %s" % e)
2082
2083 def extractfile(self, member):
2084 """Extract a member from the archive as a file object. `member' may be
2085 a filename or a TarInfo object. If `member' is a regular file, a
2086 file-like object is returned. If `member' is a link, a file-like
2087 object is constructed from the link's target. If `member' is none of
2088 the above, None is returned.
2089 The file-like object is read-only and provides the following
2090 methods: read(), readline(), readlines(), seek() and tell()
2091 """
2092 self._check("r")
2093
Lars Gustäbelc64e4022007-03-13 10:47:19 +00002094 if isinstance(member, basestring):
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002095 tarinfo = self.getmember(member)
Lars Gustäbelc64e4022007-03-13 10:47:19 +00002096 else:
2097 tarinfo = member
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002098
2099 if tarinfo.isreg():
2100 return self.fileobject(self, tarinfo)
2101
2102 elif tarinfo.type not in SUPPORTED_TYPES:
2103 # If a member's type is unknown, it is treated as a
2104 # regular file.
2105 return self.fileobject(self, tarinfo)
2106
2107 elif tarinfo.islnk() or tarinfo.issym():
2108 if isinstance(self.fileobj, _Stream):
2109 # A small but ugly workaround for the case that someone tries
2110 # to extract a (sym)link as a file-object from a non-seekable
2111 # stream of tar blocks.
Georg Brandle4751e32006-05-18 06:11:19 +00002112 raise StreamError("cannot extract (sym)link as file object")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002113 else:
Georg Brandl7eb4b7d2005-07-22 21:49:32 +00002114 # A (sym)link's file object is its target's file object.
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002115 return self.extractfile(self._getmember(tarinfo.linkname,
2116 tarinfo))
2117 else:
2118 # If there's no data associated with the member (directory, chrdev,
2119 # blkdev, etc.), return None instead of a file object.
2120 return None
2121
2122 def _extract_member(self, tarinfo, targetpath):
2123 """Extract the TarInfo object tarinfo to a physical
2124 file called targetpath.
2125 """
2126 # Fetch the TarInfo object for the given name
2127 # and build the destination pathname, replacing
2128 # forward slashes to platform specific separators.
2129 if targetpath[-1:] == "/":
2130 targetpath = targetpath[:-1]
2131 targetpath = os.path.normpath(targetpath)
2132
2133 # Create all upper directories.
2134 upperdirs = os.path.dirname(targetpath)
2135 if upperdirs and not os.path.exists(upperdirs):
Lars Gustäbel0192e432008-02-05 11:51:40 +00002136 # Create directories that are not part of the archive with
2137 # default permissions.
Lars Gustäbeld2e22902007-01-23 11:17:33 +00002138 os.makedirs(upperdirs)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002139
2140 if tarinfo.islnk() or tarinfo.issym():
2141 self._dbg(1, "%s -> %s" % (tarinfo.name, tarinfo.linkname))
2142 else:
2143 self._dbg(1, tarinfo.name)
2144
2145 if tarinfo.isreg():
2146 self.makefile(tarinfo, targetpath)
2147 elif tarinfo.isdir():
2148 self.makedir(tarinfo, targetpath)
2149 elif tarinfo.isfifo():
2150 self.makefifo(tarinfo, targetpath)
2151 elif tarinfo.ischr() or tarinfo.isblk():
2152 self.makedev(tarinfo, targetpath)
2153 elif tarinfo.islnk() or tarinfo.issym():
2154 self.makelink(tarinfo, targetpath)
2155 elif tarinfo.type not in SUPPORTED_TYPES:
2156 self.makeunknown(tarinfo, targetpath)
2157 else:
2158 self.makefile(tarinfo, targetpath)
2159
2160 self.chown(tarinfo, targetpath)
2161 if not tarinfo.issym():
2162 self.chmod(tarinfo, targetpath)
2163 self.utime(tarinfo, targetpath)
2164
2165 #--------------------------------------------------------------------------
2166 # Below are the different file methods. They are called via
2167 # _extract_member() when extract() is called. They can be replaced in a
2168 # subclass to implement other functionality.
2169
2170 def makedir(self, tarinfo, targetpath):
2171 """Make a directory called targetpath.
2172 """
2173 try:
Lars Gustäbel0192e432008-02-05 11:51:40 +00002174 # Use a safe mode for the directory, the real mode is set
2175 # later in _extract_member().
2176 os.mkdir(targetpath, 0700)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002177 except EnvironmentError, e:
2178 if e.errno != errno.EEXIST:
2179 raise
2180
2181 def makefile(self, tarinfo, targetpath):
2182 """Make a file called targetpath.
2183 """
2184 source = self.extractfile(tarinfo)
Brett Cannon6cef0762007-05-25 20:17:15 +00002185 target = bltn_open(targetpath, "wb")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002186 copyfileobj(source, target)
2187 source.close()
2188 target.close()
2189
2190 def makeunknown(self, tarinfo, targetpath):
2191 """Make a file from a TarInfo object with an unknown type
2192 at targetpath.
2193 """
2194 self.makefile(tarinfo, targetpath)
2195 self._dbg(1, "tarfile: Unknown file type %r, " \
2196 "extracted as regular file." % tarinfo.type)
2197
2198 def makefifo(self, tarinfo, targetpath):
2199 """Make a fifo called targetpath.
2200 """
2201 if hasattr(os, "mkfifo"):
2202 os.mkfifo(targetpath)
2203 else:
Georg Brandle4751e32006-05-18 06:11:19 +00002204 raise ExtractError("fifo not supported by system")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002205
2206 def makedev(self, tarinfo, targetpath):
2207 """Make a character or block device called targetpath.
2208 """
2209 if not hasattr(os, "mknod") or not hasattr(os, "makedev"):
Georg Brandle4751e32006-05-18 06:11:19 +00002210 raise ExtractError("special devices not supported by system")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002211
2212 mode = tarinfo.mode
2213 if tarinfo.isblk():
2214 mode |= stat.S_IFBLK
2215 else:
2216 mode |= stat.S_IFCHR
2217
2218 os.mknod(targetpath, mode,
2219 os.makedev(tarinfo.devmajor, tarinfo.devminor))
2220
2221 def makelink(self, tarinfo, targetpath):
2222 """Make a (symbolic) link called targetpath. If it cannot be created
2223 (platform limitation), we try to make a copy of the referenced file
2224 instead of a link.
2225 """
2226 linkpath = tarinfo.linkname
2227 try:
2228 if tarinfo.issym():
2229 os.symlink(linkpath, targetpath)
2230 else:
Neal Norwitza4f651a2004-07-20 22:07:44 +00002231 # See extract().
2232 os.link(tarinfo._link_target, targetpath)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002233 except AttributeError:
2234 if tarinfo.issym():
2235 linkpath = os.path.join(os.path.dirname(tarinfo.name),
2236 linkpath)
2237 linkpath = normpath(linkpath)
2238
2239 try:
2240 self._extract_member(self.getmember(linkpath), targetpath)
2241 except (EnvironmentError, KeyError), e:
2242 linkpath = os.path.normpath(linkpath)
2243 try:
2244 shutil.copy2(linkpath, targetpath)
2245 except EnvironmentError, e:
Georg Brandle4751e32006-05-18 06:11:19 +00002246 raise IOError("link could not be created")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002247
2248 def chown(self, tarinfo, targetpath):
2249 """Set owner of targetpath according to tarinfo.
2250 """
2251 if pwd and hasattr(os, "geteuid") and os.geteuid() == 0:
2252 # We have to be root to do so.
2253 try:
2254 g = grp.getgrnam(tarinfo.gname)[2]
2255 except KeyError:
2256 try:
2257 g = grp.getgrgid(tarinfo.gid)[2]
2258 except KeyError:
2259 g = os.getgid()
2260 try:
2261 u = pwd.getpwnam(tarinfo.uname)[2]
2262 except KeyError:
2263 try:
2264 u = pwd.getpwuid(tarinfo.uid)[2]
2265 except KeyError:
2266 u = os.getuid()
2267 try:
2268 if tarinfo.issym() and hasattr(os, "lchown"):
2269 os.lchown(targetpath, u, g)
2270 else:
Andrew MacIntyre7970d202003-02-19 12:51:34 +00002271 if sys.platform != "os2emx":
2272 os.chown(targetpath, u, g)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002273 except EnvironmentError, e:
Georg Brandle4751e32006-05-18 06:11:19 +00002274 raise ExtractError("could not change owner")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002275
2276 def chmod(self, tarinfo, targetpath):
2277 """Set file permissions of targetpath according to tarinfo.
2278 """
Jack Jansen834eff62003-03-07 12:47:06 +00002279 if hasattr(os, 'chmod'):
2280 try:
2281 os.chmod(targetpath, tarinfo.mode)
2282 except EnvironmentError, e:
Georg Brandle4751e32006-05-18 06:11:19 +00002283 raise ExtractError("could not change mode")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002284
2285 def utime(self, tarinfo, targetpath):
2286 """Set modification time of targetpath according to tarinfo.
2287 """
Jack Jansen834eff62003-03-07 12:47:06 +00002288 if not hasattr(os, 'utime'):
Tim Petersf9347782003-03-07 15:36:41 +00002289 return
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002290 try:
2291 os.utime(targetpath, (tarinfo.mtime, tarinfo.mtime))
2292 except EnvironmentError, e:
Georg Brandle4751e32006-05-18 06:11:19 +00002293 raise ExtractError("could not change modification time")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002294
2295 #--------------------------------------------------------------------------
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002296 def next(self):
2297 """Return the next member of the archive as a TarInfo object, when
2298 TarFile is opened for reading. Return None if there is no more
2299 available.
2300 """
2301 self._check("ra")
2302 if self.firstmember is not None:
2303 m = self.firstmember
2304 self.firstmember = None
2305 return m
2306
2307 # Read the next block.
Andrew M. Kuchling864bba12004-07-10 22:02:11 +00002308 self.fileobj.seek(self.offset)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002309 while True:
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002310 try:
Lars Gustäbelc64e4022007-03-13 10:47:19 +00002311 tarinfo = self.tarinfo.fromtarfile(self)
2312 if tarinfo is None:
2313 return
2314 self.members.append(tarinfo)
Georg Brandl38c6a222006-05-10 16:26:03 +00002315
Georg Brandlebbeed72006-12-19 22:06:46 +00002316 except HeaderError, e:
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002317 if self.ignore_zeros:
Georg Brandlebbeed72006-12-19 22:06:46 +00002318 self._dbg(2, "0x%X: %s" % (self.offset, e))
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002319 self.offset += BLOCKSIZE
2320 continue
2321 else:
Andrew M. Kuchling864bba12004-07-10 22:02:11 +00002322 if self.offset == 0:
Georg Brandlebbeed72006-12-19 22:06:46 +00002323 raise ReadError(str(e))
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002324 return None
2325 break
2326
Georg Brandl38c6a222006-05-10 16:26:03 +00002327 return tarinfo
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002328
2329 #--------------------------------------------------------------------------
2330 # Little helper methods:
2331
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002332 def _getmember(self, name, tarinfo=None):
2333 """Find an archive member by name from bottom to top.
2334 If tarinfo is given, it is used as the starting point.
2335 """
Martin v. Löwisf3c56112004-09-18 09:08:52 +00002336 # Ensure that all members have been loaded.
2337 members = self.getmembers()
2338
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002339 if tarinfo is None:
Martin v. Löwisf3c56112004-09-18 09:08:52 +00002340 end = len(members)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002341 else:
Martin v. Löwisf3c56112004-09-18 09:08:52 +00002342 end = members.index(tarinfo)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002343
2344 for i in xrange(end - 1, -1, -1):
Martin v. Löwisf3c56112004-09-18 09:08:52 +00002345 if name == members[i].name:
2346 return members[i]
Andrew M. Kuchling864bba12004-07-10 22:02:11 +00002347
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002348 def _load(self):
2349 """Read through the entire archive file and look for readable
2350 members.
2351 """
2352 while True:
2353 tarinfo = self.next()
2354 if tarinfo is None:
2355 break
2356 self._loaded = True
2357
2358 def _check(self, mode=None):
2359 """Check if TarFile is still open, and if the operation's mode
2360 corresponds to TarFile's mode.
2361 """
2362 if self.closed:
Georg Brandle4751e32006-05-18 06:11:19 +00002363 raise IOError("%s is closed" % self.__class__.__name__)
Lars Gustäbelc64e4022007-03-13 10:47:19 +00002364 if mode is not None and self.mode not in mode:
2365 raise IOError("bad operation for mode %r" % self.mode)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002366
2367 def __iter__(self):
2368 """Provide an iterator object.
2369 """
2370 if self._loaded:
2371 return iter(self.members)
2372 else:
2373 return TarIter(self)
2374
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002375 def _dbg(self, level, msg):
2376 """Write debugging output to sys.stderr.
2377 """
2378 if level <= self.debug:
2379 print >> sys.stderr, msg
2380# class TarFile
2381
2382class TarIter:
2383 """Iterator Class.
2384
2385 for tarinfo in TarFile(...):
2386 suite...
2387 """
2388
2389 def __init__(self, tarfile):
2390 """Construct a TarIter object.
2391 """
2392 self.tarfile = tarfile
Martin v. Löwis637431b2005-03-03 23:12:42 +00002393 self.index = 0
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002394 def __iter__(self):
2395 """Return iterator object.
2396 """
2397 return self
2398 def next(self):
2399 """Return the next item using TarFile's next() method.
2400 When all members have been read, set TarFile as _loaded.
2401 """
Martin v. Löwis637431b2005-03-03 23:12:42 +00002402 # Fix for SF #1100429: Under rare circumstances it can
2403 # happen that getmembers() is called during iteration,
2404 # which will cause TarIter to stop prematurely.
2405 if not self.tarfile._loaded:
2406 tarinfo = self.tarfile.next()
2407 if not tarinfo:
2408 self.tarfile._loaded = True
2409 raise StopIteration
2410 else:
2411 try:
2412 tarinfo = self.tarfile.members[self.index]
2413 except IndexError:
2414 raise StopIteration
2415 self.index += 1
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002416 return tarinfo
2417
2418# Helper classes for sparse file support
2419class _section:
2420 """Base class for _data and _hole.
2421 """
2422 def __init__(self, offset, size):
2423 self.offset = offset
2424 self.size = size
2425 def __contains__(self, offset):
2426 return self.offset <= offset < self.offset + self.size
2427
2428class _data(_section):
2429 """Represent a data section in a sparse file.
2430 """
2431 def __init__(self, offset, size, realpos):
2432 _section.__init__(self, offset, size)
2433 self.realpos = realpos
2434
2435class _hole(_section):
2436 """Represent a hole section in a sparse file.
2437 """
2438 pass
2439
2440class _ringbuffer(list):
2441 """Ringbuffer class which increases performance
2442 over a regular list.
2443 """
2444 def __init__(self):
2445 self.idx = 0
2446 def find(self, offset):
2447 idx = self.idx
2448 while True:
2449 item = self[idx]
2450 if offset in item:
2451 break
2452 idx += 1
2453 if idx == len(self):
2454 idx = 0
2455 if idx == self.idx:
2456 # End of File
2457 return None
2458 self.idx = idx
2459 return item
2460
2461#---------------------------------------------
2462# zipfile compatible TarFile class
2463#---------------------------------------------
2464TAR_PLAIN = 0 # zipfile.ZIP_STORED
2465TAR_GZIPPED = 8 # zipfile.ZIP_DEFLATED
2466class TarFileCompat:
2467 """TarFile class compatible with standard module zipfile's
2468 ZipFile class.
2469 """
2470 def __init__(self, file, mode="r", compression=TAR_PLAIN):
Lars Gustäbel727bd0b2008-08-02 11:26:39 +00002471 from warnings import warnpy3k
2472 warnpy3k("the TarFileCompat class has been removed in Python 3.0",
2473 stacklevel=2)
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002474 if compression == TAR_PLAIN:
2475 self.tarfile = TarFile.taropen(file, mode)
2476 elif compression == TAR_GZIPPED:
2477 self.tarfile = TarFile.gzopen(file, mode)
2478 else:
Georg Brandle4751e32006-05-18 06:11:19 +00002479 raise ValueError("unknown compression constant")
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002480 if mode[0:1] == "r":
2481 members = self.tarfile.getmembers()
Raymond Hettingera1d09e22005-09-11 16:34:05 +00002482 for m in members:
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002483 m.filename = m.name
2484 m.file_size = m.size
2485 m.date_time = time.gmtime(m.mtime)[:6]
2486 def namelist(self):
2487 return map(lambda m: m.name, self.infolist())
2488 def infolist(self):
2489 return filter(lambda m: m.type in REGULAR_TYPES,
2490 self.tarfile.getmembers())
2491 def printdir(self):
2492 self.tarfile.list()
2493 def testzip(self):
2494 return
2495 def getinfo(self, name):
2496 return self.tarfile.getmember(name)
2497 def read(self, name):
2498 return self.tarfile.extractfile(self.tarfile.getmember(name)).read()
2499 def write(self, filename, arcname=None, compress_type=None):
2500 self.tarfile.add(filename, arcname)
2501 def writestr(self, zinfo, bytes):
Raymond Hettingera6172712004-12-31 19:15:26 +00002502 try:
2503 from cStringIO import StringIO
2504 except ImportError:
2505 from StringIO import StringIO
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002506 import calendar
Lars Gustäbel727bd0b2008-08-02 11:26:39 +00002507 tinfo = TarInfo(zinfo.filename)
2508 tinfo.size = len(bytes)
2509 tinfo.mtime = calendar.timegm(zinfo.date_time)
2510 self.tarfile.addfile(tinfo, StringIO(bytes))
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002511 def close(self):
2512 self.tarfile.close()
2513#class TarFileCompat
2514
2515#--------------------
2516# exported functions
2517#--------------------
2518def is_tarfile(name):
2519 """Return True if name points to a tar archive that we
2520 are able to handle, else return False.
2521 """
2522 try:
2523 t = open(name)
2524 t.close()
2525 return True
2526 except TarError:
2527 return False
2528
Brett Cannon6cef0762007-05-25 20:17:15 +00002529bltn_open = open
Neal Norwitzb9ef4ae2003-01-05 23:19:43 +00002530open = TarFile.open