/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: 2019-02-04 01:01:24 UTC
  • mto: This revision was merged to the branch mainline in revision 7268.
  • Revision ID: jelmer@jelmer.uk-20190204010124-ni0i4qc6f5tnbvux
Fix source tests.

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
 
import warnings
21
 
 
22
 
from bzrlib import (
 
21
from breezy import (
23
22
    counted_lock,
24
23
    errors,
25
24
    lock,
26
 
    osutils,
27
25
    transactions,
28
26
    urlutils,
29
27
    )
30
28
""")
31
29
 
32
 
from bzrlib.decorators import (
 
30
from .decorators import (
33
31
    only_raises,
34
32
    )
35
33
 
36
34
 
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
35
class LockableFiles(object):
59
36
    """Object representing a set of related files locked within the same scope.
60
37
 
69
46
    This class is now deprecated; code should move to using the Transport
70
47
    directly for file operations and using the lock or CountedLock for
71
48
    locking.
72
 
    
 
49
 
73
50
    :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.
 
51
    :ivar _lock_count: If _lock_mode is true, a positive count of the number
 
52
        of times the lock has been taken (and not yet released) *by this
 
53
        process*, through this particular object instance.
 
54
    :ivar _lock_mode: None, or 'r' or 'w'
76
55
    """
77
56
 
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
57
    def __init__(self, transport, lock_name, lock_class):
84
58
        """Create a LockableFiles group
85
59
 
93
67
        self.lock_name = lock_name
94
68
        self._transaction = None
95
69
        self._lock_mode = None
96
 
        self._lock_warner = _LockWarner(repr(self))
 
70
        self._lock_count = 0
97
71
        self._find_modes()
98
72
        esc_name = self._escape(lock_name)
99
73
        self._lock = lock_class(transport, esc_name,
112
86
    def __repr__(self):
113
87
        return '%s(%r)' % (self.__class__.__name__,
114
88
                           self._transport)
 
89
 
115
90
    def __str__(self):
116
91
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
117
92
 
124
99
 
125
100
    def _escape(self, file_or_path):
126
101
        """DEPRECATED: Do not use outside this class"""
127
 
        if not isinstance(file_or_path, basestring):
128
 
            file_or_path = '/'.join(file_or_path)
129
102
        if file_or_path == '':
130
103
            return u''
131
 
        return urlutils.escape(osutils.safe_unicode(file_or_path))
 
104
        return urlutils.escape(file_or_path)
132
105
 
133
106
    def _find_modes(self):
134
107
        """Determine the appropriate modes for files and directories.
141
114
        try:
142
115
            st = self._transport.stat('.')
143
116
        except errors.TransportNotPossible:
144
 
            self._dir_mode = 0755
145
 
            self._file_mode = 0644
 
117
            self._dir_mode = 0o755
 
118
            self._file_mode = 0o644
146
119
        else:
147
120
            # Check the directory mode, but also make sure the created
148
121
            # directories and files are read-write for this user. This is
149
122
            # mostly a workaround for filesystems which lie about being able to
150
123
            # write to a directory (cygwin & win32)
151
 
            self._dir_mode = (st.st_mode & 07777) | 00700
 
124
            self._dir_mode = (st.st_mode & 0o7777) | 0o0700
152
125
            # Remove the sticky and execute bits for files
153
 
            self._file_mode = self._dir_mode & ~07111
 
126
            self._file_mode = self._dir_mode & ~0o7111
154
127
 
155
128
    def leave_in_place(self):
156
129
        """Set this LockableFiles to not clear the physical lock on unlock."""
175
148
        some other way, and need to synchronise this object's state with that
176
149
        fact.
177
150
        """
178
 
        # TODO: Upgrade locking to support using a Transport,
179
 
        # and potentially a remote locking protocol
180
151
        if self._lock_mode:
181
 
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
 
152
            if (self._lock_mode != 'w'
 
153
                    or not self.get_transaction().writeable()):
182
154
                raise errors.ReadOnlyError(self)
183
155
            self._lock.validate_token(token)
184
 
            self._lock_warner.lock_count += 1
 
156
            self._lock_count += 1
185
157
            return self._token_from_lock
186
158
        else:
187
159
            token_from_lock = self._lock.lock_write(token=token)
188
 
            #traceback.print_stack()
 
160
            # traceback.print_stack()
189
161
            self._lock_mode = 'w'
190
 
            self._lock_warner.lock_count = 1
 
162
            self._lock_count = 1
191
163
            self._set_write_transaction()
192
164
            self._token_from_lock = token_from_lock
193
165
            return token_from_lock
196
168
        if self._lock_mode:
197
169
            if self._lock_mode not in ('r', 'w'):
198
170
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
199
 
            self._lock_warner.lock_count += 1
 
171
            self._lock_count += 1
200
172
        else:
201
173
            self._lock.lock_read()
202
 
            #traceback.print_stack()
 
174
            # traceback.print_stack()
203
175
            self._lock_mode = 'r'
204
 
            self._lock_warner.lock_count = 1
 
176
            self._lock_count = 1
205
177
            self._set_read_transaction()
206
178
 
207
179
    def _set_read_transaction(self):
218
190
    def unlock(self):
219
191
        if not self._lock_mode:
220
192
            return lock.cant_unlock_not_held(self)
221
 
        if self._lock_warner.lock_count > 1:
222
 
            self._lock_warner.lock_count -= 1
 
193
        if self._lock_count > 1:
 
194
            self._lock_count -= 1
223
195
        else:
224
 
            #traceback.print_stack()
 
196
            # traceback.print_stack()
225
197
            self._finish_transaction()
226
198
            try:
227
199
                self._lock.unlock()
228
200
            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
 
201
                self._lock_count = 0
 
202
                self._lock_mode = None
234
203
 
235
204
    def is_locked(self):
236
205
        """Return true if this LockableFiles group is locked"""
237
 
        return self._lock_warner.lock_count >= 1
 
206
        return self._lock_count >= 1
238
207
 
239
208
    def get_physical_lock_status(self):
240
209
        """Return physical lock status.
287
256
    This is suitable for use only in WorkingTrees (which are at present
288
257
    always local).
289
258
    """
 
259
 
290
260
    def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
291
261
        self._transport = transport
292
262
        self._escaped_name = escaped_name
320
290
    def create(self, mode=None):
321
291
        """Create lock mechanism"""
322
292
        # for old-style locks, create the file now
323
 
        self._transport.put_bytes(self._escaped_name, '',
324
 
                            mode=self._file_modebits)
 
293
        self._transport.put_bytes(self._escaped_name, b'',
 
294
                                  mode=self._file_modebits)
325
295
 
326
296
    def validate_token(self, token):
327
297
        if token is not None:
328
298
            raise errors.TokenLockingNotSupported(self)
329