/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/atomicfile.py

  • Committer: Jelmer Vernooij
  • Date: 2020-09-02 16:35:18 UTC
  • mto: (7490.40.109 work)
  • mto: This revision was merged to the branch mainline in revision 7526.
  • Revision ID: jelmer@jelmer.uk-20200902163518-sy9f4unbboljphgu
Handle duplicate directories entries for git.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/atomicfile.py
 
1
# Copyright (C) 2005, 2006, 2008, 2009, 2010 Canonical Ltd
 
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
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
import os
 
20
 
 
21
import stat
 
22
 
 
23
from breezy import (
 
24
    errors,
 
25
    osutils,
 
26
    )
 
27
 
 
28
# not forksafe - but we dont fork.
 
29
_pid = os.getpid()
 
30
_hostname = None
 
31
 
 
32
 
 
33
class AtomicFileAlreadyClosed(errors.PathError):
 
34
 
 
35
    _fmt = ('"%(function)s" called on an AtomicFile after it was closed:'
 
36
            ' "%(path)s"')
 
37
 
 
38
    def __init__(self, path, function):
 
39
        errors.PathError.__init__(self, path=path, extra=None)
 
40
        self.function = function
 
41
 
 
42
 
 
43
class AtomicFile(object):
 
44
    """A file that does an atomic-rename to move into place.
 
45
 
 
46
    This also causes hardlinks to break when it's written out.
 
47
 
 
48
    Open this as for a regular file, then use commit() to move into
 
49
    place or abort() to cancel.
 
50
    """
 
51
 
 
52
    __slots__ = ['tmpfilename', 'realfilename', '_fd']
 
53
 
 
54
    def __init__(self, filename, mode='wb', new_mode=None):
 
55
        global _hostname
 
56
 
 
57
        self._fd = None
 
58
 
 
59
        if _hostname is None:
 
60
            _hostname = osutils.get_host_name()
 
61
 
 
62
        self.tmpfilename = '%s.%d.%s.%s.tmp' % (filename, _pid, _hostname,
 
63
                                                osutils.rand_chars(10))
 
64
 
 
65
        self.realfilename = filename
 
66
 
 
67
        flags = os.O_EXCL | os.O_CREAT | os.O_WRONLY | osutils.O_NOINHERIT
 
68
        if mode == 'wb':
 
69
            flags |= osutils.O_BINARY
 
70
        elif mode != 'wt':
 
71
            raise ValueError("invalid AtomicFile mode %r" % mode)
 
72
 
 
73
        if new_mode is not None:
 
74
            local_mode = new_mode
 
75
        else:
 
76
            local_mode = 0o666
 
77
 
 
78
        # Use a low level fd operation to avoid chmodding later.
 
79
        # This may not succeed, but it should help most of the time
 
80
        self._fd = os.open(self.tmpfilename, flags, local_mode)
 
81
 
 
82
        if new_mode is not None:
 
83
            # Because of umask issues, we may need to chmod anyway
 
84
            # the common case is that we won't, though.
 
85
            st = os.fstat(self._fd)
 
86
            if stat.S_IMODE(st.st_mode) != new_mode:
 
87
                osutils.chmod_if_possible(self.tmpfilename, new_mode)
 
88
 
 
89
    def __repr__(self):
 
90
        return '%s(%r)' % (self.__class__.__name__,
 
91
                           self.realfilename)
 
92
 
 
93
    def write(self, data):
 
94
        """Write some data to the file. Like file.write()"""
 
95
        os.write(self._fd, data)
 
96
 
 
97
    def _close_tmpfile(self, func_name):
 
98
        """Close the local temp file in preparation for commit or abort"""
 
99
        if self._fd is None:
 
100
            raise AtomicFileAlreadyClosed(path=self.realfilename,
 
101
                                          function=func_name)
 
102
        fd = self._fd
 
103
        self._fd = None
 
104
        os.close(fd)
 
105
 
 
106
    def commit(self):
 
107
        """Close the file and move to final name."""
 
108
        self._close_tmpfile('commit')
 
109
        osutils.rename(self.tmpfilename, self.realfilename)
 
110
 
 
111
    def abort(self):
 
112
        """Discard temporary file without committing changes."""
 
113
        self._close_tmpfile('abort')
 
114
        os.remove(self.tmpfilename)
 
115
 
 
116
    def close(self):
 
117
        """Discard the file unless already committed."""
 
118
        if self._fd is not None:
 
119
            self.abort()
 
120
 
 
121
    def __enter__(self):
 
122
        return self
 
123
 
 
124
    def __exit__(self, exc_type, exc_val, exc_tb):
 
125
        if exc_type:
 
126
            self.abort()
 
127
            return False
 
128
        self.commit()