/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 bzrlib/atomicfile.py

  • Committer: John Arbash Meinel
  • Date: 2006-08-09 00:50:42 UTC
  • mto: This revision was merged to the branch mainline in revision 1912.
  • Revision ID: john@arbash-meinel.com-20060809005042-818f9535c3fd5e7e
Add a test suite for Atomic File, and clean it up so that it really does set the mode properly.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/atomicfile.py
1
1
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
 
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
 
 
18
import codecs
 
19
import errno
 
20
import os
 
21
import stat
 
22
import socket
 
23
import sys
19
24
from warnings import warn
20
25
 
 
26
from bzrlib import (
 
27
    errors,
 
28
    symbol_versioning,
 
29
    )
 
30
from bzrlib.osutils import rename
 
31
 
 
32
# not forksafe - but we dont fork.
 
33
_pid = os.getpid()
 
34
_hostname = socket.gethostname()
 
35
 
 
36
# On win32 O_BINARY will set binary versus text mode
 
37
# but the constant doesn't exist on platforms where it isn't
 
38
# needed
 
39
_binary = getattr(os, 'O_BINARY', 0)
 
40
 
21
41
 
22
42
class AtomicFile(object):
23
43
    """A file that does an atomic-rename to move into place.
26
46
 
27
47
    Open this as for a regular file, then use commit() to move into
28
48
    place or abort() to cancel.
29
 
 
30
 
    An encoding can be specified; otherwise the default is ascii.
31
49
    """
32
50
 
33
 
    def __init__(self, filename, mode='wb', encoding=None):
34
 
        if mode != 'wb' and mode != 'wt':
35
 
            raise ValueError("invalid AtomicFile mode %r" % mode)
36
 
 
37
 
        import os, socket
38
 
        self.tmpfilename = '%s.%d.%s.tmp' % (filename, os.getpid(),
39
 
                                             socket.gethostname())
 
51
    __slots__ = ['tmpfilename', 'realfilename', '_fd', '_new_mode']
 
52
 
 
53
    def __init__(self, filename, mode='wb', new_mode=0666):
 
54
        self._fd = None
 
55
        assert mode in ('wb', 'wt'), \
 
56
            "invalid AtomicFile mode %r" % mode
 
57
 
 
58
        self.tmpfilename = '%s.%d.%s.tmp' % (filename, _pid, _hostname)
 
59
 
40
60
        self.realfilename = filename
41
61
        
42
 
        if encoding:
43
 
            import codecs
44
 
            self.f = codecs.open(self.tmpfilename, mode, encoding)
45
 
        else:
46
 
            self.f = open(self.tmpfilename, mode)
47
 
 
48
 
        self.write = self.f.write
49
 
        self.closed = False
50
 
 
 
62
        flags = os.O_EXCL | os.O_CREAT | os.O_WRONLY
 
63
        if mode == 'wb':
 
64
            flags |= _binary
 
65
        
 
66
        self._new_mode = new_mode
 
67
        # Use a low level fd operation to avoid chmodding later.
 
68
        # This may not succeed, but it should help most of the time
 
69
        self._fd = os.open(self.tmpfilename, flags, new_mode)
 
70
        st = os.fstat(self._fd)
 
71
        if stat.S_IMODE(st.st_mode) != new_mode:
 
72
            os.chmod(self.tmpfilename, new_mode)
 
73
 
 
74
    def _get_closed(self):
 
75
        symbol_versioning.warn('AtomicFile.closed deprecated in bzr 0.10',
 
76
                               DeprecationWarning, stacklevel=2)
 
77
        return self.f is None
 
78
 
 
79
    closed = property(_get_closed)
51
80
 
52
81
    def __repr__(self):
53
82
        return '%s(%r)' % (self.__class__.__name__,
54
83
                           self.realfilename)
55
 
    
 
84
 
 
85
    def write(self, data):
 
86
        """Write some data to the file. Like file.write()"""
 
87
        os.write(self._fd, data)
 
88
 
 
89
    def _close_tmpfile(self, func_name):
 
90
        """Close the local temp file in preparation for commit or abort"""
 
91
        if self._fd is None:
 
92
            raise errors.AtomicFileAlreadyClosed(path=self.realfilename,
 
93
                                                 function=func_name)
 
94
        fd = self._fd
 
95
        self._fd = None
 
96
        os.close(fd)
56
97
 
57
98
    def commit(self):
58
99
        """Close the file and move to final name."""
59
 
        import sys, os
60
 
        
61
 
        if self.closed:
62
 
            raise Exception('%r is already closed' % self)
63
 
 
64
 
        self.closed = True
65
 
        self.f.close()
66
 
        self.f = None
67
 
        
68
 
        if sys.platform == 'win32':
69
 
            # windows cannot rename over an existing file
70
 
            try:
71
 
                os.remove(self.realfilename)
72
 
            except OSError, e:
73
 
                import errno
74
 
                if e.errno != errno.ENOENT:
75
 
                    raise
76
 
                
77
 
        os.rename(self.tmpfilename, self.realfilename)
78
 
 
 
100
        self._close_tmpfile('commit')
 
101
        rename(self.tmpfilename, self.realfilename)
79
102
 
80
103
    def abort(self):
81
104
        """Discard temporary file without committing changes."""
82
 
        import os
83
 
 
84
 
        if self.closed:
85
 
            raise Exception('%r is already closed' % self)
86
 
 
87
 
        self.closed = True
88
 
        self.f.close()
89
 
        self.f = None
 
105
        self._close_tmpfile('abort')
90
106
        os.remove(self.tmpfilename)
91
107
 
92
 
 
93
108
    def close(self):
94
109
        """Discard the file unless already committed."""
95
 
        if not self.closed:
 
110
        if self._fd is not None:
96
111
            self.abort()
97
112
 
98
 
 
99
113
    def __del__(self):
100
 
        if not self.closed:
 
114
        if self._fd is not None:
101
115
            warn("%r leaked" % self)
102