← 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: 2008-07-14 07:39:30 UTC
  • mto: This revision was merged to the branch mainline in revision 3537.
  • Revision ID: mbp@sourcefrog.net-20080714073930-z8nl2c44jal0eozs
Update test for knit.check() to expect it to recurse into fallback vfs

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