204
mainline_revs, rev_nos, start_rev_id, end_rev_id = \
205
_get_mainline_revs(branch, start_revision, end_revision)
206
if not mainline_revs:
209
if direction == 'reverse':
210
start_rev_id, end_rev_id = end_rev_id, start_rev_id
212
legacy_lf = getattr(lf, 'log_revision', None) is None
214
# pre-0.17 formatters use show for mainline revisions.
215
# how should we show merged revisions ?
216
# pre-0.11 api: show_merge
217
# 0.11-0.16 api: show_merge_revno
218
show_merge_revno = getattr(lf, 'show_merge_revno', None)
219
show_merge = getattr(lf, 'show_merge', None)
220
if show_merge is None and show_merge_revno is None:
221
# no merged-revno support
222
generate_merge_revisions = False
224
generate_merge_revisions = True
225
# tell developers to update their code
226
symbol_versioning.warn('LogFormatters should provide log_revision '
227
'instead of show and show_merge_revno since bzr 0.17.',
228
DeprecationWarning, stacklevel=3)
230
generate_merge_revisions = getattr(lf, 'supports_merge_revisions',
232
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
233
direction, include_merges=generate_merge_revisions)
234
view_revisions = _filter_revision_range(list(view_revs_iter),
238
view_revisions = _filter_revisions_touching_file_id(branch,
243
# rebase merge_depth - unless there are no revisions or
244
# either the first or last revision have merge_depth = 0.
245
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
246
min_depth = min([d for r,n,d in view_revisions])
248
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
251
generate_tags = getattr(lf, 'supports_tags', False)
253
if branch.supports_tags():
254
rev_tag_dict = branch.tags.get_reverse_tag_dict()
256
generate_delta = verbose and getattr(lf, 'supports_delta', False)
258
def iter_revisions():
259
# r = revision, n = revno, d = merge depth
260
revision_ids = [r for r, n, d in view_revisions]
262
repository = branch.repository
265
revisions = repository.get_revisions(revision_ids[:num])
267
deltas = repository.get_deltas_for_revisions(revisions)
268
cur_deltas = dict(izip((r.revision_id for r in revisions),
270
for revision in revisions:
271
yield revision, cur_deltas.get(revision.revision_id)
272
revision_ids = revision_ids[num:]
273
num = min(int(num * 1.5), 200)
275
# now we just print all the revisions
277
for ((rev_id, revno, merge_depth), (rev, delta)) in \
278
izip(view_revisions, iter_revisions()):
281
if not searchRE.search(rev.message):
285
lr = LogRevision(rev, revno, merge_depth, delta,
286
rev_tag_dict.get(rev_id))
289
# support for legacy (pre-0.17) LogFormatters
292
lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
294
lf.show(revno, rev, delta)
296
if show_merge_revno is None:
297
lf.show_merge(rev, merge_depth)
300
lf.show_merge_revno(rev, merge_depth, revno,
301
rev_tag_dict.get(rev_id))
303
lf.show_merge_revno(rev, merge_depth, revno)
306
if log_count >= limit:
310
def _get_mainline_revs(branch, start_revision, end_revision):
311
"""Get the mainline revisions from the branch.
313
Generates the list of mainline revisions for the branch.
315
:param branch: The branch containing the revisions.
317
:param start_revision: The first revision to be logged.
318
For backwards compatibility this may be a mainline integer revno,
319
but for merge revision support a RevisionInfo is expected.
321
:param end_revision: The last revision to be logged.
322
For backwards compatibility this may be a mainline integer revno,
323
but for merge revision support a RevisionInfo is expected.
325
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
327
191
which_revs = _enumerate_history(branch)
329
return None, None, None, None
331
# For mainline generation, map start_revision and end_revision to
332
# mainline revnos. If the revision is not on the mainline choose the
333
# appropriate extreme of the mainline instead - the extra will be
335
# Also map the revisions to rev_ids, to be used in the later filtering
338
193
if start_revision is None:
341
if isinstance(start_revision,RevisionInfo):
342
start_rev_id = start_revision.rev_id
343
start_revno = start_revision.revno or 1
345
branch.check_real_revno(start_revision)
346
start_revno = start_revision
196
branch.check_real_revno(start_revision)
349
198
if end_revision is None:
350
end_revno = len(which_revs)
199
end_revision = len(which_revs)
352
if isinstance(end_revision,RevisionInfo):
353
end_rev_id = end_revision.rev_id
354
end_revno = end_revision.revno or len(which_revs)
356
branch.check_real_revno(end_revision)
357
end_revno = end_revision
359
if start_revno > end_revno:
360
from bzrlib.errors import BzrCommandError
361
raise BzrCommandError("Start revision must be older than "
201
branch.check_real_revno(end_revision)
364
203
# list indexes are 0-based; revisions are 1-based
365
cut_revs = which_revs[(start_revno-1):(end_revno)]
367
return None, None, None, None
369
# convert the revision history to a dictionary:
370
rev_nos = dict((k, v) for v, k in cut_revs)
372
# override the mainline to look like the revision history.
373
mainline_revs = [revision_id for index, revision_id in cut_revs]
374
if cut_revs[0][0] == 1:
375
mainline_revs.insert(0, None)
204
cut_revs = which_revs[(start_revision-1):(end_revision)]
206
if direction == 'reverse':
208
elif direction == 'forward':
377
mainline_revs.insert(0, which_revs[start_revno-2][1])
378
return mainline_revs, rev_nos, start_rev_id, end_rev_id
381
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
382
"""Filter view_revisions based on revision ranges.
384
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
385
tuples to be filtered.
387
:param start_rev_id: If not NONE specifies the first revision to be logged.
388
If NONE then all revisions up to the end_rev_id are logged.
390
:param end_rev_id: If not NONE specifies the last revision to be logged.
391
If NONE then all revisions up to the end of the log are logged.
393
:return: The filtered view_revisions.
395
if start_rev_id or end_rev_id:
396
revision_ids = [r for r, n, d in view_revisions]
398
start_index = revision_ids.index(start_rev_id)
401
if start_rev_id == end_rev_id:
402
end_index = start_index
405
end_index = revision_ids.index(end_rev_id)
407
end_index = len(view_revisions) - 1
408
# To include the revisions merged into the last revision,
409
# extend end_rev_id down to, but not including, the next rev
410
# with the same or lesser merge_depth
411
end_merge_depth = view_revisions[end_index][2]
413
for index in xrange(end_index+1, len(view_revisions)+1):
414
if view_revisions[index][2] <= end_merge_depth:
415
end_index = index - 1
418
# if the search falls off the end then log to the end as well
419
end_index = len(view_revisions) - 1
420
view_revisions = view_revisions[start_index:end_index+1]
421
return view_revisions
424
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
426
"""Return the list of revision ids which touch a given file id.
428
The function filters view_revisions and returns a subset.
429
This includes the revisions which directly change the file id,
430
and the revisions which merge these changes. So if the
438
And 'C' changes a file, then both C and D will be returned.
440
This will also can be restricted based on a subset of the mainline.
442
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
444
# find all the revisions that change the specific file
445
file_weave = branch.repository.weave_store.get_weave(file_id,
446
branch.repository.get_transaction())
447
weave_modifed_revisions = set(file_weave.versions())
448
# build the ancestry of each revision in the graph
449
# - only listing the ancestors that change the specific file.
450
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
451
sorted_rev_list = topo_sort(rev_graph)
453
for rev in sorted_rev_list:
454
parents = rev_graph[rev]
455
if rev not in weave_modifed_revisions and len(parents) == 1:
456
# We will not be adding anything new, so just use a reference to
457
# the parent ancestry.
458
rev_ancestry = ancestry[parents[0]]
461
if rev in weave_modifed_revisions:
462
rev_ancestry.add(rev)
463
for parent in parents:
464
rev_ancestry = rev_ancestry.union(ancestry[parent])
465
ancestry[rev] = rev_ancestry
467
def is_merging_rev(r):
468
parents = rev_graph[r]
470
leftparent = parents[0]
471
for rightparent in parents[1:]:
472
if not ancestry[leftparent].issuperset(
473
ancestry[rightparent]):
477
# filter from the view the revisions that did not change or merge
479
return [(r, n, d) for r, n, d in view_revs_iter
480
if r in weave_modifed_revisions or is_merging_rev(r)]
483
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
484
include_merges=True):
485
"""Produce an iterator of revisions to show
486
:return: an iterator of (revision_id, revno, merge_depth)
487
(if there is no revno for a revision, None is supplied)
489
if include_merges is False:
490
revision_ids = mainline_revs[1:]
491
if direction == 'reverse':
492
revision_ids.reverse()
493
for revision_id in revision_ids:
494
yield revision_id, str(rev_nos[revision_id]), 0
496
merge_sorted_revisions = merge_sort(
497
branch.repository.get_revision_graph(mainline_revs[-1]),
502
if direction == 'forward':
503
# forward means oldest first.
504
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
505
elif direction != 'reverse':
506
211
raise ValueError('invalid direction %r' % direction)
508
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
509
yield rev_id, '.'.join(map(str, revno)), merge_depth
512
def reverse_by_depth(merge_sorted_revisions, _depth=0):
513
"""Reverse revisions by depth.
515
Revisions with a different depth are sorted as a group with the previous
516
revision of that depth. There may be no topological justification for this,
517
but it looks much nicer.
520
for val in merge_sorted_revisions:
522
zd_revisions.append([val])
213
revision_history = branch.revision_history()
214
for revno, rev_id in cut_revs:
215
if verbose or specific_fileid:
216
delta = _get_revision_delta(branch, revno)
219
if not delta.touches_file_id(specific_fileid):
223
# although we calculated it, throw it away without display
226
rev = branch.get_revision(rev_id)
229
if not searchRE.search(rev.message):
232
lf.show(revno, rev, delta)
233
if hasattr(lf, 'show_merge'):
237
# revno is 1 based, so -2 to get back 1 less.
238
excludes = set(branch.get_ancestry(revision_history[revno - 2]))
239
pending = list(rev.parent_ids)
241
rev_id = pending.pop()
242
if rev_id in excludes:
244
# prevent showing merged revs twice if they multi-path.
247
rev = branch.get_revision(rev_id)
248
except errors.NoSuchRevision:
250
pending.extend(rev.parent_ids)
254
def deltas_for_log_dummy(branch, which_revs):
255
"""Return all the revisions without intermediate deltas.
257
Useful for log commands that won't need the delta information.
260
for revno, revision_id in which_revs:
261
yield revno, branch.get_revision(revision_id), None
264
def deltas_for_log_reverse(branch, which_revs):
265
"""Compute deltas for display in latest-to-earliest order.
271
Sequence of (revno, revision_id) for the subset of history to examine
274
Sequence of (revno, rev, delta)
276
The delta is from the given revision to the next one in the
277
sequence, which makes sense if the log is being displayed from
280
last_revno = last_revision_id = last_tree = None
281
for revno, revision_id in which_revs:
282
this_tree = branch.revision_tree(revision_id)
283
this_revision = branch.get_revision(revision_id)
286
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
288
this_tree = EmptyTree(branch.get_root_id())
291
last_revision = this_revision
292
last_tree = this_tree
296
this_tree = EmptyTree(branch.get_root_id())
524
assert val[2] > _depth
525
zd_revisions[-1].append(val)
526
for revisions in zd_revisions:
527
if len(revisions) > 1:
528
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
529
zd_revisions.reverse()
531
for chunk in zd_revisions:
536
class LogRevision(object):
537
"""A revision to be logged (by LogFormatter.log_revision).
539
A simple wrapper for the attributes of a revision to be logged.
540
The attributes may or may not be populated, as determined by the
541
logging options and the log formatter capabilities.
298
this_revno = last_revno - 1
299
this_revision_id = branch.revision_history()[this_revno]
300
this_tree = branch.revision_tree(this_revision_id)
301
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
304
def deltas_for_log_forward(branch, which_revs):
305
"""Compute deltas for display in forward log.
307
Given a sequence of (revno, revision_id) pairs, return
310
The delta is from the given revision to the next one in the
311
sequence, which makes sense if the log is being displayed from
544
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
548
self.merge_depth = merge_depth
314
last_revno = last_revision_id = last_tree = None
315
prev_tree = EmptyTree(branch.get_root_id())
317
for revno, revision_id in which_revs:
318
this_tree = branch.revision_tree(revision_id)
319
this_revision = branch.get_revision(revision_id)
323
last_tree = EmptyTree(branch.get_root_id())
325
last_revno = revno - 1
326
last_revision_id = branch.revision_history()[last_revno]
327
last_tree = branch.revision_tree(last_revision_id)
329
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
332
last_revision = this_revision
333
last_tree = this_tree
553
336
class LogFormatter(object):
554
"""Abstract class to display log messages.
556
At a minimum, a derived class must implement the log_revision method.
558
If the LogFormatter needs to be informed of the beginning or end of
559
a log it should implement the begin_log and/or end_log hook methods.
561
A LogFormatter should define the following supports_XXX flags
562
to indicate which LogRevision attributes it supports:
564
- supports_delta must be True if this log formatter supports delta.
565
Otherwise the delta attribute may not be populated.
566
- supports_merge_revisions must be True if this log formatter supports
567
merge revisions. If not, only mainline revisions (those
568
with merge_depth == 0) will be passed to the formatter.
569
- supports_tags must be True if this log formatter supports tags.
570
Otherwise the tags attribute may not be populated.
337
"""Abstract class to display log messages."""
573
338
def __init__(self, to_file, show_ids=False, show_timezone='original'):
574
339
self.to_file = to_file
575
340
self.show_ids = show_ids
576
341
self.show_timezone = show_timezone
578
# TODO: uncomment this block after show() has been removed.
579
# Until then defining log_revision would prevent _show_log calling show()
580
# in legacy formatters.
581
# def log_revision(self, revision):
584
# :param revision: The LogRevision to be logged.
586
# raise NotImplementedError('not implemented in abstract base')
588
@deprecated_method(zero_seventeen)
589
344
def show(self, revno, rev, delta):
590
345
raise NotImplementedError('not implemented in abstract base')
592
347
def short_committer(self, rev):
593
348
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
595
def short_author(self, rev):
596
return re.sub('<.*@.*>', '', rev.get_apparent_author()).strip(' ')
599
351
class LongLogFormatter(LogFormatter):
601
supports_merge_revisions = True
602
supports_delta = True
605
@deprecated_method(zero_seventeen)
606
def show(self, revno, rev, delta, tags=None):
607
lr = LogRevision(rev, revno, 0, delta, tags)
608
return self.log_revision(lr)
610
@deprecated_method(zero_seventeen)
611
def show_merge_revno(self, rev, merge_depth, revno, tags=None):
612
"""Show a merged revision rev, with merge_depth and a revno."""
613
lr = LogRevision(rev, revno, merge_depth, tags=tags)
614
return self.log_revision(lr)
616
def log_revision(self, revision):
617
"""Log a revision, either merged or not."""
352
def show(self, revno, rev, delta):
353
return self._show_helper(revno=revno, rev=rev, delta=delta)
355
def show_merge(self, rev):
356
return self._show_helper(rev=rev, indent=' ', merged=True, delta=None)
358
def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
359
"""Show a revision, either merged or not."""
618
360
from bzrlib.osutils import format_date
619
indent = ' ' * revision.merge_depth
620
361
to_file = self.to_file
621
to_file.write(indent + '-' * 60 + '\n')
622
if revision.revno is not None:
623
to_file.write(indent + 'revno: %s\n' % (revision.revno,))
625
to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
362
print >>to_file, indent+'-' * 60
363
if revno is not None:
364
print >>to_file, 'revno:', revno
366
print >>to_file, indent+'merged:', rev.revision_id
368
print >>to_file, indent+'revision-id:', rev.revision_id
626
369
if self.show_ids:
627
to_file.write(indent + 'revision-id:' + revision.rev.revision_id)
629
for parent_id in revision.rev.parent_ids:
630
to_file.write(indent + 'parent: %s\n' % (parent_id,))
632
author = revision.rev.properties.get('author', None)
633
if author is not None:
634
to_file.write(indent + 'author: %s\n' % (author,))
635
to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
637
branch_nick = revision.rev.properties.get('branch-nick', None)
638
if branch_nick is not None:
639
to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
641
date_str = format_date(revision.rev.timestamp,
642
revision.rev.timezone or 0,
370
for parent_id in rev.parent_ids:
371
print >>to_file, indent+'parent:', parent_id
372
print >>to_file, indent+'committer:', rev.committer
374
print >>to_file, indent+'branch nick: %s' % \
375
rev.properties['branch-nick']
378
date_str = format_date(rev.timestamp,
643
380
self.show_timezone)
644
to_file.write(indent + 'timestamp: %s\n' % (date_str,))
381
print >>to_file, indent+'timestamp: %s' % date_str
646
to_file.write(indent + 'message:\n')
647
if not revision.rev.message:
648
to_file.write(indent + ' (no message)\n')
383
print >>to_file, indent+'message:'
385
print >>to_file, indent+' (no message)'
650
message = revision.rev.message.rstrip('\r\n')
387
message = rev.message.rstrip('\r\n')
651
388
for l in message.split('\n'):
652
to_file.write(indent + ' %s\n' % (l,))
653
if revision.delta is not None:
654
revision.delta.show(to_file, self.show_ids, indent=indent)
389
print >>to_file, indent+' ' + l
391
delta.show(to_file, self.show_ids)
657
394
class ShortLogFormatter(LogFormatter):
659
supports_delta = True
661
@deprecated_method(zero_seventeen)
662
395
def show(self, revno, rev, delta):
663
lr = LogRevision(rev, revno, 0, delta)
664
return self.log_revision(lr)
666
def log_revision(self, revision):
667
396
from bzrlib.osutils import format_date
669
398
to_file = self.to_file
670
date_str = format_date(revision.rev.timestamp,
671
revision.rev.timezone or 0,
674
if len(revision.rev.parent_ids) > 1:
675
is_merge = ' [merge]'
676
to_file.write("%5s %s\t%s%s\n" % (revision.revno,
677
self.short_author(revision.rev),
678
format_date(revision.rev.timestamp,
679
revision.rev.timezone or 0,
399
date_str = format_date(rev.timestamp, rev.timezone or 0,
401
print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
402
format_date(rev.timestamp, rev.timezone or 0,
680
403
self.show_timezone, date_fmt="%Y-%m-%d",
683
405
if self.show_ids:
684
to_file.write(' revision-id:%s\n' % (revision.rev.revision_id,))
685
if not revision.rev.message:
686
to_file.write(' (no message)\n')
406
print >>to_file, ' revision-id:', rev.revision_id
408
print >>to_file, ' (no message)'
688
message = revision.rev.message.rstrip('\r\n')
410
message = rev.message.rstrip('\r\n')
689
411
for l in message.split('\n'):
690
to_file.write(' %s\n' % (l,))
412
print >>to_file, ' ' + l
692
414
# TODO: Why not show the modified files in a shorter form as
693
415
# well? rewrap them single lines of appropriate length
694
if revision.delta is not None:
695
revision.delta.show(to_file, self.show_ids)
417
delta.show(to_file, self.show_ids)
699
420
class LineLogFormatter(LogFormatter):
701
def __init__(self, *args, **kwargs):
702
from bzrlib.osutils import terminal_width
703
super(LineLogFormatter, self).__init__(*args, **kwargs)
704
self._max_chars = terminal_width() - 1
706
421
def truncate(self, str, max_len):
707
422
if len(str) <= max_len:
added
removed
bzrlib/log.py
