~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-06-16 14:33:42 UTC
  • mfrom: (1770.2.1 config)
  • Revision ID: pqm@pqm.ubuntu.com-20060616143342-8f7f4a4f77c1e4c8
Use create_signature for signing policy, deprecate check_signatures for this

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
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(), """
21
18
import codecs
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
 
    )
 
19
#import traceback
 
20
 
 
21
import bzrlib
 
22
from bzrlib.decorators import *
 
23
import bzrlib.errors as errors
 
24
from bzrlib.errors import BzrError
 
25
from bzrlib.osutils import file_iterator, safe_unicode
 
26
from bzrlib.symbol_versioning import *
 
27
from bzrlib.trace import mutter, note
 
28
import bzrlib.transactions as transactions
 
29
import bzrlib.urlutils as urlutils
40
30
 
41
31
 
42
32
# XXX: The tracking here of lock counts and whether the lock is held is
64
54
    the object is constructed.  In older formats OSLocks are used everywhere.
65
55
    in newer formats a LockDir is used for Repositories and Branches, and 
66
56
    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.
71
57
    """
72
58
 
73
59
    # _lock_mode: None, or 'r' or 'w'
75
61
    # _lock_count: If _lock_mode is true, a positive count of the number of
76
62
    # times the lock has been taken *by this process*.   
77
63
    
 
64
    # If set to False (by a plugin, etc) BzrBranch will not set the
 
65
    # mode on created files or directories
 
66
    _set_file_mode = True
 
67
    _set_dir_mode = True
 
68
 
78
69
    def __init__(self, transport, lock_name, lock_class):
79
70
        """Create a LockableFiles group
80
71
 
111
102
 
112
103
    def __del__(self):
113
104
        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)
 
105
            # XXX: This should show something every time, and be suitable for
 
106
            # headless operation and embedding
 
107
            from warnings import warn
 
108
            warn("file group %r was not explicitly unlocked" % self)
 
109
            self._lock.unlock()
117
110
 
118
111
    def break_lock(self):
119
112
        """Break the lock of this lockable files group if it is held.
127
120
            file_or_path = '/'.join(file_or_path)
128
121
        if file_or_path == '':
129
122
            return u''
130
 
        return urlutils.escape(osutils.safe_unicode(file_or_path))
 
123
        return urlutils.escape(safe_unicode(file_or_path))
131
124
 
132
125
    def _find_modes(self):
133
 
        """Determine the appropriate modes for files and directories.
134
 
        
135
 
        :deprecated: Replaced by BzrDir._find_modes.
136
 
        """
 
126
        """Determine the appropriate modes for files and directories."""
137
127
        try:
138
128
            st = self._transport.stat('.')
139
129
        except errors.TransportNotPossible:
140
130
            self._dir_mode = 0755
141
131
            self._file_mode = 0644
142
132
        else:
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
 
133
            self._dir_mode = st.st_mode & 07777
148
134
            # Remove the sticky and execute bits for files
149
135
            self._file_mode = self._dir_mode & ~07111
 
136
        if not self._set_dir_mode:
 
137
            self._dir_mode = None
 
138
        if not self._set_file_mode:
 
139
            self._file_mode = None
150
140
 
151
 
    @deprecated_method(deprecated_in((1, 6, 0)))
152
141
    def controlfilename(self, file_or_path):
153
 
        """Return location relative to branch.
154
 
        
155
 
        :deprecated: Use Transport methods instead.
156
 
        """
 
142
        """Return location relative to branch."""
157
143
        return self._transport.abspath(self._escape(file_or_path))
158
144
 
 
145
    @deprecated_method(zero_eight)
 
146
    def controlfile(self, file_or_path, mode='r'):
 
147
        """Open a control file for this branch.
 
148
 
 
149
        There are two classes of file in a lockable directory: text
 
150
        and binary.  binary files are untranslated byte streams.  Text
 
151
        control files are stored with Unix newlines and in UTF-8, even
 
152
        if the platform or locale defaults are different.
 
153
 
 
154
        Such files are not openable in write mode : they are managed via
 
155
        put and put_utf8 which atomically replace old versions using
 
156
        atomicfile.
 
157
        """
 
158
 
 
159
        relpath = self._escape(file_or_path)
 
160
        # TODO: codecs.open() buffers linewise, so it was overloaded with
 
161
        # a much larger buffer, do we need to do the same for getreader/getwriter?
 
162
        if mode == 'rb': 
 
163
            return self.get(relpath)
 
164
        elif mode == 'wb':
 
165
            raise BzrError("Branch.controlfile(mode='wb') is not supported, use put[_utf8]")
 
166
        elif mode == 'r':
 
167
            return self.get_utf8(relpath)
 
168
        elif mode == 'w':
 
169
            raise BzrError("Branch.controlfile(mode='w') is not supported, use put[_utf8]")
 
170
        else:
 
171
            raise BzrError("invalid controlfile mode %r" % mode)
 
172
 
159
173
    @needs_read_lock
160
 
    @deprecated_method(deprecated_in((1, 5, 0)))
161
174
    def get(self, relpath):
162
 
        """Get a file as a bytestream.
163
 
        
164
 
        :deprecated: Use a Transport instead of LockableFiles.
165
 
        """
 
175
        """Get a file as a bytestream."""
166
176
        relpath = self._escape(relpath)
167
177
        return self._transport.get(relpath)
168
178
 
169
179
    @needs_read_lock
170
 
    @deprecated_method(deprecated_in((1, 5, 0)))
171
180
    def get_utf8(self, relpath):
172
 
        """Get a file as a unicode stream.
173
 
        
174
 
        :deprecated: Use a Transport instead of LockableFiles.
175
 
        """
 
181
        """Get a file as a unicode stream."""
176
182
        relpath = self._escape(relpath)
177
183
        # DO NOT introduce an errors=replace here.
178
184
        return codecs.getreader('utf-8')(self._transport.get(relpath))
179
185
 
180
186
    @needs_write_lock
181
 
    @deprecated_method(deprecated_in((1, 6, 0)))
182
187
    def put(self, path, file):
183
188
        """Write a file.
184
189
        
185
190
        :param path: The path to put the file, relative to the .bzr control
186
191
                     directory
187
 
        :param file: A file-like or string object whose contents should be copied.
188
 
 
189
 
        :deprecated: Use Transport methods instead.
190
 
        """
191
 
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
192
 
 
193
 
    @needs_write_lock
194
 
    @deprecated_method(deprecated_in((1, 6, 0)))
195
 
    def put_bytes(self, path, a_string):
196
 
        """Write a string of bytes.
197
 
 
198
 
        :param path: The path to put the bytes, relative to the transport root.
199
 
        :param a_string: A string object, whose exact bytes are to be copied.
200
 
 
201
 
        :deprecated: Use Transport methods instead.
202
 
        """
203
 
        self._transport.put_bytes(self._escape(path), a_string,
204
 
                                  mode=self._file_mode)
205
 
 
206
 
    @needs_write_lock
207
 
    @deprecated_method(deprecated_in((1, 6, 0)))
 
192
        :param f: A file-like or string object whose contents should be copied.
 
193
        """
 
194
        self._transport.put(self._escape(path), file, mode=self._file_mode)
 
195
 
 
196
    @needs_write_lock
208
197
    def put_utf8(self, path, a_string):
209
198
        """Write a string, encoding as utf-8.
210
199
 
211
200
        :param path: The path to put the string, relative to the transport root.
212
 
        :param string: A string or unicode object whose contents should be copied.
213
 
 
214
 
        :deprecated: Use Transport methods instead.
 
201
        :param string: A file-like or string object whose contents should be copied.
215
202
        """
216
203
        # IterableFile would not be needed if Transport.put took iterables
217
204
        # instead of files.  ADHB 2005-12-25
221
208
        # these are valuable files which should have exact contents.
222
209
        if not isinstance(a_string, basestring):
223
210
            raise errors.BzrBadParameterNotString(a_string)
224
 
        self.put_bytes(path, a_string.encode('utf-8'))
225
 
 
226
 
    def leave_in_place(self):
227
 
        """Set this LockableFiles to not clear the physical lock on unlock."""
228
 
        self._lock.leave_in_place()
229
 
 
230
 
    def dont_leave_in_place(self):
231
 
        """Set this LockableFiles to clear the physical lock on unlock."""
232
 
        self._lock.dont_leave_in_place()
233
 
 
234
 
    def lock_write(self, token=None):
235
 
        """Lock this group of files for writing.
236
 
        
237
 
        :param token: if this is already locked, then lock_write will fail
238
 
            unless the token matches the existing lock.
239
 
        :returns: a token if this instance supports tokens, otherwise None.
240
 
        :raises TokenLockingNotSupported: when a token is given but this
241
 
            instance doesn't support using token locks.
242
 
        :raises MismatchedToken: if the specified token doesn't match the token
243
 
            of the existing lock.
244
 
 
245
 
        A token should be passed in if you know that you have locked the object
246
 
        some other way, and need to synchronise this object's state with that
247
 
        fact.
248
 
        """
 
211
        self.put(path, StringIO(a_string.encode('utf-8')))
 
212
 
 
213
    def lock_write(self):
 
214
        # mutter("lock write: %s (%s)", self, self._lock_count)
249
215
        # TODO: Upgrade locking to support using a Transport,
250
216
        # and potentially a remote locking protocol
251
217
        if self._lock_mode:
252
218
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
253
219
                raise errors.ReadOnlyError(self)
254
 
            self._lock.validate_token(token)
255
220
            self._lock_count += 1
256
 
            return self._token_from_lock
257
221
        else:
258
 
            token_from_lock = self._lock.lock_write(token=token)
 
222
            self._lock.lock_write()
 
223
            #note('write locking %s', self)
259
224
            #traceback.print_stack()
260
225
            self._lock_mode = 'w'
261
226
            self._lock_count = 1
262
227
            self._set_transaction(transactions.WriteTransaction())
263
 
            self._token_from_lock = token_from_lock
264
 
            return token_from_lock
265
228
 
266
229
    def lock_read(self):
 
230
        # mutter("lock read: %s (%s)", self, self._lock_count)
267
231
        if self._lock_mode:
268
 
            if self._lock_mode not in ('r', 'w'):
269
 
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
 
232
            assert self._lock_mode in ('r', 'w'), \
 
233
                   "invalid lock mode %r" % self._lock_mode
270
234
            self._lock_count += 1
271
235
        else:
272
236
            self._lock.lock_read()
 
237
            #note('read locking %s', self)
273
238
            #traceback.print_stack()
274
239
            self._lock_mode = 'r'
275
240
            self._lock_count = 1
278
243
            self.get_transaction().set_cache_size(5000)
279
244
                        
280
245
    def unlock(self):
 
246
        # mutter("unlock: %s (%s)", self, self._lock_count)
281
247
        if not self._lock_mode:
282
248
            raise errors.LockNotHeld(self)
283
249
        if self._lock_count > 1:
284
250
            self._lock_count -= 1
285
251
        else:
 
252
            #note('unlocking %s', self)
286
253
            #traceback.print_stack()
287
254
            self._finish_transaction()
288
255
            try:
354
321
    def break_lock(self):
355
322
        raise NotImplementedError(self.break_lock)
356
323
 
357
 
    def leave_in_place(self):
358
 
        raise NotImplementedError(self.leave_in_place)
359
 
 
360
 
    def dont_leave_in_place(self):
361
 
        raise NotImplementedError(self.dont_leave_in_place)
362
 
 
363
 
    def lock_write(self, token=None):
364
 
        if token is not None:
365
 
            raise errors.TokenLockingNotSupported(self)
 
324
    def lock_write(self):
366
325
        self._lock = self._transport.lock_write(self._escaped_name)
367
326
 
368
327
    def lock_read(self):
378
337
    def create(self, mode=None):
379
338
        """Create lock mechanism"""
380
339
        # for old-style locks, create the file now
381
 
        self._transport.put_bytes(self._escaped_name, '',
 
340
        self._transport.put(self._escaped_name, StringIO(), 
382
341
                            mode=self._file_modebits)
383
 
 
384
 
    def validate_token(self, token):
385
 
        if token is not None:
386
 
            raise errors.TokenLockingNotSupported(self)
387