1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005 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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
from cStringIO import StringIO
22
from bzrlib.decorators import (needs_read_lock,
21
from bzrlib.decorators import *
24
22
import bzrlib.errors as errors
25
from bzrlib.errors import BzrError
23
from bzrlib.errors import LockError, ReadOnlyError
26
24
from bzrlib.osutils import file_iterator, safe_unicode
27
from bzrlib.symbol_versioning import (deprecated_method,
29
from bzrlib.trace import mutter, note
25
from bzrlib.symbol_versioning import *
26
from bzrlib.symbol_versioning import deprecated_method, zero_eight
27
from bzrlib.trace import mutter
30
28
import bzrlib.transactions as transactions
31
import bzrlib.urlutils as urlutils
34
# XXX: The tracking here of lock counts and whether the lock is held is
35
# somewhat redundant with what's done in LockDir; the main difference is that
36
# LockableFiles permits reentrancy.
38
31
class LockableFiles(object):
39
"""Object representing a set of related files locked within the same scope.
41
These files are used by a WorkingTree, Repository or Branch, and should
42
generally only be touched by that object.
44
LockableFiles also provides some policy on top of Transport for encoding
45
control files as utf-8.
47
LockableFiles manage a lock count and can be locked repeatedly by
48
a single caller. (The underlying lock implementation generally does not
51
Instances of this class are often called control_files.
53
This object builds on top of a Transport, which is used to actually write
54
the files to disk, and an OSLock or LockDir, which controls how access to
55
the files is controlled. The particular type of locking used is set when
56
the object is constructed. In older formats OSLocks are used everywhere.
57
in newer formats a LockDir is used for Repositories and Branches, and
58
OSLocks for the local filesystem.
32
"""Object representing a set of files locked within the same scope
38
If _lock_mode is true, a positive count of the number of times the
39
lock has been taken *by this process*. Others may have compatible
43
Lock object from bzrlib.lock.
61
# _lock_mode: None, or 'r' or 'w'
63
# _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
49
# If set to False (by a plugin, etc) BzrBranch will not set the
67
50
# mode on created files or directories
68
51
_set_file_mode = True
69
52
_set_dir_mode = True
71
def __init__(self, transport, lock_name, lock_class):
72
"""Create a LockableFiles group
74
:param transport: Transport pointing to the directory holding the
75
control files and lock.
76
:param lock_name: Name of the lock guarding these files.
77
:param lock_class: Class of lock strategy to use: typically
78
either LockDir or TransportLock.
54
def __init__(self, transport, lock_name):
80
56
self._transport = transport
81
57
self.lock_name = lock_name
82
58
self._transaction = None
83
self._lock_mode = None
86
esc_name = self._escape(lock_name)
87
self._lock = lock_class(transport, esc_name,
88
file_modebits=self._file_mode,
89
dir_modebits=self._dir_mode)
91
def create_lock(self):
94
This should normally be called only when the LockableFiles directory
95
is first created on disk.
97
self._lock.create(mode=self._dir_mode)
100
return '%s(%r)' % (self.__class__.__name__,
103
return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
105
61
def __del__(self):
62
if self._lock_mode or self._lock:
107
63
# XXX: This should show something every time, and be suitable for
108
64
# headless operation and embedding
109
65
from warnings import warn
110
66
warn("file group %r was not explicitly unlocked" % self)
111
67
self._lock.unlock()
113
def break_lock(self):
114
"""Break the lock of this lockable files group if it is held.
116
The current ui factory will be used to prompt for user conformation.
118
self._lock.break_lock()
120
69
def _escape(self, file_or_path):
121
70
if not isinstance(file_or_path, basestring):
122
71
file_or_path = '/'.join(file_or_path)
123
72
if file_or_path == '':
125
return urlutils.escape(safe_unicode(file_or_path))
74
return bzrlib.transport.urlescape(safe_unicode(file_or_path))
127
76
def _find_modes(self):
128
77
"""Determine the appropriate modes for files and directories."""
194
143
:param f: A file-like or string object whose contents should be copied.
196
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
199
def put_bytes(self, path, a_string):
200
"""Write a string of bytes.
202
:param path: The path to put the bytes, relative to the transport root.
203
:param string: A string object, whose exact bytes are to be copied.
205
self._transport.put_bytes(self._escape(path), a_string,
206
mode=self._file_mode)
145
self._transport.put(self._escape(path), file, mode=self._file_mode)
208
147
@needs_write_lock
209
148
def put_utf8(self, path, a_string):
210
149
"""Write a string, encoding as utf-8.
212
151
:param path: The path to put the string, relative to the transport root.
213
:param string: A string or unicode object whose contents should be copied.
152
:param string: A file-like or string object whose contents should be copied.
215
154
# IterableFile would not be needed if Transport.put took iterables
216
155
# instead of files. ADHB 2005-12-25
220
159
# these are valuable files which should have exact contents.
221
160
if not isinstance(a_string, basestring):
222
161
raise errors.BzrBadParameterNotString(a_string)
223
self.put_bytes(path, a_string.encode('utf-8'))
225
def leave_in_place(self):
226
"""Set this LockableFiles to not clear the physical lock on unlock."""
227
self._lock.leave_in_place()
229
def dont_leave_in_place(self):
230
"""Set this LockableFiles to clear the physical lock on unlock."""
231
self._lock.dont_leave_in_place()
233
def lock_write(self, token=None):
234
"""Lock this group of files for writing.
236
:param token: if this is already locked, then lock_write will fail
237
unless the token matches the existing lock.
238
:returns: a token if this instance supports tokens, otherwise None.
239
:raises TokenLockingNotSupported: when a token is given but this
240
instance doesn't support using token locks.
241
:raises MismatchedToken: if the specified token doesn't match the token
242
of the existing lock.
244
A token should be passed in if you know that you have locked the object
245
some other way, and need to synchronise this object's state with that
248
# mutter("lock write: %s (%s)", self, self._lock_count)
162
self.put(path, StringIO(a_string.encode('utf-8')))
164
def lock_write(self):
165
mutter("lock write: %s (%s)", self, self._lock_count)
249
166
# TODO: Upgrade locking to support using a Transport,
250
167
# and potentially a remote locking protocol
251
168
if self._lock_mode:
252
if self._lock_mode != 'w' or not self.get_transaction().writeable():
253
raise errors.ReadOnlyError(self)
254
self._lock.validate_token(token)
169
if self._lock_mode != 'w':
170
raise ReadOnlyError("can't upgrade to a write lock from %r" %
255
172
self._lock_count += 1
256
return self._token_from_lock
258
token_from_lock = self._lock.lock_write(token=token)
259
#note('write locking %s', self)
260
#traceback.print_stack()
174
self._lock = self._transport.lock_write(
175
self._escape(self.lock_name))
261
176
self._lock_mode = 'w'
262
177
self._lock_count = 1
263
self._set_transaction(transactions.WriteTransaction())
264
self._token_from_lock = token_from_lock
265
return token_from_lock
178
self._set_transaction(transactions.PassThroughTransaction())
267
180
def lock_read(self):
268
# mutter("lock read: %s (%s)", self, self._lock_count)
181
mutter("lock read: %s (%s)", self, self._lock_count)
269
182
if self._lock_mode:
270
183
assert self._lock_mode in ('r', 'w'), \
271
184
"invalid lock mode %r" % self._lock_mode
272
185
self._lock_count += 1
274
self._lock.lock_read()
275
#note('read locking %s', self)
276
#traceback.print_stack()
187
self._lock = self._transport.lock_read(
188
self._escape(self.lock_name))
277
189
self._lock_mode = 'r'
278
190
self._lock_count = 1
279
191
self._set_transaction(transactions.ReadOnlyTransaction())
281
193
self.get_transaction().set_cache_size(5000)
283
195
def unlock(self):
284
# mutter("unlock: %s (%s)", self, self._lock_count)
196
mutter("unlock: %s (%s)", self, self._lock_count)
285
197
if not self._lock_mode:
286
raise errors.LockNotHeld(self)
198
raise LockError('branch %r is not locked' % (self))
287
200
if self._lock_count > 1:
288
201
self._lock_count -= 1
290
#note('unlocking %s', self)
291
#traceback.print_stack()
292
203
self._finish_transaction()
296
self._lock_mode = self._lock_count = None
299
"""Return true if this LockableFiles group is locked"""
300
return self._lock_count >= 1
302
def get_physical_lock_status(self):
303
"""Return physical lock status.
305
Returns true if a lock is held on the transport. If no lock is held, or
306
the underlying locking mechanism does not support querying lock
307
status, false is returned.
310
return self._lock.peek() is not None
311
except NotImplementedError:
206
self._lock_mode = self._lock_count = None
314
208
def get_transaction(self):
315
209
"""Return the current active transaction.
337
231
transaction = self._transaction
338
232
self._transaction = None
339
233
transaction.finish()
342
class TransportLock(object):
343
"""Locking method which uses transport-dependent locks.
345
On the local filesystem these transform into OS-managed locks.
347
These do not guard against concurrent access via different
350
This is suitable for use only in WorkingTrees (which are at present
353
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
354
self._transport = transport
355
self._escaped_name = escaped_name
356
self._file_modebits = file_modebits
357
self._dir_modebits = dir_modebits
359
def break_lock(self):
360
raise NotImplementedError(self.break_lock)
362
def leave_in_place(self):
363
raise NotImplementedError(self.leave_in_place)
365
def dont_leave_in_place(self):
366
raise NotImplementedError(self.dont_leave_in_place)
368
def lock_write(self, token=None):
369
if token is not None:
370
raise errors.TokenLockingNotSupported(self)
371
self._lock = self._transport.lock_write(self._escaped_name)
374
self._lock = self._transport.lock_read(self._escaped_name)
381
raise NotImplementedError()
383
def create(self, mode=None):
384
"""Create lock mechanism"""
385
# for old-style locks, create the file now
386
self._transport.put_bytes(self._escaped_name, '',
387
mode=self._file_modebits)
389
def validate_token(self, token):
390
if token is not None:
391
raise errors.TokenLockingNotSupported(self)
added
removed
bzrlib/lockable_files.py
