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
self._dir_mode = st.st_mode & 07777
136
# Remove the sticky and execute bits for files
137
self._file_mode = self._dir_mode & ~07111
138
if not self._set_dir_mode:
139
self._dir_mode = None
140
if not self._set_file_mode:
141
self._file_mode = None
143
def controlfilename(self, file_or_path):
144
"""Return location relative to branch."""
145
return self._transport.abspath(self._escape(file_or_path))
147
@deprecated_method(zero_eight)
148
def controlfile(self, file_or_path, mode='r'):
149
"""Open a control file for this branch.
151
There are two classes of file in a lockable directory: text
152
and binary. binary files are untranslated byte streams. Text
153
control files are stored with Unix newlines and in UTF-8, even
154
if the platform or locale defaults are different.
156
Such files are not openable in write mode : they are managed via
157
put and put_utf8 which atomically replace old versions using
161
relpath = self._escape(file_or_path)
162
# TODO: codecs.open() buffers linewise, so it was overloaded with
163
# a much larger buffer, do we need to do the same for getreader/getwriter?
165
return self.get(relpath)
167
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
169
return self.get_utf8(relpath)
171
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
173
raise BzrError("invalid controlfile mode %r" % mode)
176
def get(self, relpath):
177
"""Get a file as a bytestream."""
178
relpath = self._escape(relpath)
179
return self._transport.get(relpath)
182
def get_utf8(self, relpath):
183
"""Get a file as a unicode stream."""
184
relpath = self._escape(relpath)
185
# DO NOT introduce an errors=replace here.
186
return codecs.getreader('utf-8')(self._transport.get(relpath))
189
def put(self, path, file):
192
:param path: The path to put the file, relative to the .bzr control
194
: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)
209
def put_utf8(self, path, a_string):
210
"""Write a string, encoding as utf-8.
212
: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.
215
# IterableFile would not be needed if Transport.put took iterables
216
# instead of files. ADHB 2005-12-25
217
# RBC 20060103 surely its not needed anyway, with codecs transcode
219
# JAM 20060103 We definitely don't want encode(..., 'replace')
220
# these are valuable files which should have exact contents.
221
if not isinstance(a_string, basestring):
222
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
# XXX: think about renaming this!
232
self._lock.dont_leave_in_place()
234
def lock_write(self, token=None):
235
"""Lock this group of files for writing.
237
:param token: if this is already locked, then lock_write will fail
238
unless the token matches the existing lock.
239
:returns: a token if this instance supports tokens, otherwise None.
240
:raises TokenLockingNotSupported: when a token is given but this
241
instance doesn't support using token locks.
242
:raises MismatchedToken: if the specified token doesn't match the token
243
of the existing lock.
245
# mutter("lock write: %s (%s)", self, self._lock_count)
246
# TODO: Upgrade locking to support using a Transport,
247
# and potentially a remote locking protocol
249
if self._lock_mode != 'w' or not self.get_transaction().writeable():
250
raise errors.ReadOnlyError(self)
251
self._lock.validate_token(token)
252
self._lock_count += 1
253
return self._token_from_lock
255
token_from_lock = self._lock.lock_write(token=token)
256
#note('write locking %s', self)
257
#traceback.print_stack()
258
self._lock_mode = 'w'
260
self._set_transaction(transactions.WriteTransaction())
261
# XXX: add test for the case that requires self._token_from_lock:
262
# token = x.lock_write(); assert(x.lock_write() == token)
263
self._token_from_lock = token_from_lock
264
return token_from_lock
267
# mutter("lock read: %s (%s)", self, self._lock_count)
269
assert self._lock_mode in ('r', 'w'), \
270
"invalid lock mode %r" % self._lock_mode
271
self._lock_count += 1
273
self._lock.lock_read()
274
#note('read locking %s', self)
275
#traceback.print_stack()
276
self._lock_mode = 'r'
278
self._set_transaction(transactions.ReadOnlyTransaction())
279
# 5K may be excessive, but hey, its a knob.
280
self.get_transaction().set_cache_size(5000)
283
# mutter("unlock: %s (%s)", self, self._lock_count)
284
if not self._lock_mode:
285
raise errors.LockNotHeld(self)
286
if self._lock_count > 1:
287
self._lock_count -= 1
289
#note('unlocking %s', self)
290
#traceback.print_stack()
291
self._finish_transaction()
295
self._lock_mode = self._lock_count = None
298
"""Return true if this LockableFiles group is locked"""
299
return self._lock_count >= 1
301
def get_physical_lock_status(self):
302
"""Return physical lock status.
304
Returns true if a lock is held on the transport. If no lock is held, or
305
the underlying locking mechanism does not support querying lock
306
status, false is returned.
309
return self._lock.peek() is not None
310
except NotImplementedError:
313
def get_transaction(self):
314
"""Return the current active transaction.
316
If no transaction is active, this returns a passthrough object
317
for which all data is immediately flushed and no caching happens.
319
if self._transaction is None:
320
return transactions.PassThroughTransaction()
322
return self._transaction
324
def _set_transaction(self, new_transaction):
325
"""Set a new active transaction."""
326
if self._transaction is not None:
327
raise errors.LockError('Branch %s is in a transaction already.' %
329
self._transaction = new_transaction
331
def _finish_transaction(self):
332
"""Exit the current transaction."""
333
if self._transaction is None:
334
raise errors.LockError('Branch %s is not in a transaction' %
336
transaction = self._transaction
337
self._transaction = None
341
class TransportLock(object):
342
"""Locking method which uses transport-dependent locks.
344
On the local filesystem these transform into OS-managed locks.
346
These do not guard against concurrent access via different
349
This is suitable for use only in WorkingTrees (which are at present
352
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
353
self._transport = transport
354
self._escaped_name = escaped_name
355
self._file_modebits = file_modebits
356
self._dir_modebits = dir_modebits
358
def break_lock(self):
359
raise NotImplementedError(self.break_lock)
361
def leave_in_place(self):
362
raise NotImplementedError(self.leave_in_place)
364
def dont_leave_in_place(self):
365
raise NotImplementedError(self.dont_leave_in_place)
367
def lock_write(self, token=None):
368
if token is not None:
369
raise errors.TokenLockingNotSupported(self)
370
self._lock = self._transport.lock_write(self._escaped_name)
373
self._lock = self._transport.lock_read(self._escaped_name)
380
raise NotImplementedError()
382
def create(self, mode=None):
383
"""Create lock mechanism"""
384
# for old-style locks, create the file now
385
self._transport.put_bytes(self._escaped_name, '',
386
mode=self._file_modebits)
388
def validate_token(self, token):
389
if token is not None:
390
raise errors.TokenLockingNotSupported(self)
added
removed
bzrlib/lockable_files.py
