/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

Add Repository.{dont_,}leave_lock_in_place.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
 
1
# Copyright (C) 2005, 2006 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
import codecs
 
19
#import traceback
 
20
 
 
21
import bzrlib
 
22
from bzrlib.decorators import (needs_read_lock,
 
23
        needs_write_lock)
 
24
import bzrlib.errors as errors
 
25
from bzrlib.errors import BzrError
 
26
from bzrlib.osutils import file_iterator, safe_unicode
 
27
from bzrlib.symbol_versioning import (deprecated_method, 
 
28
        zero_eight)
 
29
from bzrlib.trace import mutter, note
 
30
import bzrlib.transactions as transactions
 
31
import bzrlib.urlutils as urlutils
 
32
 
 
33
 
 
34
# XXX: The tracking here of lock counts and whether the lock is held is
 
35
# somewhat redundant with what's done in LockDir; the main difference is that
 
36
# LockableFiles permits reentrancy.
 
37
 
 
38
class LockableFiles(object):
 
39
    """Object representing a set of related files locked within the same scope.
 
40
 
 
41
    These files are used by a WorkingTree, Repository or Branch, and should
 
42
    generally only be touched by that object.
 
43
 
 
44
    LockableFiles also provides some policy on top of Transport for encoding
 
45
    control files as utf-8.
 
46
 
 
47
    LockableFiles manage a lock count and can be locked repeatedly by
 
48
    a single caller.  (The underlying lock implementation generally does not
 
49
    support this.)
 
50
 
 
51
    Instances of this class are often called control_files.
 
52
    
 
53
    This object builds on top of a Transport, which is used to actually write
 
54
    the files to disk, and an OSLock or LockDir, which controls how access to
 
55
    the files is controlled.  The particular type of locking used is set when
 
56
    the object is constructed.  In older formats OSLocks are used everywhere.
 
57
    in newer formats a LockDir is used for Repositories and Branches, and 
 
58
    OSLocks for the local filesystem.
 
59
    """
 
60
 
 
61
    # _lock_mode: None, or 'r' or 'w'
 
62
 
 
63
    # _lock_count: If _lock_mode is true, a positive count of the number of
 
64
    # times the lock has been taken *by this process*.   
 
65
    
 
66
    # If set to False (by a plugin, etc) BzrBranch will not set the
 
67
    # mode on created files or directories
 
68
    _set_file_mode = True
 
69
    _set_dir_mode = True
 
70
 
 
71
    def __init__(self, transport, lock_name, lock_class):
 
72
        """Create a LockableFiles group
 
73
 
 
74
        :param transport: Transport pointing to the directory holding the 
 
75
            control files and lock.
 
76
        :param lock_name: Name of the lock guarding these files.
 
77
        :param lock_class: Class of lock strategy to use: typically
 
78
            either LockDir or TransportLock.
 
79
        """
 
80
        self._transport = transport
 
81
        self.lock_name = lock_name
 
82
        self._transaction = None
 
83
        self._lock_mode = None
 
84
        self._lock_count = 0
 
85
        self._find_modes()
 
86
        esc_name = self._escape(lock_name)
 
87
        self._lock = lock_class(transport, esc_name,
 
88
                                file_modebits=self._file_mode,
 
89
                                dir_modebits=self._dir_mode)
 
90
 
 
91
    def create_lock(self):
 
92
        """Create the lock.
 
93
 
 
94
        This should normally be called only when the LockableFiles directory
 
95
        is first created on disk.
 
96
        """
 
97
        self._lock.create(mode=self._dir_mode)
 
98
 
 
99
    def __repr__(self):
 
100
        return '%s(%r)' % (self.__class__.__name__,
 
101
                           self._transport)
 
102
    def __str__(self):
 
103
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
 
104
 
 
105
    def __del__(self):
 
106
        if self.is_locked():
 
107
            # XXX: This should show something every time, and be suitable for
 
108
            # headless operation and embedding
 
109
            from warnings import warn
 
110
            warn("file group %r was not explicitly unlocked" % self)
 
111
            self._lock.unlock()
 
112
 
 
113
    def break_lock(self):
 
114
        """Break the lock of this lockable files group if it is held.
 
115
 
 
116
        The current ui factory will be used to prompt for user conformation.
 
117
        """
 
118
        self._lock.break_lock()
 
119
 
 
120
    def _escape(self, file_or_path):
 
121
        if not isinstance(file_or_path, basestring):
 
122
            file_or_path = '/'.join(file_or_path)
 
123
        if file_or_path == '':
 
124
            return u''
 
125
        return urlutils.escape(safe_unicode(file_or_path))
 
126
 
 
127
    def _find_modes(self):
 
128
        """Determine the appropriate modes for files and directories."""
 
129
        try:
 
130
            st = self._transport.stat('.')
 
131
        except errors.TransportNotPossible:
 
132
            self._dir_mode = 0755
 
133
            self._file_mode = 0644
 
134
        else:
 
135
            self._dir_mode = st.st_mode & 07777
 
136
            # Remove the sticky and execute bits for files
 
137
            self._file_mode = self._dir_mode & ~07111
 
138
        if not self._set_dir_mode:
 
139
            self._dir_mode = None
 
140
        if not self._set_file_mode:
 
141
            self._file_mode = None
 
142
 
 
143
    def controlfilename(self, file_or_path):
 
144
        """Return location relative to branch."""
 
145
        return self._transport.abspath(self._escape(file_or_path))
 
146
 
 
147
    @deprecated_method(zero_eight)
 
148
    def controlfile(self, file_or_path, mode='r'):
 
149
        """Open a control file for this branch.
 
150
 
 
151
        There are two classes of file in a lockable directory: text
 
152
        and binary.  binary files are untranslated byte streams.  Text
 
153
        control files are stored with Unix newlines and in UTF-8, even
 
154
        if the platform or locale defaults are different.
 
155
 
 
156
        Such files are not openable in write mode : they are managed via
 
157
        put and put_utf8 which atomically replace old versions using
 
158
        atomicfile.
 
159
        """
 
160
 
 
161
        relpath = self._escape(file_or_path)
 
162
        # TODO: codecs.open() buffers linewise, so it was overloaded with
 
163
        # a much larger buffer, do we need to do the same for getreader/getwriter?
 
164
        if mode == 'rb': 
 
165
            return self.get(relpath)
 
166
        elif mode == 'wb':
 
167
            raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
 
168
        elif mode == 'r':
 
169
            return self.get_utf8(relpath)
 
170
        elif mode == 'w':
 
171
            raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
 
172
        else:
 
173
            raise BzrError("invalid controlfile mode %r" % mode)
 
174
 
 
175
    @needs_read_lock
 
176
    def get(self, relpath):
 
177
        """Get a file as a bytestream."""
 
178
        relpath = self._escape(relpath)
 
179
        return self._transport.get(relpath)
 
180
 
 
181
    @needs_read_lock
 
182
    def get_utf8(self, relpath):
 
183
        """Get a file as a unicode stream."""
 
184
        relpath = self._escape(relpath)
 
185
        # DO NOT introduce an errors=replace here.
 
186
        return codecs.getreader('utf-8')(self._transport.get(relpath))
 
187
 
 
188
    @needs_write_lock
 
189
    def put(self, path, file):
 
190
        """Write a file.
 
191
        
 
192
        :param path: The path to put the file, relative to the .bzr control
 
193
                     directory
 
194
        :param f: A file-like or string object whose contents should be copied.
 
195
        """
 
196
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
 
197
 
 
198
    @needs_write_lock
 
199
    def put_utf8(self, path, a_string):
 
200
        """Write a string, encoding as utf-8.
 
201
 
 
202
        :param path: The path to put the string, relative to the transport root.
 
203
        :param string: A file-like or string object whose contents should be copied.
 
204
        """
 
205
        # IterableFile would not be needed if Transport.put took iterables
 
206
        # instead of files.  ADHB 2005-12-25
 
207
        # RBC 20060103 surely its not needed anyway, with codecs transcode
 
208
        # file support ?
 
209
        # JAM 20060103 We definitely don't want encode(..., 'replace')
 
210
        # these are valuable files which should have exact contents.
 
211
        if not isinstance(a_string, basestring):
 
212
            raise errors.BzrBadParameterNotString(a_string)
 
213
        self.put(path, StringIO(a_string.encode('utf-8')))
 
214
 
 
215
    def leave_in_place(self):
 
216
        """Set this LockableFiles to not clear the physical lock on unlock."""
 
217
        self._lock.leave_in_place()
 
218
 
 
219
    def dont_leave_in_place(self):
 
220
        """Set this LockableFiles to clear the physical lock on unlock."""
 
221
        # XXX: think about renaming this!
 
222
        self._lock.dont_leave_in_place()
 
223
 
 
224
    def lock_write(self, token=None):
 
225
        """Lock this group of files for writing.
 
226
        
 
227
        :param token: if this is already locked, then lock_write will fail
 
228
            unless the token matches the existing lock.
 
229
        :returns: a token if this instance supports tokens, otherwise None.
 
230
        :raises TokenLockingNotSupported: when a token is given but this
 
231
            instance doesn't support using token locks.
 
232
        :raises MismatchedToken: if the specified token doesn't match the token
 
233
            of the existing lock.
 
234
        """
 
235
        # mutter("lock write: %s (%s)", self, self._lock_count)
 
236
        # TODO: Upgrade locking to support using a Transport,
 
237
        # and potentially a remote locking protocol
 
238
        if self._lock_mode:
 
239
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
 
240
                raise errors.ReadOnlyError(self)
 
241
            self._lock.validate_token(token)
 
242
            self._lock_count += 1
 
243
        else:
 
244
            token_from_lock = self._lock.lock_write(token=token)
 
245
            #note('write locking %s', self)
 
246
            #traceback.print_stack()
 
247
            self._lock_mode = 'w'
 
248
            self._lock_count = 1
 
249
            self._set_transaction(transactions.WriteTransaction())
 
250
            return token_from_lock
 
251
 
 
252
    def lock_read(self):
 
253
        # mutter("lock read: %s (%s)", self, self._lock_count)
 
254
        if self._lock_mode:
 
255
            assert self._lock_mode in ('r', 'w'), \
 
256
                   "invalid lock mode %r" % self._lock_mode
 
257
            self._lock_count += 1
 
258
        else:
 
259
            self._lock.lock_read()
 
260
            #note('read locking %s', self)
 
261
            #traceback.print_stack()
 
262
            self._lock_mode = 'r'
 
263
            self._lock_count = 1
 
264
            self._set_transaction(transactions.ReadOnlyTransaction())
 
265
            # 5K may be excessive, but hey, its a knob.
 
266
            self.get_transaction().set_cache_size(5000)
 
267
                        
 
268
    def unlock(self):
 
269
        # mutter("unlock: %s (%s)", self, self._lock_count)
 
270
        if not self._lock_mode:
 
271
            raise errors.LockNotHeld(self)
 
272
        if self._lock_count > 1:
 
273
            self._lock_count -= 1
 
274
        else:
 
275
            #note('unlocking %s', self)
 
276
            #traceback.print_stack()
 
277
            self._finish_transaction()
 
278
            try:
 
279
                self._lock.unlock()
 
280
            finally:
 
281
                self._lock_mode = self._lock_count = None
 
282
 
 
283
    def is_locked(self):
 
284
        """Return true if this LockableFiles group is locked"""
 
285
        return self._lock_count >= 1
 
286
 
 
287
    def get_physical_lock_status(self):
 
288
        """Return physical lock status.
 
289
        
 
290
        Returns true if a lock is held on the transport. If no lock is held, or
 
291
        the underlying locking mechanism does not support querying lock
 
292
        status, false is returned.
 
293
        """
 
294
        try:
 
295
            return self._lock.peek() is not None
 
296
        except NotImplementedError:
 
297
            return False
 
298
 
 
299
    def get_transaction(self):
 
300
        """Return the current active transaction.
 
301
 
 
302
        If no transaction is active, this returns a passthrough object
 
303
        for which all data is immediately flushed and no caching happens.
 
304
        """
 
305
        if self._transaction is None:
 
306
            return transactions.PassThroughTransaction()
 
307
        else:
 
308
            return self._transaction
 
309
 
 
310
    def _set_transaction(self, new_transaction):
 
311
        """Set a new active transaction."""
 
312
        if self._transaction is not None:
 
313
            raise errors.LockError('Branch %s is in a transaction already.' %
 
314
                                   self)
 
315
        self._transaction = new_transaction
 
316
 
 
317
    def _finish_transaction(self):
 
318
        """Exit the current transaction."""
 
319
        if self._transaction is None:
 
320
            raise errors.LockError('Branch %s is not in a transaction' %
 
321
                                   self)
 
322
        transaction = self._transaction
 
323
        self._transaction = None
 
324
        transaction.finish()
 
325
 
 
326
 
 
327
class TransportLock(object):
 
328
    """Locking method which uses transport-dependent locks.
 
329
 
 
330
    On the local filesystem these transform into OS-managed locks.
 
331
 
 
332
    These do not guard against concurrent access via different
 
333
    transports.
 
334
 
 
335
    This is suitable for use only in WorkingTrees (which are at present
 
336
    always local).
 
337
    """
 
338
    def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
 
339
        self._transport = transport
 
340
        self._escaped_name = escaped_name
 
341
        self._file_modebits = file_modebits
 
342
        self._dir_modebits = dir_modebits
 
343
 
 
344
    def break_lock(self):
 
345
        raise NotImplementedError(self.break_lock)
 
346
 
 
347
    def leave_in_place(self):
 
348
        raise NotImplementedError(self.leave_in_place)
 
349
 
 
350
    def lock_write(self, token=None):
 
351
        if token is not None:
 
352
            raise errors.TokenLockingNotSupported(self)
 
353
        self._lock = self._transport.lock_write(self._escaped_name)
 
354
 
 
355
    def lock_read(self):
 
356
        self._lock = self._transport.lock_read(self._escaped_name)
 
357
 
 
358
    def unlock(self):
 
359
        self._lock.unlock()
 
360
        self._lock = None
 
361
 
 
362
    def peek(self):
 
363
        raise NotImplementedError()
 
364
 
 
365
    def create(self, mode=None):
 
366
        """Create lock mechanism"""
 
367
        # for old-style locks, create the file now
 
368
        self._transport.put_bytes(self._escaped_name, '',
 
369
                            mode=self._file_modebits)
 
370
 
 
371
    def validate_token(self, token):
 
372
        if token is not None:
 
373
            raise errors.TokenLockingNotSupported(self)
 
374