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
def __init__(self, transport, lock_name, lock_class):
70
"""Create a LockableFiles group
72
:param transport: Transport pointing to the directory holding the
73
control files and lock.
74
:param lock_name: Name of the lock guarding these files.
75
:param lock_class: Class of lock strategy to use: typically
76
either LockDir or TransportLock.
78
self._transport = transport
79
self.lock_name = lock_name
80
self._transaction = None
81
self._lock_mode = None
84
esc_name = self._escape(lock_name)
85
self._lock = lock_class(transport, esc_name,
86
file_modebits=self._file_mode,
87
dir_modebits=self._dir_mode)
89
def create_lock(self):
92
This should normally be called only when the LockableFiles directory
93
is first created on disk.
95
self._lock.create(mode=self._dir_mode)
98
return '%s(%r)' % (self.__class__.__name__,
101
return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
105
# do not automatically unlock; there should have been a
106
# try/finally to unlock this.
107
warn("%r was gc'd while locked" % self)
109
def break_lock(self):
110
"""Break the lock of this lockable files group if it is held.
112
The current ui factory will be used to prompt for user conformation.
114
self._lock.break_lock()
116
def _escape(self, file_or_path):
117
if not isinstance(file_or_path, basestring):
118
file_or_path = '/'.join(file_or_path)
119
if file_or_path == '':
121
return urlutils.escape(safe_unicode(file_or_path))
123
def _find_modes(self):
124
"""Determine the appropriate modes for files and directories.
126
:deprecated: Replaced by BzrDir._find_modes.
129
st = self._transport.stat('.')
130
except errors.TransportNotPossible:
131
self._dir_mode = 0755
132
self._file_mode = 0644
134
# Check the directory mode, but also make sure the created
135
# directories and files are read-write for this user. This is
136
# mostly a workaround for filesystems which lie about being able to
137
# write to a directory (cygwin & win32)
138
self._dir_mode = (st.st_mode & 07777) | 00700
139
# Remove the sticky and execute bits for files
140
self._file_mode = self._dir_mode & ~07111
142
def controlfilename(self, file_or_path):
143
"""Return location relative to branch."""
144
return self._transport.abspath(self._escape(file_or_path))
147
def get(self, relpath):
148
"""Get a file as a bytestream."""
149
relpath = self._escape(relpath)
150
return self._transport.get(relpath)
153
@deprecated_method(deprecated_in((1, 5, 0)))
154
def get_utf8(self, relpath):
155
"""Get a file as a unicode stream."""
156
relpath = self._escape(relpath)
157
# DO NOT introduce an errors=replace here.
158
return codecs.getreader('utf-8')(self._transport.get(relpath))
161
def put(self, path, file):
164
:param path: The path to put the file, relative to the .bzr control
166
:param f: A file-like or string object whose contents should be copied.
168
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
171
def put_bytes(self, path, a_string):
172
"""Write a string of bytes.
174
:param path: The path to put the bytes, relative to the transport root.
175
:param string: A string object, whose exact bytes are to be copied.
177
self._transport.put_bytes(self._escape(path), a_string,
178
mode=self._file_mode)
181
def put_utf8(self, path, a_string):
182
"""Write a string, encoding as utf-8.
184
:param path: The path to put the string, relative to the transport root.
185
:param string: A string or unicode object whose contents should be copied.
187
# IterableFile would not be needed if Transport.put took iterables
188
# instead of files. ADHB 2005-12-25
189
# RBC 20060103 surely its not needed anyway, with codecs transcode
191
# JAM 20060103 We definitely don't want encode(..., 'replace')
192
# these are valuable files which should have exact contents.
193
if not isinstance(a_string, basestring):
194
raise errors.BzrBadParameterNotString(a_string)
195
self.put_bytes(path, a_string.encode('utf-8'))
197
def leave_in_place(self):
198
"""Set this LockableFiles to not clear the physical lock on unlock."""
199
self._lock.leave_in_place()
201
def dont_leave_in_place(self):
202
"""Set this LockableFiles to clear the physical lock on unlock."""
203
self._lock.dont_leave_in_place()
205
def lock_write(self, token=None):
206
"""Lock this group of files for writing.
208
:param token: if this is already locked, then lock_write will fail
209
unless the token matches the existing lock.
210
:returns: a token if this instance supports tokens, otherwise None.
211
:raises TokenLockingNotSupported: when a token is given but this
212
instance doesn't support using token locks.
213
:raises MismatchedToken: if the specified token doesn't match the token
214
of the existing lock.
216
A token should be passed in if you know that you have locked the object
217
some other way, and need to synchronise this object's state with that
220
# mutter("lock write: %s (%s)", self, self._lock_count)
221
# TODO: Upgrade locking to support using a Transport,
222
# and potentially a remote locking protocol
224
if self._lock_mode != 'w' or not self.get_transaction().writeable():
225
raise errors.ReadOnlyError(self)
226
self._lock.validate_token(token)
227
self._lock_count += 1
228
return self._token_from_lock
230
token_from_lock = self._lock.lock_write(token=token)
231
#note('write locking %s', self)
232
#traceback.print_stack()
233
self._lock_mode = 'w'
235
self._set_transaction(transactions.WriteTransaction())
236
self._token_from_lock = token_from_lock
237
return token_from_lock
240
# mutter("lock read: %s (%s)", self, self._lock_count)
242
if self._lock_mode not in ('r', 'w'):
243
raise ValueError("invalid lock mode %r" % (self._lock_mode,))
244
self._lock_count += 1
246
self._lock.lock_read()
247
#note('read locking %s', self)
248
#traceback.print_stack()
249
self._lock_mode = 'r'
251
self._set_transaction(transactions.ReadOnlyTransaction())
252
# 5K may be excessive, but hey, its a knob.
253
self.get_transaction().set_cache_size(5000)
256
# mutter("unlock: %s (%s)", self, self._lock_count)
257
if not self._lock_mode:
258
raise errors.LockNotHeld(self)
259
if self._lock_count > 1:
260
self._lock_count -= 1
262
#note('unlocking %s', self)
263
#traceback.print_stack()
264
self._finish_transaction()
268
self._lock_mode = self._lock_count = None
271
"""Return true if this LockableFiles group is locked"""
272
return self._lock_count >= 1
274
def get_physical_lock_status(self):
275
"""Return physical lock status.
277
Returns true if a lock is held on the transport. If no lock is held, or
278
the underlying locking mechanism does not support querying lock
279
status, false is returned.
282
return self._lock.peek() is not None
283
except NotImplementedError:
286
def get_transaction(self):
287
"""Return the current active transaction.
289
If no transaction is active, this returns a passthrough object
290
for which all data is immediately flushed and no caching happens.
292
if self._transaction is None:
293
return transactions.PassThroughTransaction()
295
return self._transaction
297
def _set_transaction(self, new_transaction):
298
"""Set a new active transaction."""
299
if self._transaction is not None:
300
raise errors.LockError('Branch %s is in a transaction already.' %
302
self._transaction = new_transaction
304
def _finish_transaction(self):
305
"""Exit the current transaction."""
306
if self._transaction is None:
307
raise errors.LockError('Branch %s is not in a transaction' %
309
transaction = self._transaction
310
self._transaction = None
314
class TransportLock(object):
315
"""Locking method which uses transport-dependent locks.
317
On the local filesystem these transform into OS-managed locks.
319
These do not guard against concurrent access via different
322
This is suitable for use only in WorkingTrees (which are at present
325
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
326
self._transport = transport
327
self._escaped_name = escaped_name
328
self._file_modebits = file_modebits
329
self._dir_modebits = dir_modebits
331
def break_lock(self):
332
raise NotImplementedError(self.break_lock)
334
def leave_in_place(self):
335
raise NotImplementedError(self.leave_in_place)
337
def dont_leave_in_place(self):
338
raise NotImplementedError(self.dont_leave_in_place)
340
def lock_write(self, token=None):
341
if token is not None:
342
raise errors.TokenLockingNotSupported(self)
343
self._lock = self._transport.lock_write(self._escaped_name)
346
self._lock = self._transport.lock_read(self._escaped_name)
353
raise NotImplementedError()
355
def create(self, mode=None):
356
"""Create lock mechanism"""
357
# for old-style locks, create the file now
358
self._transport.put_bytes(self._escaped_name, '',
359
mode=self._file_modebits)
361
def validate_token(self, token):
362
if token is not None:
363
raise errors.TokenLockingNotSupported(self)
added
removed
bzrlib/lockable_files.py
