← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/atomicfile.py

  • Committer: Vincent Ladeuil
  • Date: 2010-02-05 10:27:33 UTC
  • mto: (5008.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5009.
  • Revision ID: v.ladeuil+lp@free.fr-20100205102733-8wpjnqz6g4nvrbfu
All Conflict action method names start with 'action_' to avoid potential namespace collisions

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/atomicfile.py
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2004, 2005 Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
 
19
 
class AtomicFile:
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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):
20
40
    """A file that does an atomic-rename to move into place.
21
41
 
22
42
    This also causes hardlinks to break when it's written out.
23
43
 
24
44
    Open this as for a regular file, then use commit() to move into
25
45
    place or abort() to cancel.
26
 
 
27
 
    An encoding can be specified; otherwise the default is ascii.
28
46
    """
29
47
 
30
 
    def __init__(self, filename, mode='wb', encoding=None):
31
 
        if mode != 'wb' and mode != 'wt':
 
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
 
 
55
        if _hostname is None:
 
56
            _hostname = osutils.get_host_name()
 
57
 
 
58
        self.tmpfilename = '%s.%d.%s.%s.tmp' % (filename, _pid, _hostname,
 
59
                                                osutils.rand_chars(10))
 
60
 
 
61
        self.realfilename = filename
 
62
 
 
63
        flags = os.O_EXCL | os.O_CREAT | os.O_WRONLY
 
64
        if mode == 'wb':
 
65
            flags |= osutils.O_BINARY
 
66
        elif mode != 'wt':
32
67
            raise ValueError("invalid AtomicFile mode %r" % mode)
33
68
 
34
 
        import os, socket
35
 
        self.tmpfilename = '%s.%d.%s.tmp' % (filename, os.getpid(),
36
 
                                             socket.gethostname())
37
 
        self.realfilename = filename
38
 
        
39
 
        self.f = open(self.tmpfilename, mode)
40
 
 
41
 
        if encoding:
42
 
            import codecs
43
 
            self.f = codecs.EncodedFile(self.f, encoding)
44
 
        
45
 
        self.write = self.f.write
46
 
        self.closed = property(self.f.closed)
 
69
        if new_mode is not None:
 
70
            local_mode = new_mode
 
71
        else:
 
72
            local_mode = 0666
 
73
 
 
74
        # Use a low level fd operation to avoid chmodding later.
 
75
        # This may not succeed, but it should help most of the time
 
76
        self._fd = os.open(self.tmpfilename, flags, local_mode)
 
77
 
 
78
        if new_mode is not None:
 
79
            # Because of umask issues, we may need to chmod anyway
 
80
            # the common case is that we won't, though.
 
81
            st = os.fstat(self._fd)
 
82
            if stat.S_IMODE(st.st_mode) != new_mode:
 
83
                os.chmod(self.tmpfilename, new_mode)
 
84
 
 
85
    def _get_closed(self):
 
86
        symbol_versioning.warn('AtomicFile.closed deprecated in bzr 0.10',
 
87
                               DeprecationWarning, stacklevel=2)
 
88
        return self._fd is None
 
89
 
 
90
    closed = property(_get_closed)
 
91
 
 
92
    def __repr__(self):
 
93
        return '%s(%r)' % (self.__class__.__name__,
 
94
                           self.realfilename)
 
95
 
 
96
    def write(self, data):
 
97
        """Write some data to the file. Like file.write()"""
 
98
        os.write(self._fd, data)
 
99
 
 
100
    def _close_tmpfile(self, func_name):
 
101
        """Close the local temp file in preparation for commit or abort"""
 
102
        if self._fd is None:
 
103
            raise errors.AtomicFileAlreadyClosed(path=self.realfilename,
 
104
                                                 function=func_name)
 
105
        fd = self._fd
 
106
        self._fd = None
 
107
        os.close(fd)
47
108
 
48
109
    def commit(self):
49
 
        import sys, os
50
 
        
51
 
        self.f.close()
52
 
        if sys.platform == 'win32':
53
 
            os.remove(self.realfilename)
54
 
        os.rename(self.tmpfilename, self.realfilename)
 
110
        """Close the file and move to final name."""
 
111
        self._close_tmpfile('commit')
 
112
        osutils.rename(self.tmpfilename, self.realfilename)
55
113
 
56
114
    def abort(self):
57
 
        import os
58
 
        self.f.close()
 
115
        """Discard temporary file without committing changes."""
 
116
        self._close_tmpfile('abort')
59
117
        os.remove(self.tmpfilename)
60
 
        
61
 
        
 
118
 
 
119
    def close(self):
 
120
        """Discard the file unless already committed."""
 
121
        if self._fd is not None:
 
122
            self.abort()
 
123
 
 
124
    def __del__(self):
 
125
        if self._fd is not None:
 
126
            warnings.warn("%r leaked" % self)