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
if getattr(lf, 'begin_log', None):
163
_show_log(branch, lf, specific_fileid, verbose, direction,
164
start_revision, end_revision, search)
166
if getattr(lf, 'end_log', None):
171
def _show_log(branch,
173
specific_fileid=None,
179
"""Worker function for show_log - see show_log."""
180
from bzrlib.osutils import format_date
181
from bzrlib.errors import BzrCheckError
183
from warnings import warn
185
if not isinstance(lf, LogFormatter):
186
warn("not a LogFormatter instance: %r" % lf)
189
mutter('get log for file_id %r', specific_fileid)
191
if search is not None:
193
searchRE = re.compile(search, re.IGNORECASE)
197
which_revs = _enumerate_history(branch)
199
if start_revision is None:
202
branch.check_real_revno(start_revision)
204
if end_revision is None:
205
end_revision = len(which_revs)
207
branch.check_real_revno(end_revision)
209
# list indexes are 0-based; revisions are 1-based
210
cut_revs = which_revs[(start_revision-1):(end_revision)]
214
# convert the revision history to a dictionary:
215
rev_nos = dict((k, v) for v, k in cut_revs)
217
# override the mainline to look like the revision history.
218
mainline_revs = [revision_id for index, revision_id in cut_revs]
219
if cut_revs[0][0] == 1:
220
mainline_revs.insert(0, None)
222
mainline_revs.insert(0, which_revs[start_revision-2][1])
223
legacy_lf = getattr(lf, 'log_revision', None) is None
225
# pre-0.17 formatters use show for mainline revisions.
226
# how should we show merged revisions ?
227
# pre-0.11 api: show_merge
228
# 0.11-0.16 api: show_merge_revno
229
show_merge_revno = getattr(lf, 'show_merge_revno', None)
230
show_merge = getattr(lf, 'show_merge', None)
231
if show_merge is None and show_merge_revno is None:
232
# no merged-revno support
233
generate_merge_revisions = False
235
generate_merge_revisions = True
236
# tell developers to update their code
237
symbol_versioning.warn('LogFormatters should provide log_revision '
238
'instead of show and show_merge_revno since bzr 0.17.',
239
DeprecationWarning, stacklevel=3)
241
generate_merge_revisions = getattr(lf, 'supports_merge_revisions',
243
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
244
direction, include_merges=generate_merge_revisions)
246
view_revisions = _get_revisions_touching_file_id(branch,
251
view_revisions = list(view_revs_iter)
254
generate_tags = getattr(lf, 'supports_tags', False)
256
if branch.supports_tags():
257
rev_tag_dict = branch.tags.get_reverse_tag_dict()
259
generate_delta = verbose and getattr(lf, 'supports_delta', False)
261
def iter_revisions():
262
# r = revision, n = revno, d = merge depth
263
revision_ids = [r for r, n, d in view_revisions]
264
zeros = set(r for r, n, d in view_revisions if d == 0)
266
repository = branch.repository
269
revisions = repository.get_revisions(revision_ids[:num])
271
delta_revisions = [r for r in revisions if
272
r.revision_id in zeros]
273
deltas = repository.get_deltas_for_revisions(delta_revisions)
274
cur_deltas = dict(izip((r.revision_id for r in
275
delta_revisions), deltas))
276
for revision in revisions:
277
# The delta value will be None unless
278
# 1. verbose is specified, and
279
# 2. the revision is a mainline revision
280
yield revision, cur_deltas.get(revision.revision_id)
281
revision_ids = revision_ids[num:]
282
num = min(int(num * 1.5), 200)
284
# now we just print all the revisions
285
for ((rev_id, revno, merge_depth), (rev, delta)) in \
286
izip(view_revisions, iter_revisions()):
289
if not searchRE.search(rev.message):
293
lr = LogRevision(rev, revno, merge_depth, delta,
294
rev_tag_dict.get(rev_id))
297
# support for legacy (pre-0.17) LogFormatters
300
lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
302
lf.show(revno, rev, delta)
304
if show_merge_revno is None:
305
lf.show_merge(rev, merge_depth)
308
lf.show_merge_revno(rev, merge_depth, revno,
309
rev_tag_dict.get(rev_id))
311
lf.show_merge_revno(rev, merge_depth, revno)
314
def _get_revisions_touching_file_id(branch, file_id, mainline_revisions,
316
"""Return the list of revision ids which touch a given file id.
318
This includes the revisions which directly change the file id,
319
and the revisions which merge these changes. So if the
327
And 'C' changes a file, then both C and D will be returned.
329
This will also can be restricted based on a subset of the mainline.
331
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
333
# find all the revisions that change the specific file
334
file_weave = branch.repository.weave_store.get_weave(file_id,
335
branch.repository.get_transaction())
336
weave_modifed_revisions = set(file_weave.versions())
337
# build the ancestry of each revision in the graph
338
# - only listing the ancestors that change the specific file.
339
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
340
sorted_rev_list = topo_sort(rev_graph)
342
for rev in sorted_rev_list:
343
parents = rev_graph[rev]
344
if rev not in weave_modifed_revisions and len(parents) == 1:
345
# We will not be adding anything new, so just use a reference to
346
# the parent ancestry.
347
rev_ancestry = ancestry[parents[0]]
350
if rev in weave_modifed_revisions:
351
rev_ancestry.add(rev)
352
for parent in parents:
353
rev_ancestry = rev_ancestry.union(ancestry[parent])
354
ancestry[rev] = rev_ancestry
356
def is_merging_rev(r):
357
parents = rev_graph[r]
359
leftparent = parents[0]
360
for rightparent in parents[1:]:
361
if not ancestry[leftparent].issuperset(
362
ancestry[rightparent]):
366
# filter from the view the revisions that did not change or merge
368
return [(r, n, d) for r, n, d in view_revs_iter
369
if r in weave_modifed_revisions or is_merging_rev(r)]
372
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
373
include_merges=True):
374
"""Produce an iterator of revisions to show
375
:return: an iterator of (revision_id, revno, merge_depth)
376
(if there is no revno for a revision, None is supplied)
378
if include_merges is False:
379
revision_ids = mainline_revs[1:]
380
if direction == 'reverse':
381
revision_ids.reverse()
382
for revision_id in revision_ids:
383
yield revision_id, str(rev_nos[revision_id]), 0
385
merge_sorted_revisions = merge_sort(
386
branch.repository.get_revision_graph(mainline_revs[-1]),
391
if direction == 'forward':
392
# forward means oldest first.
393
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
394
elif direction != 'reverse':
395
raise ValueError('invalid direction %r' % direction)
397
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
398
yield rev_id, '.'.join(map(str, revno)), merge_depth
401
def reverse_by_depth(merge_sorted_revisions, _depth=0):
402
"""Reverse revisions by depth.
404
Revisions with a different depth are sorted as a group with the previous
405
revision of that depth. There may be no topological justification for this,
406
but it looks much nicer.
409
for val in merge_sorted_revisions:
411
zd_revisions.append([val])
413
assert val[2] > _depth
414
zd_revisions[-1].append(val)
415
for revisions in zd_revisions:
416
if len(revisions) > 1:
417
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
418
zd_revisions.reverse()
420
for chunk in zd_revisions:
425
class LogRevision(object):
426
"""A revision to be logged (by LogFormatter.log_revision).
428
A simple wrapper for the attributes of a revision to be logged.
429
The attributes may or may not be populated, as determined by the
430
logging options and the log formatter capabilities.
433
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
437
self.merge_depth = merge_depth
442
class LogFormatter(object):
443
"""Abstract class to display log messages.
445
At a minimum, a derived class must implement the log_revision method.
447
If the LogFormatter needs to be informed of the beginning or end of
448
a log it should implement the begin_log and/or end_log hook methods.
450
A LogFormatter should define the following supports_XXX flags
451
to indicate which LogRevision attributes it supports:
453
- supports_delta must be True if this log formatter supports delta.
454
Otherwise the delta attribute may not be populated.
455
- supports_merge_revisions must be True if this log formatter supports
456
merge revisions. If not, only revisions mainline revisions (those
457
with merge_depth == 0) will be passed to the formatter.
458
- supports_tags must be True if this log formatter supports tags.
459
Otherwise the tags attribute may not be populated.
462
def __init__(self, to_file, show_ids=False, show_timezone='original'):
463
self.to_file = to_file
464
self.show_ids = show_ids
465
self.show_timezone = show_timezone
467
# TODO: uncomment this block after show() has been removed.
468
# Until then defining log_revision would prevent _show_log calling show()
469
# in legacy formatters.
470
# def log_revision(self, revision):
473
# :param revision: The LogRevision to be logged.
475
# raise NotImplementedError('not implemented in abstract base')
477
@deprecated_method(zero_seventeen)
478
def show(self, revno, rev, delta):
479
raise NotImplementedError('not implemented in abstract base')
481
def short_committer(self, rev):
482
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
485
class LongLogFormatter(LogFormatter):
487
supports_merge_revisions = True
488
supports_delta = True
491
@deprecated_method(zero_seventeen)
492
def show(self, revno, rev, delta, tags=None):
493
lr = LogRevision(rev, revno, 0, delta, tags)
494
return self.log_revision(lr)
496
@deprecated_method(zero_eleven)
497
def show_merge(self, rev, merge_depth):
498
lr = LogRevision(rev, merge_depth=merge_depth)
499
return self.log_revision(lr)
501
@deprecated_method(zero_seventeen)
502
def show_merge_revno(self, rev, merge_depth, revno, tags=None):
503
"""Show a merged revision rev, with merge_depth and a revno."""
504
lr = LogRevision(rev, revno, merge_depth, tags=tags)
505
return self.log_revision(lr)
507
def log_revision(self, revision):
508
"""Log a revision, either merged or not."""
509
from bzrlib.osutils import format_date
510
indent = ' '*revision.merge_depth
511
to_file = self.to_file
512
print >>to_file, indent+'-' * 60
513
if revision.revno is not None:
514
print >>to_file, indent+'revno:', revision.revno
516
print >>to_file, indent+'tags: %s' % (', '.join(revision.tags))
518
print >>to_file, indent+'revision-id:', revision.rev.revision_id
519
for parent_id in revision.rev.parent_ids:
520
print >>to_file, indent+'parent:', parent_id
521
print >>to_file, indent+'committer:', revision.rev.committer
524
print >>to_file, indent+'branch nick: %s' % \
525
revision.rev.properties['branch-nick']
528
date_str = format_date(revision.rev.timestamp,
529
revision.rev.timezone or 0,
531
print >>to_file, indent+'timestamp: %s' % date_str
533
print >>to_file, indent+'message:'
534
if not revision.rev.message:
535
print >>to_file, indent+' (no message)'
537
message = revision.rev.message.rstrip('\r\n')
538
for l in message.split('\n'):
539
print >>to_file, indent+' ' + l
540
if revision.delta is not None:
541
revision.delta.show(to_file, self.show_ids)
544
class ShortLogFormatter(LogFormatter):
546
supports_delta = True
548
@deprecated_method(zero_seventeen)
549
def show(self, revno, rev, delta):
550
lr = LogRevision(rev, revno, 0, delta)
551
return self.log_revision(lr)
553
def log_revision(self, revision):
554
from bzrlib.osutils import format_date
556
to_file = self.to_file
557
date_str = format_date(revision.rev.timestamp,
558
revision.rev.timezone or 0,
560
print >>to_file, "%5s %s\t%s" % (revision.revno,
561
self.short_committer(revision.rev),
562
format_date(revision.rev.timestamp,
563
revision.rev.timezone or 0,
564
self.show_timezone, date_fmt="%Y-%m-%d",
567
print >>to_file, ' revision-id:', revision.rev.revision_id
568
if not revision.rev.message:
569
print >>to_file, ' (no message)'
571
message = revision.rev.message.rstrip('\r\n')
572
for l in message.split('\n'):
573
print >>to_file, ' ' + l
575
# TODO: Why not show the modified files in a shorter form as
576
# well? rewrap them single lines of appropriate length
577
if revision.delta is not None:
578
revision.delta.show(to_file, self.show_ids)
582
class LineLogFormatter(LogFormatter):
584
def __init__(self, *args, **kwargs):
585
from bzrlib.osutils import terminal_width
586
super(LineLogFormatter, self).__init__(*args, **kwargs)
587
self._max_chars = terminal_width() - 1
589
def truncate(self, str, max_len):
590
if len(str) <= max_len:
592
return str[:max_len-3]+'...'
594
def date_string(self, rev):
595
from bzrlib.osutils import format_date
596
return format_date(rev.timestamp, rev.timezone or 0,
597
self.show_timezone, date_fmt="%Y-%m-%d",
600
def message(self, rev):
602
return '(no message)'
606
@deprecated_method(zero_seventeen)
607
def show(self, revno, rev, delta):
608
from bzrlib.osutils import terminal_width
609
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
611
def log_revision(self, revision):
612
print >>self.to_file, self.log_string(revision.revno, revision.rev,
615
def log_string(self, revno, rev, max_chars):
616
"""Format log info into one string. Truncate tail of string
617
:param revno: revision number (int) or None.
618
Revision numbers counts from 1.
619
:param rev: revision info object
620
:param max_chars: maximum length of resulting string
621
:return: formatted truncated string
625
# show revno only when is not None
626
out.append("%s:" % revno)
627
out.append(self.truncate(self.short_committer(rev), 20))
628
out.append(self.date_string(rev))
629
out.append(rev.get_summary())
630
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
633
def line_log(rev, max_chars):
634
lf = LineLogFormatter(None)
635
return lf.log_string(None, rev, max_chars)
638
class LogFormatterRegistry(registry.Registry):
639
"""Registry for log formatters"""
641
def make_formatter(self, name, *args, **kwargs):
642
"""Construct a formatter from arguments.
644
:param name: Name of the formatter to construct. 'short', 'long' and
647
return self.get(name)(*args, **kwargs)
649
def get_default(self, branch):
650
return self.get(branch.get_config().log_format())
653
log_formatter_registry = LogFormatterRegistry()
656
log_formatter_registry.register('short', ShortLogFormatter,
657
'Moderately short log format')
658
log_formatter_registry.register('long', LongLogFormatter,
659
'Detailed log format')
660
log_formatter_registry.register('line', LineLogFormatter,
661
'Log format with one line per revision')
664
def register_formatter(name, formatter):
665
log_formatter_registry.register(name, formatter)
668
def log_formatter(name, *args, **kwargs):
669
"""Construct a formatter from arguments.
671
name -- Name of the formatter to construct; currently 'long', 'short' and
672
'line' are supported.
674
from bzrlib.errors import BzrCommandError
676
return log_formatter_registry.make_formatter(name, *args, **kwargs)
678
raise BzrCommandError("unknown log formatter: %r" % name)
681
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
682
# deprecated; for compatibility
683
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
684
lf.show(revno, rev, delta)
687
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
688
"""Show the change in revision history comparing the old revision history to the new one.
690
:param branch: The branch where the revisions exist
691
:param old_rh: The old revision history
692
:param new_rh: The new revision history
693
:param to_file: A file to write the results to. If None, stdout will be used
699
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
700
lf = log_formatter(log_format,
703
show_timezone='original')
705
# This is the first index which is different between
708
for i in xrange(max(len(new_rh),
712
or new_rh[i] != old_rh[i]):
717
to_file.write('Nothing seems to have changed\n')
719
## TODO: It might be nice to do something like show_log
720
## and show the merged entries. But since this is the
721
## removed revisions, it shouldn't be as important
722
if base_idx < len(old_rh):
723
to_file.write('*'*60)
724
to_file.write('\nRemoved Revisions:\n')
725
for i in range(base_idx, len(old_rh)):
726
rev = branch.repository.get_revision(old_rh[i])
727
lr = LogRevision(rev, i+1, 0, None)
729
to_file.write('*'*60)
730
to_file.write('\n\n')
731
if base_idx < len(new_rh):
732
to_file.write('Added Revisions:\n')
738
start_revision=base_idx+1,
739
end_revision=len(new_rh),
added
removed
bzrlib/log.py
