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):
192
def _show_log(branch,
194
specific_fileid=None,
201
"""Worker function for show_log - see show_log."""
202
if not isinstance(lf, LogFormatter):
203
warn("not a LogFormatter instance: %r" % lf)
206
mutter('get log for file_id %r', specific_fileid)
207
generate_merge_revisions = getattr(lf, 'supports_merge_revisions', False)
208
allow_single_merge_revision = getattr(lf,
209
'supports_single_merge_revision', False)
210
view_revisions = calculate_view_revisions(branch, start_revision,
211
end_revision, direction,
213
generate_merge_revisions,
214
allow_single_merge_revision)
215
if search is not None:
216
searchRE = re.compile(search, re.IGNORECASE)
221
generate_tags = getattr(lf, 'supports_tags', False)
223
if branch.supports_tags():
224
rev_tag_dict = branch.tags.get_reverse_tag_dict()
226
generate_delta = verbose and getattr(lf, 'supports_delta', False)
228
# now we just print all the revisions
230
for (rev_id, revno, merge_depth), rev, delta in _iter_revisions(
231
branch.repository, view_revisions, generate_delta):
233
if not searchRE.search(rev.message):
236
lr = LogRevision(rev, revno, merge_depth, delta,
237
rev_tag_dict.get(rev_id))
241
if log_count >= limit:
245
def calculate_view_revisions(branch, start_revision, end_revision, direction,
246
specific_fileid, generate_merge_revisions,
247
allow_single_merge_revision):
248
if (not generate_merge_revisions and start_revision is end_revision is
249
None and direction == 'reverse' and specific_fileid is None):
250
return _linear_view_revisions(branch)
252
mainline_revs, rev_nos, start_rev_id, end_rev_id = \
253
_get_mainline_revs(branch, start_revision, end_revision)
254
if not mainline_revs:
257
if direction == 'reverse':
258
start_rev_id, end_rev_id = end_rev_id, start_rev_id
260
generate_single_revision = False
261
if ((not generate_merge_revisions)
262
and ((start_rev_id and (start_rev_id not in rev_nos))
263
or (end_rev_id and (end_rev_id not in rev_nos)))):
264
generate_single_revision = ((start_rev_id == end_rev_id)
265
and allow_single_merge_revision)
266
if not generate_single_revision:
267
raise BzrCommandError('Selected log formatter only supports '
268
'mainline revisions.')
269
generate_merge_revisions = generate_single_revision
270
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
271
direction, include_merges=generate_merge_revisions)
272
view_revisions = _filter_revision_range(list(view_revs_iter),
275
if view_revisions and generate_single_revision:
276
view_revisions = view_revisions[0:1]
278
view_revisions = _filter_revisions_touching_file_id(branch,
283
# rebase merge_depth - unless there are no revisions or
284
# either the first or last revision have merge_depth = 0.
285
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
286
min_depth = min([d for r,n,d in view_revisions])
288
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
289
return view_revisions
292
def _linear_view_revisions(branch):
293
start_revno, start_revision_id = branch.last_revision_info()
294
repo = branch.repository
295
revision_ids = repo.iter_reverse_revision_history(start_revision_id)
296
for num, revision_id in enumerate(revision_ids):
297
yield revision_id, str(start_revno - num), 0
300
def _iter_revisions(repository, view_revisions, generate_delta):
302
view_revisions = iter(view_revisions)
304
cur_view_revisions = [d for x, d in zip(range(num), view_revisions)]
305
if len(cur_view_revisions) == 0:
308
# r = revision, n = revno, d = merge depth
309
revision_ids = [r for (r, n, d) in cur_view_revisions]
310
revisions = repository.get_revisions(revision_ids)
312
deltas = repository.get_deltas_for_revisions(revisions)
313
cur_deltas = dict(izip((r.revision_id for r in revisions),
315
for view_data, revision in izip(cur_view_revisions, revisions):
316
yield view_data, revision, cur_deltas.get(revision.revision_id)
317
num = min(int(num * 1.5), 200)
320
def _get_mainline_revs(branch, start_revision, end_revision):
321
"""Get the mainline revisions from the branch.
323
Generates the list of mainline revisions for the branch.
325
:param branch: The branch containing the revisions.
327
:param start_revision: The first revision to be logged.
328
For backwards compatibility this may be a mainline integer revno,
329
but for merge revision support a RevisionInfo is expected.
331
:param end_revision: The last revision to be logged.
332
For backwards compatibility this may be a mainline integer revno,
333
but for merge revision support a RevisionInfo is expected.
335
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
337
which_revs = _enumerate_history(branch)
339
return None, None, None, None
341
# For mainline generation, map start_revision and end_revision to
342
# mainline revnos. If the revision is not on the mainline choose the
343
# appropriate extreme of the mainline instead - the extra will be
345
# Also map the revisions to rev_ids, to be used in the later filtering
348
if start_revision is None:
351
if isinstance(start_revision,RevisionInfo):
352
start_rev_id = start_revision.rev_id
353
start_revno = start_revision.revno or 1
355
branch.check_real_revno(start_revision)
356
start_revno = start_revision
359
if end_revision is None:
360
end_revno = len(which_revs)
362
if isinstance(end_revision,RevisionInfo):
363
end_rev_id = end_revision.rev_id
364
end_revno = end_revision.revno or len(which_revs)
366
branch.check_real_revno(end_revision)
367
end_revno = end_revision
369
if ((start_rev_id == NULL_REVISION)
370
or (end_rev_id == NULL_REVISION)):
371
raise BzrCommandError('Logging revision 0 is invalid.')
372
if start_revno > end_revno:
373
raise BzrCommandError("Start revision must be older than "
376
# list indexes are 0-based; revisions are 1-based
377
cut_revs = which_revs[(start_revno-1):(end_revno)]
379
return None, None, None, None
381
# convert the revision history to a dictionary:
382
rev_nos = dict((k, v) for v, k in cut_revs)
384
# override the mainline to look like the revision history.
385
mainline_revs = [revision_id for index, revision_id in cut_revs]
386
if cut_revs[0][0] == 1:
387
mainline_revs.insert(0, None)
389
mainline_revs.insert(0, which_revs[start_revno-2][1])
390
return mainline_revs, rev_nos, start_rev_id, end_rev_id
393
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
394
"""Filter view_revisions based on revision ranges.
396
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
397
tuples to be filtered.
399
:param start_rev_id: If not NONE specifies the first revision to be logged.
400
If NONE then all revisions up to the end_rev_id are logged.
402
:param end_rev_id: If not NONE specifies the last revision to be logged.
403
If NONE then all revisions up to the end of the log are logged.
405
:return: The filtered view_revisions.
407
if start_rev_id or end_rev_id:
408
revision_ids = [r for r, n, d in view_revisions]
410
start_index = revision_ids.index(start_rev_id)
413
if start_rev_id == end_rev_id:
414
end_index = start_index
417
end_index = revision_ids.index(end_rev_id)
419
end_index = len(view_revisions) - 1
420
# To include the revisions merged into the last revision,
421
# extend end_rev_id down to, but not including, the next rev
422
# with the same or lesser merge_depth
423
end_merge_depth = view_revisions[end_index][2]
425
for index in xrange(end_index+1, len(view_revisions)+1):
426
if view_revisions[index][2] <= end_merge_depth:
427
end_index = index - 1
430
# if the search falls off the end then log to the end as well
431
end_index = len(view_revisions) - 1
432
view_revisions = view_revisions[start_index:end_index+1]
433
return view_revisions
436
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
438
"""Return the list of revision ids which touch a given file id.
440
The function filters view_revisions and returns a subset.
441
This includes the revisions which directly change the file id,
442
and the revisions which merge these changes. So if the
450
And 'C' changes a file, then both C and D will be returned.
452
This will also can be restricted based on a subset of the mainline.
454
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
456
# find all the revisions that change the specific file
457
file_weave = branch.repository.weave_store.get_weave(file_id,
458
branch.repository.get_transaction())
459
weave_modifed_revisions = set(file_weave.versions())
460
# build the ancestry of each revision in the graph
461
# - only listing the ancestors that change the specific file.
462
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
463
sorted_rev_list = topo_sort(rev_graph)
465
for rev in sorted_rev_list:
466
parents = rev_graph[rev]
467
if rev not in weave_modifed_revisions and len(parents) == 1:
468
# We will not be adding anything new, so just use a reference to
469
# the parent ancestry.
470
rev_ancestry = ancestry[parents[0]]
473
if rev in weave_modifed_revisions:
474
rev_ancestry.add(rev)
475
for parent in parents:
476
rev_ancestry = rev_ancestry.union(ancestry[parent])
477
ancestry[rev] = rev_ancestry
479
def is_merging_rev(r):
480
parents = rev_graph[r]
482
leftparent = parents[0]
483
for rightparent in parents[1:]:
484
if not ancestry[leftparent].issuperset(
485
ancestry[rightparent]):
489
# filter from the view the revisions that did not change or merge
491
return [(r, n, d) for r, n, d in view_revs_iter
492
if r in weave_modifed_revisions or is_merging_rev(r)]
495
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
496
include_merges=True):
497
"""Produce an iterator of revisions to show
498
:return: an iterator of (revision_id, revno, merge_depth)
499
(if there is no revno for a revision, None is supplied)
501
if include_merges is False:
502
revision_ids = mainline_revs[1:]
503
if direction == 'reverse':
504
revision_ids.reverse()
505
for revision_id in revision_ids:
506
yield revision_id, str(rev_nos[revision_id]), 0
508
merge_sorted_revisions = merge_sort(
509
branch.repository.get_revision_graph(mainline_revs[-1]),
514
if direction == 'forward':
515
# forward means oldest first.
516
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
517
elif direction != 'reverse':
518
raise ValueError('invalid direction %r' % direction)
520
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
521
yield rev_id, '.'.join(map(str, revno)), merge_depth
524
def reverse_by_depth(merge_sorted_revisions, _depth=0):
525
"""Reverse revisions by depth.
527
Revisions with a different depth are sorted as a group with the previous
528
revision of that depth. There may be no topological justification for this,
529
but it looks much nicer.
532
for val in merge_sorted_revisions:
534
zd_revisions.append([val])
536
assert val[2] > _depth
537
zd_revisions[-1].append(val)
538
for revisions in zd_revisions:
539
if len(revisions) > 1:
540
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
541
zd_revisions.reverse()
543
for chunk in zd_revisions:
548
class LogRevision(object):
549
"""A revision to be logged (by LogFormatter.log_revision).
551
A simple wrapper for the attributes of a revision to be logged.
552
The attributes may or may not be populated, as determined by the
553
logging options and the log formatter capabilities.
556
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
560
self.merge_depth = merge_depth
565
class LogFormatter(object):
566
"""Abstract class to display log messages.
568
At a minimum, a derived class must implement the log_revision method.
570
If the LogFormatter needs to be informed of the beginning or end of
571
a log it should implement the begin_log and/or end_log hook methods.
573
A LogFormatter should define the following supports_XXX flags
574
to indicate which LogRevision attributes it supports:
576
- supports_delta must be True if this log formatter supports delta.
577
Otherwise the delta attribute may not be populated.
578
- supports_merge_revisions must be True if this log formatter supports
579
merge revisions. If not, and if supports_single_merge_revisions is
580
also not True, then only mainline revisions will be passed to the
582
- supports_single_merge_revision must be True if this log formatter
583
supports logging only a single merge revision. This flag is
584
only relevant if supports_merge_revisions is not True.
585
- supports_tags must be True if this log formatter supports tags.
586
Otherwise the tags attribute may not be populated.
589
def __init__(self, to_file, show_ids=False, show_timezone='original'):
590
self.to_file = to_file
591
self.show_ids = show_ids
592
self.show_timezone = show_timezone
594
# TODO: uncomment this block after show() has been removed.
595
# Until then defining log_revision would prevent _show_log calling show()
596
# in legacy formatters.
597
# def log_revision(self, revision):
600
# :param revision: The LogRevision to be logged.
602
# raise NotImplementedError('not implemented in abstract base')
604
def short_committer(self, rev):
605
name, address = config.parse_username(rev.committer)
610
def short_author(self, rev):
611
name, address = config.parse_username(rev.get_apparent_author())
617
class LongLogFormatter(LogFormatter):
619
supports_merge_revisions = True
620
supports_delta = True
623
def log_revision(self, revision):
624
"""Log a revision, either merged or not."""
625
indent = ' ' * revision.merge_depth
626
to_file = self.to_file
627
to_file.write(indent + '-' * 60 + '\n')
628
if revision.revno is not None:
629
to_file.write(indent + 'revno: %s\n' % (revision.revno,))
631
to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
633
to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
635
for parent_id in revision.rev.parent_ids:
636
to_file.write(indent + 'parent: %s\n' % (parent_id,))
638
author = revision.rev.properties.get('author', None)
639
if author is not None:
640
to_file.write(indent + 'author: %s\n' % (author,))
641
to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
643
branch_nick = revision.rev.properties.get('branch-nick', None)
644
if branch_nick is not None:
645
to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
647
date_str = format_date(revision.rev.timestamp,
648
revision.rev.timezone or 0,
650
to_file.write(indent + 'timestamp: %s\n' % (date_str,))
652
to_file.write(indent + 'message:\n')
653
if not revision.rev.message:
654
to_file.write(indent + ' (no message)\n')
656
message = revision.rev.message.rstrip('\r\n')
657
for l in message.split('\n'):
658
to_file.write(indent + ' %s\n' % (l,))
659
if revision.delta is not None:
660
revision.delta.show(to_file, self.show_ids, indent=indent)
663
class ShortLogFormatter(LogFormatter):
665
supports_delta = True
666
supports_single_merge_revision = True
668
def log_revision(self, revision):
669
to_file = self.to_file
670
date_str = format_date(revision.rev.timestamp,
671
revision.rev.timezone or 0,
674
if len(revision.rev.parent_ids) > 1:
675
is_merge = ' [merge]'
676
to_file.write("%5s %s\t%s%s\n" % (revision.revno,
677
self.short_author(revision.rev),
678
format_date(revision.rev.timestamp,
679
revision.rev.timezone or 0,
680
self.show_timezone, date_fmt="%Y-%m-%d",
684
to_file.write(' revision-id:%s\n' % (revision.rev.revision_id,))
685
if not revision.rev.message:
686
to_file.write(' (no message)\n')
688
message = revision.rev.message.rstrip('\r\n')
689
for l in message.split('\n'):
690
to_file.write(' %s\n' % (l,))
692
# TODO: Why not show the modified files in a shorter form as
693
# well? rewrap them single lines of appropriate length
694
if revision.delta is not None:
695
revision.delta.show(to_file, self.show_ids)
699
class LineLogFormatter(LogFormatter):
701
supports_single_merge_revision = True
703
def __init__(self, *args, **kwargs):
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
return format_date(rev.timestamp, rev.timezone or 0,
714
self.show_timezone, date_fmt="%Y-%m-%d",
717
def message(self, rev):
719
return '(no message)'
723
def log_revision(self, revision):
724
self.to_file.write(self.log_string(revision.revno, revision.rev,
726
self.to_file.write('\n')
728
def log_string(self, revno, rev, max_chars):
729
"""Format log info into one string. Truncate tail of string
730
:param revno: revision number (int) or None.
731
Revision numbers counts from 1.
732
:param rev: revision info object
733
:param max_chars: maximum length of resulting string
734
:return: formatted truncated string
738
# show revno only when is not None
739
out.append("%s:" % revno)
740
out.append(self.truncate(self.short_author(rev), 20))
741
out.append(self.date_string(rev))
742
out.append(rev.get_summary())
743
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
746
def line_log(rev, max_chars):
747
lf = LineLogFormatter(None)
748
return lf.log_string(None, rev, max_chars)
751
class LogFormatterRegistry(registry.Registry):
752
"""Registry for log formatters"""
754
def make_formatter(self, name, *args, **kwargs):
755
"""Construct a formatter from arguments.
757
:param name: Name of the formatter to construct. 'short', 'long' and
760
return self.get(name)(*args, **kwargs)
762
def get_default(self, branch):
763
return self.get(branch.get_config().log_format())
766
log_formatter_registry = LogFormatterRegistry()
769
log_formatter_registry.register('short', ShortLogFormatter,
770
'Moderately short log format')
771
log_formatter_registry.register('long', LongLogFormatter,
772
'Detailed log format')
773
log_formatter_registry.register('line', LineLogFormatter,
774
'Log format with one line per revision')
777
def register_formatter(name, formatter):
778
log_formatter_registry.register(name, formatter)
781
def log_formatter(name, *args, **kwargs):
782
"""Construct a formatter from arguments.
784
name -- Name of the formatter to construct; currently 'long', 'short' and
785
'line' are supported.
788
return log_formatter_registry.make_formatter(name, *args, **kwargs)
790
raise BzrCommandError("unknown log formatter: %r" % name)
793
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
794
# deprecated; for compatibility
795
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
796
lf.show(revno, rev, delta)
799
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
801
"""Show the change in revision history comparing the old revision history to the new one.
803
:param branch: The branch where the revisions exist
804
:param old_rh: The old revision history
805
:param new_rh: The new revision history
806
:param to_file: A file to write the results to. If None, stdout will be used
809
to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
811
lf = log_formatter(log_format,
814
show_timezone='original')
816
# This is the first index which is different between
819
for i in xrange(max(len(new_rh),
823
or new_rh[i] != old_rh[i]):
828
to_file.write('Nothing seems to have changed\n')
830
## TODO: It might be nice to do something like show_log
831
## and show the merged entries. But since this is the
832
## removed revisions, it shouldn't be as important
833
if base_idx < len(old_rh):
834
to_file.write('*'*60)
835
to_file.write('\nRemoved Revisions:\n')
836
for i in range(base_idx, len(old_rh)):
837
rev = branch.repository.get_revision(old_rh[i])
838
lr = LogRevision(rev, i+1, 0, None)
840
to_file.write('*'*60)
841
to_file.write('\n\n')
842
if base_idx < len(new_rh):
843
to_file.write('Added Revisions:\n')
849
start_revision=base_idx+1,
850
end_revision=len(new_rh),
added
removed
bzrlib/log.py
