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
# If set to False (by a plugin, etc) BzrBranch will not set the
74
# mode on created files or directories
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
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(safe_unicode(file_or_path))
132
def _find_modes(self):
133
"""Determine the appropriate modes for files and directories."""
135
st = self._transport.stat('.')
136
except errors.TransportNotPossible:
137
self._dir_mode = 0755
138
self._file_mode = 0644
140
# Check the directory mode, but also make sure the created
141
# directories and files are read-write for this user. This is
142
# mostly a workaround for filesystems which lie about being able to
143
# write to a directory (cygwin & win32)
144
self._dir_mode = (st.st_mode & 07777) | 00700
145
# Remove the sticky and execute bits for files
146
self._file_mode = self._dir_mode & ~07111
147
if not self._set_dir_mode:
148
self._dir_mode = None
149
if not self._set_file_mode:
150
self._file_mode = None
152
@deprecated_method(deprecated_in((1, 6, 0)))
153
def controlfilename(self, file_or_path):
154
"""Return location relative to branch.
156
:deprecated: Use Transport methods instead.
158
return self._transport.abspath(self._escape(file_or_path))
161
@deprecated_method(deprecated_in((1, 5, 0)))
162
def get(self, relpath):
163
"""Get a file as a bytestream.
165
:deprecated: Use a Transport instead of LockableFiles.
167
relpath = self._escape(relpath)
168
return self._transport.get(relpath)
171
@deprecated_method(deprecated_in((1, 5, 0)))
172
def get_utf8(self, relpath):
173
"""Get a file as a unicode stream.
175
:deprecated: Use a Transport instead of LockableFiles.
177
relpath = self._escape(relpath)
178
# DO NOT introduce an errors=replace here.
179
return codecs.getreader('utf-8')(self._transport.get(relpath))
182
@deprecated_method(deprecated_in((1, 6, 0)))
183
def put(self, path, file):
186
:param path: The path to put the file, relative to the .bzr control
188
:param file: A file-like or string object whose contents should be copied.
190
:deprecated: Use Transport methods instead.
192
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
195
@deprecated_method(deprecated_in((1, 6, 0)))
196
def put_bytes(self, path, a_string):
197
"""Write a string of bytes.
199
:param path: The path to put the bytes, relative to the transport root.
200
:param a_string: A string object, whose exact bytes are to be copied.
202
:deprecated: Use Transport methods instead.
204
self._transport.put_bytes(self._escape(path), a_string,
205
mode=self._file_mode)
208
@deprecated_method(deprecated_in((1, 6, 0)))
209
def put_utf8(self, path, a_string):
210
"""Write a string, encoding as utf-8.
212
:param path: The path to put the string, relative to the transport root.
213
:param string: A string or unicode object whose contents should be copied.
215
:deprecated: Use Transport methods instead.
217
# IterableFile would not be needed if Transport.put took iterables
218
# instead of files. ADHB 2005-12-25
219
# RBC 20060103 surely its not needed anyway, with codecs transcode
221
# JAM 20060103 We definitely don't want encode(..., 'replace')
222
# these are valuable files which should have exact contents.
223
if not isinstance(a_string, basestring):
224
raise errors.BzrBadParameterNotString(a_string)
225
self.put_bytes(path, a_string.encode('utf-8'))
227
def leave_in_place(self):
228
"""Set this LockableFiles to not clear the physical lock on unlock."""
229
self._lock.leave_in_place()
231
def dont_leave_in_place(self):
232
"""Set this LockableFiles to clear the physical lock on unlock."""
233
self._lock.dont_leave_in_place()
235
def lock_write(self, token=None):
236
"""Lock this group of files for writing.
238
:param token: if this is already locked, then lock_write will fail
239
unless the token matches the existing lock.
240
:returns: a token if this instance supports tokens, otherwise None.
241
:raises TokenLockingNotSupported: when a token is given but this
242
instance doesn't support using token locks.
243
:raises MismatchedToken: if the specified token doesn't match the token
244
of the existing lock.
246
A token should be passed in if you know that you have locked the object
247
some other way, and need to synchronise this object's state with that
250
# mutter("lock write: %s (%s)", self, self._lock_count)
251
# TODO: Upgrade locking to support using a Transport,
252
# and potentially a remote locking protocol
254
if self._lock_mode != 'w' or not self.get_transaction().writeable():
255
raise errors.ReadOnlyError(self)
256
self._lock.validate_token(token)
257
self._lock_count += 1
258
return self._token_from_lock
260
token_from_lock = self._lock.lock_write(token=token)
261
#note('write locking %s', self)
262
#traceback.print_stack()
263
self._lock_mode = 'w'
265
self._set_transaction(transactions.WriteTransaction())
266
self._token_from_lock = token_from_lock
267
return token_from_lock
270
# mutter("lock read: %s (%s)", self, self._lock_count)
272
if self._lock_mode not in ('r', 'w'):
273
raise ValueError("invalid lock mode %r" % (self._lock_mode,))
274
self._lock_count += 1
276
self._lock.lock_read()
277
#note('read locking %s', self)
278
#traceback.print_stack()
279
self._lock_mode = 'r'
281
self._set_transaction(transactions.ReadOnlyTransaction())
282
# 5K may be excessive, but hey, its a knob.
283
self.get_transaction().set_cache_size(5000)
286
# mutter("unlock: %s (%s)", self, self._lock_count)
287
if not self._lock_mode:
288
raise errors.LockNotHeld(self)
289
if self._lock_count > 1:
290
self._lock_count -= 1
292
#note('unlocking %s', self)
293
#traceback.print_stack()
294
self._finish_transaction()
298
self._lock_mode = self._lock_count = None
301
"""Return true if this LockableFiles group is locked"""
302
return self._lock_count >= 1
304
def get_physical_lock_status(self):
305
"""Return physical lock status.
307
Returns true if a lock is held on the transport. If no lock is held, or
308
the underlying locking mechanism does not support querying lock
309
status, false is returned.
312
return self._lock.peek() is not None
313
except NotImplementedError:
316
def get_transaction(self):
317
"""Return the current active transaction.
319
If no transaction is active, this returns a passthrough object
320
for which all data is immediately flushed and no caching happens.
322
if self._transaction is None:
323
return transactions.PassThroughTransaction()
325
return self._transaction
327
def _set_transaction(self, new_transaction):
328
"""Set a new active transaction."""
329
if self._transaction is not None:
330
raise errors.LockError('Branch %s is in a transaction already.' %
332
self._transaction = new_transaction
334
def _finish_transaction(self):
335
"""Exit the current transaction."""
336
if self._transaction is None:
337
raise errors.LockError('Branch %s is not in a transaction' %
339
transaction = self._transaction
340
self._transaction = None
344
class TransportLock(object):
345
"""Locking method which uses transport-dependent locks.
347
On the local filesystem these transform into OS-managed locks.
349
These do not guard against concurrent access via different
352
This is suitable for use only in WorkingTrees (which are at present
355
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
356
self._transport = transport
357
self._escaped_name = escaped_name
358
self._file_modebits = file_modebits
359
self._dir_modebits = dir_modebits
361
def break_lock(self):
362
raise NotImplementedError(self.break_lock)
364
def leave_in_place(self):
365
raise NotImplementedError(self.leave_in_place)
367
def dont_leave_in_place(self):
368
raise NotImplementedError(self.dont_leave_in_place)
370
def lock_write(self, token=None):
371
if token is not None:
372
raise errors.TokenLockingNotSupported(self)
373
self._lock = self._transport.lock_write(self._escaped_name)
376
self._lock = self._transport.lock_read(self._escaped_name)
383
raise NotImplementedError()
385
def create(self, mode=None):
386
"""Create lock mechanism"""
387
# for old-style locks, create the file now
388
self._transport.put_bytes(self._escaped_name, '',
389
mode=self._file_modebits)
391
def validate_token(self, token):
392
if token is not None:
393
raise errors.TokenLockingNotSupported(self)
added
removed
bzrlib/lockable_files.py
