~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Aaron Bentley
  • Date: 2008-12-03 05:31:27 UTC
  • mto: This revision was merged to the branch mainline in revision 3893.
  • Revision ID: aaron@aaronbentley.com-20081203053127-vozu5rmsixaadw0v
Change ls-shelf to shelve --list

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
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
 
18
 
 
19
from bzrlib.lazy_import import lazy_import
 
20
lazy_import(globals(), """
 
21
import codecs
 
22
import warnings
 
23
 
 
24
from bzrlib import (
 
25
    errors,
 
26
    osutils,
 
27
    transactions,
 
28
    urlutils,
 
29
    )
 
30
""")
 
31
 
 
32
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,
 
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 LockableFiles(object):
 
47
    """Object representing a set of related files locked within the same scope.
 
48
 
 
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.
 
54
 
 
55
    LockableFiles manage a lock count and can be locked repeatedly by
 
56
    a single caller.  (The underlying lock implementation generally does not
 
57
    support this.)
 
58
 
 
59
    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
 
 
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
    locking.
 
71
    """
 
72
 
 
73
    # _lock_mode: None, or 'r' or 'w'
 
74
 
 
75
    # _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
    
 
78
    def __init__(self, transport, lock_name, lock_class):
 
79
        """Create a LockableFiles group
 
80
 
 
81
        :param transport: Transport pointing to the directory holding the 
 
82
            control files and lock.
 
83
        :param lock_name: Name of the lock guarding these files.
 
84
        :param lock_class: Class of lock strategy to use: typically
 
85
            either LockDir or TransportLock.
 
86
        """
 
87
        self._transport = transport
 
88
        self.lock_name = lock_name
 
89
        self._transaction = None
 
90
        self._lock_mode = None
 
91
        self._lock_count = 0
 
92
        self._find_modes()
 
93
        esc_name = self._escape(lock_name)
 
94
        self._lock = lock_class(transport, esc_name,
 
95
                                file_modebits=self._file_mode,
 
96
                                dir_modebits=self._dir_mode)
 
97
 
 
98
    def create_lock(self):
 
99
        """Create the lock.
 
100
 
 
101
        This should normally be called only when the LockableFiles directory
 
102
        is first created on disk.
 
103
        """
 
104
        self._lock.create(mode=self._dir_mode)
 
105
 
 
106
    def __repr__(self):
 
107
        return '%s(%r)' % (self.__class__.__name__,
 
108
                           self._transport)
 
109
    def __str__(self):
 
110
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
 
111
 
 
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
    def break_lock(self):
 
119
        """Break the lock of this lockable files group if it is held.
 
120
 
 
121
        The current ui factory will be used to prompt for user conformation.
 
122
        """
 
123
        self._lock.break_lock()
 
124
 
 
125
    def _escape(self, file_or_path):
 
126
        """DEPRECATED: Do not use outside this class"""
 
127
        if not isinstance(file_or_path, basestring):
 
128
            file_or_path = '/'.join(file_or_path)
 
129
        if file_or_path == '':
 
130
            return u''
 
131
        return urlutils.escape(osutils.safe_unicode(file_or_path))
 
132
 
 
133
    def _find_modes(self):
 
134
        """Determine the appropriate modes for files and directories.
 
135
        
 
136
        :deprecated: Replaced by BzrDir._find_modes.
 
137
        """
 
138
        try:
 
139
            st = self._transport.stat('.')
 
140
        except errors.TransportNotPossible:
 
141
            self._dir_mode = 0755
 
142
            self._file_mode = 0644
 
143
        else:
 
144
            # Check the directory mode, but also make sure the created
 
145
            # directories and files are read-write for this user. This is
 
146
            # mostly a workaround for filesystems which lie about being able to
 
147
            # write to a directory (cygwin & win32)
 
148
            self._dir_mode = (st.st_mode & 07777) | 00700
 
149
            # Remove the sticky and execute bits for files
 
150
            self._file_mode = self._dir_mode & ~07111
 
151
 
 
152
    @deprecated_method(deprecated_in((1, 6, 0)))
 
153
    def controlfilename(self, file_or_path):
 
154
        """Return location relative to branch.
 
155
        
 
156
        :deprecated: Use Transport methods instead.
 
157
        """
 
158
        return self._transport.abspath(self._escape(file_or_path))
 
159
 
 
160
    @needs_read_lock
 
161
    @deprecated_method(deprecated_in((1, 5, 0)))
 
162
    def get(self, relpath):
 
163
        """Get a file as a bytestream.
 
164
        
 
165
        :deprecated: Use a Transport instead of LockableFiles.
 
166
        """
 
167
        relpath = self._escape(relpath)
 
168
        return self._transport.get(relpath)
 
169
 
 
170
    @needs_read_lock
 
171
    @deprecated_method(deprecated_in((1, 5, 0)))
 
172
    def get_utf8(self, relpath):
 
173
        """Get a file as a unicode stream.
 
174
        
 
175
        :deprecated: Use a Transport instead of LockableFiles.
 
176
        """
 
177
        relpath = self._escape(relpath)
 
178
        # DO NOT introduce an errors=replace here.
 
179
        return codecs.getreader('utf-8')(self._transport.get(relpath))
 
180
 
 
181
    @needs_write_lock
 
182
    @deprecated_method(deprecated_in((1, 6, 0)))
 
183
    def put(self, path, file):
 
184
        """Write a file.
 
185
        
 
186
        :param path: The path to put the file, relative to the .bzr control
 
187
                     directory
 
188
        :param file: A file-like or string object whose contents should be copied.
 
189
 
 
190
        :deprecated: Use Transport methods instead.
 
191
        """
 
192
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
 
193
 
 
194
    @needs_write_lock
 
195
    @deprecated_method(deprecated_in((1, 6, 0)))
 
196
    def put_bytes(self, path, a_string):
 
197
        """Write a string of bytes.
 
198
 
 
199
        :param path: The path to put the bytes, relative to the transport root.
 
200
        :param a_string: A string object, whose exact bytes are to be copied.
 
201
 
 
202
        :deprecated: Use Transport methods instead.
 
203
        """
 
204
        self._transport.put_bytes(self._escape(path), a_string,
 
205
                                  mode=self._file_mode)
 
206
 
 
207
    @needs_write_lock
 
208
    @deprecated_method(deprecated_in((1, 6, 0)))
 
209
    def put_utf8(self, path, a_string):
 
210
        """Write a string, encoding as utf-8.
 
211
 
 
212
        :param path: The path to put the string, relative to the transport root.
 
213
        :param string: A string or unicode object whose contents should be copied.
 
214
 
 
215
        :deprecated: Use Transport methods instead.
 
216
        """
 
217
        # IterableFile would not be needed if Transport.put took iterables
 
218
        # instead of files.  ADHB 2005-12-25
 
219
        # RBC 20060103 surely its not needed anyway, with codecs transcode
 
220
        # file support ?
 
221
        # JAM 20060103 We definitely don't want encode(..., 'replace')
 
222
        # these are valuable files which should have exact contents.
 
223
        if not isinstance(a_string, basestring):
 
224
            raise errors.BzrBadParameterNotString(a_string)
 
225
        self.put_bytes(path, a_string.encode('utf-8'))
 
226
 
 
227
    def leave_in_place(self):
 
228
        """Set this LockableFiles to not clear the physical lock on unlock."""
 
229
        self._lock.leave_in_place()
 
230
 
 
231
    def dont_leave_in_place(self):
 
232
        """Set this LockableFiles to clear the physical lock on unlock."""
 
233
        self._lock.dont_leave_in_place()
 
234
 
 
235
    def lock_write(self, token=None):
 
236
        """Lock this group of files for writing.
 
237
        
 
238
        :param token: if this is already locked, then lock_write will fail
 
239
            unless the token matches the existing lock.
 
240
        :returns: a token if this instance supports tokens, otherwise None.
 
241
        :raises TokenLockingNotSupported: when a token is given but this
 
242
            instance doesn't support using token locks.
 
243
        :raises MismatchedToken: if the specified token doesn't match the token
 
244
            of the existing lock.
 
245
 
 
246
        A token should be passed in if you know that you have locked the object
 
247
        some other way, and need to synchronise this object's state with that
 
248
        fact.
 
249
        """
 
250
        # TODO: Upgrade locking to support using a Transport,
 
251
        # and potentially a remote locking protocol
 
252
        if self._lock_mode:
 
253
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
 
254
                raise errors.ReadOnlyError(self)
 
255
            self._lock.validate_token(token)
 
256
            self._lock_count += 1
 
257
            return self._token_from_lock
 
258
        else:
 
259
            token_from_lock = self._lock.lock_write(token=token)
 
260
            #traceback.print_stack()
 
261
            self._lock_mode = 'w'
 
262
            self._lock_count = 1
 
263
            self._set_transaction(transactions.WriteTransaction())
 
264
            self._token_from_lock = token_from_lock
 
265
            return token_from_lock
 
266
 
 
267
    def lock_read(self):
 
268
        if self._lock_mode:
 
269
            if self._lock_mode not in ('r', 'w'):
 
270
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
 
271
            self._lock_count += 1
 
272
        else:
 
273
            self._lock.lock_read()
 
274
            #traceback.print_stack()
 
275
            self._lock_mode = 'r'
 
276
            self._lock_count = 1
 
277
            self._set_transaction(transactions.ReadOnlyTransaction())
 
278
            # 5K may be excessive, but hey, its a knob.
 
279
            self.get_transaction().set_cache_size(5000)
 
280
                        
 
281
    def unlock(self):
 
282
        if not self._lock_mode:
 
283
            raise errors.LockNotHeld(self)
 
284
        if self._lock_count > 1:
 
285
            self._lock_count -= 1
 
286
        else:
 
287
            #traceback.print_stack()
 
288
            self._finish_transaction()
 
289
            try:
 
290
                self._lock.unlock()
 
291
            finally:
 
292
                self._lock_mode = self._lock_count = None
 
293
 
 
294
    def is_locked(self):
 
295
        """Return true if this LockableFiles group is locked"""
 
296
        return self._lock_count >= 1
 
297
 
 
298
    def get_physical_lock_status(self):
 
299
        """Return physical lock status.
 
300
        
 
301
        Returns true if a lock is held on the transport. If no lock is held, or
 
302
        the underlying locking mechanism does not support querying lock
 
303
        status, false is returned.
 
304
        """
 
305
        try:
 
306
            return self._lock.peek() is not None
 
307
        except NotImplementedError:
 
308
            return False
 
309
 
 
310
    def get_transaction(self):
 
311
        """Return the current active transaction.
 
312
 
 
313
        If no transaction is active, this returns a passthrough object
 
314
        for which all data is immediately flushed and no caching happens.
 
315
        """
 
316
        if self._transaction is None:
 
317
            return transactions.PassThroughTransaction()
 
318
        else:
 
319
            return self._transaction
 
320
 
 
321
    def _set_transaction(self, new_transaction):
 
322
        """Set a new active transaction."""
 
323
        if self._transaction is not None:
 
324
            raise errors.LockError('Branch %s is in a transaction already.' %
 
325
                                   self)
 
326
        self._transaction = new_transaction
 
327
 
 
328
    def _finish_transaction(self):
 
329
        """Exit the current transaction."""
 
330
        if self._transaction is None:
 
331
            raise errors.LockError('Branch %s is not in a transaction' %
 
332
                                   self)
 
333
        transaction = self._transaction
 
334
        self._transaction = None
 
335
        transaction.finish()
 
336
 
 
337
 
 
338
class TransportLock(object):
 
339
    """Locking method which uses transport-dependent locks.
 
340
 
 
341
    On the local filesystem these transform into OS-managed locks.
 
342
 
 
343
    These do not guard against concurrent access via different
 
344
    transports.
 
345
 
 
346
    This is suitable for use only in WorkingTrees (which are at present
 
347
    always local).
 
348
    """
 
349
    def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
 
350
        self._transport = transport
 
351
        self._escaped_name = escaped_name
 
352
        self._file_modebits = file_modebits
 
353
        self._dir_modebits = dir_modebits
 
354
 
 
355
    def break_lock(self):
 
356
        raise NotImplementedError(self.break_lock)
 
357
 
 
358
    def leave_in_place(self):
 
359
        raise NotImplementedError(self.leave_in_place)
 
360
 
 
361
    def dont_leave_in_place(self):
 
362
        raise NotImplementedError(self.dont_leave_in_place)
 
363
 
 
364
    def lock_write(self, token=None):
 
365
        if token is not None:
 
366
            raise errors.TokenLockingNotSupported(self)
 
367
        self._lock = self._transport.lock_write(self._escaped_name)
 
368
 
 
369
    def lock_read(self):
 
370
        self._lock = self._transport.lock_read(self._escaped_name)
 
371
 
 
372
    def unlock(self):
 
373
        self._lock.unlock()
 
374
        self._lock = None
 
375
 
 
376
    def peek(self):
 
377
        raise NotImplementedError()
 
378
 
 
379
    def create(self, mode=None):
 
380
        """Create lock mechanism"""
 
381
        # for old-style locks, create the file now
 
382
        self._transport.put_bytes(self._escaped_name, '',
 
383
                            mode=self._file_modebits)
 
384
 
 
385
    def validate_token(self, token):
 
386
        if token is not None:
 
387
            raise errors.TokenLockingNotSupported(self)
 
388