207
mainline_revs, rev_nos, start_rev_id, end_rev_id = \
208
_get_mainline_revs(branch, start_revision, end_revision)
209
if not mainline_revs:
212
if direction == 'reverse':
213
start_rev_id, end_rev_id = end_rev_id, start_rev_id
215
legacy_lf = getattr(lf, 'log_revision', None) is None
217
# pre-0.17 formatters use show for mainline revisions.
218
# how should we show merged revisions ?
219
# pre-0.11 api: show_merge
220
# 0.11-0.16 api: show_merge_revno
221
show_merge_revno = getattr(lf, 'show_merge_revno', None)
222
show_merge = getattr(lf, 'show_merge', None)
223
if show_merge is None and show_merge_revno is None:
224
# no merged-revno support
225
generate_merge_revisions = False
227
generate_merge_revisions = True
228
# tell developers to update their code
229
symbol_versioning.warn('LogFormatters should provide log_revision '
230
'instead of show and show_merge_revno since bzr 0.17.',
231
DeprecationWarning, stacklevel=3)
233
generate_merge_revisions = getattr(lf, 'supports_merge_revisions',
235
if ((not generate_merge_revisions)
236
and ((start_rev_id and (start_rev_id not in rev_nos))
237
or (end_rev_id and (end_rev_id not in rev_nos)))):
238
from bzrlib.errors import BzrCommandError
239
raise BzrCommandError('Selected log formatter only supports '
240
'mainline revisions.')
241
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
242
direction, include_merges=generate_merge_revisions)
243
view_revisions = _filter_revision_range(list(view_revs_iter),
247
view_revisions = _filter_revisions_touching_file_id(branch,
252
# rebase merge_depth - unless there are no revisions or
253
# either the first or last revision have merge_depth = 0.
254
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
255
min_depth = min([d for r,n,d in view_revisions])
257
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
260
generate_tags = getattr(lf, 'supports_tags', False)
262
if branch.supports_tags():
263
rev_tag_dict = branch.tags.get_reverse_tag_dict()
265
generate_delta = verbose and getattr(lf, 'supports_delta', False)
267
def iter_revisions():
268
# r = revision, n = revno, d = merge depth
269
revision_ids = [r for r, n, d in view_revisions]
271
repository = branch.repository
274
revisions = repository.get_revisions(revision_ids[:num])
276
deltas = repository.get_deltas_for_revisions(revisions)
277
cur_deltas = dict(izip((r.revision_id for r in revisions),
279
for revision in revisions:
280
yield revision, cur_deltas.get(revision.revision_id)
281
revision_ids = revision_ids[num:]
282
num = min(int(num * 1.5), 200)
284
# now we just print all the revisions
286
for ((rev_id, revno, merge_depth), (rev, delta)) in \
287
izip(view_revisions, iter_revisions()):
290
if not searchRE.search(rev.message):
294
lr = LogRevision(rev, revno, merge_depth, delta,
295
rev_tag_dict.get(rev_id))
298
# support for legacy (pre-0.17) LogFormatters
301
lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
303
lf.show(revno, rev, delta)
305
if show_merge_revno is None:
306
lf.show_merge(rev, merge_depth)
309
lf.show_merge_revno(rev, merge_depth, revno,
310
rev_tag_dict.get(rev_id))
312
lf.show_merge_revno(rev, merge_depth, revno)
315
if log_count >= limit:
319
def _get_mainline_revs(branch, start_revision, end_revision):
320
"""Get the mainline revisions from the branch.
322
Generates the list of mainline revisions for the branch.
324
:param branch: The branch containing the revisions.
326
:param start_revision: The first revision to be logged.
327
For backwards compatibility this may be a mainline integer revno,
328
but for merge revision support a RevisionInfo is expected.
330
:param end_revision: The last revision to be logged.
331
For backwards compatibility this may be a mainline integer revno,
332
but for merge revision support a RevisionInfo is expected.
334
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
161
336
which_revs = _enumerate_history(branch)
338
return None, None, None, None
340
# For mainline generation, map start_revision and end_revision to
341
# mainline revnos. If the revision is not on the mainline choose the
342
# appropriate extreme of the mainline instead - the extra will be
344
# Also map the revisions to rev_ids, to be used in the later filtering
163
347
if start_revision is None:
165
elif start_revision < 1 or start_revision >= len(which_revs):
166
raise InvalidRevisionNumber(start_revision)
350
if isinstance(start_revision,RevisionInfo):
351
start_rev_id = start_revision.rev_id
352
start_revno = start_revision.revno or 1
354
branch.check_real_revno(start_revision)
355
start_revno = start_revision
168
358
if end_revision is None:
169
end_revision = len(which_revs)
170
elif end_revision < 1 or end_revision >= len(which_revs):
171
raise InvalidRevisionNumber(end_revision)
359
end_revno = len(which_revs)
361
if isinstance(end_revision,RevisionInfo):
362
end_rev_id = end_revision.rev_id
363
end_revno = end_revision.revno or len(which_revs)
365
branch.check_real_revno(end_revision)
366
end_revno = end_revision
368
if ((start_rev_id == NULL_REVISION)
369
or (end_rev_id == NULL_REVISION)):
370
from bzrlib.errors import BzrCommandError
371
raise BzrCommandError('Logging revision 0 is invalid.')
372
if start_revno > end_revno:
373
from bzrlib.errors import BzrCommandError
374
raise BzrCommandError("Start revision must be older than "
173
377
# list indexes are 0-based; revisions are 1-based
174
cut_revs = which_revs[(start_revision-1):(end_revision)]
176
if direction == 'reverse':
178
elif direction == 'forward':
378
cut_revs = which_revs[(start_revno-1):(end_revno)]
380
return None, None, None, None
382
# convert the revision history to a dictionary:
383
rev_nos = dict((k, v) for v, k in cut_revs)
385
# override the mainline to look like the revision history.
386
mainline_revs = [revision_id for index, revision_id in cut_revs]
387
if cut_revs[0][0] == 1:
388
mainline_revs.insert(0, None)
390
mainline_revs.insert(0, which_revs[start_revno-2][1])
391
return mainline_revs, rev_nos, start_rev_id, end_rev_id
394
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
395
"""Filter view_revisions based on revision ranges.
397
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
398
tuples to be filtered.
400
:param start_rev_id: If not NONE specifies the first revision to be logged.
401
If NONE then all revisions up to the end_rev_id are logged.
403
:param end_rev_id: If not NONE specifies the last revision to be logged.
404
If NONE then all revisions up to the end of the log are logged.
406
:return: The filtered view_revisions.
408
if start_rev_id or end_rev_id:
409
revision_ids = [r for r, n, d in view_revisions]
411
start_index = revision_ids.index(start_rev_id)
414
if start_rev_id == end_rev_id:
415
end_index = start_index
418
end_index = revision_ids.index(end_rev_id)
420
end_index = len(view_revisions) - 1
421
# To include the revisions merged into the last revision,
422
# extend end_rev_id down to, but not including, the next rev
423
# with the same or lesser merge_depth
424
end_merge_depth = view_revisions[end_index][2]
426
for index in xrange(end_index+1, len(view_revisions)+1):
427
if view_revisions[index][2] <= end_merge_depth:
428
end_index = index - 1
431
# if the search falls off the end then log to the end as well
432
end_index = len(view_revisions) - 1
433
view_revisions = view_revisions[start_index:end_index+1]
434
return view_revisions
437
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
439
"""Return the list of revision ids which touch a given file id.
441
The function filters view_revisions and returns a subset.
442
This includes the revisions which directly change the file id,
443
and the revisions which merge these changes. So if the
451
And 'C' changes a file, then both C and D will be returned.
453
This will also can be restricted based on a subset of the mainline.
455
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
457
# find all the revisions that change the specific file
458
file_weave = branch.repository.weave_store.get_weave(file_id,
459
branch.repository.get_transaction())
460
weave_modifed_revisions = set(file_weave.versions())
461
# build the ancestry of each revision in the graph
462
# - only listing the ancestors that change the specific file.
463
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
464
sorted_rev_list = topo_sort(rev_graph)
466
for rev in sorted_rev_list:
467
parents = rev_graph[rev]
468
if rev not in weave_modifed_revisions and len(parents) == 1:
469
# We will not be adding anything new, so just use a reference to
470
# the parent ancestry.
471
rev_ancestry = ancestry[parents[0]]
474
if rev in weave_modifed_revisions:
475
rev_ancestry.add(rev)
476
for parent in parents:
477
rev_ancestry = rev_ancestry.union(ancestry[parent])
478
ancestry[rev] = rev_ancestry
480
def is_merging_rev(r):
481
parents = rev_graph[r]
483
leftparent = parents[0]
484
for rightparent in parents[1:]:
485
if not ancestry[leftparent].issuperset(
486
ancestry[rightparent]):
490
# filter from the view the revisions that did not change or merge
492
return [(r, n, d) for r, n, d in view_revs_iter
493
if r in weave_modifed_revisions or is_merging_rev(r)]
496
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
497
include_merges=True):
498
"""Produce an iterator of revisions to show
499
:return: an iterator of (revision_id, revno, merge_depth)
500
(if there is no revno for a revision, None is supplied)
502
if include_merges is False:
503
revision_ids = mainline_revs[1:]
504
if direction == 'reverse':
505
revision_ids.reverse()
506
for revision_id in revision_ids:
507
yield revision_id, str(rev_nos[revision_id]), 0
509
merge_sorted_revisions = merge_sort(
510
branch.repository.get_revision_graph(mainline_revs[-1]),
515
if direction == 'forward':
516
# forward means oldest first.
517
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
518
elif direction != 'reverse':
181
519
raise ValueError('invalid direction %r' % direction)
183
for revno, rev_id in cut_revs:
184
if verbose or specific_fileid:
185
delta = branch.get_revision_delta(revno)
188
if not delta.touches_file_id(specific_fileid):
192
# although we calculated it, throw it away without display
195
rev = branch.get_revision(rev_id)
198
if not searchRE.search(rev.message):
201
lf.show(revno, rev, delta)
205
def deltas_for_log_dummy(branch, which_revs):
206
"""Return all the revisions without intermediate deltas.
208
Useful for log commands that won't need the delta information.
211
for revno, revision_id in which_revs:
212
yield revno, branch.get_revision(revision_id), None
215
def deltas_for_log_reverse(branch, which_revs):
216
"""Compute deltas for display in latest-to-earliest order.
222
Sequence of (revno, revision_id) for the subset of history to examine
225
Sequence of (revno, rev, delta)
227
The delta is from the given revision to the next one in the
228
sequence, which makes sense if the log is being displayed from
231
last_revno = last_revision_id = last_tree = None
232
for revno, revision_id in which_revs:
233
this_tree = branch.revision_tree(revision_id)
234
this_revision = branch.get_revision(revision_id)
237
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
239
this_tree = EmptyTree(branch.get_root_id())
242
last_revision = this_revision
243
last_tree = this_tree
247
this_tree = EmptyTree(branch.get_root_id())
521
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
522
yield rev_id, '.'.join(map(str, revno)), merge_depth
525
def reverse_by_depth(merge_sorted_revisions, _depth=0):
526
"""Reverse revisions by depth.
528
Revisions with a different depth are sorted as a group with the previous
529
revision of that depth. There may be no topological justification for this,
530
but it looks much nicer.
533
for val in merge_sorted_revisions:
535
zd_revisions.append([val])
249
this_revno = last_revno - 1
250
this_revision_id = branch.revision_history()[this_revno]
251
this_tree = branch.revision_tree(this_revision_id)
252
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
255
def deltas_for_log_forward(branch, which_revs):
256
"""Compute deltas for display in forward log.
258
Given a sequence of (revno, revision_id) pairs, return
261
The delta is from the given revision to the next one in the
262
sequence, which makes sense if the log is being displayed from
537
assert val[2] > _depth
538
zd_revisions[-1].append(val)
539
for revisions in zd_revisions:
540
if len(revisions) > 1:
541
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
542
zd_revisions.reverse()
544
for chunk in zd_revisions:
549
class LogRevision(object):
550
"""A revision to be logged (by LogFormatter.log_revision).
552
A simple wrapper for the attributes of a revision to be logged.
553
The attributes may or may not be populated, as determined by the
554
logging options and the log formatter capabilities.
265
last_revno = last_revision_id = last_tree = None
266
prev_tree = EmptyTree(branch.get_root_id())
268
for revno, revision_id in which_revs:
269
this_tree = branch.revision_tree(revision_id)
270
this_revision = branch.get_revision(revision_id)
274
last_tree = EmptyTree(branch.get_root_id())
276
last_revno = revno - 1
277
last_revision_id = branch.revision_history()[last_revno]
278
last_tree = branch.revision_tree(last_revision_id)
280
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
283
last_revision = this_revision
284
last_tree = this_tree
557
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
561
self.merge_depth = merge_depth
287
566
class LogFormatter(object):
288
"""Abstract class to display log messages."""
567
"""Abstract class to display log messages.
569
At a minimum, a derived class must implement the log_revision method.
571
If the LogFormatter needs to be informed of the beginning or end of
572
a log it should implement the begin_log and/or end_log hook methods.
574
A LogFormatter should define the following supports_XXX flags
575
to indicate which LogRevision attributes it supports:
577
- supports_delta must be True if this log formatter supports delta.
578
Otherwise the delta attribute may not be populated.
579
- supports_merge_revisions must be True if this log formatter supports
580
merge revisions. If not, only mainline revisions (those
581
with merge_depth == 0) will be passed to the formatter.
582
- supports_tags must be True if this log formatter supports tags.
583
Otherwise the tags attribute may not be populated.
289
586
def __init__(self, to_file, show_ids=False, show_timezone='original'):
290
587
self.to_file = to_file
291
588
self.show_ids = show_ids
292
589
self.show_timezone = show_timezone
591
# TODO: uncomment this block after show() has been removed.
592
# Until then defining log_revision would prevent _show_log calling show()
593
# in legacy formatters.
594
# def log_revision(self, revision):
597
# :param revision: The LogRevision to be logged.
599
# raise NotImplementedError('not implemented in abstract base')
601
@deprecated_method(zero_seventeen)
295
602
def show(self, revno, rev, delta):
296
603
raise NotImplementedError('not implemented in abstract base')
605
def short_committer(self, rev):
606
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
608
def short_author(self, rev):
609
return re.sub('<.*@.*>', '', rev.get_apparent_author()).strip(' ')
303
612
class LongLogFormatter(LogFormatter):
304
def show(self, revno, rev, delta):
305
from osutils import format_date
614
supports_merge_revisions = True
615
supports_delta = True
618
@deprecated_method(zero_seventeen)
619
def show(self, revno, rev, delta, tags=None):
620
lr = LogRevision(rev, revno, 0, delta, tags)
621
return self.log_revision(lr)
623
@deprecated_method(zero_seventeen)
624
def show_merge_revno(self, rev, merge_depth, revno, tags=None):
625
"""Show a merged revision rev, with merge_depth and a revno."""
626
lr = LogRevision(rev, revno, merge_depth, tags=tags)
627
return self.log_revision(lr)
629
def log_revision(self, revision):
630
"""Log a revision, either merged or not."""
631
from bzrlib.osutils import format_date
632
indent = ' ' * revision.merge_depth
307
633
to_file = self.to_file
309
print >>to_file, '-' * 60
310
print >>to_file, 'revno:', revno
634
to_file.write(indent + '-' * 60 + '\n')
635
if revision.revno is not None:
636
to_file.write(indent + 'revno: %s\n' % (revision.revno,))
638
to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
311
639
if self.show_ids:
312
print >>to_file, 'revision-id:', rev.revision_id
313
print >>to_file, 'committer:', rev.committer
315
date_str = format_date(rev.timestamp,
640
to_file.write(indent + 'revision-id:' + revision.rev.revision_id)
642
for parent_id in revision.rev.parent_ids:
643
to_file.write(indent + 'parent: %s\n' % (parent_id,))
645
author = revision.rev.properties.get('author', None)
646
if author is not None:
647
to_file.write(indent + 'author: %s\n' % (author,))
648
to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
650
branch_nick = revision.rev.properties.get('branch-nick', None)
651
if branch_nick is not None:
652
to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
654
date_str = format_date(revision.rev.timestamp,
655
revision.rev.timezone or 0,
317
656
self.show_timezone)
318
print >>to_file, 'timestamp: %s' % date_str
657
to_file.write(indent + 'timestamp: %s\n' % (date_str,))
320
print >>to_file, 'message:'
322
print >>to_file, ' (no message)'
659
to_file.write(indent + 'message:\n')
660
if not revision.rev.message:
661
to_file.write(indent + ' (no message)\n')
324
for l in rev.message.split('\n'):
325
print >>to_file, ' ' + l
328
delta.show(to_file, self.show_ids)
663
message = revision.rev.message.rstrip('\r\n')
664
for l in message.split('\n'):
665
to_file.write(indent + ' %s\n' % (l,))
666
if revision.delta is not None:
667
revision.delta.show(to_file, self.show_ids, indent=indent)
332
670
class ShortLogFormatter(LogFormatter):
672
supports_delta = True
674
@deprecated_method(zero_seventeen)
333
675
def show(self, revno, rev, delta):
676
lr = LogRevision(rev, revno, 0, delta)
677
return self.log_revision(lr)
679
def log_revision(self, revision):
334
680
from bzrlib.osutils import format_date
336
682
to_file = self.to_file
338
print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
339
format_date(rev.timestamp, rev.timezone or 0,
683
date_str = format_date(revision.rev.timestamp,
684
revision.rev.timezone or 0,
687
if len(revision.rev.parent_ids) > 1:
688
is_merge = ' [merge]'
689
to_file.write("%5s %s\t%s%s\n" % (revision.revno,
690
self.short_author(revision.rev),
691
format_date(revision.rev.timestamp,
692
revision.rev.timezone or 0,
693
self.show_timezone, date_fmt="%Y-%m-%d",
341
696
if self.show_ids:
342
print >>to_file, ' revision-id:', rev.revision_id
344
print >>to_file, ' (no message)'
697
to_file.write(' revision-id:%s\n' % (revision.rev.revision_id,))
698
if not revision.rev.message:
699
to_file.write(' (no message)\n')
346
for l in rev.message.split('\n'):
347
print >>to_file, ' ' + l
701
message = revision.rev.message.rstrip('\r\n')
702
for l in message.split('\n'):
703
to_file.write(' %s\n' % (l,))
349
705
# TODO: Why not show the modified files in a shorter form as
350
706
# well? rewrap them single lines of appropriate length
352
delta.show(to_file, self.show_ids)
357
FORMATTERS = {'long': LongLogFormatter,
358
'short': ShortLogFormatter,
707
if revision.delta is not None:
708
revision.delta.show(to_file, self.show_ids)
712
class LineLogFormatter(LogFormatter):
714
def __init__(self, *args, **kwargs):
715
from bzrlib.osutils import terminal_width
716
super(LineLogFormatter, self).__init__(*args, **kwargs)
717
self._max_chars = terminal_width() - 1
719
def truncate(self, str, max_len):
720
if len(str) <= max_len:
722
return str[:max_len-3]+'...'
724
def date_string(self, rev):
725
from bzrlib.osutils import format_date
726
return format_date(rev.timestamp, rev.timezone or 0,
727
self.show_timezone, date_fmt="%Y-%m-%d",
730
def message(self, rev):
732
return '(no message)'
736
@deprecated_method(zero_seventeen)
737
def show(self, revno, rev, delta):
738
from bzrlib.osutils import terminal_width
739
self.to_file.write(self.log_string(revno, rev, terminal_width()-1))
740
self.to_file.write('\n')
742
def log_revision(self, revision):
743
self.to_file.write(self.log_string(revision.revno, revision.rev,
745
self.to_file.write('\n')
747
def log_string(self, revno, rev, max_chars):
748
"""Format log info into one string. Truncate tail of string
749
:param revno: revision number (int) or None.
750
Revision numbers counts from 1.
751
:param rev: revision info object
752
:param max_chars: maximum length of resulting string
753
:return: formatted truncated string
757
# show revno only when is not None
758
out.append("%s:" % revno)
759
out.append(self.truncate(self.short_author(rev), 20))
760
out.append(self.date_string(rev))
761
out.append(rev.get_summary())
762
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
765
def line_log(rev, max_chars):
766
lf = LineLogFormatter(None)
767
return lf.log_string(None, rev, max_chars)
770
class LogFormatterRegistry(registry.Registry):
771
"""Registry for log formatters"""
773
def make_formatter(self, name, *args, **kwargs):
774
"""Construct a formatter from arguments.
776
:param name: Name of the formatter to construct. 'short', 'long' and
779
return self.get(name)(*args, **kwargs)
781
def get_default(self, branch):
782
return self.get(branch.get_config().log_format())
785
log_formatter_registry = LogFormatterRegistry()
788
log_formatter_registry.register('short', ShortLogFormatter,
789
'Moderately short log format')
790
log_formatter_registry.register('long', LongLogFormatter,
791
'Detailed log format')
792
log_formatter_registry.register('line', LineLogFormatter,
793
'Log format with one line per revision')
796
def register_formatter(name, formatter):
797
log_formatter_registry.register(name, formatter)
362
800
def log_formatter(name, *args, **kwargs):
801
"""Construct a formatter from arguments.
803
name -- Name of the formatter to construct; currently 'long', 'short' and
804
'line' are supported.
363
806
from bzrlib.errors import BzrCommandError
366
return FORMATTERS[name](*args, **kwargs)
808
return log_formatter_registry.make_formatter(name, *args, **kwargs)
368
810
raise BzrCommandError("unknown log formatter: %r" % name)
370
813
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
371
# deprecated; for compatability
814
# deprecated; for compatibility
372
815
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
373
816
lf.show(revno, rev, delta)
819
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
821
"""Show the change in revision history comparing the old revision history to the new one.
823
:param branch: The branch where the revisions exist
824
:param old_rh: The old revision history
825
:param new_rh: The new revision history
826
:param to_file: A file to write the results to. If None, stdout will be used
832
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout,
834
lf = log_formatter(log_format,
837
show_timezone='original')
839
# This is the first index which is different between
842
for i in xrange(max(len(new_rh),
846
or new_rh[i] != old_rh[i]):
851
to_file.write('Nothing seems to have changed\n')
853
## TODO: It might be nice to do something like show_log
854
## and show the merged entries. But since this is the
855
## removed revisions, it shouldn't be as important
856
if base_idx < len(old_rh):
857
to_file.write('*'*60)
858
to_file.write('\nRemoved Revisions:\n')
859
for i in range(base_idx, len(old_rh)):
860
rev = branch.repository.get_revision(old_rh[i])
861
lr = LogRevision(rev, i+1, 0, None)
863
to_file.write('*'*60)
864
to_file.write('\n\n')
865
if base_idx < len(new_rh):
866
to_file.write('Added Revisions:\n')
872
start_revision=base_idx+1,
873
end_revision=len(new_rh),
added
removed
bzrlib/log.py
