/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: Robert Collins
  • Date: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 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
16
 
 
17
 
from .lazy_import import lazy_import
18
 
lazy_import(globals(), """
19
 
from breezy import (
20
 
    counted_lock,
21
 
    lock,
22
 
    transactions,
23
 
    urlutils,
24
 
    )
25
 
""")
26
 
 
27
 
from . import (
28
 
    errors,
29
 
    )
30
 
from .decorators import (
31
 
    only_raises,
32
 
    )
33
 
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
from cStringIO import StringIO
 
18
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
 
32
 
 
33
 
 
34
# XXX: The tracking here of lock counts and whether the lock is held is
 
35
# somewhat redundant with what's done in LockDir; the main difference is that
 
36
# LockableFiles permits reentrancy.
34
37
 
35
38
class LockableFiles(object):
36
39
    """Object representing a set of related files locked within the same scope.
37
40
 
38
 
    This coordinates access to the lock along with providing a transaction.
 
41
    These files are used by a WorkingTree, Repository or Branch, and should
 
42
    generally only be touched by that object.
 
43
 
 
44
    LockableFiles also provides some policy on top of Transport for encoding
 
45
    control files as utf-8.
39
46
 
40
47
    LockableFiles manage a lock count and can be locked repeatedly by
41
48
    a single caller.  (The underlying lock implementation generally does not
42
49
    support this.)
43
50
 
44
51
    Instances of this class are often called control_files.
45
 
 
46
 
    This class is now deprecated; code should move to using the Transport
47
 
    directly for file operations and using the lock or CountedLock for
48
 
    locking.
49
 
 
50
 
    :ivar _lock: The real underlying lock (e.g. a LockDir)
51
 
    :ivar _lock_count: If _lock_mode is true, a positive count of the number
52
 
        of times the lock has been taken (and not yet released) *by this
53
 
        process*, through this particular object instance.
54
 
    :ivar _lock_mode: None, or 'r' or 'w'
 
52
    
 
53
    This object builds on top of a Transport, which is used to actually write
 
54
    the files to disk, and an OSLock or LockDir, which controls how access to
 
55
    the files is controlled.  The particular type of locking used is set when
 
56
    the object is constructed.  In older formats OSLocks are used everywhere.
 
57
    in newer formats a LockDir is used for Repositories and Branches, and 
 
58
    OSLocks for the local filesystem.
55
59
    """
56
60
 
 
61
    # _lock_mode: None, or 'r' or 'w'
 
62
 
 
63
    # _lock_count: If _lock_mode is true, a positive count of the number of
 
64
    # times the lock has been taken *by this process*.   
 
65
    
 
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
 
57
71
    def __init__(self, transport, lock_name, lock_class):
58
72
        """Create a LockableFiles group
59
73
 
60
 
        :param transport: Transport pointing to the directory holding the
 
74
        :param transport: Transport pointing to the directory holding the 
61
75
            control files and lock.
62
76
        :param lock_name: Name of the lock guarding these files.
63
77
        :param lock_class: Class of lock strategy to use: typically
73
87
        self._lock = lock_class(transport, esc_name,
74
88
                                file_modebits=self._file_mode,
75
89
                                dir_modebits=self._dir_mode)
76
 
        self._counted_lock = counted_lock.CountedLock(self._lock)
77
90
 
78
91
    def create_lock(self):
79
92
        """Create the lock.
86
99
    def __repr__(self):
87
100
        return '%s(%r)' % (self.__class__.__name__,
88
101
                           self._transport)
89
 
 
90
102
    def __str__(self):
91
103
        return 'LockableFiles(%s, %s)' % (self.lock_name, self._transport.base)
92
104
 
 
105
    def __del__(self):
 
106
        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()
 
112
 
93
113
    def break_lock(self):
94
114
        """Break the lock of this lockable files group if it is held.
95
115
 
98
118
        self._lock.break_lock()
99
119
 
100
120
    def _escape(self, file_or_path):
101
 
        """DEPRECATED: Do not use outside this class"""
 
121
        if not isinstance(file_or_path, basestring):
 
122
            file_or_path = '/'.join(file_or_path)
102
123
        if file_or_path == '':
103
124
            return u''
104
 
        return urlutils.escape(file_or_path)
 
125
        return urlutils.escape(safe_unicode(file_or_path))
105
126
 
106
127
    def _find_modes(self):
107
 
        """Determine the appropriate modes for files and directories.
108
 
 
109
 
        :deprecated: Replaced by BzrDir._find_creation_modes.
110
 
        """
111
 
        # XXX: The properties created by this can be removed or deprecated
112
 
        # once all the _get_text_store methods etc no longer use them.
113
 
        # -- mbp 20080512
 
128
        """Determine the appropriate modes for files and directories."""
114
129
        try:
115
130
            st = self._transport.stat('.')
116
131
        except errors.TransportNotPossible:
117
 
            self._dir_mode = 0o755
118
 
            self._file_mode = 0o644
 
132
            self._dir_mode = 0755
 
133
            self._file_mode = 0644
119
134
        else:
120
 
            # Check the directory mode, but also make sure the created
121
 
            # directories and files are read-write for this user. This is
122
 
            # mostly a workaround for filesystems which lie about being able to
123
 
            # write to a directory (cygwin & win32)
124
 
            self._dir_mode = (st.st_mode & 0o7777) | 0o0700
 
135
            self._dir_mode = st.st_mode & 07777
125
136
            # Remove the sticky and execute bits for files
126
 
            self._file_mode = self._dir_mode & ~0o7111
 
137
            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
 
 
143
    def controlfilename(self, file_or_path):
 
144
        """Return location relative to branch."""
 
145
        return self._transport.abspath(self._escape(file_or_path))
 
146
 
 
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
    @needs_read_lock
 
176
    def get(self, relpath):
 
177
        """Get a file as a bytestream."""
 
178
        relpath = self._escape(relpath)
 
179
        return self._transport.get(relpath)
 
180
 
 
181
    @needs_read_lock
 
182
    def get_utf8(self, relpath):
 
183
        """Get a file as a unicode stream."""
 
184
        relpath = self._escape(relpath)
 
185
        # DO NOT introduce an errors=replace here.
 
186
        return codecs.getreader('utf-8')(self._transport.get(relpath))
 
187
 
 
188
    @needs_write_lock
 
189
    def put(self, path, file):
 
190
        """Write a file.
 
191
        
 
192
        :param path: The path to put the file, relative to the .bzr control
 
193
                     directory
 
194
        :param f: A file-like or string object whose contents should be copied.
 
195
        """
 
196
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
 
197
 
 
198
    @needs_write_lock
 
199
    def put_bytes(self, path, a_string):
 
200
        """Write a string of bytes.
 
201
 
 
202
        :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.
 
204
        """
 
205
        self._transport.put_bytes(self._escape(path), a_string,
 
206
                                  mode=self._file_mode)
 
207
 
 
208
    @needs_write_lock
 
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
        # IterableFile would not be needed if Transport.put took iterables
 
216
        # instead of files.  ADHB 2005-12-25
 
217
        # RBC 20060103 surely its not needed anyway, with codecs transcode
 
218
        # file support ?
 
219
        # JAM 20060103 We definitely don't want encode(..., 'replace')
 
220
        # these are valuable files which should have exact contents.
 
221
        if not isinstance(a_string, basestring):
 
222
            raise errors.BzrBadParameterNotString(a_string)
 
223
        self.put_bytes(path, a_string.encode('utf-8'))
127
224
 
128
225
    def leave_in_place(self):
129
226
        """Set this LockableFiles to not clear the physical lock on unlock."""
135
232
 
136
233
    def lock_write(self, token=None):
137
234
        """Lock this group of files for writing.
138
 
 
 
235
        
139
236
        :param token: if this is already locked, then lock_write will fail
140
237
            unless the token matches the existing lock.
141
238
        :returns: a token if this instance supports tokens, otherwise None.
148
245
        some other way, and need to synchronise this object's state with that
149
246
        fact.
150
247
        """
 
248
        # mutter("lock write: %s (%s)", self, self._lock_count)
 
249
        # TODO: Upgrade locking to support using a Transport,
 
250
        # and potentially a remote locking protocol
151
251
        if self._lock_mode:
152
 
            if (self._lock_mode != 'w'
153
 
                    or not self.get_transaction().writeable()):
 
252
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
154
253
                raise errors.ReadOnlyError(self)
155
254
            self._lock.validate_token(token)
156
255
            self._lock_count += 1
157
256
            return self._token_from_lock
158
257
        else:
159
258
            token_from_lock = self._lock.lock_write(token=token)
160
 
            # traceback.print_stack()
 
259
            #note('write locking %s', self)
 
260
            #traceback.print_stack()
161
261
            self._lock_mode = 'w'
162
262
            self._lock_count = 1
163
 
            self._set_write_transaction()
 
263
            self._set_transaction(transactions.WriteTransaction())
164
264
            self._token_from_lock = token_from_lock
165
265
            return token_from_lock
166
266
 
167
267
    def lock_read(self):
 
268
        # mutter("lock read: %s (%s)", self, self._lock_count)
168
269
        if self._lock_mode:
169
 
            if self._lock_mode not in ('r', 'w'):
170
 
                raise ValueError("invalid lock mode %r" % (self._lock_mode,))
 
270
            assert self._lock_mode in ('r', 'w'), \
 
271
                   "invalid lock mode %r" % self._lock_mode
171
272
            self._lock_count += 1
172
273
        else:
173
274
            self._lock.lock_read()
174
 
            # traceback.print_stack()
 
275
            #note('read locking %s', self)
 
276
            #traceback.print_stack()
175
277
            self._lock_mode = 'r'
176
278
            self._lock_count = 1
177
 
            self._set_read_transaction()
178
 
 
179
 
    def _set_read_transaction(self):
180
 
        """Setup a read transaction."""
181
 
        self._set_transaction(transactions.ReadOnlyTransaction())
182
 
        # 5K may be excessive, but hey, its a knob.
183
 
        self.get_transaction().set_cache_size(5000)
184
 
 
185
 
    def _set_write_transaction(self):
186
 
        """Setup a write transaction."""
187
 
        self._set_transaction(transactions.WriteTransaction())
188
 
 
189
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
 
279
            self._set_transaction(transactions.ReadOnlyTransaction())
 
280
            # 5K may be excessive, but hey, its a knob.
 
281
            self.get_transaction().set_cache_size(5000)
 
282
                        
190
283
    def unlock(self):
 
284
        # mutter("unlock: %s (%s)", self, self._lock_count)
191
285
        if not self._lock_mode:
192
 
            return lock.cant_unlock_not_held(self)
 
286
            raise errors.LockNotHeld(self)
193
287
        if self._lock_count > 1:
194
288
            self._lock_count -= 1
195
289
        else:
196
 
            # traceback.print_stack()
 
290
            #note('unlocking %s', self)
 
291
            #traceback.print_stack()
197
292
            self._finish_transaction()
198
293
            try:
199
294
                self._lock.unlock()
200
295
            finally:
201
 
                self._lock_count = 0
202
 
                self._lock_mode = None
 
296
                self._lock_mode = self._lock_count = None
203
297
 
204
298
    def is_locked(self):
205
299
        """Return true if this LockableFiles group is locked"""
207
301
 
208
302
    def get_physical_lock_status(self):
209
303
        """Return physical lock status.
210
 
 
 
304
        
211
305
        Returns true if a lock is held on the transport. If no lock is held, or
212
306
        the underlying locking mechanism does not support querying lock
213
307
        status, false is returned.
256
350
    This is suitable for use only in WorkingTrees (which are at present
257
351
    always local).
258
352
    """
259
 
 
260
353
    def __init__(self, transport, escaped_name, file_modebits, dir_modebits):
261
354
        self._transport = transport
262
355
        self._escaped_name = escaped_name
290
383
    def create(self, mode=None):
291
384
        """Create lock mechanism"""
292
385
        # for old-style locks, create the file now
293
 
        self._transport.put_bytes(self._escaped_name, b'',
294
 
                                  mode=self._file_modebits)
 
386
        self._transport.put_bytes(self._escaped_name, '',
 
387
                            mode=self._file_modebits)
295
388
 
296
389
    def validate_token(self, token):
297
390
        if token is not None:
298
391
            raise errors.TokenLockingNotSupported(self)
 
392