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
from bzrlib.lazy_import import lazy_import
18
lazy_import(globals(), """
17
from cStringIO import StringIO
32
from bzrlib.decorators import (
22
from bzrlib.decorators import (needs_read_lock,
24
import bzrlib.errors as errors
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
30
import bzrlib.transactions as transactions
31
import bzrlib.urlutils as urlutils
37
34
# XXX: The tracking here of lock counts and whether the lock is held is
38
35
# somewhat redundant with what's done in LockDir; the main difference is that
39
36
# LockableFiles permits reentrancy.
41
class _LockWarner(object):
42
"""Hold a counter for a lock and warn if GCed while the count is >= 1.
44
This is separate from LockableFiles because putting a __del__ on
45
LockableFiles can result in uncollectable cycles.
48
def __init__(self, repr):
53
if self.lock_count >= 1:
54
# There should have been a try/finally to unlock this.
55
warnings.warn("%r was gc'd while locked" % self.repr)
58
38
class LockableFiles(object):
59
39
"""Object representing a set of related files locked within the same scope.
61
This coordinates access to the lock along with providing a transaction.
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.
63
47
LockableFiles manage a lock count and can be locked repeatedly by
64
48
a single caller. (The underlying lock implementation generally does not
67
51
Instances of this class are often called control_files.
69
This class is now deprecated; code should move to using the Transport
70
directly for file operations and using the lock or CountedLock for
73
:ivar _lock: The real underlying lock (e.g. a LockDir)
74
:ivar _counted_lock: A lock decorated with a semaphore, so that it
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.
78
61
# _lock_mode: None, or 'r' or 'w'
80
63
# _lock_count: If _lock_mode is true, a positive count of the number of
81
# times the lock has been taken *by this process*.
64
# times the lock has been taken *by this process*.
66
# If set to False (by a plugin, etc) BzrBranch will not set the
67
# mode on created files or directories
83
71
def __init__(self, transport, lock_name, lock_class):
84
72
"""Create a LockableFiles group
86
:param transport: Transport pointing to the directory holding the
74
:param transport: Transport pointing to the directory holding the
87
75
control files and lock.
88
76
:param lock_name: Name of the lock guarding these files.
89
77
:param lock_class: Class of lock strategy to use: typically
123
118
self._lock.break_lock()
125
120
def _escape(self, file_or_path):
126
"""DEPRECATED: Do not use outside this class"""
127
121
if not isinstance(file_or_path, basestring):
128
122
file_or_path = '/'.join(file_or_path)
129
123
if file_or_path == '':
131
return urlutils.escape(osutils.safe_unicode(file_or_path))
125
return urlutils.escape(safe_unicode(file_or_path))
133
127
def _find_modes(self):
134
"""Determine the appropriate modes for files and directories.
136
:deprecated: Replaced by BzrDir._find_creation_modes.
138
# XXX: The properties created by this can be removed or deprecated
139
# once all the _get_text_store methods etc no longer use them.
128
"""Determine the appropriate modes for files and directories."""
142
130
st = self._transport.stat('.')
143
131
except errors.TransportNotPossible:
151
139
self._dir_mode = (st.st_mode & 07777) | 00700
152
140
# Remove the sticky and execute bits for files
153
141
self._file_mode = self._dir_mode & ~07111
142
if not self._set_dir_mode:
143
self._dir_mode = None
144
if not self._set_file_mode:
145
self._file_mode = None
147
def controlfilename(self, file_or_path):
148
"""Return location relative to branch."""
149
return self._transport.abspath(self._escape(file_or_path))
152
def get(self, relpath):
153
"""Get a file as a bytestream."""
154
relpath = self._escape(relpath)
155
return self._transport.get(relpath)
158
def get_utf8(self, relpath):
159
"""Get a file as a unicode stream."""
160
relpath = self._escape(relpath)
161
# DO NOT introduce an errors=replace here.
162
return codecs.getreader('utf-8')(self._transport.get(relpath))
165
def put(self, path, file):
168
:param path: The path to put the file, relative to the .bzr control
170
:param f: A file-like or string object whose contents should be copied.
172
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
175
def put_bytes(self, path, a_string):
176
"""Write a string of bytes.
178
:param path: The path to put the bytes, relative to the transport root.
179
:param string: A string object, whose exact bytes are to be copied.
181
self._transport.put_bytes(self._escape(path), a_string,
182
mode=self._file_mode)
185
def put_utf8(self, path, a_string):
186
"""Write a string, encoding as utf-8.
188
:param path: The path to put the string, relative to the transport root.
189
:param string: A string or unicode object whose contents should be copied.
191
# IterableFile would not be needed if Transport.put took iterables
192
# instead of files. ADHB 2005-12-25
193
# RBC 20060103 surely its not needed anyway, with codecs transcode
195
# JAM 20060103 We definitely don't want encode(..., 'replace')
196
# these are valuable files which should have exact contents.
197
if not isinstance(a_string, basestring):
198
raise errors.BzrBadParameterNotString(a_string)
199
self.put_bytes(path, a_string.encode('utf-8'))
155
201
def leave_in_place(self):
156
202
"""Set this LockableFiles to not clear the physical lock on unlock."""
175
221
some other way, and need to synchronise this object's state with that
224
# mutter("lock write: %s (%s)", self, self._lock_count)
178
225
# TODO: Upgrade locking to support using a Transport,
179
226
# and potentially a remote locking protocol
180
227
if self._lock_mode:
181
228
if self._lock_mode != 'w' or not self.get_transaction().writeable():
182
229
raise errors.ReadOnlyError(self)
183
230
self._lock.validate_token(token)
184
self._lock_warner.lock_count += 1
231
self._lock_count += 1
185
232
return self._token_from_lock
187
234
token_from_lock = self._lock.lock_write(token=token)
235
#note('write locking %s', self)
188
236
#traceback.print_stack()
189
237
self._lock_mode = 'w'
190
self._lock_warner.lock_count = 1
191
self._set_write_transaction()
239
self._set_transaction(transactions.WriteTransaction())
192
240
self._token_from_lock = token_from_lock
193
241
return token_from_lock
195
243
def lock_read(self):
244
# mutter("lock read: %s (%s)", self, self._lock_count)
196
245
if self._lock_mode:
197
if self._lock_mode not in ('r', 'w'):
198
raise ValueError("invalid lock mode %r" % (self._lock_mode,))
199
self._lock_warner.lock_count += 1
246
assert self._lock_mode in ('r', 'w'), \
247
"invalid lock mode %r" % self._lock_mode
248
self._lock_count += 1
201
250
self._lock.lock_read()
251
#note('read locking %s', self)
202
252
#traceback.print_stack()
203
253
self._lock_mode = 'r'
204
self._lock_warner.lock_count = 1
205
self._set_read_transaction()
207
def _set_read_transaction(self):
208
"""Setup a read transaction."""
209
self._set_transaction(transactions.ReadOnlyTransaction())
210
# 5K may be excessive, but hey, its a knob.
211
self.get_transaction().set_cache_size(5000)
213
def _set_write_transaction(self):
214
"""Setup a write transaction."""
215
self._set_transaction(transactions.WriteTransaction())
217
@only_raises(errors.LockNotHeld, errors.LockBroken)
255
self._set_transaction(transactions.ReadOnlyTransaction())
256
# 5K may be excessive, but hey, its a knob.
257
self.get_transaction().set_cache_size(5000)
218
259
def unlock(self):
260
# mutter("unlock: %s (%s)", self, self._lock_count)
219
261
if not self._lock_mode:
220
return lock.cant_unlock_not_held(self)
221
if self._lock_warner.lock_count > 1:
222
self._lock_warner.lock_count -= 1
262
raise errors.LockNotHeld(self)
263
if self._lock_count > 1:
264
self._lock_count -= 1
266
#note('unlocking %s', self)
224
267
#traceback.print_stack()
225
268
self._finish_transaction()
227
270
self._lock.unlock()
229
self._lock_mode = self._lock_warner.lock_count = None
232
def _lock_count(self):
233
return self._lock_warner.lock_count
272
self._lock_mode = self._lock_count = None
235
274
def is_locked(self):
236
275
"""Return true if this LockableFiles group is locked"""
237
return self._lock_warner.lock_count >= 1
276
return self._lock_count >= 1
239
278
def get_physical_lock_status(self):
240
279
"""Return physical lock status.
242
281
Returns true if a lock is held on the transport. If no lock is held, or
243
282
the underlying locking mechanism does not support querying lock
244
283
status, false is returned.