/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: Robert Collins
  • Date: 2006-11-08 00:36:30 UTC
  • mto: This revision was merged to the branch mainline in revision 2124.
  • Revision ID: robertc@robertcollins.net-20061108003630-feb31613c83f7096
(Robert Collins) Extend the problem reporting command line UI to use
apport to report more detailed diagnostics which should help in in getting
faults reported in Malone and provides the basis for capturing more
information such as detailed logging data from the current invocation of
bzr in the future (without cluttering 'bzr.log' unnecessarily).
apport is available from Ubuntu Edgy onwards.

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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
 
19
 
from warnings import warn
 
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
20
37
 
21
38
 
22
39
class AtomicFile(object):
26
43
 
27
44
    Open this as for a regular file, then use commit() to move into
28
45
    place or abort() to cancel.
29
 
 
30
 
    An encoding can be specified; otherwise the default is ascii.
31
46
    """
32
47
 
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())
 
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
 
40
62
        self.realfilename = filename
41
63
        
42
 
        if encoding:
43
 
            import codecs
44
 
            self.f = codecs.open(self.tmpfilename, mode, encoding)
 
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
45
70
        else:
46
 
            self.f = open(self.tmpfilename, mode)
47
 
 
48
 
        self.write = self.f.write
49
 
        self.closed = False
50
 
 
 
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)
51
90
 
52
91
    def __repr__(self):
53
92
        return '%s(%r)' % (self.__class__.__name__,
54
93
                           self.realfilename)
55
 
    
 
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)
56
107
 
57
108
    def commit(self):
58
109
        """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
 
 
 
110
        self._close_tmpfile('commit')
 
111
        osutils.rename(self.tmpfilename, self.realfilename)
79
112
 
80
113
    def abort(self):
81
114
        """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
 
115
        self._close_tmpfile('abort')
90
116
        os.remove(self.tmpfilename)
91
117
 
92
 
 
93
118
    def close(self):
94
119
        """Discard the file unless already committed."""
95
 
        if not self.closed:
 
120
        if self._fd is not None:
96
121
            self.abort()
97
122
 
98
 
 
99
123
    def __del__(self):
100
 
        if not self.closed:
101
 
            warn("%r leaked" % self)
102
 
        
 
124
        if self._fd is not None:
 
125
            warnings.warn("%r leaked" % self)