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
19
from bzrlib.lazy_import import lazy_import
20
lazy_import(globals(), """
32
from bzrlib.decorators import (
36
from bzrlib.symbol_versioning import (
42
# XXX: The tracking here of lock counts and whether the lock is held is
43
# somewhat redundant with what's done in LockDir; the main difference is that
44
# LockableFiles permits reentrancy.
46
class LockableFiles(object):
47
"""Object representing a set of related files locked within the same scope.
49
These files are used by a WorkingTree, Repository or Branch, and should
50
generally only be touched by that object.
52
LockableFiles also provides some policy on top of Transport for encoding
53
control files as utf-8.
55
LockableFiles manage a lock count and can be locked repeatedly by
56
a single caller. (The underlying lock implementation generally does not
59
Instances of this class are often called control_files.
61
This object builds on top of a Transport, which is used to actually write
62
the files to disk, and an OSLock or LockDir, which controls how access to
63
the files is controlled. The particular type of locking used is set when
64
the object is constructed. In older formats OSLocks are used everywhere.
65
in newer formats a LockDir is used for Repositories and Branches, and
66
OSLocks for the local filesystem.
68
This class is now deprecated; code should move to using the Transport
69
directly for file operations and using the lock or CountedLock for
73
# _lock_mode: None, or 'r' or 'w'
75
# _lock_count: If _lock_mode is true, a positive count of the number of
76
# times the lock has been taken *by this process*.
78
def __init__(self, transport, lock_name, lock_class):
79
"""Create a LockableFiles group
81
:param transport: Transport pointing to the directory holding the
82
control files and lock.
83
:param lock_name: Name of the lock guarding these files.
84
:param lock_class: Class of lock strategy to use: typically
85
either LockDir or TransportLock.
87
self._transport = transport
88
self.lock_name = lock_name
89
self._transaction = None
90
self._lock_mode = None
93
esc_name = self._escape(lock_name)
94
self._lock = lock_class(transport, esc_name,
95
file_modebits=self._file_mode,
96
dir_modebits=self._dir_mode)
98
def create_lock(self):
101
This should normally be called only when the LockableFiles directory
102
is first created on disk.
104
self._lock.create(mode=self._dir_mode)
107
return '%s(%r)' % (self.__class__.__name__,
110
return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
114
# do not automatically unlock; there should have been a
115
# try/finally to unlock this.
116
warnings.warn("%r was gc'd while locked" % self)
118
def break_lock(self):
119
"""Break the lock of this lockable files group if it is held.
121
The current ui factory will be used to prompt for user conformation.
123
self._lock.break_lock()
125
def _escape(self, file_or_path):
126
if not isinstance(file_or_path, basestring):
127
file_or_path = '/'.join(file_or_path)
128
if file_or_path == '':
130
return urlutils.escape(osutils.safe_unicode(file_or_path))
132
def _find_modes(self):
133
"""Determine the appropriate modes for files and directories.
135
:deprecated: Replaced by BzrDir._find_modes.
138
st = self._transport.stat('.')
139
except errors.TransportNotPossible:
140
self._dir_mode = 0755
141
self._file_mode = 0644
143
# Check the directory mode, but also make sure the created
144
# directories and files are read-write for this user. This is
145
# mostly a workaround for filesystems which lie about being able to
146
# write to a directory (cygwin & win32)
147
self._dir_mode = (st.st_mode & 07777) | 00700
148
# Remove the sticky and execute bits for files
149
self._file_mode = self._dir_mode & ~07111
151
@deprecated_method(deprecated_in((1, 6, 0)))
152
def controlfilename(self, file_or_path):
153
"""Return location relative to branch.
155
:deprecated: Use Transport methods instead.
157
return self._transport.abspath(self._escape(file_or_path))
160
@deprecated_method(deprecated_in((1, 5, 0)))
161
def get(self, relpath):
162
"""Get a file as a bytestream.
164
:deprecated: Use a Transport instead of LockableFiles.
166
relpath = self._escape(relpath)
167
return self._transport.get(relpath)
170
@deprecated_method(deprecated_in((1, 5, 0)))
171
def get_utf8(self, relpath):
172
"""Get a file as a unicode stream.
174
:deprecated: Use a Transport instead of LockableFiles.
176
relpath = self._escape(relpath)
177
# DO NOT introduce an errors=replace here.
178
return codecs.getreader('utf-8')(self._transport.get(relpath))
181
@deprecated_method(deprecated_in((1, 6, 0)))
182
def put(self, path, file):
185
:param path: The path to put the file, relative to the .bzr control
187
:param file: A file-like or string object whose contents should be copied.
189
:deprecated: Use Transport methods instead.
191
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
194
@deprecated_method(deprecated_in((1, 6, 0)))
195
def put_bytes(self, path, a_string):
196
"""Write a string of bytes.
198
:param path: The path to put the bytes, relative to the transport root.
199
:param a_string: A string object, whose exact bytes are to be copied.
201
:deprecated: Use Transport methods instead.
203
self._transport.put_bytes(self._escape(path), a_string,
204
mode=self._file_mode)
207
@deprecated_method(deprecated_in((1, 6, 0)))
208
def put_utf8(self, path, a_string):
209
"""Write a string, encoding as utf-8.
211
:param path: The path to put the string, relative to the transport root.
212
:param string: A string or unicode object whose contents should be copied.
214
:deprecated: Use Transport methods instead.
216
# IterableFile would not be needed if Transport.put took iterables
217
# instead of files. ADHB 2005-12-25
218
# RBC 20060103 surely its not needed anyway, with codecs transcode
220
# JAM 20060103 We definitely don't want encode(..., 'replace')
221
# these are valuable files which should have exact contents.
222
if not isinstance(a_string, basestring):
223
raise errors.BzrBadParameterNotString(a_string)
224
self.put_bytes(path, a_string.encode('utf-8'))
226
def leave_in_place(self):
227
"""Set this LockableFiles to not clear the physical lock on unlock."""
228
self._lock.leave_in_place()
230
def dont_leave_in_place(self):
231
"""Set this LockableFiles to clear the physical lock on unlock."""
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
A token should be passed in if you know that you have locked the object
246
some other way, and need to synchronise this object's state with that
249
# TODO: Upgrade locking to support using a Transport,
250
# and potentially a remote locking protocol
252
if self._lock_mode != 'w' or not self.get_transaction().writeable():
253
raise errors.ReadOnlyError(self)
254
self._lock.validate_token(token)
255
self._lock_count += 1
256
return self._token_from_lock
258
token_from_lock = self._lock.lock_write(token=token)
259
#traceback.print_stack()
260
self._lock_mode = 'w'
262
self._set_transaction(transactions.WriteTransaction())
263
self._token_from_lock = token_from_lock
264
return token_from_lock
268
if self._lock_mode not in ('r', 'w'):
269
raise ValueError("invalid lock mode %r" % (self._lock_mode,))
270
self._lock_count += 1
272
self._lock.lock_read()
273
#traceback.print_stack()
274
self._lock_mode = 'r'
276
self._set_transaction(transactions.ReadOnlyTransaction())
277
# 5K may be excessive, but hey, its a knob.
278
self.get_transaction().set_cache_size(5000)
281
if not self._lock_mode:
282
raise errors.LockNotHeld(self)
283
if self._lock_count > 1:
284
self._lock_count -= 1
286
#traceback.print_stack()
287
self._finish_transaction()
291
self._lock_mode = self._lock_count = None
294
"""Return true if this LockableFiles group is locked"""
295
return self._lock_count >= 1
297
def get_physical_lock_status(self):
298
"""Return physical lock status.
300
Returns true if a lock is held on the transport. If no lock is held, or
301
the underlying locking mechanism does not support querying lock
302
status, false is returned.
305
return self._lock.peek() is not None
306
except NotImplementedError:
309
def get_transaction(self):
310
"""Return the current active transaction.
312
If no transaction is active, this returns a passthrough object
313
for which all data is immediately flushed and no caching happens.
315
if self._transaction is None:
316
return transactions.PassThroughTransaction()
318
return self._transaction
320
def _set_transaction(self, new_transaction):
321
"""Set a new active transaction."""
322
if self._transaction is not None:
323
raise errors.LockError('Branch %s is in a transaction already.' %
325
self._transaction = new_transaction
327
def _finish_transaction(self):
328
"""Exit the current transaction."""
329
if self._transaction is None:
330
raise errors.LockError('Branch %s is not in a transaction' %
332
transaction = self._transaction
333
self._transaction = None
337
class TransportLock(object):
338
"""Locking method which uses transport-dependent locks.
340
On the local filesystem these transform into OS-managed locks.
342
These do not guard against concurrent access via different
345
This is suitable for use only in WorkingTrees (which are at present
348
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
349
self._transport = transport
350
self._escaped_name = escaped_name
351
self._file_modebits = file_modebits
352
self._dir_modebits = dir_modebits
354
def break_lock(self):
355
raise NotImplementedError(self.break_lock)
357
def leave_in_place(self):
358
raise NotImplementedError(self.leave_in_place)
360
def dont_leave_in_place(self):
361
raise NotImplementedError(self.dont_leave_in_place)
363
def lock_write(self, token=None):
364
if token is not None:
365
raise errors.TokenLockingNotSupported(self)
366
self._lock = self._transport.lock_write(self._escaped_name)
369
self._lock = self._transport.lock_read(self._escaped_name)
376
raise NotImplementedError()
378
def create(self, mode=None):
379
"""Create lock mechanism"""
380
# for old-style locks, create the file now
381
self._transport.put_bytes(self._escaped_name, '',
382
mode=self._file_modebits)
384
def validate_token(self, token):
385
if token is not None:
386
raise errors.TokenLockingNotSupported(self)
added
removed
bzrlib/lockable_files.py
