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

  • Committer: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

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