4597.9.1
by Vincent Ladeuil
Merge bzr.dev into cleanup |
1 |
# Copyright (C) 2005, 2006, 2008, 2009, 2010 Canonical Ltd
|
1887.1.1
by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines, |
2 |
#
|
409
by Martin Pool
- New AtomicFile class |
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.
|
|
1887.1.1
by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines, |
7 |
#
|
409
by Martin Pool
- New AtomicFile class |
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.
|
|
1887.1.1
by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines, |
12 |
#
|
409
by Martin Pool
- New AtomicFile class |
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
|
|
4183.7.1
by Sabin Iacob
update FSF mailing address |
15 |
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
409
by Martin Pool
- New AtomicFile class |
16 |
|
17 |
||
1773.4.1
by Martin Pool
Add pyflakes makefile target; fix many warnings |
18 |
import os |
1996.3.15
by John Arbash Meinel
lazy_import AtomicFile |
19 |
|
20 |
from bzrlib.lazy_import import lazy_import |
|
21 |
lazy_import(globals(), """ |
|
1755.3.6
by John Arbash Meinel
Add a test suite for Atomic File, and clean it up so that it really does set the mode properly. |
22 |
import stat
|
1755.3.11
by John Arbash Meinel
Test that AtomicFile.closed is supported, but deprecated |
23 |
import warnings
|
1755.3.1
by Robert Collins
Tune the time to build our kernel_like tree : make LocalTransport.put faster, AtomicFile faster, LocalTransport.append faster. |
24 |
|
1755.3.6
by John Arbash Meinel
Add a test suite for Atomic File, and clean it up so that it really does set the mode properly. |
25 |
from bzrlib import (
|
26 |
errors,
|
|
1755.3.7
by John Arbash Meinel
Clean up and write tests for permissions. Now we use fstat which should be cheap, and lets us check the permissions and the file size |
27 |
osutils,
|
1755.3.6
by John Arbash Meinel
Add a test suite for Atomic File, and clean it up so that it really does set the mode properly. |
28 |
symbol_versioning,
|
29 |
)
|
|
1996.3.15
by John Arbash Meinel
lazy_import AtomicFile |
30 |
""") |
1755.3.1
by Robert Collins
Tune the time to build our kernel_like tree : make LocalTransport.put faster, AtomicFile faster, LocalTransport.append faster. |
31 |
|
32 |
# not forksafe - but we dont fork.
|
|
33 |
_pid = os.getpid() |
|
1996.3.15
by John Arbash Meinel
lazy_import AtomicFile |
34 |
_hostname = None |
1755.3.6
by John Arbash Meinel
Add a test suite for Atomic File, and clean it up so that it really does set the mode properly. |
35 |
|
563
by Martin Pool
- AtomicFile emits a warning if it is gc'd without being closed |
36 |
|
558
by Martin Pool
- All top-level classes inherit from object |
37 |
class AtomicFile(object): |
409
by Martin Pool
- New AtomicFile class |
38 |
"""A file that does an atomic-rename to move into place.
|
39 |
||
40 |
This also causes hardlinks to break when it's written out.
|
|
41 |
||
42 |
Open this as for a regular file, then use commit() to move into
|
|
43 |
place or abort() to cancel.
|
|
44 |
"""
|
|
45 |
||
1755.3.9
by John Arbash Meinel
Make AtomicFile not do anything if not supplied a mode, clean up LocalTransport now that we do the right thing for None |
46 |
__slots__ = ['tmpfilename', 'realfilename', '_fd'] |
1755.3.1
by Robert Collins
Tune the time to build our kernel_like tree : make LocalTransport.put faster, AtomicFile faster, LocalTransport.append faster. |
47 |
|
1755.3.9
by John Arbash Meinel
Make AtomicFile not do anything if not supplied a mode, clean up LocalTransport now that we do the right thing for None |
48 |
def __init__(self, filename, mode='wb', new_mode=None): |
1996.3.15
by John Arbash Meinel
lazy_import AtomicFile |
49 |
global _hostname |
50 |
||
1755.3.6
by John Arbash Meinel
Add a test suite for Atomic File, and clean it up so that it really does set the mode properly. |
51 |
self._fd = None |
1755.3.1
by Robert Collins
Tune the time to build our kernel_like tree : make LocalTransport.put faster, AtomicFile faster, LocalTransport.append faster. |
52 |
|
1996.3.15
by John Arbash Meinel
lazy_import AtomicFile |
53 |
if _hostname is None: |
3626.1.1
by Mark Hammond
Add osutils.get_host_name() to return a unicode hostname to prevent |
54 |
_hostname = osutils.get_host_name() |
1996.3.15
by John Arbash Meinel
lazy_import AtomicFile |
55 |
|
3905.1.1
by Adrian Wilkins
AtomicFile names are now not invariant-per-process which stops multiple transactions on the same file breaking under unknown conditions on Windows CIFS shares |
56 |
self.tmpfilename = '%s.%d.%s.%s.tmp' % (filename, _pid, _hostname, |
57 |
osutils.rand_chars(10)) |
|
1755.3.4
by Robert Collins
current status |
58 |
|
409
by Martin Pool
- New AtomicFile class |
59 |
self.realfilename = filename |
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
60 |
|
4634.140.5
by INADA Naoki
Use O_NOINHERIT flag in AtomicFile. |
61 |
flags = os.O_EXCL | os.O_CREAT | os.O_WRONLY | osutils.O_NOINHERIT |
1755.3.6
by John Arbash Meinel
Add a test suite for Atomic File, and clean it up so that it really does set the mode properly. |
62 |
if mode == 'wb': |
1755.3.7
by John Arbash Meinel
Clean up and write tests for permissions. Now we use fstat which should be cheap, and lets us check the permissions and the file size |
63 |
flags |= osutils.O_BINARY |
3376.2.4
by Martin Pool
Remove every assert statement from bzrlib! |
64 |
elif mode != 'wt': |
65 |
raise ValueError("invalid AtomicFile mode %r" % mode) |
|
1755.3.9
by John Arbash Meinel
Make AtomicFile not do anything if not supplied a mode, clean up LocalTransport now that we do the right thing for None |
66 |
|
67 |
if new_mode is not None: |
|
68 |
local_mode = new_mode |
|
69 |
else: |
|
70 |
local_mode = 0666 |
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
71 |
|
1755.3.1
by Robert Collins
Tune the time to build our kernel_like tree : make LocalTransport.put faster, AtomicFile faster, LocalTransport.append faster. |
72 |
# Use a low level fd operation to avoid chmodding later.
|
1755.3.6
by John Arbash Meinel
Add a test suite for Atomic File, and clean it up so that it really does set the mode properly. |
73 |
# This may not succeed, but it should help most of the time
|
1755.3.9
by John Arbash Meinel
Make AtomicFile not do anything if not supplied a mode, clean up LocalTransport now that we do the right thing for None |
74 |
self._fd = os.open(self.tmpfilename, flags, local_mode) |
75 |
||
76 |
if new_mode is not None: |
|
77 |
# Because of umask issues, we may need to chmod anyway
|
|
78 |
# the common case is that we won't, though.
|
|
79 |
st = os.fstat(self._fd) |
|
80 |
if stat.S_IMODE(st.st_mode) != new_mode: |
|
81 |
os.chmod(self.tmpfilename, new_mode) |
|
1755.3.6
by John Arbash Meinel
Add a test suite for Atomic File, and clean it up so that it really does set the mode properly. |
82 |
|
83 |
def _get_closed(self): |
|
84 |
symbol_versioning.warn('AtomicFile.closed deprecated in bzr 0.10', |
|
85 |
DeprecationWarning, stacklevel=2) |
|
1755.3.11
by John Arbash Meinel
Test that AtomicFile.closed is supported, but deprecated |
86 |
return self._fd is None |
1755.3.6
by John Arbash Meinel
Add a test suite for Atomic File, and clean it up so that it really does set the mode properly. |
87 |
|
88 |
closed = property(_get_closed) |
|
563
by Martin Pool
- AtomicFile emits a warning if it is gc'd without being closed |
89 |
|
90 |
def __repr__(self): |
|
91 |
return '%s(%r)' % (self.__class__.__name__, |
|
92 |
self.realfilename) |
|
409
by Martin Pool
- New AtomicFile class |
93 |
|
1755.3.6
by John Arbash Meinel
Add a test suite for Atomic File, and clean it up so that it really does set the mode properly. |
94 |
def write(self, data): |
95 |
"""Write some data to the file. Like file.write()"""
|
|
96 |
os.write(self._fd, data) |
|
97 |
||
98 |
def _close_tmpfile(self, func_name): |
|
99 |
"""Close the local temp file in preparation for commit or abort"""
|
|
100 |
if self._fd is None: |
|
101 |
raise errors.AtomicFileAlreadyClosed(path=self.realfilename, |
|
102 |
function=func_name) |
|
103 |
fd = self._fd |
|
104 |
self._fd = None |
|
105 |
os.close(fd) |
|
106 |
||
409
by Martin Pool
- New AtomicFile class |
107 |
def commit(self): |
497
by Martin Pool
- new AtomicFile.close() aborts if appropriate |
108 |
"""Close the file and move to final name."""
|
1755.3.6
by John Arbash Meinel
Add a test suite for Atomic File, and clean it up so that it really does set the mode properly. |
109 |
self._close_tmpfile('commit') |
1996.3.15
by John Arbash Meinel
lazy_import AtomicFile |
110 |
osutils.rename(self.tmpfilename, self.realfilename) |
409
by Martin Pool
- New AtomicFile class |
111 |
|
112 |
def abort(self): |
|
497
by Martin Pool
- new AtomicFile.close() aborts if appropriate |
113 |
"""Discard temporary file without committing changes."""
|
1755.3.6
by John Arbash Meinel
Add a test suite for Atomic File, and clean it up so that it really does set the mode properly. |
114 |
self._close_tmpfile('abort') |
409
by Martin Pool
- New AtomicFile class |
115 |
os.remove(self.tmpfilename) |
497
by Martin Pool
- new AtomicFile.close() aborts if appropriate |
116 |
|
117 |
def close(self): |
|
118 |
"""Discard the file unless already committed."""
|
|
1755.3.6
by John Arbash Meinel
Add a test suite for Atomic File, and clean it up so that it really does set the mode properly. |
119 |
if self._fd is not None: |
497
by Martin Pool
- new AtomicFile.close() aborts if appropriate |
120 |
self.abort() |