1
# Copyright (C) 2005, 2006, 2008, 2009 Canonical Ltd
1
# Copyright (C) 2005 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
from cStringIO import StringIO
19
from bzrlib.lazy_import import lazy_import
20
lazy_import(globals(), """
34
from bzrlib.decorators import (
37
from bzrlib.symbol_versioning import (
43
# XXX: The tracking here of lock counts and whether the lock is held is
44
# somewhat redundant with what's done in LockDir; the main difference is that
45
# LockableFiles permits reentrancy.
47
class _LockWarner(object):
48
"""Hold a counter for a lock and warn if GCed while the count is >= 1.
50
This is separate from LockableFiles because putting a __del__ on
51
LockableFiles can result in uncollectable cycles.
54
def __init__(self, repr):
59
if self.lock_count >= 1:
60
# There should have been a try/finally to unlock this.
61
warnings.warn("%r was gc'd while locked" % self.repr)
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.symbol_versioning import deprecated_method, zero_eight
27
from bzrlib.trace import mutter
28
import bzrlib.transactions as transactions
64
31
class LockableFiles(object):
65
"""Object representing a set of related files locked within the same scope.
67
This coordinates access to the lock along with providing a transaction.
69
LockableFiles manage a lock count and can be locked repeatedly by
70
a single caller. (The underlying lock implementation generally does not
73
Instances of this class are often called control_files.
75
This class is now deprecated; code should move to using the Transport
76
directly for file operations and using the lock or CountedLock for
79
:ivar _lock: The real underlying lock (e.g. a LockDir)
80
:ivar _counted_lock: A lock decorated with a semaphore, so that it
32
"""Object representing a set of files locked within the same scope
38
If _lock_mode is true, a positive count of the number of times the
39
lock has been taken *by this process*. Others may have compatible
43
Lock object from bzrlib.lock.
84
# _lock_mode: None, or 'r' or 'w'
86
# _lock_count: If _lock_mode is true, a positive count of the number of
87
# times the lock has been taken *by this process*.
89
def __init__(self, transport, lock_name, lock_class):
90
"""Create a LockableFiles group
92
:param transport: Transport pointing to the directory holding the
93
control files and lock.
94
:param lock_name: Name of the lock guarding these files.
95
:param lock_class: Class of lock strategy to use: typically
96
either LockDir or TransportLock.
49
# If set to False (by a plugin, etc) BzrBranch will not set the
50
# mode on created files or directories
54
def __init__(self, transport, lock_name):
98
56
self._transport = transport
99
57
self.lock_name = lock_name
100
58
self._transaction = None
101
self._lock_mode = None
102
self._lock_warner = _LockWarner(repr(self))
103
59
self._find_modes()
104
esc_name = self._escape(lock_name)
105
self._lock = lock_class(transport, esc_name,
106
file_modebits=self._file_mode,
107
dir_modebits=self._dir_mode)
108
self._counted_lock = counted_lock.CountedLock(self._lock)
110
def create_lock(self):
113
This should normally be called only when the LockableFiles directory
114
is first created on disk.
116
self._lock.create(mode=self._dir_mode)
119
return '%s(%r)' % (self.__class__.__name__,
122
return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
124
def break_lock(self):
125
"""Break the lock of this lockable files group if it is held.
127
The current ui factory will be used to prompt for user conformation.
129
self._lock.break_lock()
62
if self._lock_mode or self._lock:
63
# XXX: This should show something every time, and be suitable for
64
# headless operation and embedding
65
from warnings import warn
66
warn("file group %r was not explicitly unlocked" % self)
131
69
def _escape(self, file_or_path):
132
"""DEPRECATED: Do not use outside this class"""
133
70
if not isinstance(file_or_path, basestring):
134
71
file_or_path = '/'.join(file_or_path)
135
72
if file_or_path == '':
137
return urlutils.escape(osutils.safe_unicode(file_or_path))
74
return bzrlib.transport.urlescape(safe_unicode(file_or_path))
139
76
def _find_modes(self):
140
"""Determine the appropriate modes for files and directories.
142
:deprecated: Replaced by BzrDir._find_creation_modes.
144
# XXX: The properties created by this can be removed or deprecated
145
# once all the _get_text_store methods etc no longer use them.
77
"""Determine the appropriate modes for files and directories."""
148
79
st = self._transport.stat('.')
149
80
except errors.TransportNotPossible:
150
81
self._dir_mode = 0755
151
82
self._file_mode = 0644
153
# Check the directory mode, but also make sure the created
154
# directories and files are read-write for this user. This is
155
# mostly a workaround for filesystems which lie about being able to
156
# write to a directory (cygwin & win32)
157
self._dir_mode = (st.st_mode & 07777) | 00700
84
self._dir_mode = st.st_mode & 07777
158
85
# Remove the sticky and execute bits for files
159
86
self._file_mode = self._dir_mode & ~07111
161
def leave_in_place(self):
162
"""Set this LockableFiles to not clear the physical lock on unlock."""
163
self._lock.leave_in_place()
165
def dont_leave_in_place(self):
166
"""Set this LockableFiles to clear the physical lock on unlock."""
167
self._lock.dont_leave_in_place()
169
def lock_write(self, token=None):
170
"""Lock this group of files for writing.
172
:param token: if this is already locked, then lock_write will fail
173
unless the token matches the existing lock.
174
:returns: a token if this instance supports tokens, otherwise None.
175
:raises TokenLockingNotSupported: when a token is given but this
176
instance doesn't support using token locks.
177
:raises MismatchedToken: if the specified token doesn't match the token
178
of the existing lock.
180
A token should be passed in if you know that you have locked the object
181
some other way, and need to synchronise this object's state with that
87
if not self._set_dir_mode:
89
if not self._set_file_mode:
90
self._file_mode = None
92
def controlfilename(self, file_or_path):
93
"""Return location relative to branch."""
94
return self._transport.abspath(self._escape(file_or_path))
96
@deprecated_method(zero_eight)
97
def controlfile(self, file_or_path, mode='r'):
98
"""Open a control file for this branch.
100
There are two classes of file in a lockable directory: text
101
and binary. binary files are untranslated byte streams. Text
102
control files are stored with Unix newlines and in UTF-8, even
103
if the platform or locale defaults are different.
105
Such files are not openable in write mode : they are managed via
106
put and put_utf8 which atomically replace old versions using
110
relpath = self._escape(file_or_path)
111
#TODO: codecs.open() buffers linewise, so it was overloaded with
112
# a much larger buffer, do we need to do the same for getreader/getwriter?
114
return self.get(relpath)
116
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
118
return self.get_utf8(relpath)
120
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
122
raise BzrError("invalid controlfile mode %r" % mode)
125
def get(self, relpath):
126
"""Get a file as a bytestream."""
127
relpath = self._escape(relpath)
128
return self._transport.get(relpath)
131
def get_utf8(self, relpath):
132
"""Get a file as a unicode stream."""
133
relpath = self._escape(relpath)
134
# DO NOT introduce an errors=replace here.
135
return codecs.getreader('utf-8')(self._transport.get(relpath))
138
def put(self, path, file):
141
:param path: The path to put the file, relative to the .bzr control
143
:param f: A file-like or string object whose contents should be copied.
145
self._transport.put(self._escape(path), file, mode=self._file_mode)
148
def put_utf8(self, path, a_string):
149
"""Write a string, encoding as utf-8.
151
:param path: The path to put the string, relative to the transport root.
152
:param string: A file-like or string object whose contents should be copied.
154
# IterableFile would not be needed if Transport.put took iterables
155
# instead of files. ADHB 2005-12-25
156
# RBC 20060103 surely its not needed anyway, with codecs transcode
158
# JAM 20060103 We definitely don't want encode(..., 'replace')
159
# these are valuable files which should have exact contents.
160
if not isinstance(a_string, basestring):
161
raise errors.BzrBadParameterNotString(a_string)
162
self.put(path, StringIO(a_string.encode('utf-8')))
164
def lock_write(self):
165
# mutter("lock write: %s (%s)", self, self._lock_count)
184
166
# TODO: Upgrade locking to support using a Transport,
185
167
# and potentially a remote locking protocol
186
168
if self._lock_mode:
187
if self._lock_mode != 'w' or not self.get_transaction().writeable():
188
raise errors.ReadOnlyError(self)
189
self._lock.validate_token(token)
190
self._lock_warner.lock_count += 1
191
return self._token_from_lock
169
if self._lock_mode != 'w':
170
raise ReadOnlyError("can't upgrade to a write lock from %r" %
172
self._lock_count += 1
193
token_from_lock = self._lock.lock_write(token=token)
194
#traceback.print_stack()
174
self._lock = self._transport.lock_write(
175
self._escape(self.lock_name))
195
176
self._lock_mode = 'w'
196
self._lock_warner.lock_count = 1
197
self._set_write_transaction()
198
self._token_from_lock = token_from_lock
199
return token_from_lock
178
self._set_transaction(transactions.PassThroughTransaction())
201
180
def lock_read(self):
181
# mutter("lock read: %s (%s)", self, self._lock_count)
202
182
if self._lock_mode:
203
if self._lock_mode not in ('r', 'w'):
204
raise ValueError("invalid lock mode %r" % (self._lock_mode,))
205
self._lock_warner.lock_count += 1
183
assert self._lock_mode in ('r', 'w'), \
184
"invalid lock mode %r" % self._lock_mode
185
self._lock_count += 1
207
self._lock.lock_read()
208
#traceback.print_stack()
187
self._lock = self._transport.lock_read(
188
self._escape(self.lock_name))
209
189
self._lock_mode = 'r'
210
self._lock_warner.lock_count = 1
211
self._set_read_transaction()
213
def _set_read_transaction(self):
214
"""Setup a read transaction."""
215
self._set_transaction(transactions.ReadOnlyTransaction())
216
# 5K may be excessive, but hey, its a knob.
217
self.get_transaction().set_cache_size(5000)
219
def _set_write_transaction(self):
220
"""Setup a write transaction."""
221
self._set_transaction(transactions.WriteTransaction())
223
@only_raises(errors.LockNotHeld, errors.LockBroken)
191
self._set_transaction(transactions.ReadOnlyTransaction())
192
# 5K may be excessive, but hey, its a knob.
193
self.get_transaction().set_cache_size(5000)
224
195
def unlock(self):
196
# mutter("unlock: %s (%s)", self, self._lock_count)
225
197
if not self._lock_mode:
226
return lock.cant_unlock_not_held(self)
227
if self._lock_warner.lock_count > 1:
228
self._lock_warner.lock_count -= 1
198
raise LockError('branch %r is not locked' % (self))
200
if self._lock_count > 1:
201
self._lock_count -= 1
230
#traceback.print_stack()
231
203
self._finish_transaction()
235
self._lock_mode = self._lock_warner.lock_count = None
238
def _lock_count(self):
239
return self._lock_warner.lock_count
242
"""Return true if this LockableFiles group is locked"""
243
return self._lock_warner.lock_count >= 1
245
def get_physical_lock_status(self):
246
"""Return physical lock status.
248
Returns true if a lock is held on the transport. If no lock is held, or
249
the underlying locking mechanism does not support querying lock
250
status, false is returned.
253
return self._lock.peek() is not None
254
except NotImplementedError:
206
self._lock_mode = self._lock_count = None
257
208
def get_transaction(self):
258
209
"""Return the current active transaction.
added
removed
bzrlib/lockable_files.py
