← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Florian Dorn
  • Date: 2011-05-25 09:45:08 UTC
  • mto: This revision was merged to the branch mainline in revision 6546.
  • Revision ID: florian.dorn@boku.ac.at-20110525094508-o1c8dagf310i8ey3
added a Base64CredentialStore, refs #788015 

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
1
 
# Copyright (C) 2005, 2006, 2008 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
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
16
 
 
17
 
from cStringIO import StringIO
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
16
 
19
17
from bzrlib.lazy_import import lazy_import
20
18
lazy_import(globals(), """
21
 
import codecs
22
19
import warnings
23
20
 
24
21
from bzrlib import (
 
22
    counted_lock,
25
23
    errors,
 
24
    lock,
26
25
    osutils,
27
26
    transactions,
28
27
    urlutils,
30
29
""")
31
30
 
32
31
from bzrlib.decorators import (
33
 
    needs_read_lock,
34
 
    needs_write_lock,
35
 
    )
36
 
from bzrlib.symbol_versioning import (
37
 
    deprecated_in,
38
 
    deprecated_method,
 
32
    only_raises,
39
33
    )
40
34
 
41
35
 
43
37
# somewhat redundant with what's done in LockDir; the main difference is that
44
38
# LockableFiles permits reentrancy.
45
39
 
 
40
class _LockWarner(object):
 
41
    """Hold a counter for a lock and warn if GCed while the count is >= 1.
 
42
 
 
43
    This is separate from LockableFiles because putting a __del__ on
 
44
    LockableFiles can result in uncollectable cycles.
 
45
    """
 
46
 
 
47
    def __init__(self, repr):
 
48
        self.lock_count = 0
 
49
        self.repr = repr
 
50
 
 
51
    def __del__(self):
 
52
        if self.lock_count >= 1:
 
53
            # There should have been a try/finally to unlock this.
 
54
            warnings.warn("%r was gc'd while locked" % self.repr)
 
55
 
 
56
 
46
57
class LockableFiles(object):
47
58
    """Object representing a set of related files locked within the same scope.
48
59
 
49
 
    These files are used by a WorkingTree, Repository or Branch, and should
50
 
    generally only be touched by that object.
51
 
 
52
 
    LockableFiles also provides some policy on top of Transport for encoding
53
 
    control files as utf-8.
 
60
    This coordinates access to the lock along with providing a transaction.
54
61
 
55
62
    LockableFiles manage a lock count and can be locked repeatedly by
56
63
    a single caller.  (The underlying lock implementation generally does not
57
64
    support this.)
58
65
 
59
66
    Instances of this class are often called control_files.
60
 
    
61
 
    This object builds on top of a Transport, which is used to actually write
62
 
    the files to disk, and an OSLock or LockDir, which controls how access to
63
 
    the files is controlled.  The particular type of locking used is set when
64
 
    the object is constructed.  In older formats OSLocks are used everywhere.
65
 
    in newer formats a LockDir is used for Repositories and Branches, and 
66
 
    OSLocks for the local filesystem.
67
67
 
68
 
    This class is now deprecated; code should move to using the Transport 
69
 
    directly for file operations and using the lock or CountedLock for 
 
68
    This class is now deprecated; code should move to using the Transport
 
69
    directly for file operations and using the lock or CountedLock for
70
70
    locking.
 
71
    
 
72
    :ivar _lock: The real underlying lock (e.g. a LockDir)
 
73
    :ivar _counted_lock: A lock decorated with a semaphore, so that it 
 
74
        can be re-entered.
71
75
    """
72
76
 
73
77
    # _lock_mode: None, or 'r' or 'w'
74
78
 
75
79
    # _lock_count: If _lock_mode is true, a positive count of the number of
76
 
    # times the lock has been taken *by this process*.   
77
 
    
 
80
    # times the lock has been taken *by this process*.
 
81
 
78
82
    def __init__(self, transport, lock_name, lock_class):
79
83
        """Create a LockableFiles group
80
84
 
81
 
        :param transport: Transport pointing to the directory holding the 
 
85
        :param transport: Transport pointing to the directory holding the
82
86
            control files and lock.
83
87
        :param lock_name: Name of the lock guarding these files.
84
88
        :param lock_class: Class of lock strategy to use: typically
88
92
        self.lock_name = lock_name
89
93
        self._transaction = None
90
94
        self._lock_mode = None
91
 
        self._lock_count = 0
 
95
        self._lock_warner = _LockWarner(repr(self))
92
96
        self._find_modes()
93
97
        esc_name = self._escape(lock_name)
94
98
        self._lock = lock_class(transport, esc_name,
95
99
                                file_modebits=self._file_mode,
96
100
                                dir_modebits=self._dir_mode)
 
101
        self._counted_lock = counted_lock.CountedLock(self._lock)
97
102
 
98
103
    def create_lock(self):
99
104
        """Create the lock.
109
114
    def __str__(self):
110
115
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
111
116
 
112
 
    def __del__(self):
113
 
        if self.is_locked():
114
 
            # do not automatically unlock; there should have been a
115
 
            # try/finally to unlock this.
116
 
            warnings.warn("%r was gc'd while locked" % self)
117
 
 
118
117
    def break_lock(self):
119
118
        """Break the lock of this lockable files group if it is held.
120
119
 
123
122
        self._lock.break_lock()
124
123
 
125
124
    def _escape(self, file_or_path):
 
125
        """DEPRECATED: Do not use outside this class"""
126
126
        if not isinstance(file_or_path, basestring):
127
127
            file_or_path = '/'.join(file_or_path)
128
128
        if file_or_path == '':
131
131
 
132
132
    def _find_modes(self):
133
133
        """Determine the appropriate modes for files and directories.
134
 
        
135
 
        :deprecated: Replaced by BzrDir._find_modes.
 
134
 
 
135
        :deprecated: Replaced by BzrDir._find_creation_modes.
136
136
        """
 
137
        # XXX: The properties created by this can be removed or deprecated
 
138
        # once all the _get_text_store methods etc no longer use them.
 
139
        # -- mbp 20080512
137
140
        try:
138
141
            st = self._transport.stat('.')
139
142
        except errors.TransportNotPossible:
148
151
            # Remove the sticky and execute bits for files
149
152
            self._file_mode = self._dir_mode & ~07111
150
153
 
151
 
    @deprecated_method(deprecated_in((1, 6, 0)))
152
 
    def controlfilename(self, file_or_path):
153
 
        """Return location relative to branch.
154
 
        
155
 
        :deprecated: Use Transport methods instead.
156
 
        """
157
 
        return self._transport.abspath(self._escape(file_or_path))
158
 
 
159
 
    @needs_read_lock
160
 
    @deprecated_method(deprecated_in((1, 5, 0)))
161
 
    def get(self, relpath):
162
 
        """Get a file as a bytestream.
163
 
        
164
 
        :deprecated: Use a Transport instead of LockableFiles.
165
 
        """
166
 
        relpath = self._escape(relpath)
167
 
        return self._transport.get(relpath)
168
 
 
169
 
    @needs_read_lock
170
 
    @deprecated_method(deprecated_in((1, 5, 0)))
171
 
    def get_utf8(self, relpath):
172
 
        """Get a file as a unicode stream.
173
 
        
174
 
        :deprecated: Use a Transport instead of LockableFiles.
175
 
        """
176
 
        relpath = self._escape(relpath)
177
 
        # DO NOT introduce an errors=replace here.
178
 
        return codecs.getreader('utf-8')(self._transport.get(relpath))
179
 
 
180
 
    @needs_write_lock
181
 
    @deprecated_method(deprecated_in((1, 6, 0)))
182
 
    def put(self, path, file):
183
 
        """Write a file.
184
 
        
185
 
        :param path: The path to put the file, relative to the .bzr control
186
 
                     directory
187
 
        :param file: A file-like or string object whose contents should be copied.
188
 
 
189
 
        :deprecated: Use Transport methods instead.
190
 
        """
191
 
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
192
 
 
193
 
    @needs_write_lock
194
 
    @deprecated_method(deprecated_in((1, 6, 0)))
195
 
    def put_bytes(self, path, a_string):
196
 
        """Write a string of bytes.
197
 
 
198
 
        :param path: The path to put the bytes, relative to the transport root.
199
 
        :param a_string: A string object, whose exact bytes are to be copied.
200
 
 
201
 
        :deprecated: Use Transport methods instead.
202
 
        """
203
 
        self._transport.put_bytes(self._escape(path), a_string,
204
 
                                  mode=self._file_mode)
205
 
 
206
 
    @needs_write_lock
207
 
    @deprecated_method(deprecated_in((1, 6, 0)))
208
 
    def put_utf8(self, path, a_string):
209
 
        """Write a string, encoding as utf-8.
210
 
 
211
 
        :param path: The path to put the string, relative to the transport root.
212
 
        :param string: A string or unicode object whose contents should be copied.
213
 
 
214
 
        :deprecated: Use Transport methods instead.
215
 
        """
216
 
        # IterableFile would not be needed if Transport.put took iterables
217
 
        # instead of files.  ADHB 2005-12-25
218
 
        # RBC 20060103 surely its not needed anyway, with codecs transcode
219
 
        # file support ?
220
 
        # JAM 20060103 We definitely don't want encode(..., 'replace')
221
 
        # these are valuable files which should have exact contents.
222
 
        if not isinstance(a_string, basestring):
223
 
            raise errors.BzrBadParameterNotString(a_string)
224
 
        self.put_bytes(path, a_string.encode('utf-8'))
225
 
 
226
154
    def leave_in_place(self):
227
155
        """Set this LockableFiles to not clear the physical lock on unlock."""
228
156
        self._lock.leave_in_place()
233
161
 
234
162
    def lock_write(self, token=None):
235
163
        """Lock this group of files for writing.
236
 
        
 
164
 
237
165
        :param token: if this is already locked, then lock_write will fail
238
166
            unless the token matches the existing lock.
239
167
        :returns: a token if this instance supports tokens, otherwise None.
252
180
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
253
181
                raise errors.ReadOnlyError(self)
254
182
            self._lock.validate_token(token)
255
 
            self._lock_count += 1
 
183
            self._lock_warner.lock_count += 1
256
184
            return self._token_from_lock
257
185
        else:
258
186
            token_from_lock = self._lock.lock_write(token=token)
259
187
            #traceback.print_stack()
260
188
            self._lock_mode = 'w'
261
 
            self._lock_count = 1
262
 
            self._set_transaction(transactions.WriteTransaction())
 
189
            self._lock_warner.lock_count = 1
 
190
            self._set_write_transaction()
263
191
            self._token_from_lock = token_from_lock
264
192
            return token_from_lock
265
193
 
267
195
        if self._lock_mode:
268
196
            if self._lock_mode not in ('r', 'w'):
269
197
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
270
 
            self._lock_count += 1
 
198
            self._lock_warner.lock_count += 1
271
199
        else:
272
200
            self._lock.lock_read()
273
201
            #traceback.print_stack()
274
202
            self._lock_mode = 'r'
275
 
            self._lock_count = 1
276
 
            self._set_transaction(transactions.ReadOnlyTransaction())
277
 
            # 5K may be excessive, but hey, its a knob.
278
 
            self.get_transaction().set_cache_size(5000)
279
 
                        
 
203
            self._lock_warner.lock_count = 1
 
204
            self._set_read_transaction()
 
205
 
 
206
    def _set_read_transaction(self):
 
207
        """Setup a read transaction."""
 
208
        self._set_transaction(transactions.ReadOnlyTransaction())
 
209
        # 5K may be excessive, but hey, its a knob.
 
210
        self.get_transaction().set_cache_size(5000)
 
211
 
 
212
    def _set_write_transaction(self):
 
213
        """Setup a write transaction."""
 
214
        self._set_transaction(transactions.WriteTransaction())
 
215
 
 
216
    @only_raises(errors.LockNotHeld, errors.LockBroken)
280
217
    def unlock(self):
281
218
        if not self._lock_mode:
282
 
            raise errors.LockNotHeld(self)
283
 
        if self._lock_count > 1:
284
 
            self._lock_count -= 1
 
219
            return lock.cant_unlock_not_held(self)
 
220
        if self._lock_warner.lock_count > 1:
 
221
            self._lock_warner.lock_count -= 1
285
222
        else:
286
223
            #traceback.print_stack()
287
224
            self._finish_transaction()
288
225
            try:
289
226
                self._lock.unlock()
290
227
            finally:
291
 
                self._lock_mode = self._lock_count = None
 
228
                self._lock_mode = self._lock_warner.lock_count = None
 
229
 
 
230
    @property
 
231
    def _lock_count(self):
 
232
        return self._lock_warner.lock_count
292
233
 
293
234
    def is_locked(self):
294
235
        """Return true if this LockableFiles group is locked"""
295
 
        return self._lock_count >= 1
 
236
        return self._lock_warner.lock_count >= 1
296
237
 
297
238
    def get_physical_lock_status(self):
298
239
        """Return physical lock status.
299
 
        
 
240
 
300
241
        Returns true if a lock is held on the transport. If no lock is held, or
301
242
        the underlying locking mechanism does not support querying lock
302
243
        status, false is returned.
384
325
    def validate_token(self, token):
385
326
        if token is not None:
386
327
            raise errors.TokenLockingNotSupported(self)
387
 
        
 
328