497
482
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
498
generate_merge_revisions,
499
delayed_graph_generation=False,
500
exclude_common_ancestry=False,
483
generate_merge_revisions, allow_single_merge_revision,
484
delayed_graph_generation=False):
502
485
"""Calculate the revisions to view.
504
487
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
505
488
a list of the same tuples.
507
if (exclude_common_ancestry and start_rev_id == end_rev_id):
508
raise errors.BzrCommandError(
509
'--exclude-common-ancestry requires two different revisions')
510
if direction not in ('reverse', 'forward'):
511
raise ValueError('invalid direction %r' % direction)
512
490
br_revno, br_rev_id = branch.last_revision_info()
513
491
if br_revno == 0:
516
if (end_rev_id and start_rev_id == end_rev_id
517
and (not generate_merge_revisions
518
or not _has_merges(branch, end_rev_id))):
519
# If a single revision is requested, check we can handle it
520
iter_revs = _generate_one_revision(branch, end_rev_id, br_rev_id,
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,
526
if direction == 'forward':
527
iter_revs = reversed(iter_revs)
494
# If a single revision is requested, check we can handle it
495
generate_single_revision = (end_rev_id and start_rev_id == end_rev_id and
496
(not generate_merge_revisions or not _has_merges(branch, end_rev_id)))
497
if generate_single_revision:
498
return _generate_one_revision(branch, end_rev_id, br_rev_id, br_revno,
499
allow_single_merge_revision)
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,
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)))
537
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
506
return _generate_all_revisions(branch, start_rev_id, end_rev_id,
507
direction, delayed_graph_generation)
510
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno,
511
allow_single_merge_revision):
538
512
if rev_id == br_rev_id:
540
514
return [(br_rev_id, br_revno, 0)]
542
516
revno = branch.revision_id_to_dotted_revno(rev_id)
517
if len(revno) > 1 and not allow_single_merge_revision:
518
# It's a merge revision and the log formatter is
519
# completely brain dead. This "feature" of allowing
520
# log formatters incapable of displaying dotted revnos
521
# ought to be deprecated IMNSHO. IGC 20091022
522
raise errors.BzrCommandError('Selected log formatter only'
523
' supports mainline revisions.')
543
524
revno_str = '.'.join(str(n) for n in revno)
544
525
return [(rev_id, revno_str, 0)]
555
536
except _StartNotLinearAncestor:
556
537
raise errors.BzrCommandError('Start revision not found in'
557
538
' left-hand history of end revision.')
539
if direction == 'forward':
540
result = reversed(result)
561
544
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
562
delayed_graph_generation,
563
exclude_common_ancestry=False):
545
delayed_graph_generation):
564
546
# On large trees, generating the merge graph can take 30-60 seconds
565
547
# so we delay doing it until a merge is detected, incrementally
566
548
# returning initial (non-merge) revisions while we can.
568
# The above is only true for old formats (<= 0.92), for newer formats, a
569
# couple of seconds only should be needed to load the whole graph and the
570
# other graph operations needed are even faster than that -- vila 100201
571
549
initial_revisions = []
572
550
if delayed_graph_generation:
574
for rev_id, revno, depth in _linear_view_revisions(
575
branch, start_rev_id, end_rev_id):
552
for rev_id, revno, depth in \
553
_linear_view_revisions(branch, start_rev_id, end_rev_id):
576
554
if _has_merges(branch, rev_id):
577
# The end_rev_id can be nested down somewhere. We need an
578
# explicit ancestry check. There is an ambiguity here as we
579
# may not raise _StartNotLinearAncestor for a revision that
580
# is an ancestor but not a *linear* one. But since we have
581
# loaded the graph to do the check (or calculate a dotted
582
# revno), we may as well accept to show the log... We need
583
# the check only if start_rev_id is not None as all
584
# revisions have _mod_revision.NULL_REVISION as an ancestor
586
graph = branch.repository.get_graph()
587
if (start_rev_id is not None
588
and not graph.is_ancestor(start_rev_id, end_rev_id)):
589
raise _StartNotLinearAncestor()
590
# Since we collected the revisions so far, we need to
592
555
end_rev_id = rev_id
595
558
initial_revisions.append((rev_id, revno, depth))
597
560
# No merged revisions found
598
return initial_revisions
561
if direction == 'reverse':
562
return initial_revisions
563
elif direction == 'forward':
564
return reversed(initial_revisions)
566
raise ValueError('invalid direction %r' % direction)
599
567
except _StartNotLinearAncestor:
600
568
# A merge was never detected so the lower revision limit can't
601
569
# be nested down somewhere
602
570
raise errors.BzrCommandError('Start revision not found in'
603
571
' history of end revision.')
605
# We exit the loop above because we encounter a revision with merges, from
606
# this revision, we need to switch to _graph_view_revisions.
608
573
# A log including nested merges is required. If the direction is reverse,
609
574
# we rebase the initial merge depths so that the development line is
610
575
# shown naturally, i.e. just like it is for linear logging. We can easily
712
676
depth_adjustment = merge_depth
713
677
if depth_adjustment:
714
678
if merge_depth < depth_adjustment:
715
# From now on we reduce the depth adjustement, this can be
716
# surprising for users. The alternative requires two passes
717
# which breaks the fast display of the first revision
719
679
depth_adjustment = merge_depth
720
680
merge_depth -= depth_adjustment
721
681
yield rev_id, '.'.join(map(str, revno)), merge_depth
724
@deprecated_function(deprecated_in((2, 2, 0)))
725
684
def calculate_view_revisions(branch, start_revision, end_revision, direction,
726
specific_fileid, generate_merge_revisions):
685
specific_fileid, generate_merge_revisions, allow_single_merge_revision):
727
686
"""Calculate the revisions to view.
729
688
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
730
689
a list of the same tuples.
691
# This method is no longer called by the main code path.
692
# It is retained for API compatibility and may be deprecated
732
694
start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
734
696
view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
735
direction, generate_merge_revisions or specific_fileid))
697
direction, generate_merge_revisions or specific_fileid,
698
allow_single_merge_revision))
736
699
if specific_fileid:
737
700
view_revisions = _filter_revisions_touching_file_id(branch,
738
701
specific_fileid, view_revisions,
1340
1311
preferred_levels = 0
1342
1313
def __init__(self, to_file, show_ids=False, show_timezone='original',
1343
delta_format=None, levels=None, show_advice=False,
1344
to_exact_file=None, author_list_handler=None):
1314
delta_format=None, levels=None):
1345
1315
"""Create a LogFormatter.
1347
1317
:param to_file: the file to output to
1348
:param to_exact_file: if set, gives an output stream to which
1349
non-Unicode diffs are written.
1350
1318
:param show_ids: if True, revision-ids are to be displayed
1351
1319
:param show_timezone: the timezone to use
1352
1320
:param delta_format: the level of delta information to display
1353
or None to leave it to the formatter to decide
1321
or None to leave it u to the formatter to decide
1354
1322
:param levels: the number of levels to display; None or -1 to
1355
1323
let the log formatter decide.
1356
:param show_advice: whether to show advice at the end of the
1358
:param author_list_handler: callable generating a list of
1359
authors to display for a given revision
1361
1325
self.to_file = to_file
1362
1326
# 'exact' stream used to show diff, it should print content 'as is'
1363
1327
# and should not try to decode/encode it to unicode to avoid bug #328007
1364
if to_exact_file is not None:
1365
self.to_exact_file = to_exact_file
1367
# XXX: somewhat hacky; this assumes it's a codec writer; it's better
1368
# for code that expects to get diffs to pass in the exact file
1370
self.to_exact_file = getattr(to_file, 'stream', to_file)
1328
self.to_exact_file = getattr(to_file, 'stream', to_file)
1371
1329
self.show_ids = show_ids
1372
1330
self.show_timezone = show_timezone
1373
1331
if delta_format is None:
1417
1359
def short_author(self, rev):
1418
return self.authors(rev, 'first', short=True, sep=', ')
1420
def authors(self, rev, who, short=False, sep=None):
1421
"""Generate list of authors, taking --authors option into account.
1423
The caller has to specify the name of a author list handler,
1424
as provided by the author list registry, using the ``who``
1425
argument. That name only sets a default, though: when the
1426
user selected a different author list generation using the
1427
``--authors`` command line switch, as represented by the
1428
``author_list_handler`` constructor argument, that value takes
1431
:param rev: The revision for which to generate the list of authors.
1432
:param who: Name of the default handler.
1433
:param short: Whether to shorten names to either name or address.
1434
:param sep: What separator to use for automatic concatenation.
1436
if self._author_list_handler is not None:
1437
# The user did specify --authors, which overrides the default
1438
author_list_handler = self._author_list_handler
1440
# The user didn't specify --authors, so we use the caller's default
1441
author_list_handler = author_list_registry.get(who)
1442
names = author_list_handler(rev)
1444
for i in range(len(names)):
1445
name, address = config.parse_username(names[i])
1451
names = sep.join(names)
1454
def merge_marker(self, revision):
1455
"""Get the merge marker to include in the output or '' if none."""
1456
if len(revision.rev.parent_ids) > 1:
1457
self._merge_count += 1
1360
name, address = config.parse_username(rev.get_apparent_authors()[0])
1462
1365
def show_properties(self, revision, indent):
1463
1366
"""Displays the custom properties returned by each registered handler.
1465
1368
If a registered handler raises an error it is propagated.
1467
for line in self.custom_properties(revision):
1468
self.to_file.write("%s%s\n" % (indent, line))
1470
def custom_properties(self, revision):
1471
"""Format the custom properties returned by each registered handler.
1473
If a registered handler raises an error it is propagated.
1475
:return: a list of formatted lines (excluding trailing newlines)
1477
lines = self._foreign_info_properties(revision)
1478
1370
for key, handler in properties_handler_registry.iteritems():
1479
lines.extend(self._format_properties(handler(revision)))
1482
def _foreign_info_properties(self, rev):
1483
"""Custom log displayer for foreign revision identifiers.
1485
:param rev: Revision object.
1487
# Revision comes directly from a foreign repository
1488
if isinstance(rev, foreign.ForeignRevision):
1489
return self._format_properties(
1490
rev.mapping.vcs.show_foreign_revid(rev.foreign_revid))
1492
# Imported foreign revision revision ids always contain :
1493
if not ":" in rev.revision_id:
1496
# Revision was once imported from a foreign repository
1498
foreign_revid, mapping = \
1499
foreign.foreign_vcs_registry.parse_revision_id(rev.revision_id)
1500
except errors.InvalidRevisionId:
1503
return self._format_properties(
1504
mapping.vcs.show_foreign_revid(foreign_revid))
1506
def _format_properties(self, properties):
1508
for key, value in properties.items():
1509
lines.append(key + ': ' + value)
1371
for key, value in handler(revision).items():
1372
self.to_file.write(indent + key + ': ' + value + '\n')
1512
1374
def show_diff(self, to_file, diff, indent):
1513
1375
for l in diff.rstrip().split('\n'):
1514
1376
to_file.write(indent + '%s\n' % (l,))
1517
# Separator between revisions in long format
1518
_LONG_SEP = '-' * 60
1521
1379
class LongLogFormatter(LogFormatter):
1523
1381
supports_merge_revisions = True
1524
preferred_levels = 1
1525
1382
supports_delta = True
1526
1383
supports_tags = True
1527
1384
supports_diff = True
1529
def __init__(self, *args, **kwargs):
1530
super(LongLogFormatter, self).__init__(*args, **kwargs)
1531
if self.show_timezone == 'original':
1532
self.date_string = self._date_string_original_timezone
1534
self.date_string = self._date_string_with_timezone
1536
def _date_string_with_timezone(self, rev):
1537
return format_date(rev.timestamp, rev.timezone or 0,
1540
def _date_string_original_timezone(self, rev):
1541
return format_date_with_offset_in_original_timezone(rev.timestamp,
1544
1386
def log_revision(self, revision):
1545
1387
"""Log a revision, either merged or not."""
1546
1388
indent = ' ' * revision.merge_depth
1389
to_file = self.to_file
1390
to_file.write(indent + '-' * 60 + '\n')
1548
1391
if revision.revno is not None:
1549
lines.append('revno: %s%s' % (revision.revno,
1550
self.merge_marker(revision)))
1392
to_file.write(indent + 'revno: %s\n' % (revision.revno,))
1551
1393
if revision.tags:
1552
lines.append('tags: %s' % (', '.join(revision.tags)))
1394
to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
1553
1395
if self.show_ids:
1554
lines.append('revision-id: %s' % (revision.rev.revision_id,))
1396
to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
1555
1398
for parent_id in revision.rev.parent_ids:
1556
lines.append('parent: %s' % (parent_id,))
1557
lines.extend(self.custom_properties(revision.rev))
1399
to_file.write(indent + 'parent: %s\n' % (parent_id,))
1400
self.show_properties(revision.rev, indent)
1559
1402
committer = revision.rev.committer
1560
authors = self.authors(revision.rev, 'all')
1403
authors = revision.rev.get_apparent_authors()
1561
1404
if authors != [committer]:
1562
lines.append('author: %s' % (", ".join(authors),))
1563
lines.append('committer: %s' % (committer,))
1405
to_file.write(indent + 'author: %s\n' % (", ".join(authors),))
1406
to_file.write(indent + 'committer: %s\n' % (committer,))
1565
1408
branch_nick = revision.rev.properties.get('branch-nick', None)
1566
1409
if branch_nick is not None:
1567
lines.append('branch nick: %s' % (branch_nick,))
1569
lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1571
lines.append('message:')
1410
to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
1412
date_str = format_date(revision.rev.timestamp,
1413
revision.rev.timezone or 0,
1415
to_file.write(indent + 'timestamp: %s\n' % (date_str,))
1417
to_file.write(indent + 'message:\n')
1572
1418
if not revision.rev.message:
1573
lines.append(' (no message)')
1419
to_file.write(indent + ' (no message)\n')
1575
1421
message = revision.rev.message.rstrip('\r\n')
1576
1422
for l in message.split('\n'):
1577
lines.append(' %s' % (l,))
1579
# Dump the output, appending the delta and diff if requested
1580
to_file = self.to_file
1581
to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
1423
to_file.write(indent + ' %s\n' % (l,))
1582
1424
if revision.delta is not None:
1583
# Use the standard status output to display changes
1584
from bzrlib.delta import report_delta
1585
report_delta(to_file, revision.delta, short_status=False,
1586
show_ids=self.show_ids, indent=indent)
1425
# We don't respect delta_format for compatibility
1426
revision.delta.show(to_file, self.show_ids, indent=indent,
1587
1428
if revision.diff is not None:
1588
1429
to_file.write(indent + 'diff:\n')
1590
1430
# Note: we explicitly don't indent the diff (relative to the
1591
1431
# revision information) so that the output can be fed to patch -p0
1592
1432
self.show_diff(self.to_exact_file, revision.diff, indent)
1593
self.to_exact_file.flush()
1595
def get_advice_separator(self):
1596
"""Get the text separating the log from the closing advice."""
1597
return '-' * 60 + '\n'
1600
1435
class ShortLogFormatter(LogFormatter):
added
removed
bzrlib/log.py
