229
227
def make_log_request_dict(direction='reverse', specific_fileids=None,
230
228
start_revision=None, end_revision=None, limit=None,
231
message_search=None, levels=None, generate_tags=True,
229
message_search=None, levels=1, generate_tags=True,
233
231
diff_type=None, _match_using_deltas=True,
234
exclude_common_ancestry=False, match=None,
232
exclude_common_ancestry=False,
237
234
"""Convenience function for making a logging request dictionary.
259
256
matching commit messages
261
258
:param levels: the number of levels of revisions to
262
generate; 1 for just the mainline; 0 for all levels, or None for
259
generate; 1 for just the mainline; 0 for all levels.
265
261
:param generate_tags: If True, include tags for matched revisions.
267
263
:param delta_type: Either 'full', 'partial' or None.
268
264
'full' means generate the complete delta - adds/deletes/modifies/etc;
269
265
'partial' means filter the delta using specific_fileids;
282
278
:param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
283
279
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.
292
# Take care of old style message_search parameter
295
if 'message' in match:
296
match['message'].append(message_search)
298
match['message'] = [message_search]
300
match={ 'message': [message_search] }
302
282
'direction': direction,
303
283
'specific_fileids': specific_fileids,
304
284
'start_revision': start_revision,
305
285
'end_revision': end_revision,
287
'message_search': message_search,
307
288
'levels': levels,
308
289
'generate_tags': generate_tags,
309
290
'delta_type': delta_type,
310
291
'diff_type': diff_type,
311
292
'exclude_common_ancestry': exclude_common_ancestry,
312
'signature': signature,
314
293
# Add 'private' attributes for features that may be deprecated
315
294
'_match_using_deltas': _match_using_deltas,
327
def format_signature_validity(rev_id, repo):
328
"""get the signature validity
330
:param rev_id: revision id to validate
331
:param repo: repository of revision
332
:return: human readable string to print to log
334
from bzrlib import gpg
336
gpg_strategy = gpg.GPGStrategy(None)
337
result = repo.verify_revision(rev_id, gpg_strategy)
338
if result[0] == gpg.SIGNATURE_VALID:
339
return "valid signature from {0}".format(result[1])
340
if result[0] == gpg.SIGNATURE_KEY_MISSING:
341
return "unknown key {0}".format(result[1])
342
if result[0] == gpg.SIGNATURE_NOT_VALID:
343
return "invalid signature!"
344
if result[0] == gpg.SIGNATURE_NOT_SIGNED:
345
return "no signature"
348
306
class LogGenerator(object):
349
307
"""A generator of log revisions."""
395
353
# Tweak the LogRequest based on what the LogFormatter can handle.
396
354
# (There's no point generating stuff if the formatter can't display it.)
398
if rqst['levels'] is None or lf.get_levels() > rqst['levels']:
399
# user didn't specify levels, use whatever the LF can handle:
400
rqst['levels'] = lf.get_levels()
356
rqst['levels'] = lf.get_levels()
402
357
if not getattr(lf, 'supports_tags', False):
403
358
rqst['generate_tags'] = False
404
359
if not getattr(lf, 'supports_delta', False):
405
360
rqst['delta_type'] = None
406
361
if not getattr(lf, 'supports_diff', False):
407
362
rqst['diff_type'] = None
408
if not getattr(lf, 'supports_signatures', False):
409
rqst['signature'] = False
411
364
# Find and print the interesting revisions
412
365
generator = self._generator_factory(self.branch, rqst)
460
412
diff = self._format_diff(rev, rev_id, diff_type)
462
signature = format_signature_validity(rev_id,
463
self.branch.repository)
466
413
yield LogRevision(rev, revno, merge_depth, delta,
467
self.rev_tag_dict.get(rev_id), diff, signature)
414
self.rev_tag_dict.get(rev_id), diff)
470
417
if log_count >= limit:
526
473
# Apply the other filters
527
474
return make_log_rev_iterator(self.branch, view_revisions,
528
rqst.get('delta_type'), rqst.get('match'),
475
rqst.get('delta_type'), rqst.get('message_search'),
529
476
file_ids=rqst.get('specific_fileids'),
530
477
direction=rqst.get('direction'))
544
491
rqst.get('specific_fileids')[0], view_revisions,
545
492
include_merges=rqst.get('levels') != 1)
546
493
return make_log_rev_iterator(self.branch, view_revisions,
547
rqst.get('delta_type'), rqst.get('match'))
494
rqst.get('delta_type'), rqst.get('message_search'))
550
497
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
732
679
br_revno, br_rev_id = branch.last_revision_info()
733
680
repo = branch.repository
734
graph = repo.get_graph()
735
681
if start_rev_id is None and end_rev_id is None:
736
682
cur_revno = br_revno
737
for revision_id in graph.iter_lefthand_ancestry(br_rev_id,
738
(_mod_revision.NULL_REVISION,)):
683
for revision_id in repo.iter_reverse_revision_history(br_rev_id):
739
684
yield revision_id, str(cur_revno), 0
742
687
if end_rev_id is None:
743
688
end_rev_id = br_rev_id
744
689
found_start = start_rev_id is None
745
for revision_id in graph.iter_lefthand_ancestry(end_rev_id,
746
(_mod_revision.NULL_REVISION,)):
690
for revision_id in repo.iter_reverse_revision_history(end_rev_id):
747
691
revno_str = _compute_revno_str(branch, revision_id)
748
692
if not found_start and revision_id == start_rev_id:
749
693
if not exclude_common_ancestry:
801
745
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)
804
767
def _rebase_merge_depth(view_revisions):
805
768
"""Adjust depths upwards so the top level is 0."""
806
769
# If either the first or last revision have a merge_depth of 0, we're done
850
813
return log_rev_iterator
853
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
816
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
854
817
"""Create a filtered iterator of log_rev_iterator matching on a regex.
856
819
:param branch: The branch being logged.
857
820
:param generate_delta: Whether to generate a delta for each revision.
858
:param match: A dictionary with properties as keys and lists of strings
859
as values. To match, a revision may match any of the supplied strings
860
within a single property but must match at least one string for each
821
:param search: A user text search string.
862
822
:param log_rev_iterator: An input iterator containing all revisions that
863
823
could be displayed, in lists.
864
824
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
868
828
return log_rev_iterator
869
searchRE = [(k, [re.compile(x, re.IGNORECASE) for x in v])
870
for (k,v) in match.iteritems()]
871
return _filter_re(searchRE, log_rev_iterator)
874
def _filter_re(searchRE, 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):
875
834
for revs in log_rev_iterator:
876
new_revs = [rev for rev in revs if _match_filter(searchRE, rev[1])]
880
def _match_filter(searchRE, rev):
882
'message': (rev.message,),
883
'committer': (rev.committer,),
884
'author': (rev.get_apparent_authors()),
885
'bugs': list(rev.iter_bugs())
887
strings[''] = [item for inner_list in strings.itervalues()
888
for item in inner_list]
889
for (k,v) in searchRE:
890
if k in strings and not _match_any_filter(strings[k], v):
894
def _match_any_filter(strings, res):
895
return any([filter(None, map(re.search, strings)) for re in res])
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))
897
842
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
898
843
fileids=None, direction='reverse'):
1140
1086
cur_revno = branch_revno
1142
1088
mainline_revs = []
1143
graph = branch.repository.get_graph()
1144
for revision_id in graph.iter_lefthand_ancestry(
1145
branch_last_revision, (_mod_revision.NULL_REVISION,)):
1089
for revision_id in branch.repository.iter_reverse_revision_history(
1090
branch_last_revision):
1146
1091
if cur_revno < start_revno:
1147
1092
# We have gone far enough, but we always add 1 more revision
1148
1093
rev_nos[revision_id] = cur_revno
1162
1107
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
1165
1154
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1166
1155
include_merges=True):
1167
1156
r"""Return the list of revision ids which touch a given file id.
1214
1200
# indexing layer. We might consider passing in hints as to the known
1215
1201
# access pattern (sparse/clustered, high success rate/low success
1216
1202
# rate). This particular access is clustered with a low success rate.
1203
get_parent_map = branch.repository.texts.get_parent_map
1217
1204
modified_text_revisions = set()
1218
1205
chunk_size = 1000
1219
1206
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
1249
1277
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1250
1278
"""Reverse revisions by depth.
1311
1338
to indicate which LogRevision attributes it supports:
1313
1340
- supports_delta must be True if this log formatter supports delta.
1314
Otherwise the delta attribute may not be populated. The 'delta_format'
1315
attribute describes whether the 'short_status' format (1) or the long
1316
one (2) should be used.
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.
1318
1345
- supports_merge_revisions must be True if this log formatter supports
1319
merge revisions. If not, then only mainline revisions will be passed
1346
merge revisions. If not, then only mainline revisions will be passed
1322
1349
- preferred_levels is the number of levels this formatter defaults to.
1323
The default value is zero meaning display all levels.
1324
This value is only relevant if supports_merge_revisions is True.
1350
The default value is zero meaning display all levels.
1351
This value is only relevant if supports_merge_revisions is True.
1326
1353
- supports_tags must be True if this log formatter supports tags.
1327
Otherwise the tags attribute may not be populated.
1354
Otherwise the tags attribute may not be populated.
1329
1356
- supports_diff must be True if this log formatter supports diffs.
1330
Otherwise the diff attribute may not be populated.
1332
- supports_signatures must be True if this log formatter supports GPG
1357
Otherwise the diff attribute may not be populated.
1335
1359
Plugins can register functions to show custom revision properties using
1336
1360
the properties_handler_registry. The registered function
1337
must respect the following interface description::
1361
must respect the following interface description:
1339
1362
def my_show_properties(properties_dict):
1340
1363
# code that returns a dict {'name':'value'} of the properties
1348
1371
"""Create a LogFormatter.
1350
1373
:param to_file: the file to output to
1351
:param to_exact_file: if set, gives an output stream to which
1374
:param to_exact_file: if set, gives an output stream to which
1352
1375
non-Unicode diffs are written.
1353
1376
:param show_ids: if True, revision-ids are to be displayed
1354
1377
:param show_timezone: the timezone to use
1590
1609
if revision.delta is not None:
1591
1610
# Use the standard status output to display changes
1592
1611
from bzrlib.delta import report_delta
1593
report_delta(to_file, revision.delta, short_status=False,
1612
report_delta(to_file, revision.delta, short_status=False,
1594
1613
show_ids=self.show_ids, indent=indent)
1595
1614
if revision.diff is not None:
1596
1615
to_file.write(indent + 'diff:\n')
1662
1681
if revision.delta is not None:
1663
1682
# Use the standard status output to display changes
1664
1683
from bzrlib.delta import report_delta
1665
report_delta(to_file, revision.delta,
1666
short_status=self.delta_format==1,
1684
report_delta(to_file, revision.delta,
1685
short_status=self.delta_format==1,
1667
1686
show_ids=self.show_ids, indent=indent + offset)
1668
1687
if revision.diff is not None:
1669
1688
self.show_diff(self.to_exact_file, revision.diff, ' ')
1709
1728
def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1710
1729
"""Format log info into one string. Truncate tail of string
1712
:param revno: revision number or None.
1713
Revision numbers counts from 1.
1714
:param rev: revision object
1715
:param max_chars: maximum length of resulting string
1716
:param tags: list of tags or None
1717
:param prefix: string to prefix each line
1718
:return: formatted truncated 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
1722
1740
# show revno only when is not None
1723
1741
out.append("%s:" % revno)
1724
if max_chars is not None:
1725
out.append(self.truncate(self.short_author(rev), (max_chars+3)/4))
1727
out.append(self.short_author(rev))
1742
out.append(self.truncate(self.short_author(rev), 20))
1728
1743
out.append(self.date_string(rev))
1729
1744
if len(rev.parent_ids) > 1:
1730
1745
out.append('[merge]')
1849
1864
'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)
1852
1873
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1853
1874
log_format='long'):
1854
1875
"""Show the change in revision history comparing the old revision history to the new one.
added
removed
bzrlib/log.py
