215
220
'direction': 'reverse',
217
222
'generate_tags': True,
223
'exclude_common_ancestry': False,
218
224
'_match_using_deltas': True,
222
228
def make_log_request_dict(direction='reverse', specific_fileids=None,
223
start_revision=None, end_revision=None, limit=None,
224
message_search=None, levels=1, generate_tags=True, delta_type=None,
225
diff_type=None, _match_using_deltas=True):
229
start_revision=None, end_revision=None, limit=None,
230
message_search=None, levels=1, generate_tags=True,
232
diff_type=None, _match_using_deltas=True,
233
exclude_common_ancestry=False,
226
235
"""Convenience function for making a logging request dictionary.
228
237
Using this function may make code slightly safer by ensuring
384
397
:return: An iterator yielding LogRevision objects.
400
levels = rqst.get('levels')
401
limit = rqst.get('limit')
402
diff_type = rqst.get('diff_type')
388
404
revision_iterator = self._create_log_revision_iterator()
389
405
for revs in revision_iterator:
390
406
for (rev_id, revno, merge_depth), rev, delta in revs:
391
407
# 0 levels means show everything; merge_depth counts from 0
392
levels = rqst.get('levels')
393
408
if levels != 0 and merge_depth >= levels:
395
diff = self._format_diff(rev, rev_id)
410
if diff_type is None:
413
diff = self._format_diff(rev, rev_id, diff_type)
396
414
yield LogRevision(rev, revno, merge_depth, delta,
397
415
self.rev_tag_dict.get(rev_id), diff)
398
limit = rqst.get('limit')
401
418
if log_count >= limit:
404
def _format_diff(self, rev, rev_id):
405
diff_type = self.rqst.get('diff_type')
406
if diff_type is None:
421
def _format_diff(self, rev, rev_id, diff_type):
408
422
repo = self.branch.repository
409
423
if len(rev.parent_ids) == 0:
410
424
ancestor_id = _mod_revision.NULL_REVISION
449
464
generate_merge_revisions = rqst.get('levels') != 1
450
465
delayed_graph_generation = not rqst.get('specific_fileids') and (
451
466
rqst.get('limit') or self.start_rev_id or self.end_rev_id)
452
view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
453
self.end_rev_id, rqst.get('direction'), generate_merge_revisions,
454
delayed_graph_generation=delayed_graph_generation)
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'))
456
474
# Apply the other filters
457
475
return make_log_rev_iterator(self.branch, view_revisions,
464
482
# Note that we always generate the merge revisions because
465
483
# filter_revisions_touching_file_id() requires them ...
467
view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
468
self.end_rev_id, rqst.get('direction'), True)
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'))
469
489
if not isinstance(view_revisions, list):
470
490
view_revisions = list(view_revisions)
471
491
view_revisions = _filter_revisions_touching_file_id(self.branch,
478
498
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
479
generate_merge_revisions, delayed_graph_generation=False):
499
generate_merge_revisions,
500
delayed_graph_generation=False,
501
exclude_common_ancestry=False,
480
503
"""Calculate the revisions to view.
482
505
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
483
506
a list of the same tuples.
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)
485
513
br_revno, br_rev_id = branch.last_revision_info()
486
514
if br_revno == 0:
489
# If a single revision is requested, check we can handle it
490
generate_single_revision = (end_rev_id and start_rev_id == end_rev_id and
491
(not generate_merge_revisions or not _has_merges(branch, end_rev_id)))
492
if generate_single_revision:
493
return _generate_one_revision(branch, end_rev_id, br_rev_id, br_revno)
495
# If we only want to see linear revisions, we can iterate ...
496
if not generate_merge_revisions:
497
return _generate_flat_revisions(branch, start_rev_id, end_rev_id,
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,
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)
500
return _generate_all_revisions(branch, start_rev_id, end_rev_id,
501
direction, delayed_graph_generation)
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)))
504
538
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
511
545
return [(rev_id, revno_str, 0)]
514
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction):
515
result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
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)
516
553
# If a start limit was given and it's not obviously an
517
554
# ancestor of the end limit, check it before outputting anything
518
555
if direction == 'forward' or (start_rev_id
522
559
except _StartNotLinearAncestor:
523
560
raise errors.BzrCommandError('Start revision not found in'
524
561
' left-hand history of end revision.')
525
if direction == 'forward':
526
result = reversed(result)
530
565
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
531
delayed_graph_generation):
566
delayed_graph_generation,
567
exclude_common_ancestry=False):
532
568
# On large trees, generating the merge graph can take 30-60 seconds
533
569
# so we delay doing it until a merge is detected, incrementally
534
570
# returning initial (non-merge) revisions while we can.
572
# The above is only true for old formats (<= 0.92), for newer formats, a
573
# couple of seconds only should be needed to load the whole graph and the
574
# other graph operations needed are even faster than that -- vila 100201
535
575
initial_revisions = []
536
576
if delayed_graph_generation:
538
for rev_id, revno, depth in \
539
_linear_view_revisions(branch, start_rev_id, end_rev_id):
578
for rev_id, revno, depth in _linear_view_revisions(
579
branch, start_rev_id, end_rev_id, exclude_common_ancestry):
540
580
if _has_merges(branch, rev_id):
581
# The end_rev_id can be nested down somewhere. We need an
582
# explicit ancestry check. There is an ambiguity here as we
583
# may not raise _StartNotLinearAncestor for a revision that
584
# is an ancestor but not a *linear* one. But since we have
585
# loaded the graph to do the check (or calculate a dotted
586
# revno), we may as well accept to show the log... We need
587
# the check only if start_rev_id is not None as all
588
# revisions have _mod_revision.NULL_REVISION as an ancestor
590
graph = branch.repository.get_graph()
591
if (start_rev_id is not None
592
and not graph.is_ancestor(start_rev_id, end_rev_id)):
593
raise _StartNotLinearAncestor()
594
# Since we collected the revisions so far, we need to
541
596
end_rev_id = rev_id
544
599
initial_revisions.append((rev_id, revno, depth))
546
601
# No merged revisions found
547
if direction == 'reverse':
548
return initial_revisions
549
elif direction == 'forward':
550
return reversed(initial_revisions)
552
raise ValueError('invalid direction %r' % direction)
602
return initial_revisions
553
603
except _StartNotLinearAncestor:
554
604
# A merge was never detected so the lower revision limit can't
555
605
# be nested down somewhere
556
606
raise errors.BzrCommandError('Start revision not found in'
557
607
' history of end revision.')
609
# We exit the loop above because we encounter a revision with merges, from
610
# this revision, we need to switch to _graph_view_revisions.
559
612
# A log including nested merges is required. If the direction is reverse,
560
613
# we rebase the initial merge depths so that the development line is
561
614
# shown naturally, i.e. just like it is for linear logging. We can easily
563
616
# indented at the end seems slightly nicer in that case.
564
617
view_revisions = chain(iter(initial_revisions),
565
618
_graph_view_revisions(branch, start_rev_id, end_rev_id,
566
rebase_initial_depths=direction == 'reverse'))
567
if direction == 'reverse':
568
return view_revisions
569
elif direction == 'forward':
570
# Forward means oldest first, adjusting for depth.
571
view_revisions = reverse_by_depth(list(view_revisions))
572
return _rebase_merge_depth(view_revisions)
574
raise ValueError('invalid direction %r' % direction)
619
rebase_initial_depths=(direction == 'reverse'),
620
exclude_common_ancestry=exclude_common_ancestry))
621
return view_revisions
577
624
def _has_merges(branch, rev_id):
645
# if either start or end is not specified then we use either the first or
646
# the last revision and *they* are obvious ancestors.
601
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
650
def _linear_view_revisions(branch, start_rev_id, end_rev_id,
651
exclude_common_ancestry=False):
602
652
"""Calculate a sequence of revisions to view, newest to oldest.
604
654
:param start_rev_id: the lower revision-id
605
655
: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.
606
658
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
607
659
:raises _StartNotLinearAncestor: if a start_rev_id is specified but
608
is not found walking the left-hand history
660
is not found walking the left-hand history
610
662
br_revno, br_rev_id = branch.last_revision_info()
611
663
repo = branch.repository
662
720
depth_adjustment = merge_depth
663
721
if depth_adjustment:
664
722
if merge_depth < depth_adjustment:
723
# From now on we reduce the depth adjustement, this can be
724
# surprising for users. The alternative requires two passes
725
# which breaks the fast display of the first revision
665
727
depth_adjustment = merge_depth
666
728
merge_depth -= depth_adjustment
667
729
yield rev_id, '.'.join(map(str, revno)), merge_depth
732
@deprecated_function(deprecated_in((2, 2, 0)))
670
733
def calculate_view_revisions(branch, start_revision, end_revision, direction,
671
734
specific_fileid, generate_merge_revisions):
672
735
"""Calculate the revisions to view.
1291
1347
preferred_levels = 0
1293
1349
def __init__(self, to_file, show_ids=False, show_timezone='original',
1294
delta_format=None, levels=None, show_advice=False):
1350
delta_format=None, levels=None, show_advice=False,
1351
to_exact_file=None, author_list_handler=None):
1295
1352
"""Create a LogFormatter.
1297
1354
:param to_file: the file to output to
1355
:param to_exact_file: if set, gives an output stream to which
1356
non-Unicode diffs are written.
1298
1357
:param show_ids: if True, revision-ids are to be displayed
1299
1358
:param show_timezone: the timezone to use
1300
1359
:param delta_format: the level of delta information to display
1303
1362
let the log formatter decide.
1304
1363
:param show_advice: whether to show advice at the end of the
1365
:param author_list_handler: callable generating a list of
1366
authors to display for a given revision
1307
1368
self.to_file = to_file
1308
1369
# 'exact' stream used to show diff, it should print content 'as is'
1309
1370
# and should not try to decode/encode it to unicode to avoid bug #328007
1310
self.to_exact_file = getattr(to_file, 'stream', to_file)
1371
if to_exact_file is not None:
1372
self.to_exact_file = to_exact_file
1374
# XXX: somewhat hacky; this assumes it's a codec writer; it's better
1375
# for code that expects to get diffs to pass in the exact file
1377
self.to_exact_file = getattr(to_file, 'stream', to_file)
1311
1378
self.show_ids = show_ids
1312
1379
self.show_timezone = show_timezone
1313
1380
if delta_format is None:
1356
1424
def short_author(self, rev):
1357
name, address = config.parse_username(rev.get_apparent_authors()[0])
1425
return self.authors(rev, 'first', short=True, sep=', ')
1427
def authors(self, rev, who, short=False, sep=None):
1428
"""Generate list of authors, taking --authors option into account.
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
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.
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
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)
1451
for i in range(len(names)):
1452
name, address = config.parse_username(names[i])
1458
names = sep.join(names)
1362
1461
def merge_marker(self, revision):
1363
1462
"""Get the merge marker to include in the output or '' if none."""
1370
def show_foreign_info(self, rev, indent):
1469
def show_properties(self, revision, indent):
1470
"""Displays the custom properties returned by each registered handler.
1472
If a registered handler raises an error it is propagated.
1474
for line in self.custom_properties(revision):
1475
self.to_file.write("%s%s\n" % (indent, line))
1477
def custom_properties(self, revision):
1478
"""Format the custom properties returned by each registered handler.
1480
If a registered handler raises an error it is propagated.
1482
:return: a list of formatted lines (excluding trailing newlines)
1484
lines = self._foreign_info_properties(revision)
1485
for key, handler in properties_handler_registry.iteritems():
1486
lines.extend(self._format_properties(handler(revision)))
1489
def _foreign_info_properties(self, rev):
1371
1490
"""Custom log displayer for foreign revision identifiers.
1373
1492
:param rev: Revision object.
1375
1494
# Revision comes directly from a foreign repository
1376
1495
if isinstance(rev, foreign.ForeignRevision):
1377
self._write_properties(indent, rev.mapping.vcs.show_foreign_revid(
1496
return self._format_properties(
1497
rev.mapping.vcs.show_foreign_revid(rev.foreign_revid))
1381
1499
# Imported foreign revision revision ids always contain :
1382
1500
if not ":" in rev.revision_id:
1385
1503
# Revision was once imported from a foreign repository
1387
1505
foreign_revid, mapping = \
1388
1506
foreign.foreign_vcs_registry.parse_revision_id(rev.revision_id)
1389
1507
except errors.InvalidRevisionId:
1392
self._write_properties(indent,
1510
return self._format_properties(
1393
1511
mapping.vcs.show_foreign_revid(foreign_revid))
1395
def show_properties(self, revision, indent):
1396
"""Displays the custom properties returned by each registered handler.
1398
If a registered handler raises an error it is propagated.
1400
for key, handler in properties_handler_registry.iteritems():
1401
self._write_properties(indent, handler(revision))
1403
def _write_properties(self, indent, properties):
1513
def _format_properties(self, properties):
1404
1515
for key, value in properties.items():
1405
self.to_file.write(indent + key + ': ' + value + '\n')
1516
lines.append(key + ': ' + value)
1407
1519
def show_diff(self, to_file, diff, indent):
1408
1520
for l in diff.rstrip().split('\n'):
1409
1521
to_file.write(indent + '%s\n' % (l,))
1524
# Separator between revisions in long format
1525
_LONG_SEP = '-' * 60
1412
1528
class LongLogFormatter(LogFormatter):
1414
1530
supports_merge_revisions = True
1417
1533
supports_tags = True
1418
1534
supports_diff = True
1536
def __init__(self, *args, **kwargs):
1537
super(LongLogFormatter, self).__init__(*args, **kwargs)
1538
if self.show_timezone == 'original':
1539
self.date_string = self._date_string_original_timezone
1541
self.date_string = self._date_string_with_timezone
1543
def _date_string_with_timezone(self, rev):
1544
return format_date(rev.timestamp, rev.timezone or 0,
1547
def _date_string_original_timezone(self, rev):
1548
return format_date_with_offset_in_original_timezone(rev.timestamp,
1420
1551
def log_revision(self, revision):
1421
1552
"""Log a revision, either merged or not."""
1422
1553
indent = ' ' * revision.merge_depth
1423
to_file = self.to_file
1424
to_file.write(indent + '-' * 60 + '\n')
1425
1555
if revision.revno is not None:
1426
to_file.write(indent + 'revno: %s%s\n' % (revision.revno,
1556
lines.append('revno: %s%s' % (revision.revno,
1427
1557
self.merge_marker(revision)))
1428
1558
if revision.tags:
1429
to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
1559
lines.append('tags: %s' % (', '.join(revision.tags)))
1430
1560
if self.show_ids:
1431
to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
1561
lines.append('revision-id: %s' % (revision.rev.revision_id,))
1433
1562
for parent_id in revision.rev.parent_ids:
1434
to_file.write(indent + 'parent: %s\n' % (parent_id,))
1435
self.show_foreign_info(revision.rev, indent)
1436
self.show_properties(revision.rev, indent)
1563
lines.append('parent: %s' % (parent_id,))
1564
lines.extend(self.custom_properties(revision.rev))
1438
1566
committer = revision.rev.committer
1439
authors = revision.rev.get_apparent_authors()
1567
authors = self.authors(revision.rev, 'all')
1440
1568
if authors != [committer]:
1441
to_file.write(indent + 'author: %s\n' % (", ".join(authors),))
1442
to_file.write(indent + 'committer: %s\n' % (committer,))
1569
lines.append('author: %s' % (", ".join(authors),))
1570
lines.append('committer: %s' % (committer,))
1444
1572
branch_nick = revision.rev.properties.get('branch-nick', None)
1445
1573
if branch_nick is not None:
1446
to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
1448
date_str = format_date(revision.rev.timestamp,
1449
revision.rev.timezone or 0,
1451
to_file.write(indent + 'timestamp: %s\n' % (date_str,))
1453
to_file.write(indent + 'message:\n')
1574
lines.append('branch nick: %s' % (branch_nick,))
1576
lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1578
lines.append('message:')
1454
1579
if not revision.rev.message:
1455
to_file.write(indent + ' (no message)\n')
1580
lines.append(' (no message)')
1457
1582
message = revision.rev.message.rstrip('\r\n')
1458
1583
for l in message.split('\n'):
1459
to_file.write(indent + ' %s\n' % (l,))
1584
lines.append(' %s' % (l,))
1586
# Dump the output, appending the delta and diff if requested
1587
to_file = self.to_file
1588
to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
1460
1589
if revision.delta is not None:
1461
# We don't respect delta_format for compatibility
1462
revision.delta.show(to_file, self.show_ids, indent=indent,
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)
1464
1594
if revision.diff is not None:
1465
1595
to_file.write(indent + 'diff:\n')
1466
1597
# Note: we explicitly don't indent the diff (relative to the
1467
1598
# revision information) so that the output can be fed to patch -p0
1468
1599
self.show_diff(self.to_exact_file, revision.diff, indent)
1600
self.to_exact_file.flush()
1470
1602
def get_advice_separator(self):
1471
1603
"""Get the text separating the log from the closing advice."""
1528
1659
to_file.write(indent + offset + '%s\n' % (l,))
1530
1661
if revision.delta is not None:
1531
revision.delta.show(to_file, self.show_ids, indent=indent + offset,
1532
short_status=self.delta_format==1)
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)
1533
1667
if revision.diff is not None:
1534
1668
self.show_diff(self.to_exact_file, revision.diff, ' ')
1535
1669
to_file.write('\n')
1677
1816
raise errors.BzrCommandError("unknown log formatter: %r" % name)
1819
def author_list_all(rev):
1820
return rev.get_apparent_authors()[:]
1823
def author_list_first(rev):
1824
lst = rev.get_apparent_authors()
1831
def author_list_committer(rev):
1832
return [rev.committer]
1835
author_list_registry = registry.Registry()
1837
author_list_registry.register('all', author_list_all,
1840
author_list_registry.register('first', author_list_first,
1843
author_list_registry.register('committer', author_list_committer,
1680
1847
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
1681
1848
# deprecated; for compatibility
1682
1849
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
1843
2010
:param file_list: the list of paths given on the command line;
1844
2011
the first of these can be a branch location or a file path,
1845
2012
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.
1846
2015
:return: (branch, info_list, start_rev_info, end_rev_info) where
1847
2016
info_list is a list of (relative_path, file_id, kind) tuples where
1848
2017
kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
2018
branch will be read-locked.
1850
2020
from builtins import _get_revision_range, safe_relpath_files
1851
2021
tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
2022
add_cleanup(b.lock_read().unlock)
1852
2023
# XXX: It's damn messy converting a list of paths to relative paths when
1853
2024
# those paths might be deleted ones, they might be on a case-insensitive
1854
2025
# filesystem and/or they might be in silly locations (like another branch).
1934
2105
properties_handler_registry = registry.Registry()
2107
# Use the properties handlers to print out bug information if available
2108
def _bugs_properties_handler(revision):
2109
if revision.properties.has_key('bugs'):
2110
bug_lines = revision.properties['bugs'].split('\n')
2111
bug_rows = [line.split(' ', 1) for line in bug_lines]
2112
fixed_bug_urls = [row[0] for row in bug_rows if
2113
len(row) > 1 and row[1] == 'fixed']
2116
return {'fixes bug(s)': ' '.join(fixed_bug_urls)}
2119
properties_handler_registry.register('bugs_properties_handler',
2120
_bugs_properties_handler)
1937
2123
# adapters which revision ids to log are filtered. When log is called, the
1938
2124
# log_rev_iterator is adapted through each of these factory methods.
added
removed
bzrlib/log.py
