← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
1
 
# Copyright (C) 2005, 2006 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
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
 
        )
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.
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
from bzrlib.lazy_import import lazy_import
 
20
lazy_import(globals(), """
 
21
import warnings
 
22
 
 
23
from bzrlib import (
 
24
    counted_lock,
 
25
    errors,
 
26
    lock,
 
27
    osutils,
 
28
    transactions,
 
29
    urlutils,
 
30
    )
 
31
""")
 
32
 
 
33
from bzrlib.decorators import (
 
34
    only_raises,
 
35
    )
 
36
 
37
37
 
38
38
class LockableFiles(object):
39
39
    """Object representing a set of related files locked within the same scope.
40
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.
 
41
    This coordinates access to the lock along with providing a transaction.
46
42
 
47
43
    LockableFiles manage a lock count and can be locked repeatedly by
48
44
    a single caller.  (The underlying lock implementation generally does not
49
45
    support this.)
50
46
 
51
47
    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.
 
48
 
 
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
 
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'
59
58
    """
60
59
 
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
60
    def __init__(self, transport, lock_name, lock_class):
72
61
        """Create a LockableFiles group
73
62
 
74
 
        :param transport: Transport pointing to the directory holding the 
 
63
        :param transport: Transport pointing to the directory holding the
75
64
            control files and lock.
76
65
        :param lock_name: Name of the lock guarding these files.
77
66
        :param lock_class: Class of lock strategy to use: typically
87
76
        self._lock = lock_class(transport, esc_name,
88
77
                                file_modebits=self._file_mode,
89
78
                                dir_modebits=self._dir_mode)
 
79
        self._counted_lock = counted_lock.CountedLock(self._lock)
90
80
 
91
81
    def create_lock(self):
92
82
        """Create the lock.
99
89
    def __repr__(self):
100
90
        return '%s(%r)' % (self.__class__.__name__,
101
91
                           self._transport)
 
92
 
102
93
    def __str__(self):
103
94
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
104
95
 
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
96
    def break_lock(self):
114
97
        """Break the lock of this lockable files group if it is held.
115
98
 
118
101
        self._lock.break_lock()
119
102
 
120
103
    def _escape(self, file_or_path):
 
104
        """DEPRECATED: Do not use outside this class"""
121
105
        if not isinstance(file_or_path, basestring):
122
106
            file_or_path = '/'.join(file_or_path)
123
107
        if file_or_path == '':
124
108
            return u''
125
 
        return urlutils.escape(safe_unicode(file_or_path))
 
109
        return urlutils.escape(osutils.safe_unicode(file_or_path))
126
110
 
127
111
    def _find_modes(self):
128
 
        """Determine the appropriate modes for files and directories."""
 
112
        """Determine the appropriate modes for files and directories.
 
113
 
 
114
        :deprecated: Replaced by BzrDir._find_creation_modes.
 
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
129
119
        try:
130
120
            st = self._transport.stat('.')
131
121
        except errors.TransportNotPossible:
139
129
            self._dir_mode = (st.st_mode & 07777) | 00700
140
130
            # Remove the sticky and execute bits for files
141
131
            self._file_mode = self._dir_mode & ~07111
142
 
        if not self._set_dir_mode:
143
 
            self._dir_mode = None
144
 
        if not self._set_file_mode:
145
 
            self._file_mode = None
146
 
 
147
 
    def controlfilename(self, file_or_path):
148
 
        """Return location relative to branch."""
149
 
        return self._transport.abspath(self._escape(file_or_path))
150
 
 
151
 
    @needs_read_lock
152
 
    def get(self, relpath):
153
 
        """Get a file as a bytestream."""
154
 
        relpath = self._escape(relpath)
155
 
        return self._transport.get(relpath)
156
 
 
157
 
    @needs_read_lock
158
 
    def get_utf8(self, relpath):
159
 
        """Get a file as a unicode stream."""
160
 
        relpath = self._escape(relpath)
161
 
        # DO NOT introduce an errors=replace here.
162
 
        return codecs.getreader('utf-8')(self._transport.get(relpath))
163
 
 
164
 
    @needs_write_lock
165
 
    def put(self, path, file):
166
 
        """Write a file.
167
 
        
168
 
        :param path: The path to put the file, relative to the .bzr control
169
 
                     directory
170
 
        :param f: A file-like or string object whose contents should be copied.
171
 
        """
172
 
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
173
 
 
174
 
    @needs_write_lock
175
 
    def put_bytes(self, path, a_string):
176
 
        """Write a string of bytes.
177
 
 
178
 
        :param path: The path to put the bytes, relative to the transport root.
179
 
        :param string: A string object, whose exact bytes are to be copied.
180
 
        """
181
 
        self._transport.put_bytes(self._escape(path), a_string,
182
 
                                  mode=self._file_mode)
183
 
 
184
 
    @needs_write_lock
185
 
    def put_utf8(self, path, a_string):
186
 
        """Write a string, encoding as utf-8.
187
 
 
188
 
        :param path: The path to put the string, relative to the transport root.
189
 
        :param string: A string or unicode object whose contents should be copied.
190
 
        """
191
 
        # IterableFile would not be needed if Transport.put took iterables
192
 
        # instead of files.  ADHB 2005-12-25
193
 
        # RBC 20060103 surely its not needed anyway, with codecs transcode
194
 
        # file support ?
195
 
        # JAM 20060103 We definitely don't want encode(..., 'replace')
196
 
        # these are valuable files which should have exact contents.
197
 
        if not isinstance(a_string, basestring):
198
 
            raise errors.BzrBadParameterNotString(a_string)
199
 
        self.put_bytes(path, a_string.encode('utf-8'))
200
132
 
201
133
    def leave_in_place(self):
202
134
        """Set this LockableFiles to not clear the physical lock on unlock."""
208
140
 
209
141
    def lock_write(self, token=None):
210
142
        """Lock this group of files for writing.
211
 
        
 
143
 
212
144
        :param token: if this is already locked, then lock_write will fail
213
145
            unless the token matches the existing lock.
214
146
        :returns: a token if this instance supports tokens, otherwise None.
221
153
        some other way, and need to synchronise this object's state with that
222
154
        fact.
223
155
        """
224
 
        # mutter("lock write: %s (%s)", self, self._lock_count)
225
 
        # TODO: Upgrade locking to support using a Transport,
226
 
        # and potentially a remote locking protocol
227
156
        if self._lock_mode:
228
 
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
 
157
            if (self._lock_mode != 'w'
 
158
                or not self.get_transaction().writeable()):
229
159
                raise errors.ReadOnlyError(self)
230
160
            self._lock.validate_token(token)
231
161
            self._lock_count += 1
232
162
            return self._token_from_lock
233
163
        else:
234
164
            token_from_lock = self._lock.lock_write(token=token)
235
 
            #note('write locking %s', self)
236
165
            #traceback.print_stack()
237
166
            self._lock_mode = 'w'
238
167
            self._lock_count = 1
239
 
            self._set_transaction(transactions.WriteTransaction())
 
168
            self._set_write_transaction()
240
169
            self._token_from_lock = token_from_lock
241
170
            return token_from_lock
242
171
 
243
172
    def lock_read(self):
244
 
        # mutter("lock read: %s (%s)", self, self._lock_count)
245
173
        if self._lock_mode:
246
 
            assert self._lock_mode in ('r', 'w'), \
247
 
                   "invalid lock mode %r" % self._lock_mode
 
174
            if self._lock_mode not in ('r', 'w'):
 
175
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
248
176
            self._lock_count += 1
249
177
        else:
250
178
            self._lock.lock_read()
251
 
            #note('read locking %s', self)
252
179
            #traceback.print_stack()
253
180
            self._lock_mode = 'r'
254
181
            self._lock_count = 1
255
 
            self._set_transaction(transactions.ReadOnlyTransaction())
256
 
            # 5K may be excessive, but hey, its a knob.
257
 
            self.get_transaction().set_cache_size(5000)
258
 
                        
 
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)
259
195
    def unlock(self):
260
 
        # mutter("unlock: %s (%s)", self, self._lock_count)
261
196
        if not self._lock_mode:
262
 
            raise errors.LockNotHeld(self)
 
197
            return lock.cant_unlock_not_held(self)
263
198
        if self._lock_count > 1:
264
199
            self._lock_count -= 1
265
200
        else:
266
 
            #note('unlocking %s', self)
267
201
            #traceback.print_stack()
268
202
            self._finish_transaction()
269
203
            try:
277
211
 
278
212
    def get_physical_lock_status(self):
279
213
        """Return physical lock status.
280
 
        
 
214
 
281
215
        Returns true if a lock is held on the transport. If no lock is held, or
282
216
        the underlying locking mechanism does not support querying lock
283
217
        status, false is returned.
365
299
    def validate_token(self, token):
366
300
        if token is not None:
367
301
            raise errors.TokenLockingNotSupported(self)
368