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 deprecated_method, zero_eleven
63
from bzrlib.trace import mutter
64
from bzrlib.tsort import(
70
def find_touching_revisions(branch, file_id):
71
"""Yield a description of revisions which affect the file_id.
73
Each returned element is (revno, revision_id, description)
75
This is the list of revisions where the file is either added,
76
modified, renamed or deleted.
78
TODO: Perhaps some way to limit this to only particular revisions,
79
or to traverse a non-mainline set of revisions?
84
for revision_id in branch.revision_history():
85
this_inv = branch.repository.get_revision_inventory(revision_id)
86
if file_id in this_inv:
87
this_ie = this_inv[file_id]
88
this_path = this_inv.id2path(file_id)
90
this_ie = this_path = None
92
# now we know how it was last time, and how it is in this revision.
93
# are those two states effectively the same or not?
95
if not this_ie and not last_ie:
96
# not present in either
98
elif this_ie and not last_ie:
99
yield revno, revision_id, "added " + this_path
100
elif not this_ie and last_ie:
102
yield revno, revision_id, "deleted " + last_path
103
elif this_path != last_path:
104
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
105
elif (this_ie.text_size != last_ie.text_size
106
or this_ie.text_sha1 != last_ie.text_sha1):
107
yield revno, revision_id, "modified " + this_path
110
last_path = this_path
115
def _enumerate_history(branch):
118
for rev_id in branch.revision_history():
119
rh.append((revno, rev_id))
126
specific_fileid=None,
132
"""Write out human-readable log of commits to this branch.
135
LogFormatter object to show the output.
138
If true, list only the commits affecting the specified
139
file, rather than all commits.
142
If true show added/changed/deleted/renamed files.
145
'reverse' (default) is latest to earliest;
146
'forward' is earliest to latest.
149
If not None, only show revisions >= start_revision
152
If not None, only show revisions <= end_revision
156
_show_log(branch, lf, specific_fileid, verbose, direction,
157
start_revision, end_revision, search)
161
def _show_log(branch,
163
specific_fileid=None,
169
"""Worker function for show_log - see show_log."""
170
from bzrlib.osutils import format_date
171
from bzrlib.errors import BzrCheckError
173
from warnings import warn
175
if not isinstance(lf, LogFormatter):
176
warn("not a LogFormatter instance: %r" % lf)
179
mutter('get log for file_id %r', specific_fileid)
181
if search is not None:
183
searchRE = re.compile(search, re.IGNORECASE)
187
which_revs = _enumerate_history(branch)
189
if start_revision is None:
192
branch.check_real_revno(start_revision)
194
if end_revision is None:
195
end_revision = len(which_revs)
197
branch.check_real_revno(end_revision)
199
# list indexes are 0-based; revisions are 1-based
200
cut_revs = which_revs[(start_revision-1):(end_revision)]
204
# convert the revision history to a dictionary:
205
rev_nos = dict((k, v) for v, k in cut_revs)
207
# override the mainline to look like the revision history.
208
mainline_revs = [revision_id for index, revision_id in cut_revs]
209
if cut_revs[0][0] == 1:
210
mainline_revs.insert(0, None)
212
mainline_revs.insert(0, which_revs[start_revision-2][1])
213
# how should we show merged revisions ?
214
# old api: show_merge. New api: show_merge_revno
215
show_merge_revno = getattr(lf, 'show_merge_revno', None)
216
show_merge = getattr(lf, 'show_merge', None)
217
if show_merge is None and show_merge_revno is None:
218
# no merged-revno support
219
include_merges = False
221
include_merges = True
222
if show_merge is not None and show_merge_revno is None:
223
# tell developers to update their code
224
symbol_versioning.warn('LogFormatters should provide show_merge_revno '
225
'instead of show_merge since bzr 0.11.',
226
DeprecationWarning, stacklevel=3)
227
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
228
direction, include_merges=include_merges)
230
view_revisions = _get_revisions_touching_file_id(branch,
235
view_revisions = list(view_revs_iter)
237
use_tags = getattr(lf, 'supports_tags', False)
240
if branch.supports_tags():
241
rev_tag_dict = branch.tags.get_reverse_tag_dict()
243
def iter_revisions():
244
# r = revision, n = revno, d = merge depth
245
revision_ids = [r for r, n, d in view_revisions]
246
zeros = set(r for r, n, d in view_revisions if d == 0)
248
repository = branch.repository
251
revisions = repository.get_revisions(revision_ids[:num])
253
delta_revisions = [r for r in revisions if
254
r.revision_id in zeros]
255
deltas = repository.get_deltas_for_revisions(delta_revisions)
256
cur_deltas = dict(izip((r.revision_id for r in
257
delta_revisions), deltas))
258
for revision in revisions:
259
# The delta value will be None unless
260
# 1. verbose is specified, and
261
# 2. the revision is a mainline revision
262
yield revision, cur_deltas.get(revision.revision_id)
263
revision_ids = revision_ids[num:]
264
num = min(int(num * 1.5), 200)
266
# now we just print all the revisions
267
for ((rev_id, revno, merge_depth), (rev, delta)) in \
268
izip(view_revisions, iter_revisions()):
271
if not searchRE.search(rev.message):
276
lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
278
lf.show(revno, rev, delta)
280
if show_merge_revno is None:
281
lf.show_merge(rev, merge_depth)
284
lf.show_merge_revno(rev, merge_depth, revno,
285
rev_tag_dict.get(rev_id))
287
lf.show_merge_revno(rev, merge_depth, revno)
290
def _get_revisions_touching_file_id(branch, file_id, mainline_revisions,
292
"""Return the list of revision ids which touch a given file id.
294
This includes the revisions which directly change the file id,
295
and the revisions which merge these changes. So if the
303
And 'C' changes a file, then both C and D will be returned.
305
This will also can be restricted based on a subset of the mainline.
307
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
309
# find all the revisions that change the specific file
310
file_weave = branch.repository.weave_store.get_weave(file_id,
311
branch.repository.get_transaction())
312
weave_modifed_revisions = set(file_weave.versions())
313
# build the ancestry of each revision in the graph
314
# - only listing the ancestors that change the specific file.
315
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
316
sorted_rev_list = topo_sort(rev_graph)
318
for rev in sorted_rev_list:
319
parents = rev_graph[rev]
320
if rev not in weave_modifed_revisions and len(parents) == 1:
321
# We will not be adding anything new, so just use a reference to
322
# the parent ancestry.
323
rev_ancestry = ancestry[parents[0]]
326
if rev in weave_modifed_revisions:
327
rev_ancestry.add(rev)
328
for parent in parents:
329
rev_ancestry = rev_ancestry.union(ancestry[parent])
330
ancestry[rev] = rev_ancestry
332
def is_merging_rev(r):
333
parents = rev_graph[r]
335
leftparent = parents[0]
336
for rightparent in parents[1:]:
337
if not ancestry[leftparent].issuperset(
338
ancestry[rightparent]):
342
# filter from the view the revisions that did not change or merge
344
return [(r, n, d) for r, n, d in view_revs_iter
345
if r in weave_modifed_revisions or is_merging_rev(r)]
348
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
349
include_merges=True):
350
"""Produce an iterator of revisions to show
351
:return: an iterator of (revision_id, revno, merge_depth)
352
(if there is no revno for a revision, None is supplied)
354
if include_merges is False:
355
revision_ids = mainline_revs[1:]
356
if direction == 'reverse':
357
revision_ids.reverse()
358
for revision_id in revision_ids:
359
yield revision_id, str(rev_nos[revision_id]), 0
361
merge_sorted_revisions = merge_sort(
362
branch.repository.get_revision_graph(mainline_revs[-1]),
367
if direction == 'forward':
368
# forward means oldest first.
369
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
370
elif direction != 'reverse':
371
raise ValueError('invalid direction %r' % direction)
373
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
374
yield rev_id, '.'.join(map(str, revno)), merge_depth
377
def reverse_by_depth(merge_sorted_revisions, _depth=0):
378
"""Reverse revisions by depth.
380
Revisions with a different depth are sorted as a group with the previous
381
revision of that depth. There may be no topological justification for this,
382
but it looks much nicer.
385
for val in merge_sorted_revisions:
387
zd_revisions.append([val])
389
assert val[2] > _depth
390
zd_revisions[-1].append(val)
391
for revisions in zd_revisions:
392
if len(revisions) > 1:
393
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
394
zd_revisions.reverse()
396
for chunk in zd_revisions:
401
class LogFormatter(object):
402
"""Abstract class to display log messages."""
404
def __init__(self, to_file, show_ids=False, show_timezone='original'):
405
self.to_file = to_file
406
self.show_ids = show_ids
407
self.show_timezone = show_timezone
409
def show(self, revno, rev, delta):
410
raise NotImplementedError('not implemented in abstract base')
412
def short_committer(self, rev):
413
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
416
class LongLogFormatter(LogFormatter):
418
supports_tags = True # must exist and be True
419
# if this log formatter support tags.
420
# .show() and .show_merge_revno() must then accept
421
# the 'tags'-argument with list of tags
423
def show(self, revno, rev, delta, tags=None):
424
return self._show_helper(revno=revno, rev=rev, delta=delta, tags=tags)
426
@deprecated_method(zero_eleven)
427
def show_merge(self, rev, merge_depth):
428
return self._show_helper(rev=rev, indent=' '*merge_depth,
429
merged=True, delta=None)
431
def show_merge_revno(self, rev, merge_depth, revno, tags=None):
432
"""Show a merged revision rev, with merge_depth and a revno."""
433
return self._show_helper(rev=rev, revno=revno,
434
indent=' '*merge_depth, merged=True, delta=None, tags=tags)
436
def _show_helper(self, rev=None, revno=None, indent='', merged=False,
437
delta=None, tags=None):
438
"""Show a revision, either merged or not."""
439
from bzrlib.osutils import format_date
440
to_file = self.to_file
441
print >>to_file, indent+'-' * 60
442
if revno is not None:
443
print >>to_file, indent+'revno:', revno
445
print >>to_file, indent+'tags: %s' % (', '.join(tags))
447
print >>to_file, indent+'merged:', rev.revision_id
449
print >>to_file, indent+'revision-id:', rev.revision_id
451
for parent_id in rev.parent_ids:
452
print >>to_file, indent+'parent:', parent_id
453
print >>to_file, indent+'committer:', rev.committer
456
print >>to_file, indent+'branch nick: %s' % \
457
rev.properties['branch-nick']
460
date_str = format_date(rev.timestamp,
463
print >>to_file, indent+'timestamp: %s' % date_str
465
print >>to_file, indent+'message:'
467
print >>to_file, indent+' (no message)'
469
message = rev.message.rstrip('\r\n')
470
for l in message.split('\n'):
471
print >>to_file, indent+' ' + l
472
if delta is not None:
473
delta.show(to_file, self.show_ids)
476
class ShortLogFormatter(LogFormatter):
477
def show(self, revno, rev, delta):
478
from bzrlib.osutils import format_date
480
to_file = self.to_file
481
date_str = format_date(rev.timestamp, rev.timezone or 0,
483
print >>to_file, "%5s %s\t%s" % (revno, self.short_committer(rev),
484
format_date(rev.timestamp, rev.timezone or 0,
485
self.show_timezone, date_fmt="%Y-%m-%d",
488
print >>to_file, ' revision-id:', rev.revision_id
490
print >>to_file, ' (no message)'
492
message = rev.message.rstrip('\r\n')
493
for l in message.split('\n'):
494
print >>to_file, ' ' + l
496
# TODO: Why not show the modified files in a shorter form as
497
# well? rewrap them single lines of appropriate length
498
if delta is not None:
499
delta.show(to_file, self.show_ids)
503
class LineLogFormatter(LogFormatter):
504
def truncate(self, str, max_len):
505
if len(str) <= max_len:
507
return str[:max_len-3]+'...'
509
def date_string(self, rev):
510
from bzrlib.osutils import format_date
511
return format_date(rev.timestamp, rev.timezone or 0,
512
self.show_timezone, date_fmt="%Y-%m-%d",
515
def message(self, rev):
517
return '(no message)'
521
def show(self, revno, rev, delta):
522
from bzrlib.osutils import terminal_width
523
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
525
def log_string(self, revno, rev, max_chars):
526
"""Format log info into one string. Truncate tail of string
527
:param revno: revision number (int) or None.
528
Revision numbers counts from 1.
529
:param rev: revision info object
530
:param max_chars: maximum length of resulting string
531
:return: formatted truncated string
535
# show revno only when is not None
536
out.append("%s:" % revno)
537
out.append(self.truncate(self.short_committer(rev), 20))
538
out.append(self.date_string(rev))
539
out.append(rev.get_summary())
540
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
543
def line_log(rev, max_chars):
544
lf = LineLogFormatter(None)
545
return lf.log_string(None, rev, max_chars)
548
class LogFormatterRegistry(registry.Registry):
549
"""Registry for log formatters"""
551
def make_formatter(self, name, *args, **kwargs):
552
"""Construct a formatter from arguments.
554
:param name: Name of the formatter to construct. 'short', 'long' and
557
return self.get(name)(*args, **kwargs)
559
def get_default(self, branch):
560
return self.get(branch.get_config().log_format())
563
log_formatter_registry = LogFormatterRegistry()
566
log_formatter_registry.register('short', ShortLogFormatter,
567
'Moderately short log format')
568
log_formatter_registry.register('long', LongLogFormatter,
569
'Detailed log format')
570
log_formatter_registry.register('line', LineLogFormatter,
571
'Log format with one line per revision')
574
def register_formatter(name, formatter):
575
log_formatter_registry.register(name, formatter)
578
def log_formatter(name, *args, **kwargs):
579
"""Construct a formatter from arguments.
581
name -- Name of the formatter to construct; currently 'long', 'short' and
582
'line' are supported.
584
from bzrlib.errors import BzrCommandError
586
return log_formatter_registry.make_formatter(name, *args, **kwargs)
588
raise BzrCommandError("unknown log formatter: %r" % name)
591
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
592
# deprecated; for compatibility
593
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
594
lf.show(revno, rev, delta)
596
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
597
"""Show the change in revision history comparing the old revision history to the new one.
599
:param branch: The branch where the revisions exist
600
:param old_rh: The old revision history
601
:param new_rh: The new revision history
602
:param to_file: A file to write the results to. If None, stdout will be used
608
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
609
lf = log_formatter(log_format,
612
show_timezone='original')
614
# This is the first index which is different between
617
for i in xrange(max(len(new_rh),
621
or new_rh[i] != old_rh[i]):
626
to_file.write('Nothing seems to have changed\n')
628
## TODO: It might be nice to do something like show_log
629
## and show the merged entries. But since this is the
630
## removed revisions, it shouldn't be as important
631
if base_idx < len(old_rh):
632
to_file.write('*'*60)
633
to_file.write('\nRemoved Revisions:\n')
634
for i in range(base_idx, len(old_rh)):
635
rev = branch.repository.get_revision(old_rh[i])
636
lf.show(i+1, rev, None)
637
to_file.write('*'*60)
638
to_file.write('\n\n')
639
if base_idx < len(new_rh):
640
to_file.write('Added Revisions:\n')
646
start_revision=base_idx+1,
647
end_revision=len(new_rh),
added
removed
bzrlib/log.py
