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(), """
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
34
from bzrlib.decorators import (
38
from bzrlib.symbol_versioning import (
34
44
# XXX: The tracking here of lock counts and whether the lock is held is
35
45
# somewhat redundant with what's done in LockDir; the main difference is that
36
46
# LockableFiles permits reentrancy.
48
class _LockWarner(object):
49
"""Hold a counter for a lock and warn if GCed while the count is >= 1.
51
This is separate from LockableFiles because putting a __del__ on
52
LockableFiles can result in uncollectable cycles.
55
def __init__(self, repr):
60
if self.lock_count >= 1:
61
# There should have been a try/finally to unlock this.
62
warnings.warn("%r was gc'd while locked" % self.repr)
38
65
class LockableFiles(object):
39
66
"""Object representing a set of related files locked within the same scope.
51
78
Instances of this class are often called control_files.
53
80
This object builds on top of a Transport, which is used to actually write
54
81
the files to disk, and an OSLock or LockDir, which controls how access to
55
82
the files is controlled. The particular type of locking used is set when
56
83
the object is constructed. In older formats OSLocks are used everywhere.
57
in newer formats a LockDir is used for Repositories and Branches, and
84
in newer formats a LockDir is used for Repositories and Branches, and
58
85
OSLocks for the local filesystem.
87
This class is now deprecated; code should move to using the Transport
88
directly for file operations and using the lock or CountedLock for
91
:ivar _lock: The real underlying lock (e.g. a LockDir)
92
:ivar _counted_lock: A lock decorated with a semaphore, so that it
61
96
# _lock_mode: None, or 'r' or 'w'
63
98
# _lock_count: If _lock_mode is true, a positive count of the number of
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
99
# times the lock has been taken *by this process*.
71
101
def __init__(self, transport, lock_name, lock_class):
72
102
"""Create a LockableFiles group
74
:param transport: Transport pointing to the directory holding the
104
:param transport: Transport pointing to the directory holding the
75
105
control files and lock.
76
106
:param lock_name: Name of the lock guarding these files.
77
107
:param lock_class: Class of lock strategy to use: typically
118
141
self._lock.break_lock()
120
143
def _escape(self, file_or_path):
144
"""DEPRECATED: Do not use outside this class"""
121
145
if not isinstance(file_or_path, basestring):
122
146
file_or_path = '/'.join(file_or_path)
123
147
if file_or_path == '':
125
return urlutils.escape(safe_unicode(file_or_path))
149
return urlutils.escape(osutils.safe_unicode(file_or_path))
127
151
def _find_modes(self):
128
"""Determine the appropriate modes for files and directories."""
152
"""Determine the appropriate modes for files and directories.
154
:deprecated: Replaced by BzrDir._find_modes.
156
# XXX: The properties created by this can be removed or deprecated
157
# once all the _get_text_store methods etc no longer use them.
130
160
st = self._transport.stat('.')
131
161
except errors.TransportNotPossible:
132
162
self._dir_mode = 0755
133
163
self._file_mode = 0644
135
self._dir_mode = st.st_mode & 07777
165
# Check the directory mode, but also make sure the created
166
# directories and files are read-write for this user. This is
167
# mostly a workaround for filesystems which lie about being able to
168
# write to a directory (cygwin & win32)
169
self._dir_mode = (st.st_mode & 07777) | 00700
136
170
# Remove the sticky and execute bits for files
137
171
self._file_mode = self._dir_mode & ~07111
138
if not self._set_dir_mode:
139
self._dir_mode = None
140
if not self._set_file_mode:
141
self._file_mode = None
173
@deprecated_method(deprecated_in((1, 6, 0)))
143
174
def controlfilename(self, file_or_path):
144
"""Return location relative to branch."""
175
"""Return location relative to branch.
177
:deprecated: Use Transport methods instead.
145
179
return self._transport.abspath(self._escape(file_or_path))
147
@deprecated_method(zero_eight)
148
def controlfile(self, file_or_path, mode='r'):
149
"""Open a control file for this branch.
151
There are two classes of file in a lockable directory: text
152
and binary. binary files are untranslated byte streams. Text
153
control files are stored with Unix newlines and in UTF-8, even
154
if the platform or locale defaults are different.
156
Such files are not openable in write mode : they are managed via
157
put and put_utf8 which atomically replace old versions using
161
relpath = self._escape(file_or_path)
162
# TODO: codecs.open() buffers linewise, so it was overloaded with
163
# a much larger buffer, do we need to do the same for getreader/getwriter?
165
return self.get(relpath)
167
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
169
return self.get_utf8(relpath)
171
raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
173
raise BzrError("invalid controlfile mode %r" % mode)
182
@deprecated_method(deprecated_in((1, 5, 0)))
176
183
def get(self, relpath):
177
"""Get a file as a bytestream."""
184
"""Get a file as a bytestream.
186
:deprecated: Use a Transport instead of LockableFiles.
178
188
relpath = self._escape(relpath)
179
189
return self._transport.get(relpath)
192
@deprecated_method(deprecated_in((1, 5, 0)))
182
193
def get_utf8(self, relpath):
183
"""Get a file as a unicode stream."""
194
"""Get a file as a unicode stream.
196
:deprecated: Use a Transport instead of LockableFiles.
184
198
relpath = self._escape(relpath)
185
199
# DO NOT introduce an errors=replace here.
186
200
return codecs.getreader('utf-8')(self._transport.get(relpath))
188
202
@needs_write_lock
203
@deprecated_method(deprecated_in((1, 6, 0)))
189
204
def put(self, path, file):
192
207
:param path: The path to put the file, relative to the .bzr control
194
:param f: A file-like or string object whose contents should be copied.
196
self._transport.put(self._escape(path), file, mode=self._file_mode)
209
:param file: A file-like or string object whose contents should be copied.
211
:deprecated: Use Transport methods instead.
213
self._transport.put_file(self._escape(path), file, mode=self._file_mode)
216
@deprecated_method(deprecated_in((1, 6, 0)))
217
def put_bytes(self, path, a_string):
218
"""Write a string of bytes.
220
:param path: The path to put the bytes, relative to the transport root.
221
:param a_string: A string object, whose exact bytes are to be copied.
223
:deprecated: Use Transport methods instead.
225
self._transport.put_bytes(self._escape(path), a_string,
226
mode=self._file_mode)
229
@deprecated_method(deprecated_in((1, 6, 0)))
199
230
def put_utf8(self, path, a_string):
200
231
"""Write a string, encoding as utf-8.
202
233
:param path: The path to put the string, relative to the transport root.
203
:param string: A file-like or string object whose contents should be copied.
234
:param string: A string or unicode object whose contents should be copied.
236
:deprecated: Use Transport methods instead.
205
238
# IterableFile would not be needed if Transport.put took iterables
206
239
# instead of files. ADHB 2005-12-25
210
243
# these are valuable files which should have exact contents.
211
244
if not isinstance(a_string, basestring):
212
245
raise errors.BzrBadParameterNotString(a_string)
213
self.put(path, StringIO(a_string.encode('utf-8')))
215
def lock_write(self):
216
# mutter("lock write: %s (%s)", self, self._lock_count)
246
self.put_bytes(path, a_string.encode('utf-8'))
248
def leave_in_place(self):
249
"""Set this LockableFiles to not clear the physical lock on unlock."""
250
self._lock.leave_in_place()
252
def dont_leave_in_place(self):
253
"""Set this LockableFiles to clear the physical lock on unlock."""
254
self._lock.dont_leave_in_place()
256
def lock_write(self, token=None):
257
"""Lock this group of files for writing.
259
:param token: if this is already locked, then lock_write will fail
260
unless the token matches the existing lock.
261
:returns: a token if this instance supports tokens, otherwise None.
262
:raises TokenLockingNotSupported: when a token is given but this
263
instance doesn't support using token locks.
264
:raises MismatchedToken: if the specified token doesn't match the token
265
of the existing lock.
267
A token should be passed in if you know that you have locked the object
268
some other way, and need to synchronise this object's state with that
217
271
# TODO: Upgrade locking to support using a Transport,
218
272
# and potentially a remote locking protocol
219
273
if self._lock_mode:
220
274
if self._lock_mode != 'w' or not self.get_transaction().writeable():
221
275
raise errors.ReadOnlyError(self)
222
self._lock_count += 1
276
self._lock.validate_token(token)
277
self._lock_warner.lock_count += 1
278
return self._token_from_lock
224
self._lock.lock_write()
225
#note('write locking %s', self)
280
token_from_lock = self._lock.lock_write(token=token)
226
281
#traceback.print_stack()
227
282
self._lock_mode = 'w'
229
self._set_transaction(transactions.WriteTransaction())
283
self._lock_warner.lock_count = 1
284
self._set_write_transaction()
285
self._token_from_lock = token_from_lock
286
return token_from_lock
231
288
def lock_read(self):
232
# mutter("lock read: %s (%s)", self, self._lock_count)
233
289
if self._lock_mode:
234
assert self._lock_mode in ('r', 'w'), \
235
"invalid lock mode %r" % self._lock_mode
236
self._lock_count += 1
290
if self._lock_mode not in ('r', 'w'):
291
raise ValueError("invalid lock mode %r" % (self._lock_mode,))
292
self._lock_warner.lock_count += 1
238
294
self._lock.lock_read()
239
#note('read locking %s', self)
240
295
#traceback.print_stack()
241
296
self._lock_mode = 'r'
243
self._set_transaction(transactions.ReadOnlyTransaction())
244
# 5K may be excessive, but hey, its a knob.
245
self.get_transaction().set_cache_size(5000)
297
self._lock_warner.lock_count = 1
298
self._set_read_transaction()
300
def _set_read_transaction(self):
301
"""Setup a read transaction."""
302
self._set_transaction(transactions.ReadOnlyTransaction())
303
# 5K may be excessive, but hey, its a knob.
304
self.get_transaction().set_cache_size(5000)
306
def _set_write_transaction(self):
307
"""Setup a write transaction."""
308
self._set_transaction(transactions.WriteTransaction())
247
310
def unlock(self):
248
# mutter("unlock: %s (%s)", self, self._lock_count)
249
311
if not self._lock_mode:
250
raise errors.LockNotHeld(self)
251
if self._lock_count > 1:
252
self._lock_count -= 1
312
return lock.cant_unlock_not_held(self)
313
if self._lock_warner.lock_count > 1:
314
self._lock_warner.lock_count -= 1
254
#note('unlocking %s', self)
255
316
#traceback.print_stack()
256
317
self._finish_transaction()
258
319
self._lock.unlock()
260
self._lock_mode = self._lock_count = None
321
self._lock_mode = self._lock_warner.lock_count = None
324
def _lock_count(self):
325
return self._lock_warner.lock_count
262
327
def is_locked(self):
263
328
"""Return true if this LockableFiles group is locked"""
264
return self._lock_count >= 1
329
return self._lock_warner.lock_count >= 1
266
331
def get_physical_lock_status(self):
267
332
"""Return physical lock status.
269
334
Returns true if a lock is held on the transport. If no lock is held, or
270
335
the underlying locking mechanism does not support querying lock
271
336
status, false is returned.
added
removed
bzrlib/lockable_files.py
