~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Vincent Ladeuil
  • Date: 2010-04-28 10:33:44 UTC
  • mfrom: (5171.2.3 401599-strict-warnings)
  • mto: This revision was merged to the branch mainline in revision 5191.
  • Revision ID: v.ladeuil+lp@free.fr-20100428103344-e32qf3cn1avdd2cb
Don't mention --no-strict when we just issue the warning about unclean trees

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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,
76
77
    tsort,
77
78
    )
78
 
from bzrlib.i18n import gettext, ngettext
79
79
""")
80
80
 
81
81
from bzrlib import (
82
 
    lazy_regex,
83
82
    registry,
84
83
    )
85
84
from bzrlib.osutils import (
86
85
    format_date,
87
86
    format_date_with_offset_in_original_timezone,
88
 
    get_diff_header_encoding,
89
87
    get_terminal_encoding,
 
88
    re_compile_checked,
90
89
    terminal_width,
91
90
    )
 
91
from bzrlib.symbol_versioning import (
 
92
    deprecated_function,
 
93
    deprecated_in,
 
94
    )
92
95
 
93
96
 
94
97
def find_touching_revisions(branch, file_id):
107
110
    revno = 1
108
111
    for revision_id in branch.revision_history():
109
112
        this_inv = branch.repository.get_inventory(revision_id)
110
 
        if this_inv.has_id(file_id):
 
113
        if file_id in this_inv:
111
114
            this_ie = this_inv[file_id]
112
115
            this_path = this_inv.id2path(file_id)
113
116
        else:
153
156
             end_revision=None,
154
157
             search=None,
155
158
             limit=None,
156
 
             show_diff=False,
157
 
             match=None):
 
159
             show_diff=False):
158
160
    """Write out human-readable log of commits to this branch.
159
161
 
160
162
    This function is being retained for backwards compatibility but
183
185
        if None or 0.
184
186
 
185
187
    :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.
189
188
    """
190
189
    # Convert old-style parameters to new-style parameters
191
190
    if specific_fileid is not None:
215
214
    Logger(branch, rqst).show(lf)
216
215
 
217
216
 
218
 
# Note: This needs to be kept in sync with the defaults in
 
217
# Note: This needs to be kept this in sync with the defaults in
219
218
# make_log_request_dict() below
220
219
_DEFAULT_REQUEST_PARAMS = {
221
220
    'direction': 'reverse',
222
 
    'levels': None,
 
221
    'levels': 1,
223
222
    'generate_tags': True,
224
223
    'exclude_common_ancestry': False,
225
224
    '_match_using_deltas': True,
228
227
 
229
228
def make_log_request_dict(direction='reverse', specific_fileids=None,
230
229
                          start_revision=None, end_revision=None, limit=None,
231
 
                          message_search=None, levels=None, generate_tags=True,
 
230
                          message_search=None, levels=1, generate_tags=True,
232
231
                          delta_type=None,
233
232
                          diff_type=None, _match_using_deltas=True,
234
 
                          exclude_common_ancestry=False, match=None,
235
 
                          signature=False, omit_merges=False,
 
233
                          exclude_common_ancestry=False,
236
234
                          ):
237
235
    """Convenience function for making a logging request dictionary.
238
236
 
259
257
      matching commit messages
260
258
 
261
259
    :param levels: the number of levels of revisions to
262
 
      generate; 1 for just the mainline; 0 for all levels, or None for
263
 
      a sensible default.
 
260
      generate; 1 for just the mainline; 0 for all levels.
264
261
 
265
262
    :param generate_tags: If True, include tags for matched revisions.
266
 
`
 
263
 
267
264
    :param delta_type: Either 'full', 'partial' or None.
268
265
      'full' means generate the complete delta - adds/deletes/modifies/etc;
269
266
      'partial' means filter the delta using specific_fileids;
281
278
 
282
279
    :param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
283
280
      range operator or as a graph difference.
284
 
 
285
 
    :param signature: show digital signature information
286
 
 
287
 
    :param match: Dictionary of list of search strings to use when filtering
288
 
      revisions. Keys can be 'message', 'author', 'committer', 'bugs' or
289
 
      the empty string to match any of the preceding properties.
290
 
 
291
 
    :param omit_merges: If True, commits with more than one parent are
292
 
      omitted.
293
 
 
294
281
    """
295
 
    # Take care of old style message_search parameter
296
 
    if message_search:
297
 
        if match:
298
 
            if 'message' in match:
299
 
                match['message'].append(message_search)
300
 
            else:
301
 
                match['message'] = [message_search]
302
 
        else:
303
 
            match={ 'message': [message_search] }
304
282
    return {
305
283
        'direction': direction,
306
284
        'specific_fileids': specific_fileids,
307
285
        'start_revision': start_revision,
308
286
        'end_revision': end_revision,
309
287
        'limit': limit,
 
288
        'message_search': message_search,
310
289
        'levels': levels,
311
290
        'generate_tags': generate_tags,
312
291
        'delta_type': delta_type,
313
292
        'diff_type': diff_type,
314
293
        'exclude_common_ancestry': exclude_common_ancestry,
315
 
        'signature': signature,
316
 
        'match': match,
317
 
        'omit_merges': omit_merges,
318
294
        # Add 'private' attributes for features that may be deprecated
319
295
        '_match_using_deltas': _match_using_deltas,
320
296
    }
322
298
 
323
299
def _apply_log_request_defaults(rqst):
324
300
    """Apply default values to a request dictionary."""
325
 
    result = _DEFAULT_REQUEST_PARAMS.copy()
 
301
    result = _DEFAULT_REQUEST_PARAMS
326
302
    if rqst:
327
303
        result.update(rqst)
328
304
    return result
329
305
 
330
306
 
331
 
def format_signature_validity(rev_id, repo):
332
 
    """get the signature validity
333
 
 
334
 
    :param rev_id: revision id to validate
335
 
    :param repo: repository of revision
336
 
    :return: human readable string to print to log
337
 
    """
338
 
    from bzrlib import gpg
339
 
 
340
 
    gpg_strategy = gpg.GPGStrategy(None)
341
 
    result = repo.verify_revision(rev_id, gpg_strategy)
342
 
    if result[0] == gpg.SIGNATURE_VALID:
343
 
        return "valid signature from {0}".format(result[1])
344
 
    if result[0] == gpg.SIGNATURE_KEY_MISSING:
345
 
        return "unknown key {0}".format(result[1])
346
 
    if result[0] == gpg.SIGNATURE_NOT_VALID:
347
 
        return "invalid signature!"
348
 
    if result[0] == gpg.SIGNATURE_NOT_SIGNED:
349
 
        return "no signature"
350
 
 
351
 
 
352
307
class LogGenerator(object):
353
308
    """A generator of log revisions."""
354
309
 
399
354
        # Tweak the LogRequest based on what the LogFormatter can handle.
400
355
        # (There's no point generating stuff if the formatter can't display it.)
401
356
        rqst = self.rqst
402
 
        if rqst['levels'] is None or lf.get_levels() > rqst['levels']:
403
 
            # user didn't specify levels, use whatever the LF can handle:
404
 
            rqst['levels'] = lf.get_levels()
405
 
 
 
357
        rqst['levels'] = lf.get_levels()
406
358
        if not getattr(lf, 'supports_tags', False):
407
359
            rqst['generate_tags'] = False
408
360
        if not getattr(lf, 'supports_delta', False):
409
361
            rqst['delta_type'] = None
410
362
        if not getattr(lf, 'supports_diff', False):
411
363
            rqst['diff_type'] = None
412
 
        if not getattr(lf, 'supports_signatures', False):
413
 
            rqst['signature'] = False
414
364
 
415
365
        # Find and print the interesting revisions
416
366
        generator = self._generator_factory(self.branch, rqst)
420
370
 
421
371
    def _generator_factory(self, branch, rqst):
422
372
        """Make the LogGenerator object to use.
423
 
 
 
373
        
424
374
        Subclasses may wish to override this.
425
375
        """
426
376
        return _DefaultLogGenerator(branch, rqst)
450
400
        levels = rqst.get('levels')
451
401
        limit = rqst.get('limit')
452
402
        diff_type = rqst.get('diff_type')
453
 
        show_signature = rqst.get('signature')
454
 
        omit_merges = rqst.get('omit_merges')
455
403
        log_count = 0
456
404
        revision_iterator = self._create_log_revision_iterator()
457
405
        for revs in revision_iterator:
459
407
                # 0 levels means show everything; merge_depth counts from 0
460
408
                if levels != 0 and merge_depth >= levels:
461
409
                    continue
462
 
                if omit_merges and len(rev.parent_ids) > 1:
463
 
                    continue
464
410
                if diff_type is None:
465
411
                    diff = None
466
412
                else:
467
413
                    diff = self._format_diff(rev, rev_id, diff_type)
468
 
                if show_signature:
469
 
                    signature = format_signature_validity(rev_id,
470
 
                                                self.branch.repository)
471
 
                else:
472
 
                    signature = None
473
414
                yield LogRevision(rev, revno, merge_depth, delta,
474
 
                    self.rev_tag_dict.get(rev_id), diff, signature)
 
415
                    self.rev_tag_dict.get(rev_id), diff)
475
416
                if limit:
476
417
                    log_count += 1
477
418
                    if log_count >= limit:
491
432
        else:
492
433
            specific_files = None
493
434
        s = StringIO()
494
 
        path_encoding = get_diff_header_encoding()
495
435
        diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
496
 
            new_label='', path_encoding=path_encoding)
 
436
            new_label='')
497
437
        return s.getvalue()
498
438
 
499
439
    def _create_log_revision_iterator(self):
532
472
 
533
473
        # Apply the other filters
534
474
        return make_log_rev_iterator(self.branch, view_revisions,
535
 
            rqst.get('delta_type'), rqst.get('match'),
 
475
            rqst.get('delta_type'), rqst.get('message_search'),
536
476
            file_ids=rqst.get('specific_fileids'),
537
477
            direction=rqst.get('direction'))
538
478
 
551
491
            rqst.get('specific_fileids')[0], view_revisions,
552
492
            include_merges=rqst.get('levels') != 1)
553
493
        return make_log_rev_iterator(self.branch, view_revisions,
554
 
            rqst.get('delta_type'), rqst.get('match'))
 
494
            rqst.get('delta_type'), rqst.get('message_search'))
555
495
 
556
496
 
557
497
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
565
505
             a list of the same tuples.
566
506
    """
567
507
    if (exclude_common_ancestry and start_rev_id == end_rev_id):
568
 
        raise errors.BzrCommandError(gettext(
569
 
            '--exclude-common-ancestry requires two different revisions'))
 
508
        raise errors.BzrCommandError(
 
509
            '--exclude-common-ancestry requires two different revisions')
570
510
    if direction not in ('reverse', 'forward'):
571
 
        raise ValueError(gettext('invalid direction %r') % direction)
 
511
        raise ValueError('invalid direction %r' % direction)
572
512
    br_revno, br_rev_id = branch.last_revision_info()
573
513
    if br_revno == 0:
574
514
        return []
582
522
    elif not generate_merge_revisions:
583
523
        # If we only want to see linear revisions, we can iterate ...
584
524
        iter_revs = _generate_flat_revisions(branch, start_rev_id, end_rev_id,
585
 
                                             direction, exclude_common_ancestry)
 
525
                                             direction)
586
526
        if direction == 'forward':
587
527
            iter_revs = reversed(iter_revs)
588
528
    else:
599
539
        # It's the tip
600
540
        return [(br_rev_id, br_revno, 0)]
601
541
    else:
602
 
        revno_str = _compute_revno_str(branch, rev_id)
 
542
        revno = branch.revision_id_to_dotted_revno(rev_id)
 
543
        revno_str = '.'.join(str(n) for n in revno)
603
544
        return [(rev_id, revno_str, 0)]
604
545
 
605
546
 
606
 
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction,
607
 
                             exclude_common_ancestry=False):
608
 
    result = _linear_view_revisions(
609
 
        branch, start_rev_id, end_rev_id,
610
 
        exclude_common_ancestry=exclude_common_ancestry)
 
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)
611
549
    # If a start limit was given and it's not obviously an
612
550
    # ancestor of the end limit, check it before outputting anything
613
551
    if direction == 'forward' or (start_rev_id
615
553
        try:
616
554
            result = list(result)
617
555
        except _StartNotLinearAncestor:
618
 
            raise errors.BzrCommandError(gettext('Start revision not found in'
619
 
                ' left-hand history of end revision.'))
 
556
            raise errors.BzrCommandError('Start revision not found in'
 
557
                ' left-hand history of end revision.')
620
558
    return result
621
559
 
622
560
 
634
572
    if delayed_graph_generation:
635
573
        try:
636
574
            for rev_id, revno, depth in  _linear_view_revisions(
637
 
                branch, start_rev_id, end_rev_id, exclude_common_ancestry):
 
575
                branch, start_rev_id, end_rev_id):
638
576
                if _has_merges(branch, rev_id):
639
577
                    # The end_rev_id can be nested down somewhere. We need an
640
578
                    # explicit ancestry check. There is an ambiguity here as we
661
599
        except _StartNotLinearAncestor:
662
600
            # A merge was never detected so the lower revision limit can't
663
601
            # be nested down somewhere
664
 
            raise errors.BzrCommandError(gettext('Start revision not found in'
665
 
                ' history of end revision.'))
 
602
            raise errors.BzrCommandError('Start revision not found in'
 
603
                ' history of end revision.')
666
604
 
667
605
    # We exit the loop above because we encounter a revision with merges, from
668
606
    # this revision, we need to switch to _graph_view_revisions.
685
623
    return len(parents) > 1
686
624
 
687
625
 
688
 
def _compute_revno_str(branch, rev_id):
689
 
    """Compute the revno string from a rev_id.
690
 
 
691
 
    :return: The revno string, or None if the revision is not in the supplied
692
 
        branch.
693
 
    """
694
 
    try:
695
 
        revno = branch.revision_id_to_dotted_revno(rev_id)
696
 
    except errors.NoSuchRevision:
697
 
        # The revision must be outside of this branch
698
 
        return None
699
 
    else:
700
 
        return '.'.join(str(n) for n in revno)
701
 
 
702
 
 
703
626
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
704
627
    """Is start_rev_id an obvious ancestor of end_rev_id?"""
705
628
    if start_rev_id and end_rev_id:
706
 
        try:
707
 
            start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
708
 
            end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
709
 
        except errors.NoSuchRevision:
710
 
            # one or both is not in the branch; not obvious
711
 
            return False
 
629
        start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
 
630
        end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
712
631
        if len(start_dotted) == 1 and len(end_dotted) == 1:
713
632
            # both on mainline
714
633
            return start_dotted[0] <= end_dotted[0]
724
643
    return True
725
644
 
726
645
 
727
 
def _linear_view_revisions(branch, start_rev_id, end_rev_id,
728
 
                           exclude_common_ancestry=False):
 
646
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
729
647
    """Calculate a sequence of revisions to view, newest to oldest.
730
648
 
731
649
    :param start_rev_id: the lower revision-id
732
650
    :param end_rev_id: the upper revision-id
733
 
    :param exclude_common_ancestry: Whether the start_rev_id should be part of
734
 
        the iterated revisions.
735
651
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
736
652
    :raises _StartNotLinearAncestor: if a start_rev_id is specified but
737
 
        is not found walking the left-hand history
 
653
      is not found walking the left-hand history
738
654
    """
739
655
    br_revno, br_rev_id = branch.last_revision_info()
740
656
    repo = branch.repository
741
 
    graph = repo.get_graph()
742
657
    if start_rev_id is None and end_rev_id is None:
743
658
        cur_revno = br_revno
744
 
        for revision_id in graph.iter_lefthand_ancestry(br_rev_id,
745
 
            (_mod_revision.NULL_REVISION,)):
 
659
        for revision_id in repo.iter_reverse_revision_history(br_rev_id):
746
660
            yield revision_id, str(cur_revno), 0
747
661
            cur_revno -= 1
748
662
    else:
749
663
        if end_rev_id is None:
750
664
            end_rev_id = br_rev_id
751
665
        found_start = start_rev_id is None
752
 
        for revision_id in graph.iter_lefthand_ancestry(end_rev_id,
753
 
                (_mod_revision.NULL_REVISION,)):
754
 
            revno_str = _compute_revno_str(branch, revision_id)
 
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)
755
669
            if not found_start and revision_id == start_rev_id:
756
 
                if not exclude_common_ancestry:
757
 
                    yield revision_id, revno_str, 0
 
670
                yield revision_id, revno_str, 0
758
671
                found_start = True
759
672
                break
760
673
            else:
808
721
            yield rev_id, '.'.join(map(str, revno)), merge_depth
809
722
 
810
723
 
 
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
 
811
743
def _rebase_merge_depth(view_revisions):
812
744
    """Adjust depths upwards so the top level is 0."""
813
745
    # If either the first or last revision have a merge_depth of 0, we're done
857
789
    return log_rev_iterator
858
790
 
859
791
 
860
 
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
 
792
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
861
793
    """Create a filtered iterator of log_rev_iterator matching on a regex.
862
794
 
863
795
    :param branch: The branch being logged.
864
796
    :param generate_delta: Whether to generate a delta for each revision.
865
 
    :param match: A dictionary with properties as keys and lists of strings
866
 
        as values. To match, a revision may match any of the supplied strings
867
 
        within a single property but must match at least one string for each
868
 
        property.
 
797
    :param search: A user text search string.
869
798
    :param log_rev_iterator: An input iterator containing all revisions that
870
799
        could be displayed, in lists.
871
800
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
872
801
        delta).
873
802
    """
874
 
    if match is None:
 
803
    if search is None:
875
804
        return log_rev_iterator
876
 
    searchRE = [(k, [re.compile(x, re.IGNORECASE) for x in v])
877
 
                for (k,v) in match.iteritems()]
878
 
    return _filter_re(searchRE, log_rev_iterator)
879
 
 
880
 
 
881
 
def _filter_re(searchRE, log_rev_iterator):
 
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):
882
811
    for revs in log_rev_iterator:
883
 
        new_revs = [rev for rev in revs if _match_filter(searchRE, rev[1])]
884
 
        if new_revs:
885
 
            yield new_revs
886
 
 
887
 
def _match_filter(searchRE, rev):
888
 
    strings = {
889
 
               'message': (rev.message,),
890
 
               'committer': (rev.committer,),
891
 
               'author': (rev.get_apparent_authors()),
892
 
               'bugs': list(rev.iter_bugs())
893
 
               }
894
 
    strings[''] = [item for inner_list in strings.itervalues()
895
 
                   for item in inner_list]
896
 
    for (k,v) in searchRE:
897
 
        if k in strings and not _match_any_filter(strings[k], v):
898
 
            return False
899
 
    return True
900
 
 
901
 
def _match_any_filter(strings, res):
902
 
    return any([filter(None, map(re.search, strings)) for re in res])
 
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
 
903
818
 
904
819
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
905
820
    fileids=None, direction='reverse'):
978
893
 
979
894
def _update_fileids(delta, fileids, stop_on):
980
895
    """Update the set of file-ids to search based on file lifecycle events.
981
 
 
 
896
    
982
897
    :param fileids: a set of fileids to update
983
898
    :param stop_on: either 'add' or 'remove' - take file-ids out of the
984
899
      fileids set once their add or remove entry is detected respectively
1025
940
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
1026
941
        delta).
1027
942
    """
 
943
    repository = branch.repository
1028
944
    num = 9
1029
945
    for batch in log_rev_iterator:
1030
946
        batch = iter(batch)
1079
995
    if branch_revno != 0:
1080
996
        if (start_rev_id == _mod_revision.NULL_REVISION
1081
997
            or end_rev_id == _mod_revision.NULL_REVISION):
1082
 
            raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
 
998
            raise errors.BzrCommandError('Logging revision 0 is invalid.')
1083
999
        if start_revno > end_revno:
1084
 
            raise errors.BzrCommandError(gettext("Start revision must be "
1085
 
                                         "older than the end revision."))
 
1000
            raise errors.BzrCommandError("Start revision must be older than "
 
1001
                                         "the end revision.")
1086
1002
    return (start_rev_id, end_rev_id)
1087
1003
 
1088
1004
 
1137
1053
 
1138
1054
    if ((start_rev_id == _mod_revision.NULL_REVISION)
1139
1055
        or (end_rev_id == _mod_revision.NULL_REVISION)):
1140
 
        raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
 
1056
        raise errors.BzrCommandError('Logging revision 0 is invalid.')
1141
1057
    if start_revno > end_revno:
1142
 
        raise errors.BzrCommandError(gettext("Start revision must be older "
1143
 
                                     "than the end revision."))
 
1058
        raise errors.BzrCommandError("Start revision must be older than "
 
1059
                                     "the end revision.")
1144
1060
 
1145
1061
    if end_revno < start_revno:
1146
1062
        return None, None, None, None
1147
1063
    cur_revno = branch_revno
1148
1064
    rev_nos = {}
1149
1065
    mainline_revs = []
1150
 
    graph = branch.repository.get_graph()
1151
 
    for revision_id in graph.iter_lefthand_ancestry(
1152
 
            branch_last_revision, (_mod_revision.NULL_REVISION,)):
 
1066
    for revision_id in branch.repository.iter_reverse_revision_history(
 
1067
                        branch_last_revision):
1153
1068
        if cur_revno < start_revno:
1154
1069
            # We have gone far enough, but we always add 1 more revision
1155
1070
            rev_nos[revision_id] = cur_revno
1169
1084
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
1170
1085
 
1171
1086
 
 
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
 
1172
1131
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1173
1132
    include_merges=True):
1174
1133
    r"""Return the list of revision ids which touch a given file id.
1177
1136
    This includes the revisions which directly change the file id,
1178
1137
    and the revisions which merge these changes. So if the
1179
1138
    revision graph is::
1180
 
 
1181
1139
        A-.
1182
1140
        |\ \
1183
1141
        B C E
1210
1168
    """
1211
1169
    # Lookup all possible text keys to determine which ones actually modified
1212
1170
    # the file.
1213
 
    graph = branch.repository.get_file_graph()
1214
 
    get_parent_map = graph.get_parent_map
1215
1171
    text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
1216
1172
    next_keys = None
1217
1173
    # Looking up keys in batches of 1000 can cut the time in half, as well as
1221
1177
    #       indexing layer. We might consider passing in hints as to the known
1222
1178
    #       access pattern (sparse/clustered, high success rate/low success
1223
1179
    #       rate). This particular access is clustered with a low success rate.
 
1180
    get_parent_map = branch.repository.texts.get_parent_map
1224
1181
    modified_text_revisions = set()
1225
1182
    chunk_size = 1000
1226
1183
    for start in xrange(0, len(text_keys), chunk_size):
1253
1210
    return result
1254
1211
 
1255
1212
 
 
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
 
1256
1254
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1257
1255
    """Reverse revisions by depth.
1258
1256
 
1293
1291
    """
1294
1292
 
1295
1293
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1296
 
                 tags=None, diff=None, signature=None):
 
1294
                 tags=None, diff=None):
1297
1295
        self.rev = rev
1298
 
        if revno is None:
1299
 
            self.revno = None
1300
 
        else:
1301
 
            self.revno = str(revno)
 
1296
        self.revno = str(revno)
1302
1297
        self.merge_depth = merge_depth
1303
1298
        self.delta = delta
1304
1299
        self.tags = tags
1305
1300
        self.diff = diff
1306
 
        self.signature = signature
1307
1301
 
1308
1302
 
1309
1303
class LogFormatter(object):
1318
1312
    to indicate which LogRevision attributes it supports:
1319
1313
 
1320
1314
    - supports_delta must be True if this log formatter supports delta.
1321
 
      Otherwise the delta attribute may not be populated.  The 'delta_format'
1322
 
      attribute describes whether the 'short_status' format (1) or the long
1323
 
      one (2) should be used.
 
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.
1324
1318
 
1325
1319
    - supports_merge_revisions must be True if this log formatter supports
1326
 
      merge revisions.  If not, then only mainline revisions will be passed
1327
 
      to the formatter.
 
1320
        merge revisions.  If not, then only mainline revisions will be passed
 
1321
        to the formatter.
1328
1322
 
1329
1323
    - preferred_levels is the number of levels this formatter defaults to.
1330
 
      The default value is zero meaning display all levels.
1331
 
      This value is only relevant if supports_merge_revisions is True.
 
1324
        The default value is zero meaning display all levels.
 
1325
        This value is only relevant if supports_merge_revisions is True.
1332
1326
 
1333
1327
    - supports_tags must be True if this log formatter supports tags.
1334
 
      Otherwise the tags attribute may not be populated.
 
1328
        Otherwise the tags attribute may not be populated.
1335
1329
 
1336
1330
    - supports_diff must be True if this log formatter supports diffs.
1337
 
      Otherwise the diff attribute may not be populated.
1338
 
 
1339
 
    - supports_signatures must be True if this log formatter supports GPG
1340
 
      signatures.
 
1331
        Otherwise the diff attribute may not be populated.
1341
1332
 
1342
1333
    Plugins can register functions to show custom revision properties using
1343
1334
    the properties_handler_registry. The registered function
1344
 
    must respect the following interface description::
1345
 
 
 
1335
    must respect the following interface description:
1346
1336
        def my_show_properties(properties_dict):
1347
1337
            # code that returns a dict {'name':'value'} of the properties
1348
1338
            # to be shown
1351
1341
 
1352
1342
    def __init__(self, to_file, show_ids=False, show_timezone='original',
1353
1343
                 delta_format=None, levels=None, show_advice=False,
1354
 
                 to_exact_file=None, author_list_handler=None):
 
1344
                 to_exact_file=None):
1355
1345
        """Create a LogFormatter.
1356
1346
 
1357
1347
        :param to_file: the file to output to
1358
 
        :param to_exact_file: if set, gives an output stream to which
 
1348
        :param to_exact_file: if set, gives an output stream to which 
1359
1349
             non-Unicode diffs are written.
1360
1350
        :param show_ids: if True, revision-ids are to be displayed
1361
1351
        :param show_timezone: the timezone to use
1365
1355
          let the log formatter decide.
1366
1356
        :param show_advice: whether to show advice at the end of the
1367
1357
          log or not
1368
 
        :param author_list_handler: callable generating a list of
1369
 
          authors to display for a given revision
1370
1358
        """
1371
1359
        self.to_file = to_file
1372
1360
        # 'exact' stream used to show diff, it should print content 'as is'
1387
1375
        self.levels = levels
1388
1376
        self._show_advice = show_advice
1389
1377
        self._merge_count = 0
1390
 
        self._author_list_handler = author_list_handler
1391
1378
 
1392
1379
    def get_levels(self):
1393
1380
        """Get the number of levels to display or 0 for all."""
1412
1399
            if advice_sep:
1413
1400
                self.to_file.write(advice_sep)
1414
1401
            self.to_file.write(
1415
 
                "Use --include-merged or -n0 to see merged revisions.\n")
 
1402
                "Use --include-merges or -n0 to see merged revisions.\n")
1416
1403
 
1417
1404
    def get_advice_separator(self):
1418
1405
        """Get the text separating the log from the closing advice."""
1425
1412
        return address
1426
1413
 
1427
1414
    def short_author(self, rev):
1428
 
        return self.authors(rev, 'first', short=True, sep=', ')
1429
 
 
1430
 
    def authors(self, rev, who, short=False, sep=None):
1431
 
        """Generate list of authors, taking --authors option into account.
1432
 
 
1433
 
        The caller has to specify the name of a author list handler,
1434
 
        as provided by the author list registry, using the ``who``
1435
 
        argument.  That name only sets a default, though: when the
1436
 
        user selected a different author list generation using the
1437
 
        ``--authors`` command line switch, as represented by the
1438
 
        ``author_list_handler`` constructor argument, that value takes
1439
 
        precedence.
1440
 
 
1441
 
        :param rev: The revision for which to generate the list of authors.
1442
 
        :param who: Name of the default handler.
1443
 
        :param short: Whether to shorten names to either name or address.
1444
 
        :param sep: What separator to use for automatic concatenation.
1445
 
        """
1446
 
        if self._author_list_handler is not None:
1447
 
            # The user did specify --authors, which overrides the default
1448
 
            author_list_handler = self._author_list_handler
1449
 
        else:
1450
 
            # The user didn't specify --authors, so we use the caller's default
1451
 
            author_list_handler = author_list_registry.get(who)
1452
 
        names = author_list_handler(rev)
1453
 
        if short:
1454
 
            for i in range(len(names)):
1455
 
                name, address = config.parse_username(names[i])
1456
 
                if name:
1457
 
                    names[i] = name
1458
 
                else:
1459
 
                    names[i] = address
1460
 
        if sep is not None:
1461
 
            names = sep.join(names)
1462
 
        return names
 
1415
        name, address = config.parse_username(rev.get_apparent_authors()[0])
 
1416
        if name:
 
1417
            return name
 
1418
        return address
1463
1419
 
1464
1420
    def merge_marker(self, revision):
1465
1421
        """Get the merge marker to include in the output or '' if none."""
1535
1491
    supports_delta = True
1536
1492
    supports_tags = True
1537
1493
    supports_diff = True
1538
 
    supports_signatures = True
1539
1494
 
1540
1495
    def __init__(self, *args, **kwargs):
1541
1496
        super(LongLogFormatter, self).__init__(*args, **kwargs)
1561
1516
                self.merge_marker(revision)))
1562
1517
        if revision.tags:
1563
1518
            lines.append('tags: %s' % (', '.join(revision.tags)))
1564
 
        if self.show_ids or revision.revno is None:
 
1519
        if self.show_ids:
1565
1520
            lines.append('revision-id: %s' % (revision.rev.revision_id,))
1566
 
        if self.show_ids:
1567
1521
            for parent_id in revision.rev.parent_ids:
1568
1522
                lines.append('parent: %s' % (parent_id,))
1569
1523
        lines.extend(self.custom_properties(revision.rev))
1570
1524
 
1571
1525
        committer = revision.rev.committer
1572
 
        authors = self.authors(revision.rev, 'all')
 
1526
        authors = revision.rev.get_apparent_authors()
1573
1527
        if authors != [committer]:
1574
1528
            lines.append('author: %s' % (", ".join(authors),))
1575
1529
        lines.append('committer: %s' % (committer,))
1580
1534
 
1581
1535
        lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1582
1536
 
1583
 
        if revision.signature is not None:
1584
 
            lines.append('signature: ' + revision.signature)
1585
 
 
1586
1537
        lines.append('message:')
1587
1538
        if not revision.rev.message:
1588
1539
            lines.append('  (no message)')
1597
1548
        if revision.delta is not None:
1598
1549
            # Use the standard status output to display changes
1599
1550
            from bzrlib.delta import report_delta
1600
 
            report_delta(to_file, revision.delta, short_status=False,
 
1551
            report_delta(to_file, revision.delta, short_status=False, 
1601
1552
                         show_ids=self.show_ids, indent=indent)
1602
1553
        if revision.diff is not None:
1603
1554
            to_file.write(indent + 'diff:\n')
1635
1586
        indent = '    ' * depth
1636
1587
        revno_width = self.revno_width_by_depth.get(depth)
1637
1588
        if revno_width is None:
1638
 
            if revision.revno is None or revision.revno.find('.') == -1:
 
1589
            if revision.revno.find('.') == -1:
1639
1590
                # mainline revno, e.g. 12345
1640
1591
                revno_width = 5
1641
1592
            else:
1649
1600
        if revision.tags:
1650
1601
            tags = ' {%s}' % (', '.join(revision.tags))
1651
1602
        to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1652
 
                revision.revno or "", self.short_author(revision.rev),
 
1603
                revision.revno, self.short_author(revision.rev),
1653
1604
                format_date(revision.rev.timestamp,
1654
1605
                            revision.rev.timezone or 0,
1655
1606
                            self.show_timezone, date_fmt="%Y-%m-%d",
1656
1607
                            show_offset=False),
1657
1608
                tags, self.merge_marker(revision)))
1658
1609
        self.show_properties(revision.rev, indent+offset)
1659
 
        if self.show_ids or revision.revno is None:
 
1610
        if self.show_ids:
1660
1611
            to_file.write(indent + offset + 'revision-id:%s\n'
1661
1612
                          % (revision.rev.revision_id,))
1662
1613
        if not revision.rev.message:
1669
1620
        if revision.delta is not None:
1670
1621
            # Use the standard status output to display changes
1671
1622
            from bzrlib.delta import report_delta
1672
 
            report_delta(to_file, revision.delta,
1673
 
                         short_status=self.delta_format==1,
 
1623
            report_delta(to_file, revision.delta, 
 
1624
                         short_status=self.delta_format==1, 
1674
1625
                         show_ids=self.show_ids, indent=indent + offset)
1675
1626
        if revision.diff is not None:
1676
1627
            self.show_diff(self.to_exact_file, revision.diff, '      ')
1715
1666
 
1716
1667
    def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1717
1668
        """Format log info into one string. Truncate tail of string
1718
 
 
1719
 
        :param revno:      revision number or None.
1720
 
                           Revision numbers counts from 1.
1721
 
        :param rev:        revision object
1722
 
        :param max_chars:  maximum length of resulting string
1723
 
        :param tags:       list of tags or None
1724
 
        :param prefix:     string to prefix each line
1725
 
        :return:           formatted truncated string
 
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
1726
1676
        """
1727
1677
        out = []
1728
1678
        if revno:
1729
1679
            # show revno only when is not None
1730
1680
            out.append("%s:" % revno)
1731
 
        if max_chars is not None:
1732
 
            out.append(self.truncate(self.short_author(rev), (max_chars+3)/4))
1733
 
        else:
1734
 
            out.append(self.short_author(rev))
 
1681
        out.append(self.truncate(self.short_author(rev), 20))
1735
1682
        out.append(self.date_string(rev))
1736
1683
        if len(rev.parent_ids) > 1:
1737
1684
            out.append('[merge]')
1756
1703
                               self.show_timezone,
1757
1704
                               date_fmt='%Y-%m-%d',
1758
1705
                               show_offset=False)
1759
 
        committer_str = self.authors(revision.rev, 'first', sep=', ')
1760
 
        committer_str = committer_str.replace(' <', '  <')
 
1706
        committer_str = revision.rev.get_apparent_authors()[0].replace (' <', '  <')
1761
1707
        to_file.write('%s  %s\n\n' % (date_str,committer_str))
1762
1708
 
1763
1709
        if revision.delta is not None and revision.delta.has_changed():
1825
1771
    try:
1826
1772
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
1827
1773
    except KeyError:
1828
 
        raise errors.BzrCommandError(gettext("unknown log formatter: %r") % name)
1829
 
 
1830
 
 
1831
 
def author_list_all(rev):
1832
 
    return rev.get_apparent_authors()[:]
1833
 
 
1834
 
 
1835
 
def author_list_first(rev):
1836
 
    lst = rev.get_apparent_authors()
1837
 
    try:
1838
 
        return [lst[0]]
1839
 
    except IndexError:
1840
 
        return []
1841
 
 
1842
 
 
1843
 
def author_list_committer(rev):
1844
 
    return [rev.committer]
1845
 
 
1846
 
 
1847
 
author_list_registry = registry.Registry()
1848
 
 
1849
 
author_list_registry.register('all', author_list_all,
1850
 
                              'All authors')
1851
 
 
1852
 
author_list_registry.register('first', author_list_first,
1853
 
                              'The first author')
1854
 
 
1855
 
author_list_registry.register('committer', author_list_committer,
1856
 
                              'The committer')
 
1774
        raise errors.BzrCommandError("unknown log formatter: %r" % name)
 
1775
 
 
1776
 
 
1777
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
 
1778
    # deprecated; for compatibility
 
1779
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
 
1780
    lf.show(revno, rev, delta)
1857
1781
 
1858
1782
 
1859
1783
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1924
1848
    old_revisions = set()
1925
1849
    new_history = []
1926
1850
    new_revisions = set()
1927
 
    graph = repository.get_graph()
1928
 
    new_iter = graph.iter_lefthand_ancestry(new_revision_id)
1929
 
    old_iter = graph.iter_lefthand_ancestry(old_revision_id)
 
1851
    new_iter = repository.iter_reverse_revision_history(new_revision_id)
 
1852
    old_iter = repository.iter_reverse_revision_history(old_revision_id)
1930
1853
    stop_revision = None
1931
1854
    do_old = True
1932
1855
    do_new = True
2007
1930
        lf.log_revision(lr)
2008
1931
 
2009
1932
 
2010
 
def _get_info_for_log_files(revisionspec_list, file_list, add_cleanup):
 
1933
def _get_info_for_log_files(revisionspec_list, file_list):
2011
1934
    """Find file-ids and kinds given a list of files and a revision range.
2012
1935
 
2013
1936
    We search for files at the end of the range. If not found there,
2017
1940
    :param file_list: the list of paths given on the command line;
2018
1941
      the first of these can be a branch location or a file path,
2019
1942
      the remainder must be file paths
2020
 
    :param add_cleanup: When the branch returned is read locked,
2021
 
      an unlock call will be queued to the cleanup.
2022
1943
    :return: (branch, info_list, start_rev_info, end_rev_info) where
2023
1944
      info_list is a list of (relative_path, file_id, kind) tuples where
2024
1945
      kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
2025
1946
      branch will be read-locked.
2026
1947
    """
2027
 
    from builtins import _get_revision_range
 
1948
    from builtins import _get_revision_range, safe_relpath_files
2028
1949
    tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
2029
 
    add_cleanup(b.lock_read().unlock)
 
1950
    b.lock_read()
2030
1951
    # XXX: It's damn messy converting a list of paths to relative paths when
2031
1952
    # those paths might be deleted ones, they might be on a case-insensitive
2032
1953
    # filesystem and/or they might be in silly locations (like another branch).
2036
1957
    # case of running log in a nested directory, assuming paths beyond the
2037
1958
    # first one haven't been deleted ...
2038
1959
    if tree:
2039
 
        relpaths = [path] + tree.safe_relpath_files(file_list[1:])
 
1960
        relpaths = [path] + safe_relpath_files(tree, file_list[1:])
2040
1961
    else:
2041
1962
        relpaths = [path] + file_list[1:]
2042
1963
    info_list = []
2120
2041
                          len(row) > 1 and row[1] == 'fixed']
2121
2042
 
2122
2043
        if fixed_bug_urls:
2123
 
            return {ngettext('fixes bug', 'fixes bugs', len(fixed_bug_urls)):\
2124
 
                    ' '.join(fixed_bug_urls)}
 
2044
            return {'fixes bug(s)': ' '.join(fixed_bug_urls)}
2125
2045
    return {}
2126
2046
 
2127
2047
properties_handler_registry.register('bugs_properties_handler',