1
# Copyright (C) 2005-2011 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
19
from bzrlib.lazy_import import lazy_import
20
lazy_import(globals(), """
33
from bzrlib.decorators import (
38
class LockableFiles(object):
39
"""Object representing a set of related files locked within the same scope.
41
This coordinates access to the lock along with providing a transaction.
43
LockableFiles manage a lock count and can be locked repeatedly by
44
a single caller. (The underlying lock implementation generally does not
47
Instances of this class are often called control_files.
49
This class is now deprecated; code should move to using the Transport
50
directly for file operations and using the lock or CountedLock for
53
:ivar _lock: The real underlying lock (e.g. a LockDir)
54
:ivar _lock_count: If _lock_mode is true, a positive count of the number
55
of times the lock has been taken (and not yet released) *by this
56
process*, through this particular object instance.
57
:ivar _lock_mode: None, or 'r' or 'w'
60
def __init__(self, transport, lock_name, lock_class):
61
"""Create a LockableFiles group
63
:param transport: Transport pointing to the directory holding the
64
control files and lock.
65
:param lock_name: Name of the lock guarding these files.
66
:param lock_class: Class of lock strategy to use: typically
67
either LockDir or TransportLock.
69
self._transport = transport
70
self.lock_name = lock_name
71
self._transaction = None
72
self._lock_mode = None
75
esc_name = self._escape(lock_name)
76
self._lock = lock_class(transport, esc_name,
77
file_modebits=self._file_mode,
78
dir_modebits=self._dir_mode)
79
self._counted_lock = counted_lock.CountedLock(self._lock)
81
def create_lock(self):
84
This should normally be called only when the LockableFiles directory
85
is first created on disk.
87
self._lock.create(mode=self._dir_mode)
90
return '%s(%r)' % (self.__class__.__name__,
94
return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
97
"""Break the lock of this lockable files group if it is held.
99
The current ui factory will be used to prompt for user conformation.
101
self._lock.break_lock()
103
def _escape(self, file_or_path):
104
"""DEPRECATED: Do not use outside this class"""
105
if not isinstance(file_or_path, basestring):
106
file_or_path = '/'.join(file_or_path)
107
if file_or_path == '':
109
return urlutils.escape(osutils.safe_unicode(file_or_path))
111
def _find_modes(self):
112
"""Determine the appropriate modes for files and directories.
114
:deprecated: Replaced by BzrDir._find_creation_modes.
116
# XXX: The properties created by this can be removed or deprecated
117
# once all the _get_text_store methods etc no longer use them.
120
st = self._transport.stat('.')
121
except errors.TransportNotPossible:
122
self._dir_mode = 0755
123
self._file_mode = 0644
125
# Check the directory mode, but also make sure the created
126
# directories and files are read-write for this user. This is
127
# mostly a workaround for filesystems which lie about being able to
128
# write to a directory (cygwin & win32)
129
self._dir_mode = (st.st_mode & 07777) | 00700
130
# Remove the sticky and execute bits for files
131
self._file_mode = self._dir_mode & ~07111
133
def leave_in_place(self):
134
"""Set this LockableFiles to not clear the physical lock on unlock."""
135
self._lock.leave_in_place()
137
def dont_leave_in_place(self):
138
"""Set this LockableFiles to clear the physical lock on unlock."""
139
self._lock.dont_leave_in_place()
141
def lock_write(self, token=None):
142
"""Lock this group of files for writing.
144
:param token: if this is already locked, then lock_write will fail
145
unless the token matches the existing lock.
146
:returns: a token if this instance supports tokens, otherwise None.
147
:raises TokenLockingNotSupported: when a token is given but this
148
instance doesn't support using token locks.
149
:raises MismatchedToken: if the specified token doesn't match the token
150
of the existing lock.
152
A token should be passed in if you know that you have locked the object
153
some other way, and need to synchronise this object's state with that
157
if (self._lock_mode != 'w'
158
or not self.get_transaction().writeable()):
159
raise errors.ReadOnlyError(self)
160
self._lock.validate_token(token)
161
self._lock_count += 1
162
return self._token_from_lock
164
token_from_lock = self._lock.lock_write(token=token)
165
#traceback.print_stack()
166
self._lock_mode = 'w'
168
self._set_write_transaction()
169
self._token_from_lock = token_from_lock
170
return token_from_lock
174
if self._lock_mode not in ('r', 'w'):
175
raise ValueError("invalid lock mode %r" % (self._lock_mode,))
176
self._lock_count += 1
178
self._lock.lock_read()
179
#traceback.print_stack()
180
self._lock_mode = 'r'
182
self._set_read_transaction()
184
def _set_read_transaction(self):
185
"""Setup a read transaction."""
186
self._set_transaction(transactions.ReadOnlyTransaction())
187
# 5K may be excessive, but hey, its a knob.
188
self.get_transaction().set_cache_size(5000)
190
def _set_write_transaction(self):
191
"""Setup a write transaction."""
192
self._set_transaction(transactions.WriteTransaction())
194
@only_raises(errors.LockNotHeld, errors.LockBroken)
196
if not self._lock_mode:
197
return lock.cant_unlock_not_held(self)
198
if self._lock_count > 1:
199
self._lock_count -= 1
201
#traceback.print_stack()
202
self._finish_transaction()
206
self._lock_mode = self._lock_count = None
209
"""Return true if this LockableFiles group is locked"""
210
return self._lock_count >= 1
212
def get_physical_lock_status(self):
213
"""Return physical lock status.
215
Returns true if a lock is held on the transport. If no lock is held, or
216
the underlying locking mechanism does not support querying lock
217
status, false is returned.
220
return self._lock.peek() is not None
221
except NotImplementedError:
224
def get_transaction(self):
225
"""Return the current active transaction.
227
If no transaction is active, this returns a passthrough object
228
for which all data is immediately flushed and no caching happens.
230
if self._transaction is None:
231
return transactions.PassThroughTransaction()
233
return self._transaction
235
def _set_transaction(self, new_transaction):
236
"""Set a new active transaction."""
237
if self._transaction is not None:
238
raise errors.LockError('Branch %s is in a transaction already.' %
240
self._transaction = new_transaction
242
def _finish_transaction(self):
243
"""Exit the current transaction."""
244
if self._transaction is None:
245
raise errors.LockError('Branch %s is not in a transaction' %
247
transaction = self._transaction
248
self._transaction = None
252
class TransportLock(object):
253
"""Locking method which uses transport-dependent locks.
255
On the local filesystem these transform into OS-managed locks.
257
These do not guard against concurrent access via different
260
This is suitable for use only in WorkingTrees (which are at present
263
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
264
self._transport = transport
265
self._escaped_name = escaped_name
266
self._file_modebits = file_modebits
267
self._dir_modebits = dir_modebits
269
def break_lock(self):
270
raise NotImplementedError(self.break_lock)
272
def leave_in_place(self):
273
raise NotImplementedError(self.leave_in_place)
275
def dont_leave_in_place(self):
276
raise NotImplementedError(self.dont_leave_in_place)
278
def lock_write(self, token=None):
279
if token is not None:
280
raise errors.TokenLockingNotSupported(self)
281
self._lock = self._transport.lock_write(self._escaped_name)
284
self._lock = self._transport.lock_read(self._escaped_name)
291
raise NotImplementedError()
293
def create(self, mode=None):
294
"""Create lock mechanism"""
295
# for old-style locks, create the file now
296
self._transport.put_bytes(self._escaped_name, '',
297
mode=self._file_modebits)
299
def validate_token(self, token):
300
if token is not None:
301
raise errors.TokenLockingNotSupported(self)
added
removed
bzrlib/lockable_files.py
