1
# Copyright (C) 2005, 2006 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
22
from bzrlib.decorators import *
23
import bzrlib.errors as errors
24
from bzrlib.errors import BzrError
25
from bzrlib.osutils import file_iterator, safe_unicode
26
from bzrlib.symbol_versioning import *
27
from bzrlib.trace import mutter, note
28
import bzrlib.transactions as transactions
30
# XXX: The tracking here of lock counts and whether the lock is held is
31
# somewhat redundant with what's done in LockDir; the main difference is that
32
# LockableFiles permits reentrancy.
34
class LockableFiles(object):
35
"""Object representing a set of related files locked within the same scope.
37
These files are used by a WorkingTree, Repository or Branch, and should
38
generally only be touched by that object.
40
LockableFiles also provides some policy on top of Transport for encoding
41
control files as utf-8.
43
LockableFiles manage a lock count and can be locked repeatedly by
44
a single caller. (The underlying lock implementation generally does not
47
Instances of this class are often called control_files.
49
This object builds on top of a Transport, which is used to actually write
50
the files to disk, and an OSLock or LockDir, which controls how access to
51
the files is controlled. The particular type of locking used is set when
52
the object is constructed. In older formats OSLocks are used everywhere.
53
in newer formats a LockDir is used for Repositories and Branches, and
54
OSLocks for the local filesystem.
57
# _lock_mode: None, or 'r' or 'w'
59
# _lock_count: If _lock_mode is true, a positive count of the number of
60
# times the lock has been taken *by this process*.
62
# If set to False (by a plugin, etc) BzrBranch will not set the
63
# mode on created files or directories
67
def __init__(self, transport, lock_name, lock_class):
68
"""Create a LockableFiles group
70
:param transport: Transport pointing to the directory holding the
71
control files and lock.
72
:param lock_name: Name of the lock guarding these files.
73
:param lock_class: Class of lock strategy to use: typically
74
either LockDir or TransportLock.
77
self._transport = transport
78
self.lock_name = lock_name
79
self._transaction = None
81
self._lock_mode = None
83
esc_name = self._escape(lock_name)
84
self._lock = lock_class(transport, esc_name,
85
file_modebits=self._file_mode,
86
dir_modebits=self._dir_mode)
88
def create_lock(self):
91
This should normally be called only when the LockableFiles directory
92
is first created on disk.
94
self._lock.create(mode=self._dir_mode)
97
return '%s(%r)' % (self.__class__.__name__,
100
return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
104
# XXX: This should show something every time, and be suitable for
105
# headless operation and embedding
106
from warnings import warn
107
warn("file group %r was not explicitly unlocked" % self)
110
def break_lock(self):
111
"""Break the lock of this lockable files group if it is held.
113
The current ui factory will be used to prompt for user conformation.
115
self._lock.break_lock()
117
def _escape(self, file_or_path):
118
if not isinstance(file_or_path, basestring):
119
file_or_path = '/'.join(file_or_path)
120
if file_or_path == '':
122
return bzrlib.transport.urlescape(safe_unicode(file_or_path))
124
def _find_modes(self):
125
"""Determine the appropriate modes for files and directories."""
127
st = self._transport.stat('.')
128
except errors.TransportNotPossible:
129
self._dir_mode = 0755
130
self._file_mode = 0644
132
self._dir_mode = st.st_mode & 07777
133
# Remove the sticky and execute bits for files
134
self._file_mode = self._dir_mode & ~07111
135
if not self._set_dir_mode:
136
self._dir_mode = None
137
if not self._set_file_mode:
138
self._file_mode = None
140
def controlfilename(self, file_or_path):
141
"""Return location relative to branch."""
142
return self._transport.abspath(self._escape(file_or_path))
144
@deprecated_method(zero_eight)
145
def controlfile(self, file_or_path, mode='r'):
146
"""Open a control file for this branch.
148
There are two classes of file in a lockable directory: text
149
and binary. binary files are untranslated byte streams. Text
150
control files are stored with Unix newlines and in UTF-8, even
151
if the platform or locale defaults are different.
153
Such files are not openable in write mode : they are managed via
154
put and put_utf8 which atomically replace old versions using
158
relpath = self._escape(file_or_path)
159
# TODO: codecs.open() buffers linewise, so it was overloaded with
160
# a much larger buffer, do we need to do the same for getreader/getwriter?
162
return self.get(relpath)
164
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
166
return self.get_utf8(relpath)
168
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
170
raise BzrError("invalid controlfile mode %r" % mode)
173
def get(self, relpath):
174
"""Get a file as a bytestream."""
175
relpath = self._escape(relpath)
176
return self._transport.get(relpath)
179
def get_utf8(self, relpath):
180
"""Get a file as a unicode stream."""
181
relpath = self._escape(relpath)
182
# DO NOT introduce an errors=replace here.
183
return codecs.getreader('utf-8')(self._transport.get(relpath))
186
def put(self, path, file):
189
:param path: The path to put the file, relative to the .bzr control
191
:param f: A file-like or string object whose contents should be copied.
193
self._transport.put(self._escape(path), file, mode=self._file_mode)
196
def put_utf8(self, path, a_string):
197
"""Write a string, encoding as utf-8.
199
:param path: The path to put the string, relative to the transport root.
200
:param string: A file-like or string object whose contents should be copied.
202
# IterableFile would not be needed if Transport.put took iterables
203
# instead of files. ADHB 2005-12-25
204
# RBC 20060103 surely its not needed anyway, with codecs transcode
206
# JAM 20060103 We definitely don't want encode(..., 'replace')
207
# these are valuable files which should have exact contents.
208
if not isinstance(a_string, basestring):
209
raise errors.BzrBadParameterNotString(a_string)
210
self.put(path, StringIO(a_string.encode('utf-8')))
212
def lock_write(self):
213
# mutter("lock write: %s (%s)", self, self._lock_count)
214
# TODO: Upgrade locking to support using a Transport,
215
# and potentially a remote locking protocol
217
if self._lock_mode != 'w' or not self.get_transaction().writeable():
218
raise errors.ReadOnlyError(self)
219
self._lock_count += 1
221
self._lock.lock_write()
222
#note('write locking %s', self)
223
#traceback.print_stack()
224
self._lock_mode = 'w'
226
self._set_transaction(transactions.WriteTransaction())
229
# mutter("lock read: %s (%s)", self, self._lock_count)
231
assert self._lock_mode in ('r', 'w'), \
232
"invalid lock mode %r" % self._lock_mode
233
self._lock_count += 1
235
self._lock.lock_read()
236
#note('read locking %s', self)
237
#traceback.print_stack()
238
self._lock_mode = 'r'
240
self._set_transaction(transactions.ReadOnlyTransaction())
241
# 5K may be excessive, but hey, its a knob.
242
self.get_transaction().set_cache_size(5000)
245
# mutter("unlock: %s (%s)", self, self._lock_count)
246
if not self._lock_mode:
247
raise errors.LockNotHeld(self)
248
if self._lock_count > 1:
249
self._lock_count -= 1
251
#note('unlocking %s', self)
252
#traceback.print_stack()
253
self._finish_transaction()
257
self._lock_mode = self._lock_count = None
260
"""Return true if this LockableFiles group is locked"""
261
return self._lock_count >= 1
263
def get_physical_lock_status(self):
264
"""Return physical lock status.
266
Returns true if a lock is held on the transport. If no lock is held, or
267
the underlying locking mechanism does not support querying lock
268
status, false is returned.
271
return self._lock.peek() is not None
272
except NotImplementedError:
275
def get_transaction(self):
276
"""Return the current active transaction.
278
If no transaction is active, this returns a passthrough object
279
for which all data is immediately flushed and no caching happens.
281
if self._transaction is None:
282
return transactions.PassThroughTransaction()
284
return self._transaction
286
def _set_transaction(self, new_transaction):
287
"""Set a new active transaction."""
288
if self._transaction is not None:
289
raise errors.LockError('Branch %s is in a transaction already.' %
291
self._transaction = new_transaction
293
def _finish_transaction(self):
294
"""Exit the current transaction."""
295
if self._transaction is None:
296
raise errors.LockError('Branch %s is not in a transaction' %
298
transaction = self._transaction
299
self._transaction = None
303
class TransportLock(object):
304
"""Locking method which uses transport-dependent locks.
306
On the local filesystem these transform into OS-managed locks.
308
These do not guard against concurrent access via different
311
This is suitable for use only in WorkingTrees (which are at present
314
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
315
self._transport = transport
316
self._escaped_name = escaped_name
317
self._file_modebits = file_modebits
318
self._dir_modebits = dir_modebits
320
def break_lock(self):
321
raise NotImplementedError(self.break_lock)
323
def lock_write(self):
324
self._lock = self._transport.lock_write(self._escaped_name)
327
self._lock = self._transport.lock_read(self._escaped_name)
334
raise NotImplementedError()
336
def create(self, mode=None):
337
"""Create lock mechanism"""
338
# for old-style locks, create the file now
339
self._transport.put(self._escaped_name, StringIO(),
340
mode=self._file_modebits)
added
removed
bzrlib/lockable_files.py
