1
# Copyright (C) 2005, 2006, 2008 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
20
from warnings import warn
23
from bzrlib.decorators import (needs_read_lock,
25
import bzrlib.errors as errors
26
from bzrlib.errors import BzrError
27
from bzrlib.osutils import file_iterator, safe_unicode
28
from bzrlib.symbol_versioning import (
32
from bzrlib.trace import mutter, note
33
import bzrlib.transactions as transactions
34
import bzrlib.urlutils as urlutils
37
# XXX: The tracking here of lock counts and whether the lock is held is
38
# somewhat redundant with what's done in LockDir; the main difference is that
39
# LockableFiles permits reentrancy.
41
class LockableFiles(object):
42
"""Object representing a set of related files locked within the same scope.
44
These files are used by a WorkingTree, Repository or Branch, and should
45
generally only be touched by that object.
47
LockableFiles also provides some policy on top of Transport for encoding
48
control files as utf-8.
50
LockableFiles manage a lock count and can be locked repeatedly by
51
a single caller. (The underlying lock implementation generally does not
54
Instances of this class are often called control_files.
56
This object builds on top of a Transport, which is used to actually write
57
the files to disk, and an OSLock or LockDir, which controls how access to
58
the files is controlled. The particular type of locking used is set when
59
the object is constructed. In older formats OSLocks are used everywhere.
60
in newer formats a LockDir is used for Repositories and Branches, and
61
OSLocks for the local filesystem.
64
# _lock_mode: None, or 'r' or 'w'
66
# _lock_count: If _lock_mode is true, a positive count of the number of
67
# times the lock has been taken *by this process*.
69
# If set to False (by a plugin, etc) BzrBranch will not set the
70
# mode on created files or directories
74
def __init__(self, transport, lock_name, lock_class):
75
"""Create a LockableFiles group
77
:param transport: Transport pointing to the directory holding the
78
control files and lock.
79
:param lock_name: Name of the lock guarding these files.
80
:param lock_class: Class of lock strategy to use: typically
81
either LockDir or TransportLock.
83
self._transport = transport
84
self.lock_name = lock_name
85
self._transaction = None
86
self._lock_mode = None
89
esc_name = self._escape(lock_name)
90
self._lock = lock_class(transport, esc_name,
91
file_modebits=self._file_mode,
92
dir_modebits=self._dir_mode)
94
def create_lock(self):
97
This should normally be called only when the LockableFiles directory
98
is first created on disk.
100
self._lock.create(mode=self._dir_mode)
103
return '%s(%r)' % (self.__class__.__name__,
106
return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
110
# do not automatically unlock; there should have been a
111
# try/finally to unlock this.
112
warn("%r was gc'd while locked" % self)
114
def break_lock(self):
115
"""Break the lock of this lockable files group if it is held.
117
The current ui factory will be used to prompt for user conformation.
119
self._lock.break_lock()
121
def _escape(self, file_or_path):
122
if not isinstance(file_or_path, basestring):
123
file_or_path = '/'.join(file_or_path)
124
if file_or_path == '':
126
return urlutils.escape(safe_unicode(file_or_path))
128
def _find_modes(self):
129
"""Determine the appropriate modes for files and directories."""
131
st = self._transport.stat('.')
132
except errors.TransportNotPossible:
133
self._dir_mode = 0755
134
self._file_mode = 0644
136
# Check the directory mode, but also make sure the created
137
# directories and files are read-write for this user. This is
138
# mostly a workaround for filesystems which lie about being able to
139
# write to a directory (cygwin & win32)
140
self._dir_mode = (st.st_mode & 07777) | 00700
141
# Remove the sticky and execute bits for files
142
self._file_mode = self._dir_mode & ~07111
143
if not self._set_dir_mode:
144
self._dir_mode = None
145
if not self._set_file_mode:
146
self._file_mode = None
148
def controlfilename(self, file_or_path):
149
"""Return location relative to branch."""
150
return self._transport.abspath(self._escape(file_or_path))
153
@deprecated_method(deprecated_in((1, 5, 0)))
154
def get(self, relpath):
155
"""Get a file as a bytestream.
157
:deprecated: Use a Transport instead of LockableFiles.
159
relpath = self._escape(relpath)
160
return self._transport.get(relpath)
163
@deprecated_method(deprecated_in((1, 5, 0)))
164
def get_utf8(self, relpath):
165
"""Get a file as a unicode stream.
167
:deprecated: Use a Transport instead of LockableFiles.
169
relpath = self._escape(relpath)
170
# DO NOT introduce an errors=replace here.
171
return codecs.getreader('utf-8')(self._transport.get(relpath))
174
@deprecated_method(deprecated_in((1, 6, 0)))
175
def put(self, path, file):
178
:param path: The path to put the file, relative to the .bzr control
180
:param file: A file-like or string object whose contents should be copied.
182
:deprecated: Use Transport methods instead.
184
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
187
@deprecated_method(deprecated_in((1, 6, 0)))
188
def put_bytes(self, path, a_string):
189
"""Write a string of bytes.
191
:param path: The path to put the bytes, relative to the transport root.
192
:param a_string: A string object, whose exact bytes are to be copied.
194
:deprecated: Use Transport methods instead.
196
self._transport.put_bytes(self._escape(path), a_string,
197
mode=self._file_mode)
200
@deprecated_method(deprecated_in((1, 6, 0)))
201
def put_utf8(self, path, a_string):
202
"""Write a string, encoding as utf-8.
204
:param path: The path to put the string, relative to the transport root.
205
:param string: A string or unicode object whose contents should be copied.
207
:deprecated: Use Transport methods instead.
209
# IterableFile would not be needed if Transport.put took iterables
210
# instead of files. ADHB 2005-12-25
211
# RBC 20060103 surely its not needed anyway, with codecs transcode
213
# JAM 20060103 We definitely don't want encode(..., 'replace')
214
# these are valuable files which should have exact contents.
215
if not isinstance(a_string, basestring):
216
raise errors.BzrBadParameterNotString(a_string)
217
self.put_bytes(path, a_string.encode('utf-8'))
219
def leave_in_place(self):
220
"""Set this LockableFiles to not clear the physical lock on unlock."""
221
self._lock.leave_in_place()
223
def dont_leave_in_place(self):
224
"""Set this LockableFiles to clear the physical lock on unlock."""
225
self._lock.dont_leave_in_place()
227
def lock_write(self, token=None):
228
"""Lock this group of files for writing.
230
:param token: if this is already locked, then lock_write will fail
231
unless the token matches the existing lock.
232
:returns: a token if this instance supports tokens, otherwise None.
233
:raises TokenLockingNotSupported: when a token is given but this
234
instance doesn't support using token locks.
235
:raises MismatchedToken: if the specified token doesn't match the token
236
of the existing lock.
238
A token should be passed in if you know that you have locked the object
239
some other way, and need to synchronise this object's state with that
242
# mutter("lock write: %s (%s)", self, self._lock_count)
243
# TODO: Upgrade locking to support using a Transport,
244
# and potentially a remote locking protocol
246
if self._lock_mode != 'w' or not self.get_transaction().writeable():
247
raise errors.ReadOnlyError(self)
248
self._lock.validate_token(token)
249
self._lock_count += 1
250
return self._token_from_lock
252
token_from_lock = self._lock.lock_write(token=token)
253
#note('write locking %s', self)
254
#traceback.print_stack()
255
self._lock_mode = 'w'
257
self._set_transaction(transactions.WriteTransaction())
258
self._token_from_lock = token_from_lock
259
return token_from_lock
262
# mutter("lock read: %s (%s)", self, self._lock_count)
264
assert self._lock_mode in ('r', 'w'), \
265
"invalid lock mode %r" % self._lock_mode
266
self._lock_count += 1
268
self._lock.lock_read()
269
#note('read locking %s', self)
270
#traceback.print_stack()
271
self._lock_mode = 'r'
273
self._set_transaction(transactions.ReadOnlyTransaction())
274
# 5K may be excessive, but hey, its a knob.
275
self.get_transaction().set_cache_size(5000)
278
# mutter("unlock: %s (%s)", self, self._lock_count)
279
if not self._lock_mode:
280
raise errors.LockNotHeld(self)
281
if self._lock_count > 1:
282
self._lock_count -= 1
284
#note('unlocking %s', self)
285
#traceback.print_stack()
286
self._finish_transaction()
290
self._lock_mode = self._lock_count = None
293
"""Return true if this LockableFiles group is locked"""
294
return self._lock_count >= 1
296
def get_physical_lock_status(self):
297
"""Return physical lock status.
299
Returns true if a lock is held on the transport. If no lock is held, or
300
the underlying locking mechanism does not support querying lock
301
status, false is returned.
304
return self._lock.peek() is not None
305
except NotImplementedError:
308
def get_transaction(self):
309
"""Return the current active transaction.
311
If no transaction is active, this returns a passthrough object
312
for which all data is immediately flushed and no caching happens.
314
if self._transaction is None:
315
return transactions.PassThroughTransaction()
317
return self._transaction
319
def _set_transaction(self, new_transaction):
320
"""Set a new active transaction."""
321
if self._transaction is not None:
322
raise errors.LockError('Branch %s is in a transaction already.' %
324
self._transaction = new_transaction
326
def _finish_transaction(self):
327
"""Exit the current transaction."""
328
if self._transaction is None:
329
raise errors.LockError('Branch %s is not in a transaction' %
331
transaction = self._transaction
332
self._transaction = None
336
class TransportLock(object):
337
"""Locking method which uses transport-dependent locks.
339
On the local filesystem these transform into OS-managed locks.
341
These do not guard against concurrent access via different
344
This is suitable for use only in WorkingTrees (which are at present
347
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
348
self._transport = transport
349
self._escaped_name = escaped_name
350
self._file_modebits = file_modebits
351
self._dir_modebits = dir_modebits
353
def break_lock(self):
354
raise NotImplementedError(self.break_lock)
356
def leave_in_place(self):
357
raise NotImplementedError(self.leave_in_place)
359
def dont_leave_in_place(self):
360
raise NotImplementedError(self.dont_leave_in_place)
362
def lock_write(self, token=None):
363
if token is not None:
364
raise errors.TokenLockingNotSupported(self)
365
self._lock = self._transport.lock_write(self._escaped_name)
368
self._lock = self._transport.lock_read(self._escaped_name)
375
raise NotImplementedError()
377
def create(self, mode=None):
378
"""Create lock mechanism"""
379
# for old-style locks, create the file now
380
self._transport.put_bytes(self._escaped_name, '',
381
mode=self._file_modebits)
383
def validate_token(self, token):
384
if token is not None:
385
raise errors.TokenLockingNotSupported(self)
added
removed
bzrlib/lockable_files.py
