73
74
repository as _mod_repository,
74
75
revision as _mod_revision,
81
82
from bzrlib import (
85
85
from bzrlib.osutils import (
87
87
format_date_with_offset_in_original_timezone,
88
get_diff_header_encoding,
89
88
get_terminal_encoding,
91
from bzrlib.symbol_versioning import (
94
97
def find_touching_revisions(branch, file_id):
229
228
def make_log_request_dict(direction='reverse', specific_fileids=None,
230
229
start_revision=None, end_revision=None, limit=None,
231
message_search=None, levels=None, generate_tags=True,
230
message_search=None, levels=1, generate_tags=True,
233
232
diff_type=None, _match_using_deltas=True,
234
exclude_common_ancestry=False, match=None,
233
exclude_common_ancestry=False,
237
235
"""Convenience function for making a logging request dictionary.
259
257
matching commit messages
261
259
:param levels: the number of levels of revisions to
262
generate; 1 for just the mainline; 0 for all levels, or None for
260
generate; 1 for just the mainline; 0 for all levels.
265
262
:param generate_tags: If True, include tags for matched revisions.
267
264
:param delta_type: Either 'full', 'partial' or None.
268
265
'full' means generate the complete delta - adds/deletes/modifies/etc;
269
266
'partial' means filter the delta using specific_fileids;
282
279
:param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
283
280
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
283
'direction': direction,
303
284
'specific_fileids': specific_fileids,
304
285
'start_revision': start_revision,
305
286
'end_revision': end_revision,
288
'message_search': message_search,
307
289
'levels': levels,
308
290
'generate_tags': generate_tags,
309
291
'delta_type': delta_type,
310
292
'diff_type': diff_type,
311
293
'exclude_common_ancestry': exclude_common_ancestry,
312
'signature': signature,
314
294
# Add 'private' attributes for features that may be deprecated
315
295
'_match_using_deltas': _match_using_deltas,
319
299
def _apply_log_request_defaults(rqst):
320
300
"""Apply default values to a request dictionary."""
321
result = _DEFAULT_REQUEST_PARAMS.copy()
301
result = _DEFAULT_REQUEST_PARAMS
323
303
result.update(rqst)
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
307
class LogGenerator(object):
349
308
"""A generator of log revisions."""
395
354
# Tweak the LogRequest based on what the LogFormatter can handle.
396
355
# (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()
357
rqst['levels'] = lf.get_levels()
402
358
if not getattr(lf, 'supports_tags', False):
403
359
rqst['generate_tags'] = False
404
360
if not getattr(lf, 'supports_delta', False):
405
361
rqst['delta_type'] = None
406
362
if not getattr(lf, 'supports_diff', False):
407
363
rqst['diff_type'] = None
408
if not getattr(lf, 'supports_signatures', False):
409
rqst['signature'] = False
411
365
# Find and print the interesting revisions
412
366
generator = self._generator_factory(self.branch, rqst)
460
413
diff = self._format_diff(rev, rev_id, diff_type)
462
signature = format_signature_validity(rev_id,
463
self.branch.repository)
466
414
yield LogRevision(rev, revno, merge_depth, delta,
467
self.rev_tag_dict.get(rev_id), diff, signature)
415
self.rev_tag_dict.get(rev_id), diff)
470
418
if log_count >= limit:
526
474
# Apply the other filters
527
475
return make_log_rev_iterator(self.branch, view_revisions,
528
rqst.get('delta_type'), rqst.get('match'),
476
rqst.get('delta_type'), rqst.get('message_search'),
529
477
file_ids=rqst.get('specific_fileids'),
530
478
direction=rqst.get('direction'))
544
492
rqst.get('specific_fileids')[0], view_revisions,
545
493
include_merges=rqst.get('levels') != 1)
546
494
return make_log_rev_iterator(self.branch, view_revisions,
547
rqst.get('delta_type'), rqst.get('match'))
495
rqst.get('delta_type'), rqst.get('message_search'))
550
498
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
678
627
return len(parents) > 1
681
def _compute_revno_str(branch, rev_id):
682
"""Compute the revno string from a rev_id.
684
:return: The revno string, or None if the revision is not in the supplied
688
revno = branch.revision_id_to_dotted_revno(rev_id)
689
except errors.NoSuchRevision:
690
# The revision must be outside of this branch
693
return '.'.join(str(n) for n in revno)
696
630
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
697
631
"""Is start_rev_id an obvious ancestor of end_rev_id?"""
698
632
if start_rev_id and end_rev_id:
700
start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
701
end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
702
except errors.NoSuchRevision:
703
# one or both is not in the branch; not obvious
633
start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
634
end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
705
635
if len(start_dotted) == 1 and len(end_dotted) == 1:
706
636
# both on mainline
707
637
return start_dotted[0] <= end_dotted[0]
732
662
br_revno, br_rev_id = branch.last_revision_info()
733
663
repo = branch.repository
734
graph = repo.get_graph()
735
664
if start_rev_id is None and end_rev_id is None:
736
665
cur_revno = br_revno
737
for revision_id in graph.iter_lefthand_ancestry(br_rev_id,
738
(_mod_revision.NULL_REVISION,)):
666
for revision_id in repo.iter_reverse_revision_history(br_rev_id):
739
667
yield revision_id, str(cur_revno), 0
742
670
if end_rev_id is None:
743
671
end_rev_id = br_rev_id
744
672
found_start = start_rev_id is None
745
for revision_id in graph.iter_lefthand_ancestry(end_rev_id,
746
(_mod_revision.NULL_REVISION,)):
747
revno_str = _compute_revno_str(branch, revision_id)
673
for revision_id in repo.iter_reverse_revision_history(end_rev_id):
674
revno = branch.revision_id_to_dotted_revno(revision_id)
675
revno_str = '.'.join(str(n) for n in revno)
748
676
if not found_start and revision_id == start_rev_id:
749
677
if not exclude_common_ancestry:
750
678
yield revision_id, revno_str, 0
801
729
yield rev_id, '.'.join(map(str, revno)), merge_depth
732
@deprecated_function(deprecated_in((2, 2, 0)))
733
def calculate_view_revisions(branch, start_revision, end_revision, direction,
734
specific_fileid, generate_merge_revisions):
735
"""Calculate the revisions to view.
737
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
738
a list of the same tuples.
740
start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
742
view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
743
direction, generate_merge_revisions or specific_fileid))
745
view_revisions = _filter_revisions_touching_file_id(branch,
746
specific_fileid, view_revisions,
747
include_merges=generate_merge_revisions)
748
return _rebase_merge_depth(view_revisions)
804
751
def _rebase_merge_depth(view_revisions):
805
752
"""Adjust depths upwards so the top level is 0."""
806
753
# If either the first or last revision have a merge_depth of 0, we're done
850
797
return log_rev_iterator
853
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
800
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
854
801
"""Create a filtered iterator of log_rev_iterator matching on a regex.
856
803
:param branch: The branch being logged.
857
804
: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
805
:param search: A user text search string.
862
806
:param log_rev_iterator: An input iterator containing all revisions that
863
807
could be displayed, in lists.
864
808
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
868
812
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):
813
searchRE = re.compile(search, re.IGNORECASE)
814
return _filter_message_re(searchRE, log_rev_iterator)
817
def _filter_message_re(searchRE, log_rev_iterator):
875
818
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])
820
for (rev_id, revno, merge_depth), rev, delta in revs:
821
if searchRE.search(rev.message):
822
new_revs.append(((rev_id, revno, merge_depth), rev, delta))
897
826
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
898
827
fileids=None, direction='reverse'):
1140
1070
cur_revno = branch_revno
1142
1072
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,)):
1073
for revision_id in branch.repository.iter_reverse_revision_history(
1074
branch_last_revision):
1146
1075
if cur_revno < start_revno:
1147
1076
# We have gone far enough, but we always add 1 more revision
1148
1077
rev_nos[revision_id] = cur_revno
1162
1091
return mainline_revs, rev_nos, start_rev_id, end_rev_id
1094
@deprecated_function(deprecated_in((2, 2, 0)))
1095
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
1096
"""Filter view_revisions based on revision ranges.
1098
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1099
tuples to be filtered.
1101
:param start_rev_id: If not NONE specifies the first revision to be logged.
1102
If NONE then all revisions up to the end_rev_id are logged.
1104
:param end_rev_id: If not NONE specifies the last revision to be logged.
1105
If NONE then all revisions up to the end of the log are logged.
1107
:return: The filtered view_revisions.
1109
if start_rev_id or end_rev_id:
1110
revision_ids = [r for r, n, d in view_revisions]
1112
start_index = revision_ids.index(start_rev_id)
1115
if start_rev_id == end_rev_id:
1116
end_index = start_index
1119
end_index = revision_ids.index(end_rev_id)
1121
end_index = len(view_revisions) - 1
1122
# To include the revisions merged into the last revision,
1123
# extend end_rev_id down to, but not including, the next rev
1124
# with the same or lesser merge_depth
1125
end_merge_depth = view_revisions[end_index][2]
1127
for index in xrange(end_index+1, len(view_revisions)+1):
1128
if view_revisions[index][2] <= end_merge_depth:
1129
end_index = index - 1
1132
# if the search falls off the end then log to the end as well
1133
end_index = len(view_revisions) - 1
1134
view_revisions = view_revisions[start_index:end_index+1]
1135
return view_revisions
1165
1138
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1166
1139
include_merges=True):
1167
1140
r"""Return the list of revision ids which touch a given file id.
1214
1184
# indexing layer. We might consider passing in hints as to the known
1215
1185
# access pattern (sparse/clustered, high success rate/low success
1216
1186
# rate). This particular access is clustered with a low success rate.
1187
get_parent_map = branch.repository.texts.get_parent_map
1217
1188
modified_text_revisions = set()
1218
1189
chunk_size = 1000
1219
1190
for start in xrange(0, len(text_keys), chunk_size):
1220
@deprecated_function(deprecated_in((2, 2, 0)))
1221
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
1222
include_merges=True):
1223
"""Produce an iterator of revisions to show
1224
:return: an iterator of (revision_id, revno, merge_depth)
1225
(if there is no revno for a revision, None is supplied)
1227
if not include_merges:
1228
revision_ids = mainline_revs[1:]
1229
if direction == 'reverse':
1230
revision_ids.reverse()
1231
for revision_id in revision_ids:
1232
yield revision_id, str(rev_nos[revision_id]), 0
1234
graph = branch.repository.get_graph()
1235
# This asks for all mainline revisions, which means we only have to spider
1236
# sideways, rather than depth history. That said, its still size-of-history
1237
# and should be addressed.
1238
# mainline_revisions always includes an extra revision at the beginning, so
1240
parent_map = dict(((key, value) for key, value in
1241
graph.iter_ancestry(mainline_revs[1:]) if value is not None))
1242
# filter out ghosts; merge_sort errors on ghosts.
1243
rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
1244
merge_sorted_revisions = tsort.merge_sort(
1248
generate_revno=True)
1250
if direction == 'forward':
1251
# forward means oldest first.
1252
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
1253
elif direction != 'reverse':
1254
raise ValueError('invalid direction %r' % direction)
1256
for (sequence, rev_id, merge_depth, revno, end_of_merge
1257
) in merge_sorted_revisions:
1258
yield rev_id, '.'.join(map(str, revno)), merge_depth
1249
1261
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1250
1262
"""Reverse revisions by depth.
1288
1300
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1289
tags=None, diff=None, signature=None):
1301
tags=None, diff=None):
1294
self.revno = str(revno)
1303
self.revno = str(revno)
1295
1304
self.merge_depth = merge_depth
1296
1305
self.delta = delta
1297
1306
self.tags = tags
1298
1307
self.diff = diff
1299
self.signature = signature
1302
1310
class LogFormatter(object):
1311
1319
to indicate which LogRevision attributes it supports:
1313
1321
- 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.
1322
Otherwise the delta attribute may not be populated. The 'delta_format'
1323
attribute describes whether the 'short_status' format (1) or the long
1324
one (2) should be used.
1318
1326
- supports_merge_revisions must be True if this log formatter supports
1319
merge revisions. If not, then only mainline revisions will be passed
1327
merge revisions. If not, then only mainline revisions will be passed
1322
1330
- 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.
1331
The default value is zero meaning display all levels.
1332
This value is only relevant if supports_merge_revisions is True.
1326
1334
- supports_tags must be True if this log formatter supports tags.
1327
Otherwise the tags attribute may not be populated.
1335
Otherwise the tags attribute may not be populated.
1329
1337
- 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
1338
Otherwise the diff attribute may not be populated.
1335
1340
Plugins can register functions to show custom revision properties using
1336
1341
the properties_handler_registry. The registered function
1337
must respect the following interface description::
1342
must respect the following interface description:
1339
1343
def my_show_properties(properties_dict):
1340
1344
# code that returns a dict {'name':'value'} of the properties
1348
1352
"""Create a LogFormatter.
1350
1354
:param to_file: the file to output to
1351
:param to_exact_file: if set, gives an output stream to which
1355
:param to_exact_file: if set, gives an output stream to which
1352
1356
non-Unicode diffs are written.
1353
1357
:param show_ids: if True, revision-ids are to be displayed
1354
1358
:param show_timezone: the timezone to use
1554
1557
self.merge_marker(revision)))
1555
1558
if revision.tags:
1556
1559
lines.append('tags: %s' % (', '.join(revision.tags)))
1557
if self.show_ids or revision.revno is None:
1558
1561
lines.append('revision-id: %s' % (revision.rev.revision_id,))
1560
1562
for parent_id in revision.rev.parent_ids:
1561
1563
lines.append('parent: %s' % (parent_id,))
1562
1564
lines.extend(self.custom_properties(revision.rev))
1590
1589
if revision.delta is not None:
1591
1590
# Use the standard status output to display changes
1592
1591
from bzrlib.delta import report_delta
1593
report_delta(to_file, revision.delta, short_status=False,
1592
report_delta(to_file, revision.delta, short_status=False,
1594
1593
show_ids=self.show_ids, indent=indent)
1595
1594
if revision.diff is not None:
1596
1595
to_file.write(indent + 'diff:\n')
1642
1641
if revision.tags:
1643
1642
tags = ' {%s}' % (', '.join(revision.tags))
1644
1643
to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1645
revision.revno or "", self.short_author(revision.rev),
1644
revision.revno, self.short_author(revision.rev),
1646
1645
format_date(revision.rev.timestamp,
1647
1646
revision.rev.timezone or 0,
1648
1647
self.show_timezone, date_fmt="%Y-%m-%d",
1649
1648
show_offset=False),
1650
1649
tags, self.merge_marker(revision)))
1651
1650
self.show_properties(revision.rev, indent+offset)
1652
if self.show_ids or revision.revno is None:
1653
1652
to_file.write(indent + offset + 'revision-id:%s\n'
1654
1653
% (revision.rev.revision_id,))
1655
1654
if not revision.rev.message:
1662
1661
if revision.delta is not None:
1663
1662
# Use the standard status output to display changes
1664
1663
from bzrlib.delta import report_delta
1665
report_delta(to_file, revision.delta,
1666
short_status=self.delta_format==1,
1664
report_delta(to_file, revision.delta,
1665
short_status=self.delta_format==1,
1667
1666
show_ids=self.show_ids, indent=indent + offset)
1668
1667
if revision.diff is not None:
1669
1668
self.show_diff(self.to_exact_file, revision.diff, ' ')
1709
1708
def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1710
1709
"""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
1710
:param revno: revision number or None.
1711
Revision numbers counts from 1.
1712
:param rev: revision object
1713
:param max_chars: maximum length of resulting string
1714
:param tags: list of tags or None
1715
:param prefix: string to prefix each line
1716
:return: formatted truncated string
1722
1720
# show revno only when is not None
1723
1721
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))
1722
out.append(self.truncate(self.short_author(rev), 20))
1728
1723
out.append(self.date_string(rev))
1729
1724
if len(rev.parent_ids) > 1:
1730
1725
out.append('[merge]')
1849
1844
'The committer')
1847
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
1848
# deprecated; for compatibility
1849
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
1850
lf.show(revno, rev, delta)
1852
1853
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1853
1854
log_format='long'):
1854
1855
"""Show the change in revision history comparing the old revision history to the new one.
added
removed
bzrlib/log.py
