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 (
20
from warnings import warn
23
from bzrlib.decorators import (needs_read_lock,
25
import bzrlib.errors as errors
26
from bzrlib.errors import BzrError
27
from bzrlib.osutils import file_iterator, safe_unicode
28
from bzrlib.symbol_versioning import (deprecated_method,
30
from bzrlib.trace import mutter, note
31
import bzrlib.transactions as transactions
32
import bzrlib.urlutils as urlutils
37
35
# XXX: The tracking here of lock counts and whether the lock is held is
38
36
# somewhat redundant with what's done in LockDir; the main difference is that
39
37
# 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
39
class LockableFiles(object):
59
40
"""Object representing a set of related files locked within the same scope.
61
This coordinates access to the lock along with providing a transaction.
42
These files are used by a WorkingTree, Repository or Branch, and should
43
generally only be touched by that object.
45
LockableFiles also provides some policy on top of Transport for encoding
46
control files as utf-8.
63
48
LockableFiles manage a lock count and can be locked repeatedly by
64
49
a single caller. (The underlying lock implementation generally does not
67
52
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
54
This object builds on top of a Transport, which is used to actually write
55
the files to disk, and an OSLock or LockDir, which controls how access to
56
the files is controlled. The particular type of locking used is set when
57
the object is constructed. In older formats OSLocks are used everywhere.
58
in newer formats a LockDir is used for Repositories and Branches, and
59
OSLocks for the local filesystem.
78
62
# _lock_mode: None, or 'r' or 'w'
80
64
# _lock_count: If _lock_mode is true, a positive count of the number of
81
# times the lock has been taken *by this process*.
65
# times the lock has been taken *by this process*.
67
# If set to False (by a plugin, etc) BzrBranch will not set the
68
# mode on created files or directories
83
72
def __init__(self, transport, lock_name, lock_class):
84
73
"""Create a LockableFiles group
86
:param transport: Transport pointing to the directory holding the
75
:param transport: Transport pointing to the directory holding the
87
76
control files and lock.
88
77
:param lock_name: Name of the lock guarding these files.
89
78
:param lock_class: Class of lock strategy to use: typically
123
117
self._lock.break_lock()
125
119
def _escape(self, file_or_path):
126
"""DEPRECATED: Do not use outside this class"""
127
120
if not isinstance(file_or_path, basestring):
128
121
file_or_path = '/'.join(file_or_path)
129
122
if file_or_path == '':
131
return urlutils.escape(osutils.safe_unicode(file_or_path))
124
return urlutils.escape(safe_unicode(file_or_path))
133
126
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.
127
"""Determine the appropriate modes for files and directories."""
142
129
st = self._transport.stat('.')
143
130
except errors.TransportNotPossible:
151
138
self._dir_mode = (st.st_mode & 07777) | 00700
152
139
# Remove the sticky and execute bits for files
153
140
self._file_mode = self._dir_mode & ~07111
141
if not self._set_dir_mode:
142
self._dir_mode = None
143
if not self._set_file_mode:
144
self._file_mode = None
146
def controlfilename(self, file_or_path):
147
"""Return location relative to branch."""
148
return self._transport.abspath(self._escape(file_or_path))
151
def get(self, relpath):
152
"""Get a file as a bytestream."""
153
relpath = self._escape(relpath)
154
return self._transport.get(relpath)
157
def get_utf8(self, relpath):
158
"""Get a file as a unicode stream."""
159
relpath = self._escape(relpath)
160
# DO NOT introduce an errors=replace here.
161
return codecs.getreader('utf-8')(self._transport.get(relpath))
164
def put(self, path, file):
167
:param path: The path to put the file, relative to the .bzr control
169
:param f: A file-like or string object whose contents should be copied.
171
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
174
def put_bytes(self, path, a_string):
175
"""Write a string of bytes.
177
:param path: The path to put the bytes, relative to the transport root.
178
:param string: A string object, whose exact bytes are to be copied.
180
self._transport.put_bytes(self._escape(path), a_string,
181
mode=self._file_mode)
184
def put_utf8(self, path, a_string):
185
"""Write a string, encoding as utf-8.
187
:param path: The path to put the string, relative to the transport root.
188
:param string: A string or unicode object whose contents should be copied.
190
# IterableFile would not be needed if Transport.put took iterables
191
# instead of files. ADHB 2005-12-25
192
# RBC 20060103 surely its not needed anyway, with codecs transcode
194
# JAM 20060103 We definitely don't want encode(..., 'replace')
195
# these are valuable files which should have exact contents.
196
if not isinstance(a_string, basestring):
197
raise errors.BzrBadParameterNotString(a_string)
198
self.put_bytes(path, a_string.encode('utf-8'))
155
200
def leave_in_place(self):
156
201
"""Set this LockableFiles to not clear the physical lock on unlock."""
175
220
some other way, and need to synchronise this object's state with that
223
# mutter("lock write: %s (%s)", self, self._lock_count)
178
224
# TODO: Upgrade locking to support using a Transport,
179
225
# and potentially a remote locking protocol
180
226
if self._lock_mode:
181
227
if self._lock_mode != 'w' or not self.get_transaction().writeable():
182
228
raise errors.ReadOnlyError(self)
183
229
self._lock.validate_token(token)
184
self._lock_warner.lock_count += 1
230
self._lock_count += 1
185
231
return self._token_from_lock
187
233
token_from_lock = self._lock.lock_write(token=token)
234
#note('write locking %s', self)
188
235
#traceback.print_stack()
189
236
self._lock_mode = 'w'
190
self._lock_warner.lock_count = 1
191
self._set_write_transaction()
238
self._set_transaction(transactions.WriteTransaction())
192
239
self._token_from_lock = token_from_lock
193
240
return token_from_lock
195
242
def lock_read(self):
243
# mutter("lock read: %s (%s)", self, self._lock_count)
196
244
if self._lock_mode:
197
245
if self._lock_mode not in ('r', 'w'):
198
246
raise ValueError("invalid lock mode %r" % (self._lock_mode,))
199
self._lock_warner.lock_count += 1
247
self._lock_count += 1
201
249
self._lock.lock_read()
250
#note('read locking %s', self)
202
251
#traceback.print_stack()
203
252
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)
254
self._set_transaction(transactions.ReadOnlyTransaction())
255
# 5K may be excessive, but hey, its a knob.
256
self.get_transaction().set_cache_size(5000)
218
258
def unlock(self):
259
# mutter("unlock: %s (%s)", self, self._lock_count)
219
260
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
261
raise errors.LockNotHeld(self)
262
if self._lock_count > 1:
263
self._lock_count -= 1
265
#note('unlocking %s', self)
224
266
#traceback.print_stack()
225
267
self._finish_transaction()
227
269
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
271
self._lock_mode = self._lock_count = None
235
273
def is_locked(self):
236
274
"""Return true if this LockableFiles group is locked"""
237
return self._lock_warner.lock_count >= 1
275
return self._lock_count >= 1
239
277
def get_physical_lock_status(self):
240
278
"""Return physical lock status.
242
280
Returns true if a lock is held on the transport. If no lock is held, or
243
281
the underlying locking mechanism does not support querying lock
244
282
status, false is returned.
added
removed
bzrlib/lockable_files.py
