← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-03-16 16:58:03 UTC
  • mfrom: (3224.3.1 news-typo)
  • Revision ID: pqm@pqm.ubuntu.com-20080316165803-tisoc9mpob9z544o
(Matt Nordhoff) Trivial NEWS typo fix

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
from bzrlib.lazy_import import lazy_import
18
 
lazy_import(globals(), """
19
 
import warnings
20
 
 
21
 
from bzrlib import (
22
 
    counted_lock,
23
 
    errors,
24
 
    lock,
25
 
    osutils,
26
 
    transactions,
27
 
    urlutils,
28
 
    )
29
 
""")
30
 
 
31
 
from bzrlib.decorators import (
32
 
    only_raises,
33
 
    )
34
 
 
 
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.
35
37
 
36
38
class LockableFiles(object):
37
39
    """Object representing a set of related files locked within the same scope.
38
40
 
39
 
    This coordinates access to the lock along with providing a transaction.
 
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.
40
46
 
41
47
    LockableFiles manage a lock count and can be locked repeatedly by
42
48
    a single caller.  (The underlying lock implementation generally does not
43
49
    support this.)
44
50
 
45
51
    Instances of this class are often called control_files.
46
 
 
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
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'
 
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.
56
59
    """
57
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
 
58
71
    def __init__(self, transport, lock_name, lock_class):
59
72
        """Create a LockableFiles group
60
73
 
61
 
        :param transport: Transport pointing to the directory holding the
 
74
        :param transport: Transport pointing to the directory holding the 
62
75
            control files and lock.
63
76
        :param lock_name: Name of the lock guarding these files.
64
77
        :param lock_class: Class of lock strategy to use: typically
74
87
        self._lock = lock_class(transport, esc_name,
75
88
                                file_modebits=self._file_mode,
76
89
                                dir_modebits=self._dir_mode)
77
 
        self._counted_lock = counted_lock.CountedLock(self._lock)
78
90
 
79
91
    def create_lock(self):
80
92
        """Create the lock.
87
99
    def __repr__(self):
88
100
        return '%s(%r)' % (self.__class__.__name__,
89
101
                           self._transport)
90
 
 
91
102
    def __str__(self):
92
103
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
93
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
 
94
113
    def break_lock(self):
95
114
        """Break the lock of this lockable files group if it is held.
96
115
 
99
118
        self._lock.break_lock()
100
119
 
101
120
    def _escape(self, file_or_path):
102
 
        """DEPRECATED: Do not use outside this class"""
103
121
        if not isinstance(file_or_path, basestring):
104
122
            file_or_path = '/'.join(file_or_path)
105
123
        if file_or_path == '':
106
124
            return u''
107
 
        return urlutils.escape(osutils.safe_unicode(file_or_path))
 
125
        return urlutils.escape(safe_unicode(file_or_path))
108
126
 
109
127
    def _find_modes(self):
110
 
        """Determine the appropriate modes for files and directories.
111
 
 
112
 
        :deprecated: Replaced by BzrDir._find_creation_modes.
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
 
128
        """Determine the appropriate modes for files and directories."""
117
129
        try:
118
130
            st = self._transport.stat('.')
119
131
        except errors.TransportNotPossible:
127
139
            self._dir_mode = (st.st_mode & 07777) | 00700
128
140
            # Remove the sticky and execute bits for files
129
141
            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'))
130
200
 
131
201
    def leave_in_place(self):
132
202
        """Set this LockableFiles to not clear the physical lock on unlock."""
138
208
 
139
209
    def lock_write(self, token=None):
140
210
        """Lock this group of files for writing.
141
 
 
 
211
        
142
212
        :param token: if this is already locked, then lock_write will fail
143
213
            unless the token matches the existing lock.
144
214
        :returns: a token if this instance supports tokens, otherwise None.
151
221
        some other way, and need to synchronise this object's state with that
152
222
        fact.
153
223
        """
 
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
154
227
        if self._lock_mode:
155
 
            if (self._lock_mode != 'w'
156
 
                or not self.get_transaction().writeable()):
 
228
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
157
229
                raise errors.ReadOnlyError(self)
158
230
            self._lock.validate_token(token)
159
231
            self._lock_count += 1
160
232
            return self._token_from_lock
161
233
        else:
162
234
            token_from_lock = self._lock.lock_write(token=token)
 
235
            #note('write locking %s', self)
163
236
            #traceback.print_stack()
164
237
            self._lock_mode = 'w'
165
238
            self._lock_count = 1
166
 
            self._set_write_transaction()
 
239
            self._set_transaction(transactions.WriteTransaction())
167
240
            self._token_from_lock = token_from_lock
168
241
            return token_from_lock
169
242
 
170
243
    def lock_read(self):
 
244
        # mutter("lock read: %s (%s)", self, self._lock_count)
171
245
        if self._lock_mode:
172
 
            if self._lock_mode not in ('r', 'w'):
173
 
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
 
246
            assert self._lock_mode in ('r', 'w'), \
 
247
                   "invalid lock mode %r" % self._lock_mode
174
248
            self._lock_count += 1
175
249
        else:
176
250
            self._lock.lock_read()
 
251
            #note('read locking %s', self)
177
252
            #traceback.print_stack()
178
253
            self._lock_mode = 'r'
179
254
            self._lock_count = 1
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)
 
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
                        
193
259
    def unlock(self):
 
260
        # mutter("unlock: %s (%s)", self, self._lock_count)
194
261
        if not self._lock_mode:
195
 
            return lock.cant_unlock_not_held(self)
 
262
            raise errors.LockNotHeld(self)
196
263
        if self._lock_count > 1:
197
264
            self._lock_count -= 1
198
265
        else:
 
266
            #note('unlocking %s', self)
199
267
            #traceback.print_stack()
200
268
            self._finish_transaction()
201
269
            try:
209
277
 
210
278
    def get_physical_lock_status(self):
211
279
        """Return physical lock status.
212
 
 
 
280
        
213
281
        Returns true if a lock is held on the transport. If no lock is held, or
214
282
        the underlying locking mechanism does not support querying lock
215
283
        status, false is returned.
297
365
    def validate_token(self, token):
298
366
        if token is not None:
299
367
            raise errors.TokenLockingNotSupported(self)
 
368