/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/lockable_files.py

  • Committer: Jelmer Vernooij
  • Date: 2017-06-10 16:40:42 UTC
  • mfrom: (6653.6.7 rename-controldir)
  • mto: This revision was merged to the branch mainline in revision 6690.
  • Revision ID: jelmer@jelmer.uk-20170610164042-zrxqgy2htyduvke2
Merge rename-controldir branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/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 bzrlib.lazy_import import lazy_import
 
17
from __future__ import absolute_import
 
18
 
 
19
from .lazy_import import lazy_import
18
20
lazy_import(globals(), """
19
 
import codecs
20
21
import warnings
21
22
 
22
 
from bzrlib import (
 
23
from breezy import (
23
24
    counted_lock,
24
25
    errors,
25
26
    lock,
29
30
    )
30
31
""")
31
32
 
32
 
from bzrlib.decorators import (
 
33
from .decorators import (
33
34
    only_raises,
34
35
    )
35
36
 
36
37
 
37
 
# XXX: The tracking here of lock counts and whether the lock is held is
38
 
# somewhat redundant with what's done in LockDir; the main difference is that
39
 
# LockableFiles permits reentrancy.
40
 
 
41
 
class _LockWarner(object):
42
 
    """Hold a counter for a lock and warn if GCed while the count is >= 1.
43
 
 
44
 
    This is separate from LockableFiles because putting a __del__ on
45
 
    LockableFiles can result in uncollectable cycles.
46
 
    """
47
 
 
48
 
    def __init__(self, repr):
49
 
        self.lock_count = 0
50
 
        self.repr = repr
51
 
 
52
 
    def __del__(self):
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)
56
 
 
57
 
 
58
38
class LockableFiles(object):
59
39
    """Object representing a set of related files locked within the same scope.
60
40
 
69
49
    This class is now deprecated; code should move to using the Transport
70
50
    directly for file operations and using the lock or CountedLock for
71
51
    locking.
72
 
    
 
52
 
73
53
    :ivar _lock: The real underlying lock (e.g. a LockDir)
74
 
    :ivar _counted_lock: A lock decorated with a semaphore, so that it 
75
 
        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'
76
58
    """
77
59
 
78
 
    # _lock_mode: None, or 'r' or 'w'
79
 
 
80
 
    # _lock_count: If _lock_mode is true, a positive count of the number of
81
 
    # times the lock has been taken *by this process*.
82
 
 
83
60
    def __init__(self, transport, lock_name, lock_class):
84
61
        """Create a LockableFiles group
85
62
 
93
70
        self.lock_name = lock_name
94
71
        self._transaction = None
95
72
        self._lock_mode = None
96
 
        self._lock_warner = _LockWarner(repr(self))
 
73
        self._lock_count = 0
97
74
        self._find_modes()
98
75
        esc_name = self._escape(lock_name)
99
76
        self._lock = lock_class(transport, esc_name,
112
89
    def __repr__(self):
113
90
        return '%s(%r)' % (self.__class__.__name__,
114
91
                           self._transport)
 
92
 
115
93
    def __str__(self):
116
94
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
117
95
 
124
102
 
125
103
    def _escape(self, file_or_path):
126
104
        """DEPRECATED: Do not use outside this class"""
127
 
        if not isinstance(file_or_path, basestring):
128
 
            file_or_path = '/'.join(file_or_path)
129
105
        if file_or_path == '':
130
106
            return u''
131
 
        return urlutils.escape(osutils.safe_unicode(file_or_path))
 
107
        return urlutils.escape(file_or_path)
132
108
 
133
109
    def _find_modes(self):
134
110
        """Determine the appropriate modes for files and directories.
141
117
        try:
142
118
            st = self._transport.stat('.')
143
119
        except errors.TransportNotPossible:
144
 
            self._dir_mode = 0755
145
 
            self._file_mode = 0644
 
120
            self._dir_mode = 0o755
 
121
            self._file_mode = 0o644
146
122
        else:
147
123
            # Check the directory mode, but also make sure the created
148
124
            # directories and files are read-write for this user. This is
149
125
            # mostly a workaround for filesystems which lie about being able to
150
126
            # write to a directory (cygwin & win32)
151
 
            self._dir_mode = (st.st_mode & 07777) | 00700
 
127
            self._dir_mode = (st.st_mode & 0o7777) | 0o0700
152
128
            # Remove the sticky and execute bits for files
153
 
            self._file_mode = self._dir_mode & ~07111
 
129
            self._file_mode = self._dir_mode & ~0o7111
154
130
 
155
131
    def leave_in_place(self):
156
132
        """Set this LockableFiles to not clear the physical lock on unlock."""
175
151
        some other way, and need to synchronise this object's state with that
176
152
        fact.
177
153
        """
178
 
        # TODO: Upgrade locking to support using a Transport,
179
 
        # and potentially a remote locking protocol
180
154
        if self._lock_mode:
181
 
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
 
155
            if (self._lock_mode != 'w'
 
156
                or not self.get_transaction().writeable()):
182
157
                raise errors.ReadOnlyError(self)
183
158
            self._lock.validate_token(token)
184
 
            self._lock_warner.lock_count += 1
 
159
            self._lock_count += 1
185
160
            return self._token_from_lock
186
161
        else:
187
162
            token_from_lock = self._lock.lock_write(token=token)
188
163
            #traceback.print_stack()
189
164
            self._lock_mode = 'w'
190
 
            self._lock_warner.lock_count = 1
 
165
            self._lock_count = 1
191
166
            self._set_write_transaction()
192
167
            self._token_from_lock = token_from_lock
193
168
            return token_from_lock
196
171
        if self._lock_mode:
197
172
            if self._lock_mode not in ('r', 'w'):
198
173
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
199
 
            self._lock_warner.lock_count += 1
 
174
            self._lock_count += 1
200
175
        else:
201
176
            self._lock.lock_read()
202
177
            #traceback.print_stack()
203
178
            self._lock_mode = 'r'
204
 
            self._lock_warner.lock_count = 1
 
179
            self._lock_count = 1
205
180
            self._set_read_transaction()
206
181
 
207
182
    def _set_read_transaction(self):
218
193
    def unlock(self):
219
194
        if not self._lock_mode:
220
195
            return lock.cant_unlock_not_held(self)
221
 
        if self._lock_warner.lock_count > 1:
222
 
            self._lock_warner.lock_count -= 1
 
196
        if self._lock_count > 1:
 
197
            self._lock_count -= 1
223
198
        else:
224
199
            #traceback.print_stack()
225
200
            self._finish_transaction()
226
201
            try:
227
202
                self._lock.unlock()
228
203
            finally:
229
 
                self._lock_mode = self._lock_warner.lock_count = None
230
 
 
231
 
    @property
232
 
    def _lock_count(self):
233
 
        return self._lock_warner.lock_count
 
204
                self._lock_count = 0
 
205
                self._lock_mode = None
234
206
 
235
207
    def is_locked(self):
236
208
        """Return true if this LockableFiles group is locked"""
237
 
        return self._lock_warner.lock_count >= 1
 
209
        return self._lock_count >= 1
238
210
 
239
211
    def get_physical_lock_status(self):
240
212
        """Return physical lock status.
326
298
    def validate_token(self, token):
327
299
        if token is not None:
328
300
            raise errors.TokenLockingNotSupported(self)
329