1
# Copyright (C) 2005, 2006 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
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
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
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.
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
# If set to False (by a plugin, etc) BzrBranch will not set the
67
# mode on created files or directories
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.
80
self._transport = transport
81
self.lock_name = lock_name
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)
107
# XXX: This should show something every time, and be suitable for
108
# headless operation and embedding
109
from warnings import warn
110
warn("file group %r was not explicitly unlocked" % self)
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
def _escape(self, file_or_path):
121
if not isinstance(file_or_path, basestring):
122
file_or_path = '/'.join(file_or_path)
123
if file_or_path == '':
125
return urlutils.escape(safe_unicode(file_or_path))
127
def _find_modes(self):
128
"""Determine the appropriate modes for files and directories."""
130
st = self._transport.stat('.')
131
except errors.TransportNotPossible:
132
self._dir_mode = 0755
133
self._file_mode = 0644
135
# Check the directory mode, but also make sure the created
136
# directories and files are read-write for this user. This is
137
# mostly a workaround for filesystems which lie about being able to
138
# write to a directory (cygwin & win32)
139
self._dir_mode = (st.st_mode & 07777) | 00700
140
# Remove the sticky and execute bits for files
141
self._file_mode = self._dir_mode & ~07111
142
if not self._set_dir_mode:
143
self._dir_mode = None
144
if not self._set_file_mode:
145
self._file_mode = None
147
def controlfilename(self, file_or_path):
148
"""Return location relative to branch."""
149
return self._transport.abspath(self._escape(file_or_path))
152
def get(self, relpath):
153
"""Get a file as a bytestream."""
154
relpath = self._escape(relpath)
155
return self._transport.get(relpath)
158
def get_utf8(self, relpath):
159
"""Get a file as a unicode stream."""
160
relpath = self._escape(relpath)
161
# DO NOT introduce an errors=replace here.
162
return codecs.getreader('utf-8')(self._transport.get(relpath))
165
def put(self, path, file):
168
:param path: The path to put the file, relative to the .bzr control
170
:param f: A file-like or string object whose contents should be copied.
172
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
175
def put_bytes(self, path, a_string):
176
"""Write a string of bytes.
178
:param path: The path to put the bytes, relative to the transport root.
179
:param string: A string object, whose exact bytes are to be copied.
181
self._transport.put_bytes(self._escape(path), a_string,
182
mode=self._file_mode)
185
def put_utf8(self, path, a_string):
186
"""Write a string, encoding as utf-8.
188
:param path: The path to put the string, relative to the transport root.
189
:param string: A string or unicode object whose contents should be copied.
191
# IterableFile would not be needed if Transport.put took iterables
192
# instead of files. ADHB 2005-12-25
193
# RBC 20060103 surely its not needed anyway, with codecs transcode
195
# JAM 20060103 We definitely don't want encode(..., 'replace')
196
# these are valuable files which should have exact contents.
197
if not isinstance(a_string, basestring):
198
raise errors.BzrBadParameterNotString(a_string)
199
self.put_bytes(path, a_string.encode('utf-8'))
201
def leave_in_place(self):
202
"""Set this LockableFiles to not clear the physical lock on unlock."""
203
self._lock.leave_in_place()
205
def dont_leave_in_place(self):
206
"""Set this LockableFiles to clear the physical lock on unlock."""
207
self._lock.dont_leave_in_place()
209
def lock_write(self, token=None):
210
"""Lock this group of files for writing.
212
:param token: if this is already locked, then lock_write will fail
213
unless the token matches the existing lock.
214
:returns: a token if this instance supports tokens, otherwise None.
215
:raises TokenLockingNotSupported: when a token is given but this
216
instance doesn't support using token locks.
217
:raises MismatchedToken: if the specified token doesn't match the token
218
of the existing lock.
220
A token should be passed in if you know that you have locked the object
221
some other way, and need to synchronise this object's state with that
224
# mutter("lock write: %s (%s)", self, self._lock_count)
225
# TODO: Upgrade locking to support using a Transport,
226
# and potentially a remote locking protocol
228
if self._lock_mode != 'w' or not self.get_transaction().writeable():
229
raise errors.ReadOnlyError(self)
230
self._lock.validate_token(token)
231
self._lock_count += 1
232
return self._token_from_lock
234
token_from_lock = self._lock.lock_write(token=token)
235
#note('write locking %s', self)
236
#traceback.print_stack()
237
self._lock_mode = 'w'
239
self._set_transaction(transactions.WriteTransaction())
240
self._token_from_lock = token_from_lock
241
return token_from_lock
244
# mutter("lock read: %s (%s)", self, self._lock_count)
246
assert self._lock_mode in ('r', 'w'), \
247
"invalid lock mode %r" % self._lock_mode
248
self._lock_count += 1
250
self._lock.lock_read()
251
#note('read locking %s', self)
252
#traceback.print_stack()
253
self._lock_mode = 'r'
255
self._set_transaction(transactions.ReadOnlyTransaction())
256
# 5K may be excessive, but hey, its a knob.
257
self.get_transaction().set_cache_size(5000)
260
# mutter("unlock: %s (%s)", self, self._lock_count)
261
if not self._lock_mode:
262
raise errors.LockNotHeld(self)
263
if self._lock_count > 1:
264
self._lock_count -= 1
266
#note('unlocking %s', self)
267
#traceback.print_stack()
268
self._finish_transaction()
272
self._lock_mode = self._lock_count = None
275
"""Return true if this LockableFiles group is locked"""
276
return self._lock_count >= 1
278
def get_physical_lock_status(self):
279
"""Return physical lock status.
281
Returns true if a lock is held on the transport. If no lock is held, or
282
the underlying locking mechanism does not support querying lock
283
status, false is returned.
286
return self._lock.peek() is not None
287
except NotImplementedError:
290
def get_transaction(self):
291
"""Return the current active transaction.
293
If no transaction is active, this returns a passthrough object
294
for which all data is immediately flushed and no caching happens.
296
if self._transaction is None:
297
return transactions.PassThroughTransaction()
299
return self._transaction
301
def _set_transaction(self, new_transaction):
302
"""Set a new active transaction."""
303
if self._transaction is not None:
304
raise errors.LockError('Branch %s is in a transaction already.' %
306
self._transaction = new_transaction
308
def _finish_transaction(self):
309
"""Exit the current transaction."""
310
if self._transaction is None:
311
raise errors.LockError('Branch %s is not in a transaction' %
313
transaction = self._transaction
314
self._transaction = None
318
class TransportLock(object):
319
"""Locking method which uses transport-dependent locks.
321
On the local filesystem these transform into OS-managed locks.
323
These do not guard against concurrent access via different
326
This is suitable for use only in WorkingTrees (which are at present
329
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
330
self._transport = transport
331
self._escaped_name = escaped_name
332
self._file_modebits = file_modebits
333
self._dir_modebits = dir_modebits
335
def break_lock(self):
336
raise NotImplementedError(self.break_lock)
338
def leave_in_place(self):
339
raise NotImplementedError(self.leave_in_place)
341
def dont_leave_in_place(self):
342
raise NotImplementedError(self.dont_leave_in_place)
344
def lock_write(self, token=None):
345
if token is not None:
346
raise errors.TokenLockingNotSupported(self)
347
self._lock = self._transport.lock_write(self._escaped_name)
350
self._lock = self._transport.lock_read(self._escaped_name)
357
raise NotImplementedError()
359
def create(self, mode=None):
360
"""Create lock mechanism"""
361
# for old-style locks, create the file now
362
self._transport.put_bytes(self._escaped_name, '',
363
mode=self._file_modebits)
365
def validate_token(self, token):
366
if token is not None:
367
raise errors.TokenLockingNotSupported(self)
added
removed
bzrlib/lockable_files.py
