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
17
from cStringIO import StringIO
19
from bzrlib.lazy_import import lazy_import
20
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
34
from bzrlib.decorators import (
28
37
from bzrlib.symbol_versioning import (
32
from bzrlib.trace import mutter, note
33
import bzrlib.transactions as transactions
34
import bzrlib.urlutils as urlutils
37
43
# XXX: The tracking here of lock counts and whether the lock is held is
38
44
# somewhat redundant with what's done in LockDir; the main difference is that
39
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)
41
64
class LockableFiles(object):
42
65
"""Object representing a set of related files locked within the same scope.
44
These files are used by a WorkingTree, Repository or Branch, and should
45
generally only be touched by that object.
47
LockableFiles also provides some policy on top of Transport for encoding
48
control files as utf-8.
67
This coordinates access to the lock along with providing a transaction.
50
69
LockableFiles manage a lock count and can be locked repeatedly by
51
70
a single caller. (The underlying lock implementation generally does not
54
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
56
This object builds on top of a Transport, which is used to actually write
57
the files to disk, and an OSLock or LockDir, which controls how access to
58
the files is controlled. The particular type of locking used is set when
59
the object is constructed. In older formats OSLocks are used everywhere.
60
in newer formats a LockDir is used for Repositories and Branches, and
61
OSLocks for the local filesystem.
79
:ivar _lock: The real underlying lock (e.g. a LockDir)
80
:ivar _counted_lock: A lock decorated with a semaphore, so that it
64
84
# _lock_mode: None, or 'r' or 'w'
66
86
# _lock_count: If _lock_mode is true, a positive count of the number of
67
# times the lock has been taken *by this process*.
69
# If set to False (by a plugin, etc) BzrBranch will not set the
70
# mode on created files or directories
87
# times the lock has been taken *by this process*.
74
89
def __init__(self, transport, lock_name, lock_class):
75
90
"""Create a LockableFiles group
77
:param transport: Transport pointing to the directory holding the
92
:param transport: Transport pointing to the directory holding the
78
93
control files and lock.
79
94
:param lock_name: Name of the lock guarding these files.
80
95
:param lock_class: Class of lock strategy to use: typically
119
129
self._lock.break_lock()
121
131
def _escape(self, file_or_path):
132
"""DEPRECATED: Do not use outside this class"""
122
133
if not isinstance(file_or_path, basestring):
123
134
file_or_path = '/'.join(file_or_path)
124
135
if file_or_path == '':
126
return urlutils.escape(safe_unicode(file_or_path))
137
return urlutils.escape(osutils.safe_unicode(file_or_path))
128
139
def _find_modes(self):
129
"""Determine the appropriate modes for files and directories."""
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.
131
148
st = self._transport.stat('.')
132
149
except errors.TransportNotPossible:
140
157
self._dir_mode = (st.st_mode & 07777) | 00700
141
158
# Remove the sticky and execute bits for files
142
159
self._file_mode = self._dir_mode & ~07111
143
if not self._set_dir_mode:
144
self._dir_mode = None
145
if not self._set_file_mode:
146
self._file_mode = None
148
def controlfilename(self, file_or_path):
149
"""Return location relative to branch."""
150
return self._transport.abspath(self._escape(file_or_path))
153
def get(self, relpath):
154
"""Get a file as a bytestream."""
155
relpath = self._escape(relpath)
156
return self._transport.get(relpath)
159
@deprecated_method(deprecated_in((1, 5, 0)))
160
def get_utf8(self, relpath):
161
"""Get a file as a unicode stream."""
162
relpath = self._escape(relpath)
163
# DO NOT introduce an errors=replace here.
164
return codecs.getreader('utf-8')(self._transport.get(relpath))
167
def put(self, path, file):
170
:param path: The path to put the file, relative to the .bzr control
172
:param f: A file-like or string object whose contents should be copied.
174
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
177
def put_bytes(self, path, a_string):
178
"""Write a string of bytes.
180
:param path: The path to put the bytes, relative to the transport root.
181
:param string: A string object, whose exact bytes are to be copied.
183
self._transport.put_bytes(self._escape(path), a_string,
184
mode=self._file_mode)
187
def put_utf8(self, path, a_string):
188
"""Write a string, encoding as utf-8.
190
:param path: The path to put the string, relative to the transport root.
191
:param string: A string or unicode object whose contents should be copied.
193
# IterableFile would not be needed if Transport.put took iterables
194
# instead of files. ADHB 2005-12-25
195
# RBC 20060103 surely its not needed anyway, with codecs transcode
197
# JAM 20060103 We definitely don't want encode(..., 'replace')
198
# these are valuable files which should have exact contents.
199
if not isinstance(a_string, basestring):
200
raise errors.BzrBadParameterNotString(a_string)
201
self.put_bytes(path, a_string.encode('utf-8'))
203
161
def leave_in_place(self):
204
162
"""Set this LockableFiles to not clear the physical lock on unlock."""
223
181
some other way, and need to synchronise this object's state with that
226
# mutter("lock write: %s (%s)", self, self._lock_count)
227
184
# TODO: Upgrade locking to support using a Transport,
228
185
# and potentially a remote locking protocol
229
186
if self._lock_mode:
230
187
if self._lock_mode != 'w' or not self.get_transaction().writeable():
231
188
raise errors.ReadOnlyError(self)
232
189
self._lock.validate_token(token)
233
self._lock_count += 1
190
self._lock_warner.lock_count += 1
234
191
return self._token_from_lock
236
193
token_from_lock = self._lock.lock_write(token=token)
237
#note('write locking %s', self)
238
194
#traceback.print_stack()
239
195
self._lock_mode = 'w'
241
self._set_transaction(transactions.WriteTransaction())
196
self._lock_warner.lock_count = 1
197
self._set_write_transaction()
242
198
self._token_from_lock = token_from_lock
243
199
return token_from_lock
245
201
def lock_read(self):
246
# mutter("lock read: %s (%s)", self, self._lock_count)
247
202
if self._lock_mode:
248
203
if self._lock_mode not in ('r', 'w'):
249
204
raise ValueError("invalid lock mode %r" % (self._lock_mode,))
250
self._lock_count += 1
205
self._lock_warner.lock_count += 1
252
207
self._lock.lock_read()
253
#note('read locking %s', self)
254
208
#traceback.print_stack()
255
209
self._lock_mode = 'r'
257
self._set_transaction(transactions.ReadOnlyTransaction())
258
# 5K may be excessive, but hey, its a knob.
259
self.get_transaction().set_cache_size(5000)
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)
261
224
def unlock(self):
262
# mutter("unlock: %s (%s)", self, self._lock_count)
263
225
if not self._lock_mode:
264
raise errors.LockNotHeld(self)
265
if self._lock_count > 1:
266
self._lock_count -= 1
226
return lock.cant_unlock_not_held(self)
227
if self._lock_warner.lock_count > 1:
228
self._lock_warner.lock_count -= 1
268
#note('unlocking %s', self)
269
230
#traceback.print_stack()
270
231
self._finish_transaction()
272
233
self._lock.unlock()
274
self._lock_mode = self._lock_count = None
235
self._lock_mode = self._lock_warner.lock_count = None
238
def _lock_count(self):
239
return self._lock_warner.lock_count
276
241
def is_locked(self):
277
242
"""Return true if this LockableFiles group is locked"""
278
return self._lock_count >= 1
243
return self._lock_warner.lock_count >= 1
280
245
def get_physical_lock_status(self):
281
246
"""Return physical lock status.
283
248
Returns true if a lock is held on the transport. If no lock is held, or
284
249
the underlying locking mechanism does not support querying lock
285
250
status, false is returned.
added
removed
bzrlib/lockable_files.py
