← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
1
 
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
from cStringIO import StringIO
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
16
 
19
17
from bzrlib.lazy_import import lazy_import
20
18
lazy_import(globals(), """
21
 
import codecs
22
19
import warnings
23
20
 
24
21
from bzrlib import (
 
22
    counted_lock,
25
23
    errors,
 
24
    lock,
26
25
    osutils,
27
26
    transactions,
28
27
    urlutils,
30
29
""")
31
30
 
32
31
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.
 
32
    only_raises,
 
33
    )
 
34
 
45
35
 
46
36
class LockableFiles(object):
47
37
    """Object representing a set of related files locked within the same scope.
48
38
 
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.
 
39
    This coordinates access to the lock along with providing a transaction.
54
40
 
55
41
    LockableFiles manage a lock count and can be locked repeatedly by
56
42
    a single caller.  (The underlying lock implementation generally does not
57
43
    support this.)
58
44
 
59
45
    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
46
 
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 
 
47
    This class is now deprecated; code should move to using the Transport
 
48
    directly for file operations and using the lock or CountedLock for
70
49
    locking.
 
50
 
 
51
    :ivar _lock: The real underlying lock (e.g. a LockDir)
 
52
    :ivar _lock_count: If _lock_mode is true, a positive count of the number
 
53
        of times the lock has been taken (and not yet released) *by this
 
54
        process*, through this particular object instance.
 
55
    :ivar _lock_mode: None, or 'r' or 'w'
71
56
    """
72
57
 
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
58
    def __init__(self, transport, lock_name, lock_class):
79
59
        """Create a LockableFiles group
80
60
 
81
 
        :param transport: Transport pointing to the directory holding the 
 
61
        :param transport: Transport pointing to the directory holding the
82
62
            control files and lock.
83
63
        :param lock_name: Name of the lock guarding these files.
84
64
        :param lock_class: Class of lock strategy to use: typically
94
74
        self._lock = lock_class(transport, esc_name,
95
75
                                file_modebits=self._file_mode,
96
76
                                dir_modebits=self._dir_mode)
 
77
        self._counted_lock = counted_lock.CountedLock(self._lock)
97
78
 
98
79
    def create_lock(self):
99
80
        """Create the lock.
106
87
    def __repr__(self):
107
88
        return '%s(%r)' % (self.__class__.__name__,
108
89
                           self._transport)
 
90
 
109
91
    def __str__(self):
110
92
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
111
93
 
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
94
    def break_lock(self):
119
95
        """Break the lock of this lockable files group if it is held.
120
96
 
132
108
 
133
109
    def _find_modes(self):
134
110
        """Determine the appropriate modes for files and directories.
135
 
        
136
 
        :deprecated: Replaced by BzrDir._find_modes.
 
111
 
 
112
        :deprecated: Replaced by BzrDir._find_creation_modes.
137
113
        """
 
114
        # XXX: The properties created by this can be removed or deprecated
 
115
        # once all the _get_text_store methods etc no longer use them.
 
116
        # -- mbp 20080512
138
117
        try:
139
118
            st = self._transport.stat('.')
140
119
        except errors.TransportNotPossible:
149
128
            # Remove the sticky and execute bits for files
150
129
            self._file_mode = self._dir_mode & ~07111
151
130
 
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
131
    def leave_in_place(self):
228
132
        """Set this LockableFiles to not clear the physical lock on unlock."""
229
133
        self._lock.leave_in_place()
234
138
 
235
139
    def lock_write(self, token=None):
236
140
        """Lock this group of files for writing.
237
 
        
 
141
 
238
142
        :param token: if this is already locked, then lock_write will fail
239
143
            unless the token matches the existing lock.
240
144
        :returns: a token if this instance supports tokens, otherwise None.
247
151
        some other way, and need to synchronise this object's state with that
248
152
        fact.
249
153
        """
250
 
        # TODO: Upgrade locking to support using a Transport,
251
 
        # and potentially a remote locking protocol
252
154
        if self._lock_mode:
253
 
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
 
155
            if (self._lock_mode != 'w'
 
156
                or not self.get_transaction().writeable()):
254
157
                raise errors.ReadOnlyError(self)
255
158
            self._lock.validate_token(token)
256
159
            self._lock_count += 1
260
163
            #traceback.print_stack()
261
164
            self._lock_mode = 'w'
262
165
            self._lock_count = 1
263
 
            self._set_transaction(transactions.WriteTransaction())
 
166
            self._set_write_transaction()
264
167
            self._token_from_lock = token_from_lock
265
168
            return token_from_lock
266
169
 
274
177
            #traceback.print_stack()
275
178
            self._lock_mode = 'r'
276
179
            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
 
                        
 
180
            self._set_read_transaction()
 
181
 
 
182
    def _set_read_transaction(self):
 
183
        """Setup a read transaction."""
 
184
        self._set_transaction(transactions.ReadOnlyTransaction())
 
185
        # 5K may be excessive, but hey, its a knob.
 
186
        self.get_transaction().set_cache_size(5000)
 
187
 
 
188
    def _set_write_transaction(self):
 
189
        """Setup a write transaction."""
 
190
        self._set_transaction(transactions.WriteTransaction())
 
191
 
 
192
    @only_raises(errors.LockNotHeld, errors.LockBroken)
281
193
    def unlock(self):
282
194
        if not self._lock_mode:
283
 
            raise errors.LockNotHeld(self)
 
195
            return lock.cant_unlock_not_held(self)
284
196
        if self._lock_count > 1:
285
197
            self._lock_count -= 1
286
198
        else:
297
209
 
298
210
    def get_physical_lock_status(self):
299
211
        """Return physical lock status.
300
 
        
 
212
 
301
213
        Returns true if a lock is held on the transport. If no lock is held, or
302
214
        the underlying locking mechanism does not support querying lock
303
215
        status, false is returned.
385
297
    def validate_token(self, token):
386
298
        if token is not None:
387
299
            raise errors.TokenLockingNotSupported(self)
388