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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from cStringIO import StringIO
17
from bzrlib.lazy_import import lazy_import
18
lazy_import(globals(), """
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
32
from bzrlib.decorators import (
35
37
# XXX: The tracking here of lock counts and whether the lock is held is
36
38
# somewhat redundant with what's done in LockDir; the main difference is that
37
39
# 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)
39
58
class LockableFiles(object):
40
59
"""Object representing a set of related files locked within the same scope.
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.
61
This coordinates access to the lock along with providing a transaction.
48
63
LockableFiles manage a lock count and can be locked repeatedly by
49
64
a single caller. (The underlying lock implementation generally does not
52
67
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
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.
73
:ivar _lock: The real underlying lock (e.g. a LockDir)
74
:ivar _counted_lock: A lock decorated with a semaphore, so that it
62
78
# _lock_mode: None, or 'r' or 'w'
64
80
# _lock_count: If _lock_mode is true, a positive count of the number of
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
81
# times the lock has been taken *by this process*.
72
83
def __init__(self, transport, lock_name, lock_class):
73
84
"""Create a LockableFiles group
75
:param transport: Transport pointing to the directory holding the
86
:param transport: Transport pointing to the directory holding the
76
87
control files and lock.
77
88
:param lock_name: Name of the lock guarding these files.
78
89
:param lock_class: Class of lock strategy to use: typically
117
123
self._lock.break_lock()
119
125
def _escape(self, file_or_path):
126
"""DEPRECATED: Do not use outside this class"""
120
127
if not isinstance(file_or_path, basestring):
121
128
file_or_path = '/'.join(file_or_path)
122
129
if file_or_path == '':
124
return urlutils.escape(safe_unicode(file_or_path))
131
return urlutils.escape(osutils.safe_unicode(file_or_path))
126
133
def _find_modes(self):
127
"""Determine the appropriate modes for files and directories."""
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.
129
142
st = self._transport.stat('.')
130
143
except errors.TransportNotPossible:
138
151
self._dir_mode = (st.st_mode & 07777) | 00700
139
152
# Remove the sticky and execute bits for files
140
153
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'))
200
155
def leave_in_place(self):
201
156
"""Set this LockableFiles to not clear the physical lock on unlock."""
220
175
some other way, and need to synchronise this object's state with that
223
# mutter("lock write: %s (%s)", self, self._lock_count)
224
178
# TODO: Upgrade locking to support using a Transport,
225
179
# and potentially a remote locking protocol
226
180
if self._lock_mode:
227
181
if self._lock_mode != 'w' or not self.get_transaction().writeable():
228
182
raise errors.ReadOnlyError(self)
229
183
self._lock.validate_token(token)
230
self._lock_count += 1
184
self._lock_warner.lock_count += 1
231
185
return self._token_from_lock
233
187
token_from_lock = self._lock.lock_write(token=token)
234
#note('write locking %s', self)
235
188
#traceback.print_stack()
236
189
self._lock_mode = 'w'
238
self._set_transaction(transactions.WriteTransaction())
190
self._lock_warner.lock_count = 1
191
self._set_write_transaction()
239
192
self._token_from_lock = token_from_lock
240
193
return token_from_lock
242
195
def lock_read(self):
243
# mutter("lock read: %s (%s)", self, self._lock_count)
244
196
if self._lock_mode:
245
assert self._lock_mode in ('r', 'w'), \
246
"invalid lock mode %r" % self._lock_mode
247
self._lock_count += 1
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
249
201
self._lock.lock_read()
250
#note('read locking %s', self)
251
202
#traceback.print_stack()
252
203
self._lock_mode = 'r'
254
self._set_transaction(transactions.ReadOnlyTransaction())
255
# 5K may be excessive, but hey, its a knob.
256
self.get_transaction().set_cache_size(5000)
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)
258
218
def unlock(self):
259
# mutter("unlock: %s (%s)", self, self._lock_count)
260
219
if not self._lock_mode:
261
raise errors.LockNotHeld(self)
262
if self._lock_count > 1:
263
self._lock_count -= 1
220
return lock.cant_unlock_not_held(self)
221
if self._lock_warner.lock_count > 1:
222
self._lock_warner.lock_count -= 1
265
#note('unlocking %s', self)
266
224
#traceback.print_stack()
267
225
self._finish_transaction()
269
227
self._lock.unlock()
271
self._lock_mode = self._lock_count = None
229
self._lock_mode = self._lock_warner.lock_count = None
232
def _lock_count(self):
233
return self._lock_warner.lock_count
273
235
def is_locked(self):
274
236
"""Return true if this LockableFiles group is locked"""
275
return self._lock_count >= 1
237
return self._lock_warner.lock_count >= 1
277
239
def get_physical_lock_status(self):
278
240
"""Return physical lock status.
280
242
Returns true if a lock is held on the transport. If no lock is held, or
281
243
the underlying locking mechanism does not support querying lock
282
244
status, false is returned.
added
removed
bzrlib/lockable_files.py
