1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
"""Code to show logs of changes.
21
Various flavors of log can be produced:
23
* for one file, or the whole tree, and (not done yet) for
24
files in a given directory
26
* in "verbose" mode with a description of what changed from one
29
* with file-ids and revision-ids shown
31
Logs are actually written out through an abstract LogFormatter
32
interface, which allows for different preferred formats. Plugins can
35
Logs can be produced in either forward (oldest->newest) or reverse
36
(newest->oldest) order.
38
Logs can be filtered to show only revisions matching a particular
39
search string, or within a particular range of revisions. The range
40
can be given as date/times, which are reduced to revisions before
43
In verbose mode we show a summary of what changed in each particular
44
revision. Note that this is the delta for changes in that revision
45
relative to its left-most parent, not the delta relative to the last
46
logged revision. So for example if you ask for a verbose log of
47
changes touching hello.c you will get a list of those revisions also
48
listing other things that were changed in the same revision, but not
49
all the changes since the previous revision that touched hello.c.
52
# TODO: option to show delta summaries for merged-in revisions
54
from itertools import izip
61
import bzrlib.errors as errors
62
from bzrlib.revisionspec import(
65
from bzrlib.symbol_versioning import (
70
from bzrlib.trace import mutter
71
from bzrlib.tsort import (
77
def find_touching_revisions(branch, file_id):
78
"""Yield a description of revisions which affect the file_id.
80
Each returned element is (revno, revision_id, description)
82
This is the list of revisions where the file is either added,
83
modified, renamed or deleted.
85
TODO: Perhaps some way to limit this to only particular revisions,
86
or to traverse a non-mainline set of revisions?
91
for revision_id in branch.revision_history():
92
this_inv = branch.repository.get_revision_inventory(revision_id)
93
if file_id in this_inv:
94
this_ie = this_inv[file_id]
95
this_path = this_inv.id2path(file_id)
97
this_ie = this_path = None
99
# now we know how it was last time, and how it is in this revision.
100
# are those two states effectively the same or not?
102
if not this_ie and not last_ie:
103
# not present in either
105
elif this_ie and not last_ie:
106
yield revno, revision_id, "added " + this_path
107
elif not this_ie and last_ie:
109
yield revno, revision_id, "deleted " + last_path
110
elif this_path != last_path:
111
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
112
elif (this_ie.text_size != last_ie.text_size
113
or this_ie.text_sha1 != last_ie.text_sha1):
114
yield revno, revision_id, "modified " + this_path
117
last_path = this_path
121
def _enumerate_history(branch):
124
for rev_id in branch.revision_history():
125
rh.append((revno, rev_id))
132
specific_fileid=None,
139
"""Write out human-readable log of commits to this branch.
142
LogFormatter object to show the output.
145
If true, list only the commits affecting the specified
146
file, rather than all commits.
149
If true show added/changed/deleted/renamed files.
152
'reverse' (default) is latest to earliest;
153
'forward' is earliest to latest.
156
If not None, only show revisions >= start_revision
159
If not None, only show revisions <= end_revision
162
If not None, only show revisions with matching commit messages
165
If not None or 0, only show limit revisions
169
if getattr(lf, 'begin_log', None):
172
_show_log(branch, lf, specific_fileid, verbose, direction,
173
start_revision, end_revision, search, limit)
175
if getattr(lf, 'end_log', None):
180
def _show_log(branch,
182
specific_fileid=None,
189
"""Worker function for show_log - see show_log."""
190
from bzrlib.osutils import format_date
191
from bzrlib.errors import BzrCheckError
193
from warnings import warn
195
if not isinstance(lf, LogFormatter):
196
warn("not a LogFormatter instance: %r" % lf)
199
mutter('get log for file_id %r', specific_fileid)
201
if search is not None:
203
searchRE = re.compile(search, re.IGNORECASE)
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
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
236
direction, include_merges=generate_merge_revisions)
237
view_revisions = _filter_revision_range(list(view_revs_iter),
241
view_revisions = _filter_revisions_touching_file_id(branch,
246
# rebase merge_depth - unless there are no revisions or
247
# either the first or last revision have merge_depth = 0.
248
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
249
min_depth = min([d for r,n,d in view_revisions])
251
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
254
generate_tags = getattr(lf, 'supports_tags', False)
256
if branch.supports_tags():
257
rev_tag_dict = branch.tags.get_reverse_tag_dict()
259
generate_delta = verbose and getattr(lf, 'supports_delta', False)
261
def iter_revisions():
262
# r = revision, n = revno, d = merge depth
263
revision_ids = [r for r, n, d in view_revisions]
265
repository = branch.repository
268
revisions = repository.get_revisions(revision_ids[:num])
270
deltas = repository.get_deltas_for_revisions(revisions)
271
cur_deltas = dict(izip((r.revision_id for r in revisions),
273
for revision in revisions:
274
yield revision, cur_deltas.get(revision.revision_id)
275
revision_ids = revision_ids[num:]
276
num = min(int(num * 1.5), 200)
278
# now we just print all the revisions
280
for ((rev_id, revno, merge_depth), (rev, delta)) in \
281
izip(view_revisions, iter_revisions()):
284
if not searchRE.search(rev.message):
288
lr = LogRevision(rev, revno, merge_depth, delta,
289
rev_tag_dict.get(rev_id))
292
# support for legacy (pre-0.17) LogFormatters
295
lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
297
lf.show(revno, rev, delta)
299
if show_merge_revno is None:
300
lf.show_merge(rev, merge_depth)
303
lf.show_merge_revno(rev, merge_depth, revno,
304
rev_tag_dict.get(rev_id))
306
lf.show_merge_revno(rev, merge_depth, revno)
309
if log_count >= limit:
313
def _get_mainline_revs(branch, start_revision, end_revision):
314
"""Get the mainline revisions from the branch.
316
Generates the list of mainline revisions for the branch.
318
:param branch: The branch containing the revisions.
320
:param start_revision: The first revision to be logged.
321
For backwards compatibility this may be a mainline integer revno,
322
but for merge revision support a RevisionInfo is expected.
324
:param end_revision: The last revision to be logged.
325
For backwards compatibility this may be a mainline integer revno,
326
but for merge revision support a RevisionInfo is expected.
328
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
330
which_revs = _enumerate_history(branch)
332
return None, None, None, None
334
# For mainline generation, map start_revision and end_revision to
335
# mainline revnos. If the revision is not on the mainline choose the
336
# appropriate extreme of the mainline instead - the extra will be
338
# Also map the revisions to rev_ids, to be used in the later filtering
341
if start_revision is None:
344
if isinstance(start_revision,RevisionInfo):
345
start_rev_id = start_revision.rev_id
346
start_revno = start_revision.revno or 1
348
branch.check_real_revno(start_revision)
349
start_revno = start_revision
352
if end_revision is None:
353
end_revno = len(which_revs)
355
if isinstance(end_revision,RevisionInfo):
356
end_rev_id = end_revision.rev_id
357
end_revno = end_revision.revno or len(which_revs)
359
branch.check_real_revno(end_revision)
360
end_revno = end_revision
362
if start_revno > end_revno:
363
from bzrlib.errors import BzrCommandError
364
raise BzrCommandError("Start revision must be older than "
367
# list indexes are 0-based; revisions are 1-based
368
cut_revs = which_revs[(start_revno-1):(end_revno)]
370
return None, None, None, None
372
# convert the revision history to a dictionary:
373
rev_nos = dict((k, v) for v, k in cut_revs)
375
# override the mainline to look like the revision history.
376
mainline_revs = [revision_id for index, revision_id in cut_revs]
377
if cut_revs[0][0] == 1:
378
mainline_revs.insert(0, None)
380
mainline_revs.insert(0, which_revs[start_revno-2][1])
381
return mainline_revs, rev_nos, start_rev_id, end_rev_id
384
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
385
"""Filter view_revisions based on revision ranges.
387
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
388
tuples to be filtered.
390
:param start_rev_id: If not NONE specifies the first revision to be logged.
391
If NONE then all revisions up to the end_rev_id are logged.
393
:param end_rev_id: If not NONE specifies the last revision to be logged.
394
If NONE then all revisions up to the end of the log are logged.
396
:return: The filtered view_revisions.
398
if start_rev_id or end_rev_id:
399
revision_ids = [r for r, n, d in view_revisions]
401
start_index = revision_ids.index(start_rev_id)
404
if start_rev_id == end_rev_id:
405
end_index = start_index
408
end_index = revision_ids.index(end_rev_id)
410
end_index = len(view_revisions) - 1
411
# To include the revisions merged into the last revision,
412
# extend end_rev_id down to, but not including, the next rev
413
# with the same or lesser merge_depth
414
end_merge_depth = view_revisions[end_index][2]
416
for index in xrange(end_index+1, len(view_revisions)+1):
417
if view_revisions[index][2] <= end_merge_depth:
418
end_index = index - 1
421
# if the search falls off the end then log to the end as well
422
end_index = len(view_revisions) - 1
423
view_revisions = view_revisions[start_index:end_index+1]
424
return view_revisions
427
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
429
"""Return the list of revision ids which touch a given file id.
431
The function filters view_revisions and returns a subset.
432
This includes the revisions which directly change the file id,
433
and the revisions which merge these changes. So if the
441
And 'C' changes a file, then both C and D will be returned.
443
This will also can be restricted based on a subset of the mainline.
445
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
447
# find all the revisions that change the specific file
448
file_weave = branch.repository.weave_store.get_weave(file_id,
449
branch.repository.get_transaction())
450
weave_modifed_revisions = set(file_weave.versions())
451
# build the ancestry of each revision in the graph
452
# - only listing the ancestors that change the specific file.
453
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
454
sorted_rev_list = topo_sort(rev_graph)
456
for rev in sorted_rev_list:
457
parents = rev_graph[rev]
458
if rev not in weave_modifed_revisions and len(parents) == 1:
459
# We will not be adding anything new, so just use a reference to
460
# the parent ancestry.
461
rev_ancestry = ancestry[parents[0]]
464
if rev in weave_modifed_revisions:
465
rev_ancestry.add(rev)
466
for parent in parents:
467
rev_ancestry = rev_ancestry.union(ancestry[parent])
468
ancestry[rev] = rev_ancestry
470
def is_merging_rev(r):
471
parents = rev_graph[r]
473
leftparent = parents[0]
474
for rightparent in parents[1:]:
475
if not ancestry[leftparent].issuperset(
476
ancestry[rightparent]):
480
# filter from the view the revisions that did not change or merge
482
return [(r, n, d) for r, n, d in view_revs_iter
483
if r in weave_modifed_revisions or is_merging_rev(r)]
486
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
487
include_merges=True):
488
"""Produce an iterator of revisions to show
489
:return: an iterator of (revision_id, revno, merge_depth)
490
(if there is no revno for a revision, None is supplied)
492
if include_merges is False:
493
revision_ids = mainline_revs[1:]
494
if direction == 'reverse':
495
revision_ids.reverse()
496
for revision_id in revision_ids:
497
yield revision_id, str(rev_nos[revision_id]), 0
499
merge_sorted_revisions = merge_sort(
500
branch.repository.get_revision_graph(mainline_revs[-1]),
505
if direction == 'forward':
506
# forward means oldest first.
507
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
508
elif direction != 'reverse':
509
raise ValueError('invalid direction %r' % direction)
511
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
512
yield rev_id, '.'.join(map(str, revno)), merge_depth
515
def reverse_by_depth(merge_sorted_revisions, _depth=0):
516
"""Reverse revisions by depth.
518
Revisions with a different depth are sorted as a group with the previous
519
revision of that depth. There may be no topological justification for this,
520
but it looks much nicer.
523
for val in merge_sorted_revisions:
525
zd_revisions.append([val])
527
assert val[2] > _depth
528
zd_revisions[-1].append(val)
529
for revisions in zd_revisions:
530
if len(revisions) > 1:
531
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
532
zd_revisions.reverse()
534
for chunk in zd_revisions:
539
class LogRevision(object):
540
"""A revision to be logged (by LogFormatter.log_revision).
542
A simple wrapper for the attributes of a revision to be logged.
543
The attributes may or may not be populated, as determined by the
544
logging options and the log formatter capabilities.
547
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
551
self.merge_depth = merge_depth
556
class LogFormatter(object):
557
"""Abstract class to display log messages.
559
At a minimum, a derived class must implement the log_revision method.
561
If the LogFormatter needs to be informed of the beginning or end of
562
a log it should implement the begin_log and/or end_log hook methods.
564
A LogFormatter should define the following supports_XXX flags
565
to indicate which LogRevision attributes it supports:
567
- supports_delta must be True if this log formatter supports delta.
568
Otherwise the delta attribute may not be populated.
569
- supports_merge_revisions must be True if this log formatter supports
570
merge revisions. If not, only mainline revisions (those
571
with merge_depth == 0) will be passed to the formatter.
572
- supports_tags must be True if this log formatter supports tags.
573
Otherwise the tags attribute may not be populated.
576
def __init__(self, to_file, show_ids=False, show_timezone='original'):
577
self.to_file = to_file
578
self.show_ids = show_ids
579
self.show_timezone = show_timezone
581
# TODO: uncomment this block after show() has been removed.
582
# Until then defining log_revision would prevent _show_log calling show()
583
# in legacy formatters.
584
# def log_revision(self, revision):
587
# :param revision: The LogRevision to be logged.
589
# raise NotImplementedError('not implemented in abstract base')
591
@deprecated_method(zero_seventeen)
592
def show(self, revno, rev, delta):
593
raise NotImplementedError('not implemented in abstract base')
595
def short_committer(self, rev):
596
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
599
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_eleven)
611
def show_merge(self, rev, merge_depth):
612
lr = LogRevision(rev, merge_depth=merge_depth)
613
return self.log_revision(lr)
615
@deprecated_method(zero_seventeen)
616
def show_merge_revno(self, rev, merge_depth, revno, tags=None):
617
"""Show a merged revision rev, with merge_depth and a revno."""
618
lr = LogRevision(rev, revno, merge_depth, tags=tags)
619
return self.log_revision(lr)
621
def log_revision(self, revision):
622
"""Log a revision, either merged or not."""
623
from bzrlib.osutils import format_date
624
indent = ' '*revision.merge_depth
625
to_file = self.to_file
626
print >>to_file, indent+'-' * 60
627
if revision.revno is not None:
628
print >>to_file, indent+'revno:', revision.revno
630
print >>to_file, indent+'tags: %s' % (', '.join(revision.tags))
632
print >>to_file, indent+'revision-id:', revision.rev.revision_id
633
for parent_id in revision.rev.parent_ids:
634
print >>to_file, indent+'parent:', parent_id
635
print >>to_file, indent+'committer:', revision.rev.committer
638
print >>to_file, indent+'branch nick: %s' % \
639
revision.rev.properties['branch-nick']
642
date_str = format_date(revision.rev.timestamp,
643
revision.rev.timezone or 0,
645
print >>to_file, indent+'timestamp: %s' % date_str
647
print >>to_file, indent+'message:'
648
if not revision.rev.message:
649
print >>to_file, indent+' (no message)'
651
message = revision.rev.message.rstrip('\r\n')
652
for l in message.split('\n'):
653
print >>to_file, indent+' ' + l
654
if revision.delta is not None:
655
revision.delta.show(to_file, self.show_ids, indent=indent)
658
class ShortLogFormatter(LogFormatter):
660
supports_delta = True
662
@deprecated_method(zero_seventeen)
663
def show(self, revno, rev, delta):
664
lr = LogRevision(rev, revno, 0, delta)
665
return self.log_revision(lr)
667
def log_revision(self, revision):
668
from bzrlib.osutils import format_date
670
to_file = self.to_file
671
date_str = format_date(revision.rev.timestamp,
672
revision.rev.timezone or 0,
675
if len(revision.rev.parent_ids) > 1:
676
is_merge = ' [merge]'
677
print >>to_file, "%5s %s\t%s%s" % (revision.revno,
678
self.short_committer(revision.rev),
679
format_date(revision.rev.timestamp,
680
revision.rev.timezone or 0,
681
self.show_timezone, date_fmt="%Y-%m-%d",
685
print >>to_file, ' revision-id:', revision.rev.revision_id
686
if not revision.rev.message:
687
print >>to_file, ' (no message)'
689
message = revision.rev.message.rstrip('\r\n')
690
for l in message.split('\n'):
691
print >>to_file, ' ' + l
693
# TODO: Why not show the modified files in a shorter form as
694
# well? rewrap them single lines of appropriate length
695
if revision.delta is not None:
696
revision.delta.show(to_file, self.show_ids)
700
class LineLogFormatter(LogFormatter):
702
def __init__(self, *args, **kwargs):
703
from bzrlib.osutils import terminal_width
704
super(LineLogFormatter, self).__init__(*args, **kwargs)
705
self._max_chars = terminal_width() - 1
707
def truncate(self, str, max_len):
708
if len(str) <= max_len:
710
return str[:max_len-3]+'...'
712
def date_string(self, rev):
713
from bzrlib.osutils import format_date
714
return format_date(rev.timestamp, rev.timezone or 0,
715
self.show_timezone, date_fmt="%Y-%m-%d",
718
def message(self, rev):
720
return '(no message)'
724
@deprecated_method(zero_seventeen)
725
def show(self, revno, rev, delta):
726
from bzrlib.osutils import terminal_width
727
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
729
def log_revision(self, revision):
730
print >>self.to_file, self.log_string(revision.revno, revision.rev,
733
def log_string(self, revno, rev, max_chars):
734
"""Format log info into one string. Truncate tail of string
735
:param revno: revision number (int) or None.
736
Revision numbers counts from 1.
737
:param rev: revision info object
738
:param max_chars: maximum length of resulting string
739
:return: formatted truncated string
743
# show revno only when is not None
744
out.append("%s:" % revno)
745
out.append(self.truncate(self.short_committer(rev), 20))
746
out.append(self.date_string(rev))
747
out.append(rev.get_summary())
748
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
751
def line_log(rev, max_chars):
752
lf = LineLogFormatter(None)
753
return lf.log_string(None, rev, max_chars)
756
class LogFormatterRegistry(registry.Registry):
757
"""Registry for log formatters"""
759
def make_formatter(self, name, *args, **kwargs):
760
"""Construct a formatter from arguments.
762
:param name: Name of the formatter to construct. 'short', 'long' and
765
return self.get(name)(*args, **kwargs)
767
def get_default(self, branch):
768
return self.get(branch.get_config().log_format())
771
log_formatter_registry = LogFormatterRegistry()
774
log_formatter_registry.register('short', ShortLogFormatter,
775
'Moderately short log format')
776
log_formatter_registry.register('long', LongLogFormatter,
777
'Detailed log format')
778
log_formatter_registry.register('line', LineLogFormatter,
779
'Log format with one line per revision')
782
def register_formatter(name, formatter):
783
log_formatter_registry.register(name, formatter)
786
def log_formatter(name, *args, **kwargs):
787
"""Construct a formatter from arguments.
789
name -- Name of the formatter to construct; currently 'long', 'short' and
790
'line' are supported.
792
from bzrlib.errors import BzrCommandError
794
return log_formatter_registry.make_formatter(name, *args, **kwargs)
796
raise BzrCommandError("unknown log formatter: %r" % name)
799
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
800
# deprecated; for compatibility
801
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
802
lf.show(revno, rev, delta)
805
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
806
"""Show the change in revision history comparing the old revision history to the new one.
808
:param branch: The branch where the revisions exist
809
:param old_rh: The old revision history
810
:param new_rh: The new revision history
811
:param to_file: A file to write the results to. If None, stdout will be used
817
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
818
lf = log_formatter(log_format,
821
show_timezone='original')
823
# This is the first index which is different between
826
for i in xrange(max(len(new_rh),
830
or new_rh[i] != old_rh[i]):
835
to_file.write('Nothing seems to have changed\n')
837
## TODO: It might be nice to do something like show_log
838
## and show the merged entries. But since this is the
839
## removed revisions, it shouldn't be as important
840
if base_idx < len(old_rh):
841
to_file.write('*'*60)
842
to_file.write('\nRemoved Revisions:\n')
843
for i in range(base_idx, len(old_rh)):
844
rev = branch.repository.get_revision(old_rh[i])
845
lr = LogRevision(rev, i+1, 0, None)
847
to_file.write('*'*60)
848
to_file.write('\n\n')
849
if base_idx < len(new_rh):
850
to_file.write('Added Revisions:\n')
856
start_revision=base_idx+1,
857
end_revision=len(new_rh),
added
removed
bzrlib/log.py
