~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

MergeĀ lp:~gz/bzr/path_from_environ_832028

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
65
65
lazy_import(globals(), """
66
66
 
67
67
from bzrlib import (
68
 
    bzrdir,
69
68
    config,
 
69
    controldir,
70
70
    diff,
71
71
    errors,
72
72
    foreign,
73
 
    osutils,
74
73
    repository as _mod_repository,
75
74
    revision as _mod_revision,
76
75
    revisionspec,
77
 
    trace,
78
76
    tsort,
79
77
    )
 
78
from bzrlib.i18n import gettext, ngettext
80
79
""")
81
80
 
82
81
from bzrlib import (
 
82
    lazy_regex,
83
83
    registry,
84
84
    )
85
85
from bzrlib.osutils import (
86
86
    format_date,
87
87
    format_date_with_offset_in_original_timezone,
 
88
    get_diff_header_encoding,
88
89
    get_terminal_encoding,
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):
108
105
    last_ie = None
109
106
    last_path = None
110
107
    revno = 1
111
 
    for revision_id in branch.revision_history():
 
108
    graph = branch.repository.get_graph()
 
109
    history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
 
110
        [_mod_revision.NULL_REVISION]))
 
111
    for revision_id in reversed(history):
112
112
        this_inv = branch.repository.get_inventory(revision_id)
113
 
        if file_id in this_inv:
 
113
        if this_inv.has_id(file_id):
114
114
            this_ie = this_inv[file_id]
115
115
            this_path = this_inv.id2path(file_id)
116
116
        else:
156
156
             end_revision=None,
157
157
             search=None,
158
158
             limit=None,
159
 
             show_diff=False):
 
159
             show_diff=False,
 
160
             match=None):
160
161
    """Write out human-readable log of commits to this branch.
161
162
 
162
163
    This function is being retained for backwards compatibility but
185
186
        if None or 0.
186
187
 
187
188
    :param show_diff: If True, output a diff after each revision.
 
189
 
 
190
    :param match: Dictionary of search lists to use when matching revision
 
191
      properties.
188
192
    """
189
193
    # Convert old-style parameters to new-style parameters
190
194
    if specific_fileid is not None:
214
218
    Logger(branch, rqst).show(lf)
215
219
 
216
220
 
217
 
# Note: This needs to be kept this in sync with the defaults in
 
221
# Note: This needs to be kept in sync with the defaults in
218
222
# make_log_request_dict() below
219
223
_DEFAULT_REQUEST_PARAMS = {
220
224
    'direction': 'reverse',
221
 
    'levels': 1,
 
225
    'levels': None,
222
226
    'generate_tags': True,
223
227
    'exclude_common_ancestry': False,
224
228
    '_match_using_deltas': True,
227
231
 
228
232
def make_log_request_dict(direction='reverse', specific_fileids=None,
229
233
                          start_revision=None, end_revision=None, limit=None,
230
 
                          message_search=None, levels=1, generate_tags=True,
 
234
                          message_search=None, levels=None, generate_tags=True,
231
235
                          delta_type=None,
232
236
                          diff_type=None, _match_using_deltas=True,
233
 
                          exclude_common_ancestry=False,
 
237
                          exclude_common_ancestry=False, match=None,
 
238
                          signature=False, omit_merges=False,
234
239
                          ):
235
240
    """Convenience function for making a logging request dictionary.
236
241
 
257
262
      matching commit messages
258
263
 
259
264
    :param levels: the number of levels of revisions to
260
 
      generate; 1 for just the mainline; 0 for all levels.
 
265
      generate; 1 for just the mainline; 0 for all levels, or None for
 
266
      a sensible default.
261
267
 
262
268
    :param generate_tags: If True, include tags for matched revisions.
263
 
 
 
269
`
264
270
    :param delta_type: Either 'full', 'partial' or None.
265
271
      'full' means generate the complete delta - adds/deletes/modifies/etc;
266
272
      'partial' means filter the delta using specific_fileids;
278
284
 
279
285
    :param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
280
286
      range operator or as a graph difference.
 
287
 
 
288
    :param signature: show digital signature information
 
289
 
 
290
    :param match: Dictionary of list of search strings to use when filtering
 
291
      revisions. Keys can be 'message', 'author', 'committer', 'bugs' or
 
292
      the empty string to match any of the preceding properties.
 
293
 
 
294
    :param omit_merges: If True, commits with more than one parent are
 
295
      omitted.
 
296
 
281
297
    """
 
298
    # Take care of old style message_search parameter
 
299
    if message_search:
 
300
        if match:
 
301
            if 'message' in match:
 
302
                match['message'].append(message_search)
 
303
            else:
 
304
                match['message'] = [message_search]
 
305
        else:
 
306
            match={ 'message': [message_search] }
282
307
    return {
283
308
        'direction': direction,
284
309
        'specific_fileids': specific_fileids,
285
310
        'start_revision': start_revision,
286
311
        'end_revision': end_revision,
287
312
        'limit': limit,
288
 
        'message_search': message_search,
289
313
        'levels': levels,
290
314
        'generate_tags': generate_tags,
291
315
        'delta_type': delta_type,
292
316
        'diff_type': diff_type,
293
317
        'exclude_common_ancestry': exclude_common_ancestry,
 
318
        'signature': signature,
 
319
        'match': match,
 
320
        'omit_merges': omit_merges,
294
321
        # Add 'private' attributes for features that may be deprecated
295
322
        '_match_using_deltas': _match_using_deltas,
296
323
    }
298
325
 
299
326
def _apply_log_request_defaults(rqst):
300
327
    """Apply default values to a request dictionary."""
301
 
    result = _DEFAULT_REQUEST_PARAMS
 
328
    result = _DEFAULT_REQUEST_PARAMS.copy()
302
329
    if rqst:
303
330
        result.update(rqst)
304
331
    return result
305
332
 
306
333
 
 
334
def format_signature_validity(rev_id, repo):
 
335
    """get the signature validity
 
336
 
 
337
    :param rev_id: revision id to validate
 
338
    :param repo: repository of revision
 
339
    :return: human readable string to print to log
 
340
    """
 
341
    from bzrlib import gpg
 
342
 
 
343
    gpg_strategy = gpg.GPGStrategy(None)
 
344
    result = repo.verify_revision_signature(rev_id, gpg_strategy)
 
345
    if result[0] == gpg.SIGNATURE_VALID:
 
346
        return "valid signature from {0}".format(result[1])
 
347
    if result[0] == gpg.SIGNATURE_KEY_MISSING:
 
348
        return "unknown key {0}".format(result[1])
 
349
    if result[0] == gpg.SIGNATURE_NOT_VALID:
 
350
        return "invalid signature!"
 
351
    if result[0] == gpg.SIGNATURE_NOT_SIGNED:
 
352
        return "no signature"
 
353
 
 
354
 
307
355
class LogGenerator(object):
308
356
    """A generator of log revisions."""
309
357
 
354
402
        # Tweak the LogRequest based on what the LogFormatter can handle.
355
403
        # (There's no point generating stuff if the formatter can't display it.)
356
404
        rqst = self.rqst
357
 
        rqst['levels'] = lf.get_levels()
 
405
        if rqst['levels'] is None or lf.get_levels() > rqst['levels']:
 
406
            # user didn't specify levels, use whatever the LF can handle:
 
407
            rqst['levels'] = lf.get_levels()
 
408
 
358
409
        if not getattr(lf, 'supports_tags', False):
359
410
            rqst['generate_tags'] = False
360
411
        if not getattr(lf, 'supports_delta', False):
361
412
            rqst['delta_type'] = None
362
413
        if not getattr(lf, 'supports_diff', False):
363
414
            rqst['diff_type'] = None
 
415
        if not getattr(lf, 'supports_signatures', False):
 
416
            rqst['signature'] = False
364
417
 
365
418
        # Find and print the interesting revisions
366
419
        generator = self._generator_factory(self.branch, rqst)
370
423
 
371
424
    def _generator_factory(self, branch, rqst):
372
425
        """Make the LogGenerator object to use.
373
 
        
 
426
 
374
427
        Subclasses may wish to override this.
375
428
        """
376
429
        return _DefaultLogGenerator(branch, rqst)
400
453
        levels = rqst.get('levels')
401
454
        limit = rqst.get('limit')
402
455
        diff_type = rqst.get('diff_type')
 
456
        show_signature = rqst.get('signature')
 
457
        omit_merges = rqst.get('omit_merges')
403
458
        log_count = 0
404
459
        revision_iterator = self._create_log_revision_iterator()
405
460
        for revs in revision_iterator:
407
462
                # 0 levels means show everything; merge_depth counts from 0
408
463
                if levels != 0 and merge_depth >= levels:
409
464
                    continue
 
465
                if omit_merges and len(rev.parent_ids) > 1:
 
466
                    continue
410
467
                if diff_type is None:
411
468
                    diff = None
412
469
                else:
413
470
                    diff = self._format_diff(rev, rev_id, diff_type)
 
471
                if show_signature:
 
472
                    signature = format_signature_validity(rev_id,
 
473
                                                self.branch.repository)
 
474
                else:
 
475
                    signature = None
414
476
                yield LogRevision(rev, revno, merge_depth, delta,
415
 
                    self.rev_tag_dict.get(rev_id), diff)
 
477
                    self.rev_tag_dict.get(rev_id), diff, signature)
416
478
                if limit:
417
479
                    log_count += 1
418
480
                    if log_count >= limit:
432
494
        else:
433
495
            specific_files = None
434
496
        s = StringIO()
435
 
        path_encoding = osutils.get_diff_header_encoding()
 
497
        path_encoding = get_diff_header_encoding()
436
498
        diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
437
499
            new_label='', path_encoding=path_encoding)
438
500
        return s.getvalue()
473
535
 
474
536
        # Apply the other filters
475
537
        return make_log_rev_iterator(self.branch, view_revisions,
476
 
            rqst.get('delta_type'), rqst.get('message_search'),
 
538
            rqst.get('delta_type'), rqst.get('match'),
477
539
            file_ids=rqst.get('specific_fileids'),
478
540
            direction=rqst.get('direction'))
479
541
 
492
554
            rqst.get('specific_fileids')[0], view_revisions,
493
555
            include_merges=rqst.get('levels') != 1)
494
556
        return make_log_rev_iterator(self.branch, view_revisions,
495
 
            rqst.get('delta_type'), rqst.get('message_search'))
 
557
            rqst.get('delta_type'), rqst.get('match'))
496
558
 
497
559
 
498
560
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
506
568
             a list of the same tuples.
507
569
    """
508
570
    if (exclude_common_ancestry and start_rev_id == end_rev_id):
509
 
        raise errors.BzrCommandError(
510
 
            '--exclude-common-ancestry requires two different revisions')
 
571
        raise errors.BzrCommandError(gettext(
 
572
            '--exclude-common-ancestry requires two different revisions'))
511
573
    if direction not in ('reverse', 'forward'):
512
 
        raise ValueError('invalid direction %r' % direction)
 
574
        raise ValueError(gettext('invalid direction %r') % direction)
513
575
    br_revno, br_rev_id = branch.last_revision_info()
514
576
    if br_revno == 0:
515
577
        return []
540
602
        # It's the tip
541
603
        return [(br_rev_id, br_revno, 0)]
542
604
    else:
543
 
        revno = branch.revision_id_to_dotted_revno(rev_id)
544
 
        revno_str = '.'.join(str(n) for n in revno)
 
605
        revno_str = _compute_revno_str(branch, rev_id)
545
606
        return [(rev_id, revno_str, 0)]
546
607
 
547
608
 
557
618
        try:
558
619
            result = list(result)
559
620
        except _StartNotLinearAncestor:
560
 
            raise errors.BzrCommandError('Start revision not found in'
561
 
                ' left-hand history of end revision.')
 
621
            raise errors.BzrCommandError(gettext('Start revision not found in'
 
622
                ' left-hand history of end revision.'))
562
623
    return result
563
624
 
564
625
 
603
664
        except _StartNotLinearAncestor:
604
665
            # A merge was never detected so the lower revision limit can't
605
666
            # be nested down somewhere
606
 
            raise errors.BzrCommandError('Start revision not found in'
607
 
                ' history of end revision.')
 
667
            raise errors.BzrCommandError(gettext('Start revision not found in'
 
668
                ' history of end revision.'))
608
669
 
609
670
    # We exit the loop above because we encounter a revision with merges, from
610
671
    # this revision, we need to switch to _graph_view_revisions.
627
688
    return len(parents) > 1
628
689
 
629
690
 
 
691
def _compute_revno_str(branch, rev_id):
 
692
    """Compute the revno string from a rev_id.
 
693
 
 
694
    :return: The revno string, or None if the revision is not in the supplied
 
695
        branch.
 
696
    """
 
697
    try:
 
698
        revno = branch.revision_id_to_dotted_revno(rev_id)
 
699
    except errors.NoSuchRevision:
 
700
        # The revision must be outside of this branch
 
701
        return None
 
702
    else:
 
703
        return '.'.join(str(n) for n in revno)
 
704
 
 
705
 
630
706
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
631
707
    """Is start_rev_id an obvious ancestor of end_rev_id?"""
632
708
    if start_rev_id and end_rev_id:
633
 
        start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
634
 
        end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
 
709
        try:
 
710
            start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
 
711
            end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
 
712
        except errors.NoSuchRevision:
 
713
            # one or both is not in the branch; not obvious
 
714
            return False
635
715
        if len(start_dotted) == 1 and len(end_dotted) == 1:
636
716
            # both on mainline
637
717
            return start_dotted[0] <= end_dotted[0]
661
741
    """
662
742
    br_revno, br_rev_id = branch.last_revision_info()
663
743
    repo = branch.repository
 
744
    graph = repo.get_graph()
664
745
    if start_rev_id is None and end_rev_id is None:
665
746
        cur_revno = br_revno
666
 
        for revision_id in repo.iter_reverse_revision_history(br_rev_id):
 
747
        for revision_id in graph.iter_lefthand_ancestry(br_rev_id,
 
748
            (_mod_revision.NULL_REVISION,)):
667
749
            yield revision_id, str(cur_revno), 0
668
750
            cur_revno -= 1
669
751
    else:
670
752
        if end_rev_id is None:
671
753
            end_rev_id = br_rev_id
672
754
        found_start = start_rev_id is None
673
 
        for revision_id in repo.iter_reverse_revision_history(end_rev_id):
674
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
675
 
            revno_str = '.'.join(str(n) for n in revno)
 
755
        for revision_id in graph.iter_lefthand_ancestry(end_rev_id,
 
756
                (_mod_revision.NULL_REVISION,)):
 
757
            revno_str = _compute_revno_str(branch, revision_id)
676
758
            if not found_start and revision_id == start_rev_id:
677
759
                if not exclude_common_ancestry:
678
760
                    yield revision_id, revno_str, 0
729
811
            yield rev_id, '.'.join(map(str, revno)), merge_depth
730
812
 
731
813
 
732
 
@deprecated_function(deprecated_in((2, 2, 0)))
733
 
def calculate_view_revisions(branch, start_revision, end_revision, direction,
734
 
        specific_fileid, generate_merge_revisions):
735
 
    """Calculate the revisions to view.
736
 
 
737
 
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
738
 
             a list of the same tuples.
739
 
    """
740
 
    start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
741
 
        end_revision)
742
 
    view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
743
 
        direction, generate_merge_revisions or specific_fileid))
744
 
    if specific_fileid:
745
 
        view_revisions = _filter_revisions_touching_file_id(branch,
746
 
            specific_fileid, view_revisions,
747
 
            include_merges=generate_merge_revisions)
748
 
    return _rebase_merge_depth(view_revisions)
749
 
 
750
 
 
751
814
def _rebase_merge_depth(view_revisions):
752
815
    """Adjust depths upwards so the top level is 0."""
753
816
    # If either the first or last revision have a merge_depth of 0, we're done
797
860
    return log_rev_iterator
798
861
 
799
862
 
800
 
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
 
863
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
801
864
    """Create a filtered iterator of log_rev_iterator matching on a regex.
802
865
 
803
866
    :param branch: The branch being logged.
804
867
    :param generate_delta: Whether to generate a delta for each revision.
805
 
    :param search: A user text search string.
 
868
    :param match: A dictionary with properties as keys and lists of strings
 
869
        as values. To match, a revision may match any of the supplied strings
 
870
        within a single property but must match at least one string for each
 
871
        property.
806
872
    :param log_rev_iterator: An input iterator containing all revisions that
807
873
        could be displayed, in lists.
808
874
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
809
875
        delta).
810
876
    """
811
 
    if search is None:
 
877
    if match is None:
812
878
        return log_rev_iterator
813
 
    searchRE = re.compile(search, re.IGNORECASE)
814
 
    return _filter_message_re(searchRE, log_rev_iterator)
815
 
 
816
 
 
817
 
def _filter_message_re(searchRE, log_rev_iterator):
 
879
    searchRE = [(k, [re.compile(x, re.IGNORECASE) for x in v])
 
880
                for (k,v) in match.iteritems()]
 
881
    return _filter_re(searchRE, log_rev_iterator)
 
882
 
 
883
 
 
884
def _filter_re(searchRE, log_rev_iterator):
818
885
    for revs in log_rev_iterator:
819
 
        new_revs = []
820
 
        for (rev_id, revno, merge_depth), rev, delta in revs:
821
 
            if searchRE.search(rev.message):
822
 
                new_revs.append(((rev_id, revno, merge_depth), rev, delta))
823
 
        yield new_revs
824
 
 
 
886
        new_revs = [rev for rev in revs if _match_filter(searchRE, rev[1])]
 
887
        if new_revs:
 
888
            yield new_revs
 
889
 
 
890
def _match_filter(searchRE, rev):
 
891
    strings = {
 
892
               'message': (rev.message,),
 
893
               'committer': (rev.committer,),
 
894
               'author': (rev.get_apparent_authors()),
 
895
               'bugs': list(rev.iter_bugs())
 
896
               }
 
897
    strings[''] = [item for inner_list in strings.itervalues()
 
898
                   for item in inner_list]
 
899
    for (k,v) in searchRE:
 
900
        if k in strings and not _match_any_filter(strings[k], v):
 
901
            return False
 
902
    return True
 
903
 
 
904
def _match_any_filter(strings, res):
 
905
    return any([filter(None, map(re.search, strings)) for re in res])
825
906
 
826
907
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
827
908
    fileids=None, direction='reverse'):
900
981
 
901
982
def _update_fileids(delta, fileids, stop_on):
902
983
    """Update the set of file-ids to search based on file lifecycle events.
903
 
    
 
984
 
904
985
    :param fileids: a set of fileids to update
905
986
    :param stop_on: either 'add' or 'remove' - take file-ids out of the
906
987
      fileids set once their add or remove entry is detected respectively
947
1028
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
948
1029
        delta).
949
1030
    """
950
 
    repository = branch.repository
951
1031
    num = 9
952
1032
    for batch in log_rev_iterator:
953
1033
        batch = iter(batch)
1002
1082
    if branch_revno != 0:
1003
1083
        if (start_rev_id == _mod_revision.NULL_REVISION
1004
1084
            or end_rev_id == _mod_revision.NULL_REVISION):
1005
 
            raise errors.BzrCommandError('Logging revision 0 is invalid.')
 
1085
            raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
1006
1086
        if start_revno > end_revno:
1007
 
            raise errors.BzrCommandError("Start revision must be older than "
1008
 
                                         "the end revision.")
 
1087
            raise errors.BzrCommandError(gettext("Start revision must be "
 
1088
                                         "older than the end revision."))
1009
1089
    return (start_rev_id, end_rev_id)
1010
1090
 
1011
1091
 
1060
1140
 
1061
1141
    if ((start_rev_id == _mod_revision.NULL_REVISION)
1062
1142
        or (end_rev_id == _mod_revision.NULL_REVISION)):
1063
 
        raise errors.BzrCommandError('Logging revision 0 is invalid.')
 
1143
        raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
1064
1144
    if start_revno > end_revno:
1065
 
        raise errors.BzrCommandError("Start revision must be older than "
1066
 
                                     "the end revision.")
 
1145
        raise errors.BzrCommandError(gettext("Start revision must be older "
 
1146
                                     "than the end revision."))
1067
1147
 
1068
1148
    if end_revno < start_revno:
1069
1149
        return None, None, None, None
1070
1150
    cur_revno = branch_revno
1071
1151
    rev_nos = {}
1072
1152
    mainline_revs = []
1073
 
    for revision_id in branch.repository.iter_reverse_revision_history(
1074
 
                        branch_last_revision):
 
1153
    graph = branch.repository.get_graph()
 
1154
    for revision_id in graph.iter_lefthand_ancestry(
 
1155
            branch_last_revision, (_mod_revision.NULL_REVISION,)):
1075
1156
        if cur_revno < start_revno:
1076
1157
            # We have gone far enough, but we always add 1 more revision
1077
1158
            rev_nos[revision_id] = cur_revno
1091
1172
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
1092
1173
 
1093
1174
 
1094
 
@deprecated_function(deprecated_in((2, 2, 0)))
1095
 
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
1096
 
    """Filter view_revisions based on revision ranges.
1097
 
 
1098
 
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1099
 
            tuples to be filtered.
1100
 
 
1101
 
    :param start_rev_id: If not NONE specifies the first revision to be logged.
1102
 
            If NONE then all revisions up to the end_rev_id are logged.
1103
 
 
1104
 
    :param end_rev_id: If not NONE specifies the last revision to be logged.
1105
 
            If NONE then all revisions up to the end of the log are logged.
1106
 
 
1107
 
    :return: The filtered view_revisions.
1108
 
    """
1109
 
    if start_rev_id or end_rev_id:
1110
 
        revision_ids = [r for r, n, d in view_revisions]
1111
 
        if start_rev_id:
1112
 
            start_index = revision_ids.index(start_rev_id)
1113
 
        else:
1114
 
            start_index = 0
1115
 
        if start_rev_id == end_rev_id:
1116
 
            end_index = start_index
1117
 
        else:
1118
 
            if end_rev_id:
1119
 
                end_index = revision_ids.index(end_rev_id)
1120
 
            else:
1121
 
                end_index = len(view_revisions) - 1
1122
 
        # To include the revisions merged into the last revision,
1123
 
        # extend end_rev_id down to, but not including, the next rev
1124
 
        # with the same or lesser merge_depth
1125
 
        end_merge_depth = view_revisions[end_index][2]
1126
 
        try:
1127
 
            for index in xrange(end_index+1, len(view_revisions)+1):
1128
 
                if view_revisions[index][2] <= end_merge_depth:
1129
 
                    end_index = index - 1
1130
 
                    break
1131
 
        except IndexError:
1132
 
            # if the search falls off the end then log to the end as well
1133
 
            end_index = len(view_revisions) - 1
1134
 
        view_revisions = view_revisions[start_index:end_index+1]
1135
 
    return view_revisions
1136
 
 
1137
 
 
1138
1175
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1139
1176
    include_merges=True):
1140
1177
    r"""Return the list of revision ids which touch a given file id.
1143
1180
    This includes the revisions which directly change the file id,
1144
1181
    and the revisions which merge these changes. So if the
1145
1182
    revision graph is::
 
1183
 
1146
1184
        A-.
1147
1185
        |\ \
1148
1186
        B C E
1175
1213
    """
1176
1214
    # Lookup all possible text keys to determine which ones actually modified
1177
1215
    # the file.
 
1216
    graph = branch.repository.get_file_graph()
 
1217
    get_parent_map = graph.get_parent_map
1178
1218
    text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
1179
1219
    next_keys = None
1180
1220
    # Looking up keys in batches of 1000 can cut the time in half, as well as
1184
1224
    #       indexing layer. We might consider passing in hints as to the known
1185
1225
    #       access pattern (sparse/clustered, high success rate/low success
1186
1226
    #       rate). This particular access is clustered with a low success rate.
1187
 
    get_parent_map = branch.repository.texts.get_parent_map
1188
1227
    modified_text_revisions = set()
1189
1228
    chunk_size = 1000
1190
1229
    for start in xrange(0, len(text_keys), chunk_size):
1217
1256
    return result
1218
1257
 
1219
1258
 
1220
 
@deprecated_function(deprecated_in((2, 2, 0)))
1221
 
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
1222
 
                       include_merges=True):
1223
 
    """Produce an iterator of revisions to show
1224
 
    :return: an iterator of (revision_id, revno, merge_depth)
1225
 
    (if there is no revno for a revision, None is supplied)
1226
 
    """
1227
 
    if not include_merges:
1228
 
        revision_ids = mainline_revs[1:]
1229
 
        if direction == 'reverse':
1230
 
            revision_ids.reverse()
1231
 
        for revision_id in revision_ids:
1232
 
            yield revision_id, str(rev_nos[revision_id]), 0
1233
 
        return
1234
 
    graph = branch.repository.get_graph()
1235
 
    # This asks for all mainline revisions, which means we only have to spider
1236
 
    # sideways, rather than depth history. That said, its still size-of-history
1237
 
    # and should be addressed.
1238
 
    # mainline_revisions always includes an extra revision at the beginning, so
1239
 
    # don't request it.
1240
 
    parent_map = dict(((key, value) for key, value in
1241
 
        graph.iter_ancestry(mainline_revs[1:]) if value is not None))
1242
 
    # filter out ghosts; merge_sort errors on ghosts.
1243
 
    rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
1244
 
    merge_sorted_revisions = tsort.merge_sort(
1245
 
        rev_graph,
1246
 
        mainline_revs[-1],
1247
 
        mainline_revs,
1248
 
        generate_revno=True)
1249
 
 
1250
 
    if direction == 'forward':
1251
 
        # forward means oldest first.
1252
 
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
1253
 
    elif direction != 'reverse':
1254
 
        raise ValueError('invalid direction %r' % direction)
1255
 
 
1256
 
    for (sequence, rev_id, merge_depth, revno, end_of_merge
1257
 
         ) in merge_sorted_revisions:
1258
 
        yield rev_id, '.'.join(map(str, revno)), merge_depth
1259
 
 
1260
 
 
1261
1259
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1262
1260
    """Reverse revisions by depth.
1263
1261
 
1298
1296
    """
1299
1297
 
1300
1298
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1301
 
                 tags=None, diff=None):
 
1299
                 tags=None, diff=None, signature=None):
1302
1300
        self.rev = rev
1303
 
        self.revno = str(revno)
 
1301
        if revno is None:
 
1302
            self.revno = None
 
1303
        else:
 
1304
            self.revno = str(revno)
1304
1305
        self.merge_depth = merge_depth
1305
1306
        self.delta = delta
1306
1307
        self.tags = tags
1307
1308
        self.diff = diff
 
1309
        self.signature = signature
1308
1310
 
1309
1311
 
1310
1312
class LogFormatter(object):
1319
1321
    to indicate which LogRevision attributes it supports:
1320
1322
 
1321
1323
    - supports_delta must be True if this log formatter supports delta.
1322
 
        Otherwise the delta attribute may not be populated.  The 'delta_format'
1323
 
        attribute describes whether the 'short_status' format (1) or the long
1324
 
        one (2) should be used.
 
1324
      Otherwise the delta attribute may not be populated.  The 'delta_format'
 
1325
      attribute describes whether the 'short_status' format (1) or the long
 
1326
      one (2) should be used.
1325
1327
 
1326
1328
    - supports_merge_revisions must be True if this log formatter supports
1327
 
        merge revisions.  If not, then only mainline revisions will be passed
1328
 
        to the formatter.
 
1329
      merge revisions.  If not, then only mainline revisions will be passed
 
1330
      to the formatter.
1329
1331
 
1330
1332
    - preferred_levels is the number of levels this formatter defaults to.
1331
 
        The default value is zero meaning display all levels.
1332
 
        This value is only relevant if supports_merge_revisions is True.
 
1333
      The default value is zero meaning display all levels.
 
1334
      This value is only relevant if supports_merge_revisions is True.
1333
1335
 
1334
1336
    - supports_tags must be True if this log formatter supports tags.
1335
 
        Otherwise the tags attribute may not be populated.
 
1337
      Otherwise the tags attribute may not be populated.
1336
1338
 
1337
1339
    - supports_diff must be True if this log formatter supports diffs.
1338
 
        Otherwise the diff attribute may not be populated.
 
1340
      Otherwise the diff attribute may not be populated.
 
1341
 
 
1342
    - supports_signatures must be True if this log formatter supports GPG
 
1343
      signatures.
1339
1344
 
1340
1345
    Plugins can register functions to show custom revision properties using
1341
1346
    the properties_handler_registry. The registered function
1342
 
    must respect the following interface description:
 
1347
    must respect the following interface description::
 
1348
 
1343
1349
        def my_show_properties(properties_dict):
1344
1350
            # code that returns a dict {'name':'value'} of the properties
1345
1351
            # to be shown
1352
1358
        """Create a LogFormatter.
1353
1359
 
1354
1360
        :param to_file: the file to output to
1355
 
        :param to_exact_file: if set, gives an output stream to which 
 
1361
        :param to_exact_file: if set, gives an output stream to which
1356
1362
             non-Unicode diffs are written.
1357
1363
        :param show_ids: if True, revision-ids are to be displayed
1358
1364
        :param show_timezone: the timezone to use
1409
1415
            if advice_sep:
1410
1416
                self.to_file.write(advice_sep)
1411
1417
            self.to_file.write(
1412
 
                "Use --include-merges or -n0 to see merged revisions.\n")
 
1418
                "Use --include-merged or -n0 to see merged revisions.\n")
1413
1419
 
1414
1420
    def get_advice_separator(self):
1415
1421
        """Get the text separating the log from the closing advice."""
1532
1538
    supports_delta = True
1533
1539
    supports_tags = True
1534
1540
    supports_diff = True
 
1541
    supports_signatures = True
1535
1542
 
1536
1543
    def __init__(self, *args, **kwargs):
1537
1544
        super(LongLogFormatter, self).__init__(*args, **kwargs)
1557
1564
                self.merge_marker(revision)))
1558
1565
        if revision.tags:
1559
1566
            lines.append('tags: %s' % (', '.join(revision.tags)))
1560
 
        if self.show_ids:
 
1567
        if self.show_ids or revision.revno is None:
1561
1568
            lines.append('revision-id: %s' % (revision.rev.revision_id,))
 
1569
        if self.show_ids:
1562
1570
            for parent_id in revision.rev.parent_ids:
1563
1571
                lines.append('parent: %s' % (parent_id,))
1564
1572
        lines.extend(self.custom_properties(revision.rev))
1575
1583
 
1576
1584
        lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1577
1585
 
 
1586
        if revision.signature is not None:
 
1587
            lines.append('signature: ' + revision.signature)
 
1588
 
1578
1589
        lines.append('message:')
1579
1590
        if not revision.rev.message:
1580
1591
            lines.append('  (no message)')
1589
1600
        if revision.delta is not None:
1590
1601
            # Use the standard status output to display changes
1591
1602
            from bzrlib.delta import report_delta
1592
 
            report_delta(to_file, revision.delta, short_status=False, 
 
1603
            report_delta(to_file, revision.delta, short_status=False,
1593
1604
                         show_ids=self.show_ids, indent=indent)
1594
1605
        if revision.diff is not None:
1595
1606
            to_file.write(indent + 'diff:\n')
1627
1638
        indent = '    ' * depth
1628
1639
        revno_width = self.revno_width_by_depth.get(depth)
1629
1640
        if revno_width is None:
1630
 
            if revision.revno.find('.') == -1:
 
1641
            if revision.revno is None or revision.revno.find('.') == -1:
1631
1642
                # mainline revno, e.g. 12345
1632
1643
                revno_width = 5
1633
1644
            else:
1641
1652
        if revision.tags:
1642
1653
            tags = ' {%s}' % (', '.join(revision.tags))
1643
1654
        to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1644
 
                revision.revno, self.short_author(revision.rev),
 
1655
                revision.revno or "", self.short_author(revision.rev),
1645
1656
                format_date(revision.rev.timestamp,
1646
1657
                            revision.rev.timezone or 0,
1647
1658
                            self.show_timezone, date_fmt="%Y-%m-%d",
1648
1659
                            show_offset=False),
1649
1660
                tags, self.merge_marker(revision)))
1650
1661
        self.show_properties(revision.rev, indent+offset)
1651
 
        if self.show_ids:
 
1662
        if self.show_ids or revision.revno is None:
1652
1663
            to_file.write(indent + offset + 'revision-id:%s\n'
1653
1664
                          % (revision.rev.revision_id,))
1654
1665
        if not revision.rev.message:
1661
1672
        if revision.delta is not None:
1662
1673
            # Use the standard status output to display changes
1663
1674
            from bzrlib.delta import report_delta
1664
 
            report_delta(to_file, revision.delta, 
1665
 
                         short_status=self.delta_format==1, 
 
1675
            report_delta(to_file, revision.delta,
 
1676
                         short_status=self.delta_format==1,
1666
1677
                         show_ids=self.show_ids, indent=indent + offset)
1667
1678
        if revision.diff is not None:
1668
1679
            self.show_diff(self.to_exact_file, revision.diff, '      ')
1707
1718
 
1708
1719
    def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1709
1720
        """Format log info into one string. Truncate tail of string
1710
 
        :param  revno:      revision number or None.
1711
 
                            Revision numbers counts from 1.
1712
 
        :param  rev:        revision object
1713
 
        :param  max_chars:  maximum length of resulting string
1714
 
        :param  tags:       list of tags or None
1715
 
        :param  prefix:     string to prefix each line
1716
 
        :return:            formatted truncated string
 
1721
 
 
1722
        :param revno:      revision number or None.
 
1723
                           Revision numbers counts from 1.
 
1724
        :param rev:        revision object
 
1725
        :param max_chars:  maximum length of resulting string
 
1726
        :param tags:       list of tags or None
 
1727
        :param prefix:     string to prefix each line
 
1728
        :return:           formatted truncated string
1717
1729
        """
1718
1730
        out = []
1719
1731
        if revno:
1720
1732
            # show revno only when is not None
1721
1733
            out.append("%s:" % revno)
1722
 
        out.append(self.truncate(self.short_author(rev), 20))
 
1734
        if max_chars is not None:
 
1735
            out.append(self.truncate(self.short_author(rev), (max_chars+3)/4))
 
1736
        else:
 
1737
            out.append(self.short_author(rev))
1723
1738
        out.append(self.date_string(rev))
1724
1739
        if len(rev.parent_ids) > 1:
1725
1740
            out.append('[merge]')
1784
1799
        return self.get(name)(*args, **kwargs)
1785
1800
 
1786
1801
    def get_default(self, branch):
1787
 
        return self.get(branch.get_config().log_format())
 
1802
        c = branch.get_config_stack()
 
1803
        return self.get(c.get('log_format'))
1788
1804
 
1789
1805
 
1790
1806
log_formatter_registry = LogFormatterRegistry()
1791
1807
 
1792
1808
 
1793
1809
log_formatter_registry.register('short', ShortLogFormatter,
1794
 
                                'Moderately short log format')
 
1810
                                'Moderately short log format.')
1795
1811
log_formatter_registry.register('long', LongLogFormatter,
1796
 
                                'Detailed log format')
 
1812
                                'Detailed log format.')
1797
1813
log_formatter_registry.register('line', LineLogFormatter,
1798
 
                                'Log format with one line per revision')
 
1814
                                'Log format with one line per revision.')
1799
1815
log_formatter_registry.register('gnu-changelog', GnuChangelogLogFormatter,
1800
 
                                'Format used by GNU ChangeLog files')
 
1816
                                'Format used by GNU ChangeLog files.')
1801
1817
 
1802
1818
 
1803
1819
def register_formatter(name, formatter):
1813
1829
    try:
1814
1830
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
1815
1831
    except KeyError:
1816
 
        raise errors.BzrCommandError("unknown log formatter: %r" % name)
 
1832
        raise errors.BzrCommandError(gettext("unknown log formatter: %r") % name)
1817
1833
 
1818
1834
 
1819
1835
def author_list_all(rev):
1844
1860
                              'The committer')
1845
1861
 
1846
1862
 
1847
 
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
1848
 
    # deprecated; for compatibility
1849
 
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
1850
 
    lf.show(revno, rev, delta)
1851
 
 
1852
 
 
1853
1863
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1854
1864
                           log_format='long'):
1855
1865
    """Show the change in revision history comparing the old revision history to the new one.
1918
1928
    old_revisions = set()
1919
1929
    new_history = []
1920
1930
    new_revisions = set()
1921
 
    new_iter = repository.iter_reverse_revision_history(new_revision_id)
1922
 
    old_iter = repository.iter_reverse_revision_history(old_revision_id)
 
1931
    graph = repository.get_graph()
 
1932
    new_iter = graph.iter_lefthand_ancestry(new_revision_id)
 
1933
    old_iter = graph.iter_lefthand_ancestry(old_revision_id)
1923
1934
    stop_revision = None
1924
1935
    do_old = True
1925
1936
    do_new = True
2018
2029
      branch will be read-locked.
2019
2030
    """
2020
2031
    from builtins import _get_revision_range
2021
 
    tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
 
2032
    tree, b, path = controldir.ControlDir.open_containing_tree_or_branch(
 
2033
        file_list[0])
2022
2034
    add_cleanup(b.lock_read().unlock)
2023
2035
    # XXX: It's damn messy converting a list of paths to relative paths when
2024
2036
    # those paths might be deleted ones, they might be on a case-insensitive
2113
2125
                          len(row) > 1 and row[1] == 'fixed']
2114
2126
 
2115
2127
        if fixed_bug_urls:
2116
 
            return {'fixes bug(s)': ' '.join(fixed_bug_urls)}
 
2128
            return {ngettext('fixes bug', 'fixes bugs', len(fixed_bug_urls)):\
 
2129
                    ' '.join(fixed_bug_urls)}
2117
2130
    return {}
2118
2131
 
2119
2132
properties_handler_registry.register('bugs_properties_handler',