/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/lockdir.py

  • Committer: Martin Pool
  • Date: 2009-12-08 09:17:34 UTC
  • mto: This revision was merged to the branch mainline in revision 4880.
  • Revision ID: mbp@sourcefrog.net-20091208091734-1ktawydv0whimork
TextUIOutputStream must have an .encoding

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockdir.py
1
 
# Copyright (C) 2006 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2006, 2007, 2008 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
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""On-disk mutex protecting a resource
18
18
 
21
21
internal locks (such as flock etc) because they can be seen across all
22
22
transports, including http.
23
23
 
24
 
Objects can be read if there is only physical read access; therefore 
 
24
Objects can be read if there is only physical read access; therefore
25
25
readers can never be required to create a lock, though they will
26
26
check whether a writer is using the lock.  Writers can't detect
27
27
whether anyone else is reading from the resource as they write.
56
56
 
57
57
The desired characteristics are:
58
58
 
59
 
* Locks are not reentrant.  (That is, a client that tries to take a 
 
59
* Locks are not reentrant.  (That is, a client that tries to take a
60
60
  lock it already holds may deadlock or fail.)
61
61
* Stale locks can be guessed at by a heuristic
62
62
* Lost locks can be broken by any client
78
78
and deadlocks will likely occur if the locks are aliased.
79
79
 
80
80
In the future we may add a "freshen" method which can be called
81
 
by a lock holder to check that their lock has not been broken, and to 
 
81
by a lock holder to check that their lock has not been broken, and to
82
82
update the timestamp within it.
83
83
 
84
84
Example usage:
88
88
>>> t = MemoryTransport()
89
89
>>> l = LockDir(t, 'sample-lock')
90
90
>>> l.create()
91
 
>>> l.wait_lock()
 
91
>>> token = l.wait_lock()
92
92
>>> # do something here
93
93
>>> l.unlock()
94
94
 
95
95
"""
96
96
 
 
97
 
 
98
# TODO: We sometimes have the problem that our attempt to rename '1234' to
 
99
# 'held' fails because the transport server moves into an existing directory,
 
100
# rather than failing the rename.  If we made the info file name the same as
 
101
# the locked directory name we would avoid this problem because moving into
 
102
# the held directory would implicitly clash.  However this would not mesh with
 
103
# the existing locking code and needs a new format of the containing object.
 
104
# -- robertc, mbp 20070628
 
105
 
97
106
import os
98
107
import time
99
 
from warnings import warn
100
 
from StringIO import StringIO
101
108
 
 
109
from bzrlib import (
 
110
    debug,
 
111
    errors,
 
112
    lock,
 
113
    )
102
114
import bzrlib.config
 
115
from bzrlib.decorators import only_raises
103
116
from bzrlib.errors import (
104
117
        DirectoryNotEmpty,
105
118
        FileExists,
106
119
        LockBreakMismatch,
107
120
        LockBroken,
108
121
        LockContention,
109
 
        LockError,
 
122
        LockFailed,
110
123
        LockNotHeld,
111
124
        NoSuchFile,
 
125
        PathError,
112
126
        ResourceBusy,
113
 
        UnlockableTransport,
 
127
        TransportError,
114
128
        )
115
 
from bzrlib.transport import Transport
116
 
from bzrlib.osutils import rand_chars
117
 
from bzrlib.rio import RioWriter, read_stanza, Stanza
 
129
from bzrlib.trace import mutter, note
 
130
from bzrlib.osutils import format_delta, rand_chars, get_host_name
 
131
import bzrlib.ui
 
132
 
 
133
from bzrlib.lazy_import import lazy_import
 
134
lazy_import(globals(), """
 
135
from bzrlib import rio
 
136
""")
118
137
 
119
138
# XXX: At the moment there is no consideration of thread safety on LockDir
120
139
# objects.  This should perhaps be updated - e.g. if two threads try to take a
121
140
# lock at the same time they should *both* get it.  But then that's unlikely
122
141
# to be a good idea.
123
142
 
124
 
# TODO: Transport could offer a simpler put() method that avoids the
125
 
# rename-into-place for cases like creating the lock template, where there is
126
 
# no chance that the file already exists.
127
 
 
128
143
# TODO: Perhaps store some kind of note like the bzr command line in the lock
129
144
# info?
130
145
 
134
149
# TODO: Make sure to pass the right file and directory mode bits to all
135
150
# files/dirs created.
136
151
 
 
152
 
137
153
_DEFAULT_TIMEOUT_SECONDS = 300
138
 
_DEFAULT_POLL_SECONDS = 0.5
139
 
 
140
 
class LockDir(object):
141
 
    """Write-lock guarding access to data."""
 
154
_DEFAULT_POLL_SECONDS = 1.0
 
155
 
 
156
 
 
157
class LockDir(lock.Lock):
 
158
    """Write-lock guarding access to data.
 
159
    """
142
160
 
143
161
    __INFO_NAME = '/info'
144
162
 
149
167
 
150
168
        :param transport: Transport which will contain the lock
151
169
 
152
 
        :param path: Path to the lock within the base directory of the 
 
170
        :param path: Path to the lock within the base directory of the
153
171
            transport.
154
172
        """
155
 
        assert isinstance(transport, Transport), \
156
 
            ("not a transport: %r" % transport)
157
173
        self.transport = transport
158
174
        self.path = path
159
175
        self._lock_held = False
 
176
        self._locked_via_token = False
160
177
        self._fake_read_lock = False
161
178
        self._held_dir = path + '/held'
162
179
        self._held_info_path = self._held_dir + self.__INFO_NAME
163
180
        self._file_modebits = file_modebits
164
181
        self._dir_modebits = dir_modebits
165
 
        self.nonce = rand_chars(20)
 
182
 
 
183
        self._report_function = note
166
184
 
167
185
    def __repr__(self):
168
186
        return '%s(%s%s)' % (self.__class__.__name__,
171
189
 
172
190
    is_held = property(lambda self: self._lock_held)
173
191
 
174
 
    def create(self):
 
192
    def create(self, mode=None):
175
193
        """Create the on-disk lock.
176
194
 
177
 
        This is typically only called when the object/directory containing the 
 
195
        This is typically only called when the object/directory containing the
178
196
        directory is first created.  The lock is not held when it's created.
179
197
        """
180
 
        if self.transport.is_readonly():
181
 
            raise UnlockableTransport(self.transport)
182
 
        self.transport.mkdir(self.path)
183
 
 
184
 
    def attempt_lock(self):
185
 
        """Take the lock; fail if it's already held.
186
 
        
187
 
        If you wish to block until the lock can be obtained, call wait_lock()
188
 
        instead.
 
198
        self._trace("create lock directory")
 
199
        try:
 
200
            self.transport.mkdir(self.path, mode=mode)
 
201
        except (TransportError, PathError), e:
 
202
            raise LockFailed(self, e)
 
203
 
 
204
 
 
205
    def _attempt_lock(self):
 
206
        """Make the pending directory and attempt to rename into place.
 
207
 
 
208
        If the rename succeeds, we read back the info file to check that we
 
209
        really got the lock.
 
210
 
 
211
        If we fail to acquire the lock, this method is responsible for
 
212
        cleaning up the pending directory if possible.  (But it doesn't do
 
213
        that yet.)
 
214
 
 
215
        :returns: The nonce of the lock, if it was successfully acquired.
 
216
 
 
217
        :raises LockContention: If the lock is held by someone else.  The exception
 
218
            contains the info of the current holder of the lock.
189
219
        """
190
 
        if self._fake_read_lock:
191
 
            raise LockContention(self)
192
 
        if self.transport.is_readonly():
193
 
            raise UnlockableTransport(self.transport)
194
 
        try:
195
 
            tmpname = '%s/pending.%s.tmp' % (self.path, rand_chars(20))
196
 
            self.transport.mkdir(tmpname)
197
 
            sio = StringIO()
198
 
            self._prepare_info(sio)
199
 
            sio.seek(0)
200
 
            self.transport.put(tmpname + self.__INFO_NAME, sio)
 
220
        self._trace("lock_write...")
 
221
        start_time = time.time()
 
222
        try:
 
223
            tmpname = self._create_pending_dir()
 
224
        except (errors.TransportError, PathError), e:
 
225
            self._trace("... failed to create pending dir, %s", e)
 
226
            raise LockFailed(self, e)
 
227
        try:
201
228
            self.transport.rename(tmpname, self._held_dir)
202
 
            self._lock_held = True
203
 
            self.confirm()
204
 
            return
205
 
        except (DirectoryNotEmpty, FileExists, ResourceBusy), e:
206
 
            pass
207
 
        # fall through to here on contention
208
 
        raise LockContention(self)
209
 
 
 
229
        except (errors.TransportError, PathError, DirectoryNotEmpty,
 
230
                FileExists, ResourceBusy), e:
 
231
            self._trace("... contention, %s", e)
 
232
            self._remove_pending_dir(tmpname)
 
233
            raise LockContention(self)
 
234
        except Exception, e:
 
235
            self._trace("... lock failed, %s", e)
 
236
            self._remove_pending_dir(tmpname)
 
237
            raise
 
238
        # We must check we really got the lock, because Launchpad's sftp
 
239
        # server at one time had a bug were the rename would successfully
 
240
        # move the new directory into the existing directory, which was
 
241
        # incorrect.  It's possible some other servers or filesystems will
 
242
        # have a similar bug allowing someone to think they got the lock
 
243
        # when it's already held.
 
244
        info = self.peek()
 
245
        self._trace("after locking, info=%r", info)
 
246
        if info['nonce'] != self.nonce:
 
247
            self._trace("rename succeeded, "
 
248
                "but lock is still held by someone else")
 
249
            raise LockContention(self)
 
250
        self._lock_held = True
 
251
        self._trace("... lock succeeded after %dms",
 
252
                (time.time() - start_time) * 1000)
 
253
        return self.nonce
 
254
 
 
255
    def _remove_pending_dir(self, tmpname):
 
256
        """Remove the pending directory
 
257
 
 
258
        This is called if we failed to rename into place, so that the pending
 
259
        dirs don't clutter up the lockdir.
 
260
        """
 
261
        self._trace("remove %s", tmpname)
 
262
        try:
 
263
            self.transport.delete(tmpname + self.__INFO_NAME)
 
264
            self.transport.rmdir(tmpname)
 
265
        except PathError, e:
 
266
            note("error removing pending lock: %s", e)
 
267
 
 
268
    def _create_pending_dir(self):
 
269
        tmpname = '%s/%s.tmp' % (self.path, rand_chars(10))
 
270
        try:
 
271
            self.transport.mkdir(tmpname)
 
272
        except NoSuchFile:
 
273
            # This may raise a FileExists exception
 
274
            # which is okay, it will be caught later and determined
 
275
            # to be a LockContention.
 
276
            self._trace("lock directory does not exist, creating it")
 
277
            self.create(mode=self._dir_modebits)
 
278
            # After creating the lock directory, try again
 
279
            self.transport.mkdir(tmpname)
 
280
        self.nonce = rand_chars(20)
 
281
        info_bytes = self._prepare_info()
 
282
        # We use put_file_non_atomic because we just created a new unique
 
283
        # directory so we don't have to worry about files existing there.
 
284
        # We'll rename the whole directory into place to get atomic
 
285
        # properties
 
286
        self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
 
287
                                            info_bytes)
 
288
        return tmpname
 
289
 
 
290
    @only_raises(LockNotHeld, LockBroken)
210
291
    def unlock(self):
211
292
        """Release a held lock
212
293
        """
214
295
            self._fake_read_lock = False
215
296
            return
216
297
        if not self._lock_held:
217
 
            raise LockNotHeld(self)
218
 
        # rename before deleting, because we can't atomically remove the whole
219
 
        # tree
220
 
        tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
221
 
        self.transport.rename(self._held_dir, tmpname)
222
 
        self._lock_held = False
223
 
        self.transport.delete(tmpname + self.__INFO_NAME)
224
 
        self.transport.rmdir(tmpname)
 
298
            return lock.cant_unlock_not_held(self)
 
299
        if self._locked_via_token:
 
300
            self._locked_via_token = False
 
301
            self._lock_held = False
 
302
        else:
 
303
            old_nonce = self.nonce
 
304
            # rename before deleting, because we can't atomically remove the
 
305
            # whole tree
 
306
            start_time = time.time()
 
307
            self._trace("unlocking")
 
308
            tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
 
309
            # gotta own it to unlock
 
310
            self.confirm()
 
311
            self.transport.rename(self._held_dir, tmpname)
 
312
            self._lock_held = False
 
313
            self.transport.delete(tmpname + self.__INFO_NAME)
 
314
            try:
 
315
                self.transport.rmdir(tmpname)
 
316
            except DirectoryNotEmpty, e:
 
317
                # There might have been junk left over by a rename that moved
 
318
                # another locker within the 'held' directory.  do a slower
 
319
                # deletion where we list the directory and remove everything
 
320
                # within it.
 
321
                #
 
322
                # Maybe this should be broader to allow for ftp servers with
 
323
                # non-specific error messages?
 
324
                self._trace("doing recursive deletion of non-empty directory "
 
325
                        "%s", tmpname)
 
326
                self.transport.delete_tree(tmpname)
 
327
            self._trace("... unlock succeeded after %dms",
 
328
                    (time.time() - start_time) * 1000)
 
329
            result = lock.LockResult(self.transport.abspath(self.path),
 
330
                                     old_nonce)
 
331
            for hook in self.hooks['lock_released']:
 
332
                hook(result)
 
333
 
 
334
    def break_lock(self):
 
335
        """Break a lock not held by this instance of LockDir.
 
336
 
 
337
        This is a UI centric function: it uses the bzrlib.ui.ui_factory to
 
338
        prompt for input if a lock is detected and there is any doubt about
 
339
        it possibly being still active.
 
340
        """
 
341
        self._check_not_locked()
 
342
        holder_info = self.peek()
 
343
        if holder_info is not None:
 
344
            lock_info = '\n'.join(self._format_lock_info(holder_info))
 
345
            if bzrlib.ui.ui_factory.get_boolean("Break %s" % lock_info):
 
346
                self.force_break(holder_info)
225
347
 
226
348
    def force_break(self, dead_holder_info):
227
349
        """Release a lock held by another process.
236
358
        LockBreakMismatch is raised.
237
359
 
238
360
        After the lock is broken it will not be held by any process.
239
 
        It is possible that another process may sneak in and take the 
 
361
        It is possible that another process may sneak in and take the
240
362
        lock before the breaking process acquires it.
241
363
        """
242
364
        if not isinstance(dead_holder_info, dict):
243
365
            raise ValueError("dead_holder_info: %r" % dead_holder_info)
244
 
        if self._lock_held:
245
 
            raise AssertionError("can't break own lock: %r" % self)
 
366
        self._check_not_locked()
246
367
        current_info = self.peek()
247
368
        if current_info is None:
248
369
            # must have been recently released
252
373
        tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
253
374
        self.transport.rename(self._held_dir, tmpname)
254
375
        # check that we actually broke the right lock, not someone else;
255
 
        # there's a small race window between checking it and doing the 
 
376
        # there's a small race window between checking it and doing the
256
377
        # rename.
257
378
        broken_info_path = tmpname + self.__INFO_NAME
258
379
        broken_info = self._read_info_file(broken_info_path)
260
381
            raise LockBreakMismatch(self, broken_info, dead_holder_info)
261
382
        self.transport.delete(broken_info_path)
262
383
        self.transport.rmdir(tmpname)
 
384
        result = lock.LockResult(self.transport.abspath(self.path),
 
385
                                 current_info.get('nonce'))
 
386
        for hook in self.hooks['lock_broken']:
 
387
            hook(result)
 
388
 
 
389
    def _check_not_locked(self):
 
390
        """If the lock is held by this instance, raise an error."""
 
391
        if self._lock_held:
 
392
            raise AssertionError("can't break own lock: %r" % self)
263
393
 
264
394
    def confirm(self):
265
395
        """Make sure that the lock is still held by this locker.
268
398
        or if the lock has been affected by a bug.
269
399
 
270
400
        If the lock is not thought to be held, raises LockNotHeld.  If
271
 
        the lock is thought to be held but has been broken, raises 
 
401
        the lock is thought to be held but has been broken, raises
272
402
        LockBroken.
273
403
        """
274
404
        if not self._lock_held:
280
410
        if info.get('nonce') != self.nonce:
281
411
            # there is a lock, but not ours
282
412
            raise LockBroken(self)
283
 
        
 
413
 
284
414
    def _read_info_file(self, path):
285
415
        """Read one given info file.
286
416
 
290
420
 
291
421
    def peek(self):
292
422
        """Check if the lock is held by anyone.
293
 
        
 
423
 
294
424
        If it is held, this returns the lock info structure as a rio Stanza,
295
425
        which contains some information about the current lock holder.
296
426
        Otherwise returns None.
297
427
        """
298
428
        try:
299
429
            info = self._read_info_file(self._held_info_path)
300
 
            assert isinstance(info, dict), \
301
 
                    "bad parse result %r" % info
 
430
            self._trace("peek -> held")
302
431
            return info
303
432
        except NoSuchFile, e:
304
 
            return None
 
433
            self._trace("peek -> not held")
305
434
 
306
 
    def _prepare_info(self, outf):
 
435
    def _prepare_info(self):
307
436
        """Write information about a pending lock to a temporary file.
308
437
        """
309
 
        import socket
310
438
        # XXX: is creating this here inefficient?
311
439
        config = bzrlib.config.GlobalConfig()
312
 
        s = Stanza(hostname=socket.gethostname(),
 
440
        try:
 
441
            user = config.user_email()
 
442
        except errors.NoEmailInUsername:
 
443
            user = config.username()
 
444
        s = rio.Stanza(hostname=get_host_name(),
313
445
                   pid=str(os.getpid()),
314
446
                   start_time=str(int(time.time())),
315
447
                   nonce=self.nonce,
316
 
                   user=config.user_email(),
 
448
                   user=user,
317
449
                   )
318
 
        RioWriter(outf).write_stanza(s)
 
450
        return s.to_string()
319
451
 
320
452
    def _parse_info(self, info_file):
321
 
        return read_stanza(info_file.readlines()).as_dict()
322
 
 
323
 
    def wait_lock(self, timeout=_DEFAULT_TIMEOUT_SECONDS,
324
 
                  poll=_DEFAULT_POLL_SECONDS):
 
453
        return rio.read_stanza(info_file.readlines()).as_dict()
 
454
 
 
455
    def attempt_lock(self):
 
456
        """Take the lock; fail if it's already held.
 
457
 
 
458
        If you wish to block until the lock can be obtained, call wait_lock()
 
459
        instead.
 
460
 
 
461
        :return: The lock token.
 
462
        :raises LockContention: if the lock is held by someone else.
 
463
        """
 
464
        if self._fake_read_lock:
 
465
            raise LockContention(self)
 
466
        result = self._attempt_lock()
 
467
        hook_result = lock.LockResult(self.transport.abspath(self.path),
 
468
                self.nonce)
 
469
        for hook in self.hooks['lock_acquired']:
 
470
            hook(hook_result)
 
471
        return result
 
472
 
 
473
    def wait_lock(self, timeout=None, poll=None, max_attempts=None):
325
474
        """Wait a certain period for a lock.
326
475
 
327
476
        If the lock can be acquired within the bounded time, it
329
478
        is raised.  Either way, this function should return within
330
479
        approximately `timeout` seconds.  (It may be a bit more if
331
480
        a transport operation takes a long time to complete.)
 
481
 
 
482
        :param timeout: Approximate maximum amount of time to wait for the
 
483
        lock, in seconds.
 
484
 
 
485
        :param poll: Delay in seconds between retrying the lock.
 
486
 
 
487
        :param max_attempts: Maximum number of times to try to lock.
 
488
 
 
489
        :return: The lock token.
332
490
        """
333
 
        # XXX: the transport interface doesn't let us guard 
334
 
        # against operations there taking a long time.
 
491
        if timeout is None:
 
492
            timeout = _DEFAULT_TIMEOUT_SECONDS
 
493
        if poll is None:
 
494
            poll = _DEFAULT_POLL_SECONDS
 
495
        # XXX: the transport interface doesn't let us guard against operations
 
496
        # there taking a long time, so the total elapsed time or poll interval
 
497
        # may be more than was requested.
335
498
        deadline = time.time() + timeout
 
499
        deadline_str = None
 
500
        last_info = None
 
501
        attempt_count = 0
336
502
        while True:
 
503
            attempt_count += 1
337
504
            try:
338
 
                self.attempt_lock()
339
 
                return
 
505
                return self.attempt_lock()
340
506
            except LockContention:
 
507
                # possibly report the blockage, then try again
341
508
                pass
 
509
            # TODO: In a few cases, we find out that there's contention by
 
510
            # reading the held info and observing that it's not ours.  In
 
511
            # those cases it's a bit redundant to read it again.  However,
 
512
            # the normal case (??) is that the rename fails and so we
 
513
            # don't know who holds the lock.  For simplicity we peek
 
514
            # always.
 
515
            new_info = self.peek()
 
516
            if new_info is not None and new_info != last_info:
 
517
                if last_info is None:
 
518
                    start = 'Unable to obtain'
 
519
                else:
 
520
                    start = 'Lock owner changed for'
 
521
                last_info = new_info
 
522
                formatted_info = self._format_lock_info(new_info)
 
523
                if deadline_str is None:
 
524
                    deadline_str = time.strftime('%H:%M:%S',
 
525
                                                 time.localtime(deadline))
 
526
                lock_url = self.transport.abspath(self.path)
 
527
                self._report_function('%s %s\n'
 
528
                                      '%s\n' # held by
 
529
                                      '%s\n' # locked ... ago
 
530
                                      'Will continue to try until %s, unless '
 
531
                                      'you press Ctrl-C\n'
 
532
                                      'If you\'re sure that it\'s not being '
 
533
                                      'modified, use bzr break-lock %s',
 
534
                                      start,
 
535
                                      formatted_info[0],
 
536
                                      formatted_info[1],
 
537
                                      formatted_info[2],
 
538
                                      deadline_str,
 
539
                                      lock_url)
 
540
 
 
541
            if (max_attempts is not None) and (attempt_count >= max_attempts):
 
542
                self._trace("exceeded %d attempts")
 
543
                raise LockContention(self)
342
544
            if time.time() + poll < deadline:
 
545
                self._trace("waiting %ss", poll)
343
546
                time.sleep(poll)
344
547
            else:
 
548
                self._trace("timeout after waiting %ss", timeout)
345
549
                raise LockContention(self)
346
550
 
347
 
    def lock_write(self):
348
 
        """Wait for and acquire the lock."""
349
 
        self.attempt_lock()
 
551
    def leave_in_place(self):
 
552
        self._locked_via_token = True
 
553
 
 
554
    def dont_leave_in_place(self):
 
555
        self._locked_via_token = False
 
556
 
 
557
    def lock_write(self, token=None):
 
558
        """Wait for and acquire the lock.
 
559
 
 
560
        :param token: if this is already locked, then lock_write will fail
 
561
            unless the token matches the existing lock.
 
562
        :returns: a token if this instance supports tokens, otherwise None.
 
563
        :raises TokenLockingNotSupported: when a token is given but this
 
564
            instance doesn't support using token locks.
 
565
        :raises MismatchedToken: if the specified token doesn't match the token
 
566
            of the existing lock.
 
567
 
 
568
        A token should be passed in if you know that you have locked the object
 
569
        some other way, and need to synchronise this object's state with that
 
570
        fact.
 
571
 
 
572
        XXX: docstring duplicated from LockableFiles.lock_write.
 
573
        """
 
574
        if token is not None:
 
575
            self.validate_token(token)
 
576
            self.nonce = token
 
577
            self._lock_held = True
 
578
            self._locked_via_token = True
 
579
            return token
 
580
        else:
 
581
            return self.wait_lock()
350
582
 
351
583
    def lock_read(self):
352
 
        """Compatability-mode shared lock.
 
584
        """Compatibility-mode shared lock.
353
585
 
354
 
        LockDir doesn't support shared read-only locks, so this 
 
586
        LockDir doesn't support shared read-only locks, so this
355
587
        just pretends that the lock is taken but really does nothing.
356
588
        """
357
 
        # At the moment Branches are commonly locked for read, but 
 
589
        # At the moment Branches are commonly locked for read, but
358
590
        # we can't rely on that remotely.  Once this is cleaned up,
359
 
        # reenable this warning to prevent it coming back in 
 
591
        # reenable this warning to prevent it coming back in
360
592
        # -- mbp 20060303
361
593
        ## warn("LockDir.lock_read falls back to write lock")
362
594
        if self._lock_held or self._fake_read_lock:
363
595
            raise LockContention(self)
364
596
        self._fake_read_lock = True
365
597
 
366
 
    def wait(self, timeout=20, poll=0.5):
367
 
        """Wait a certain period for a lock to be released."""
368
 
        # XXX: the transport interface doesn't let us guard 
369
 
        # against operations there taking a long time.
370
 
        deadline = time.time() + timeout
371
 
        while True:
372
 
            if self.peek():
373
 
                return
374
 
            if time.time() + poll < deadline:
375
 
                time.sleep(poll)
376
 
            else:
377
 
                raise LockContention(self)
378
 
 
 
598
    def _format_lock_info(self, info):
 
599
        """Turn the contents of peek() into something for the user"""
 
600
        lock_url = self.transport.abspath(self.path)
 
601
        delta = time.time() - int(info['start_time'])
 
602
        return [
 
603
            'lock %s' % (lock_url,),
 
604
            'held by %(user)s on host %(hostname)s [process #%(pid)s]' % info,
 
605
            'locked %s' % (format_delta(delta),),
 
606
            ]
 
607
 
 
608
    def validate_token(self, token):
 
609
        if token is not None:
 
610
            info = self.peek()
 
611
            if info is None:
 
612
                # Lock isn't held
 
613
                lock_token = None
 
614
            else:
 
615
                lock_token = info.get('nonce')
 
616
            if token != lock_token:
 
617
                raise errors.TokenMismatch(token, lock_token)
 
618
            else:
 
619
                self._trace("revalidated by token %r", token)
 
620
 
 
621
    def _trace(self, format, *args):
 
622
        if 'lock' not in debug.debug_flags:
 
623
            return
 
624
        mutter(str(self) + ": " + (format % args))