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.
53
from itertools import (
58
from warnings import (
67
from bzrlib.errors import (
70
from bzrlib.osutils import (
72
get_terminal_encoding,
75
from bzrlib.revision import (
78
from bzrlib.revisionspec import (
81
from bzrlib.trace import mutter
82
from bzrlib.tsort import (
88
def find_touching_revisions(branch, file_id):
89
"""Yield a description of revisions which affect the file_id.
91
Each returned element is (revno, revision_id, description)
93
This is the list of revisions where the file is either added,
94
modified, renamed or deleted.
96
TODO: Perhaps some way to limit this to only particular revisions,
97
or to traverse a non-mainline set of revisions?
102
for revision_id in branch.revision_history():
103
this_inv = branch.repository.get_revision_inventory(revision_id)
104
if file_id in this_inv:
105
this_ie = this_inv[file_id]
106
this_path = this_inv.id2path(file_id)
108
this_ie = this_path = None
110
# now we know how it was last time, and how it is in this revision.
111
# are those two states effectively the same or not?
113
if not this_ie and not last_ie:
114
# not present in either
116
elif this_ie and not last_ie:
117
yield revno, revision_id, "added " + this_path
118
elif not this_ie and last_ie:
120
yield revno, revision_id, "deleted " + last_path
121
elif this_path != last_path:
122
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
123
elif (this_ie.text_size != last_ie.text_size
124
or this_ie.text_sha1 != last_ie.text_sha1):
125
yield revno, revision_id, "modified " + this_path
128
last_path = this_path
132
def _enumerate_history(branch):
135
for rev_id in branch.revision_history():
136
rh.append((revno, rev_id))
143
specific_fileid=None,
150
"""Write out human-readable log of commits to this branch.
153
LogFormatter object to show the output.
156
If true, list only the commits affecting the specified
157
file, rather than all commits.
160
If true show added/changed/deleted/renamed files.
163
'reverse' (default) is latest to earliest;
164
'forward' is earliest to latest.
167
If not None, only show revisions >= start_revision
170
If not None, only show revisions <= end_revision
173
If not None, only show revisions with matching commit messages
176
If not None or 0, only show limit revisions
180
if getattr(lf, 'begin_log', None):
183
_show_log(branch, lf, specific_fileid, verbose, direction,
184
start_revision, end_revision, search, limit)
186
if getattr(lf, 'end_log', None):
191
def _show_log(branch,
193
specific_fileid=None,
200
"""Worker function for show_log - see show_log."""
201
if not isinstance(lf, LogFormatter):
202
warn("not a LogFormatter instance: %r" % lf)
205
mutter('get log for file_id %r', specific_fileid)
207
if search is not None:
208
searchRE = re.compile(search, re.IGNORECASE)
212
mainline_revs, rev_nos, start_rev_id, end_rev_id = \
213
_get_mainline_revs(branch, start_revision, end_revision)
214
if not mainline_revs:
217
if direction == 'reverse':
218
start_rev_id, end_rev_id = end_rev_id, start_rev_id
220
generate_merge_revisions = getattr(lf, 'supports_merge_revisions', False)
221
generate_single_revision = False
222
if ((not generate_merge_revisions)
223
and ((start_rev_id and (start_rev_id not in rev_nos))
224
or (end_rev_id and (end_rev_id not in rev_nos)))):
225
generate_single_revision = ((start_rev_id == end_rev_id)
226
and getattr(lf, 'supports_single_merge_revision', False))
227
if not generate_single_revision:
228
raise BzrCommandError('Selected log formatter only supports '
229
'mainline revisions.')
230
generate_merge_revisions = generate_single_revision
231
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
232
direction, include_merges=generate_merge_revisions)
233
view_revisions = _filter_revision_range(list(view_revs_iter),
236
if view_revisions and generate_single_revision:
237
view_revisions = view_revisions[0:1]
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):
285
lr = LogRevision(rev, revno, merge_depth, delta,
286
rev_tag_dict.get(rev_id))
290
if log_count >= limit:
294
def _get_mainline_revs(branch, start_revision, end_revision):
295
"""Get the mainline revisions from the branch.
297
Generates the list of mainline revisions for the branch.
299
:param branch: The branch containing the revisions.
301
:param start_revision: The first revision to be logged.
302
For backwards compatibility this may be a mainline integer revno,
303
but for merge revision support a RevisionInfo is expected.
305
:param end_revision: The last revision to be logged.
306
For backwards compatibility this may be a mainline integer revno,
307
but for merge revision support a RevisionInfo is expected.
309
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
311
which_revs = _enumerate_history(branch)
313
return None, None, None, None
315
# For mainline generation, map start_revision and end_revision to
316
# mainline revnos. If the revision is not on the mainline choose the
317
# appropriate extreme of the mainline instead - the extra will be
319
# Also map the revisions to rev_ids, to be used in the later filtering
322
if start_revision is None:
325
if isinstance(start_revision,RevisionInfo):
326
start_rev_id = start_revision.rev_id
327
start_revno = start_revision.revno or 1
329
branch.check_real_revno(start_revision)
330
start_revno = start_revision
333
if end_revision is None:
334
end_revno = len(which_revs)
336
if isinstance(end_revision,RevisionInfo):
337
end_rev_id = end_revision.rev_id
338
end_revno = end_revision.revno or len(which_revs)
340
branch.check_real_revno(end_revision)
341
end_revno = end_revision
343
if ((start_rev_id == NULL_REVISION)
344
or (end_rev_id == NULL_REVISION)):
345
raise BzrCommandError('Logging revision 0 is invalid.')
346
if start_revno > end_revno:
347
raise BzrCommandError("Start revision must be older than "
350
# list indexes are 0-based; revisions are 1-based
351
cut_revs = which_revs[(start_revno-1):(end_revno)]
353
return None, None, None, None
355
# convert the revision history to a dictionary:
356
rev_nos = dict((k, v) for v, k in cut_revs)
358
# override the mainline to look like the revision history.
359
mainline_revs = [revision_id for index, revision_id in cut_revs]
360
if cut_revs[0][0] == 1:
361
mainline_revs.insert(0, None)
363
mainline_revs.insert(0, which_revs[start_revno-2][1])
364
return mainline_revs, rev_nos, start_rev_id, end_rev_id
367
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
368
"""Filter view_revisions based on revision ranges.
370
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
371
tuples to be filtered.
373
:param start_rev_id: If not NONE specifies the first revision to be logged.
374
If NONE then all revisions up to the end_rev_id are logged.
376
:param end_rev_id: If not NONE specifies the last revision to be logged.
377
If NONE then all revisions up to the end of the log are logged.
379
:return: The filtered view_revisions.
381
if start_rev_id or end_rev_id:
382
revision_ids = [r for r, n, d in view_revisions]
384
start_index = revision_ids.index(start_rev_id)
387
if start_rev_id == end_rev_id:
388
end_index = start_index
391
end_index = revision_ids.index(end_rev_id)
393
end_index = len(view_revisions) - 1
394
# To include the revisions merged into the last revision,
395
# extend end_rev_id down to, but not including, the next rev
396
# with the same or lesser merge_depth
397
end_merge_depth = view_revisions[end_index][2]
399
for index in xrange(end_index+1, len(view_revisions)+1):
400
if view_revisions[index][2] <= end_merge_depth:
401
end_index = index - 1
404
# if the search falls off the end then log to the end as well
405
end_index = len(view_revisions) - 1
406
view_revisions = view_revisions[start_index:end_index+1]
407
return view_revisions
410
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
412
"""Return the list of revision ids which touch a given file id.
414
The function filters view_revisions and returns a subset.
415
This includes the revisions which directly change the file id,
416
and the revisions which merge these changes. So if the
424
And 'C' changes a file, then both C and D will be returned.
426
This will also can be restricted based on a subset of the mainline.
428
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
430
# find all the revisions that change the specific file
431
file_weave = branch.repository.weave_store.get_weave(file_id,
432
branch.repository.get_transaction())
433
weave_modifed_revisions = set(file_weave.versions())
434
# build the ancestry of each revision in the graph
435
# - only listing the ancestors that change the specific file.
436
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
437
sorted_rev_list = topo_sort(rev_graph)
439
for rev in sorted_rev_list:
440
parents = rev_graph[rev]
441
if rev not in weave_modifed_revisions and len(parents) == 1:
442
# We will not be adding anything new, so just use a reference to
443
# the parent ancestry.
444
rev_ancestry = ancestry[parents[0]]
447
if rev in weave_modifed_revisions:
448
rev_ancestry.add(rev)
449
for parent in parents:
450
rev_ancestry = rev_ancestry.union(ancestry[parent])
451
ancestry[rev] = rev_ancestry
453
def is_merging_rev(r):
454
parents = rev_graph[r]
456
leftparent = parents[0]
457
for rightparent in parents[1:]:
458
if not ancestry[leftparent].issuperset(
459
ancestry[rightparent]):
463
# filter from the view the revisions that did not change or merge
465
return [(r, n, d) for r, n, d in view_revs_iter
466
if r in weave_modifed_revisions or is_merging_rev(r)]
469
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
470
include_merges=True):
471
"""Produce an iterator of revisions to show
472
:return: an iterator of (revision_id, revno, merge_depth)
473
(if there is no revno for a revision, None is supplied)
475
if include_merges is False:
476
revision_ids = mainline_revs[1:]
477
if direction == 'reverse':
478
revision_ids.reverse()
479
for revision_id in revision_ids:
480
yield revision_id, str(rev_nos[revision_id]), 0
482
merge_sorted_revisions = merge_sort(
483
branch.repository.get_revision_graph(mainline_revs[-1]),
488
if direction == 'forward':
489
# forward means oldest first.
490
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
491
elif direction != 'reverse':
492
raise ValueError('invalid direction %r' % direction)
494
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
495
yield rev_id, '.'.join(map(str, revno)), merge_depth
498
def reverse_by_depth(merge_sorted_revisions, _depth=0):
499
"""Reverse revisions by depth.
501
Revisions with a different depth are sorted as a group with the previous
502
revision of that depth. There may be no topological justification for this,
503
but it looks much nicer.
506
for val in merge_sorted_revisions:
508
zd_revisions.append([val])
510
assert val[2] > _depth
511
zd_revisions[-1].append(val)
512
for revisions in zd_revisions:
513
if len(revisions) > 1:
514
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
515
zd_revisions.reverse()
517
for chunk in zd_revisions:
522
class LogRevision(object):
523
"""A revision to be logged (by LogFormatter.log_revision).
525
A simple wrapper for the attributes of a revision to be logged.
526
The attributes may or may not be populated, as determined by the
527
logging options and the log formatter capabilities.
530
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
534
self.merge_depth = merge_depth
539
class LogFormatter(object):
540
"""Abstract class to display log messages.
542
At a minimum, a derived class must implement the log_revision method.
544
If the LogFormatter needs to be informed of the beginning or end of
545
a log it should implement the begin_log and/or end_log hook methods.
547
A LogFormatter should define the following supports_XXX flags
548
to indicate which LogRevision attributes it supports:
550
- supports_delta must be True if this log formatter supports delta.
551
Otherwise the delta attribute may not be populated.
552
- supports_merge_revisions must be True if this log formatter supports
553
merge revisions. If not, and if supports_single_merge_revisions is
554
also not True, then only mainline revisions will be passed to the
556
- supports_single_merge_revision must be True if this log formatter
557
supports logging only a single merge revision. This flag is
558
only relevant if supports_merge_revisions is not True.
559
- supports_tags must be True if this log formatter supports tags.
560
Otherwise the tags attribute may not be populated.
563
def __init__(self, to_file, show_ids=False, show_timezone='original'):
564
self.to_file = to_file
565
self.show_ids = show_ids
566
self.show_timezone = show_timezone
568
# TODO: uncomment this block after show() has been removed.
569
# Until then defining log_revision would prevent _show_log calling show()
570
# in legacy formatters.
571
# def log_revision(self, revision):
574
# :param revision: The LogRevision to be logged.
576
# raise NotImplementedError('not implemented in abstract base')
578
def short_committer(self, rev):
579
name, address = config.parse_username(rev.committer)
584
def short_author(self, rev):
585
name, address = config.parse_username(rev.get_apparent_author())
591
class LongLogFormatter(LogFormatter):
593
supports_merge_revisions = True
594
supports_delta = True
597
def log_revision(self, revision):
598
"""Log a revision, either merged or not."""
599
indent = ' ' * revision.merge_depth
600
to_file = self.to_file
601
to_file.write(indent + '-' * 60 + '\n')
602
if revision.revno is not None:
603
to_file.write(indent + 'revno: %s\n' % (revision.revno,))
605
to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
607
to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
609
for parent_id in revision.rev.parent_ids:
610
to_file.write(indent + 'parent: %s\n' % (parent_id,))
612
author = revision.rev.properties.get('author', None)
613
if author is not None:
614
to_file.write(indent + 'author: %s\n' % (author,))
615
to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
617
branch_nick = revision.rev.properties.get('branch-nick', None)
618
if branch_nick is not None:
619
to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
621
date_str = format_date(revision.rev.timestamp,
622
revision.rev.timezone or 0,
624
to_file.write(indent + 'timestamp: %s\n' % (date_str,))
626
to_file.write(indent + 'message:\n')
627
if not revision.rev.message:
628
to_file.write(indent + ' (no message)\n')
630
message = revision.rev.message.rstrip('\r\n')
631
for l in message.split('\n'):
632
to_file.write(indent + ' %s\n' % (l,))
633
if revision.delta is not None:
634
revision.delta.show(to_file, self.show_ids, indent=indent)
637
class ShortLogFormatter(LogFormatter):
639
supports_delta = True
640
supports_single_merge_revision = True
642
def log_revision(self, revision):
643
to_file = self.to_file
644
date_str = format_date(revision.rev.timestamp,
645
revision.rev.timezone or 0,
648
if len(revision.rev.parent_ids) > 1:
649
is_merge = ' [merge]'
650
to_file.write("%5s %s\t%s%s\n" % (revision.revno,
651
self.short_author(revision.rev),
652
format_date(revision.rev.timestamp,
653
revision.rev.timezone or 0,
654
self.show_timezone, date_fmt="%Y-%m-%d",
658
to_file.write(' revision-id:%s\n' % (revision.rev.revision_id,))
659
if not revision.rev.message:
660
to_file.write(' (no message)\n')
662
message = revision.rev.message.rstrip('\r\n')
663
for l in message.split('\n'):
664
to_file.write(' %s\n' % (l,))
666
# TODO: Why not show the modified files in a shorter form as
667
# well? rewrap them single lines of appropriate length
668
if revision.delta is not None:
669
revision.delta.show(to_file, self.show_ids)
673
class LineLogFormatter(LogFormatter):
675
supports_single_merge_revision = True
677
def __init__(self, *args, **kwargs):
678
super(LineLogFormatter, self).__init__(*args, **kwargs)
679
self._max_chars = terminal_width() - 1
681
def truncate(self, str, max_len):
682
if len(str) <= max_len:
684
return str[:max_len-3]+'...'
686
def date_string(self, rev):
687
return format_date(rev.timestamp, rev.timezone or 0,
688
self.show_timezone, date_fmt="%Y-%m-%d",
691
def message(self, rev):
693
return '(no message)'
697
def log_revision(self, revision):
698
self.to_file.write(self.log_string(revision.revno, revision.rev,
700
self.to_file.write('\n')
702
def log_string(self, revno, rev, max_chars):
703
"""Format log info into one string. Truncate tail of string
704
:param revno: revision number (int) or None.
705
Revision numbers counts from 1.
706
:param rev: revision info object
707
:param max_chars: maximum length of resulting string
708
:return: formatted truncated string
712
# show revno only when is not None
713
out.append("%s:" % revno)
714
out.append(self.truncate(self.short_author(rev), 20))
715
out.append(self.date_string(rev))
716
out.append(rev.get_summary())
717
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
720
def line_log(rev, max_chars):
721
lf = LineLogFormatter(None)
722
return lf.log_string(None, rev, max_chars)
725
class LogFormatterRegistry(registry.Registry):
726
"""Registry for log formatters"""
728
def make_formatter(self, name, *args, **kwargs):
729
"""Construct a formatter from arguments.
731
:param name: Name of the formatter to construct. 'short', 'long' and
734
return self.get(name)(*args, **kwargs)
736
def get_default(self, branch):
737
return self.get(branch.get_config().log_format())
740
log_formatter_registry = LogFormatterRegistry()
743
log_formatter_registry.register('short', ShortLogFormatter,
744
'Moderately short log format')
745
log_formatter_registry.register('long', LongLogFormatter,
746
'Detailed log format')
747
log_formatter_registry.register('line', LineLogFormatter,
748
'Log format with one line per revision')
751
def register_formatter(name, formatter):
752
log_formatter_registry.register(name, formatter)
755
def log_formatter(name, *args, **kwargs):
756
"""Construct a formatter from arguments.
758
name -- Name of the formatter to construct; currently 'long', 'short' and
759
'line' are supported.
762
return log_formatter_registry.make_formatter(name, *args, **kwargs)
764
raise BzrCommandError("unknown log formatter: %r" % name)
767
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
768
# deprecated; for compatibility
769
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
770
lf.show(revno, rev, delta)
773
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
775
"""Show the change in revision history comparing the old revision history to the new one.
777
:param branch: The branch where the revisions exist
778
:param old_rh: The old revision history
779
:param new_rh: The new revision history
780
:param to_file: A file to write the results to. If None, stdout will be used
783
to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
785
lf = log_formatter(log_format,
788
show_timezone='original')
790
# This is the first index which is different between
793
for i in xrange(max(len(new_rh),
797
or new_rh[i] != old_rh[i]):
802
to_file.write('Nothing seems to have changed\n')
804
## TODO: It might be nice to do something like show_log
805
## and show the merged entries. But since this is the
806
## removed revisions, it shouldn't be as important
807
if base_idx < len(old_rh):
808
to_file.write('*'*60)
809
to_file.write('\nRemoved Revisions:\n')
810
for i in range(base_idx, len(old_rh)):
811
rev = branch.repository.get_revision(old_rh[i])
812
lr = LogRevision(rev, i+1, 0, None)
814
to_file.write('*'*60)
815
to_file.write('\n\n')
816
if base_idx < len(new_rh):
817
to_file.write('Added Revisions:\n')
823
start_revision=base_idx+1,
824
end_revision=len(new_rh),
added
removed
bzrlib/log.py
