]> arthur.barton.de Git - bup.git/blobdiff - lib/bup/metadata.py
metadata.py: be careful with the umask() when restoring symlinks.
[bup.git] / lib / bup / metadata.py
index bb16892b6fa499fb46f41c906b79ee13e44adb88..6dae38b83bc08404b5952ce87e2d5c85c150ecb8 100644 (file)
@@ -4,9 +4,7 @@
 #
 # 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, pwd, grp, struct, xattr, posix1e, re
-
+import errno, os, sys, stat, pwd, grp, struct, re
 from cStringIO import StringIO
 from bup import vint
 from bup.drecurse import recursive_dirlist
@@ -14,8 +12,31 @@ from bup.helpers import add_error, mkdirp, log
 from bup.xstat import utime, lutime, lstat, FSTime
 import bup._helpers as _helpers
 
-if _helpers.get_linux_file_attr:
+try:
+    import xattr
+except ImportError:
+    log('Warning: Linux xattr support missing; install python-pyxattr.\n')
+    xattr = None
+if xattr:
+    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
+try:
     from bup._helpers import get_linux_file_attr, set_linux_file_attr
+except ImportError:
+    # No need for a warning here; the only reason they won't exist is that we're
+    # 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
+    
 
 # WARNING: the metadata encoding is *not* stable yet.  Caveat emptor!
 
@@ -76,7 +97,7 @@ def _clean_up_path_for_archive(p):
 
     # Take everything after any '/../'.
     pos = result.rfind('/../')
-    if(pos != -1):
+    if pos != -1:
         result = result[result.rfind('/../') + 4:]
 
     # Take everything after any remaining '../'.
@@ -222,7 +243,7 @@ class Metadata:
         st = None
         try:
             st = lstat(path)
-        except IOError, e:
+        except OSError, e:
             if e.errno != errno.ENOENT:
                 raise
         if st:
@@ -238,7 +259,8 @@ class Metadata:
                 os.unlink(path)
 
         if stat.S_ISREG(self.mode):
-            os.mknod(path, 0600 | stat.S_IFREG)
+            fd = os.open(path, os.O_CREAT|os.O_WRONLY|os.O_EXCL, 0600)
+            os.close(fd)
         elif stat.S_ISDIR(self.mode):
             os.mkdir(path, 0700)
         elif stat.S_ISCHR(self.mode):
@@ -248,8 +270,15 @@ class Metadata:
         elif stat.S_ISFIFO(self.mode):
             os.mknod(path, 0600 | stat.S_IFIFO)
         elif stat.S_ISLNK(self.mode):
-            if(self.symlink_target and create_symlinks):
-                os.symlink(self.symlink_target, path)
+            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)
+                try:
+                    os.symlink(self.symlink_target, path)
+                finally:
+                    os.umask(oldumask)
         # FIXME: S_ISDOOR, S_IFMPB, S_IFCMP, S_IFNWK, ... see stat(2).
         # Otherwise, do nothing.
 
@@ -259,7 +288,7 @@ class Metadata:
         if stat.S_ISLNK(self.mode):
             try:
                 lutime(path, (self.atime, self.mtime))
-            except IOError, e:
+            except OSError, e:
                 if e.errno == errno.EACCES:
                     raise ApplyError('lutime: %s' % e)
                 else:
@@ -267,7 +296,7 @@ class Metadata:
         else:
             try:
                 utime(path, (self.atime, self.mtime))
-            except IOError, e:
+            except OSError, e:
                 if e.errno == errno.EACCES:
                     raise ApplyError('utime: %s' % e)
                 else:
@@ -333,7 +362,7 @@ class Metadata:
 
     def _add_symlink_target(self, path, st):
         try:
-            if(stat.S_ISLNK(st.st_mode)):
+            if stat.S_ISLNK(st.st_mode):
                 self.symlink_target = os.readlink(path)
         except OSError, e:
             add_error('readlink: %s', e)
@@ -354,6 +383,7 @@ 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 stat.S_ISLNK(st.st_mode):
             try:
                 if posix1e.has_extended(path):
@@ -374,7 +404,7 @@ class Metadata:
             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):
+            if len(acls) < 3:
                 acl_reps += ['', '']
             else:
                 acl_reps.append(acls[2].to_any_text('', '\n', txt_flags))
@@ -387,14 +417,19 @@ class Metadata:
     def _load_posix1e_acl_rec(self, port):
         data = vint.read_bvec(port)
         acl_reps = vint.unpack('ssss', data)
-        if(acl_reps[2] == ''):
+        if acl_reps[2] == '':
             acl_reps = acl_reps[:2]
         self.posix1e_acl = [posix1e.ACL(text=x) for x in acl_reps]
 
     def _apply_posix1e_acl_rec(self, path, restore_numeric_ids=False):
-        if(self.posix1e_acl):
+        if not posix1e:
+            if self.posix1e_acl:
+                add_error("%s: can't restore ACLs; posix1e support missing.\n"
+                          % path)
+            return
+        if self.posix1e_acl:
             acls = self.posix1e_acl
-            if(len(acls) > 2):
+            if len(acls) > 2:
                 if restore_numeric_ids:
                     acls[3].applyto(path, posix1e.ACL_TYPE_DEFAULT)
                 else:
@@ -408,12 +443,13 @@ class Metadata:
     ## Linux attributes (lsattr(1), chattr(1))
 
     def _add_linux_attr(self, path, st):
+        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):
+                if attr != 0:
                     self.linux_attr = attr
-            except IOError, e:
+            except OSError, e:
                 if e.errno == errno.EACCES:
                     add_error('read Linux attr: %s' % e)
                 elif e.errno == errno.ENOTTY: # Inappropriate ioctl for device.
@@ -432,13 +468,18 @@ class Metadata:
         self.linux_attr = vint.unpack('V', data)[0]
 
     def _apply_linux_attr_rec(self, path, restore_numeric_ids=False):
-        if(self.linux_attr):
+        if self.linux_attr:
+            if not set_linux_file_attr:
+                add_error("%s: can't restore linuxattrs: "
+                          "linuxattr support missing.\n" % path)
+                return
             set_linux_file_attr(path, self.linux_attr)
 
 
     ## Linux extended attributes (getfattr(1), setfattr(1))
 
     def _add_linux_xattr(self, path, st):
+        if not xattr: return
         try:
             self.linux_xattr = xattr.get_all(path, nofollow=True)
         except EnvironmentError, e:
@@ -465,9 +506,32 @@ class Metadata:
         self.linux_xattr = result
 
     def _apply_linux_xattr_rec(self, path, restore_numeric_ids=False):
-        if(self.linux_xattr):
+        if not xattr:
+            if self.linux_xattr:
+                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:
-                xattr.set(path, k, v, nofollow=True)
+                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:
+                            raise ApplyError('xattr.set: %s' % e)
+                        else:
+                            raise
+                existing_xattrs -= frozenset([k])
+            for k in existing_xattrs:
+                try:
+                    xattr.remove(path, k, nofollow=True)
+                except IOError, e:
+                    if e.errno == errno.EPERM:
+                        raise ApplyError('xattr.remove: %s' % e)
+                    else:
+                        raise
 
     def __init__(self):
         # optional members
@@ -479,7 +543,7 @@ class Metadata:
         self.posix1e_acl_default = None
 
     def write(self, port, include_path=True):
-        records = [(_rec_tag_path, self._encode_path())] if include_path else []
+        records = include_path and [(_rec_tag_path, self._encode_path())] or []
         records.extend([(_rec_tag_common, self._encode_common()),
                         (_rec_tag_symlink_target, self._encode_symlink_target()),
                         (_rec_tag_posix1e_acl, self._encode_posix1e_acl()),
@@ -499,7 +563,7 @@ class Metadata:
         tag = vint.read_vuint(port)
         try: # From here on, EOF is an error.
             result = Metadata()
-            while(True): # only exit is error (exception) or _rec_tag_end
+            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:
@@ -547,9 +611,9 @@ class Metadata:
 def from_path(path, statinfo=None, archive_path=None, save_symlinks=True):
     result = Metadata()
     result.path = archive_path
-    st = statinfo if statinfo else lstat(path)
+    st = statinfo or lstat(path)
     result._add_common(path, st)
-    if(save_symlinks):
+    if save_symlinks:
         result._add_symlink_target(path, st)
     result._add_posix1e_acl(path, st)
     result._add_linux_attr(path, st)
@@ -566,7 +630,7 @@ def save_tree(output_file, paths,
     # Issue top-level rewrite warnings.
     for path in paths:
         safe_path = _clean_up_path_for_archive(path)
-        if(safe_path != path):
+        if safe_path != path:
             log('archiving "%s" as "%s"\n' % (path, safe_path))
 
     start_dir = os.getcwd()