← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Jelmer Vernooij
  • Date: 2010-03-21 21:39:33 UTC
  • mfrom: (5102 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5143.
  • Revision ID: jelmer@samba.org-20100321213933-fexeh9zcoz8oaju2
merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/log.py
70
70
    diff,
71
71
    errors,
72
72
    foreign,
73
 
    osutils,
74
73
    repository as _mod_repository,
75
74
    revision as _mod_revision,
76
75
    revisionspec,
86
85
    format_date,
87
86
    format_date_with_offset_in_original_timezone,
88
87
    get_terminal_encoding,
 
88
    re_compile_checked,
89
89
    terminal_width,
90
90
    )
91
91
from bzrlib.symbol_versioning import (
220
220
    'direction': 'reverse',
221
221
    'levels': 1,
222
222
    'generate_tags': True,
223
 
    'exclude_common_ancestry': False,
224
223
    '_match_using_deltas': True,
225
224
    }
226
225
 
227
226
 
228
227
def make_log_request_dict(direction='reverse', specific_fileids=None,
229
 
                          start_revision=None, end_revision=None, limit=None,
230
 
                          message_search=None, levels=1, generate_tags=True,
231
 
                          delta_type=None,
232
 
                          diff_type=None, _match_using_deltas=True,
233
 
                          exclude_common_ancestry=False,
234
 
                          ):
 
228
    start_revision=None, end_revision=None, limit=None,
 
229
    message_search=None, levels=1, generate_tags=True, delta_type=None,
 
230
    diff_type=None, _match_using_deltas=True):
235
231
    """Convenience function for making a logging request dictionary.
236
232
 
237
233
    Using this function may make code slightly safer by ensuring
275
271
      algorithm used for matching specific_fileids. This parameter
276
272
      may be removed in the future so bzrlib client code should NOT
277
273
      use it.
278
 
 
279
 
    :param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
280
 
      range operator or as a graph difference.
281
274
    """
282
275
    return {
283
276
        'direction': direction,
290
283
        'generate_tags': generate_tags,
291
284
        'delta_type': delta_type,
292
285
        'diff_type': diff_type,
293
 
        'exclude_common_ancestry': exclude_common_ancestry,
294
286
        # Add 'private' attributes for features that may be deprecated
295
287
        '_match_using_deltas': _match_using_deltas,
296
288
    }
432
424
        else:
433
425
            specific_files = None
434
426
        s = StringIO()
435
 
        path_encoding = osutils.get_diff_header_encoding()
436
427
        diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
437
 
            new_label='', path_encoding=path_encoding)
 
428
            new_label='')
438
429
        return s.getvalue()
439
430
 
440
431
    def _create_log_revision_iterator(self):
464
455
        generate_merge_revisions = rqst.get('levels') != 1
465
456
        delayed_graph_generation = not rqst.get('specific_fileids') and (
466
457
                rqst.get('limit') or self.start_rev_id or self.end_rev_id)
467
 
        view_revisions = _calc_view_revisions(
468
 
            self.branch, self.start_rev_id, self.end_rev_id,
469
 
            rqst.get('direction'),
470
 
            generate_merge_revisions=generate_merge_revisions,
471
 
            delayed_graph_generation=delayed_graph_generation,
472
 
            exclude_common_ancestry=rqst.get('exclude_common_ancestry'))
 
458
        view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
 
459
            self.end_rev_id, rqst.get('direction'), generate_merge_revisions,
 
460
            delayed_graph_generation=delayed_graph_generation)
473
461
 
474
462
        # Apply the other filters
475
463
        return make_log_rev_iterator(self.branch, view_revisions,
482
470
        # Note that we always generate the merge revisions because
483
471
        # filter_revisions_touching_file_id() requires them ...
484
472
        rqst = self.rqst
485
 
        view_revisions = _calc_view_revisions(
486
 
            self.branch, self.start_rev_id, self.end_rev_id,
487
 
            rqst.get('direction'), generate_merge_revisions=True,
488
 
            exclude_common_ancestry=rqst.get('exclude_common_ancestry'))
 
473
        view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
 
474
            self.end_rev_id, rqst.get('direction'), True)
489
475
        if not isinstance(view_revisions, list):
490
476
            view_revisions = list(view_revisions)
491
477
        view_revisions = _filter_revisions_touching_file_id(self.branch,
496
482
 
497
483
 
498
484
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
499
 
                         generate_merge_revisions,
500
 
                         delayed_graph_generation=False,
501
 
                         exclude_common_ancestry=False,
502
 
                         ):
 
485
    generate_merge_revisions, delayed_graph_generation=False):
503
486
    """Calculate the revisions to view.
504
487
 
505
488
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
506
489
             a list of the same tuples.
507
490
    """
508
 
    if (exclude_common_ancestry and start_rev_id == end_rev_id):
509
 
        raise errors.BzrCommandError(
510
 
            '--exclude-common-ancestry requires two different revisions')
511
 
    if direction not in ('reverse', 'forward'):
512
 
        raise ValueError('invalid direction %r' % direction)
513
491
    br_revno, br_rev_id = branch.last_revision_info()
514
492
    if br_revno == 0:
515
493
        return []
516
494
 
517
 
    if (end_rev_id and start_rev_id == end_rev_id
518
 
        and (not generate_merge_revisions
519
 
             or not _has_merges(branch, end_rev_id))):
520
 
        # If a single revision is requested, check we can handle it
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)
 
495
    # If a single revision is requested, check we can handle it
 
496
    generate_single_revision = (end_rev_id and start_rev_id == end_rev_id and
 
497
        (not generate_merge_revisions or not _has_merges(branch, end_rev_id)))
 
498
    if generate_single_revision:
 
499
        return _generate_one_revision(branch, end_rev_id, br_rev_id, br_revno)
 
500
 
 
501
    # If we only want to see linear revisions, we can iterate ...
 
502
    if not generate_merge_revisions:
 
503
        return _generate_flat_revisions(branch, start_rev_id, end_rev_id,
 
504
            direction)
529
505
    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)))
535
 
    return iter_revs
 
506
        return _generate_all_revisions(branch, start_rev_id, end_rev_id,
 
507
            direction, delayed_graph_generation)
536
508
 
537
509
 
538
510
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
545
517
        return [(rev_id, revno_str, 0)]
546
518
 
547
519
 
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)
 
520
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction):
 
521
    result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
553
522
    # If a start limit was given and it's not obviously an
554
523
    # ancestor of the end limit, check it before outputting anything
555
524
    if direction == 'forward' or (start_rev_id
559
528
        except _StartNotLinearAncestor:
560
529
            raise errors.BzrCommandError('Start revision not found in'
561
530
                ' left-hand history of end revision.')
 
531
    if direction == 'forward':
 
532
        result = reversed(result)
562
533
    return result
563
534
 
564
535
 
565
536
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
566
 
                            delayed_graph_generation,
567
 
                            exclude_common_ancestry=False):
 
537
                            delayed_graph_generation):
568
538
    # On large trees, generating the merge graph can take 30-60 seconds
569
539
    # so we delay doing it until a merge is detected, incrementally
570
540
    # returning initial (non-merge) revisions while we can.
576
546
    if delayed_graph_generation:
577
547
        try:
578
548
            for rev_id, revno, depth in  _linear_view_revisions(
579
 
                branch, start_rev_id, end_rev_id, exclude_common_ancestry):
 
549
                branch, start_rev_id, end_rev_id):
580
550
                if _has_merges(branch, rev_id):
581
551
                    # The end_rev_id can be nested down somewhere. We need an
582
552
                    # explicit ancestry check. There is an ambiguity here as we
599
569
                    initial_revisions.append((rev_id, revno, depth))
600
570
            else:
601
571
                # No merged revisions found
602
 
                return initial_revisions
 
572
                if direction == 'reverse':
 
573
                    return initial_revisions
 
574
                elif direction == 'forward':
 
575
                    return reversed(initial_revisions)
 
576
                else:
 
577
                    raise ValueError('invalid direction %r' % direction)
603
578
        except _StartNotLinearAncestor:
604
579
            # A merge was never detected so the lower revision limit can't
605
580
            # be nested down somewhere
616
591
    # indented at the end seems slightly nicer in that case.
617
592
    view_revisions = chain(iter(initial_revisions),
618
593
        _graph_view_revisions(branch, start_rev_id, end_rev_id,
619
 
                              rebase_initial_depths=(direction == 'reverse'),
620
 
                              exclude_common_ancestry=exclude_common_ancestry))
621
 
    return view_revisions
 
594
                              rebase_initial_depths=(direction == 'reverse')))
 
595
    if direction == 'reverse':
 
596
        return view_revisions
 
597
    elif direction == 'forward':
 
598
        # Forward means oldest first, adjusting for depth.
 
599
        view_revisions = reverse_by_depth(list(view_revisions))
 
600
        return _rebase_merge_depth(view_revisions)
 
601
    else:
 
602
        raise ValueError('invalid direction %r' % direction)
622
603
 
623
604
 
624
605
def _has_merges(branch, rev_id):
647
628
    return True
648
629
 
649
630
 
650
 
def _linear_view_revisions(branch, start_rev_id, end_rev_id,
651
 
                           exclude_common_ancestry=False):
 
631
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
652
632
    """Calculate a sequence of revisions to view, newest to oldest.
653
633
 
654
634
    :param start_rev_id: the lower revision-id
655
635
    :param end_rev_id: the upper revision-id
656
 
    :param exclude_common_ancestry: Whether the start_rev_id should be part of
657
 
        the iterated revisions.
658
636
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
659
637
    :raises _StartNotLinearAncestor: if a start_rev_id is specified but
660
 
        is not found walking the left-hand history
 
638
      is not found walking the left-hand history
661
639
    """
662
640
    br_revno, br_rev_id = branch.last_revision_info()
663
641
    repo = branch.repository
674
652
            revno = branch.revision_id_to_dotted_revno(revision_id)
675
653
            revno_str = '.'.join(str(n) for n in revno)
676
654
            if not found_start and revision_id == start_rev_id:
677
 
                if not exclude_common_ancestry:
678
 
                    yield revision_id, revno_str, 0
 
655
                yield revision_id, revno_str, 0
679
656
                found_start = True
680
657
                break
681
658
            else:
686
663
 
687
664
 
688
665
def _graph_view_revisions(branch, start_rev_id, end_rev_id,
689
 
                          rebase_initial_depths=True,
690
 
                          exclude_common_ancestry=False):
 
666
                          rebase_initial_depths=True):
691
667
    """Calculate revisions to view including merges, newest to oldest.
692
668
 
693
669
    :param branch: the branch
697
673
      revision is found?
698
674
    :return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
699
675
    """
700
 
    if exclude_common_ancestry:
701
 
        stop_rule = 'with-merges-without-common-ancestry'
702
 
    else:
703
 
        stop_rule = 'with-merges'
704
676
    view_revisions = branch.iter_merge_sorted_revisions(
705
677
        start_revision_id=end_rev_id, stop_revision_id=start_rev_id,
706
 
        stop_rule=stop_rule)
 
678
        stop_rule="with-merges")
707
679
    if not rebase_initial_depths:
708
680
        for (rev_id, merge_depth, revno, end_of_merge
709
681
             ) in view_revisions:
810
782
    """
811
783
    if search is None:
812
784
        return log_rev_iterator
813
 
    searchRE = re.compile(search, re.IGNORECASE)
 
785
    searchRE = re_compile_checked(search, re.IGNORECASE,
 
786
            'log message filter')
814
787
    return _filter_message_re(searchRE, log_rev_iterator)
815
788
 
816
789
 
1348
1321
 
1349
1322
    def __init__(self, to_file, show_ids=False, show_timezone='original',
1350
1323
                 delta_format=None, levels=None, show_advice=False,
1351
 
                 to_exact_file=None, author_list_handler=None):
 
1324
                 to_exact_file=None):
1352
1325
        """Create a LogFormatter.
1353
1326
 
1354
1327
        :param to_file: the file to output to
1362
1335
          let the log formatter decide.
1363
1336
        :param show_advice: whether to show advice at the end of the
1364
1337
          log or not
1365
 
        :param author_list_handler: callable generating a list of
1366
 
          authors to display for a given revision
1367
1338
        """
1368
1339
        self.to_file = to_file
1369
1340
        # 'exact' stream used to show diff, it should print content 'as is'
1384
1355
        self.levels = levels
1385
1356
        self._show_advice = show_advice
1386
1357
        self._merge_count = 0
1387
 
        self._author_list_handler = author_list_handler
1388
1358
 
1389
1359
    def get_levels(self):
1390
1360
        """Get the number of levels to display or 0 for all."""
1422
1392
        return address
1423
1393
 
1424
1394
    def short_author(self, rev):
1425
 
        return self.authors(rev, 'first', short=True, sep=', ')
1426
 
 
1427
 
    def authors(self, rev, who, short=False, sep=None):
1428
 
        """Generate list of authors, taking --authors option into account.
1429
 
 
1430
 
        The caller has to specify the name of a author list handler,
1431
 
        as provided by the author list registry, using the ``who``
1432
 
        argument.  That name only sets a default, though: when the
1433
 
        user selected a different author list generation using the
1434
 
        ``--authors`` command line switch, as represented by the
1435
 
        ``author_list_handler`` constructor argument, that value takes
1436
 
        precedence.
1437
 
 
1438
 
        :param rev: The revision for which to generate the list of authors.
1439
 
        :param who: Name of the default handler.
1440
 
        :param short: Whether to shorten names to either name or address.
1441
 
        :param sep: What separator to use for automatic concatenation.
1442
 
        """
1443
 
        if self._author_list_handler is not None:
1444
 
            # The user did specify --authors, which overrides the default
1445
 
            author_list_handler = self._author_list_handler
1446
 
        else:
1447
 
            # The user didn't specify --authors, so we use the caller's default
1448
 
            author_list_handler = author_list_registry.get(who)
1449
 
        names = author_list_handler(rev)
1450
 
        if short:
1451
 
            for i in range(len(names)):
1452
 
                name, address = config.parse_username(names[i])
1453
 
                if name:
1454
 
                    names[i] = name
1455
 
                else:
1456
 
                    names[i] = address
1457
 
        if sep is not None:
1458
 
            names = sep.join(names)
1459
 
        return names
 
1395
        name, address = config.parse_username(rev.get_apparent_authors()[0])
 
1396
        if name:
 
1397
            return name
 
1398
        return address
1460
1399
 
1461
1400
    def merge_marker(self, revision):
1462
1401
        """Get the merge marker to include in the output or '' if none."""
1564
1503
        lines.extend(self.custom_properties(revision.rev))
1565
1504
 
1566
1505
        committer = revision.rev.committer
1567
 
        authors = self.authors(revision.rev, 'all')
 
1506
        authors = revision.rev.get_apparent_authors()
1568
1507
        if authors != [committer]:
1569
1508
            lines.append('author: %s' % (", ".join(authors),))
1570
1509
        lines.append('committer: %s' % (committer,))
1587
1526
        to_file = self.to_file
1588
1527
        to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
1589
1528
        if revision.delta is not None:
1590
 
            # Use the standard status output to display changes
1591
 
            from bzrlib.delta import report_delta
1592
 
            report_delta(to_file, revision.delta, short_status=False, 
1593
 
                         show_ids=self.show_ids, indent=indent)
 
1529
            # We don't respect delta_format for compatibility
 
1530
            revision.delta.show(to_file, self.show_ids, indent=indent,
 
1531
                                short_status=False)
1594
1532
        if revision.diff is not None:
1595
1533
            to_file.write(indent + 'diff:\n')
1596
1534
            to_file.flush()
1659
1597
                to_file.write(indent + offset + '%s\n' % (l,))
1660
1598
 
1661
1599
        if revision.delta is not None:
1662
 
            # Use the standard status output to display changes
1663
 
            from bzrlib.delta import report_delta
1664
 
            report_delta(to_file, revision.delta, 
1665
 
                         short_status=self.delta_format==1, 
1666
 
                         show_ids=self.show_ids, indent=indent + offset)
 
1600
            revision.delta.show(to_file, self.show_ids, indent=indent + offset,
 
1601
                                short_status=self.delta_format==1)
1667
1602
        if revision.diff is not None:
1668
1603
            self.show_diff(self.to_exact_file, revision.diff, '      ')
1669
1604
        to_file.write('\n')
1744
1679
                               self.show_timezone,
1745
1680
                               date_fmt='%Y-%m-%d',
1746
1681
                               show_offset=False)
1747
 
        committer_str = self.authors(revision.rev, 'first', sep=', ')
1748
 
        committer_str = committer_str.replace(' <', '  <')
 
1682
        committer_str = revision.rev.committer.replace (' <', '  <')
1749
1683
        to_file.write('%s  %s\n\n' % (date_str,committer_str))
1750
1684
 
1751
1685
        if revision.delta is not None and revision.delta.has_changed():
1816
1750
        raise errors.BzrCommandError("unknown log formatter: %r" % name)
1817
1751
 
1818
1752
 
1819
 
def author_list_all(rev):
1820
 
    return rev.get_apparent_authors()[:]
1821
 
 
1822
 
 
1823
 
def author_list_first(rev):
1824
 
    lst = rev.get_apparent_authors()
1825
 
    try:
1826
 
        return [lst[0]]
1827
 
    except IndexError:
1828
 
        return []
1829
 
 
1830
 
 
1831
 
def author_list_committer(rev):
1832
 
    return [rev.committer]
1833
 
 
1834
 
 
1835
 
author_list_registry = registry.Registry()
1836
 
 
1837
 
author_list_registry.register('all', author_list_all,
1838
 
                              'All authors')
1839
 
 
1840
 
author_list_registry.register('first', author_list_first,
1841
 
                              'The first author')
1842
 
 
1843
 
author_list_registry.register('committer', author_list_committer,
1844
 
                              'The committer')
1845
 
 
1846
 
 
1847
1753
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
1848
1754
    # deprecated; for compatibility
1849
1755
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
2000
1906
        lf.log_revision(lr)
2001
1907
 
2002
1908
 
2003
 
def _get_info_for_log_files(revisionspec_list, file_list, add_cleanup):
 
1909
def _get_info_for_log_files(revisionspec_list, file_list):
2004
1910
    """Find file-ids and kinds given a list of files and a revision range.
2005
1911
 
2006
1912
    We search for files at the end of the range. If not found there,
2010
1916
    :param file_list: the list of paths given on the command line;
2011
1917
      the first of these can be a branch location or a file path,
2012
1918
      the remainder must be file paths
2013
 
    :param add_cleanup: When the branch returned is read locked,
2014
 
      an unlock call will be queued to the cleanup.
2015
1919
    :return: (branch, info_list, start_rev_info, end_rev_info) where
2016
1920
      info_list is a list of (relative_path, file_id, kind) tuples where
2017
1921
      kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
2018
1922
      branch will be read-locked.
2019
1923
    """
2020
 
    from builtins import _get_revision_range
 
1924
    from builtins import _get_revision_range, safe_relpath_files
2021
1925
    tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
2022
 
    add_cleanup(b.lock_read().unlock)
 
1926
    b.lock_read()
2023
1927
    # XXX: It's damn messy converting a list of paths to relative paths when
2024
1928
    # those paths might be deleted ones, they might be on a case-insensitive
2025
1929
    # filesystem and/or they might be in silly locations (like another branch).
2029
1933
    # case of running log in a nested directory, assuming paths beyond the
2030
1934
    # first one haven't been deleted ...
2031
1935
    if tree:
2032
 
        relpaths = [path] + tree.safe_relpath_files(file_list[1:])
 
1936
        relpaths = [path] + safe_relpath_files(tree, file_list[1:])
2033
1937
    else:
2034
1938
        relpaths = [path] + file_list[1:]
2035
1939
    info_list = []