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
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
from cStringIO import StringIO
19
from bzrlib.lazy_import import lazy_import
20
lazy_import(globals(), """
22
from bzrlib.decorators import (needs_read_lock,
24
import bzrlib.errors as errors
25
from bzrlib.errors import BzrError
26
from bzrlib.osutils import file_iterator, safe_unicode
27
from bzrlib.symbol_versioning import (deprecated_method,
29
from bzrlib.trace import mutter, note
30
import bzrlib.transactions as transactions
31
import bzrlib.urlutils as urlutils
33
from bzrlib.decorators import (
37
from bzrlib.symbol_versioning import (
34
43
# XXX: The tracking here of lock counts and whether the lock is held is
35
44
# somewhat redundant with what's done in LockDir; the main difference is that
36
45
# LockableFiles permits reentrancy.
47
class _LockWarner(object):
48
"""Hold a counter for a lock and warn if GCed while the count is >= 1.
50
This is separate from LockableFiles because putting a __del__ on
51
LockableFiles can result in uncollectable cycles.
54
def __init__(self, repr):
59
if self.lock_count >= 1:
60
# There should have been a try/finally to unlock this.
61
warnings.warn("%r was gc'd while locked" % self.repr)
38
64
class LockableFiles(object):
39
65
"""Object representing a set of related files locked within the same scope.
51
77
Instances of this class are often called control_files.
53
79
This object builds on top of a Transport, which is used to actually write
54
80
the files to disk, and an OSLock or LockDir, which controls how access to
55
81
the files is controlled. The particular type of locking used is set when
56
82
the object is constructed. In older formats OSLocks are used everywhere.
57
in newer formats a LockDir is used for Repositories and Branches, and
83
in newer formats a LockDir is used for Repositories and Branches, and
58
84
OSLocks for the local filesystem.
86
This class is now deprecated; code should move to using the Transport
87
directly for file operations and using the lock or CountedLock for
90
:ivar _lock: The real underlying lock (e.g. a LockDir)
91
:ivar _counted_lock: A lock decorated with a semaphore, so that it
61
95
# _lock_mode: None, or 'r' or 'w'
63
97
# _lock_count: If _lock_mode is true, a positive count of the number of
64
# times the lock has been taken *by this process*.
66
# If set to False (by a plugin, etc) BzrBranch will not set the
67
# mode on created files or directories
98
# times the lock has been taken *by this process*.
71
100
def __init__(self, transport, lock_name, lock_class):
72
101
"""Create a LockableFiles group
74
:param transport: Transport pointing to the directory holding the
103
:param transport: Transport pointing to the directory holding the
75
104
control files and lock.
76
105
:param lock_name: Name of the lock guarding these files.
77
106
:param lock_class: Class of lock strategy to use: typically
118
140
self._lock.break_lock()
120
142
def _escape(self, file_or_path):
143
"""DEPRECATED: Do not use outside this class"""
121
144
if not isinstance(file_or_path, basestring):
122
145
file_or_path = '/'.join(file_or_path)
123
146
if file_or_path == '':
125
return urlutils.escape(safe_unicode(file_or_path))
148
return urlutils.escape(osutils.safe_unicode(file_or_path))
127
150
def _find_modes(self):
128
"""Determine the appropriate modes for files and directories."""
151
"""Determine the appropriate modes for files and directories.
153
:deprecated: Replaced by BzrDir._find_modes.
155
# XXX: The properties created by this can be removed or deprecated
156
# once all the _get_text_store methods etc no longer use them.
130
159
st = self._transport.stat('.')
131
160
except errors.TransportNotPossible:
132
161
self._dir_mode = 0755
133
162
self._file_mode = 0644
135
self._dir_mode = st.st_mode & 07777
164
# Check the directory mode, but also make sure the created
165
# directories and files are read-write for this user. This is
166
# mostly a workaround for filesystems which lie about being able to
167
# write to a directory (cygwin & win32)
168
self._dir_mode = (st.st_mode & 07777) | 00700
136
169
# Remove the sticky and execute bits for files
137
170
self._file_mode = self._dir_mode & ~07111
138
if not self._set_dir_mode:
139
self._dir_mode = None
140
if not self._set_file_mode:
141
self._file_mode = None
172
@deprecated_method(deprecated_in((1, 6, 0)))
143
173
def controlfilename(self, file_or_path):
144
"""Return location relative to branch."""
174
"""Return location relative to branch.
176
:deprecated: Use Transport methods instead.
145
178
return self._transport.abspath(self._escape(file_or_path))
147
@deprecated_method(zero_eight)
148
def controlfile(self, file_or_path, mode='r'):
149
"""Open a control file for this branch.
151
There are two classes of file in a lockable directory: text
152
and binary. binary files are untranslated byte streams. Text
153
control files are stored with Unix newlines and in UTF-8, even
154
if the platform or locale defaults are different.
156
Such files are not openable in write mode : they are managed via
157
put and put_utf8 which atomically replace old versions using
161
relpath = self._escape(file_or_path)
162
# TODO: codecs.open() buffers linewise, so it was overloaded with
163
# a much larger buffer, do we need to do the same for getreader/getwriter?
165
return self.get(relpath)
167
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
169
return self.get_utf8(relpath)
171
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
173
raise BzrError("invalid controlfile mode %r" % mode)
181
@deprecated_method(deprecated_in((1, 5, 0)))
176
182
def get(self, relpath):
177
"""Get a file as a bytestream."""
183
"""Get a file as a bytestream.
185
:deprecated: Use a Transport instead of LockableFiles.
178
187
relpath = self._escape(relpath)
179
188
return self._transport.get(relpath)
191
@deprecated_method(deprecated_in((1, 5, 0)))
182
192
def get_utf8(self, relpath):
183
"""Get a file as a unicode stream."""
193
"""Get a file as a unicode stream.
195
:deprecated: Use a Transport instead of LockableFiles.
184
197
relpath = self._escape(relpath)
185
198
# DO NOT introduce an errors=replace here.
186
199
return codecs.getreader('utf-8')(self._transport.get(relpath))
188
201
@needs_write_lock
202
@deprecated_method(deprecated_in((1, 6, 0)))
189
203
def put(self, path, file):
192
206
:param path: The path to put the file, relative to the .bzr control
194
:param f: A file-like or string object whose contents should be copied.
208
:param file: A file-like or string object whose contents should be copied.
210
:deprecated: Use Transport methods instead.
196
212
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
198
214
@needs_write_lock
215
@deprecated_method(deprecated_in((1, 6, 0)))
216
def put_bytes(self, path, a_string):
217
"""Write a string of bytes.
219
:param path: The path to put the bytes, relative to the transport root.
220
:param a_string: A string object, whose exact bytes are to be copied.
222
:deprecated: Use Transport methods instead.
224
self._transport.put_bytes(self._escape(path), a_string,
225
mode=self._file_mode)
228
@deprecated_method(deprecated_in((1, 6, 0)))
199
229
def put_utf8(self, path, a_string):
200
230
"""Write a string, encoding as utf-8.
202
232
:param path: The path to put the string, relative to the transport root.
203
:param string: A file-like or string object whose contents should be copied.
233
:param string: A string or unicode object whose contents should be copied.
235
:deprecated: Use Transport methods instead.
205
237
# IterableFile would not be needed if Transport.put took iterables
206
238
# instead of files. ADHB 2005-12-25
210
242
# these are valuable files which should have exact contents.
211
243
if not isinstance(a_string, basestring):
212
244
raise errors.BzrBadParameterNotString(a_string)
213
self.put(path, StringIO(a_string.encode('utf-8')))
215
def lock_write(self):
216
# mutter("lock write: %s (%s)", self, self._lock_count)
245
self.put_bytes(path, a_string.encode('utf-8'))
247
def leave_in_place(self):
248
"""Set this LockableFiles to not clear the physical lock on unlock."""
249
self._lock.leave_in_place()
251
def dont_leave_in_place(self):
252
"""Set this LockableFiles to clear the physical lock on unlock."""
253
self._lock.dont_leave_in_place()
255
def lock_write(self, token=None):
256
"""Lock this group of files for writing.
258
:param token: if this is already locked, then lock_write will fail
259
unless the token matches the existing lock.
260
:returns: a token if this instance supports tokens, otherwise None.
261
:raises TokenLockingNotSupported: when a token is given but this
262
instance doesn't support using token locks.
263
:raises MismatchedToken: if the specified token doesn't match the token
264
of the existing lock.
266
A token should be passed in if you know that you have locked the object
267
some other way, and need to synchronise this object's state with that
217
270
# TODO: Upgrade locking to support using a Transport,
218
271
# and potentially a remote locking protocol
219
272
if self._lock_mode:
220
273
if self._lock_mode != 'w' or not self.get_transaction().writeable():
221
274
raise errors.ReadOnlyError(self)
222
self._lock_count += 1
275
self._lock.validate_token(token)
276
self._lock_warner.lock_count += 1
277
return self._token_from_lock
224
self._lock.lock_write()
225
#note('write locking %s', self)
279
token_from_lock = self._lock.lock_write(token=token)
226
280
#traceback.print_stack()
227
281
self._lock_mode = 'w'
229
self._set_transaction(transactions.WriteTransaction())
282
self._lock_warner.lock_count = 1
283
self._set_write_transaction()
284
self._token_from_lock = token_from_lock
285
return token_from_lock
231
287
def lock_read(self):
232
# mutter("lock read: %s (%s)", self, self._lock_count)
233
288
if self._lock_mode:
234
assert self._lock_mode in ('r', 'w'), \
235
"invalid lock mode %r" % self._lock_mode
236
self._lock_count += 1
289
if self._lock_mode not in ('r', 'w'):
290
raise ValueError("invalid lock mode %r" % (self._lock_mode,))
291
self._lock_warner.lock_count += 1
238
293
self._lock.lock_read()
239
#note('read locking %s', self)
240
294
#traceback.print_stack()
241
295
self._lock_mode = 'r'
243
self._set_transaction(transactions.ReadOnlyTransaction())
244
# 5K may be excessive, but hey, its a knob.
245
self.get_transaction().set_cache_size(5000)
296
self._lock_warner.lock_count = 1
297
self._set_read_transaction()
299
def _set_read_transaction(self):
300
"""Setup a read transaction."""
301
self._set_transaction(transactions.ReadOnlyTransaction())
302
# 5K may be excessive, but hey, its a knob.
303
self.get_transaction().set_cache_size(5000)
305
def _set_write_transaction(self):
306
"""Setup a write transaction."""
307
self._set_transaction(transactions.WriteTransaction())
247
309
def unlock(self):
248
# mutter("unlock: %s (%s)", self, self._lock_count)
249
310
if not self._lock_mode:
250
311
raise errors.LockNotHeld(self)
251
if self._lock_count > 1:
252
self._lock_count -= 1
312
if self._lock_warner.lock_count > 1:
313
self._lock_warner.lock_count -= 1
254
#note('unlocking %s', self)
255
315
#traceback.print_stack()
256
316
self._finish_transaction()
258
318
self._lock.unlock()
260
self._lock_mode = self._lock_count = None
320
self._lock_mode = self._lock_warner.lock_count = None
323
def _lock_count(self):
324
return self._lock_warner.lock_count
262
326
def is_locked(self):
263
327
"""Return true if this LockableFiles group is locked"""
264
return self._lock_count >= 1
328
return self._lock_warner.lock_count >= 1
266
330
def get_physical_lock_status(self):
267
331
"""Return physical lock status.
269
333
Returns true if a lock is held on the transport. If no lock is held, or
270
334
the underlying locking mechanism does not support querying lock
271
335
status, false is returned.
added
removed
bzrlib/lockable_files.py
