← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Ian Clatworthy
  • Date: 2009-07-22 14:07:56 UTC
  • mto: (4568.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4569.
  • Revision ID: ian.clatworthy@canonical.com-20090722140756-rx3dbtf3rlubfy4r
Improve the names and location of the quick reference cards

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from cStringIO import StringIO
 
18
 
17
19
from bzrlib.lazy_import import lazy_import
18
20
lazy_import(globals(), """
 
21
import codecs
19
22
import warnings
20
23
 
21
24
from bzrlib import (
22
25
    counted_lock,
23
26
    errors,
24
 
    lock,
25
27
    osutils,
26
28
    transactions,
27
29
    urlutils,
29
31
""")
30
32
 
31
33
from bzrlib.decorators import (
32
 
    only_raises,
33
 
    )
 
34
    needs_read_lock,
 
35
    needs_write_lock,
 
36
    )
 
37
from bzrlib.symbol_versioning import (
 
38
    deprecated_in,
 
39
    deprecated_method,
 
40
    )
 
41
 
 
42
 
 
43
# XXX: The tracking here of lock counts and whether the lock is held is
 
44
# somewhat redundant with what's done in LockDir; the main difference is that
 
45
# LockableFiles permits reentrancy.
 
46
 
 
47
class _LockWarner(object):
 
48
    """Hold a counter for a lock and warn if GCed while the count is >= 1.
 
49
 
 
50
    This is separate from LockableFiles because putting a __del__ on
 
51
    LockableFiles can result in uncollectable cycles.
 
52
    """
 
53
 
 
54
    def __init__(self, repr):
 
55
        self.lock_count = 0
 
56
        self.repr = repr
 
57
 
 
58
    def __del__(self):
 
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)
34
62
 
35
63
 
36
64
class LockableFiles(object):
37
65
    """Object representing a set of related files locked within the same scope.
38
66
 
39
 
    This coordinates access to the lock along with providing a transaction.
 
67
    These files are used by a WorkingTree, Repository or Branch, and should
 
68
    generally only be touched by that object.
 
69
 
 
70
    LockableFiles also provides some policy on top of Transport for encoding
 
71
    control files as utf-8.
40
72
 
41
73
    LockableFiles manage a lock count and can be locked repeatedly by
42
74
    a single caller.  (The underlying lock implementation generally does not
44
76
 
45
77
    Instances of this class are often called control_files.
46
78
 
 
79
    This object builds on top of a Transport, which is used to actually write
 
80
    the files to disk, and an OSLock or LockDir, which controls how access to
 
81
    the files is controlled.  The particular type of locking used is set when
 
82
    the object is constructed.  In older formats OSLocks are used everywhere.
 
83
    in newer formats a LockDir is used for Repositories and Branches, and
 
84
    OSLocks for the local filesystem.
 
85
 
47
86
    This class is now deprecated; code should move to using the Transport
48
87
    directly for file operations and using the lock or CountedLock for
49
88
    locking.
50
 
 
 
89
    
51
90
    :ivar _lock: The real underlying lock (e.g. a LockDir)
52
 
    :ivar _lock_count: If _lock_mode is true, a positive count of the number
53
 
        of times the lock has been taken (and not yet released) *by this
54
 
        process*, through this particular object instance.
55
 
    :ivar _lock_mode: None, or 'r' or 'w'
 
91
    :ivar _counted_lock: A lock decorated with a semaphore, so that it 
 
92
        can be re-entered.
56
93
    """
57
94
 
 
95
    # _lock_mode: None, or 'r' or 'w'
 
96
 
 
97
    # _lock_count: If _lock_mode is true, a positive count of the number of
 
98
    # times the lock has been taken *by this process*.
 
99
 
58
100
    def __init__(self, transport, lock_name, lock_class):
59
101
        """Create a LockableFiles group
60
102
 
68
110
        self.lock_name = lock_name
69
111
        self._transaction = None
70
112
        self._lock_mode = None
71
 
        self._lock_count = 0
 
113
        self._lock_warner = _LockWarner(repr(self))
72
114
        self._find_modes()
73
115
        esc_name = self._escape(lock_name)
74
116
        self._lock = lock_class(transport, esc_name,
87
129
    def __repr__(self):
88
130
        return '%s(%r)' % (self.__class__.__name__,
89
131
                           self._transport)
90
 
 
91
132
    def __str__(self):
92
133
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
93
134
 
109
150
    def _find_modes(self):
110
151
        """Determine the appropriate modes for files and directories.
111
152
 
112
 
        :deprecated: Replaced by BzrDir._find_creation_modes.
 
153
        :deprecated: Replaced by BzrDir._find_modes.
113
154
        """
114
155
        # XXX: The properties created by this can be removed or deprecated
115
156
        # once all the _get_text_store methods etc no longer use them.
128
169
            # Remove the sticky and execute bits for files
129
170
            self._file_mode = self._dir_mode & ~07111
130
171
 
 
172
    @deprecated_method(deprecated_in((1, 6, 0)))
 
173
    def controlfilename(self, file_or_path):
 
174
        """Return location relative to branch.
 
175
 
 
176
        :deprecated: Use Transport methods instead.
 
177
        """
 
178
        return self._transport.abspath(self._escape(file_or_path))
 
179
 
 
180
    @needs_read_lock
 
181
    @deprecated_method(deprecated_in((1, 5, 0)))
 
182
    def get(self, relpath):
 
183
        """Get a file as a bytestream.
 
184
 
 
185
        :deprecated: Use a Transport instead of LockableFiles.
 
186
        """
 
187
        relpath = self._escape(relpath)
 
188
        return self._transport.get(relpath)
 
189
 
 
190
    @needs_read_lock
 
191
    @deprecated_method(deprecated_in((1, 5, 0)))
 
192
    def get_utf8(self, relpath):
 
193
        """Get a file as a unicode stream.
 
194
 
 
195
        :deprecated: Use a Transport instead of LockableFiles.
 
196
        """
 
197
        relpath = self._escape(relpath)
 
198
        # DO NOT introduce an errors=replace here.
 
199
        return codecs.getreader('utf-8')(self._transport.get(relpath))
 
200
 
 
201
    @needs_write_lock
 
202
    @deprecated_method(deprecated_in((1, 6, 0)))
 
203
    def put(self, path, file):
 
204
        """Write a file.
 
205
 
 
206
        :param path: The path to put the file, relative to the .bzr control
 
207
                     directory
 
208
        :param file: A file-like or string object whose contents should be copied.
 
209
 
 
210
        :deprecated: Use Transport methods instead.
 
211
        """
 
212
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
 
213
 
 
214
    @needs_write_lock
 
215
    @deprecated_method(deprecated_in((1, 6, 0)))
 
216
    def put_bytes(self, path, a_string):
 
217
        """Write a string of bytes.
 
218
 
 
219
        :param path: The path to put the bytes, relative to the transport root.
 
220
        :param a_string: A string object, whose exact bytes are to be copied.
 
221
 
 
222
        :deprecated: Use Transport methods instead.
 
223
        """
 
224
        self._transport.put_bytes(self._escape(path), a_string,
 
225
                                  mode=self._file_mode)
 
226
 
 
227
    @needs_write_lock
 
228
    @deprecated_method(deprecated_in((1, 6, 0)))
 
229
    def put_utf8(self, path, a_string):
 
230
        """Write a string, encoding as utf-8.
 
231
 
 
232
        :param path: The path to put the string, relative to the transport root.
 
233
        :param string: A string or unicode object whose contents should be copied.
 
234
 
 
235
        :deprecated: Use Transport methods instead.
 
236
        """
 
237
        # IterableFile would not be needed if Transport.put took iterables
 
238
        # instead of files.  ADHB 2005-12-25
 
239
        # RBC 20060103 surely its not needed anyway, with codecs transcode
 
240
        # file support ?
 
241
        # JAM 20060103 We definitely don't want encode(..., 'replace')
 
242
        # these are valuable files which should have exact contents.
 
243
        if not isinstance(a_string, basestring):
 
244
            raise errors.BzrBadParameterNotString(a_string)
 
245
        self.put_bytes(path, a_string.encode('utf-8'))
 
246
 
131
247
    def leave_in_place(self):
132
248
        """Set this LockableFiles to not clear the physical lock on unlock."""
133
249
        self._lock.leave_in_place()
151
267
        some other way, and need to synchronise this object's state with that
152
268
        fact.
153
269
        """
 
270
        # TODO: Upgrade locking to support using a Transport,
 
271
        # and potentially a remote locking protocol
154
272
        if self._lock_mode:
155
 
            if (self._lock_mode != 'w'
156
 
                or not self.get_transaction().writeable()):
 
273
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
157
274
                raise errors.ReadOnlyError(self)
158
275
            self._lock.validate_token(token)
159
 
            self._lock_count += 1
 
276
            self._lock_warner.lock_count += 1
160
277
            return self._token_from_lock
161
278
        else:
162
279
            token_from_lock = self._lock.lock_write(token=token)
163
280
            #traceback.print_stack()
164
281
            self._lock_mode = 'w'
165
 
            self._lock_count = 1
 
282
            self._lock_warner.lock_count = 1
166
283
            self._set_write_transaction()
167
284
            self._token_from_lock = token_from_lock
168
285
            return token_from_lock
171
288
        if self._lock_mode:
172
289
            if self._lock_mode not in ('r', 'w'):
173
290
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
174
 
            self._lock_count += 1
 
291
            self._lock_warner.lock_count += 1
175
292
        else:
176
293
            self._lock.lock_read()
177
294
            #traceback.print_stack()
178
295
            self._lock_mode = 'r'
179
 
            self._lock_count = 1
 
296
            self._lock_warner.lock_count = 1
180
297
            self._set_read_transaction()
181
298
 
182
299
    def _set_read_transaction(self):
189
306
        """Setup a write transaction."""
190
307
        self._set_transaction(transactions.WriteTransaction())
191
308
 
192
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
193
309
    def unlock(self):
194
310
        if not self._lock_mode:
195
 
            return lock.cant_unlock_not_held(self)
196
 
        if self._lock_count > 1:
197
 
            self._lock_count -= 1
 
311
            raise errors.LockNotHeld(self)
 
312
        if self._lock_warner.lock_count > 1:
 
313
            self._lock_warner.lock_count -= 1
198
314
        else:
199
315
            #traceback.print_stack()
200
316
            self._finish_transaction()
201
317
            try:
202
318
                self._lock.unlock()
203
319
            finally:
204
 
                self._lock_mode = self._lock_count = None
 
320
                self._lock_mode = self._lock_warner.lock_count = None
 
321
 
 
322
    @property
 
323
    def _lock_count(self):
 
324
        return self._lock_warner.lock_count
205
325
 
206
326
    def is_locked(self):
207
327
        """Return true if this LockableFiles group is locked"""
208
 
        return self._lock_count >= 1
 
328
        return self._lock_warner.lock_count >= 1
209
329
 
210
330
    def get_physical_lock_status(self):
211
331
        """Return physical lock status.
297
417
    def validate_token(self, token):
298
418
        if token is not None:
299
419
            raise errors.TokenLockingNotSupported(self)
 
420