~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-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
73
73
    repository as _mod_repository,
74
74
    revision as _mod_revision,
75
75
    revisionspec,
76
 
    trace,
77
76
    tsort,
78
77
    )
 
78
from bzrlib.i18n import gettext, ngettext
79
79
""")
80
80
 
81
81
from bzrlib import (
 
82
    lazy_regex,
82
83
    registry,
83
84
    )
84
85
from bzrlib.osutils import (
85
86
    format_date,
86
87
    format_date_with_offset_in_original_timezone,
 
88
    get_diff_header_encoding,
87
89
    get_terminal_encoding,
88
 
    re_compile_checked,
89
90
    terminal_width,
90
91
    )
91
92
 
105
106
    last_path = None
106
107
    revno = 1
107
108
    for revision_id in branch.revision_history():
108
 
        this_inv = branch.repository.get_revision_inventory(revision_id)
109
 
        if file_id in this_inv:
 
109
        this_inv = branch.repository.get_inventory(revision_id)
 
110
        if this_inv.has_id(file_id):
110
111
            this_ie = this_inv[file_id]
111
112
            this_path = this_inv.id2path(file_id)
112
113
        else:
152
153
             end_revision=None,
153
154
             search=None,
154
155
             limit=None,
155
 
             show_diff=False):
 
156
             show_diff=False,
 
157
             match=None):
156
158
    """Write out human-readable log of commits to this branch.
157
159
 
158
160
    This function is being retained for backwards compatibility but
181
183
        if None or 0.
182
184
 
183
185
    :param show_diff: If True, output a diff after each revision.
 
186
 
 
187
    :param match: Dictionary of search lists to use when matching revision
 
188
      properties.
184
189
    """
185
190
    # Convert old-style parameters to new-style parameters
186
191
    if specific_fileid is not None:
210
215
    Logger(branch, rqst).show(lf)
211
216
 
212
217
 
213
 
# Note: This needs to be kept this in sync with the defaults in
 
218
# Note: This needs to be kept in sync with the defaults in
214
219
# make_log_request_dict() below
215
220
_DEFAULT_REQUEST_PARAMS = {
216
221
    'direction': 'reverse',
217
 
    'levels': 1,
 
222
    'levels': None,
218
223
    'generate_tags': True,
 
224
    'exclude_common_ancestry': False,
219
225
    '_match_using_deltas': True,
220
226
    }
221
227
 
222
228
 
223
229
def make_log_request_dict(direction='reverse', specific_fileids=None,
224
 
    start_revision=None, end_revision=None, limit=None,
225
 
    message_search=None, levels=1, generate_tags=True, delta_type=None,
226
 
    diff_type=None, _match_using_deltas=True):
 
230
                          start_revision=None, end_revision=None, limit=None,
 
231
                          message_search=None, levels=None, generate_tags=True,
 
232
                          delta_type=None,
 
233
                          diff_type=None, _match_using_deltas=True,
 
234
                          exclude_common_ancestry=False, match=None,
 
235
                          signature=False, omit_merges=False,
 
236
                          ):
227
237
    """Convenience function for making a logging request dictionary.
228
238
 
229
239
    Using this function may make code slightly safer by ensuring
249
259
      matching commit messages
250
260
 
251
261
    :param levels: the number of levels of revisions to
252
 
      generate; 1 for just the mainline; 0 for all levels.
 
262
      generate; 1 for just the mainline; 0 for all levels, or None for
 
263
      a sensible default.
253
264
 
254
265
    :param generate_tags: If True, include tags for matched revisions.
255
 
 
 
266
`
256
267
    :param delta_type: Either 'full', 'partial' or None.
257
268
      'full' means generate the complete delta - adds/deletes/modifies/etc;
258
269
      'partial' means filter the delta using specific_fileids;
267
278
      algorithm used for matching specific_fileids. This parameter
268
279
      may be removed in the future so bzrlib client code should NOT
269
280
      use it.
 
281
 
 
282
    :param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
 
283
      range operator or as a graph difference.
 
284
 
 
285
    :param signature: show digital signature information
 
286
 
 
287
    :param match: Dictionary of list of search strings to use when filtering
 
288
      revisions. Keys can be 'message', 'author', 'committer', 'bugs' or
 
289
      the empty string to match any of the preceding properties.
 
290
 
 
291
    :param omit_merges: If True, commits with more than one parent are
 
292
      omitted.
 
293
 
270
294
    """
 
295
    # Take care of old style message_search parameter
 
296
    if message_search:
 
297
        if match:
 
298
            if 'message' in match:
 
299
                match['message'].append(message_search)
 
300
            else:
 
301
                match['message'] = [message_search]
 
302
        else:
 
303
            match={ 'message': [message_search] }
271
304
    return {
272
305
        'direction': direction,
273
306
        'specific_fileids': specific_fileids,
274
307
        'start_revision': start_revision,
275
308
        'end_revision': end_revision,
276
309
        'limit': limit,
277
 
        'message_search': message_search,
278
310
        'levels': levels,
279
311
        'generate_tags': generate_tags,
280
312
        'delta_type': delta_type,
281
313
        'diff_type': diff_type,
 
314
        'exclude_common_ancestry': exclude_common_ancestry,
 
315
        'signature': signature,
 
316
        'match': match,
 
317
        'omit_merges': omit_merges,
282
318
        # Add 'private' attributes for features that may be deprecated
283
319
        '_match_using_deltas': _match_using_deltas,
284
320
    }
286
322
 
287
323
def _apply_log_request_defaults(rqst):
288
324
    """Apply default values to a request dictionary."""
289
 
    result = _DEFAULT_REQUEST_PARAMS
 
325
    result = _DEFAULT_REQUEST_PARAMS.copy()
290
326
    if rqst:
291
327
        result.update(rqst)
292
328
    return result
293
329
 
294
330
 
 
331
def format_signature_validity(rev_id, repo):
 
332
    """get the signature validity
 
333
 
 
334
    :param rev_id: revision id to validate
 
335
    :param repo: repository of revision
 
336
    :return: human readable string to print to log
 
337
    """
 
338
    from bzrlib import gpg
 
339
 
 
340
    gpg_strategy = gpg.GPGStrategy(None)
 
341
    result = repo.verify_revision(rev_id, gpg_strategy)
 
342
    if result[0] == gpg.SIGNATURE_VALID:
 
343
        return "valid signature from {0}".format(result[1])
 
344
    if result[0] == gpg.SIGNATURE_KEY_MISSING:
 
345
        return "unknown key {0}".format(result[1])
 
346
    if result[0] == gpg.SIGNATURE_NOT_VALID:
 
347
        return "invalid signature!"
 
348
    if result[0] == gpg.SIGNATURE_NOT_SIGNED:
 
349
        return "no signature"
 
350
 
 
351
 
295
352
class LogGenerator(object):
296
353
    """A generator of log revisions."""
297
354
 
304
361
 
305
362
 
306
363
class Logger(object):
307
 
    """An object the generates, formats and displays a log."""
 
364
    """An object that generates, formats and displays a log."""
308
365
 
309
366
    def __init__(self, branch, rqst):
310
367
        """Create a Logger.
342
399
        # Tweak the LogRequest based on what the LogFormatter can handle.
343
400
        # (There's no point generating stuff if the formatter can't display it.)
344
401
        rqst = self.rqst
345
 
        rqst['levels'] = lf.get_levels()
 
402
        if rqst['levels'] is None or lf.get_levels() > rqst['levels']:
 
403
            # user didn't specify levels, use whatever the LF can handle:
 
404
            rqst['levels'] = lf.get_levels()
 
405
 
346
406
        if not getattr(lf, 'supports_tags', False):
347
407
            rqst['generate_tags'] = False
348
408
        if not getattr(lf, 'supports_delta', False):
349
409
            rqst['delta_type'] = None
350
410
        if not getattr(lf, 'supports_diff', False):
351
411
            rqst['diff_type'] = None
 
412
        if not getattr(lf, 'supports_signatures', False):
 
413
            rqst['signature'] = False
352
414
 
353
415
        # Find and print the interesting revisions
354
416
        generator = self._generator_factory(self.branch, rqst)
358
420
 
359
421
    def _generator_factory(self, branch, rqst):
360
422
        """Make the LogGenerator object to use.
361
 
        
 
423
 
362
424
        Subclasses may wish to override this.
363
425
        """
364
426
        return _DefaultLogGenerator(branch, rqst)
388
450
        levels = rqst.get('levels')
389
451
        limit = rqst.get('limit')
390
452
        diff_type = rqst.get('diff_type')
 
453
        show_signature = rqst.get('signature')
 
454
        omit_merges = rqst.get('omit_merges')
391
455
        log_count = 0
392
456
        revision_iterator = self._create_log_revision_iterator()
393
457
        for revs in revision_iterator:
395
459
                # 0 levels means show everything; merge_depth counts from 0
396
460
                if levels != 0 and merge_depth >= levels:
397
461
                    continue
 
462
                if omit_merges and len(rev.parent_ids) > 1:
 
463
                    continue
398
464
                if diff_type is None:
399
465
                    diff = None
400
466
                else:
401
467
                    diff = self._format_diff(rev, rev_id, diff_type)
 
468
                if show_signature:
 
469
                    signature = format_signature_validity(rev_id,
 
470
                                                self.branch.repository)
 
471
                else:
 
472
                    signature = None
402
473
                yield LogRevision(rev, revno, merge_depth, delta,
403
 
                    self.rev_tag_dict.get(rev_id), diff)
 
474
                    self.rev_tag_dict.get(rev_id), diff, signature)
404
475
                if limit:
405
476
                    log_count += 1
406
477
                    if log_count >= limit:
420
491
        else:
421
492
            specific_files = None
422
493
        s = StringIO()
 
494
        path_encoding = get_diff_header_encoding()
423
495
        diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
424
 
            new_label='')
 
496
            new_label='', path_encoding=path_encoding)
425
497
        return s.getvalue()
426
498
 
427
499
    def _create_log_revision_iterator(self):
451
523
        generate_merge_revisions = rqst.get('levels') != 1
452
524
        delayed_graph_generation = not rqst.get('specific_fileids') and (
453
525
                rqst.get('limit') or self.start_rev_id or self.end_rev_id)
454
 
        view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
455
 
            self.end_rev_id, rqst.get('direction'), generate_merge_revisions,
456
 
            delayed_graph_generation=delayed_graph_generation)
 
526
        view_revisions = _calc_view_revisions(
 
527
            self.branch, self.start_rev_id, self.end_rev_id,
 
528
            rqst.get('direction'),
 
529
            generate_merge_revisions=generate_merge_revisions,
 
530
            delayed_graph_generation=delayed_graph_generation,
 
531
            exclude_common_ancestry=rqst.get('exclude_common_ancestry'))
457
532
 
458
533
        # Apply the other filters
459
534
        return make_log_rev_iterator(self.branch, view_revisions,
460
 
            rqst.get('delta_type'), rqst.get('message_search'),
 
535
            rqst.get('delta_type'), rqst.get('match'),
461
536
            file_ids=rqst.get('specific_fileids'),
462
537
            direction=rqst.get('direction'))
463
538
 
466
541
        # Note that we always generate the merge revisions because
467
542
        # filter_revisions_touching_file_id() requires them ...
468
543
        rqst = self.rqst
469
 
        view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
470
 
            self.end_rev_id, rqst.get('direction'), True)
 
544
        view_revisions = _calc_view_revisions(
 
545
            self.branch, self.start_rev_id, self.end_rev_id,
 
546
            rqst.get('direction'), generate_merge_revisions=True,
 
547
            exclude_common_ancestry=rqst.get('exclude_common_ancestry'))
471
548
        if not isinstance(view_revisions, list):
472
549
            view_revisions = list(view_revisions)
473
550
        view_revisions = _filter_revisions_touching_file_id(self.branch,
474
551
            rqst.get('specific_fileids')[0], view_revisions,
475
552
            include_merges=rqst.get('levels') != 1)
476
553
        return make_log_rev_iterator(self.branch, view_revisions,
477
 
            rqst.get('delta_type'), rqst.get('message_search'))
 
554
            rqst.get('delta_type'), rqst.get('match'))
478
555
 
479
556
 
480
557
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
481
 
    generate_merge_revisions, delayed_graph_generation=False):
 
558
                         generate_merge_revisions,
 
559
                         delayed_graph_generation=False,
 
560
                         exclude_common_ancestry=False,
 
561
                         ):
482
562
    """Calculate the revisions to view.
483
563
 
484
564
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
485
565
             a list of the same tuples.
486
566
    """
 
567
    if (exclude_common_ancestry and start_rev_id == end_rev_id):
 
568
        raise errors.BzrCommandError(gettext(
 
569
            '--exclude-common-ancestry requires two different revisions'))
 
570
    if direction not in ('reverse', 'forward'):
 
571
        raise ValueError(gettext('invalid direction %r') % direction)
487
572
    br_revno, br_rev_id = branch.last_revision_info()
488
573
    if br_revno == 0:
489
574
        return []
490
575
 
491
 
    # If a single revision is requested, check we can handle it
492
 
    generate_single_revision = (end_rev_id and start_rev_id == end_rev_id and
493
 
        (not generate_merge_revisions or not _has_merges(branch, end_rev_id)))
494
 
    if generate_single_revision:
495
 
        return _generate_one_revision(branch, end_rev_id, br_rev_id, br_revno)
496
 
 
497
 
    # If we only want to see linear revisions, we can iterate ...
498
 
    if not generate_merge_revisions:
499
 
        return _generate_flat_revisions(branch, start_rev_id, end_rev_id,
500
 
            direction)
 
576
    if (end_rev_id and start_rev_id == end_rev_id
 
577
        and (not generate_merge_revisions
 
578
             or not _has_merges(branch, end_rev_id))):
 
579
        # If a single revision is requested, check we can handle it
 
580
        iter_revs = _generate_one_revision(branch, end_rev_id, br_rev_id,
 
581
                                           br_revno)
 
582
    elif not generate_merge_revisions:
 
583
        # If we only want to see linear revisions, we can iterate ...
 
584
        iter_revs = _generate_flat_revisions(branch, start_rev_id, end_rev_id,
 
585
                                             direction, exclude_common_ancestry)
 
586
        if direction == 'forward':
 
587
            iter_revs = reversed(iter_revs)
501
588
    else:
502
 
        return _generate_all_revisions(branch, start_rev_id, end_rev_id,
503
 
            direction, delayed_graph_generation)
 
589
        iter_revs = _generate_all_revisions(branch, start_rev_id, end_rev_id,
 
590
                                            direction, delayed_graph_generation,
 
591
                                            exclude_common_ancestry)
 
592
        if direction == 'forward':
 
593
            iter_revs = _rebase_merge_depth(reverse_by_depth(list(iter_revs)))
 
594
    return iter_revs
504
595
 
505
596
 
506
597
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
508
599
        # It's the tip
509
600
        return [(br_rev_id, br_revno, 0)]
510
601
    else:
511
 
        revno = branch.revision_id_to_dotted_revno(rev_id)
512
 
        revno_str = '.'.join(str(n) for n in revno)
 
602
        revno_str = _compute_revno_str(branch, rev_id)
513
603
        return [(rev_id, revno_str, 0)]
514
604
 
515
605
 
516
 
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction):
517
 
    result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
 
606
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction,
 
607
                             exclude_common_ancestry=False):
 
608
    result = _linear_view_revisions(
 
609
        branch, start_rev_id, end_rev_id,
 
610
        exclude_common_ancestry=exclude_common_ancestry)
518
611
    # If a start limit was given and it's not obviously an
519
612
    # ancestor of the end limit, check it before outputting anything
520
613
    if direction == 'forward' or (start_rev_id
522
615
        try:
523
616
            result = list(result)
524
617
        except _StartNotLinearAncestor:
525
 
            raise errors.BzrCommandError('Start revision not found in'
526
 
                ' left-hand history of end revision.')
527
 
    if direction == 'forward':
528
 
        result = reversed(result)
 
618
            raise errors.BzrCommandError(gettext('Start revision not found in'
 
619
                ' left-hand history of end revision.'))
529
620
    return result
530
621
 
531
622
 
532
623
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
533
 
    delayed_graph_generation):
 
624
                            delayed_graph_generation,
 
625
                            exclude_common_ancestry=False):
534
626
    # On large trees, generating the merge graph can take 30-60 seconds
535
627
    # so we delay doing it until a merge is detected, incrementally
536
628
    # returning initial (non-merge) revisions while we can.
 
629
 
 
630
    # The above is only true for old formats (<= 0.92), for newer formats, a
 
631
    # couple of seconds only should be needed to load the whole graph and the
 
632
    # other graph operations needed are even faster than that -- vila 100201
537
633
    initial_revisions = []
538
634
    if delayed_graph_generation:
539
635
        try:
540
 
            for rev_id, revno, depth in \
541
 
                _linear_view_revisions(branch, start_rev_id, end_rev_id):
 
636
            for rev_id, revno, depth in  _linear_view_revisions(
 
637
                branch, start_rev_id, end_rev_id, exclude_common_ancestry):
542
638
                if _has_merges(branch, rev_id):
 
639
                    # The end_rev_id can be nested down somewhere. We need an
 
640
                    # explicit ancestry check. There is an ambiguity here as we
 
641
                    # may not raise _StartNotLinearAncestor for a revision that
 
642
                    # is an ancestor but not a *linear* one. But since we have
 
643
                    # loaded the graph to do the check (or calculate a dotted
 
644
                    # revno), we may as well accept to show the log...  We need
 
645
                    # the check only if start_rev_id is not None as all
 
646
                    # revisions have _mod_revision.NULL_REVISION as an ancestor
 
647
                    # -- vila 20100319
 
648
                    graph = branch.repository.get_graph()
 
649
                    if (start_rev_id is not None
 
650
                        and not graph.is_ancestor(start_rev_id, end_rev_id)):
 
651
                        raise _StartNotLinearAncestor()
 
652
                    # Since we collected the revisions so far, we need to
 
653
                    # adjust end_rev_id.
543
654
                    end_rev_id = rev_id
544
655
                    break
545
656
                else:
546
657
                    initial_revisions.append((rev_id, revno, depth))
547
658
            else:
548
659
                # No merged revisions found
549
 
                if direction == 'reverse':
550
 
                    return initial_revisions
551
 
                elif direction == 'forward':
552
 
                    return reversed(initial_revisions)
553
 
                else:
554
 
                    raise ValueError('invalid direction %r' % direction)
 
660
                return initial_revisions
555
661
        except _StartNotLinearAncestor:
556
662
            # A merge was never detected so the lower revision limit can't
557
663
            # be nested down somewhere
558
 
            raise errors.BzrCommandError('Start revision not found in'
559
 
                ' history of end revision.')
 
664
            raise errors.BzrCommandError(gettext('Start revision not found in'
 
665
                ' history of end revision.'))
 
666
 
 
667
    # We exit the loop above because we encounter a revision with merges, from
 
668
    # this revision, we need to switch to _graph_view_revisions.
560
669
 
561
670
    # A log including nested merges is required. If the direction is reverse,
562
671
    # we rebase the initial merge depths so that the development line is
565
674
    # indented at the end seems slightly nicer in that case.
566
675
    view_revisions = chain(iter(initial_revisions),
567
676
        _graph_view_revisions(branch, start_rev_id, end_rev_id,
568
 
        rebase_initial_depths=direction == 'reverse'))
569
 
    if direction == 'reverse':
570
 
        return view_revisions
571
 
    elif direction == 'forward':
572
 
        # Forward means oldest first, adjusting for depth.
573
 
        view_revisions = reverse_by_depth(list(view_revisions))
574
 
        return _rebase_merge_depth(view_revisions)
575
 
    else:
576
 
        raise ValueError('invalid direction %r' % direction)
 
677
                              rebase_initial_depths=(direction == 'reverse'),
 
678
                              exclude_common_ancestry=exclude_common_ancestry))
 
679
    return view_revisions
577
680
 
578
681
 
579
682
def _has_merges(branch, rev_id):
582
685
    return len(parents) > 1
583
686
 
584
687
 
 
688
def _compute_revno_str(branch, rev_id):
 
689
    """Compute the revno string from a rev_id.
 
690
 
 
691
    :return: The revno string, or None if the revision is not in the supplied
 
692
        branch.
 
693
    """
 
694
    try:
 
695
        revno = branch.revision_id_to_dotted_revno(rev_id)
 
696
    except errors.NoSuchRevision:
 
697
        # The revision must be outside of this branch
 
698
        return None
 
699
    else:
 
700
        return '.'.join(str(n) for n in revno)
 
701
 
 
702
 
585
703
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
586
704
    """Is start_rev_id an obvious ancestor of end_rev_id?"""
587
705
    if start_rev_id and end_rev_id:
588
 
        start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
589
 
        end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
 
706
        try:
 
707
            start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
 
708
            end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
 
709
        except errors.NoSuchRevision:
 
710
            # one or both is not in the branch; not obvious
 
711
            return False
590
712
        if len(start_dotted) == 1 and len(end_dotted) == 1:
591
713
            # both on mainline
592
714
            return start_dotted[0] <= end_dotted[0]
597
719
        else:
598
720
            # not obvious
599
721
            return False
 
722
    # if either start or end is not specified then we use either the first or
 
723
    # the last revision and *they* are obvious ancestors.
600
724
    return True
601
725
 
602
726
 
603
 
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
 
727
def _linear_view_revisions(branch, start_rev_id, end_rev_id,
 
728
                           exclude_common_ancestry=False):
604
729
    """Calculate a sequence of revisions to view, newest to oldest.
605
730
 
606
731
    :param start_rev_id: the lower revision-id
607
732
    :param end_rev_id: the upper revision-id
 
733
    :param exclude_common_ancestry: Whether the start_rev_id should be part of
 
734
        the iterated revisions.
608
735
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
609
736
    :raises _StartNotLinearAncestor: if a start_rev_id is specified but
610
 
      is not found walking the left-hand history
 
737
        is not found walking the left-hand history
611
738
    """
612
739
    br_revno, br_rev_id = branch.last_revision_info()
613
740
    repo = branch.repository
 
741
    graph = repo.get_graph()
614
742
    if start_rev_id is None and end_rev_id is None:
615
743
        cur_revno = br_revno
616
 
        for revision_id in repo.iter_reverse_revision_history(br_rev_id):
 
744
        for revision_id in graph.iter_lefthand_ancestry(br_rev_id,
 
745
            (_mod_revision.NULL_REVISION,)):
617
746
            yield revision_id, str(cur_revno), 0
618
747
            cur_revno -= 1
619
748
    else:
620
749
        if end_rev_id is None:
621
750
            end_rev_id = br_rev_id
622
751
        found_start = start_rev_id is None
623
 
        for revision_id in repo.iter_reverse_revision_history(end_rev_id):
624
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
625
 
            revno_str = '.'.join(str(n) for n in revno)
 
752
        for revision_id in graph.iter_lefthand_ancestry(end_rev_id,
 
753
                (_mod_revision.NULL_REVISION,)):
 
754
            revno_str = _compute_revno_str(branch, revision_id)
626
755
            if not found_start and revision_id == start_rev_id:
627
 
                yield revision_id, revno_str, 0
 
756
                if not exclude_common_ancestry:
 
757
                    yield revision_id, revno_str, 0
628
758
                found_start = True
629
759
                break
630
760
            else:
635
765
 
636
766
 
637
767
def _graph_view_revisions(branch, start_rev_id, end_rev_id,
638
 
    rebase_initial_depths=True):
 
768
                          rebase_initial_depths=True,
 
769
                          exclude_common_ancestry=False):
639
770
    """Calculate revisions to view including merges, newest to oldest.
640
771
 
641
772
    :param branch: the branch
645
776
      revision is found?
646
777
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
647
778
    """
 
779
    if exclude_common_ancestry:
 
780
        stop_rule = 'with-merges-without-common-ancestry'
 
781
    else:
 
782
        stop_rule = 'with-merges'
648
783
    view_revisions = branch.iter_merge_sorted_revisions(
649
784
        start_revision_id=end_rev_id, stop_revision_id=start_rev_id,
650
 
        stop_rule="with-merges")
 
785
        stop_rule=stop_rule)
651
786
    if not rebase_initial_depths:
652
787
        for (rev_id, merge_depth, revno, end_of_merge
653
788
             ) in view_revisions:
664
799
                depth_adjustment = merge_depth
665
800
            if depth_adjustment:
666
801
                if merge_depth < depth_adjustment:
 
802
                    # From now on we reduce the depth adjustement, this can be
 
803
                    # surprising for users. The alternative requires two passes
 
804
                    # which breaks the fast display of the first revision
 
805
                    # though.
667
806
                    depth_adjustment = merge_depth
668
807
                merge_depth -= depth_adjustment
669
808
            yield rev_id, '.'.join(map(str, revno)), merge_depth
670
809
 
671
810
 
672
 
def calculate_view_revisions(branch, start_revision, end_revision, direction,
673
 
        specific_fileid, generate_merge_revisions):
674
 
    """Calculate the revisions to view.
675
 
 
676
 
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
677
 
             a list of the same tuples.
678
 
    """
679
 
    # This method is no longer called by the main code path.
680
 
    # It is retained for API compatibility and may be deprecated
681
 
    # soon. IGC 20090116
682
 
    start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
683
 
        end_revision)
684
 
    view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
685
 
        direction, generate_merge_revisions or specific_fileid))
686
 
    if specific_fileid:
687
 
        view_revisions = _filter_revisions_touching_file_id(branch,
688
 
            specific_fileid, view_revisions,
689
 
            include_merges=generate_merge_revisions)
690
 
    return _rebase_merge_depth(view_revisions)
691
 
 
692
 
 
693
811
def _rebase_merge_depth(view_revisions):
694
812
    """Adjust depths upwards so the top level is 0."""
695
813
    # If either the first or last revision have a merge_depth of 0, we're done
739
857
    return log_rev_iterator
740
858
 
741
859
 
742
 
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
 
860
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
743
861
    """Create a filtered iterator of log_rev_iterator matching on a regex.
744
862
 
745
863
    :param branch: The branch being logged.
746
864
    :param generate_delta: Whether to generate a delta for each revision.
747
 
    :param search: A user text search string.
 
865
    :param match: A dictionary with properties as keys and lists of strings
 
866
        as values. To match, a revision may match any of the supplied strings
 
867
        within a single property but must match at least one string for each
 
868
        property.
748
869
    :param log_rev_iterator: An input iterator containing all revisions that
749
870
        could be displayed, in lists.
750
871
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
751
872
        delta).
752
873
    """
753
 
    if search is None:
 
874
    if match is None:
754
875
        return log_rev_iterator
755
 
    searchRE = re_compile_checked(search, re.IGNORECASE,
756
 
            'log message filter')
757
 
    return _filter_message_re(searchRE, log_rev_iterator)
758
 
 
759
 
 
760
 
def _filter_message_re(searchRE, log_rev_iterator):
 
876
    searchRE = [(k, [re.compile(x, re.IGNORECASE) for x in v])
 
877
                for (k,v) in match.iteritems()]
 
878
    return _filter_re(searchRE, log_rev_iterator)
 
879
 
 
880
 
 
881
def _filter_re(searchRE, log_rev_iterator):
761
882
    for revs in log_rev_iterator:
762
 
        new_revs = []
763
 
        for (rev_id, revno, merge_depth), rev, delta in revs:
764
 
            if searchRE.search(rev.message):
765
 
                new_revs.append(((rev_id, revno, merge_depth), rev, delta))
766
 
        yield new_revs
767
 
 
 
883
        new_revs = [rev for rev in revs if _match_filter(searchRE, rev[1])]
 
884
        if new_revs:
 
885
            yield new_revs
 
886
 
 
887
def _match_filter(searchRE, rev):
 
888
    strings = {
 
889
               'message': (rev.message,),
 
890
               'committer': (rev.committer,),
 
891
               'author': (rev.get_apparent_authors()),
 
892
               'bugs': list(rev.iter_bugs())
 
893
               }
 
894
    strings[''] = [item for inner_list in strings.itervalues()
 
895
                   for item in inner_list]
 
896
    for (k,v) in searchRE:
 
897
        if k in strings and not _match_any_filter(strings[k], v):
 
898
            return False
 
899
    return True
 
900
 
 
901
def _match_any_filter(strings, res):
 
902
    return any([filter(None, map(re.search, strings)) for re in res])
768
903
 
769
904
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
770
905
    fileids=None, direction='reverse'):
843
978
 
844
979
def _update_fileids(delta, fileids, stop_on):
845
980
    """Update the set of file-ids to search based on file lifecycle events.
846
 
    
 
981
 
847
982
    :param fileids: a set of fileids to update
848
983
    :param stop_on: either 'add' or 'remove' - take file-ids out of the
849
984
      fileids set once their add or remove entry is detected respectively
890
1025
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
891
1026
        delta).
892
1027
    """
893
 
    repository = branch.repository
894
1028
    num = 9
895
1029
    for batch in log_rev_iterator:
896
1030
        batch = iter(batch)
945
1079
    if branch_revno != 0:
946
1080
        if (start_rev_id == _mod_revision.NULL_REVISION
947
1081
            or end_rev_id == _mod_revision.NULL_REVISION):
948
 
            raise errors.BzrCommandError('Logging revision 0 is invalid.')
 
1082
            raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
949
1083
        if start_revno > end_revno:
950
 
            raise errors.BzrCommandError("Start revision must be older than "
951
 
                                         "the end revision.")
 
1084
            raise errors.BzrCommandError(gettext("Start revision must be "
 
1085
                                         "older than the end revision."))
952
1086
    return (start_rev_id, end_rev_id)
953
1087
 
954
1088
 
1003
1137
 
1004
1138
    if ((start_rev_id == _mod_revision.NULL_REVISION)
1005
1139
        or (end_rev_id == _mod_revision.NULL_REVISION)):
1006
 
        raise errors.BzrCommandError('Logging revision 0 is invalid.')
 
1140
        raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
1007
1141
    if start_revno > end_revno:
1008
 
        raise errors.BzrCommandError("Start revision must be older than "
1009
 
                                     "the end revision.")
 
1142
        raise errors.BzrCommandError(gettext("Start revision must be older "
 
1143
                                     "than the end revision."))
1010
1144
 
1011
1145
    if end_revno < start_revno:
1012
1146
        return None, None, None, None
1013
1147
    cur_revno = branch_revno
1014
1148
    rev_nos = {}
1015
1149
    mainline_revs = []
1016
 
    for revision_id in branch.repository.iter_reverse_revision_history(
1017
 
                        branch_last_revision):
 
1150
    graph = branch.repository.get_graph()
 
1151
    for revision_id in graph.iter_lefthand_ancestry(
 
1152
            branch_last_revision, (_mod_revision.NULL_REVISION,)):
1018
1153
        if cur_revno < start_revno:
1019
1154
            # We have gone far enough, but we always add 1 more revision
1020
1155
            rev_nos[revision_id] = cur_revno
1034
1169
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
1035
1170
 
1036
1171
 
1037
 
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
1038
 
    """Filter view_revisions based on revision ranges.
1039
 
 
1040
 
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1041
 
            tuples to be filtered.
1042
 
 
1043
 
    :param start_rev_id: If not NONE specifies the first revision to be logged.
1044
 
            If NONE then all revisions up to the end_rev_id are logged.
1045
 
 
1046
 
    :param end_rev_id: If not NONE specifies the last revision to be logged.
1047
 
            If NONE then all revisions up to the end of the log are logged.
1048
 
 
1049
 
    :return: The filtered view_revisions.
1050
 
    """
1051
 
    # This method is no longer called by the main code path.
1052
 
    # It may be removed soon. IGC 20090127
1053
 
    if start_rev_id or end_rev_id:
1054
 
        revision_ids = [r for r, n, d in view_revisions]
1055
 
        if start_rev_id:
1056
 
            start_index = revision_ids.index(start_rev_id)
1057
 
        else:
1058
 
            start_index = 0
1059
 
        if start_rev_id == end_rev_id:
1060
 
            end_index = start_index
1061
 
        else:
1062
 
            if end_rev_id:
1063
 
                end_index = revision_ids.index(end_rev_id)
1064
 
            else:
1065
 
                end_index = len(view_revisions) - 1
1066
 
        # To include the revisions merged into the last revision,
1067
 
        # extend end_rev_id down to, but not including, the next rev
1068
 
        # with the same or lesser merge_depth
1069
 
        end_merge_depth = view_revisions[end_index][2]
1070
 
        try:
1071
 
            for index in xrange(end_index+1, len(view_revisions)+1):
1072
 
                if view_revisions[index][2] <= end_merge_depth:
1073
 
                    end_index = index - 1
1074
 
                    break
1075
 
        except IndexError:
1076
 
            # if the search falls off the end then log to the end as well
1077
 
            end_index = len(view_revisions) - 1
1078
 
        view_revisions = view_revisions[start_index:end_index+1]
1079
 
    return view_revisions
1080
 
 
1081
 
 
1082
1172
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1083
1173
    include_merges=True):
1084
1174
    r"""Return the list of revision ids which touch a given file id.
1087
1177
    This includes the revisions which directly change the file id,
1088
1178
    and the revisions which merge these changes. So if the
1089
1179
    revision graph is::
 
1180
 
1090
1181
        A-.
1091
1182
        |\ \
1092
1183
        B C E
1119
1210
    """
1120
1211
    # Lookup all possible text keys to determine which ones actually modified
1121
1212
    # the file.
 
1213
    graph = branch.repository.get_file_graph()
 
1214
    get_parent_map = graph.get_parent_map
1122
1215
    text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
1123
1216
    next_keys = None
1124
1217
    # Looking up keys in batches of 1000 can cut the time in half, as well as
1128
1221
    #       indexing layer. We might consider passing in hints as to the known
1129
1222
    #       access pattern (sparse/clustered, high success rate/low success
1130
1223
    #       rate). This particular access is clustered with a low success rate.
1131
 
    get_parent_map = branch.repository.texts.get_parent_map
1132
1224
    modified_text_revisions = set()
1133
1225
    chunk_size = 1000
1134
1226
    for start in xrange(0, len(text_keys), chunk_size):
1161
1253
    return result
1162
1254
 
1163
1255
 
1164
 
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
1165
 
                       include_merges=True):
1166
 
    """Produce an iterator of revisions to show
1167
 
    :return: an iterator of (revision_id, revno, merge_depth)
1168
 
    (if there is no revno for a revision, None is supplied)
1169
 
    """
1170
 
    # This method is no longer called by the main code path.
1171
 
    # It is retained for API compatibility and may be deprecated
1172
 
    # soon. IGC 20090127
1173
 
    if not include_merges:
1174
 
        revision_ids = mainline_revs[1:]
1175
 
        if direction == 'reverse':
1176
 
            revision_ids.reverse()
1177
 
        for revision_id in revision_ids:
1178
 
            yield revision_id, str(rev_nos[revision_id]), 0
1179
 
        return
1180
 
    graph = branch.repository.get_graph()
1181
 
    # This asks for all mainline revisions, which means we only have to spider
1182
 
    # sideways, rather than depth history. That said, its still size-of-history
1183
 
    # and should be addressed.
1184
 
    # mainline_revisions always includes an extra revision at the beginning, so
1185
 
    # don't request it.
1186
 
    parent_map = dict(((key, value) for key, value in
1187
 
        graph.iter_ancestry(mainline_revs[1:]) if value is not None))
1188
 
    # filter out ghosts; merge_sort errors on ghosts.
1189
 
    rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
1190
 
    merge_sorted_revisions = tsort.merge_sort(
1191
 
        rev_graph,
1192
 
        mainline_revs[-1],
1193
 
        mainline_revs,
1194
 
        generate_revno=True)
1195
 
 
1196
 
    if direction == 'forward':
1197
 
        # forward means oldest first.
1198
 
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
1199
 
    elif direction != 'reverse':
1200
 
        raise ValueError('invalid direction %r' % direction)
1201
 
 
1202
 
    for (sequence, rev_id, merge_depth, revno, end_of_merge
1203
 
         ) in merge_sorted_revisions:
1204
 
        yield rev_id, '.'.join(map(str, revno)), merge_depth
1205
 
 
1206
 
 
1207
1256
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1208
1257
    """Reverse revisions by depth.
1209
1258
 
1244
1293
    """
1245
1294
 
1246
1295
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1247
 
                 tags=None, diff=None):
 
1296
                 tags=None, diff=None, signature=None):
1248
1297
        self.rev = rev
1249
 
        self.revno = str(revno)
 
1298
        if revno is None:
 
1299
            self.revno = None
 
1300
        else:
 
1301
            self.revno = str(revno)
1250
1302
        self.merge_depth = merge_depth
1251
1303
        self.delta = delta
1252
1304
        self.tags = tags
1253
1305
        self.diff = diff
 
1306
        self.signature = signature
1254
1307
 
1255
1308
 
1256
1309
class LogFormatter(object):
1265
1318
    to indicate which LogRevision attributes it supports:
1266
1319
 
1267
1320
    - supports_delta must be True if this log formatter supports delta.
1268
 
        Otherwise the delta attribute may not be populated.  The 'delta_format'
1269
 
        attribute describes whether the 'short_status' format (1) or the long
1270
 
        one (2) should be used.
 
1321
      Otherwise the delta attribute may not be populated.  The 'delta_format'
 
1322
      attribute describes whether the 'short_status' format (1) or the long
 
1323
      one (2) should be used.
1271
1324
 
1272
1325
    - supports_merge_revisions must be True if this log formatter supports
1273
 
        merge revisions.  If not, then only mainline revisions will be passed
1274
 
        to the formatter.
 
1326
      merge revisions.  If not, then only mainline revisions will be passed
 
1327
      to the formatter.
1275
1328
 
1276
1329
    - preferred_levels is the number of levels this formatter defaults to.
1277
 
        The default value is zero meaning display all levels.
1278
 
        This value is only relevant if supports_merge_revisions is True.
 
1330
      The default value is zero meaning display all levels.
 
1331
      This value is only relevant if supports_merge_revisions is True.
1279
1332
 
1280
1333
    - supports_tags must be True if this log formatter supports tags.
1281
 
        Otherwise the tags attribute may not be populated.
 
1334
      Otherwise the tags attribute may not be populated.
1282
1335
 
1283
1336
    - supports_diff must be True if this log formatter supports diffs.
1284
 
        Otherwise the diff attribute may not be populated.
 
1337
      Otherwise the diff attribute may not be populated.
 
1338
 
 
1339
    - supports_signatures must be True if this log formatter supports GPG
 
1340
      signatures.
1285
1341
 
1286
1342
    Plugins can register functions to show custom revision properties using
1287
1343
    the properties_handler_registry. The registered function
1288
 
    must respect the following interface description:
 
1344
    must respect the following interface description::
 
1345
 
1289
1346
        def my_show_properties(properties_dict):
1290
1347
            # code that returns a dict {'name':'value'} of the properties
1291
1348
            # to be shown
1293
1350
    preferred_levels = 0
1294
1351
 
1295
1352
    def __init__(self, to_file, show_ids=False, show_timezone='original',
1296
 
            delta_format=None, levels=None, show_advice=False,
1297
 
            to_exact_file=None):
 
1353
                 delta_format=None, levels=None, show_advice=False,
 
1354
                 to_exact_file=None, author_list_handler=None):
1298
1355
        """Create a LogFormatter.
1299
1356
 
1300
1357
        :param to_file: the file to output to
1301
 
        :param to_exact_file: if set, gives an output stream to which 
 
1358
        :param to_exact_file: if set, gives an output stream to which
1302
1359
             non-Unicode diffs are written.
1303
1360
        :param show_ids: if True, revision-ids are to be displayed
1304
1361
        :param show_timezone: the timezone to use
1308
1365
          let the log formatter decide.
1309
1366
        :param show_advice: whether to show advice at the end of the
1310
1367
          log or not
 
1368
        :param author_list_handler: callable generating a list of
 
1369
          authors to display for a given revision
1311
1370
        """
1312
1371
        self.to_file = to_file
1313
1372
        # 'exact' stream used to show diff, it should print content 'as is'
1328
1387
        self.levels = levels
1329
1388
        self._show_advice = show_advice
1330
1389
        self._merge_count = 0
 
1390
        self._author_list_handler = author_list_handler
1331
1391
 
1332
1392
    def get_levels(self):
1333
1393
        """Get the number of levels to display or 0 for all."""
1352
1412
            if advice_sep:
1353
1413
                self.to_file.write(advice_sep)
1354
1414
            self.to_file.write(
1355
 
                "Use --include-merges or -n0 to see merged revisions.\n")
 
1415
                "Use --include-merged or -n0 to see merged revisions.\n")
1356
1416
 
1357
1417
    def get_advice_separator(self):
1358
1418
        """Get the text separating the log from the closing advice."""
1365
1425
        return address
1366
1426
 
1367
1427
    def short_author(self, rev):
1368
 
        name, address = config.parse_username(rev.get_apparent_authors()[0])
1369
 
        if name:
1370
 
            return name
1371
 
        return address
 
1428
        return self.authors(rev, 'first', short=True, sep=', ')
 
1429
 
 
1430
    def authors(self, rev, who, short=False, sep=None):
 
1431
        """Generate list of authors, taking --authors option into account.
 
1432
 
 
1433
        The caller has to specify the name of a author list handler,
 
1434
        as provided by the author list registry, using the ``who``
 
1435
        argument.  That name only sets a default, though: when the
 
1436
        user selected a different author list generation using the
 
1437
        ``--authors`` command line switch, as represented by the
 
1438
        ``author_list_handler`` constructor argument, that value takes
 
1439
        precedence.
 
1440
 
 
1441
        :param rev: The revision for which to generate the list of authors.
 
1442
        :param who: Name of the default handler.
 
1443
        :param short: Whether to shorten names to either name or address.
 
1444
        :param sep: What separator to use for automatic concatenation.
 
1445
        """
 
1446
        if self._author_list_handler is not None:
 
1447
            # The user did specify --authors, which overrides the default
 
1448
            author_list_handler = self._author_list_handler
 
1449
        else:
 
1450
            # The user didn't specify --authors, so we use the caller's default
 
1451
            author_list_handler = author_list_registry.get(who)
 
1452
        names = author_list_handler(rev)
 
1453
        if short:
 
1454
            for i in range(len(names)):
 
1455
                name, address = config.parse_username(names[i])
 
1456
                if name:
 
1457
                    names[i] = name
 
1458
                else:
 
1459
                    names[i] = address
 
1460
        if sep is not None:
 
1461
            names = sep.join(names)
 
1462
        return names
1372
1463
 
1373
1464
    def merge_marker(self, revision):
1374
1465
        """Get the merge marker to include in the output or '' if none."""
1405
1496
        """
1406
1497
        # Revision comes directly from a foreign repository
1407
1498
        if isinstance(rev, foreign.ForeignRevision):
1408
 
            return rev.mapping.vcs.show_foreign_revid(rev.foreign_revid)
 
1499
            return self._format_properties(
 
1500
                rev.mapping.vcs.show_foreign_revid(rev.foreign_revid))
1409
1501
 
1410
1502
        # Imported foreign revision revision ids always contain :
1411
1503
        if not ":" in rev.revision_id:
1443
1535
    supports_delta = True
1444
1536
    supports_tags = True
1445
1537
    supports_diff = True
 
1538
    supports_signatures = True
1446
1539
 
1447
1540
    def __init__(self, *args, **kwargs):
1448
1541
        super(LongLogFormatter, self).__init__(*args, **kwargs)
1468
1561
                self.merge_marker(revision)))
1469
1562
        if revision.tags:
1470
1563
            lines.append('tags: %s' % (', '.join(revision.tags)))
1471
 
        if self.show_ids:
 
1564
        if self.show_ids or revision.revno is None:
1472
1565
            lines.append('revision-id: %s' % (revision.rev.revision_id,))
 
1566
        if self.show_ids:
1473
1567
            for parent_id in revision.rev.parent_ids:
1474
1568
                lines.append('parent: %s' % (parent_id,))
1475
1569
        lines.extend(self.custom_properties(revision.rev))
1476
1570
 
1477
1571
        committer = revision.rev.committer
1478
 
        authors = revision.rev.get_apparent_authors()
 
1572
        authors = self.authors(revision.rev, 'all')
1479
1573
        if authors != [committer]:
1480
1574
            lines.append('author: %s' % (", ".join(authors),))
1481
1575
        lines.append('committer: %s' % (committer,))
1486
1580
 
1487
1581
        lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1488
1582
 
 
1583
        if revision.signature is not None:
 
1584
            lines.append('signature: ' + revision.signature)
 
1585
 
1489
1586
        lines.append('message:')
1490
1587
        if not revision.rev.message:
1491
1588
            lines.append('  (no message)')
1498
1595
        to_file = self.to_file
1499
1596
        to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
1500
1597
        if revision.delta is not None:
1501
 
            # We don't respect delta_format for compatibility
1502
 
            revision.delta.show(to_file, self.show_ids, indent=indent,
1503
 
                                short_status=False)
 
1598
            # Use the standard status output to display changes
 
1599
            from bzrlib.delta import report_delta
 
1600
            report_delta(to_file, revision.delta, short_status=False,
 
1601
                         show_ids=self.show_ids, indent=indent)
1504
1602
        if revision.diff is not None:
1505
1603
            to_file.write(indent + 'diff:\n')
1506
1604
            to_file.flush()
1537
1635
        indent = '    ' * depth
1538
1636
        revno_width = self.revno_width_by_depth.get(depth)
1539
1637
        if revno_width is None:
1540
 
            if revision.revno.find('.') == -1:
 
1638
            if revision.revno is None or revision.revno.find('.') == -1:
1541
1639
                # mainline revno, e.g. 12345
1542
1640
                revno_width = 5
1543
1641
            else:
1551
1649
        if revision.tags:
1552
1650
            tags = ' {%s}' % (', '.join(revision.tags))
1553
1651
        to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1554
 
                revision.revno, self.short_author(revision.rev),
 
1652
                revision.revno or "", self.short_author(revision.rev),
1555
1653
                format_date(revision.rev.timestamp,
1556
1654
                            revision.rev.timezone or 0,
1557
1655
                            self.show_timezone, date_fmt="%Y-%m-%d",
1558
1656
                            show_offset=False),
1559
1657
                tags, self.merge_marker(revision)))
1560
1658
        self.show_properties(revision.rev, indent+offset)
1561
 
        if self.show_ids:
 
1659
        if self.show_ids or revision.revno is None:
1562
1660
            to_file.write(indent + offset + 'revision-id:%s\n'
1563
1661
                          % (revision.rev.revision_id,))
1564
1662
        if not revision.rev.message:
1569
1667
                to_file.write(indent + offset + '%s\n' % (l,))
1570
1668
 
1571
1669
        if revision.delta is not None:
1572
 
            revision.delta.show(to_file, self.show_ids, indent=indent + offset,
1573
 
                                short_status=self.delta_format==1)
 
1670
            # Use the standard status output to display changes
 
1671
            from bzrlib.delta import report_delta
 
1672
            report_delta(to_file, revision.delta,
 
1673
                         short_status=self.delta_format==1,
 
1674
                         show_ids=self.show_ids, indent=indent + offset)
1574
1675
        if revision.diff is not None:
1575
1676
            self.show_diff(self.to_exact_file, revision.diff, '      ')
1576
1677
        to_file.write('\n')
1614
1715
 
1615
1716
    def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1616
1717
        """Format log info into one string. Truncate tail of string
1617
 
        :param  revno:      revision number or None.
1618
 
                            Revision numbers counts from 1.
1619
 
        :param  rev:        revision object
1620
 
        :param  max_chars:  maximum length of resulting string
1621
 
        :param  tags:       list of tags or None
1622
 
        :param  prefix:     string to prefix each line
1623
 
        :return:            formatted truncated string
 
1718
 
 
1719
        :param revno:      revision number or None.
 
1720
                           Revision numbers counts from 1.
 
1721
        :param rev:        revision object
 
1722
        :param max_chars:  maximum length of resulting string
 
1723
        :param tags:       list of tags or None
 
1724
        :param prefix:     string to prefix each line
 
1725
        :return:           formatted truncated string
1624
1726
        """
1625
1727
        out = []
1626
1728
        if revno:
1627
1729
            # show revno only when is not None
1628
1730
            out.append("%s:" % revno)
1629
 
        out.append(self.truncate(self.short_author(rev), 20))
 
1731
        if max_chars is not None:
 
1732
            out.append(self.truncate(self.short_author(rev), (max_chars+3)/4))
 
1733
        else:
 
1734
            out.append(self.short_author(rev))
1630
1735
        out.append(self.date_string(rev))
1631
1736
        if len(rev.parent_ids) > 1:
1632
1737
            out.append('[merge]')
1651
1756
                               self.show_timezone,
1652
1757
                               date_fmt='%Y-%m-%d',
1653
1758
                               show_offset=False)
1654
 
        committer_str = revision.rev.committer.replace (' <', '  <')
 
1759
        committer_str = self.authors(revision.rev, 'first', sep=', ')
 
1760
        committer_str = committer_str.replace(' <', '  <')
1655
1761
        to_file.write('%s  %s\n\n' % (date_str,committer_str))
1656
1762
 
1657
1763
        if revision.delta is not None and revision.delta.has_changed():
1719
1825
    try:
1720
1826
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
1721
1827
    except KeyError:
1722
 
        raise errors.BzrCommandError("unknown log formatter: %r" % name)
1723
 
 
1724
 
 
1725
 
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
1726
 
    # deprecated; for compatibility
1727
 
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
1728
 
    lf.show(revno, rev, delta)
 
1828
        raise errors.BzrCommandError(gettext("unknown log formatter: %r") % name)
 
1829
 
 
1830
 
 
1831
def author_list_all(rev):
 
1832
    return rev.get_apparent_authors()[:]
 
1833
 
 
1834
 
 
1835
def author_list_first(rev):
 
1836
    lst = rev.get_apparent_authors()
 
1837
    try:
 
1838
        return [lst[0]]
 
1839
    except IndexError:
 
1840
        return []
 
1841
 
 
1842
 
 
1843
def author_list_committer(rev):
 
1844
    return [rev.committer]
 
1845
 
 
1846
 
 
1847
author_list_registry = registry.Registry()
 
1848
 
 
1849
author_list_registry.register('all', author_list_all,
 
1850
                              'All authors')
 
1851
 
 
1852
author_list_registry.register('first', author_list_first,
 
1853
                              'The first author')
 
1854
 
 
1855
author_list_registry.register('committer', author_list_committer,
 
1856
                              'The committer')
1729
1857
 
1730
1858
 
1731
1859
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1796
1924
    old_revisions = set()
1797
1925
    new_history = []
1798
1926
    new_revisions = set()
1799
 
    new_iter = repository.iter_reverse_revision_history(new_revision_id)
1800
 
    old_iter = repository.iter_reverse_revision_history(old_revision_id)
 
1927
    graph = repository.get_graph()
 
1928
    new_iter = graph.iter_lefthand_ancestry(new_revision_id)
 
1929
    old_iter = graph.iter_lefthand_ancestry(old_revision_id)
1801
1930
    stop_revision = None
1802
1931
    do_old = True
1803
1932
    do_new = True
1878
2007
        lf.log_revision(lr)
1879
2008
 
1880
2009
 
1881
 
def _get_info_for_log_files(revisionspec_list, file_list):
 
2010
def _get_info_for_log_files(revisionspec_list, file_list, add_cleanup):
1882
2011
    """Find file-ids and kinds given a list of files and a revision range.
1883
2012
 
1884
2013
    We search for files at the end of the range. If not found there,
1888
2017
    :param file_list: the list of paths given on the command line;
1889
2018
      the first of these can be a branch location or a file path,
1890
2019
      the remainder must be file paths
 
2020
    :param add_cleanup: When the branch returned is read locked,
 
2021
      an unlock call will be queued to the cleanup.
1891
2022
    :return: (branch, info_list, start_rev_info, end_rev_info) where
1892
2023
      info_list is a list of (relative_path, file_id, kind) tuples where
1893
2024
      kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
1894
2025
      branch will be read-locked.
1895
2026
    """
1896
 
    from builtins import _get_revision_range, safe_relpath_files
 
2027
    from builtins import _get_revision_range
1897
2028
    tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
1898
 
    b.lock_read()
 
2029
    add_cleanup(b.lock_read().unlock)
1899
2030
    # XXX: It's damn messy converting a list of paths to relative paths when
1900
2031
    # those paths might be deleted ones, they might be on a case-insensitive
1901
2032
    # filesystem and/or they might be in silly locations (like another branch).
1905
2036
    # case of running log in a nested directory, assuming paths beyond the
1906
2037
    # first one haven't been deleted ...
1907
2038
    if tree:
1908
 
        relpaths = [path] + safe_relpath_files(tree, file_list[1:])
 
2039
        relpaths = [path] + tree.safe_relpath_files(file_list[1:])
1909
2040
    else:
1910
2041
        relpaths = [path] + file_list[1:]
1911
2042
    info_list = []
1980
2111
 
1981
2112
properties_handler_registry = registry.Registry()
1982
2113
 
 
2114
# Use the properties handlers to print out bug information if available
 
2115
def _bugs_properties_handler(revision):
 
2116
    if revision.properties.has_key('bugs'):
 
2117
        bug_lines = revision.properties['bugs'].split('\n')
 
2118
        bug_rows = [line.split(' ', 1) for line in bug_lines]
 
2119
        fixed_bug_urls = [row[0] for row in bug_rows if
 
2120
                          len(row) > 1 and row[1] == 'fixed']
 
2121
 
 
2122
        if fixed_bug_urls:
 
2123
            return {ngettext('fixes bug', 'fixes bugs', len(fixed_bug_urls)):\
 
2124
                    ' '.join(fixed_bug_urls)}
 
2125
    return {}
 
2126
 
 
2127
properties_handler_registry.register('bugs_properties_handler',
 
2128
                                     _bugs_properties_handler)
 
2129
 
1983
2130
 
1984
2131
# adapters which revision ids to log are filtered. When log is called, the
1985
2132
# log_rev_iterator is adapted through each of these factory methods.