~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Max Bowsher
  • Date: 2011-08-23 09:29:27 UTC
  • mto: This revision was merged to the branch mainline in revision 6104.
  • Revision ID: _@maxb.eu-20110823092927-c7fnueriuunvv9mh
Per jam's review comments, get rid of features.meliae_feature, which is new in
2.5 and so will not be missed, assigning the corrected behaviour to the
features.meliae name.

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