210
209
Logger(branch, rqst).show(lf)
213
# Note: This needs to be kept this in sync with the defaults in
212
# Note: This needs to be kept in sync with the defaults in
214
213
# make_log_request_dict() below
215
214
_DEFAULT_REQUEST_PARAMS = {
216
215
'direction': 'reverse',
218
217
'generate_tags': True,
218
'exclude_common_ancestry': False,
219
219
'_match_using_deltas': True,
223
223
def make_log_request_dict(direction='reverse', specific_fileids=None,
224
start_revision=None, end_revision=None, limit=None,
225
message_search=None, levels=1, generate_tags=True, delta_type=None,
226
diff_type=None, _match_using_deltas=True):
224
start_revision=None, end_revision=None, limit=None,
225
message_search=None, levels=None, generate_tags=True,
227
diff_type=None, _match_using_deltas=True,
228
exclude_common_ancestry=False, match=None,
229
signature=False, omit_merges=False,
227
231
"""Convenience function for making a logging request dictionary.
229
233
Using this function may make code slightly safer by ensuring
267
272
algorithm used for matching specific_fileids. This parameter
268
273
may be removed in the future so bzrlib client code should NOT
276
:param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
277
range operator or as a graph difference.
279
:param signature: show digital signature information
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.
285
:param omit_merges: If True, commits with more than one parent are
289
# Take care of old style message_search parameter
292
if 'message' in match:
293
match['message'].append(message_search)
295
match['message'] = [message_search]
297
match={ 'message': [message_search] }
272
299
'direction': direction,
273
300
'specific_fileids': specific_fileids,
274
301
'start_revision': start_revision,
275
302
'end_revision': end_revision,
277
'message_search': message_search,
278
304
'levels': levels,
279
305
'generate_tags': generate_tags,
280
306
'delta_type': delta_type,
281
307
'diff_type': diff_type,
308
'exclude_common_ancestry': exclude_common_ancestry,
309
'signature': signature,
311
'omit_merges': omit_merges,
282
312
# Add 'private' attributes for features that may be deprecated
283
313
'_match_using_deltas': _match_using_deltas,
287
317
def _apply_log_request_defaults(rqst):
288
318
"""Apply default values to a request dictionary."""
289
result = _DEFAULT_REQUEST_PARAMS
319
result = _DEFAULT_REQUEST_PARAMS.copy()
291
321
result.update(rqst)
325
def format_signature_validity(rev_id, repo):
326
"""get the signature validity
328
:param rev_id: revision id to validate
329
:param repo: repository of revision
330
:return: human readable string to print to log
332
from bzrlib import gpg
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"
295
346
class LogGenerator(object):
296
347
"""A generator of log revisions."""
342
393
# Tweak the LogRequest based on what the LogFormatter can handle.
343
394
# (There's no point generating stuff if the formatter can't display it.)
345
rqst['levels'] = lf.get_levels()
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()
346
400
if not getattr(lf, 'supports_tags', False):
347
401
rqst['generate_tags'] = False
348
402
if not getattr(lf, 'supports_delta', False):
349
403
rqst['delta_type'] = None
350
404
if not getattr(lf, 'supports_diff', False):
351
405
rqst['diff_type'] = None
406
if not getattr(lf, 'supports_signatures', False):
407
rqst['signature'] = False
353
409
# Find and print the interesting revisions
354
410
generator = self._generator_factory(self.branch, rqst)
451
517
generate_merge_revisions = rqst.get('levels') != 1
452
518
delayed_graph_generation = not rqst.get('specific_fileids') and (
453
519
rqst.get('limit') or self.start_rev_id or self.end_rev_id)
454
view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
455
self.end_rev_id, rqst.get('direction'), generate_merge_revisions,
456
delayed_graph_generation=delayed_graph_generation)
520
view_revisions = _calc_view_revisions(
521
self.branch, self.start_rev_id, self.end_rev_id,
522
rqst.get('direction'),
523
generate_merge_revisions=generate_merge_revisions,
524
delayed_graph_generation=delayed_graph_generation,
525
exclude_common_ancestry=rqst.get('exclude_common_ancestry'))
458
527
# Apply the other filters
459
528
return make_log_rev_iterator(self.branch, view_revisions,
460
rqst.get('delta_type'), rqst.get('message_search'),
529
rqst.get('delta_type'), rqst.get('match'),
461
530
file_ids=rqst.get('specific_fileids'),
462
531
direction=rqst.get('direction'))
466
535
# Note that we always generate the merge revisions because
467
536
# filter_revisions_touching_file_id() requires them ...
469
view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
470
self.end_rev_id, rqst.get('direction'), True)
538
view_revisions = _calc_view_revisions(
539
self.branch, self.start_rev_id, self.end_rev_id,
540
rqst.get('direction'), generate_merge_revisions=True,
541
exclude_common_ancestry=rqst.get('exclude_common_ancestry'))
471
542
if not isinstance(view_revisions, list):
472
543
view_revisions = list(view_revisions)
473
544
view_revisions = _filter_revisions_touching_file_id(self.branch,
474
545
rqst.get('specific_fileids')[0], view_revisions,
475
546
include_merges=rqst.get('levels') != 1)
476
547
return make_log_rev_iterator(self.branch, view_revisions,
477
rqst.get('delta_type'), rqst.get('message_search'))
548
rqst.get('delta_type'), rqst.get('match'))
480
551
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
481
generate_merge_revisions, delayed_graph_generation=False):
552
generate_merge_revisions,
553
delayed_graph_generation=False,
554
exclude_common_ancestry=False,
482
556
"""Calculate the revisions to view.
484
558
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
485
559
a list of the same tuples.
561
if (exclude_common_ancestry and start_rev_id == end_rev_id):
562
raise errors.BzrCommandError(gettext(
563
'--exclude-common-ancestry requires two different revisions'))
564
if direction not in ('reverse', 'forward'):
565
raise ValueError(gettext('invalid direction %r') % direction)
487
566
br_revno, br_rev_id = branch.last_revision_info()
488
567
if br_revno == 0:
491
# If a single revision is requested, check we can handle it
492
generate_single_revision = (end_rev_id and start_rev_id == end_rev_id and
493
(not generate_merge_revisions or not _has_merges(branch, end_rev_id)))
494
if generate_single_revision:
495
return _generate_one_revision(branch, end_rev_id, br_rev_id, br_revno)
497
# If we only want to see linear revisions, we can iterate ...
570
if (end_rev_id and start_rev_id == end_rev_id
571
and (not generate_merge_revisions
572
or not _has_merges(branch, end_rev_id))):
573
# If a single revision is requested, check we can handle it
574
return _generate_one_revision(branch, end_rev_id, br_rev_id,
498
576
if not generate_merge_revisions:
499
return _generate_flat_revisions(branch, start_rev_id, end_rev_id,
502
return _generate_all_revisions(branch, start_rev_id, end_rev_id,
503
direction, delayed_graph_generation)
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)
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.
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)))
506
603
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
509
606
return [(br_rev_id, br_revno, 0)]
511
revno = branch.revision_id_to_dotted_revno(rev_id)
512
revno_str = '.'.join(str(n) for n in revno)
608
revno_str = _compute_revno_str(branch, rev_id)
513
609
return [(rev_id, revno_str, 0)]
516
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction):
517
result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
518
# If a start limit was given and it's not obviously an
519
# ancestor of the end limit, check it before outputting anything
520
if direction == 'forward' or (start_rev_id
521
and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
523
result = list(result)
524
except _StartNotLinearAncestor:
525
raise errors.BzrCommandError('Start revision not found in'
526
' left-hand history of end revision.')
527
if direction == 'forward':
528
result = reversed(result)
532
612
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
533
delayed_graph_generation):
613
delayed_graph_generation,
614
exclude_common_ancestry=False):
534
615
# On large trees, generating the merge graph can take 30-60 seconds
535
616
# so we delay doing it until a merge is detected, incrementally
536
617
# returning initial (non-merge) revisions while we can.
619
# The above is only true for old formats (<= 0.92), for newer formats, a
620
# couple of seconds only should be needed to load the whole graph and the
621
# other graph operations needed are even faster than that -- vila 100201
537
622
initial_revisions = []
538
623
if delayed_graph_generation:
540
for rev_id, revno, depth in \
541
_linear_view_revisions(branch, start_rev_id, end_rev_id):
625
for rev_id, revno, depth in _linear_view_revisions(
626
branch, start_rev_id, end_rev_id, exclude_common_ancestry):
542
627
if _has_merges(branch, rev_id):
628
# The end_rev_id can be nested down somewhere. We need an
629
# explicit ancestry check. There is an ambiguity here as we
630
# may not raise _StartNotLinearAncestor for a revision that
631
# is an ancestor but not a *linear* one. But since we have
632
# loaded the graph to do the check (or calculate a dotted
633
# revno), we may as well accept to show the log... We need
634
# the check only if start_rev_id is not None as all
635
# revisions have _mod_revision.NULL_REVISION as an ancestor
637
graph = branch.repository.get_graph()
638
if (start_rev_id is not None
639
and not graph.is_ancestor(start_rev_id, end_rev_id)):
640
raise _StartNotLinearAncestor()
641
# Since we collected the revisions so far, we need to
543
643
end_rev_id = rev_id
546
646
initial_revisions.append((rev_id, revno, depth))
548
648
# No merged revisions found
549
if direction == 'reverse':
550
return initial_revisions
551
elif direction == 'forward':
552
return reversed(initial_revisions)
554
raise ValueError('invalid direction %r' % direction)
649
return initial_revisions
555
650
except _StartNotLinearAncestor:
556
651
# A merge was never detected so the lower revision limit can't
557
652
# be nested down somewhere
558
raise errors.BzrCommandError('Start revision not found in'
559
' history of end revision.')
653
raise errors.BzrCommandError(gettext('Start revision not found in'
654
' history of end revision.'))
656
# We exit the loop above because we encounter a revision with merges, from
657
# this revision, we need to switch to _graph_view_revisions.
561
659
# A log including nested merges is required. If the direction is reverse,
562
660
# we rebase the initial merge depths so that the development line is
565
663
# indented at the end seems slightly nicer in that case.
566
664
view_revisions = chain(iter(initial_revisions),
567
665
_graph_view_revisions(branch, start_rev_id, end_rev_id,
568
rebase_initial_depths=direction == 'reverse'))
569
if direction == 'reverse':
570
return view_revisions
571
elif direction == 'forward':
572
# Forward means oldest first, adjusting for depth.
573
view_revisions = reverse_by_depth(list(view_revisions))
574
return _rebase_merge_depth(view_revisions)
576
raise ValueError('invalid direction %r' % direction)
666
rebase_initial_depths=(direction == 'reverse'),
667
exclude_common_ancestry=exclude_common_ancestry))
668
return view_revisions
579
671
def _has_merges(branch, rev_id):
582
674
return len(parents) > 1
677
def _compute_revno_str(branch, rev_id):
678
"""Compute the revno string from a rev_id.
680
:return: The revno string, or None if the revision is not in the supplied
684
revno = branch.revision_id_to_dotted_revno(rev_id)
685
except errors.NoSuchRevision:
686
# The revision must be outside of this branch
689
return '.'.join(str(n) for n in revno)
585
692
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
586
693
"""Is start_rev_id an obvious ancestor of end_rev_id?"""
587
694
if start_rev_id and end_rev_id:
588
start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
589
end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
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
590
701
if len(start_dotted) == 1 and len(end_dotted) == 1:
591
702
# both on mainline
592
703
return start_dotted[0] <= end_dotted[0]
711
# if either start or end is not specified then we use either the first or
712
# the last revision and *they* are obvious ancestors.
603
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
716
def _linear_view_revisions(branch, start_rev_id, end_rev_id,
717
exclude_common_ancestry=False):
604
718
"""Calculate a sequence of revisions to view, newest to oldest.
606
720
:param start_rev_id: the lower revision-id
607
721
:param end_rev_id: the upper revision-id
722
:param exclude_common_ancestry: Whether the start_rev_id should be part of
723
the iterated revisions.
608
724
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
609
725
:raises _StartNotLinearAncestor: if a start_rev_id is specified but
610
is not found walking the left-hand history
726
is not found walking the left-hand history
612
728
br_revno, br_rev_id = branch.last_revision_info()
613
729
repo = branch.repository
730
graph = repo.get_graph()
614
731
if start_rev_id is None and end_rev_id is None:
615
732
cur_revno = br_revno
616
for revision_id in repo.iter_reverse_revision_history(br_rev_id):
733
for revision_id in graph.iter_lefthand_ancestry(br_rev_id,
734
(_mod_revision.NULL_REVISION,)):
617
735
yield revision_id, str(cur_revno), 0
620
738
if end_rev_id is None:
621
739
end_rev_id = br_rev_id
622
740
found_start = start_rev_id is None
623
for revision_id in repo.iter_reverse_revision_history(end_rev_id):
624
revno = branch.revision_id_to_dotted_revno(revision_id)
625
revno_str = '.'.join(str(n) for n in revno)
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)
626
744
if not found_start and revision_id == start_rev_id:
627
yield revision_id, revno_str, 0
745
if not exclude_common_ancestry:
746
yield revision_id, revno_str, 0
628
747
found_start = True
664
788
depth_adjustment = merge_depth
665
789
if depth_adjustment:
666
790
if merge_depth < depth_adjustment:
791
# From now on we reduce the depth adjustement, this can be
792
# surprising for users. The alternative requires two passes
793
# which breaks the fast display of the first revision
667
795
depth_adjustment = merge_depth
668
796
merge_depth -= depth_adjustment
669
797
yield rev_id, '.'.join(map(str, revno)), merge_depth
672
def calculate_view_revisions(branch, start_revision, end_revision, direction,
673
specific_fileid, generate_merge_revisions):
674
"""Calculate the revisions to view.
676
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
677
a list of the same tuples.
679
# This method is no longer called by the main code path.
680
# It is retained for API compatibility and may be deprecated
682
start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
684
view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
685
direction, generate_merge_revisions or specific_fileid))
687
view_revisions = _filter_revisions_touching_file_id(branch,
688
specific_fileid, view_revisions,
689
include_merges=generate_merge_revisions)
690
return _rebase_merge_depth(view_revisions)
693
800
def _rebase_merge_depth(view_revisions):
694
801
"""Adjust depths upwards so the top level is 0."""
695
802
# If either the first or last revision have a merge_depth of 0, we're done
739
846
return log_rev_iterator
742
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
849
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
743
850
"""Create a filtered iterator of log_rev_iterator matching on a regex.
745
852
:param branch: The branch being logged.
746
853
:param generate_delta: Whether to generate a delta for each revision.
747
:param search: A user text search string.
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
748
858
:param log_rev_iterator: An input iterator containing all revisions that
749
859
could be displayed, in lists.
750
860
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
754
864
return log_rev_iterator
755
searchRE = re_compile_checked(search, re.IGNORECASE,
756
'log message filter')
757
return _filter_message_re(searchRE, log_rev_iterator)
760
def _filter_message_re(searchRE, 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)
870
def _filter_re(searchRE, log_rev_iterator):
761
871
for revs in log_rev_iterator:
763
for (rev_id, revno, merge_depth), rev, delta in revs:
764
if searchRE.search(rev.message):
765
new_revs.append(((rev_id, revno, merge_depth), rev, delta))
872
new_revs = [rev for rev in revs if _match_filter(searchRE, rev[1])]
876
def _match_filter(searchRE, rev):
878
'message': (rev.message,),
879
'committer': (rev.committer,),
880
'author': (rev.get_apparent_authors()),
881
'bugs': list(rev.iter_bugs())
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):
890
def _match_any_filter(strings, res):
891
return any([filter(None, map(re.search, strings)) for re in res])
769
893
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
770
894
fileids=None, direction='reverse'):
1004
1127
if ((start_rev_id == _mod_revision.NULL_REVISION)
1005
1128
or (end_rev_id == _mod_revision.NULL_REVISION)):
1006
raise errors.BzrCommandError('Logging revision 0 is invalid.')
1129
raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
1007
1130
if start_revno > end_revno:
1008
raise errors.BzrCommandError("Start revision must be older than "
1009
"the end revision.")
1131
raise errors.BzrCommandError(gettext("Start revision must be older "
1132
"than the end revision."))
1011
1134
if end_revno < start_revno:
1012
1135
return None, None, None, None
1013
1136
cur_revno = branch_revno
1015
1138
mainline_revs = []
1016
for revision_id in branch.repository.iter_reverse_revision_history(
1017
branch_last_revision):
1139
graph = branch.repository.get_graph()
1140
for revision_id in graph.iter_lefthand_ancestry(
1141
branch_last_revision, (_mod_revision.NULL_REVISION,)):
1018
1142
if cur_revno < start_revno:
1019
1143
# We have gone far enough, but we always add 1 more revision
1020
1144
rev_nos[revision_id] = cur_revno
1034
1158
return mainline_revs, rev_nos, start_rev_id, end_rev_id
1037
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
1038
"""Filter view_revisions based on revision ranges.
1040
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1041
tuples to be filtered.
1043
:param start_rev_id: If not NONE specifies the first revision to be logged.
1044
If NONE then all revisions up to the end_rev_id are logged.
1046
:param end_rev_id: If not NONE specifies the last revision to be logged.
1047
If NONE then all revisions up to the end of the log are logged.
1049
:return: The filtered view_revisions.
1051
# This method is no longer called by the main code path.
1052
# It may be removed soon. IGC 20090127
1053
if start_rev_id or end_rev_id:
1054
revision_ids = [r for r, n, d in view_revisions]
1056
start_index = revision_ids.index(start_rev_id)
1059
if start_rev_id == end_rev_id:
1060
end_index = start_index
1063
end_index = revision_ids.index(end_rev_id)
1065
end_index = len(view_revisions) - 1
1066
# To include the revisions merged into the last revision,
1067
# extend end_rev_id down to, but not including, the next rev
1068
# with the same or lesser merge_depth
1069
end_merge_depth = view_revisions[end_index][2]
1071
for index in xrange(end_index+1, len(view_revisions)+1):
1072
if view_revisions[index][2] <= end_merge_depth:
1073
end_index = index - 1
1076
# if the search falls off the end then log to the end as well
1077
end_index = len(view_revisions) - 1
1078
view_revisions = view_revisions[start_index:end_index+1]
1079
return view_revisions
1082
1161
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1083
1162
include_merges=True):
1084
1163
r"""Return the list of revision ids which touch a given file id.
1164
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
1165
include_merges=True):
1166
"""Produce an iterator of revisions to show
1167
:return: an iterator of (revision_id, revno, merge_depth)
1168
(if there is no revno for a revision, None is supplied)
1170
# This method is no longer called by the main code path.
1171
# It is retained for API compatibility and may be deprecated
1172
# soon. IGC 20090127
1173
if not include_merges:
1174
revision_ids = mainline_revs[1:]
1175
if direction == 'reverse':
1176
revision_ids.reverse()
1177
for revision_id in revision_ids:
1178
yield revision_id, str(rev_nos[revision_id]), 0
1180
graph = branch.repository.get_graph()
1181
# This asks for all mainline revisions, which means we only have to spider
1182
# sideways, rather than depth history. That said, its still size-of-history
1183
# and should be addressed.
1184
# mainline_revisions always includes an extra revision at the beginning, so
1186
parent_map = dict(((key, value) for key, value in
1187
graph.iter_ancestry(mainline_revs[1:]) if value is not None))
1188
# filter out ghosts; merge_sort errors on ghosts.
1189
rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
1190
merge_sorted_revisions = tsort.merge_sort(
1194
generate_revno=True)
1196
if direction == 'forward':
1197
# forward means oldest first.
1198
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
1199
elif direction != 'reverse':
1200
raise ValueError('invalid direction %r' % direction)
1202
for (sequence, rev_id, merge_depth, revno, end_of_merge
1203
) in merge_sorted_revisions:
1204
yield rev_id, '.'.join(map(str, revno)), merge_depth
1207
1245
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1208
1246
"""Reverse revisions by depth.
1265
1307
to indicate which LogRevision attributes it supports:
1267
1309
- supports_delta must be True if this log formatter supports delta.
1268
Otherwise the delta attribute may not be populated. The 'delta_format'
1269
attribute describes whether the 'short_status' format (1) or the long
1270
one (2) should be used.
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.
1272
1314
- supports_merge_revisions must be True if this log formatter supports
1273
merge revisions. If not, then only mainline revisions will be passed
1315
merge revisions. If not, then only mainline revisions will be passed
1276
1318
- preferred_levels is the number of levels this formatter defaults to.
1277
The default value is zero meaning display all levels.
1278
This value is only relevant if supports_merge_revisions is True.
1319
The default value is zero meaning display all levels.
1320
This value is only relevant if supports_merge_revisions is True.
1280
1322
- supports_tags must be True if this log formatter supports tags.
1281
Otherwise the tags attribute may not be populated.
1323
Otherwise the tags attribute may not be populated.
1283
1325
- supports_diff must be True if this log formatter supports diffs.
1284
Otherwise the diff attribute may not be populated.
1326
Otherwise the diff attribute may not be populated.
1328
- supports_signatures must be True if this log formatter supports GPG
1286
1331
Plugins can register functions to show custom revision properties using
1287
1332
the properties_handler_registry. The registered function
1288
must respect the following interface description:
1333
must respect the following interface description::
1289
1335
def my_show_properties(properties_dict):
1290
1336
# code that returns a dict {'name':'value'} of the properties
1293
1339
preferred_levels = 0
1295
1341
def __init__(self, to_file, show_ids=False, show_timezone='original',
1296
delta_format=None, levels=None, show_advice=False,
1297
to_exact_file=None):
1342
delta_format=None, levels=None, show_advice=False,
1343
to_exact_file=None, author_list_handler=None):
1298
1344
"""Create a LogFormatter.
1300
1346
:param to_file: the file to output to
1301
:param to_exact_file: if set, gives an output stream to which
1347
:param to_exact_file: if set, gives an output stream to which
1302
1348
non-Unicode diffs are written.
1303
1349
:param show_ids: if True, revision-ids are to be displayed
1304
1350
:param show_timezone: the timezone to use
1367
1416
def short_author(self, rev):
1368
name, address = config.parse_username(rev.get_apparent_authors()[0])
1417
return self.authors(rev, 'first', short=True, sep=', ')
1419
def authors(self, rev, who, short=False, sep=None):
1420
"""Generate list of authors, taking --authors option into account.
1422
The caller has to specify the name of a author list handler,
1423
as provided by the author list registry, using the ``who``
1424
argument. That name only sets a default, though: when the
1425
user selected a different author list generation using the
1426
``--authors`` command line switch, as represented by the
1427
``author_list_handler`` constructor argument, that value takes
1430
:param rev: The revision for which to generate the list of authors.
1431
:param who: Name of the default handler.
1432
:param short: Whether to shorten names to either name or address.
1433
:param sep: What separator to use for automatic concatenation.
1435
if self._author_list_handler is not None:
1436
# The user did specify --authors, which overrides the default
1437
author_list_handler = self._author_list_handler
1439
# The user didn't specify --authors, so we use the caller's default
1440
author_list_handler = author_list_registry.get(who)
1441
names = author_list_handler(rev)
1443
for i in range(len(names)):
1444
name, address = config.parse_username(names[i])
1450
names = sep.join(names)
1373
1453
def merge_marker(self, revision):
1374
1454
"""Get the merge marker to include in the output or '' if none."""
1468
1550
self.merge_marker(revision)))
1469
1551
if revision.tags:
1470
1552
lines.append('tags: %s' % (', '.join(revision.tags)))
1553
if self.show_ids or revision.revno is None:
1472
1554
lines.append('revision-id: %s' % (revision.rev.revision_id,))
1473
1556
for parent_id in revision.rev.parent_ids:
1474
1557
lines.append('parent: %s' % (parent_id,))
1475
1558
lines.extend(self.custom_properties(revision.rev))
1477
1560
committer = revision.rev.committer
1478
authors = revision.rev.get_apparent_authors()
1561
authors = self.authors(revision.rev, 'all')
1479
1562
if authors != [committer]:
1480
1563
lines.append('author: %s' % (", ".join(authors),))
1481
1564
lines.append('committer: %s' % (committer,))
1551
1638
if revision.tags:
1552
1639
tags = ' {%s}' % (', '.join(revision.tags))
1553
1640
to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1554
revision.revno, self.short_author(revision.rev),
1641
revision.revno or "", self.short_author(revision.rev),
1555
1642
format_date(revision.rev.timestamp,
1556
1643
revision.rev.timezone or 0,
1557
1644
self.show_timezone, date_fmt="%Y-%m-%d",
1558
1645
show_offset=False),
1559
1646
tags, self.merge_marker(revision)))
1560
1647
self.show_properties(revision.rev, indent+offset)
1648
if self.show_ids or revision.revno is None:
1562
1649
to_file.write(indent + offset + 'revision-id:%s\n'
1563
1650
% (revision.rev.revision_id,))
1564
1651
if not revision.rev.message:
1615
1705
def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1616
1706
"""Format log info into one string. Truncate tail of string
1617
:param revno: revision number or None.
1618
Revision numbers counts from 1.
1619
:param rev: revision object
1620
:param max_chars: maximum length of resulting string
1621
:param tags: list of tags or None
1622
:param prefix: string to prefix each line
1623
:return: formatted truncated string
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
1627
1718
# show revno only when is not None
1628
1719
out.append("%s:" % revno)
1629
out.append(self.truncate(self.short_author(rev), 20))
1720
if max_chars is not None:
1721
out.append(self.truncate(self.short_author(rev), (max_chars+3)/4))
1723
out.append(self.short_author(rev))
1630
1724
out.append(self.date_string(rev))
1631
1725
if len(rev.parent_ids) > 1:
1632
1726
out.append('[merge]')
1690
1785
return self.get(name)(*args, **kwargs)
1692
1787
def get_default(self, branch):
1693
return self.get(branch.get_config().log_format())
1788
c = branch.get_config_stack()
1789
return self.get(c.get('log_format'))
1696
1792
log_formatter_registry = LogFormatterRegistry()
1699
1795
log_formatter_registry.register('short', ShortLogFormatter,
1700
'Moderately short log format')
1796
'Moderately short log format.')
1701
1797
log_formatter_registry.register('long', LongLogFormatter,
1702
'Detailed log format')
1798
'Detailed log format.')
1703
1799
log_formatter_registry.register('line', LineLogFormatter,
1704
'Log format with one line per revision')
1800
'Log format with one line per revision.')
1705
1801
log_formatter_registry.register('gnu-changelog', GnuChangelogLogFormatter,
1706
'Format used by GNU ChangeLog files')
1802
'Format used by GNU ChangeLog files.')
1709
1805
def register_formatter(name, formatter):
1720
1816
return log_formatter_registry.make_formatter(name, *args, **kwargs)
1721
1817
except KeyError:
1722
raise errors.BzrCommandError("unknown log formatter: %r" % name)
1725
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
1726
# deprecated; for compatibility
1727
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
1728
lf.show(revno, rev, delta)
1818
raise errors.BzrCommandError(gettext("unknown log formatter: %r") % name)
1821
def author_list_all(rev):
1822
return rev.get_apparent_authors()[:]
1825
def author_list_first(rev):
1826
lst = rev.get_apparent_authors()
1833
def author_list_committer(rev):
1834
return [rev.committer]
1837
author_list_registry = registry.Registry()
1839
author_list_registry.register('all', author_list_all,
1842
author_list_registry.register('first', author_list_first,
1845
author_list_registry.register('committer', author_list_committer,
1731
1849
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1888
2007
:param file_list: the list of paths given on the command line;
1889
2008
the first of these can be a branch location or a file path,
1890
2009
the remainder must be file paths
2010
:param add_cleanup: When the branch returned is read locked,
2011
an unlock call will be queued to the cleanup.
1891
2012
:return: (branch, info_list, start_rev_info, end_rev_info) where
1892
2013
info_list is a list of (relative_path, file_id, kind) tuples where
1893
2014
kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
1894
2015
branch will be read-locked.
1896
from builtins import _get_revision_range, safe_relpath_files
1897
tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
2017
from bzrlib.builtins import _get_revision_range
2018
tree, b, path = controldir.ControlDir.open_containing_tree_or_branch(
2020
add_cleanup(b.lock_read().unlock)
1899
2021
# XXX: It's damn messy converting a list of paths to relative paths when
1900
2022
# those paths might be deleted ones, they might be on a case-insensitive
1901
2023
# filesystem and/or they might be in silly locations (like another branch).
added
removed
bzrlib/log.py
