116
150
direction='reverse',
117
151
start_revision=None,
118
152
end_revision=None,
120
156
"""Write out human-readable log of commits to this branch.
123
LogFormatter object to show the output.
126
If true, list only the commits affecting the specified
127
file, rather than all commits.
130
If true show added/changed/deleted/renamed files.
133
'reverse' (default) is latest to earliest;
134
'forward' is earliest to latest.
137
If not None, only show revisions >= start_revision
140
If not None, only show revisions <= end_revision
142
from bzrlib.osutils import format_date
143
from bzrlib.errors import BzrCheckError
144
from bzrlib.textui import show_status
146
from warnings import warn
148
if not isinstance(lf, LogFormatter):
149
warn("not a LogFormatter instance: %r" % lf)
152
mutter('get log for file_id %r' % specific_fileid)
154
if search is not None:
156
searchRE = re.compile(search, re.IGNORECASE)
160
which_revs = _enumerate_history(branch)
162
if start_revision is None:
165
branch.check_real_revno(start_revision)
167
if end_revision is None:
168
end_revision = len(which_revs)
170
branch.check_real_revno(end_revision)
172
# list indexes are 0-based; revisions are 1-based
173
cut_revs = which_revs[(start_revision-1):(end_revision)]
158
This function is being retained for backwards compatibility but
159
should not be extended with new parameters. Use the new Logger class
160
instead, eg. Logger(branch, rqst).show(lf), adding parameters to the
161
make_log_request_dict function.
163
:param lf: The LogFormatter object showing the output.
165
:param specific_fileid: If not None, list only the commits affecting the
166
specified file, rather than all commits.
168
:param verbose: If True show added/changed/deleted/renamed files.
170
:param direction: 'reverse' (default) is latest to earliest; 'forward' is
173
:param start_revision: If not None, only show revisions >= start_revision
175
:param end_revision: If not None, only show revisions <= end_revision
177
:param search: If not None, only show revisions with matching commit
180
:param limit: If set, shows only 'limit' revisions, all revisions are shown
183
:param show_diff: If True, output a diff after each revision.
185
# Convert old-style parameters to new-style parameters
186
if specific_fileid is not None:
187
file_ids = [specific_fileid]
192
delta_type = 'partial'
199
diff_type = 'partial'
205
# Build the request and execute it
206
rqst = make_log_request_dict(direction=direction, specific_fileids=file_ids,
207
start_revision=start_revision, end_revision=end_revision,
208
limit=limit, message_search=search,
209
delta_type=delta_type, diff_type=diff_type)
210
Logger(branch, rqst).show(lf)
213
# Note: This needs to be kept this in sync with the defaults in
214
# make_log_request_dict() below
215
_DEFAULT_REQUEST_PARAMS = {
216
'direction': 'reverse',
218
'generate_tags': True,
219
'_match_using_deltas': True,
223
def make_log_request_dict(direction='reverse', specific_fileids=None,
224
start_revision=None, end_revision=None, limit=None,
225
message_search=None, levels=1, generate_tags=True, delta_type=None,
226
diff_type=None, _match_using_deltas=True):
227
"""Convenience function for making a logging request dictionary.
229
Using this function may make code slightly safer by ensuring
230
parameters have the correct names. It also provides a reference
231
point for documenting the supported parameters.
233
:param direction: 'reverse' (default) is latest to earliest;
234
'forward' is earliest to latest.
236
:param specific_fileids: If not None, only include revisions
237
affecting the specified files, rather than all revisions.
239
:param start_revision: If not None, only generate
240
revisions >= start_revision
242
:param end_revision: If not None, only generate
243
revisions <= end_revision
245
:param limit: If set, generate only 'limit' revisions, all revisions
246
are shown if None or 0.
248
:param message_search: If not None, only include revisions with
249
matching commit messages
251
:param levels: the number of levels of revisions to
252
generate; 1 for just the mainline; 0 for all levels.
254
:param generate_tags: If True, include tags for matched revisions.
256
:param delta_type: Either 'full', 'partial' or None.
257
'full' means generate the complete delta - adds/deletes/modifies/etc;
258
'partial' means filter the delta using specific_fileids;
259
None means do not generate any delta.
261
:param diff_type: Either 'full', 'partial' or None.
262
'full' means generate the complete diff - adds/deletes/modifies/etc;
263
'partial' means filter the diff using specific_fileids;
264
None means do not generate any diff.
266
:param _match_using_deltas: a private parameter controlling the
267
algorithm used for matching specific_fileids. This parameter
268
may be removed in the future so bzrlib client code should NOT
272
'direction': direction,
273
'specific_fileids': specific_fileids,
274
'start_revision': start_revision,
275
'end_revision': end_revision,
277
'message_search': message_search,
279
'generate_tags': generate_tags,
280
'delta_type': delta_type,
281
'diff_type': diff_type,
282
# Add 'private' attributes for features that may be deprecated
283
'_match_using_deltas': _match_using_deltas,
287
def _apply_log_request_defaults(rqst):
288
"""Apply default values to a request dictionary."""
289
result = _DEFAULT_REQUEST_PARAMS
295
class LogGenerator(object):
296
"""A generator of log revisions."""
298
def iter_log_revisions(self):
299
"""Iterate over LogRevision objects.
301
:return: An iterator yielding LogRevision objects.
303
raise NotImplementedError(self.iter_log_revisions)
306
class Logger(object):
307
"""An object the generates, formats and displays a log."""
309
def __init__(self, branch, rqst):
312
:param branch: the branch to log
313
:param rqst: A dictionary specifying the query parameters.
314
See make_log_request_dict() for supported values.
317
self.rqst = _apply_log_request_defaults(rqst)
322
:param lf: The LogFormatter object to send the output to.
324
if not isinstance(lf, LogFormatter):
325
warn("not a LogFormatter instance: %r" % lf)
327
self.branch.lock_read()
329
if getattr(lf, 'begin_log', None):
332
if getattr(lf, 'end_log', None):
337
def _show_body(self, lf):
338
"""Show the main log output.
340
Subclasses may wish to override this.
342
# Tweak the LogRequest based on what the LogFormatter can handle.
343
# (There's no point generating stuff if the formatter can't display it.)
345
rqst['levels'] = lf.get_levels()
346
if not getattr(lf, 'supports_tags', False):
347
rqst['generate_tags'] = False
348
if not getattr(lf, 'supports_delta', False):
349
rqst['delta_type'] = None
350
if not getattr(lf, 'supports_diff', False):
351
rqst['diff_type'] = None
353
# Find and print the interesting revisions
354
generator = self._generator_factory(self.branch, rqst)
355
for lr in generator.iter_log_revisions():
359
def _generator_factory(self, branch, rqst):
360
"""Make the LogGenerator object to use.
362
Subclasses may wish to override this.
364
return _DefaultLogGenerator(branch, rqst)
367
class _StartNotLinearAncestor(Exception):
368
"""Raised when a start revision is not found walking left-hand history."""
371
class _DefaultLogGenerator(LogGenerator):
372
"""The default generator of log revisions."""
374
def __init__(self, branch, rqst):
377
if rqst.get('generate_tags') and branch.supports_tags():
378
self.rev_tag_dict = branch.tags.get_reverse_tag_dict()
380
self.rev_tag_dict = {}
382
def iter_log_revisions(self):
383
"""Iterate over LogRevision objects.
385
:return: An iterator yielding LogRevision objects.
388
levels = rqst.get('levels')
389
limit = rqst.get('limit')
390
diff_type = rqst.get('diff_type')
392
revision_iterator = self._create_log_revision_iterator()
393
for revs in revision_iterator:
394
for (rev_id, revno, merge_depth), rev, delta in revs:
395
# 0 levels means show everything; merge_depth counts from 0
396
if levels != 0 and merge_depth >= levels:
398
if diff_type is None:
401
diff = self._format_diff(rev, rev_id, diff_type)
402
yield LogRevision(rev, revno, merge_depth, delta,
403
self.rev_tag_dict.get(rev_id), diff)
406
if log_count >= limit:
409
def _format_diff(self, rev, rev_id, diff_type):
410
repo = self.branch.repository
411
if len(rev.parent_ids) == 0:
412
ancestor_id = _mod_revision.NULL_REVISION
414
ancestor_id = rev.parent_ids[0]
415
tree_1 = repo.revision_tree(ancestor_id)
416
tree_2 = repo.revision_tree(rev_id)
417
file_ids = self.rqst.get('specific_fileids')
418
if diff_type == 'partial' and file_ids is not None:
419
specific_files = [tree_2.id2path(id) for id in file_ids]
421
specific_files = None
423
diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
427
def _create_log_revision_iterator(self):
428
"""Create a revision iterator for log.
430
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
433
self.start_rev_id, self.end_rev_id = _get_revision_limits(
434
self.branch, self.rqst.get('start_revision'),
435
self.rqst.get('end_revision'))
436
if self.rqst.get('_match_using_deltas'):
437
return self._log_revision_iterator_using_delta_matching()
439
# We're using the per-file-graph algorithm. This scales really
440
# well but only makes sense if there is a single file and it's
442
file_count = len(self.rqst.get('specific_fileids'))
444
raise BzrError("illegal LogRequest: must match-using-deltas "
445
"when logging %d files" % file_count)
446
return self._log_revision_iterator_using_per_file_graph()
448
def _log_revision_iterator_using_delta_matching(self):
449
# Get the base revisions, filtering by the revision range
451
generate_merge_revisions = rqst.get('levels') != 1
452
delayed_graph_generation = not rqst.get('specific_fileids') and (
453
rqst.get('limit') or self.start_rev_id or self.end_rev_id)
454
view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
455
self.end_rev_id, rqst.get('direction'), generate_merge_revisions,
456
delayed_graph_generation=delayed_graph_generation)
458
# Apply the other filters
459
return make_log_rev_iterator(self.branch, view_revisions,
460
rqst.get('delta_type'), rqst.get('message_search'),
461
file_ids=rqst.get('specific_fileids'),
462
direction=rqst.get('direction'))
464
def _log_revision_iterator_using_per_file_graph(self):
465
# Get the base revisions, filtering by the revision range.
466
# Note that we always generate the merge revisions because
467
# filter_revisions_touching_file_id() requires them ...
469
view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
470
self.end_rev_id, rqst.get('direction'), True)
471
if not isinstance(view_revisions, list):
472
view_revisions = list(view_revisions)
473
view_revisions = _filter_revisions_touching_file_id(self.branch,
474
rqst.get('specific_fileids')[0], view_revisions,
475
include_merges=rqst.get('levels') != 1)
476
return make_log_rev_iterator(self.branch, view_revisions,
477
rqst.get('delta_type'), rqst.get('message_search'))
480
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
481
generate_merge_revisions, delayed_graph_generation=False):
482
"""Calculate the revisions to view.
484
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
485
a list of the same tuples.
487
br_revno, br_rev_id = branch.last_revision_info()
491
# If a single revision is requested, check we can handle it
492
generate_single_revision = (end_rev_id and start_rev_id == end_rev_id and
493
(not generate_merge_revisions or not _has_merges(branch, end_rev_id)))
494
if generate_single_revision:
495
return _generate_one_revision(branch, end_rev_id, br_rev_id, br_revno)
497
# If we only want to see linear revisions, we can iterate ...
498
if not generate_merge_revisions:
499
return _generate_flat_revisions(branch, start_rev_id, end_rev_id,
502
return _generate_all_revisions(branch, start_rev_id, end_rev_id,
503
direction, delayed_graph_generation)
506
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
507
if rev_id == br_rev_id:
509
return [(br_rev_id, br_revno, 0)]
511
revno = branch.revision_id_to_dotted_revno(rev_id)
512
revno_str = '.'.join(str(n) for n in revno)
513
return [(rev_id, revno_str, 0)]
516
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction):
517
result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
518
# If a start limit was given and it's not obviously an
519
# ancestor of the end limit, check it before outputting anything
520
if direction == 'forward' or (start_rev_id
521
and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
523
result = list(result)
524
except _StartNotLinearAncestor:
525
raise errors.BzrCommandError('Start revision not found in'
526
' left-hand history of end revision.')
527
if direction == 'forward':
528
result = reversed(result)
532
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
533
delayed_graph_generation):
534
# On large trees, generating the merge graph can take 30-60 seconds
535
# so we delay doing it until a merge is detected, incrementally
536
# returning initial (non-merge) revisions while we can.
537
initial_revisions = []
538
if delayed_graph_generation:
540
for rev_id, revno, depth in \
541
_linear_view_revisions(branch, start_rev_id, end_rev_id):
542
if _has_merges(branch, rev_id):
546
initial_revisions.append((rev_id, revno, depth))
548
# No merged revisions found
549
if direction == 'reverse':
550
return initial_revisions
551
elif direction == 'forward':
552
return reversed(initial_revisions)
554
raise ValueError('invalid direction %r' % direction)
555
except _StartNotLinearAncestor:
556
# A merge was never detected so the lower revision limit can't
557
# be nested down somewhere
558
raise errors.BzrCommandError('Start revision not found in'
559
' history of end revision.')
561
# A log including nested merges is required. If the direction is reverse,
562
# we rebase the initial merge depths so that the development line is
563
# shown naturally, i.e. just like it is for linear logging. We can easily
564
# make forward the exact opposite display, but showing the merge revisions
565
# indented at the end seems slightly nicer in that case.
566
view_revisions = chain(iter(initial_revisions),
567
_graph_view_revisions(branch, start_rev_id, end_rev_id,
568
rebase_initial_depths=direction == 'reverse'))
175
569
if direction == 'reverse':
570
return view_revisions
177
571
elif direction == 'forward':
572
# Forward means oldest first, adjusting for depth.
573
view_revisions = reverse_by_depth(list(view_revisions))
574
return _rebase_merge_depth(view_revisions)
180
576
raise ValueError('invalid direction %r' % direction)
182
for revno, rev_id in cut_revs:
183
if verbose or specific_fileid:
184
delta = branch.get_revision_delta(revno)
187
if not delta.touches_file_id(specific_fileid):
191
# although we calculated it, throw it away without display
194
rev = branch.get_revision(rev_id)
197
if not searchRE.search(rev.message):
200
lf.show(revno, rev, delta)
204
def deltas_for_log_dummy(branch, which_revs):
205
"""Return all the revisions without intermediate deltas.
207
Useful for log commands that won't need the delta information.
579
def _has_merges(branch, rev_id):
580
"""Does a revision have multiple parents or not?"""
581
parents = branch.repository.get_parent_map([rev_id]).get(rev_id, [])
582
return len(parents) > 1
585
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
586
"""Is start_rev_id an obvious ancestor of end_rev_id?"""
587
if start_rev_id and end_rev_id:
588
start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
589
end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
590
if len(start_dotted) == 1 and len(end_dotted) == 1:
592
return start_dotted[0] <= end_dotted[0]
593
elif (len(start_dotted) == 3 and len(end_dotted) == 3 and
594
start_dotted[0:1] == end_dotted[0:1]):
595
# both on same development line
596
return start_dotted[2] <= end_dotted[2]
603
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
604
"""Calculate a sequence of revisions to view, newest to oldest.
606
:param start_rev_id: the lower revision-id
607
:param end_rev_id: the upper revision-id
608
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
609
:raises _StartNotLinearAncestor: if a start_rev_id is specified but
610
is not found walking the left-hand history
612
br_revno, br_rev_id = branch.last_revision_info()
613
repo = branch.repository
614
if start_rev_id is None and end_rev_id is None:
616
for revision_id in repo.iter_reverse_revision_history(br_rev_id):
617
yield revision_id, str(cur_revno), 0
620
if end_rev_id is None:
621
end_rev_id = br_rev_id
622
found_start = start_rev_id is None
623
for revision_id in repo.iter_reverse_revision_history(end_rev_id):
624
revno = branch.revision_id_to_dotted_revno(revision_id)
625
revno_str = '.'.join(str(n) for n in revno)
626
if not found_start and revision_id == start_rev_id:
627
yield revision_id, revno_str, 0
631
yield revision_id, revno_str, 0
634
raise _StartNotLinearAncestor()
637
def _graph_view_revisions(branch, start_rev_id, end_rev_id,
638
rebase_initial_depths=True):
639
"""Calculate revisions to view including merges, newest to oldest.
641
:param branch: the branch
642
:param start_rev_id: the lower revision-id
643
:param end_rev_id: the upper revision-id
644
:param rebase_initial_depth: should depths be rebased until a mainline
646
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
648
view_revisions = branch.iter_merge_sorted_revisions(
649
start_revision_id=end_rev_id, stop_revision_id=start_rev_id,
650
stop_rule="with-merges")
651
if not rebase_initial_depths:
652
for (rev_id, merge_depth, revno, end_of_merge
654
yield rev_id, '.'.join(map(str, revno)), merge_depth
656
# We're following a development line starting at a merged revision.
657
# We need to adjust depths down by the initial depth until we find
658
# a depth less than it. Then we use that depth as the adjustment.
659
# If and when we reach the mainline, depth adjustment ends.
660
depth_adjustment = None
661
for (rev_id, merge_depth, revno, end_of_merge
663
if depth_adjustment is None:
664
depth_adjustment = merge_depth
666
if merge_depth < depth_adjustment:
667
depth_adjustment = merge_depth
668
merge_depth -= depth_adjustment
669
yield rev_id, '.'.join(map(str, revno)), merge_depth
672
def calculate_view_revisions(branch, start_revision, end_revision, direction,
673
specific_fileid, generate_merge_revisions):
674
"""Calculate the revisions to view.
676
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
677
a list of the same tuples.
679
# This method is no longer called by the main code path.
680
# It is retained for API compatibility and may be deprecated
682
start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
684
view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
685
direction, generate_merge_revisions or specific_fileid))
687
view_revisions = _filter_revisions_touching_file_id(branch,
688
specific_fileid, view_revisions,
689
include_merges=generate_merge_revisions)
690
return _rebase_merge_depth(view_revisions)
693
def _rebase_merge_depth(view_revisions):
694
"""Adjust depths upwards so the top level is 0."""
695
# If either the first or last revision have a merge_depth of 0, we're done
696
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
697
min_depth = min([d for r,n,d in view_revisions])
699
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
700
return view_revisions
703
def make_log_rev_iterator(branch, view_revisions, generate_delta, search,
704
file_ids=None, direction='reverse'):
705
"""Create a revision iterator for log.
707
:param branch: The branch being logged.
708
:param view_revisions: The revisions being viewed.
709
:param generate_delta: Whether to generate a delta for each revision.
710
Permitted values are None, 'full' and 'partial'.
711
:param search: A user text search string.
712
:param file_ids: If non empty, only revisions matching one or more of
713
the file-ids are to be kept.
714
:param direction: the direction in which view_revisions is sorted
715
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
718
# Convert view_revisions into (view, None, None) groups to fit with
719
# the standard interface here.
720
if type(view_revisions) == list:
721
# A single batch conversion is faster than many incremental ones.
722
# As we have all the data, do a batch conversion.
723
nones = [None] * len(view_revisions)
724
log_rev_iterator = iter([zip(view_revisions, nones, nones)])
727
for view in view_revisions:
728
yield (view, None, None)
729
log_rev_iterator = iter([_convert()])
730
for adapter in log_adapters:
731
# It would be nicer if log adapters were first class objects
732
# with custom parameters. This will do for now. IGC 20090127
733
if adapter == _make_delta_filter:
734
log_rev_iterator = adapter(branch, generate_delta,
735
search, log_rev_iterator, file_ids, direction)
737
log_rev_iterator = adapter(branch, generate_delta,
738
search, log_rev_iterator)
739
return log_rev_iterator
742
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
743
"""Create a filtered iterator of log_rev_iterator matching on a regex.
745
:param branch: The branch being logged.
746
:param generate_delta: Whether to generate a delta for each revision.
747
:param search: A user text search string.
748
:param log_rev_iterator: An input iterator containing all revisions that
749
could be displayed, in lists.
750
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
754
return log_rev_iterator
755
searchRE = re_compile_checked(search, re.IGNORECASE,
756
'log message filter')
757
return _filter_message_re(searchRE, log_rev_iterator)
760
def _filter_message_re(searchRE, log_rev_iterator):
761
for revs in log_rev_iterator:
763
for (rev_id, revno, merge_depth), rev, delta in revs:
764
if searchRE.search(rev.message):
765
new_revs.append(((rev_id, revno, merge_depth), rev, delta))
769
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
770
fileids=None, direction='reverse'):
771
"""Add revision deltas to a log iterator if needed.
773
:param branch: The branch being logged.
774
:param generate_delta: Whether to generate a delta for each revision.
775
Permitted values are None, 'full' and 'partial'.
776
:param search: A user text search string.
777
:param log_rev_iterator: An input iterator containing all revisions that
778
could be displayed, in lists.
779
:param fileids: If non empty, only revisions matching one or more of
780
the file-ids are to be kept.
781
:param direction: the direction in which view_revisions is sorted
782
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
785
if not generate_delta and not fileids:
786
return log_rev_iterator
787
return _generate_deltas(branch.repository, log_rev_iterator,
788
generate_delta, fileids, direction)
791
def _generate_deltas(repository, log_rev_iterator, delta_type, fileids,
793
"""Create deltas for each batch of revisions in log_rev_iterator.
795
If we're only generating deltas for the sake of filtering against
796
file-ids, we stop generating deltas once all file-ids reach the
797
appropriate life-cycle point. If we're receiving data newest to
798
oldest, then that life-cycle point is 'add', otherwise it's 'remove'.
800
check_fileids = fileids is not None and len(fileids) > 0
802
fileid_set = set(fileids)
803
if direction == 'reverse':
809
for revs in log_rev_iterator:
810
# If we were matching against fileids and we've run out,
811
# there's nothing left to do
812
if check_fileids and not fileid_set:
814
revisions = [rev[1] for rev in revs]
816
if delta_type == 'full' and not check_fileids:
817
deltas = repository.get_deltas_for_revisions(revisions)
818
for rev, delta in izip(revs, deltas):
819
new_revs.append((rev[0], rev[1], delta))
821
deltas = repository.get_deltas_for_revisions(revisions, fileid_set)
822
for rev, delta in izip(revs, deltas):
824
if delta is None or not delta.has_changed():
827
_update_fileids(delta, fileid_set, stop_on)
828
if delta_type is None:
830
elif delta_type == 'full':
831
# If the file matches all the time, rebuilding
832
# a full delta like this in addition to a partial
833
# one could be slow. However, it's likely that
834
# most revisions won't get this far, making it
835
# faster to filter on the partial deltas and
836
# build the occasional full delta than always
837
# building full deltas and filtering those.
839
delta = repository.get_revision_delta(rev_id)
840
new_revs.append((rev[0], rev[1], delta))
844
def _update_fileids(delta, fileids, stop_on):
845
"""Update the set of file-ids to search based on file lifecycle events.
210
for revno, revision_id in which_revs:
211
yield revno, branch.get_revision(revision_id), None
214
def deltas_for_log_reverse(branch, which_revs):
215
"""Compute deltas for display in latest-to-earliest order.
221
Sequence of (revno, revision_id) for the subset of history to examine
224
Sequence of (revno, rev, delta)
226
The delta is from the given revision to the next one in the
227
sequence, which makes sense if the log is being displayed from
230
last_revno = last_revision_id = last_tree = None
231
for revno, revision_id in which_revs:
232
this_tree = branch.revision_tree(revision_id)
233
this_revision = branch.get_revision(revision_id)
236
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
238
this_tree = EmptyTree(branch.get_root_id())
241
last_revision = this_revision
242
last_tree = this_tree
246
this_tree = EmptyTree(branch.get_root_id())
248
this_revno = last_revno - 1
249
this_revision_id = branch.revision_history()[this_revno]
250
this_tree = branch.revision_tree(this_revision_id)
251
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
254
def deltas_for_log_forward(branch, which_revs):
255
"""Compute deltas for display in forward log.
257
Given a sequence of (revno, revision_id) pairs, return
260
The delta is from the given revision to the next one in the
261
sequence, which makes sense if the log is being displayed from
264
last_revno = last_revision_id = last_tree = None
265
prev_tree = EmptyTree(branch.get_root_id())
267
for revno, revision_id in which_revs:
268
this_tree = branch.revision_tree(revision_id)
269
this_revision = branch.get_revision(revision_id)
273
last_tree = EmptyTree(branch.get_root_id())
847
:param fileids: a set of fileids to update
848
:param stop_on: either 'add' or 'remove' - take file-ids out of the
849
fileids set once their add or remove entry is detected respectively
852
for item in delta.added:
853
if item[1] in fileids:
854
fileids.remove(item[1])
855
elif stop_on == 'delete':
856
for item in delta.removed:
857
if item[1] in fileids:
858
fileids.remove(item[1])
861
def _make_revision_objects(branch, generate_delta, search, log_rev_iterator):
862
"""Extract revision objects from the repository
864
:param branch: The branch being logged.
865
:param generate_delta: Whether to generate a delta for each revision.
866
:param search: A user text search string.
867
:param log_rev_iterator: An input iterator containing all revisions that
868
could be displayed, in lists.
869
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
872
repository = branch.repository
873
for revs in log_rev_iterator:
874
# r = revision_id, n = revno, d = merge depth
875
revision_ids = [view[0] for view, _, _ in revs]
876
revisions = repository.get_revisions(revision_ids)
877
revs = [(rev[0], revision, rev[2]) for rev, revision in
878
izip(revs, revisions)]
882
def _make_batch_filter(branch, generate_delta, search, log_rev_iterator):
883
"""Group up a single large batch into smaller ones.
885
:param branch: The branch being logged.
886
:param generate_delta: Whether to generate a delta for each revision.
887
:param search: A user text search string.
888
:param log_rev_iterator: An input iterator containing all revisions that
889
could be displayed, in lists.
890
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
893
repository = branch.repository
895
for batch in log_rev_iterator:
898
step = [detail for _, detail in zip(range(num), batch)]
902
num = min(int(num * 1.5), 200)
905
def _get_revision_limits(branch, start_revision, end_revision):
906
"""Get and check revision limits.
908
:param branch: The branch containing the revisions.
910
:param start_revision: The first revision to be logged.
911
For backwards compatibility this may be a mainline integer revno,
912
but for merge revision support a RevisionInfo is expected.
914
:param end_revision: The last revision to be logged.
915
For backwards compatibility this may be a mainline integer revno,
916
but for merge revision support a RevisionInfo is expected.
918
:return: (start_rev_id, end_rev_id) tuple.
920
branch_revno, branch_rev_id = branch.last_revision_info()
922
if start_revision is None:
925
if isinstance(start_revision, revisionspec.RevisionInfo):
926
start_rev_id = start_revision.rev_id
927
start_revno = start_revision.revno or 1
929
branch.check_real_revno(start_revision)
930
start_revno = start_revision
931
start_rev_id = branch.get_rev_id(start_revno)
934
if end_revision is None:
935
end_revno = branch_revno
937
if isinstance(end_revision, revisionspec.RevisionInfo):
938
end_rev_id = end_revision.rev_id
939
end_revno = end_revision.revno or branch_revno
941
branch.check_real_revno(end_revision)
942
end_revno = end_revision
943
end_rev_id = branch.get_rev_id(end_revno)
945
if branch_revno != 0:
946
if (start_rev_id == _mod_revision.NULL_REVISION
947
or end_rev_id == _mod_revision.NULL_REVISION):
948
raise errors.BzrCommandError('Logging revision 0 is invalid.')
949
if start_revno > end_revno:
950
raise errors.BzrCommandError("Start revision must be older than "
952
return (start_rev_id, end_rev_id)
955
def _get_mainline_revs(branch, start_revision, end_revision):
956
"""Get the mainline revisions from the branch.
958
Generates the list of mainline revisions for the branch.
960
:param branch: The branch containing the revisions.
962
:param start_revision: The first revision to be logged.
963
For backwards compatibility this may be a mainline integer revno,
964
but for merge revision support a RevisionInfo is expected.
966
:param end_revision: The last revision to be logged.
967
For backwards compatibility this may be a mainline integer revno,
968
but for merge revision support a RevisionInfo is expected.
970
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
972
branch_revno, branch_last_revision = branch.last_revision_info()
973
if branch_revno == 0:
974
return None, None, None, None
976
# For mainline generation, map start_revision and end_revision to
977
# mainline revnos. If the revision is not on the mainline choose the
978
# appropriate extreme of the mainline instead - the extra will be
980
# Also map the revisions to rev_ids, to be used in the later filtering
983
if start_revision is None:
986
if isinstance(start_revision, revisionspec.RevisionInfo):
987
start_rev_id = start_revision.rev_id
988
start_revno = start_revision.revno or 1
990
branch.check_real_revno(start_revision)
991
start_revno = start_revision
994
if end_revision is None:
995
end_revno = branch_revno
997
if isinstance(end_revision, revisionspec.RevisionInfo):
998
end_rev_id = end_revision.rev_id
999
end_revno = end_revision.revno or branch_revno
1001
branch.check_real_revno(end_revision)
1002
end_revno = end_revision
1004
if ((start_rev_id == _mod_revision.NULL_REVISION)
1005
or (end_rev_id == _mod_revision.NULL_REVISION)):
1006
raise errors.BzrCommandError('Logging revision 0 is invalid.')
1007
if start_revno > end_revno:
1008
raise errors.BzrCommandError("Start revision must be older than "
1009
"the end revision.")
1011
if end_revno < start_revno:
1012
return None, None, None, None
1013
cur_revno = branch_revno
1016
for revision_id in branch.repository.iter_reverse_revision_history(
1017
branch_last_revision):
1018
if cur_revno < start_revno:
1019
# We have gone far enough, but we always add 1 more revision
1020
rev_nos[revision_id] = cur_revno
1021
mainline_revs.append(revision_id)
1023
if cur_revno <= end_revno:
1024
rev_nos[revision_id] = cur_revno
1025
mainline_revs.append(revision_id)
1028
# We walked off the edge of all revisions, so we add a 'None' marker
1029
mainline_revs.append(None)
1031
mainline_revs.reverse()
1033
# override the mainline to look like the revision history.
1034
return mainline_revs, rev_nos, start_rev_id, end_rev_id
1037
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
1038
"""Filter view_revisions based on revision ranges.
1040
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1041
tuples to be filtered.
1043
:param start_rev_id: If not NONE specifies the first revision to be logged.
1044
If NONE then all revisions up to the end_rev_id are logged.
1046
:param end_rev_id: If not NONE specifies the last revision to be logged.
1047
If NONE then all revisions up to the end of the log are logged.
1049
:return: The filtered view_revisions.
1051
# This method is no longer called by the main code path.
1052
# It may be removed soon. IGC 20090127
1053
if start_rev_id or end_rev_id:
1054
revision_ids = [r for r, n, d in view_revisions]
1056
start_index = revision_ids.index(start_rev_id)
1059
if start_rev_id == end_rev_id:
1060
end_index = start_index
1063
end_index = revision_ids.index(end_rev_id)
275
last_revno = revno - 1
276
last_revision_id = branch.revision_history()[last_revno]
277
last_tree = branch.revision_tree(last_revision_id)
279
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
282
last_revision = this_revision
283
last_tree = this_tree
1065
end_index = len(view_revisions) - 1
1066
# To include the revisions merged into the last revision,
1067
# extend end_rev_id down to, but not including, the next rev
1068
# with the same or lesser merge_depth
1069
end_merge_depth = view_revisions[end_index][2]
1071
for index in xrange(end_index+1, len(view_revisions)+1):
1072
if view_revisions[index][2] <= end_merge_depth:
1073
end_index = index - 1
1076
# if the search falls off the end then log to the end as well
1077
end_index = len(view_revisions) - 1
1078
view_revisions = view_revisions[start_index:end_index+1]
1079
return view_revisions
1082
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1083
include_merges=True):
1084
r"""Return the list of revision ids which touch a given file id.
1086
The function filters view_revisions and returns a subset.
1087
This includes the revisions which directly change the file id,
1088
and the revisions which merge these changes. So if the
1100
And 'C' changes a file, then both C and D will be returned. F will not be
1101
returned even though it brings the changes to C into the branch starting
1102
with E. (Note that if we were using F as the tip instead of G, then we
1105
This will also be restricted based on a subset of the mainline.
1107
:param branch: The branch where we can get text revision information.
1109
:param file_id: Filter out revisions that do not touch file_id.
1111
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1112
tuples. This is the list of revisions which will be filtered. It is
1113
assumed that view_revisions is in merge_sort order (i.e. newest
1116
:param include_merges: include merge revisions in the result or not
1118
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
1120
# Lookup all possible text keys to determine which ones actually modified
1122
text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
1124
# Looking up keys in batches of 1000 can cut the time in half, as well as
1125
# memory consumption. GraphIndex *does* like to look for a few keys in
1126
# parallel, it just doesn't like looking for *lots* of keys in parallel.
1127
# TODO: This code needs to be re-evaluated periodically as we tune the
1128
# indexing layer. We might consider passing in hints as to the known
1129
# access pattern (sparse/clustered, high success rate/low success
1130
# rate). This particular access is clustered with a low success rate.
1131
get_parent_map = branch.repository.texts.get_parent_map
1132
modified_text_revisions = set()
1134
for start in xrange(0, len(text_keys), chunk_size):
1135
next_keys = text_keys[start:start + chunk_size]
1136
# Only keep the revision_id portion of the key
1137
modified_text_revisions.update(
1138
[k[1] for k in get_parent_map(next_keys)])
1139
del text_keys, next_keys
1142
# Track what revisions will merge the current revision, replace entries
1143
# with 'None' when they have been added to result
1144
current_merge_stack = [None]
1145
for info in view_revisions:
1146
rev_id, revno, depth = info
1147
if depth == len(current_merge_stack):
1148
current_merge_stack.append(info)
1150
del current_merge_stack[depth + 1:]
1151
current_merge_stack[-1] = info
1153
if rev_id in modified_text_revisions:
1154
# This needs to be logged, along with the extra revisions
1155
for idx in xrange(len(current_merge_stack)):
1156
node = current_merge_stack[idx]
1157
if node is not None:
1158
if include_merges or node[2] == 0:
1160
current_merge_stack[idx] = None
1164
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
1165
include_merges=True):
1166
"""Produce an iterator of revisions to show
1167
:return: an iterator of (revision_id, revno, merge_depth)
1168
(if there is no revno for a revision, None is supplied)
1170
# This method is no longer called by the main code path.
1171
# It is retained for API compatibility and may be deprecated
1172
# soon. IGC 20090127
1173
if not include_merges:
1174
revision_ids = mainline_revs[1:]
1175
if direction == 'reverse':
1176
revision_ids.reverse()
1177
for revision_id in revision_ids:
1178
yield revision_id, str(rev_nos[revision_id]), 0
1180
graph = branch.repository.get_graph()
1181
# This asks for all mainline revisions, which means we only have to spider
1182
# sideways, rather than depth history. That said, its still size-of-history
1183
# and should be addressed.
1184
# mainline_revisions always includes an extra revision at the beginning, so
1186
parent_map = dict(((key, value) for key, value in
1187
graph.iter_ancestry(mainline_revs[1:]) if value is not None))
1188
# filter out ghosts; merge_sort errors on ghosts.
1189
rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
1190
merge_sorted_revisions = tsort.merge_sort(
1194
generate_revno=True)
1196
if direction == 'forward':
1197
# forward means oldest first.
1198
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
1199
elif direction != 'reverse':
1200
raise ValueError('invalid direction %r' % direction)
1202
for (sequence, rev_id, merge_depth, revno, end_of_merge
1203
) in merge_sorted_revisions:
1204
yield rev_id, '.'.join(map(str, revno)), merge_depth
1207
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1208
"""Reverse revisions by depth.
1210
Revisions with a different depth are sorted as a group with the previous
1211
revision of that depth. There may be no topological justification for this,
1212
but it looks much nicer.
1214
# Add a fake revision at start so that we can always attach sub revisions
1215
merge_sorted_revisions = [(None, None, _depth)] + merge_sorted_revisions
1217
for val in merge_sorted_revisions:
1218
if val[2] == _depth:
1219
# Each revision at the current depth becomes a chunk grouping all
1220
# higher depth revisions.
1221
zd_revisions.append([val])
1223
zd_revisions[-1].append(val)
1224
for revisions in zd_revisions:
1225
if len(revisions) > 1:
1226
# We have higher depth revisions, let reverse them locally
1227
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
1228
zd_revisions.reverse()
1230
for chunk in zd_revisions:
1231
result.extend(chunk)
1233
# Top level call, get rid of the fake revisions that have been added
1234
result = [r for r in result if r[0] is not None and r[1] is not None]
1238
class LogRevision(object):
1239
"""A revision to be logged (by LogFormatter.log_revision).
1241
A simple wrapper for the attributes of a revision to be logged.
1242
The attributes may or may not be populated, as determined by the
1243
logging options and the log formatter capabilities.
1246
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1247
tags=None, diff=None):
1249
self.revno = str(revno)
1250
self.merge_depth = merge_depth
286
1256
class LogFormatter(object):
287
"""Abstract class to display log messages."""
288
def __init__(self, to_file, show_ids=False, show_timezone='original'):
1257
"""Abstract class to display log messages.
1259
At a minimum, a derived class must implement the log_revision method.
1261
If the LogFormatter needs to be informed of the beginning or end of
1262
a log it should implement the begin_log and/or end_log hook methods.
1264
A LogFormatter should define the following supports_XXX flags
1265
to indicate which LogRevision attributes it supports:
1267
- supports_delta must be True if this log formatter supports delta.
1268
Otherwise the delta attribute may not be populated. The 'delta_format'
1269
attribute describes whether the 'short_status' format (1) or the long
1270
one (2) should be used.
1272
- supports_merge_revisions must be True if this log formatter supports
1273
merge revisions. If not, then only mainline revisions will be passed
1276
- preferred_levels is the number of levels this formatter defaults to.
1277
The default value is zero meaning display all levels.
1278
This value is only relevant if supports_merge_revisions is True.
1280
- supports_tags must be True if this log formatter supports tags.
1281
Otherwise the tags attribute may not be populated.
1283
- supports_diff must be True if this log formatter supports diffs.
1284
Otherwise the diff attribute may not be populated.
1286
Plugins can register functions to show custom revision properties using
1287
the properties_handler_registry. The registered function
1288
must respect the following interface description:
1289
def my_show_properties(properties_dict):
1290
# code that returns a dict {'name':'value'} of the properties
1293
preferred_levels = 0
1295
def __init__(self, to_file, show_ids=False, show_timezone='original',
1296
delta_format=None, levels=None, show_advice=False,
1297
to_exact_file=None):
1298
"""Create a LogFormatter.
1300
:param to_file: the file to output to
1301
:param to_exact_file: if set, gives an output stream to which
1302
non-Unicode diffs are written.
1303
:param show_ids: if True, revision-ids are to be displayed
1304
:param show_timezone: the timezone to use
1305
:param delta_format: the level of delta information to display
1306
or None to leave it to the formatter to decide
1307
:param levels: the number of levels to display; None or -1 to
1308
let the log formatter decide.
1309
:param show_advice: whether to show advice at the end of the
289
1312
self.to_file = to_file
1313
# 'exact' stream used to show diff, it should print content 'as is'
1314
# and should not try to decode/encode it to unicode to avoid bug #328007
1315
if to_exact_file is not None:
1316
self.to_exact_file = to_exact_file
1318
# XXX: somewhat hacky; this assumes it's a codec writer; it's better
1319
# for code that expects to get diffs to pass in the exact file
1321
self.to_exact_file = getattr(to_file, 'stream', to_file)
290
1322
self.show_ids = show_ids
291
1323
self.show_timezone = show_timezone
294
def show(self, revno, rev, delta):
1324
if delta_format is None:
1325
# Ensures backward compatibility
1326
delta_format = 2 # long format
1327
self.delta_format = delta_format
1328
self.levels = levels
1329
self._show_advice = show_advice
1330
self._merge_count = 0
1332
def get_levels(self):
1333
"""Get the number of levels to display or 0 for all."""
1334
if getattr(self, 'supports_merge_revisions', False):
1335
if self.levels is None or self.levels == -1:
1336
self.levels = self.preferred_levels
1341
def log_revision(self, revision):
1344
:param revision: The LogRevision to be logged.
295
1346
raise NotImplementedError('not implemented in abstract base')
1348
def show_advice(self):
1349
"""Output user advice, if any, when the log is completed."""
1350
if self._show_advice and self.levels == 1 and self._merge_count > 0:
1351
advice_sep = self.get_advice_separator()
1353
self.to_file.write(advice_sep)
1355
"Use --include-merges or -n0 to see merged revisions.\n")
1357
def get_advice_separator(self):
1358
"""Get the text separating the log from the closing advice."""
1361
def short_committer(self, rev):
1362
name, address = config.parse_username(rev.committer)
1367
def short_author(self, rev):
1368
name, address = config.parse_username(rev.get_apparent_authors()[0])
1373
def merge_marker(self, revision):
1374
"""Get the merge marker to include in the output or '' if none."""
1375
if len(revision.rev.parent_ids) > 1:
1376
self._merge_count += 1
1381
def show_properties(self, revision, indent):
1382
"""Displays the custom properties returned by each registered handler.
1384
If a registered handler raises an error it is propagated.
1386
for line in self.custom_properties(revision):
1387
self.to_file.write("%s%s\n" % (indent, line))
1389
def custom_properties(self, revision):
1390
"""Format the custom properties returned by each registered handler.
1392
If a registered handler raises an error it is propagated.
1394
:return: a list of formatted lines (excluding trailing newlines)
1396
lines = self._foreign_info_properties(revision)
1397
for key, handler in properties_handler_registry.iteritems():
1398
lines.extend(self._format_properties(handler(revision)))
1401
def _foreign_info_properties(self, rev):
1402
"""Custom log displayer for foreign revision identifiers.
1404
:param rev: Revision object.
1406
# Revision comes directly from a foreign repository
1407
if isinstance(rev, foreign.ForeignRevision):
1408
return rev.mapping.vcs.show_foreign_revid(rev.foreign_revid)
1410
# Imported foreign revision revision ids always contain :
1411
if not ":" in rev.revision_id:
1414
# Revision was once imported from a foreign repository
1416
foreign_revid, mapping = \
1417
foreign.foreign_vcs_registry.parse_revision_id(rev.revision_id)
1418
except errors.InvalidRevisionId:
1421
return self._format_properties(
1422
mapping.vcs.show_foreign_revid(foreign_revid))
1424
def _format_properties(self, properties):
1426
for key, value in properties.items():
1427
lines.append(key + ': ' + value)
1430
def show_diff(self, to_file, diff, indent):
1431
for l in diff.rstrip().split('\n'):
1432
to_file.write(indent + '%s\n' % (l,))
1435
# Separator between revisions in long format
1436
_LONG_SEP = '-' * 60
302
1439
class LongLogFormatter(LogFormatter):
303
def show(self, revno, rev, delta):
304
from osutils import format_date
1441
supports_merge_revisions = True
1442
preferred_levels = 1
1443
supports_delta = True
1444
supports_tags = True
1445
supports_diff = True
1447
def __init__(self, *args, **kwargs):
1448
super(LongLogFormatter, self).__init__(*args, **kwargs)
1449
if self.show_timezone == 'original':
1450
self.date_string = self._date_string_original_timezone
1452
self.date_string = self._date_string_with_timezone
1454
def _date_string_with_timezone(self, rev):
1455
return format_date(rev.timestamp, rev.timezone or 0,
1458
def _date_string_original_timezone(self, rev):
1459
return format_date_with_offset_in_original_timezone(rev.timestamp,
1462
def log_revision(self, revision):
1463
"""Log a revision, either merged or not."""
1464
indent = ' ' * revision.merge_depth
1466
if revision.revno is not None:
1467
lines.append('revno: %s%s' % (revision.revno,
1468
self.merge_marker(revision)))
1470
lines.append('tags: %s' % (', '.join(revision.tags)))
1472
lines.append('revision-id: %s' % (revision.rev.revision_id,))
1473
for parent_id in revision.rev.parent_ids:
1474
lines.append('parent: %s' % (parent_id,))
1475
lines.extend(self.custom_properties(revision.rev))
1477
committer = revision.rev.committer
1478
authors = revision.rev.get_apparent_authors()
1479
if authors != [committer]:
1480
lines.append('author: %s' % (", ".join(authors),))
1481
lines.append('committer: %s' % (committer,))
1483
branch_nick = revision.rev.properties.get('branch-nick', None)
1484
if branch_nick is not None:
1485
lines.append('branch nick: %s' % (branch_nick,))
1487
lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1489
lines.append('message:')
1490
if not revision.rev.message:
1491
lines.append(' (no message)')
1493
message = revision.rev.message.rstrip('\r\n')
1494
for l in message.split('\n'):
1495
lines.append(' %s' % (l,))
1497
# Dump the output, appending the delta and diff if requested
306
1498
to_file = self.to_file
308
print >>to_file, '-' * 60
309
print >>to_file, 'revno:', revno
311
print >>to_file, 'revision-id:', rev.revision_id
313
for parent in rev.parents:
314
print >>to_file, 'parent:', parent.revision_id
316
print >>to_file, 'committer:', rev.committer
318
date_str = format_date(rev.timestamp,
321
print >>to_file, 'timestamp: %s' % date_str
323
print >>to_file, 'message:'
325
print >>to_file, ' (no message)'
327
for l in rev.message.split('\n'):
328
print >>to_file, ' ' + l
331
delta.show(to_file, self.show_ids)
1499
to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
1500
if revision.delta is not None:
1501
# We don't respect delta_format for compatibility
1502
revision.delta.show(to_file, self.show_ids, indent=indent,
1504
if revision.diff is not None:
1505
to_file.write(indent + 'diff:\n')
1507
# Note: we explicitly don't indent the diff (relative to the
1508
# revision information) so that the output can be fed to patch -p0
1509
self.show_diff(self.to_exact_file, revision.diff, indent)
1510
self.to_exact_file.flush()
1512
def get_advice_separator(self):
1513
"""Get the text separating the log from the closing advice."""
1514
return '-' * 60 + '\n'
335
1517
class ShortLogFormatter(LogFormatter):
336
def show(self, revno, rev, delta):
337
from bzrlib.osutils import format_date
1519
supports_merge_revisions = True
1520
preferred_levels = 1
1521
supports_delta = True
1522
supports_tags = True
1523
supports_diff = True
1525
def __init__(self, *args, **kwargs):
1526
super(ShortLogFormatter, self).__init__(*args, **kwargs)
1527
self.revno_width_by_depth = {}
1529
def log_revision(self, revision):
1530
# We need two indents: one per depth and one for the information
1531
# relative to that indent. Most mainline revnos are 5 chars or
1532
# less while dotted revnos are typically 11 chars or less. Once
1533
# calculated, we need to remember the offset for a given depth
1534
# as we might be starting from a dotted revno in the first column
1535
# and we want subsequent mainline revisions to line up.
1536
depth = revision.merge_depth
1537
indent = ' ' * depth
1538
revno_width = self.revno_width_by_depth.get(depth)
1539
if revno_width is None:
1540
if revision.revno.find('.') == -1:
1541
# mainline revno, e.g. 12345
1544
# dotted revno, e.g. 12345.10.55
1546
self.revno_width_by_depth[depth] = revno_width
1547
offset = ' ' * (revno_width + 1)
339
1549
to_file = self.to_file
341
print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
342
format_date(rev.timestamp, rev.timezone or 0,
1552
tags = ' {%s}' % (', '.join(revision.tags))
1553
to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1554
revision.revno, self.short_author(revision.rev),
1555
format_date(revision.rev.timestamp,
1556
revision.rev.timezone or 0,
1557
self.show_timezone, date_fmt="%Y-%m-%d",
1559
tags, self.merge_marker(revision)))
1560
self.show_properties(revision.rev, indent+offset)
344
1561
if self.show_ids:
345
print >>to_file, ' revision-id:', rev.revision_id
1562
to_file.write(indent + offset + 'revision-id:%s\n'
1563
% (revision.rev.revision_id,))
1564
if not revision.rev.message:
1565
to_file.write(indent + offset + '(no message)\n')
1567
message = revision.rev.message.rstrip('\r\n')
1568
for l in message.split('\n'):
1569
to_file.write(indent + offset + '%s\n' % (l,))
1571
if revision.delta is not None:
1572
revision.delta.show(to_file, self.show_ids, indent=indent + offset,
1573
short_status=self.delta_format==1)
1574
if revision.diff is not None:
1575
self.show_diff(self.to_exact_file, revision.diff, ' ')
1579
class LineLogFormatter(LogFormatter):
1581
supports_merge_revisions = True
1582
preferred_levels = 1
1583
supports_tags = True
1585
def __init__(self, *args, **kwargs):
1586
super(LineLogFormatter, self).__init__(*args, **kwargs)
1587
width = terminal_width()
1588
if width is not None:
1589
# we need one extra space for terminals that wrap on last char
1591
self._max_chars = width
1593
def truncate(self, str, max_len):
1594
if max_len is None or len(str) <= max_len:
1596
return str[:max_len-3] + '...'
1598
def date_string(self, rev):
1599
return format_date(rev.timestamp, rev.timezone or 0,
1600
self.show_timezone, date_fmt="%Y-%m-%d",
1603
def message(self, rev):
346
1604
if not rev.message:
347
print >>to_file, ' (no message)'
349
for l in rev.message.split('\n'):
350
print >>to_file, ' ' + l
352
# TODO: Why not show the modified files in a shorter form as
353
# well? rewrap them single lines of appropriate length
355
delta.show(to_file, self.show_ids)
360
FORMATTERS = {'long': LongLogFormatter,
361
'short': ShortLogFormatter,
1605
return '(no message)'
1609
def log_revision(self, revision):
1610
indent = ' ' * revision.merge_depth
1611
self.to_file.write(self.log_string(revision.revno, revision.rev,
1612
self._max_chars, revision.tags, indent))
1613
self.to_file.write('\n')
1615
def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1616
"""Format log info into one string. Truncate tail of string
1617
:param revno: revision number or None.
1618
Revision numbers counts from 1.
1619
:param rev: revision object
1620
:param max_chars: maximum length of resulting string
1621
:param tags: list of tags or None
1622
:param prefix: string to prefix each line
1623
:return: formatted truncated string
1627
# show revno only when is not None
1628
out.append("%s:" % revno)
1629
out.append(self.truncate(self.short_author(rev), 20))
1630
out.append(self.date_string(rev))
1631
if len(rev.parent_ids) > 1:
1632
out.append('[merge]')
1634
tag_str = '{%s}' % (', '.join(tags))
1636
out.append(rev.get_summary())
1637
return self.truncate(prefix + " ".join(out).rstrip('\n'), max_chars)
1640
class GnuChangelogLogFormatter(LogFormatter):
1642
supports_merge_revisions = True
1643
supports_delta = True
1645
def log_revision(self, revision):
1646
"""Log a revision, either merged or not."""
1647
to_file = self.to_file
1649
date_str = format_date(revision.rev.timestamp,
1650
revision.rev.timezone or 0,
1652
date_fmt='%Y-%m-%d',
1654
committer_str = revision.rev.committer.replace (' <', ' <')
1655
to_file.write('%s %s\n\n' % (date_str,committer_str))
1657
if revision.delta is not None and revision.delta.has_changed():
1658
for c in revision.delta.added + revision.delta.removed + revision.delta.modified:
1660
to_file.write('\t* %s:\n' % (path,))
1661
for c in revision.delta.renamed:
1662
oldpath,newpath = c[:2]
1663
# For renamed files, show both the old and the new path
1664
to_file.write('\t* %s:\n\t* %s:\n' % (oldpath,newpath))
1667
if not revision.rev.message:
1668
to_file.write('\tNo commit message\n')
1670
message = revision.rev.message.rstrip('\r\n')
1671
for l in message.split('\n'):
1672
to_file.write('\t%s\n' % (l.lstrip(),))
1676
def line_log(rev, max_chars):
1677
lf = LineLogFormatter(None)
1678
return lf.log_string(None, rev, max_chars)
1681
class LogFormatterRegistry(registry.Registry):
1682
"""Registry for log formatters"""
1684
def make_formatter(self, name, *args, **kwargs):
1685
"""Construct a formatter from arguments.
1687
:param name: Name of the formatter to construct. 'short', 'long' and
1688
'line' are built-in.
1690
return self.get(name)(*args, **kwargs)
1692
def get_default(self, branch):
1693
return self.get(branch.get_config().log_format())
1696
log_formatter_registry = LogFormatterRegistry()
1699
log_formatter_registry.register('short', ShortLogFormatter,
1700
'Moderately short log format')
1701
log_formatter_registry.register('long', LongLogFormatter,
1702
'Detailed log format')
1703
log_formatter_registry.register('line', LineLogFormatter,
1704
'Log format with one line per revision')
1705
log_formatter_registry.register('gnu-changelog', GnuChangelogLogFormatter,
1706
'Format used by GNU ChangeLog files')
1709
def register_formatter(name, formatter):
1710
log_formatter_registry.register(name, formatter)
365
1713
def log_formatter(name, *args, **kwargs):
366
from bzrlib.errors import BzrCommandError
1714
"""Construct a formatter from arguments.
1716
name -- Name of the formatter to construct; currently 'long', 'short' and
1717
'line' are supported.
369
return FORMATTERS[name](*args, **kwargs)
371
raise BzrCommandError("unknown log formatter: %r" % name)
1720
return log_formatter_registry.make_formatter(name, *args, **kwargs)
1722
raise errors.BzrCommandError("unknown log formatter: %r" % name)
373
1725
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
374
# deprecated; for compatability
1726
# deprecated; for compatibility
375
1727
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
376
1728
lf.show(revno, rev, delta)
1731
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1733
"""Show the change in revision history comparing the old revision history to the new one.
1735
:param branch: The branch where the revisions exist
1736
:param old_rh: The old revision history
1737
:param new_rh: The new revision history
1738
:param to_file: A file to write the results to. If None, stdout will be used
1741
to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
1743
lf = log_formatter(log_format,
1746
show_timezone='original')
1748
# This is the first index which is different between
1751
for i in xrange(max(len(new_rh),
1753
if (len(new_rh) <= i
1755
or new_rh[i] != old_rh[i]):
1759
if base_idx is None:
1760
to_file.write('Nothing seems to have changed\n')
1762
## TODO: It might be nice to do something like show_log
1763
## and show the merged entries. But since this is the
1764
## removed revisions, it shouldn't be as important
1765
if base_idx < len(old_rh):
1766
to_file.write('*'*60)
1767
to_file.write('\nRemoved Revisions:\n')
1768
for i in range(base_idx, len(old_rh)):
1769
rev = branch.repository.get_revision(old_rh[i])
1770
lr = LogRevision(rev, i+1, 0, None)
1772
to_file.write('*'*60)
1773
to_file.write('\n\n')
1774
if base_idx < len(new_rh):
1775
to_file.write('Added Revisions:\n')
1780
direction='forward',
1781
start_revision=base_idx+1,
1782
end_revision=len(new_rh),
1786
def get_history_change(old_revision_id, new_revision_id, repository):
1787
"""Calculate the uncommon lefthand history between two revisions.
1789
:param old_revision_id: The original revision id.
1790
:param new_revision_id: The new revision id.
1791
:param repository: The repository to use for the calculation.
1793
return old_history, new_history
1796
old_revisions = set()
1798
new_revisions = set()
1799
new_iter = repository.iter_reverse_revision_history(new_revision_id)
1800
old_iter = repository.iter_reverse_revision_history(old_revision_id)
1801
stop_revision = None
1804
while do_new or do_old:
1807
new_revision = new_iter.next()
1808
except StopIteration:
1811
new_history.append(new_revision)
1812
new_revisions.add(new_revision)
1813
if new_revision in old_revisions:
1814
stop_revision = new_revision
1818
old_revision = old_iter.next()
1819
except StopIteration:
1822
old_history.append(old_revision)
1823
old_revisions.add(old_revision)
1824
if old_revision in new_revisions:
1825
stop_revision = old_revision
1827
new_history.reverse()
1828
old_history.reverse()
1829
if stop_revision is not None:
1830
new_history = new_history[new_history.index(stop_revision) + 1:]
1831
old_history = old_history[old_history.index(stop_revision) + 1:]
1832
return old_history, new_history
1835
def show_branch_change(branch, output, old_revno, old_revision_id):
1836
"""Show the changes made to a branch.
1838
:param branch: The branch to show changes about.
1839
:param output: A file-like object to write changes to.
1840
:param old_revno: The revno of the old tip.
1841
:param old_revision_id: The revision_id of the old tip.
1843
new_revno, new_revision_id = branch.last_revision_info()
1844
old_history, new_history = get_history_change(old_revision_id,
1847
if old_history == [] and new_history == []:
1848
output.write('Nothing seems to have changed\n')
1851
log_format = log_formatter_registry.get_default(branch)
1852
lf = log_format(show_ids=False, to_file=output, show_timezone='original')
1853
if old_history != []:
1854
output.write('*'*60)
1855
output.write('\nRemoved Revisions:\n')
1856
show_flat_log(branch.repository, old_history, old_revno, lf)
1857
output.write('*'*60)
1858
output.write('\n\n')
1859
if new_history != []:
1860
output.write('Added Revisions:\n')
1861
start_revno = new_revno - len(new_history) + 1
1862
show_log(branch, lf, None, verbose=False, direction='forward',
1863
start_revision=start_revno,)
1866
def show_flat_log(repository, history, last_revno, lf):
1867
"""Show a simple log of the specified history.
1869
:param repository: The repository to retrieve revisions from.
1870
:param history: A list of revision_ids indicating the lefthand history.
1871
:param last_revno: The revno of the last revision_id in the history.
1872
:param lf: The log formatter to use.
1874
start_revno = last_revno - len(history) + 1
1875
revisions = repository.get_revisions(history)
1876
for i, rev in enumerate(revisions):
1877
lr = LogRevision(rev, i + last_revno, 0, None)
1881
def _get_info_for_log_files(revisionspec_list, file_list):
1882
"""Find file-ids and kinds given a list of files and a revision range.
1884
We search for files at the end of the range. If not found there,
1885
we try the start of the range.
1887
:param revisionspec_list: revision range as parsed on the command line
1888
:param file_list: the list of paths given on the command line;
1889
the first of these can be a branch location or a file path,
1890
the remainder must be file paths
1891
:return: (branch, info_list, start_rev_info, end_rev_info) where
1892
info_list is a list of (relative_path, file_id, kind) tuples where
1893
kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
1894
branch will be read-locked.
1896
from builtins import _get_revision_range, safe_relpath_files
1897
tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
1899
# XXX: It's damn messy converting a list of paths to relative paths when
1900
# those paths might be deleted ones, they might be on a case-insensitive
1901
# filesystem and/or they might be in silly locations (like another branch).
1902
# For example, what should "log bzr://branch/dir/file1 file2" do? (Is
1903
# file2 implicitly in the same dir as file1 or should its directory be
1904
# taken from the current tree somehow?) For now, this solves the common
1905
# case of running log in a nested directory, assuming paths beyond the
1906
# first one haven't been deleted ...
1908
relpaths = [path] + safe_relpath_files(tree, file_list[1:])
1910
relpaths = [path] + file_list[1:]
1912
start_rev_info, end_rev_info = _get_revision_range(revisionspec_list, b,
1914
if relpaths in ([], [u'']):
1915
return b, [], start_rev_info, end_rev_info
1916
if start_rev_info is None and end_rev_info is None:
1918
tree = b.basis_tree()
1921
file_id = tree.path2id(fp)
1922
kind = _get_kind_for_file_id(tree, file_id)
1924
# go back to when time began
1927
rev1 = b.get_rev_id(1)
1928
except errors.NoSuchRevision:
1933
tree1 = b.repository.revision_tree(rev1)
1935
file_id = tree1.path2id(fp)
1936
kind = _get_kind_for_file_id(tree1, file_id)
1937
info_list.append((fp, file_id, kind))
1939
elif start_rev_info == end_rev_info:
1940
# One revision given - file must exist in it
1941
tree = b.repository.revision_tree(end_rev_info.rev_id)
1943
file_id = tree.path2id(fp)
1944
kind = _get_kind_for_file_id(tree, file_id)
1945
info_list.append((fp, file_id, kind))
1948
# Revision range given. Get the file-id from the end tree.
1949
# If that fails, try the start tree.
1950
rev_id = end_rev_info.rev_id
1952
tree = b.basis_tree()
1954
tree = b.repository.revision_tree(rev_id)
1957
file_id = tree.path2id(fp)
1958
kind = _get_kind_for_file_id(tree, file_id)
1961
rev_id = start_rev_info.rev_id
1963
rev1 = b.get_rev_id(1)
1964
tree1 = b.repository.revision_tree(rev1)
1966
tree1 = b.repository.revision_tree(rev_id)
1967
file_id = tree1.path2id(fp)
1968
kind = _get_kind_for_file_id(tree1, file_id)
1969
info_list.append((fp, file_id, kind))
1970
return b, info_list, start_rev_info, end_rev_info
1973
def _get_kind_for_file_id(tree, file_id):
1974
"""Return the kind of a file-id or None if it doesn't exist."""
1975
if file_id is not None:
1976
return tree.kind(file_id)
1981
properties_handler_registry = registry.Registry()
1983
# Use the properties handlers to print out bug information if available
1984
def _bugs_properties_handler(revision):
1985
if revision.properties.has_key('bugs'):
1986
bug_lines = revision.properties['bugs'].split('\n')
1987
bug_rows = [line.split(' ', 1) for line in bug_lines]
1988
fixed_bug_urls = [row[0] for row in bug_rows if
1989
len(row) > 1 and row[1] == 'fixed']
1992
return {'fixes bug(s)': ' '.join(fixed_bug_urls)}
1995
properties_handler_registry.register('bugs_properties_handler',
1996
_bugs_properties_handler)
1999
# adapters which revision ids to log are filtered. When log is called, the
2000
# log_rev_iterator is adapted through each of these factory methods.
2001
# Plugins are welcome to mutate this list in any way they like - as long
2002
# as the overall behaviour is preserved. At this point there is no extensible
2003
# mechanism for getting parameters to each factory method, and until there is
2004
# this won't be considered a stable api.
2008
# read revision objects
2009
_make_revision_objects,
2010
# filter on log messages
2011
_make_search_filter,
2012
# generate deltas for things we will show
added
removed
bzrlib/log.py
