← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

(jam) Handle bug #382709 by encoding paths as 'mbcs' when spawning
        external diff.

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