/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

Fix formatting, remove catch-all for exceptions when opening local repositories.

Show diffs side-by-side

added added

removed removed

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