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 (
62
from bzrlib.lazy_import import lazy_import
63
lazy_import(globals(), """
76
from bzrlib.osutils import (
78
get_terminal_encoding,
81
from bzrlib.repository import _strip_NULL_ghosts
82
from bzrlib.trace import mutter
85
def find_touching_revisions(branch, file_id):
86
"""Yield a description of revisions which affect the file_id.
88
Each returned element is (revno, revision_id, description)
90
This is the list of revisions where the file is either added,
91
modified, renamed or deleted.
93
TODO: Perhaps some way to limit this to only particular revisions,
94
or to traverse a non-mainline set of revisions?
99
for revision_id in branch.revision_history():
100
this_inv = branch.repository.get_revision_inventory(revision_id)
101
if file_id in this_inv:
102
this_ie = this_inv[file_id]
103
this_path = this_inv.id2path(file_id)
105
this_ie = this_path = None
107
# now we know how it was last time, and how it is in this revision.
108
# are those two states effectively the same or not?
110
if not this_ie and not last_ie:
111
# not present in either
113
elif this_ie and not last_ie:
114
yield revno, revision_id, "added " + this_path
115
elif not this_ie and last_ie:
117
yield revno, revision_id, "deleted " + last_path
118
elif this_path != last_path:
119
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
120
elif (this_ie.text_size != last_ie.text_size
121
or this_ie.text_sha1 != last_ie.text_sha1):
122
yield revno, revision_id, "modified " + this_path
125
last_path = this_path
129
def _enumerate_history(branch):
132
for rev_id in branch.revision_history():
133
rh.append((revno, rev_id))
140
specific_fileid=None,
147
"""Write out human-readable log of commits to this branch.
150
LogFormatter object to show the output.
153
If true, list only the commits affecting the specified
154
file, rather than all commits.
157
If true show added/changed/deleted/renamed files.
160
'reverse' (default) is latest to earliest;
161
'forward' is earliest to latest.
164
If not None, only show revisions >= start_revision
167
If not None, only show revisions <= end_revision
170
If not None, only show revisions with matching commit messages
173
If not None or 0, only show limit revisions
177
if getattr(lf, 'begin_log', None):
180
_show_log(branch, lf, specific_fileid, verbose, direction,
181
start_revision, end_revision, search, limit)
183
if getattr(lf, 'end_log', None):
189
def _show_log(branch,
191
specific_fileid=None,
198
"""Worker function for show_log - see show_log."""
199
if not isinstance(lf, LogFormatter):
200
warn("not a LogFormatter instance: %r" % lf)
203
mutter('get log for file_id %r', specific_fileid)
204
generate_merge_revisions = getattr(lf, 'supports_merge_revisions', False)
205
allow_single_merge_revision = getattr(lf,
206
'supports_single_merge_revision', False)
207
view_revisions = calculate_view_revisions(branch, start_revision,
208
end_revision, direction,
210
generate_merge_revisions,
211
allow_single_merge_revision)
212
if search is not None:
213
searchRE = re.compile(search, re.IGNORECASE)
218
generate_tags = getattr(lf, 'supports_tags', False)
220
if branch.supports_tags():
221
rev_tag_dict = branch.tags.get_reverse_tag_dict()
223
generate_delta = verbose and getattr(lf, 'supports_delta', False)
225
# now we just print all the revisions
227
for (rev_id, revno, merge_depth), rev, delta in _iter_revisions(
228
branch.repository, view_revisions, generate_delta):
230
if not searchRE.search(rev.message):
233
lr = LogRevision(rev, revno, merge_depth, delta,
234
rev_tag_dict.get(rev_id))
238
if log_count >= limit:
242
def calculate_view_revisions(branch, start_revision, end_revision, direction,
243
specific_fileid, generate_merge_revisions,
244
allow_single_merge_revision):
245
if (not generate_merge_revisions and start_revision is end_revision is
246
None and direction == 'reverse' and specific_fileid is None):
247
return _linear_view_revisions(branch)
249
mainline_revs, rev_nos, start_rev_id, end_rev_id = \
250
_get_mainline_revs(branch, start_revision, end_revision)
251
if not mainline_revs:
254
if direction == 'reverse':
255
start_rev_id, end_rev_id = end_rev_id, start_rev_id
257
generate_single_revision = False
258
if ((not generate_merge_revisions)
259
and ((start_rev_id and (start_rev_id not in rev_nos))
260
or (end_rev_id and (end_rev_id not in rev_nos)))):
261
generate_single_revision = ((start_rev_id == end_rev_id)
262
and allow_single_merge_revision)
263
if not generate_single_revision:
264
raise errors.BzrCommandError('Selected log formatter only supports '
265
'mainline revisions.')
266
generate_merge_revisions = generate_single_revision
267
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
268
direction, include_merges=generate_merge_revisions)
269
view_revisions = _filter_revision_range(list(view_revs_iter),
272
if view_revisions and generate_single_revision:
273
view_revisions = view_revisions[0:1]
275
view_revisions = _filter_revisions_touching_file_id(branch,
280
# rebase merge_depth - unless there are no revisions or
281
# either the first or last revision have merge_depth = 0.
282
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
283
min_depth = min([d for r,n,d in view_revisions])
285
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
286
return view_revisions
289
def _linear_view_revisions(branch):
290
start_revno, start_revision_id = branch.last_revision_info()
291
repo = branch.repository
292
revision_ids = repo.iter_reverse_revision_history(start_revision_id)
293
for num, revision_id in enumerate(revision_ids):
294
yield revision_id, str(start_revno - num), 0
297
def _iter_revisions(repository, view_revisions, generate_delta):
299
view_revisions = iter(view_revisions)
301
cur_view_revisions = [d for x, d in zip(range(num), view_revisions)]
302
if len(cur_view_revisions) == 0:
305
# r = revision, n = revno, d = merge depth
306
revision_ids = [r for (r, n, d) in cur_view_revisions]
307
revisions = repository.get_revisions(revision_ids)
309
deltas = repository.get_deltas_for_revisions(revisions)
310
cur_deltas = dict(izip((r.revision_id for r in revisions),
312
for view_data, revision in izip(cur_view_revisions, revisions):
313
yield view_data, revision, cur_deltas.get(revision.revision_id)
314
num = min(int(num * 1.5), 200)
317
def _get_mainline_revs(branch, start_revision, end_revision):
318
"""Get the mainline revisions from the branch.
320
Generates the list of mainline revisions for the branch.
322
:param branch: The branch containing the revisions.
324
:param start_revision: The first 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
:param end_revision: The last revision to be logged.
329
For backwards compatibility this may be a mainline integer revno,
330
but for merge revision support a RevisionInfo is expected.
332
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
334
which_revs = _enumerate_history(branch)
336
return None, None, None, None
338
# For mainline generation, map start_revision and end_revision to
339
# mainline revnos. If the revision is not on the mainline choose the
340
# appropriate extreme of the mainline instead - the extra will be
342
# Also map the revisions to rev_ids, to be used in the later filtering
345
if start_revision is None:
348
if isinstance(start_revision, revisionspec.RevisionInfo):
349
start_rev_id = start_revision.rev_id
350
start_revno = start_revision.revno or 1
352
branch.check_real_revno(start_revision)
353
start_revno = start_revision
356
if end_revision is None:
357
end_revno = len(which_revs)
359
if isinstance(end_revision, revisionspec.RevisionInfo):
360
end_rev_id = end_revision.rev_id
361
end_revno = end_revision.revno or len(which_revs)
363
branch.check_real_revno(end_revision)
364
end_revno = end_revision
366
if ((start_rev_id == revision.NULL_REVISION)
367
or (end_rev_id == revision.NULL_REVISION)):
368
raise errors.BzrCommandError('Logging revision 0 is invalid.')
369
if start_revno > end_revno:
370
raise errors.BzrCommandError("Start revision must be older than "
373
# list indexes are 0-based; revisions are 1-based
374
cut_revs = which_revs[(start_revno-1):(end_revno)]
376
return None, None, None, None
378
# convert the revision history to a dictionary:
379
rev_nos = dict((k, v) for v, k in cut_revs)
381
# override the mainline to look like the revision history.
382
mainline_revs = [revision_id for index, revision_id in cut_revs]
383
if cut_revs[0][0] == 1:
384
mainline_revs.insert(0, None)
386
mainline_revs.insert(0, which_revs[start_revno-2][1])
387
return mainline_revs, rev_nos, start_rev_id, end_rev_id
390
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
391
"""Filter view_revisions based on revision ranges.
393
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
394
tuples to be filtered.
396
:param start_rev_id: If not NONE specifies the first revision to be logged.
397
If NONE then all revisions up to the end_rev_id are logged.
399
:param end_rev_id: If not NONE specifies the last revision to be logged.
400
If NONE then all revisions up to the end of the log are logged.
402
:return: The filtered view_revisions.
404
if start_rev_id or end_rev_id:
405
revision_ids = [r for r, n, d in view_revisions]
407
start_index = revision_ids.index(start_rev_id)
410
if start_rev_id == end_rev_id:
411
end_index = start_index
414
end_index = revision_ids.index(end_rev_id)
416
end_index = len(view_revisions) - 1
417
# To include the revisions merged into the last revision,
418
# extend end_rev_id down to, but not including, the next rev
419
# with the same or lesser merge_depth
420
end_merge_depth = view_revisions[end_index][2]
422
for index in xrange(end_index+1, len(view_revisions)+1):
423
if view_revisions[index][2] <= end_merge_depth:
424
end_index = index - 1
427
# if the search falls off the end then log to the end as well
428
end_index = len(view_revisions) - 1
429
view_revisions = view_revisions[start_index:end_index+1]
430
return view_revisions
433
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
435
"""Return the list of revision ids which touch a given file id.
437
The function filters view_revisions and returns a subset.
438
This includes the revisions which directly change the file id,
439
and the revisions which merge these changes. So if the
447
And 'C' changes a file, then both C and D will be returned.
449
This will also can be restricted based on a subset of the mainline.
451
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
453
# find all the revisions that change the specific file
454
file_weave = branch.repository.weave_store.get_weave(file_id,
455
branch.repository.get_transaction())
456
weave_modifed_revisions = set(file_weave.versions())
457
# build the ancestry of each revision in the graph
458
# - only listing the ancestors that change the specific file.
459
graph = branch.repository.get_graph()
460
# This asks for all mainline revisions, which means we only have to spider
461
# sideways, rather than depth history. That said, its still size-of-history
462
# and should be addressed.
463
parent_map = dict(((key, value) for key, value in
464
graph.iter_ancestry(mainline_revisions) if value is not None))
465
sorted_rev_list = tsort.topo_sort(parent_map.items())
467
for rev in sorted_rev_list:
468
parents = parent_map[rev]
469
if rev not in weave_modifed_revisions and len(parents) == 1:
470
# We will not be adding anything new, so just use a reference to
471
# the parent ancestry.
472
rev_ancestry = ancestry[parents[0]]
475
if rev in weave_modifed_revisions:
476
rev_ancestry.add(rev)
477
for parent in parents:
478
rev_ancestry = rev_ancestry.union(ancestry[parent])
479
ancestry[rev] = rev_ancestry
481
def is_merging_rev(r):
482
parents = parent_map[r]
484
leftparent = parents[0]
485
for rightparent in parents[1:]:
486
if not ancestry[leftparent].issuperset(
487
ancestry[rightparent]):
491
# filter from the view the revisions that did not change or merge
493
return [(r, n, d) for r, n, d in view_revs_iter
494
if r in weave_modifed_revisions or is_merging_rev(r)]
497
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
498
include_merges=True):
499
"""Produce an iterator of revisions to show
500
:return: an iterator of (revision_id, revno, merge_depth)
501
(if there is no revno for a revision, None is supplied)
503
if include_merges is False:
504
revision_ids = mainline_revs[1:]
505
if direction == 'reverse':
506
revision_ids.reverse()
507
for revision_id in revision_ids:
508
yield revision_id, str(rev_nos[revision_id]), 0
510
graph = branch.repository.get_graph()
511
# This asks for all mainline revisions, which means we only have to spider
512
# sideways, rather than depth history. That said, its still size-of-history
513
# and should be addressed.
514
parent_map = dict(((key, value) for key, value in
515
graph.iter_ancestry(mainline_revs) if value is not None))
516
# filter out ghosts; merge_sort errors on ghosts.
517
rev_graph = _strip_NULL_ghosts(parent_map)
518
merge_sorted_revisions = tsort.merge_sort(
524
if direction == 'forward':
525
# forward means oldest first.
526
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
527
elif direction != 'reverse':
528
raise ValueError('invalid direction %r' % direction)
530
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
531
yield rev_id, '.'.join(map(str, revno)), merge_depth
534
def reverse_by_depth(merge_sorted_revisions, _depth=0):
535
"""Reverse revisions by depth.
537
Revisions with a different depth are sorted as a group with the previous
538
revision of that depth. There may be no topological justification for this,
539
but it looks much nicer.
542
for val in merge_sorted_revisions:
544
zd_revisions.append([val])
546
assert val[2] > _depth
547
zd_revisions[-1].append(val)
548
for revisions in zd_revisions:
549
if len(revisions) > 1:
550
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
551
zd_revisions.reverse()
553
for chunk in zd_revisions:
558
class LogRevision(object):
559
"""A revision to be logged (by LogFormatter.log_revision).
561
A simple wrapper for the attributes of a revision to be logged.
562
The attributes may or may not be populated, as determined by the
563
logging options and the log formatter capabilities.
566
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
570
self.merge_depth = merge_depth
575
class LogFormatter(object):
576
"""Abstract class to display log messages.
578
At a minimum, a derived class must implement the log_revision method.
580
If the LogFormatter needs to be informed of the beginning or end of
581
a log it should implement the begin_log and/or end_log hook methods.
583
A LogFormatter should define the following supports_XXX flags
584
to indicate which LogRevision attributes it supports:
586
- supports_delta must be True if this log formatter supports delta.
587
Otherwise the delta attribute may not be populated.
588
- supports_merge_revisions must be True if this log formatter supports
589
merge revisions. If not, and if supports_single_merge_revisions is
590
also not True, then only mainline revisions will be passed to the
592
- supports_single_merge_revision must be True if this log formatter
593
supports logging only a single merge revision. This flag is
594
only relevant if supports_merge_revisions is not True.
595
- supports_tags must be True if this log formatter supports tags.
596
Otherwise the tags attribute may not be populated.
599
def __init__(self, to_file, show_ids=False, show_timezone='original'):
600
self.to_file = to_file
601
self.show_ids = show_ids
602
self.show_timezone = show_timezone
604
# TODO: uncomment this block after show() has been removed.
605
# Until then defining log_revision would prevent _show_log calling show()
606
# in legacy formatters.
607
# def log_revision(self, revision):
610
# :param revision: The LogRevision to be logged.
612
# raise NotImplementedError('not implemented in abstract base')
614
def short_committer(self, rev):
615
name, address = config.parse_username(rev.committer)
620
def short_author(self, rev):
621
name, address = config.parse_username(rev.get_apparent_author())
627
class LongLogFormatter(LogFormatter):
629
supports_merge_revisions = True
630
supports_delta = True
633
def log_revision(self, revision):
634
"""Log a revision, either merged or not."""
635
indent = ' ' * revision.merge_depth
636
to_file = self.to_file
637
to_file.write(indent + '-' * 60 + '\n')
638
if revision.revno is not None:
639
to_file.write(indent + 'revno: %s\n' % (revision.revno,))
641
to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
643
to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
645
for parent_id in revision.rev.parent_ids:
646
to_file.write(indent + 'parent: %s\n' % (parent_id,))
648
author = revision.rev.properties.get('author', None)
649
if author is not None:
650
to_file.write(indent + 'author: %s\n' % (author,))
651
to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
653
branch_nick = revision.rev.properties.get('branch-nick', None)
654
if branch_nick is not None:
655
to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
657
date_str = format_date(revision.rev.timestamp,
658
revision.rev.timezone or 0,
660
to_file.write(indent + 'timestamp: %s\n' % (date_str,))
662
to_file.write(indent + 'message:\n')
663
if not revision.rev.message:
664
to_file.write(indent + ' (no message)\n')
666
message = revision.rev.message.rstrip('\r\n')
667
for l in message.split('\n'):
668
to_file.write(indent + ' %s\n' % (l,))
669
if revision.delta is not None:
670
revision.delta.show(to_file, self.show_ids, indent=indent)
673
class ShortLogFormatter(LogFormatter):
675
supports_delta = True
676
supports_single_merge_revision = True
678
def log_revision(self, revision):
679
to_file = self.to_file
680
date_str = format_date(revision.rev.timestamp,
681
revision.rev.timezone or 0,
684
if len(revision.rev.parent_ids) > 1:
685
is_merge = ' [merge]'
686
to_file.write("%5s %s\t%s%s\n" % (revision.revno,
687
self.short_author(revision.rev),
688
format_date(revision.rev.timestamp,
689
revision.rev.timezone or 0,
690
self.show_timezone, date_fmt="%Y-%m-%d",
694
to_file.write(' revision-id:%s\n' % (revision.rev.revision_id,))
695
if not revision.rev.message:
696
to_file.write(' (no message)\n')
698
message = revision.rev.message.rstrip('\r\n')
699
for l in message.split('\n'):
700
to_file.write(' %s\n' % (l,))
702
# TODO: Why not show the modified files in a shorter form as
703
# well? rewrap them single lines of appropriate length
704
if revision.delta is not None:
705
revision.delta.show(to_file, self.show_ids)
709
class LineLogFormatter(LogFormatter):
711
supports_single_merge_revision = True
713
def __init__(self, *args, **kwargs):
714
super(LineLogFormatter, self).__init__(*args, **kwargs)
715
self._max_chars = terminal_width() - 1
717
def truncate(self, str, max_len):
718
if len(str) <= max_len:
720
return str[:max_len-3]+'...'
722
def date_string(self, rev):
723
return format_date(rev.timestamp, rev.timezone or 0,
724
self.show_timezone, date_fmt="%Y-%m-%d",
727
def message(self, rev):
729
return '(no message)'
733
def log_revision(self, revision):
734
self.to_file.write(self.log_string(revision.revno, revision.rev,
736
self.to_file.write('\n')
738
def log_string(self, revno, rev, max_chars):
739
"""Format log info into one string. Truncate tail of string
740
:param revno: revision number (int) or None.
741
Revision numbers counts from 1.
742
:param rev: revision info object
743
:param max_chars: maximum length of resulting string
744
:return: formatted truncated string
748
# show revno only when is not None
749
out.append("%s:" % revno)
750
out.append(self.truncate(self.short_author(rev), 20))
751
out.append(self.date_string(rev))
752
out.append(rev.get_summary())
753
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
756
def line_log(rev, max_chars):
757
lf = LineLogFormatter(None)
758
return lf.log_string(None, rev, max_chars)
761
class LogFormatterRegistry(registry.Registry):
762
"""Registry for log formatters"""
764
def make_formatter(self, name, *args, **kwargs):
765
"""Construct a formatter from arguments.
767
:param name: Name of the formatter to construct. 'short', 'long' and
770
return self.get(name)(*args, **kwargs)
772
def get_default(self, branch):
773
return self.get(branch.get_config().log_format())
776
log_formatter_registry = LogFormatterRegistry()
779
log_formatter_registry.register('short', ShortLogFormatter,
780
'Moderately short log format')
781
log_formatter_registry.register('long', LongLogFormatter,
782
'Detailed log format')
783
log_formatter_registry.register('line', LineLogFormatter,
784
'Log format with one line per revision')
787
def register_formatter(name, formatter):
788
log_formatter_registry.register(name, formatter)
791
def log_formatter(name, *args, **kwargs):
792
"""Construct a formatter from arguments.
794
name -- Name of the formatter to construct; currently 'long', 'short' and
795
'line' are supported.
798
return log_formatter_registry.make_formatter(name, *args, **kwargs)
800
raise errors.BzrCommandError("unknown log formatter: %r" % name)
803
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
804
# deprecated; for compatibility
805
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
806
lf.show(revno, rev, delta)
809
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
811
"""Show the change in revision history comparing the old revision history to the new one.
813
:param branch: The branch where the revisions exist
814
:param old_rh: The old revision history
815
:param new_rh: The new revision history
816
:param to_file: A file to write the results to. If None, stdout will be used
819
to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
821
lf = log_formatter(log_format,
824
show_timezone='original')
826
# This is the first index which is different between
829
for i in xrange(max(len(new_rh),
833
or new_rh[i] != old_rh[i]):
838
to_file.write('Nothing seems to have changed\n')
840
## TODO: It might be nice to do something like show_log
841
## and show the merged entries. But since this is the
842
## removed revisions, it shouldn't be as important
843
if base_idx < len(old_rh):
844
to_file.write('*'*60)
845
to_file.write('\nRemoved Revisions:\n')
846
for i in range(base_idx, len(old_rh)):
847
rev = branch.repository.get_revision(old_rh[i])
848
lr = LogRevision(rev, i+1, 0, None)
850
to_file.write('*'*60)
851
to_file.write('\n\n')
852
if base_idx < len(new_rh):
853
to_file.write('Added Revisions:\n')
859
start_revision=base_idx+1,
860
end_revision=len(new_rh),
added
removed
bzrlib/log.py
