/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: John Arbash Meinel
  • Date: 2011-04-22 14:12:22 UTC
  • mfrom: (5809 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5836.
  • Revision ID: john@arbash-meinel.com-20110422141222-nx2j0hbkihcb8j16
Merge newer bzr.dev and resolve conflicts.
Try to write some documentation about how the _dirblock_state works.
Fix up the tests so that they pass again.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockdir.py
83
83
 
84
84
Example usage:
85
85
 
86
 
>>> from breezy.transport.memory import MemoryTransport
 
86
>>> from bzrlib.transport.memory import MemoryTransport
87
87
>>> # typically will be obtained from a BzrDir, Branch, etc
88
88
>>> t = MemoryTransport()
89
89
>>> l = LockDir(t, 'sample-lock')
92
92
>>> # do something here
93
93
>>> l.unlock()
94
94
 
95
 
Some classes of stale locks can be predicted by checking: the host name is the
96
 
same as the local host name; the user name is the same as the local user; the
97
 
process id no longer exists.  The check on user name is not strictly necessary
98
 
but helps protect against colliding host names.
99
95
"""
100
96
 
101
97
 
110
106
import os
111
107
import time
112
108
 
113
 
from . import (
114
 
    config,
 
109
from bzrlib import (
115
110
    debug,
116
111
    errors,
117
112
    lock,
118
113
    osutils,
119
 
    rio,
120
 
    ui,
121
 
    urlutils,
122
 
    )
123
 
from .decorators import only_raises
124
 
from .errors import (
125
 
    DirectoryNotEmpty,
126
 
    FileExists,
127
 
    LockBreakMismatch,
128
 
    LockBroken,
129
 
    LockContention,
130
 
    LockCorrupt,
131
 
    LockFailed,
132
 
    LockNotHeld,
133
 
    NoSuchFile,
134
 
    PathError,
135
 
    ResourceBusy,
136
 
    TransportError,
137
 
    )
138
 
from .i18n import gettext
139
 
from .osutils import format_delta, rand_chars, get_host_name
140
 
from .trace import mutter, note
 
114
    )
 
115
import bzrlib.config
 
116
from bzrlib.decorators import only_raises
 
117
from bzrlib.errors import (
 
118
        DirectoryNotEmpty,
 
119
        FileExists,
 
120
        LockBreakMismatch,
 
121
        LockBroken,
 
122
        LockContention,
 
123
        LockCorrupt,
 
124
        LockFailed,
 
125
        LockNotHeld,
 
126
        NoSuchFile,
 
127
        PathError,
 
128
        ResourceBusy,
 
129
        TransportError,
 
130
        )
 
131
from bzrlib.trace import mutter, note
 
132
from bzrlib.osutils import format_delta, rand_chars, get_host_name
 
133
import bzrlib.ui
141
134
 
 
135
from bzrlib.lazy_import import lazy_import
 
136
lazy_import(globals(), """
 
137
from bzrlib import rio
 
138
""")
142
139
 
143
140
# XXX: At the moment there is no consideration of thread safety on LockDir
144
141
# objects.  This should perhaps be updated - e.g. if two threads try to take a
165
162
 
166
163
    __INFO_NAME = '/info'
167
164
 
168
 
    def __init__(self, transport, path, file_modebits=0o644,
169
 
                 dir_modebits=0o755, extra_holder_info=None):
 
165
    def __init__(self, transport, path, file_modebits=0644, dir_modebits=0755):
170
166
        """Create a new LockDir object.
171
167
 
172
168
        The LockDir is initially unlocked - this just creates the object.
175
171
 
176
172
        :param path: Path to the lock within the base directory of the
177
173
            transport.
178
 
 
179
 
        :param extra_holder_info: If passed, {str:str} dict of extra or
180
 
            updated information to insert into the info file when the lock is
181
 
            taken.
182
174
        """
183
175
        self.transport = transport
184
176
        self.path = path
189
181
        self._held_info_path = self._held_dir + self.__INFO_NAME
190
182
        self._file_modebits = file_modebits
191
183
        self._dir_modebits = dir_modebits
 
184
 
192
185
        self._report_function = note
193
 
        self.extra_holder_info = extra_holder_info
194
 
        self._warned_about_lock_holder = None
195
186
 
196
187
    def __repr__(self):
197
188
        return '%s(%s%s)' % (self.__class__.__name__,
209
200
        self._trace("create lock directory")
210
201
        try:
211
202
            self.transport.mkdir(self.path, mode=mode)
212
 
        except (TransportError, PathError) as e:
 
203
        except (TransportError, PathError), e:
213
204
            raise LockFailed(self, e)
214
205
 
 
206
 
215
207
    def _attempt_lock(self):
216
208
        """Make the pending directory and attempt to rename into place.
217
209
 
224
216
 
225
217
        :returns: The nonce of the lock, if it was successfully acquired.
226
218
 
227
 
        :raises LockContention: If the lock is held by someone else.  The
228
 
            exception contains the info of the current holder of the lock.
 
219
        :raises LockContention: If the lock is held by someone else.  The exception
 
220
            contains the info of the current holder of the lock.
229
221
        """
230
222
        self._trace("lock_write...")
231
223
        start_time = time.time()
232
224
        try:
233
225
            tmpname = self._create_pending_dir()
234
 
        except (errors.TransportError, PathError) as e:
 
226
        except (errors.TransportError, PathError), e:
235
227
            self._trace("... failed to create pending dir, %s", e)
236
228
            raise LockFailed(self, e)
237
 
        while True:
238
 
            try:
239
 
                self.transport.rename(tmpname, self._held_dir)
240
 
                break
241
 
            except (errors.TransportError, PathError, DirectoryNotEmpty,
242
 
                    FileExists, ResourceBusy) as e:
243
 
                self._trace("... contention, %s", e)
244
 
                other_holder = self.peek()
245
 
                self._trace("other holder is %r" % other_holder)
246
 
                try:
247
 
                    self._handle_lock_contention(other_holder)
248
 
                except BaseException:
249
 
                    self._remove_pending_dir(tmpname)
250
 
                    raise
251
 
            except Exception as e:
252
 
                self._trace("... lock failed, %s", e)
253
 
                self._remove_pending_dir(tmpname)
254
 
                raise
 
229
        try:
 
230
            self.transport.rename(tmpname, self._held_dir)
 
231
        except (errors.TransportError, PathError, DirectoryNotEmpty,
 
232
                FileExists, ResourceBusy), e:
 
233
            self._trace("... contention, %s", e)
 
234
            self._remove_pending_dir(tmpname)
 
235
            raise LockContention(self)
 
236
        except Exception, e:
 
237
            self._trace("... lock failed, %s", e)
 
238
            self._remove_pending_dir(tmpname)
 
239
            raise
255
240
        # We must check we really got the lock, because Launchpad's sftp
256
241
        # server at one time had a bug were the rename would successfully
257
242
        # move the new directory into the existing directory, which was
267
252
        self._trace("after locking, info=%r", info)
268
253
        if info is None:
269
254
            raise LockFailed(self, "lock was renamed into place, but "
270
 
                             "now is missing!")
 
255
                "now is missing!")
271
256
        if info.get('nonce') != self.nonce:
272
257
            self._trace("rename succeeded, "
273
 
                        "but lock is still held by someone else")
 
258
                "but lock is still held by someone else")
274
259
            raise LockContention(self)
275
260
        self._lock_held = True
276
261
        self._trace("... lock succeeded after %dms",
277
 
                    (time.time() - start_time) * 1000)
 
262
                (time.time() - start_time) * 1000)
278
263
        return self.nonce
279
264
 
280
 
    def _handle_lock_contention(self, other_holder):
281
 
        """A lock we want to take is held by someone else.
282
 
 
283
 
        This function can: tell the user about it; possibly detect that it's
284
 
        safe or appropriate to steal the lock, or just raise an exception.
285
 
 
286
 
        If this function returns (without raising an exception) the lock will
287
 
        be attempted again.
288
 
 
289
 
        :param other_holder: A LockHeldInfo for the current holder; note that
290
 
            it might be None if the lock can be seen to be held but the info
291
 
            can't be read.
292
 
        """
293
 
        if (other_holder is not None):
294
 
            if other_holder.is_lock_holder_known_dead():
295
 
                if self.get_config().get('locks.steal_dead'):
296
 
                    ui.ui_factory.show_user_warning(
297
 
                        'locks_steal_dead',
298
 
                        lock_url=urlutils.join(self.transport.base, self.path),
299
 
                        other_holder_info=str(other_holder))
300
 
                    self.force_break(other_holder)
301
 
                    self._trace("stole lock from dead holder")
302
 
                    return
303
 
        raise LockContention(self)
304
 
 
305
265
    def _remove_pending_dir(self, tmpname):
306
266
        """Remove the pending directory
307
267
 
312
272
        try:
313
273
            self.transport.delete(tmpname + self.__INFO_NAME)
314
274
            self.transport.rmdir(tmpname)
315
 
        except PathError as e:
316
 
            note(gettext("error removing pending lock: %s"), e)
 
275
        except PathError, e:
 
276
            note("error removing pending lock: %s", e)
317
277
 
318
278
    def _create_pending_dir(self):
319
279
        tmpname = '%s/%s.tmp' % (self.path, rand_chars(10))
327
287
            self.create(mode=self._dir_modebits)
328
288
            # After creating the lock directory, try again
329
289
            self.transport.mkdir(tmpname)
330
 
        info = LockHeldInfo.for_this_process(self.extra_holder_info)
331
 
        self.nonce = info.get('nonce')
 
290
        self.nonce = rand_chars(20)
 
291
        info_bytes = self._prepare_info()
332
292
        # We use put_file_non_atomic because we just created a new unique
333
293
        # directory so we don't have to worry about files existing there.
334
294
        # We'll rename the whole directory into place to get atomic
335
295
        # properties
336
296
        self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
337
 
                                            info.to_bytes())
 
297
                                            info_bytes)
338
298
        return tmpname
339
299
 
340
300
    @only_raises(LockNotHeld, LockBroken)
363
323
            self.transport.delete(tmpname + self.__INFO_NAME)
364
324
            try:
365
325
                self.transport.rmdir(tmpname)
366
 
            except DirectoryNotEmpty:
 
326
            except DirectoryNotEmpty, e:
367
327
                # There might have been junk left over by a rename that moved
368
328
                # another locker within the 'held' directory.  do a slower
369
329
                # deletion where we list the directory and remove everything
370
330
                # within it.
 
331
                #
 
332
                # Maybe this should be broader to allow for ftp servers with
 
333
                # non-specific error messages?
371
334
                self._trace("doing recursive deletion of non-empty directory "
372
 
                            "%s", tmpname)
 
335
                        "%s", tmpname)
373
336
                self.transport.delete_tree(tmpname)
374
337
            self._trace("... unlock succeeded after %dms",
375
 
                        (time.time() - start_time) * 1000)
 
338
                    (time.time() - start_time) * 1000)
376
339
            result = lock.LockResult(self.transport.abspath(self.path),
377
340
                                     old_nonce)
378
341
            for hook in self.hooks['lock_released']:
381
344
    def break_lock(self):
382
345
        """Break a lock not held by this instance of LockDir.
383
346
 
384
 
        This is a UI centric function: it uses the ui.ui_factory to
 
347
        This is a UI centric function: it uses the bzrlib.ui.ui_factory to
385
348
        prompt for input if a lock is detected and there is any doubt about
386
 
        it possibly being still active.  force_break is the non-interactive
387
 
        version.
 
349
        it possibly being still active.
388
350
 
389
351
        :returns: LockResult for the broken lock.
390
352
        """
391
353
        self._check_not_locked()
392
354
        try:
393
355
            holder_info = self.peek()
394
 
        except LockCorrupt as e:
 
356
        except LockCorrupt, e:
395
357
            # The lock info is corrupt.
396
 
            if ui.ui_factory.get_boolean(u"Break (corrupt %r)" % (self,)):
 
358
            if bzrlib.ui.ui_factory.get_boolean("Break (corrupt %r)" % (self,)):
397
359
                self.force_break_corrupt(e.file_data)
398
360
            return
399
361
        if holder_info is not None:
400
 
            if ui.ui_factory.confirm_action(
401
 
                u"Break %(lock_info)s",
402
 
                'breezy.lockdir.break',
403
 
                    dict(lock_info=str(holder_info))):
 
362
            lock_info = '\n'.join(self._format_lock_info(holder_info))
 
363
            if bzrlib.ui.ui_factory.confirm_action(
 
364
                "Break %(lock_info)s", 'bzrlib.lockdir.break', 
 
365
                dict(lock_info=lock_info)):
404
366
                result = self.force_break(holder_info)
405
 
                ui.ui_factory.show_message(
 
367
                bzrlib.ui.ui_factory.show_message(
406
368
                    "Broke lock %s" % result.lock_url)
407
369
 
408
370
    def force_break(self, dead_holder_info):
412
374
        it still thinks it has the lock there will be two concurrent writers.
413
375
        In general the user's approval should be sought for lock breaks.
414
376
 
 
377
        dead_holder_info must be the result of a previous LockDir.peek() call;
 
378
        this is used to check that it's still held by the same process that
 
379
        the user decided was dead.  If this is not the current holder,
 
380
        LockBreakMismatch is raised.
 
381
 
415
382
        After the lock is broken it will not be held by any process.
416
383
        It is possible that another process may sneak in and take the
417
384
        lock before the breaking process acquires it.
418
385
 
419
 
        :param dead_holder_info:
420
 
            Must be the result of a previous LockDir.peek() call; this is used
421
 
            to check that it's still held by the same process that the user
422
 
            decided was dead.  If this is not the current holder,
423
 
            LockBreakMismatch is raised.
424
 
 
425
386
        :returns: LockResult for the broken lock.
426
387
        """
427
 
        if not isinstance(dead_holder_info, LockHeldInfo):
 
388
        if not isinstance(dead_holder_info, dict):
428
389
            raise ValueError("dead_holder_info: %r" % dead_holder_info)
429
390
        self._check_not_locked()
430
391
        current_info = self.peek()
452
413
 
453
414
    def force_break_corrupt(self, corrupt_info_lines):
454
415
        """Release a lock that has been corrupted.
455
 
 
 
416
        
456
417
        This is very similar to force_break, it except it doesn't assume that
457
418
        self.peek() can work.
458
 
 
 
419
        
459
420
        :param corrupt_info_lines: the lines of the corrupted info file, used
460
421
            to check that the lock hasn't changed between reading the (corrupt)
461
422
            info file and calling force_break_corrupt.
509
470
 
510
471
        peek() reads the info file of the lock holder, if any.
511
472
        """
512
 
        return LockHeldInfo.from_info_file_bytes(
513
 
            self.transport.get_bytes(path))
 
473
        return self._parse_info(self.transport.get_bytes(path))
514
474
 
515
475
    def peek(self):
516
476
        """Check if the lock is held by anyone.
523
483
            info = self._read_info_file(self._held_info_path)
524
484
            self._trace("peek -> held")
525
485
            return info
526
 
        except NoSuchFile:
 
486
        except NoSuchFile, e:
527
487
            self._trace("peek -> not held")
528
488
 
529
489
    def _prepare_info(self):
530
490
        """Write information about a pending lock to a temporary file.
531
491
        """
 
492
        # XXX: is creating this here inefficient?
 
493
        config = bzrlib.config.GlobalConfig()
 
494
        try:
 
495
            user = config.username()
 
496
        except errors.NoWhoami:
 
497
            user = osutils.getuser_unicode()
 
498
        s = rio.Stanza(hostname=get_host_name(),
 
499
                   pid=str(os.getpid()),
 
500
                   start_time=str(int(time.time())),
 
501
                   nonce=self.nonce,
 
502
                   user=user,
 
503
                   )
 
504
        return s.to_string()
 
505
 
 
506
    def _parse_info(self, info_bytes):
 
507
        lines = osutils.split_lines(info_bytes)
 
508
        try:
 
509
            stanza = rio.read_stanza(lines)
 
510
        except ValueError, e:
 
511
            mutter('Corrupt lock info file: %r', lines)
 
512
            raise LockCorrupt("could not parse lock info file: " + str(e),
 
513
                              lines)
 
514
        if stanza is None:
 
515
            # see bug 185013; we fairly often end up with the info file being
 
516
            # empty after an interruption; we could log a message here but
 
517
            # there may not be much we can say
 
518
            return {}
 
519
        else:
 
520
            return stanza.as_dict()
532
521
 
533
522
    def attempt_lock(self):
534
523
        """Take the lock; fail if it's already held.
543
532
            raise LockContention(self)
544
533
        result = self._attempt_lock()
545
534
        hook_result = lock.LockResult(self.transport.abspath(self.path),
546
 
                                      self.nonce)
 
535
                self.nonce)
547
536
        for hook in self.hooks['lock_acquired']:
548
537
            hook(hook_result)
549
538
        return result
605
594
            new_info = self.peek()
606
595
            if new_info is not None and new_info != last_info:
607
596
                if last_info is None:
608
 
                    start = gettext('Unable to obtain')
 
597
                    start = 'Unable to obtain'
609
598
                else:
610
 
                    start = gettext('Lock owner changed for')
 
599
                    start = 'Lock owner changed for'
611
600
                last_info = new_info
612
 
                msg = gettext('{0} lock {1} {2}.').format(start, lock_url,
613
 
                                                          new_info)
 
601
                formatted_info = self._format_lock_info(new_info)
614
602
                if deadline_str is None:
615
603
                    deadline_str = time.strftime('%H:%M:%S',
616
604
                                                 time.localtime(deadline))
 
605
                user, hostname, pid, time_ago = formatted_info
 
606
                msg = ('%s lock %s '        # lock_url
 
607
                    'held by '              # start
 
608
                    '%s\n'                  # user
 
609
                    'at %s '                # hostname
 
610
                    '[process #%s], '       # pid
 
611
                    'acquired %s.')         # time ago
 
612
                msg_args = [start, lock_url, user, hostname, pid, time_ago]
617
613
                if timeout > 0:
618
 
                    msg += '\n' + gettext(
619
 
                        'Will continue to try until %s, unless '
620
 
                        'you press Ctrl-C.') % deadline_str
621
 
                msg += '\n' + gettext('See "brz help break-lock" for more.')
622
 
                self._report_function(msg)
 
614
                    msg += ('\nWill continue to try until %s, unless '
 
615
                        'you press Ctrl-C.')
 
616
                    msg_args.append(deadline_str)
 
617
                msg += '\nSee "bzr help break-lock" for more.'
 
618
                self._report_function(msg, *msg_args)
623
619
            if (max_attempts is not None) and (attempt_count >= max_attempts):
624
620
                self._trace("exceeded %d attempts")
625
621
                raise LockContention(self)
675
671
        # we can't rely on that remotely.  Once this is cleaned up,
676
672
        # reenable this warning to prevent it coming back in
677
673
        # -- mbp 20060303
678
 
        # warn("LockDir.lock_read falls back to write lock")
 
674
        ## warn("LockDir.lock_read falls back to write lock")
679
675
        if self._lock_held or self._fake_read_lock:
680
676
            raise LockContention(self)
681
677
        self._fake_read_lock = True
682
678
 
 
679
    def _format_lock_info(self, info):
 
680
        """Turn the contents of peek() into something for the user"""
 
681
        start_time = info.get('start_time')
 
682
        if start_time is None:
 
683
            time_ago = '(unknown)'
 
684
        else:
 
685
            time_ago = format_delta(time.time() - int(info['start_time']))
 
686
        user = info.get('user', '<unknown>')
 
687
        hostname = info.get('hostname', '<unknown>')
 
688
        pid = info.get('pid', '<unknown>')
 
689
        return [
 
690
            user,
 
691
            hostname,
 
692
            pid,
 
693
            time_ago,
 
694
            ]
 
695
 
683
696
    def validate_token(self, token):
684
697
        if token is not None:
685
698
            info = self.peek()
697
710
        if 'lock' not in debug.debug_flags:
698
711
            return
699
712
        mutter(str(self) + ": " + (format % args))
700
 
 
701
 
    def get_config(self):
702
 
        """Get the configuration that governs this lockdir."""
703
 
        # XXX: This really should also use the locationconfig at least, but
704
 
        # that seems a bit hard to hook up at the moment. -- mbp 20110329
705
 
        # FIXME: The above is still true ;) -- vila 20110811
706
 
        return config.GlobalStack()
707
 
 
708
 
 
709
 
class LockHeldInfo(object):
710
 
    """The information recorded about a held lock.
711
 
 
712
 
    This information is recorded into the lock when it's taken, and it can be
713
 
    read back by any process with access to the lockdir.  It can be used, for
714
 
    example, to tell the user who holds the lock, or to try to detect whether
715
 
    the lock holder is still alive.
716
 
 
717
 
    Prior to bzr 2.4 a simple dict was used instead of an object.
718
 
    """
719
 
 
720
 
    def __init__(self, info_dict):
721
 
        self.info_dict = info_dict
722
 
 
723
 
    def __repr__(self):
724
 
        """Return a debugging representation of this object."""
725
 
        return "%s(%r)" % (self.__class__.__name__, self.info_dict)
726
 
 
727
 
    def __str__(self):
728
 
        """Return a user-oriented description of this object."""
729
 
        d = self.to_readable_dict()
730
 
        return (gettext(
731
 
            u'held by %(user)s on %(hostname)s (process #%(pid)s), '
732
 
            u'acquired %(time_ago)s') % d)
733
 
 
734
 
    def to_readable_dict(self):
735
 
        """Turn the holder info into a dict of human-readable attributes.
736
 
 
737
 
        For example, the start time is presented relative to the current time,
738
 
        rather than as seconds since the epoch.
739
 
 
740
 
        Returns a list of [user, hostname, pid, time_ago] all as readable
741
 
        strings.
742
 
        """
743
 
        start_time = self.info_dict.get('start_time')
744
 
        if start_time is None:
745
 
            time_ago = '(unknown)'
746
 
        else:
747
 
            time_ago = format_delta(
748
 
                time.time() - int(self.info_dict['start_time']))
749
 
        user = self.info_dict.get('user', '<unknown>')
750
 
        hostname = self.info_dict.get('hostname', '<unknown>')
751
 
        pid = self.info_dict.get('pid', '<unknown>')
752
 
        return dict(
753
 
            user=user,
754
 
            hostname=hostname,
755
 
            pid=pid,
756
 
            time_ago=time_ago)
757
 
 
758
 
    def get(self, field_name):
759
 
        """Return the contents of a field from the lock info, or None."""
760
 
        return self.info_dict.get(field_name)
761
 
 
762
 
    @classmethod
763
 
    def for_this_process(cls, extra_holder_info):
764
 
        """Return a new LockHeldInfo for a lock taken by this process.
765
 
        """
766
 
        info = dict(
767
 
            hostname=get_host_name(),
768
 
            pid=str(os.getpid()),
769
 
            nonce=rand_chars(20).encode('ascii'),
770
 
            start_time=str(int(time.time())),
771
 
            user=get_username_for_lock_info(),
772
 
            )
773
 
        if extra_holder_info is not None:
774
 
            info.update(extra_holder_info)
775
 
        return cls(info)
776
 
 
777
 
    def to_bytes(self):
778
 
        s = rio.Stanza(**self.info_dict)
779
 
        return s.to_string()
780
 
 
781
 
    @classmethod
782
 
    def from_info_file_bytes(cls, info_file_bytes):
783
 
        """Construct from the contents of the held file."""
784
 
        lines = osutils.split_lines(info_file_bytes)
785
 
        try:
786
 
            stanza = rio.read_stanza(lines)
787
 
        except ValueError as e:
788
 
            mutter('Corrupt lock info file: %r', lines)
789
 
            raise LockCorrupt("could not parse lock info file: " + str(e),
790
 
                              lines)
791
 
        if stanza is None:
792
 
            # see bug 185013; we fairly often end up with the info file being
793
 
            # empty after an interruption; we could log a message here but
794
 
            # there may not be much we can say
795
 
            return cls({})
796
 
        else:
797
 
            ret = stanza.as_dict()
798
 
            ret['nonce'] = ret['nonce'].encode('ascii')
799
 
            return cls(ret)
800
 
 
801
 
    def __hash__(self):
802
 
        return id(self)
803
 
 
804
 
    def __eq__(self, other):
805
 
        """Equality check for lock holders."""
806
 
        if type(self) != type(other):
807
 
            return False
808
 
        return self.info_dict == other.info_dict
809
 
 
810
 
    def __ne__(self, other):
811
 
        return not self == other
812
 
 
813
 
    def is_locked_by_this_process(self):
814
 
        """True if this process seems to be the current lock holder."""
815
 
        return (
816
 
            self.get('hostname') == get_host_name()
817
 
            and self.get('pid') == str(os.getpid())
818
 
            and self.get('user') == get_username_for_lock_info())
819
 
 
820
 
    def is_lock_holder_known_dead(self):
821
 
        """True if the lock holder process is known to be dead.
822
 
 
823
 
        False if it's either known to be still alive, or if we just can't tell.
824
 
 
825
 
        We can be fairly sure the lock holder is dead if it declared the same
826
 
        hostname and there is no process with the given pid alive.  If people
827
 
        have multiple machines with the same hostname this may cause trouble.
828
 
 
829
 
        This doesn't check whether the lock holder is in fact the same process
830
 
        calling this method.  (In that case it will return true.)
831
 
        """
832
 
        if self.get('hostname') != get_host_name():
833
 
            return False
834
 
        if self.get('hostname') == 'localhost':
835
 
            # Too ambiguous.
836
 
            return False
837
 
        if self.get('user') != get_username_for_lock_info():
838
 
            # Could well be another local process by a different user, but
839
 
            # just to be safe we won't conclude about this either.
840
 
            return False
841
 
        pid_str = self.info_dict.get('pid', None)
842
 
        if not pid_str:
843
 
            mutter("no pid recorded in %r" % (self, ))
844
 
            return False
845
 
        try:
846
 
            pid = int(pid_str)
847
 
        except ValueError:
848
 
            mutter("can't parse pid %r from %r"
849
 
                   % (pid_str, self))
850
 
            return False
851
 
        return osutils.is_local_pid_dead(pid)
852
 
 
853
 
 
854
 
def get_username_for_lock_info():
855
 
    """Get a username suitable for putting into a lock.
856
 
 
857
 
    It's ok if what's written here is not a proper email address as long
858
 
    as it gives some clue who the user is.
859
 
    """
860
 
    try:
861
 
        return config.GlobalStack().get('email')
862
 
    except errors.NoWhoami:
863
 
        return osutils.getuser_unicode()