201
217
# list indexes are 0-based; revisions are 1-based
202
218
cut_revs = which_revs[(start_revision-1):(end_revision)]
204
if direction == 'reverse':
206
elif direction == 'forward':
209
raise ValueError('invalid direction %r' % direction)
211
revision_history = branch.revision_history()
212
for revno, rev_id in cut_revs:
213
if verbose or specific_fileid:
214
delta = _get_revision_delta(branch, revno)
217
if not delta.touches_file_id(specific_fileid):
221
# although we calculated it, throw it away without display
224
rev = branch.get_revision(rev_id)
222
# convert the revision history to a dictionary:
223
rev_nos = dict((k, v) for v, k in cut_revs)
225
# override the mainline to look like the revision history.
226
mainline_revs = [revision_id for index, revision_id in cut_revs]
227
if cut_revs[0][0] == 1:
228
mainline_revs.insert(0, None)
230
mainline_revs.insert(0, which_revs[start_revision-2][1])
231
legacy_lf = getattr(lf, 'log_revision', None) is None
233
# pre-0.17 formatters use show for mainline revisions.
234
# how should we show merged revisions ?
235
# pre-0.11 api: show_merge
236
# 0.11-0.16 api: show_merge_revno
237
show_merge_revno = getattr(lf, 'show_merge_revno', None)
238
show_merge = getattr(lf, 'show_merge', None)
239
if show_merge is None and show_merge_revno is None:
240
# no merged-revno support
241
generate_merge_revisions = False
243
generate_merge_revisions = True
244
# tell developers to update their code
245
symbol_versioning.warn('LogFormatters should provide log_revision '
246
'instead of show and show_merge_revno since bzr 0.17.',
247
DeprecationWarning, stacklevel=3)
249
generate_merge_revisions = getattr(lf, 'supports_merge_revisions',
251
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
252
direction, include_merges=generate_merge_revisions)
254
view_revisions = _get_revisions_touching_file_id(branch,
259
view_revisions = list(view_revs_iter)
262
generate_tags = getattr(lf, 'supports_tags', False)
264
if branch.supports_tags():
265
rev_tag_dict = branch.tags.get_reverse_tag_dict()
267
generate_delta = verbose and getattr(lf, 'supports_delta', False)
269
def iter_revisions():
270
# r = revision, n = revno, d = merge depth
271
revision_ids = [r for r, n, d in view_revisions]
272
zeros = set(r for r, n, d in view_revisions if d == 0)
274
repository = branch.repository
277
revisions = repository.get_revisions(revision_ids[:num])
279
delta_revisions = [r for r in revisions if
280
r.revision_id in zeros]
281
deltas = repository.get_deltas_for_revisions(delta_revisions)
282
cur_deltas = dict(izip((r.revision_id for r in
283
delta_revisions), deltas))
284
for revision in revisions:
285
# The delta value will be None unless
286
# 1. verbose is specified, and
287
# 2. the revision is a mainline revision
288
yield revision, cur_deltas.get(revision.revision_id)
289
revision_ids = revision_ids[num:]
290
num = min(int(num * 1.5), 200)
292
# now we just print all the revisions
294
for ((rev_id, revno, merge_depth), (rev, delta)) in \
295
izip(view_revisions, iter_revisions()):
227
298
if not searchRE.search(rev.message):
230
lf.show(revno, rev, delta)
231
if hasattr(lf, 'show_merge'):
235
# revno is 1 based, so -2 to get back 1 less.
236
excludes = set(branch.get_ancestry(revision_history[revno - 2]))
237
pending = list(rev.parent_ids)
239
rev_id = pending.pop()
240
if rev_id in excludes:
242
# prevent showing merged revs twice if they multi-path.
245
rev = branch.get_revision(rev_id)
246
except errors.NoSuchRevision:
248
pending.extend(rev.parent_ids)
252
def deltas_for_log_dummy(branch, which_revs):
253
"""Return all the revisions without intermediate deltas.
255
Useful for log commands that won't need the delta information.
258
for revno, revision_id in which_revs:
259
yield revno, branch.get_revision(revision_id), None
262
def deltas_for_log_reverse(branch, which_revs):
263
"""Compute deltas for display in latest-to-earliest order.
269
Sequence of (revno, revision_id) for the subset of history to examine
272
Sequence of (revno, rev, delta)
274
The delta is from the given revision to the next one in the
275
sequence, which makes sense if the log is being displayed from
278
last_revno = last_revision_id = last_tree = None
279
for revno, revision_id in which_revs:
280
this_tree = branch.revision_tree(revision_id)
281
this_revision = branch.get_revision(revision_id)
284
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
286
this_tree = EmptyTree(branch.get_root_id())
289
last_revision = this_revision
290
last_tree = this_tree
294
this_tree = EmptyTree(branch.get_root_id())
296
this_revno = last_revno - 1
297
this_revision_id = branch.revision_history()[this_revno]
298
this_tree = branch.revision_tree(this_revision_id)
299
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
302
def deltas_for_log_forward(branch, which_revs):
303
"""Compute deltas for display in forward log.
305
Given a sequence of (revno, revision_id) pairs, return
308
The delta is from the given revision to the next one in the
309
sequence, which makes sense if the log is being displayed from
312
last_revno = last_revision_id = last_tree = None
313
prev_tree = EmptyTree(branch.get_root_id())
315
for revno, revision_id in which_revs:
316
this_tree = branch.revision_tree(revision_id)
317
this_revision = branch.get_revision(revision_id)
321
last_tree = EmptyTree(branch.get_root_id())
323
last_revno = revno - 1
324
last_revision_id = branch.revision_history()[last_revno]
325
last_tree = branch.revision_tree(last_revision_id)
327
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
330
last_revision = this_revision
331
last_tree = this_tree
302
lr = LogRevision(rev, revno, merge_depth, delta,
303
rev_tag_dict.get(rev_id))
306
# support for legacy (pre-0.17) LogFormatters
309
lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
311
lf.show(revno, rev, delta)
313
if show_merge_revno is None:
314
lf.show_merge(rev, merge_depth)
317
lf.show_merge_revno(rev, merge_depth, revno,
318
rev_tag_dict.get(rev_id))
320
lf.show_merge_revno(rev, merge_depth, revno)
323
if log_count >= limit:
327
def _get_revisions_touching_file_id(branch, file_id, mainline_revisions,
329
"""Return the list of revision ids which touch a given file id.
331
This includes the revisions which directly change the file id,
332
and the revisions which merge these changes. So if the
340
And 'C' changes a file, then both C and D will be returned.
342
This will also can be restricted based on a subset of the mainline.
344
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
346
# find all the revisions that change the specific file
347
file_weave = branch.repository.weave_store.get_weave(file_id,
348
branch.repository.get_transaction())
349
weave_modifed_revisions = set(file_weave.versions())
350
# build the ancestry of each revision in the graph
351
# - only listing the ancestors that change the specific file.
352
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
353
sorted_rev_list = topo_sort(rev_graph)
355
for rev in sorted_rev_list:
356
parents = rev_graph[rev]
357
if rev not in weave_modifed_revisions and len(parents) == 1:
358
# We will not be adding anything new, so just use a reference to
359
# the parent ancestry.
360
rev_ancestry = ancestry[parents[0]]
363
if rev in weave_modifed_revisions:
364
rev_ancestry.add(rev)
365
for parent in parents:
366
rev_ancestry = rev_ancestry.union(ancestry[parent])
367
ancestry[rev] = rev_ancestry
369
def is_merging_rev(r):
370
parents = rev_graph[r]
372
leftparent = parents[0]
373
for rightparent in parents[1:]:
374
if not ancestry[leftparent].issuperset(
375
ancestry[rightparent]):
379
# filter from the view the revisions that did not change or merge
381
return [(r, n, d) for r, n, d in view_revs_iter
382
if r in weave_modifed_revisions or is_merging_rev(r)]
385
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
386
include_merges=True):
387
"""Produce an iterator of revisions to show
388
:return: an iterator of (revision_id, revno, merge_depth)
389
(if there is no revno for a revision, None is supplied)
391
if include_merges is False:
392
revision_ids = mainline_revs[1:]
393
if direction == 'reverse':
394
revision_ids.reverse()
395
for revision_id in revision_ids:
396
yield revision_id, str(rev_nos[revision_id]), 0
398
merge_sorted_revisions = merge_sort(
399
branch.repository.get_revision_graph(mainline_revs[-1]),
404
if direction == 'forward':
405
# forward means oldest first.
406
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
407
elif direction != 'reverse':
408
raise ValueError('invalid direction %r' % direction)
410
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
411
yield rev_id, '.'.join(map(str, revno)), merge_depth
414
def reverse_by_depth(merge_sorted_revisions, _depth=0):
415
"""Reverse revisions by depth.
417
Revisions with a different depth are sorted as a group with the previous
418
revision of that depth. There may be no topological justification for this,
419
but it looks much nicer.
422
for val in merge_sorted_revisions:
424
zd_revisions.append([val])
426
assert val[2] > _depth
427
zd_revisions[-1].append(val)
428
for revisions in zd_revisions:
429
if len(revisions) > 1:
430
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
431
zd_revisions.reverse()
433
for chunk in zd_revisions:
438
class LogRevision(object):
439
"""A revision to be logged (by LogFormatter.log_revision).
441
A simple wrapper for the attributes of a revision to be logged.
442
The attributes may or may not be populated, as determined by the
443
logging options and the log formatter capabilities.
446
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
450
self.merge_depth = merge_depth
334
455
class LogFormatter(object):
335
"""Abstract class to display log messages."""
456
"""Abstract class to display log messages.
458
At a minimum, a derived class must implement the log_revision method.
460
If the LogFormatter needs to be informed of the beginning or end of
461
a log it should implement the begin_log and/or end_log hook methods.
463
A LogFormatter should define the following supports_XXX flags
464
to indicate which LogRevision attributes it supports:
466
- supports_delta must be True if this log formatter supports delta.
467
Otherwise the delta attribute may not be populated.
468
- supports_merge_revisions must be True if this log formatter supports
469
merge revisions. If not, only revisions mainline revisions (those
470
with merge_depth == 0) will be passed to the formatter.
471
- supports_tags must be True if this log formatter supports tags.
472
Otherwise the tags attribute may not be populated.
336
475
def __init__(self, to_file, show_ids=False, show_timezone='original'):
337
476
self.to_file = to_file
338
477
self.show_ids = show_ids
339
478
self.show_timezone = show_timezone
480
# TODO: uncomment this block after show() has been removed.
481
# Until then defining log_revision would prevent _show_log calling show()
482
# in legacy formatters.
483
# def log_revision(self, revision):
486
# :param revision: The LogRevision to be logged.
488
# raise NotImplementedError('not implemented in abstract base')
490
@deprecated_method(zero_seventeen)
342
491
def show(self, revno, rev, delta):
343
492
raise NotImplementedError('not implemented in abstract base')
345
494
def short_committer(self, rev):
346
495
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
349
498
class LongLogFormatter(LogFormatter):
350
def show(self, revno, rev, delta):
351
return self._show_helper(revno=revno, rev=rev)
353
def show_merge(self, rev):
354
return self._show_helper(rev=rev, indent=' ', merged=True)
356
def _show_helper(self, rev=None, revno=None, indent='', merged=False):
357
from osutils import format_date
500
supports_merge_revisions = True
501
supports_delta = True
504
@deprecated_method(zero_seventeen)
505
def show(self, revno, rev, delta, tags=None):
506
lr = LogRevision(rev, revno, 0, delta, tags)
507
return self.log_revision(lr)
509
@deprecated_method(zero_eleven)
510
def show_merge(self, rev, merge_depth):
511
lr = LogRevision(rev, merge_depth=merge_depth)
512
return self.log_revision(lr)
514
@deprecated_method(zero_seventeen)
515
def show_merge_revno(self, rev, merge_depth, revno, tags=None):
516
"""Show a merged revision rev, with merge_depth and a revno."""
517
lr = LogRevision(rev, revno, merge_depth, tags=tags)
518
return self.log_revision(lr)
520
def log_revision(self, revision):
521
"""Log a revision, either merged or not."""
522
from bzrlib.osutils import format_date
523
indent = ' '*revision.merge_depth
359
524
to_file = self.to_file
362
525
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
526
if revision.revno is not None:
527
print >>to_file, indent+'revno:', revision.revno
529
print >>to_file, indent+'tags: %s' % (', '.join(revision.tags))
369
530
if self.show_ids:
370
for parent_id in rev.parent_ids:
531
print >>to_file, indent+'revision-id:', revision.rev.revision_id
532
for parent_id in revision.rev.parent_ids:
371
533
print >>to_file, indent+'parent:', parent_id
373
print >>to_file, indent+'committer:', rev.committer
534
print >>to_file, indent+'committer:', revision.rev.committer
375
537
print >>to_file, indent+'branch nick: %s' % \
376
rev.properties['branch-nick']
538
revision.rev.properties['branch-nick']
380
date_str = format_date(rev.timestamp,
541
date_str = format_date(revision.rev.timestamp,
542
revision.rev.timezone or 0,
382
543
self.show_timezone)
383
544
print >>to_file, indent+'timestamp: %s' % date_str
385
546
print >>to_file, indent+'message:'
547
if not revision.rev.message:
387
548
print >>to_file, indent+' (no message)'
389
for l in rev.message.split('\n'):
550
message = revision.rev.message.rstrip('\r\n')
551
for l in message.split('\n'):
390
552
print >>to_file, indent+' ' + l
553
if revision.delta is not None:
554
revision.delta.show(to_file, self.show_ids)
393
557
class ShortLogFormatter(LogFormatter):
559
supports_delta = True
561
@deprecated_method(zero_seventeen)
394
562
def show(self, revno, rev, delta):
563
lr = LogRevision(rev, revno, 0, delta)
564
return self.log_revision(lr)
566
def log_revision(self, revision):
395
567
from bzrlib.osutils import format_date
397
569
to_file = self.to_file
398
date_str = format_date(rev.timestamp, rev.timezone or 0,
400
print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
401
format_date(rev.timestamp, rev.timezone or 0,
570
date_str = format_date(revision.rev.timestamp,
571
revision.rev.timezone or 0,
574
if len(revision.rev.parent_ids) > 1:
575
is_merge = ' [merge]'
576
print >>to_file, "%5s %s\t%s%s" % (revision.revno,
577
self.short_committer(revision.rev),
578
format_date(revision.rev.timestamp,
579
revision.rev.timezone or 0,
402
580
self.show_timezone, date_fmt="%Y-%m-%d",
404
583
if self.show_ids:
405
print >>to_file, ' revision-id:', rev.revision_id
584
print >>to_file, ' revision-id:', revision.rev.revision_id
585
if not revision.rev.message:
407
586
print >>to_file, ' (no message)'
409
for l in rev.message.split('\n'):
588
message = revision.rev.message.rstrip('\r\n')
589
for l in message.split('\n'):
410
590
print >>to_file, ' ' + l
412
592
# TODO: Why not show the modified files in a shorter form as
413
593
# well? rewrap them single lines of appropriate length
415
delta.show(to_file, self.show_ids)
594
if revision.delta is not None:
595
revision.delta.show(to_file, self.show_ids)
418
599
class LineLogFormatter(LogFormatter):
601
def __init__(self, *args, **kwargs):
602
from bzrlib.osutils import terminal_width
603
super(LineLogFormatter, self).__init__(*args, **kwargs)
604
self._max_chars = terminal_width() - 1
419
606
def truncate(self, str, max_len):
420
607
if len(str) <= max_len: