386
389
:return: An iterator yielding LogRevision objects.
392
levels = rqst.get('levels')
393
limit = rqst.get('limit')
394
diff_type = rqst.get('diff_type')
390
396
revision_iterator = self._create_log_revision_iterator()
391
397
for revs in revision_iterator:
392
398
for (rev_id, revno, merge_depth), rev, delta in revs:
393
399
# 0 levels means show everything; merge_depth counts from 0
394
levels = rqst.get('levels')
395
400
if levels != 0 and merge_depth >= levels:
397
diff = self._format_diff(rev, rev_id)
402
if diff_type is None:
405
diff = self._format_diff(rev, rev_id, diff_type)
398
406
yield LogRevision(rev, revno, merge_depth, delta,
399
407
self.rev_tag_dict.get(rev_id), diff)
400
limit = rqst.get('limit')
403
410
if log_count >= limit:
406
def _format_diff(self, rev, rev_id):
407
diff_type = self.rqst.get('diff_type')
408
if diff_type is None:
413
def _format_diff(self, rev, rev_id, diff_type):
410
414
repo = self.branch.repository
411
415
if len(rev.parent_ids) == 0:
412
416
ancestor_id = _mod_revision.NULL_REVISION
482
487
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
483
generate_merge_revisions, allow_single_merge_revision,
484
delayed_graph_generation=False):
488
generate_merge_revisions, delayed_graph_generation=False):
485
489
"""Calculate the revisions to view.
487
491
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
488
492
a list of the same tuples.
494
if direction not in ('reverse', 'forward'):
495
raise ValueError('invalid direction %r' % direction)
490
496
br_revno, br_rev_id = branch.last_revision_info()
491
497
if br_revno == 0:
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,
500
if (end_rev_id and start_rev_id == end_rev_id
501
and (not generate_merge_revisions
502
or not _has_merges(branch, end_rev_id))):
503
# If a single revision is requested, check we can handle it
504
iter_revs = _generate_one_revision(branch, end_rev_id, br_rev_id,
506
elif not generate_merge_revisions:
507
# If we only want to see linear revisions, we can iterate ...
508
iter_revs = _generate_flat_revisions(branch, start_rev_id, end_rev_id,
510
if direction == 'forward':
511
iter_revs = reversed(iter_revs)
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):
513
iter_revs = _generate_all_revisions(branch, start_rev_id, end_rev_id,
514
direction, delayed_graph_generation)
515
if direction == 'forward':
516
iter_revs = _rebase_merge_depth(reverse_by_depth(list(iter_revs)))
520
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
512
521
if rev_id == br_rev_id:
514
523
return [(br_rev_id, br_revno, 0)]
516
525
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.')
524
526
revno_str = '.'.join(str(n) for n in revno)
525
527
return [(rev_id, revno_str, 0)]
536
538
except _StartNotLinearAncestor:
537
539
raise errors.BzrCommandError('Start revision not found in'
538
540
' left-hand history of end revision.')
539
if direction == 'forward':
540
result = reversed(result)
544
544
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
545
delayed_graph_generation):
545
delayed_graph_generation):
546
546
# On large trees, generating the merge graph can take 30-60 seconds
547
547
# so we delay doing it until a merge is detected, incrementally
548
548
# returning initial (non-merge) revisions while we can.
550
# The above is only true for old formats (<= 0.92), for newer formats, a
551
# couple of seconds only should be needed to load the whole graph and the
552
# other graph operations needed are even faster than that -- vila 100201
549
553
initial_revisions = []
550
554
if delayed_graph_generation:
552
for rev_id, revno, depth in \
553
_linear_view_revisions(branch, start_rev_id, end_rev_id):
556
for rev_id, revno, depth in _linear_view_revisions(
557
branch, start_rev_id, end_rev_id):
554
558
if _has_merges(branch, rev_id):
559
# The end_rev_id can be nested down somewhere. We need an
560
# explicit ancestry check. There is an ambiguity here as we
561
# may not raise _StartNotLinearAncestor for a revision that
562
# is an ancestor but not a *linear* one. But since we have
563
# loaded the graph to do the check (or calculate a dotted
564
# revno), we may as well accept to show the log... We need
565
# the check only if start_rev_id is not None as all
566
# revisions have _mod_revision.NULL_REVISION as an ancestor
568
graph = branch.repository.get_graph()
569
if (start_rev_id is not None
570
and not graph.is_ancestor(start_rev_id, end_rev_id)):
571
raise _StartNotLinearAncestor()
572
# Since we collected the revisions so far, we need to
555
574
end_rev_id = rev_id
558
577
initial_revisions.append((rev_id, revno, depth))
560
579
# No merged revisions found
561
if direction == 'reverse':
562
return initial_revisions
563
elif direction == 'forward':
564
return reversed(initial_revisions)
566
raise ValueError('invalid direction %r' % direction)
580
return initial_revisions
567
581
except _StartNotLinearAncestor:
568
582
# A merge was never detected so the lower revision limit can't
569
583
# be nested down somewhere
570
584
raise errors.BzrCommandError('Start revision not found in'
571
585
' history of end revision.')
587
# We exit the loop above because we encounter a revision with merges, from
588
# this revision, we need to switch to _graph_view_revisions.
573
590
# A log including nested merges is required. If the direction is reverse,
574
591
# we rebase the initial merge depths so that the development line is
575
592
# shown naturally, i.e. just like it is for linear logging. We can easily
676
688
depth_adjustment = merge_depth
677
689
if depth_adjustment:
678
690
if merge_depth < depth_adjustment:
691
# From now on we reduce the depth adjustement, this can be
692
# surprising for users. The alternative requires two passes
693
# which breaks the fast display of the first revision
679
695
depth_adjustment = merge_depth
680
696
merge_depth -= depth_adjustment
681
697
yield rev_id, '.'.join(map(str, revno)), merge_depth
700
@deprecated_function(deprecated_in((2, 2, 0)))
684
701
def calculate_view_revisions(branch, start_revision, end_revision, direction,
685
specific_fileid, generate_merge_revisions, allow_single_merge_revision):
702
specific_fileid, generate_merge_revisions):
686
703
"""Calculate the revisions to view.
688
705
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
689
706
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
694
708
start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
696
710
view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
697
direction, generate_merge_revisions or specific_fileid,
698
allow_single_merge_revision))
711
direction, generate_merge_revisions or specific_fileid))
699
712
if specific_fileid:
700
713
view_revisions = _filter_revisions_touching_file_id(branch,
701
714
specific_fileid, view_revisions,
1311
1316
preferred_levels = 0
1313
1318
def __init__(self, to_file, show_ids=False, show_timezone='original',
1314
delta_format=None, levels=None):
1319
delta_format=None, levels=None, show_advice=False,
1320
to_exact_file=None):
1315
1321
"""Create a LogFormatter.
1317
1323
:param to_file: the file to output to
1324
:param to_exact_file: if set, gives an output stream to which
1325
non-Unicode diffs are written.
1318
1326
:param show_ids: if True, revision-ids are to be displayed
1319
1327
:param show_timezone: the timezone to use
1320
1328
:param delta_format: the level of delta information to display
1321
or None to leave it u to the formatter to decide
1329
or None to leave it to the formatter to decide
1322
1330
:param levels: the number of levels to display; None or -1 to
1323
1331
let the log formatter decide.
1332
:param show_advice: whether to show advice at the end of the
1325
1335
self.to_file = to_file
1326
1336
# 'exact' stream used to show diff, it should print content 'as is'
1327
1337
# and should not try to decode/encode it to unicode to avoid bug #328007
1328
self.to_exact_file = getattr(to_file, 'stream', to_file)
1338
if to_exact_file is not None:
1339
self.to_exact_file = to_exact_file
1341
# XXX: somewhat hacky; this assumes it's a codec writer; it's better
1342
# for code that expects to get diffs to pass in the exact file
1344
self.to_exact_file = getattr(to_file, 'stream', to_file)
1329
1345
self.show_ids = show_ids
1330
1346
self.show_timezone = show_timezone
1331
1347
if delta_format is None:
1396
def merge_marker(self, revision):
1397
"""Get the merge marker to include in the output or '' if none."""
1398
if len(revision.rev.parent_ids) > 1:
1399
self._merge_count += 1
1365
1404
def show_properties(self, revision, indent):
1366
1405
"""Displays the custom properties returned by each registered handler.
1368
1407
If a registered handler raises an error it is propagated.
1409
for line in self.custom_properties(revision):
1410
self.to_file.write("%s%s\n" % (indent, line))
1412
def custom_properties(self, revision):
1413
"""Format the custom properties returned by each registered handler.
1415
If a registered handler raises an error it is propagated.
1417
:return: a list of formatted lines (excluding trailing newlines)
1419
lines = self._foreign_info_properties(revision)
1370
1420
for key, handler in properties_handler_registry.iteritems():
1371
for key, value in handler(revision).items():
1372
self.to_file.write(indent + key + ': ' + value + '\n')
1421
lines.extend(self._format_properties(handler(revision)))
1424
def _foreign_info_properties(self, rev):
1425
"""Custom log displayer for foreign revision identifiers.
1427
:param rev: Revision object.
1429
# Revision comes directly from a foreign repository
1430
if isinstance(rev, foreign.ForeignRevision):
1431
return self._format_properties(
1432
rev.mapping.vcs.show_foreign_revid(rev.foreign_revid))
1434
# Imported foreign revision revision ids always contain :
1435
if not ":" in rev.revision_id:
1438
# Revision was once imported from a foreign repository
1440
foreign_revid, mapping = \
1441
foreign.foreign_vcs_registry.parse_revision_id(rev.revision_id)
1442
except errors.InvalidRevisionId:
1445
return self._format_properties(
1446
mapping.vcs.show_foreign_revid(foreign_revid))
1448
def _format_properties(self, properties):
1450
for key, value in properties.items():
1451
lines.append(key + ': ' + value)
1374
1454
def show_diff(self, to_file, diff, indent):
1375
1455
for l in diff.rstrip().split('\n'):
1376
1456
to_file.write(indent + '%s\n' % (l,))
1459
# Separator between revisions in long format
1460
_LONG_SEP = '-' * 60
1379
1463
class LongLogFormatter(LogFormatter):
1381
1465
supports_merge_revisions = True
1466
preferred_levels = 1
1382
1467
supports_delta = True
1383
1468
supports_tags = True
1384
1469
supports_diff = True
1471
def __init__(self, *args, **kwargs):
1472
super(LongLogFormatter, self).__init__(*args, **kwargs)
1473
if self.show_timezone == 'original':
1474
self.date_string = self._date_string_original_timezone
1476
self.date_string = self._date_string_with_timezone
1478
def _date_string_with_timezone(self, rev):
1479
return format_date(rev.timestamp, rev.timezone or 0,
1482
def _date_string_original_timezone(self, rev):
1483
return format_date_with_offset_in_original_timezone(rev.timestamp,
1386
1486
def log_revision(self, revision):
1387
1487
"""Log a revision, either merged or not."""
1388
1488
indent = ' ' * revision.merge_depth
1389
to_file = self.to_file
1390
to_file.write(indent + '-' * 60 + '\n')
1391
1490
if revision.revno is not None:
1392
to_file.write(indent + 'revno: %s\n' % (revision.revno,))
1491
lines.append('revno: %s%s' % (revision.revno,
1492
self.merge_marker(revision)))
1393
1493
if revision.tags:
1394
to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
1494
lines.append('tags: %s' % (', '.join(revision.tags)))
1395
1495
if self.show_ids:
1396
to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
1496
lines.append('revision-id: %s' % (revision.rev.revision_id,))
1398
1497
for parent_id in revision.rev.parent_ids:
1399
to_file.write(indent + 'parent: %s\n' % (parent_id,))
1400
self.show_properties(revision.rev, indent)
1498
lines.append('parent: %s' % (parent_id,))
1499
lines.extend(self.custom_properties(revision.rev))
1402
1501
committer = revision.rev.committer
1403
1502
authors = revision.rev.get_apparent_authors()
1404
1503
if authors != [committer]:
1405
to_file.write(indent + 'author: %s\n' % (", ".join(authors),))
1406
to_file.write(indent + 'committer: %s\n' % (committer,))
1504
lines.append('author: %s' % (", ".join(authors),))
1505
lines.append('committer: %s' % (committer,))
1408
1507
branch_nick = revision.rev.properties.get('branch-nick', None)
1409
1508
if branch_nick is not None:
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')
1509
lines.append('branch nick: %s' % (branch_nick,))
1511
lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1513
lines.append('message:')
1418
1514
if not revision.rev.message:
1419
to_file.write(indent + ' (no message)\n')
1515
lines.append(' (no message)')
1421
1517
message = revision.rev.message.rstrip('\r\n')
1422
1518
for l in message.split('\n'):
1423
to_file.write(indent + ' %s\n' % (l,))
1519
lines.append(' %s' % (l,))
1521
# Dump the output, appending the delta and diff if requested
1522
to_file = self.to_file
1523
to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
1424
1524
if revision.delta is not None:
1425
# We don't respect delta_format for compatibility
1426
revision.delta.show(to_file, self.show_ids, indent=indent,
1525
# Use the standard status output to display changes
1526
from bzrlib.delta import report_delta
1527
report_delta(to_file, revision.delta, short_status=False,
1528
show_ids=self.show_ids, indent=indent)
1428
1529
if revision.diff is not None:
1429
1530
to_file.write(indent + 'diff:\n')
1430
1532
# Note: we explicitly don't indent the diff (relative to the
1431
1533
# revision information) so that the output can be fed to patch -p0
1432
1534
self.show_diff(self.to_exact_file, revision.diff, indent)
1535
self.to_exact_file.flush()
1537
def get_advice_separator(self):
1538
"""Get the text separating the log from the closing advice."""
1539
return '-' * 60 + '\n'
1435
1542
class ShortLogFormatter(LogFormatter):
added
removed
bzrlib/log.py
