~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Jonathan Riddell
  • Date: 2011-09-20 11:01:37 UTC
  • mto: This revision was merged to the branch mainline in revision 6153.
  • Revision ID: jriddell@canonical.com-20110920110137-mrps089ulocx1skd
gettext() in plugin.py and hooks.py

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 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
 
from bzrlib.symbol_versioning import (
92
 
    deprecated_function,
93
 
    deprecated_in,
94
 
    )
95
92
 
96
93
 
97
94
def find_touching_revisions(branch, file_id):
110
107
    revno = 1
111
108
    for revision_id in branch.revision_history():
112
109
        this_inv = branch.repository.get_inventory(revision_id)
113
 
        if file_id in this_inv:
 
110
        if this_inv.has_id(file_id):
114
111
            this_ie = this_inv[file_id]
115
112
            this_path = this_inv.id2path(file_id)
116
113
        else:
156
153
             end_revision=None,
157
154
             search=None,
158
155
             limit=None,
159
 
             show_diff=False):
 
156
             show_diff=False,
 
157
             match=None):
160
158
    """Write out human-readable log of commits to this branch.
161
159
 
162
160
    This function is being retained for backwards compatibility but
185
183
        if None or 0.
186
184
 
187
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.
188
189
    """
189
190
    # Convert old-style parameters to new-style parameters
190
191
    if specific_fileid is not None:
214
215
    Logger(branch, rqst).show(lf)
215
216
 
216
217
 
217
 
# 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
218
219
# make_log_request_dict() below
219
220
_DEFAULT_REQUEST_PARAMS = {
220
221
    'direction': 'reverse',
221
 
    'levels': 1,
 
222
    'levels': None,
222
223
    'generate_tags': True,
223
224
    'exclude_common_ancestry': False,
224
225
    '_match_using_deltas': True,
227
228
 
228
229
def make_log_request_dict(direction='reverse', specific_fileids=None,
229
230
                          start_revision=None, end_revision=None, limit=None,
230
 
                          message_search=None, levels=1, generate_tags=True,
 
231
                          message_search=None, levels=None, generate_tags=True,
231
232
                          delta_type=None,
232
233
                          diff_type=None, _match_using_deltas=True,
233
 
                          exclude_common_ancestry=False,
 
234
                          exclude_common_ancestry=False, match=None,
 
235
                          signature=False, omit_merges=False,
234
236
                          ):
235
237
    """Convenience function for making a logging request dictionary.
236
238
 
257
259
      matching commit messages
258
260
 
259
261
    :param levels: the number of levels of revisions to
260
 
      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.
261
264
 
262
265
    :param generate_tags: If True, include tags for matched revisions.
263
 
 
 
266
`
264
267
    :param delta_type: Either 'full', 'partial' or None.
265
268
      'full' means generate the complete delta - adds/deletes/modifies/etc;
266
269
      'partial' means filter the delta using specific_fileids;
278
281
 
279
282
    :param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
280
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
 
281
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] }
282
304
    return {
283
305
        'direction': direction,
284
306
        'specific_fileids': specific_fileids,
285
307
        'start_revision': start_revision,
286
308
        'end_revision': end_revision,
287
309
        'limit': limit,
288
 
        'message_search': message_search,
289
310
        'levels': levels,
290
311
        'generate_tags': generate_tags,
291
312
        'delta_type': delta_type,
292
313
        'diff_type': diff_type,
293
314
        'exclude_common_ancestry': exclude_common_ancestry,
 
315
        'signature': signature,
 
316
        'match': match,
 
317
        'omit_merges': omit_merges,
294
318
        # Add 'private' attributes for features that may be deprecated
295
319
        '_match_using_deltas': _match_using_deltas,
296
320
    }
298
322
 
299
323
def _apply_log_request_defaults(rqst):
300
324
    """Apply default values to a request dictionary."""
301
 
    result = _DEFAULT_REQUEST_PARAMS
 
325
    result = _DEFAULT_REQUEST_PARAMS.copy()
302
326
    if rqst:
303
327
        result.update(rqst)
304
328
    return result
305
329
 
306
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
 
307
352
class LogGenerator(object):
308
353
    """A generator of log revisions."""
309
354
 
354
399
        # Tweak the LogRequest based on what the LogFormatter can handle.
355
400
        # (There's no point generating stuff if the formatter can't display it.)
356
401
        rqst = self.rqst
357
 
        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
 
358
406
        if not getattr(lf, 'supports_tags', False):
359
407
            rqst['generate_tags'] = False
360
408
        if not getattr(lf, 'supports_delta', False):
361
409
            rqst['delta_type'] = None
362
410
        if not getattr(lf, 'supports_diff', False):
363
411
            rqst['diff_type'] = None
 
412
        if not getattr(lf, 'supports_signatures', False):
 
413
            rqst['signature'] = False
364
414
 
365
415
        # Find and print the interesting revisions
366
416
        generator = self._generator_factory(self.branch, rqst)
370
420
 
371
421
    def _generator_factory(self, branch, rqst):
372
422
        """Make the LogGenerator object to use.
373
 
        
 
423
 
374
424
        Subclasses may wish to override this.
375
425
        """
376
426
        return _DefaultLogGenerator(branch, rqst)
400
450
        levels = rqst.get('levels')
401
451
        limit = rqst.get('limit')
402
452
        diff_type = rqst.get('diff_type')
 
453
        show_signature = rqst.get('signature')
 
454
        omit_merges = rqst.get('omit_merges')
403
455
        log_count = 0
404
456
        revision_iterator = self._create_log_revision_iterator()
405
457
        for revs in revision_iterator:
407
459
                # 0 levels means show everything; merge_depth counts from 0
408
460
                if levels != 0 and merge_depth >= levels:
409
461
                    continue
 
462
                if omit_merges and len(rev.parent_ids) > 1:
 
463
                    continue
410
464
                if diff_type is None:
411
465
                    diff = None
412
466
                else:
413
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
414
473
                yield LogRevision(rev, revno, merge_depth, delta,
415
 
                    self.rev_tag_dict.get(rev_id), diff)
 
474
                    self.rev_tag_dict.get(rev_id), diff, signature)
416
475
                if limit:
417
476
                    log_count += 1
418
477
                    if log_count >= limit:
432
491
        else:
433
492
            specific_files = None
434
493
        s = StringIO()
 
494
        path_encoding = get_diff_header_encoding()
435
495
        diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
436
 
            new_label='')
 
496
            new_label='', path_encoding=path_encoding)
437
497
        return s.getvalue()
438
498
 
439
499
    def _create_log_revision_iterator(self):
472
532
 
473
533
        # Apply the other filters
474
534
        return make_log_rev_iterator(self.branch, view_revisions,
475
 
            rqst.get('delta_type'), rqst.get('message_search'),
 
535
            rqst.get('delta_type'), rqst.get('match'),
476
536
            file_ids=rqst.get('specific_fileids'),
477
537
            direction=rqst.get('direction'))
478
538
 
491
551
            rqst.get('specific_fileids')[0], view_revisions,
492
552
            include_merges=rqst.get('levels') != 1)
493
553
        return make_log_rev_iterator(self.branch, view_revisions,
494
 
            rqst.get('delta_type'), rqst.get('message_search'))
 
554
            rqst.get('delta_type'), rqst.get('match'))
495
555
 
496
556
 
497
557
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
505
565
             a list of the same tuples.
506
566
    """
507
567
    if (exclude_common_ancestry and start_rev_id == end_rev_id):
508
 
        raise errors.BzrCommandError(
509
 
            '--exclude-common-ancestry requires two different revisions')
 
568
        raise errors.BzrCommandError(gettext(
 
569
            '--exclude-common-ancestry requires two different revisions'))
510
570
    if direction not in ('reverse', 'forward'):
511
 
        raise ValueError('invalid direction %r' % direction)
 
571
        raise ValueError(gettext('invalid direction %r') % direction)
512
572
    br_revno, br_rev_id = branch.last_revision_info()
513
573
    if br_revno == 0:
514
574
        return []
522
582
    elif not generate_merge_revisions:
523
583
        # If we only want to see linear revisions, we can iterate ...
524
584
        iter_revs = _generate_flat_revisions(branch, start_rev_id, end_rev_id,
525
 
                                             direction)
 
585
                                             direction, exclude_common_ancestry)
526
586
        if direction == 'forward':
527
587
            iter_revs = reversed(iter_revs)
528
588
    else:
539
599
        # It's the tip
540
600
        return [(br_rev_id, br_revno, 0)]
541
601
    else:
542
 
        revno = branch.revision_id_to_dotted_revno(rev_id)
543
 
        revno_str = '.'.join(str(n) for n in revno)
 
602
        revno_str = _compute_revno_str(branch, rev_id)
544
603
        return [(rev_id, revno_str, 0)]
545
604
 
546
605
 
547
 
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction):
548
 
    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)
549
611
    # If a start limit was given and it's not obviously an
550
612
    # ancestor of the end limit, check it before outputting anything
551
613
    if direction == 'forward' or (start_rev_id
553
615
        try:
554
616
            result = list(result)
555
617
        except _StartNotLinearAncestor:
556
 
            raise errors.BzrCommandError('Start revision not found in'
557
 
                ' left-hand history of end revision.')
 
618
            raise errors.BzrCommandError(gettext('Start revision not found in'
 
619
                ' left-hand history of end revision.'))
558
620
    return result
559
621
 
560
622
 
572
634
    if delayed_graph_generation:
573
635
        try:
574
636
            for rev_id, revno, depth in  _linear_view_revisions(
575
 
                branch, start_rev_id, end_rev_id):
 
637
                branch, start_rev_id, end_rev_id, exclude_common_ancestry):
576
638
                if _has_merges(branch, rev_id):
577
639
                    # The end_rev_id can be nested down somewhere. We need an
578
640
                    # explicit ancestry check. There is an ambiguity here as we
599
661
        except _StartNotLinearAncestor:
600
662
            # A merge was never detected so the lower revision limit can't
601
663
            # be nested down somewhere
602
 
            raise errors.BzrCommandError('Start revision not found in'
603
 
                ' history of end revision.')
 
664
            raise errors.BzrCommandError(gettext('Start revision not found in'
 
665
                ' history of end revision.'))
604
666
 
605
667
    # We exit the loop above because we encounter a revision with merges, from
606
668
    # this revision, we need to switch to _graph_view_revisions.
623
685
    return len(parents) > 1
624
686
 
625
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
 
626
703
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
627
704
    """Is start_rev_id an obvious ancestor of end_rev_id?"""
628
705
    if start_rev_id and end_rev_id:
629
 
        start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
630
 
        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
631
712
        if len(start_dotted) == 1 and len(end_dotted) == 1:
632
713
            # both on mainline
633
714
            return start_dotted[0] <= end_dotted[0]
643
724
    return True
644
725
 
645
726
 
646
 
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):
647
729
    """Calculate a sequence of revisions to view, newest to oldest.
648
730
 
649
731
    :param start_rev_id: the lower revision-id
650
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.
651
735
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
652
736
    :raises _StartNotLinearAncestor: if a start_rev_id is specified but
653
 
      is not found walking the left-hand history
 
737
        is not found walking the left-hand history
654
738
    """
655
739
    br_revno, br_rev_id = branch.last_revision_info()
656
740
    repo = branch.repository
 
741
    graph = repo.get_graph()
657
742
    if start_rev_id is None and end_rev_id is None:
658
743
        cur_revno = br_revno
659
 
        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,)):
660
746
            yield revision_id, str(cur_revno), 0
661
747
            cur_revno -= 1
662
748
    else:
663
749
        if end_rev_id is None:
664
750
            end_rev_id = br_rev_id
665
751
        found_start = start_rev_id is None
666
 
        for revision_id in repo.iter_reverse_revision_history(end_rev_id):
667
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
668
 
            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)
669
755
            if not found_start and revision_id == start_rev_id:
670
 
                yield revision_id, revno_str, 0
 
756
                if not exclude_common_ancestry:
 
757
                    yield revision_id, revno_str, 0
671
758
                found_start = True
672
759
                break
673
760
            else:
721
808
            yield rev_id, '.'.join(map(str, revno)), merge_depth
722
809
 
723
810
 
724
 
@deprecated_function(deprecated_in((2, 2, 0)))
725
 
def calculate_view_revisions(branch, start_revision, end_revision, direction,
726
 
        specific_fileid, generate_merge_revisions):
727
 
    """Calculate the revisions to view.
728
 
 
729
 
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
730
 
             a list of the same tuples.
731
 
    """
732
 
    start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
733
 
        end_revision)
734
 
    view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
735
 
        direction, generate_merge_revisions or specific_fileid))
736
 
    if specific_fileid:
737
 
        view_revisions = _filter_revisions_touching_file_id(branch,
738
 
            specific_fileid, view_revisions,
739
 
            include_merges=generate_merge_revisions)
740
 
    return _rebase_merge_depth(view_revisions)
741
 
 
742
 
 
743
811
def _rebase_merge_depth(view_revisions):
744
812
    """Adjust depths upwards so the top level is 0."""
745
813
    # If either the first or last revision have a merge_depth of 0, we're done
789
857
    return log_rev_iterator
790
858
 
791
859
 
792
 
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
 
860
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
793
861
    """Create a filtered iterator of log_rev_iterator matching on a regex.
794
862
 
795
863
    :param branch: The branch being logged.
796
864
    :param generate_delta: Whether to generate a delta for each revision.
797
 
    :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.
798
869
    :param log_rev_iterator: An input iterator containing all revisions that
799
870
        could be displayed, in lists.
800
871
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
801
872
        delta).
802
873
    """
803
 
    if search is None:
 
874
    if match is None:
804
875
        return log_rev_iterator
805
 
    searchRE = re_compile_checked(search, re.IGNORECASE,
806
 
            'log message filter')
807
 
    return _filter_message_re(searchRE, log_rev_iterator)
808
 
 
809
 
 
810
 
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):
811
882
    for revs in log_rev_iterator:
812
 
        new_revs = []
813
 
        for (rev_id, revno, merge_depth), rev, delta in revs:
814
 
            if searchRE.search(rev.message):
815
 
                new_revs.append(((rev_id, revno, merge_depth), rev, delta))
816
 
        yield new_revs
817
 
 
 
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])
818
903
 
819
904
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
820
905
    fileids=None, direction='reverse'):
893
978
 
894
979
def _update_fileids(delta, fileids, stop_on):
895
980
    """Update the set of file-ids to search based on file lifecycle events.
896
 
    
 
981
 
897
982
    :param fileids: a set of fileids to update
898
983
    :param stop_on: either 'add' or 'remove' - take file-ids out of the
899
984
      fileids set once their add or remove entry is detected respectively
940
1025
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
941
1026
        delta).
942
1027
    """
943
 
    repository = branch.repository
944
1028
    num = 9
945
1029
    for batch in log_rev_iterator:
946
1030
        batch = iter(batch)
995
1079
    if branch_revno != 0:
996
1080
        if (start_rev_id == _mod_revision.NULL_REVISION
997
1081
            or end_rev_id == _mod_revision.NULL_REVISION):
998
 
            raise errors.BzrCommandError('Logging revision 0 is invalid.')
 
1082
            raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
999
1083
        if start_revno > end_revno:
1000
 
            raise errors.BzrCommandError("Start revision must be older than "
1001
 
                                         "the end revision.")
 
1084
            raise errors.BzrCommandError(gettext("Start revision must be "
 
1085
                                         "older than the end revision."))
1002
1086
    return (start_rev_id, end_rev_id)
1003
1087
 
1004
1088
 
1053
1137
 
1054
1138
    if ((start_rev_id == _mod_revision.NULL_REVISION)
1055
1139
        or (end_rev_id == _mod_revision.NULL_REVISION)):
1056
 
        raise errors.BzrCommandError('Logging revision 0 is invalid.')
 
1140
        raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
1057
1141
    if start_revno > end_revno:
1058
 
        raise errors.BzrCommandError("Start revision must be older than "
1059
 
                                     "the end revision.")
 
1142
        raise errors.BzrCommandError(gettext("Start revision must be older "
 
1143
                                     "than the end revision."))
1060
1144
 
1061
1145
    if end_revno < start_revno:
1062
1146
        return None, None, None, None
1063
1147
    cur_revno = branch_revno
1064
1148
    rev_nos = {}
1065
1149
    mainline_revs = []
1066
 
    for revision_id in branch.repository.iter_reverse_revision_history(
1067
 
                        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,)):
1068
1153
        if cur_revno < start_revno:
1069
1154
            # We have gone far enough, but we always add 1 more revision
1070
1155
            rev_nos[revision_id] = cur_revno
1084
1169
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
1085
1170
 
1086
1171
 
1087
 
@deprecated_function(deprecated_in((2, 2, 0)))
1088
 
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
1089
 
    """Filter view_revisions based on revision ranges.
1090
 
 
1091
 
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1092
 
            tuples to be filtered.
1093
 
 
1094
 
    :param start_rev_id: If not NONE specifies the first revision to be logged.
1095
 
            If NONE then all revisions up to the end_rev_id are logged.
1096
 
 
1097
 
    :param end_rev_id: If not NONE specifies the last revision to be logged.
1098
 
            If NONE then all revisions up to the end of the log are logged.
1099
 
 
1100
 
    :return: The filtered view_revisions.
1101
 
    """
1102
 
    if start_rev_id or end_rev_id:
1103
 
        revision_ids = [r for r, n, d in view_revisions]
1104
 
        if start_rev_id:
1105
 
            start_index = revision_ids.index(start_rev_id)
1106
 
        else:
1107
 
            start_index = 0
1108
 
        if start_rev_id == end_rev_id:
1109
 
            end_index = start_index
1110
 
        else:
1111
 
            if end_rev_id:
1112
 
                end_index = revision_ids.index(end_rev_id)
1113
 
            else:
1114
 
                end_index = len(view_revisions) - 1
1115
 
        # To include the revisions merged into the last revision,
1116
 
        # extend end_rev_id down to, but not including, the next rev
1117
 
        # with the same or lesser merge_depth
1118
 
        end_merge_depth = view_revisions[end_index][2]
1119
 
        try:
1120
 
            for index in xrange(end_index+1, len(view_revisions)+1):
1121
 
                if view_revisions[index][2] <= end_merge_depth:
1122
 
                    end_index = index - 1
1123
 
                    break
1124
 
        except IndexError:
1125
 
            # if the search falls off the end then log to the end as well
1126
 
            end_index = len(view_revisions) - 1
1127
 
        view_revisions = view_revisions[start_index:end_index+1]
1128
 
    return view_revisions
1129
 
 
1130
 
 
1131
1172
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1132
1173
    include_merges=True):
1133
1174
    r"""Return the list of revision ids which touch a given file id.
1136
1177
    This includes the revisions which directly change the file id,
1137
1178
    and the revisions which merge these changes. So if the
1138
1179
    revision graph is::
 
1180
 
1139
1181
        A-.
1140
1182
        |\ \
1141
1183
        B C E
1168
1210
    """
1169
1211
    # Lookup all possible text keys to determine which ones actually modified
1170
1212
    # the file.
 
1213
    graph = branch.repository.get_file_graph()
 
1214
    get_parent_map = graph.get_parent_map
1171
1215
    text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
1172
1216
    next_keys = None
1173
1217
    # Looking up keys in batches of 1000 can cut the time in half, as well as
1177
1221
    #       indexing layer. We might consider passing in hints as to the known
1178
1222
    #       access pattern (sparse/clustered, high success rate/low success
1179
1223
    #       rate). This particular access is clustered with a low success rate.
1180
 
    get_parent_map = branch.repository.texts.get_parent_map
1181
1224
    modified_text_revisions = set()
1182
1225
    chunk_size = 1000
1183
1226
    for start in xrange(0, len(text_keys), chunk_size):
1210
1253
    return result
1211
1254
 
1212
1255
 
1213
 
@deprecated_function(deprecated_in((2, 2, 0)))
1214
 
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
1215
 
                       include_merges=True):
1216
 
    """Produce an iterator of revisions to show
1217
 
    :return: an iterator of (revision_id, revno, merge_depth)
1218
 
    (if there is no revno for a revision, None is supplied)
1219
 
    """
1220
 
    if not include_merges:
1221
 
        revision_ids = mainline_revs[1:]
1222
 
        if direction == 'reverse':
1223
 
            revision_ids.reverse()
1224
 
        for revision_id in revision_ids:
1225
 
            yield revision_id, str(rev_nos[revision_id]), 0
1226
 
        return
1227
 
    graph = branch.repository.get_graph()
1228
 
    # This asks for all mainline revisions, which means we only have to spider
1229
 
    # sideways, rather than depth history. That said, its still size-of-history
1230
 
    # and should be addressed.
1231
 
    # mainline_revisions always includes an extra revision at the beginning, so
1232
 
    # don't request it.
1233
 
    parent_map = dict(((key, value) for key, value in
1234
 
        graph.iter_ancestry(mainline_revs[1:]) if value is not None))
1235
 
    # filter out ghosts; merge_sort errors on ghosts.
1236
 
    rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
1237
 
    merge_sorted_revisions = tsort.merge_sort(
1238
 
        rev_graph,
1239
 
        mainline_revs[-1],
1240
 
        mainline_revs,
1241
 
        generate_revno=True)
1242
 
 
1243
 
    if direction == 'forward':
1244
 
        # forward means oldest first.
1245
 
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
1246
 
    elif direction != 'reverse':
1247
 
        raise ValueError('invalid direction %r' % direction)
1248
 
 
1249
 
    for (sequence, rev_id, merge_depth, revno, end_of_merge
1250
 
         ) in merge_sorted_revisions:
1251
 
        yield rev_id, '.'.join(map(str, revno)), merge_depth
1252
 
 
1253
 
 
1254
1256
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1255
1257
    """Reverse revisions by depth.
1256
1258
 
1291
1293
    """
1292
1294
 
1293
1295
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1294
 
                 tags=None, diff=None):
 
1296
                 tags=None, diff=None, signature=None):
1295
1297
        self.rev = rev
1296
 
        self.revno = str(revno)
 
1298
        if revno is None:
 
1299
            self.revno = None
 
1300
        else:
 
1301
            self.revno = str(revno)
1297
1302
        self.merge_depth = merge_depth
1298
1303
        self.delta = delta
1299
1304
        self.tags = tags
1300
1305
        self.diff = diff
 
1306
        self.signature = signature
1301
1307
 
1302
1308
 
1303
1309
class LogFormatter(object):
1312
1318
    to indicate which LogRevision attributes it supports:
1313
1319
 
1314
1320
    - supports_delta must be True if this log formatter supports delta.
1315
 
        Otherwise the delta attribute may not be populated.  The 'delta_format'
1316
 
        attribute describes whether the 'short_status' format (1) or the long
1317
 
        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.
1318
1324
 
1319
1325
    - supports_merge_revisions must be True if this log formatter supports
1320
 
        merge revisions.  If not, then only mainline revisions will be passed
1321
 
        to the formatter.
 
1326
      merge revisions.  If not, then only mainline revisions will be passed
 
1327
      to the formatter.
1322
1328
 
1323
1329
    - preferred_levels is the number of levels this formatter defaults to.
1324
 
        The default value is zero meaning display all levels.
1325
 
        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.
1326
1332
 
1327
1333
    - supports_tags must be True if this log formatter supports tags.
1328
 
        Otherwise the tags attribute may not be populated.
 
1334
      Otherwise the tags attribute may not be populated.
1329
1335
 
1330
1336
    - supports_diff must be True if this log formatter supports diffs.
1331
 
        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.
1332
1341
 
1333
1342
    Plugins can register functions to show custom revision properties using
1334
1343
    the properties_handler_registry. The registered function
1335
 
    must respect the following interface description:
 
1344
    must respect the following interface description::
 
1345
 
1336
1346
        def my_show_properties(properties_dict):
1337
1347
            # code that returns a dict {'name':'value'} of the properties
1338
1348
            # to be shown
1341
1351
 
1342
1352
    def __init__(self, to_file, show_ids=False, show_timezone='original',
1343
1353
                 delta_format=None, levels=None, show_advice=False,
1344
 
                 to_exact_file=None):
 
1354
                 to_exact_file=None, author_list_handler=None):
1345
1355
        """Create a LogFormatter.
1346
1356
 
1347
1357
        :param to_file: the file to output to
1348
 
        :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
1349
1359
             non-Unicode diffs are written.
1350
1360
        :param show_ids: if True, revision-ids are to be displayed
1351
1361
        :param show_timezone: the timezone to use
1355
1365
          let the log formatter decide.
1356
1366
        :param show_advice: whether to show advice at the end of the
1357
1367
          log or not
 
1368
        :param author_list_handler: callable generating a list of
 
1369
          authors to display for a given revision
1358
1370
        """
1359
1371
        self.to_file = to_file
1360
1372
        # 'exact' stream used to show diff, it should print content 'as is'
1375
1387
        self.levels = levels
1376
1388
        self._show_advice = show_advice
1377
1389
        self._merge_count = 0
 
1390
        self._author_list_handler = author_list_handler
1378
1391
 
1379
1392
    def get_levels(self):
1380
1393
        """Get the number of levels to display or 0 for all."""
1399
1412
            if advice_sep:
1400
1413
                self.to_file.write(advice_sep)
1401
1414
            self.to_file.write(
1402
 
                "Use --include-merges or -n0 to see merged revisions.\n")
 
1415
                "Use --include-merged or -n0 to see merged revisions.\n")
1403
1416
 
1404
1417
    def get_advice_separator(self):
1405
1418
        """Get the text separating the log from the closing advice."""
1412
1425
        return address
1413
1426
 
1414
1427
    def short_author(self, rev):
1415
 
        name, address = config.parse_username(rev.get_apparent_authors()[0])
1416
 
        if name:
1417
 
            return name
1418
 
        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
1419
1463
 
1420
1464
    def merge_marker(self, revision):
1421
1465
        """Get the merge marker to include in the output or '' if none."""
1491
1535
    supports_delta = True
1492
1536
    supports_tags = True
1493
1537
    supports_diff = True
 
1538
    supports_signatures = True
1494
1539
 
1495
1540
    def __init__(self, *args, **kwargs):
1496
1541
        super(LongLogFormatter, self).__init__(*args, **kwargs)
1516
1561
                self.merge_marker(revision)))
1517
1562
        if revision.tags:
1518
1563
            lines.append('tags: %s' % (', '.join(revision.tags)))
1519
 
        if self.show_ids:
 
1564
        if self.show_ids or revision.revno is None:
1520
1565
            lines.append('revision-id: %s' % (revision.rev.revision_id,))
 
1566
        if self.show_ids:
1521
1567
            for parent_id in revision.rev.parent_ids:
1522
1568
                lines.append('parent: %s' % (parent_id,))
1523
1569
        lines.extend(self.custom_properties(revision.rev))
1524
1570
 
1525
1571
        committer = revision.rev.committer
1526
 
        authors = revision.rev.get_apparent_authors()
 
1572
        authors = self.authors(revision.rev, 'all')
1527
1573
        if authors != [committer]:
1528
1574
            lines.append('author: %s' % (", ".join(authors),))
1529
1575
        lines.append('committer: %s' % (committer,))
1534
1580
 
1535
1581
        lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1536
1582
 
 
1583
        if revision.signature is not None:
 
1584
            lines.append('signature: ' + revision.signature)
 
1585
 
1537
1586
        lines.append('message:')
1538
1587
        if not revision.rev.message:
1539
1588
            lines.append('  (no message)')
1548
1597
        if revision.delta is not None:
1549
1598
            # Use the standard status output to display changes
1550
1599
            from bzrlib.delta import report_delta
1551
 
            report_delta(to_file, revision.delta, short_status=False, 
 
1600
            report_delta(to_file, revision.delta, short_status=False,
1552
1601
                         show_ids=self.show_ids, indent=indent)
1553
1602
        if revision.diff is not None:
1554
1603
            to_file.write(indent + 'diff:\n')
1586
1635
        indent = '    ' * depth
1587
1636
        revno_width = self.revno_width_by_depth.get(depth)
1588
1637
        if revno_width is None:
1589
 
            if revision.revno.find('.') == -1:
 
1638
            if revision.revno is None or revision.revno.find('.') == -1:
1590
1639
                # mainline revno, e.g. 12345
1591
1640
                revno_width = 5
1592
1641
            else:
1600
1649
        if revision.tags:
1601
1650
            tags = ' {%s}' % (', '.join(revision.tags))
1602
1651
        to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1603
 
                revision.revno, self.short_author(revision.rev),
 
1652
                revision.revno or "", self.short_author(revision.rev),
1604
1653
                format_date(revision.rev.timestamp,
1605
1654
                            revision.rev.timezone or 0,
1606
1655
                            self.show_timezone, date_fmt="%Y-%m-%d",
1607
1656
                            show_offset=False),
1608
1657
                tags, self.merge_marker(revision)))
1609
1658
        self.show_properties(revision.rev, indent+offset)
1610
 
        if self.show_ids:
 
1659
        if self.show_ids or revision.revno is None:
1611
1660
            to_file.write(indent + offset + 'revision-id:%s\n'
1612
1661
                          % (revision.rev.revision_id,))
1613
1662
        if not revision.rev.message:
1620
1669
        if revision.delta is not None:
1621
1670
            # Use the standard status output to display changes
1622
1671
            from bzrlib.delta import report_delta
1623
 
            report_delta(to_file, revision.delta, 
1624
 
                         short_status=self.delta_format==1, 
 
1672
            report_delta(to_file, revision.delta,
 
1673
                         short_status=self.delta_format==1,
1625
1674
                         show_ids=self.show_ids, indent=indent + offset)
1626
1675
        if revision.diff is not None:
1627
1676
            self.show_diff(self.to_exact_file, revision.diff, '      ')
1666
1715
 
1667
1716
    def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1668
1717
        """Format log info into one string. Truncate tail of string
1669
 
        :param  revno:      revision number or None.
1670
 
                            Revision numbers counts from 1.
1671
 
        :param  rev:        revision object
1672
 
        :param  max_chars:  maximum length of resulting string
1673
 
        :param  tags:       list of tags or None
1674
 
        :param  prefix:     string to prefix each line
1675
 
        :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
1676
1726
        """
1677
1727
        out = []
1678
1728
        if revno:
1679
1729
            # show revno only when is not None
1680
1730
            out.append("%s:" % revno)
1681
 
        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))
1682
1735
        out.append(self.date_string(rev))
1683
1736
        if len(rev.parent_ids) > 1:
1684
1737
            out.append('[merge]')
1703
1756
                               self.show_timezone,
1704
1757
                               date_fmt='%Y-%m-%d',
1705
1758
                               show_offset=False)
1706
 
        committer_str = revision.rev.get_apparent_authors()[0].replace (' <', '  <')
 
1759
        committer_str = self.authors(revision.rev, 'first', sep=', ')
 
1760
        committer_str = committer_str.replace(' <', '  <')
1707
1761
        to_file.write('%s  %s\n\n' % (date_str,committer_str))
1708
1762
 
1709
1763
        if revision.delta is not None and revision.delta.has_changed():
1771
1825
    try:
1772
1826
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
1773
1827
    except KeyError:
1774
 
        raise errors.BzrCommandError("unknown log formatter: %r" % name)
1775
 
 
1776
 
 
1777
 
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
1778
 
    # deprecated; for compatibility
1779
 
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
1780
 
    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')
1781
1857
 
1782
1858
 
1783
1859
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1848
1924
    old_revisions = set()
1849
1925
    new_history = []
1850
1926
    new_revisions = set()
1851
 
    new_iter = repository.iter_reverse_revision_history(new_revision_id)
1852
 
    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)
1853
1930
    stop_revision = None
1854
1931
    do_old = True
1855
1932
    do_new = True
1930
2007
        lf.log_revision(lr)
1931
2008
 
1932
2009
 
1933
 
def _get_info_for_log_files(revisionspec_list, file_list):
 
2010
def _get_info_for_log_files(revisionspec_list, file_list, add_cleanup):
1934
2011
    """Find file-ids and kinds given a list of files and a revision range.
1935
2012
 
1936
2013
    We search for files at the end of the range. If not found there,
1940
2017
    :param file_list: the list of paths given on the command line;
1941
2018
      the first of these can be a branch location or a file path,
1942
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.
1943
2022
    :return: (branch, info_list, start_rev_info, end_rev_info) where
1944
2023
      info_list is a list of (relative_path, file_id, kind) tuples where
1945
2024
      kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
1946
2025
      branch will be read-locked.
1947
2026
    """
1948
 
    from builtins import _get_revision_range, safe_relpath_files
 
2027
    from builtins import _get_revision_range
1949
2028
    tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
1950
 
    b.lock_read()
 
2029
    add_cleanup(b.lock_read().unlock)
1951
2030
    # XXX: It's damn messy converting a list of paths to relative paths when
1952
2031
    # those paths might be deleted ones, they might be on a case-insensitive
1953
2032
    # filesystem and/or they might be in silly locations (like another branch).
1957
2036
    # case of running log in a nested directory, assuming paths beyond the
1958
2037
    # first one haven't been deleted ...
1959
2038
    if tree:
1960
 
        relpaths = [path] + safe_relpath_files(tree, file_list[1:])
 
2039
        relpaths = [path] + tree.safe_relpath_files(file_list[1:])
1961
2040
    else:
1962
2041
        relpaths = [path] + file_list[1:]
1963
2042
    info_list = []
2041
2120
                          len(row) > 1 and row[1] == 'fixed']
2042
2121
 
2043
2122
        if fixed_bug_urls:
2044
 
            return {'fixes bug(s)': ' '.join(fixed_bug_urls)}
 
2123
            return {ngettext('fixes bug', 'fixes bugs', len(fixed_bug_urls)):\
 
2124
                    ' '.join(fixed_bug_urls)}
2045
2125
    return {}
2046
2126
 
2047
2127
properties_handler_registry.register('bugs_properties_handler',