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
:deprecated: Replaced by BzrDir._find_modes.
134
st = self._transport.stat('.')
135
except errors.TransportNotPossible:
136
self._dir_mode = 0755
137
self._file_mode = 0644
139
# Check the directory mode, but also make sure the created
140
# directories and files are read-write for this user. This is
141
# mostly a workaround for filesystems which lie about being able to
142
# write to a directory (cygwin & win32)
143
self._dir_mode = (st.st_mode & 07777) | 00700
144
# Remove the sticky and execute bits for files
145
self._file_mode = self._dir_mode & ~07111
146
if not self._set_dir_mode:
147
self._dir_mode = None
148
if not self._set_file_mode:
149
self._file_mode = None
151
def controlfilename(self, file_or_path):
152
"""Return location relative to branch."""
153
return self._transport.abspath(self._escape(file_or_path))
156
def get(self, relpath):
157
"""Get a file as a bytestream."""
158
relpath = self._escape(relpath)
159
return self._transport.get(relpath)
162
@deprecated_method(deprecated_in((1, 5, 0)))
163
def get_utf8(self, relpath):
164
"""Get a file as a unicode stream."""
165
relpath = self._escape(relpath)
166
# DO NOT introduce an errors=replace here.
167
return codecs.getreader('utf-8')(self._transport.get(relpath))
170
def put(self, path, file):
173
:param path: The path to put the file, relative to the .bzr control
175
:param f: A file-like or string object whose contents should be copied.
177
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
180
def put_bytes(self, path, a_string):
181
"""Write a string of bytes.
183
:param path: The path to put the bytes, relative to the transport root.
184
:param string: A string object, whose exact bytes are to be copied.
186
self._transport.put_bytes(self._escape(path), a_string,
187
mode=self._file_mode)
190
def put_utf8(self, path, a_string):
191
"""Write a string, encoding as utf-8.
193
:param path: The path to put the string, relative to the transport root.
194
:param string: A string or unicode object whose contents should be copied.
196
# IterableFile would not be needed if Transport.put took iterables
197
# instead of files. ADHB 2005-12-25
198
# RBC 20060103 surely its not needed anyway, with codecs transcode
200
# JAM 20060103 We definitely don't want encode(..., 'replace')
201
# these are valuable files which should have exact contents.
202
if not isinstance(a_string, basestring):
203
raise errors.BzrBadParameterNotString(a_string)
204
self.put_bytes(path, a_string.encode('utf-8'))
206
def leave_in_place(self):
207
"""Set this LockableFiles to not clear the physical lock on unlock."""
208
self._lock.leave_in_place()
210
def dont_leave_in_place(self):
211
"""Set this LockableFiles to clear the physical lock on unlock."""
212
self._lock.dont_leave_in_place()
214
def lock_write(self, token=None):
215
"""Lock this group of files for writing.
217
:param token: if this is already locked, then lock_write will fail
218
unless the token matches the existing lock.
219
:returns: a token if this instance supports tokens, otherwise None.
220
:raises TokenLockingNotSupported: when a token is given but this
221
instance doesn't support using token locks.
222
:raises MismatchedToken: if the specified token doesn't match the token
223
of the existing lock.
225
A token should be passed in if you know that you have locked the object
226
some other way, and need to synchronise this object's state with that
229
# mutter("lock write: %s (%s)", self, self._lock_count)
230
# TODO: Upgrade locking to support using a Transport,
231
# and potentially a remote locking protocol
233
if self._lock_mode != 'w' or not self.get_transaction().writeable():
234
raise errors.ReadOnlyError(self)
235
self._lock.validate_token(token)
236
self._lock_count += 1
237
return self._token_from_lock
239
token_from_lock = self._lock.lock_write(token=token)
240
#note('write locking %s', self)
241
#traceback.print_stack()
242
self._lock_mode = 'w'
244
self._set_transaction(transactions.WriteTransaction())
245
self._token_from_lock = token_from_lock
246
return token_from_lock
249
# mutter("lock read: %s (%s)", self, self._lock_count)
251
if self._lock_mode not in ('r', 'w'):
252
raise ValueError("invalid lock mode %r" % (self._lock_mode,))
253
self._lock_count += 1
255
self._lock.lock_read()
256
#note('read locking %s', self)
257
#traceback.print_stack()
258
self._lock_mode = 'r'
260
self._set_transaction(transactions.ReadOnlyTransaction())
261
# 5K may be excessive, but hey, its a knob.
262
self.get_transaction().set_cache_size(5000)
265
# mutter("unlock: %s (%s)", self, self._lock_count)
266
if not self._lock_mode:
267
raise errors.LockNotHeld(self)
268
if self._lock_count > 1:
269
self._lock_count -= 1
271
#note('unlocking %s', self)
272
#traceback.print_stack()
273
self._finish_transaction()
277
self._lock_mode = self._lock_count = None
280
"""Return true if this LockableFiles group is locked"""
281
return self._lock_count >= 1
283
def get_physical_lock_status(self):
284
"""Return physical lock status.
286
Returns true if a lock is held on the transport. If no lock is held, or
287
the underlying locking mechanism does not support querying lock
288
status, false is returned.
291
return self._lock.peek() is not None
292
except NotImplementedError:
295
def get_transaction(self):
296
"""Return the current active transaction.
298
If no transaction is active, this returns a passthrough object
299
for which all data is immediately flushed and no caching happens.
301
if self._transaction is None:
302
return transactions.PassThroughTransaction()
304
return self._transaction
306
def _set_transaction(self, new_transaction):
307
"""Set a new active transaction."""
308
if self._transaction is not None:
309
raise errors.LockError('Branch %s is in a transaction already.' %
311
self._transaction = new_transaction
313
def _finish_transaction(self):
314
"""Exit the current transaction."""
315
if self._transaction is None:
316
raise errors.LockError('Branch %s is not in a transaction' %
318
transaction = self._transaction
319
self._transaction = None
323
class TransportLock(object):
324
"""Locking method which uses transport-dependent locks.
326
On the local filesystem these transform into OS-managed locks.
328
These do not guard against concurrent access via different
331
This is suitable for use only in WorkingTrees (which are at present
334
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
335
self._transport = transport
336
self._escaped_name = escaped_name
337
self._file_modebits = file_modebits
338
self._dir_modebits = dir_modebits
340
def break_lock(self):
341
raise NotImplementedError(self.break_lock)
343
def leave_in_place(self):
344
raise NotImplementedError(self.leave_in_place)
346
def dont_leave_in_place(self):
347
raise NotImplementedError(self.dont_leave_in_place)
349
def lock_write(self, token=None):
350
if token is not None:
351
raise errors.TokenLockingNotSupported(self)
352
self._lock = self._transport.lock_write(self._escaped_name)
355
self._lock = self._transport.lock_read(self._escaped_name)
362
raise NotImplementedError()
364
def create(self, mode=None):
365
"""Create lock mechanism"""
366
# for old-style locks, create the file now
367
self._transport.put_bytes(self._escaped_name, '',
368
mode=self._file_modebits)
370
def validate_token(self, token):
371
if token is not None:
372
raise errors.TokenLockingNotSupported(self)
added
removed
bzrlib/lockable_files.py
