~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Andrew Bennetts
  • Date: 2010-10-08 08:15:14 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101008081514-dviqzrdfwyzsqbz2
Split NEWS into per-release doc/en/release-notes/bzr-*.txt

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
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,
 
73
    osutils,
73
74
    repository as _mod_repository,
74
75
    revision as _mod_revision,
75
76
    revisionspec,
 
77
    trace,
76
78
    tsort,
77
79
    )
78
 
from bzrlib.i18n import gettext, ngettext
79
80
""")
80
81
 
81
82
from bzrlib import (
82
 
    lazy_regex,
83
83
    registry,
84
84
    )
85
85
from bzrlib.osutils import (
86
86
    format_date,
87
87
    format_date_with_offset_in_original_timezone,
88
 
    get_diff_header_encoding,
89
88
    get_terminal_encoding,
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:
138
138
        revno += 1
139
139
 
140
140
 
 
141
def _enumerate_history(branch):
 
142
    rh = []
 
143
    revno = 1
 
144
    for rev_id in branch.revision_history():
 
145
        rh.append((revno, rev_id))
 
146
        revno += 1
 
147
    return rh
 
148
 
 
149
 
141
150
def show_log(branch,
142
151
             lf,
143
152
             specific_fileid=None,
147
156
             end_revision=None,
148
157
             search=None,
149
158
             limit=None,
150
 
             show_diff=False,
151
 
             match=None):
 
159
             show_diff=False):
152
160
    """Write out human-readable log of commits to this branch.
153
161
 
154
162
    This function is being retained for backwards compatibility but
177
185
        if None or 0.
178
186
 
179
187
    :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
188
    """
184
189
    # Convert old-style parameters to new-style parameters
185
190
    if specific_fileid is not None:
209
214
    Logger(branch, rqst).show(lf)
210
215
 
211
216
 
212
 
# 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
213
218
# make_log_request_dict() below
214
219
_DEFAULT_REQUEST_PARAMS = {
215
220
    'direction': 'reverse',
216
 
    'levels': None,
 
221
    'levels': 1,
217
222
    'generate_tags': True,
218
223
    'exclude_common_ancestry': False,
219
224
    '_match_using_deltas': True,
222
227
 
223
228
def make_log_request_dict(direction='reverse', specific_fileids=None,
224
229
                          start_revision=None, end_revision=None, limit=None,
225
 
                          message_search=None, levels=None, generate_tags=True,
 
230
                          message_search=None, levels=1, generate_tags=True,
226
231
                          delta_type=None,
227
232
                          diff_type=None, _match_using_deltas=True,
228
 
                          exclude_common_ancestry=False, match=None,
229
 
                          signature=False, omit_merges=False,
 
233
                          exclude_common_ancestry=False,
230
234
                          ):
231
235
    """Convenience function for making a logging request dictionary.
232
236
 
253
257
      matching commit messages
254
258
 
255
259
    :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.
 
260
      generate; 1 for just the mainline; 0 for all levels.
258
261
 
259
262
    :param generate_tags: If True, include tags for matched revisions.
260
 
`
 
263
 
261
264
    :param delta_type: Either 'full', 'partial' or None.
262
265
      'full' means generate the complete delta - adds/deletes/modifies/etc;
263
266
      'partial' means filter the delta using specific_fileids;
275
278
 
276
279
    :param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
277
280
      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
281
    """
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
282
    return {
299
283
        'direction': direction,
300
284
        'specific_fileids': specific_fileids,
301
285
        'start_revision': start_revision,
302
286
        'end_revision': end_revision,
303
287
        'limit': limit,
 
288
        'message_search': message_search,
304
289
        'levels': levels,
305
290
        'generate_tags': generate_tags,
306
291
        'delta_type': delta_type,
307
292
        'diff_type': diff_type,
308
293
        'exclude_common_ancestry': exclude_common_ancestry,
309
 
        'signature': signature,
310
 
        'match': match,
311
 
        'omit_merges': omit_merges,
312
294
        # Add 'private' attributes for features that may be deprecated
313
295
        '_match_using_deltas': _match_using_deltas,
314
296
    }
316
298
 
317
299
def _apply_log_request_defaults(rqst):
318
300
    """Apply default values to a request dictionary."""
319
 
    result = _DEFAULT_REQUEST_PARAMS.copy()
 
301
    result = _DEFAULT_REQUEST_PARAMS
320
302
    if rqst:
321
303
        result.update(rqst)
322
304
    return result
323
305
 
324
306
 
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
307
class LogGenerator(object):
347
308
    """A generator of log revisions."""
348
309
 
393
354
        # Tweak the LogRequest based on what the LogFormatter can handle.
394
355
        # (There's no point generating stuff if the formatter can't display it.)
395
356
        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
 
 
 
357
        rqst['levels'] = lf.get_levels()
400
358
        if not getattr(lf, 'supports_tags', False):
401
359
            rqst['generate_tags'] = False
402
360
        if not getattr(lf, 'supports_delta', False):
403
361
            rqst['delta_type'] = None
404
362
        if not getattr(lf, 'supports_diff', False):
405
363
            rqst['diff_type'] = None
406
 
        if not getattr(lf, 'supports_signatures', False):
407
 
            rqst['signature'] = False
408
364
 
409
365
        # Find and print the interesting revisions
410
366
        generator = self._generator_factory(self.branch, rqst)
414
370
 
415
371
    def _generator_factory(self, branch, rqst):
416
372
        """Make the LogGenerator object to use.
417
 
 
 
373
        
418
374
        Subclasses may wish to override this.
419
375
        """
420
376
        return _DefaultLogGenerator(branch, rqst)
444
400
        levels = rqst.get('levels')
445
401
        limit = rqst.get('limit')
446
402
        diff_type = rqst.get('diff_type')
447
 
        show_signature = rqst.get('signature')
448
 
        omit_merges = rqst.get('omit_merges')
449
403
        log_count = 0
450
404
        revision_iterator = self._create_log_revision_iterator()
451
405
        for revs in revision_iterator:
453
407
                # 0 levels means show everything; merge_depth counts from 0
454
408
                if levels != 0 and merge_depth >= levels:
455
409
                    continue
456
 
                if omit_merges and len(rev.parent_ids) > 1:
457
 
                    continue
458
410
                if diff_type is None:
459
411
                    diff = None
460
412
                else:
461
413
                    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
414
                yield LogRevision(rev, revno, merge_depth, delta,
468
 
                    self.rev_tag_dict.get(rev_id), diff, signature)
 
415
                    self.rev_tag_dict.get(rev_id), diff)
469
416
                if limit:
470
417
                    log_count += 1
471
418
                    if log_count >= limit:
485
432
        else:
486
433
            specific_files = None
487
434
        s = StringIO()
488
 
        path_encoding = get_diff_header_encoding()
 
435
        path_encoding = osutils.get_diff_header_encoding()
489
436
        diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
490
437
            new_label='', path_encoding=path_encoding)
491
438
        return s.getvalue()
526
473
 
527
474
        # Apply the other filters
528
475
        return make_log_rev_iterator(self.branch, view_revisions,
529
 
            rqst.get('delta_type'), rqst.get('match'),
 
476
            rqst.get('delta_type'), rqst.get('message_search'),
530
477
            file_ids=rqst.get('specific_fileids'),
531
478
            direction=rqst.get('direction'))
532
479
 
545
492
            rqst.get('specific_fileids')[0], view_revisions,
546
493
            include_merges=rqst.get('levels') != 1)
547
494
        return make_log_rev_iterator(self.branch, view_revisions,
548
 
            rqst.get('delta_type'), rqst.get('match'))
 
495
            rqst.get('delta_type'), rqst.get('message_search'))
549
496
 
550
497
 
551
498
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
559
506
             a list of the same tuples.
560
507
    """
561
508
    if (exclude_common_ancestry and start_rev_id == end_rev_id):
562
 
        raise errors.BzrCommandError(gettext(
563
 
            '--exclude-common-ancestry requires two different revisions'))
 
509
        raise errors.BzrCommandError(
 
510
            '--exclude-common-ancestry requires two different revisions')
564
511
    if direction not in ('reverse', 'forward'):
565
 
        raise ValueError(gettext('invalid direction %r') % direction)
 
512
        raise ValueError('invalid direction %r' % direction)
566
513
    br_revno, br_rev_id = branch.last_revision_info()
567
514
    if br_revno == 0:
568
515
        return []
571
518
        and (not generate_merge_revisions
572
519
             or not _has_merges(branch, end_rev_id))):
573
520
        # 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)))
 
521
        iter_revs = _generate_one_revision(branch, end_rev_id, br_rev_id,
 
522
                                           br_revno)
 
523
    elif not generate_merge_revisions:
 
524
        # If we only want to see linear revisions, we can iterate ...
 
525
        iter_revs = _generate_flat_revisions(branch, start_rev_id, end_rev_id,
 
526
                                             direction, exclude_common_ancestry)
 
527
        if direction == 'forward':
 
528
            iter_revs = reversed(iter_revs)
 
529
    else:
 
530
        iter_revs = _generate_all_revisions(branch, start_rev_id, end_rev_id,
 
531
                                            direction, delayed_graph_generation,
 
532
                                            exclude_common_ancestry)
 
533
        if direction == 'forward':
 
534
            iter_revs = _rebase_merge_depth(reverse_by_depth(list(iter_revs)))
600
535
    return iter_revs
601
536
 
602
537
 
605
540
        # It's the tip
606
541
        return [(br_rev_id, br_revno, 0)]
607
542
    else:
608
 
        revno_str = _compute_revno_str(branch, rev_id)
 
543
        revno = branch.revision_id_to_dotted_revno(rev_id)
 
544
        revno_str = '.'.join(str(n) for n in revno)
609
545
        return [(rev_id, revno_str, 0)]
610
546
 
611
547
 
 
548
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction,
 
549
                             exclude_common_ancestry=False):
 
550
    result = _linear_view_revisions(
 
551
        branch, start_rev_id, end_rev_id,
 
552
        exclude_common_ancestry=exclude_common_ancestry)
 
553
    # If a start limit was given and it's not obviously an
 
554
    # ancestor of the end limit, check it before outputting anything
 
555
    if direction == 'forward' or (start_rev_id
 
556
        and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
 
557
        try:
 
558
            result = list(result)
 
559
        except _StartNotLinearAncestor:
 
560
            raise errors.BzrCommandError('Start revision not found in'
 
561
                ' left-hand history of end revision.')
 
562
    return result
 
563
 
 
564
 
612
565
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
613
566
                            delayed_graph_generation,
614
567
                            exclude_common_ancestry=False):
650
603
        except _StartNotLinearAncestor:
651
604
            # A merge was never detected so the lower revision limit can't
652
605
            # be nested down somewhere
653
 
            raise errors.BzrCommandError(gettext('Start revision not found in'
654
 
                ' history of end revision.'))
 
606
            raise errors.BzrCommandError('Start revision not found in'
 
607
                ' history of end revision.')
655
608
 
656
609
    # We exit the loop above because we encounter a revision with merges, from
657
610
    # this revision, we need to switch to _graph_view_revisions.
674
627
    return len(parents) > 1
675
628
 
676
629
 
677
 
def _compute_revno_str(branch, rev_id):
678
 
    """Compute the revno string from a rev_id.
679
 
 
680
 
    :return: The revno string, or None if the revision is not in the supplied
681
 
        branch.
682
 
    """
683
 
    try:
684
 
        revno = branch.revision_id_to_dotted_revno(rev_id)
685
 
    except errors.NoSuchRevision:
686
 
        # The revision must be outside of this branch
687
 
        return None
688
 
    else:
689
 
        return '.'.join(str(n) for n in revno)
690
 
 
691
 
 
692
630
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
693
631
    """Is start_rev_id an obvious ancestor of end_rev_id?"""
694
632
    if start_rev_id and end_rev_id:
695
 
        try:
696
 
            start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
697
 
            end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
698
 
        except errors.NoSuchRevision:
699
 
            # one or both is not in the branch; not obvious
700
 
            return False
 
633
        start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
 
634
        end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
701
635
        if len(start_dotted) == 1 and len(end_dotted) == 1:
702
636
            # both on mainline
703
637
            return start_dotted[0] <= end_dotted[0]
727
661
    """
728
662
    br_revno, br_rev_id = branch.last_revision_info()
729
663
    repo = branch.repository
730
 
    graph = repo.get_graph()
731
664
    if start_rev_id is None and end_rev_id is None:
732
665
        cur_revno = br_revno
733
 
        for revision_id in graph.iter_lefthand_ancestry(br_rev_id,
734
 
            (_mod_revision.NULL_REVISION,)):
 
666
        for revision_id in repo.iter_reverse_revision_history(br_rev_id):
735
667
            yield revision_id, str(cur_revno), 0
736
668
            cur_revno -= 1
737
669
    else:
738
670
        if end_rev_id is None:
739
671
            end_rev_id = br_rev_id
740
672
        found_start = start_rev_id is None
741
 
        for revision_id in graph.iter_lefthand_ancestry(end_rev_id,
742
 
                (_mod_revision.NULL_REVISION,)):
743
 
            revno_str = _compute_revno_str(branch, revision_id)
 
673
        for revision_id in repo.iter_reverse_revision_history(end_rev_id):
 
674
            revno = branch.revision_id_to_dotted_revno(revision_id)
 
675
            revno_str = '.'.join(str(n) for n in revno)
744
676
            if not found_start and revision_id == start_rev_id:
745
677
                if not exclude_common_ancestry:
746
678
                    yield revision_id, revno_str, 0
797
729
            yield rev_id, '.'.join(map(str, revno)), merge_depth
798
730
 
799
731
 
 
732
@deprecated_function(deprecated_in((2, 2, 0)))
 
733
def calculate_view_revisions(branch, start_revision, end_revision, direction,
 
734
        specific_fileid, generate_merge_revisions):
 
735
    """Calculate the revisions to view.
 
736
 
 
737
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
 
738
             a list of the same tuples.
 
739
    """
 
740
    start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
 
741
        end_revision)
 
742
    view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
 
743
        direction, generate_merge_revisions or specific_fileid))
 
744
    if specific_fileid:
 
745
        view_revisions = _filter_revisions_touching_file_id(branch,
 
746
            specific_fileid, view_revisions,
 
747
            include_merges=generate_merge_revisions)
 
748
    return _rebase_merge_depth(view_revisions)
 
749
 
 
750
 
800
751
def _rebase_merge_depth(view_revisions):
801
752
    """Adjust depths upwards so the top level is 0."""
802
753
    # If either the first or last revision have a merge_depth of 0, we're done
846
797
    return log_rev_iterator
847
798
 
848
799
 
849
 
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
 
800
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
850
801
    """Create a filtered iterator of log_rev_iterator matching on a regex.
851
802
 
852
803
    :param branch: The branch being logged.
853
804
    :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.
 
805
    :param search: A user text search string.
858
806
    :param log_rev_iterator: An input iterator containing all revisions that
859
807
        could be displayed, in lists.
860
808
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
861
809
        delta).
862
810
    """
863
 
    if match is None:
 
811
    if search is None:
864
812
        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):
 
813
    searchRE = re.compile(search, re.IGNORECASE)
 
814
    return _filter_message_re(searchRE, log_rev_iterator)
 
815
 
 
816
 
 
817
def _filter_message_re(searchRE, log_rev_iterator):
871
818
    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])
 
819
        new_revs = []
 
820
        for (rev_id, revno, merge_depth), rev, delta in revs:
 
821
            if searchRE.search(rev.message):
 
822
                new_revs.append(((rev_id, revno, merge_depth), rev, delta))
 
823
        yield new_revs
 
824
 
892
825
 
893
826
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
894
827
    fileids=None, direction='reverse'):
967
900
 
968
901
def _update_fileids(delta, fileids, stop_on):
969
902
    """Update the set of file-ids to search based on file lifecycle events.
970
 
 
 
903
    
971
904
    :param fileids: a set of fileids to update
972
905
    :param stop_on: either 'add' or 'remove' - take file-ids out of the
973
906
      fileids set once their add or remove entry is detected respectively
1014
947
    :return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
1015
948
        delta).
1016
949
    """
 
950
    repository = branch.repository
1017
951
    num = 9
1018
952
    for batch in log_rev_iterator:
1019
953
        batch = iter(batch)
1068
1002
    if branch_revno != 0:
1069
1003
        if (start_rev_id == _mod_revision.NULL_REVISION
1070
1004
            or end_rev_id == _mod_revision.NULL_REVISION):
1071
 
            raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
 
1005
            raise errors.BzrCommandError('Logging revision 0 is invalid.')
1072
1006
        if start_revno > end_revno:
1073
 
            raise errors.BzrCommandError(gettext("Start revision must be "
1074
 
                                         "older than the end revision."))
 
1007
            raise errors.BzrCommandError("Start revision must be older than "
 
1008
                                         "the end revision.")
1075
1009
    return (start_rev_id, end_rev_id)
1076
1010
 
1077
1011
 
1126
1060
 
1127
1061
    if ((start_rev_id == _mod_revision.NULL_REVISION)
1128
1062
        or (end_rev_id == _mod_revision.NULL_REVISION)):
1129
 
        raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
 
1063
        raise errors.BzrCommandError('Logging revision 0 is invalid.')
1130
1064
    if start_revno > end_revno:
1131
 
        raise errors.BzrCommandError(gettext("Start revision must be older "
1132
 
                                     "than the end revision."))
 
1065
        raise errors.BzrCommandError("Start revision must be older than "
 
1066
                                     "the end revision.")
1133
1067
 
1134
1068
    if end_revno < start_revno:
1135
1069
        return None, None, None, None
1136
1070
    cur_revno = branch_revno
1137
1071
    rev_nos = {}
1138
1072
    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,)):
 
1073
    for revision_id in branch.repository.iter_reverse_revision_history(
 
1074
                        branch_last_revision):
1142
1075
        if cur_revno < start_revno:
1143
1076
            # We have gone far enough, but we always add 1 more revision
1144
1077
            rev_nos[revision_id] = cur_revno
1158
1091
    return mainline_revs, rev_nos, start_rev_id, end_rev_id
1159
1092
 
1160
1093
 
 
1094
@deprecated_function(deprecated_in((2, 2, 0)))
 
1095
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
 
1096
    """Filter view_revisions based on revision ranges.
 
1097
 
 
1098
    :param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
 
1099
            tuples to be filtered.
 
1100
 
 
1101
    :param start_rev_id: If not NONE specifies the first revision to be logged.
 
1102
            If NONE then all revisions up to the end_rev_id are logged.
 
1103
 
 
1104
    :param end_rev_id: If not NONE specifies the last revision to be logged.
 
1105
            If NONE then all revisions up to the end of the log are logged.
 
1106
 
 
1107
    :return: The filtered view_revisions.
 
1108
    """
 
1109
    if start_rev_id or end_rev_id:
 
1110
        revision_ids = [r for r, n, d in view_revisions]
 
1111
        if start_rev_id:
 
1112
            start_index = revision_ids.index(start_rev_id)
 
1113
        else:
 
1114
            start_index = 0
 
1115
        if start_rev_id == end_rev_id:
 
1116
            end_index = start_index
 
1117
        else:
 
1118
            if end_rev_id:
 
1119
                end_index = revision_ids.index(end_rev_id)
 
1120
            else:
 
1121
                end_index = len(view_revisions) - 1
 
1122
        # To include the revisions merged into the last revision,
 
1123
        # extend end_rev_id down to, but not including, the next rev
 
1124
        # with the same or lesser merge_depth
 
1125
        end_merge_depth = view_revisions[end_index][2]
 
1126
        try:
 
1127
            for index in xrange(end_index+1, len(view_revisions)+1):
 
1128
                if view_revisions[index][2] <= end_merge_depth:
 
1129
                    end_index = index - 1
 
1130
                    break
 
1131
        except IndexError:
 
1132
            # if the search falls off the end then log to the end as well
 
1133
            end_index = len(view_revisions) - 1
 
1134
        view_revisions = view_revisions[start_index:end_index+1]
 
1135
    return view_revisions
 
1136
 
 
1137
 
1161
1138
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1162
1139
    include_merges=True):
1163
1140
    r"""Return the list of revision ids which touch a given file id.
1166
1143
    This includes the revisions which directly change the file id,
1167
1144
    and the revisions which merge these changes. So if the
1168
1145
    revision graph is::
1169
 
 
1170
1146
        A-.
1171
1147
        |\ \
1172
1148
        B C E
1199
1175
    """
1200
1176
    # Lookup all possible text keys to determine which ones actually modified
1201
1177
    # the file.
1202
 
    graph = branch.repository.get_file_graph()
1203
 
    get_parent_map = graph.get_parent_map
1204
1178
    text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
1205
1179
    next_keys = None
1206
1180
    # Looking up keys in batches of 1000 can cut the time in half, as well as
1210
1184
    #       indexing layer. We might consider passing in hints as to the known
1211
1185
    #       access pattern (sparse/clustered, high success rate/low success
1212
1186
    #       rate). This particular access is clustered with a low success rate.
 
1187
    get_parent_map = branch.repository.texts.get_parent_map
1213
1188
    modified_text_revisions = set()
1214
1189
    chunk_size = 1000
1215
1190
    for start in xrange(0, len(text_keys), chunk_size):
1242
1217
    return result
1243
1218
 
1244
1219
 
 
1220
@deprecated_function(deprecated_in((2, 2, 0)))
 
1221
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
 
1222
                       include_merges=True):
 
1223
    """Produce an iterator of revisions to show
 
1224
    :return: an iterator of (revision_id, revno, merge_depth)
 
1225
    (if there is no revno for a revision, None is supplied)
 
1226
    """
 
1227
    if not include_merges:
 
1228
        revision_ids = mainline_revs[1:]
 
1229
        if direction == 'reverse':
 
1230
            revision_ids.reverse()
 
1231
        for revision_id in revision_ids:
 
1232
            yield revision_id, str(rev_nos[revision_id]), 0
 
1233
        return
 
1234
    graph = branch.repository.get_graph()
 
1235
    # This asks for all mainline revisions, which means we only have to spider
 
1236
    # sideways, rather than depth history. That said, its still size-of-history
 
1237
    # and should be addressed.
 
1238
    # mainline_revisions always includes an extra revision at the beginning, so
 
1239
    # don't request it.
 
1240
    parent_map = dict(((key, value) for key, value in
 
1241
        graph.iter_ancestry(mainline_revs[1:]) if value is not None))
 
1242
    # filter out ghosts; merge_sort errors on ghosts.
 
1243
    rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
 
1244
    merge_sorted_revisions = tsort.merge_sort(
 
1245
        rev_graph,
 
1246
        mainline_revs[-1],
 
1247
        mainline_revs,
 
1248
        generate_revno=True)
 
1249
 
 
1250
    if direction == 'forward':
 
1251
        # forward means oldest first.
 
1252
        merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
 
1253
    elif direction != 'reverse':
 
1254
        raise ValueError('invalid direction %r' % direction)
 
1255
 
 
1256
    for (sequence, rev_id, merge_depth, revno, end_of_merge
 
1257
         ) in merge_sorted_revisions:
 
1258
        yield rev_id, '.'.join(map(str, revno)), merge_depth
 
1259
 
 
1260
 
1245
1261
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1246
1262
    """Reverse revisions by depth.
1247
1263
 
1282
1298
    """
1283
1299
 
1284
1300
    def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1285
 
                 tags=None, diff=None, signature=None):
 
1301
                 tags=None, diff=None):
1286
1302
        self.rev = rev
1287
 
        if revno is None:
1288
 
            self.revno = None
1289
 
        else:
1290
 
            self.revno = str(revno)
 
1303
        self.revno = str(revno)
1291
1304
        self.merge_depth = merge_depth
1292
1305
        self.delta = delta
1293
1306
        self.tags = tags
1294
1307
        self.diff = diff
1295
 
        self.signature = signature
1296
1308
 
1297
1309
 
1298
1310
class LogFormatter(object):
1307
1319
    to indicate which LogRevision attributes it supports:
1308
1320
 
1309
1321
    - 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.
 
1322
        Otherwise the delta attribute may not be populated.  The 'delta_format'
 
1323
        attribute describes whether the 'short_status' format (1) or the long
 
1324
        one (2) should be used.
1313
1325
 
1314
1326
    - 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.
 
1327
        merge revisions.  If not, then only mainline revisions will be passed
 
1328
        to the formatter.
1317
1329
 
1318
1330
    - 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.
 
1331
        The default value is zero meaning display all levels.
 
1332
        This value is only relevant if supports_merge_revisions is True.
1321
1333
 
1322
1334
    - supports_tags must be True if this log formatter supports tags.
1323
 
      Otherwise the tags attribute may not be populated.
 
1335
        Otherwise the tags attribute may not be populated.
1324
1336
 
1325
1337
    - 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.
 
1338
        Otherwise the diff attribute may not be populated.
1330
1339
 
1331
1340
    Plugins can register functions to show custom revision properties using
1332
1341
    the properties_handler_registry. The registered function
1333
 
    must respect the following interface description::
1334
 
 
 
1342
    must respect the following interface description:
1335
1343
        def my_show_properties(properties_dict):
1336
1344
            # code that returns a dict {'name':'value'} of the properties
1337
1345
            # to be shown
1344
1352
        """Create a LogFormatter.
1345
1353
 
1346
1354
        :param to_file: the file to output to
1347
 
        :param to_exact_file: if set, gives an output stream to which
 
1355
        :param to_exact_file: if set, gives an output stream to which 
1348
1356
             non-Unicode diffs are written.
1349
1357
        :param show_ids: if True, revision-ids are to be displayed
1350
1358
        :param show_timezone: the timezone to use
1401
1409
            if advice_sep:
1402
1410
                self.to_file.write(advice_sep)
1403
1411
            self.to_file.write(
1404
 
                "Use --include-merged or -n0 to see merged revisions.\n")
 
1412
                "Use --include-merges or -n0 to see merged revisions.\n")
1405
1413
 
1406
1414
    def get_advice_separator(self):
1407
1415
        """Get the text separating the log from the closing advice."""
1524
1532
    supports_delta = True
1525
1533
    supports_tags = True
1526
1534
    supports_diff = True
1527
 
    supports_signatures = True
1528
1535
 
1529
1536
    def __init__(self, *args, **kwargs):
1530
1537
        super(LongLogFormatter, self).__init__(*args, **kwargs)
1550
1557
                self.merge_marker(revision)))
1551
1558
        if revision.tags:
1552
1559
            lines.append('tags: %s' % (', '.join(revision.tags)))
1553
 
        if self.show_ids or revision.revno is None:
 
1560
        if self.show_ids:
1554
1561
            lines.append('revision-id: %s' % (revision.rev.revision_id,))
1555
 
        if self.show_ids:
1556
1562
            for parent_id in revision.rev.parent_ids:
1557
1563
                lines.append('parent: %s' % (parent_id,))
1558
1564
        lines.extend(self.custom_properties(revision.rev))
1569
1575
 
1570
1576
        lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1571
1577
 
1572
 
        if revision.signature is not None:
1573
 
            lines.append('signature: ' + revision.signature)
1574
 
 
1575
1578
        lines.append('message:')
1576
1579
        if not revision.rev.message:
1577
1580
            lines.append('  (no message)')
1586
1589
        if revision.delta is not None:
1587
1590
            # Use the standard status output to display changes
1588
1591
            from bzrlib.delta import report_delta
1589
 
            report_delta(to_file, revision.delta, short_status=False,
 
1592
            report_delta(to_file, revision.delta, short_status=False, 
1590
1593
                         show_ids=self.show_ids, indent=indent)
1591
1594
        if revision.diff is not None:
1592
1595
            to_file.write(indent + 'diff:\n')
1624
1627
        indent = '    ' * depth
1625
1628
        revno_width = self.revno_width_by_depth.get(depth)
1626
1629
        if revno_width is None:
1627
 
            if revision.revno is None or revision.revno.find('.') == -1:
 
1630
            if revision.revno.find('.') == -1:
1628
1631
                # mainline revno, e.g. 12345
1629
1632
                revno_width = 5
1630
1633
            else:
1638
1641
        if revision.tags:
1639
1642
            tags = ' {%s}' % (', '.join(revision.tags))
1640
1643
        to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1641
 
                revision.revno or "", self.short_author(revision.rev),
 
1644
                revision.revno, self.short_author(revision.rev),
1642
1645
                format_date(revision.rev.timestamp,
1643
1646
                            revision.rev.timezone or 0,
1644
1647
                            self.show_timezone, date_fmt="%Y-%m-%d",
1645
1648
                            show_offset=False),
1646
1649
                tags, self.merge_marker(revision)))
1647
1650
        self.show_properties(revision.rev, indent+offset)
1648
 
        if self.show_ids or revision.revno is None:
 
1651
        if self.show_ids:
1649
1652
            to_file.write(indent + offset + 'revision-id:%s\n'
1650
1653
                          % (revision.rev.revision_id,))
1651
1654
        if not revision.rev.message:
1658
1661
        if revision.delta is not None:
1659
1662
            # Use the standard status output to display changes
1660
1663
            from bzrlib.delta import report_delta
1661
 
            report_delta(to_file, revision.delta,
1662
 
                         short_status=self.delta_format==1,
 
1664
            report_delta(to_file, revision.delta, 
 
1665
                         short_status=self.delta_format==1, 
1663
1666
                         show_ids=self.show_ids, indent=indent + offset)
1664
1667
        if revision.diff is not None:
1665
1668
            self.show_diff(self.to_exact_file, revision.diff, '      ')
1704
1707
 
1705
1708
    def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1706
1709
        """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
 
1710
        :param  revno:      revision number or None.
 
1711
                            Revision numbers counts from 1.
 
1712
        :param  rev:        revision object
 
1713
        :param  max_chars:  maximum length of resulting string
 
1714
        :param  tags:       list of tags or None
 
1715
        :param  prefix:     string to prefix each line
 
1716
        :return:            formatted truncated string
1715
1717
        """
1716
1718
        out = []
1717
1719
        if revno:
1718
1720
            # show revno only when is not None
1719
1721
            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))
 
1722
        out.append(self.truncate(self.short_author(rev), 20))
1724
1723
        out.append(self.date_string(rev))
1725
1724
        if len(rev.parent_ids) > 1:
1726
1725
            out.append('[merge]')
1785
1784
        return self.get(name)(*args, **kwargs)
1786
1785
 
1787
1786
    def get_default(self, branch):
1788
 
        c = branch.get_config_stack()
1789
 
        return self.get(c.get('log_format'))
 
1787
        return self.get(branch.get_config().log_format())
1790
1788
 
1791
1789
 
1792
1790
log_formatter_registry = LogFormatterRegistry()
1793
1791
 
1794
1792
 
1795
1793
log_formatter_registry.register('short', ShortLogFormatter,
1796
 
                                'Moderately short log format.')
 
1794
                                'Moderately short log format')
1797
1795
log_formatter_registry.register('long', LongLogFormatter,
1798
 
                                'Detailed log format.')
 
1796
                                'Detailed log format')
1799
1797
log_formatter_registry.register('line', LineLogFormatter,
1800
 
                                'Log format with one line per revision.')
 
1798
                                'Log format with one line per revision')
1801
1799
log_formatter_registry.register('gnu-changelog', GnuChangelogLogFormatter,
1802
 
                                'Format used by GNU ChangeLog files.')
 
1800
                                'Format used by GNU ChangeLog files')
1803
1801
 
1804
1802
 
1805
1803
def register_formatter(name, formatter):
1815
1813
    try:
1816
1814
        return log_formatter_registry.make_formatter(name, *args, **kwargs)
1817
1815
    except KeyError:
1818
 
        raise errors.BzrCommandError(gettext("unknown log formatter: %r") % name)
 
1816
        raise errors.BzrCommandError("unknown log formatter: %r" % name)
1819
1817
 
1820
1818
 
1821
1819
def author_list_all(rev):
1846
1844
                              'The committer')
1847
1845
 
1848
1846
 
 
1847
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
 
1848
    # deprecated; for compatibility
 
1849
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
 
1850
    lf.show(revno, rev, delta)
 
1851
 
 
1852
 
1849
1853
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1850
1854
                           log_format='long'):
1851
1855
    """Show the change in revision history comparing the old revision history to the new one.
1914
1918
    old_revisions = set()
1915
1919
    new_history = []
1916
1920
    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)
 
1921
    new_iter = repository.iter_reverse_revision_history(new_revision_id)
 
1922
    old_iter = repository.iter_reverse_revision_history(old_revision_id)
1920
1923
    stop_revision = None
1921
1924
    do_old = True
1922
1925
    do_new = True
2014
2017
      kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
2015
2018
      branch will be read-locked.
2016
2019
    """
2017
 
    from bzrlib.builtins import _get_revision_range
2018
 
    tree, b, path = controldir.ControlDir.open_containing_tree_or_branch(
2019
 
        file_list[0])
 
2020
    from builtins import _get_revision_range
 
2021
    tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
2020
2022
    add_cleanup(b.lock_read().unlock)
2021
2023
    # XXX: It's damn messy converting a list of paths to relative paths when
2022
2024
    # those paths might be deleted ones, they might be on a case-insensitive
2111
2113
                          len(row) > 1 and row[1] == 'fixed']
2112
2114
 
2113
2115
        if fixed_bug_urls:
2114
 
            return {ngettext('fixes bug', 'fixes bugs', len(fixed_bug_urls)):\
2115
 
                    ' '.join(fixed_bug_urls)}
 
2116
            return {'fixes bug(s)': ' '.join(fixed_bug_urls)}
2116
2117
    return {}
2117
2118
 
2118
2119
properties_handler_registry.register('bugs_properties_handler',