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.repository import _strip_NULL_ghosts
76
from bzrlib.revision import (
79
from bzrlib.revisionspec import (
82
from bzrlib.trace import mutter
83
from bzrlib.tsort import (
89
def find_touching_revisions(branch, file_id):
90
"""Yield a description of revisions which affect the file_id.
92
Each returned element is (revno, revision_id, description)
94
This is the list of revisions where the file is either added,
95
modified, renamed or deleted.
97
TODO: Perhaps some way to limit this to only particular revisions,
98
or to traverse a non-mainline set of revisions?
103
for revision_id in branch.revision_history():
104
this_inv = branch.repository.get_revision_inventory(revision_id)
105
if file_id in this_inv:
106
this_ie = this_inv[file_id]
107
this_path = this_inv.id2path(file_id)
109
this_ie = this_path = None
111
# now we know how it was last time, and how it is in this revision.
112
# are those two states effectively the same or not?
114
if not this_ie and not last_ie:
115
# not present in either
117
elif this_ie and not last_ie:
118
yield revno, revision_id, "added " + this_path
119
elif not this_ie and last_ie:
121
yield revno, revision_id, "deleted " + last_path
122
elif this_path != last_path:
123
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
124
elif (this_ie.text_size != last_ie.text_size
125
or this_ie.text_sha1 != last_ie.text_sha1):
126
yield revno, revision_id, "modified " + this_path
129
last_path = this_path
133
def _enumerate_history(branch):
136
for rev_id in branch.revision_history():
137
rh.append((revno, rev_id))
144
specific_fileid=None,
151
"""Write out human-readable log of commits to this branch.
154
LogFormatter object to show the output.
157
If true, list only the commits affecting the specified
158
file, rather than all commits.
161
If true show added/changed/deleted/renamed files.
164
'reverse' (default) is latest to earliest;
165
'forward' is earliest to latest.
168
If not None, only show revisions >= start_revision
171
If not None, only show revisions <= end_revision
174
If not None, only show revisions with matching commit messages
177
If not None or 0, only show limit revisions
181
if getattr(lf, 'begin_log', None):
184
_show_log(branch, lf, specific_fileid, verbose, direction,
185
start_revision, end_revision, search, limit)
187
if getattr(lf, 'end_log', None):
193
def _show_log(branch,
195
specific_fileid=None,
202
"""Worker function for show_log - see show_log."""
203
if not isinstance(lf, LogFormatter):
204
warn("not a LogFormatter instance: %r" % lf)
207
mutter('get log for file_id %r', specific_fileid)
208
generate_merge_revisions = getattr(lf, 'supports_merge_revisions', False)
209
allow_single_merge_revision = getattr(lf,
210
'supports_single_merge_revision', False)
211
view_revisions = calculate_view_revisions(branch, start_revision,
212
end_revision, direction,
214
generate_merge_revisions,
215
allow_single_merge_revision)
216
if search is not None:
217
searchRE = re.compile(search, re.IGNORECASE)
222
generate_tags = getattr(lf, 'supports_tags', False)
224
if branch.supports_tags():
225
rev_tag_dict = branch.tags.get_reverse_tag_dict()
227
generate_delta = verbose and getattr(lf, 'supports_delta', False)
229
# now we just print all the revisions
231
for (rev_id, revno, merge_depth), rev, delta in _iter_revisions(
232
branch.repository, view_revisions, generate_delta):
234
if not searchRE.search(rev.message):
237
lr = LogRevision(rev, revno, merge_depth, delta,
238
rev_tag_dict.get(rev_id))
242
if log_count >= limit:
246
def calculate_view_revisions(branch, start_revision, end_revision, direction,
247
specific_fileid, generate_merge_revisions,
248
allow_single_merge_revision):
249
if (not generate_merge_revisions and start_revision is end_revision is
250
None and direction == 'reverse' and specific_fileid is None):
251
return _linear_view_revisions(branch)
253
mainline_revs, rev_nos, start_rev_id, end_rev_id = \
254
_get_mainline_revs(branch, start_revision, end_revision)
255
if not mainline_revs:
258
if direction == 'reverse':
259
start_rev_id, end_rev_id = end_rev_id, start_rev_id
261
generate_single_revision = False
262
if ((not generate_merge_revisions)
263
and ((start_rev_id and (start_rev_id not in rev_nos))
264
or (end_rev_id and (end_rev_id not in rev_nos)))):
265
generate_single_revision = ((start_rev_id == end_rev_id)
266
and allow_single_merge_revision)
267
if not generate_single_revision:
268
raise BzrCommandError('Selected log formatter only supports '
269
'mainline revisions.')
270
generate_merge_revisions = generate_single_revision
271
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
272
direction, include_merges=generate_merge_revisions)
273
view_revisions = _filter_revision_range(list(view_revs_iter),
276
if view_revisions and generate_single_revision:
277
view_revisions = view_revisions[0:1]
279
view_revisions = _filter_revisions_touching_file_id(branch,
284
# rebase merge_depth - unless there are no revisions or
285
# either the first or last revision have merge_depth = 0.
286
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
287
min_depth = min([d for r,n,d in view_revisions])
289
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
290
return view_revisions
293
def _linear_view_revisions(branch):
294
start_revno, start_revision_id = branch.last_revision_info()
295
repo = branch.repository
296
revision_ids = repo.iter_reverse_revision_history(start_revision_id)
297
for num, revision_id in enumerate(revision_ids):
298
yield revision_id, str(start_revno - num), 0
301
def _iter_revisions(repository, view_revisions, generate_delta):
303
view_revisions = iter(view_revisions)
305
cur_view_revisions = [d for x, d in zip(range(num), view_revisions)]
306
if len(cur_view_revisions) == 0:
309
# r = revision, n = revno, d = merge depth
310
revision_ids = [r for (r, n, d) in cur_view_revisions]
311
revisions = repository.get_revisions(revision_ids)
313
deltas = repository.get_deltas_for_revisions(revisions)
314
cur_deltas = dict(izip((r.revision_id for r in revisions),
316
for view_data, revision in izip(cur_view_revisions, revisions):
317
yield view_data, revision, cur_deltas.get(revision.revision_id)
318
num = min(int(num * 1.5), 200)
321
def _get_mainline_revs(branch, start_revision, end_revision):
322
"""Get the mainline revisions from the branch.
324
Generates the list of mainline revisions for the branch.
326
:param branch: The branch containing the revisions.
328
:param start_revision: The first 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
:param end_revision: The last revision to be logged.
333
For backwards compatibility this may be a mainline integer revno,
334
but for merge revision support a RevisionInfo is expected.
336
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
338
which_revs = _enumerate_history(branch)
340
return None, None, None, None
342
# For mainline generation, map start_revision and end_revision to
343
# mainline revnos. If the revision is not on the mainline choose the
344
# appropriate extreme of the mainline instead - the extra will be
346
# Also map the revisions to rev_ids, to be used in the later filtering
349
if start_revision is None:
352
if isinstance(start_revision,RevisionInfo):
353
start_rev_id = start_revision.rev_id
354
start_revno = start_revision.revno or 1
356
branch.check_real_revno(start_revision)
357
start_revno = start_revision
360
if end_revision is None:
361
end_revno = len(which_revs)
363
if isinstance(end_revision,RevisionInfo):
364
end_rev_id = end_revision.rev_id
365
end_revno = end_revision.revno or len(which_revs)
367
branch.check_real_revno(end_revision)
368
end_revno = end_revision
370
if ((start_rev_id == NULL_REVISION)
371
or (end_rev_id == NULL_REVISION)):
372
raise BzrCommandError('Logging revision 0 is invalid.')
373
if start_revno > end_revno:
374
raise BzrCommandError("Start revision must be older than "
377
# list indexes are 0-based; revisions are 1-based
378
cut_revs = which_revs[(start_revno-1):(end_revno)]
380
return None, None, None, None
382
# convert the revision history to a dictionary:
383
rev_nos = dict((k, v) for v, k in cut_revs)
385
# override the mainline to look like the revision history.
386
mainline_revs = [revision_id for index, revision_id in cut_revs]
387
if cut_revs[0][0] == 1:
388
mainline_revs.insert(0, None)
390
mainline_revs.insert(0, which_revs[start_revno-2][1])
391
return mainline_revs, rev_nos, start_rev_id, end_rev_id
394
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
395
"""Filter view_revisions based on revision ranges.
397
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
398
tuples to be filtered.
400
:param start_rev_id: If not NONE specifies the first revision to be logged.
401
If NONE then all revisions up to the end_rev_id are logged.
403
:param end_rev_id: If not NONE specifies the last revision to be logged.
404
If NONE then all revisions up to the end of the log are logged.
406
:return: The filtered view_revisions.
408
if start_rev_id or end_rev_id:
409
revision_ids = [r for r, n, d in view_revisions]
411
start_index = revision_ids.index(start_rev_id)
414
if start_rev_id == end_rev_id:
415
end_index = start_index
418
end_index = revision_ids.index(end_rev_id)
420
end_index = len(view_revisions) - 1
421
# To include the revisions merged into the last revision,
422
# extend end_rev_id down to, but not including, the next rev
423
# with the same or lesser merge_depth
424
end_merge_depth = view_revisions[end_index][2]
426
for index in xrange(end_index+1, len(view_revisions)+1):
427
if view_revisions[index][2] <= end_merge_depth:
428
end_index = index - 1
431
# if the search falls off the end then log to the end as well
432
end_index = len(view_revisions) - 1
433
view_revisions = view_revisions[start_index:end_index+1]
434
return view_revisions
437
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
439
"""Return the list of revision ids which touch a given file id.
441
The function filters view_revisions and returns a subset.
442
This includes the revisions which directly change the file id,
443
and the revisions which merge these changes. So if the
451
And 'C' changes a file, then both C and D will be returned.
453
This will also can be restricted based on a subset of the mainline.
455
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
457
# find all the revisions that change the specific file
458
file_weave = branch.repository.weave_store.get_weave(file_id,
459
branch.repository.get_transaction())
460
weave_modifed_revisions = set(file_weave.versions())
461
# build the ancestry of each revision in the graph
462
# - only listing the ancestors that change the specific file.
463
graph = branch.repository.get_graph()
464
# This asks for all mainline revisions, which means we only have to spider
465
# sideways, rather than depth history. That said, its still size-of-history
466
# and should be addressed.
467
# mainline_revisions always includes an extra revision at the beginning, so
469
parent_map = dict(((key, value) for key, value in
470
graph.iter_ancestry(mainline_revisions[1:]) if value is not None))
471
sorted_rev_list = topo_sort(parent_map.items())
473
for rev in sorted_rev_list:
474
parents = parent_map[rev]
475
if rev not in weave_modifed_revisions and len(parents) == 1:
476
# We will not be adding anything new, so just use a reference to
477
# the parent ancestry.
478
rev_ancestry = ancestry[parents[0]]
481
if rev in weave_modifed_revisions:
482
rev_ancestry.add(rev)
483
for parent in parents:
484
if parent not in ancestry:
485
# parent is a Ghost, which won't be present in
486
# sorted_rev_list, but we may access it later, so create an
488
ancestry[parent] = set()
489
rev_ancestry = rev_ancestry.union(ancestry[parent])
490
ancestry[rev] = rev_ancestry
492
def is_merging_rev(r):
493
parents = parent_map[r]
495
leftparent = parents[0]
496
for rightparent in parents[1:]:
497
if not ancestry[leftparent].issuperset(
498
ancestry[rightparent]):
502
# filter from the view the revisions that did not change or merge
504
return [(r, n, d) for r, n, d in view_revs_iter
505
if r in weave_modifed_revisions or is_merging_rev(r)]
508
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
509
include_merges=True):
510
"""Produce an iterator of revisions to show
511
:return: an iterator of (revision_id, revno, merge_depth)
512
(if there is no revno for a revision, None is supplied)
514
if include_merges is False:
515
revision_ids = mainline_revs[1:]
516
if direction == 'reverse':
517
revision_ids.reverse()
518
for revision_id in revision_ids:
519
yield revision_id, str(rev_nos[revision_id]), 0
521
graph = branch.repository.get_graph()
522
# This asks for all mainline revisions, which means we only have to spider
523
# sideways, rather than depth history. That said, its still size-of-history
524
# and should be addressed.
525
parent_map = dict(((key, value) for key, value in
526
graph.iter_ancestry(mainline_revs) if value is not None))
527
# filter out ghosts; merge_sort errors on ghosts.
528
rev_graph = _strip_NULL_ghosts(parent_map)
529
merge_sorted_revisions = merge_sort(
535
if direction == 'forward':
536
# forward means oldest first.
537
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
538
elif direction != 'reverse':
539
raise ValueError('invalid direction %r' % direction)
541
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
542
yield rev_id, '.'.join(map(str, revno)), merge_depth
545
def reverse_by_depth(merge_sorted_revisions, _depth=0):
546
"""Reverse revisions by depth.
548
Revisions with a different depth are sorted as a group with the previous
549
revision of that depth. There may be no topological justification for this,
550
but it looks much nicer.
553
for val in merge_sorted_revisions:
555
zd_revisions.append([val])
557
zd_revisions[-1].append(val)
558
for revisions in zd_revisions:
559
if len(revisions) > 1:
560
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
561
zd_revisions.reverse()
563
for chunk in zd_revisions:
568
class LogRevision(object):
569
"""A revision to be logged (by LogFormatter.log_revision).
571
A simple wrapper for the attributes of a revision to be logged.
572
The attributes may or may not be populated, as determined by the
573
logging options and the log formatter capabilities.
576
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
580
self.merge_depth = merge_depth
585
class LogFormatter(object):
586
"""Abstract class to display log messages.
588
At a minimum, a derived class must implement the log_revision method.
590
If the LogFormatter needs to be informed of the beginning or end of
591
a log it should implement the begin_log and/or end_log hook methods.
593
A LogFormatter should define the following supports_XXX flags
594
to indicate which LogRevision attributes it supports:
596
- supports_delta must be True if this log formatter supports delta.
597
Otherwise the delta attribute may not be populated.
598
- supports_merge_revisions must be True if this log formatter supports
599
merge revisions. If not, and if supports_single_merge_revisions is
600
also not True, then only mainline revisions will be passed to the
602
- supports_single_merge_revision must be True if this log formatter
603
supports logging only a single merge revision. This flag is
604
only relevant if supports_merge_revisions is not True.
605
- supports_tags must be True if this log formatter supports tags.
606
Otherwise the tags attribute may not be populated.
609
def __init__(self, to_file, show_ids=False, show_timezone='original'):
610
self.to_file = to_file
611
self.show_ids = show_ids
612
self.show_timezone = show_timezone
614
# TODO: uncomment this block after show() has been removed.
615
# Until then defining log_revision would prevent _show_log calling show()
616
# in legacy formatters.
617
# def log_revision(self, revision):
620
# :param revision: The LogRevision to be logged.
622
# raise NotImplementedError('not implemented in abstract base')
624
def short_committer(self, rev):
625
name, address = config.parse_username(rev.committer)
630
def short_author(self, rev):
631
name, address = config.parse_username(rev.get_apparent_author())
637
class LongLogFormatter(LogFormatter):
639
supports_merge_revisions = True
640
supports_delta = True
643
def log_revision(self, revision):
644
"""Log a revision, either merged or not."""
645
indent = ' ' * revision.merge_depth
646
to_file = self.to_file
647
to_file.write(indent + '-' * 60 + '\n')
648
if revision.revno is not None:
649
to_file.write(indent + 'revno: %s\n' % (revision.revno,))
651
to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
653
to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
655
for parent_id in revision.rev.parent_ids:
656
to_file.write(indent + 'parent: %s\n' % (parent_id,))
658
author = revision.rev.properties.get('author', None)
659
if author is not None:
660
to_file.write(indent + 'author: %s\n' % (author,))
661
to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
663
branch_nick = revision.rev.properties.get('branch-nick', None)
664
if branch_nick is not None:
665
to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
667
date_str = format_date(revision.rev.timestamp,
668
revision.rev.timezone or 0,
670
to_file.write(indent + 'timestamp: %s\n' % (date_str,))
672
to_file.write(indent + 'message:\n')
673
if not revision.rev.message:
674
to_file.write(indent + ' (no message)\n')
676
message = revision.rev.message.rstrip('\r\n')
677
for l in message.split('\n'):
678
to_file.write(indent + ' %s\n' % (l,))
679
if revision.delta is not None:
680
revision.delta.show(to_file, self.show_ids, indent=indent)
683
class ShortLogFormatter(LogFormatter):
685
supports_delta = True
686
supports_single_merge_revision = True
688
def log_revision(self, revision):
689
to_file = self.to_file
690
date_str = format_date(revision.rev.timestamp,
691
revision.rev.timezone or 0,
694
if len(revision.rev.parent_ids) > 1:
695
is_merge = ' [merge]'
696
to_file.write("%5s %s\t%s%s\n" % (revision.revno,
697
self.short_author(revision.rev),
698
format_date(revision.rev.timestamp,
699
revision.rev.timezone or 0,
700
self.show_timezone, date_fmt="%Y-%m-%d",
704
to_file.write(' revision-id:%s\n' % (revision.rev.revision_id,))
705
if not revision.rev.message:
706
to_file.write(' (no message)\n')
708
message = revision.rev.message.rstrip('\r\n')
709
for l in message.split('\n'):
710
to_file.write(' %s\n' % (l,))
712
# TODO: Why not show the modified files in a shorter form as
713
# well? rewrap them single lines of appropriate length
714
if revision.delta is not None:
715
revision.delta.show(to_file, self.show_ids)
719
class LineLogFormatter(LogFormatter):
721
supports_single_merge_revision = True
723
def __init__(self, *args, **kwargs):
724
super(LineLogFormatter, self).__init__(*args, **kwargs)
725
self._max_chars = terminal_width() - 1
727
def truncate(self, str, max_len):
728
if len(str) <= max_len:
730
return str[:max_len-3]+'...'
732
def date_string(self, rev):
733
return format_date(rev.timestamp, rev.timezone or 0,
734
self.show_timezone, date_fmt="%Y-%m-%d",
737
def message(self, rev):
739
return '(no message)'
743
def log_revision(self, revision):
744
self.to_file.write(self.log_string(revision.revno, revision.rev,
746
self.to_file.write('\n')
748
def log_string(self, revno, rev, max_chars):
749
"""Format log info into one string. Truncate tail of string
750
:param revno: revision number (int) or None.
751
Revision numbers counts from 1.
752
:param rev: revision info object
753
:param max_chars: maximum length of resulting string
754
:return: formatted truncated string
758
# show revno only when is not None
759
out.append("%s:" % revno)
760
out.append(self.truncate(self.short_author(rev), 20))
761
out.append(self.date_string(rev))
762
out.append(rev.get_summary())
763
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
766
def line_log(rev, max_chars):
767
lf = LineLogFormatter(None)
768
return lf.log_string(None, rev, max_chars)
771
class LogFormatterRegistry(registry.Registry):
772
"""Registry for log formatters"""
774
def make_formatter(self, name, *args, **kwargs):
775
"""Construct a formatter from arguments.
777
:param name: Name of the formatter to construct. 'short', 'long' and
780
return self.get(name)(*args, **kwargs)
782
def get_default(self, branch):
783
return self.get(branch.get_config().log_format())
786
log_formatter_registry = LogFormatterRegistry()
789
log_formatter_registry.register('short', ShortLogFormatter,
790
'Moderately short log format')
791
log_formatter_registry.register('long', LongLogFormatter,
792
'Detailed log format')
793
log_formatter_registry.register('line', LineLogFormatter,
794
'Log format with one line per revision')
797
def register_formatter(name, formatter):
798
log_formatter_registry.register(name, formatter)
801
def log_formatter(name, *args, **kwargs):
802
"""Construct a formatter from arguments.
804
name -- Name of the formatter to construct; currently 'long', 'short' and
805
'line' are supported.
808
return log_formatter_registry.make_formatter(name, *args, **kwargs)
810
raise BzrCommandError("unknown log formatter: %r" % name)
813
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
814
# deprecated; for compatibility
815
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
816
lf.show(revno, rev, delta)
819
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
821
"""Show the change in revision history comparing the old revision history to the new one.
823
:param branch: The branch where the revisions exist
824
:param old_rh: The old revision history
825
:param new_rh: The new revision history
826
:param to_file: A file to write the results to. If None, stdout will be used
829
to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
831
lf = log_formatter(log_format,
834
show_timezone='original')
836
# This is the first index which is different between
839
for i in xrange(max(len(new_rh),
843
or new_rh[i] != old_rh[i]):
848
to_file.write('Nothing seems to have changed\n')
850
## TODO: It might be nice to do something like show_log
851
## and show the merged entries. But since this is the
852
## removed revisions, it shouldn't be as important
853
if base_idx < len(old_rh):
854
to_file.write('*'*60)
855
to_file.write('\nRemoved Revisions:\n')
856
for i in range(base_idx, len(old_rh)):
857
rev = branch.repository.get_revision(old_rh[i])
858
lr = LogRevision(rev, i+1, 0, None)
860
to_file.write('*'*60)
861
to_file.write('\n\n')
862
if base_idx < len(new_rh):
863
to_file.write('Added Revisions:\n')
869
start_revision=base_idx+1,
870
end_revision=len(new_rh),
added
removed
bzrlib/log.py
