/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: Joe Julian
  • Date: 2010-01-10 02:25:31 UTC
  • mto: (4634.119.7 2.0)
  • mto: This revision was merged to the branch mainline in revision 4959.
  • Revision ID: joe@julianfamily.org-20100110022531-wqk61rsagz8xsiga
https://launchpad.net/bugs/175839
Added MANIFEST.in to allow bdist_rpm to have all the required include files and tools. bdist_rpm will still fail to build correctly on some distributions due to a disttools bug http://bugs.python.org/issue644744

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockdir.py
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 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
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
 
    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
 
113
    )
 
114
import bzrlib.config
 
115
from bzrlib.errors import (
 
116
        DirectoryNotEmpty,
 
117
        FileExists,
 
118
        LockBreakMismatch,
 
119
        LockBroken,
 
120
        LockContention,
 
121
        LockFailed,
 
122
        LockNotHeld,
 
123
        NoSuchFile,
 
124
        PathError,
 
125
        ResourceBusy,
 
126
        TransportError,
 
127
        )
 
128
from bzrlib.trace import mutter, note
 
129
from bzrlib.osutils import format_delta, rand_chars, get_host_name
 
130
import bzrlib.ui
141
131
 
 
132
from bzrlib.lazy_import import lazy_import
 
133
lazy_import(globals(), """
 
134
from bzrlib import rio
 
135
""")
142
136
 
143
137
# XXX: At the moment there is no consideration of thread safety on LockDir
144
138
# objects.  This should perhaps be updated - e.g. if two threads try to take a
155
149
# files/dirs created.
156
150
 
157
151
 
158
 
_DEFAULT_TIMEOUT_SECONDS = 30
 
152
_DEFAULT_TIMEOUT_SECONDS = 300
159
153
_DEFAULT_POLL_SECONDS = 1.0
160
154
 
161
155
 
165
159
 
166
160
    __INFO_NAME = '/info'
167
161
 
168
 
    def __init__(self, transport, path, file_modebits=0o644,
169
 
                 dir_modebits=0o755, extra_holder_info=None):
 
162
    def __init__(self, transport, path, file_modebits=0644, dir_modebits=0755):
170
163
        """Create a new LockDir object.
171
164
 
172
165
        The LockDir is initially unlocked - this just creates the object.
175
168
 
176
169
        :param path: Path to the lock within the base directory of the
177
170
            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
171
        """
183
172
        self.transport = transport
184
173
        self.path = path
189
178
        self._held_info_path = self._held_dir + self.__INFO_NAME
190
179
        self._file_modebits = file_modebits
191
180
        self._dir_modebits = dir_modebits
 
181
 
192
182
        self._report_function = note
193
 
        self.extra_holder_info = extra_holder_info
194
 
        self._warned_about_lock_holder = None
195
183
 
196
184
    def __repr__(self):
197
185
        return '%s(%s%s)' % (self.__class__.__name__,
209
197
        self._trace("create lock directory")
210
198
        try:
211
199
            self.transport.mkdir(self.path, mode=mode)
212
 
        except (TransportError, PathError) as e:
 
200
        except (TransportError, PathError), e:
213
201
            raise LockFailed(self, e)
214
202
 
 
203
 
215
204
    def _attempt_lock(self):
216
205
        """Make the pending directory and attempt to rename into place.
217
206
 
224
213
 
225
214
        :returns: The nonce of the lock, if it was successfully acquired.
226
215
 
227
 
        :raises LockContention: If the lock is held by someone else.  The
228
 
            exception contains the info of the current holder of the lock.
 
216
        :raises LockContention: If the lock is held by someone else.  The exception
 
217
            contains the info of the current holder of the lock.
229
218
        """
230
219
        self._trace("lock_write...")
231
220
        start_time = time.time()
232
221
        try:
233
222
            tmpname = self._create_pending_dir()
234
 
        except (errors.TransportError, PathError) as e:
 
223
        except (errors.TransportError, PathError), e:
235
224
            self._trace("... failed to create pending dir, %s", e)
236
225
            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
 
226
        try:
 
227
            self.transport.rename(tmpname, self._held_dir)
 
228
        except (errors.TransportError, PathError, DirectoryNotEmpty,
 
229
                FileExists, ResourceBusy), e:
 
230
            self._trace("... contention, %s", e)
 
231
            self._remove_pending_dir(tmpname)
 
232
            raise LockContention(self)
 
233
        except Exception, e:
 
234
            self._trace("... lock failed, %s", e)
 
235
            self._remove_pending_dir(tmpname)
 
236
            raise
255
237
        # We must check we really got the lock, because Launchpad's sftp
256
238
        # server at one time had a bug were the rename would successfully
257
239
        # move the new directory into the existing directory, which was
259
241
        # have a similar bug allowing someone to think they got the lock
260
242
        # when it's already held.
261
243
        #
262
 
        # See <https://bugs.launchpad.net/bzr/+bug/498378> for one case.
 
244
        # See <https://bugs.edge.launchpad.net/bzr/+bug/498378> for one case.
263
245
        #
264
246
        # Strictly the check is unnecessary and a waste of time for most
265
247
        # people, but probably worth trapping if something is wrong.
267
249
        self._trace("after locking, info=%r", info)
268
250
        if info is None:
269
251
            raise LockFailed(self, "lock was renamed into place, but "
270
 
                             "now is missing!")
271
 
        if info.get('nonce') != self.nonce:
 
252
                "now is missing!")
 
253
        if info['nonce'] != self.nonce:
272
254
            self._trace("rename succeeded, "
273
 
                        "but lock is still held by someone else")
 
255
                "but lock is still held by someone else")
274
256
            raise LockContention(self)
275
257
        self._lock_held = True
276
258
        self._trace("... lock succeeded after %dms",
277
 
                    (time.time() - start_time) * 1000)
 
259
                (time.time() - start_time) * 1000)
278
260
        return self.nonce
279
261
 
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
262
    def _remove_pending_dir(self, tmpname):
306
263
        """Remove the pending directory
307
264
 
312
269
        try:
313
270
            self.transport.delete(tmpname + self.__INFO_NAME)
314
271
            self.transport.rmdir(tmpname)
315
 
        except PathError as e:
316
 
            note(gettext("error removing pending lock: %s"), e)
 
272
        except PathError, e:
 
273
            note("error removing pending lock: %s", e)
317
274
 
318
275
    def _create_pending_dir(self):
319
276
        tmpname = '%s/%s.tmp' % (self.path, rand_chars(10))
327
284
            self.create(mode=self._dir_modebits)
328
285
            # After creating the lock directory, try again
329
286
            self.transport.mkdir(tmpname)
330
 
        info = LockHeldInfo.for_this_process(self.extra_holder_info)
331
 
        self.nonce = info.get('nonce')
 
287
        self.nonce = rand_chars(20)
 
288
        info_bytes = self._prepare_info()
332
289
        # We use put_file_non_atomic because we just created a new unique
333
290
        # directory so we don't have to worry about files existing there.
334
291
        # We'll rename the whole directory into place to get atomic
335
292
        # properties
336
293
        self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
337
 
                                            info.to_bytes())
 
294
                                            info_bytes)
338
295
        return tmpname
339
296
 
340
 
    @only_raises(LockNotHeld, LockBroken)
341
297
    def unlock(self):
342
298
        """Release a held lock
343
299
        """
363
319
            self.transport.delete(tmpname + self.__INFO_NAME)
364
320
            try:
365
321
                self.transport.rmdir(tmpname)
366
 
            except DirectoryNotEmpty:
 
322
            except DirectoryNotEmpty, e:
367
323
                # There might have been junk left over by a rename that moved
368
324
                # another locker within the 'held' directory.  do a slower
369
325
                # deletion where we list the directory and remove everything
370
326
                # within it.
 
327
                #
 
328
                # Maybe this should be broader to allow for ftp servers with
 
329
                # non-specific error messages?
371
330
                self._trace("doing recursive deletion of non-empty directory "
372
 
                            "%s", tmpname)
 
331
                        "%s", tmpname)
373
332
                self.transport.delete_tree(tmpname)
374
333
            self._trace("... unlock succeeded after %dms",
375
 
                        (time.time() - start_time) * 1000)
 
334
                    (time.time() - start_time) * 1000)
376
335
            result = lock.LockResult(self.transport.abspath(self.path),
377
336
                                     old_nonce)
378
337
            for hook in self.hooks['lock_released']:
381
340
    def break_lock(self):
382
341
        """Break a lock not held by this instance of LockDir.
383
342
 
384
 
        This is a UI centric function: it uses the ui.ui_factory to
 
343
        This is a UI centric function: it uses the bzrlib.ui.ui_factory to
385
344
        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.
388
 
 
389
 
        :returns: LockResult for the broken lock.
 
345
        it possibly being still active.
390
346
        """
391
347
        self._check_not_locked()
392
 
        try:
393
 
            holder_info = self.peek()
394
 
        except LockCorrupt as e:
395
 
            # The lock info is corrupt.
396
 
            if ui.ui_factory.get_boolean(u"Break (corrupt %r)" % (self,)):
397
 
                self.force_break_corrupt(e.file_data)
398
 
            return
 
348
        holder_info = self.peek()
399
349
        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))):
404
 
                result = self.force_break(holder_info)
405
 
                ui.ui_factory.show_message(
406
 
                    "Broke lock %s" % result.lock_url)
 
350
            lock_info = '\n'.join(self._format_lock_info(holder_info))
 
351
            if bzrlib.ui.ui_factory.get_boolean("Break %s" % lock_info):
 
352
                self.force_break(holder_info)
407
353
 
408
354
    def force_break(self, dead_holder_info):
409
355
        """Release a lock held by another process.
412
358
        it still thinks it has the lock there will be two concurrent writers.
413
359
        In general the user's approval should be sought for lock breaks.
414
360
 
 
361
        dead_holder_info must be the result of a previous LockDir.peek() call;
 
362
        this is used to check that it's still held by the same process that
 
363
        the user decided was dead.  If this is not the current holder,
 
364
        LockBreakMismatch is raised.
 
365
 
415
366
        After the lock is broken it will not be held by any process.
416
367
        It is possible that another process may sneak in and take the
417
368
        lock before the breaking process acquires it.
418
 
 
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
 
        :returns: LockResult for the broken lock.
426
369
        """
427
 
        if not isinstance(dead_holder_info, LockHeldInfo):
 
370
        if not isinstance(dead_holder_info, dict):
428
371
            raise ValueError("dead_holder_info: %r" % dead_holder_info)
429
372
        self._check_not_locked()
430
373
        current_info = self.peek()
448
391
                                 current_info.get('nonce'))
449
392
        for hook in self.hooks['lock_broken']:
450
393
            hook(result)
451
 
        return result
452
 
 
453
 
    def force_break_corrupt(self, corrupt_info_lines):
454
 
        """Release a lock that has been corrupted.
455
 
 
456
 
        This is very similar to force_break, it except it doesn't assume that
457
 
        self.peek() can work.
458
 
 
459
 
        :param corrupt_info_lines: the lines of the corrupted info file, used
460
 
            to check that the lock hasn't changed between reading the (corrupt)
461
 
            info file and calling force_break_corrupt.
462
 
        """
463
 
        # XXX: this copes with unparseable info files, but what about missing
464
 
        # info files?  Or missing lock dirs?
465
 
        self._check_not_locked()
466
 
        tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
467
 
        self.transport.rename(self._held_dir, tmpname)
468
 
        # check that we actually broke the right lock, not someone else;
469
 
        # there's a small race window between checking it and doing the
470
 
        # rename.
471
 
        broken_info_path = tmpname + self.__INFO_NAME
472
 
        broken_content = self.transport.get_bytes(broken_info_path)
473
 
        broken_lines = osutils.split_lines(broken_content)
474
 
        if broken_lines != corrupt_info_lines:
475
 
            raise LockBreakMismatch(self, broken_lines, corrupt_info_lines)
476
 
        self.transport.delete(broken_info_path)
477
 
        self.transport.rmdir(tmpname)
478
 
        result = lock.LockResult(self.transport.abspath(self.path))
479
 
        for hook in self.hooks['lock_broken']:
480
 
            hook(result)
481
394
 
482
395
    def _check_not_locked(self):
483
396
        """If the lock is held by this instance, raise an error."""
509
422
 
510
423
        peek() reads the info file of the lock holder, if any.
511
424
        """
512
 
        return LockHeldInfo.from_info_file_bytes(
513
 
            self.transport.get_bytes(path))
 
425
        return self._parse_info(self.transport.get(path))
514
426
 
515
427
    def peek(self):
516
428
        """Check if the lock is held by anyone.
517
429
 
518
 
        If it is held, this returns the lock info structure as a dict
 
430
        If it is held, this returns the lock info structure as a rio Stanza,
519
431
        which contains some information about the current lock holder.
520
432
        Otherwise returns None.
521
433
        """
523
435
            info = self._read_info_file(self._held_info_path)
524
436
            self._trace("peek -> held")
525
437
            return info
526
 
        except NoSuchFile:
 
438
        except NoSuchFile, e:
527
439
            self._trace("peek -> not held")
528
440
 
529
441
    def _prepare_info(self):
530
442
        """Write information about a pending lock to a temporary file.
531
443
        """
 
444
        # XXX: is creating this here inefficient?
 
445
        config = bzrlib.config.GlobalConfig()
 
446
        try:
 
447
            user = config.user_email()
 
448
        except errors.NoEmailInUsername:
 
449
            user = config.username()
 
450
        s = rio.Stanza(hostname=get_host_name(),
 
451
                   pid=str(os.getpid()),
 
452
                   start_time=str(int(time.time())),
 
453
                   nonce=self.nonce,
 
454
                   user=user,
 
455
                   )
 
456
        return s.to_string()
 
457
 
 
458
    def _parse_info(self, info_file):
 
459
        return rio.read_stanza(info_file.readlines()).as_dict()
532
460
 
533
461
    def attempt_lock(self):
534
462
        """Take the lock; fail if it's already held.
543
471
            raise LockContention(self)
544
472
        result = self._attempt_lock()
545
473
        hook_result = lock.LockResult(self.transport.abspath(self.path),
546
 
                                      self.nonce)
 
474
                self.nonce)
547
475
        for hook in self.hooks['lock_acquired']:
548
476
            hook(hook_result)
549
477
        return result
550
478
 
551
 
    def lock_url_for_display(self):
552
 
        """Give a nicely-printable representation of the URL of this lock."""
553
 
        # As local lock urls are correct we display them.
554
 
        # We avoid displaying remote lock urls.
555
 
        lock_url = self.transport.abspath(self.path)
556
 
        if lock_url.startswith('file://'):
557
 
            lock_url = lock_url.split('.bzr/')[0]
558
 
        else:
559
 
            lock_url = ''
560
 
        return lock_url
561
 
 
562
479
    def wait_lock(self, timeout=None, poll=None, max_attempts=None):
563
480
        """Wait a certain period for a lock.
564
481
 
588
505
        deadline_str = None
589
506
        last_info = None
590
507
        attempt_count = 0
591
 
        lock_url = self.lock_url_for_display()
592
508
        while True:
593
509
            attempt_count += 1
594
510
            try:
605
521
            new_info = self.peek()
606
522
            if new_info is not None and new_info != last_info:
607
523
                if last_info is None:
608
 
                    start = gettext('Unable to obtain')
 
524
                    start = 'Unable to obtain'
609
525
                else:
610
 
                    start = gettext('Lock owner changed for')
 
526
                    start = 'Lock owner changed for'
611
527
                last_info = new_info
612
 
                msg = gettext('{0} lock {1} {2}.').format(start, lock_url,
613
 
                                                          new_info)
 
528
                formatted_info = self._format_lock_info(new_info)
614
529
                if deadline_str is None:
615
530
                    deadline_str = time.strftime('%H:%M:%S',
616
531
                                                 time.localtime(deadline))
617
 
                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)
 
532
                lock_url = self.transport.abspath(self.path)
 
533
                self._report_function('%s %s\n'
 
534
                                      '%s\n' # held by
 
535
                                      '%s\n' # locked ... ago
 
536
                                      'Will continue to try until %s, unless '
 
537
                                      'you press Ctrl-C\n'
 
538
                                      'If you\'re sure that it\'s not being '
 
539
                                      'modified, use bzr break-lock %s',
 
540
                                      start,
 
541
                                      formatted_info[0],
 
542
                                      formatted_info[1],
 
543
                                      formatted_info[2],
 
544
                                      deadline_str,
 
545
                                      lock_url)
 
546
 
623
547
            if (max_attempts is not None) and (attempt_count >= max_attempts):
624
548
                self._trace("exceeded %d attempts")
625
549
                raise LockContention(self)
627
551
                self._trace("waiting %ss", poll)
628
552
                time.sleep(poll)
629
553
            else:
630
 
                # As timeout is always 0 for remote locks
631
 
                # this block is applicable only for local
632
 
                # lock contention
633
554
                self._trace("timeout after waiting %ss", timeout)
634
 
                raise LockContention('(local)', lock_url)
 
555
                raise LockContention(self)
635
556
 
636
557
    def leave_in_place(self):
637
558
        self._locked_via_token = True
675
596
        # we can't rely on that remotely.  Once this is cleaned up,
676
597
        # reenable this warning to prevent it coming back in
677
598
        # -- mbp 20060303
678
 
        # warn("LockDir.lock_read falls back to write lock")
 
599
        ## warn("LockDir.lock_read falls back to write lock")
679
600
        if self._lock_held or self._fake_read_lock:
680
601
            raise LockContention(self)
681
602
        self._fake_read_lock = True
682
603
 
 
604
    def _format_lock_info(self, info):
 
605
        """Turn the contents of peek() into something for the user"""
 
606
        lock_url = self.transport.abspath(self.path)
 
607
        delta = time.time() - int(info['start_time'])
 
608
        return [
 
609
            'lock %s' % (lock_url,),
 
610
            'held by %(user)s on host %(hostname)s [process #%(pid)s]' % info,
 
611
            'locked %s' % (format_delta(delta),),
 
612
            ]
 
613
 
683
614
    def validate_token(self, token):
684
615
        if token is not None:
685
616
            info = self.peek()
697
628
        if 'lock' not in debug.debug_flags:
698
629
            return
699
630
        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()