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,
137
"""Write out human-readable log of commits to this branch.
140
LogFormatter object to show the output.
143
If true, list only the commits affecting the specified
144
file, rather than all commits.
147
If true show added/changed/deleted/renamed files.
150
'reverse' (default) is latest to earliest;
151
'forward' is earliest to latest.
154
If not None, only show revisions >= start_revision
157
If not None, only show revisions <= end_revision
160
If not None, only show revisions with matching commit messages
163
If not None or 0, only show limit revisions
167
if getattr(lf, 'begin_log', None):
170
_show_log(branch, lf, specific_fileid, verbose, direction,
171
start_revision, end_revision, search, limit)
173
if getattr(lf, 'end_log', None):
178
def _show_log(branch,
180
specific_fileid=None,
187
"""Worker function for show_log - see show_log."""
188
from bzrlib.osutils import format_date
189
from bzrlib.errors import BzrCheckError
191
from warnings import warn
193
if not isinstance(lf, LogFormatter):
194
warn("not a LogFormatter instance: %r" % lf)
197
mutter('get log for file_id %r', specific_fileid)
199
if search is not None:
201
searchRE = re.compile(search, re.IGNORECASE)
205
which_revs = _enumerate_history(branch)
207
if start_revision is None:
210
branch.check_real_revno(start_revision)
212
if end_revision is None:
213
end_revision = len(which_revs)
215
branch.check_real_revno(end_revision)
217
# list indexes are 0-based; revisions are 1-based
218
cut_revs = which_revs[(start_revision-1):(end_revision)]
222
# convert the revision history to a dictionary:
223
rev_nos = dict((k, v) for v, k in cut_revs)
225
# override the mainline to look like the revision history.
226
mainline_revs = [revision_id for index, revision_id in cut_revs]
227
if cut_revs[0][0] == 1:
228
mainline_revs.insert(0, None)
230
mainline_revs.insert(0, which_revs[start_revision-2][1])
231
legacy_lf = getattr(lf, 'log_revision', None) is None
233
# pre-0.17 formatters use show for mainline revisions.
234
# how should we show merged revisions ?
235
# pre-0.11 api: show_merge
236
# 0.11-0.16 api: show_merge_revno
237
show_merge_revno = getattr(lf, 'show_merge_revno', None)
238
show_merge = getattr(lf, 'show_merge', None)
239
if show_merge is None and show_merge_revno is None:
240
# no merged-revno support
241
generate_merge_revisions = False
243
generate_merge_revisions = True
244
# tell developers to update their code
245
symbol_versioning.warn('LogFormatters should provide log_revision '
246
'instead of show and show_merge_revno since bzr 0.17.',
247
DeprecationWarning, stacklevel=3)
249
generate_merge_revisions = getattr(lf, 'supports_merge_revisions',
251
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
252
direction, include_merges=generate_merge_revisions)
254
view_revisions = _get_revisions_touching_file_id(branch,
259
view_revisions = list(view_revs_iter)
262
generate_tags = getattr(lf, 'supports_tags', False)
264
if branch.supports_tags():
265
rev_tag_dict = branch.tags.get_reverse_tag_dict()
267
generate_delta = verbose and getattr(lf, 'supports_delta', False)
269
def iter_revisions():
270
# r = revision, n = revno, d = merge depth
271
revision_ids = [r for r, n, d in view_revisions]
272
zeros = set(r for r, n, d in view_revisions if d == 0)
274
repository = branch.repository
277
revisions = repository.get_revisions(revision_ids[:num])
279
delta_revisions = [r for r in revisions if
280
r.revision_id in zeros]
281
deltas = repository.get_deltas_for_revisions(delta_revisions)
282
cur_deltas = dict(izip((r.revision_id for r in
283
delta_revisions), deltas))
284
for revision in revisions:
285
# The delta value will be None unless
286
# 1. verbose is specified, and
287
# 2. the revision is a mainline revision
288
yield revision, cur_deltas.get(revision.revision_id)
289
revision_ids = revision_ids[num:]
290
num = min(int(num * 1.5), 200)
292
# now we just print all the revisions
294
for ((rev_id, revno, merge_depth), (rev, delta)) in \
295
izip(view_revisions, iter_revisions()):
298
if not searchRE.search(rev.message):
302
lr = LogRevision(rev, revno, merge_depth, delta,
303
rev_tag_dict.get(rev_id))
306
# support for legacy (pre-0.17) LogFormatters
309
lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
311
lf.show(revno, rev, delta)
313
if show_merge_revno is None:
314
lf.show_merge(rev, merge_depth)
317
lf.show_merge_revno(rev, merge_depth, revno,
318
rev_tag_dict.get(rev_id))
320
lf.show_merge_revno(rev, merge_depth, revno)
323
if log_count >= limit:
327
def _get_revisions_touching_file_id(branch, file_id, mainline_revisions,
329
"""Return the list of revision ids which touch a given file id.
331
This includes the revisions which directly change the file id,
332
and the revisions which merge these changes. So if the
340
And 'C' changes a file, then both C and D will be returned.
342
This will also can be restricted based on a subset of the mainline.
344
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
346
# find all the revisions that change the specific file
347
file_weave = branch.repository.weave_store.get_weave(file_id,
348
branch.repository.get_transaction())
349
weave_modifed_revisions = set(file_weave.versions())
350
# build the ancestry of each revision in the graph
351
# - only listing the ancestors that change the specific file.
352
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
353
sorted_rev_list = topo_sort(rev_graph)
355
for rev in sorted_rev_list:
356
parents = rev_graph[rev]
357
if rev not in weave_modifed_revisions and len(parents) == 1:
358
# We will not be adding anything new, so just use a reference to
359
# the parent ancestry.
360
rev_ancestry = ancestry[parents[0]]
363
if rev in weave_modifed_revisions:
364
rev_ancestry.add(rev)
365
for parent in parents:
366
rev_ancestry = rev_ancestry.union(ancestry[parent])
367
ancestry[rev] = rev_ancestry
369
def is_merging_rev(r):
370
parents = rev_graph[r]
372
leftparent = parents[0]
373
for rightparent in parents[1:]:
374
if not ancestry[leftparent].issuperset(
375
ancestry[rightparent]):
379
# filter from the view the revisions that did not change or merge
381
return [(r, n, d) for r, n, d in view_revs_iter
382
if r in weave_modifed_revisions or is_merging_rev(r)]
385
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
386
include_merges=True):
387
"""Produce an iterator of revisions to show
388
:return: an iterator of (revision_id, revno, merge_depth)
389
(if there is no revno for a revision, None is supplied)
391
if include_merges is False:
392
revision_ids = mainline_revs[1:]
393
if direction == 'reverse':
394
revision_ids.reverse()
395
for revision_id in revision_ids:
396
yield revision_id, str(rev_nos[revision_id]), 0
398
merge_sorted_revisions = merge_sort(
399
branch.repository.get_revision_graph(mainline_revs[-1]),
404
if direction == 'forward':
405
# forward means oldest first.
406
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
407
elif direction != 'reverse':
408
raise ValueError('invalid direction %r' % direction)
410
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
411
yield rev_id, '.'.join(map(str, revno)), merge_depth
414
def reverse_by_depth(merge_sorted_revisions, _depth=0):
415
"""Reverse revisions by depth.
417
Revisions with a different depth are sorted as a group with the previous
418
revision of that depth. There may be no topological justification for this,
419
but it looks much nicer.
422
for val in merge_sorted_revisions:
424
zd_revisions.append([val])
426
assert val[2] > _depth
427
zd_revisions[-1].append(val)
428
for revisions in zd_revisions:
429
if len(revisions) > 1:
430
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
431
zd_revisions.reverse()
433
for chunk in zd_revisions:
438
class LogRevision(object):
439
"""A revision to be logged (by LogFormatter.log_revision).
441
A simple wrapper for the attributes of a revision to be logged.
442
The attributes may or may not be populated, as determined by the
443
logging options and the log formatter capabilities.
446
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
450
self.merge_depth = merge_depth
455
class LogFormatter(object):
456
"""Abstract class to display log messages.
458
At a minimum, a derived class must implement the log_revision method.
460
If the LogFormatter needs to be informed of the beginning or end of
461
a log it should implement the begin_log and/or end_log hook methods.
463
A LogFormatter should define the following supports_XXX flags
464
to indicate which LogRevision attributes it supports:
466
- supports_delta must be True if this log formatter supports delta.
467
Otherwise the delta attribute may not be populated.
468
- supports_merge_revisions must be True if this log formatter supports
469
merge revisions. If not, only revisions mainline revisions (those
470
with merge_depth == 0) will be passed to the formatter.
471
- supports_tags must be True if this log formatter supports tags.
472
Otherwise the tags attribute may not be populated.
475
def __init__(self, to_file, show_ids=False, show_timezone='original'):
476
self.to_file = to_file
477
self.show_ids = show_ids
478
self.show_timezone = show_timezone
480
# TODO: uncomment this block after show() has been removed.
481
# Until then defining log_revision would prevent _show_log calling show()
482
# in legacy formatters.
483
# def log_revision(self, revision):
486
# :param revision: The LogRevision to be logged.
488
# raise NotImplementedError('not implemented in abstract base')
490
@deprecated_method(zero_seventeen)
491
def show(self, revno, rev, delta):
492
raise NotImplementedError('not implemented in abstract base')
494
def short_committer(self, rev):
495
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
498
class LongLogFormatter(LogFormatter):
500
supports_merge_revisions = True
501
supports_delta = True
504
@deprecated_method(zero_seventeen)
505
def show(self, revno, rev, delta, tags=None):
506
lr = LogRevision(rev, revno, 0, delta, tags)
507
return self.log_revision(lr)
509
@deprecated_method(zero_eleven)
510
def show_merge(self, rev, merge_depth):
511
lr = LogRevision(rev, merge_depth=merge_depth)
512
return self.log_revision(lr)
514
@deprecated_method(zero_seventeen)
515
def show_merge_revno(self, rev, merge_depth, revno, tags=None):
516
"""Show a merged revision rev, with merge_depth and a revno."""
517
lr = LogRevision(rev, revno, merge_depth, tags=tags)
518
return self.log_revision(lr)
520
def log_revision(self, revision):
521
"""Log a revision, either merged or not."""
522
from bzrlib.osutils import format_date
523
indent = ' '*revision.merge_depth
524
to_file = self.to_file
525
print >>to_file, indent+'-' * 60
526
if revision.revno is not None:
527
print >>to_file, indent+'revno:', revision.revno
529
print >>to_file, indent+'tags: %s' % (', '.join(revision.tags))
531
print >>to_file, indent+'revision-id:', revision.rev.revision_id
532
for parent_id in revision.rev.parent_ids:
533
print >>to_file, indent+'parent:', parent_id
534
print >>to_file, indent+'committer:', revision.rev.committer
537
print >>to_file, indent+'branch nick: %s' % \
538
revision.rev.properties['branch-nick']
541
date_str = format_date(revision.rev.timestamp,
542
revision.rev.timezone or 0,
544
print >>to_file, indent+'timestamp: %s' % date_str
546
print >>to_file, indent+'message:'
547
if not revision.rev.message:
548
print >>to_file, indent+' (no message)'
550
message = revision.rev.message.rstrip('\r\n')
551
for l in message.split('\n'):
552
print >>to_file, indent+' ' + l
553
if revision.delta is not None:
554
revision.delta.show(to_file, self.show_ids)
557
class ShortLogFormatter(LogFormatter):
559
supports_delta = True
561
@deprecated_method(zero_seventeen)
562
def show(self, revno, rev, delta):
563
lr = LogRevision(rev, revno, 0, delta)
564
return self.log_revision(lr)
566
def log_revision(self, revision):
567
from bzrlib.osutils import format_date
569
to_file = self.to_file
570
date_str = format_date(revision.rev.timestamp,
571
revision.rev.timezone or 0,
574
if len(revision.rev.parent_ids) > 1:
575
is_merge = ' [merge]'
576
print >>to_file, "%5s %s\t%s%s" % (revision.revno,
577
self.short_committer(revision.rev),
578
format_date(revision.rev.timestamp,
579
revision.rev.timezone or 0,
580
self.show_timezone, date_fmt="%Y-%m-%d",
584
print >>to_file, ' revision-id:', revision.rev.revision_id
585
if not revision.rev.message:
586
print >>to_file, ' (no message)'
588
message = revision.rev.message.rstrip('\r\n')
589
for l in message.split('\n'):
590
print >>to_file, ' ' + l
592
# TODO: Why not show the modified files in a shorter form as
593
# well? rewrap them single lines of appropriate length
594
if revision.delta is not None:
595
revision.delta.show(to_file, self.show_ids)
599
class LineLogFormatter(LogFormatter):
601
def __init__(self, *args, **kwargs):
602
from bzrlib.osutils import terminal_width
603
super(LineLogFormatter, self).__init__(*args, **kwargs)
604
self._max_chars = terminal_width() - 1
606
def truncate(self, str, max_len):
607
if len(str) <= max_len:
609
return str[:max_len-3]+'...'
611
def date_string(self, rev):
612
from bzrlib.osutils import format_date
613
return format_date(rev.timestamp, rev.timezone or 0,
614
self.show_timezone, date_fmt="%Y-%m-%d",
617
def message(self, rev):
619
return '(no message)'
623
@deprecated_method(zero_seventeen)
624
def show(self, revno, rev, delta):
625
from bzrlib.osutils import terminal_width
626
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
628
def log_revision(self, revision):
629
print >>self.to_file, self.log_string(revision.revno, revision.rev,
632
def log_string(self, revno, rev, max_chars):
633
"""Format log info into one string. Truncate tail of string
634
:param revno: revision number (int) or None.
635
Revision numbers counts from 1.
636
:param rev: revision info object
637
:param max_chars: maximum length of resulting string
638
:return: formatted truncated string
642
# show revno only when is not None
643
out.append("%s:" % revno)
644
out.append(self.truncate(self.short_committer(rev), 20))
645
out.append(self.date_string(rev))
646
out.append(rev.get_summary())
647
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
650
def line_log(rev, max_chars):
651
lf = LineLogFormatter(None)
652
return lf.log_string(None, rev, max_chars)
655
class LogFormatterRegistry(registry.Registry):
656
"""Registry for log formatters"""
658
def make_formatter(self, name, *args, **kwargs):
659
"""Construct a formatter from arguments.
661
:param name: Name of the formatter to construct. 'short', 'long' and
664
return self.get(name)(*args, **kwargs)
666
def get_default(self, branch):
667
return self.get(branch.get_config().log_format())
670
log_formatter_registry = LogFormatterRegistry()
673
log_formatter_registry.register('short', ShortLogFormatter,
674
'Moderately short log format')
675
log_formatter_registry.register('long', LongLogFormatter,
676
'Detailed log format')
677
log_formatter_registry.register('line', LineLogFormatter,
678
'Log format with one line per revision')
681
def register_formatter(name, formatter):
682
log_formatter_registry.register(name, formatter)
685
def log_formatter(name, *args, **kwargs):
686
"""Construct a formatter from arguments.
688
name -- Name of the formatter to construct; currently 'long', 'short' and
689
'line' are supported.
691
from bzrlib.errors import BzrCommandError
693
return log_formatter_registry.make_formatter(name, *args, **kwargs)
695
raise BzrCommandError("unknown log formatter: %r" % name)
698
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
699
# deprecated; for compatibility
700
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
701
lf.show(revno, rev, delta)
704
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
705
"""Show the change in revision history comparing the old revision history to the new one.
707
:param branch: The branch where the revisions exist
708
:param old_rh: The old revision history
709
:param new_rh: The new revision history
710
:param to_file: A file to write the results to. If None, stdout will be used
716
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
717
lf = log_formatter(log_format,
720
show_timezone='original')
722
# This is the first index which is different between
725
for i in xrange(max(len(new_rh),
729
or new_rh[i] != old_rh[i]):
734
to_file.write('Nothing seems to have changed\n')
736
## TODO: It might be nice to do something like show_log
737
## and show the merged entries. But since this is the
738
## removed revisions, it shouldn't be as important
739
if base_idx < len(old_rh):
740
to_file.write('*'*60)
741
to_file.write('\nRemoved Revisions:\n')
742
for i in range(base_idx, len(old_rh)):
743
rev = branch.repository.get_revision(old_rh[i])
744
lr = LogRevision(rev, i+1, 0, None)
746
to_file.write('*'*60)
747
to_file.write('\n\n')
748
if base_idx < len(new_rh):
749
to_file.write('Added Revisions:\n')
755
start_revision=base_idx+1,
756
end_revision=len(new_rh),
added
removed
bzrlib/log.py
