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
29
import bzrlib.urlutils as urlutils
32
# XXX: The tracking here of lock counts and whether the lock is held is
33
# somewhat redundant with what's done in LockDir; the main difference is that
34
# LockableFiles permits reentrancy.
36
class LockableFiles(object):
37
"""Object representing a set of related files locked within the same scope.
39
These files are used by a WorkingTree, Repository or Branch, and should
40
generally only be touched by that object.
42
LockableFiles also provides some policy on top of Transport for encoding
43
control files as utf-8.
45
LockableFiles manage a lock count and can be locked repeatedly by
46
a single caller. (The underlying lock implementation generally does not
49
Instances of this class are often called control_files.
51
This object builds on top of a Transport, which is used to actually write
52
the files to disk, and an OSLock or LockDir, which controls how access to
53
the files is controlled. The particular type of locking used is set when
54
the object is constructed. In older formats OSLocks are used everywhere.
55
in newer formats a LockDir is used for Repositories and Branches, and
56
OSLocks for the local filesystem.
59
# _lock_mode: None, or 'r' or 'w'
61
# _lock_count: If _lock_mode is true, a positive count of the number of
62
# times the lock has been taken *by this process*.
64
# If set to False (by a plugin, etc) BzrBranch will not set the
65
# mode on created files or directories
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
# XXX: This should show something every time, and be suitable for
106
# headless operation and embedding
107
from warnings import warn
108
warn("file group %r was not explicitly unlocked" % self)
111
def break_lock(self):
112
"""Break the lock of this lockable files group if it is held.
114
The current ui factory will be used to prompt for user conformation.
116
self._lock.break_lock()
118
def _escape(self, file_or_path):
119
if not isinstance(file_or_path, basestring):
120
file_or_path = '/'.join(file_or_path)
121
if file_or_path == '':
123
return urlutils.escape(safe_unicode(file_or_path))
125
def _find_modes(self):
126
"""Determine the appropriate modes for files and directories."""
128
st = self._transport.stat('.')
129
except errors.TransportNotPossible:
130
self._dir_mode = 0755
131
self._file_mode = 0644
133
self._dir_mode = st.st_mode & 07777
134
# Remove the sticky and execute bits for files
135
self._file_mode = self._dir_mode & ~07111
136
if not self._set_dir_mode:
137
self._dir_mode = None
138
if not self._set_file_mode:
139
self._file_mode = None
141
def controlfilename(self, file_or_path):
142
"""Return location relative to branch."""
143
return self._transport.abspath(self._escape(file_or_path))
145
@deprecated_method(zero_eight)
146
def controlfile(self, file_or_path, mode='r'):
147
"""Open a control file for this branch.
149
There are two classes of file in a lockable directory: text
150
and binary. binary files are untranslated byte streams. Text
151
control files are stored with Unix newlines and in UTF-8, even
152
if the platform or locale defaults are different.
154
Such files are not openable in write mode : they are managed via
155
put and put_utf8 which atomically replace old versions using
159
relpath = self._escape(file_or_path)
160
# TODO: codecs.open() buffers linewise, so it was overloaded with
161
# a much larger buffer, do we need to do the same for getreader/getwriter?
163
return self.get(relpath)
165
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
167
return self.get_utf8(relpath)
169
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
171
raise BzrError("invalid controlfile mode %r" % mode)
174
def get(self, relpath):
175
"""Get a file as a bytestream."""
176
relpath = self._escape(relpath)
177
return self._transport.get(relpath)
180
def get_utf8(self, relpath):
181
"""Get a file as a unicode stream."""
182
relpath = self._escape(relpath)
183
# DO NOT introduce an errors=replace here.
184
return codecs.getreader('utf-8')(self._transport.get(relpath))
187
def put(self, path, file):
190
:param path: The path to put the file, relative to the .bzr control
192
:param f: A file-like or string object whose contents should be copied.
194
self._transport.put(self._escape(path), file, mode=self._file_mode)
197
def put_utf8(self, path, a_string):
198
"""Write a string, encoding as utf-8.
200
:param path: The path to put the string, relative to the transport root.
201
:param string: A file-like or string object whose contents should be copied.
203
# IterableFile would not be needed if Transport.put took iterables
204
# instead of files. ADHB 2005-12-25
205
# RBC 20060103 surely its not needed anyway, with codecs transcode
207
# JAM 20060103 We definitely don't want encode(..., 'replace')
208
# these are valuable files which should have exact contents.
209
if not isinstance(a_string, basestring):
210
raise errors.BzrBadParameterNotString(a_string)
211
self.put(path, StringIO(a_string.encode('utf-8')))
213
def lock_write(self):
214
# mutter("lock write: %s (%s)", self, self._lock_count)
215
# TODO: Upgrade locking to support using a Transport,
216
# and potentially a remote locking protocol
218
if self._lock_mode != 'w' or not self.get_transaction().writeable():
219
raise errors.ReadOnlyError(self)
220
self._lock_count += 1
222
self._lock.lock_write()
223
#note('write locking %s', self)
224
#traceback.print_stack()
225
self._lock_mode = 'w'
227
self._set_transaction(transactions.WriteTransaction())
230
# mutter("lock read: %s (%s)", self, self._lock_count)
232
assert self._lock_mode in ('r', 'w'), \
233
"invalid lock mode %r" % self._lock_mode
234
self._lock_count += 1
236
self._lock.lock_read()
237
#note('read locking %s', self)
238
#traceback.print_stack()
239
self._lock_mode = 'r'
241
self._set_transaction(transactions.ReadOnlyTransaction())
242
# 5K may be excessive, but hey, its a knob.
243
self.get_transaction().set_cache_size(5000)
246
# mutter("unlock: %s (%s)", self, self._lock_count)
247
if not self._lock_mode:
248
raise errors.LockNotHeld(self)
249
if self._lock_count > 1:
250
self._lock_count -= 1
252
#note('unlocking %s', self)
253
#traceback.print_stack()
254
self._finish_transaction()
258
self._lock_mode = self._lock_count = None
261
"""Return true if this LockableFiles group is locked"""
262
return self._lock_count >= 1
264
def get_physical_lock_status(self):
265
"""Return physical lock status.
267
Returns true if a lock is held on the transport. If no lock is held, or
268
the underlying locking mechanism does not support querying lock
269
status, false is returned.
272
return self._lock.peek() is not None
273
except NotImplementedError:
276
def get_transaction(self):
277
"""Return the current active transaction.
279
If no transaction is active, this returns a passthrough object
280
for which all data is immediately flushed and no caching happens.
282
if self._transaction is None:
283
return transactions.PassThroughTransaction()
285
return self._transaction
287
def _set_transaction(self, new_transaction):
288
"""Set a new active transaction."""
289
if self._transaction is not None:
290
raise errors.LockError('Branch %s is in a transaction already.' %
292
self._transaction = new_transaction
294
def _finish_transaction(self):
295
"""Exit the current transaction."""
296
if self._transaction is None:
297
raise errors.LockError('Branch %s is not in a transaction' %
299
transaction = self._transaction
300
self._transaction = None
304
class TransportLock(object):
305
"""Locking method which uses transport-dependent locks.
307
On the local filesystem these transform into OS-managed locks.
309
These do not guard against concurrent access via different
312
This is suitable for use only in WorkingTrees (which are at present
315
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
316
self._transport = transport
317
self._escaped_name = escaped_name
318
self._file_modebits = file_modebits
319
self._dir_modebits = dir_modebits
321
def break_lock(self):
322
raise NotImplementedError(self.break_lock)
324
def lock_write(self):
325
self._lock = self._transport.lock_write(self._escaped_name)
328
self._lock = self._transport.lock_read(self._escaped_name)
335
raise NotImplementedError()
337
def create(self, mode=None):
338
"""Create lock mechanism"""
339
# for old-style locks, create the file now
340
self._transport.put(self._escaped_name, StringIO(),
341
mode=self._file_modebits)
added
removed
bzrlib/lockable_files.py
