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 _escape(self, file_or_path):
111
if not isinstance(file_or_path, basestring):
112
file_or_path = '/'.join(file_or_path)
113
if file_or_path == '':
115
return bzrlib.transport.urlescape(safe_unicode(file_or_path))
117
def _find_modes(self):
118
"""Determine the appropriate modes for files and directories."""
120
st = self._transport.stat('.')
121
except errors.TransportNotPossible:
122
self._dir_mode = 0755
123
self._file_mode = 0644
125
self._dir_mode = st.st_mode & 07777
126
# Remove the sticky and execute bits for files
127
self._file_mode = self._dir_mode & ~07111
128
if not self._set_dir_mode:
129
self._dir_mode = None
130
if not self._set_file_mode:
131
self._file_mode = None
133
def controlfilename(self, file_or_path):
134
"""Return location relative to branch."""
135
return self._transport.abspath(self._escape(file_or_path))
137
@deprecated_method(zero_eight)
138
def controlfile(self, file_or_path, mode='r'):
139
"""Open a control file for this branch.
141
There are two classes of file in a lockable directory: text
142
and binary. binary files are untranslated byte streams. Text
143
control files are stored with Unix newlines and in UTF-8, even
144
if the platform or locale defaults are different.
146
Such files are not openable in write mode : they are managed via
147
put and put_utf8 which atomically replace old versions using
151
relpath = self._escape(file_or_path)
152
# TODO: codecs.open() buffers linewise, so it was overloaded with
153
# a much larger buffer, do we need to do the same for getreader/getwriter?
155
return self.get(relpath)
157
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
159
return self.get_utf8(relpath)
161
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
163
raise BzrError("invalid controlfile mode %r" % mode)
166
def get(self, relpath):
167
"""Get a file as a bytestream."""
168
relpath = self._escape(relpath)
169
return self._transport.get(relpath)
172
def get_utf8(self, relpath):
173
"""Get a file as a unicode stream."""
174
relpath = self._escape(relpath)
175
# DO NOT introduce an errors=replace here.
176
return codecs.getreader('utf-8')(self._transport.get(relpath))
179
def put(self, path, file):
182
:param path: The path to put the file, relative to the .bzr control
184
:param f: A file-like or string object whose contents should be copied.
186
self._transport.put(self._escape(path), file, mode=self._file_mode)
189
def put_utf8(self, path, a_string):
190
"""Write a string, encoding as utf-8.
192
:param path: The path to put the string, relative to the transport root.
193
:param string: A file-like or string object whose contents should be copied.
195
# IterableFile would not be needed if Transport.put took iterables
196
# instead of files. ADHB 2005-12-25
197
# RBC 20060103 surely its not needed anyway, with codecs transcode
199
# JAM 20060103 We definitely don't want encode(..., 'replace')
200
# these are valuable files which should have exact contents.
201
if not isinstance(a_string, basestring):
202
raise errors.BzrBadParameterNotString(a_string)
203
self.put(path, StringIO(a_string.encode('utf-8')))
205
def lock_write(self):
206
# mutter("lock write: %s (%s)", self, self._lock_count)
207
# TODO: Upgrade locking to support using a Transport,
208
# and potentially a remote locking protocol
210
if self._lock_mode != 'w' or not self.get_transaction().writeable():
211
raise errors.ReadOnlyError(self)
212
self._lock_count += 1
214
self._lock.lock_write()
215
#note('write locking %s', self)
216
#traceback.print_stack()
217
self._lock_mode = 'w'
219
self._set_transaction(transactions.WriteTransaction())
222
# mutter("lock read: %s (%s)", self, self._lock_count)
224
assert self._lock_mode in ('r', 'w'), \
225
"invalid lock mode %r" % self._lock_mode
226
self._lock_count += 1
228
self._lock.lock_read()
229
#note('read locking %s', self)
230
#traceback.print_stack()
231
self._lock_mode = 'r'
233
self._set_transaction(transactions.ReadOnlyTransaction())
234
# 5K may be excessive, but hey, its a knob.
235
self.get_transaction().set_cache_size(5000)
238
# mutter("unlock: %s (%s)", self, self._lock_count)
239
if not self._lock_mode:
240
raise errors.LockNotHeld(self)
241
if self._lock_count > 1:
242
self._lock_count -= 1
244
#note('unlocking %s', self)
245
#traceback.print_stack()
246
self._finish_transaction()
248
self._lock_mode = self._lock_count = None
251
"""Return true if this LockableFiles group is locked"""
252
return self._lock_count >= 1
254
def get_physical_lock_status(self):
255
"""Return physical lock status.
257
Returns true if a lock is held on the transport. If no lock is held, or
258
the underlying locking mechanism does not support querying lock
259
status, false is returned.
262
return self._lock.peek() is not None
263
except NotImplementedError:
266
def get_transaction(self):
267
"""Return the current active transaction.
269
If no transaction is active, this returns a passthrough object
270
for which all data is immediately flushed and no caching happens.
272
if self._transaction is None:
273
return transactions.PassThroughTransaction()
275
return self._transaction
277
def _set_transaction(self, new_transaction):
278
"""Set a new active transaction."""
279
if self._transaction is not None:
280
raise errors.LockError('Branch %s is in a transaction already.' %
282
self._transaction = new_transaction
284
def _finish_transaction(self):
285
"""Exit the current transaction."""
286
if self._transaction is None:
287
raise errors.LockError('Branch %s is not in a transaction' %
289
transaction = self._transaction
290
self._transaction = None
294
class TransportLock(object):
295
"""Locking method which uses transport-dependent locks.
297
On the local filesystem these transform into OS-managed locks.
299
These do not guard against concurrent access via different
302
This is suitable for use only in WorkingTrees (which are at present
305
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
306
self._transport = transport
307
self._escaped_name = escaped_name
308
self._file_modebits = file_modebits
309
self._dir_modebits = dir_modebits
311
def lock_write(self):
312
self._lock = self._transport.lock_write(self._escaped_name)
315
self._lock = self._transport.lock_read(self._escaped_name)
322
raise NotImplementedError()
324
def create(self, mode=None):
325
"""Create lock mechanism"""
326
# for old-style locks, create the file now
327
self._transport.put(self._escaped_name, StringIO(),
328
mode=self._file_modebits)
added
removed
bzrlib/lockable_files.py
