← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/atomicfile.py

  • Committer: Alexander Belchenko
  • Date: 2007-04-14 12:17:31 UTC
  • mto: This revision was merged to the branch mainline in revision 2422.
  • Revision ID: bialix@ukr.net-20070414121731-jtc76rfulndihkh3
workingtree_implementations: make usage of symlinks optional

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/atomicfile.py
 
1
# Copyright (C) 2004, 2005 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
import os
 
19
import sys
 
20
 
 
21
from bzrlib.lazy_import import lazy_import
 
22
lazy_import(globals(), """
 
23
import stat
 
24
import socket
 
25
import warnings
 
26
 
 
27
from bzrlib import (
 
28
    errors,
 
29
    osutils,
 
30
    symbol_versioning,
 
31
    )
 
32
""")
 
33
 
 
34
# not forksafe - but we dont fork.
 
35
_pid = os.getpid()
 
36
_hostname = None
 
37
 
 
38
 
 
39
class AtomicFile(object):
 
40
    """A file that does an atomic-rename to move into place.
 
41
 
 
42
    This also causes hardlinks to break when it's written out.
 
43
 
 
44
    Open this as for a regular file, then use commit() to move into
 
45
    place or abort() to cancel.
 
46
    """
 
47
 
 
48
    __slots__ = ['tmpfilename', 'realfilename', '_fd']
 
49
 
 
50
    def __init__(self, filename, mode='wb', new_mode=None):
 
51
        global _hostname
 
52
 
 
53
        self._fd = None
 
54
        assert mode in ('wb', 'wt'), \
 
55
            "invalid AtomicFile mode %r" % mode
 
56
 
 
57
        if _hostname is None:
 
58
            _hostname = socket.gethostname()
 
59
 
 
60
        self.tmpfilename = '%s.%d.%s.tmp' % (filename, _pid, _hostname)
 
61
 
 
62
        self.realfilename = filename
 
63
        
 
64
        flags = os.O_EXCL | os.O_CREAT | os.O_WRONLY
 
65
        if mode == 'wb':
 
66
            flags |= osutils.O_BINARY
 
67
 
 
68
        if new_mode is not None:
 
69
            local_mode = new_mode
 
70
        else:
 
71
            local_mode = 0666
 
72
        
 
73
        # Use a low level fd operation to avoid chmodding later.
 
74
        # This may not succeed, but it should help most of the time
 
75
        self._fd = os.open(self.tmpfilename, flags, local_mode)
 
76
 
 
77
        if new_mode is not None:
 
78
            # Because of umask issues, we may need to chmod anyway
 
79
            # the common case is that we won't, though.
 
80
            st = os.fstat(self._fd)
 
81
            if stat.S_IMODE(st.st_mode) != new_mode:
 
82
                os.chmod(self.tmpfilename, new_mode)
 
83
 
 
84
    def _get_closed(self):
 
85
        symbol_versioning.warn('AtomicFile.closed deprecated in bzr 0.10',
 
86
                               DeprecationWarning, stacklevel=2)
 
87
        return self._fd is None
 
88
 
 
89
    closed = property(_get_closed)
 
90
 
 
91
    def __repr__(self):
 
92
        return '%s(%r)' % (self.__class__.__name__,
 
93
                           self.realfilename)
 
94
 
 
95
    def write(self, data):
 
96
        """Write some data to the file. Like file.write()"""
 
97
        os.write(self._fd, data)
 
98
 
 
99
    def _close_tmpfile(self, func_name):
 
100
        """Close the local temp file in preparation for commit or abort"""
 
101
        if self._fd is None:
 
102
            raise errors.AtomicFileAlreadyClosed(path=self.realfilename,
 
103
                                                 function=func_name)
 
104
        fd = self._fd
 
105
        self._fd = None
 
106
        os.close(fd)
 
107
 
 
108
    def commit(self):
 
109
        """Close the file and move to final name."""
 
110
        self._close_tmpfile('commit')
 
111
        osutils.rename(self.tmpfilename, self.realfilename)
 
112
 
 
113
    def abort(self):
 
114
        """Discard temporary file without committing changes."""
 
115
        self._close_tmpfile('abort')
 
116
        os.remove(self.tmpfilename)
 
117
 
 
118
    def close(self):
 
119
        """Discard the file unless already committed."""
 
120
        if self._fd is not None:
 
121
            self.abort()
 
122
 
 
123
    def __del__(self):
 
124
        if self._fd is not None:
 
125
            warnings.warn("%r leaked" % self)