~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: John Arbash Meinel
  • Date: 2008-09-26 22:14:42 UTC
  • mto: This revision was merged to the branch mainline in revision 3747.
  • Revision ID: john@arbash-meinel.com-20080926221442-3r67j99sr9rwe9w0
Make message optional, don't check the memory flag directly.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
        zero_eight)
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:
132
140
            self._dir_mode = 0755
133
141
            self._file_mode = 0644
134
142
        else:
135
 
            self._dir_mode = st.st_mode & 07777
 
143
            # Check the directory mode, but also make sure the created
 
144
            # directories and files are read-write for this user. This is
 
145
            # mostly a workaround for filesystems which lie about being able to
 
146
            # write to a directory (cygwin & win32)
 
147
            self._dir_mode = (st.st_mode & 07777) | 00700
136
148
            # Remove the sticky and execute bits for files
137
149
            self._file_mode = self._dir_mode & ~07111
138
 
        if not self._set_dir_mode:
139
 
            self._dir_mode = None
140
 
        if not self._set_file_mode:
141
 
            self._file_mode = None
142
150
 
 
151
    @deprecated_method(deprecated_in((1, 6, 0)))
143
152
    def controlfilename(self, file_or_path):
144
 
        """Return location relative to branch."""
 
153
        """Return location relative to branch.
 
154
        
 
155
        :deprecated: Use Transport methods instead.
 
156
        """
145
157
        return self._transport.abspath(self._escape(file_or_path))
146
158
 
147
 
    @deprecated_method(zero_eight)
148
 
    def controlfile(self, file_or_path, mode='r'):
149
 
        """Open a control file for this branch.
150
 
 
151
 
        There are two classes of file in a lockable directory: text
152
 
        and binary.  binary files are untranslated byte streams.  Text
153
 
        control files are stored with Unix newlines and in UTF-8, even
154
 
        if the platform or locale defaults are different.
155
 
 
156
 
        Such files are not openable in write mode : they are managed via
157
 
        put and put_utf8 which atomically replace old versions using
158
 
        atomicfile.
159
 
        """
160
 
 
161
 
        relpath = self._escape(file_or_path)
162
 
        # TODO: codecs.open() buffers linewise, so it was overloaded with
163
 
        # a much larger buffer, do we need to do the same for getreader/getwriter?
164
 
        if mode == 'rb': 
165
 
            return self.get(relpath)
166
 
        elif mode == 'wb':
167
 
            raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
168
 
        elif mode == 'r':
169
 
            return self.get_utf8(relpath)
170
 
        elif mode == 'w':
171
 
            raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
172
 
        else:
173
 
            raise BzrError("invalid controlfile mode %r" % mode)
174
 
 
175
159
    @needs_read_lock
 
160
    @deprecated_method(deprecated_in((1, 5, 0)))
176
161
    def get(self, relpath):
177
 
        """Get a file as a bytestream."""
 
162
        """Get a file as a bytestream.
 
163
        
 
164
        :deprecated: Use a Transport instead of LockableFiles.
 
165
        """
178
166
        relpath = self._escape(relpath)
179
167
        return self._transport.get(relpath)
180
168
 
181
169
    @needs_read_lock
 
170
    @deprecated_method(deprecated_in((1, 5, 0)))
182
171
    def get_utf8(self, relpath):
183
 
        """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
        """
184
176
        relpath = self._escape(relpath)
185
177
        # DO NOT introduce an errors=replace here.
186
178
        return codecs.getreader('utf-8')(self._transport.get(relpath))
187
179
 
188
180
    @needs_write_lock
 
181
    @deprecated_method(deprecated_in((1, 6, 0)))
189
182
    def put(self, path, file):
190
183
        """Write a file.
191
184
        
192
185
        :param path: The path to put the file, relative to the .bzr control
193
186
                     directory
194
 
        :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.
195
190
        """
196
191
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
197
192
 
198
193
    @needs_write_lock
 
194
    @deprecated_method(deprecated_in((1, 6, 0)))
199
195
    def put_bytes(self, path, a_string):
200
196
        """Write a string of bytes.
201
197
 
202
198
        :param path: The path to put the bytes, relative to the transport root.
203
 
        :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.
204
202
        """
205
203
        self._transport.put_bytes(self._escape(path), a_string,
206
204
                                  mode=self._file_mode)
207
205
 
208
206
    @needs_write_lock
 
207
    @deprecated_method(deprecated_in((1, 6, 0)))
209
208
    def put_utf8(self, path, a_string):
210
209
        """Write a string, encoding as utf-8.
211
210
 
212
211
        :param path: The path to put the string, relative to the transport root.
213
212
        :param string: A string or unicode object whose contents should be copied.
 
213
 
 
214
        :deprecated: Use Transport methods instead.
214
215
        """
215
216
        # IterableFile would not be needed if Transport.put took iterables
216
217
        # instead of files.  ADHB 2005-12-25
245
246
        some other way, and need to synchronise this object's state with that
246
247
        fact.
247
248
        """
248
 
        # mutter("lock write: %s (%s)", self, self._lock_count)
249
249
        # TODO: Upgrade locking to support using a Transport,
250
250
        # and potentially a remote locking protocol
251
251
        if self._lock_mode:
256
256
            return self._token_from_lock
257
257
        else:
258
258
            token_from_lock = self._lock.lock_write(token=token)
259
 
            #note('write locking %s', self)
260
259
            #traceback.print_stack()
261
260
            self._lock_mode = 'w'
262
261
            self._lock_count = 1
265
264
            return token_from_lock
266
265
 
267
266
    def lock_read(self):
268
 
        # mutter("lock read: %s (%s)", self, self._lock_count)
269
267
        if self._lock_mode:
270
 
            assert self._lock_mode in ('r', 'w'), \
271
 
                   "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,))
272
270
            self._lock_count += 1
273
271
        else:
274
272
            self._lock.lock_read()
275
 
            #note('read locking %s', self)
276
273
            #traceback.print_stack()
277
274
            self._lock_mode = 'r'
278
275
            self._lock_count = 1
281
278
            self.get_transaction().set_cache_size(5000)
282
279
                        
283
280
    def unlock(self):
284
 
        # mutter("unlock: %s (%s)", self, self._lock_count)
285
281
        if not self._lock_mode:
286
282
            raise errors.LockNotHeld(self)
287
283
        if self._lock_count > 1:
288
284
            self._lock_count -= 1
289
285
        else:
290
 
            #note('unlocking %s', self)
291
286
            #traceback.print_stack()
292
287
            self._finish_transaction()
293
288
            try: