lib/bup/metadata.py

   1 """Metadata read/write support for bup."""
   2
   3 # Copyright (C) 2010 Rob Browning
   4 #
   5 # This code is covered under the terms of the GNU Library General
   6 # Public License as described in the bup LICENSE file.
   7 import errno, os, sys, stat, time, pwd, grp, socket
   8 from cStringIO import StringIO
   9 from bup import vint, xstat
  10 from bup.drecurse import recursive_dirlist
  11 from bup.helpers import add_error, mkdirp, log, is_superuser
  12 from bup.helpers import pwd_from_uid, pwd_from_name, grp_from_gid, grp_from_name
  13 from bup.xstat import utime, lutime
  14
  15 xattr = None
  16 if sys.platform.startswith('linux'):
  17     try:
  18         import xattr
  19     except ImportError:
  20         log('Warning: Linux xattr support missing; install python-pyxattr.\n')
  21     if xattr:
  22         try:
  23             xattr.get_all
  24         except AttributeError:
  25             log('Warning: python-xattr module is too old; '
  26                 'install python-pyxattr instead.\n')
  27             xattr = None
  28
  29 posix1e = None
  30 if not (sys.platform.startswith('cygwin') or sys.platform.startswith('darwin')):
  31     try:
  32         import posix1e
  33     except ImportError:
  34         log('Warning: POSIX ACL support missing; install python-pylibacl.\n')
  35
  36 try:
  37     from bup._helpers import get_linux_file_attr, set_linux_file_attr
  38 except ImportError:
  39     # No need for a warning here; the only reason they won't exist is that we're
  40     # not on Linux, in which case files don't have any linux attrs anyway, so
  41     # lacking the functions isn't a problem.
  42     get_linux_file_attr = set_linux_file_attr = None
  43
  44
  45 # WARNING: the metadata encoding is *not* stable yet.  Caveat emptor!
  46
  47 # Q: Consider hardlink support?
  48 # Q: Is it OK to store raw linux attr (chattr) flags?
  49 # Q: Can anything other than S_ISREG(x) or S_ISDIR(x) support posix1e ACLs?
  50 # Q: Is the application of posix1e has_extended() correct?
  51 # Q: Is one global --numeric-ids argument sufficient?
  52 # Q: Do nfsv4 acls trump posix1e acls? (seems likely)
  53 # Q: Add support for crtime -- ntfs, and (only internally?) ext*?
  54
  55 # FIXME: Fix relative/abs path detection/stripping wrt other platforms.
  56 # FIXME: Add nfsv4 acl handling - see nfs4-acl-tools.
  57 # FIXME: Consider other entries mentioned in stat(2) (S_IFDOOR, etc.).
  58 # FIXME: Consider pack('vvvvsss', ...) optimization.
  59 # FIXME: Consider caching users/groups.
  60
  61 ## FS notes:
  62 #
  63 # osx (varies between hfs and hfs+):
  64 #   type - regular dir char block fifo socket ...
  65 #   perms - rwxrwxrwxsgt
  66 #   times - ctime atime mtime
  67 #   uid
  68 #   gid
  69 #   hard-link-info (hfs+ only)
  70 #   link-target
  71 #   device-major/minor
  72 #   attributes-osx see chflags
  73 #   content-type
  74 #   content-creator
  75 #   forks
  76 #
  77 # ntfs
  78 #   type - regular dir ...
  79 #   times - creation, modification, posix change, access
  80 #   hard-link-info
  81 #   link-target
  82 #   attributes - see attrib
  83 #   ACLs
  84 #   forks (alternate data streams)
  85 #   crtime?
  86 #
  87 # fat
  88 #   type - regular dir ...
  89 #   perms - rwxrwxrwx (maybe - see wikipedia)
  90 #   times - creation, modification, access
  91 #   attributes - see attrib
  92
  93 verbose = 0
  94
  95 _have_lchmod = hasattr(os, 'lchmod')
  96
  97
  98 def _clean_up_path_for_archive(p):
  99     # Not the most efficient approach.
 100     result = p
 101
 102     # Take everything after any '/../'.
 103     pos = result.rfind('/../')
 104     if pos != -1:
 105         result = result[result.rfind('/../') + 4:]
 106
 107     # Take everything after any remaining '../'.
 108     if result.startswith("../"):
 109         result = result[3:]
 110
 111     # Remove any '/./' sequences.
 112     pos = result.find('/./')
 113     while pos != -1:
 114         result = result[0:pos] + '/' + result[pos + 3:]
 115         pos = result.find('/./')
 116
 117     # Remove any leading '/'s.
 118     result = result.lstrip('/')
 119
 120     # Replace '//' with '/' everywhere.
 121     pos = result.find('//')
 122     while pos != -1:
 123         result = result[0:pos] + '/' + result[pos + 2:]
 124         pos = result.find('//')
 125
 126     # Take everything after any remaining './'.
 127     if result.startswith('./'):
 128         result = result[2:]
 129
 130     # Take everything before any remaining '/.'.
 131     if result.endswith('/.'):
 132         result = result[:-2]
 133
 134     if result == '' or result.endswith('/..'):
 135         result = '.'
 136
 137     return result
 138
 139
 140 def _risky_path(p):
 141     if p.startswith('/'):
 142         return True
 143     if p.find('/../') != -1:
 144         return True
 145     if p.startswith('../'):
 146         return True
 147     if p.endswith('/..'):
 148         return True
 149     return False
 150
 151
 152 def _clean_up_extract_path(p):
 153     result = p.lstrip('/')
 154     if result == '':
 155         return '.'
 156     elif _risky_path(result):
 157         return None
 158     else:
 159         return result
 160
 161
 162 # These tags are currently conceptually private to Metadata, and they
 163 # must be unique, and must *never* be changed.
 164 _rec_tag_end = 0
 165 _rec_tag_path = 1
 166 _rec_tag_common = 2           # times, user, group, type, perms, etc.
 167 _rec_tag_symlink_target = 3
 168 _rec_tag_posix1e_acl = 4      # getfacl(1), setfacl(1), etc.
 169 _rec_tag_nfsv4_acl = 5        # intended to supplant posix1e? (unimplemented)
 170 _rec_tag_linux_attr = 6       # lsattr(1) chattr(1)
 171 _rec_tag_linux_xattr = 7      # getfattr(1) setfattr(1)
 172 _rec_tag_hardlink_target = 8 # hard link target path
 173
 174
 175 class ApplyError(Exception):
 176     # Thrown when unable to apply any given bit of metadata to a path.
 177     pass
 178
 179
 180 class Metadata:
 181     # Metadata is stored as a sequence of tagged binary records.  Each
 182     # record will have some subset of add, encode, load, create, and
 183     # apply methods, i.e. _add_foo...
 184
 185     # We do allow an "empty" object as a special case, i.e. no
 186     # records.  One can be created by trying to write Metadata(), and
 187     # for such an object, read() will return None.  This is used by
 188     # "bup save", for example, as a placeholder in cases where
 189     # from_path() fails.
 190
 191     # NOTE: if any relevant fields are added or removed, be sure to
 192     # update same_file() below.
 193
 194     ## Common records
 195
 196     # Timestamps are (sec, ns), relative to 1970-01-01 00:00:00, ns
 197     # must be non-negative and < 10**9.
 198
 199     def _add_common(self, path, st):
 200         self.uid = st.st_uid
 201         self.gid = st.st_gid
 202         self.atime = st.st_atime
 203         self.mtime = st.st_mtime
 204         self.ctime = st.st_ctime
 205         self.user = self.group = ''
 206         entry = pwd_from_uid(st.st_uid)
 207         if entry:
 208             self.user = entry.pw_name
 209         entry = grp_from_gid(st.st_gid)
 210         if entry:
 211             self.group = entry.gr_name
 212         self.mode = st.st_mode
 213         # Only collect st_rdev if we might need it for a mknod()
 214         # during restore.  On some platforms (i.e. kFreeBSD), it isn't
 215         # stable for other file types.  For example "cp -a" will
 216         # change it for a plain file.
 217         if stat.S_ISCHR(st.st_mode) or stat.S_ISBLK(st.st_mode):
 218             self.rdev = st.st_rdev
 219         else:
 220             self.rdev = 0
 221
 222     def _same_common(self, other):
 223         """Return true or false to indicate similarity in the hardlink sense."""
 224         return self.uid == other.uid \
 225             and self.gid == other.gid \
 226             and self.rdev == other.rdev \
 227             and self.atime == other.atime \
 228             and self.mtime == other.mtime \
 229             and self.ctime == other.ctime \
 230             and self.user == other.user \
 231             and self.group == other.group
 232
 233     def _encode_common(self):
 234         if not self.mode:
 235             return None
 236         atime = xstat.nsecs_to_timespec(self.atime)
 237         mtime = xstat.nsecs_to_timespec(self.mtime)
 238         ctime = xstat.nsecs_to_timespec(self.ctime)
 239         result = vint.pack('VVsVsVvVvVvV',
 240                            self.mode,
 241                            self.uid,
 242                            self.user,
 243                            self.gid,
 244                            self.group,
 245                            self.rdev,
 246                            atime[0],
 247                            atime[1],
 248                            mtime[0],
 249                            mtime[1],
 250                            ctime[0],
 251                            ctime[1])
 252         return result
 253
 254     def _load_common_rec(self, port):
 255         data = vint.read_bvec(port)
 256         (self.mode,
 257          self.uid,
 258          self.user,
 259          self.gid,
 260          self.group,
 261          self.rdev,
 262          self.atime,
 263          atime_ns,
 264          self.mtime,
 265          mtime_ns,
 266          self.ctime,
 267          ctime_ns) = vint.unpack('VVsVsVvVvVvV', data)
 268         self.atime = xstat.timespec_to_nsecs((self.atime, atime_ns))
 269         self.mtime = xstat.timespec_to_nsecs((self.mtime, mtime_ns))
 270         self.ctime = xstat.timespec_to_nsecs((self.ctime, ctime_ns))
 271
 272     def _recognized_file_type(self):
 273         return stat.S_ISREG(self.mode) \
 274             or stat.S_ISDIR(self.mode) \
 275             or stat.S_ISCHR(self.mode) \
 276             or stat.S_ISBLK(self.mode) \
 277             or stat.S_ISFIFO(self.mode) \
 278             or stat.S_ISSOCK(self.mode) \
 279             or stat.S_ISLNK(self.mode)
 280
 281     def _create_via_common_rec(self, path, create_symlinks=True):
 282         if not self.mode:
 283             raise ApplyError('no metadata - cannot create path ' + path)
 284
 285         # If the path already exists and is a dir, try rmdir.
 286         # If the path already exists and is anything else, try unlink.
 287         st = None
 288         try:
 289             st = xstat.lstat(path)
 290         except OSError, e:
 291             if e.errno != errno.ENOENT:
 292                 raise
 293         if st:
 294             if stat.S_ISDIR(st.st_mode):
 295                 try:
 296                     os.rmdir(path)
 297                 except OSError, e:
 298                     if e.errno in (errno.ENOTEMPTY, errno.EEXIST):
 299                         msg = 'refusing to overwrite non-empty dir ' + path
 300                         raise Exception(msg)
 301                     raise
 302             else:
 303                 os.unlink(path)
 304
 305         if stat.S_ISREG(self.mode):
 306             assert(self._recognized_file_type())
 307             fd = os.open(path, os.O_CREAT|os.O_WRONLY|os.O_EXCL, 0600)
 308             os.close(fd)
 309         elif stat.S_ISDIR(self.mode):
 310             assert(self._recognized_file_type())
 311             os.mkdir(path, 0700)
 312         elif stat.S_ISCHR(self.mode):
 313             assert(self._recognized_file_type())
 314             os.mknod(path, 0600 | stat.S_IFCHR, self.rdev)
 315         elif stat.S_ISBLK(self.mode):
 316             assert(self._recognized_file_type())
 317             os.mknod(path, 0600 | stat.S_IFBLK, self.rdev)
 318         elif stat.S_ISFIFO(self.mode):
 319             assert(self._recognized_file_type())
 320             os.mknod(path, 0600 | stat.S_IFIFO)
 321         elif stat.S_ISSOCK(self.mode):
 322             try:
 323                 os.mknod(path, 0600 | stat.S_IFSOCK)
 324             except OSError, e:
 325                 if e.errno in (errno.EINVAL, errno.EPERM):
 326                     s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
 327                     s.bind(path)
 328                 else:
 329                     raise
 330         elif stat.S_ISLNK(self.mode):
 331             assert(self._recognized_file_type())
 332             if self.symlink_target and create_symlinks:
 333                 # on MacOS, symlink() permissions depend on umask, and there's
 334                 # no way to chown a symlink after creating it, so we have to
 335                 # be careful here!
 336                 oldumask = os.umask((self.mode & 0777) ^ 0777)
 337                 try:
 338                     os.symlink(self.symlink_target, path)
 339                 finally:
 340                     os.umask(oldumask)
 341         # FIXME: S_ISDOOR, S_IFMPB, S_IFCMP, S_IFNWK, ... see stat(2).
 342         else:
 343             assert(not self._recognized_file_type())
 344             add_error('not creating "%s" with unrecognized mode "0x%x"\n'
 345                       % (path, self.mode))
 346
 347     def _apply_common_rec(self, path, restore_numeric_ids=False):
 348         if not self.mode:
 349             raise ApplyError('no metadata - cannot apply to ' + path)
 350
 351         # FIXME: S_ISDOOR, S_IFMPB, S_IFCMP, S_IFNWK, ... see stat(2).
 352         # EACCES errors at this stage are fatal for the current path.
 353         if lutime and stat.S_ISLNK(self.mode):
 354             try:
 355                 lutime(path, (self.atime, self.mtime))
 356             except OSError, e:
 357                 if e.errno == errno.EACCES:
 358                     raise ApplyError('lutime: %s' % e)
 359                 else:
 360                     raise
 361         else:
 362             try:
 363                 utime(path, (self.atime, self.mtime))
 364             except OSError, e:
 365                 if e.errno == errno.EACCES:
 366                     raise ApplyError('utime: %s' % e)
 367                 else:
 368                     raise
 369
 370         # Implement tar/rsync-like semantics; see bup-restore(1).
 371         # FIXME: should we consider caching user/group name <-> id
 372         # mappings, getgroups(), etc.?
 373         uid = gid = -1 # By default, do nothing.
 374         if is_superuser():
 375             uid = self.uid
 376             gid = self.gid
 377             if not restore_numeric_ids:
 378                 if self.uid != 0 and self.user:
 379                     entry = pwd_from_name(self.user)
 380                     if entry:
 381                         uid = entry.pw_uid
 382                 if self.gid != 0 and self.group:
 383                     entry = grp_from_name(self.group)
 384                     if entry:
 385                         gid = entry.gr_gid
 386         else: # not superuser - only consider changing the group/gid
 387             user_gids = os.getgroups()
 388             if self.gid in user_gids:
 389                 gid = self.gid
 390             if not restore_numeric_ids and self.gid != 0:
 391                 # The grp might not exist on the local system.
 392                 grps = filter(None, [grp_from_gid(x) for x in user_gids])
 393                 if self.group in [x.gr_name for x in grps]:
 394                     g = grp_from_name(self.group)
 395                     if g:
 396                         gid = g.gr_gid
 397
 398         if uid != -1 or gid != -1:
 399             try:
 400                 os.lchown(path, uid, gid)
 401             except OSError, e:
 402                 if e.errno == errno.EPERM:
 403                     add_error('lchown: %s' %  e)
 404                 elif sys.platform.startswith('cygwin') \
 405                    and e.errno == errno.EINVAL:
 406                     add_error('lchown: unknown uid/gid (%d/%d) for %s'
 407                               %  (uid, gid, path))
 408                 else:
 409                     raise
 410
 411         if _have_lchmod:
 412             os.lchmod(path, stat.S_IMODE(self.mode))
 413         elif not stat.S_ISLNK(self.mode):
 414             os.chmod(path, stat.S_IMODE(self.mode))
 415
 416
 417     ## Path records
 418
 419     def _encode_path(self):
 420         if self.path:
 421             return vint.pack('s', self.path)
 422         else:
 423             return None
 424
 425     def _load_path_rec(self, port):
 426         self.path = vint.unpack('s', vint.read_bvec(port))[0]
 427
 428
 429     ## Symlink targets
 430
 431     def _add_symlink_target(self, path, st):
 432         try:
 433             if stat.S_ISLNK(st.st_mode):
 434                 self.symlink_target = os.readlink(path)
 435         except OSError, e:
 436             add_error('readlink: %s', e)
 437
 438     def _encode_symlink_target(self):
 439         return self.symlink_target
 440
 441     def _load_symlink_target_rec(self, port):
 442         self.symlink_target = vint.read_bvec(port)
 443
 444
 445     ## Hardlink targets
 446
 447     def _add_hardlink_target(self, target):
 448         self.hardlink_target = target
 449
 450     def _same_hardlink_target(self, other):
 451         """Return true or false to indicate similarity in the hardlink sense."""
 452         return self.hardlink_target == other.hardlink_target
 453
 454     def _encode_hardlink_target(self):
 455         return self.hardlink_target
 456
 457     def _load_hardlink_target_rec(self, port):
 458         self.hardlink_target = vint.read_bvec(port)
 459
 460
 461     ## POSIX1e ACL records
 462
 463     # Recorded as a list:
 464     #   [txt_id_acl, num_id_acl]
 465     # or, if a directory:
 466     #   [txt_id_acl, num_id_acl, txt_id_default_acl, num_id_default_acl]
 467     # The numeric/text distinction only matters when reading/restoring
 468     # a stored record.
 469     def _add_posix1e_acl(self, path, st):
 470         if not posix1e: return
 471         if not stat.S_ISLNK(st.st_mode):
 472             try:
 473                 if posix1e.has_extended(path):
 474                     acl = posix1e.ACL(file=path)
 475                     self.posix1e_acl = [acl, acl] # txt and num are the same
 476                     if stat.S_ISDIR(st.st_mode):
 477                         acl = posix1e.ACL(filedef=path)
 478                         self.posix1e_acl.extend([acl, acl])
 479             except EnvironmentError, e:
 480                 if e.errno not in (errno.EOPNOTSUPP, errno.ENOSYS):
 481                     raise
 482
 483     def _same_posix1e_acl(self, other):
 484         """Return true or false to indicate similarity in the hardlink sense."""
 485         return self.posix1e_acl == other.posix1e_acl
 486
 487     def _encode_posix1e_acl(self):
 488         # Encode as two strings (w/default ACL string possibly empty).
 489         if self.posix1e_acl:
 490             acls = self.posix1e_acl
 491             txt_flags = posix1e.TEXT_ABBREVIATE
 492             num_flags = posix1e.TEXT_ABBREVIATE | posix1e.TEXT_NUMERIC_IDS
 493             acl_reps = [acls[0].to_any_text('', '\n', txt_flags),
 494                         acls[1].to_any_text('', '\n', num_flags)]
 495             if len(acls) < 3:
 496                 acl_reps += ['', '']
 497             else:
 498                 acl_reps.append(acls[2].to_any_text('', '\n', txt_flags))
 499                 acl_reps.append(acls[3].to_any_text('', '\n', num_flags))
 500             return vint.pack('ssss',
 501                              acl_reps[0], acl_reps[1], acl_reps[2], acl_reps[3])
 502         else:
 503             return None
 504
 505     def _load_posix1e_acl_rec(self, port):
 506         if not posix1e: return
 507         data = vint.read_bvec(port)
 508         acl_reps = vint.unpack('ssss', data)
 509         if acl_reps[2] == '':
 510             acl_reps = acl_reps[:2]
 511         self.posix1e_acl = [posix1e.ACL(text=x) for x in acl_reps]
 512
 513     def _apply_posix1e_acl_rec(self, path, restore_numeric_ids=False):
 514         def apply_acl(acl, kind):
 515             try:
 516                 acl.applyto(path, kind)
 517             except IOError, e:
 518                 if e.errno == errno.EPERM or e.errno == errno.EOPNOTSUPP:
 519                     raise ApplyError('POSIX1e ACL applyto: %s' % e)
 520                 else:
 521                     raise
 522
 523         if not posix1e:
 524             if self.posix1e_acl:
 525                 add_error("%s: can't restore ACLs; posix1e support missing.\n"
 526                           % path)
 527             return
 528         if self.posix1e_acl:
 529             acls = self.posix1e_acl
 530             if len(acls) > 2:
 531                 if restore_numeric_ids:
 532                     apply_acl(acls[3], posix1e.ACL_TYPE_DEFAULT)
 533                 else:
 534                     apply_acl(acls[2], posix1e.ACL_TYPE_DEFAULT)
 535             if restore_numeric_ids:
 536                 apply_acl(acls[1], posix1e.ACL_TYPE_ACCESS)
 537             else:
 538                 apply_acl(acls[0], posix1e.ACL_TYPE_ACCESS)
 539
 540
 541     ## Linux attributes (lsattr(1), chattr(1))
 542
 543     def _add_linux_attr(self, path, st):
 544         if not get_linux_file_attr: return
 545         if stat.S_ISREG(st.st_mode) or stat.S_ISDIR(st.st_mode):
 546             try:
 547                 attr = get_linux_file_attr(path)
 548                 if attr != 0:
 549                     self.linux_attr = attr
 550             except OSError, e:
 551                 if e.errno == errno.EACCES:
 552                     add_error('read Linux attr: %s' % e)
 553                 elif e.errno in (errno.ENOTTY, errno.ENOSYS, errno.EOPNOTSUPP):
 554                     # Assume filesystem doesn't support attrs.
 555                     return
 556                 else:
 557                     raise
 558
 559     def _same_linux_attr(self, other):
 560         """Return true or false to indicate similarity in the hardlink sense."""
 561         return self.linux_attr == other.linux_attr
 562
 563     def _encode_linux_attr(self):
 564         if self.linux_attr:
 565             return vint.pack('V', self.linux_attr)
 566         else:
 567             return None
 568
 569     def _load_linux_attr_rec(self, port):
 570         data = vint.read_bvec(port)
 571         self.linux_attr = vint.unpack('V', data)[0]
 572
 573     def _apply_linux_attr_rec(self, path, restore_numeric_ids=False):
 574         if self.linux_attr:
 575             if not set_linux_file_attr:
 576                 add_error("%s: can't restore linuxattrs: "
 577                           "linuxattr support missing.\n" % path)
 578                 return
 579             try:
 580                 set_linux_file_attr(path, self.linux_attr)
 581             except OSError, e:
 582                 if e.errno in (errno.ENOTTY, errno.EOPNOTSUPP, errno.ENOSYS):
 583                     raise ApplyError('Linux chattr: %s' % e)
 584                 else:
 585                     raise
 586
 587
 588     ## Linux extended attributes (getfattr(1), setfattr(1))
 589
 590     def _add_linux_xattr(self, path, st):
 591         if not xattr: return
 592         try:
 593             self.linux_xattr = xattr.get_all(path, nofollow=True)
 594         except EnvironmentError, e:
 595             if e.errno != errno.EOPNOTSUPP:
 596                 raise
 597
 598     def _same_linux_xattr(self, other):
 599         """Return true or false to indicate similarity in the hardlink sense."""
 600         return self.linux_xattr == other.linux_xattr
 601
 602     def _encode_linux_xattr(self):
 603         if self.linux_xattr:
 604             result = vint.pack('V', len(self.linux_xattr))
 605             for name, value in self.linux_xattr:
 606                 result += vint.pack('ss', name, value)
 607             return result
 608         else:
 609             return None
 610
 611     def _load_linux_xattr_rec(self, file):
 612         data = vint.read_bvec(file)
 613         memfile = StringIO(data)
 614         result = []
 615         for i in range(vint.read_vuint(memfile)):
 616             key = vint.read_bvec(memfile)
 617             value = vint.read_bvec(memfile)
 618             result.append((key, value))
 619         self.linux_xattr = result
 620
 621     def _apply_linux_xattr_rec(self, path, restore_numeric_ids=False):
 622         if not xattr:
 623             if self.linux_xattr:
 624                 add_error("%s: can't restore xattr; xattr support missing.\n"
 625                           % path)
 626             return
 627         existing_xattrs = set(xattr.list(path, nofollow=True))
 628         if self.linux_xattr:
 629             for k, v in self.linux_xattr:
 630                 if k not in existing_xattrs \
 631                         or v != xattr.get(path, k, nofollow=True):
 632                     try:
 633                         xattr.set(path, k, v, nofollow=True)
 634                     except IOError, e:
 635                         if e.errno == errno.EPERM \
 636                                 or e.errno == errno.EOPNOTSUPP:
 637                             raise ApplyError('xattr.set: %s' % e)
 638                         else:
 639                             raise
 640                 existing_xattrs -= frozenset([k])
 641             for k in existing_xattrs:
 642                 try:
 643                     xattr.remove(path, k, nofollow=True)
 644                 except IOError, e:
 645                     if e.errno == errno.EPERM:
 646                         raise ApplyError('xattr.remove: %s' % e)
 647                     else:
 648                         raise
 649
 650     def __init__(self):
 651         self.mode = None
 652         # optional members
 653         self.path = None
 654         self.size = None
 655         self.symlink_target = None
 656         self.hardlink_target = None
 657         self.linux_attr = None
 658         self.linux_xattr = None
 659         self.posix1e_acl = None
 660         self.posix1e_acl_default = None
 661
 662     def write(self, port, include_path=True):
 663         records = include_path and [(_rec_tag_path, self._encode_path())] or []
 664         records.extend([(_rec_tag_common, self._encode_common()),
 665                         (_rec_tag_symlink_target,
 666                          self._encode_symlink_target()),
 667                         (_rec_tag_hardlink_target,
 668                          self._encode_hardlink_target()),
 669                         (_rec_tag_posix1e_acl, self._encode_posix1e_acl()),
 670                         (_rec_tag_linux_attr, self._encode_linux_attr()),
 671                         (_rec_tag_linux_xattr, self._encode_linux_xattr())])
 672         for tag, data in records:
 673             if data:
 674                 vint.write_vuint(port, tag)
 675                 vint.write_bvec(port, data)
 676         vint.write_vuint(port, _rec_tag_end)
 677
 678     def encode(self, include_path=True):
 679         port = StringIO()
 680         self.write(port, include_path)
 681         return port.getvalue()
 682
 683     @staticmethod
 684     def read(port):
 685         # This method should either return a valid Metadata object,
 686         # return None if there was no information at all (just a
 687         # _rec_tag_end), throw EOFError if there was nothing at all to
 688         # read, or throw an Exception if a valid object could not be
 689         # read completely.
 690         tag = vint.read_vuint(port)
 691         if tag == _rec_tag_end:
 692             return None
 693         try: # From here on, EOF is an error.
 694             result = Metadata()
 695             while True: # only exit is error (exception) or _rec_tag_end
 696                 if tag == _rec_tag_path:
 697                     result._load_path_rec(port)
 698                 elif tag == _rec_tag_common:
 699                     result._load_common_rec(port)
 700                 elif tag == _rec_tag_symlink_target:
 701                     result._load_symlink_target_rec(port)
 702                 elif tag == _rec_tag_hardlink_target:
 703                     result._load_hardlink_target_rec(port)
 704                 elif tag == _rec_tag_posix1e_acl:
 705                     result._load_posix1e_acl_rec(port)
 706                 elif tag == _rec_tag_linux_attr:
 707                     result._load_linux_attr_rec(port)
 708                 elif tag == _rec_tag_linux_xattr:
 709                     result._load_linux_xattr_rec(port)
 710                 elif tag == _rec_tag_end:
 711                     return result
 712                 else: # unknown record
 713                     vint.skip_bvec(port)
 714                 tag = vint.read_vuint(port)
 715         except EOFError:
 716             raise Exception("EOF while reading Metadata")
 717
 718     def isdir(self):
 719         return stat.S_ISDIR(self.mode)
 720
 721     def create_path(self, path, create_symlinks=True):
 722         self._create_via_common_rec(path, create_symlinks=create_symlinks)
 723
 724     def apply_to_path(self, path=None, restore_numeric_ids=False):
 725         # apply metadata to path -- file must exist
 726         if not path:
 727             path = self.path
 728         if not path:
 729             raise Exception('Metadata.apply_to_path() called with no path')
 730         if not self._recognized_file_type():
 731             add_error('not applying metadata to "%s"' % path
 732                       + ' with unrecognized mode "0x%x"\n' % self.mode)
 733             return
 734         num_ids = restore_numeric_ids
 735         try:
 736             self._apply_common_rec(path, restore_numeric_ids=num_ids)
 737             self._apply_posix1e_acl_rec(path, restore_numeric_ids=num_ids)
 738             self._apply_linux_attr_rec(path, restore_numeric_ids=num_ids)
 739             self._apply_linux_xattr_rec(path, restore_numeric_ids=num_ids)
 740         except ApplyError, e:
 741             add_error(e)
 742
 743     def same_file(self, other):
 744         """Compare this to other for equivalency.  Return true if
 745         their information implies they could represent the same file
 746         on disk, in the hardlink sense.  Assume they're both regular
 747         files."""
 748         return self._same_common(other) \
 749             and self._same_hardlink_target(other) \
 750             and self._same_posix1e_acl(other) \
 751             and self._same_linux_attr(other) \
 752             and self._same_linux_xattr(other)
 753
 754
 755 def from_path(path, statinfo=None, archive_path=None,
 756               save_symlinks=True, hardlink_target=None):
 757     result = Metadata()
 758     result.path = archive_path
 759     st = statinfo or xstat.lstat(path)
 760     result.size = st.st_size
 761     result._add_common(path, st)
 762     if save_symlinks:
 763         result._add_symlink_target(path, st)
 764     result._add_hardlink_target(hardlink_target)
 765     result._add_posix1e_acl(path, st)
 766     result._add_linux_attr(path, st)
 767     result._add_linux_xattr(path, st)
 768     return result
 769
 770
 771 def save_tree(output_file, paths,
 772               recurse=False,
 773               write_paths=True,
 774               save_symlinks=True,
 775               xdev=False):
 776
 777     # Issue top-level rewrite warnings.
 778     for path in paths:
 779         safe_path = _clean_up_path_for_archive(path)
 780         if safe_path != path:
 781             log('archiving "%s" as "%s"\n' % (path, safe_path))
 782
 783     start_dir = os.getcwd()
 784     try:
 785         for (p, st) in recursive_dirlist(paths, xdev=xdev):
 786             dirlist_dir = os.getcwd()
 787             os.chdir(start_dir)
 788             safe_path = _clean_up_path_for_archive(p)
 789             m = from_path(p, statinfo=st, archive_path=safe_path,
 790                           save_symlinks=save_symlinks)
 791             if verbose:
 792                 print >> sys.stderr, m.path
 793             m.write(output_file, include_path=write_paths)
 794             os.chdir(dirlist_dir)
 795     finally:
 796         os.chdir(start_dir)
 797
 798
 799 def _set_up_path(meta, create_symlinks=True):
 800     # Allow directories to exist as a special case -- might have
 801     # been created by an earlier longer path.
 802     if meta.isdir():
 803         mkdirp(meta.path)
 804     else:
 805         parent = os.path.dirname(meta.path)
 806         if parent:
 807             mkdirp(parent)
 808         meta.create_path(meta.path, create_symlinks=create_symlinks)
 809
 810
 811 all_fields = frozenset(['path',
 812                         'mode',
 813                         'link-target',
 814                         'rdev',
 815                         'size',
 816                         'uid',
 817                         'gid',
 818                         'user',
 819                         'group',
 820                         'atime',
 821                         'mtime',
 822                         'ctime',
 823                         'linux-attr',
 824                         'linux-xattr',
 825                         'posix1e-acl'])
 826
 827
 828 def summary_str(meta):
 829     mode_val = xstat.mode_str(meta.mode)
 830     user_val = meta.user
 831     if not user_val:
 832         user_val = str(meta.uid)
 833     group_val = meta.group
 834     if not group_val:
 835         group_val = str(meta.gid)
 836     size_or_dev_val = '-'
 837     if stat.S_ISCHR(meta.mode) or stat.S_ISBLK(meta.mode):
 838         size_or_dev_val = '%d,%d' % (os.major(meta.rdev), os.minor(meta.rdev))
 839     elif meta.size:
 840         size_or_dev_val = meta.size
 841     mtime_secs = xstat.fstime_floor_secs(meta.mtime)
 842     time_val = time.strftime('%Y-%m-%d %H:%M', time.localtime(mtime_secs))
 843     path_val = meta.path or ''
 844     if stat.S_ISLNK(meta.mode):
 845         path_val += ' -> ' + meta.symlink_target
 846     return '%-10s %-11s %11s %16s %s' % (mode_val,
 847                                          user_val + "/" + group_val,
 848                                          size_or_dev_val,
 849                                          time_val,
 850                                          path_val)
 851
 852
 853 def detailed_str(meta, fields = None):
 854     # FIXME: should optional fields be omitted, or empty i.e. "rdev:
 855     # 0", "link-target:", etc.
 856     if not fields:
 857         fields = all_fields
 858
 859     result = []
 860     if 'path' in fields:
 861         path = meta.path or ''
 862         result.append('path: ' + path)
 863     if 'mode' in fields:
 864         result.append('mode: %s (%s)' % (oct(meta.mode),
 865                                          xstat.mode_str(meta.mode)))
 866     if 'link-target' in fields and stat.S_ISLNK(meta.mode):
 867         result.append('link-target: ' + meta.symlink_target)
 868     if 'rdev' in fields:
 869         if meta.rdev:
 870             result.append('rdev: %d,%d' % (os.major(meta.rdev),
 871                                            os.minor(meta.rdev)))
 872         else:
 873             result.append('rdev: 0')
 874     if 'size' in fields and meta.size:
 875         result.append('size: ' + str(meta.size))
 876     if 'uid' in fields:
 877         result.append('uid: ' + str(meta.uid))
 878     if 'gid' in fields:
 879         result.append('gid: ' + str(meta.gid))
 880     if 'user' in fields:
 881         result.append('user: ' + meta.user)
 882     if 'group' in fields:
 883         result.append('group: ' + meta.group)
 884     if 'atime' in fields:
 885         # If we don't have xstat.lutime, that means we have to use
 886         # utime(), and utime() has no way to set the mtime/atime of a
 887         # symlink.  Thus, the mtime/atime of a symlink is meaningless,
 888         # so let's not report it.  (That way scripts comparing
 889         # before/after won't trigger.)
 890         if xstat.lutime or not stat.S_ISLNK(meta.mode):
 891             result.append('atime: ' + xstat.fstime_to_sec_str(meta.atime))
 892         else:
 893             result.append('atime: 0')
 894     if 'mtime' in fields:
 895         if xstat.lutime or not stat.S_ISLNK(meta.mode):
 896             result.append('mtime: ' + xstat.fstime_to_sec_str(meta.mtime))
 897         else:
 898             result.append('mtime: 0')
 899     if 'ctime' in fields:
 900         result.append('ctime: ' + xstat.fstime_to_sec_str(meta.ctime))
 901     if 'linux-attr' in fields and meta.linux_attr:
 902         result.append('linux-attr: ' + hex(meta.linux_attr))
 903     if 'linux-xattr' in fields and meta.linux_xattr:
 904         for name, value in meta.linux_xattr:
 905             result.append('linux-xattr: %s -> %s' % (name, repr(value)))
 906     if 'posix1e-acl' in fields and meta.posix1e_acl and posix1e:
 907         flags = posix1e.TEXT_ABBREVIATE
 908         if stat.S_ISDIR(meta.mode):
 909             acl = meta.posix1e_acl[0]
 910             default_acl = meta.posix1e_acl[2]
 911             result.append(acl.to_any_text('posix1e-acl: ', '\n', flags))
 912             result.append(acl.to_any_text('posix1e-acl-default: ', '\n', flags))
 913         else:
 914             acl = meta.posix1e_acl[0]
 915             result.append(acl.to_any_text('posix1e-acl: ', '\n', flags))
 916     return '\n'.join(result)
 917
 918
 919 class _ArchiveIterator:
 920     def next(self):
 921         try:
 922             return Metadata.read(self._file)
 923         except EOFError:
 924             raise StopIteration()
 925
 926     def __iter__(self):
 927         return self
 928
 929     def __init__(self, file):
 930         self._file = file
 931
 932
 933 def display_archive(file):
 934     if verbose > 1:
 935         first_item = True
 936         for meta in _ArchiveIterator(file):
 937             if not first_item:
 938                 print
 939             print detailed_str(meta)
 940             first_item = False
 941     elif verbose > 0:
 942         for meta in _ArchiveIterator(file):
 943             print summary_str(meta)
 944     elif verbose == 0:
 945         for meta in _ArchiveIterator(file):
 946             if not meta.path:
 947                 print >> sys.stderr, \
 948                     'bup: no metadata path, but asked to only display path', \
 949                     '(increase verbosity?)'
 950                 sys.exit(1)
 951             print meta.path
 952
 953
 954 def start_extract(file, create_symlinks=True):
 955     for meta in _ArchiveIterator(file):
 956         if not meta: # Hit end record.
 957             break
 958         if verbose:
 959             print >> sys.stderr, meta.path
 960         xpath = _clean_up_extract_path(meta.path)
 961         if not xpath:
 962             add_error(Exception('skipping risky path "%s"' % meta.path))
 963         else:
 964             meta.path = xpath
 965             _set_up_path(meta, create_symlinks=create_symlinks)
 966
 967
 968 def finish_extract(file, restore_numeric_ids=False):
 969     all_dirs = []
 970     for meta in _ArchiveIterator(file):
 971         if not meta: # Hit end record.
 972             break
 973         xpath = _clean_up_extract_path(meta.path)
 974         if not xpath:
 975             add_error(Exception('skipping risky path "%s"' % dir.path))
 976         else:
 977             if os.path.isdir(meta.path):
 978                 all_dirs.append(meta)
 979             else:
 980                 if verbose:
 981                     print >> sys.stderr, meta.path
 982                 meta.apply_to_path(path=xpath,
 983                                    restore_numeric_ids=restore_numeric_ids)
 984     all_dirs.sort(key = lambda x : len(x.path), reverse=True)
 985     for dir in all_dirs:
 986         # Don't need to check xpath -- won't be in all_dirs if not OK.
 987         xpath = _clean_up_extract_path(dir.path)
 988         if verbose:
 989             print >> sys.stderr, dir.path
 990         dir.apply_to_path(path=xpath, restore_numeric_ids=restore_numeric_ids)
 991
 992
 993 def extract(file, restore_numeric_ids=False, create_symlinks=True):
 994     # For now, just store all the directories and handle them last,
 995     # longest first.
 996     all_dirs = []
 997     for meta in _ArchiveIterator(file):
 998         if not meta: # Hit end record.
 999             break
1000         xpath = _clean_up_extract_path(meta.path)
1001         if not xpath:
1002             add_error(Exception('skipping risky path "%s"' % meta.path))
1003         else:
1004             meta.path = xpath
1005             if verbose:
1006                 print >> sys.stderr, '+', meta.path
1007             _set_up_path(meta, create_symlinks=create_symlinks)
1008             if os.path.isdir(meta.path):
1009                 all_dirs.append(meta)
1010             else:
1011                 if verbose:
1012                     print >> sys.stderr, '=', meta.path
1013                 meta.apply_to_path(restore_numeric_ids=restore_numeric_ids)
1014     all_dirs.sort(key = lambda x : len(x.path), reverse=True)
1015     for dir in all_dirs:
1016         # Don't need to check xpath -- won't be in all_dirs if not OK.
1017         xpath = _clean_up_extract_path(dir.path)
1018         if verbose:
1019             print >> sys.stderr, '=', xpath
1020         # Shouldn't have to check for risky paths here (omitted above).
1021         dir.apply_to_path(path=dir.path,
1022                           restore_numeric_ids=restore_numeric_ids)