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]
259
repository = branch.repository
262
revisions = repository.get_revisions(revision_ids[:num])
264
deltas = repository.get_deltas_for_revisions(revisions)
265
cur_deltas = dict(izip((r.revision_id for r in revisions),
267
for revision in revisions:
268
yield revision, cur_deltas.get(revision.revision_id)
269
revision_ids = revision_ids[num:]
270
num = min(int(num * 1.5), 200)
272
if getattr(lf, 'begin_log', None):
275
# now we just print all the revisions
276
for ((rev_id, revno, merge_depth), (rev, delta)) in \
277
izip(view_revisions, iter_revisions()):
280
if not searchRE.search(rev.message):
284
lr = LogRevision(rev,revno,merge_depth,delta,rev_tag_dict.get(rev_id))
287
# support for legacy (pre-0.17) LogFormatters
290
lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
292
lf.show(revno, rev, delta)
294
if show_merge_revno is None:
295
lf.show_merge(rev, merge_depth)
298
lf.show_merge_revno(rev, merge_depth, revno,
299
rev_tag_dict.get(rev_id))
301
lf.show_merge_revno(rev, merge_depth, revno)
303
if getattr(lf, 'end_log', None):
307
def _get_revisions_touching_file_id(branch, file_id, mainline_revisions,
309
"""Return the list of revision ids which touch a given file id.
311
This includes the revisions which directly change the file id,
312
and the revisions which merge these changes. So if the
320
And 'C' changes a file, then both C and D will be returned.
322
This will also can be restricted based on a subset of the mainline.
324
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
326
# find all the revisions that change the specific file
327
file_weave = branch.repository.weave_store.get_weave(file_id,
328
branch.repository.get_transaction())
329
weave_modifed_revisions = set(file_weave.versions())
330
# build the ancestry of each revision in the graph
331
# - only listing the ancestors that change the specific file.
332
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
333
sorted_rev_list = topo_sort(rev_graph)
335
for rev in sorted_rev_list:
336
parents = rev_graph[rev]
337
if rev not in weave_modifed_revisions and len(parents) == 1:
338
# We will not be adding anything new, so just use a reference to
339
# the parent ancestry.
340
rev_ancestry = ancestry[parents[0]]
343
if rev in weave_modifed_revisions:
344
rev_ancestry.add(rev)
345
for parent in parents:
346
rev_ancestry = rev_ancestry.union(ancestry[parent])
347
ancestry[rev] = rev_ancestry
349
def is_merging_rev(r):
350
parents = rev_graph[r]
352
leftparent = parents[0]
353
for rightparent in parents[1:]:
354
if not ancestry[leftparent].issuperset(
355
ancestry[rightparent]):
359
# filter from the view the revisions that did not change or merge
361
return [(r, n, d) for r, n, d in view_revs_iter
362
if r in weave_modifed_revisions or is_merging_rev(r)]
365
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
366
include_merges=True):
367
"""Produce an iterator of revisions to show
368
:return: an iterator of (revision_id, revno, merge_depth)
369
(if there is no revno for a revision, None is supplied)
371
if include_merges is False:
372
revision_ids = mainline_revs[1:]
373
if direction == 'reverse':
374
revision_ids.reverse()
375
for revision_id in revision_ids:
376
yield revision_id, str(rev_nos[revision_id]), 0
378
merge_sorted_revisions = merge_sort(
379
branch.repository.get_revision_graph(mainline_revs[-1]),
384
if direction == 'forward':
385
# forward means oldest first.
386
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
387
elif direction != 'reverse':
388
raise ValueError('invalid direction %r' % direction)
390
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
391
yield rev_id, '.'.join(map(str, revno)), merge_depth
394
def reverse_by_depth(merge_sorted_revisions, _depth=0):
395
"""Reverse revisions by depth.
397
Revisions with a different depth are sorted as a group with the previous
398
revision of that depth. There may be no topological justification for this,
399
but it looks much nicer.
402
for val in merge_sorted_revisions:
404
zd_revisions.append([val])
406
assert val[2] > _depth
407
zd_revisions[-1].append(val)
408
for revisions in zd_revisions:
409
if len(revisions) > 1:
410
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
411
zd_revisions.reverse()
413
for chunk in zd_revisions:
418
class LogRevision(object):
419
"""A revision to be logged (by LogFormatter.log_revision).
421
A simple wrapper for the attributes of a revision to be logged.
422
The attributes may or may not be populated, as determined by the
423
logging options and the log formatter capabilities.
426
def __init__(self,rev=None,revno=None,merge_depth=0,delta=None,tags=None):
429
self.merge_depth = merge_depth
434
class LogFormatter(object):
435
"""Abstract class to display log messages.
437
At a minimum, a derived class must implement the log_revision method.
439
If the LogFormatter needs to be informed of the beginning or end of
440
a log it should implement the begin_log and/or end_log hook methods.
442
A LogFormatter should define the following supports_XXX flags
443
to indicate which LogRevision attributes it supports:
445
- supports_delta must be True if this log formatter supports delta.
446
Otherwise the delta attribute may not be populated.
447
- supports_merge_revisions must be True if this log formatter supports
448
merge revisions. If not, only revisions mainline revisions (those
449
with merge_depth == 0) will be passed to the formatter.
450
- supports_tags must be True if this log formatter supports tags.
451
Otherwise the tags attribute may not be populated.
454
def __init__(self, to_file, show_ids=False, show_timezone='original'):
455
self.to_file = to_file
456
self.show_ids = show_ids
457
self.show_timezone = show_timezone
459
# TODO: uncomment this block after show() has been removed.
460
# Until then defining log_revision would prevent _show_log calling show()
461
# in legacy formatters.
462
# def log_revision(self, revision):
465
# :param revision: The LogRevision to be logged.
467
# raise NotImplementedError('not implemented in abstract base')
469
@deprecated_method(zero_seventeen)
470
def show(self, revno, rev, delta):
471
raise NotImplementedError('not implemented in abstract base')
473
def short_committer(self, rev):
474
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
477
class LongLogFormatter(LogFormatter):
479
supports_merge_revisions = True
480
supports_delta = True
483
@deprecated_method(zero_seventeen)
484
def show(self, revno, rev, delta, tags=None):
485
lr = LogRevision(rev,revno,0,delta,tags)
486
return self.log_revision(lr)
488
@deprecated_method(zero_eleven)
489
def show_merge(self, rev, merge_depth):
490
lr = LogRevision(rev,merge_depth=merge_depth)
491
return self.log_revision(lr)
493
@deprecated_method(zero_seventeen)
494
def show_merge_revno(self, rev, merge_depth, revno, tags=None):
495
"""Show a merged revision rev, with merge_depth and a revno."""
496
lr = LogRevision(rev,revno,merge_depth,tags=tags)
497
return self.log_revision(lr)
499
def log_revision(self, revision):
500
"""Log a revision, either merged or not."""
501
from bzrlib.osutils import format_date
502
indent = ' '*revision.merge_depth
503
to_file = self.to_file
504
print >>to_file, indent+'-' * 60
505
if revision.revno is not None:
506
print >>to_file, indent+'revno:', revision.revno
508
print >>to_file, indent+'tags: %s' % (', '.join(revision.tags))
510
print >>to_file, indent+'revision-id:', revision.rev.revision_id
511
for parent_id in revision.rev.parent_ids:
512
print >>to_file, indent+'parent:', parent_id
513
print >>to_file, indent+'committer:', revision.rev.committer
516
print >>to_file, indent+'branch nick: %s' % \
517
revision.rev.properties['branch-nick']
520
date_str = format_date(revision.rev.timestamp,
521
revision.rev.timezone or 0,
523
print >>to_file, indent+'timestamp: %s' % date_str
525
print >>to_file, indent+'message:'
526
if not revision.rev.message:
527
print >>to_file, indent+' (no message)'
529
message = revision.rev.message.rstrip('\r\n')
530
for l in message.split('\n'):
531
print >>to_file, indent+' ' + l
532
if revision.delta is not None:
533
revision.delta.show(to_file, self.show_ids, indent=indent)
536
class ShortLogFormatter(LogFormatter):
538
supports_delta = True
540
@deprecated_method(zero_seventeen)
541
def show(self, revno, rev, delta):
542
lr = LogRevision(rev,revno,0,delta)
543
return self.log_revision(lr)
545
def log_revision(self, revision):
546
from bzrlib.osutils import format_date
548
to_file = self.to_file
549
date_str = format_date(revision.rev.timestamp,
550
revision.rev.timezone or 0,
552
print >>to_file, "%5s %s\t%s" % (revision.revno,
553
self.short_committer(revision.rev),
554
format_date(revision.rev.timestamp,
555
revision.rev.timezone or 0,
556
self.show_timezone, date_fmt="%Y-%m-%d",
559
print >>to_file, ' revision-id:', revision.rev.revision_id
560
if not revision.rev.message:
561
print >>to_file, ' (no message)'
563
message = revision.rev.message.rstrip('\r\n')
564
for l in message.split('\n'):
565
print >>to_file, ' ' + l
567
# TODO: Why not show the modified files in a shorter form as
568
# well? rewrap them single lines of appropriate length
569
if revision.delta is not None:
570
revision.delta.show(to_file, self.show_ids)
574
class LineLogFormatter(LogFormatter):
576
def __init__(self, *args, **kwargs):
577
from bzrlib.osutils import terminal_width
578
super(LineLogFormatter, self).__init__(*args, **kwargs)
579
self._max_chars = terminal_width() - 1
581
def truncate(self, str, max_len):
582
if len(str) <= max_len:
584
return str[:max_len-3]+'...'
586
def date_string(self, rev):
587
from bzrlib.osutils import format_date
588
return format_date(rev.timestamp, rev.timezone or 0,
589
self.show_timezone, date_fmt="%Y-%m-%d",
592
def message(self, rev):
594
return '(no message)'
598
@deprecated_method(zero_seventeen)
599
def show(self, revno, rev, delta):
600
from bzrlib.osutils import terminal_width
601
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
603
def log_revision(self, revision):
604
print >> self.to_file, self.log_string(revision.revno, revision.rev,
607
def log_string(self, revno, rev, max_chars):
608
"""Format log info into one string. Truncate tail of string
609
:param revno: revision number (int) or None.
610
Revision numbers counts from 1.
611
:param rev: revision info object
612
:param max_chars: maximum length of resulting string
613
:return: formatted truncated string
617
# show revno only when is not None
618
out.append("%s:" % revno)
619
out.append(self.truncate(self.short_committer(rev), 20))
620
out.append(self.date_string(rev))
621
out.append(rev.get_summary())
622
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
625
def line_log(rev, max_chars):
626
lf = LineLogFormatter(None)
627
return lf.log_string(None, rev, max_chars)
630
class LogFormatterRegistry(registry.Registry):
631
"""Registry for log formatters"""
633
def make_formatter(self, name, *args, **kwargs):
634
"""Construct a formatter from arguments.
636
:param name: Name of the formatter to construct. 'short', 'long' and
639
return self.get(name)(*args, **kwargs)
641
def get_default(self, branch):
642
return self.get(branch.get_config().log_format())
645
log_formatter_registry = LogFormatterRegistry()
648
log_formatter_registry.register('short', ShortLogFormatter,
649
'Moderately short log format')
650
log_formatter_registry.register('long', LongLogFormatter,
651
'Detailed log format')
652
log_formatter_registry.register('line', LineLogFormatter,
653
'Log format with one line per revision')
656
def register_formatter(name, formatter):
657
log_formatter_registry.register(name, formatter)
660
def log_formatter(name, *args, **kwargs):
661
"""Construct a formatter from arguments.
663
name -- Name of the formatter to construct; currently 'long', 'short' and
664
'line' are supported.
666
from bzrlib.errors import BzrCommandError
668
return log_formatter_registry.make_formatter(name, *args, **kwargs)
670
raise BzrCommandError("unknown log formatter: %r" % name)
673
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
674
# deprecated; for compatibility
675
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
676
lf.show(revno, rev, delta)
678
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
679
"""Show the change in revision history comparing the old revision history to the new one.
681
:param branch: The branch where the revisions exist
682
:param old_rh: The old revision history
683
:param new_rh: The new revision history
684
:param to_file: A file to write the results to. If None, stdout will be used
690
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
691
lf = log_formatter(log_format,
694
show_timezone='original')
696
# This is the first index which is different between
699
for i in xrange(max(len(new_rh),
703
or new_rh[i] != old_rh[i]):
708
to_file.write('Nothing seems to have changed\n')
710
## TODO: It might be nice to do something like show_log
711
## and show the merged entries. But since this is the
712
## removed revisions, it shouldn't be as important
713
if base_idx < len(old_rh):
714
to_file.write('*'*60)
715
to_file.write('\nRemoved Revisions:\n')
716
for i in range(base_idx, len(old_rh)):
717
rev = branch.repository.get_revision(old_rh[i])
718
lf.show(i+1, rev, None)
719
to_file.write('*'*60)
720
to_file.write('\n\n')
721
if base_idx < len(new_rh):
722
to_file.write('Added Revisions:\n')
728
start_revision=base_idx+1,
729
end_revision=len(new_rh),
added
removed
bzrlib/log.py
