X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=lib%2Fbup%2Fmetadata.py;h=84b0f2a23597c5f61be21808d88b61c1c545833b;hb=e861537c86a6b25b39a093342408d0e222f32afc;hp=58f2989fd795a8fedd44c4ffd86b07357df7cc1f;hpb=6ddad71811edb38e56b35e20b1a2d5305c14015b;p=bup.git diff --git a/lib/bup/metadata.py b/lib/bup/metadata.py index 58f2989..84b0f2a 100644 --- a/lib/bup/metadata.py +++ b/lib/bup/metadata.py @@ -4,31 +4,43 @@ # # This code is covered under the terms of the GNU Library General # Public License as described in the bup LICENSE file. -import errno, os, sys, stat, time, pwd, grp -from cStringIO import StringIO + +from __future__ import absolute_import, print_function +from copy import deepcopy +from errno import EACCES, EINVAL, ENOTTY, ENOSYS, EOPNOTSUPP +from io import BytesIO +from time import gmtime, strftime +import errno, os, sys, stat, time, pwd, grp, socket, struct + from bup import vint, xstat from bup.drecurse import recursive_dirlist -from bup.helpers import add_error, mkdirp, log, is_superuser -from bup.helpers import pwd_from_uid, pwd_from_name, grp_from_gid, grp_from_name +from bup.helpers import add_error, mkdirp, log, is_superuser, format_filesize +from bup.pwdgrp import pwd_from_uid, pwd_from_name, grp_from_gid, grp_from_name from bup.xstat import utime, lutime -try: - import xattr -except ImportError: - log('Warning: Linux xattr support missing; install python-pyxattr.\n') - xattr = None -if xattr: +xattr = None +if sys.platform.startswith('linux'): try: - xattr.get_all - except AttributeError: - log('Warning: python-xattr module is too old; ' - 'install python-pyxattr instead.\n') - xattr = None -try: - import posix1e -except ImportError: - log('Warning: POSIX ACL support missing; install python-pylibacl.\n') - posix1e = None + import xattr + except ImportError: + log('Warning: Linux xattr support missing; install python-pyxattr.\n') + if xattr: + try: + xattr.get_all + except AttributeError: + log('Warning: python-xattr module is too old; ' + 'install python-pyxattr instead.\n') + xattr = None + +posix1e = None +if not (sys.platform.startswith('cygwin') \ + or sys.platform.startswith('darwin') \ + or sys.platform.startswith('netbsd')): + try: + import posix1e + except ImportError: + log('Warning: POSIX ACL support missing; install python-pylibacl.\n') + try: from bup._helpers import get_linux_file_attr, set_linux_file_attr except ImportError: @@ -36,7 +48,20 @@ except ImportError: # not on Linux, in which case files don't have any linux attrs anyway, so # lacking the functions isn't a problem. get_linux_file_attr = set_linux_file_attr = None - + + +# See the bup_get_linux_file_attr() comments. +_suppress_linux_file_attr = \ + sys.byteorder == 'big' and struct.calcsize('@l') > struct.calcsize('@i') + +def check_linux_file_attr_api(): + global get_linux_file_attr, set_linux_file_attr + if not (get_linux_file_attr or set_linux_file_attr): + return + if _suppress_linux_file_attr: + log('Warning: Linux attr support disabled (see "bup help index").\n') + get_linux_file_attr = set_linux_file_attr = None + # WARNING: the metadata encoding is *not* stable yet. Caveat emptor! @@ -52,7 +77,6 @@ except ImportError: # FIXME: Add nfsv4 acl handling - see nfs4-acl-tools. # FIXME: Consider other entries mentioned in stat(2) (S_IFDOOR, etc.). # FIXME: Consider pack('vvvvsss', ...) optimization. -# FIXME: Consider caching users/groups. ## FS notes: # @@ -159,13 +183,17 @@ def _clean_up_extract_path(p): # must be unique, and must *never* be changed. _rec_tag_end = 0 _rec_tag_path = 1 -_rec_tag_common = 2 # times, user, group, type, perms, etc. +_rec_tag_common_v1 = 2 # times, user, group, type, perms, etc. (legacy/broken) _rec_tag_symlink_target = 3 _rec_tag_posix1e_acl = 4 # getfacl(1), setfacl(1), etc. -_rec_tag_nfsv4_acl = 5 # intended to supplant posix1e acls? +_rec_tag_nfsv4_acl = 5 # intended to supplant posix1e? (unimplemented) _rec_tag_linux_attr = 6 # lsattr(1) chattr(1) _rec_tag_linux_xattr = 7 # getfattr(1) setfattr(1) _rec_tag_hardlink_target = 8 # hard link target path +_rec_tag_common_v2 = 9 # times, user, group, type, perms, etc. (current) +_rec_tag_common_v3 = 10 # adds optional size to v2 + +_warned_about_attr_einval = None class ApplyError(Exception): @@ -193,9 +221,11 @@ class Metadata: # must be non-negative and < 10**9. def _add_common(self, path, st): + assert(st.st_uid >= 0) + assert(st.st_gid >= 0) + self.size = st.st_size self.uid = st.st_uid self.gid = st.st_gid - self.rdev = st.st_rdev self.atime = st.st_atime self.mtime = st.st_mtime self.ctime = st.st_ctime @@ -207,17 +237,25 @@ class Metadata: if entry: self.group = entry.gr_name self.mode = st.st_mode + # Only collect st_rdev if we might need it for a mknod() + # during restore. On some platforms (i.e. kFreeBSD), it isn't + # stable for other file types. For example "cp -a" will + # change it for a plain file. + if stat.S_ISCHR(st.st_mode) or stat.S_ISBLK(st.st_mode): + self.rdev = st.st_rdev + else: + self.rdev = 0 def _same_common(self, other): """Return true or false to indicate similarity in the hardlink sense.""" return self.uid == other.uid \ and self.gid == other.gid \ and self.rdev == other.rdev \ - and self.atime == other.atime \ and self.mtime == other.mtime \ and self.ctime == other.ctime \ and self.user == other.user \ - and self.group == other.group + and self.group == other.group \ + and self.size == other.size def _encode_common(self): if not self.mode: @@ -225,7 +263,7 @@ class Metadata: atime = xstat.nsecs_to_timespec(self.atime) mtime = xstat.nsecs_to_timespec(self.mtime) ctime = xstat.nsecs_to_timespec(self.ctime) - result = vint.pack('VVsVsVvVvVvV', + result = vint.pack('vvsvsvvVvVvVv', self.mode, self.uid, self.user, @@ -237,23 +275,36 @@ class Metadata: mtime[0], mtime[1], ctime[0], - ctime[1]) + ctime[1], + self.size if self.size is not None else -1) return result - def _load_common_rec(self, port): + def _load_common_rec(self, port, version=3): + if version == 3: + # Added trailing size to v2, negative when None. + unpack_fmt = 'vvsvsvvVvVvVv' + elif version == 2: + unpack_fmt = 'vvsvsvvVvVvV' + elif version == 1: + unpack_fmt = 'VVsVsVvVvVvV' + else: + raise Exception('unexpected common_rec version %d' % version) data = vint.read_bvec(port) - (self.mode, - self.uid, - self.user, - self.gid, - self.group, - self.rdev, - self.atime, - atime_ns, - self.mtime, - mtime_ns, - self.ctime, - ctime_ns) = vint.unpack('VVsVsVvVvVvV', data) + values = vint.unpack(unpack_fmt, data) + if version == 3: + (self.mode, self.uid, self.user, self.gid, self.group, + self.rdev, + self.atime, atime_ns, + self.mtime, mtime_ns, + self.ctime, ctime_ns, size) = values + if size >= 0: + self.size = size + else: + (self.mode, self.uid, self.user, self.gid, self.group, + self.rdev, + self.atime, atime_ns, + self.mtime, mtime_ns, + self.ctime, ctime_ns) = values self.atime = xstat.timespec_to_nsecs((self.atime, atime_ns)) self.mtime = xstat.timespec_to_nsecs((self.mtime, mtime_ns)) self.ctime = xstat.timespec_to_nsecs((self.ctime, ctime_ns)) @@ -276,15 +327,15 @@ class Metadata: st = None try: st = xstat.lstat(path) - except OSError, e: + except OSError as e: if e.errno != errno.ENOENT: raise if st: if stat.S_ISDIR(st.st_mode): try: os.rmdir(path) - except OSError, e: - if e.errno == errno.ENOTEMPTY: + except OSError as e: + if e.errno in (errno.ENOTEMPTY, errno.EEXIST): msg = 'refusing to overwrite non-empty dir ' + path raise Exception(msg) raise @@ -293,29 +344,36 @@ class Metadata: if stat.S_ISREG(self.mode): assert(self._recognized_file_type()) - fd = os.open(path, os.O_CREAT|os.O_WRONLY|os.O_EXCL, 0600) + fd = os.open(path, os.O_CREAT|os.O_WRONLY|os.O_EXCL, 0o600) os.close(fd) elif stat.S_ISDIR(self.mode): assert(self._recognized_file_type()) - os.mkdir(path, 0700) + os.mkdir(path, 0o700) elif stat.S_ISCHR(self.mode): assert(self._recognized_file_type()) - os.mknod(path, 0600 | stat.S_IFCHR, self.rdev) + os.mknod(path, 0o600 | stat.S_IFCHR, self.rdev) elif stat.S_ISBLK(self.mode): assert(self._recognized_file_type()) - os.mknod(path, 0600 | stat.S_IFBLK, self.rdev) + os.mknod(path, 0o600 | stat.S_IFBLK, self.rdev) elif stat.S_ISFIFO(self.mode): assert(self._recognized_file_type()) - os.mknod(path, 0600 | stat.S_IFIFO) + os.mkfifo(path, 0o600 | stat.S_IFIFO) elif stat.S_ISSOCK(self.mode): - os.mknod(path, 0600 | stat.S_IFSOCK) + try: + os.mknod(path, 0o600 | stat.S_IFSOCK) + except OSError as e: + if e.errno in (errno.EINVAL, errno.EPERM): + s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) + s.bind(path) + else: + raise elif stat.S_ISLNK(self.mode): assert(self._recognized_file_type()) if self.symlink_target and create_symlinks: # on MacOS, symlink() permissions depend on umask, and there's # no way to chown a symlink after creating it, so we have to # be careful here! - oldumask = os.umask((self.mode & 0777) ^ 0777) + oldumask = os.umask((self.mode & 0o777) ^ 0o777) try: os.symlink(self.symlink_target, path) finally: @@ -335,7 +393,7 @@ class Metadata: if lutime and stat.S_ISLNK(self.mode): try: lutime(path, (self.atime, self.mtime)) - except OSError, e: + except OSError as e: if e.errno == errno.EACCES: raise ApplyError('lutime: %s' % e) else: @@ -343,15 +401,12 @@ class Metadata: else: try: utime(path, (self.atime, self.mtime)) - except OSError, e: + except OSError as e: if e.errno == errno.EACCES: raise ApplyError('utime: %s' % e) else: raise - # Implement tar/rsync-like semantics; see bup-restore(1). - # FIXME: should we consider caching user/group name <-> id - # mappings, getgroups(), etc.? uid = gid = -1 # By default, do nothing. if is_superuser(): uid = self.uid @@ -380,14 +435,21 @@ class Metadata: if uid != -1 or gid != -1: try: os.lchown(path, uid, gid) - except OSError, e: + except OSError as e: if e.errno == errno.EPERM: add_error('lchown: %s' % e) + elif sys.platform.startswith('cygwin') \ + and e.errno == errno.EINVAL: + add_error('lchown: unknown uid/gid (%d/%d) for %s' + % (uid, gid, path)) else: raise if _have_lchmod: - os.lchmod(path, stat.S_IMODE(self.mode)) + try: + os.lchmod(path, stat.S_IMODE(self.mode)) + except errno.ENOSYS: # Function not implemented + pass elif not stat.S_ISLNK(self.mode): os.chmod(path, stat.S_IMODE(self.mode)) @@ -410,14 +472,19 @@ class Metadata: try: if stat.S_ISLNK(st.st_mode): self.symlink_target = os.readlink(path) - except OSError, e: - add_error('readlink: %s', e) + except OSError as e: + add_error('readlink: %s' % e) def _encode_symlink_target(self): return self.symlink_target def _load_symlink_target_rec(self, port): - self.symlink_target = vint.read_bvec(port) + target = vint.read_bvec(port) + self.symlink_target = target + if self.size is None: + self.size = len(target) + else: + assert(self.size == len(target)) ## Hardlink targets @@ -445,18 +512,30 @@ class Metadata: # The numeric/text distinction only matters when reading/restoring # a stored record. def _add_posix1e_acl(self, path, st): - if not posix1e: return + if not posix1e or not posix1e.HAS_EXTENDED_CHECK: + return if not stat.S_ISLNK(st.st_mode): + acls = None + def_acls = None try: if posix1e.has_extended(path): acl = posix1e.ACL(file=path) - self.posix1e_acl = [acl, acl] # txt and num are the same + acls = [acl, acl] # txt and num are the same if stat.S_ISDIR(st.st_mode): - acl = posix1e.ACL(filedef=path) - self.posix1e_acl.extend([acl, acl]) - except EnvironmentError, e: - if e.errno != errno.EOPNOTSUPP: + def_acl = posix1e.ACL(filedef=path) + def_acls = [def_acl, def_acl] + except EnvironmentError as e: + if e.errno not in (errno.EOPNOTSUPP, errno.ENOSYS): raise + if acls: + txt_flags = posix1e.TEXT_ABBREVIATE + num_flags = posix1e.TEXT_ABBREVIATE | posix1e.TEXT_NUMERIC_IDS + acl_rep = [acls[0].to_any_text('', '\n', txt_flags), + acls[1].to_any_text('', '\n', num_flags)] + if def_acls: + acl_rep.append(def_acls[0].to_any_text('', '\n', txt_flags)) + acl_rep.append(def_acls[1].to_any_text('', '\n', num_flags)) + self.posix1e_acl = acl_rep def _same_posix1e_acl(self, other): """Return true or false to indicate similarity in the hardlink sense.""" @@ -466,32 +545,34 @@ class Metadata: # Encode as two strings (w/default ACL string possibly empty). if self.posix1e_acl: acls = self.posix1e_acl - txt_flags = posix1e.TEXT_ABBREVIATE - num_flags = posix1e.TEXT_ABBREVIATE | posix1e.TEXT_NUMERIC_IDS - acl_reps = [acls[0].to_any_text('', '\n', txt_flags), - acls[1].to_any_text('', '\n', num_flags)] - if len(acls) < 3: - acl_reps += ['', ''] - else: - acl_reps.append(acls[2].to_any_text('', '\n', txt_flags)) - acl_reps.append(acls[3].to_any_text('', '\n', num_flags)) - return vint.pack('ssss', - acl_reps[0], acl_reps[1], acl_reps[2], acl_reps[3]) + if len(acls) == 2: + acls.extend(['', '']) + return vint.pack('ssss', acls[0], acls[1], acls[2], acls[3]) else: return None def _load_posix1e_acl_rec(self, port): - data = vint.read_bvec(port) - acl_reps = vint.unpack('ssss', data) - if acl_reps[2] == '': - acl_reps = acl_reps[:2] - self.posix1e_acl = [posix1e.ACL(text=x) for x in acl_reps] + acl_rep = vint.unpack('ssss', vint.read_bvec(port)) + if acl_rep[2] == '': + acl_rep = acl_rep[:2] + self.posix1e_acl = acl_rep def _apply_posix1e_acl_rec(self, path, restore_numeric_ids=False): - def apply_acl(acl, kind): + def apply_acl(acl_rep, kind): + try: + acl = posix1e.ACL(text = acl_rep) + except IOError as e: + if e.errno == 0: + # pylibacl appears to return an IOError with errno + # set to 0 if a group referred to by the ACL rep + # doesn't exist on the current system. + raise ApplyError("POSIX1e ACL: can't create %r for %r" + % (acl_rep, path)) + else: + raise try: acl.applyto(path, kind) - except IOError, e: + except IOError as e: if e.errno == errno.EPERM or e.errno == errno.EOPNOTSUPP: raise ApplyError('POSIX1e ACL applyto: %s' % e) else: @@ -518,20 +599,27 @@ class Metadata: ## Linux attributes (lsattr(1), chattr(1)) def _add_linux_attr(self, path, st): + check_linux_file_attr_api() if not get_linux_file_attr: return if stat.S_ISREG(st.st_mode) or stat.S_ISDIR(st.st_mode): try: attr = get_linux_file_attr(path) if attr != 0: self.linux_attr = attr - except OSError, e: + except OSError as e: if e.errno == errno.EACCES: add_error('read Linux attr: %s' % e) - elif e.errno == errno.ENOTTY or e.errno == errno.ENOSYS: - # ENOTTY: Function not implemented. - # ENOSYS: Inappropriate ioctl for device. + elif e.errno in (ENOTTY, ENOSYS, EOPNOTSUPP): # Assume filesystem doesn't support attrs. return + elif e.errno == EINVAL: + global _warned_about_attr_einval + if not _warned_about_attr_einval: + log("Ignoring attr EINVAL;" + + " if you're not using ntfs-3g, please report: " + + repr(path) + '\n') + _warned_about_attr_einval = True + return else: raise @@ -551,15 +639,21 @@ class Metadata: def _apply_linux_attr_rec(self, path, restore_numeric_ids=False): if self.linux_attr: + check_linux_file_attr_api() if not set_linux_file_attr: add_error("%s: can't restore linuxattrs: " "linuxattr support missing.\n" % path) return try: set_linux_file_attr(path, self.linux_attr) - except OSError, e: - if e.errno == errno.ENOTTY: - raise ApplyError('Linux chattr: %s' % e) + except OSError as e: + if e.errno in (EACCES, ENOTTY, EOPNOTSUPP, ENOSYS): + raise ApplyError('Linux chattr: %s (0x%s)' + % (e, hex(self.linux_attr))) + elif e.errno == EINVAL: + msg = "if you're not using ntfs-3g, please report" + raise ApplyError('Linux chattr: %s (0x%s) (%s)' + % (e, hex(self.linux_attr), msg)) else: raise @@ -570,7 +664,7 @@ class Metadata: if not xattr: return try: self.linux_xattr = xattr.get_all(path, nofollow=True) - except EnvironmentError, e: + except EnvironmentError as e: if e.errno != errno.EOPNOTSUPP: raise @@ -589,7 +683,7 @@ class Metadata: def _load_linux_xattr_rec(self, file): data = vint.read_bvec(file) - memfile = StringIO(data) + memfile = BytesIO(data) result = [] for i in range(vint.read_vuint(memfile)): key = vint.read_bvec(memfile) @@ -603,31 +697,39 @@ class Metadata: add_error("%s: can't restore xattr; xattr support missing.\n" % path) return - existing_xattrs = set(xattr.list(path, nofollow=True)) - if self.linux_xattr: - for k, v in self.linux_xattr: - if k not in existing_xattrs \ - or v != xattr.get(path, k, nofollow=True): - try: - xattr.set(path, k, v, nofollow=True) - except IOError, e: - if e.errno == errno.EPERM \ - or e.errno == errno.EOPNOTSUPP: - raise ApplyError('xattr.set: %s' % e) - else: - raise - existing_xattrs -= frozenset([k]) - for k in existing_xattrs: + if not self.linux_xattr: + return + try: + existing_xattrs = set(xattr.list(path, nofollow=True)) + except IOError as e: + if e.errno == errno.EACCES: + raise ApplyError('xattr.set %r: %s' % (path, e)) + else: + raise + for k, v in self.linux_xattr: + if k not in existing_xattrs \ + or v != xattr.get(path, k, nofollow=True): try: - xattr.remove(path, k, nofollow=True) - except IOError, e: - if e.errno == errno.EPERM: - raise ApplyError('xattr.remove: %s' % e) + xattr.set(path, k, v, nofollow=True) + except IOError as e: + if e.errno == errno.EPERM \ + or e.errno == errno.EOPNOTSUPP: + raise ApplyError('xattr.set %r: %s' % (path, e)) else: raise + existing_xattrs -= frozenset([k]) + for k in existing_xattrs: + try: + xattr.remove(path, k, nofollow=True) + except IOError as e: + if e.errno in (errno.EPERM, errno.EACCES): + raise ApplyError('xattr.remove %r: %s' % (path, e)) + else: + raise def __init__(self): - self.mode = None + self.mode = self.uid = self.gid = self.user = self.group = None + self.atime = self.mtime = self.ctime = None # optional members self.path = None self.size = None @@ -636,11 +738,76 @@ class Metadata: self.linux_attr = None self.linux_xattr = None self.posix1e_acl = None - self.posix1e_acl_default = None + + def __eq__(self, other): + if not isinstance(other, Metadata): return False + if self.mode != other.mode: return False + if self.mtime != other.mtime: return False + if self.ctime != other.ctime: return False + if self.atime != other.atime: return False + if self.path != other.path: return False + if self.uid != other.uid: return False + if self.gid != other.gid: return False + if self.size != other.size: return False + if self.user != other.user: return False + if self.group != other.group: return False + if self.symlink_target != other.symlink_target: return False + if self.hardlink_target != other.hardlink_target: return False + if self.linux_attr != other.linux_attr: return False + if self.posix1e_acl != other.posix1e_acl: return False + return True + + def __ne__(self, other): + return not self.__eq__(other) + + def __hash__(self): + return hash((self.mode, + self.mtime, + self.ctime, + self.atime, + self.path, + self.uid, + self.gid, + self.size, + self.user, + self.group, + self.symlink_target, + self.hardlink_target, + self.linux_attr, + self.posix1e_acl)) + + def __repr__(self): + result = ['<%s instance at %s' % (self.__class__, hex(id(self)))] + if self.path is not None: + result += ' path:' + repr(self.path) + if self.mode is not None: + result += ' mode:' + repr(xstat.mode_str(self.mode) + + '(%s)' % oct(self.mode)) + if self.uid is not None: + result += ' uid:' + str(self.uid) + if self.gid is not None: + result += ' gid:' + str(self.gid) + if self.user is not None: + result += ' user:' + repr(self.user) + if self.group is not None: + result += ' group:' + repr(self.group) + if self.size is not None: + result += ' size:' + repr(self.size) + for name, val in (('atime', self.atime), + ('mtime', self.mtime), + ('ctime', self.ctime)): + if val is not None: + result += ' %s:%r (%d)' \ + % (name, + strftime('%Y-%m-%d %H:%M %z', + gmtime(xstat.fstime_floor_secs(val))), + val) + result += '>' + return ''.join(result) def write(self, port, include_path=True): records = include_path and [(_rec_tag_path, self._encode_path())] or [] - records.extend([(_rec_tag_common, self._encode_common()), + records.extend([(_rec_tag_common_v3, self._encode_common()), (_rec_tag_symlink_target, self._encode_symlink_target()), (_rec_tag_hardlink_target, @@ -655,10 +822,13 @@ class Metadata: vint.write_vuint(port, _rec_tag_end) def encode(self, include_path=True): - port = StringIO() + port = BytesIO() self.write(port, include_path) return port.getvalue() + def copy(self): + return deepcopy(self) + @staticmethod def read(port): # This method should either return a valid Metadata object, @@ -674,22 +844,24 @@ class Metadata: while True: # only exit is error (exception) or _rec_tag_end if tag == _rec_tag_path: result._load_path_rec(port) - elif tag == _rec_tag_common: - result._load_common_rec(port) + elif tag == _rec_tag_common_v3: + result._load_common_rec(port, version=3) + elif tag == _rec_tag_common_v2: + result._load_common_rec(port, version=2) elif tag == _rec_tag_symlink_target: result._load_symlink_target_rec(port) elif tag == _rec_tag_hardlink_target: result._load_hardlink_target_rec(port) elif tag == _rec_tag_posix1e_acl: result._load_posix1e_acl_rec(port) - elif tag ==_rec_tag_nfsv4_acl: - result._load_nfsv4_acl_rec(port) elif tag == _rec_tag_linux_attr: result._load_linux_attr_rec(port) elif tag == _rec_tag_linux_xattr: result._load_linux_xattr_rec(port) elif tag == _rec_tag_end: return result + elif tag == _rec_tag_common_v1: # Should be very rare. + result._load_common_rec(port, version=1) else: # unknown record vint.skip_bvec(port) tag = vint.read_vuint(port) @@ -713,13 +885,14 @@ class Metadata: + ' with unrecognized mode "0x%x"\n' % self.mode) return num_ids = restore_numeric_ids - try: - self._apply_common_rec(path, restore_numeric_ids=num_ids) - self._apply_posix1e_acl_rec(path, restore_numeric_ids=num_ids) - self._apply_linux_attr_rec(path, restore_numeric_ids=num_ids) - self._apply_linux_xattr_rec(path, restore_numeric_ids=num_ids) - except ApplyError, e: - add_error(e) + for apply_metadata in (self._apply_common_rec, + self._apply_posix1e_acl_rec, + self._apply_linux_attr_rec, + self._apply_linux_xattr_rec): + try: + apply_metadata(path, restore_numeric_ids=num_ids) + except ApplyError as e: + add_error(e) def same_file(self, other): """Compare this to other for equivalency. Return true if @@ -734,11 +907,14 @@ class Metadata: def from_path(path, statinfo=None, archive_path=None, - save_symlinks=True, hardlink_target=None): + save_symlinks=True, hardlink_target=None, + normalized=False): + """Return the metadata associated with the path. When normalized is + true, return the metadata appropriate for a typical save, which + may or may not be all of it.""" result = Metadata() result.path = archive_path st = statinfo or xstat.lstat(path) - result.size = st.st_size result._add_common(path, st) if save_symlinks: result._add_symlink_target(path, st) @@ -746,6 +922,10 @@ def from_path(path, statinfo=None, archive_path=None, result._add_posix1e_acl(path, st) result._add_linux_attr(path, st) result._add_linux_xattr(path, st) + if normalized: + # Only store sizes for regular files and symlinks for now. + if not (stat.S_ISREG(result.mode) or stat.S_ISLNK(result.mode)): + result.size = None return result @@ -761,20 +941,32 @@ def save_tree(output_file, paths, if safe_path != path: log('archiving "%s" as "%s"\n' % (path, safe_path)) - start_dir = os.getcwd() - try: - for (p, st) in recursive_dirlist(paths, xdev=xdev): - dirlist_dir = os.getcwd() - os.chdir(start_dir) + if not recurse: + for p in paths: safe_path = _clean_up_path_for_archive(p) + st = xstat.lstat(p) + if stat.S_ISDIR(st.st_mode): + safe_path += '/' m = from_path(p, statinfo=st, archive_path=safe_path, save_symlinks=save_symlinks) if verbose: - print >> sys.stderr, m.path + print(m.path, file=sys.stderr) m.write(output_file, include_path=write_paths) - os.chdir(dirlist_dir) - finally: - os.chdir(start_dir) + else: + start_dir = os.getcwd() + try: + for (p, st) in recursive_dirlist(paths, xdev=xdev): + dirlist_dir = os.getcwd() + os.chdir(start_dir) + safe_path = _clean_up_path_for_archive(p) + m = from_path(p, statinfo=st, archive_path=safe_path, + save_symlinks=save_symlinks) + if verbose: + print(m.path, file=sys.stderr) + m.write(output_file, include_path=write_paths) + os.chdir(dirlist_dir) + finally: + os.chdir(start_dir) def _set_up_path(meta, create_symlinks=True): @@ -806,29 +998,57 @@ all_fields = frozenset(['path', 'posix1e-acl']) -def summary_str(meta): - mode_val = xstat.mode_str(meta.mode) - user_val = meta.user - if not user_val: - user_val = str(meta.uid) - group_val = meta.group - if not group_val: - group_val = str(meta.gid) - size_or_dev_val = '-' - if stat.S_ISCHR(meta.mode) or stat.S_ISBLK(meta.mode): - size_or_dev_val = '%d,%d' % (os.major(meta.rdev), os.minor(meta.rdev)) - elif meta.size: - size_or_dev_val = meta.size - mtime_secs = xstat.fstime_floor_secs(meta.mtime) - time_val = time.strftime('%Y-%m-%d %H:%M', time.localtime(mtime_secs)) - path_val = meta.path or '' - if stat.S_ISLNK(meta.mode): - path_val += ' -> ' + meta.symlink_target - return '%-10s %-11s %11s %16s %s' % (mode_val, - user_val + "/" + group_val, - size_or_dev_val, - time_val, - path_val) +def summary_str(meta, numeric_ids = False, classification = None, + human_readable = False): + + """Return a string containing the "ls -l" style listing for meta. + Classification may be "all", "type", or None.""" + user_str = group_str = size_or_dev_str = '?' + symlink_target = None + if meta: + name = meta.path + mode_str = xstat.mode_str(meta.mode) + symlink_target = meta.symlink_target + mtime_secs = xstat.fstime_floor_secs(meta.mtime) + mtime_str = strftime('%Y-%m-%d %H:%M', time.localtime(mtime_secs)) + if meta.user and not numeric_ids: + user_str = meta.user + elif meta.uid != None: + user_str = str(meta.uid) + if meta.group and not numeric_ids: + group_str = meta.group + elif meta.gid != None: + group_str = str(meta.gid) + if stat.S_ISCHR(meta.mode) or stat.S_ISBLK(meta.mode): + if meta.rdev: + size_or_dev_str = '%d,%d' % (os.major(meta.rdev), + os.minor(meta.rdev)) + elif meta.size != None: + if human_readable: + size_or_dev_str = format_filesize(meta.size) + else: + size_or_dev_str = str(meta.size) + else: + size_or_dev_str = '-' + if classification: + classification_str = \ + xstat.classification_str(meta.mode, classification == 'all') + else: + mode_str = '?' * 10 + mtime_str = '????-??-?? ??:??' + classification_str = '?' + + name = name or '' + if classification: + name += classification_str + if symlink_target: + name += ' -> ' + meta.symlink_target + + return '%-10s %-11s %11s %16s %s' % (mode_str, + user_str + "/" + group_str, + size_or_dev_str, + mtime_str, + name) def detailed_str(meta, fields = None): @@ -852,7 +1072,7 @@ def detailed_str(meta, fields = None): os.minor(meta.rdev))) else: result.append('rdev: 0') - if 'size' in fields and meta.size: + if 'size' in fields and meta.size is not None: result.append('size: ' + str(meta.size)) if 'uid' in fields: result.append('uid: ' + str(meta.uid)) @@ -884,16 +1104,12 @@ def detailed_str(meta, fields = None): if 'linux-xattr' in fields and meta.linux_xattr: for name, value in meta.linux_xattr: result.append('linux-xattr: %s -> %s' % (name, repr(value))) - if 'posix1e-acl' in fields and meta.posix1e_acl and posix1e: - flags = posix1e.TEXT_ABBREVIATE + if 'posix1e-acl' in fields and meta.posix1e_acl: + acl = meta.posix1e_acl[0] + result.append('posix1e-acl: ' + acl + '\n') if stat.S_ISDIR(meta.mode): - acl = meta.posix1e_acl[0] - default_acl = meta.posix1e_acl[2] - result.append(acl.to_any_text('posix1e-acl: ', '\n', flags)) - result.append(acl.to_any_text('posix1e-acl-default: ', '\n', flags)) - else: - acl = meta.posix1e_acl[0] - result.append(acl.to_any_text('posix1e-acl: ', '\n', flags)) + def_acl = meta.posix1e_acl[2] + result.append('posix1e-acl-default: ' + def_acl + '\n') return '\n'.join(result) @@ -916,20 +1132,19 @@ def display_archive(file): first_item = True for meta in _ArchiveIterator(file): if not first_item: - print - print detailed_str(meta) + print() + print(detailed_str(meta)) first_item = False elif verbose > 0: for meta in _ArchiveIterator(file): - print summary_str(meta) + print(summary_str(meta)) elif verbose == 0: for meta in _ArchiveIterator(file): if not meta.path: - print >> sys.stderr, \ - 'bup: no metadata path, but asked to only display path', \ - '(increase verbosity?)' + print('bup: no metadata path, but asked to only display path' + '(increase verbosity?)') sys.exit(1) - print meta.path + print(meta.path) def start_extract(file, create_symlinks=True): @@ -937,7 +1152,7 @@ def start_extract(file, create_symlinks=True): if not meta: # Hit end record. break if verbose: - print >> sys.stderr, meta.path + print(meta.path, file=sys.stderr) xpath = _clean_up_extract_path(meta.path) if not xpath: add_error(Exception('skipping risky path "%s"' % meta.path)) @@ -959,7 +1174,7 @@ def finish_extract(file, restore_numeric_ids=False): all_dirs.append(meta) else: if verbose: - print >> sys.stderr, meta.path + print(meta.path, file=sys.stderr) meta.apply_to_path(path=xpath, restore_numeric_ids=restore_numeric_ids) all_dirs.sort(key = lambda x : len(x.path), reverse=True) @@ -967,7 +1182,7 @@ def finish_extract(file, restore_numeric_ids=False): # Don't need to check xpath -- won't be in all_dirs if not OK. xpath = _clean_up_extract_path(dir.path) if verbose: - print >> sys.stderr, dir.path + print(dir.path, file=sys.stderr) dir.apply_to_path(path=xpath, restore_numeric_ids=restore_numeric_ids) @@ -984,20 +1199,20 @@ def extract(file, restore_numeric_ids=False, create_symlinks=True): else: meta.path = xpath if verbose: - print >> sys.stderr, '+', meta.path + print('+', meta.path, file=sys.stderr) _set_up_path(meta, create_symlinks=create_symlinks) if os.path.isdir(meta.path): all_dirs.append(meta) else: if verbose: - print >> sys.stderr, '=', meta.path + print('=', meta.path, file=sys.stderr) meta.apply_to_path(restore_numeric_ids=restore_numeric_ids) all_dirs.sort(key = lambda x : len(x.path), reverse=True) for dir in all_dirs: # Don't need to check xpath -- won't be in all_dirs if not OK. xpath = _clean_up_extract_path(dir.path) if verbose: - print >> sys.stderr, '=', xpath + print('=', xpath, file=sys.stderr) # Shouldn't have to check for risky paths here (omitted above). dir.apply_to_path(path=dir.path, restore_numeric_ids=restore_numeric_ids)