/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

  • Committer: Andrew Bennetts
  • Date: 2007-03-28 07:08:42 UTC
  • mfrom: (2380 +trunk)
  • mto: (2018.5.146 hpss)
  • mto: This revision was merged to the branch mainline in revision 2414.
  • Revision ID: andrew.bennetts@canonical.com-20070328070842-r843houy668oxb9o
Merge from bzr.dev.

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_bytes(self, path, a_string):
 
200
        """Write a string of bytes.
 
201
 
 
202
        :param path: The path to put the bytes, relative to the transport root.
 
203
        :param string: A string object, whose exact bytes are to be copied.
 
204
        """
 
205
        self._transport.put_bytes(self._escape(path), a_string,
 
206
                                  mode=self._file_mode)
 
207
 
 
208
    @needs_write_lock
 
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
        # IterableFile would not be needed if Transport.put took iterables
 
216
        # instead of files.  ADHB 2005-12-25
 
217
        # RBC 20060103 surely its not needed anyway, with codecs transcode
 
218
        # file support ?
 
219
        # JAM 20060103 We definitely don't want encode(..., 'replace')
 
220
        # these are valuable files which should have exact contents.
 
221
        if not isinstance(a_string, basestring):
 
222
            raise errors.BzrBadParameterNotString(a_string)
 
223
        self.put_bytes(path, a_string.encode('utf-8'))
 
224
 
 
225
    def lock_write(self, token=None):
 
226
        """Lock this group of files for writing.
 
227
        
 
228
        :param token: if this is already locked, then lock_write will fail
 
229
            unless the token matches the existing lock.
 
230
        :returns: a token if this instance supports tokens, otherwise None.
 
231
        :raises TokenLockingNotSupported: when a token is given but this
 
232
            instance doesn't support using token locks.
 
233
        :raises MismatchedToken: if the specified token doesn't match the token
 
234
            of the existing lock.
 
235
        """
 
236
        # mutter("lock write: %s (%s)", self, self._lock_count)
 
237
        # TODO: Upgrade locking to support using a Transport,
 
238
        # and potentially a remote locking protocol
 
239
        if self._lock_mode:
 
240
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
 
241
                raise errors.ReadOnlyError(self)
 
242
            self._lock.validate_token(token)
 
243
            self._lock_count += 1
 
244
        else:
 
245
            token_from_lock = self._lock.lock_write(token=token)
 
246
            #note('write locking %s', self)
 
247
            #traceback.print_stack()
 
248
            self._lock_mode = 'w'
 
249
            self._lock_count = 1
 
250
            self._set_transaction(transactions.WriteTransaction())
 
251
            return token_from_lock
 
252
 
 
253
    def lock_read(self):
 
254
        # mutter("lock read: %s (%s)", self, self._lock_count)
 
255
        if self._lock_mode:
 
256
            assert self._lock_mode in ('r', 'w'), \
 
257
                   "invalid lock mode %r" % self._lock_mode
 
258
            self._lock_count += 1
 
259
        else:
 
260
            self._lock.lock_read()
 
261
            #note('read locking %s', self)
 
262
            #traceback.print_stack()
 
263
            self._lock_mode = 'r'
 
264
            self._lock_count = 1
 
265
            self._set_transaction(transactions.ReadOnlyTransaction())
 
266
            # 5K may be excessive, but hey, its a knob.
 
267
            self.get_transaction().set_cache_size(5000)
 
268
                        
 
269
    def unlock(self):
 
270
        # mutter("unlock: %s (%s)", self, self._lock_count)
 
271
        if not self._lock_mode:
 
272
            raise errors.LockNotHeld(self)
 
273
        if self._lock_count > 1:
 
274
            self._lock_count -= 1
 
275
        else:
 
276
            #note('unlocking %s', self)
 
277
            #traceback.print_stack()
 
278
            self._finish_transaction()
 
279
            try:
 
280
                self._lock.unlock()
 
281
            finally:
 
282
                self._lock_mode = self._lock_count = None
 
283
 
 
284
    def is_locked(self):
 
285
        """Return true if this LockableFiles group is locked"""
 
286
        return self._lock_count >= 1
 
287
 
 
288
    def get_physical_lock_status(self):
 
289
        """Return physical lock status.
 
290
        
 
291
        Returns true if a lock is held on the transport. If no lock is held, or
 
292
        the underlying locking mechanism does not support querying lock
 
293
        status, false is returned.
 
294
        """
 
295
        try:
 
296
            return self._lock.peek() is not None
 
297
        except NotImplementedError:
 
298
            return False
 
299
 
 
300
    def get_transaction(self):
 
301
        """Return the current active transaction.
 
302
 
 
303
        If no transaction is active, this returns a passthrough object
 
304
        for which all data is immediately flushed and no caching happens.
 
305
        """
 
306
        if self._transaction is None:
 
307
            return transactions.PassThroughTransaction()
 
308
        else:
 
309
            return self._transaction
 
310
 
 
311
    def _set_transaction(self, new_transaction):
 
312
        """Set a new active transaction."""
 
313
        if self._transaction is not None:
 
314
            raise errors.LockError('Branch %s is in a transaction already.' %
 
315
                                   self)
 
316
        self._transaction = new_transaction
 
317
 
 
318
    def _finish_transaction(self):
 
319
        """Exit the current transaction."""
 
320
        if self._transaction is None:
 
321
            raise errors.LockError('Branch %s is not in a transaction' %
 
322
                                   self)
 
323
        transaction = self._transaction
 
324
        self._transaction = None
 
325
        transaction.finish()
 
326
 
 
327
 
 
328
class TransportLock(object):
 
329
    """Locking method which uses transport-dependent locks.
 
330
 
 
331
    On the local filesystem these transform into OS-managed locks.
 
332
 
 
333
    These do not guard against concurrent access via different
 
334
    transports.
 
335
 
 
336
    This is suitable for use only in WorkingTrees (which are at present
 
337
    always local).
 
338
    """
 
339
    def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
 
340
        self._transport = transport
 
341
        self._escaped_name = escaped_name
 
342
        self._file_modebits = file_modebits
 
343
        self._dir_modebits = dir_modebits
 
344
 
 
345
    def break_lock(self):
 
346
        raise NotImplementedError(self.break_lock)
 
347
 
 
348
    def lock_write(self, token=None):
 
349
        if token is not None:
 
350
            raise errors.TokenLockingNotSupported(self)
 
351
        self._lock = self._transport.lock_write(self._escaped_name)
 
352
 
 
353
    def lock_read(self):
 
354
        self._lock = self._transport.lock_read(self._escaped_name)
 
355
 
 
356
    def unlock(self):
 
357
        self._lock.unlock()
 
358
        self._lock = None
 
359
 
 
360
    def peek(self):
 
361
        raise NotImplementedError()
 
362
 
 
363
    def create(self, mode=None):
 
364
        """Create lock mechanism"""
 
365
        # for old-style locks, create the file now
 
366
        self._transport.put_bytes(self._escaped_name, '',
 
367
                            mode=self._file_modebits)
 
368
 
 
369
    def validate_token(self, token):
 
370
        if token is not None:
 
371
            raise errors.TokenLockingNotSupported(self)
 
372