1
# Copyright (C) 2005, 2006, 2008, 2009 Canonical Ltd
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.
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.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
from cStringIO import StringIO
19
from bzrlib.lazy_import import lazy_import
20
lazy_import(globals(), """
32
from bzrlib.decorators import (
36
from bzrlib.symbol_versioning import (
42
# XXX: The tracking here of lock counts and whether the lock is held is
43
# somewhat redundant with what's done in LockDir; the main difference is that
44
# LockableFiles permits reentrancy.
46
class _LockWarner(object):
47
"""Hold a counter for a lock and warn if GCed while the count is >= 1.
49
This is separate from LockableFiles because putting a __del__ on
50
LockableFiles can result in uncollectable cycles.
53
def __init__(self, repr):
58
if self.lock_count >= 1:
59
# There should have been a try/finally to unlock this.
60
warnings.warn("%r was gc'd while locked" % self.repr)
63
class LockableFiles(object):
64
"""Object representing a set of related files locked within the same scope.
66
These files are used by a WorkingTree, Repository or Branch, and should
67
generally only be touched by that object.
69
LockableFiles also provides some policy on top of Transport for encoding
70
control files as utf-8.
72
LockableFiles manage a lock count and can be locked repeatedly by
73
a single caller. (The underlying lock implementation generally does not
76
Instances of this class are often called control_files.
78
This object builds on top of a Transport, which is used to actually write
79
the files to disk, and an OSLock or LockDir, which controls how access to
80
the files is controlled. The particular type of locking used is set when
81
the object is constructed. In older formats OSLocks are used everywhere.
82
in newer formats a LockDir is used for Repositories and Branches, and
83
OSLocks for the local filesystem.
85
This class is now deprecated; code should move to using the Transport
86
directly for file operations and using the lock or CountedLock for
90
# _lock_mode: None, or 'r' or 'w'
92
# _lock_count: If _lock_mode is true, a positive count of the number of
93
# times the lock has been taken *by this process*.
95
def __init__(self, transport, lock_name, lock_class):
96
"""Create a LockableFiles group
98
:param transport: Transport pointing to the directory holding the
99
control files and lock.
100
:param lock_name: Name of the lock guarding these files.
101
:param lock_class: Class of lock strategy to use: typically
102
either LockDir or TransportLock.
104
self._transport = transport
105
self.lock_name = lock_name
106
self._transaction = None
107
self._lock_mode = None
108
self._lock_warner = _LockWarner(repr(self))
110
esc_name = self._escape(lock_name)
111
self._lock = lock_class(transport, esc_name,
112
file_modebits=self._file_mode,
113
dir_modebits=self._dir_mode)
115
def create_lock(self):
118
This should normally be called only when the LockableFiles directory
119
is first created on disk.
121
self._lock.create(mode=self._dir_mode)
124
return '%s(%r)' % (self.__class__.__name__,
127
return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
129
def break_lock(self):
130
"""Break the lock of this lockable files group if it is held.
132
The current ui factory will be used to prompt for user conformation.
134
self._lock.break_lock()
136
def _escape(self, file_or_path):
137
"""DEPRECATED: Do not use outside this class"""
138
if not isinstance(file_or_path, basestring):
139
file_or_path = '/'.join(file_or_path)
140
if file_or_path == '':
142
return urlutils.escape(osutils.safe_unicode(file_or_path))
144
def _find_modes(self):
145
"""Determine the appropriate modes for files and directories.
147
:deprecated: Replaced by BzrDir._find_modes.
150
st = self._transport.stat('.')
151
except errors.TransportNotPossible:
152
self._dir_mode = 0755
153
self._file_mode = 0644
155
# Check the directory mode, but also make sure the created
156
# directories and files are read-write for this user. This is
157
# mostly a workaround for filesystems which lie about being able to
158
# write to a directory (cygwin & win32)
159
self._dir_mode = (st.st_mode & 07777) | 00700
160
# Remove the sticky and execute bits for files
161
self._file_mode = self._dir_mode & ~07111
163
@deprecated_method(deprecated_in((1, 6, 0)))
164
def controlfilename(self, file_or_path):
165
"""Return location relative to branch.
167
:deprecated: Use Transport methods instead.
169
return self._transport.abspath(self._escape(file_or_path))
172
@deprecated_method(deprecated_in((1, 5, 0)))
173
def get(self, relpath):
174
"""Get a file as a bytestream.
176
:deprecated: Use a Transport instead of LockableFiles.
178
relpath = self._escape(relpath)
179
return self._transport.get(relpath)
182
@deprecated_method(deprecated_in((1, 5, 0)))
183
def get_utf8(self, relpath):
184
"""Get a file as a unicode stream.
186
:deprecated: Use a Transport instead of LockableFiles.
188
relpath = self._escape(relpath)
189
# DO NOT introduce an errors=replace here.
190
return codecs.getreader('utf-8')(self._transport.get(relpath))
193
@deprecated_method(deprecated_in((1, 6, 0)))
194
def put(self, path, file):
197
:param path: The path to put the file, relative to the .bzr control
199
:param file: A file-like or string object whose contents should be copied.
201
:deprecated: Use Transport methods instead.
203
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
206
@deprecated_method(deprecated_in((1, 6, 0)))
207
def put_bytes(self, path, a_string):
208
"""Write a string of bytes.
210
:param path: The path to put the bytes, relative to the transport root.
211
:param a_string: A string object, whose exact bytes are to be copied.
213
:deprecated: Use Transport methods instead.
215
self._transport.put_bytes(self._escape(path), a_string,
216
mode=self._file_mode)
219
@deprecated_method(deprecated_in((1, 6, 0)))
220
def put_utf8(self, path, a_string):
221
"""Write a string, encoding as utf-8.
223
:param path: The path to put the string, relative to the transport root.
224
:param string: A string or unicode object whose contents should be copied.
226
:deprecated: Use Transport methods instead.
228
# IterableFile would not be needed if Transport.put took iterables
229
# instead of files. ADHB 2005-12-25
230
# RBC 20060103 surely its not needed anyway, with codecs transcode
232
# JAM 20060103 We definitely don't want encode(..., 'replace')
233
# these are valuable files which should have exact contents.
234
if not isinstance(a_string, basestring):
235
raise errors.BzrBadParameterNotString(a_string)
236
self.put_bytes(path, a_string.encode('utf-8'))
238
def leave_in_place(self):
239
"""Set this LockableFiles to not clear the physical lock on unlock."""
240
self._lock.leave_in_place()
242
def dont_leave_in_place(self):
243
"""Set this LockableFiles to clear the physical lock on unlock."""
244
self._lock.dont_leave_in_place()
246
def lock_write(self, token=None):
247
"""Lock this group of files for writing.
249
:param token: if this is already locked, then lock_write will fail
250
unless the token matches the existing lock.
251
:returns: a token if this instance supports tokens, otherwise None.
252
:raises TokenLockingNotSupported: when a token is given but this
253
instance doesn't support using token locks.
254
:raises MismatchedToken: if the specified token doesn't match the token
255
of the existing lock.
257
A token should be passed in if you know that you have locked the object
258
some other way, and need to synchronise this object's state with that
261
# TODO: Upgrade locking to support using a Transport,
262
# and potentially a remote locking protocol
264
if self._lock_mode != 'w' or not self.get_transaction().writeable():
265
raise errors.ReadOnlyError(self)
266
self._lock.validate_token(token)
267
self._lock_warner.lock_count += 1
268
return self._token_from_lock
270
token_from_lock = self._lock.lock_write(token=token)
271
#traceback.print_stack()
272
self._lock_mode = 'w'
273
self._lock_warner.lock_count = 1
274
self._set_write_transaction()
275
self._token_from_lock = token_from_lock
276
return token_from_lock
280
if self._lock_mode not in ('r', 'w'):
281
raise ValueError("invalid lock mode %r" % (self._lock_mode,))
282
self._lock_warner.lock_count += 1
284
self._lock.lock_read()
285
#traceback.print_stack()
286
self._lock_mode = 'r'
287
self._lock_warner.lock_count = 1
288
self._set_read_transaction()
290
def _set_read_transaction(self):
291
"""Setup a read transaction."""
292
self._set_transaction(transactions.ReadOnlyTransaction())
293
# 5K may be excessive, but hey, its a knob.
294
self.get_transaction().set_cache_size(5000)
296
def _set_write_transaction(self):
297
"""Setup a write transaction."""
298
self._set_transaction(transactions.WriteTransaction())
301
if not self._lock_mode:
302
raise errors.LockNotHeld(self)
303
if self._lock_warner.lock_count > 1:
304
self._lock_warner.lock_count -= 1
306
#traceback.print_stack()
307
self._finish_transaction()
311
self._lock_mode = self._lock_warner.lock_count = None
314
def _lock_count(self):
315
return self._lock_warner.lock_count
318
"""Return true if this LockableFiles group is locked"""
319
return self._lock_warner.lock_count >= 1
321
def get_physical_lock_status(self):
322
"""Return physical lock status.
324
Returns true if a lock is held on the transport. If no lock is held, or
325
the underlying locking mechanism does not support querying lock
326
status, false is returned.
329
return self._lock.peek() is not None
330
except NotImplementedError:
333
def get_transaction(self):
334
"""Return the current active transaction.
336
If no transaction is active, this returns a passthrough object
337
for which all data is immediately flushed and no caching happens.
339
if self._transaction is None:
340
return transactions.PassThroughTransaction()
342
return self._transaction
344
def _set_transaction(self, new_transaction):
345
"""Set a new active transaction."""
346
if self._transaction is not None:
347
raise errors.LockError('Branch %s is in a transaction already.' %
349
self._transaction = new_transaction
351
def _finish_transaction(self):
352
"""Exit the current transaction."""
353
if self._transaction is None:
354
raise errors.LockError('Branch %s is not in a transaction' %
356
transaction = self._transaction
357
self._transaction = None
361
class TransportLock(object):
362
"""Locking method which uses transport-dependent locks.
364
On the local filesystem these transform into OS-managed locks.
366
These do not guard against concurrent access via different
369
This is suitable for use only in WorkingTrees (which are at present
372
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
373
self._transport = transport
374
self._escaped_name = escaped_name
375
self._file_modebits = file_modebits
376
self._dir_modebits = dir_modebits
378
def break_lock(self):
379
raise NotImplementedError(self.break_lock)
381
def leave_in_place(self):
382
raise NotImplementedError(self.leave_in_place)
384
def dont_leave_in_place(self):
385
raise NotImplementedError(self.dont_leave_in_place)
387
def lock_write(self, token=None):
388
if token is not None:
389
raise errors.TokenLockingNotSupported(self)
390
self._lock = self._transport.lock_write(self._escaped_name)
393
self._lock = self._transport.lock_read(self._escaped_name)
400
raise NotImplementedError()
402
def create(self, mode=None):
403
"""Create lock mechanism"""
404
# for old-style locks, create the file now
405
self._transport.put_bytes(self._escaped_name, '',
406
mode=self._file_modebits)
408
def validate_token(self, token):
409
if token is not None:
410
raise errors.TokenLockingNotSupported(self)
added
removed
bzrlib/lockable_files.py
