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
   8 import errno, os, sys, stat, pwd, grp, struct, xattr, posix1e, re
   9
  10 from cStringIO import StringIO
  11 from bup import vint
  12 from bup.drecurse import recursive_dirlist
  13 from bup.helpers import add_error, mkdirp, log
  14 from bup.xstat import utime, lutime, lstat, FSTime
  15 import bup._helpers as _helpers
  16
  17 if _helpers.get_linux_file_attr:
  18     from bup._helpers import get_linux_file_attr, set_linux_file_attr
  19
  20 # WARNING: the metadata encoding is *not* stable yet.  Caveat emptor!
  21
  22 # Q: Consider hardlink support?
  23 # Q: Is it OK to store raw linux attr (chattr) flags?
  24 # Q: Can anything other than S_ISREG(x) or S_ISDIR(x) support posix1e ACLs?
  25 # Q: Is the application of posix1e has_extended() correct?
  26 # Q: Is one global --numeric-ids argument sufficient?
  27 # Q: Do nfsv4 acls trump posix1e acls? (seems likely)
  28 # Q: Add support for crtime -- ntfs, and (only internally?) ext*?
  29
  30 # FIXME: Fix relative/abs path detection/stripping wrt other platforms.
  31 # FIXME: Add nfsv4 acl handling - see nfs4-acl-tools.
  32 # FIXME: Consider other entries mentioned in stat(2) (S_IFDOOR, etc.).
  33 # FIXME: Consider pack('vvvvsss', ...) optimization.
  34 # FIXME: Consider caching users/groups.
  35
  36 ## FS notes:
  37 #
  38 # osx (varies between hfs and hfs+):
  39 #   type - regular dir char block fifo socket ...
  40 #   perms - rwxrwxrwxsgt
  41 #   times - ctime atime mtime
  42 #   uid
  43 #   gid
  44 #   hard-link-info (hfs+ only)
  45 #   link-target
  46 #   device-major/minor
  47 #   attributes-osx see chflags
  48 #   content-type
  49 #   content-creator
  50 #   forks
  51 #
  52 # ntfs
  53 #   type - regular dir ...
  54 #   times - creation, modification, posix change, access
  55 #   hard-link-info
  56 #   link-target
  57 #   attributes - see attrib
  58 #   ACLs
  59 #   forks (alternate data streams)
  60 #   crtime?
  61 #
  62 # fat
  63 #   type - regular dir ...
  64 #   perms - rwxrwxrwx (maybe - see wikipedia)
  65 #   times - creation, modification, access
  66 #   attributes - see attrib
  67
  68 verbose = 0
  69
  70 _have_lchmod = hasattr(os, 'lchmod')
  71
  72
  73 def _clean_up_path_for_archive(p):
  74     # Not the most efficient approach.
  75     result = p
  76
  77     # Take everything after any '/../'.
  78     pos = result.rfind('/../')
  79     if(pos != -1):
  80         result = result[result.rfind('/../') + 4:]
  81
  82     # Take everything after any remaining '../'.
  83     if result.startswith("../"):
  84         result = result[3:]
  85
  86     # Remove any '/./' sequences.
  87     pos = result.find('/./')
  88     while pos != -1:
  89         result = result[0:pos] + '/' + result[pos + 3:]
  90         pos = result.find('/./')
  91
  92     # Remove any leading '/'s.
  93     result = result.lstrip('/')
  94
  95     # Replace '//' with '/' everywhere.
  96     pos = result.find('//')
  97     while pos != -1:
  98         result = result[0:pos] + '/' + result[pos + 2:]
  99         pos = result.find('//')
 100
 101     # Take everything after any remaining './'.
 102     if result.startswith('./'):
 103         result = result[2:]
 104
 105     # Take everything before any remaining '/.'.
 106     if result.endswith('/.'):
 107         result = result[:-2]
 108
 109     if result == '' or result.endswith('/..'):
 110         result = '.'
 111
 112     return result
 113
 114
 115 def _risky_path(p):
 116     if p.startswith('/'):
 117         return True
 118     if p.find('/../') != -1:
 119         return True
 120     if p.startswith('../'):
 121         return True
 122     if p.endswith('/..'):
 123         return True
 124     return False
 125
 126
 127 def _clean_up_extract_path(p):
 128     result = p.lstrip('/')
 129     if result == '':
 130         return '.'
 131     elif _risky_path(result):
 132         return None
 133     else:
 134         return result
 135
 136
 137 # These tags are currently conceptually private to Metadata, and they
 138 # must be unique, and must *never* be changed.
 139 _rec_tag_end = 0
 140 _rec_tag_path = 1
 141 _rec_tag_common = 2           # times, owner, group, type, perms, etc.
 142 _rec_tag_symlink_target = 3
 143 _rec_tag_posix1e_acl = 4      # getfacl(1), setfacl(1), etc.
 144 _rec_tag_nfsv4_acl = 5        # intended to supplant posix1e acls?
 145 _rec_tag_linux_attr = 6       # lsattr(1) chattr(1)
 146 _rec_tag_linux_xattr = 7      # getfattr(1) setfattr(1)
 147
 148
 149 class ApplyError(Exception):
 150     # Thrown when unable to apply any given bit of metadata to a path.
 151     pass
 152
 153
 154 class Metadata:
 155     # Metadata is stored as a sequence of tagged binary records.  Each
 156     # record will have some subset of add, encode, load, create, and
 157     # apply methods, i.e. _add_foo...
 158
 159     ## Common records
 160
 161     # Timestamps are (sec, ns), relative to 1970-01-01 00:00:00, ns
 162     # must be non-negative and < 10**9.
 163
 164     def _add_common(self, path, st):
 165         self.mode = st.st_mode
 166         self.uid = st.st_uid
 167         self.gid = st.st_gid
 168         self.rdev = st.st_rdev
 169         self.atime = st.st_atime
 170         self.mtime = st.st_mtime
 171         self.ctime = st.st_ctime
 172         self.owner = self.group = ''
 173         try:
 174             self.owner = pwd.getpwuid(st.st_uid)[0]
 175         except KeyError, e:
 176             add_error(e)
 177         try:
 178             self.group = grp.getgrgid(st.st_gid)[0]
 179         except KeyError, e:
 180             add_error(e)
 181
 182     def _encode_common(self):
 183         atime = self.atime.to_timespec()
 184         mtime = self.mtime.to_timespec()
 185         ctime = self.ctime.to_timespec()
 186         result = vint.pack('VVsVsVvVvVvV',
 187                            self.mode,
 188                            self.uid,
 189                            self.owner,
 190                            self.gid,
 191                            self.group,
 192                            self.rdev,
 193                            atime[0],
 194                            atime[1],
 195                            mtime[0],
 196                            mtime[1],
 197                            ctime[0],
 198                            ctime[1])
 199         return result
 200
 201     def _load_common_rec(self, port):
 202         data = vint.read_bvec(port)
 203         (self.mode,
 204          self.uid,
 205          self.owner,
 206          self.gid,
 207          self.group,
 208          self.rdev,
 209          self.atime,
 210          atime_ns,
 211          self.mtime,
 212          mtime_ns,
 213          self.ctime,
 214          ctime_ns) = vint.unpack('VVsVsVvVvVvV', data)
 215         self.atime = FSTime.from_timespec((self.atime, atime_ns))
 216         self.mtime = FSTime.from_timespec((self.mtime, mtime_ns))
 217         self.ctime = FSTime.from_timespec((self.ctime, ctime_ns))
 218
 219     def _create_via_common_rec(self, path, create_symlinks=True):
 220         # If the path already exists and is a dir, try rmdir.
 221         # If the path already exists and is anything else, try unlink.
 222         st = None
 223         try:
 224             st = lstat(path)
 225         except IOError, e:
 226             if e.errno != errno.ENOENT:
 227                 raise
 228         if st:
 229             if stat.S_ISDIR(st.st_mode):
 230                 try:
 231                     os.rmdir(path)
 232                 except OSError, e:
 233                     if e.errno == errno.ENOTEMPTY:
 234                         msg = 'refusing to overwrite non-empty dir' + path
 235                         raise Exception(msg)
 236                     raise
 237             else:
 238                 os.unlink(path)
 239
 240         if stat.S_ISREG(self.mode):
 241             os.mknod(path, 0600 | stat.S_IFREG)
 242         elif stat.S_ISDIR(self.mode):
 243             os.mkdir(path, 0700)
 244         elif stat.S_ISCHR(self.mode):
 245             os.mknod(path, 0600 | stat.S_IFCHR, self.rdev)
 246         elif stat.S_ISBLK(self.mode):
 247             os.mknod(path, 0600 | stat.S_IFBLK, self.rdev)
 248         elif stat.S_ISFIFO(self.mode):
 249             os.mknod(path, 0600 | stat.S_IFIFO)
 250         elif stat.S_ISLNK(self.mode):
 251             if(self.symlink_target and create_symlinks):
 252                 os.symlink(self.symlink_target, path)
 253         # FIXME: S_ISDOOR, S_IFMPB, S_IFCMP, S_IFNWK, ... see stat(2).
 254         # Otherwise, do nothing.
 255
 256     def _apply_common_rec(self, path, restore_numeric_ids=False):
 257         # FIXME: S_ISDOOR, S_IFMPB, S_IFCMP, S_IFNWK, ... see stat(2).
 258         # EACCES errors at this stage are fatal for the current path.
 259         if stat.S_ISLNK(self.mode):
 260             try:
 261                 lutime(path, (self.atime, self.mtime))
 262             except IOError, e:
 263                 if e.errno == errno.EACCES:
 264                     raise ApplyError('lutime: %s' % e)
 265                 else:
 266                     raise
 267         else:
 268             try:
 269                 utime(path, (self.atime, self.mtime))
 270             except IOError, e:
 271                 if e.errno == errno.EACCES:
 272                     raise ApplyError('utime: %s' % e)
 273                 else:
 274                     raise
 275
 276         if stat.S_ISREG(self.mode) \
 277                 | stat.S_ISDIR(self.mode) \
 278                 | stat.S_ISCHR(self.mode) \
 279                 | stat.S_ISBLK(self.mode) \
 280                 | stat.S_ISLNK(self.mode) \
 281                 | stat.S_ISFIFO(self.mode):
 282             # Be safe.
 283             if _have_lchmod:
 284                 os.lchmod(path, 0)
 285             elif not stat.S_ISLNK(self.mode):
 286                 os.chmod(path, 0)
 287
 288             # Don't try to restore owner unless we're root, and even
 289             # if asked, don't try to restore the owner or group if
 290             # it doesn't exist in the system db.
 291             uid = self.uid
 292             gid = self.gid
 293             if not restore_numeric_ids:
 294                 if not self.owner:
 295                     uid = -1
 296                     add_error('bup: ignoring missing owner for "%s"\n' % path)
 297                 else:
 298                     if os.geteuid() != 0:
 299                         uid = -1 # Not root; assume we can't change owner.
 300                     else:
 301                         try:
 302                             uid = pwd.getpwnam(self.owner)[2]
 303                         except KeyError:
 304                             uid = -1
 305                             fmt = 'bup: ignoring unknown owner %s for "%s"\n'
 306                             add_error(fmt % (self.owner, path))
 307                 if not self.group:
 308                     gid = -1
 309                     add_error('bup: ignoring missing group for "%s"\n' % path)
 310                 else:
 311                     try:
 312                         gid = grp.getgrnam(self.group)[2]
 313                     except KeyError:
 314                         gid = -1
 315                         add_error('bup: ignoring unknown group %s for "%s"\n'
 316                                   % (self.group, path))
 317
 318             try:
 319                 os.lchown(path, uid, gid)
 320             except OSError, e:
 321                 if e.errno == errno.EPERM:
 322                     add_error('lchown: %s' %  e)
 323                 else:
 324                     raise
 325
 326             if _have_lchmod:
 327                 os.lchmod(path, stat.S_IMODE(self.mode))
 328             elif not stat.S_ISLNK(self.mode):
 329                 os.chmod(path, stat.S_IMODE(self.mode))
 330
 331
 332     ## Path records
 333
 334     def _encode_path(self):
 335         if self.path:
 336             return vint.pack('s', self.path)
 337         else:
 338             return None
 339
 340     def _load_path_rec(self, port):
 341         self.path = vint.unpack('s', vint.read_bvec(port))[0]
 342
 343
 344     ## Symlink targets
 345
 346     def _add_symlink_target(self, path, st):
 347         try:
 348             if(stat.S_ISLNK(st.st_mode)):
 349                 self.symlink_target = os.readlink(path)
 350         except OSError, e:
 351             add_error(e)
 352
 353     def _encode_symlink_target(self):
 354         return self.symlink_target
 355
 356     def _load_symlink_target_rec(self, port):
 357         self.symlink_target = vint.read_bvec(port)
 358
 359
 360     ## POSIX1e ACL records
 361
 362     # Recorded as a list:
 363     #   [txt_id_acl, num_id_acl]
 364     # or, if a directory:
 365     #   [txt_id_acl, num_id_acl, txt_id_default_acl, num_id_default_acl]
 366     # The numeric/text distinction only matters when reading/restoring
 367     # a stored record.
 368     def _add_posix1e_acl(self, path, st):
 369         if not stat.S_ISLNK(st.st_mode):
 370             try:
 371                 if posix1e.has_extended(path):
 372                     acl = posix1e.ACL(file=path)
 373                     self.posix1e_acl = [acl, acl] # txt and num are the same
 374                     if stat.S_ISDIR(st.st_mode):
 375                         acl = posix1e.ACL(filedef=path)
 376                         self.posix1e_acl.extend([acl, acl])
 377             except EnvironmentError, e:
 378                 if e.errno != errno.EOPNOTSUPP:
 379                     raise
 380
 381     def _encode_posix1e_acl(self):
 382         # Encode as two strings (w/default ACL string possibly empty).
 383         if self.posix1e_acl:
 384             acls = self.posix1e_acl
 385             txt_flags = posix1e.TEXT_ABBREVIATE
 386             num_flags = posix1e.TEXT_ABBREVIATE | posix1e.TEXT_NUMERIC_IDS
 387             acl_reps = [acls[0].to_any_text('', '\n', txt_flags),
 388                         acls[1].to_any_text('', '\n', num_flags)]
 389             if(len(acls) < 3):
 390                 acl_reps += ['', '']
 391             else:
 392                 acl_reps.append(acls[2].to_any_text('', '\n', txt_flags))
 393                 acl_reps.append(acls[3].to_any_text('', '\n', num_flags))
 394             return vint.pack('ssss',
 395                              acl_reps[0], acl_reps[1], acl_reps[2], acl_reps[3])
 396         else:
 397             return None
 398
 399     def _load_posix1e_acl_rec(self, port):
 400         data = vint.read_bvec(port)
 401         acl_reps = vint.unpack('ssss', data)
 402         if(acl_reps[2] == ''):
 403             acl_reps = acl_reps[:2]
 404         self.posix1e_acl = [posix1e.ACL(x) for x in acl_reps]
 405
 406     def _apply_posix1e_acl_rec(self, path, restore_numeric_ids=False):
 407         if(self.posix1e_acl):
 408             acls = self.posix1e_acl
 409             if(len(acls) > 2):
 410                 if restore_numeric_ids:
 411                     acls[3].applyto(path, posix1e.ACL_TYPE_DEFAULT)
 412                 else:
 413                     acls[2].applyto(path, posix1e.ACL_TYPE_DEFAULT)
 414             if restore_numeric_ids:
 415                 acls[1].applyto(path, posix1e.ACL_TYPE_ACCESS)
 416             else:
 417                 acls[0].applyto(path, posix1e.ACL_TYPE_ACCESS)
 418
 419
 420     ## Linux attributes (lsattr(1), chattr(1))
 421
 422     def _add_linux_attr(self, path, st):
 423         if stat.S_ISREG(st.st_mode) or stat.S_ISDIR(st.st_mode):
 424             try:
 425                 attr = get_linux_file_attr(path)
 426                 if(attr != 0):
 427                     self.linux_attr = get_linux_file_attr(path)
 428             except EnvironmentError, e:
 429                 if e.errno == errno.EACCES:
 430                     add_error('bup: unable to read Linux attr for "%s"' % path)
 431                 else:
 432                     raise
 433
 434     def _encode_linux_attr(self):
 435         if self.linux_attr:
 436             return vint.pack('V', self.linux_attr)
 437         else:
 438             return None
 439
 440     def _load_linux_attr_rec(self, port):
 441         data = vint.read_bvec(port)
 442         self.linux_attr = vint.unpack('V', data)[0]
 443
 444     def _apply_linux_attr_rec(self, path, restore_numeric_ids=False):
 445         if(self.linux_attr):
 446             set_linux_file_attr(path, self.linux_attr)
 447
 448
 449     ## Linux extended attributes (getfattr(1), setfattr(1))
 450
 451     def _add_linux_xattr(self, path, st):
 452         try:
 453             self.linux_xattr = xattr.get_all(path, nofollow=True)
 454         except EnvironmentError, e:
 455             if e.errno != errno.EOPNOTSUPP:
 456                 raise
 457
 458     def _encode_linux_xattr(self):
 459         if self.linux_xattr:
 460             result = vint.pack('V', len(self.linux_xattr))
 461             for name, value in self.linux_xattr:
 462                 result += vint.pack('ss', name, value)
 463             return result
 464         else:
 465             return None
 466
 467     def _load_linux_xattr_rec(self, file):
 468         data = vint.read_bvec(file)
 469         memfile = StringIO(data)
 470         result = []
 471         for i in range(vint.read_vuint(memfile)):
 472             key = vint.read_bvec(memfile)
 473             value = vint.read_bvec(memfile)
 474             result.append((key, value))
 475         self.linux_xattr = result
 476
 477     def _apply_linux_xattr_rec(self, path, restore_numeric_ids=False):
 478         if(self.linux_xattr):
 479             for k, v in self.linux_xattr:
 480                 xattr.set(path, k, v, nofollow=True)
 481
 482     def __init__(self):
 483         # optional members
 484         self.path = None
 485         self.symlink_target = None
 486         self.linux_attr = None
 487         self.linux_xattr = None
 488         self.posix1e_acl = None
 489         self.posix1e_acl_default = None
 490
 491     def write(self, port, include_path=True):
 492         records = [(_rec_tag_path, self._encode_path())] if include_path else []
 493         records.extend([(_rec_tag_common, self._encode_common()),
 494                         (_rec_tag_symlink_target, self._encode_symlink_target()),
 495                         (_rec_tag_posix1e_acl, self._encode_posix1e_acl()),
 496                         (_rec_tag_linux_attr, self._encode_linux_attr()),
 497                         (_rec_tag_linux_xattr, self._encode_linux_xattr())])
 498         for tag, data in records:
 499             if data:
 500                 vint.write_vuint(port, tag)
 501                 vint.write_bvec(port, data)
 502         vint.write_vuint(port, _rec_tag_end)
 503
 504     @staticmethod
 505     def read(port):
 506         # This method should either: return a valid Metadata object;
 507         # throw EOFError if there was nothing at all to read; throw an
 508         # Exception if a valid object could not be read completely.
 509         tag = vint.read_vuint(port)
 510         try: # From here on, EOF is an error.
 511             result = Metadata()
 512             while(True): # only exit is error (exception) or _rec_tag_end
 513                 if tag == _rec_tag_path:
 514                     result._load_path_rec(port)
 515                 elif tag == _rec_tag_common:
 516                     result._load_common_rec(port)
 517                 elif tag == _rec_tag_symlink_target:
 518                     result._load_symlink_target_rec(port)
 519                 elif tag == _rec_tag_posix1e_acl:
 520                     result._load_posix1e_acl(port)
 521                 elif tag ==_rec_tag_nfsv4_acl:
 522                     result._load_nfsv4_acl_rec(port)
 523                 elif tag == _rec_tag_linux_attr:
 524                     result._load_linux_attr_rec(port)
 525                 elif tag == _rec_tag_linux_xattr:
 526                     result._load_linux_xattr_rec(port)
 527                 elif tag == _rec_tag_end:
 528                     return result
 529                 else: # unknown record
 530                     vint.skip_bvec(port)
 531                 tag = vint.read_vuint(port)
 532         except EOFError:
 533             raise Exception("EOF while reading Metadata")
 534
 535     def isdir(self):
 536         return stat.S_ISDIR(self.mode)
 537
 538     def create_path(self, path, create_symlinks=True):
 539         self._create_via_common_rec(path, create_symlinks=create_symlinks)
 540
 541     def apply_to_path(self, path=None, restore_numeric_ids=False):
 542         # apply metadata to path -- file must exist
 543         if not path:
 544             path = self.path
 545         if not path:
 546             raise Exception('Metadata.apply_to_path() called with no path');
 547         num_ids = restore_numeric_ids
 548         try:
 549             self._apply_common_rec(path, restore_numeric_ids=num_ids)
 550             self._apply_posix1e_acl_rec(path, restore_numeric_ids=num_ids)
 551             self._apply_linux_attr_rec(path, restore_numeric_ids=num_ids)
 552             self._apply_linux_xattr_rec(path, restore_numeric_ids=num_ids)
 553         except ApplyError, e:
 554             add_error(e)
 555
 556
 557 def from_path(path, archive_path=None, save_symlinks=True):
 558     result = Metadata()
 559     result.path = archive_path
 560     st = lstat(path)
 561     result._add_common(path, st)
 562     if(save_symlinks):
 563         result._add_symlink_target(path, st)
 564     result._add_posix1e_acl(path, st)
 565     result._add_linux_attr(path, st)
 566     result._add_linux_xattr(path, st)
 567     return result
 568
 569
 570 def save_tree(output_file, paths,
 571               recurse=False,
 572               write_paths=True,
 573               save_symlinks=True,
 574               xdev=False):
 575
 576     # Issue top-level rewrite warnings.
 577     for path in paths:
 578         safe_path = _clean_up_path_for_archive(path)
 579         if(safe_path != path):
 580             log('bup: archiving "%s" as "%s"\n' % (path, safe_path))
 581
 582     start_dir = os.getcwd()
 583     try:
 584         for (p, st) in recursive_dirlist(paths, xdev=xdev):
 585             dirlist_dir = os.getcwd()
 586             os.chdir(start_dir)
 587             safe_path = _clean_up_path_for_archive(p)
 588             m = from_path(p, archive_path=safe_path,
 589                           save_symlinks=save_symlinks)
 590             if verbose:
 591                 print >> sys.stderr, m.path
 592             m.write(output_file, include_path=write_paths)
 593             os.chdir(dirlist_dir)
 594     finally:
 595         os.chdir(start_dir)
 596
 597
 598 def _set_up_path(meta, create_symlinks=True):
 599     # Allow directories to exist as a special case -- might have
 600     # been created by an earlier longer path.
 601     if meta.isdir():
 602         mkdirp(meta.path, 0700)
 603     else:
 604         parent = os.path.dirname(meta.path)
 605         if parent:
 606             mkdirp(parent, 0700)
 607             meta.create_path(meta.path, create_symlinks=create_symlinks)
 608
 609
 610 class _ArchiveIterator:
 611     def next(self):
 612         try:
 613             return Metadata.read(self._file)
 614         except EOFError:
 615             raise StopIteration()
 616
 617     def __iter__(self):
 618         return self
 619
 620     def __init__(self, file):
 621         self._file = file
 622
 623
 624 def display_archive(file):
 625     for meta in _ArchiveIterator(file):
 626         if verbose:
 627             print meta.path # FIXME
 628         else:
 629             print meta.path
 630
 631
 632 def start_extract(file, create_symlinks=True):
 633     for meta in _ArchiveIterator(file):
 634         if verbose:
 635             print >> sys.stderr, meta.path
 636         xpath = _clean_up_extract_path(meta.path)
 637         if not xpath:
 638             add_error(Exception('skipping risky path "%s"' % meta.path))
 639         else:
 640             meta.path = xpath
 641             _set_up_path(meta, create_symlinks=create_symlinks)
 642
 643
 644 def finish_extract(file, restore_numeric_ids=False):
 645     all_dirs = []
 646     for meta in _ArchiveIterator(file):
 647         xpath = _clean_up_extract_path(meta.path)
 648         if not xpath:
 649             add_error(Exception('skipping risky path "%s"' % dir.path))
 650         else:
 651             if os.path.isdir(meta.path):
 652                 all_dirs.append(meta)
 653             else:
 654                 if verbose:
 655                     print >> sys.stderr, meta.path
 656                 meta.apply_to_path(path=xpath,
 657                                    restore_numeric_ids=restore_numeric_ids)
 658     all_dirs.sort(key = lambda x : len(x.path), reverse=True)
 659     for dir in all_dirs:
 660         # Don't need to check xpath -- won't be in all_dirs if not OK.
 661         xpath = _clean_up_extract_path(dir.path)
 662         if verbose:
 663             print >> sys.stderr, dir.path
 664         dir.apply_to_path(path=xpath, restore_numeric_ids=restore_numeric_ids)
 665
 666
 667 def extract(file, restore_numeric_ids=False, create_symlinks=True):
 668     # For now, just store all the directories and handle them last,
 669     # longest first.
 670     all_dirs = []
 671     for meta in _ArchiveIterator(file):
 672         xpath = _clean_up_extract_path(meta.path)
 673         if not xpath:
 674             add_error(Exception('skipping risky path "%s"' % meta.path))
 675         else:
 676             meta.path = xpath
 677             if verbose:
 678                 print >> sys.stderr, '+', meta.path
 679             _set_up_path(meta, create_symlinks=create_symlinks)
 680             if os.path.isdir(meta.path):
 681                 all_dirs.append(meta)
 682             else:
 683                 if verbose:
 684                     print >> sys.stderr, '=', meta.path
 685                 meta.apply_to_path(restore_numeric_ids=restore_numeric_ids)
 686     all_dirs.sort(key = lambda x : len(x.path), reverse=True)
 687     for dir in all_dirs:
 688         # Don't need to check xpath -- won't be in all_dirs if not OK.
 689         xpath = _clean_up_extract_path(meta.path)
 690         if verbose:
 691             print >> sys.stderr, '=', meta.path
 692         # Shouldn't have to check for risky paths here (omitted above).
 693         dir.apply_to_path(path=dir.path,
 694                           restore_numeric_ids=restore_numeric_ids)