← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: John Arbash Meinel
  • Date: 2009-03-06 20:42:40 UTC
  • mto: This revision was merged to the branch mainline in revision 4088.
  • Revision ID: john@arbash-meinel.com-20090306204240-mzjavv31z3gu1x7i
Fix a small bug in setup.py when an extension fails to build

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
1
 
# Copyright (C) 2005, 2006, 2008, 2009 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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
from cStringIO import StringIO
18
18
 
22
22
import warnings
23
23
 
24
24
from bzrlib import (
25
 
    counted_lock,
26
25
    errors,
27
 
    lock,
28
26
    osutils,
29
27
    transactions,
30
28
    urlutils,
32
30
""")
33
31
 
34
32
from bzrlib.decorators import (
35
 
    only_raises,
 
33
    needs_read_lock,
 
34
    needs_write_lock,
36
35
    )
37
36
from bzrlib.symbol_versioning import (
38
37
    deprecated_in,
44
43
# somewhat redundant with what's done in LockDir; the main difference is that
45
44
# LockableFiles permits reentrancy.
46
45
 
47
 
class _LockWarner(object):
48
 
    """Hold a counter for a lock and warn if GCed while the count is >= 1.
49
 
 
50
 
    This is separate from LockableFiles because putting a __del__ on
51
 
    LockableFiles can result in uncollectable cycles.
52
 
    """
53
 
 
54
 
    def __init__(self, repr):
55
 
        self.lock_count = 0
56
 
        self.repr = repr
57
 
 
58
 
    def __del__(self):
59
 
        if self.lock_count >= 1:
60
 
            # There should have been a try/finally to unlock this.
61
 
            warnings.warn("%r was gc'd while locked" % self.repr)
62
 
 
63
 
 
64
46
class LockableFiles(object):
65
47
    """Object representing a set of related files locked within the same scope.
66
48
 
67
 
    This coordinates access to the lock along with providing a transaction.
 
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.
68
54
 
69
55
    LockableFiles manage a lock count and can be locked repeatedly by
70
56
    a single caller.  (The underlying lock implementation generally does not
72
58
 
73
59
    Instances of this class are often called control_files.
74
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
 
75
68
    This class is now deprecated; code should move to using the Transport
76
69
    directly for file operations and using the lock or CountedLock for
77
70
    locking.
78
 
    
79
 
    :ivar _lock: The real underlying lock (e.g. a LockDir)
80
 
    :ivar _counted_lock: A lock decorated with a semaphore, so that it 
81
 
        can be re-entered.
82
71
    """
83
72
 
84
73
    # _lock_mode: None, or 'r' or 'w'
99
88
        self.lock_name = lock_name
100
89
        self._transaction = None
101
90
        self._lock_mode = None
102
 
        self._lock_warner = _LockWarner(repr(self))
 
91
        self._lock_count = 0
103
92
        self._find_modes()
104
93
        esc_name = self._escape(lock_name)
105
94
        self._lock = lock_class(transport, esc_name,
106
95
                                file_modebits=self._file_mode,
107
96
                                dir_modebits=self._dir_mode)
108
 
        self._counted_lock = counted_lock.CountedLock(self._lock)
109
97
 
110
98
    def create_lock(self):
111
99
        """Create the lock.
121
109
    def __str__(self):
122
110
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
123
111
 
 
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
 
124
118
    def break_lock(self):
125
119
        """Break the lock of this lockable files group if it is held.
126
120
 
139
133
    def _find_modes(self):
140
134
        """Determine the appropriate modes for files and directories.
141
135
 
142
 
        :deprecated: Replaced by BzrDir._find_creation_modes.
 
136
        :deprecated: Replaced by BzrDir._find_modes.
143
137
        """
144
 
        # XXX: The properties created by this can be removed or deprecated
145
 
        # once all the _get_text_store methods etc no longer use them.
146
 
        # -- mbp 20080512
147
138
        try:
148
139
            st = self._transport.stat('.')
149
140
        except errors.TransportNotPossible:
158
149
            # Remove the sticky and execute bits for files
159
150
            self._file_mode = self._dir_mode & ~07111
160
151
 
 
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
 
161
227
    def leave_in_place(self):
162
228
        """Set this LockableFiles to not clear the physical lock on unlock."""
163
229
        self._lock.leave_in_place()
187
253
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
188
254
                raise errors.ReadOnlyError(self)
189
255
            self._lock.validate_token(token)
190
 
            self._lock_warner.lock_count += 1
 
256
            self._lock_count += 1
191
257
            return self._token_from_lock
192
258
        else:
193
259
            token_from_lock = self._lock.lock_write(token=token)
194
260
            #traceback.print_stack()
195
261
            self._lock_mode = 'w'
196
 
            self._lock_warner.lock_count = 1
197
 
            self._set_write_transaction()
 
262
            self._lock_count = 1
 
263
            self._set_transaction(transactions.WriteTransaction())
198
264
            self._token_from_lock = token_from_lock
199
265
            return token_from_lock
200
266
 
202
268
        if self._lock_mode:
203
269
            if self._lock_mode not in ('r', 'w'):
204
270
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
205
 
            self._lock_warner.lock_count += 1
 
271
            self._lock_count += 1
206
272
        else:
207
273
            self._lock.lock_read()
208
274
            #traceback.print_stack()
209
275
            self._lock_mode = 'r'
210
 
            self._lock_warner.lock_count = 1
211
 
            self._set_read_transaction()
212
 
 
213
 
    def _set_read_transaction(self):
214
 
        """Setup a read transaction."""
215
 
        self._set_transaction(transactions.ReadOnlyTransaction())
216
 
        # 5K may be excessive, but hey, its a knob.
217
 
        self.get_transaction().set_cache_size(5000)
218
 
 
219
 
    def _set_write_transaction(self):
220
 
        """Setup a write transaction."""
221
 
        self._set_transaction(transactions.WriteTransaction())
222
 
 
223
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
 
276
            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
 
224
281
    def unlock(self):
225
282
        if not self._lock_mode:
226
 
            return lock.cant_unlock_not_held(self)
227
 
        if self._lock_warner.lock_count > 1:
228
 
            self._lock_warner.lock_count -= 1
 
283
            raise errors.LockNotHeld(self)
 
284
        if self._lock_count > 1:
 
285
            self._lock_count -= 1
229
286
        else:
230
287
            #traceback.print_stack()
231
288
            self._finish_transaction()
232
289
            try:
233
290
                self._lock.unlock()
234
291
            finally:
235
 
                self._lock_mode = self._lock_warner.lock_count = None
236
 
 
237
 
    @property
238
 
    def _lock_count(self):
239
 
        return self._lock_warner.lock_count
 
292
                self._lock_mode = self._lock_count = None
240
293
 
241
294
    def is_locked(self):
242
295
        """Return true if this LockableFiles group is locked"""
243
 
        return self._lock_warner.lock_count >= 1
 
296
        return self._lock_count >= 1
244
297
 
245
298
    def get_physical_lock_status(self):
246
299
        """Return physical lock status.