/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Shannon Weyrick
  • Date: 2011-08-19 21:01:49 UTC
  • mto: This revision was merged to the branch mainline in revision 6086.
  • Revision ID: weyrick@mozek.us-20110819210149-7q4qqungeb3im9pq
Make it explicit in docs that large file skips happen only in recursive mode. Add test.

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,
 
77
    i18n,
78
78
    )
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:
230
231
                          message_search=None, levels=1, 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,
234
236
                          ):
235
237
    """Convenience function for making a logging request dictionary.
236
238
 
260
262
      generate; 1 for just the mainline; 0 for all levels.
261
263
 
262
264
    :param generate_tags: If True, include tags for matched revisions.
263
 
 
 
265
`
264
266
    :param delta_type: Either 'full', 'partial' or None.
265
267
      'full' means generate the complete delta - adds/deletes/modifies/etc;
266
268
      'partial' means filter the delta using specific_fileids;
278
280
 
279
281
    :param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
280
282
      range operator or as a graph difference.
 
283
 
 
284
    :param signature: show digital signature information
 
285
      
 
286
    :param match: Dictionary of list of search strings to use when filtering
 
287
      revisions. Keys can be 'message', 'author', 'committer', 'bugs' or
 
288
      the empty string to match any of the preceding properties. 
 
289
      
281
290
    """
 
291
    # Take care of old style message_search parameter
 
292
    if message_search:
 
293
        if match:
 
294
            if 'message' in match:
 
295
                match['message'].append(message_search)
 
296
            else:
 
297
                match['message'] = [message_search]
 
298
        else:
 
299
            match={ 'message': [message_search] }
282
300
    return {
283
301
        'direction': direction,
284
302
        'specific_fileids': specific_fileids,
285
303
        'start_revision': start_revision,
286
304
        'end_revision': end_revision,
287
305
        'limit': limit,
288
 
        'message_search': message_search,
289
306
        'levels': levels,
290
307
        'generate_tags': generate_tags,
291
308
        'delta_type': delta_type,
292
309
        'diff_type': diff_type,
293
310
        'exclude_common_ancestry': exclude_common_ancestry,
 
311
        'signature': signature,
 
312
        'match': match,
294
313
        # Add 'private' attributes for features that may be deprecated
295
314
        '_match_using_deltas': _match_using_deltas,
296
315
    }
298
317
 
299
318
def _apply_log_request_defaults(rqst):
300
319
    """Apply default values to a request dictionary."""
301
 
    result = _DEFAULT_REQUEST_PARAMS
 
320
    result = _DEFAULT_REQUEST_PARAMS.copy()
302
321
    if rqst:
303
322
        result.update(rqst)
304
323
    return result
305
324
 
306
325
 
 
326
def format_signature_validity(rev_id, repo):
 
327
    """get the signature validity
 
328
    
 
329
    :param rev_id: revision id to validate
 
330
    :param repo: repository of revision
 
331
    :return: human readable string to print to log
 
332
    """
 
333
    from bzrlib import gpg
 
334
 
 
335
    gpg_strategy = gpg.GPGStrategy(None)
 
336
    result = repo.verify_revision(rev_id, gpg_strategy)
 
337
    if result[0] == gpg.SIGNATURE_VALID:
 
338
        return "valid signature from {0}".format(result[1])
 
339
    if result[0] == gpg.SIGNATURE_KEY_MISSING:
 
340
        return "unknown key {0}".format(result[1])
 
341
    if result[0] == gpg.SIGNATURE_NOT_VALID:
 
342
        return "invalid signature!"
 
343
    if result[0] == gpg.SIGNATURE_NOT_SIGNED:
 
344
        return "no signature"
 
345
 
 
346
 
307
347
class LogGenerator(object):
308
348
    """A generator of log revisions."""
309
349
 
361
401
            rqst['delta_type'] = None
362
402
        if not getattr(lf, 'supports_diff', False):
363
403
            rqst['diff_type'] = None
 
404
        if not getattr(lf, 'supports_signatures', False):
 
405
            rqst['signature'] = False
364
406
 
365
407
        # Find and print the interesting revisions
366
408
        generator = self._generator_factory(self.branch, rqst)
400
442
        levels = rqst.get('levels')
401
443
        limit = rqst.get('limit')
402
444
        diff_type = rqst.get('diff_type')
 
445
        show_signature = rqst.get('signature')
403
446
        log_count = 0
404
447
        revision_iterator = self._create_log_revision_iterator()
405
448
        for revs in revision_iterator:
411
454
                    diff = None
412
455
                else:
413
456
                    diff = self._format_diff(rev, rev_id, diff_type)
 
457
                if show_signature:
 
458
                    signature = format_signature_validity(rev_id,
 
459
                                                self.branch.repository)
 
460
                else:
 
461
                    signature = None
414
462
                yield LogRevision(rev, revno, merge_depth, delta,
415
 
                    self.rev_tag_dict.get(rev_id), diff)
 
463
                    self.rev_tag_dict.get(rev_id), diff, signature)
416
464
                if limit:
417
465
                    log_count += 1
418
466
                    if log_count >= limit:
432
480
        else:
433
481
            specific_files = None
434
482
        s = StringIO()
 
483
        path_encoding = get_diff_header_encoding()
435
484
        diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
436
 
            new_label='')
 
485
            new_label='', path_encoding=path_encoding)
437
486
        return s.getvalue()
438
487
 
439
488
    def _create_log_revision_iterator(self):
472
521
 
473
522
        # Apply the other filters
474
523
        return make_log_rev_iterator(self.branch, view_revisions,
475
 
            rqst.get('delta_type'), rqst.get('message_search'),
 
524
            rqst.get('delta_type'), rqst.get('match'),
476
525
            file_ids=rqst.get('specific_fileids'),
477
526
            direction=rqst.get('direction'))
478
527
 
491
540
            rqst.get('specific_fileids')[0], view_revisions,
492
541
            include_merges=rqst.get('levels') != 1)
493
542
        return make_log_rev_iterator(self.branch, view_revisions,
494
 
            rqst.get('delta_type'), rqst.get('message_search'))
 
543
            rqst.get('delta_type'), rqst.get('match'))
495
544
 
496
545
 
497
546
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
522
571
    elif not generate_merge_revisions:
523
572
        # If we only want to see linear revisions, we can iterate ...
524
573
        iter_revs = _generate_flat_revisions(branch, start_rev_id, end_rev_id,
525
 
                                             direction)
 
574
                                             direction, exclude_common_ancestry)
526
575
        if direction == 'forward':
527
576
            iter_revs = reversed(iter_revs)
528
577
    else:
539
588
        # It's the tip
540
589
        return [(br_rev_id, br_revno, 0)]
541
590
    else:
542
 
        revno = branch.revision_id_to_dotted_revno(rev_id)
543
 
        revno_str = '.'.join(str(n) for n in revno)
 
591
        revno_str = _compute_revno_str(branch, rev_id)
544
592
        return [(rev_id, revno_str, 0)]
545
593
 
546
594
 
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)
 
595
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction,
 
596
                             exclude_common_ancestry=False):
 
597
    result = _linear_view_revisions(
 
598
        branch, start_rev_id, end_rev_id,
 
599
        exclude_common_ancestry=exclude_common_ancestry)
549
600
    # If a start limit was given and it's not obviously an
550
601
    # ancestor of the end limit, check it before outputting anything
551
602
    if direction == 'forward' or (start_rev_id
572
623
    if delayed_graph_generation:
573
624
        try:
574
625
            for rev_id, revno, depth in  _linear_view_revisions(
575
 
                branch, start_rev_id, end_rev_id):
 
626
                branch, start_rev_id, end_rev_id, exclude_common_ancestry):
576
627
                if _has_merges(branch, rev_id):
577
628
                    # The end_rev_id can be nested down somewhere. We need an
578
629
                    # explicit ancestry check. There is an ambiguity here as we
623
674
    return len(parents) > 1
624
675
 
625
676
 
 
677
def _compute_revno_str(branch, rev_id):
 
678
    """Compute the revno string from a rev_id.
 
679
 
 
680
    :return: The revno string, or None if the revision is not in the supplied
 
681
        branch.
 
682
    """
 
683
    try:
 
684
        revno = branch.revision_id_to_dotted_revno(rev_id)
 
685
    except errors.NoSuchRevision:
 
686
        # The revision must be outside of this branch
 
687
        return None
 
688
    else:
 
689
        return '.'.join(str(n) for n in revno)
 
690
 
 
691
 
626
692
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
627
693
    """Is start_rev_id an obvious ancestor of end_rev_id?"""
628
694
    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)
 
695
        try:
 
696
            start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
 
697
            end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
 
698
        except errors.NoSuchRevision:
 
699
            # one or both is not in the branch; not obvious
 
700
            return False
631
701
        if len(start_dotted) == 1 and len(end_dotted) == 1:
632
702
            # both on mainline
633
703
            return start_dotted[0] <= end_dotted[0]
643
713
    return True
644
714
 
645
715
 
646
 
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
 
716
def _linear_view_revisions(branch, start_rev_id, end_rev_id,
 
717
                           exclude_common_ancestry=False):
647
718
    """Calculate a sequence of revisions to view, newest to oldest.
648
719
 
649
720
    :param start_rev_id: the lower revision-id
650
721
    :param end_rev_id: the upper revision-id
 
722
    :param exclude_common_ancestry: Whether the start_rev_id should be part of
 
723
        the iterated revisions.
651
724
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
652
725
    :raises _StartNotLinearAncestor: if a start_rev_id is specified but
653
 
      is not found walking the left-hand history
 
726
        is not found walking the left-hand history
654
727
    """
655
728
    br_revno, br_rev_id = branch.last_revision_info()
656
729
    repo = branch.repository
 
730
    graph = repo.get_graph()
657
731
    if start_rev_id is None and end_rev_id is None:
658
732
        cur_revno = br_revno
659
 
        for revision_id in repo.iter_reverse_revision_history(br_rev_id):
 
733
        for revision_id in graph.iter_lefthand_ancestry(br_rev_id,
 
734
            (_mod_revision.NULL_REVISION,)):
660
735
            yield revision_id, str(cur_revno), 0
661
736
            cur_revno -= 1
662
737
    else:
663
738
        if end_rev_id is None:
664
739
            end_rev_id = br_rev_id
665
740
        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)
 
741
        for revision_id in graph.iter_lefthand_ancestry(end_rev_id,
 
742
                (_mod_revision.NULL_REVISION,)):
 
743
            revno_str = _compute_revno_str(branch, revision_id)
669
744
            if not found_start and revision_id == start_rev_id:
670
 
                yield revision_id, revno_str, 0
 
745
                if not exclude_common_ancestry:
 
746
                    yield revision_id, revno_str, 0
671
747
                found_start = True
672
748
                break
673
749
            else:
721
797
            yield rev_id, '.'.join(map(str, revno)), merge_depth
722
798
 
723
799
 
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
800
def _rebase_merge_depth(view_revisions):
744
801
    """Adjust depths upwards so the top level is 0."""
745
802
    # If either the first or last revision have a merge_depth of 0, we're done
789
846
    return log_rev_iterator
790
847
 
791
848
 
792
 
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
 
849
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
793
850
    """Create a filtered iterator of log_rev_iterator matching on a regex.
794
851
 
795
852
    :param branch: The branch being logged.
796
853
    :param generate_delta: Whether to generate a delta for each revision.
797
 
    :param search: A user text search string.
 
854
    :param match: A dictionary with properties as keys and lists of strings
 
855
        as values. To match, a revision may match any of the supplied strings
 
856
        within a single property but must match at least one string for each
 
857
        property.
798
858
    :param log_rev_iterator: An input iterator containing all revisions that
799
859
        could be displayed, in lists.
800
860
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
801
861
        delta).
802
862
    """
803
 
    if search is None:
 
863
    if match is None:
804
864
        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):
 
865
    searchRE = [(k, [re.compile(x, re.IGNORECASE) for x in v])
 
866
                for (k,v) in match.iteritems()]
 
867
    return _filter_re(searchRE, log_rev_iterator)
 
868
 
 
869
 
 
870
def _filter_re(searchRE, log_rev_iterator):
811
871
    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
 
 
 
872
        new_revs = [rev for rev in revs if _match_filter(searchRE, rev[1])]
 
873
        if new_revs:
 
874
            yield new_revs
 
875
 
 
876
def _match_filter(searchRE, rev):
 
877
    strings = {
 
878
               'message': (rev.message,),
 
879
               'committer': (rev.committer,),
 
880
               'author': (rev.get_apparent_authors()),
 
881
               'bugs': list(rev.iter_bugs())
 
882
               }
 
883
    strings[''] = [item for inner_list in strings.itervalues()
 
884
                   for item in inner_list]
 
885
    for (k,v) in searchRE:
 
886
        if k in strings and not _match_any_filter(strings[k], v):
 
887
            return False
 
888
    return True
 
889
 
 
890
def _match_any_filter(strings, res):
 
891
    return any([filter(None, map(re.search, strings)) for re in res])
818
892
 
819
893
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
820
894
    fileids=None, direction='reverse'):
940
1014
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
941
1015
        delta).
942
1016
    """
943
 
    repository = branch.repository
944
1017
    num = 9
945
1018
    for batch in log_rev_iterator:
946
1019
        batch = iter(batch)
1063
1136
    cur_revno = branch_revno
1064
1137
    rev_nos = {}
1065
1138
    mainline_revs = []
1066
 
    for revision_id in branch.repository.iter_reverse_revision_history(
1067
 
                        branch_last_revision):
 
1139
    graph = branch.repository.get_graph()
 
1140
    for revision_id in graph.iter_lefthand_ancestry(
 
1141
            branch_last_revision, (_mod_revision.NULL_REVISION,)):
1068
1142
        if cur_revno < start_revno:
1069
1143
            # We have gone far enough, but we always add 1 more revision
1070
1144
            rev_nos[revision_id] = cur_revno
1084
1158
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
1085
1159
 
1086
1160
 
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
1161
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1132
1162
    include_merges=True):
1133
1163
    r"""Return the list of revision ids which touch a given file id.
1136
1166
    This includes the revisions which directly change the file id,
1137
1167
    and the revisions which merge these changes. So if the
1138
1168
    revision graph is::
 
1169
 
1139
1170
        A-.
1140
1171
        |\ \
1141
1172
        B C E
1168
1199
    """
1169
1200
    # Lookup all possible text keys to determine which ones actually modified
1170
1201
    # the file.
 
1202
    graph = branch.repository.get_file_graph()
 
1203
    get_parent_map = graph.get_parent_map
1171
1204
    text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
1172
1205
    next_keys = None
1173
1206
    # Looking up keys in batches of 1000 can cut the time in half, as well as
1177
1210
    #       indexing layer. We might consider passing in hints as to the known
1178
1211
    #       access pattern (sparse/clustered, high success rate/low success
1179
1212
    #       rate). This particular access is clustered with a low success rate.
1180
 
    get_parent_map = branch.repository.texts.get_parent_map
1181
1213
    modified_text_revisions = set()
1182
1214
    chunk_size = 1000
1183
1215
    for start in xrange(0, len(text_keys), chunk_size):
1210
1242
    return result
1211
1243
 
1212
1244
 
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
1245
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1255
1246
    """Reverse revisions by depth.
1256
1247
 
1291
1282
    """
1292
1283
 
1293
1284
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1294
 
                 tags=None, diff=None):
 
1285
                 tags=None, diff=None, signature=None):
1295
1286
        self.rev = rev
1296
 
        self.revno = str(revno)
 
1287
        if revno is None:
 
1288
            self.revno = None
 
1289
        else:
 
1290
            self.revno = str(revno)
1297
1291
        self.merge_depth = merge_depth
1298
1292
        self.delta = delta
1299
1293
        self.tags = tags
1300
1294
        self.diff = diff
 
1295
        self.signature = signature
1301
1296
 
1302
1297
 
1303
1298
class LogFormatter(object):
1312
1307
    to indicate which LogRevision attributes it supports:
1313
1308
 
1314
1309
    - 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.
 
1310
      Otherwise the delta attribute may not be populated.  The 'delta_format'
 
1311
      attribute describes whether the 'short_status' format (1) or the long
 
1312
      one (2) should be used.
1318
1313
 
1319
1314
    - 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.
 
1315
      merge revisions.  If not, then only mainline revisions will be passed
 
1316
      to the formatter.
1322
1317
 
1323
1318
    - 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.
 
1319
      The default value is zero meaning display all levels.
 
1320
      This value is only relevant if supports_merge_revisions is True.
1326
1321
 
1327
1322
    - supports_tags must be True if this log formatter supports tags.
1328
 
        Otherwise the tags attribute may not be populated.
 
1323
      Otherwise the tags attribute may not be populated.
1329
1324
 
1330
1325
    - supports_diff must be True if this log formatter supports diffs.
1331
 
        Otherwise the diff attribute may not be populated.
 
1326
      Otherwise the diff attribute may not be populated.
 
1327
 
 
1328
    - supports_signatures must be True if this log formatter supports GPG
 
1329
      signatures.
1332
1330
 
1333
1331
    Plugins can register functions to show custom revision properties using
1334
1332
    the properties_handler_registry. The registered function
1335
 
    must respect the following interface description:
 
1333
    must respect the following interface description::
 
1334
 
1336
1335
        def my_show_properties(properties_dict):
1337
1336
            # code that returns a dict {'name':'value'} of the properties
1338
1337
            # to be shown
1341
1340
 
1342
1341
    def __init__(self, to_file, show_ids=False, show_timezone='original',
1343
1342
                 delta_format=None, levels=None, show_advice=False,
1344
 
                 to_exact_file=None):
 
1343
                 to_exact_file=None, author_list_handler=None):
1345
1344
        """Create a LogFormatter.
1346
1345
 
1347
1346
        :param to_file: the file to output to
1355
1354
          let the log formatter decide.
1356
1355
        :param show_advice: whether to show advice at the end of the
1357
1356
          log or not
 
1357
        :param author_list_handler: callable generating a list of
 
1358
          authors to display for a given revision
1358
1359
        """
1359
1360
        self.to_file = to_file
1360
1361
        # 'exact' stream used to show diff, it should print content 'as is'
1375
1376
        self.levels = levels
1376
1377
        self._show_advice = show_advice
1377
1378
        self._merge_count = 0
 
1379
        self._author_list_handler = author_list_handler
1378
1380
 
1379
1381
    def get_levels(self):
1380
1382
        """Get the number of levels to display or 0 for all."""
1412
1414
        return address
1413
1415
 
1414
1416
    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
 
1417
        return self.authors(rev, 'first', short=True, sep=', ')
 
1418
 
 
1419
    def authors(self, rev, who, short=False, sep=None):
 
1420
        """Generate list of authors, taking --authors option into account.
 
1421
 
 
1422
        The caller has to specify the name of a author list handler,
 
1423
        as provided by the author list registry, using the ``who``
 
1424
        argument.  That name only sets a default, though: when the
 
1425
        user selected a different author list generation using the
 
1426
        ``--authors`` command line switch, as represented by the
 
1427
        ``author_list_handler`` constructor argument, that value takes
 
1428
        precedence.
 
1429
 
 
1430
        :param rev: The revision for which to generate the list of authors.
 
1431
        :param who: Name of the default handler.
 
1432
        :param short: Whether to shorten names to either name or address.
 
1433
        :param sep: What separator to use for automatic concatenation.
 
1434
        """
 
1435
        if self._author_list_handler is not None:
 
1436
            # The user did specify --authors, which overrides the default
 
1437
            author_list_handler = self._author_list_handler
 
1438
        else:
 
1439
            # The user didn't specify --authors, so we use the caller's default
 
1440
            author_list_handler = author_list_registry.get(who)
 
1441
        names = author_list_handler(rev)
 
1442
        if short:
 
1443
            for i in range(len(names)):
 
1444
                name, address = config.parse_username(names[i])
 
1445
                if name:
 
1446
                    names[i] = name
 
1447
                else:
 
1448
                    names[i] = address
 
1449
        if sep is not None:
 
1450
            names = sep.join(names)
 
1451
        return names
1419
1452
 
1420
1453
    def merge_marker(self, revision):
1421
1454
        """Get the merge marker to include in the output or '' if none."""
1491
1524
    supports_delta = True
1492
1525
    supports_tags = True
1493
1526
    supports_diff = True
 
1527
    supports_signatures = True
1494
1528
 
1495
1529
    def __init__(self, *args, **kwargs):
1496
1530
        super(LongLogFormatter, self).__init__(*args, **kwargs)
1516
1550
                self.merge_marker(revision)))
1517
1551
        if revision.tags:
1518
1552
            lines.append('tags: %s' % (', '.join(revision.tags)))
1519
 
        if self.show_ids:
 
1553
        if self.show_ids or revision.revno is None:
1520
1554
            lines.append('revision-id: %s' % (revision.rev.revision_id,))
 
1555
        if self.show_ids:
1521
1556
            for parent_id in revision.rev.parent_ids:
1522
1557
                lines.append('parent: %s' % (parent_id,))
1523
1558
        lines.extend(self.custom_properties(revision.rev))
1524
1559
 
1525
1560
        committer = revision.rev.committer
1526
 
        authors = revision.rev.get_apparent_authors()
 
1561
        authors = self.authors(revision.rev, 'all')
1527
1562
        if authors != [committer]:
1528
1563
            lines.append('author: %s' % (", ".join(authors),))
1529
1564
        lines.append('committer: %s' % (committer,))
1534
1569
 
1535
1570
        lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1536
1571
 
 
1572
        if revision.signature is not None:
 
1573
            lines.append('signature: ' + revision.signature)
 
1574
 
1537
1575
        lines.append('message:')
1538
1576
        if not revision.rev.message:
1539
1577
            lines.append('  (no message)')
1586
1624
        indent = '    ' * depth
1587
1625
        revno_width = self.revno_width_by_depth.get(depth)
1588
1626
        if revno_width is None:
1589
 
            if revision.revno.find('.') == -1:
 
1627
            if revision.revno is None or revision.revno.find('.') == -1:
1590
1628
                # mainline revno, e.g. 12345
1591
1629
                revno_width = 5
1592
1630
            else:
1600
1638
        if revision.tags:
1601
1639
            tags = ' {%s}' % (', '.join(revision.tags))
1602
1640
        to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1603
 
                revision.revno, self.short_author(revision.rev),
 
1641
                revision.revno or "", self.short_author(revision.rev),
1604
1642
                format_date(revision.rev.timestamp,
1605
1643
                            revision.rev.timezone or 0,
1606
1644
                            self.show_timezone, date_fmt="%Y-%m-%d",
1607
1645
                            show_offset=False),
1608
1646
                tags, self.merge_marker(revision)))
1609
1647
        self.show_properties(revision.rev, indent+offset)
1610
 
        if self.show_ids:
 
1648
        if self.show_ids or revision.revno is None:
1611
1649
            to_file.write(indent + offset + 'revision-id:%s\n'
1612
1650
                          % (revision.rev.revision_id,))
1613
1651
        if not revision.rev.message:
1666
1704
 
1667
1705
    def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1668
1706
        """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
 
1707
 
 
1708
        :param revno:      revision number or None.
 
1709
                           Revision numbers counts from 1.
 
1710
        :param rev:        revision object
 
1711
        :param max_chars:  maximum length of resulting string
 
1712
        :param tags:       list of tags or None
 
1713
        :param prefix:     string to prefix each line
 
1714
        :return:           formatted truncated string
1676
1715
        """
1677
1716
        out = []
1678
1717
        if revno:
1679
1718
            # show revno only when is not None
1680
1719
            out.append("%s:" % revno)
1681
 
        out.append(self.truncate(self.short_author(rev), 20))
 
1720
        if max_chars is not None:
 
1721
            out.append(self.truncate(self.short_author(rev), (max_chars+3)/4))
 
1722
        else:
 
1723
            out.append(self.short_author(rev))
1682
1724
        out.append(self.date_string(rev))
1683
1725
        if len(rev.parent_ids) > 1:
1684
1726
            out.append('[merge]')
1703
1745
                               self.show_timezone,
1704
1746
                               date_fmt='%Y-%m-%d',
1705
1747
                               show_offset=False)
1706
 
        committer_str = revision.rev.get_apparent_authors()[0].replace (' <', '  <')
 
1748
        committer_str = self.authors(revision.rev, 'first', sep=', ')
 
1749
        committer_str = committer_str.replace(' <', '  <')
1707
1750
        to_file.write('%s  %s\n\n' % (date_str,committer_str))
1708
1751
 
1709
1752
        if revision.delta is not None and revision.delta.has_changed():
1774
1817
        raise errors.BzrCommandError("unknown log formatter: %r" % name)
1775
1818
 
1776
1819
 
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)
 
1820
def author_list_all(rev):
 
1821
    return rev.get_apparent_authors()[:]
 
1822
 
 
1823
 
 
1824
def author_list_first(rev):
 
1825
    lst = rev.get_apparent_authors()
 
1826
    try:
 
1827
        return [lst[0]]
 
1828
    except IndexError:
 
1829
        return []
 
1830
 
 
1831
 
 
1832
def author_list_committer(rev):
 
1833
    return [rev.committer]
 
1834
 
 
1835
 
 
1836
author_list_registry = registry.Registry()
 
1837
 
 
1838
author_list_registry.register('all', author_list_all,
 
1839
                              'All authors')
 
1840
 
 
1841
author_list_registry.register('first', author_list_first,
 
1842
                              'The first author')
 
1843
 
 
1844
author_list_registry.register('committer', author_list_committer,
 
1845
                              'The committer')
1781
1846
 
1782
1847
 
1783
1848
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1848
1913
    old_revisions = set()
1849
1914
    new_history = []
1850
1915
    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)
 
1916
    graph = repository.get_graph()
 
1917
    new_iter = graph.iter_lefthand_ancestry(new_revision_id)
 
1918
    old_iter = graph.iter_lefthand_ancestry(old_revision_id)
1853
1919
    stop_revision = None
1854
1920
    do_old = True
1855
1921
    do_new = True
1930
1996
        lf.log_revision(lr)
1931
1997
 
1932
1998
 
1933
 
def _get_info_for_log_files(revisionspec_list, file_list):
 
1999
def _get_info_for_log_files(revisionspec_list, file_list, add_cleanup):
1934
2000
    """Find file-ids and kinds given a list of files and a revision range.
1935
2001
 
1936
2002
    We search for files at the end of the range. If not found there,
1940
2006
    :param file_list: the list of paths given on the command line;
1941
2007
      the first of these can be a branch location or a file path,
1942
2008
      the remainder must be file paths
 
2009
    :param add_cleanup: When the branch returned is read locked,
 
2010
      an unlock call will be queued to the cleanup.
1943
2011
    :return: (branch, info_list, start_rev_info, end_rev_info) where
1944
2012
      info_list is a list of (relative_path, file_id, kind) tuples where
1945
2013
      kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
1946
2014
      branch will be read-locked.
1947
2015
    """
1948
 
    from builtins import _get_revision_range, safe_relpath_files
 
2016
    from builtins import _get_revision_range
1949
2017
    tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
1950
 
    b.lock_read()
 
2018
    add_cleanup(b.lock_read().unlock)
1951
2019
    # XXX: It's damn messy converting a list of paths to relative paths when
1952
2020
    # those paths might be deleted ones, they might be on a case-insensitive
1953
2021
    # filesystem and/or they might be in silly locations (like another branch).
1957
2025
    # case of running log in a nested directory, assuming paths beyond the
1958
2026
    # first one haven't been deleted ...
1959
2027
    if tree:
1960
 
        relpaths = [path] + safe_relpath_files(tree, file_list[1:])
 
2028
        relpaths = [path] + tree.safe_relpath_files(file_list[1:])
1961
2029
    else:
1962
2030
        relpaths = [path] + file_list[1:]
1963
2031
    info_list = []