213
215
Logger(branch, rqst).show(lf)
216
# 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
217
219
# make_log_request_dict() below
218
220
_DEFAULT_REQUEST_PARAMS = {
219
221
'direction': 'reverse',
221
223
'generate_tags': True,
222
224
'exclude_common_ancestry': False,
223
225
'_match_using_deltas': True,
227
229
def make_log_request_dict(direction='reverse', specific_fileids=None,
228
230
start_revision=None, end_revision=None, limit=None,
229
message_search=None, levels=1, generate_tags=True,
231
message_search=None, levels=None, generate_tags=True,
231
233
diff_type=None, _match_using_deltas=True,
232
exclude_common_ancestry=False,
234
exclude_common_ancestry=False, match=None,
235
signature=False, omit_merges=False,
234
237
"""Convenience function for making a logging request dictionary.
256
259
matching commit messages
258
261
:param levels: the number of levels of revisions to
259
generate; 1 for just the mainline; 0 for all levels.
262
generate; 1 for just the mainline; 0 for all levels, or None for
261
265
:param generate_tags: If True, include tags for matched revisions.
263
267
:param delta_type: Either 'full', 'partial' or None.
264
268
'full' means generate the complete delta - adds/deletes/modifies/etc;
265
269
'partial' means filter the delta using specific_fileids;
278
282
:param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
279
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] }
282
305
'direction': direction,
283
306
'specific_fileids': specific_fileids,
284
307
'start_revision': start_revision,
285
308
'end_revision': end_revision,
287
'message_search': message_search,
288
310
'levels': levels,
289
311
'generate_tags': generate_tags,
290
312
'delta_type': delta_type,
291
313
'diff_type': diff_type,
292
314
'exclude_common_ancestry': exclude_common_ancestry,
315
'signature': signature,
317
'omit_merges': omit_merges,
293
318
# Add 'private' attributes for features that may be deprecated
294
319
'_match_using_deltas': _match_using_deltas,
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"
306
352
class LogGenerator(object):
307
353
"""A generator of log revisions."""
353
399
# Tweak the LogRequest based on what the LogFormatter can handle.
354
400
# (There's no point generating stuff if the formatter can't display it.)
356
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()
357
406
if not getattr(lf, 'supports_tags', False):
358
407
rqst['generate_tags'] = False
359
408
if not getattr(lf, 'supports_delta', False):
360
409
rqst['delta_type'] = None
361
410
if not getattr(lf, 'supports_diff', False):
362
411
rqst['diff_type'] = None
412
if not getattr(lf, 'supports_signatures', False):
413
rqst['signature'] = False
364
415
# Find and print the interesting revisions
365
416
generator = self._generator_factory(self.branch, rqst)
406
459
# 0 levels means show everything; merge_depth counts from 0
407
460
if levels != 0 and merge_depth >= levels:
462
if omit_merges and len(rev.parent_ids) > 1:
409
464
if diff_type is None:
412
467
diff = self._format_diff(rev, rev_id, diff_type)
469
signature = format_signature_validity(rev_id,
470
self.branch.repository)
413
473
yield LogRevision(rev, revno, merge_depth, delta,
414
self.rev_tag_dict.get(rev_id), diff)
474
self.rev_tag_dict.get(rev_id), diff, signature)
417
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:
601
661
except _StartNotLinearAncestor:
602
662
# A merge was never detected so the lower revision limit can't
603
663
# be nested down somewhere
604
raise errors.BzrCommandError('Start revision not found in'
605
' history of end revision.')
664
raise errors.BzrCommandError(gettext('Start revision not found in'
665
' history of end revision.'))
607
667
# We exit the loop above because we encounter a revision with merges, from
608
668
# this revision, we need to switch to _graph_view_revisions.
679
739
br_revno, br_rev_id = branch.last_revision_info()
680
740
repo = branch.repository
741
graph = repo.get_graph()
681
742
if start_rev_id is None and end_rev_id is None:
682
743
cur_revno = br_revno
683
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,)):
684
746
yield revision_id, str(cur_revno), 0
687
749
if end_rev_id is None:
688
750
end_rev_id = br_rev_id
689
751
found_start = start_rev_id is None
690
for revision_id in repo.iter_reverse_revision_history(end_rev_id):
752
for revision_id in graph.iter_lefthand_ancestry(end_rev_id,
753
(_mod_revision.NULL_REVISION,)):
691
754
revno_str = _compute_revno_str(branch, revision_id)
692
755
if not found_start and revision_id == start_rev_id:
693
756
if not exclude_common_ancestry:
745
808
yield rev_id, '.'.join(map(str, revno)), merge_depth
748
@deprecated_function(deprecated_in((2, 2, 0)))
749
def calculate_view_revisions(branch, start_revision, end_revision, direction,
750
specific_fileid, generate_merge_revisions):
751
"""Calculate the revisions to view.
753
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
754
a list of the same tuples.
756
start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
758
view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
759
direction, generate_merge_revisions or specific_fileid))
761
view_revisions = _filter_revisions_touching_file_id(branch,
762
specific_fileid, view_revisions,
763
include_merges=generate_merge_revisions)
764
return _rebase_merge_depth(view_revisions)
767
811
def _rebase_merge_depth(view_revisions):
768
812
"""Adjust depths upwards so the top level is 0."""
769
813
# If either the first or last revision have a merge_depth of 0, we're done
813
857
return log_rev_iterator
816
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
860
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
817
861
"""Create a filtered iterator of log_rev_iterator matching on a regex.
819
863
:param branch: The branch being logged.
820
864
:param generate_delta: Whether to generate a delta for each revision.
821
: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
822
869
:param log_rev_iterator: An input iterator containing all revisions that
823
870
could be displayed, in lists.
824
871
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
828
875
return log_rev_iterator
829
searchRE = re.compile(search, re.IGNORECASE)
830
return _filter_message_re(searchRE, log_rev_iterator)
833
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):
834
882
for revs in log_rev_iterator:
836
for (rev_id, revno, merge_depth), rev, delta in revs:
837
if searchRE.search(rev.message):
838
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])
842
904
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
843
905
fileids=None, direction='reverse'):
1018
1079
if branch_revno != 0:
1019
1080
if (start_rev_id == _mod_revision.NULL_REVISION
1020
1081
or end_rev_id == _mod_revision.NULL_REVISION):
1021
raise errors.BzrCommandError('Logging revision 0 is invalid.')
1082
raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
1022
1083
if start_revno > end_revno:
1023
raise errors.BzrCommandError("Start revision must be older than "
1024
"the end revision.")
1084
raise errors.BzrCommandError(gettext("Start revision must be "
1085
"older than the end revision."))
1025
1086
return (start_rev_id, end_rev_id)
1077
1138
if ((start_rev_id == _mod_revision.NULL_REVISION)
1078
1139
or (end_rev_id == _mod_revision.NULL_REVISION)):
1079
raise errors.BzrCommandError('Logging revision 0 is invalid.')
1140
raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
1080
1141
if start_revno > end_revno:
1081
raise errors.BzrCommandError("Start revision must be older than "
1082
"the end revision.")
1142
raise errors.BzrCommandError(gettext("Start revision must be older "
1143
"than the end revision."))
1084
1145
if end_revno < start_revno:
1085
1146
return None, None, None, None
1086
1147
cur_revno = branch_revno
1088
1149
mainline_revs = []
1089
for revision_id in branch.repository.iter_reverse_revision_history(
1090
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,)):
1091
1153
if cur_revno < start_revno:
1092
1154
# We have gone far enough, but we always add 1 more revision
1093
1155
rev_nos[revision_id] = cur_revno
1107
1169
return mainline_revs, rev_nos, start_rev_id, end_rev_id
1110
@deprecated_function(deprecated_in((2, 2, 0)))
1111
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
1112
"""Filter view_revisions based on revision ranges.
1114
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1115
tuples to be filtered.
1117
:param start_rev_id: If not NONE specifies the first revision to be logged.
1118
If NONE then all revisions up to the end_rev_id are logged.
1120
:param end_rev_id: If not NONE specifies the last revision to be logged.
1121
If NONE then all revisions up to the end of the log are logged.
1123
:return: The filtered view_revisions.
1125
if start_rev_id or end_rev_id:
1126
revision_ids = [r for r, n, d in view_revisions]
1128
start_index = revision_ids.index(start_rev_id)
1131
if start_rev_id == end_rev_id:
1132
end_index = start_index
1135
end_index = revision_ids.index(end_rev_id)
1137
end_index = len(view_revisions) - 1
1138
# To include the revisions merged into the last revision,
1139
# extend end_rev_id down to, but not including, the next rev
1140
# with the same or lesser merge_depth
1141
end_merge_depth = view_revisions[end_index][2]
1143
for index in xrange(end_index+1, len(view_revisions)+1):
1144
if view_revisions[index][2] <= end_merge_depth:
1145
end_index = index - 1
1148
# if the search falls off the end then log to the end as well
1149
end_index = len(view_revisions) - 1
1150
view_revisions = view_revisions[start_index:end_index+1]
1151
return view_revisions
1154
1172
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1155
1173
include_merges=True):
1156
1174
r"""Return the list of revision ids which touch a given file id.
1200
1221
# indexing layer. We might consider passing in hints as to the known
1201
1222
# access pattern (sparse/clustered, high success rate/low success
1202
1223
# rate). This particular access is clustered with a low success rate.
1203
get_parent_map = branch.repository.texts.get_parent_map
1204
1224
modified_text_revisions = set()
1205
1225
chunk_size = 1000
1206
1226
for start in xrange(0, len(text_keys), chunk_size):
1236
@deprecated_function(deprecated_in((2, 2, 0)))
1237
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
1238
include_merges=True):
1239
"""Produce an iterator of revisions to show
1240
:return: an iterator of (revision_id, revno, merge_depth)
1241
(if there is no revno for a revision, None is supplied)
1243
if not include_merges:
1244
revision_ids = mainline_revs[1:]
1245
if direction == 'reverse':
1246
revision_ids.reverse()
1247
for revision_id in revision_ids:
1248
yield revision_id, str(rev_nos[revision_id]), 0
1250
graph = branch.repository.get_graph()
1251
# This asks for all mainline revisions, which means we only have to spider
1252
# sideways, rather than depth history. That said, its still size-of-history
1253
# and should be addressed.
1254
# mainline_revisions always includes an extra revision at the beginning, so
1256
parent_map = dict(((key, value) for key, value in
1257
graph.iter_ancestry(mainline_revs[1:]) if value is not None))
1258
# filter out ghosts; merge_sort errors on ghosts.
1259
rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
1260
merge_sorted_revisions = tsort.merge_sort(
1264
generate_revno=True)
1266
if direction == 'forward':
1267
# forward means oldest first.
1268
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
1269
elif direction != 'reverse':
1270
raise ValueError('invalid direction %r' % direction)
1272
for (sequence, rev_id, merge_depth, revno, end_of_merge
1273
) in merge_sorted_revisions:
1274
yield rev_id, '.'.join(map(str, revno)), merge_depth
1277
1256
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1278
1257
"""Reverse revisions by depth.
1338
1318
to indicate which LogRevision attributes it supports:
1340
1320
- supports_delta must be True if this log formatter supports delta.
1341
Otherwise the delta attribute may not be populated. The 'delta_format'
1342
attribute describes whether the 'short_status' format (1) or the long
1343
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.
1345
1325
- supports_merge_revisions must be True if this log formatter supports
1346
merge revisions. If not, then only mainline revisions will be passed
1326
merge revisions. If not, then only mainline revisions will be passed
1349
1329
- preferred_levels is the number of levels this formatter defaults to.
1350
The default value is zero meaning display all levels.
1351
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.
1353
1333
- supports_tags must be True if this log formatter supports tags.
1354
Otherwise the tags attribute may not be populated.
1334
Otherwise the tags attribute may not be populated.
1356
1336
- supports_diff must be True if this log formatter supports diffs.
1357
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
1359
1342
Plugins can register functions to show custom revision properties using
1360
1343
the properties_handler_registry. The registered function
1361
must respect the following interface description:
1344
must respect the following interface description::
1362
1346
def my_show_properties(properties_dict):
1363
1347
# code that returns a dict {'name':'value'} of the properties
1371
1355
"""Create a LogFormatter.
1373
1357
:param to_file: the file to output to
1374
: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
1375
1359
non-Unicode diffs are written.
1376
1360
:param show_ids: if True, revision-ids are to be displayed
1377
1361
:param show_timezone: the timezone to use
1609
1597
if revision.delta is not None:
1610
1598
# Use the standard status output to display changes
1611
1599
from bzrlib.delta import report_delta
1612
report_delta(to_file, revision.delta, short_status=False,
1600
report_delta(to_file, revision.delta, short_status=False,
1613
1601
show_ids=self.show_ids, indent=indent)
1614
1602
if revision.diff is not None:
1615
1603
to_file.write(indent + 'diff:\n')
1681
1669
if revision.delta is not None:
1682
1670
# Use the standard status output to display changes
1683
1671
from bzrlib.delta import report_delta
1684
report_delta(to_file, revision.delta,
1685
short_status=self.delta_format==1,
1672
report_delta(to_file, revision.delta,
1673
short_status=self.delta_format==1,
1686
1674
show_ids=self.show_ids, indent=indent + offset)
1687
1675
if revision.diff is not None:
1688
1676
self.show_diff(self.to_exact_file, revision.diff, ' ')
1728
1716
def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1729
1717
"""Format log info into one string. Truncate tail of string
1730
:param revno: revision number or None.
1731
Revision numbers counts from 1.
1732
:param rev: revision object
1733
:param max_chars: maximum length of resulting string
1734
:param tags: list of tags or None
1735
:param prefix: string to prefix each line
1736
: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
1740
1729
# show revno only when is not None
1741
1730
out.append("%s:" % revno)
1742
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))
1743
1735
out.append(self.date_string(rev))
1744
1736
if len(rev.parent_ids) > 1:
1745
1737
out.append('[merge]')
1864
1856
'The committer')
1867
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
1868
# deprecated; for compatibility
1869
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
1870
lf.show(revno, rev, delta)
1873
1859
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1874
1860
log_format='long'):
1875
1861
"""Show the change in revision history comparing the old revision history to the new one.