65
65
lazy_import(globals(), """
67
67
from bzrlib import (
73
73
repository as _mod_repository,
74
74
revision as _mod_revision,
78
from bzrlib.i18n import gettext, ngettext
81
81
from bzrlib import (
84
85
from bzrlib.osutils import (
86
87
format_date_with_offset_in_original_timezone,
88
get_diff_header_encoding,
87
89
get_terminal_encoding,
91
from bzrlib.symbol_versioning import (
97
94
def find_touching_revisions(branch, file_id):
111
for revision_id in branch.revision_history():
108
graph = branch.repository.get_graph()
109
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
110
[_mod_revision.NULL_REVISION]))
111
for revision_id in reversed(history):
112
112
this_inv = branch.repository.get_inventory(revision_id)
113
if file_id in this_inv:
113
if this_inv.has_id(file_id):
114
114
this_ie = this_inv[file_id]
115
115
this_path = this_inv.id2path(file_id)
214
209
Logger(branch, rqst).show(lf)
217
# 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
218
213
# make_log_request_dict() below
219
214
_DEFAULT_REQUEST_PARAMS = {
220
215
'direction': 'reverse',
222
217
'generate_tags': True,
223
218
'exclude_common_ancestry': False,
224
219
'_match_using_deltas': True,
228
223
def make_log_request_dict(direction='reverse', specific_fileids=None,
229
224
start_revision=None, end_revision=None, limit=None,
230
message_search=None, levels=1, generate_tags=True,
225
message_search=None, levels=None, generate_tags=True,
232
227
diff_type=None, _match_using_deltas=True,
233
exclude_common_ancestry=False,
228
exclude_common_ancestry=False, match=None,
229
signature=False, omit_merges=False,
235
231
"""Convenience function for making a logging request dictionary.
257
253
matching commit messages
259
255
:param levels: the number of levels of revisions to
260
generate; 1 for just the mainline; 0 for all levels.
256
generate; 1 for just the mainline; 0 for all levels, or None for
262
259
:param generate_tags: If True, include tags for matched revisions.
264
261
:param delta_type: Either 'full', 'partial' or None.
265
262
'full' means generate the complete delta - adds/deletes/modifies/etc;
266
263
'partial' means filter the delta using specific_fileids;
279
276
:param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
280
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] }
283
299
'direction': direction,
284
300
'specific_fileids': specific_fileids,
285
301
'start_revision': start_revision,
286
302
'end_revision': end_revision,
288
'message_search': message_search,
289
304
'levels': levels,
290
305
'generate_tags': generate_tags,
291
306
'delta_type': delta_type,
292
307
'diff_type': diff_type,
293
308
'exclude_common_ancestry': exclude_common_ancestry,
309
'signature': signature,
311
'omit_merges': omit_merges,
294
312
# Add 'private' attributes for features that may be deprecated
295
313
'_match_using_deltas': _match_using_deltas,
299
317
def _apply_log_request_defaults(rqst):
300
318
"""Apply default values to a request dictionary."""
301
result = _DEFAULT_REQUEST_PARAMS
319
result = _DEFAULT_REQUEST_PARAMS.copy()
303
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"
307
346
class LogGenerator(object):
308
347
"""A generator of log revisions."""
354
393
# Tweak the LogRequest based on what the LogFormatter can handle.
355
394
# (There's no point generating stuff if the formatter can't display it.)
357
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()
358
400
if not getattr(lf, 'supports_tags', False):
359
401
rqst['generate_tags'] = False
360
402
if not getattr(lf, 'supports_delta', False):
361
403
rqst['delta_type'] = None
362
404
if not getattr(lf, 'supports_diff', False):
363
405
rqst['diff_type'] = None
406
if not getattr(lf, 'supports_signatures', False):
407
rqst['signature'] = False
365
409
# Find and print the interesting revisions
366
410
generator = self._generator_factory(self.branch, rqst)
407
453
# 0 levels means show everything; merge_depth counts from 0
408
454
if levels != 0 and merge_depth >= levels:
456
if omit_merges and len(rev.parent_ids) > 1:
410
458
if diff_type is None:
413
461
diff = self._format_diff(rev, rev_id, diff_type)
463
signature = format_signature_validity(rev_id,
464
self.branch.repository)
414
467
yield LogRevision(rev, revno, merge_depth, delta,
415
self.rev_tag_dict.get(rev_id), diff)
468
self.rev_tag_dict.get(rev_id), diff, signature)
418
471
if log_count >= limit:
473
527
# Apply the other filters
474
528
return make_log_rev_iterator(self.branch, view_revisions,
475
rqst.get('delta_type'), rqst.get('message_search'),
529
rqst.get('delta_type'), rqst.get('match'),
476
530
file_ids=rqst.get('specific_fileids'),
477
531
direction=rqst.get('direction'))
491
545
rqst.get('specific_fileids')[0], view_revisions,
492
546
include_merges=rqst.get('levels') != 1)
493
547
return make_log_rev_iterator(self.branch, view_revisions,
494
rqst.get('delta_type'), rqst.get('message_search'))
548
rqst.get('delta_type'), rqst.get('match'))
497
551
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
505
559
a list of the same tuples.
507
561
if (exclude_common_ancestry and start_rev_id == end_rev_id):
508
raise errors.BzrCommandError(
509
'--exclude-common-ancestry requires two different revisions')
562
raise errors.BzrCommandError(gettext(
563
'--exclude-common-ancestry requires two different revisions'))
510
564
if direction not in ('reverse', 'forward'):
511
raise ValueError('invalid direction %r' % direction)
565
raise ValueError(gettext('invalid direction %r') % direction)
512
566
br_revno, br_rev_id = branch.last_revision_info()
513
567
if br_revno == 0:
517
571
and (not generate_merge_revisions
518
572
or not _has_merges(branch, end_rev_id))):
519
573
# 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)))
574
return _generate_one_revision(branch, end_rev_id, br_rev_id,
576
if not generate_merge_revisions:
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)))
540
606
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)
608
revno_str = _compute_revno_str(branch, rev_id)
544
609
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
612
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
562
613
delayed_graph_generation,
563
614
exclude_common_ancestry=False):
572
623
if delayed_graph_generation:
574
625
for rev_id, revno, depth in _linear_view_revisions(
575
branch, start_rev_id, end_rev_id):
626
branch, start_rev_id, end_rev_id, exclude_common_ancestry):
576
627
if _has_merges(branch, rev_id):
577
628
# The end_rev_id can be nested down somewhere. We need an
578
629
# explicit ancestry check. There is an ambiguity here as we
599
650
except _StartNotLinearAncestor:
600
651
# A merge was never detected so the lower revision limit can't
601
652
# be nested down somewhere
602
raise errors.BzrCommandError('Start revision not found in'
603
' history of end revision.')
653
raise errors.BzrCommandError(gettext('Start revision not found in'
654
' history of end revision.'))
605
656
# We exit the loop above because we encounter a revision with merges, from
606
657
# this revision, we need to switch to _graph_view_revisions.
623
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)
626
692
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
627
693
"""Is start_rev_id an obvious ancestor of end_rev_id?"""
628
694
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)
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
631
701
if len(start_dotted) == 1 and len(end_dotted) == 1:
632
702
# both on mainline
633
703
return start_dotted[0] <= end_dotted[0]
646
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):
647
718
"""Calculate a sequence of revisions to view, newest to oldest.
649
720
:param start_rev_id: the lower revision-id
650
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.
651
724
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
652
725
:raises _StartNotLinearAncestor: if a start_rev_id is specified but
653
is not found walking the left-hand history
726
is not found walking the left-hand history
655
728
br_revno, br_rev_id = branch.last_revision_info()
656
729
repo = branch.repository
730
graph = repo.get_graph()
657
731
if start_rev_id is None and end_rev_id is None:
658
732
cur_revno = br_revno
659
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,)):
660
735
yield revision_id, str(cur_revno), 0
663
738
if end_rev_id is None:
664
739
end_rev_id = br_rev_id
665
740
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)
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)
669
744
if not found_start and revision_id == start_rev_id:
670
yield revision_id, revno_str, 0
745
if not exclude_common_ancestry:
746
yield revision_id, revno_str, 0
671
747
found_start = True
721
797
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
800
def _rebase_merge_depth(view_revisions):
744
801
"""Adjust depths upwards so the top level is 0."""
745
802
# If either the first or last revision have a merge_depth of 0, we're done
789
846
return log_rev_iterator
792
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
849
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
793
850
"""Create a filtered iterator of log_rev_iterator matching on a regex.
795
852
:param branch: The branch being logged.
796
853
:param generate_delta: Whether to generate a delta for each revision.
797
: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
798
858
:param log_rev_iterator: An input iterator containing all revisions that
799
859
could be displayed, in lists.
800
860
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
804
864
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):
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):
811
871
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))
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])
819
893
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
820
894
fileids=None, direction='reverse'):
995
1068
if branch_revno != 0:
996
1069
if (start_rev_id == _mod_revision.NULL_REVISION
997
1070
or end_rev_id == _mod_revision.NULL_REVISION):
998
raise errors.BzrCommandError('Logging revision 0 is invalid.')
1071
raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
999
1072
if start_revno > end_revno:
1000
raise errors.BzrCommandError("Start revision must be older than "
1001
"the end revision.")
1073
raise errors.BzrCommandError(gettext("Start revision must be "
1074
"older than the end revision."))
1002
1075
return (start_rev_id, end_rev_id)
1054
1127
if ((start_rev_id == _mod_revision.NULL_REVISION)
1055
1128
or (end_rev_id == _mod_revision.NULL_REVISION)):
1056
raise errors.BzrCommandError('Logging revision 0 is invalid.')
1129
raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
1057
1130
if start_revno > end_revno:
1058
raise errors.BzrCommandError("Start revision must be older than "
1059
"the end revision.")
1131
raise errors.BzrCommandError(gettext("Start revision must be older "
1132
"than the end revision."))
1061
1134
if end_revno < start_revno:
1062
1135
return None, None, None, None
1063
1136
cur_revno = branch_revno
1065
1138
mainline_revs = []
1066
for revision_id in branch.repository.iter_reverse_revision_history(
1067
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,)):
1068
1142
if cur_revno < start_revno:
1069
1143
# We have gone far enough, but we always add 1 more revision
1070
1144
rev_nos[revision_id] = cur_revno
1084
1158
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
1161
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1132
1162
include_merges=True):
1133
1163
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
1245
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1255
1246
"""Reverse revisions by depth.
1293
1284
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1294
tags=None, diff=None):
1285
tags=None, diff=None, signature=None):
1296
self.revno = str(revno)
1290
self.revno = str(revno)
1297
1291
self.merge_depth = merge_depth
1298
1292
self.delta = delta
1299
1293
self.tags = tags
1300
1294
self.diff = diff
1295
self.signature = signature
1303
1298
class LogFormatter(object):
1312
1307
to indicate which LogRevision attributes it supports:
1314
1309
- 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.
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.
1319
1314
- supports_merge_revisions must be True if this log formatter supports
1320
merge revisions. If not, then only mainline revisions will be passed
1315
merge revisions. If not, then only mainline revisions will be passed
1323
1318
- 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.
1319
The default value is zero meaning display all levels.
1320
This value is only relevant if supports_merge_revisions is True.
1327
1322
- supports_tags must be True if this log formatter supports tags.
1328
Otherwise the tags attribute may not be populated.
1323
Otherwise the tags attribute may not be populated.
1330
1325
- supports_diff must be True if this log formatter supports diffs.
1331
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
1333
1331
Plugins can register functions to show custom revision properties using
1334
1332
the properties_handler_registry. The registered function
1335
must respect the following interface description:
1333
must respect the following interface description::
1336
1335
def my_show_properties(properties_dict):
1337
1336
# code that returns a dict {'name':'value'} of the properties
1342
1341
def __init__(self, to_file, show_ids=False, show_timezone='original',
1343
1342
delta_format=None, levels=None, show_advice=False,
1344
to_exact_file=None):
1343
to_exact_file=None, author_list_handler=None):
1345
1344
"""Create a LogFormatter.
1347
1346
:param to_file: the file to output to
1348
: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
1349
1348
non-Unicode diffs are written.
1350
1349
:param show_ids: if True, revision-ids are to be displayed
1351
1350
:param show_timezone: the timezone to use
1414
1416
def short_author(self, rev):
1415
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)
1420
1453
def merge_marker(self, revision):
1421
1454
"""Get the merge marker to include in the output or '' if none."""
1516
1550
self.merge_marker(revision)))
1517
1551
if revision.tags:
1518
1552
lines.append('tags: %s' % (', '.join(revision.tags)))
1553
if self.show_ids or revision.revno is None:
1520
1554
lines.append('revision-id: %s' % (revision.rev.revision_id,))
1521
1556
for parent_id in revision.rev.parent_ids:
1522
1557
lines.append('parent: %s' % (parent_id,))
1523
1558
lines.extend(self.custom_properties(revision.rev))
1525
1560
committer = revision.rev.committer
1526
authors = revision.rev.get_apparent_authors()
1561
authors = self.authors(revision.rev, 'all')
1527
1562
if authors != [committer]:
1528
1563
lines.append('author: %s' % (", ".join(authors),))
1529
1564
lines.append('committer: %s' % (committer,))
1548
1586
if revision.delta is not None:
1549
1587
# Use the standard status output to display changes
1550
1588
from bzrlib.delta import report_delta
1551
report_delta(to_file, revision.delta, short_status=False,
1589
report_delta(to_file, revision.delta, short_status=False,
1552
1590
show_ids=self.show_ids, indent=indent)
1553
1591
if revision.diff is not None:
1554
1592
to_file.write(indent + 'diff:\n')
1600
1638
if revision.tags:
1601
1639
tags = ' {%s}' % (', '.join(revision.tags))
1602
1640
to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1603
revision.revno, self.short_author(revision.rev),
1641
revision.revno or "", self.short_author(revision.rev),
1604
1642
format_date(revision.rev.timestamp,
1605
1643
revision.rev.timezone or 0,
1606
1644
self.show_timezone, date_fmt="%Y-%m-%d",
1607
1645
show_offset=False),
1608
1646
tags, self.merge_marker(revision)))
1609
1647
self.show_properties(revision.rev, indent+offset)
1648
if self.show_ids or revision.revno is None:
1611
1649
to_file.write(indent + offset + 'revision-id:%s\n'
1612
1650
% (revision.rev.revision_id,))
1613
1651
if not revision.rev.message:
1620
1658
if revision.delta is not None:
1621
1659
# Use the standard status output to display changes
1622
1660
from bzrlib.delta import report_delta
1623
report_delta(to_file, revision.delta,
1624
short_status=self.delta_format==1,
1661
report_delta(to_file, revision.delta,
1662
short_status=self.delta_format==1,
1625
1663
show_ids=self.show_ids, indent=indent + offset)
1626
1664
if revision.diff is not None:
1627
1665
self.show_diff(self.to_exact_file, revision.diff, ' ')
1667
1705
def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1668
1706
"""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
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
1679
1718
# show revno only when is not None
1680
1719
out.append("%s:" % revno)
1681
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))
1682
1724
out.append(self.date_string(rev))
1683
1725
if len(rev.parent_ids) > 1:
1684
1726
out.append('[merge]')
1703
1745
self.show_timezone,
1704
1746
date_fmt='%Y-%m-%d',
1705
1747
show_offset=False)
1706
committer_str = revision.rev.get_apparent_authors()[0].replace (' <', ' <')
1748
committer_str = self.authors(revision.rev, 'first', sep=', ')
1749
committer_str = committer_str.replace(' <', ' <')
1707
1750
to_file.write('%s %s\n\n' % (date_str,committer_str))
1709
1752
if revision.delta is not None and revision.delta.has_changed():
1742
1785
return self.get(name)(*args, **kwargs)
1744
1787
def get_default(self, branch):
1745
return self.get(branch.get_config().log_format())
1788
c = branch.get_config_stack()
1789
return self.get(c.get('log_format'))
1748
1792
log_formatter_registry = LogFormatterRegistry()
1751
1795
log_formatter_registry.register('short', ShortLogFormatter,
1752
'Moderately short log format')
1796
'Moderately short log format.')
1753
1797
log_formatter_registry.register('long', LongLogFormatter,
1754
'Detailed log format')
1798
'Detailed log format.')
1755
1799
log_formatter_registry.register('line', LineLogFormatter,
1756
'Log format with one line per revision')
1800
'Log format with one line per revision.')
1757
1801
log_formatter_registry.register('gnu-changelog', GnuChangelogLogFormatter,
1758
'Format used by GNU ChangeLog files')
1802
'Format used by GNU ChangeLog files.')
1761
1805
def register_formatter(name, formatter):
1772
1816
return log_formatter_registry.make_formatter(name, *args, **kwargs)
1773
1817
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)
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,
1783
1849
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1940
2007
:param file_list: the list of paths given on the command line;
1941
2008
the first of these can be a branch location or a file path,
1942
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.
1943
2012
:return: (branch, info_list, start_rev_info, end_rev_info) where
1944
2013
info_list is a list of (relative_path, file_id, kind) tuples where
1945
2014
kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
1946
2015
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])
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)
1951
2021
# XXX: It's damn messy converting a list of paths to relative paths when
1952
2022
# those paths might be deleted ones, they might be on a case-insensitive
1953
2023
# filesystem and/or they might be in silly locations (like another branch).