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 LockError, ReadOnlyError
25
from bzrlib.osutils import file_iterator, safe_unicode
26
from bzrlib.symbol_versioning import *
27
from bzrlib.symbol_versioning import deprecated_method, zero_eight
28
from bzrlib.trace import mutter, note
29
import bzrlib.transactions as transactions
31
# XXX: The tracking here of lock counts and whether the lock is held is
32
# somewhat redundant with what's done in LockDir; the main difference is that
33
# LockableFiles permits reentrancy.
35
class LockableFiles(object):
36
"""Object representing a set of related files locked within the same scope.
38
These files are used by a WorkingTree, Repository or Branch, and should
39
generally only be touched by that object.
41
LockableFiles also provides some policy on top of Transport for encoding
42
control files as utf-8.
44
LockableFiles manage a lock count and can be locked repeatedly by
45
a single caller. (The underlying lock implementation generally does not
48
Instances of this class are often called control_files.
50
This object builds on top of a Transport, which is used to actually write
51
the files to disk, and an OSLock or LockDir, which controls how access to
52
the files is controlled. The particular type of locking used is set when
53
the object is constructed. In older formats OSLocks are used everywhere.
54
in newer formats a LockDir is used for Repositories and Branches, and
55
OSLocks for the local filesystem.
58
# _lock_mode: None, or 'r' or 'w'
60
# _lock_count: If _lock_mode is true, a positive count of the number of
61
# times the lock has been taken *by this process*.
63
# If set to False (by a plugin, etc) BzrBranch will not set the
64
# mode on created files or directories
68
def __init__(self, transport, lock_name, lock_class):
69
"""Create a LockableFiles group
71
:param transport: Transport pointing to the directory holding the
72
control files and lock.
73
:param lock_name: Name of the lock guarding these files.
74
:param lock_class: Class of lock strategy to use: typically
75
either LockDir or TransportLock.
78
self._transport = transport
79
self.lock_name = lock_name
80
self._transaction = None
82
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.
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 _escape(self, file_or_path):
112
if not isinstance(file_or_path, basestring):
113
file_or_path = '/'.join(file_or_path)
114
if file_or_path == '':
116
return bzrlib.transport.urlescape(safe_unicode(file_or_path))
118
def _find_modes(self):
119
"""Determine the appropriate modes for files and directories."""
121
st = self._transport.stat('.')
122
except errors.TransportNotPossible:
123
self._dir_mode = 0755
124
self._file_mode = 0644
126
self._dir_mode = st.st_mode & 07777
127
# Remove the sticky and execute bits for files
128
self._file_mode = self._dir_mode & ~07111
129
if not self._set_dir_mode:
130
self._dir_mode = None
131
if not self._set_file_mode:
132
self._file_mode = None
134
def controlfilename(self, file_or_path):
135
"""Return location relative to branch."""
136
return self._transport.abspath(self._escape(file_or_path))
138
@deprecated_method(zero_eight)
139
def controlfile(self, file_or_path, mode='r'):
140
"""Open a control file for this branch.
142
There are two classes of file in a lockable directory: text
143
and binary. binary files are untranslated byte streams. Text
144
control files are stored with Unix newlines and in UTF-8, even
145
if the platform or locale defaults are different.
147
Such files are not openable in write mode : they are managed via
148
put and put_utf8 which atomically replace old versions using
152
relpath = self._escape(file_or_path)
153
# TODO: codecs.open() buffers linewise, so it was overloaded with
154
# a much larger buffer, do we need to do the same for getreader/getwriter?
156
return self.get(relpath)
158
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
160
return self.get_utf8(relpath)
162
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
164
raise BzrError("invalid controlfile mode %r" % mode)
167
def get(self, relpath):
168
"""Get a file as a bytestream."""
169
relpath = self._escape(relpath)
170
return self._transport.get(relpath)
173
def get_utf8(self, relpath):
174
"""Get a file as a unicode stream."""
175
relpath = self._escape(relpath)
176
# DO NOT introduce an errors=replace here.
177
return codecs.getreader('utf-8')(self._transport.get(relpath))
180
def put(self, path, file):
183
:param path: The path to put the file, relative to the .bzr control
185
:param f: A file-like or string object whose contents should be copied.
187
self._transport.put(self._escape(path), file, 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 file-like or string 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(path, StringIO(a_string.encode('utf-8')))
206
def lock_write(self):
207
# mutter("lock write: %s (%s)", self, self._lock_count)
208
# TODO: Upgrade locking to support using a Transport,
209
# and potentially a remote locking protocol
211
if self._lock_mode != 'w' or not self.get_transaction().writeable():
212
raise ReadOnlyError(self)
213
self._lock_count += 1
215
self._lock.lock_write()
216
#note('write locking %s', self)
217
#traceback.print_stack()
218
self._lock_mode = 'w'
220
self._set_transaction(transactions.WriteTransaction())
223
# mutter("lock read: %s (%s)", self, self._lock_count)
225
assert self._lock_mode in ('r', 'w'), \
226
"invalid lock mode %r" % self._lock_mode
227
self._lock_count += 1
229
self._lock.lock_read()
230
#note('read locking %s', self)
231
#traceback.print_stack()
232
self._lock_mode = 'r'
234
self._set_transaction(transactions.ReadOnlyTransaction())
235
# 5K may be excessive, but hey, its a knob.
236
self.get_transaction().set_cache_size(5000)
239
# mutter("unlock: %s (%s)", self, self._lock_count)
240
if not self._lock_mode:
241
raise errors.LockNotHeld(self)
242
if self._lock_count > 1:
243
self._lock_count -= 1
245
#note('unlocking %s', self)
246
#traceback.print_stack()
247
self._finish_transaction()
249
self._lock_mode = self._lock_count = None
252
"""Return true if this LockableFiles group is locked"""
253
return self._lock_count >= 1
255
def get_transaction(self):
256
"""Return the current active transaction.
258
If no transaction is active, this returns a passthrough object
259
for which all data is immediately flushed and no caching happens.
261
if self._transaction is None:
262
return transactions.PassThroughTransaction()
264
return self._transaction
266
def _set_transaction(self, new_transaction):
267
"""Set a new active transaction."""
268
if self._transaction is not None:
269
raise errors.LockError('Branch %s is in a transaction already.' %
271
self._transaction = new_transaction
273
def _finish_transaction(self):
274
"""Exit the current transaction."""
275
if self._transaction is None:
276
raise errors.LockError('Branch %s is not in a transaction' %
278
transaction = self._transaction
279
self._transaction = None
283
class TransportLock(object):
284
"""Locking method which uses transport-dependent locks.
286
On the local filesystem these transform into OS-managed locks.
288
These do not guard against concurrent access via different
291
This is suitable for use only in WorkingTrees (which are at present
294
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
295
self._transport = transport
296
self._escaped_name = escaped_name
297
self._file_modebits = file_modebits
298
self._dir_modebits = dir_modebits
300
def lock_write(self):
301
self._lock = self._transport.lock_write(self._escaped_name)
304
self._lock = self._transport.lock_read(self._escaped_name)
311
"""Create lock mechanism"""
312
# for old-style locks, create the file now
313
self._transport.put(self._escaped_name, StringIO(),
314
mode=self._file_modebits)
added
removed
bzrlib/lockable_files.py
