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.
63
This class is now deprecated; code should move to using the Transport
64
directly for file operations and using the lock or CountedLock for
68
# _lock_mode: None, or 'r' or 'w'
70
# _lock_count: If _lock_mode is true, a positive count of the number of
71
# times the lock has been taken *by this process*.
73
def __init__(self, transport, lock_name, lock_class):
74
"""Create a LockableFiles group
76
:param transport: Transport pointing to the directory holding the
77
control files and lock.
78
:param lock_name: Name of the lock guarding these files.
79
:param lock_class: Class of lock strategy to use: typically
80
either LockDir or TransportLock.
82
self._transport = transport
83
self.lock_name = lock_name
84
self._transaction = None
85
self._lock_mode = None
88
esc_name = self._escape(lock_name)
89
self._lock = lock_class(transport, esc_name,
90
file_modebits=self._file_mode,
91
dir_modebits=self._dir_mode)
93
def create_lock(self):
96
This should normally be called only when the LockableFiles directory
97
is first created on disk.
99
self._lock.create(mode=self._dir_mode)
102
return '%s(%r)' % (self.__class__.__name__,
105
return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
109
# do not automatically unlock; there should have been a
110
# try/finally to unlock this.
111
warn("%r was gc'd while locked" % 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
:deprecated: Replaced by BzrDir._find_modes.
133
st = self._transport.stat('.')
134
except errors.TransportNotPossible:
135
self._dir_mode = 0755
136
self._file_mode = 0644
138
# Check the directory mode, but also make sure the created
139
# directories and files are read-write for this user. This is
140
# mostly a workaround for filesystems which lie about being able to
141
# write to a directory (cygwin & win32)
142
self._dir_mode = (st.st_mode & 07777) | 00700
143
# Remove the sticky and execute bits for files
144
self._file_mode = self._dir_mode & ~07111
146
@deprecated_method(deprecated_in((1, 6, 0)))
147
def controlfilename(self, file_or_path):
148
"""Return location relative to branch.
150
:deprecated: Use Transport methods instead.
152
return self._transport.abspath(self._escape(file_or_path))
155
@deprecated_method(deprecated_in((1, 5, 0)))
156
def get(self, relpath):
157
"""Get a file as a bytestream.
159
:deprecated: Use a Transport instead of LockableFiles.
161
relpath = self._escape(relpath)
162
return self._transport.get(relpath)
165
@deprecated_method(deprecated_in((1, 5, 0)))
166
def get_utf8(self, relpath):
167
"""Get a file as a unicode stream.
169
:deprecated: Use a Transport instead of LockableFiles.
171
relpath = self._escape(relpath)
172
# DO NOT introduce an errors=replace here.
173
return codecs.getreader('utf-8')(self._transport.get(relpath))
176
@deprecated_method(deprecated_in((1, 6, 0)))
177
def put(self, path, file):
180
:param path: The path to put the file, relative to the .bzr control
182
:param file: A file-like or string object whose contents should be copied.
184
:deprecated: Use Transport methods instead.
186
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
189
@deprecated_method(deprecated_in((1, 6, 0)))
190
def put_bytes(self, path, a_string):
191
"""Write a string of bytes.
193
:param path: The path to put the bytes, relative to the transport root.
194
:param a_string: A string object, whose exact bytes are to be copied.
196
:deprecated: Use Transport methods instead.
198
self._transport.put_bytes(self._escape(path), a_string,
199
mode=self._file_mode)
202
@deprecated_method(deprecated_in((1, 6, 0)))
203
def put_utf8(self, path, a_string):
204
"""Write a string, encoding as utf-8.
206
:param path: The path to put the string, relative to the transport root.
207
:param string: A string or unicode object whose contents should be copied.
209
:deprecated: Use Transport methods instead.
211
# IterableFile would not be needed if Transport.put took iterables
212
# instead of files. ADHB 2005-12-25
213
# RBC 20060103 surely its not needed anyway, with codecs transcode
215
# JAM 20060103 We definitely don't want encode(..., 'replace')
216
# these are valuable files which should have exact contents.
217
if not isinstance(a_string, basestring):
218
raise errors.BzrBadParameterNotString(a_string)
219
self.put_bytes(path, a_string.encode('utf-8'))
221
def leave_in_place(self):
222
"""Set this LockableFiles to not clear the physical lock on unlock."""
223
self._lock.leave_in_place()
225
def dont_leave_in_place(self):
226
"""Set this LockableFiles to clear the physical lock on unlock."""
227
self._lock.dont_leave_in_place()
229
def lock_write(self, token=None):
230
"""Lock this group of files for writing.
232
:param token: if this is already locked, then lock_write will fail
233
unless the token matches the existing lock.
234
:returns: a token if this instance supports tokens, otherwise None.
235
:raises TokenLockingNotSupported: when a token is given but this
236
instance doesn't support using token locks.
237
:raises MismatchedToken: if the specified token doesn't match the token
238
of the existing lock.
240
A token should be passed in if you know that you have locked the object
241
some other way, and need to synchronise this object's state with that
244
# mutter("lock write: %s (%s)", self, self._lock_count)
245
# TODO: Upgrade locking to support using a Transport,
246
# and potentially a remote locking protocol
248
if self._lock_mode != 'w' or not self.get_transaction().writeable():
249
raise errors.ReadOnlyError(self)
250
self._lock.validate_token(token)
251
self._lock_count += 1
252
return self._token_from_lock
254
token_from_lock = self._lock.lock_write(token=token)
255
#note('write locking %s', self)
256
#traceback.print_stack()
257
self._lock_mode = 'w'
259
self._set_transaction(transactions.WriteTransaction())
260
self._token_from_lock = token_from_lock
261
return token_from_lock
264
# mutter("lock read: %s (%s)", self, self._lock_count)
266
if self._lock_mode not in ('r', 'w'):
267
raise ValueError("invalid lock mode %r" % (self._lock_mode,))
268
self._lock_count += 1
270
self._lock.lock_read()
271
#note('read locking %s', self)
272
#traceback.print_stack()
273
self._lock_mode = 'r'
275
self._set_transaction(transactions.ReadOnlyTransaction())
276
# 5K may be excessive, but hey, its a knob.
277
self.get_transaction().set_cache_size(5000)
280
# mutter("unlock: %s (%s)", self, self._lock_count)
281
if not self._lock_mode:
282
raise errors.LockNotHeld(self)
283
if self._lock_count > 1:
284
self._lock_count -= 1
286
#note('unlocking %s', self)
287
#traceback.print_stack()
288
self._finish_transaction()
292
self._lock_mode = self._lock_count = None
295
"""Return true if this LockableFiles group is locked"""
296
return self._lock_count >= 1
298
def get_physical_lock_status(self):
299
"""Return physical lock status.
301
Returns true if a lock is held on the transport. If no lock is held, or
302
the underlying locking mechanism does not support querying lock
303
status, false is returned.
306
return self._lock.peek() is not None
307
except NotImplementedError:
310
def get_transaction(self):
311
"""Return the current active transaction.
313
If no transaction is active, this returns a passthrough object
314
for which all data is immediately flushed and no caching happens.
316
if self._transaction is None:
317
return transactions.PassThroughTransaction()
319
return self._transaction
321
def _set_transaction(self, new_transaction):
322
"""Set a new active transaction."""
323
if self._transaction is not None:
324
raise errors.LockError('Branch %s is in a transaction already.' %
326
self._transaction = new_transaction
328
def _finish_transaction(self):
329
"""Exit the current transaction."""
330
if self._transaction is None:
331
raise errors.LockError('Branch %s is not in a transaction' %
333
transaction = self._transaction
334
self._transaction = None
338
class TransportLock(object):
339
"""Locking method which uses transport-dependent locks.
341
On the local filesystem these transform into OS-managed locks.
343
These do not guard against concurrent access via different
346
This is suitable for use only in WorkingTrees (which are at present
349
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
350
self._transport = transport
351
self._escaped_name = escaped_name
352
self._file_modebits = file_modebits
353
self._dir_modebits = dir_modebits
355
def break_lock(self):
356
raise NotImplementedError(self.break_lock)
358
def leave_in_place(self):
359
raise NotImplementedError(self.leave_in_place)
361
def dont_leave_in_place(self):
362
raise NotImplementedError(self.dont_leave_in_place)
364
def lock_write(self, token=None):
365
if token is not None:
366
raise errors.TokenLockingNotSupported(self)
367
self._lock = self._transport.lock_write(self._escaped_name)
370
self._lock = self._transport.lock_read(self._escaped_name)
377
raise NotImplementedError()
379
def create(self, mode=None):
380
"""Create lock mechanism"""
381
# for old-style locks, create the file now
382
self._transport.put_bytes(self._escaped_name, '',
383
mode=self._file_modebits)
385
def validate_token(self, token):
386
if token is not None:
387
raise errors.TokenLockingNotSupported(self)
added
removed
bzrlib/lockable_files.py
