daklib/fstransactions.py

   1 # Copyright (C) 2012, Ansgar Burchardt <ansgar@debian.org>
   2 #
   3 # This program is free software; you can redistribute it and/or modify
   4 # it under the terms of the GNU General Public License as published by
   5 # the Free Software Foundation; either version 2 of the License, or
   6 # (at your option) any later version.
   7 #
   8 # This program is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 # GNU General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU General Public License along
  14 # with this program; if not, write to the Free Software Foundation, Inc.,
  15 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16
  17 """Transactions for filesystem actions
  18 """
  19
  20 import errno
  21 import os
  22 import shutil
  23
  24 class _FilesystemAction(object):
  25     @property
  26     def temporary_name(self):
  27         raise NotImplementedError()
  28
  29     def check_for_temporary(self):
  30         try:
  31             if os.path.exists(self.temporary_name):
  32                 raise IOError("Temporary file '{0}' already exists.".format(self.temporary_name))
  33         except NotImplementedError:
  34             pass
  35
  36 class _FilesystemCopyAction(_FilesystemAction):
  37     def __init__(self, source, destination, link=True, symlink=False, mode=None):
  38         self.destination = destination
  39         self.need_cleanup = False
  40
  41         dirmode = 0o2755
  42         if mode is not None:
  43             dirmode = 0o2700 | mode
  44             # Allow +x for group and others if they have +r.
  45             if dirmode & 0o0040:
  46                 dirmode = dirmode | 0o0010
  47             if dirmode & 0o0004:
  48                 dirmode = dirmode | 0o0001
  49
  50         self.check_for_temporary()
  51         destdir = os.path.dirname(self.destination)
  52         if not os.path.exists(destdir):
  53             os.makedirs(destdir, dirmode)
  54         if symlink:
  55             os.symlink(source, self.destination)
  56         elif link:
  57             try:
  58                 os.link(source, self.destination)
  59             except OSError:
  60                 shutil.copy2(source, self.destination)
  61         else:
  62             shutil.copy2(source, self.destination)
  63
  64         self.need_cleanup = True
  65         if mode is not None:
  66             os.chmod(self.destination, mode)
  67
  68     @property
  69     def temporary_name(self):
  70         return self.destination
  71
  72     def commit(self):
  73         pass
  74
  75     def rollback(self):
  76         if self.need_cleanup:
  77             os.unlink(self.destination)
  78             self.need_cleanup = False
  79
  80 class _FilesystemUnlinkAction(_FilesystemAction):
  81     def __init__(self, path):
  82         self.path = path
  83         self.need_cleanup = False
  84
  85         self.check_for_temporary()
  86         os.rename(self.path, self.temporary_name)
  87         self.need_cleanup = True
  88
  89     @property
  90     def temporary_name(self):
  91         return "{0}.dak-rm".format(self.path)
  92
  93     def commit(self):
  94         if self.need_cleanup:
  95             os.unlink(self.temporary_name)
  96             self.need_cleanup = False
  97
  98     def rollback(self):
  99         if self.need_cleanup:
 100             os.rename(self.temporary_name, self.path)
 101             self.need_cleanup = False
 102
 103 class _FilesystemCreateAction(_FilesystemAction):
 104     def __init__(self, path):
 105         self.path = path
 106         self.need_cleanup = True
 107
 108     @property
 109     def temporary_name(self):
 110         return self.path
 111
 112     def commit(self):
 113         pass
 114
 115     def rollback(self):
 116         if self.need_cleanup:
 117             os.unlink(self.path)
 118             self.need_cleanup = False
 119
 120 class FilesystemTransaction(object):
 121     """transactions for filesystem actions"""
 122     def __init__(self):
 123         self.actions = []
 124
 125     def copy(self, source, destination, link=True, symlink=False, mode=None):
 126         """copy `source` to `destination`
 127
 128         Args:
 129            source (str): source file
 130            destination (str): destination file
 131
 132         Kwargs:
 133            link (bool): Try hardlinking, falling back to copying.
 134            symlink (bool): Create a symlink instead
 135            mode (int): Permissions to change `destination` to.
 136         """
 137         if isinstance(mode, str) or isinstance(mode, unicode):
 138             mode = int(mode, 8)
 139
 140         self.actions.append(_FilesystemCopyAction(source, destination, link=link, symlink=symlink, mode=mode))
 141
 142     def move(self, source, destination, mode=None):
 143         """move `source` to `destination`
 144
 145         Args:
 146            source (str): source file
 147            destination (str): destination file
 148
 149         Kwargs:
 150            mode (int): Permissions to change `destination` to.
 151         """
 152         self.copy(source, destination, link=True, mode=mode)
 153         self.unlink(source)
 154
 155     def unlink(self, path):
 156         """unlink `path`
 157
 158         Args:
 159            path (str): file to unlink
 160         """
 161         self.actions.append(_FilesystemUnlinkAction(path))
 162
 163     def create(self, path, mode=None):
 164         """create `filename` and return file handle
 165
 166         Args:
 167            filename (str): file to create
 168
 169         Kwargs:
 170            mode (int): Permissions for the new file
 171
 172         Returns:
 173            file handle of the new file
 174         """
 175         if isinstance(mode, str) or isinstance(mode, unicode):
 176             mode = int(mode, 8)
 177
 178         destdir = os.path.dirname(path)
 179         if not os.path.exists(destdir):
 180             os.makedirs(destdir, 0o2775)
 181         if os.path.exists(path):
 182             raise IOError("File '{0}' already exists.".format(path))
 183         fh = open(path, 'w')
 184         self.actions.append(_FilesystemCreateAction(path))
 185         if mode is not None:
 186             os.chmod(path, mode)
 187         return fh
 188
 189     def commit(self):
 190         """Commit all recorded actions."""
 191         try:
 192             for action in self.actions:
 193                 action.commit()
 194         except:
 195             self.rollback()
 196             raise
 197         finally:
 198             self.actions = []
 199
 200     def rollback(self):
 201         """Undo all recorded actions."""
 202         try:
 203             for action in self.actions:
 204                 action.rollback()
 205         finally:
 206             self.actions = []
 207
 208     def __enter__(self):
 209         return self
 210
 211     def __exit__(self, type, value, traceback):
 212         if type is None:
 213             self.commit()
 214         else:
 215             self.rollback()
 216         return None