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=None):
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
if lock_class is None:
84
warn("LockableFiles: lock_class is now a mandatory parameter",
85
DeprecationWarning, stacklevel=2)
86
lock_class = TransportLock
87
self._lock = lock_class(transport, esc_name)
90
return '%s(%r)' % (self.__class__.__name__,
93
def _escape(self, file_or_path):
94
if not isinstance(file_or_path, basestring):
95
file_or_path = '/'.join(file_or_path)
96
if file_or_path == '':
98
return bzrlib.transport.urlescape(safe_unicode(file_or_path))
100
def _find_modes(self):
101
"""Determine the appropriate modes for files and directories."""
103
st = self._transport.stat('.')
104
except errors.TransportNotPossible:
105
self._dir_mode = 0755
106
self._file_mode = 0644
108
self._dir_mode = st.st_mode & 07777
109
# Remove the sticky and execute bits for files
110
self._file_mode = self._dir_mode & ~07111
111
if not self._set_dir_mode:
112
self._dir_mode = None
113
if not self._set_file_mode:
114
self._file_mode = None
116
def controlfilename(self, file_or_path):
117
"""Return location relative to branch."""
118
return self._transport.abspath(self._escape(file_or_path))
120
@deprecated_method(zero_eight)
121
def controlfile(self, file_or_path, mode='r'):
122
"""Open a control file for this branch.
124
There are two classes of file in a lockable directory: text
125
and binary. binary files are untranslated byte streams. Text
126
control files are stored with Unix newlines and in UTF-8, even
127
if the platform or locale defaults are different.
129
Such files are not openable in write mode : they are managed via
130
put and put_utf8 which atomically replace old versions using
134
relpath = self._escape(file_or_path)
135
# TODO: codecs.open() buffers linewise, so it was overloaded with
136
# a much larger buffer, do we need to do the same for getreader/getwriter?
138
return self.get(relpath)
140
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
142
return self.get_utf8(relpath)
144
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
146
raise BzrError("invalid controlfile mode %r" % mode)
149
def get(self, relpath):
150
"""Get a file as a bytestream."""
151
relpath = self._escape(relpath)
152
return self._transport.get(relpath)
155
def get_utf8(self, relpath):
156
"""Get a file as a unicode stream."""
157
relpath = self._escape(relpath)
158
# DO NOT introduce an errors=replace here.
159
return codecs.getreader('utf-8')(self._transport.get(relpath))
162
def put(self, path, file):
165
:param path: The path to put the file, relative to the .bzr control
167
:param f: A file-like or string object whose contents should be copied.
169
self._transport.put(self._escape(path), file, mode=self._file_mode)
172
def put_utf8(self, path, a_string):
173
"""Write a string, encoding as utf-8.
175
:param path: The path to put the string, relative to the transport root.
176
:param string: A file-like or string object whose contents should be copied.
178
# IterableFile would not be needed if Transport.put took iterables
179
# instead of files. ADHB 2005-12-25
180
# RBC 20060103 surely its not needed anyway, with codecs transcode
182
# JAM 20060103 We definitely don't want encode(..., 'replace')
183
# these are valuable files which should have exact contents.
184
if not isinstance(a_string, basestring):
185
raise errors.BzrBadParameterNotString(a_string)
186
self.put(path, StringIO(a_string.encode('utf-8')))
188
def lock_write(self):
189
# mutter("lock write: %s (%s)", self, self._lock_count)
190
# TODO: Upgrade locking to support using a Transport,
191
# and potentially a remote locking protocol
193
if self._lock_mode != 'w':
194
raise ReadOnlyError(self)
195
self._lock_count += 1
197
self._lock.lock_write()
198
self._lock_mode = 'w'
200
self._set_transaction(transactions.PassThroughTransaction())
203
# mutter("lock read: %s (%s)", self, self._lock_count)
205
assert self._lock_mode in ('r', 'w'), \
206
"invalid lock mode %r" % self._lock_mode
207
self._lock_count += 1
209
self._lock.lock_read()
210
self._lock_mode = 'r'
212
self._set_transaction(transactions.ReadOnlyTransaction())
213
# 5K may be excessive, but hey, its a knob.
214
self.get_transaction().set_cache_size(5000)
217
# mutter("unlock: %s (%s)", self, self._lock_count)
218
if not self._lock_mode:
219
raise errors.LockNotHeld(self)
220
if self._lock_count > 1:
221
self._lock_count -= 1
223
self._finish_transaction()
225
self._lock_mode = self._lock_count = None
228
"""Return true if this LockableFiles group is locked"""
229
return self._lock_count >= 1
231
def get_transaction(self):
232
"""Return the current active transaction.
234
If no transaction is active, this returns a passthrough object
235
for which all data is immediately flushed and no caching happens.
237
if self._transaction is None:
238
return transactions.PassThroughTransaction()
240
return self._transaction
242
def _set_transaction(self, new_transaction):
243
"""Set a new active transaction."""
244
if self._transaction is not None:
245
raise errors.LockError('Branch %s is in a transaction already.' %
247
self._transaction = new_transaction
249
def _finish_transaction(self):
250
"""Exit the current transaction."""
251
if self._transaction is None:
252
raise errors.LockError('Branch %s is not in a transaction' %
254
transaction = self._transaction
255
self._transaction = None
259
class TransportLock(object):
260
"""Locking method which uses transport-dependent locks.
262
On the local filesystem these transform into OS-managed locks.
264
These do not guard against concurrent access via different
267
This is suitable for use only in WorkingTrees (which are at present
270
def __init__(self, transport, escaped_name):
271
self._transport = transport
272
self._escaped_name = escaped_name
274
def lock_write(self):
275
self._lock = self._transport.lock_write(self._escaped_name)
278
self._lock = self._transport.lock_read(self._escaped_name)
284
# TODO: for old locks we have to manually create the file the first time
285
# it's used; this should be here too.
added
removed
bzrlib/lockable_files.py
