~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: John Arbash Meinel
  • Date: 2011-04-20 15:06:17 UTC
  • mto: This revision was merged to the branch mainline in revision 5836.
  • Revision ID: john@arbash-meinel.com-20110420150617-i41caxgemg32tq1r
Start adding tests that _worth_saving_limit works as expected.

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
 
 
18
 
17
19
"""Code to show logs of changes.
18
20
 
19
21
Various flavors of log can be produced:
47
49
all the changes since the previous revision that touched hello.c.
48
50
"""
49
51
 
50
 
from __future__ import absolute_import
51
 
 
52
52
import codecs
53
53
from cStringIO import StringIO
54
54
from itertools import (
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,
75
75
    revisionspec,
76
76
    tsort,
77
77
    )
78
 
from bzrlib.i18n import gettext, ngettext
79
78
""")
80
79
 
81
80
from bzrlib import (
82
 
    lazy_regex,
83
81
    registry,
84
82
    )
85
83
from bzrlib.osutils import (
89
87
    get_terminal_encoding,
90
88
    terminal_width,
91
89
    )
 
90
from bzrlib.symbol_versioning import (
 
91
    deprecated_function,
 
92
    deprecated_in,
 
93
    )
92
94
 
93
95
 
94
96
def find_touching_revisions(branch, file_id):
105
107
    last_ie = None
106
108
    last_path = None
107
109
    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):
 
110
    for revision_id in branch.revision_history():
112
111
        this_inv = branch.repository.get_inventory(revision_id)
113
 
        if this_inv.has_id(file_id):
 
112
        if file_id in this_inv:
114
113
            this_ie = this_inv[file_id]
115
114
            this_path = this_inv.id2path(file_id)
116
115
        else:
138
137
        revno += 1
139
138
 
140
139
 
 
140
def _enumerate_history(branch):
 
141
    rh = []
 
142
    revno = 1
 
143
    for rev_id in branch.revision_history():
 
144
        rh.append((revno, rev_id))
 
145
        revno += 1
 
146
    return rh
 
147
 
 
148
 
141
149
def show_log(branch,
142
150
             lf,
143
151
             specific_fileid=None,
147
155
             end_revision=None,
148
156
             search=None,
149
157
             limit=None,
150
 
             show_diff=False,
151
 
             match=None):
 
158
             show_diff=False):
152
159
    """Write out human-readable log of commits to this branch.
153
160
 
154
161
    This function is being retained for backwards compatibility but
177
184
        if None or 0.
178
185
 
179
186
    :param show_diff: If True, output a diff after each revision.
180
 
 
181
 
    :param match: Dictionary of search lists to use when matching revision
182
 
      properties.
183
187
    """
184
188
    # Convert old-style parameters to new-style parameters
185
189
    if specific_fileid is not None:
209
213
    Logger(branch, rqst).show(lf)
210
214
 
211
215
 
212
 
# Note: This needs to be kept in sync with the defaults in
 
216
# Note: This needs to be kept this in sync with the defaults in
213
217
# make_log_request_dict() below
214
218
_DEFAULT_REQUEST_PARAMS = {
215
219
    'direction': 'reverse',
216
 
    'levels': None,
 
220
    'levels': 1,
217
221
    'generate_tags': True,
218
222
    'exclude_common_ancestry': False,
219
223
    '_match_using_deltas': True,
222
226
 
223
227
def make_log_request_dict(direction='reverse', specific_fileids=None,
224
228
                          start_revision=None, end_revision=None, limit=None,
225
 
                          message_search=None, levels=None, generate_tags=True,
 
229
                          message_search=None, levels=1, generate_tags=True,
226
230
                          delta_type=None,
227
231
                          diff_type=None, _match_using_deltas=True,
228
 
                          exclude_common_ancestry=False, match=None,
229
 
                          signature=False, omit_merges=False,
 
232
                          exclude_common_ancestry=False,
230
233
                          ):
231
234
    """Convenience function for making a logging request dictionary.
232
235
 
253
256
      matching commit messages
254
257
 
255
258
    :param levels: the number of levels of revisions to
256
 
      generate; 1 for just the mainline; 0 for all levels, or None for
257
 
      a sensible default.
 
259
      generate; 1 for just the mainline; 0 for all levels.
258
260
 
259
261
    :param generate_tags: If True, include tags for matched revisions.
260
 
`
 
262
 
261
263
    :param delta_type: Either 'full', 'partial' or None.
262
264
      'full' means generate the complete delta - adds/deletes/modifies/etc;
263
265
      'partial' means filter the delta using specific_fileids;
275
277
 
276
278
    :param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
277
279
      range operator or as a graph difference.
278
 
 
279
 
    :param signature: show digital signature information
280
 
 
281
 
    :param match: Dictionary of list of search strings to use when filtering
282
 
      revisions. Keys can be 'message', 'author', 'committer', 'bugs' or
283
 
      the empty string to match any of the preceding properties.
284
 
 
285
 
    :param omit_merges: If True, commits with more than one parent are
286
 
      omitted.
287
 
 
288
280
    """
289
 
    # Take care of old style message_search parameter
290
 
    if message_search:
291
 
        if match:
292
 
            if 'message' in match:
293
 
                match['message'].append(message_search)
294
 
            else:
295
 
                match['message'] = [message_search]
296
 
        else:
297
 
            match={ 'message': [message_search] }
298
281
    return {
299
282
        'direction': direction,
300
283
        'specific_fileids': specific_fileids,
301
284
        'start_revision': start_revision,
302
285
        'end_revision': end_revision,
303
286
        'limit': limit,
 
287
        'message_search': message_search,
304
288
        'levels': levels,
305
289
        'generate_tags': generate_tags,
306
290
        'delta_type': delta_type,
307
291
        'diff_type': diff_type,
308
292
        'exclude_common_ancestry': exclude_common_ancestry,
309
 
        'signature': signature,
310
 
        'match': match,
311
 
        'omit_merges': omit_merges,
312
293
        # Add 'private' attributes for features that may be deprecated
313
294
        '_match_using_deltas': _match_using_deltas,
314
295
    }
322
303
    return result
323
304
 
324
305
 
325
 
def format_signature_validity(rev_id, repo):
326
 
    """get the signature validity
327
 
 
328
 
    :param rev_id: revision id to validate
329
 
    :param repo: repository of revision
330
 
    :return: human readable string to print to log
331
 
    """
332
 
    from bzrlib import gpg
333
 
 
334
 
    gpg_strategy = gpg.GPGStrategy(None)
335
 
    result = repo.verify_revision_signature(rev_id, gpg_strategy)
336
 
    if result[0] == gpg.SIGNATURE_VALID:
337
 
        return u"valid signature from {0}".format(result[1])
338
 
    if result[0] == gpg.SIGNATURE_KEY_MISSING:
339
 
        return "unknown key {0}".format(result[1])
340
 
    if result[0] == gpg.SIGNATURE_NOT_VALID:
341
 
        return "invalid signature!"
342
 
    if result[0] == gpg.SIGNATURE_NOT_SIGNED:
343
 
        return "no signature"
344
 
 
345
 
 
346
306
class LogGenerator(object):
347
307
    """A generator of log revisions."""
348
308
 
393
353
        # Tweak the LogRequest based on what the LogFormatter can handle.
394
354
        # (There's no point generating stuff if the formatter can't display it.)
395
355
        rqst = self.rqst
396
 
        if rqst['levels'] is None or lf.get_levels() > rqst['levels']:
397
 
            # user didn't specify levels, use whatever the LF can handle:
398
 
            rqst['levels'] = lf.get_levels()
399
 
 
 
356
        rqst['levels'] = lf.get_levels()
400
357
        if not getattr(lf, 'supports_tags', False):
401
358
            rqst['generate_tags'] = False
402
359
        if not getattr(lf, 'supports_delta', False):
403
360
            rqst['delta_type'] = None
404
361
        if not getattr(lf, 'supports_diff', False):
405
362
            rqst['diff_type'] = None
406
 
        if not getattr(lf, 'supports_signatures', False):
407
 
            rqst['signature'] = False
408
363
 
409
364
        # Find and print the interesting revisions
410
365
        generator = self._generator_factory(self.branch, rqst)
414
369
 
415
370
    def _generator_factory(self, branch, rqst):
416
371
        """Make the LogGenerator object to use.
417
 
 
 
372
        
418
373
        Subclasses may wish to override this.
419
374
        """
420
375
        return _DefaultLogGenerator(branch, rqst)
444
399
        levels = rqst.get('levels')
445
400
        limit = rqst.get('limit')
446
401
        diff_type = rqst.get('diff_type')
447
 
        show_signature = rqst.get('signature')
448
 
        omit_merges = rqst.get('omit_merges')
449
402
        log_count = 0
450
403
        revision_iterator = self._create_log_revision_iterator()
451
404
        for revs in revision_iterator:
453
406
                # 0 levels means show everything; merge_depth counts from 0
454
407
                if levels != 0 and merge_depth >= levels:
455
408
                    continue
456
 
                if omit_merges and len(rev.parent_ids) > 1:
457
 
                    continue
458
409
                if diff_type is None:
459
410
                    diff = None
460
411
                else:
461
412
                    diff = self._format_diff(rev, rev_id, diff_type)
462
 
                if show_signature:
463
 
                    signature = format_signature_validity(rev_id,
464
 
                                                self.branch.repository)
465
 
                else:
466
 
                    signature = None
467
413
                yield LogRevision(rev, revno, merge_depth, delta,
468
 
                    self.rev_tag_dict.get(rev_id), diff, signature)
 
414
                    self.rev_tag_dict.get(rev_id), diff)
469
415
                if limit:
470
416
                    log_count += 1
471
417
                    if log_count >= limit:
526
472
 
527
473
        # Apply the other filters
528
474
        return make_log_rev_iterator(self.branch, view_revisions,
529
 
            rqst.get('delta_type'), rqst.get('match'),
 
475
            rqst.get('delta_type'), rqst.get('message_search'),
530
476
            file_ids=rqst.get('specific_fileids'),
531
477
            direction=rqst.get('direction'))
532
478
 
545
491
            rqst.get('specific_fileids')[0], view_revisions,
546
492
            include_merges=rqst.get('levels') != 1)
547
493
        return make_log_rev_iterator(self.branch, view_revisions,
548
 
            rqst.get('delta_type'), rqst.get('match'))
 
494
            rqst.get('delta_type'), rqst.get('message_search'))
549
495
 
550
496
 
551
497
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
559
505
             a list of the same tuples.
560
506
    """
561
507
    if (exclude_common_ancestry and start_rev_id == end_rev_id):
562
 
        raise errors.BzrCommandError(gettext(
563
 
            '--exclude-common-ancestry requires two different revisions'))
 
508
        raise errors.BzrCommandError(
 
509
            '--exclude-common-ancestry requires two different revisions')
564
510
    if direction not in ('reverse', 'forward'):
565
 
        raise ValueError(gettext('invalid direction %r') % direction)
 
511
        raise ValueError('invalid direction %r' % direction)
566
512
    br_revno, br_rev_id = branch.last_revision_info()
567
513
    if br_revno == 0:
568
514
        return []
571
517
        and (not generate_merge_revisions
572
518
             or not _has_merges(branch, end_rev_id))):
573
519
        # If a single revision is requested, check we can handle it
574
 
        return  _generate_one_revision(branch, end_rev_id, br_rev_id,
575
 
                                       br_revno)
576
 
    if not generate_merge_revisions:
577
 
        try:
578
 
            # If we only want to see linear revisions, we can iterate ...
579
 
            iter_revs = _linear_view_revisions(
580
 
                branch, start_rev_id, end_rev_id,
581
 
                exclude_common_ancestry=exclude_common_ancestry)
582
 
            # If a start limit was given and it's not obviously an
583
 
            # ancestor of the end limit, check it before outputting anything
584
 
            if (direction == 'forward'
585
 
                or (start_rev_id and not _is_obvious_ancestor(
586
 
                        branch, start_rev_id, end_rev_id))):
587
 
                    iter_revs = list(iter_revs)
588
 
            if direction == 'forward':
589
 
                iter_revs = reversed(iter_revs)
590
 
            return iter_revs
591
 
        except _StartNotLinearAncestor:
592
 
            # Switch to the slower implementation that may be able to find a
593
 
            # non-obvious ancestor out of the left-hand history.
594
 
            pass
595
 
    iter_revs = _generate_all_revisions(branch, start_rev_id, end_rev_id,
596
 
                                        direction, delayed_graph_generation,
597
 
                                        exclude_common_ancestry)
598
 
    if direction == 'forward':
599
 
        iter_revs = _rebase_merge_depth(reverse_by_depth(list(iter_revs)))
 
520
        iter_revs = _generate_one_revision(branch, end_rev_id, br_rev_id,
 
521
                                           br_revno)
 
522
    elif not generate_merge_revisions:
 
523
        # If we only want to see linear revisions, we can iterate ...
 
524
        iter_revs = _generate_flat_revisions(branch, start_rev_id, end_rev_id,
 
525
                                             direction, exclude_common_ancestry)
 
526
        if direction == 'forward':
 
527
            iter_revs = reversed(iter_revs)
 
528
    else:
 
529
        iter_revs = _generate_all_revisions(branch, start_rev_id, end_rev_id,
 
530
                                            direction, delayed_graph_generation,
 
531
                                            exclude_common_ancestry)
 
532
        if direction == 'forward':
 
533
            iter_revs = _rebase_merge_depth(reverse_by_depth(list(iter_revs)))
600
534
    return iter_revs
601
535
 
602
536
 
609
543
        return [(rev_id, revno_str, 0)]
610
544
 
611
545
 
 
546
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction,
 
547
                             exclude_common_ancestry=False):
 
548
    result = _linear_view_revisions(
 
549
        branch, start_rev_id, end_rev_id,
 
550
        exclude_common_ancestry=exclude_common_ancestry)
 
551
    # If a start limit was given and it's not obviously an
 
552
    # ancestor of the end limit, check it before outputting anything
 
553
    if direction == 'forward' or (start_rev_id
 
554
        and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
 
555
        try:
 
556
            result = list(result)
 
557
        except _StartNotLinearAncestor:
 
558
            raise errors.BzrCommandError('Start revision not found in'
 
559
                ' left-hand history of end revision.')
 
560
    return result
 
561
 
 
562
 
612
563
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
613
564
                            delayed_graph_generation,
614
565
                            exclude_common_ancestry=False):
650
601
        except _StartNotLinearAncestor:
651
602
            # A merge was never detected so the lower revision limit can't
652
603
            # be nested down somewhere
653
 
            raise errors.BzrCommandError(gettext('Start revision not found in'
654
 
                ' history of end revision.'))
 
604
            raise errors.BzrCommandError('Start revision not found in'
 
605
                ' history of end revision.')
655
606
 
656
607
    # We exit the loop above because we encounter a revision with merges, from
657
608
    # this revision, we need to switch to _graph_view_revisions.
727
678
    """
728
679
    br_revno, br_rev_id = branch.last_revision_info()
729
680
    repo = branch.repository
730
 
    graph = repo.get_graph()
731
681
    if start_rev_id is None and end_rev_id is None:
732
682
        cur_revno = br_revno
733
 
        for revision_id in graph.iter_lefthand_ancestry(br_rev_id,
734
 
            (_mod_revision.NULL_REVISION,)):
 
683
        for revision_id in repo.iter_reverse_revision_history(br_rev_id):
735
684
            yield revision_id, str(cur_revno), 0
736
685
            cur_revno -= 1
737
686
    else:
738
687
        if end_rev_id is None:
739
688
            end_rev_id = br_rev_id
740
689
        found_start = start_rev_id is None
741
 
        for revision_id in graph.iter_lefthand_ancestry(end_rev_id,
742
 
                (_mod_revision.NULL_REVISION,)):
 
690
        for revision_id in repo.iter_reverse_revision_history(end_rev_id):
743
691
            revno_str = _compute_revno_str(branch, revision_id)
744
692
            if not found_start and revision_id == start_rev_id:
745
693
                if not exclude_common_ancestry:
797
745
            yield rev_id, '.'.join(map(str, revno)), merge_depth
798
746
 
799
747
 
 
748
@deprecated_function(deprecated_in((2, 2, 0)))
 
749
def calculate_view_revisions(branch, start_revision, end_revision, direction,
 
750
        specific_fileid, generate_merge_revisions):
 
751
    """Calculate the revisions to view.
 
752
 
 
753
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
 
754
             a list of the same tuples.
 
755
    """
 
756
    start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
 
757
        end_revision)
 
758
    view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
 
759
        direction, generate_merge_revisions or specific_fileid))
 
760
    if specific_fileid:
 
761
        view_revisions = _filter_revisions_touching_file_id(branch,
 
762
            specific_fileid, view_revisions,
 
763
            include_merges=generate_merge_revisions)
 
764
    return _rebase_merge_depth(view_revisions)
 
765
 
 
766
 
800
767
def _rebase_merge_depth(view_revisions):
801
768
    """Adjust depths upwards so the top level is 0."""
802
769
    # If either the first or last revision have a merge_depth of 0, we're done
846
813
    return log_rev_iterator
847
814
 
848
815
 
849
 
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
 
816
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
850
817
    """Create a filtered iterator of log_rev_iterator matching on a regex.
851
818
 
852
819
    :param branch: The branch being logged.
853
820
    :param generate_delta: Whether to generate a delta for each revision.
854
 
    :param match: A dictionary with properties as keys and lists of strings
855
 
        as values. To match, a revision may match any of the supplied strings
856
 
        within a single property but must match at least one string for each
857
 
        property.
 
821
    :param search: A user text search string.
858
822
    :param log_rev_iterator: An input iterator containing all revisions that
859
823
        could be displayed, in lists.
860
824
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
861
825
        delta).
862
826
    """
863
 
    if match is None:
 
827
    if search is None:
864
828
        return log_rev_iterator
865
 
    searchRE = [(k, [re.compile(x, re.IGNORECASE) for x in v])
866
 
                for (k,v) in match.iteritems()]
867
 
    return _filter_re(searchRE, log_rev_iterator)
868
 
 
869
 
 
870
 
def _filter_re(searchRE, log_rev_iterator):
 
829
    searchRE = re.compile(search, re.IGNORECASE)
 
830
    return _filter_message_re(searchRE, log_rev_iterator)
 
831
 
 
832
 
 
833
def _filter_message_re(searchRE, log_rev_iterator):
871
834
    for revs in log_rev_iterator:
872
 
        new_revs = [rev for rev in revs if _match_filter(searchRE, rev[1])]
873
 
        if new_revs:
874
 
            yield new_revs
875
 
 
876
 
def _match_filter(searchRE, rev):
877
 
    strings = {
878
 
               'message': (rev.message,),
879
 
               'committer': (rev.committer,),
880
 
               'author': (rev.get_apparent_authors()),
881
 
               'bugs': list(rev.iter_bugs())
882
 
               }
883
 
    strings[''] = [item for inner_list in strings.itervalues()
884
 
                   for item in inner_list]
885
 
    for (k,v) in searchRE:
886
 
        if k in strings and not _match_any_filter(strings[k], v):
887
 
            return False
888
 
    return True
889
 
 
890
 
def _match_any_filter(strings, res):
891
 
    return any([filter(None, map(re.search, strings)) for re in res])
 
835
        new_revs = []
 
836
        for (rev_id, revno, merge_depth), rev, delta in revs:
 
837
            if searchRE.search(rev.message):
 
838
                new_revs.append(((rev_id, revno, merge_depth), rev, delta))
 
839
        yield new_revs
 
840
 
892
841
 
893
842
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
894
843
    fileids=None, direction='reverse'):
967
916
 
968
917
def _update_fileids(delta, fileids, stop_on):
969
918
    """Update the set of file-ids to search based on file lifecycle events.
970
 
 
 
919
    
971
920
    :param fileids: a set of fileids to update
972
921
    :param stop_on: either 'add' or 'remove' - take file-ids out of the
973
922
      fileids set once their add or remove entry is detected respectively
1014
963
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
1015
964
        delta).
1016
965
    """
 
966
    repository = branch.repository
1017
967
    num = 9
1018
968
    for batch in log_rev_iterator:
1019
969
        batch = iter(batch)
1068
1018
    if branch_revno != 0:
1069
1019
        if (start_rev_id == _mod_revision.NULL_REVISION
1070
1020
            or end_rev_id == _mod_revision.NULL_REVISION):
1071
 
            raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
 
1021
            raise errors.BzrCommandError('Logging revision 0 is invalid.')
1072
1022
        if start_revno > end_revno:
1073
 
            raise errors.BzrCommandError(gettext("Start revision must be "
1074
 
                                         "older than the end revision."))
 
1023
            raise errors.BzrCommandError("Start revision must be older than "
 
1024
                                         "the end revision.")
1075
1025
    return (start_rev_id, end_rev_id)
1076
1026
 
1077
1027
 
1126
1076
 
1127
1077
    if ((start_rev_id == _mod_revision.NULL_REVISION)
1128
1078
        or (end_rev_id == _mod_revision.NULL_REVISION)):
1129
 
        raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
 
1079
        raise errors.BzrCommandError('Logging revision 0 is invalid.')
1130
1080
    if start_revno > end_revno:
1131
 
        raise errors.BzrCommandError(gettext("Start revision must be older "
1132
 
                                     "than the end revision."))
 
1081
        raise errors.BzrCommandError("Start revision must be older than "
 
1082
                                     "the end revision.")
1133
1083
 
1134
1084
    if end_revno < start_revno:
1135
1085
        return None, None, None, None
1136
1086
    cur_revno = branch_revno
1137
1087
    rev_nos = {}
1138
1088
    mainline_revs = []
1139
 
    graph = branch.repository.get_graph()
1140
 
    for revision_id in graph.iter_lefthand_ancestry(
1141
 
            branch_last_revision, (_mod_revision.NULL_REVISION,)):
 
1089
    for revision_id in branch.repository.iter_reverse_revision_history(
 
1090
                        branch_last_revision):
1142
1091
        if cur_revno < start_revno:
1143
1092
            # We have gone far enough, but we always add 1 more revision
1144
1093
            rev_nos[revision_id] = cur_revno
1158
1107
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
1159
1108
 
1160
1109
 
 
1110
@deprecated_function(deprecated_in((2, 2, 0)))
 
1111
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
 
1112
    """Filter view_revisions based on revision ranges.
 
1113
 
 
1114
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
 
1115
            tuples to be filtered.
 
1116
 
 
1117
    :param start_rev_id: If not NONE specifies the first revision to be logged.
 
1118
            If NONE then all revisions up to the end_rev_id are logged.
 
1119
 
 
1120
    :param end_rev_id: If not NONE specifies the last revision to be logged.
 
1121
            If NONE then all revisions up to the end of the log are logged.
 
1122
 
 
1123
    :return: The filtered view_revisions.
 
1124
    """
 
1125
    if start_rev_id or end_rev_id:
 
1126
        revision_ids = [r for r, n, d in view_revisions]
 
1127
        if start_rev_id:
 
1128
            start_index = revision_ids.index(start_rev_id)
 
1129
        else:
 
1130
            start_index = 0
 
1131
        if start_rev_id == end_rev_id:
 
1132
            end_index = start_index
 
1133
        else:
 
1134
            if end_rev_id:
 
1135
                end_index = revision_ids.index(end_rev_id)
 
1136
            else:
 
1137
                end_index = len(view_revisions) - 1
 
1138
        # To include the revisions merged into the last revision,
 
1139
        # extend end_rev_id down to, but not including, the next rev
 
1140
        # with the same or lesser merge_depth
 
1141
        end_merge_depth = view_revisions[end_index][2]
 
1142
        try:
 
1143
            for index in xrange(end_index+1, len(view_revisions)+1):
 
1144
                if view_revisions[index][2] <= end_merge_depth:
 
1145
                    end_index = index - 1
 
1146
                    break
 
1147
        except IndexError:
 
1148
            # if the search falls off the end then log to the end as well
 
1149
            end_index = len(view_revisions) - 1
 
1150
        view_revisions = view_revisions[start_index:end_index+1]
 
1151
    return view_revisions
 
1152
 
 
1153
 
1161
1154
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1162
1155
    include_merges=True):
1163
1156
    r"""Return the list of revision ids which touch a given file id.
1166
1159
    This includes the revisions which directly change the file id,
1167
1160
    and the revisions which merge these changes. So if the
1168
1161
    revision graph is::
1169
 
 
1170
1162
        A-.
1171
1163
        |\ \
1172
1164
        B C E
1199
1191
    """
1200
1192
    # Lookup all possible text keys to determine which ones actually modified
1201
1193
    # the file.
1202
 
    graph = branch.repository.get_file_graph()
1203
 
    get_parent_map = graph.get_parent_map
1204
1194
    text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
1205
1195
    next_keys = None
1206
1196
    # Looking up keys in batches of 1000 can cut the time in half, as well as
1210
1200
    #       indexing layer. We might consider passing in hints as to the known
1211
1201
    #       access pattern (sparse/clustered, high success rate/low success
1212
1202
    #       rate). This particular access is clustered with a low success rate.
 
1203
    get_parent_map = branch.repository.texts.get_parent_map
1213
1204
    modified_text_revisions = set()
1214
1205
    chunk_size = 1000
1215
1206
    for start in xrange(0, len(text_keys), chunk_size):
1242
1233
    return result
1243
1234
 
1244
1235
 
 
1236
@deprecated_function(deprecated_in((2, 2, 0)))
 
1237
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
 
1238
                       include_merges=True):
 
1239
    """Produce an iterator of revisions to show
 
1240
    :return: an iterator of (revision_id, revno, merge_depth)
 
1241
    (if there is no revno for a revision, None is supplied)
 
1242
    """
 
1243
    if not include_merges:
 
1244
        revision_ids = mainline_revs[1:]
 
1245
        if direction == 'reverse':
 
1246
            revision_ids.reverse()
 
1247
        for revision_id in revision_ids:
 
1248
            yield revision_id, str(rev_nos[revision_id]), 0
 
1249
        return
 
1250
    graph = branch.repository.get_graph()
 
1251
    # This asks for all mainline revisions, which means we only have to spider
 
1252
    # sideways, rather than depth history. That said, its still size-of-history
 
1253
    # and should be addressed.
 
1254
    # mainline_revisions always includes an extra revision at the beginning, so
 
1255
    # don't request it.
 
1256
    parent_map = dict(((key, value) for key, value in
 
1257
        graph.iter_ancestry(mainline_revs[1:]) if value is not None))
 
1258
    # filter out ghosts; merge_sort errors on ghosts.
 
1259
    rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
 
1260
    merge_sorted_revisions = tsort.merge_sort(
 
1261
        rev_graph,
 
1262
        mainline_revs[-1],
 
1263
        mainline_revs,
 
1264
        generate_revno=True)
 
1265
 
 
1266
    if direction == 'forward':
 
1267
        # forward means oldest first.
 
1268
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
 
1269
    elif direction != 'reverse':
 
1270
        raise ValueError('invalid direction %r' % direction)
 
1271
 
 
1272
    for (sequence, rev_id, merge_depth, revno, end_of_merge
 
1273
         ) in merge_sorted_revisions:
 
1274
        yield rev_id, '.'.join(map(str, revno)), merge_depth
 
1275
 
 
1276
 
1245
1277
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1246
1278
    """Reverse revisions by depth.
1247
1279
 
1282
1314
    """
1283
1315
 
1284
1316
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1285
 
                 tags=None, diff=None, signature=None):
 
1317
                 tags=None, diff=None):
1286
1318
        self.rev = rev
1287
1319
        if revno is None:
1288
1320
            self.revno = None
1292
1324
        self.delta = delta
1293
1325
        self.tags = tags
1294
1326
        self.diff = diff
1295
 
        self.signature = signature
1296
1327
 
1297
1328
 
1298
1329
class LogFormatter(object):
1307
1338
    to indicate which LogRevision attributes it supports:
1308
1339
 
1309
1340
    - supports_delta must be True if this log formatter supports delta.
1310
 
      Otherwise the delta attribute may not be populated.  The 'delta_format'
1311
 
      attribute describes whether the 'short_status' format (1) or the long
1312
 
      one (2) should be used.
 
1341
        Otherwise the delta attribute may not be populated.  The 'delta_format'
 
1342
        attribute describes whether the 'short_status' format (1) or the long
 
1343
        one (2) should be used.
1313
1344
 
1314
1345
    - supports_merge_revisions must be True if this log formatter supports
1315
 
      merge revisions.  If not, then only mainline revisions will be passed
1316
 
      to the formatter.
 
1346
        merge revisions.  If not, then only mainline revisions will be passed
 
1347
        to the formatter.
1317
1348
 
1318
1349
    - preferred_levels is the number of levels this formatter defaults to.
1319
 
      The default value is zero meaning display all levels.
1320
 
      This value is only relevant if supports_merge_revisions is True.
 
1350
        The default value is zero meaning display all levels.
 
1351
        This value is only relevant if supports_merge_revisions is True.
1321
1352
 
1322
1353
    - supports_tags must be True if this log formatter supports tags.
1323
 
      Otherwise the tags attribute may not be populated.
 
1354
        Otherwise the tags attribute may not be populated.
1324
1355
 
1325
1356
    - supports_diff must be True if this log formatter supports diffs.
1326
 
      Otherwise the diff attribute may not be populated.
1327
 
 
1328
 
    - supports_signatures must be True if this log formatter supports GPG
1329
 
      signatures.
 
1357
        Otherwise the diff attribute may not be populated.
1330
1358
 
1331
1359
    Plugins can register functions to show custom revision properties using
1332
1360
    the properties_handler_registry. The registered function
1333
 
    must respect the following interface description::
1334
 
 
 
1361
    must respect the following interface description:
1335
1362
        def my_show_properties(properties_dict):
1336
1363
            # code that returns a dict {'name':'value'} of the properties
1337
1364
            # to be shown
1344
1371
        """Create a LogFormatter.
1345
1372
 
1346
1373
        :param to_file: the file to output to
1347
 
        :param to_exact_file: if set, gives an output stream to which
 
1374
        :param to_exact_file: if set, gives an output stream to which 
1348
1375
             non-Unicode diffs are written.
1349
1376
        :param show_ids: if True, revision-ids are to be displayed
1350
1377
        :param show_timezone: the timezone to use
1401
1428
            if advice_sep:
1402
1429
                self.to_file.write(advice_sep)
1403
1430
            self.to_file.write(
1404
 
                "Use --include-merged or -n0 to see merged revisions.\n")
 
1431
                "Use --include-merges or -n0 to see merged revisions.\n")
1405
1432
 
1406
1433
    def get_advice_separator(self):
1407
1434
        """Get the text separating the log from the closing advice."""
1524
1551
    supports_delta = True
1525
1552
    supports_tags = True
1526
1553
    supports_diff = True
1527
 
    supports_signatures = True
1528
1554
 
1529
1555
    def __init__(self, *args, **kwargs):
1530
1556
        super(LongLogFormatter, self).__init__(*args, **kwargs)
1569
1595
 
1570
1596
        lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1571
1597
 
1572
 
        if revision.signature is not None:
1573
 
            lines.append('signature: ' + revision.signature)
1574
 
 
1575
1598
        lines.append('message:')
1576
1599
        if not revision.rev.message:
1577
1600
            lines.append('  (no message)')
1586
1609
        if revision.delta is not None:
1587
1610
            # Use the standard status output to display changes
1588
1611
            from bzrlib.delta import report_delta
1589
 
            report_delta(to_file, revision.delta, short_status=False,
 
1612
            report_delta(to_file, revision.delta, short_status=False, 
1590
1613
                         show_ids=self.show_ids, indent=indent)
1591
1614
        if revision.diff is not None:
1592
1615
            to_file.write(indent + 'diff:\n')
1658
1681
        if revision.delta is not None:
1659
1682
            # Use the standard status output to display changes
1660
1683
            from bzrlib.delta import report_delta
1661
 
            report_delta(to_file, revision.delta,
1662
 
                         short_status=self.delta_format==1,
 
1684
            report_delta(to_file, revision.delta, 
 
1685
                         short_status=self.delta_format==1, 
1663
1686
                         show_ids=self.show_ids, indent=indent + offset)
1664
1687
        if revision.diff is not None:
1665
1688
            self.show_diff(self.to_exact_file, revision.diff, '      ')
1704
1727
 
1705
1728
    def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1706
1729
        """Format log info into one string. Truncate tail of string
1707
 
 
1708
 
        :param revno:      revision number or None.
1709
 
                           Revision numbers counts from 1.
1710
 
        :param rev:        revision object
1711
 
        :param max_chars:  maximum length of resulting string
1712
 
        :param tags:       list of tags or None
1713
 
        :param prefix:     string to prefix each line
1714
 
        :return:           formatted truncated string
 
1730
        :param  revno:      revision number or None.
 
1731
                            Revision numbers counts from 1.
 
1732
        :param  rev:        revision object
 
1733
        :param  max_chars:  maximum length of resulting string
 
1734
        :param  tags:       list of tags or None
 
1735
        :param  prefix:     string to prefix each line
 
1736
        :return:            formatted truncated string
1715
1737
        """
1716
1738
        out = []
1717
1739
        if revno:
1718
1740
            # show revno only when is not None
1719
1741
            out.append("%s:" % revno)
1720
 
        if max_chars is not None:
1721
 
            out.append(self.truncate(self.short_author(rev), (max_chars+3)/4))
1722
 
        else:
1723
 
            out.append(self.short_author(rev))
 
1742
        out.append(self.truncate(self.short_author(rev), 20))
1724
1743
        out.append(self.date_string(rev))
1725
1744
        if len(rev.parent_ids) > 1:
1726
1745
            out.append('[merge]')
1785
1804
        return self.get(name)(*args, **kwargs)
1786
1805
 
1787
1806
    def get_default(self, branch):
1788
 
        c = branch.get_config_stack()
1789
 
        return self.get(c.get('log_format'))
 
1807
        return self.get(branch.get_config().log_format())
1790
1808
 
1791
1809
 
1792
1810
log_formatter_registry = LogFormatterRegistry()
1793
1811
 
1794
1812
 
1795
1813
log_formatter_registry.register('short', ShortLogFormatter,
1796
 
                                'Moderately short log format.')
 
1814
                                'Moderately short log format')
1797
1815
log_formatter_registry.register('long', LongLogFormatter,
1798
 
                                'Detailed log format.')
 
1816
                                'Detailed log format')
1799
1817
log_formatter_registry.register('line', LineLogFormatter,
1800
 
                                'Log format with one line per revision.')
 
1818
                                'Log format with one line per revision')
1801
1819
log_formatter_registry.register('gnu-changelog', GnuChangelogLogFormatter,
1802
 
                                'Format used by GNU ChangeLog files.')
 
1820
                                'Format used by GNU ChangeLog files')
1803
1821
 
1804
1822
 
1805
1823
def register_formatter(name, formatter):
1815
1833
    try:
1816
1834
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
1817
1835
    except KeyError:
1818
 
        raise errors.BzrCommandError(gettext("unknown log formatter: %r") % name)
 
1836
        raise errors.BzrCommandError("unknown log formatter: %r" % name)
1819
1837
 
1820
1838
 
1821
1839
def author_list_all(rev):
1846
1864
                              'The committer')
1847
1865
 
1848
1866
 
 
1867
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
 
1868
    # deprecated; for compatibility
 
1869
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
 
1870
    lf.show(revno, rev, delta)
 
1871
 
 
1872
 
1849
1873
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1850
1874
                           log_format='long'):
1851
1875
    """Show the change in revision history comparing the old revision history to the new one.
1914
1938
    old_revisions = set()
1915
1939
    new_history = []
1916
1940
    new_revisions = set()
1917
 
    graph = repository.get_graph()
1918
 
    new_iter = graph.iter_lefthand_ancestry(new_revision_id)
1919
 
    old_iter = graph.iter_lefthand_ancestry(old_revision_id)
 
1941
    new_iter = repository.iter_reverse_revision_history(new_revision_id)
 
1942
    old_iter = repository.iter_reverse_revision_history(old_revision_id)
1920
1943
    stop_revision = None
1921
1944
    do_old = True
1922
1945
    do_new = True
2014
2037
      kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
2015
2038
      branch will be read-locked.
2016
2039
    """
2017
 
    from bzrlib.builtins import _get_revision_range
2018
 
    tree, b, path = controldir.ControlDir.open_containing_tree_or_branch(
2019
 
        file_list[0])
 
2040
    from builtins import _get_revision_range
 
2041
    tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
2020
2042
    add_cleanup(b.lock_read().unlock)
2021
2043
    # XXX: It's damn messy converting a list of paths to relative paths when
2022
2044
    # those paths might be deleted ones, they might be on a case-insensitive
2111
2133
                          len(row) > 1 and row[1] == 'fixed']
2112
2134
 
2113
2135
        if fixed_bug_urls:
2114
 
            return {ngettext('fixes bug', 'fixes bugs', len(fixed_bug_urls)):\
2115
 
                    ' '.join(fixed_bug_urls)}
 
2136
            return {'fixes bug(s)': ' '.join(fixed_bug_urls)}
2116
2137
    return {}
2117
2138
 
2118
2139
properties_handler_registry.register('bugs_properties_handler',