← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

(vila) Make all transport put_bytes() raises TypeError when given unicode
 strings rather than bytes (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
1
 
# Copyright (C) 2005, 2006, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
 
17
from __future__ import absolute_import
18
18
 
19
19
from bzrlib.lazy_import import lazy_import
20
20
lazy_import(globals(), """
21
 
import codecs
22
21
import warnings
23
22
 
24
23
from bzrlib import (
34
33
from bzrlib.decorators import (
35
34
    only_raises,
36
35
    )
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)
62
36
 
63
37
 
64
38
class LockableFiles(object):
75
49
    This class is now deprecated; code should move to using the Transport
76
50
    directly for file operations and using the lock or CountedLock for
77
51
    locking.
78
 
    
 
52
 
79
53
    :ivar _lock: The real underlying lock (e.g. a LockDir)
80
 
    :ivar _counted_lock: A lock decorated with a semaphore, so that it 
81
 
        can be re-entered.
 
54
    :ivar _lock_count: If _lock_mode is true, a positive count of the number
 
55
        of times the lock has been taken (and not yet released) *by this
 
56
        process*, through this particular object instance.
 
57
    :ivar _lock_mode: None, or 'r' or 'w'
82
58
    """
83
59
 
84
 
    # _lock_mode: None, or 'r' or 'w'
85
 
 
86
 
    # _lock_count: If _lock_mode is true, a positive count of the number of
87
 
    # times the lock has been taken *by this process*.
88
 
 
89
60
    def __init__(self, transport, lock_name, lock_class):
90
61
        """Create a LockableFiles group
91
62
 
99
70
        self.lock_name = lock_name
100
71
        self._transaction = None
101
72
        self._lock_mode = None
102
 
        self._lock_warner = _LockWarner(repr(self))
 
73
        self._lock_count = 0
103
74
        self._find_modes()
104
75
        esc_name = self._escape(lock_name)
105
76
        self._lock = lock_class(transport, esc_name,
118
89
    def __repr__(self):
119
90
        return '%s(%r)' % (self.__class__.__name__,
120
91
                           self._transport)
 
92
 
121
93
    def __str__(self):
122
94
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
123
95
 
181
153
        some other way, and need to synchronise this object's state with that
182
154
        fact.
183
155
        """
184
 
        # TODO: Upgrade locking to support using a Transport,
185
 
        # and potentially a remote locking protocol
186
156
        if self._lock_mode:
187
 
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
 
157
            if (self._lock_mode != 'w'
 
158
                or not self.get_transaction().writeable()):
188
159
                raise errors.ReadOnlyError(self)
189
160
            self._lock.validate_token(token)
190
 
            self._lock_warner.lock_count += 1
 
161
            self._lock_count += 1
191
162
            return self._token_from_lock
192
163
        else:
193
164
            token_from_lock = self._lock.lock_write(token=token)
194
165
            #traceback.print_stack()
195
166
            self._lock_mode = 'w'
196
 
            self._lock_warner.lock_count = 1
 
167
            self._lock_count = 1
197
168
            self._set_write_transaction()
198
169
            self._token_from_lock = token_from_lock
199
170
            return token_from_lock
202
173
        if self._lock_mode:
203
174
            if self._lock_mode not in ('r', 'w'):
204
175
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
205
 
            self._lock_warner.lock_count += 1
 
176
            self._lock_count += 1
206
177
        else:
207
178
            self._lock.lock_read()
208
179
            #traceback.print_stack()
209
180
            self._lock_mode = 'r'
210
 
            self._lock_warner.lock_count = 1
 
181
            self._lock_count = 1
211
182
            self._set_read_transaction()
212
183
 
213
184
    def _set_read_transaction(self):
224
195
    def unlock(self):
225
196
        if not self._lock_mode:
226
197
            return lock.cant_unlock_not_held(self)
227
 
        if self._lock_warner.lock_count > 1:
228
 
            self._lock_warner.lock_count -= 1
 
198
        if self._lock_count > 1:
 
199
            self._lock_count -= 1
229
200
        else:
230
201
            #traceback.print_stack()
231
202
            self._finish_transaction()
232
203
            try:
233
204
                self._lock.unlock()
234
205
            finally:
235
 
                self._lock_mode = self._lock_warner.lock_count = None
236
 
 
237
 
    @property
238
 
    def _lock_count(self):
239
 
        return self._lock_warner.lock_count
 
206
                self._lock_mode = self._lock_count = None
240
207
 
241
208
    def is_locked(self):
242
209
        """Return true if this LockableFiles group is locked"""
243
 
        return self._lock_warner.lock_count >= 1
 
210
        return self._lock_count >= 1
244
211
 
245
212
    def get_physical_lock_status(self):
246
213
        """Return physical lock status.
332
299
    def validate_token(self, token):
333
300
        if token is not None:
334
301
            raise errors.TokenLockingNotSupported(self)
335