/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: Andrew Bennetts
  • Date: 2008-09-08 12:59:00 UTC
  • mfrom: (3695 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3756.
  • Revision ID: andrew.bennetts@canonical.com-20080908125900-8ywtsr7jqyyatjz0
Merge from bzr.dev.

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, 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
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
from cStringIO import StringIO
 
18
 
 
19
from bzrlib.lazy_import import lazy_import
 
20
lazy_import(globals(), """
18
21
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
 
22
import warnings
 
23
 
 
24
from bzrlib import (
 
25
    errors,
 
26
    osutils,
 
27
    transactions,
 
28
    urlutils,
 
29
    )
 
30
""")
 
31
 
 
32
from bzrlib.decorators import (
 
33
    needs_read_lock,
 
34
    needs_write_lock,
 
35
    )
 
36
from bzrlib.symbol_versioning import (
 
37
    deprecated_in,
 
38
    deprecated_method,
 
39
    )
32
40
 
33
41
 
34
42
# XXX: The tracking here of lock counts and whether the lock is held is
56
64
    the object is constructed.  In older formats OSLocks are used everywhere.
57
65
    in newer formats a LockDir is used for Repositories and Branches, and 
58
66
    OSLocks for the local filesystem.
 
67
 
 
68
    This class is now deprecated; code should move to using the Transport 
 
69
    directly for file operations and using the lock or CountedLock for 
 
70
    locking.
59
71
    """
60
72
 
61
73
    # _lock_mode: None, or 'r' or 'w'
63
75
    # _lock_count: If _lock_mode is true, a positive count of the number of
64
76
    # times the lock has been taken *by this process*.   
65
77
    
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
78
    def __init__(self, transport, lock_name, lock_class):
72
79
        """Create a LockableFiles group
73
80
 
104
111
 
105
112
    def __del__(self):
106
113
        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()
 
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)
112
117
 
113
118
    def break_lock(self):
114
119
        """Break the lock of this lockable files group if it is held.
122
127
            file_or_path = '/'.join(file_or_path)
123
128
        if file_or_path == '':
124
129
            return u''
125
 
        return urlutils.escape(safe_unicode(file_or_path))
 
130
        return urlutils.escape(osutils.safe_unicode(file_or_path))
126
131
 
127
132
    def _find_modes(self):
128
 
        """Determine the appropriate modes for files and directories."""
 
133
        """Determine the appropriate modes for files and directories.
 
134
        
 
135
        :deprecated: Replaced by BzrDir._find_modes.
 
136
        """
129
137
        try:
130
138
            st = self._transport.stat('.')
131
139
        except errors.TransportNotPossible:
139
147
            self._dir_mode = (st.st_mode & 07777) | 00700
140
148
            # Remove the sticky and execute bits for files
141
149
            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
150
 
 
151
    @deprecated_method(deprecated_in((1, 6, 0)))
147
152
    def controlfilename(self, file_or_path):
148
 
        """Return location relative to branch."""
 
153
        """Return location relative to branch.
 
154
        
 
155
        :deprecated: Use Transport methods instead.
 
156
        """
149
157
        return self._transport.abspath(self._escape(file_or_path))
150
158
 
151
159
    @needs_read_lock
 
160
    @deprecated_method(deprecated_in((1, 5, 0)))
152
161
    def get(self, relpath):
153
 
        """Get a file as a bytestream."""
 
162
        """Get a file as a bytestream.
 
163
        
 
164
        :deprecated: Use a Transport instead of LockableFiles.
 
165
        """
154
166
        relpath = self._escape(relpath)
155
167
        return self._transport.get(relpath)
156
168
 
157
169
    @needs_read_lock
 
170
    @deprecated_method(deprecated_in((1, 5, 0)))
158
171
    def get_utf8(self, relpath):
159
 
        """Get a file as a unicode stream."""
 
172
        """Get a file as a unicode stream.
 
173
        
 
174
        :deprecated: Use a Transport instead of LockableFiles.
 
175
        """
160
176
        relpath = self._escape(relpath)
161
177
        # DO NOT introduce an errors=replace here.
162
178
        return codecs.getreader('utf-8')(self._transport.get(relpath))
163
179
 
164
180
    @needs_write_lock
 
181
    @deprecated_method(deprecated_in((1, 6, 0)))
165
182
    def put(self, path, file):
166
183
        """Write a file.
167
184
        
168
185
        :param path: The path to put the file, relative to the .bzr control
169
186
                     directory
170
 
        :param f: A file-like or string object whose contents should be copied.
 
187
        :param file: A file-like or string object whose contents should be copied.
 
188
 
 
189
        :deprecated: Use Transport methods instead.
171
190
        """
172
191
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
173
192
 
174
193
    @needs_write_lock
 
194
    @deprecated_method(deprecated_in((1, 6, 0)))
175
195
    def put_bytes(self, path, a_string):
176
196
        """Write a string of bytes.
177
197
 
178
198
        :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.
 
199
        :param a_string: A string object, whose exact bytes are to be copied.
 
200
 
 
201
        :deprecated: Use Transport methods instead.
180
202
        """
181
203
        self._transport.put_bytes(self._escape(path), a_string,
182
204
                                  mode=self._file_mode)
183
205
 
184
206
    @needs_write_lock
 
207
    @deprecated_method(deprecated_in((1, 6, 0)))
185
208
    def put_utf8(self, path, a_string):
186
209
        """Write a string, encoding as utf-8.
187
210
 
188
211
        :param path: The path to put the string, relative to the transport root.
189
212
        :param string: A string or unicode object whose contents should be copied.
 
213
 
 
214
        :deprecated: Use Transport methods instead.
190
215
        """
191
216
        # IterableFile would not be needed if Transport.put took iterables
192
217
        # instead of files.  ADHB 2005-12-25
221
246
        some other way, and need to synchronise this object's state with that
222
247
        fact.
223
248
        """
224
 
        # mutter("lock write: %s (%s)", self, self._lock_count)
225
249
        # TODO: Upgrade locking to support using a Transport,
226
250
        # and potentially a remote locking protocol
227
251
        if self._lock_mode:
232
256
            return self._token_from_lock
233
257
        else:
234
258
            token_from_lock = self._lock.lock_write(token=token)
235
 
            #note('write locking %s', self)
236
259
            #traceback.print_stack()
237
260
            self._lock_mode = 'w'
238
261
            self._lock_count = 1
241
264
            return token_from_lock
242
265
 
243
266
    def lock_read(self):
244
 
        # mutter("lock read: %s (%s)", self, self._lock_count)
245
267
        if self._lock_mode:
246
 
            assert self._lock_mode in ('r', 'w'), \
247
 
                   "invalid lock mode %r" % self._lock_mode
 
268
            if self._lock_mode not in ('r', 'w'):
 
269
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
248
270
            self._lock_count += 1
249
271
        else:
250
272
            self._lock.lock_read()
251
 
            #note('read locking %s', self)
252
273
            #traceback.print_stack()
253
274
            self._lock_mode = 'r'
254
275
            self._lock_count = 1
257
278
            self.get_transaction().set_cache_size(5000)
258
279
                        
259
280
    def unlock(self):
260
 
        # mutter("unlock: %s (%s)", self, self._lock_count)
261
281
        if not self._lock_mode:
262
282
            raise errors.LockNotHeld(self)
263
283
        if self._lock_count > 1:
264
284
            self._lock_count -= 1
265
285
        else:
266
 
            #note('unlocking %s', self)
267
286
            #traceback.print_stack()
268
287
            self._finish_transaction()
269
288
            try: