210
215
Logger(branch, rqst).show(lf)
213
# Note: This needs to be kept this in sync with the defaults in
218
# Note: This needs to be kept in sync with the defaults in
214
219
# make_log_request_dict() below
215
220
_DEFAULT_REQUEST_PARAMS = {
216
221
'direction': 'reverse',
218
223
'generate_tags': True,
224
'exclude_common_ancestry': False,
219
225
'_match_using_deltas': True,
223
229
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):
230
start_revision=None, end_revision=None, limit=None,
231
message_search=None, levels=None, generate_tags=True,
233
diff_type=None, _match_using_deltas=True,
234
exclude_common_ancestry=False, match=None,
235
signature=False, omit_merges=False,
227
237
"""Convenience function for making a logging request dictionary.
229
239
Using this function may make code slightly safer by ensuring
267
278
algorithm used for matching specific_fileids. This parameter
268
279
may be removed in the future so bzrlib client code should NOT
282
:param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
283
range operator or as a graph difference.
285
:param signature: show digital signature information
287
:param match: Dictionary of list of search strings to use when filtering
288
revisions. Keys can be 'message', 'author', 'committer', 'bugs' or
289
the empty string to match any of the preceding properties.
291
:param omit_merges: If True, commits with more than one parent are
295
# Take care of old style message_search parameter
298
if 'message' in match:
299
match['message'].append(message_search)
301
match['message'] = [message_search]
303
match={ 'message': [message_search] }
272
305
'direction': direction,
273
306
'specific_fileids': specific_fileids,
274
307
'start_revision': start_revision,
275
308
'end_revision': end_revision,
277
'message_search': message_search,
278
310
'levels': levels,
279
311
'generate_tags': generate_tags,
280
312
'delta_type': delta_type,
281
313
'diff_type': diff_type,
314
'exclude_common_ancestry': exclude_common_ancestry,
315
'signature': signature,
317
'omit_merges': omit_merges,
282
318
# Add 'private' attributes for features that may be deprecated
283
319
'_match_using_deltas': _match_using_deltas,
287
323
def _apply_log_request_defaults(rqst):
288
324
"""Apply default values to a request dictionary."""
289
result = _DEFAULT_REQUEST_PARAMS
325
result = _DEFAULT_REQUEST_PARAMS.copy()
291
327
result.update(rqst)
331
def format_signature_validity(rev_id, repo):
332
"""get the signature validity
334
:param rev_id: revision id to validate
335
:param repo: repository of revision
336
:return: human readable string to print to log
338
from bzrlib import gpg
340
gpg_strategy = gpg.GPGStrategy(None)
341
result = repo.verify_revision(rev_id, gpg_strategy)
342
if result[0] == gpg.SIGNATURE_VALID:
343
return "valid signature from {0}".format(result[1])
344
if result[0] == gpg.SIGNATURE_KEY_MISSING:
345
return "unknown key {0}".format(result[1])
346
if result[0] == gpg.SIGNATURE_NOT_VALID:
347
return "invalid signature!"
348
if result[0] == gpg.SIGNATURE_NOT_SIGNED:
349
return "no signature"
295
352
class LogGenerator(object):
296
353
"""A generator of log revisions."""
342
399
# Tweak the LogRequest based on what the LogFormatter can handle.
343
400
# (There's no point generating stuff if the formatter can't display it.)
345
rqst['levels'] = lf.get_levels()
402
if rqst['levels'] is None or lf.get_levels() > rqst['levels']:
403
# user didn't specify levels, use whatever the LF can handle:
404
rqst['levels'] = lf.get_levels()
346
406
if not getattr(lf, 'supports_tags', False):
347
407
rqst['generate_tags'] = False
348
408
if not getattr(lf, 'supports_delta', False):
349
409
rqst['delta_type'] = None
350
410
if not getattr(lf, 'supports_diff', False):
351
411
rqst['diff_type'] = None
412
if not getattr(lf, 'supports_signatures', False):
413
rqst['signature'] = False
353
415
# Find and print the interesting revisions
354
416
generator = self._generator_factory(self.branch, rqst)
451
523
generate_merge_revisions = rqst.get('levels') != 1
452
524
delayed_graph_generation = not rqst.get('specific_fileids') and (
453
525
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)
526
view_revisions = _calc_view_revisions(
527
self.branch, self.start_rev_id, self.end_rev_id,
528
rqst.get('direction'),
529
generate_merge_revisions=generate_merge_revisions,
530
delayed_graph_generation=delayed_graph_generation,
531
exclude_common_ancestry=rqst.get('exclude_common_ancestry'))
458
533
# Apply the other filters
459
534
return make_log_rev_iterator(self.branch, view_revisions,
460
rqst.get('delta_type'), rqst.get('message_search'),
535
rqst.get('delta_type'), rqst.get('match'),
461
536
file_ids=rqst.get('specific_fileids'),
462
537
direction=rqst.get('direction'))
466
541
# Note that we always generate the merge revisions because
467
542
# 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)
544
view_revisions = _calc_view_revisions(
545
self.branch, self.start_rev_id, self.end_rev_id,
546
rqst.get('direction'), generate_merge_revisions=True,
547
exclude_common_ancestry=rqst.get('exclude_common_ancestry'))
471
548
if not isinstance(view_revisions, list):
472
549
view_revisions = list(view_revisions)
473
550
view_revisions = _filter_revisions_touching_file_id(self.branch,
474
551
rqst.get('specific_fileids')[0], view_revisions,
475
552
include_merges=rqst.get('levels') != 1)
476
553
return make_log_rev_iterator(self.branch, view_revisions,
477
rqst.get('delta_type'), rqst.get('message_search'))
554
rqst.get('delta_type'), rqst.get('match'))
480
557
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
481
generate_merge_revisions, delayed_graph_generation=False):
558
generate_merge_revisions,
559
delayed_graph_generation=False,
560
exclude_common_ancestry=False,
482
562
"""Calculate the revisions to view.
484
564
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
485
565
a list of the same tuples.
567
if (exclude_common_ancestry and start_rev_id == end_rev_id):
568
raise errors.BzrCommandError(gettext(
569
'--exclude-common-ancestry requires two different revisions'))
570
if direction not in ('reverse', 'forward'):
571
raise ValueError(gettext('invalid direction %r') % direction)
487
572
br_revno, br_rev_id = branch.last_revision_info()
488
573
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 ...
498
if not generate_merge_revisions:
499
return _generate_flat_revisions(branch, start_rev_id, end_rev_id,
576
if (end_rev_id and start_rev_id == end_rev_id
577
and (not generate_merge_revisions
578
or not _has_merges(branch, end_rev_id))):
579
# If a single revision is requested, check we can handle it
580
iter_revs = _generate_one_revision(branch, end_rev_id, br_rev_id,
582
elif not generate_merge_revisions:
583
# If we only want to see linear revisions, we can iterate ...
584
iter_revs = _generate_flat_revisions(branch, start_rev_id, end_rev_id,
585
direction, exclude_common_ancestry)
586
if direction == 'forward':
587
iter_revs = reversed(iter_revs)
502
return _generate_all_revisions(branch, start_rev_id, end_rev_id,
503
direction, delayed_graph_generation)
589
iter_revs = _generate_all_revisions(branch, start_rev_id, end_rev_id,
590
direction, delayed_graph_generation,
591
exclude_common_ancestry)
592
if direction == 'forward':
593
iter_revs = _rebase_merge_depth(reverse_by_depth(list(iter_revs)))
506
597
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
509
600
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)
602
revno_str = _compute_revno_str(branch, rev_id)
513
603
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)
606
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction,
607
exclude_common_ancestry=False):
608
result = _linear_view_revisions(
609
branch, start_rev_id, end_rev_id,
610
exclude_common_ancestry=exclude_common_ancestry)
518
611
# If a start limit was given and it's not obviously an
519
612
# ancestor of the end limit, check it before outputting anything
520
613
if direction == 'forward' or (start_rev_id
523
616
result = list(result)
524
617
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)
618
raise errors.BzrCommandError(gettext('Start revision not found in'
619
' left-hand history of end revision.'))
532
623
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
533
delayed_graph_generation):
624
delayed_graph_generation,
625
exclude_common_ancestry=False):
534
626
# On large trees, generating the merge graph can take 30-60 seconds
535
627
# so we delay doing it until a merge is detected, incrementally
536
628
# returning initial (non-merge) revisions while we can.
630
# The above is only true for old formats (<= 0.92), for newer formats, a
631
# couple of seconds only should be needed to load the whole graph and the
632
# other graph operations needed are even faster than that -- vila 100201
537
633
initial_revisions = []
538
634
if delayed_graph_generation:
540
for rev_id, revno, depth in \
541
_linear_view_revisions(branch, start_rev_id, end_rev_id):
636
for rev_id, revno, depth in _linear_view_revisions(
637
branch, start_rev_id, end_rev_id, exclude_common_ancestry):
542
638
if _has_merges(branch, rev_id):
639
# The end_rev_id can be nested down somewhere. We need an
640
# explicit ancestry check. There is an ambiguity here as we
641
# may not raise _StartNotLinearAncestor for a revision that
642
# is an ancestor but not a *linear* one. But since we have
643
# loaded the graph to do the check (or calculate a dotted
644
# revno), we may as well accept to show the log... We need
645
# the check only if start_rev_id is not None as all
646
# revisions have _mod_revision.NULL_REVISION as an ancestor
648
graph = branch.repository.get_graph()
649
if (start_rev_id is not None
650
and not graph.is_ancestor(start_rev_id, end_rev_id)):
651
raise _StartNotLinearAncestor()
652
# Since we collected the revisions so far, we need to
543
654
end_rev_id = rev_id
546
657
initial_revisions.append((rev_id, revno, depth))
548
659
# 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)
660
return initial_revisions
555
661
except _StartNotLinearAncestor:
556
662
# A merge was never detected so the lower revision limit can't
557
663
# be nested down somewhere
558
raise errors.BzrCommandError('Start revision not found in'
559
' history of end revision.')
664
raise errors.BzrCommandError(gettext('Start revision not found in'
665
' history of end revision.'))
667
# We exit the loop above because we encounter a revision with merges, from
668
# this revision, we need to switch to _graph_view_revisions.
561
670
# A log including nested merges is required. If the direction is reverse,
562
671
# we rebase the initial merge depths so that the development line is
565
674
# indented at the end seems slightly nicer in that case.
566
675
view_revisions = chain(iter(initial_revisions),
567
676
_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)
677
rebase_initial_depths=(direction == 'reverse'),
678
exclude_common_ancestry=exclude_common_ancestry))
679
return view_revisions
579
682
def _has_merges(branch, rev_id):
582
685
return len(parents) > 1
688
def _compute_revno_str(branch, rev_id):
689
"""Compute the revno string from a rev_id.
691
:return: The revno string, or None if the revision is not in the supplied
695
revno = branch.revision_id_to_dotted_revno(rev_id)
696
except errors.NoSuchRevision:
697
# The revision must be outside of this branch
700
return '.'.join(str(n) for n in revno)
585
703
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
586
704
"""Is start_rev_id an obvious ancestor of end_rev_id?"""
587
705
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)
707
start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
708
end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
709
except errors.NoSuchRevision:
710
# one or both is not in the branch; not obvious
590
712
if len(start_dotted) == 1 and len(end_dotted) == 1:
591
713
# both on mainline
592
714
return start_dotted[0] <= end_dotted[0]
722
# if either start or end is not specified then we use either the first or
723
# the last revision and *they* are obvious ancestors.
603
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
727
def _linear_view_revisions(branch, start_rev_id, end_rev_id,
728
exclude_common_ancestry=False):
604
729
"""Calculate a sequence of revisions to view, newest to oldest.
606
731
:param start_rev_id: the lower revision-id
607
732
:param end_rev_id: the upper revision-id
733
:param exclude_common_ancestry: Whether the start_rev_id should be part of
734
the iterated revisions.
608
735
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
609
736
:raises _StartNotLinearAncestor: if a start_rev_id is specified but
610
is not found walking the left-hand history
737
is not found walking the left-hand history
612
739
br_revno, br_rev_id = branch.last_revision_info()
613
740
repo = branch.repository
741
graph = repo.get_graph()
614
742
if start_rev_id is None and end_rev_id is None:
615
743
cur_revno = br_revno
616
for revision_id in repo.iter_reverse_revision_history(br_rev_id):
744
for revision_id in graph.iter_lefthand_ancestry(br_rev_id,
745
(_mod_revision.NULL_REVISION,)):
617
746
yield revision_id, str(cur_revno), 0
620
749
if end_rev_id is None:
621
750
end_rev_id = br_rev_id
622
751
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)
752
for revision_id in graph.iter_lefthand_ancestry(end_rev_id,
753
(_mod_revision.NULL_REVISION,)):
754
revno_str = _compute_revno_str(branch, revision_id)
626
755
if not found_start and revision_id == start_rev_id:
627
yield revision_id, revno_str, 0
756
if not exclude_common_ancestry:
757
yield revision_id, revno_str, 0
628
758
found_start = True
664
799
depth_adjustment = merge_depth
665
800
if depth_adjustment:
666
801
if merge_depth < depth_adjustment:
802
# From now on we reduce the depth adjustement, this can be
803
# surprising for users. The alternative requires two passes
804
# which breaks the fast display of the first revision
667
806
depth_adjustment = merge_depth
668
807
merge_depth -= depth_adjustment
669
808
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
811
def _rebase_merge_depth(view_revisions):
694
812
"""Adjust depths upwards so the top level is 0."""
695
813
# If either the first or last revision have a merge_depth of 0, we're done
739
857
return log_rev_iterator
742
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
860
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
743
861
"""Create a filtered iterator of log_rev_iterator matching on a regex.
745
863
:param branch: The branch being logged.
746
864
:param generate_delta: Whether to generate a delta for each revision.
747
:param search: A user text search string.
865
:param match: A dictionary with properties as keys and lists of strings
866
as values. To match, a revision may match any of the supplied strings
867
within a single property but must match at least one string for each
748
869
:param log_rev_iterator: An input iterator containing all revisions that
749
870
could be displayed, in lists.
750
871
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
754
875
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):
876
searchRE = [(k, [re.compile(x, re.IGNORECASE) for x in v])
877
for (k,v) in match.iteritems()]
878
return _filter_re(searchRE, log_rev_iterator)
881
def _filter_re(searchRE, log_rev_iterator):
761
882
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))
883
new_revs = [rev for rev in revs if _match_filter(searchRE, rev[1])]
887
def _match_filter(searchRE, rev):
889
'message': (rev.message,),
890
'committer': (rev.committer,),
891
'author': (rev.get_apparent_authors()),
892
'bugs': list(rev.iter_bugs())
894
strings[''] = [item for inner_list in strings.itervalues()
895
for item in inner_list]
896
for (k,v) in searchRE:
897
if k in strings and not _match_any_filter(strings[k], v):
901
def _match_any_filter(strings, res):
902
return any([filter(None, map(re.search, strings)) for re in res])
769
904
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
770
905
fileids=None, direction='reverse'):
1004
1138
if ((start_rev_id == _mod_revision.NULL_REVISION)
1005
1139
or (end_rev_id == _mod_revision.NULL_REVISION)):
1006
raise errors.BzrCommandError('Logging revision 0 is invalid.')
1140
raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
1007
1141
if start_revno > end_revno:
1008
raise errors.BzrCommandError("Start revision must be older than "
1009
"the end revision.")
1142
raise errors.BzrCommandError(gettext("Start revision must be older "
1143
"than the end revision."))
1011
1145
if end_revno < start_revno:
1012
1146
return None, None, None, None
1013
1147
cur_revno = branch_revno
1015
1149
mainline_revs = []
1016
for revision_id in branch.repository.iter_reverse_revision_history(
1017
branch_last_revision):
1150
graph = branch.repository.get_graph()
1151
for revision_id in graph.iter_lefthand_ancestry(
1152
branch_last_revision, (_mod_revision.NULL_REVISION,)):
1018
1153
if cur_revno < start_revno:
1019
1154
# We have gone far enough, but we always add 1 more revision
1020
1155
rev_nos[revision_id] = cur_revno
1034
1169
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
1172
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1083
1173
include_merges=True):
1084
1174
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
1256
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1208
1257
"""Reverse revisions by depth.
1265
1318
to indicate which LogRevision attributes it supports:
1267
1320
- 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.
1321
Otherwise the delta attribute may not be populated. The 'delta_format'
1322
attribute describes whether the 'short_status' format (1) or the long
1323
one (2) should be used.
1272
1325
- supports_merge_revisions must be True if this log formatter supports
1273
merge revisions. If not, then only mainline revisions will be passed
1326
merge revisions. If not, then only mainline revisions will be passed
1276
1329
- 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.
1330
The default value is zero meaning display all levels.
1331
This value is only relevant if supports_merge_revisions is True.
1280
1333
- supports_tags must be True if this log formatter supports tags.
1281
Otherwise the tags attribute may not be populated.
1334
Otherwise the tags attribute may not be populated.
1283
1336
- supports_diff must be True if this log formatter supports diffs.
1284
Otherwise the diff attribute may not be populated.
1337
Otherwise the diff attribute may not be populated.
1339
- supports_signatures must be True if this log formatter supports GPG
1286
1342
Plugins can register functions to show custom revision properties using
1287
1343
the properties_handler_registry. The registered function
1288
must respect the following interface description:
1344
must respect the following interface description::
1289
1346
def my_show_properties(properties_dict):
1290
1347
# code that returns a dict {'name':'value'} of the properties
1293
1350
preferred_levels = 0
1295
1352
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):
1353
delta_format=None, levels=None, show_advice=False,
1354
to_exact_file=None, author_list_handler=None):
1298
1355
"""Create a LogFormatter.
1300
1357
:param to_file: the file to output to
1301
:param to_exact_file: if set, gives an output stream to which
1358
:param to_exact_file: if set, gives an output stream to which
1302
1359
non-Unicode diffs are written.
1303
1360
:param show_ids: if True, revision-ids are to be displayed
1304
1361
:param show_timezone: the timezone to use
1367
1427
def short_author(self, rev):
1368
name, address = config.parse_username(rev.get_apparent_authors()[0])
1428
return self.authors(rev, 'first', short=True, sep=', ')
1430
def authors(self, rev, who, short=False, sep=None):
1431
"""Generate list of authors, taking --authors option into account.
1433
The caller has to specify the name of a author list handler,
1434
as provided by the author list registry, using the ``who``
1435
argument. That name only sets a default, though: when the
1436
user selected a different author list generation using the
1437
``--authors`` command line switch, as represented by the
1438
``author_list_handler`` constructor argument, that value takes
1441
:param rev: The revision for which to generate the list of authors.
1442
:param who: Name of the default handler.
1443
:param short: Whether to shorten names to either name or address.
1444
:param sep: What separator to use for automatic concatenation.
1446
if self._author_list_handler is not None:
1447
# The user did specify --authors, which overrides the default
1448
author_list_handler = self._author_list_handler
1450
# The user didn't specify --authors, so we use the caller's default
1451
author_list_handler = author_list_registry.get(who)
1452
names = author_list_handler(rev)
1454
for i in range(len(names)):
1455
name, address = config.parse_username(names[i])
1461
names = sep.join(names)
1373
1464
def merge_marker(self, revision):
1374
1465
"""Get the merge marker to include in the output or '' if none."""
1468
1561
self.merge_marker(revision)))
1469
1562
if revision.tags:
1470
1563
lines.append('tags: %s' % (', '.join(revision.tags)))
1564
if self.show_ids or revision.revno is None:
1472
1565
lines.append('revision-id: %s' % (revision.rev.revision_id,))
1473
1567
for parent_id in revision.rev.parent_ids:
1474
1568
lines.append('parent: %s' % (parent_id,))
1475
1569
lines.extend(self.custom_properties(revision.rev))
1477
1571
committer = revision.rev.committer
1478
authors = revision.rev.get_apparent_authors()
1572
authors = self.authors(revision.rev, 'all')
1479
1573
if authors != [committer]:
1480
1574
lines.append('author: %s' % (", ".join(authors),))
1481
1575
lines.append('committer: %s' % (committer,))
1498
1595
to_file = self.to_file
1499
1596
to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
1500
1597
if revision.delta is not None:
1501
# We don't respect delta_format for compatibility
1502
revision.delta.show(to_file, self.show_ids, indent=indent,
1598
# Use the standard status output to display changes
1599
from bzrlib.delta import report_delta
1600
report_delta(to_file, revision.delta, short_status=False,
1601
show_ids=self.show_ids, indent=indent)
1504
1602
if revision.diff is not None:
1505
1603
to_file.write(indent + 'diff:\n')
1506
1604
to_file.flush()
1551
1649
if revision.tags:
1552
1650
tags = ' {%s}' % (', '.join(revision.tags))
1553
1651
to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1554
revision.revno, self.short_author(revision.rev),
1652
revision.revno or "", self.short_author(revision.rev),
1555
1653
format_date(revision.rev.timestamp,
1556
1654
revision.rev.timezone or 0,
1557
1655
self.show_timezone, date_fmt="%Y-%m-%d",
1558
1656
show_offset=False),
1559
1657
tags, self.merge_marker(revision)))
1560
1658
self.show_properties(revision.rev, indent+offset)
1659
if self.show_ids or revision.revno is None:
1562
1660
to_file.write(indent + offset + 'revision-id:%s\n'
1563
1661
% (revision.rev.revision_id,))
1564
1662
if not revision.rev.message:
1569
1667
to_file.write(indent + offset + '%s\n' % (l,))
1571
1669
if revision.delta is not None:
1572
revision.delta.show(to_file, self.show_ids, indent=indent + offset,
1573
short_status=self.delta_format==1)
1670
# Use the standard status output to display changes
1671
from bzrlib.delta import report_delta
1672
report_delta(to_file, revision.delta,
1673
short_status=self.delta_format==1,
1674
show_ids=self.show_ids, indent=indent + offset)
1574
1675
if revision.diff is not None:
1575
1676
self.show_diff(self.to_exact_file, revision.diff, ' ')
1576
1677
to_file.write('\n')
1615
1716
def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1616
1717
"""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
1719
:param revno: revision number or None.
1720
Revision numbers counts from 1.
1721
:param rev: revision object
1722
:param max_chars: maximum length of resulting string
1723
:param tags: list of tags or None
1724
:param prefix: string to prefix each line
1725
:return: formatted truncated string
1627
1729
# show revno only when is not None
1628
1730
out.append("%s:" % revno)
1629
out.append(self.truncate(self.short_author(rev), 20))
1731
if max_chars is not None:
1732
out.append(self.truncate(self.short_author(rev), (max_chars+3)/4))
1734
out.append(self.short_author(rev))
1630
1735
out.append(self.date_string(rev))
1631
1736
if len(rev.parent_ids) > 1:
1632
1737
out.append('[merge]')
1720
1826
return log_formatter_registry.make_formatter(name, *args, **kwargs)
1721
1827
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)
1828
raise errors.BzrCommandError(gettext("unknown log formatter: %r") % name)
1831
def author_list_all(rev):
1832
return rev.get_apparent_authors()[:]
1835
def author_list_first(rev):
1836
lst = rev.get_apparent_authors()
1843
def author_list_committer(rev):
1844
return [rev.committer]
1847
author_list_registry = registry.Registry()
1849
author_list_registry.register('all', author_list_all,
1852
author_list_registry.register('first', author_list_first,
1855
author_list_registry.register('committer', author_list_committer,
1731
1859
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1888
2017
:param file_list: the list of paths given on the command line;
1889
2018
the first of these can be a branch location or a file path,
1890
2019
the remainder must be file paths
2020
:param add_cleanup: When the branch returned is read locked,
2021
an unlock call will be queued to the cleanup.
1891
2022
:return: (branch, info_list, start_rev_info, end_rev_info) where
1892
2023
info_list is a list of (relative_path, file_id, kind) tuples where
1893
2024
kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
1894
2025
branch will be read-locked.
1896
from builtins import _get_revision_range, safe_relpath_files
2027
from builtins import _get_revision_range
1897
2028
tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
2029
add_cleanup(b.lock_read().unlock)
1899
2030
# XXX: It's damn messy converting a list of paths to relative paths when
1900
2031
# those paths might be deleted ones, they might be on a case-insensitive
1901
2032
# filesystem and/or they might be in silly locations (like another branch).
1981
2112
properties_handler_registry = registry.Registry()
2114
# Use the properties handlers to print out bug information if available
2115
def _bugs_properties_handler(revision):
2116
if revision.properties.has_key('bugs'):
2117
bug_lines = revision.properties['bugs'].split('\n')
2118
bug_rows = [line.split(' ', 1) for line in bug_lines]
2119
fixed_bug_urls = [row[0] for row in bug_rows if
2120
len(row) > 1 and row[1] == 'fixed']
2123
return {ngettext('fixes bug', 'fixes bugs', len(fixed_bug_urls)):\
2124
' '.join(fixed_bug_urls)}
2127
properties_handler_registry.register('bugs_properties_handler',
2128
_bugs_properties_handler)
1984
2131
# adapters which revision ids to log are filtered. When log is called, the
1985
2132
# log_rev_iterator is adapted through each of these factory methods.