← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Martin Pool
  • Date: 2008-05-08 04:18:41 UTC
  • mto: This revision was merged to the branch mainline in revision 3415.
  • Revision ID: mbp@sourcefrog.net-20080508041841-6cv1owy6y1gukja5
Remove dead main method from test_patches

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, 2008 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 __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
 
 
 
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
from warnings import warn
 
21
 
 
22
import bzrlib
 
23
from bzrlib.decorators import (needs_read_lock,
 
24
        needs_write_lock)
 
25
import bzrlib.errors as errors
 
26
from bzrlib.errors import BzrError
 
27
from bzrlib.osutils import file_iterator, safe_unicode
 
28
from bzrlib.symbol_versioning import (deprecated_method,
 
29
        )
 
30
from bzrlib.trace import mutter, note
 
31
import bzrlib.transactions as transactions
 
32
import bzrlib.urlutils as urlutils
 
33
 
 
34
 
 
35
# XXX: The tracking here of lock counts and whether the lock is held is
 
36
# somewhat redundant with what's done in LockDir; the main difference is that
 
37
# LockableFiles permits reentrancy.
37
38
 
38
39
class LockableFiles(object):
39
40
    """Object representing a set of related files locked within the same scope.
40
41
 
41
 
    This coordinates access to the lock along with providing a transaction.
 
42
    These files are used by a WorkingTree, Repository or Branch, and should
 
43
    generally only be touched by that object.
 
44
 
 
45
    LockableFiles also provides some policy on top of Transport for encoding
 
46
    control files as utf-8.
42
47
 
43
48
    LockableFiles manage a lock count and can be locked repeatedly by
44
49
    a single caller.  (The underlying lock implementation generally does not
45
50
    support this.)
46
51
 
47
52
    Instances of this class are often called control_files.
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'
 
53
    
 
54
    This object builds on top of a Transport, which is used to actually write
 
55
    the files to disk, and an OSLock or LockDir, which controls how access to
 
56
    the files is controlled.  The particular type of locking used is set when
 
57
    the object is constructed.  In older formats OSLocks are used everywhere.
 
58
    in newer formats a LockDir is used for Repositories and Branches, and 
 
59
    OSLocks for the local filesystem.
58
60
    """
59
61
 
 
62
    # _lock_mode: None, or 'r' or 'w'
 
63
 
 
64
    # _lock_count: If _lock_mode is true, a positive count of the number of
 
65
    # times the lock has been taken *by this process*.   
 
66
    
 
67
    # If set to False (by a plugin, etc) BzrBranch will not set the
 
68
    # mode on created files or directories
 
69
    _set_file_mode = True
 
70
    _set_dir_mode = True
 
71
 
60
72
    def __init__(self, transport, lock_name, lock_class):
61
73
        """Create a LockableFiles group
62
74
 
63
 
        :param transport: Transport pointing to the directory holding the
 
75
        :param transport: Transport pointing to the directory holding the 
64
76
            control files and lock.
65
77
        :param lock_name: Name of the lock guarding these files.
66
78
        :param lock_class: Class of lock strategy to use: typically
76
88
        self._lock = lock_class(transport, esc_name,
77
89
                                file_modebits=self._file_mode,
78
90
                                dir_modebits=self._dir_mode)
79
 
        self._counted_lock = counted_lock.CountedLock(self._lock)
80
91
 
81
92
    def create_lock(self):
82
93
        """Create the lock.
89
100
    def __repr__(self):
90
101
        return '%s(%r)' % (self.__class__.__name__,
91
102
                           self._transport)
92
 
 
93
103
    def __str__(self):
94
104
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
95
105
 
 
106
    def __del__(self):
 
107
        if self.is_locked():
 
108
            # do not automatically unlock; there should have been a
 
109
            # try/finally to unlock this.
 
110
            warn("%r was gc'd while locked" % self)
 
111
 
96
112
    def break_lock(self):
97
113
        """Break the lock of this lockable files group if it is held.
98
114
 
101
117
        self._lock.break_lock()
102
118
 
103
119
    def _escape(self, file_or_path):
104
 
        """DEPRECATED: Do not use outside this class"""
105
120
        if not isinstance(file_or_path, basestring):
106
121
            file_or_path = '/'.join(file_or_path)
107
122
        if file_or_path == '':
108
123
            return u''
109
 
        return urlutils.escape(osutils.safe_unicode(file_or_path))
 
124
        return urlutils.escape(safe_unicode(file_or_path))
110
125
 
111
126
    def _find_modes(self):
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
 
127
        """Determine the appropriate modes for files and directories."""
119
128
        try:
120
129
            st = self._transport.stat('.')
121
130
        except errors.TransportNotPossible:
129
138
            self._dir_mode = (st.st_mode & 07777) | 00700
130
139
            # Remove the sticky and execute bits for files
131
140
            self._file_mode = self._dir_mode & ~07111
 
141
        if not self._set_dir_mode:
 
142
            self._dir_mode = None
 
143
        if not self._set_file_mode:
 
144
            self._file_mode = None
 
145
 
 
146
    def controlfilename(self, file_or_path):
 
147
        """Return location relative to branch."""
 
148
        return self._transport.abspath(self._escape(file_or_path))
 
149
 
 
150
    @needs_read_lock
 
151
    def get(self, relpath):
 
152
        """Get a file as a bytestream."""
 
153
        relpath = self._escape(relpath)
 
154
        return self._transport.get(relpath)
 
155
 
 
156
    @needs_read_lock
 
157
    def get_utf8(self, relpath):
 
158
        """Get a file as a unicode stream."""
 
159
        relpath = self._escape(relpath)
 
160
        # DO NOT introduce an errors=replace here.
 
161
        return codecs.getreader('utf-8')(self._transport.get(relpath))
 
162
 
 
163
    @needs_write_lock
 
164
    def put(self, path, file):
 
165
        """Write a file.
 
166
        
 
167
        :param path: The path to put the file, relative to the .bzr control
 
168
                     directory
 
169
        :param f: A file-like or string object whose contents should be copied.
 
170
        """
 
171
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
 
172
 
 
173
    @needs_write_lock
 
174
    def put_bytes(self, path, a_string):
 
175
        """Write a string of bytes.
 
176
 
 
177
        :param path: The path to put the bytes, relative to the transport root.
 
178
        :param string: A string object, whose exact bytes are to be copied.
 
179
        """
 
180
        self._transport.put_bytes(self._escape(path), a_string,
 
181
                                  mode=self._file_mode)
 
182
 
 
183
    @needs_write_lock
 
184
    def put_utf8(self, path, a_string):
 
185
        """Write a string, encoding as utf-8.
 
186
 
 
187
        :param path: The path to put the string, relative to the transport root.
 
188
        :param string: A string or unicode object whose contents should be copied.
 
189
        """
 
190
        # IterableFile would not be needed if Transport.put took iterables
 
191
        # instead of files.  ADHB 2005-12-25
 
192
        # RBC 20060103 surely its not needed anyway, with codecs transcode
 
193
        # file support ?
 
194
        # JAM 20060103 We definitely don't want encode(..., 'replace')
 
195
        # these are valuable files which should have exact contents.
 
196
        if not isinstance(a_string, basestring):
 
197
            raise errors.BzrBadParameterNotString(a_string)
 
198
        self.put_bytes(path, a_string.encode('utf-8'))
132
199
 
133
200
    def leave_in_place(self):
134
201
        """Set this LockableFiles to not clear the physical lock on unlock."""
140
207
 
141
208
    def lock_write(self, token=None):
142
209
        """Lock this group of files for writing.
143
 
 
 
210
        
144
211
        :param token: if this is already locked, then lock_write will fail
145
212
            unless the token matches the existing lock.
146
213
        :returns: a token if this instance supports tokens, otherwise None.
153
220
        some other way, and need to synchronise this object's state with that
154
221
        fact.
155
222
        """
 
223
        # mutter("lock write: %s (%s)", self, self._lock_count)
 
224
        # TODO: Upgrade locking to support using a Transport,
 
225
        # and potentially a remote locking protocol
156
226
        if self._lock_mode:
157
 
            if (self._lock_mode != 'w'
158
 
                or not self.get_transaction().writeable()):
 
227
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
159
228
                raise errors.ReadOnlyError(self)
160
229
            self._lock.validate_token(token)
161
230
            self._lock_count += 1
162
231
            return self._token_from_lock
163
232
        else:
164
233
            token_from_lock = self._lock.lock_write(token=token)
 
234
            #note('write locking %s', self)
165
235
            #traceback.print_stack()
166
236
            self._lock_mode = 'w'
167
237
            self._lock_count = 1
168
 
            self._set_write_transaction()
 
238
            self._set_transaction(transactions.WriteTransaction())
169
239
            self._token_from_lock = token_from_lock
170
240
            return token_from_lock
171
241
 
172
242
    def lock_read(self):
 
243
        # mutter("lock read: %s (%s)", self, self._lock_count)
173
244
        if self._lock_mode:
174
245
            if self._lock_mode not in ('r', 'w'):
175
246
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
176
247
            self._lock_count += 1
177
248
        else:
178
249
            self._lock.lock_read()
 
250
            #note('read locking %s', self)
179
251
            #traceback.print_stack()
180
252
            self._lock_mode = 'r'
181
253
            self._lock_count = 1
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)
 
254
            self._set_transaction(transactions.ReadOnlyTransaction())
 
255
            # 5K may be excessive, but hey, its a knob.
 
256
            self.get_transaction().set_cache_size(5000)
 
257
                        
195
258
    def unlock(self):
 
259
        # mutter("unlock: %s (%s)", self, self._lock_count)
196
260
        if not self._lock_mode:
197
 
            return lock.cant_unlock_not_held(self)
 
261
            raise errors.LockNotHeld(self)
198
262
        if self._lock_count > 1:
199
263
            self._lock_count -= 1
200
264
        else:
 
265
            #note('unlocking %s', self)
201
266
            #traceback.print_stack()
202
267
            self._finish_transaction()
203
268
            try:
211
276
 
212
277
    def get_physical_lock_status(self):
213
278
        """Return physical lock status.
214
 
 
 
279
        
215
280
        Returns true if a lock is held on the transport. If no lock is held, or
216
281
        the underlying locking mechanism does not support querying lock
217
282
        status, false is returned.
299
364
    def validate_token(self, token):
300
365
        if token is not None:
301
366
            raise errors.TokenLockingNotSupported(self)
 
367