← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Martin Pool
  • Date: 2009-06-05 23:15:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4565.
  • Revision ID: mbp@sourcefrog.net-20090605231523-fzaebdzckp38hoir
Remove one use of DummyProgress

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
1
 
# Copyright (C) 2005, 2006 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
from cStringIO import StringIO
 
18
 
 
19
from bzrlib.lazy_import import lazy_import
 
20
lazy_import(globals(), """
18
21
import codecs
19
 
#import traceback
20
 
 
21
 
import bzrlib
22
 
from bzrlib.decorators import (needs_read_lock,
23
 
        needs_write_lock)
24
 
import bzrlib.errors as errors
25
 
from bzrlib.errors import BzrError
26
 
from bzrlib.osutils import file_iterator, safe_unicode
27
 
from bzrlib.symbol_versioning import (deprecated_method,
28
 
        )
29
 
from bzrlib.trace import mutter, note
30
 
import bzrlib.transactions as transactions
31
 
import bzrlib.urlutils as urlutils
 
22
import warnings
 
23
 
 
24
from bzrlib import (
 
25
    counted_lock,
 
26
    errors,
 
27
    osutils,
 
28
    transactions,
 
29
    urlutils,
 
30
    )
 
31
""")
 
32
 
 
33
from bzrlib.decorators import (
 
34
    needs_read_lock,
 
35
    needs_write_lock,
 
36
    )
 
37
from bzrlib.symbol_versioning import (
 
38
    deprecated_in,
 
39
    deprecated_method,
 
40
    )
32
41
 
33
42
 
34
43
# XXX: The tracking here of lock counts and whether the lock is held is
35
44
# somewhat redundant with what's done in LockDir; the main difference is that
36
45
# LockableFiles permits reentrancy.
37
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
 
 
63
 
38
64
class LockableFiles(object):
39
65
    """Object representing a set of related files locked within the same scope.
40
66
 
49
75
    support this.)
50
76
 
51
77
    Instances of this class are often called control_files.
52
 
    
 
78
 
53
79
    This object builds on top of a Transport, which is used to actually write
54
80
    the files to disk, and an OSLock or LockDir, which controls how access to
55
81
    the files is controlled.  The particular type of locking used is set when
56
82
    the object is constructed.  In older formats OSLocks are used everywhere.
57
 
    in newer formats a LockDir is used for Repositories and Branches, and 
 
83
    in newer formats a LockDir is used for Repositories and Branches, and
58
84
    OSLocks for the local filesystem.
 
85
 
 
86
    This class is now deprecated; code should move to using the Transport
 
87
    directly for file operations and using the lock or CountedLock for
 
88
    locking.
 
89
    
 
90
    :ivar _lock: The real underlying lock (e.g. a LockDir)
 
91
    :ivar _counted_lock: A lock decorated with a semaphore, so that it 
 
92
        can be re-entered.
59
93
    """
60
94
 
61
95
    # _lock_mode: None, or 'r' or 'w'
62
96
 
63
97
    # _lock_count: If _lock_mode is true, a positive count of the number of
64
 
    # times the lock has been taken *by this process*.   
65
 
    
66
 
    # If set to False (by a plugin, etc) BzrBranch will not set the
67
 
    # mode on created files or directories
68
 
    _set_file_mode = True
69
 
    _set_dir_mode = True
 
98
    # times the lock has been taken *by this process*.
70
99
 
71
100
    def __init__(self, transport, lock_name, lock_class):
72
101
        """Create a LockableFiles group
73
102
 
74
 
        :param transport: Transport pointing to the directory holding the 
 
103
        :param transport: Transport pointing to the directory holding the
75
104
            control files and lock.
76
105
        :param lock_name: Name of the lock guarding these files.
77
106
        :param lock_class: Class of lock strategy to use: typically
81
110
        self.lock_name = lock_name
82
111
        self._transaction = None
83
112
        self._lock_mode = None
84
 
        self._lock_count = 0
 
113
        self._lock_warner = _LockWarner(repr(self))
85
114
        self._find_modes()
86
115
        esc_name = self._escape(lock_name)
87
116
        self._lock = lock_class(transport, esc_name,
88
117
                                file_modebits=self._file_mode,
89
118
                                dir_modebits=self._dir_mode)
 
119
        self._counted_lock = counted_lock.CountedLock(self._lock)
90
120
 
91
121
    def create_lock(self):
92
122
        """Create the lock.
102
132
    def __str__(self):
103
133
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
104
134
 
105
 
    def __del__(self):
106
 
        if self.is_locked():
107
 
            # XXX: This should show something every time, and be suitable for
108
 
            # headless operation and embedding
109
 
            from warnings import warn
110
 
            warn("file group %r was not explicitly unlocked" % self)
111
 
            self._lock.unlock()
112
 
 
113
135
    def break_lock(self):
114
136
        """Break the lock of this lockable files group if it is held.
115
137
 
118
140
        self._lock.break_lock()
119
141
 
120
142
    def _escape(self, file_or_path):
 
143
        """DEPRECATED: Do not use outside this class"""
121
144
        if not isinstance(file_or_path, basestring):
122
145
            file_or_path = '/'.join(file_or_path)
123
146
        if file_or_path == '':
124
147
            return u''
125
 
        return urlutils.escape(safe_unicode(file_or_path))
 
148
        return urlutils.escape(osutils.safe_unicode(file_or_path))
126
149
 
127
150
    def _find_modes(self):
128
 
        """Determine the appropriate modes for files and directories."""
 
151
        """Determine the appropriate modes for files and directories.
 
152
 
 
153
        :deprecated: Replaced by BzrDir._find_modes.
 
154
        """
 
155
        # XXX: The properties created by this can be removed or deprecated
 
156
        # once all the _get_text_store methods etc no longer use them.
 
157
        # -- mbp 20080512
129
158
        try:
130
159
            st = self._transport.stat('.')
131
160
        except errors.TransportNotPossible:
139
168
            self._dir_mode = (st.st_mode & 07777) | 00700
140
169
            # Remove the sticky and execute bits for files
141
170
            self._file_mode = self._dir_mode & ~07111
142
 
        if not self._set_dir_mode:
143
 
            self._dir_mode = None
144
 
        if not self._set_file_mode:
145
 
            self._file_mode = None
146
171
 
 
172
    @deprecated_method(deprecated_in((1, 6, 0)))
147
173
    def controlfilename(self, file_or_path):
148
 
        """Return location relative to branch."""
 
174
        """Return location relative to branch.
 
175
 
 
176
        :deprecated: Use Transport methods instead.
 
177
        """
149
178
        return self._transport.abspath(self._escape(file_or_path))
150
179
 
151
180
    @needs_read_lock
 
181
    @deprecated_method(deprecated_in((1, 5, 0)))
152
182
    def get(self, relpath):
153
 
        """Get a file as a bytestream."""
 
183
        """Get a file as a bytestream.
 
184
 
 
185
        :deprecated: Use a Transport instead of LockableFiles.
 
186
        """
154
187
        relpath = self._escape(relpath)
155
188
        return self._transport.get(relpath)
156
189
 
157
190
    @needs_read_lock
 
191
    @deprecated_method(deprecated_in((1, 5, 0)))
158
192
    def get_utf8(self, relpath):
159
 
        """Get a file as a unicode stream."""
 
193
        """Get a file as a unicode stream.
 
194
 
 
195
        :deprecated: Use a Transport instead of LockableFiles.
 
196
        """
160
197
        relpath = self._escape(relpath)
161
198
        # DO NOT introduce an errors=replace here.
162
199
        return codecs.getreader('utf-8')(self._transport.get(relpath))
163
200
 
164
201
    @needs_write_lock
 
202
    @deprecated_method(deprecated_in((1, 6, 0)))
165
203
    def put(self, path, file):
166
204
        """Write a file.
167
 
        
 
205
 
168
206
        :param path: The path to put the file, relative to the .bzr control
169
207
                     directory
170
 
        :param f: A file-like or string object whose contents should be copied.
 
208
        :param file: A file-like or string object whose contents should be copied.
 
209
 
 
210
        :deprecated: Use Transport methods instead.
171
211
        """
172
212
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
173
213
 
174
214
    @needs_write_lock
 
215
    @deprecated_method(deprecated_in((1, 6, 0)))
175
216
    def put_bytes(self, path, a_string):
176
217
        """Write a string of bytes.
177
218
 
178
219
        :param path: The path to put the bytes, relative to the transport root.
179
 
        :param string: A string object, whose exact bytes are to be copied.
 
220
        :param a_string: A string object, whose exact bytes are to be copied.
 
221
 
 
222
        :deprecated: Use Transport methods instead.
180
223
        """
181
224
        self._transport.put_bytes(self._escape(path), a_string,
182
225
                                  mode=self._file_mode)
183
226
 
184
227
    @needs_write_lock
 
228
    @deprecated_method(deprecated_in((1, 6, 0)))
185
229
    def put_utf8(self, path, a_string):
186
230
        """Write a string, encoding as utf-8.
187
231
 
188
232
        :param path: The path to put the string, relative to the transport root.
189
233
        :param string: A string or unicode object whose contents should be copied.
 
234
 
 
235
        :deprecated: Use Transport methods instead.
190
236
        """
191
237
        # IterableFile would not be needed if Transport.put took iterables
192
238
        # instead of files.  ADHB 2005-12-25
208
254
 
209
255
    def lock_write(self, token=None):
210
256
        """Lock this group of files for writing.
211
 
        
 
257
 
212
258
        :param token: if this is already locked, then lock_write will fail
213
259
            unless the token matches the existing lock.
214
260
        :returns: a token if this instance supports tokens, otherwise None.
221
267
        some other way, and need to synchronise this object's state with that
222
268
        fact.
223
269
        """
224
 
        # mutter("lock write: %s (%s)", self, self._lock_count)
225
270
        # TODO: Upgrade locking to support using a Transport,
226
271
        # and potentially a remote locking protocol
227
272
        if self._lock_mode:
228
273
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
229
274
                raise errors.ReadOnlyError(self)
230
275
            self._lock.validate_token(token)
231
 
            self._lock_count += 1
 
276
            self._lock_warner.lock_count += 1
232
277
            return self._token_from_lock
233
278
        else:
234
279
            token_from_lock = self._lock.lock_write(token=token)
235
 
            #note('write locking %s', self)
236
280
            #traceback.print_stack()
237
281
            self._lock_mode = 'w'
238
 
            self._lock_count = 1
239
 
            self._set_transaction(transactions.WriteTransaction())
 
282
            self._lock_warner.lock_count = 1
 
283
            self._set_write_transaction()
240
284
            self._token_from_lock = token_from_lock
241
285
            return token_from_lock
242
286
 
243
287
    def lock_read(self):
244
 
        # mutter("lock read: %s (%s)", self, self._lock_count)
245
288
        if self._lock_mode:
246
 
            assert self._lock_mode in ('r', 'w'), \
247
 
                   "invalid lock mode %r" % self._lock_mode
248
 
            self._lock_count += 1
 
289
            if self._lock_mode not in ('r', 'w'):
 
290
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
 
291
            self._lock_warner.lock_count += 1
249
292
        else:
250
293
            self._lock.lock_read()
251
 
            #note('read locking %s', self)
252
294
            #traceback.print_stack()
253
295
            self._lock_mode = 'r'
254
 
            self._lock_count = 1
255
 
            self._set_transaction(transactions.ReadOnlyTransaction())
256
 
            # 5K may be excessive, but hey, its a knob.
257
 
            self.get_transaction().set_cache_size(5000)
258
 
                        
 
296
            self._lock_warner.lock_count = 1
 
297
            self._set_read_transaction()
 
298
 
 
299
    def _set_read_transaction(self):
 
300
        """Setup a read transaction."""
 
301
        self._set_transaction(transactions.ReadOnlyTransaction())
 
302
        # 5K may be excessive, but hey, its a knob.
 
303
        self.get_transaction().set_cache_size(5000)
 
304
 
 
305
    def _set_write_transaction(self):
 
306
        """Setup a write transaction."""
 
307
        self._set_transaction(transactions.WriteTransaction())
 
308
 
259
309
    def unlock(self):
260
 
        # mutter("unlock: %s (%s)", self, self._lock_count)
261
310
        if not self._lock_mode:
262
311
            raise errors.LockNotHeld(self)
263
 
        if self._lock_count > 1:
264
 
            self._lock_count -= 1
 
312
        if self._lock_warner.lock_count > 1:
 
313
            self._lock_warner.lock_count -= 1
265
314
        else:
266
 
            #note('unlocking %s', self)
267
315
            #traceback.print_stack()
268
316
            self._finish_transaction()
269
317
            try:
270
318
                self._lock.unlock()
271
319
            finally:
272
 
                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
273
325
 
274
326
    def is_locked(self):
275
327
        """Return true if this LockableFiles group is locked"""
276
 
        return self._lock_count >= 1
 
328
        return self._lock_warner.lock_count >= 1
277
329
 
278
330
    def get_physical_lock_status(self):
279
331
        """Return physical lock status.
280
 
        
 
332
 
281
333
        Returns true if a lock is held on the transport. If no lock is held, or
282
334
        the underlying locking mechanism does not support querying lock
283
335
        status, false is returned.
365
417
    def validate_token(self, token):
366
418
        if token is not None:
367
419
            raise errors.TokenLockingNotSupported(self)
368
 
        
 
420