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 (needs_read_lock,
2
24
import bzrlib.errors as errors
3
from bzrlib.errors import LockError, ReadOnlyError
4
from bzrlib.trace import mutter
25
from bzrlib.errors import BzrError
26
from bzrlib.osutils import file_iterator, safe_unicode
27
from bzrlib.symbol_versioning import (deprecated_method,
29
from bzrlib.trace import mutter, note
5
30
import bzrlib.transactions as transactions
6
from osutils import file_iterator
31
import bzrlib.urlutils as urlutils
34
# XXX: The tracking here of lock counts and whether the lock is held is
35
# somewhat redundant with what's done in LockDir; the main difference is that
36
# LockableFiles permits reentrancy.
8
38
class LockableFiles(object):
9
"""Object representing a set of lockable files
15
If _lock_mode is true, a positive count of the number of times the
19
Lock object from bzrlib.lock.
39
"""Object representing a set of related files locked within the same scope.
41
These files are used by a WorkingTree, Repository or Branch, and should
42
generally only be touched by that object.
44
LockableFiles also provides some policy on top of Transport for encoding
45
control files as utf-8.
47
LockableFiles manage a lock count and can be locked repeatedly by
48
a single caller. (The underlying lock implementation generally does not
51
Instances of this class are often called control_files.
53
This object builds on top of a Transport, which is used to actually write
54
the files to disk, and an OSLock or LockDir, which controls how access to
55
the files is controlled. The particular type of locking used is set when
56
the object is constructed. In older formats OSLocks are used everywhere.
57
in newer formats a LockDir is used for Repositories and Branches, and
58
OSLocks for the local filesystem.
61
# _lock_mode: None, or 'r' or 'w'
63
# _lock_count: If _lock_mode is true, a positive count of the number of
64
# times the lock has been taken *by this process*.
25
66
# If set to False (by a plugin, etc) BzrBranch will not set the
26
67
# mode on created files or directories
27
68
_set_file_mode = True
28
69
_set_dir_mode = True
30
def __init__(self, transport, lock_name):
71
def __init__(self, transport, lock_name, lock_class):
72
"""Create a LockableFiles group
74
:param transport: Transport pointing to the directory holding the
75
control files and lock.
76
:param lock_name: Name of the lock guarding these files.
77
:param lock_class: Class of lock strategy to use: typically
78
either LockDir or TransportLock.
32
80
self._transport = transport
33
81
self.lock_name = lock_name
34
82
self._transaction = None
83
self._lock_mode = None
86
esc_name = self._escape(lock_name)
87
self._lock = lock_class(transport, esc_name,
88
file_modebits=self._file_mode,
89
dir_modebits=self._dir_mode)
91
def create_lock(self):
94
This should normally be called only when the LockableFiles directory
95
is first created on disk.
97
self._lock.create(mode=self._dir_mode)
100
return '%s(%r)' % (self.__class__.__name__,
103
return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
37
105
def __del__(self):
38
if self._lock_mode or self._lock:
39
107
# XXX: This should show something every time, and be suitable for
40
108
# headless operation and embedding
41
109
from warnings import warn
42
110
warn("file group %r was not explicitly unlocked" % self)
43
111
self._lock.unlock()
113
def break_lock(self):
114
"""Break the lock of this lockable files group if it is held.
116
The current ui factory will be used to prompt for user conformation.
118
self._lock.break_lock()
45
120
def _escape(self, file_or_path):
46
121
if not isinstance(file_or_path, basestring):
47
122
file_or_path = '/'.join(file_or_path)
48
123
if file_or_path == '':
50
return bzrlib.transport.urlescape(unicode(file_or_path))
125
return urlutils.escape(safe_unicode(file_or_path))
52
127
def _find_modes(self):
53
128
"""Determine the appropriate modes for files and directories."""
56
st = self._transport.stat(u'.')
57
except errors.NoSuchFile:
58
# The .bzr/ directory doesn't exist, try to
59
# inherit the permissions from the parent directory
60
# but only try 1 level up
61
temp_transport = self._transport.clone('..')
62
st = temp_transport.stat(u'.')
63
except (errors.TransportNotPossible, errors.NoSuchFile):
130
st = self._transport.stat('.')
131
except errors.TransportNotPossible:
64
132
self._dir_mode = 0755
65
133
self._file_mode = 0644
76
144
"""Return location relative to branch."""
77
145
return self._transport.abspath(self._escape(file_or_path))
147
@deprecated_method(zero_eight)
79
148
def controlfile(self, file_or_path, mode='r'):
80
149
"""Open a control file for this branch.
82
There are two classes of file in the control directory: text
151
There are two classes of file in a lockable directory: text
83
152
and binary. binary files are untranslated byte streams. Text
84
153
control files are stored with Unix newlines and in UTF-8, even
85
154
if the platform or locale defaults are different.
87
Controlfiles should almost never be opened in write mode but
88
rather should be atomically copied and replaced using atomicfile.
156
Such files are not openable in write mode : they are managed via
157
put and put_utf8 which atomically replace old versions using
92
161
relpath = self._escape(file_or_path)
93
#TODO: codecs.open() buffers linewise, so it was overloaded with
162
# TODO: codecs.open() buffers linewise, so it was overloaded with
94
163
# a much larger buffer, do we need to do the same for getreader/getwriter?
96
return self._transport.get(relpath)
165
return self.get(relpath)
97
166
elif mode == 'wb':
98
167
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
100
# XXX: Do we really want errors='replace'? Perhaps it should be
101
# an error, or at least reported, if there's incorrectly-encoded
102
# data inside a file.
103
# <https://launchpad.net/products/bzr/+bug/3823>
104
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
169
return self.get_utf8(relpath)
105
170
elif mode == 'w':
106
171
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
108
173
raise BzrError("invalid controlfile mode %r" % mode)
176
def get(self, relpath):
177
"""Get a file as a bytestream."""
178
relpath = self._escape(relpath)
179
return self._transport.get(relpath)
182
def get_utf8(self, relpath):
183
"""Get a file as a unicode stream."""
184
relpath = self._escape(relpath)
185
# DO NOT introduce an errors=replace here.
186
return codecs.getreader('utf-8')(self._transport.get(relpath))
110
189
def put(self, path, file):
115
194
:param f: A file-like or string object whose contents should be copied.
117
if not self._lock_mode == 'w':
118
raise ReadOnlyError()
119
self._transport.put(self._escape(path), file, mode=self._file_mode)
121
def put_utf8(self, path, file, mode=None):
122
"""Write a file, encoding as utf-8.
124
:param path: The path to put the file, relative to the .bzr control
126
:param f: A file-like or string object whose contents should be copied.
129
from iterablefile import IterableFile
131
if hasattr(file, 'read'):
132
iterator = file_iterator(file)
196
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
199
def put_bytes(self, path, a_string):
200
"""Write a string of bytes.
202
:param path: The path to put the bytes, relative to the transport root.
203
:param string: A string object, whose exact bytes are to be copied.
205
self._transport.put_bytes(self._escape(path), a_string,
206
mode=self._file_mode)
209
def put_utf8(self, path, a_string):
210
"""Write a string, encoding as utf-8.
212
:param path: The path to put the string, relative to the transport root.
213
:param string: A string or unicode object whose contents should be copied.
135
215
# IterableFile would not be needed if Transport.put took iterables
136
216
# instead of files. ADHB 2005-12-25
137
217
# RBC 20060103 surely its not needed anyway, with codecs transcode
139
219
# JAM 20060103 We definitely don't want encode(..., 'replace')
140
220
# these are valuable files which should have exact contents.
141
encoded_file = IterableFile(b.encode('utf-8') for b in
143
self.put(path, encoded_file)
145
def lock_write(self):
146
mutter("lock write: %s (%s)", self, self._lock_count)
221
if not isinstance(a_string, basestring):
222
raise errors.BzrBadParameterNotString(a_string)
223
self.put_bytes(path, a_string.encode('utf-8'))
225
def leave_in_place(self):
226
"""Set this LockableFiles to not clear the physical lock on unlock."""
227
self._lock.leave_in_place()
229
def dont_leave_in_place(self):
230
"""Set this LockableFiles to clear the physical lock on unlock."""
231
self._lock.dont_leave_in_place()
233
def lock_write(self, token=None):
234
"""Lock this group of files for writing.
236
:param token: if this is already locked, then lock_write will fail
237
unless the token matches the existing lock.
238
:returns: a token if this instance supports tokens, otherwise None.
239
:raises TokenLockingNotSupported: when a token is given but this
240
instance doesn't support using token locks.
241
:raises MismatchedToken: if the specified token doesn't match the token
242
of the existing lock.
244
A token should be passed in if you know that you have locked the object
245
some other way, and need to synchronise this object's state with that
248
# mutter("lock write: %s (%s)", self, self._lock_count)
147
249
# TODO: Upgrade locking to support using a Transport,
148
250
# and potentially a remote locking protocol
149
251
if self._lock_mode:
150
if self._lock_mode != 'w':
151
raise LockError("can't upgrade to a write lock from %r" %
252
if self._lock_mode != 'w' or not self.get_transaction().writeable():
253
raise errors.ReadOnlyError(self)
254
self._lock.validate_token(token)
153
255
self._lock_count += 1
256
return self._token_from_lock
155
self._lock = self._transport.lock_write(
156
self._escape(self.lock_name))
258
token_from_lock = self._lock.lock_write(token=token)
259
#note('write locking %s', self)
260
#traceback.print_stack()
157
261
self._lock_mode = 'w'
158
262
self._lock_count = 1
159
self._set_transaction(transactions.PassThroughTransaction())
263
self._set_transaction(transactions.WriteTransaction())
264
self._token_from_lock = token_from_lock
265
return token_from_lock
161
267
def lock_read(self):
162
mutter("lock read: %s (%s)", self, self._lock_count)
268
# mutter("lock read: %s (%s)", self, self._lock_count)
163
269
if self._lock_mode:
164
270
assert self._lock_mode in ('r', 'w'), \
165
271
"invalid lock mode %r" % self._lock_mode
166
272
self._lock_count += 1
168
self._lock = self._transport.lock_read(
169
self._escape(self.lock_name))
274
self._lock.lock_read()
275
#note('read locking %s', self)
276
#traceback.print_stack()
170
277
self._lock_mode = 'r'
171
278
self._lock_count = 1
172
279
self._set_transaction(transactions.ReadOnlyTransaction())
174
281
self.get_transaction().set_cache_size(5000)
176
283
def unlock(self):
177
mutter("unlock: %s (%s)", self, self._lock_count)
284
# mutter("unlock: %s (%s)", self, self._lock_count)
178
285
if not self._lock_mode:
179
raise LockError('branch %r is not locked' % (self))
286
raise errors.LockNotHeld(self)
181
287
if self._lock_count > 1:
182
288
self._lock_count -= 1
290
#note('unlocking %s', self)
291
#traceback.print_stack()
184
292
self._finish_transaction()
187
self._lock_mode = self._lock_count = None
296
self._lock_mode = self._lock_count = None
299
"""Return true if this LockableFiles group is locked"""
300
return self._lock_count >= 1
302
def get_physical_lock_status(self):
303
"""Return physical lock status.
305
Returns true if a lock is held on the transport. If no lock is held, or
306
the underlying locking mechanism does not support querying lock
307
status, false is returned.
310
return self._lock.peek() is not None
311
except NotImplementedError:
189
314
def get_transaction(self):
190
315
"""Return the current active transaction.
212
337
transaction = self._transaction
213
338
self._transaction = None
214
339
transaction.finish()
342
class TransportLock(object):
343
"""Locking method which uses transport-dependent locks.
345
On the local filesystem these transform into OS-managed locks.
347
These do not guard against concurrent access via different
350
This is suitable for use only in WorkingTrees (which are at present
353
def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
354
self._transport = transport
355
self._escaped_name = escaped_name
356
self._file_modebits = file_modebits
357
self._dir_modebits = dir_modebits
359
def break_lock(self):
360
raise NotImplementedError(self.break_lock)
362
def leave_in_place(self):
363
raise NotImplementedError(self.leave_in_place)
365
def dont_leave_in_place(self):
366
raise NotImplementedError(self.dont_leave_in_place)
368
def lock_write(self, token=None):
369
if token is not None:
370
raise errors.TokenLockingNotSupported(self)
371
self._lock = self._transport.lock_write(self._escaped_name)
374
self._lock = self._transport.lock_read(self._escaped_name)
381
raise NotImplementedError()
383
def create(self, mode=None):
384
"""Create lock mechanism"""
385
# for old-style locks, create the file now
386
self._transport.put_bytes(self._escaped_name, '',
387
mode=self._file_modebits)
389
def validate_token(self, token):
390
if token is not None:
391
raise errors.TokenLockingNotSupported(self)
added
removed
bzrlib/lockable_files.py
