/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

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
65
65
lazy_import(globals(), """
66
66
 
67
67
from bzrlib import (
 
68
    bzrdir,
68
69
    config,
69
 
    controldir,
70
70
    diff,
71
71
    errors,
72
72
    foreign,
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):
105
108
    last_ie = None
106
109
    last_path = None
107
110
    revno = 1
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):
 
111
    for revision_id in branch.revision_history():
112
112
        this_inv = branch.repository.get_inventory(revision_id)
113
 
        if this_inv.has_id(file_id):
 
113
        if file_id in this_inv:
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,
160
 
             match=None):
 
159
             show_diff=False):
161
160
    """Write out human-readable log of commits to this branch.
162
161
 
163
162
    This function is being retained for backwards compatibility but
186
185
        if None or 0.
187
186
 
188
187
    :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.
192
188
    """
193
189
    # Convert old-style parameters to new-style parameters
194
190
    if specific_fileid is not None:
218
214
    Logger(branch, rqst).show(lf)
219
215
 
220
216
 
221
 
# 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
222
218
# make_log_request_dict() below
223
219
_DEFAULT_REQUEST_PARAMS = {
224
220
    'direction': 'reverse',
225
 
    'levels': None,
 
221
    'levels': 1,
226
222
    'generate_tags': True,
227
223
    'exclude_common_ancestry': False,
228
224
    '_match_using_deltas': True,
231
227
 
232
228
def make_log_request_dict(direction='reverse', specific_fileids=None,
233
229
                          start_revision=None, end_revision=None, limit=None,
234
 
                          message_search=None, levels=None, generate_tags=True,
 
230
                          message_search=None, levels=1, generate_tags=True,
235
231
                          delta_type=None,
236
232
                          diff_type=None, _match_using_deltas=True,
237
 
                          exclude_common_ancestry=False, match=None,
238
 
                          signature=False, omit_merges=False,
 
233
                          exclude_common_ancestry=False,
239
234
                          ):
240
235
    """Convenience function for making a logging request dictionary.
241
236
 
262
257
      matching commit messages
263
258
 
264
259
    :param levels: the number of levels of revisions to
265
 
      generate; 1 for just the mainline; 0 for all levels, or None for
266
 
      a sensible default.
 
260
      generate; 1 for just the mainline; 0 for all levels.
267
261
 
268
262
    :param generate_tags: If True, include tags for matched revisions.
269
 
`
 
263
 
270
264
    :param delta_type: Either 'full', 'partial' or None.
271
265
      'full' means generate the complete delta - adds/deletes/modifies/etc;
272
266
      'partial' means filter the delta using specific_fileids;
284
278
 
285
279
    :param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
286
280
      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
 
 
297
281
    """
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] }
307
282
    return {
308
283
        'direction': direction,
309
284
        'specific_fileids': specific_fileids,
310
285
        'start_revision': start_revision,
311
286
        'end_revision': end_revision,
312
287
        'limit': limit,
 
288
        'message_search': message_search,
313
289
        'levels': levels,
314
290
        'generate_tags': generate_tags,
315
291
        'delta_type': delta_type,
316
292
        'diff_type': diff_type,
317
293
        'exclude_common_ancestry': exclude_common_ancestry,
318
 
        'signature': signature,
319
 
        'match': match,
320
 
        'omit_merges': omit_merges,
321
294
        # Add 'private' attributes for features that may be deprecated
322
295
        '_match_using_deltas': _match_using_deltas,
323
296
    }
325
298
 
326
299
def _apply_log_request_defaults(rqst):
327
300
    """Apply default values to a request dictionary."""
328
 
    result = _DEFAULT_REQUEST_PARAMS.copy()
 
301
    result = _DEFAULT_REQUEST_PARAMS
329
302
    if rqst:
330
303
        result.update(rqst)
331
304
    return result
332
305
 
333
306
 
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
 
 
355
307
class LogGenerator(object):
356
308
    """A generator of log revisions."""
357
309
 
402
354
        # Tweak the LogRequest based on what the LogFormatter can handle.
403
355
        # (There's no point generating stuff if the formatter can't display it.)
404
356
        rqst = self.rqst
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
 
 
 
357
        rqst['levels'] = lf.get_levels()
409
358
        if not getattr(lf, 'supports_tags', False):
410
359
            rqst['generate_tags'] = False
411
360
        if not getattr(lf, 'supports_delta', False):
412
361
            rqst['delta_type'] = None
413
362
        if not getattr(lf, 'supports_diff', False):
414
363
            rqst['diff_type'] = None
415
 
        if not getattr(lf, 'supports_signatures', False):
416
 
            rqst['signature'] = False
417
364
 
418
365
        # Find and print the interesting revisions
419
366
        generator = self._generator_factory(self.branch, rqst)
423
370
 
424
371
    def _generator_factory(self, branch, rqst):
425
372
        """Make the LogGenerator object to use.
426
 
 
 
373
        
427
374
        Subclasses may wish to override this.
428
375
        """
429
376
        return _DefaultLogGenerator(branch, rqst)
453
400
        levels = rqst.get('levels')
454
401
        limit = rqst.get('limit')
455
402
        diff_type = rqst.get('diff_type')
456
 
        show_signature = rqst.get('signature')
457
 
        omit_merges = rqst.get('omit_merges')
458
403
        log_count = 0
459
404
        revision_iterator = self._create_log_revision_iterator()
460
405
        for revs in revision_iterator:
462
407
                # 0 levels means show everything; merge_depth counts from 0
463
408
                if levels != 0 and merge_depth >= levels:
464
409
                    continue
465
 
                if omit_merges and len(rev.parent_ids) > 1:
466
 
                    continue
467
410
                if diff_type is None:
468
411
                    diff = None
469
412
                else:
470
413
                    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
476
414
                yield LogRevision(rev, revno, merge_depth, delta,
477
 
                    self.rev_tag_dict.get(rev_id), diff, signature)
 
415
                    self.rev_tag_dict.get(rev_id), diff)
478
416
                if limit:
479
417
                    log_count += 1
480
418
                    if log_count >= limit:
494
432
        else:
495
433
            specific_files = None
496
434
        s = StringIO()
497
 
        path_encoding = get_diff_header_encoding()
498
435
        diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
499
 
            new_label='', path_encoding=path_encoding)
 
436
            new_label='')
500
437
        return s.getvalue()
501
438
 
502
439
    def _create_log_revision_iterator(self):
535
472
 
536
473
        # Apply the other filters
537
474
        return make_log_rev_iterator(self.branch, view_revisions,
538
 
            rqst.get('delta_type'), rqst.get('match'),
 
475
            rqst.get('delta_type'), rqst.get('message_search'),
539
476
            file_ids=rqst.get('specific_fileids'),
540
477
            direction=rqst.get('direction'))
541
478
 
554
491
            rqst.get('specific_fileids')[0], view_revisions,
555
492
            include_merges=rqst.get('levels') != 1)
556
493
        return make_log_rev_iterator(self.branch, view_revisions,
557
 
            rqst.get('delta_type'), rqst.get('match'))
 
494
            rqst.get('delta_type'), rqst.get('message_search'))
558
495
 
559
496
 
560
497
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
568
505
             a list of the same tuples.
569
506
    """
570
507
    if (exclude_common_ancestry and start_rev_id == end_rev_id):
571
 
        raise errors.BzrCommandError(gettext(
572
 
            '--exclude-common-ancestry requires two different revisions'))
 
508
        raise errors.BzrCommandError(
 
509
            '--exclude-common-ancestry requires two different revisions')
573
510
    if direction not in ('reverse', 'forward'):
574
 
        raise ValueError(gettext('invalid direction %r') % direction)
 
511
        raise ValueError('invalid direction %r' % direction)
575
512
    br_revno, br_rev_id = branch.last_revision_info()
576
513
    if br_revno == 0:
577
514
        return []
585
522
    elif not generate_merge_revisions:
586
523
        # If we only want to see linear revisions, we can iterate ...
587
524
        iter_revs = _generate_flat_revisions(branch, start_rev_id, end_rev_id,
588
 
                                             direction, exclude_common_ancestry)
 
525
                                             direction)
589
526
        if direction == 'forward':
590
527
            iter_revs = reversed(iter_revs)
591
528
    else:
602
539
        # It's the tip
603
540
        return [(br_rev_id, br_revno, 0)]
604
541
    else:
605
 
        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)
606
544
        return [(rev_id, revno_str, 0)]
607
545
 
608
546
 
609
 
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction,
610
 
                             exclude_common_ancestry=False):
611
 
    result = _linear_view_revisions(
612
 
        branch, start_rev_id, end_rev_id,
613
 
        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)
614
549
    # If a start limit was given and it's not obviously an
615
550
    # ancestor of the end limit, check it before outputting anything
616
551
    if direction == 'forward' or (start_rev_id
618
553
        try:
619
554
            result = list(result)
620
555
        except _StartNotLinearAncestor:
621
 
            raise errors.BzrCommandError(gettext('Start revision not found in'
622
 
                ' left-hand history of end revision.'))
 
556
            raise errors.BzrCommandError('Start revision not found in'
 
557
                ' left-hand history of end revision.')
623
558
    return result
624
559
 
625
560
 
637
572
    if delayed_graph_generation:
638
573
        try:
639
574
            for rev_id, revno, depth in  _linear_view_revisions(
640
 
                branch, start_rev_id, end_rev_id, exclude_common_ancestry):
 
575
                branch, start_rev_id, end_rev_id):
641
576
                if _has_merges(branch, rev_id):
642
577
                    # The end_rev_id can be nested down somewhere. We need an
643
578
                    # explicit ancestry check. There is an ambiguity here as we
664
599
        except _StartNotLinearAncestor:
665
600
            # A merge was never detected so the lower revision limit can't
666
601
            # be nested down somewhere
667
 
            raise errors.BzrCommandError(gettext('Start revision not found in'
668
 
                ' history of end revision.'))
 
602
            raise errors.BzrCommandError('Start revision not found in'
 
603
                ' history of end revision.')
669
604
 
670
605
    # We exit the loop above because we encounter a revision with merges, from
671
606
    # this revision, we need to switch to _graph_view_revisions.
688
623
    return len(parents) > 1
689
624
 
690
625
 
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
 
 
706
626
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
707
627
    """Is start_rev_id an obvious ancestor of end_rev_id?"""
708
628
    if start_rev_id and 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
 
629
        start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
 
630
        end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
715
631
        if len(start_dotted) == 1 and len(end_dotted) == 1:
716
632
            # both on mainline
717
633
            return start_dotted[0] <= end_dotted[0]
727
643
    return True
728
644
 
729
645
 
730
 
def _linear_view_revisions(branch, start_rev_id, end_rev_id,
731
 
                           exclude_common_ancestry=False):
 
646
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
732
647
    """Calculate a sequence of revisions to view, newest to oldest.
733
648
 
734
649
    :param start_rev_id: the lower revision-id
735
650
    :param end_rev_id: the upper revision-id
736
 
    :param exclude_common_ancestry: Whether the start_rev_id should be part of
737
 
        the iterated revisions.
738
651
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
739
652
    :raises _StartNotLinearAncestor: if a start_rev_id is specified but
740
 
        is not found walking the left-hand history
 
653
      is not found walking the left-hand history
741
654
    """
742
655
    br_revno, br_rev_id = branch.last_revision_info()
743
656
    repo = branch.repository
744
 
    graph = repo.get_graph()
745
657
    if start_rev_id is None and end_rev_id is None:
746
658
        cur_revno = br_revno
747
 
        for revision_id in graph.iter_lefthand_ancestry(br_rev_id,
748
 
            (_mod_revision.NULL_REVISION,)):
 
659
        for revision_id in repo.iter_reverse_revision_history(br_rev_id):
749
660
            yield revision_id, str(cur_revno), 0
750
661
            cur_revno -= 1
751
662
    else:
752
663
        if end_rev_id is None:
753
664
            end_rev_id = br_rev_id
754
665
        found_start = start_rev_id is None
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)
 
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)
758
669
            if not found_start and revision_id == start_rev_id:
759
 
                if not exclude_common_ancestry:
760
 
                    yield revision_id, revno_str, 0
 
670
                yield revision_id, revno_str, 0
761
671
                found_start = True
762
672
                break
763
673
            else:
811
721
            yield rev_id, '.'.join(map(str, revno)), merge_depth
812
722
 
813
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
 
814
743
def _rebase_merge_depth(view_revisions):
815
744
    """Adjust depths upwards so the top level is 0."""
816
745
    # If either the first or last revision have a merge_depth of 0, we're done
860
789
    return log_rev_iterator
861
790
 
862
791
 
863
 
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
 
792
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
864
793
    """Create a filtered iterator of log_rev_iterator matching on a regex.
865
794
 
866
795
    :param branch: The branch being logged.
867
796
    :param generate_delta: Whether to generate a delta for each revision.
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.
 
797
    :param search: A user text search string.
872
798
    :param log_rev_iterator: An input iterator containing all revisions that
873
799
        could be displayed, in lists.
874
800
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
875
801
        delta).
876
802
    """
877
 
    if match is None:
 
803
    if search is None:
878
804
        return 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):
 
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):
885
811
    for revs in log_rev_iterator:
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])
 
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
 
906
818
 
907
819
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
908
820
    fileids=None, direction='reverse'):
981
893
 
982
894
def _update_fileids(delta, fileids, stop_on):
983
895
    """Update the set of file-ids to search based on file lifecycle events.
984
 
 
 
896
    
985
897
    :param fileids: a set of fileids to update
986
898
    :param stop_on: either 'add' or 'remove' - take file-ids out of the
987
899
      fileids set once their add or remove entry is detected respectively
1028
940
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
1029
941
        delta).
1030
942
    """
 
943
    repository = branch.repository
1031
944
    num = 9
1032
945
    for batch in log_rev_iterator:
1033
946
        batch = iter(batch)
1082
995
    if branch_revno != 0:
1083
996
        if (start_rev_id == _mod_revision.NULL_REVISION
1084
997
            or end_rev_id == _mod_revision.NULL_REVISION):
1085
 
            raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
 
998
            raise errors.BzrCommandError('Logging revision 0 is invalid.')
1086
999
        if start_revno > end_revno:
1087
 
            raise errors.BzrCommandError(gettext("Start revision must be "
1088
 
                                         "older than the end revision."))
 
1000
            raise errors.BzrCommandError("Start revision must be older than "
 
1001
                                         "the end revision.")
1089
1002
    return (start_rev_id, end_rev_id)
1090
1003
 
1091
1004
 
1140
1053
 
1141
1054
    if ((start_rev_id == _mod_revision.NULL_REVISION)
1142
1055
        or (end_rev_id == _mod_revision.NULL_REVISION)):
1143
 
        raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
 
1056
        raise errors.BzrCommandError('Logging revision 0 is invalid.')
1144
1057
    if start_revno > end_revno:
1145
 
        raise errors.BzrCommandError(gettext("Start revision must be older "
1146
 
                                     "than the end revision."))
 
1058
        raise errors.BzrCommandError("Start revision must be older than "
 
1059
                                     "the end revision.")
1147
1060
 
1148
1061
    if end_revno < start_revno:
1149
1062
        return None, None, None, None
1150
1063
    cur_revno = branch_revno
1151
1064
    rev_nos = {}
1152
1065
    mainline_revs = []
1153
 
    graph = branch.repository.get_graph()
1154
 
    for revision_id in graph.iter_lefthand_ancestry(
1155
 
            branch_last_revision, (_mod_revision.NULL_REVISION,)):
 
1066
    for revision_id in branch.repository.iter_reverse_revision_history(
 
1067
                        branch_last_revision):
1156
1068
        if cur_revno < start_revno:
1157
1069
            # We have gone far enough, but we always add 1 more revision
1158
1070
            rev_nos[revision_id] = cur_revno
1172
1084
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
1173
1085
 
1174
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
 
1175
1131
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1176
1132
    include_merges=True):
1177
1133
    r"""Return the list of revision ids which touch a given file id.
1180
1136
    This includes the revisions which directly change the file id,
1181
1137
    and the revisions which merge these changes. So if the
1182
1138
    revision graph is::
1183
 
 
1184
1139
        A-.
1185
1140
        |\ \
1186
1141
        B C E
1213
1168
    """
1214
1169
    # Lookup all possible text keys to determine which ones actually modified
1215
1170
    # the file.
1216
 
    graph = branch.repository.get_file_graph()
1217
 
    get_parent_map = graph.get_parent_map
1218
1171
    text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
1219
1172
    next_keys = None
1220
1173
    # Looking up keys in batches of 1000 can cut the time in half, as well as
1224
1177
    #       indexing layer. We might consider passing in hints as to the known
1225
1178
    #       access pattern (sparse/clustered, high success rate/low success
1226
1179
    #       rate). This particular access is clustered with a low success rate.
 
1180
    get_parent_map = branch.repository.texts.get_parent_map
1227
1181
    modified_text_revisions = set()
1228
1182
    chunk_size = 1000
1229
1183
    for start in xrange(0, len(text_keys), chunk_size):
1256
1210
    return result
1257
1211
 
1258
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
 
1259
1254
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1260
1255
    """Reverse revisions by depth.
1261
1256
 
1296
1291
    """
1297
1292
 
1298
1293
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1299
 
                 tags=None, diff=None, signature=None):
 
1294
                 tags=None, diff=None):
1300
1295
        self.rev = rev
1301
 
        if revno is None:
1302
 
            self.revno = None
1303
 
        else:
1304
 
            self.revno = str(revno)
 
1296
        self.revno = str(revno)
1305
1297
        self.merge_depth = merge_depth
1306
1298
        self.delta = delta
1307
1299
        self.tags = tags
1308
1300
        self.diff = diff
1309
 
        self.signature = signature
1310
1301
 
1311
1302
 
1312
1303
class LogFormatter(object):
1321
1312
    to indicate which LogRevision attributes it supports:
1322
1313
 
1323
1314
    - supports_delta must be True if this log formatter supports delta.
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.
 
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.
1327
1318
 
1328
1319
    - supports_merge_revisions must be True if this log formatter supports
1329
 
      merge revisions.  If not, then only mainline revisions will be passed
1330
 
      to the formatter.
 
1320
        merge revisions.  If not, then only mainline revisions will be passed
 
1321
        to the formatter.
1331
1322
 
1332
1323
    - preferred_levels is the number of levels this formatter defaults to.
1333
 
      The default value is zero meaning display all levels.
1334
 
      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.
1335
1326
 
1336
1327
    - supports_tags must be True if this log formatter supports tags.
1337
 
      Otherwise the tags attribute may not be populated.
 
1328
        Otherwise the tags attribute may not be populated.
1338
1329
 
1339
1330
    - supports_diff must be True if this log formatter supports diffs.
1340
 
      Otherwise the diff attribute may not be populated.
1341
 
 
1342
 
    - supports_signatures must be True if this log formatter supports GPG
1343
 
      signatures.
 
1331
        Otherwise the diff attribute may not be populated.
1344
1332
 
1345
1333
    Plugins can register functions to show custom revision properties using
1346
1334
    the properties_handler_registry. The registered function
1347
 
    must respect the following interface description::
1348
 
 
 
1335
    must respect the following interface description:
1349
1336
        def my_show_properties(properties_dict):
1350
1337
            # code that returns a dict {'name':'value'} of the properties
1351
1338
            # to be shown
1354
1341
 
1355
1342
    def __init__(self, to_file, show_ids=False, show_timezone='original',
1356
1343
                 delta_format=None, levels=None, show_advice=False,
1357
 
                 to_exact_file=None, author_list_handler=None):
 
1344
                 to_exact_file=None):
1358
1345
        """Create a LogFormatter.
1359
1346
 
1360
1347
        :param to_file: the file to output to
1361
 
        :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 
1362
1349
             non-Unicode diffs are written.
1363
1350
        :param show_ids: if True, revision-ids are to be displayed
1364
1351
        :param show_timezone: the timezone to use
1368
1355
          let the log formatter decide.
1369
1356
        :param show_advice: whether to show advice at the end of the
1370
1357
          log or not
1371
 
        :param author_list_handler: callable generating a list of
1372
 
          authors to display for a given revision
1373
1358
        """
1374
1359
        self.to_file = to_file
1375
1360
        # 'exact' stream used to show diff, it should print content 'as is'
1390
1375
        self.levels = levels
1391
1376
        self._show_advice = show_advice
1392
1377
        self._merge_count = 0
1393
 
        self._author_list_handler = author_list_handler
1394
1378
 
1395
1379
    def get_levels(self):
1396
1380
        """Get the number of levels to display or 0 for all."""
1415
1399
            if advice_sep:
1416
1400
                self.to_file.write(advice_sep)
1417
1401
            self.to_file.write(
1418
 
                "Use --include-merged or -n0 to see merged revisions.\n")
 
1402
                "Use --include-merges or -n0 to see merged revisions.\n")
1419
1403
 
1420
1404
    def get_advice_separator(self):
1421
1405
        """Get the text separating the log from the closing advice."""
1428
1412
        return address
1429
1413
 
1430
1414
    def short_author(self, rev):
1431
 
        return self.authors(rev, 'first', short=True, sep=', ')
1432
 
 
1433
 
    def authors(self, rev, who, short=False, sep=None):
1434
 
        """Generate list of authors, taking --authors option into account.
1435
 
 
1436
 
        The caller has to specify the name of a author list handler,
1437
 
        as provided by the author list registry, using the ``who``
1438
 
        argument.  That name only sets a default, though: when the
1439
 
        user selected a different author list generation using the
1440
 
        ``--authors`` command line switch, as represented by the
1441
 
        ``author_list_handler`` constructor argument, that value takes
1442
 
        precedence.
1443
 
 
1444
 
        :param rev: The revision for which to generate the list of authors.
1445
 
        :param who: Name of the default handler.
1446
 
        :param short: Whether to shorten names to either name or address.
1447
 
        :param sep: What separator to use for automatic concatenation.
1448
 
        """
1449
 
        if self._author_list_handler is not None:
1450
 
            # The user did specify --authors, which overrides the default
1451
 
            author_list_handler = self._author_list_handler
1452
 
        else:
1453
 
            # The user didn't specify --authors, so we use the caller's default
1454
 
            author_list_handler = author_list_registry.get(who)
1455
 
        names = author_list_handler(rev)
1456
 
        if short:
1457
 
            for i in range(len(names)):
1458
 
                name, address = config.parse_username(names[i])
1459
 
                if name:
1460
 
                    names[i] = name
1461
 
                else:
1462
 
                    names[i] = address
1463
 
        if sep is not None:
1464
 
            names = sep.join(names)
1465
 
        return names
 
1415
        name, address = config.parse_username(rev.get_apparent_authors()[0])
 
1416
        if name:
 
1417
            return name
 
1418
        return address
1466
1419
 
1467
1420
    def merge_marker(self, revision):
1468
1421
        """Get the merge marker to include in the output or '' if none."""
1538
1491
    supports_delta = True
1539
1492
    supports_tags = True
1540
1493
    supports_diff = True
1541
 
    supports_signatures = True
1542
1494
 
1543
1495
    def __init__(self, *args, **kwargs):
1544
1496
        super(LongLogFormatter, self).__init__(*args, **kwargs)
1564
1516
                self.merge_marker(revision)))
1565
1517
        if revision.tags:
1566
1518
            lines.append('tags: %s' % (', '.join(revision.tags)))
1567
 
        if self.show_ids or revision.revno is None:
 
1519
        if self.show_ids:
1568
1520
            lines.append('revision-id: %s' % (revision.rev.revision_id,))
1569
 
        if self.show_ids:
1570
1521
            for parent_id in revision.rev.parent_ids:
1571
1522
                lines.append('parent: %s' % (parent_id,))
1572
1523
        lines.extend(self.custom_properties(revision.rev))
1573
1524
 
1574
1525
        committer = revision.rev.committer
1575
 
        authors = self.authors(revision.rev, 'all')
 
1526
        authors = revision.rev.get_apparent_authors()
1576
1527
        if authors != [committer]:
1577
1528
            lines.append('author: %s' % (", ".join(authors),))
1578
1529
        lines.append('committer: %s' % (committer,))
1583
1534
 
1584
1535
        lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1585
1536
 
1586
 
        if revision.signature is not None:
1587
 
            lines.append('signature: ' + revision.signature)
1588
 
 
1589
1537
        lines.append('message:')
1590
1538
        if not revision.rev.message:
1591
1539
            lines.append('  (no message)')
1600
1548
        if revision.delta is not None:
1601
1549
            # Use the standard status output to display changes
1602
1550
            from bzrlib.delta import report_delta
1603
 
            report_delta(to_file, revision.delta, short_status=False,
 
1551
            report_delta(to_file, revision.delta, short_status=False, 
1604
1552
                         show_ids=self.show_ids, indent=indent)
1605
1553
        if revision.diff is not None:
1606
1554
            to_file.write(indent + 'diff:\n')
1638
1586
        indent = '    ' * depth
1639
1587
        revno_width = self.revno_width_by_depth.get(depth)
1640
1588
        if revno_width is None:
1641
 
            if revision.revno is None or revision.revno.find('.') == -1:
 
1589
            if revision.revno.find('.') == -1:
1642
1590
                # mainline revno, e.g. 12345
1643
1591
                revno_width = 5
1644
1592
            else:
1652
1600
        if revision.tags:
1653
1601
            tags = ' {%s}' % (', '.join(revision.tags))
1654
1602
        to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1655
 
                revision.revno or "", self.short_author(revision.rev),
 
1603
                revision.revno, self.short_author(revision.rev),
1656
1604
                format_date(revision.rev.timestamp,
1657
1605
                            revision.rev.timezone or 0,
1658
1606
                            self.show_timezone, date_fmt="%Y-%m-%d",
1659
1607
                            show_offset=False),
1660
1608
                tags, self.merge_marker(revision)))
1661
1609
        self.show_properties(revision.rev, indent+offset)
1662
 
        if self.show_ids or revision.revno is None:
 
1610
        if self.show_ids:
1663
1611
            to_file.write(indent + offset + 'revision-id:%s\n'
1664
1612
                          % (revision.rev.revision_id,))
1665
1613
        if not revision.rev.message:
1672
1620
        if revision.delta is not None:
1673
1621
            # Use the standard status output to display changes
1674
1622
            from bzrlib.delta import report_delta
1675
 
            report_delta(to_file, revision.delta,
1676
 
                         short_status=self.delta_format==1,
 
1623
            report_delta(to_file, revision.delta, 
 
1624
                         short_status=self.delta_format==1, 
1677
1625
                         show_ids=self.show_ids, indent=indent + offset)
1678
1626
        if revision.diff is not None:
1679
1627
            self.show_diff(self.to_exact_file, revision.diff, '      ')
1718
1666
 
1719
1667
    def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1720
1668
        """Format log info into one string. Truncate tail of 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
 
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
1729
1676
        """
1730
1677
        out = []
1731
1678
        if revno:
1732
1679
            # show revno only when is not None
1733
1680
            out.append("%s:" % revno)
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))
 
1681
        out.append(self.truncate(self.short_author(rev), 20))
1738
1682
        out.append(self.date_string(rev))
1739
1683
        if len(rev.parent_ids) > 1:
1740
1684
            out.append('[merge]')
1759
1703
                               self.show_timezone,
1760
1704
                               date_fmt='%Y-%m-%d',
1761
1705
                               show_offset=False)
1762
 
        committer_str = self.authors(revision.rev, 'first', sep=', ')
1763
 
        committer_str = committer_str.replace(' <', '  <')
 
1706
        committer_str = revision.rev.get_apparent_authors()[0].replace (' <', '  <')
1764
1707
        to_file.write('%s  %s\n\n' % (date_str,committer_str))
1765
1708
 
1766
1709
        if revision.delta is not None and revision.delta.has_changed():
1799
1742
        return self.get(name)(*args, **kwargs)
1800
1743
 
1801
1744
    def get_default(self, branch):
1802
 
        c = branch.get_config_stack()
1803
 
        return self.get(c.get('log_format'))
 
1745
        return self.get(branch.get_config().log_format())
1804
1746
 
1805
1747
 
1806
1748
log_formatter_registry = LogFormatterRegistry()
1829
1771
    try:
1830
1772
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
1831
1773
    except KeyError:
1832
 
        raise errors.BzrCommandError(gettext("unknown log formatter: %r") % name)
1833
 
 
1834
 
 
1835
 
def author_list_all(rev):
1836
 
    return rev.get_apparent_authors()[:]
1837
 
 
1838
 
 
1839
 
def author_list_first(rev):
1840
 
    lst = rev.get_apparent_authors()
1841
 
    try:
1842
 
        return [lst[0]]
1843
 
    except IndexError:
1844
 
        return []
1845
 
 
1846
 
 
1847
 
def author_list_committer(rev):
1848
 
    return [rev.committer]
1849
 
 
1850
 
 
1851
 
author_list_registry = registry.Registry()
1852
 
 
1853
 
author_list_registry.register('all', author_list_all,
1854
 
                              'All authors')
1855
 
 
1856
 
author_list_registry.register('first', author_list_first,
1857
 
                              'The first author')
1858
 
 
1859
 
author_list_registry.register('committer', author_list_committer,
1860
 
                              '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)
1861
1781
 
1862
1782
 
1863
1783
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1928
1848
    old_revisions = set()
1929
1849
    new_history = []
1930
1850
    new_revisions = set()
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)
 
1851
    new_iter = repository.iter_reverse_revision_history(new_revision_id)
 
1852
    old_iter = repository.iter_reverse_revision_history(old_revision_id)
1934
1853
    stop_revision = None
1935
1854
    do_old = True
1936
1855
    do_new = True
2011
1930
        lf.log_revision(lr)
2012
1931
 
2013
1932
 
2014
 
def _get_info_for_log_files(revisionspec_list, file_list, add_cleanup):
 
1933
def _get_info_for_log_files(revisionspec_list, file_list):
2015
1934
    """Find file-ids and kinds given a list of files and a revision range.
2016
1935
 
2017
1936
    We search for files at the end of the range. If not found there,
2021
1940
    :param file_list: the list of paths given on the command line;
2022
1941
      the first of these can be a branch location or a file path,
2023
1942
      the remainder must be file paths
2024
 
    :param add_cleanup: When the branch returned is read locked,
2025
 
      an unlock call will be queued to the cleanup.
2026
1943
    :return: (branch, info_list, start_rev_info, end_rev_info) where
2027
1944
      info_list is a list of (relative_path, file_id, kind) tuples where
2028
1945
      kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
2029
1946
      branch will be read-locked.
2030
1947
    """
2031
 
    from builtins import _get_revision_range
2032
 
    tree, b, path = controldir.ControlDir.open_containing_tree_or_branch(
2033
 
        file_list[0])
2034
 
    add_cleanup(b.lock_read().unlock)
 
1948
    from builtins import _get_revision_range, safe_relpath_files
 
1949
    tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
 
1950
    b.lock_read()
2035
1951
    # XXX: It's damn messy converting a list of paths to relative paths when
2036
1952
    # those paths might be deleted ones, they might be on a case-insensitive
2037
1953
    # filesystem and/or they might be in silly locations (like another branch).
2041
1957
    # case of running log in a nested directory, assuming paths beyond the
2042
1958
    # first one haven't been deleted ...
2043
1959
    if tree:
2044
 
        relpaths = [path] + tree.safe_relpath_files(file_list[1:])
 
1960
        relpaths = [path] + safe_relpath_files(tree, file_list[1:])
2045
1961
    else:
2046
1962
        relpaths = [path] + file_list[1:]
2047
1963
    info_list = []
2125
2041
                          len(row) > 1 and row[1] == 'fixed']
2126
2042
 
2127
2043
        if fixed_bug_urls:
2128
 
            return {ngettext('fixes bug', 'fixes bugs', len(fixed_bug_urls)):\
2129
 
                    ' '.join(fixed_bug_urls)}
 
2044
            return {'fixes bug(s)': ' '.join(fixed_bug_urls)}
2130
2045
    return {}
2131
2046
 
2132
2047
properties_handler_registry.register('bugs_properties_handler',