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 mainline parent, not the delta relative to the last
46
logged revision. So for example if you ask for a verbose log of
47
changes touching hello.c you will get a list of those revisions also
48
listing other things that were changed in the same revision, but not
49
all the changes since the previous revision that touched hello.c.
52
# TODO: option to show delta summaries for merged-in revisions
54
from itertools import izip
61
import bzrlib.errors as errors
62
from bzrlib.symbol_versioning import(
67
from bzrlib.trace import mutter
68
from bzrlib.tsort import(
74
def find_touching_revisions(branch, file_id):
75
"""Yield a description of revisions which affect the file_id.
77
Each returned element is (revno, revision_id, description)
79
This is the list of revisions where the file is either added,
80
modified, renamed or deleted.
82
TODO: Perhaps some way to limit this to only particular revisions,
83
or to traverse a non-mainline set of revisions?
88
for revision_id in branch.revision_history():
89
this_inv = branch.repository.get_revision_inventory(revision_id)
90
if file_id in this_inv:
91
this_ie = this_inv[file_id]
92
this_path = this_inv.id2path(file_id)
94
this_ie = this_path = None
96
# now we know how it was last time, and how it is in this revision.
97
# are those two states effectively the same or not?
99
if not this_ie and not last_ie:
100
# not present in either
102
elif this_ie and not last_ie:
103
yield revno, revision_id, "added " + this_path
104
elif not this_ie and last_ie:
106
yield revno, revision_id, "deleted " + last_path
107
elif this_path != last_path:
108
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
109
elif (this_ie.text_size != last_ie.text_size
110
or this_ie.text_sha1 != last_ie.text_sha1):
111
yield revno, revision_id, "modified " + this_path
114
last_path = this_path
119
def _enumerate_history(branch):
122
for rev_id in branch.revision_history():
123
rh.append((revno, rev_id))
130
specific_fileid=None,
136
"""Write out human-readable log of commits to this branch.
139
LogFormatter object to show the output.
142
If true, list only the commits affecting the specified
143
file, rather than all commits.
146
If true show added/changed/deleted/renamed files.
149
'reverse' (default) is latest to earliest;
150
'forward' is earliest to latest.
153
If not None, only show revisions >= start_revision
156
If not None, only show revisions <= end_revision
160
_show_log(branch, lf, specific_fileid, verbose, direction,
161
start_revision, end_revision, search)
165
def _show_log(branch,
167
specific_fileid=None,
173
"""Worker function for show_log - see show_log."""
174
from bzrlib.osutils import format_date
175
from bzrlib.errors import BzrCheckError
177
from warnings import warn
179
if not isinstance(lf, LogFormatter):
180
warn("not a LogFormatter instance: %r" % lf)
183
mutter('get log for file_id %r', specific_fileid)
185
if search is not None:
187
searchRE = re.compile(search, re.IGNORECASE)
191
which_revs = _enumerate_history(branch)
193
if start_revision is None:
196
branch.check_real_revno(start_revision)
198
if end_revision is None:
199
end_revision = len(which_revs)
201
branch.check_real_revno(end_revision)
203
# list indexes are 0-based; revisions are 1-based
204
cut_revs = which_revs[(start_revision-1):(end_revision)]
208
# convert the revision history to a dictionary:
209
rev_nos = dict((k, v) for v, k in cut_revs)
211
# override the mainline to look like the revision history.
212
mainline_revs = [revision_id for index, revision_id in cut_revs]
213
if cut_revs[0][0] == 1:
214
mainline_revs.insert(0, None)
216
mainline_revs.insert(0, which_revs[start_revision-2][1])
217
legacy_lf = not getattr(lf,'log_revision',None)
219
# pre-0.17 formatters use show for mainline revisions.
220
# how should we show merged revisions ?
221
# pre-0.11 api: show_merge
222
# 0.11-0.16 api: show_merge_revno
223
show_merge_revno = getattr(lf, 'show_merge_revno', None)
224
show_merge = getattr(lf, 'show_merge', None)
225
if show_merge is None and show_merge_revno is None:
226
# no merged-revno support
227
generate_merge_revisions = False
229
generate_merge_revisions = True
230
# tell developers to update their code
231
symbol_versioning.warn('LogFormatters should provide log_revision '
232
'instead of show and show_merge_revno since bzr 0.17.',
233
DeprecationWarning, stacklevel=3)
235
generate_merge_revisions = getattr(lf, 'supports_merge_revisions',
237
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
238
direction, include_merges=generate_merge_revisions)
240
view_revisions = _get_revisions_touching_file_id(branch,
245
view_revisions = list(view_revs_iter)
248
generate_tags = getattr(lf, 'supports_tags', False)
250
if branch.supports_tags():
251
rev_tag_dict = branch.tags.get_reverse_tag_dict()
253
generate_delta = verbose and getattr(lf, 'supports_delta', False)
255
def iter_revisions():
256
# r = revision, n = revno, d = merge depth
257
revision_ids = [r for r, n, d in view_revisions]
258
zeros = set(r for r, n, d in view_revisions if d == 0)
260
repository = branch.repository
263
revisions = repository.get_revisions(revision_ids[:num])
265
delta_revisions = [r for r in revisions if
266
r.revision_id in zeros]
267
deltas = repository.get_deltas_for_revisions(delta_revisions)
268
cur_deltas = dict(izip((r.revision_id for r in
269
delta_revisions), deltas))
270
for revision in revisions:
271
# The delta value will be None unless
272
# 1. verbose is specified, and
273
# 2. the revision is a mainline revision
274
yield revision, cur_deltas.get(revision.revision_id)
275
revision_ids = revision_ids[num:]
276
num = min(int(num * 1.5), 200)
278
if getattr(lf, 'begin_log', None):
281
# now we just print all the revisions
282
for ((rev_id, revno, merge_depth), (rev, delta)) in \
283
izip(view_revisions, iter_revisions()):
286
if not searchRE.search(rev.message):
290
lr = LogRevision(rev,revno,merge_depth,delta,rev_tag_dict.get(rev_id))
293
# support for legacy (pre-0.17) LogFormatters
296
lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
298
lf.show(revno, rev, delta)
300
if show_merge_revno is None:
301
lf.show_merge(rev, merge_depth)
304
lf.show_merge_revno(rev, merge_depth, revno,
305
rev_tag_dict.get(rev_id))
307
lf.show_merge_revno(rev, merge_depth, revno)
309
if getattr(lf, 'end_log', None):
313
def _get_revisions_touching_file_id(branch, file_id, mainline_revisions,
315
"""Return the list of revision ids which touch a given file id.
317
This includes the revisions which directly change the file id,
318
and the revisions which merge these changes. So if the
326
And 'C' changes a file, then both C and D will be returned.
328
This will also can be restricted based on a subset of the mainline.
330
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
332
# find all the revisions that change the specific file
333
file_weave = branch.repository.weave_store.get_weave(file_id,
334
branch.repository.get_transaction())
335
weave_modifed_revisions = set(file_weave.versions())
336
# build the ancestry of each revision in the graph
337
# - only listing the ancestors that change the specific file.
338
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
339
sorted_rev_list = topo_sort(rev_graph)
341
for rev in sorted_rev_list:
342
parents = rev_graph[rev]
343
if rev not in weave_modifed_revisions and len(parents) == 1:
344
# We will not be adding anything new, so just use a reference to
345
# the parent ancestry.
346
rev_ancestry = ancestry[parents[0]]
349
if rev in weave_modifed_revisions:
350
rev_ancestry.add(rev)
351
for parent in parents:
352
rev_ancestry = rev_ancestry.union(ancestry[parent])
353
ancestry[rev] = rev_ancestry
355
def is_merging_rev(r):
356
parents = rev_graph[r]
358
leftparent = parents[0]
359
for rightparent in parents[1:]:
360
if not ancestry[leftparent].issuperset(
361
ancestry[rightparent]):
365
# filter from the view the revisions that did not change or merge
367
return [(r, n, d) for r, n, d in view_revs_iter
368
if r in weave_modifed_revisions or is_merging_rev(r)]
371
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
372
include_merges=True):
373
"""Produce an iterator of revisions to show
374
:return: an iterator of (revision_id, revno, merge_depth)
375
(if there is no revno for a revision, None is supplied)
377
if include_merges is False:
378
revision_ids = mainline_revs[1:]
379
if direction == 'reverse':
380
revision_ids.reverse()
381
for revision_id in revision_ids:
382
yield revision_id, str(rev_nos[revision_id]), 0
384
merge_sorted_revisions = merge_sort(
385
branch.repository.get_revision_graph(mainline_revs[-1]),
390
if direction == 'forward':
391
# forward means oldest first.
392
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
393
elif direction != 'reverse':
394
raise ValueError('invalid direction %r' % direction)
396
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
397
yield rev_id, '.'.join(map(str, revno)), merge_depth
400
def reverse_by_depth(merge_sorted_revisions, _depth=0):
401
"""Reverse revisions by depth.
403
Revisions with a different depth are sorted as a group with the previous
404
revision of that depth. There may be no topological justification for this,
405
but it looks much nicer.
408
for val in merge_sorted_revisions:
410
zd_revisions.append([val])
412
assert val[2] > _depth
413
zd_revisions[-1].append(val)
414
for revisions in zd_revisions:
415
if len(revisions) > 1:
416
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
417
zd_revisions.reverse()
419
for chunk in zd_revisions:
424
class LogRevision(object):
425
"""A revision to be logged (by LogFormatter.log_revision).
427
A simple wrapper for the attributes of a revision to be logged.
428
The attributes may or may not be populated, as determined by the
429
logging options and the log formatter capabilities.
432
def __init__(self,rev=None,revno=None,merge_depth=0,delta=None,tags=None):
435
self.merge_depth = merge_depth
440
class LogFormatter(object):
441
"""Abstract class to display log messages.
443
At a minimum, a derived class must implement the log_revision method.
445
If the LogFormatter needs to be informed of the beginning or end of
446
a log it should implement the begin_log and/or end_log hook methods.
448
A LogFormatter should define the following supports_XXX flags
449
to indicate which LogRevision attributes it supports:
451
- supports_delta must be True if this log formatter supports delta.
452
Otherwise the delta attribute may not be populated.
453
- supports_merge_revisions must be True if this log formatter supports
454
merge revisions. If not, only revisions mainline revisions (those
455
with merge_depth == 0) will be passed to the formatter.
456
- supports_tags must be True if this log formatter supports tags.
457
Otherwise the tags attribute may not be populated.
460
def __init__(self, to_file, show_ids=False, show_timezone='original'):
461
self.to_file = to_file
462
self.show_ids = show_ids
463
self.show_timezone = show_timezone
465
# TODO: uncomment this block after show() has been removed.
466
# Until then defining log_revision would prevent _show_log calling show()
467
# in legacy formatters.
468
# def log_revision(self, revision):
471
# :param revision: The LogRevision to be logged.
473
# raise NotImplementedError('not implemented in abstract base')
475
@deprecated_method(zero_seventeen)
476
def show(self, revno, rev, delta):
477
raise NotImplementedError('not implemented in abstract base')
479
def short_committer(self, rev):
480
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
483
class LongLogFormatter(LogFormatter):
485
supports_merge_revisions = True
486
supports_delta = True
489
@deprecated_method(zero_seventeen)
490
def show(self, revno, rev, delta, tags=None):
491
lr = LogRevision(rev,revno,0,delta,tags)
492
return self.log_revision(lr)
494
@deprecated_method(zero_eleven)
495
def show_merge(self, rev, merge_depth):
496
lr = LogRevision(rev,merge_depth=merge_depth)
497
return self.log_revision(lr)
499
@deprecated_method(zero_seventeen)
500
def show_merge_revno(self, rev, merge_depth, revno, tags=None):
501
"""Show a merged revision rev, with merge_depth and a revno."""
502
lr = LogRevision(rev,revno,merge_depth,tags=tags)
503
return self.log_revision(lr)
505
def log_revision(self, revision):
506
"""Log a revision, either merged or not."""
507
from bzrlib.osutils import format_date
508
indent = ' '*revision.merge_depth
509
to_file = self.to_file
510
print >>to_file, indent+'-' * 60
511
if revision.revno is not None:
512
print >>to_file, indent+'revno:', revision.revno
514
print >>to_file, indent+'tags: %s' % (', '.join(revision.tags))
516
print >>to_file, indent+'revision-id:', revision.rev.revision_id
517
for parent_id in revision.rev.parent_ids:
518
print >>to_file, indent+'parent:', parent_id
519
print >>to_file, indent+'committer:', revision.rev.committer
522
print >>to_file, indent+'branch nick: %s' % \
523
revision.rev.properties['branch-nick']
526
date_str = format_date(revision.rev.timestamp,
527
revision.rev.timezone or 0,
529
print >>to_file, indent+'timestamp: %s' % date_str
531
print >>to_file, indent+'message:'
532
if not revision.rev.message:
533
print >>to_file, indent+' (no message)'
535
message = revision.rev.message.rstrip('\r\n')
536
for l in message.split('\n'):
537
print >>to_file, indent+' ' + l
538
if revision.delta is not None:
539
revision.delta.show(to_file, self.show_ids)
542
class ShortLogFormatter(LogFormatter):
544
supports_delta = True
546
@deprecated_method(zero_seventeen)
547
def show(self, revno, rev, delta):
548
lr = LogRevision(rev,revno,0,delta)
549
return self.log_revision(lr)
551
def log_revision(self, revision):
552
from bzrlib.osutils import format_date
554
to_file = self.to_file
555
date_str = format_date(revision.rev.timestamp,
556
revision.rev.timezone or 0,
558
print >>to_file, "%5s %s\t%s" % (revision.revno,
559
self.short_committer(revision.rev),
560
format_date(revision.rev.timestamp,
561
revision.rev.timezone or 0,
562
self.show_timezone, date_fmt="%Y-%m-%d",
565
print >>to_file, ' revision-id:', revision.rev.revision_id
566
if not revision.rev.message:
567
print >>to_file, ' (no message)'
569
message = revision.rev.message.rstrip('\r\n')
570
for l in message.split('\n'):
571
print >>to_file, ' ' + l
573
# TODO: Why not show the modified files in a shorter form as
574
# well? rewrap them single lines of appropriate length
575
if revision.delta is not None:
576
revision.delta.show(to_file, self.show_ids)
580
class LineLogFormatter(LogFormatter):
582
def __init__(self, *args, **kwargs):
583
from bzrlib.osutils import terminal_width
584
super(LineLogFormatter, self).__init__(*args, **kwargs)
585
self._max_chars = terminal_width() - 1
587
def truncate(self, str, max_len):
588
if len(str) <= max_len:
590
return str[:max_len-3]+'...'
592
def date_string(self, rev):
593
from bzrlib.osutils import format_date
594
return format_date(rev.timestamp, rev.timezone or 0,
595
self.show_timezone, date_fmt="%Y-%m-%d",
598
def message(self, rev):
600
return '(no message)'
604
@deprecated_method(zero_seventeen)
605
def show(self, revno, rev, delta):
606
from bzrlib.osutils import terminal_width
607
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
609
def log_revision(self, revision):
610
print >> self.to_file, self.log_string(revision.revno, revision.rev,
613
def log_string(self, revno, rev, max_chars):
614
"""Format log info into one string. Truncate tail of string
615
:param revno: revision number (int) or None.
616
Revision numbers counts from 1.
617
:param rev: revision info object
618
:param max_chars: maximum length of resulting string
619
:return: formatted truncated string
623
# show revno only when is not None
624
out.append("%s:" % revno)
625
out.append(self.truncate(self.short_committer(rev), 20))
626
out.append(self.date_string(rev))
627
out.append(rev.get_summary())
628
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
631
def line_log(rev, max_chars):
632
lf = LineLogFormatter(None)
633
return lf.log_string(None, rev, max_chars)
636
class LogFormatterRegistry(registry.Registry):
637
"""Registry for log formatters"""
639
def make_formatter(self, name, *args, **kwargs):
640
"""Construct a formatter from arguments.
642
:param name: Name of the formatter to construct. 'short', 'long' and
645
return self.get(name)(*args, **kwargs)
647
def get_default(self, branch):
648
return self.get(branch.get_config().log_format())
651
log_formatter_registry = LogFormatterRegistry()
654
log_formatter_registry.register('short', ShortLogFormatter,
655
'Moderately short log format')
656
log_formatter_registry.register('long', LongLogFormatter,
657
'Detailed log format')
658
log_formatter_registry.register('line', LineLogFormatter,
659
'Log format with one line per revision')
662
def register_formatter(name, formatter):
663
log_formatter_registry.register(name, formatter)
666
def log_formatter(name, *args, **kwargs):
667
"""Construct a formatter from arguments.
669
name -- Name of the formatter to construct; currently 'long', 'short' and
670
'line' are supported.
672
from bzrlib.errors import BzrCommandError
674
return log_formatter_registry.make_formatter(name, *args, **kwargs)
676
raise BzrCommandError("unknown log formatter: %r" % name)
679
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
680
# deprecated; for compatibility
681
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
682
lf.show(revno, rev, delta)
684
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
685
"""Show the change in revision history comparing the old revision history to the new one.
687
:param branch: The branch where the revisions exist
688
:param old_rh: The old revision history
689
:param new_rh: The new revision history
690
:param to_file: A file to write the results to. If None, stdout will be used
696
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
697
lf = log_formatter(log_format,
700
show_timezone='original')
702
# This is the first index which is different between
705
for i in xrange(max(len(new_rh),
709
or new_rh[i] != old_rh[i]):
714
to_file.write('Nothing seems to have changed\n')
716
## TODO: It might be nice to do something like show_log
717
## and show the merged entries. But since this is the
718
## removed revisions, it shouldn't be as important
719
if base_idx < len(old_rh):
720
to_file.write('*'*60)
721
to_file.write('\nRemoved Revisions:\n')
722
for i in range(base_idx, len(old_rh)):
723
rev = branch.repository.get_revision(old_rh[i])
724
lf.show(i+1, rev, None)
725
to_file.write('*'*60)
726
to_file.write('\n\n')
727
if base_idx < len(new_rh):
728
to_file.write('Added Revisions:\n')
734
start_revision=base_idx+1,
735
end_revision=len(new_rh),
added
removed
bzrlib/log.py
