/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Michael Hudson
  • Date: 2009-02-26 22:28:08 UTC
  • mto: This revision was merged to the branch mainline in revision 4121.
  • Revision ID: michael.hudson@canonical.com-20090226222808-url1udsulbge2r28
_this_ works

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
 
 
17
from cStringIO import StringIO
16
18
 
17
19
from bzrlib.lazy_import import lazy_import
18
20
lazy_import(globals(), """
20
22
import warnings
21
23
 
22
24
from bzrlib import (
23
 
    counted_lock,
24
25
    errors,
25
 
    lock,
26
26
    osutils,
27
27
    transactions,
28
28
    urlutils,
30
30
""")
31
31
 
32
32
from bzrlib.decorators import (
33
 
    only_raises,
 
33
    needs_read_lock,
 
34
    needs_write_lock,
 
35
    )
 
36
from bzrlib.symbol_versioning import (
 
37
    deprecated_in,
 
38
    deprecated_method,
34
39
    )
35
40
 
36
41
 
38
43
# somewhat redundant with what's done in LockDir; the main difference is that
39
44
# LockableFiles permits reentrancy.
40
45
 
41
 
class _LockWarner(object):
42
 
    """Hold a counter for a lock and warn if GCed while the count is >= 1.
43
 
 
44
 
    This is separate from LockableFiles because putting a __del__ on
45
 
    LockableFiles can result in uncollectable cycles.
46
 
    """
47
 
 
48
 
    def __init__(self, repr):
49
 
        self.lock_count = 0
 
46
class LockWarner(object):
 
47
 
 
48
    def __init__(self, lock_count_holder, repr):
 
49
        self.lock_count_holder = lock_count_holder
50
50
        self.repr = repr
51
51
 
52
52
    def __del__(self):
53
 
        if self.lock_count >= 1:
54
 
            # There should have been a try/finally to unlock this.
 
53
        if self.lock_count_holder[0] >= 1:
 
54
            # do not automatically unlock; there should have been a
 
55
            # try/finally to unlock this.
55
56
            warnings.warn("%r was gc'd while locked" % self.repr)
56
57
 
57
58
 
58
59
class LockableFiles(object):
59
60
    """Object representing a set of related files locked within the same scope.
60
61
 
61
 
    This coordinates access to the lock along with providing a transaction.
 
62
    These files are used by a WorkingTree, Repository or Branch, and should
 
63
    generally only be touched by that object.
 
64
 
 
65
    LockableFiles also provides some policy on top of Transport for encoding
 
66
    control files as utf-8.
62
67
 
63
68
    LockableFiles manage a lock count and can be locked repeatedly by
64
69
    a single caller.  (The underlying lock implementation generally does not
66
71
 
67
72
    Instances of this class are often called control_files.
68
73
 
 
74
    This object builds on top of a Transport, which is used to actually write
 
75
    the files to disk, and an OSLock or LockDir, which controls how access to
 
76
    the files is controlled.  The particular type of locking used is set when
 
77
    the object is constructed.  In older formats OSLocks are used everywhere.
 
78
    in newer formats a LockDir is used for Repositories and Branches, and
 
79
    OSLocks for the local filesystem.
 
80
 
69
81
    This class is now deprecated; code should move to using the Transport
70
82
    directly for file operations and using the lock or CountedLock for
71
83
    locking.
72
 
    
73
 
    :ivar _lock: The real underlying lock (e.g. a LockDir)
74
 
    :ivar _counted_lock: A lock decorated with a semaphore, so that it 
75
 
        can be re-entered.
76
84
    """
77
85
 
78
86
    # _lock_mode: None, or 'r' or 'w'
93
101
        self.lock_name = lock_name
94
102
        self._transaction = None
95
103
        self._lock_mode = None
96
 
        self._lock_warner = _LockWarner(repr(self))
 
104
        self._lock_count_holder = [0]
 
105
        self._lock_warner = LockWarner(self._lock_count_holder, repr(self))
97
106
        self._find_modes()
98
107
        esc_name = self._escape(lock_name)
99
108
        self._lock = lock_class(transport, esc_name,
100
109
                                file_modebits=self._file_mode,
101
110
                                dir_modebits=self._dir_mode)
102
 
        self._counted_lock = counted_lock.CountedLock(self._lock)
103
111
 
104
112
    def create_lock(self):
105
113
        """Create the lock.
133
141
    def _find_modes(self):
134
142
        """Determine the appropriate modes for files and directories.
135
143
 
136
 
        :deprecated: Replaced by BzrDir._find_creation_modes.
 
144
        :deprecated: Replaced by BzrDir._find_modes.
137
145
        """
138
 
        # XXX: The properties created by this can be removed or deprecated
139
 
        # once all the _get_text_store methods etc no longer use them.
140
 
        # -- mbp 20080512
141
146
        try:
142
147
            st = self._transport.stat('.')
143
148
        except errors.TransportNotPossible:
152
157
            # Remove the sticky and execute bits for files
153
158
            self._file_mode = self._dir_mode & ~07111
154
159
 
 
160
    @deprecated_method(deprecated_in((1, 6, 0)))
 
161
    def controlfilename(self, file_or_path):
 
162
        """Return location relative to branch.
 
163
 
 
164
        :deprecated: Use Transport methods instead.
 
165
        """
 
166
        return self._transport.abspath(self._escape(file_or_path))
 
167
 
 
168
    @needs_read_lock
 
169
    @deprecated_method(deprecated_in((1, 5, 0)))
 
170
    def get(self, relpath):
 
171
        """Get a file as a bytestream.
 
172
 
 
173
        :deprecated: Use a Transport instead of LockableFiles.
 
174
        """
 
175
        relpath = self._escape(relpath)
 
176
        return self._transport.get(relpath)
 
177
 
 
178
    @needs_read_lock
 
179
    @deprecated_method(deprecated_in((1, 5, 0)))
 
180
    def get_utf8(self, relpath):
 
181
        """Get a file as a unicode stream.
 
182
 
 
183
        :deprecated: Use a Transport instead of LockableFiles.
 
184
        """
 
185
        relpath = self._escape(relpath)
 
186
        # DO NOT introduce an errors=replace here.
 
187
        return codecs.getreader('utf-8')(self._transport.get(relpath))
 
188
 
 
189
    @needs_write_lock
 
190
    @deprecated_method(deprecated_in((1, 6, 0)))
 
191
    def put(self, path, file):
 
192
        """Write a file.
 
193
 
 
194
        :param path: The path to put the file, relative to the .bzr control
 
195
                     directory
 
196
        :param file: A file-like or string object whose contents should be copied.
 
197
 
 
198
        :deprecated: Use Transport methods instead.
 
199
        """
 
200
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
 
201
 
 
202
    @needs_write_lock
 
203
    @deprecated_method(deprecated_in((1, 6, 0)))
 
204
    def put_bytes(self, path, a_string):
 
205
        """Write a string of bytes.
 
206
 
 
207
        :param path: The path to put the bytes, relative to the transport root.
 
208
        :param a_string: A string object, whose exact bytes are to be copied.
 
209
 
 
210
        :deprecated: Use Transport methods instead.
 
211
        """
 
212
        self._transport.put_bytes(self._escape(path), a_string,
 
213
                                  mode=self._file_mode)
 
214
 
 
215
    @needs_write_lock
 
216
    @deprecated_method(deprecated_in((1, 6, 0)))
 
217
    def put_utf8(self, path, a_string):
 
218
        """Write a string, encoding as utf-8.
 
219
 
 
220
        :param path: The path to put the string, relative to the transport root.
 
221
        :param string: A string or unicode object whose contents should be copied.
 
222
 
 
223
        :deprecated: Use Transport methods instead.
 
224
        """
 
225
        # IterableFile would not be needed if Transport.put took iterables
 
226
        # instead of files.  ADHB 2005-12-25
 
227
        # RBC 20060103 surely its not needed anyway, with codecs transcode
 
228
        # file support ?
 
229
        # JAM 20060103 We definitely don't want encode(..., 'replace')
 
230
        # these are valuable files which should have exact contents.
 
231
        if not isinstance(a_string, basestring):
 
232
            raise errors.BzrBadParameterNotString(a_string)
 
233
        self.put_bytes(path, a_string.encode('utf-8'))
 
234
 
155
235
    def leave_in_place(self):
156
236
        """Set this LockableFiles to not clear the physical lock on unlock."""
157
237
        self._lock.leave_in_place()
181
261
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
182
262
                raise errors.ReadOnlyError(self)
183
263
            self._lock.validate_token(token)
184
 
            self._lock_warner.lock_count += 1
 
264
            self._lock_count_holder[0] += 1
185
265
            return self._token_from_lock
186
266
        else:
187
267
            token_from_lock = self._lock.lock_write(token=token)
188
268
            #traceback.print_stack()
189
269
            self._lock_mode = 'w'
190
 
            self._lock_warner.lock_count = 1
191
 
            self._set_write_transaction()
 
270
            self._lock_count_holder[0] = 1
 
271
            self._set_transaction(transactions.WriteTransaction())
192
272
            self._token_from_lock = token_from_lock
193
273
            return token_from_lock
194
274
 
196
276
        if self._lock_mode:
197
277
            if self._lock_mode not in ('r', 'w'):
198
278
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
199
 
            self._lock_warner.lock_count += 1
 
279
            self._lock_count_holder[0] += 1
200
280
        else:
201
281
            self._lock.lock_read()
202
282
            #traceback.print_stack()
203
283
            self._lock_mode = 'r'
204
 
            self._lock_warner.lock_count = 1
205
 
            self._set_read_transaction()
206
 
 
207
 
    def _set_read_transaction(self):
208
 
        """Setup a read transaction."""
209
 
        self._set_transaction(transactions.ReadOnlyTransaction())
210
 
        # 5K may be excessive, but hey, its a knob.
211
 
        self.get_transaction().set_cache_size(5000)
212
 
 
213
 
    def _set_write_transaction(self):
214
 
        """Setup a write transaction."""
215
 
        self._set_transaction(transactions.WriteTransaction())
216
 
 
217
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
 
284
            self._lock_count_holder[0] = 1
 
285
            self._set_transaction(transactions.ReadOnlyTransaction())
 
286
            # 5K may be excessive, but hey, its a knob.
 
287
            self.get_transaction().set_cache_size(5000)
 
288
 
218
289
    def unlock(self):
219
290
        if not self._lock_mode:
220
 
            return lock.cant_unlock_not_held(self)
221
 
        if self._lock_warner.lock_count > 1:
222
 
            self._lock_warner.lock_count -= 1
 
291
            raise errors.LockNotHeld(self)
 
292
        if self._lock_count_holder[0] > 1:
 
293
            self._lock_count_holder[0] -= 1
223
294
        else:
224
295
            #traceback.print_stack()
225
296
            self._finish_transaction()
226
297
            try:
227
298
                self._lock.unlock()
228
299
            finally:
229
 
                self._lock_mode = self._lock_warner.lock_count = None
 
300
                self._lock_mode = self._lock_count_holder[0] = None
230
301
 
231
302
    @property
232
303
    def _lock_count(self):
233
 
        return self._lock_warner.lock_count
 
304
        return self._lock_count_holder[0]
234
305
 
235
306
    def is_locked(self):
236
307
        """Return true if this LockableFiles group is locked"""
237
 
        return self._lock_warner.lock_count >= 1
 
308
        return self._lock_count_holder[0] >= 1
238
309
 
239
310
    def get_physical_lock_status(self):
240
311
        """Return physical lock status.