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
21
from bzrlib.decorators import *
22
import bzrlib.errors as errors
23
from bzrlib.errors import LockError, ReadOnlyError
24
from bzrlib.osutils import file_iterator, safe_unicode
25
from bzrlib.symbol_versioning import *
26
from bzrlib.trace import mutter
27
import bzrlib.transactions as transactions
29
# XXX: The tracking here of lock counts and whether the lock is held is
30
# somewhat redundant with what's done in LockDir; the main difference is that
31
# LockableFiles permits reentrancy.
33
class LockableFiles(object):
34
"""Object representing a set of related files locked within the same scope.
36
These files are used by a WorkingTree, Repository or Branch, and should
37
generally only be touched by that object.
39
LockableFiles also provides some policy on top of Transport for encoding
40
control files as utf-8.
42
LockableFiles manage a lock count and can be locked repeatedly by
43
a single caller. (The underlying lock implementation generally does not
46
Instances of this class are often called control_files.
48
This object builds on top of a Transport, which is used to actually write
49
the files to disk, and an OSLock or LockDir, which controls how access to
50
the files is controlled. The particular type of locking used is set when
51
the object is constructed. In older formats OSLocks are used everywhere.
52
in newer formats a LockDir is used for Repositories and Branches, and
53
OSLocks for the local filesystem.
56
# _lock_mode: None, or 'r' or 'w'
58
# _lock_count: If _lock_mode is true, a positive count of the number of
59
# times the lock has been taken *by this process*.
61
# If set to False (by a plugin, etc) BzrBranch will not set the
62
# mode on created files or directories
66
def __init__(self, transport, lock_name, lock_class):
67
"""Create a LockableFiles group
69
:param transport: Transport pointing to the directory holding the
70
control files and lock.
71
:param lock_name: Name of the lock guarding these files.
72
:param lock_class: Class of lock strategy to use: typically
73
either LockDir or TransportLock.
76
self._transport = transport
77
self.lock_name = lock_name
78
self._transaction = None
80
self._lock_mode = None
82
esc_name = self._escape(lock_name)
83
self._lock = lock_class(transport, esc_name,
84
file_modebits=self._file_mode,
85
dir_modebits=self._dir_mode)
87
def create_lock(self):
90
This should normally be called only when the LockableFiles directory
91
is first created on disk.
96
return '%s(%r)' % (self.__class__.__name__,
99
def _escape(self, file_or_path):
100
if not isinstance(file_or_path, basestring):
101
file_or_path = '/'.join(file_or_path)
102
if file_or_path == '':
104
return bzrlib.transport.urlescape(safe_unicode(file_or_path))
106
def _find_modes(self):
107
"""Determine the appropriate modes for files and directories."""
109
st = self._transport.stat('.')
110
except errors.TransportNotPossible:
111
self._dir_mode = 0755
112
self._file_mode = 0644
114
self._dir_mode = st.st_mode & 07777
115
# Remove the sticky and execute bits for files
116
self._file_mode = self._dir_mode & ~07111
117
if not self._set_dir_mode:
118
self._dir_mode = None
119
if not self._set_file_mode:
120
self._file_mode = None
122
def controlfilename(self, file_or_path):
123
"""Return location relative to branch."""
124
return self._transport.abspath(self._escape(file_or_path))
126
@deprecated_method(zero_eight)
127
def controlfile(self, file_or_path, mode='r'):
128
"""Open a control file for this branch.
130
There are two classes of file in a lockable directory: text
131
and binary. binary files are untranslated byte streams. Text
132
control files are stored with Unix newlines and in UTF-8, even
133
if the platform or locale defaults are different.
135
Such files are not openable in write mode : they are managed via
136
put and put_utf8 which atomically replace old versions using
140
relpath = self._escape(file_or_path)
141
# TODO: codecs.open() buffers linewise, so it was overloaded with
142
# a much larger buffer, do we need to do the same for getreader/getwriter?
144
return self.get(relpath)
146
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
148
return self.get_utf8(relpath)
150
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
152
raise BzrError("invalid controlfile mode %r" % mode)
155
def get(self, relpath):
156
"""Get a file as a bytestream."""
157
relpath = self._escape(relpath)
158
return self._transport.get(relpath)
161
def get_utf8(self, relpath):
162
"""Get a file as a unicode stream."""
163
relpath = self._escape(relpath)
164
# DO NOT introduce an errors=replace here.
165
return codecs.getreader('utf-8')(self._transport.get(relpath))
168
def put(self, path, file):
171
:param path: The path to put the file, relative to the .bzr control
173
:param f: A file-like or string object whose contents should be copied.
175
self._transport.put(self._escape(path), file, mode=self._file_mode)
178
def put_utf8(self, path, a_string):
179
"""Write a string, encoding as utf-8.
181
:param path: The path to put the string, relative to the transport root.
182
:param string: A file-like or string object whose contents should be copied.
184
# IterableFile would not be needed if Transport.put took iterables
185
# instead of files. ADHB 2005-12-25
186
# RBC 20060103 surely its not needed anyway, with codecs transcode
188
# JAM 20060103 We definitely don't want encode(..., 'replace')
189
# these are valuable files which should have exact contents.
190
if not isinstance(a_string, basestring):
191
raise errors.BzrBadParameterNotString(a_string)
192
self.put(path, StringIO(a_string.encode('utf-8')))
194
def lock_write(self):
195
# mutter("lock write: %s (%s)", self, self._lock_count)
196
# TODO: Upgrade locking to support using a Transport,
197
# and potentially a remote locking protocol
199
if self._lock_mode != 'w':
200
raise ReadOnlyError(self)
201
self._lock_count += 1
203
self._lock.lock_write()
204
self._lock_mode = 'w'
206
self._set_transaction(transactions.PassThroughTransaction())
209
# mutter("lock read: %s (%s)", self, self._lock_count)
211
assert self._lock_mode in ('r', 'w'), \
212
"invalid lock mode %r" % self._lock_mode
213
self._lock_count += 1
215
self._lock.lock_read()
216
self._lock_mode = 'r'
218
self._set_transaction(transactions.ReadOnlyTransaction())
219
# 5K may be excessive, but hey, its a knob.
220
self.get_transaction().set_cache_size(5000)
223
# mutter("unlock: %s (%s)", self, self._lock_count)
224
if not self._lock_mode:
225
raise errors.LockNotHeld(self)
226
if self._lock_count > 1:
227
self._lock_count -= 1
229
self._finish_transaction()
231
self._lock_mode = self._lock_count = None
234
"""Return true if this LockableFiles group is locked"""
235
return self._lock_count >= 1
237
def get_transaction(self):
238
"""Return the current active transaction.
240
If no transaction is active, this returns a passthrough object
241
for which all data is immediately flushed and no caching happens.
243
if self._transaction is None:
244
return transactions.PassThroughTransaction()
246
return self._transaction
248
def _set_transaction(self, new_transaction):
249
"""Set a new active transaction."""
250
if self._transaction is not None:
251
raise errors.LockError('Branch %s is in a transaction already.' %
253
self._transaction = new_transaction
255
def _finish_transaction(self):
256
"""Exit the current transaction."""
257
if self._transaction is None:
258
raise errors.LockError('Branch %s is not in a transaction' %
260
transaction = self._transaction
261
self._transaction = None
265
class TransportLock(object):
266
"""Locking method which uses transport-dependent locks.
268
On the local filesystem these transform into OS-managed locks.
270
These do not guard against concurrent access via different
273
This is suitable for use only in WorkingTrees (which are at present
276
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
277
self._transport = transport
278
self._escaped_name = escaped_name
279
self._file_modebits = file_modebits
280
self._dir_modebits = dir_modebits
282
def lock_write(self):
283
self._lock = self._transport.lock_write(self._escaped_name)
286
self._lock = self._transport.lock_read(self._escaped_name)
293
"""Create lock mechanism"""
294
# for old-style locks, create the file now
295
self._transport.put(self._escaped_name, StringIO(),
296
mode=self._file_modebits)
added
removed
bzrlib/lockable_files.py
