← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Robert Collins
  • Date: 2009-03-26 23:16:06 UTC
  • mto: This revision was merged to the branch mainline in revision 4216.
  • Revision ID: robertc@robertcollins.net-20090326231606-rh98suac20x246pk
Review caught a bogus change to test_last_modified_revision_after_commit_link_unchanged_ric.

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