133
def _enumerate_history(branch):
136
for rev_id in branch.revision_history():
137
rh.append((revno, rev_id))
69
142
def show_log(branch,
71
show_timezone='original',
144
specific_fileid=None,
75
151
"""Write out human-readable log of commits to this branch.
154
LogFormatter object to show the output.
78
157
If true, list only the commits affecting the specified
79
158
file, rather than all commits.
82
'original' (committer's timezone),
83
'utc' (universal time), or
84
'local' (local user's timezone)
87
161
If true show added/changed/deleted/renamed files.
90
If true, show revision and file ids.
93
File to send log to; by default stdout.
95
from osutils import format_date
96
from errors import BzrCheckError
97
from diff import compare_inventories
98
from textui import show_status
99
from inventory import Inventory
106
file_id = branch.read_working_inventory().path2id(filename)
108
for revno, revid, why in find_touching_revisions(branch, file_id):
112
for i, revid in enumerate(branch.revision_history()):
115
branch._need_readlock()
118
prev_inv = Inventory()
119
for revno, revision_id in which_revs():
120
print >>to_file, '-' * 60
121
print >>to_file, 'revno:', revno
122
rev = branch.get_revision(revision_id)
124
print >>to_file, 'revision-id:', revision_id
125
print >>to_file, 'committer:', rev.committer
126
print >>to_file, 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
129
if revision_id != rev.revision_id:
130
raise BzrCheckError("retrieved wrong revision: %r"
131
% (revision_id, rev.revision_id))
133
print >>to_file, 'message:'
164
'reverse' (default) is latest to earliest;
165
'forward' is earliest to latest.
168
If not None, only show revisions >= start_revision
171
If not None, only show revisions <= end_revision
174
If not None, only show revisions with matching commit messages
177
If not None or 0, only show limit revisions
181
if getattr(lf, 'begin_log', None):
184
_show_log(branch, lf, specific_fileid, verbose, direction,
185
start_revision, end_revision, search, limit)
187
if getattr(lf, 'end_log', None):
193
def _show_log(branch,
195
specific_fileid=None,
202
"""Worker function for show_log - see show_log."""
203
if not isinstance(lf, LogFormatter):
204
warn("not a LogFormatter instance: %r" % lf)
207
mutter('get log for file_id %r', specific_fileid)
208
generate_merge_revisions = getattr(lf, 'supports_merge_revisions', False)
209
allow_single_merge_revision = getattr(lf,
210
'supports_single_merge_revision', False)
211
view_revisions = calculate_view_revisions(branch, start_revision,
212
end_revision, direction,
214
generate_merge_revisions,
215
allow_single_merge_revision)
216
if search is not None:
217
searchRE = re.compile(search, re.IGNORECASE)
222
generate_tags = getattr(lf, 'supports_tags', False)
224
if branch.supports_tags():
225
rev_tag_dict = branch.tags.get_reverse_tag_dict()
227
generate_delta = verbose and getattr(lf, 'supports_delta', False)
229
# now we just print all the revisions
231
for (rev_id, revno, merge_depth), rev, delta in _iter_revisions(
232
branch.repository, view_revisions, generate_delta):
234
if not searchRE.search(rev.message):
237
lr = LogRevision(rev, revno, merge_depth, delta,
238
rev_tag_dict.get(rev_id))
242
if log_count >= limit:
246
def calculate_view_revisions(branch, start_revision, end_revision, direction,
247
specific_fileid, generate_merge_revisions,
248
allow_single_merge_revision):
249
if (not generate_merge_revisions and start_revision is end_revision is
250
None and direction == 'reverse' and specific_fileid is None):
251
return _linear_view_revisions(branch)
253
mainline_revs, rev_nos, start_rev_id, end_rev_id = \
254
_get_mainline_revs(branch, start_revision, end_revision)
255
if not mainline_revs:
258
if direction == 'reverse':
259
start_rev_id, end_rev_id = end_rev_id, start_rev_id
261
generate_single_revision = False
262
if ((not generate_merge_revisions)
263
and ((start_rev_id and (start_rev_id not in rev_nos))
264
or (end_rev_id and (end_rev_id not in rev_nos)))):
265
generate_single_revision = ((start_rev_id == end_rev_id)
266
and allow_single_merge_revision)
267
if not generate_single_revision:
268
raise BzrCommandError('Selected log formatter only supports '
269
'mainline revisions.')
270
generate_merge_revisions = generate_single_revision
271
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
272
direction, include_merges=generate_merge_revisions)
273
view_revisions = _filter_revision_range(list(view_revs_iter),
276
if view_revisions and generate_single_revision:
277
view_revisions = view_revisions[0:1]
279
view_revisions = _filter_revisions_touching_file_id(branch,
284
# rebase merge_depth - unless there are no revisions or
285
# either the first or last revision have merge_depth = 0.
286
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
287
min_depth = min([d for r,n,d in view_revisions])
289
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
290
return view_revisions
293
def _linear_view_revisions(branch):
294
start_revno, start_revision_id = branch.last_revision_info()
295
repo = branch.repository
296
revision_ids = repo.iter_reverse_revision_history(start_revision_id)
297
for num, revision_id in enumerate(revision_ids):
298
yield revision_id, str(start_revno - num), 0
301
def _iter_revisions(repository, view_revisions, generate_delta):
303
view_revisions = iter(view_revisions)
305
cur_view_revisions = [d for x, d in zip(range(num), view_revisions)]
306
if len(cur_view_revisions) == 0:
309
# r = revision, n = revno, d = merge depth
310
revision_ids = [r for (r, n, d) in cur_view_revisions]
311
revisions = repository.get_revisions(revision_ids)
313
deltas = repository.get_deltas_for_revisions(revisions)
314
cur_deltas = dict(izip((r.revision_id for r in revisions),
316
for view_data, revision in izip(cur_view_revisions, revisions):
317
yield view_data, revision, cur_deltas.get(revision.revision_id)
318
num = min(int(num * 1.5), 200)
321
def _get_mainline_revs(branch, start_revision, end_revision):
322
"""Get the mainline revisions from the branch.
324
Generates the list of mainline revisions for the branch.
326
:param branch: The branch containing the revisions.
328
:param start_revision: The first revision to be logged.
329
For backwards compatibility this may be a mainline integer revno,
330
but for merge revision support a RevisionInfo is expected.
332
:param end_revision: The last revision to be logged.
333
For backwards compatibility this may be a mainline integer revno,
334
but for merge revision support a RevisionInfo is expected.
336
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
338
branch_revno, branch_last_revision = branch.last_revision_info()
339
if branch_revno == 0:
340
return None, None, None, None
342
# For mainline generation, map start_revision and end_revision to
343
# mainline revnos. If the revision is not on the mainline choose the
344
# appropriate extreme of the mainline instead - the extra will be
346
# Also map the revisions to rev_ids, to be used in the later filtering
349
if start_revision is None:
352
if isinstance(start_revision, RevisionInfo):
353
start_rev_id = start_revision.rev_id
354
start_revno = start_revision.revno or 1
356
branch.check_real_revno(start_revision)
357
start_revno = start_revision
360
if end_revision is None:
361
end_revno = branch_revno
363
if isinstance(end_revision, RevisionInfo):
364
end_rev_id = end_revision.rev_id
365
end_revno = end_revision.revno or branch_revno
367
branch.check_real_revno(end_revision)
368
end_revno = end_revision
370
if ((start_rev_id == NULL_REVISION)
371
or (end_rev_id == NULL_REVISION)):
372
raise BzrCommandError('Logging revision 0 is invalid.')
373
if start_revno > end_revno:
374
raise BzrCommandError("Start revision must be older than "
377
if end_revno < start_revno:
378
return None, None, None, None
379
cur_revno = branch_revno
382
for revision_id in branch.repository.iter_reverse_revision_history(
383
branch_last_revision):
384
if cur_revno < start_revno:
385
# We have gone far enough, but we always add 1 more revision
386
rev_nos[revision_id] = cur_revno
387
mainline_revs.append(revision_id)
389
if cur_revno <= end_revno:
390
rev_nos[revision_id] = cur_revno
391
mainline_revs.append(revision_id)
394
# We walked off the edge of all revisions, so we add a 'None' marker
395
mainline_revs.append(None)
397
mainline_revs.reverse()
399
# override the mainline to look like the revision history.
400
return mainline_revs, rev_nos, start_rev_id, end_rev_id
403
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
404
"""Filter view_revisions based on revision ranges.
406
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
407
tuples to be filtered.
409
:param start_rev_id: If not NONE specifies the first revision to be logged.
410
If NONE then all revisions up to the end_rev_id are logged.
412
:param end_rev_id: If not NONE specifies the last revision to be logged.
413
If NONE then all revisions up to the end of the log are logged.
415
:return: The filtered view_revisions.
417
if start_rev_id or end_rev_id:
418
revision_ids = [r for r, n, d in view_revisions]
420
start_index = revision_ids.index(start_rev_id)
423
if start_rev_id == end_rev_id:
424
end_index = start_index
427
end_index = revision_ids.index(end_rev_id)
429
end_index = len(view_revisions) - 1
430
# To include the revisions merged into the last revision,
431
# extend end_rev_id down to, but not including, the next rev
432
# with the same or lesser merge_depth
433
end_merge_depth = view_revisions[end_index][2]
435
for index in xrange(end_index+1, len(view_revisions)+1):
436
if view_revisions[index][2] <= end_merge_depth:
437
end_index = index - 1
440
# if the search falls off the end then log to the end as well
441
end_index = len(view_revisions) - 1
442
view_revisions = view_revisions[start_index:end_index+1]
443
return view_revisions
446
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
448
"""Return the list of revision ids which touch a given file id.
450
The function filters view_revisions and returns a subset.
451
This includes the revisions which directly change the file id,
452
and the revisions which merge these changes. So if the
460
And 'C' changes a file, then both C and D will be returned.
462
This will also can be restricted based on a subset of the mainline.
464
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
466
# find all the revisions that change the specific file
467
file_weave = branch.repository.weave_store.get_weave(file_id,
468
branch.repository.get_transaction())
469
weave_modifed_revisions = set(file_weave.versions())
470
# build the ancestry of each revision in the graph
471
# - only listing the ancestors that change the specific file.
472
graph = branch.repository.get_graph()
473
# This asks for all mainline revisions, which means we only have to spider
474
# sideways, rather than depth history. That said, its still size-of-history
475
# and should be addressed.
476
# mainline_revisions always includes an extra revision at the beginning, so
478
parent_map = dict(((key, value) for key, value in
479
graph.iter_ancestry(mainline_revisions[1:]) if value is not None))
480
sorted_rev_list = topo_sort(parent_map.items())
482
for rev in sorted_rev_list:
483
parents = parent_map[rev]
484
if rev not in weave_modifed_revisions and len(parents) == 1:
485
# We will not be adding anything new, so just use a reference to
486
# the parent ancestry.
487
rev_ancestry = ancestry[parents[0]]
490
if rev in weave_modifed_revisions:
491
rev_ancestry.add(rev)
492
for parent in parents:
493
if parent not in ancestry:
494
# parent is a Ghost, which won't be present in
495
# sorted_rev_list, but we may access it later, so create an
497
ancestry[parent] = set()
498
rev_ancestry = rev_ancestry.union(ancestry[parent])
499
ancestry[rev] = rev_ancestry
501
def is_merging_rev(r):
502
parents = parent_map[r]
504
leftparent = parents[0]
505
for rightparent in parents[1:]:
506
if not ancestry[leftparent].issuperset(
507
ancestry[rightparent]):
511
# filter from the view the revisions that did not change or merge
513
return [(r, n, d) for r, n, d in view_revs_iter
514
if r in weave_modifed_revisions or is_merging_rev(r)]
517
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
518
include_merges=True):
519
"""Produce an iterator of revisions to show
520
:return: an iterator of (revision_id, revno, merge_depth)
521
(if there is no revno for a revision, None is supplied)
523
if include_merges is False:
524
revision_ids = mainline_revs[1:]
525
if direction == 'reverse':
526
revision_ids.reverse()
527
for revision_id in revision_ids:
528
yield revision_id, str(rev_nos[revision_id]), 0
530
graph = branch.repository.get_graph()
531
# This asks for all mainline revisions, which means we only have to spider
532
# sideways, rather than depth history. That said, its still size-of-history
533
# and should be addressed.
534
# mainline_revisions always includes an extra revision at the beginning, so
536
parent_map = dict(((key, value) for key, value in
537
graph.iter_ancestry(mainline_revs[1:]) if value is not None))
538
# filter out ghosts; merge_sort errors on ghosts.
539
rev_graph = _strip_NULL_ghosts(parent_map)
540
merge_sorted_revisions = merge_sort(
546
if direction == 'forward':
547
# forward means oldest first.
548
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
549
elif direction != 'reverse':
550
raise ValueError('invalid direction %r' % direction)
552
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
553
yield rev_id, '.'.join(map(str, revno)), merge_depth
556
def reverse_by_depth(merge_sorted_revisions, _depth=0):
557
"""Reverse revisions by depth.
559
Revisions with a different depth are sorted as a group with the previous
560
revision of that depth. There may be no topological justification for this,
561
but it looks much nicer.
564
for val in merge_sorted_revisions:
566
zd_revisions.append([val])
568
zd_revisions[-1].append(val)
569
for revisions in zd_revisions:
570
if len(revisions) > 1:
571
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
572
zd_revisions.reverse()
574
for chunk in zd_revisions:
579
class LogRevision(object):
580
"""A revision to be logged (by LogFormatter.log_revision).
582
A simple wrapper for the attributes of a revision to be logged.
583
The attributes may or may not be populated, as determined by the
584
logging options and the log formatter capabilities.
587
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
591
self.merge_depth = merge_depth
596
class LogFormatter(object):
597
"""Abstract class to display log messages.
599
At a minimum, a derived class must implement the log_revision method.
601
If the LogFormatter needs to be informed of the beginning or end of
602
a log it should implement the begin_log and/or end_log hook methods.
604
A LogFormatter should define the following supports_XXX flags
605
to indicate which LogRevision attributes it supports:
607
- supports_delta must be True if this log formatter supports delta.
608
Otherwise the delta attribute may not be populated.
609
- supports_merge_revisions must be True if this log formatter supports
610
merge revisions. If not, and if supports_single_merge_revisions is
611
also not True, then only mainline revisions will be passed to the
613
- supports_single_merge_revision must be True if this log formatter
614
supports logging only a single merge revision. This flag is
615
only relevant if supports_merge_revisions is not True.
616
- supports_tags must be True if this log formatter supports tags.
617
Otherwise the tags attribute may not be populated.
620
def __init__(self, to_file, show_ids=False, show_timezone='original'):
621
self.to_file = to_file
622
self.show_ids = show_ids
623
self.show_timezone = show_timezone
625
# TODO: uncomment this block after show() has been removed.
626
# Until then defining log_revision would prevent _show_log calling show()
627
# in legacy formatters.
628
# def log_revision(self, revision):
631
# :param revision: The LogRevision to be logged.
633
# raise NotImplementedError('not implemented in abstract base')
635
def short_committer(self, rev):
636
name, address = config.parse_username(rev.committer)
641
def short_author(self, rev):
642
name, address = config.parse_username(rev.get_apparent_author())
648
class LongLogFormatter(LogFormatter):
650
supports_merge_revisions = True
651
supports_delta = True
654
def log_revision(self, revision):
655
"""Log a revision, either merged or not."""
656
indent = ' ' * revision.merge_depth
657
to_file = self.to_file
658
to_file.write(indent + '-' * 60 + '\n')
659
if revision.revno is not None:
660
to_file.write(indent + 'revno: %s\n' % (revision.revno,))
662
to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
664
to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
666
for parent_id in revision.rev.parent_ids:
667
to_file.write(indent + 'parent: %s\n' % (parent_id,))
669
author = revision.rev.properties.get('author', None)
670
if author is not None:
671
to_file.write(indent + 'author: %s\n' % (author,))
672
to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
674
branch_nick = revision.rev.properties.get('branch-nick', None)
675
if branch_nick is not None:
676
to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
678
date_str = format_date(revision.rev.timestamp,
679
revision.rev.timezone or 0,
681
to_file.write(indent + 'timestamp: %s\n' % (date_str,))
683
to_file.write(indent + 'message:\n')
684
if not revision.rev.message:
685
to_file.write(indent + ' (no message)\n')
687
message = revision.rev.message.rstrip('\r\n')
688
for l in message.split('\n'):
689
to_file.write(indent + ' %s\n' % (l,))
690
if revision.delta is not None:
691
revision.delta.show(to_file, self.show_ids, indent=indent)
694
class ShortLogFormatter(LogFormatter):
696
supports_delta = True
697
supports_single_merge_revision = True
699
def log_revision(self, revision):
700
to_file = self.to_file
701
date_str = format_date(revision.rev.timestamp,
702
revision.rev.timezone or 0,
705
if len(revision.rev.parent_ids) > 1:
706
is_merge = ' [merge]'
707
to_file.write("%5s %s\t%s%s\n" % (revision.revno,
708
self.short_author(revision.rev),
709
format_date(revision.rev.timestamp,
710
revision.rev.timezone or 0,
711
self.show_timezone, date_fmt="%Y-%m-%d",
715
to_file.write(' revision-id:%s\n' % (revision.rev.revision_id,))
716
if not revision.rev.message:
717
to_file.write(' (no message)\n')
719
message = revision.rev.message.rstrip('\r\n')
720
for l in message.split('\n'):
721
to_file.write(' %s\n' % (l,))
723
# TODO: Why not show the modified files in a shorter form as
724
# well? rewrap them single lines of appropriate length
725
if revision.delta is not None:
726
revision.delta.show(to_file, self.show_ids)
730
class LineLogFormatter(LogFormatter):
732
supports_single_merge_revision = True
734
def __init__(self, *args, **kwargs):
735
super(LineLogFormatter, self).__init__(*args, **kwargs)
736
self._max_chars = terminal_width() - 1
738
def truncate(self, str, max_len):
739
if len(str) <= max_len:
741
return str[:max_len-3]+'...'
743
def date_string(self, rev):
744
return format_date(rev.timestamp, rev.timezone or 0,
745
self.show_timezone, date_fmt="%Y-%m-%d",
748
def message(self, rev):
134
749
if not rev.message:
135
print >>to_file, ' (no message)'
750
return '(no message)'
137
for l in rev.message.split('\n'):
138
print >>to_file, ' ' + l
140
# Don't show a list of changed files if we were asked about
143
if verbose and not filename:
144
this_inv = branch.get_inventory(rev.inventory_id)
145
delta = compare_inventories(prev_inv, this_inv)
148
print >>to_file, 'removed files:'
149
for path, fid in delta.removed:
151
print >>to_file, ' %-30s %s' % (path, fid)
153
print >>to_file, ' ', path
155
print >>to_file, 'added files:'
156
for path, fid in delta.added:
158
print >>to_file, ' %-30s %s' % (path, fid)
160
print >>to_file, ' ' + path
162
print >>to_file, 'renamed files:'
163
for oldpath, newpath, fid in delta.renamed:
165
print >>to_file, ' %s => %s %s' % (oldpath, newpath, fid)
167
print >>to_file, ' %s => %s' % (oldpath, newpath)
169
print >>to_file, 'modified files:'
170
for path, fid in delta.modified:
172
print >>to_file, ' %-30s %s' % (path, fid)
174
print >>to_file, ' ' + path
178
precursor = revision_id
754
def log_revision(self, revision):
755
self.to_file.write(self.log_string(revision.revno, revision.rev,
757
self.to_file.write('\n')
759
def log_string(self, revno, rev, max_chars):
760
"""Format log info into one string. Truncate tail of string
761
:param revno: revision number (int) or None.
762
Revision numbers counts from 1.
763
:param rev: revision info object
764
:param max_chars: maximum length of resulting string
765
:return: formatted truncated string
769
# show revno only when is not None
770
out.append("%s:" % revno)
771
out.append(self.truncate(self.short_author(rev), 20))
772
out.append(self.date_string(rev))
773
out.append(rev.get_summary())
774
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
777
def line_log(rev, max_chars):
778
lf = LineLogFormatter(None)
779
return lf.log_string(None, rev, max_chars)
782
class LogFormatterRegistry(registry.Registry):
783
"""Registry for log formatters"""
785
def make_formatter(self, name, *args, **kwargs):
786
"""Construct a formatter from arguments.
788
:param name: Name of the formatter to construct. 'short', 'long' and
791
return self.get(name)(*args, **kwargs)
793
def get_default(self, branch):
794
return self.get(branch.get_config().log_format())
797
log_formatter_registry = LogFormatterRegistry()
800
log_formatter_registry.register('short', ShortLogFormatter,
801
'Moderately short log format')
802
log_formatter_registry.register('long', LongLogFormatter,
803
'Detailed log format')
804
log_formatter_registry.register('line', LineLogFormatter,
805
'Log format with one line per revision')
808
def register_formatter(name, formatter):
809
log_formatter_registry.register(name, formatter)
812
def log_formatter(name, *args, **kwargs):
813
"""Construct a formatter from arguments.
815
name -- Name of the formatter to construct; currently 'long', 'short' and
816
'line' are supported.
819
return log_formatter_registry.make_formatter(name, *args, **kwargs)
821
raise BzrCommandError("unknown log formatter: %r" % name)
824
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
825
# deprecated; for compatibility
826
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
827
lf.show(revno, rev, delta)
830
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
832
"""Show the change in revision history comparing the old revision history to the new one.
834
:param branch: The branch where the revisions exist
835
:param old_rh: The old revision history
836
:param new_rh: The new revision history
837
:param to_file: A file to write the results to. If None, stdout will be used
840
to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
842
lf = log_formatter(log_format,
845
show_timezone='original')
847
# This is the first index which is different between
850
for i in xrange(max(len(new_rh),
854
or new_rh[i] != old_rh[i]):
859
to_file.write('Nothing seems to have changed\n')
861
## TODO: It might be nice to do something like show_log
862
## and show the merged entries. But since this is the
863
## removed revisions, it shouldn't be as important
864
if base_idx < len(old_rh):
865
to_file.write('*'*60)
866
to_file.write('\nRemoved Revisions:\n')
867
for i in range(base_idx, len(old_rh)):
868
rev = branch.repository.get_revision(old_rh[i])
869
lr = LogRevision(rev, i+1, 0, None)
871
to_file.write('*'*60)
872
to_file.write('\n\n')
873
if base_idx < len(new_rh):
874
to_file.write('Added Revisions:\n')
880
start_revision=base_idx+1,
881
end_revision=len(new_rh),
added
removed
bzrlib/log.py
