49
47
all the changes since the previous revision that touched hello.c.
50
from __future__ import absolute_import
53
from cStringIO import StringIO
54
from itertools import (
60
56
from warnings import (
64
from bzrlib.lazy_import import lazy_import
60
from .lazy_import import lazy_import
65
61
lazy_import(globals(), """
73
69
repository as _mod_repository,
74
70
revision as _mod_revision,
74
from breezy.i18n import gettext, ngettext
84
from bzrlib.osutils import (
81
from .osutils import (
86
83
format_date_with_offset_in_original_timezone,
84
get_diff_header_encoding,
87
85
get_terminal_encoding,
91
from bzrlib.symbol_versioning import (
88
from breezy.sixish import (
97
100
def find_touching_revisions(branch, file_id):
98
101
"""Yield a description of revisions which affect the file_id.
111
for revision_id in branch.revision_history():
114
graph = branch.repository.get_graph()
115
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
116
[_mod_revision.NULL_REVISION]))
117
for revision_id in reversed(history):
112
118
this_inv = branch.repository.get_inventory(revision_id)
113
if file_id in this_inv:
119
if this_inv.has_id(file_id):
114
120
this_ie = this_inv[file_id]
115
121
this_path = this_inv.id2path(file_id)
214
215
Logger(branch, rqst).show(lf)
217
# 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
218
219
# make_log_request_dict() below
219
220
_DEFAULT_REQUEST_PARAMS = {
220
221
'direction': 'reverse',
222
223
'generate_tags': True,
223
224
'exclude_common_ancestry': False,
224
225
'_match_using_deltas': True,
228
229
def make_log_request_dict(direction='reverse', specific_fileids=None,
229
230
start_revision=None, end_revision=None, limit=None,
230
message_search=None, levels=1, generate_tags=True,
231
message_search=None, levels=None, generate_tags=True,
232
233
diff_type=None, _match_using_deltas=True,
233
exclude_common_ancestry=False,
234
exclude_common_ancestry=False, match=None,
235
signature=False, omit_merges=False,
235
237
"""Convenience function for making a logging request dictionary.
257
259
matching commit messages
259
261
:param levels: the number of levels of revisions to
260
generate; 1 for just the mainline; 0 for all levels.
262
generate; 1 for just the mainline; 0 for all levels, or None for
262
265
:param generate_tags: If True, include tags for matched revisions.
264
267
:param delta_type: Either 'full', 'partial' or None.
265
268
'full' means generate the complete delta - adds/deletes/modifies/etc;
266
269
'partial' means filter the delta using specific_fileids;
274
277
:param _match_using_deltas: a private parameter controlling the
275
278
algorithm used for matching specific_fileids. This parameter
276
may be removed in the future so bzrlib client code should NOT
279
may be removed in the future so breezy client code should NOT
279
282
:param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
280
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] }
283
305
'direction': direction,
284
306
'specific_fileids': specific_fileids,
285
307
'start_revision': start_revision,
286
308
'end_revision': end_revision,
288
'message_search': message_search,
289
310
'levels': levels,
290
311
'generate_tags': generate_tags,
291
312
'delta_type': delta_type,
292
313
'diff_type': diff_type,
293
314
'exclude_common_ancestry': exclude_common_ancestry,
315
'signature': signature,
317
'omit_merges': omit_merges,
294
318
# Add 'private' attributes for features that may be deprecated
295
319
'_match_using_deltas': _match_using_deltas,
299
323
def _apply_log_request_defaults(rqst):
300
324
"""Apply default values to a request dictionary."""
301
result = _DEFAULT_REQUEST_PARAMS
325
result = _DEFAULT_REQUEST_PARAMS.copy()
303
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 breezy import gpg
340
gpg_strategy = gpg.GPGStrategy(None)
341
result = repo.verify_revision_signature(rev_id, gpg_strategy)
342
if result[0] == gpg.SIGNATURE_VALID:
343
return u"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"
307
352
class LogGenerator(object):
308
353
"""A generator of log revisions."""
354
399
# Tweak the LogRequest based on what the LogFormatter can handle.
355
400
# (There's no point generating stuff if the formatter can't display it.)
357
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()
358
406
if not getattr(lf, 'supports_tags', False):
359
407
rqst['generate_tags'] = False
360
408
if not getattr(lf, 'supports_delta', False):
361
409
rqst['delta_type'] = None
362
410
if not getattr(lf, 'supports_diff', False):
363
411
rqst['diff_type'] = None
412
if not getattr(lf, 'supports_signatures', False):
413
rqst['signature'] = False
365
415
# Find and print the interesting revisions
366
416
generator = self._generator_factory(self.branch, rqst)
407
459
# 0 levels means show everything; merge_depth counts from 0
408
460
if levels != 0 and merge_depth >= levels:
462
if omit_merges and len(rev.parent_ids) > 1:
410
464
if diff_type is None:
413
467
diff = self._format_diff(rev, rev_id, diff_type)
469
signature = format_signature_validity(rev_id,
470
self.branch.repository)
414
473
yield LogRevision(rev, revno, merge_depth, delta,
415
self.rev_tag_dict.get(rev_id), diff)
474
self.rev_tag_dict.get(rev_id), diff, signature)
418
477
if log_count >= limit:
473
533
# Apply the other filters
474
534
return make_log_rev_iterator(self.branch, view_revisions,
475
rqst.get('delta_type'), rqst.get('message_search'),
535
rqst.get('delta_type'), rqst.get('match'),
476
536
file_ids=rqst.get('specific_fileids'),
477
537
direction=rqst.get('direction'))
491
551
rqst.get('specific_fileids')[0], view_revisions,
492
552
include_merges=rqst.get('levels') != 1)
493
553
return make_log_rev_iterator(self.branch, view_revisions,
494
rqst.get('delta_type'), rqst.get('message_search'))
554
rqst.get('delta_type'), rqst.get('match'))
497
557
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
505
565
a list of the same tuples.
507
567
if (exclude_common_ancestry and start_rev_id == end_rev_id):
508
raise errors.BzrCommandError(
509
'--exclude-common-ancestry requires two different revisions')
568
raise errors.BzrCommandError(gettext(
569
'--exclude-common-ancestry requires two different revisions'))
510
570
if direction not in ('reverse', 'forward'):
511
raise ValueError('invalid direction %r' % direction)
571
raise ValueError(gettext('invalid direction %r') % direction)
512
572
br_revno, br_rev_id = branch.last_revision_info()
513
573
if br_revno == 0:
517
577
and (not generate_merge_revisions
518
578
or not _has_merges(branch, end_rev_id))):
519
579
# If a single revision is requested, check we can handle it
520
iter_revs = _generate_one_revision(branch, end_rev_id, br_rev_id,
522
elif not generate_merge_revisions:
523
# If we only want to see linear revisions, we can iterate ...
524
iter_revs = _generate_flat_revisions(branch, start_rev_id, end_rev_id,
526
if direction == 'forward':
527
iter_revs = reversed(iter_revs)
529
iter_revs = _generate_all_revisions(branch, start_rev_id, end_rev_id,
530
direction, delayed_graph_generation,
531
exclude_common_ancestry)
532
if direction == 'forward':
533
iter_revs = _rebase_merge_depth(reverse_by_depth(list(iter_revs)))
580
return _generate_one_revision(branch, end_rev_id, br_rev_id,
582
if not generate_merge_revisions:
584
# If we only want to see linear revisions, we can iterate ...
585
iter_revs = _linear_view_revisions(
586
branch, start_rev_id, end_rev_id,
587
exclude_common_ancestry=exclude_common_ancestry)
588
# If a start limit was given and it's not obviously an
589
# ancestor of the end limit, check it before outputting anything
590
if (direction == 'forward'
591
or (start_rev_id and not _is_obvious_ancestor(
592
branch, start_rev_id, end_rev_id))):
593
iter_revs = list(iter_revs)
594
if direction == 'forward':
595
iter_revs = reversed(iter_revs)
597
except _StartNotLinearAncestor:
598
# Switch to the slower implementation that may be able to find a
599
# non-obvious ancestor out of the left-hand history.
601
iter_revs = _generate_all_revisions(branch, start_rev_id, end_rev_id,
602
direction, delayed_graph_generation,
603
exclude_common_ancestry)
604
if direction == 'forward':
605
iter_revs = _rebase_merge_depth(reverse_by_depth(list(iter_revs)))
540
612
return [(br_rev_id, br_revno, 0)]
542
revno = branch.revision_id_to_dotted_revno(rev_id)
543
revno_str = '.'.join(str(n) for n in revno)
614
revno_str = _compute_revno_str(branch, rev_id)
544
615
return [(rev_id, revno_str, 0)]
547
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction):
548
result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
549
# If a start limit was given and it's not obviously an
550
# ancestor of the end limit, check it before outputting anything
551
if direction == 'forward' or (start_rev_id
552
and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
554
result = list(result)
555
except _StartNotLinearAncestor:
556
raise errors.BzrCommandError('Start revision not found in'
557
' left-hand history of end revision.')
561
618
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
562
619
delayed_graph_generation,
563
620
exclude_common_ancestry=False):
572
629
if delayed_graph_generation:
574
631
for rev_id, revno, depth in _linear_view_revisions(
575
branch, start_rev_id, end_rev_id):
632
branch, start_rev_id, end_rev_id, exclude_common_ancestry):
576
633
if _has_merges(branch, rev_id):
577
634
# The end_rev_id can be nested down somewhere. We need an
578
635
# explicit ancestry check. There is an ambiguity here as we
599
656
except _StartNotLinearAncestor:
600
657
# A merge was never detected so the lower revision limit can't
601
658
# be nested down somewhere
602
raise errors.BzrCommandError('Start revision not found in'
603
' history of end revision.')
659
raise errors.BzrCommandError(gettext('Start revision not found in'
660
' history of end revision.'))
605
662
# We exit the loop above because we encounter a revision with merges, from
606
663
# this revision, we need to switch to _graph_view_revisions.
610
667
# shown naturally, i.e. just like it is for linear logging. We can easily
611
668
# make forward the exact opposite display, but showing the merge revisions
612
669
# indented at the end seems slightly nicer in that case.
613
view_revisions = chain(iter(initial_revisions),
670
view_revisions = itertools.chain(iter(initial_revisions),
614
671
_graph_view_revisions(branch, start_rev_id, end_rev_id,
615
672
rebase_initial_depths=(direction == 'reverse'),
616
673
exclude_common_ancestry=exclude_common_ancestry))
623
680
return len(parents) > 1
683
def _compute_revno_str(branch, rev_id):
684
"""Compute the revno string from a rev_id.
686
:return: The revno string, or None if the revision is not in the supplied
690
revno = branch.revision_id_to_dotted_revno(rev_id)
691
except errors.NoSuchRevision:
692
# The revision must be outside of this branch
695
return '.'.join(str(n) for n in revno)
626
698
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
627
699
"""Is start_rev_id an obvious ancestor of end_rev_id?"""
628
700
if start_rev_id and end_rev_id:
629
start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
630
end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
702
start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
703
end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
704
except errors.NoSuchRevision:
705
# one or both is not in the branch; not obvious
631
707
if len(start_dotted) == 1 and len(end_dotted) == 1:
632
708
# both on mainline
633
709
return start_dotted[0] <= end_dotted[0]
646
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
722
def _linear_view_revisions(branch, start_rev_id, end_rev_id,
723
exclude_common_ancestry=False):
647
724
"""Calculate a sequence of revisions to view, newest to oldest.
649
726
:param start_rev_id: the lower revision-id
650
727
:param end_rev_id: the upper revision-id
728
:param exclude_common_ancestry: Whether the start_rev_id should be part of
729
the iterated revisions.
651
730
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
652
731
:raises _StartNotLinearAncestor: if a start_rev_id is specified but
653
is not found walking the left-hand history
732
is not found walking the left-hand history
655
734
br_revno, br_rev_id = branch.last_revision_info()
656
735
repo = branch.repository
736
graph = repo.get_graph()
657
737
if start_rev_id is None and end_rev_id is None:
658
738
cur_revno = br_revno
659
for revision_id in repo.iter_reverse_revision_history(br_rev_id):
739
for revision_id in graph.iter_lefthand_ancestry(br_rev_id,
740
(_mod_revision.NULL_REVISION,)):
660
741
yield revision_id, str(cur_revno), 0
663
744
if end_rev_id is None:
664
745
end_rev_id = br_rev_id
665
746
found_start = start_rev_id is None
666
for revision_id in repo.iter_reverse_revision_history(end_rev_id):
667
revno = branch.revision_id_to_dotted_revno(revision_id)
668
revno_str = '.'.join(str(n) for n in revno)
747
for revision_id in graph.iter_lefthand_ancestry(end_rev_id,
748
(_mod_revision.NULL_REVISION,)):
749
revno_str = _compute_revno_str(branch, revision_id)
669
750
if not found_start and revision_id == start_rev_id:
670
yield revision_id, revno_str, 0
751
if not exclude_common_ancestry:
752
yield revision_id, revno_str, 0
671
753
found_start = True
721
803
yield rev_id, '.'.join(map(str, revno)), merge_depth
724
@deprecated_function(deprecated_in((2, 2, 0)))
725
def calculate_view_revisions(branch, start_revision, end_revision, direction,
726
specific_fileid, generate_merge_revisions):
727
"""Calculate the revisions to view.
729
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
730
a list of the same tuples.
732
start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
734
view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
735
direction, generate_merge_revisions or specific_fileid))
737
view_revisions = _filter_revisions_touching_file_id(branch,
738
specific_fileid, view_revisions,
739
include_merges=generate_merge_revisions)
740
return _rebase_merge_depth(view_revisions)
743
806
def _rebase_merge_depth(view_revisions):
744
807
"""Adjust depths upwards so the top level is 0."""
745
808
# If either the first or last revision have a merge_depth of 0, we're done
768
831
# Convert view_revisions into (view, None, None) groups to fit with
769
832
# the standard interface here.
770
if type(view_revisions) == list:
833
if isinstance(view_revisions, list):
771
834
# A single batch conversion is faster than many incremental ones.
772
835
# As we have all the data, do a batch conversion.
773
836
nones = [None] * len(view_revisions)
789
852
return log_rev_iterator
792
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
855
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
793
856
"""Create a filtered iterator of log_rev_iterator matching on a regex.
795
858
:param branch: The branch being logged.
796
859
:param generate_delta: Whether to generate a delta for each revision.
797
:param search: A user text search string.
860
:param match: A dictionary with properties as keys and lists of strings
861
as values. To match, a revision may match any of the supplied strings
862
within a single property but must match at least one string for each
798
864
:param log_rev_iterator: An input iterator containing all revisions that
799
865
could be displayed, in lists.
800
866
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
804
870
return log_rev_iterator
805
searchRE = re_compile_checked(search, re.IGNORECASE,
806
'log message filter')
807
return _filter_message_re(searchRE, log_rev_iterator)
810
def _filter_message_re(searchRE, log_rev_iterator):
871
searchRE = [(k, [re.compile(x, re.IGNORECASE) for x in v])
872
for (k,v) in match.iteritems()]
873
return _filter_re(searchRE, log_rev_iterator)
876
def _filter_re(searchRE, log_rev_iterator):
811
877
for revs in log_rev_iterator:
813
for (rev_id, revno, merge_depth), rev, delta in revs:
814
if searchRE.search(rev.message):
815
new_revs.append(((rev_id, revno, merge_depth), rev, delta))
878
new_revs = [rev for rev in revs if _match_filter(searchRE, rev[1])]
882
def _match_filter(searchRE, rev):
884
'message': (rev.message,),
885
'committer': (rev.committer,),
886
'author': (rev.get_apparent_authors()),
887
'bugs': list(rev.iter_bugs())
889
strings[''] = [item for inner_list in strings.itervalues()
890
for item in inner_list]
891
for (k,v) in searchRE:
892
if k in strings and not _match_any_filter(strings[k], v):
896
def _match_any_filter(strings, res):
897
return any([filter(None, map(re.search, strings)) for re in res])
819
899
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
820
900
fileids=None, direction='reverse'):
995
1074
if branch_revno != 0:
996
1075
if (start_rev_id == _mod_revision.NULL_REVISION
997
1076
or end_rev_id == _mod_revision.NULL_REVISION):
998
raise errors.BzrCommandError('Logging revision 0 is invalid.')
1077
raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
999
1078
if start_revno > end_revno:
1000
raise errors.BzrCommandError("Start revision must be older than "
1001
"the end revision.")
1079
raise errors.BzrCommandError(gettext("Start revision must be "
1080
"older than the end revision."))
1002
1081
return (start_rev_id, end_rev_id)
1054
1133
if ((start_rev_id == _mod_revision.NULL_REVISION)
1055
1134
or (end_rev_id == _mod_revision.NULL_REVISION)):
1056
raise errors.BzrCommandError('Logging revision 0 is invalid.')
1135
raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
1057
1136
if start_revno > end_revno:
1058
raise errors.BzrCommandError("Start revision must be older than "
1059
"the end revision.")
1137
raise errors.BzrCommandError(gettext("Start revision must be older "
1138
"than the end revision."))
1061
1140
if end_revno < start_revno:
1062
1141
return None, None, None, None
1063
1142
cur_revno = branch_revno
1065
1144
mainline_revs = []
1066
for revision_id in branch.repository.iter_reverse_revision_history(
1067
branch_last_revision):
1145
graph = branch.repository.get_graph()
1146
for revision_id in graph.iter_lefthand_ancestry(
1147
branch_last_revision, (_mod_revision.NULL_REVISION,)):
1068
1148
if cur_revno < start_revno:
1069
1149
# We have gone far enough, but we always add 1 more revision
1070
1150
rev_nos[revision_id] = cur_revno
1084
1164
return mainline_revs, rev_nos, start_rev_id, end_rev_id
1087
@deprecated_function(deprecated_in((2, 2, 0)))
1088
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
1089
"""Filter view_revisions based on revision ranges.
1091
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1092
tuples to be filtered.
1094
:param start_rev_id: If not NONE specifies the first revision to be logged.
1095
If NONE then all revisions up to the end_rev_id are logged.
1097
:param end_rev_id: If not NONE specifies the last revision to be logged.
1098
If NONE then all revisions up to the end of the log are logged.
1100
:return: The filtered view_revisions.
1102
if start_rev_id or end_rev_id:
1103
revision_ids = [r for r, n, d in view_revisions]
1105
start_index = revision_ids.index(start_rev_id)
1108
if start_rev_id == end_rev_id:
1109
end_index = start_index
1112
end_index = revision_ids.index(end_rev_id)
1114
end_index = len(view_revisions) - 1
1115
# To include the revisions merged into the last revision,
1116
# extend end_rev_id down to, but not including, the next rev
1117
# with the same or lesser merge_depth
1118
end_merge_depth = view_revisions[end_index][2]
1120
for index in xrange(end_index+1, len(view_revisions)+1):
1121
if view_revisions[index][2] <= end_merge_depth:
1122
end_index = index - 1
1125
# if the search falls off the end then log to the end as well
1126
end_index = len(view_revisions) - 1
1127
view_revisions = view_revisions[start_index:end_index+1]
1128
return view_revisions
1131
1167
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1132
1168
include_merges=True):
1133
1169
r"""Return the list of revision ids which touch a given file id.
1213
@deprecated_function(deprecated_in((2, 2, 0)))
1214
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
1215
include_merges=True):
1216
"""Produce an iterator of revisions to show
1217
:return: an iterator of (revision_id, revno, merge_depth)
1218
(if there is no revno for a revision, None is supplied)
1220
if not include_merges:
1221
revision_ids = mainline_revs[1:]
1222
if direction == 'reverse':
1223
revision_ids.reverse()
1224
for revision_id in revision_ids:
1225
yield revision_id, str(rev_nos[revision_id]), 0
1227
graph = branch.repository.get_graph()
1228
# This asks for all mainline revisions, which means we only have to spider
1229
# sideways, rather than depth history. That said, its still size-of-history
1230
# and should be addressed.
1231
# mainline_revisions always includes an extra revision at the beginning, so
1233
parent_map = dict(((key, value) for key, value in
1234
graph.iter_ancestry(mainline_revs[1:]) if value is not None))
1235
# filter out ghosts; merge_sort errors on ghosts.
1236
rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
1237
merge_sorted_revisions = tsort.merge_sort(
1241
generate_revno=True)
1243
if direction == 'forward':
1244
# forward means oldest first.
1245
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
1246
elif direction != 'reverse':
1247
raise ValueError('invalid direction %r' % direction)
1249
for (sequence, rev_id, merge_depth, revno, end_of_merge
1250
) in merge_sorted_revisions:
1251
yield rev_id, '.'.join(map(str, revno)), merge_depth
1254
1251
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1255
1252
"""Reverse revisions by depth.
1293
1290
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1294
tags=None, diff=None):
1291
tags=None, diff=None, signature=None):
1296
self.revno = str(revno)
1296
self.revno = str(revno)
1297
1297
self.merge_depth = merge_depth
1298
1298
self.delta = delta
1299
1299
self.tags = tags
1300
1300
self.diff = diff
1301
self.signature = signature
1303
1304
class LogFormatter(object):
1312
1313
to indicate which LogRevision attributes it supports:
1314
1315
- supports_delta must be True if this log formatter supports delta.
1315
Otherwise the delta attribute may not be populated. The 'delta_format'
1316
attribute describes whether the 'short_status' format (1) or the long
1317
one (2) should be used.
1316
Otherwise the delta attribute may not be populated. The 'delta_format'
1317
attribute describes whether the 'short_status' format (1) or the long
1318
one (2) should be used.
1319
1320
- supports_merge_revisions must be True if this log formatter supports
1320
merge revisions. If not, then only mainline revisions will be passed
1321
merge revisions. If not, then only mainline revisions will be passed
1323
1324
- preferred_levels is the number of levels this formatter defaults to.
1324
The default value is zero meaning display all levels.
1325
This value is only relevant if supports_merge_revisions is True.
1325
The default value is zero meaning display all levels.
1326
This value is only relevant if supports_merge_revisions is True.
1327
1328
- supports_tags must be True if this log formatter supports tags.
1328
Otherwise the tags attribute may not be populated.
1329
Otherwise the tags attribute may not be populated.
1330
1331
- supports_diff must be True if this log formatter supports diffs.
1331
Otherwise the diff attribute may not be populated.
1332
Otherwise the diff attribute may not be populated.
1334
- supports_signatures must be True if this log formatter supports GPG
1333
1337
Plugins can register functions to show custom revision properties using
1334
1338
the properties_handler_registry. The registered function
1335
must respect the following interface description:
1339
must respect the following interface description::
1336
1341
def my_show_properties(properties_dict):
1337
1342
# code that returns a dict {'name':'value'} of the properties
1342
1347
def __init__(self, to_file, show_ids=False, show_timezone='original',
1343
1348
delta_format=None, levels=None, show_advice=False,
1344
to_exact_file=None):
1349
to_exact_file=None, author_list_handler=None):
1345
1350
"""Create a LogFormatter.
1347
1352
:param to_file: the file to output to
1348
:param to_exact_file: if set, gives an output stream to which
1353
:param to_exact_file: if set, gives an output stream to which
1349
1354
non-Unicode diffs are written.
1350
1355
:param show_ids: if True, revision-ids are to be displayed
1351
1356
:param show_timezone: the timezone to use
1414
1422
def short_author(self, rev):
1415
name, address = config.parse_username(rev.get_apparent_authors()[0])
1423
return self.authors(rev, 'first', short=True, sep=', ')
1425
def authors(self, rev, who, short=False, sep=None):
1426
"""Generate list of authors, taking --authors option into account.
1428
The caller has to specify the name of a author list handler,
1429
as provided by the author list registry, using the ``who``
1430
argument. That name only sets a default, though: when the
1431
user selected a different author list generation using the
1432
``--authors`` command line switch, as represented by the
1433
``author_list_handler`` constructor argument, that value takes
1436
:param rev: The revision for which to generate the list of authors.
1437
:param who: Name of the default handler.
1438
:param short: Whether to shorten names to either name or address.
1439
:param sep: What separator to use for automatic concatenation.
1441
if self._author_list_handler is not None:
1442
# The user did specify --authors, which overrides the default
1443
author_list_handler = self._author_list_handler
1445
# The user didn't specify --authors, so we use the caller's default
1446
author_list_handler = author_list_registry.get(who)
1447
names = author_list_handler(rev)
1449
for i in range(len(names)):
1450
name, address = config.parse_username(names[i])
1456
names = sep.join(names)
1420
1459
def merge_marker(self, revision):
1421
1460
"""Get the merge marker to include in the output or '' if none."""
1516
1556
self.merge_marker(revision)))
1517
1557
if revision.tags:
1518
1558
lines.append('tags: %s' % (', '.join(revision.tags)))
1559
if self.show_ids or revision.revno is None:
1520
1560
lines.append('revision-id: %s' % (revision.rev.revision_id,))
1521
1562
for parent_id in revision.rev.parent_ids:
1522
1563
lines.append('parent: %s' % (parent_id,))
1523
1564
lines.extend(self.custom_properties(revision.rev))
1525
1566
committer = revision.rev.committer
1526
authors = revision.rev.get_apparent_authors()
1567
authors = self.authors(revision.rev, 'all')
1527
1568
if authors != [committer]:
1528
1569
lines.append('author: %s' % (", ".join(authors),))
1529
1570
lines.append('committer: %s' % (committer,))
1547
1591
to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
1548
1592
if revision.delta is not None:
1549
1593
# Use the standard status output to display changes
1550
from bzrlib.delta import report_delta
1551
report_delta(to_file, revision.delta, short_status=False,
1594
from breezy.delta import report_delta
1595
report_delta(to_file, revision.delta, short_status=False,
1552
1596
show_ids=self.show_ids, indent=indent)
1553
1597
if revision.diff is not None:
1554
1598
to_file.write(indent + 'diff:\n')
1600
1644
if revision.tags:
1601
1645
tags = ' {%s}' % (', '.join(revision.tags))
1602
1646
to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1603
revision.revno, self.short_author(revision.rev),
1647
revision.revno or "", self.short_author(revision.rev),
1604
1648
format_date(revision.rev.timestamp,
1605
1649
revision.rev.timezone or 0,
1606
1650
self.show_timezone, date_fmt="%Y-%m-%d",
1607
1651
show_offset=False),
1608
1652
tags, self.merge_marker(revision)))
1609
1653
self.show_properties(revision.rev, indent+offset)
1654
if self.show_ids or revision.revno is None:
1611
1655
to_file.write(indent + offset + 'revision-id:%s\n'
1612
1656
% (revision.rev.revision_id,))
1613
1657
if not revision.rev.message:
1620
1664
if revision.delta is not None:
1621
1665
# Use the standard status output to display changes
1622
from bzrlib.delta import report_delta
1623
report_delta(to_file, revision.delta,
1624
short_status=self.delta_format==1,
1666
from breezy.delta import report_delta
1667
report_delta(to_file, revision.delta,
1668
short_status=self.delta_format==1,
1625
1669
show_ids=self.show_ids, indent=indent + offset)
1626
1670
if revision.diff is not None:
1627
1671
self.show_diff(self.to_exact_file, revision.diff, ' ')
1667
1711
def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1668
1712
"""Format log info into one string. Truncate tail of string
1669
:param revno: revision number or None.
1670
Revision numbers counts from 1.
1671
:param rev: revision object
1672
:param max_chars: maximum length of resulting string
1673
:param tags: list of tags or None
1674
:param prefix: string to prefix each line
1675
:return: formatted truncated string
1714
:param revno: revision number or None.
1715
Revision numbers counts from 1.
1716
:param rev: revision object
1717
:param max_chars: maximum length of resulting string
1718
:param tags: list of tags or None
1719
:param prefix: string to prefix each line
1720
:return: formatted truncated string
1679
1724
# show revno only when is not None
1680
1725
out.append("%s:" % revno)
1681
out.append(self.truncate(self.short_author(rev), 20))
1726
if max_chars is not None:
1727
out.append(self.truncate(self.short_author(rev), (max_chars+3)/4))
1729
out.append(self.short_author(rev))
1682
1730
out.append(self.date_string(rev))
1683
1731
if len(rev.parent_ids) > 1:
1684
1732
out.append('[merge]')
1703
1751
self.show_timezone,
1704
1752
date_fmt='%Y-%m-%d',
1705
1753
show_offset=False)
1706
committer_str = revision.rev.get_apparent_authors()[0].replace (' <', ' <')
1754
committer_str = self.authors(revision.rev, 'first', sep=', ')
1755
committer_str = committer_str.replace(' <', ' <')
1707
1756
to_file.write('%s %s\n\n' % (date_str,committer_str))
1709
1758
if revision.delta is not None and revision.delta.has_changed():
1742
1791
return self.get(name)(*args, **kwargs)
1744
1793
def get_default(self, branch):
1745
return self.get(branch.get_config().log_format())
1794
c = branch.get_config_stack()
1795
return self.get(c.get('log_format'))
1748
1798
log_formatter_registry = LogFormatterRegistry()
1751
1801
log_formatter_registry.register('short', ShortLogFormatter,
1752
'Moderately short log format')
1802
'Moderately short log format.')
1753
1803
log_formatter_registry.register('long', LongLogFormatter,
1754
'Detailed log format')
1804
'Detailed log format.')
1755
1805
log_formatter_registry.register('line', LineLogFormatter,
1756
'Log format with one line per revision')
1806
'Log format with one line per revision.')
1757
1807
log_formatter_registry.register('gnu-changelog', GnuChangelogLogFormatter,
1758
'Format used by GNU ChangeLog files')
1808
'Format used by GNU ChangeLog files.')
1761
1811
def register_formatter(name, formatter):
1772
1822
return log_formatter_registry.make_formatter(name, *args, **kwargs)
1773
1823
except KeyError:
1774
raise errors.BzrCommandError("unknown log formatter: %r" % name)
1777
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
1778
# deprecated; for compatibility
1779
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
1780
lf.show(revno, rev, delta)
1824
raise errors.BzrCommandError(gettext("unknown log formatter: %r") % name)
1827
def author_list_all(rev):
1828
return rev.get_apparent_authors()[:]
1831
def author_list_first(rev):
1832
lst = rev.get_apparent_authors()
1839
def author_list_committer(rev):
1840
return [rev.committer]
1843
author_list_registry = registry.Registry()
1845
author_list_registry.register('all', author_list_all,
1848
author_list_registry.register('first', author_list_first,
1851
author_list_registry.register('committer', author_list_committer,
1783
1855
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1940
2013
:param file_list: the list of paths given on the command line;
1941
2014
the first of these can be a branch location or a file path,
1942
2015
the remainder must be file paths
2016
:param add_cleanup: When the branch returned is read locked,
2017
an unlock call will be queued to the cleanup.
1943
2018
:return: (branch, info_list, start_rev_info, end_rev_info) where
1944
2019
info_list is a list of (relative_path, file_id, kind) tuples where
1945
2020
kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
1946
2021
branch will be read-locked.
1948
from builtins import _get_revision_range, safe_relpath_files
1949
tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
2023
from breezy.builtins import _get_revision_range
2024
tree, b, path = controldir.ControlDir.open_containing_tree_or_branch(
2026
add_cleanup(b.lock_read().unlock)
1951
2027
# XXX: It's damn messy converting a list of paths to relative paths when
1952
2028
# those paths might be deleted ones, they might be on a case-insensitive
1953
2029
# filesystem and/or they might be in silly locations (like another branch).
2035
2111
# Use the properties handlers to print out bug information if available
2036
2112
def _bugs_properties_handler(revision):
2037
if revision.properties.has_key('bugs'):
2113
if 'bugs' in revision.properties:
2038
2114
bug_lines = revision.properties['bugs'].split('\n')
2039
2115
bug_rows = [line.split(' ', 1) for line in bug_lines]
2040
2116
fixed_bug_urls = [row[0] for row in bug_rows if
2041
2117
len(row) > 1 and row[1] == 'fixed']
2043
2119
if fixed_bug_urls:
2044
return {'fixes bug(s)': ' '.join(fixed_bug_urls)}
2120
return {ngettext('fixes bug', 'fixes bugs', len(fixed_bug_urls)):\
2121
' '.join(fixed_bug_urls)}
2047
2124
properties_handler_registry.register('bugs_properties_handler',