1
# Copyright (C) 2005, 2006, 2008, 2009, 2010 Canonical Ltd
1
# Copyright (C) 2004, 2005 by Canonical Ltd
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
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
24
from warnings import warn
26
26
from bzrlib import (
31
from bzrlib.osutils import rename
33
33
# not forksafe - but we dont fork.
35
_hostname = socket.gethostname()
38
38
class AtomicFile(object):
44
44
place or abort() to cancel.
47
__slots__ = ['tmpfilename', 'realfilename', '_fd']
49
def __init__(self, filename, mode='wb', new_mode=None):
47
__slots__ = ['tmpfilename', 'realfilename', '_fd', '_new_mode']
49
def __init__(self, filename, mode='wb', new_mode=0666):
55
_hostname = osutils.get_host_name()
57
self.tmpfilename = '%s.%d.%s.%s.tmp' % (filename, _pid, _hostname,
58
osutils.rand_chars(10))
51
assert mode in ('wb', 'wt'), \
52
"invalid AtomicFile mode %r" % mode
54
self.tmpfilename = '%s.%d.%s.tmp' % (filename, _pid, _hostname)
60
56
self.realfilename = filename
62
flags = os.O_EXCL | os.O_CREAT | os.O_WRONLY | osutils.O_NOINHERIT
58
flags = os.O_EXCL | os.O_CREAT | os.O_WRONLY
64
60
flags |= osutils.O_BINARY
66
raise ValueError("invalid AtomicFile mode %r" % mode)
68
if new_mode is not None:
62
self._new_mode = new_mode
73
63
# Use a low level fd operation to avoid chmodding later.
74
64
# This may not succeed, but it should help most of the time
75
self._fd = os.open(self.tmpfilename, flags, local_mode)
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)
65
self._fd = os.open(self.tmpfilename, flags, new_mode)
66
st = os.fstat(self._fd)
67
if stat.S_IMODE(st.st_mode) != new_mode:
68
os.chmod(self.tmpfilename, new_mode)
84
70
def _get_closed(self):
85
71
symbol_versioning.warn('AtomicFile.closed deprecated in bzr 0.10',
86
72
DeprecationWarning, stacklevel=2)
87
return self._fd is None
89
75
closed = property(_get_closed)
109
95
"""Close the file and move to final name."""
110
96
self._close_tmpfile('commit')
111
osutils.rename(self.tmpfilename, self.realfilename)
97
rename(self.tmpfilename, self.realfilename)
114
100
"""Discard temporary file without committing changes."""