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
from itertools import izip
59
import bzrlib.errors as errors
60
from bzrlib.revisionspec import(
63
from bzrlib.symbol_versioning import (
68
from bzrlib.trace import mutter
69
from bzrlib.tsort import (
75
def find_touching_revisions(branch, file_id):
76
"""Yield a description of revisions which affect the file_id.
78
Each returned element is (revno, revision_id, description)
80
This is the list of revisions where the file is either added,
81
modified, renamed or deleted.
83
TODO: Perhaps some way to limit this to only particular revisions,
84
or to traverse a non-mainline set of revisions?
89
for revision_id in branch.revision_history():
90
this_inv = branch.repository.get_revision_inventory(revision_id)
91
if file_id in this_inv:
92
this_ie = this_inv[file_id]
93
this_path = this_inv.id2path(file_id)
95
this_ie = this_path = None
97
# now we know how it was last time, and how it is in this revision.
98
# are those two states effectively the same or not?
100
if not this_ie and not last_ie:
101
# not present in either
103
elif this_ie and not last_ie:
104
yield revno, revision_id, "added " + this_path
105
elif not this_ie and last_ie:
107
yield revno, revision_id, "deleted " + last_path
108
elif this_path != last_path:
109
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
110
elif (this_ie.text_size != last_ie.text_size
111
or this_ie.text_sha1 != last_ie.text_sha1):
112
yield revno, revision_id, "modified " + this_path
115
last_path = this_path
119
def _enumerate_history(branch):
122
for rev_id in branch.revision_history():
123
rh.append((revno, rev_id))
130
specific_fileid=None,
137
"""Write out human-readable log of commits to this branch.
140
LogFormatter object to show the output.
143
If true, list only the commits affecting the specified
144
file, rather than all commits.
147
If true show added/changed/deleted/renamed files.
150
'reverse' (default) is latest to earliest;
151
'forward' is earliest to latest.
154
If not None, only show revisions >= start_revision
157
If not None, only show revisions <= end_revision
160
If not None, only show revisions with matching commit messages
163
If not None or 0, only show limit revisions
167
if getattr(lf, 'begin_log', None):
170
_show_log(branch, lf, specific_fileid, verbose, direction,
171
start_revision, end_revision, search, limit)
173
if getattr(lf, 'end_log', None):
178
def _show_log(branch,
180
specific_fileid=None,
187
"""Worker function for show_log - see show_log."""
188
from bzrlib.osutils import format_date
189
from bzrlib.errors import BzrCheckError
191
from warnings import warn
193
if not isinstance(lf, LogFormatter):
194
warn("not a LogFormatter instance: %r" % lf)
197
mutter('get log for file_id %r', specific_fileid)
199
if search is not None:
201
searchRE = re.compile(search, re.IGNORECASE)
205
mainline_revs, rev_nos, start_rev_id, end_rev_id = \
206
_get_mainline_revs(branch, start_revision, end_revision)
207
if not mainline_revs:
210
if direction == 'reverse':
211
start_rev_id, end_rev_id = end_rev_id, start_rev_id
213
legacy_lf = getattr(lf, 'log_revision', None) is None
215
# pre-0.17 formatters use show for mainline revisions.
216
# how should we show merged revisions ?
217
# pre-0.11 api: show_merge
218
# 0.11-0.16 api: show_merge_revno
219
show_merge_revno = getattr(lf, 'show_merge_revno', None)
220
show_merge = getattr(lf, 'show_merge', None)
221
if show_merge is None and show_merge_revno is None:
222
# no merged-revno support
223
generate_merge_revisions = False
225
generate_merge_revisions = True
226
# tell developers to update their code
227
symbol_versioning.warn('LogFormatters should provide log_revision '
228
'instead of show and show_merge_revno since bzr 0.17.',
229
DeprecationWarning, stacklevel=3)
231
generate_merge_revisions = getattr(lf, 'supports_merge_revisions',
233
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
234
direction, include_merges=generate_merge_revisions)
235
view_revisions = _filter_revision_range(list(view_revs_iter),
239
view_revisions = _filter_revisions_touching_file_id(branch,
244
# rebase merge_depth - unless there are no revisions or
245
# either the first or last revision have merge_depth = 0.
246
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
247
min_depth = min([d for r,n,d in view_revisions])
249
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
252
generate_tags = getattr(lf, 'supports_tags', False)
254
if branch.supports_tags():
255
rev_tag_dict = branch.tags.get_reverse_tag_dict()
257
generate_delta = verbose and getattr(lf, 'supports_delta', False)
259
def iter_revisions():
260
# r = revision, n = revno, d = merge depth
261
revision_ids = [r for r, n, d in view_revisions]
263
repository = branch.repository
266
revisions = repository.get_revisions(revision_ids[:num])
268
deltas = repository.get_deltas_for_revisions(revisions)
269
cur_deltas = dict(izip((r.revision_id for r in revisions),
271
for revision in revisions:
272
yield revision, cur_deltas.get(revision.revision_id)
273
revision_ids = revision_ids[num:]
274
num = min(int(num * 1.5), 200)
276
# now we just print all the revisions
278
for ((rev_id, revno, merge_depth), (rev, delta)) in \
279
izip(view_revisions, iter_revisions()):
282
if not searchRE.search(rev.message):
286
lr = LogRevision(rev, revno, merge_depth, delta,
287
rev_tag_dict.get(rev_id))
290
# support for legacy (pre-0.17) LogFormatters
293
lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
295
lf.show(revno, rev, delta)
297
if show_merge_revno is None:
298
lf.show_merge(rev, merge_depth)
301
lf.show_merge_revno(rev, merge_depth, revno,
302
rev_tag_dict.get(rev_id))
304
lf.show_merge_revno(rev, merge_depth, revno)
307
if log_count >= limit:
311
def _get_mainline_revs(branch, start_revision, end_revision):
312
"""Get the mainline revisions from the branch.
314
Generates the list of mainline revisions for the branch.
316
:param branch: The branch containing the revisions.
318
:param start_revision: The first revision to be logged.
319
For backwards compatibility this may be a mainline integer revno,
320
but for merge revision support a RevisionInfo is expected.
322
:param end_revision: The last revision to be logged.
323
For backwards compatibility this may be a mainline integer revno,
324
but for merge revision support a RevisionInfo is expected.
326
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
328
which_revs = _enumerate_history(branch)
330
return None, None, None, None
332
# For mainline generation, map start_revision and end_revision to
333
# mainline revnos. If the revision is not on the mainline choose the
334
# appropriate extreme of the mainline instead - the extra will be
336
# Also map the revisions to rev_ids, to be used in the later filtering
339
if start_revision is None:
342
if isinstance(start_revision,RevisionInfo):
343
start_rev_id = start_revision.rev_id
344
start_revno = start_revision.revno or 1
346
branch.check_real_revno(start_revision)
347
start_revno = start_revision
350
if end_revision is None:
351
end_revno = len(which_revs)
353
if isinstance(end_revision,RevisionInfo):
354
end_rev_id = end_revision.rev_id
355
end_revno = end_revision.revno or len(which_revs)
357
branch.check_real_revno(end_revision)
358
end_revno = end_revision
360
if start_revno > end_revno:
361
from bzrlib.errors import BzrCommandError
362
raise BzrCommandError("Start revision must be older than "
365
# list indexes are 0-based; revisions are 1-based
366
cut_revs = which_revs[(start_revno-1):(end_revno)]
368
return None, None, None, None
370
# convert the revision history to a dictionary:
371
rev_nos = dict((k, v) for v, k in cut_revs)
373
# override the mainline to look like the revision history.
374
mainline_revs = [revision_id for index, revision_id in cut_revs]
375
if cut_revs[0][0] == 1:
376
mainline_revs.insert(0, None)
378
mainline_revs.insert(0, which_revs[start_revno-2][1])
379
return mainline_revs, rev_nos, start_rev_id, end_rev_id
382
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
383
"""Filter view_revisions based on revision ranges.
385
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
386
tuples to be filtered.
388
:param start_rev_id: If not NONE specifies the first revision to be logged.
389
If NONE then all revisions up to the end_rev_id are logged.
391
:param end_rev_id: If not NONE specifies the last revision to be logged.
392
If NONE then all revisions up to the end of the log are logged.
394
:return: The filtered view_revisions.
396
if start_rev_id or end_rev_id:
397
revision_ids = [r for r, n, d in view_revisions]
399
start_index = revision_ids.index(start_rev_id)
402
if start_rev_id == end_rev_id:
403
end_index = start_index
406
end_index = revision_ids.index(end_rev_id)
408
end_index = len(view_revisions) - 1
409
# To include the revisions merged into the last revision,
410
# extend end_rev_id down to, but not including, the next rev
411
# with the same or lesser merge_depth
412
end_merge_depth = view_revisions[end_index][2]
414
for index in xrange(end_index+1, len(view_revisions)+1):
415
if view_revisions[index][2] <= end_merge_depth:
416
end_index = index - 1
419
# if the search falls off the end then log to the end as well
420
end_index = len(view_revisions) - 1
421
view_revisions = view_revisions[start_index:end_index+1]
422
return view_revisions
425
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
427
"""Return the list of revision ids which touch a given file id.
429
The function filters view_revisions and returns a subset.
430
This includes the revisions which directly change the file id,
431
and the revisions which merge these changes. So if the
439
And 'C' changes a file, then both C and D will be returned.
441
This will also can be restricted based on a subset of the mainline.
443
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
445
# find all the revisions that change the specific file
446
file_weave = branch.repository.weave_store.get_weave(file_id,
447
branch.repository.get_transaction())
448
weave_modifed_revisions = set(file_weave.versions())
449
# build the ancestry of each revision in the graph
450
# - only listing the ancestors that change the specific file.
451
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
452
sorted_rev_list = topo_sort(rev_graph)
454
for rev in sorted_rev_list:
455
parents = rev_graph[rev]
456
if rev not in weave_modifed_revisions and len(parents) == 1:
457
# We will not be adding anything new, so just use a reference to
458
# the parent ancestry.
459
rev_ancestry = ancestry[parents[0]]
462
if rev in weave_modifed_revisions:
463
rev_ancestry.add(rev)
464
for parent in parents:
465
rev_ancestry = rev_ancestry.union(ancestry[parent])
466
ancestry[rev] = rev_ancestry
468
def is_merging_rev(r):
469
parents = rev_graph[r]
471
leftparent = parents[0]
472
for rightparent in parents[1:]:
473
if not ancestry[leftparent].issuperset(
474
ancestry[rightparent]):
478
# filter from the view the revisions that did not change or merge
480
return [(r, n, d) for r, n, d in view_revs_iter
481
if r in weave_modifed_revisions or is_merging_rev(r)]
484
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
485
include_merges=True):
486
"""Produce an iterator of revisions to show
487
:return: an iterator of (revision_id, revno, merge_depth)
488
(if there is no revno for a revision, None is supplied)
490
if include_merges is False:
491
revision_ids = mainline_revs[1:]
492
if direction == 'reverse':
493
revision_ids.reverse()
494
for revision_id in revision_ids:
495
yield revision_id, str(rev_nos[revision_id]), 0
497
merge_sorted_revisions = merge_sort(
498
branch.repository.get_revision_graph(mainline_revs[-1]),
503
if direction == 'forward':
504
# forward means oldest first.
505
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
506
elif direction != 'reverse':
507
raise ValueError('invalid direction %r' % direction)
509
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
510
yield rev_id, '.'.join(map(str, revno)), merge_depth
513
def reverse_by_depth(merge_sorted_revisions, _depth=0):
514
"""Reverse revisions by depth.
516
Revisions with a different depth are sorted as a group with the previous
517
revision of that depth. There may be no topological justification for this,
518
but it looks much nicer.
521
for val in merge_sorted_revisions:
523
zd_revisions.append([val])
525
assert val[2] > _depth
526
zd_revisions[-1].append(val)
527
for revisions in zd_revisions:
528
if len(revisions) > 1:
529
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
530
zd_revisions.reverse()
532
for chunk in zd_revisions:
537
class LogRevision(object):
538
"""A revision to be logged (by LogFormatter.log_revision).
540
A simple wrapper for the attributes of a revision to be logged.
541
The attributes may or may not be populated, as determined by the
542
logging options and the log formatter capabilities.
545
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
549
self.merge_depth = merge_depth
554
class LogFormatter(object):
555
"""Abstract class to display log messages.
557
At a minimum, a derived class must implement the log_revision method.
559
If the LogFormatter needs to be informed of the beginning or end of
560
a log it should implement the begin_log and/or end_log hook methods.
562
A LogFormatter should define the following supports_XXX flags
563
to indicate which LogRevision attributes it supports:
565
- supports_delta must be True if this log formatter supports delta.
566
Otherwise the delta attribute may not be populated.
567
- supports_merge_revisions must be True if this log formatter supports
568
merge revisions. If not, only mainline revisions (those
569
with merge_depth == 0) will be passed to the formatter.
570
- supports_tags must be True if this log formatter supports tags.
571
Otherwise the tags attribute may not be populated.
574
def __init__(self, to_file, show_ids=False, show_timezone='original'):
575
self.to_file = to_file
576
self.show_ids = show_ids
577
self.show_timezone = show_timezone
579
# TODO: uncomment this block after show() has been removed.
580
# Until then defining log_revision would prevent _show_log calling show()
581
# in legacy formatters.
582
# def log_revision(self, revision):
585
# :param revision: The LogRevision to be logged.
587
# raise NotImplementedError('not implemented in abstract base')
589
@deprecated_method(zero_seventeen)
590
def show(self, revno, rev, delta):
591
raise NotImplementedError('not implemented in abstract base')
593
def short_committer(self, rev):
594
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
597
class LongLogFormatter(LogFormatter):
599
supports_merge_revisions = True
600
supports_delta = True
603
@deprecated_method(zero_seventeen)
604
def show(self, revno, rev, delta, tags=None):
605
lr = LogRevision(rev, revno, 0, delta, tags)
606
return self.log_revision(lr)
608
@deprecated_method(zero_eleven)
609
def show_merge(self, rev, merge_depth):
610
lr = LogRevision(rev, merge_depth=merge_depth)
611
return self.log_revision(lr)
613
@deprecated_method(zero_seventeen)
614
def show_merge_revno(self, rev, merge_depth, revno, tags=None):
615
"""Show a merged revision rev, with merge_depth and a revno."""
616
lr = LogRevision(rev, revno, merge_depth, tags=tags)
617
return self.log_revision(lr)
619
def log_revision(self, revision):
620
"""Log a revision, either merged or not."""
621
from bzrlib.osutils import format_date
622
indent = ' '*revision.merge_depth
623
to_file = self.to_file
624
print >>to_file, indent+'-' * 60
625
if revision.revno is not None:
626
print >>to_file, indent+'revno:', revision.revno
628
print >>to_file, indent+'tags: %s' % (', '.join(revision.tags))
630
print >>to_file, indent+'revision-id:', revision.rev.revision_id
631
for parent_id in revision.rev.parent_ids:
632
print >>to_file, indent+'parent:', parent_id
633
print >>to_file, indent+'committer:', revision.rev.committer
636
print >>to_file, indent+'branch nick: %s' % \
637
revision.rev.properties['branch-nick']
640
date_str = format_date(revision.rev.timestamp,
641
revision.rev.timezone or 0,
643
print >>to_file, indent+'timestamp: %s' % date_str
645
print >>to_file, indent+'message:'
646
if not revision.rev.message:
647
print >>to_file, indent+' (no message)'
649
message = revision.rev.message.rstrip('\r\n')
650
for l in message.split('\n'):
651
print >>to_file, indent+' ' + l
652
if revision.delta is not None:
653
revision.delta.show(to_file, self.show_ids, indent=indent)
656
class ShortLogFormatter(LogFormatter):
658
supports_delta = True
660
@deprecated_method(zero_seventeen)
661
def show(self, revno, rev, delta):
662
lr = LogRevision(rev, revno, 0, delta)
663
return self.log_revision(lr)
665
def log_revision(self, revision):
666
from bzrlib.osutils import format_date
668
to_file = self.to_file
669
date_str = format_date(revision.rev.timestamp,
670
revision.rev.timezone or 0,
673
if len(revision.rev.parent_ids) > 1:
674
is_merge = ' [merge]'
675
print >>to_file, "%5s %s\t%s%s" % (revision.revno,
676
self.short_committer(revision.rev),
677
format_date(revision.rev.timestamp,
678
revision.rev.timezone or 0,
679
self.show_timezone, date_fmt="%Y-%m-%d",
683
print >>to_file, ' revision-id:', revision.rev.revision_id
684
if not revision.rev.message:
685
print >>to_file, ' (no message)'
687
message = revision.rev.message.rstrip('\r\n')
688
for l in message.split('\n'):
689
print >>to_file, ' ' + l
691
# TODO: Why not show the modified files in a shorter form as
692
# well? rewrap them single lines of appropriate length
693
if revision.delta is not None:
694
revision.delta.show(to_file, self.show_ids)
698
class LineLogFormatter(LogFormatter):
700
def __init__(self, *args, **kwargs):
701
from bzrlib.osutils import terminal_width
702
super(LineLogFormatter, self).__init__(*args, **kwargs)
703
self._max_chars = terminal_width() - 1
705
def truncate(self, str, max_len):
706
if len(str) <= max_len:
708
return str[:max_len-3]+'...'
710
def date_string(self, rev):
711
from bzrlib.osutils import format_date
712
return format_date(rev.timestamp, rev.timezone or 0,
713
self.show_timezone, date_fmt="%Y-%m-%d",
716
def message(self, rev):
718
return '(no message)'
722
@deprecated_method(zero_seventeen)
723
def show(self, revno, rev, delta):
724
from bzrlib.osutils import terminal_width
725
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
727
def log_revision(self, revision):
728
print >>self.to_file, self.log_string(revision.revno, revision.rev,
731
def log_string(self, revno, rev, max_chars):
732
"""Format log info into one string. Truncate tail of string
733
:param revno: revision number (int) or None.
734
Revision numbers counts from 1.
735
:param rev: revision info object
736
:param max_chars: maximum length of resulting string
737
:return: formatted truncated string
741
# show revno only when is not None
742
out.append("%s:" % revno)
743
out.append(self.truncate(self.short_committer(rev), 20))
744
out.append(self.date_string(rev))
745
out.append(rev.get_summary())
746
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
749
def line_log(rev, max_chars):
750
lf = LineLogFormatter(None)
751
return lf.log_string(None, rev, max_chars)
754
class LogFormatterRegistry(registry.Registry):
755
"""Registry for log formatters"""
757
def make_formatter(self, name, *args, **kwargs):
758
"""Construct a formatter from arguments.
760
:param name: Name of the formatter to construct. 'short', 'long' and
763
return self.get(name)(*args, **kwargs)
765
def get_default(self, branch):
766
return self.get(branch.get_config().log_format())
769
log_formatter_registry = LogFormatterRegistry()
772
log_formatter_registry.register('short', ShortLogFormatter,
773
'Moderately short log format')
774
log_formatter_registry.register('long', LongLogFormatter,
775
'Detailed log format')
776
log_formatter_registry.register('line', LineLogFormatter,
777
'Log format with one line per revision')
780
def register_formatter(name, formatter):
781
log_formatter_registry.register(name, formatter)
784
def log_formatter(name, *args, **kwargs):
785
"""Construct a formatter from arguments.
787
name -- Name of the formatter to construct; currently 'long', 'short' and
788
'line' are supported.
790
from bzrlib.errors import BzrCommandError
792
return log_formatter_registry.make_formatter(name, *args, **kwargs)
794
raise BzrCommandError("unknown log formatter: %r" % name)
797
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
798
# deprecated; for compatibility
799
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
800
lf.show(revno, rev, delta)
803
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
805
"""Show the change in revision history comparing the old revision history to the new one.
807
:param branch: The branch where the revisions exist
808
:param old_rh: The old revision history
809
:param new_rh: The new revision history
810
:param to_file: A file to write the results to. If None, stdout will be used
816
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout,
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
