1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006 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
21
from bzrlib.decorators import *
22
from bzrlib.decorators import (needs_read_lock,
22
24
import bzrlib.errors as errors
23
from bzrlib.errors import LockError, ReadOnlyError
25
from bzrlib.errors import BzrError
24
26
from bzrlib.osutils import file_iterator, safe_unicode
25
from bzrlib.symbol_versioning import *
26
from bzrlib.symbol_versioning import deprecated_method, zero_eight
27
from bzrlib.trace import mutter
27
from bzrlib.symbol_versioning import (deprecated_method,
29
from bzrlib.trace import mutter, note
28
30
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.
31
38
class LockableFiles(object):
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.
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.
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*.
49
66
# If set to False (by a plugin, etc) BzrBranch will not set the
50
67
# mode on created files or directories
51
68
_set_file_mode = True
52
69
_set_dir_mode = True
54
def __init__(self, transport, lock_name):
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.
56
80
self._transport = transport
57
81
self.lock_name = lock_name
58
82
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)
61
105
def __del__(self):
62
if self._lock_mode or self._lock:
63
107
# XXX: This should show something every time, and be suitable for
64
108
# headless operation and embedding
65
109
from warnings import warn
66
110
warn("file group %r was not explicitly unlocked" % self)
67
111
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()
69
120
def _escape(self, file_or_path):
70
121
if not isinstance(file_or_path, basestring):
71
122
file_or_path = '/'.join(file_or_path)
72
123
if file_or_path == '':
74
return bzrlib.transport.urlescape(safe_unicode(file_or_path))
125
return urlutils.escape(safe_unicode(file_or_path))
76
127
def _find_modes(self):
77
128
"""Determine the appropriate modes for files and directories."""
80
st = self._transport.stat('.')
81
except errors.NoSuchFile:
82
# The .bzr/ directory doesn't exist, try to
83
# inherit the permissions from the parent directory
84
# but only try 1 level up
85
temp_transport = self._transport.clone('..')
86
st = temp_transport.stat('.')
87
except (errors.TransportNotPossible, errors.NoSuchFile):
130
st = self._transport.stat('.')
131
except errors.TransportNotPossible:
88
132
self._dir_mode = 0755
89
133
self._file_mode = 0644
100
144
"""Return location relative to branch."""
101
145
return self._transport.abspath(self._escape(file_or_path))
103
@deprecated_method(zero_eight)
104
def controlfile(self, file_or_path, mode='r'):
105
"""Open a control file for this branch.
107
There are two classes of file in a lockable directory: text
108
and binary. binary files are untranslated byte streams. Text
109
control files are stored with Unix newlines and in UTF-8, even
110
if the platform or locale defaults are different.
112
Such files are not openable in write mode : they are managed via
113
put and put_utf8 which atomically replace old versions using
117
relpath = self._escape(file_or_path)
118
#TODO: codecs.open() buffers linewise, so it was overloaded with
119
# a much larger buffer, do we need to do the same for getreader/getwriter?
121
return self.get(relpath)
123
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
125
return self.get_utf8(relpath)
127
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
129
raise BzrError("invalid controlfile mode %r" % mode)
132
148
def get(self, relpath):
133
149
"""Get a file as a bytestream."""
150
166
:param f: A file-like or string object whose contents should be copied.
152
self._transport.put(self._escape(path), file, mode=self._file_mode)
168
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
171
def put_bytes(self, path, a_string):
172
"""Write a string of bytes.
174
:param path: The path to put the bytes, relative to the transport root.
175
:param string: A string object, whose exact bytes are to be copied.
177
self._transport.put_bytes(self._escape(path), a_string,
178
mode=self._file_mode)
154
180
@needs_write_lock
155
181
def put_utf8(self, path, a_string):
156
182
"""Write a string, encoding as utf-8.
158
184
:param path: The path to put the string, relative to the transport root.
159
:param string: A file-like or string object whose contents should be copied.
185
:param string: A string or unicode object whose contents should be copied.
161
187
# IterableFile would not be needed if Transport.put took iterables
162
188
# instead of files. ADHB 2005-12-25
166
192
# these are valuable files which should have exact contents.
167
193
if not isinstance(a_string, basestring):
168
194
raise errors.BzrBadParameterNotString(a_string)
169
self.put(path, StringIO(a_string.encode('utf-8')))
171
def lock_write(self):
172
mutter("lock write: %s (%s)", self, self._lock_count)
195
self.put_bytes(path, a_string.encode('utf-8'))
197
def leave_in_place(self):
198
"""Set this LockableFiles to not clear the physical lock on unlock."""
199
self._lock.leave_in_place()
201
def dont_leave_in_place(self):
202
"""Set this LockableFiles to clear the physical lock on unlock."""
203
self._lock.dont_leave_in_place()
205
def lock_write(self, token=None):
206
"""Lock this group of files for writing.
208
:param token: if this is already locked, then lock_write will fail
209
unless the token matches the existing lock.
210
:returns: a token if this instance supports tokens, otherwise None.
211
:raises TokenLockingNotSupported: when a token is given but this
212
instance doesn't support using token locks.
213
:raises MismatchedToken: if the specified token doesn't match the token
214
of the existing lock.
216
A token should be passed in if you know that you have locked the object
217
some other way, and need to synchronise this object's state with that
220
# mutter("lock write: %s (%s)", self, self._lock_count)
173
221
# TODO: Upgrade locking to support using a Transport,
174
222
# and potentially a remote locking protocol
175
223
if self._lock_mode:
176
if self._lock_mode != 'w':
177
raise ReadOnlyError("can't upgrade to a write lock from %r" %
224
if self._lock_mode != 'w' or not self.get_transaction().writeable():
225
raise errors.ReadOnlyError(self)
226
self._lock.validate_token(token)
179
227
self._lock_count += 1
228
return self._token_from_lock
181
self._lock = self._transport.lock_write(
182
self._escape(self.lock_name))
230
token_from_lock = self._lock.lock_write(token=token)
231
#note('write locking %s', self)
232
#traceback.print_stack()
183
233
self._lock_mode = 'w'
184
234
self._lock_count = 1
185
self._set_transaction(transactions.PassThroughTransaction())
235
self._set_transaction(transactions.WriteTransaction())
236
self._token_from_lock = token_from_lock
237
return token_from_lock
187
239
def lock_read(self):
188
mutter("lock read: %s (%s)", self, self._lock_count)
240
# mutter("lock read: %s (%s)", self, self._lock_count)
189
241
if self._lock_mode:
190
242
assert self._lock_mode in ('r', 'w'), \
191
243
"invalid lock mode %r" % self._lock_mode
192
244
self._lock_count += 1
194
self._lock = self._transport.lock_read(
195
self._escape(self.lock_name))
246
self._lock.lock_read()
247
#note('read locking %s', self)
248
#traceback.print_stack()
196
249
self._lock_mode = 'r'
197
250
self._lock_count = 1
198
251
self._set_transaction(transactions.ReadOnlyTransaction())
200
253
self.get_transaction().set_cache_size(5000)
202
255
def unlock(self):
203
mutter("unlock: %s (%s)", self, self._lock_count)
256
# mutter("unlock: %s (%s)", self, self._lock_count)
204
257
if not self._lock_mode:
205
raise LockError('branch %r is not locked' % (self))
258
raise errors.LockNotHeld(self)
207
259
if self._lock_count > 1:
208
260
self._lock_count -= 1
262
#note('unlocking %s', self)
263
#traceback.print_stack()
210
264
self._finish_transaction()
213
self._lock_mode = self._lock_count = None
268
self._lock_mode = self._lock_count = None
271
"""Return true if this LockableFiles group is locked"""
272
return self._lock_count >= 1
274
def get_physical_lock_status(self):
275
"""Return physical lock status.
277
Returns true if a lock is held on the transport. If no lock is held, or
278
the underlying locking mechanism does not support querying lock
279
status, false is returned.
282
return self._lock.peek() is not None
283
except NotImplementedError:
215
286
def get_transaction(self):
216
287
"""Return the current active transaction.
238
309
transaction = self._transaction
239
310
self._transaction = None
240
311
transaction.finish()
314
class TransportLock(object):
315
"""Locking method which uses transport-dependent locks.
317
On the local filesystem these transform into OS-managed locks.
319
These do not guard against concurrent access via different
322
This is suitable for use only in WorkingTrees (which are at present
325
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
326
self._transport = transport
327
self._escaped_name = escaped_name
328
self._file_modebits = file_modebits
329
self._dir_modebits = dir_modebits
331
def break_lock(self):
332
raise NotImplementedError(self.break_lock)
334
def leave_in_place(self):
335
raise NotImplementedError(self.leave_in_place)
337
def dont_leave_in_place(self):
338
raise NotImplementedError(self.dont_leave_in_place)
340
def lock_write(self, token=None):
341
if token is not None:
342
raise errors.TokenLockingNotSupported(self)
343
self._lock = self._transport.lock_write(self._escaped_name)
346
self._lock = self._transport.lock_read(self._escaped_name)
353
raise NotImplementedError()
355
def create(self, mode=None):
356
"""Create lock mechanism"""
357
# for old-style locks, create the file now
358
self._transport.put_bytes(self._escaped_name, '',
359
mode=self._file_modebits)
361
def validate_token(self, token):
362
if token is not None:
363
raise errors.TokenLockingNotSupported(self)
added
removed
bzrlib/lockable_files.py
