/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: Martin Pool
  • Date: 2006-10-06 02:04:17 UTC
  • mfrom: (1908.10.1 bench_usecases.merge2)
  • mto: This revision was merged to the branch mainline in revision 2068.
  • Revision ID: mbp@sourcefrog.net-20061006020417-4949ca86f4417a4d
merge additional fix from cfbolz

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
1
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
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
19
19
#import traceback
20
20
 
21
21
import bzrlib
22
 
from bzrlib.decorators import *
 
22
from bzrlib.decorators import (needs_read_lock,
 
23
        needs_write_lock)
23
24
import bzrlib.errors as errors
24
 
from bzrlib.errors import LockError, ReadOnlyError
 
25
from bzrlib.errors import BzrError
25
26
from bzrlib.osutils import file_iterator, safe_unicode
26
 
from bzrlib.symbol_versioning import *
 
27
from bzrlib.symbol_versioning import (deprecated_method, 
 
28
        zero_eight)
27
29
from bzrlib.trace import mutter, note
28
30
import bzrlib.transactions as transactions
 
31
import bzrlib.urlutils as urlutils
 
32
 
29
33
 
30
34
# XXX: The tracking here of lock counts and whether the lock is held is
31
35
# somewhat redundant with what's done in LockDir; the main difference is that
73
77
        :param lock_class: Class of lock strategy to use: typically
74
78
            either LockDir or TransportLock.
75
79
        """
76
 
        object.__init__(self)
77
80
        self._transport = transport
78
81
        self.lock_name = lock_name
79
82
        self._transaction = None
80
 
        self._find_modes()
81
83
        self._lock_mode = None
82
84
        self._lock_count = 0
 
85
        self._find_modes()
83
86
        esc_name = self._escape(lock_name)
84
87
        self._lock = lock_class(transport, esc_name,
85
88
                                file_modebits=self._file_mode,
91
94
        This should normally be called only when the LockableFiles directory
92
95
        is first created on disk.
93
96
        """
94
 
        self._lock.create()
 
97
        self._lock.create(mode=self._dir_mode)
95
98
 
96
99
    def __repr__(self):
97
100
        return '%s(%r)' % (self.__class__.__name__,
107
110
            warn("file group %r was not explicitly unlocked" % self)
108
111
            self._lock.unlock()
109
112
 
 
113
    def break_lock(self):
 
114
        """Break the lock of this lockable files group if it is held.
 
115
 
 
116
        The current ui factory will be used to prompt for user conformation.
 
117
        """
 
118
        self._lock.break_lock()
 
119
 
110
120
    def _escape(self, file_or_path):
111
121
        if not isinstance(file_or_path, basestring):
112
122
            file_or_path = '/'.join(file_or_path)
113
123
        if file_or_path == '':
114
124
            return u''
115
 
        return bzrlib.transport.urlescape(safe_unicode(file_or_path))
 
125
        return urlutils.escape(safe_unicode(file_or_path))
116
126
 
117
127
    def _find_modes(self):
118
128
        """Determine the appropriate modes for files and directories."""
183
193
                     directory
184
194
        :param f: A file-like or string object whose contents should be copied.
185
195
        """
186
 
        self._transport.put(self._escape(path), file, mode=self._file_mode)
 
196
        self._transport.put_file(self._escape(path), file, mode=self._file_mode)
187
197
 
188
198
    @needs_write_lock
189
199
    def put_utf8(self, path, a_string):
208
218
        # and potentially a remote locking protocol
209
219
        if self._lock_mode:
210
220
            if self._lock_mode != 'w' or not self.get_transaction().writeable():
211
 
                raise ReadOnlyError(self)
 
221
                raise errors.ReadOnlyError(self)
212
222
            self._lock_count += 1
213
223
        else:
214
224
            self._lock.lock_write()
244
254
            #note('unlocking %s', self)
245
255
            #traceback.print_stack()
246
256
            self._finish_transaction()
247
 
            self._lock.unlock()
248
 
            self._lock_mode = self._lock_count = None
 
257
            try:
 
258
                self._lock.unlock()
 
259
            finally:
 
260
                self._lock_mode = self._lock_count = None
249
261
 
250
262
    def is_locked(self):
251
263
        """Return true if this LockableFiles group is locked"""
252
264
        return self._lock_count >= 1
253
265
 
 
266
    def get_physical_lock_status(self):
 
267
        """Return physical lock status.
 
268
        
 
269
        Returns true if a lock is held on the transport. If no lock is held, or
 
270
        the underlying locking mechanism does not support querying lock
 
271
        status, false is returned.
 
272
        """
 
273
        try:
 
274
            return self._lock.peek() is not None
 
275
        except NotImplementedError:
 
276
            return False
 
277
 
254
278
    def get_transaction(self):
255
279
        """Return the current active transaction.
256
280
 
296
320
        self._file_modebits = file_modebits
297
321
        self._dir_modebits = dir_modebits
298
322
 
 
323
    def break_lock(self):
 
324
        raise NotImplementedError(self.break_lock)
 
325
 
299
326
    def lock_write(self):
300
327
        self._lock = self._transport.lock_write(self._escaped_name)
301
328
 
306
333
        self._lock.unlock()
307
334
        self._lock = None
308
335
 
309
 
    def create(self):
 
336
    def peek(self):
 
337
        raise NotImplementedError()
 
338
 
 
339
    def create(self, mode=None):
310
340
        """Create lock mechanism"""
311
341
        # for old-style locks, create the file now
312
 
        self._transport.put(self._escaped_name, StringIO(), 
 
342
        self._transport.put_bytes(self._escaped_name, '',
313
343
                            mode=self._file_modebits)