174
182
:param show_diff: If True, output a diff after each revision.
178
if getattr(lf, 'begin_log', None):
181
_show_log(branch, lf, specific_fileid, verbose, direction,
182
start_revision, end_revision, search, limit, show_diff)
184
if getattr(lf, 'end_log', None):
190
def _show_log(branch,
192
specific_fileid=None,
200
"""Worker function for show_log - see show_log."""
201
if not isinstance(lf, LogFormatter):
202
warn("not a LogFormatter instance: %r" % lf)
204
trace.mutter('get log for file_id %r', specific_fileid)
206
# Consult the LogFormatter about what it needs and can handle
207
levels_to_display = lf.get_levels()
208
generate_merge_revisions = levels_to_display != 1
209
allow_single_merge_revision = True
210
if not getattr(lf, 'supports_merge_revisions', False):
211
allow_single_merge_revision = getattr(lf,
212
'supports_single_merge_revision', False)
213
generate_tags = getattr(lf, 'supports_tags', False)
214
if generate_tags and branch.supports_tags():
215
rev_tag_dict = branch.tags.get_reverse_tag_dict()
218
generate_delta = verbose and getattr(lf, 'supports_delta', False)
219
generate_diff = show_diff and getattr(lf, 'supports_diff', False)
221
# Find and print the interesting revisions
222
repo = branch.repository
224
revision_iterator = _create_log_revision_iterator(branch,
225
start_revision, end_revision, direction, specific_fileid, search,
226
generate_merge_revisions, allow_single_merge_revision,
227
generate_delta, limited_output=limit > 0)
228
for revs in revision_iterator:
229
for (rev_id, revno, merge_depth), rev, delta in revs:
230
# Note: 0 levels means show everything; merge_depth counts from 0
231
if levels_to_display != 0 and merge_depth >= levels_to_display:
234
diff = _format_diff(repo, rev, rev_id, specific_fileid)
237
lr = LogRevision(rev, revno, merge_depth, delta,
238
rev_tag_dict.get(rev_id), diff)
184
# Convert old-style parameters to new-style parameters
185
if specific_fileid is not None:
186
file_ids = [specific_fileid]
191
delta_type = 'partial'
198
diff_type = 'partial'
204
# Build the request and execute it
205
rqst = make_log_request_dict(direction=direction, specific_fileids=file_ids,
206
start_revision=start_revision, end_revision=end_revision,
207
limit=limit, message_search=search,
208
delta_type=delta_type, diff_type=diff_type)
209
Logger(branch, rqst).show(lf)
212
# Note: This needs to be kept this in sync with the defaults in
213
# make_log_request_dict() below
214
_DEFAULT_REQUEST_PARAMS = {
215
'direction': 'reverse',
217
'generate_tags': True,
218
'_match_using_deltas': True,
222
def make_log_request_dict(direction='reverse', specific_fileids=None,
223
start_revision=None, end_revision=None, limit=None,
224
message_search=None, levels=1, generate_tags=True, delta_type=None,
225
diff_type=None, _match_using_deltas=True):
226
"""Convenience function for making a logging request dictionary.
228
Using this function may make code slightly safer by ensuring
229
parameters have the correct names. It also provides a reference
230
point for documenting the supported parameters.
232
:param direction: 'reverse' (default) is latest to earliest;
233
'forward' is earliest to latest.
235
:param specific_fileids: If not None, only include revisions
236
affecting the specified files, rather than all revisions.
238
:param start_revision: If not None, only generate
239
revisions >= start_revision
241
:param end_revision: If not None, only generate
242
revisions <= end_revision
244
:param limit: If set, generate only 'limit' revisions, all revisions
245
are shown if None or 0.
247
:param message_search: If not None, only include revisions with
248
matching commit messages
250
:param levels: the number of levels of revisions to
251
generate; 1 for just the mainline; 0 for all levels.
253
:param generate_tags: If True, include tags for matched revisions.
255
:param delta_type: Either 'full', 'partial' or None.
256
'full' means generate the complete delta - adds/deletes/modifies/etc;
257
'partial' means filter the delta using specific_fileids;
258
None means do not generate any delta.
260
:param diff_type: Either 'full', 'partial' or None.
261
'full' means generate the complete diff - adds/deletes/modifies/etc;
262
'partial' means filter the diff using specific_fileids;
263
None means do not generate any diff.
265
:param _match_using_deltas: a private parameter controlling the
266
algorithm used for matching specific_fileids. This parameter
267
may be removed in the future so bzrlib client code should NOT
271
'direction': direction,
272
'specific_fileids': specific_fileids,
273
'start_revision': start_revision,
274
'end_revision': end_revision,
276
'message_search': message_search,
278
'generate_tags': generate_tags,
279
'delta_type': delta_type,
280
'diff_type': diff_type,
281
# Add 'private' attributes for features that may be deprecated
282
'_match_using_deltas': _match_using_deltas,
286
def _apply_log_request_defaults(rqst):
287
"""Apply default values to a request dictionary."""
288
result = _DEFAULT_REQUEST_PARAMS
294
class LogGenerator(object):
295
"""A generator of log revisions."""
297
def iter_log_revisions(self):
298
"""Iterate over LogRevision objects.
300
:return: An iterator yielding LogRevision objects.
302
raise NotImplementedError(self.iter_log_revisions)
305
class Logger(object):
306
"""An object the generates, formats and displays a log."""
308
def __init__(self, branch, rqst):
311
:param branch: the branch to log
312
:param rqst: A dictionary specifying the query parameters.
313
See make_log_request_dict() for supported values.
316
self.rqst = _apply_log_request_defaults(rqst)
321
:param lf: The LogFormatter object to send the output to.
323
if not isinstance(lf, LogFormatter):
324
warn("not a LogFormatter instance: %r" % lf)
326
self.branch.lock_read()
328
if getattr(lf, 'begin_log', None):
331
if getattr(lf, 'end_log', None):
336
def _show_body(self, lf):
337
"""Show the main log output.
339
Subclasses may wish to override this.
341
# Tweak the LogRequest based on what the LogFormatter can handle.
342
# (There's no point generating stuff if the formatter can't display it.)
344
rqst['levels'] = lf.get_levels()
345
if not getattr(lf, 'supports_tags', False):
346
rqst['generate_tags'] = False
347
if not getattr(lf, 'supports_delta', False):
348
rqst['delta_type'] = None
349
if not getattr(lf, 'supports_diff', False):
350
rqst['diff_type'] = None
352
# Find and print the interesting revisions
353
generator = self._generator_factory(self.branch, rqst)
354
for lr in generator.iter_log_revisions():
239
355
lf.log_revision(lr)
242
if log_count >= limit:
246
def _format_diff(repo, rev, rev_id, specific_fileid):
247
if len(rev.parent_ids) == 0:
248
ancestor_id = _mod_revision.NULL_REVISION
250
ancestor_id = rev.parent_ids[0]
251
tree_1 = repo.revision_tree(ancestor_id)
252
tree_2 = repo.revision_tree(rev_id)
254
specific_files = [tree_2.id2path(specific_fileid)]
256
specific_files = None
258
diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
358
def _generator_factory(self, branch, rqst):
359
"""Make the LogGenerator object to use.
361
Subclasses may wish to override this.
363
return _DefaultLogGenerator(branch, rqst)
263
366
class _StartNotLinearAncestor(Exception):
264
367
"""Raised when a start revision is not found walking left-hand history."""
267
def _create_log_revision_iterator(branch, start_revision, end_revision,
268
direction, specific_fileid, search, generate_merge_revisions,
269
allow_single_merge_revision, generate_delta, limited_output=False):
270
"""Create a revision iterator for log.
272
:param branch: The branch being logged.
273
:param start_revision: If not None, only show revisions >= start_revision
274
:param end_revision: If not None, only show revisions <= end_revision
275
:param direction: 'reverse' (default) is latest to earliest; 'forward' is
277
:param specific_fileid: If not None, list only the commits affecting the
279
:param search: If not None, only show revisions with matching commit
281
:param generate_merge_revisions: If False, show only mainline revisions.
282
:param allow_single_merge_revision: If True, logging of a single
283
revision off the mainline is to be allowed
284
:param generate_delta: Whether to generate a delta for each revision.
285
:param limited_output: if True, the user only wants a limited result
287
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
290
start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
293
# Decide how file-ids are matched: delta-filtering vs per-file graph.
294
# Delta filtering allows revisions to be displayed incrementally
295
# though the total time is much slower for huge repositories: log -v
296
# is the *lower* performance bound. At least until the split
297
# inventory format arrives, per-file-graph needs to remain the
298
# default except in verbose mode. Delta filtering should give more
299
# accurate results (e.g. inclusion of FILE deletions) so arguably
300
# it should always be used in the future.
301
use_deltas_for_matching = specific_fileid and generate_delta
302
delayed_graph_generation = not specific_fileid and (
303
start_rev_id or end_rev_id or limited_output)
304
generate_merges = generate_merge_revisions or (specific_fileid and
305
not use_deltas_for_matching)
306
view_revisions = _calc_view_revisions(branch, start_rev_id, end_rev_id,
307
direction, generate_merges, allow_single_merge_revision,
308
delayed_graph_generation=delayed_graph_generation)
309
search_deltas_for_fileids = None
310
if use_deltas_for_matching:
311
search_deltas_for_fileids = set([specific_fileid])
312
elif specific_fileid:
370
class _DefaultLogGenerator(LogGenerator):
371
"""The default generator of log revisions."""
373
def __init__(self, branch, rqst):
376
if rqst.get('generate_tags') and branch.supports_tags():
377
self.rev_tag_dict = branch.tags.get_reverse_tag_dict()
379
self.rev_tag_dict = {}
381
def iter_log_revisions(self):
382
"""Iterate over LogRevision objects.
384
:return: An iterator yielding LogRevision objects.
388
revision_iterator = self._create_log_revision_iterator()
389
for revs in revision_iterator:
390
for (rev_id, revno, merge_depth), rev, delta in revs:
391
# 0 levels means show everything; merge_depth counts from 0
392
levels = rqst.get('levels')
393
if levels != 0 and merge_depth >= levels:
395
diff = self._format_diff(rev, rev_id)
396
yield LogRevision(rev, revno, merge_depth, delta,
397
self.rev_tag_dict.get(rev_id), diff)
398
limit = rqst.get('limit')
401
if log_count >= limit:
404
def _format_diff(self, rev, rev_id):
405
diff_type = self.rqst.get('diff_type')
406
if diff_type is None:
408
repo = self.branch.repository
409
if len(rev.parent_ids) == 0:
410
ancestor_id = _mod_revision.NULL_REVISION
412
ancestor_id = rev.parent_ids[0]
413
tree_1 = repo.revision_tree(ancestor_id)
414
tree_2 = repo.revision_tree(rev_id)
415
file_ids = self.rqst.get('specific_fileids')
416
if diff_type == 'partial' and file_ids is not None:
417
specific_files = [tree_2.id2path(id) for id in file_ids]
419
specific_files = None
421
diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
425
def _create_log_revision_iterator(self):
426
"""Create a revision iterator for log.
428
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
431
self.start_rev_id, self.end_rev_id = _get_revision_limits(
432
self.branch, self.rqst.get('start_revision'),
433
self.rqst.get('end_revision'))
434
if self.rqst.get('_match_using_deltas'):
435
return self._log_revision_iterator_using_delta_matching()
437
# We're using the per-file-graph algorithm. This scales really
438
# well but only makes sense if there is a single file and it's
440
file_count = len(self.rqst.get('specific_fileids'))
442
raise BzrError("illegal LogRequest: must match-using-deltas "
443
"when logging %d files" % file_count)
444
return self._log_revision_iterator_using_per_file_graph()
446
def _log_revision_iterator_using_delta_matching(self):
447
# Get the base revisions, filtering by the revision range
449
generate_merge_revisions = rqst.get('levels') != 1
450
delayed_graph_generation = not rqst.get('specific_fileids') and (
451
rqst.get('limit') or self.start_rev_id or self.end_rev_id)
452
view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
453
self.end_rev_id, rqst.get('direction'), generate_merge_revisions,
454
delayed_graph_generation=delayed_graph_generation)
456
# Apply the other filters
457
return make_log_rev_iterator(self.branch, view_revisions,
458
rqst.get('delta_type'), rqst.get('message_search'),
459
file_ids=rqst.get('specific_fileids'),
460
direction=rqst.get('direction'))
462
def _log_revision_iterator_using_per_file_graph(self):
463
# Get the base revisions, filtering by the revision range.
464
# Note that we always generate the merge revisions because
465
# filter_revisions_touching_file_id() requires them ...
467
view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
468
self.end_rev_id, rqst.get('direction'), True)
313
469
if not isinstance(view_revisions, list):
314
470
view_revisions = list(view_revisions)
315
view_revisions = _filter_revisions_touching_file_id(branch,
316
specific_fileid, view_revisions,
317
include_merges=generate_merge_revisions)
318
return make_log_rev_iterator(branch, view_revisions, generate_delta,
319
search, file_ids=search_deltas_for_fileids, direction=direction)
471
view_revisions = _filter_revisions_touching_file_id(self.branch,
472
rqst.get('specific_fileids')[0], view_revisions,
473
include_merges=rqst.get('levels') != 1)
474
return make_log_rev_iterator(self.branch, view_revisions,
475
rqst.get('delta_type'), rqst.get('message_search'))
322
478
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
323
generate_merge_revisions, allow_single_merge_revision,
324
delayed_graph_generation=False):
479
generate_merge_revisions, delayed_graph_generation=False):
325
480
"""Calculate the revisions to view.
327
482
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
335
490
generate_single_revision = (end_rev_id and start_rev_id == end_rev_id and
336
491
(not generate_merge_revisions or not _has_merges(branch, end_rev_id)))
337
492
if generate_single_revision:
338
if end_rev_id == br_rev_id:
340
return [(br_rev_id, br_revno, 0)]
342
revno = branch.revision_id_to_dotted_revno(end_rev_id)
343
if len(revno) > 1 and not allow_single_merge_revision:
344
# It's a merge revision and the log formatter is
345
# completely brain dead. This "feature" of allowing
346
# log formatters incapable of displaying dotted revnos
347
# ought to be deprecated IMNSHO. IGC 20091022
348
raise errors.BzrCommandError('Selected log formatter only'
349
' supports mainline revisions.')
350
revno_str = '.'.join(str(n) for n in revno)
351
return [(end_rev_id, revno_str, 0)]
493
return _generate_one_revision(branch, end_rev_id, br_rev_id, br_revno)
353
495
# If we only want to see linear revisions, we can iterate ...
354
496
if not generate_merge_revisions:
355
result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
356
# If a start limit was given and it's not obviously an
357
# ancestor of the end limit, check it before outputting anything
358
if direction == 'forward' or (start_rev_id
359
and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
361
result = list(result)
362
except _StartNotLinearAncestor:
363
raise errors.BzrCommandError('Start revision not found in'
364
' left-hand history of end revision.')
365
if direction == 'forward':
366
result = reversed(list(result))
497
return _generate_flat_revisions(branch, start_rev_id, end_rev_id,
500
return _generate_all_revisions(branch, start_rev_id, end_rev_id,
501
direction, delayed_graph_generation)
504
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
505
if rev_id == br_rev_id:
507
return [(br_rev_id, br_revno, 0)]
509
revno = branch.revision_id_to_dotted_revno(rev_id)
510
revno_str = '.'.join(str(n) for n in revno)
511
return [(rev_id, revno_str, 0)]
514
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction):
515
result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
516
# If a start limit was given and it's not obviously an
517
# ancestor of the end limit, check it before outputting anything
518
if direction == 'forward' or (start_rev_id
519
and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
521
result = list(result)
522
except _StartNotLinearAncestor:
523
raise errors.BzrCommandError('Start revision not found in'
524
' left-hand history of end revision.')
525
if direction == 'forward':
526
result = reversed(result)
530
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
531
delayed_graph_generation):
369
532
# On large trees, generating the merge graph can take 30-60 seconds
370
533
# so we delay doing it until a merge is detected, incrementally
371
534
# returning initial (non-merge) revisions while we can.
1615
1833
lf.log_revision(lr)
1618
def _get_fileid_to_log(revision, tree, b, fp):
1619
"""Find the file-id to log for a file path in a revision range.
1621
:param revision: the revision range as parsed on the command line
1622
:param tree: the working tree, if any
1623
:param b: the branch
1624
:param fp: file path
1836
def _get_info_for_log_files(revisionspec_list, file_list):
1837
"""Find file-ids and kinds given a list of files and a revision range.
1839
We search for files at the end of the range. If not found there,
1840
we try the start of the range.
1842
:param revisionspec_list: revision range as parsed on the command line
1843
:param file_list: the list of paths given on the command line;
1844
the first of these can be a branch location or a file path,
1845
the remainder must be file paths
1846
:return: (branch, info_list, start_rev_info, end_rev_info) where
1847
info_list is a list of (relative_path, file_id, kind) tuples where
1848
kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
1626
if revision is None:
1850
from builtins import _get_revision_range, safe_relpath_files
1851
tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
1852
# XXX: It's damn messy converting a list of paths to relative paths when
1853
# those paths might be deleted ones, they might be on a case-insensitive
1854
# filesystem and/or they might be in silly locations (like another branch).
1855
# For example, what should "log bzr://branch/dir/file1 file2" do? (Is
1856
# file2 implicitly in the same dir as file1 or should its directory be
1857
# taken from the current tree somehow?) For now, this solves the common
1858
# case of running log in a nested directory, assuming paths beyond the
1859
# first one haven't been deleted ...
1861
relpaths = [path] + safe_relpath_files(tree, file_list[1:])
1863
relpaths = [path] + file_list[1:]
1865
start_rev_info, end_rev_info = _get_revision_range(revisionspec_list, b,
1867
if relpaths in ([], [u'']):
1868
return b, [], start_rev_info, end_rev_info
1869
if start_rev_info is None and end_rev_info is None:
1627
1870
if tree is None:
1628
1871
tree = b.basis_tree()
1629
file_id = tree.path2id(fp)
1631
# go back to when time began
1633
rev1 = b.get_rev_id(1)
1634
except errors.NoSuchRevision:
1638
tree = b.repository.revision_tree(rev1)
1639
file_id = tree.path2id(fp)
1874
file_id = tree.path2id(fp)
1875
kind = _get_kind_for_file_id(tree, file_id)
1877
# go back to when time began
1880
rev1 = b.get_rev_id(1)
1881
except errors.NoSuchRevision:
1886
tree1 = b.repository.revision_tree(rev1)
1888
file_id = tree1.path2id(fp)
1889
kind = _get_kind_for_file_id(tree1, file_id)
1890
info_list.append((fp, file_id, kind))
1641
elif len(revision) == 1:
1892
elif start_rev_info == end_rev_info:
1642
1893
# One revision given - file must exist in it
1643
tree = revision[0].as_tree(b)
1644
file_id = tree.path2id(fp)
1894
tree = b.repository.revision_tree(end_rev_info.rev_id)
1896
file_id = tree.path2id(fp)
1897
kind = _get_kind_for_file_id(tree, file_id)
1898
info_list.append((fp, file_id, kind))
1646
elif len(revision) == 2:
1647
1901
# Revision range given. Get the file-id from the end tree.
1648
1902
# If that fails, try the start tree.
1649
rev_id = revision[1].as_revision_id(b)
1903
rev_id = end_rev_info.rev_id
1650
1904
if rev_id is None:
1651
1905
tree = b.basis_tree()
1653
tree = revision[1].as_tree(b)
1654
file_id = tree.path2id(fp)
1656
rev_id = revision[0].as_revision_id(b)
1658
rev1 = b.get_rev_id(1)
1659
tree = b.repository.revision_tree(rev1)
1661
tree = revision[0].as_tree(b)
1907
tree = b.repository.revision_tree(rev_id)
1662
1910
file_id = tree.path2id(fp)
1911
kind = _get_kind_for_file_id(tree, file_id)
1914
rev_id = start_rev_info.rev_id
1916
rev1 = b.get_rev_id(1)
1917
tree1 = b.repository.revision_tree(rev1)
1919
tree1 = b.repository.revision_tree(rev_id)
1920
file_id = tree1.path2id(fp)
1921
kind = _get_kind_for_file_id(tree1, file_id)
1922
info_list.append((fp, file_id, kind))
1923
return b, info_list, start_rev_info, end_rev_info
1926
def _get_kind_for_file_id(tree, file_id):
1927
"""Return the kind of a file-id or None if it doesn't exist."""
1928
if file_id is not None:
1929
return tree.kind(file_id)
1664
raise errors.BzrCommandError(
1665
'bzr log --revision takes one or two values.')
1669
1934
properties_handler_registry = registry.Registry()
1670
properties_handler_registry.register_lazy("foreign",
1672
"show_foreign_properties")
1675
1937
# adapters which revision ids to log are filtered. When log is called, the
added
removed
bzrlib/log.py
