← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from cStringIO import StringIO
 
17
from __future__ import absolute_import
18
18
 
19
19
from bzrlib.lazy_import import lazy_import
20
20
lazy_import(globals(), """
21
 
import codecs
22
21
import warnings
23
22
 
24
23
from bzrlib import (
 
24
    counted_lock,
25
25
    errors,
 
26
    lock,
26
27
    osutils,
27
28
    transactions,
28
29
    urlutils,
30
31
""")
31
32
 
32
33
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.
 
34
    only_raises,
 
35
    )
 
36
 
45
37
 
46
38
class LockableFiles(object):
47
39
    """Object representing a set of related files locked within the same scope.
48
40
 
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.
 
41
    This coordinates access to the lock along with providing a transaction.
54
42
 
55
43
    LockableFiles manage a lock count and can be locked repeatedly by
56
44
    a single caller.  (The underlying lock implementation generally does not
57
45
    support this.)
58
46
 
59
47
    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
48
 
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 
 
49
    This class is now deprecated; code should move to using the Transport
 
50
    directly for file operations and using the lock or CountedLock for
70
51
    locking.
 
52
 
 
53
    :ivar _lock: The real underlying lock (e.g. a LockDir)
 
54
    :ivar _lock_count: If _lock_mode is true, a positive count of the number
 
55
        of times the lock has been taken (and not yet released) *by this
 
56
        process*, through this particular object instance.
 
57
    :ivar _lock_mode: None, or 'r' or 'w'
71
58
    """
72
59
 
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
60
    def __init__(self, transport, lock_name, lock_class):
79
61
        """Create a LockableFiles group
80
62
 
81
 
        :param transport: Transport pointing to the directory holding the 
 
63
        :param transport: Transport pointing to the directory holding the
82
64
            control files and lock.
83
65
        :param lock_name: Name of the lock guarding these files.
84
66
        :param lock_class: Class of lock strategy to use: typically
94
76
        self._lock = lock_class(transport, esc_name,
95
77
                                file_modebits=self._file_mode,
96
78
                                dir_modebits=self._dir_mode)
 
79
        self._counted_lock = counted_lock.CountedLock(self._lock)
97
80
 
98
81
    def create_lock(self):
99
82
        """Create the lock.
106
89
    def __repr__(self):
107
90
        return '%s(%r)' % (self.__class__.__name__,
108
91
                           self._transport)
 
92
 
109
93
    def __str__(self):
110
94
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
111
95
 
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
96
    def break_lock(self):
119
97
        """Break the lock of this lockable files group if it is held.
120
98
 
123
101
        self._lock.break_lock()
124
102
 
125
103
    def _escape(self, file_or_path):
 
104
        """DEPRECATED: Do not use outside this class"""
126
105
        if not isinstance(file_or_path, basestring):
127
106
            file_or_path = '/'.join(file_or_path)
128
107
        if file_or_path == '':
131
110
 
132
111
    def _find_modes(self):
133
112
        """Determine the appropriate modes for files and directories.
134
 
        
135
 
        :deprecated: Replaced by BzrDir._find_modes.
 
113
 
 
114
        :deprecated: Replaced by BzrDir._find_creation_modes.
136
115
        """
 
116
        # XXX: The properties created by this can be removed or deprecated
 
117
        # once all the _get_text_store methods etc no longer use them.
 
118
        # -- mbp 20080512
137
119
        try:
138
120
            st = self._transport.stat('.')
139
121
        except errors.TransportNotPossible:
148
130
            # Remove the sticky and execute bits for files
149
131
            self._file_mode = self._dir_mode & ~07111
150
132
 
151
 
    @deprecated_method(deprecated_in((1, 6, 0)))
152
 
    def controlfilename(self, file_or_path):
153
 
        """Return location relative to branch.
154
 
        
155
 
        :deprecated: Use Transport methods instead.
156
 
        """
157
 
        return self._transport.abspath(self._escape(file_or_path))
158
 
 
159
 
    @needs_read_lock
160
 
    @deprecated_method(deprecated_in((1, 5, 0)))
161
 
    def get(self, relpath):
162
 
        """Get a file as a bytestream.
163
 
        
164
 
        :deprecated: Use a Transport instead of LockableFiles.
165
 
        """
166
 
        relpath = self._escape(relpath)
167
 
        return self._transport.get(relpath)
168
 
 
169
 
    @needs_read_lock
170
 
    @deprecated_method(deprecated_in((1, 5, 0)))
171
 
    def get_utf8(self, relpath):
172
 
        """Get a file as a unicode stream.
173
 
        
174
 
        :deprecated: Use a Transport instead of LockableFiles.
175
 
        """
176
 
        relpath = self._escape(relpath)
177
 
        # DO NOT introduce an errors=replace here.
178
 
        return codecs.getreader('utf-8')(self._transport.get(relpath))
179
 
 
180
 
    @needs_write_lock
181
 
    @deprecated_method(deprecated_in((1, 6, 0)))
182
 
    def put(self, path, file):
183
 
        """Write a file.
184
 
        
185
 
        :param path: The path to put the file, relative to the .bzr control
186
 
                     directory
187
 
        :param file: A file-like or string object whose contents should be copied.
188
 
 
189
 
        :deprecated: Use Transport methods instead.
190
 
        """
191
 
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
192
 
 
193
 
    @needs_write_lock
194
 
    @deprecated_method(deprecated_in((1, 6, 0)))
195
 
    def put_bytes(self, path, a_string):
196
 
        """Write a string of bytes.
197
 
 
198
 
        :param path: The path to put the bytes, relative to the transport root.
199
 
        :param a_string: A string object, whose exact bytes are to be copied.
200
 
 
201
 
        :deprecated: Use Transport methods instead.
202
 
        """
203
 
        self._transport.put_bytes(self._escape(path), a_string,
204
 
                                  mode=self._file_mode)
205
 
 
206
 
    @needs_write_lock
207
 
    @deprecated_method(deprecated_in((1, 6, 0)))
208
 
    def put_utf8(self, path, a_string):
209
 
        """Write a string, encoding as utf-8.
210
 
 
211
 
        :param path: The path to put the string, relative to the transport root.
212
 
        :param string: A string or unicode object whose contents should be copied.
213
 
 
214
 
        :deprecated: Use Transport methods instead.
215
 
        """
216
 
        # IterableFile would not be needed if Transport.put took iterables
217
 
        # instead of files.  ADHB 2005-12-25
218
 
        # RBC 20060103 surely its not needed anyway, with codecs transcode
219
 
        # file support ?
220
 
        # JAM 20060103 We definitely don't want encode(..., 'replace')
221
 
        # these are valuable files which should have exact contents.
222
 
        if not isinstance(a_string, basestring):
223
 
            raise errors.BzrBadParameterNotString(a_string)
224
 
        self.put_bytes(path, a_string.encode('utf-8'))
225
 
 
226
133
    def leave_in_place(self):
227
134
        """Set this LockableFiles to not clear the physical lock on unlock."""
228
135
        self._lock.leave_in_place()
233
140
 
234
141
    def lock_write(self, token=None):
235
142
        """Lock this group of files for writing.
236
 
        
 
143
 
237
144
        :param token: if this is already locked, then lock_write will fail
238
145
            unless the token matches the existing lock.
239
146
        :returns: a token if this instance supports tokens, otherwise None.
246
153
        some other way, and need to synchronise this object's state with that
247
154
        fact.
248
155
        """
249
 
        # TODO: Upgrade locking to support using a Transport,
250
 
        # and potentially a remote locking protocol
251
156
        if self._lock_mode:
252
 
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
 
157
            if (self._lock_mode != 'w'
 
158
                or not self.get_transaction().writeable()):
253
159
                raise errors.ReadOnlyError(self)
254
160
            self._lock.validate_token(token)
255
161
            self._lock_count += 1
259
165
            #traceback.print_stack()
260
166
            self._lock_mode = 'w'
261
167
            self._lock_count = 1
262
 
            self._set_transaction(transactions.WriteTransaction())
 
168
            self._set_write_transaction()
263
169
            self._token_from_lock = token_from_lock
264
170
            return token_from_lock
265
171
 
273
179
            #traceback.print_stack()
274
180
            self._lock_mode = 'r'
275
181
            self._lock_count = 1
276
 
            self._set_transaction(transactions.ReadOnlyTransaction())
277
 
            # 5K may be excessive, but hey, its a knob.
278
 
            self.get_transaction().set_cache_size(5000)
279
 
                        
 
182
            self._set_read_transaction()
 
183
 
 
184
    def _set_read_transaction(self):
 
185
        """Setup a read transaction."""
 
186
        self._set_transaction(transactions.ReadOnlyTransaction())
 
187
        # 5K may be excessive, but hey, its a knob.
 
188
        self.get_transaction().set_cache_size(5000)
 
189
 
 
190
    def _set_write_transaction(self):
 
191
        """Setup a write transaction."""
 
192
        self._set_transaction(transactions.WriteTransaction())
 
193
 
 
194
    @only_raises(errors.LockNotHeld, errors.LockBroken)
280
195
    def unlock(self):
281
196
        if not self._lock_mode:
282
 
            raise errors.LockNotHeld(self)
 
197
            return lock.cant_unlock_not_held(self)
283
198
        if self._lock_count > 1:
284
199
            self._lock_count -= 1
285
200
        else:
296
211
 
297
212
    def get_physical_lock_status(self):
298
213
        """Return physical lock status.
299
 
        
 
214
 
300
215
        Returns true if a lock is held on the transport. If no lock is held, or
301
216
        the underlying locking mechanism does not support querying lock
302
217
        status, false is returned.
384
299
    def validate_token(self, token):
385
300
        if token is not None:
386
301
            raise errors.TokenLockingNotSupported(self)
387