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
def iter_revisions():
238
# r = revision, n = revno, d = merge depth
239
revision_ids = [r for r, n, d in view_revisions]
240
zeros = set(r for r, n, d in view_revisions if d == 0)
242
repository = branch.repository
245
revisions = repository.get_revisions(revision_ids[:num])
247
delta_revisions = [r for r in revisions if
248
r.revision_id in zeros]
249
deltas = repository.get_deltas_for_revisions(delta_revisions)
250
cur_deltas = dict(izip((r.revision_id for r in
251
delta_revisions), deltas))
252
for revision in revisions:
253
# The delta value will be None unless
254
# 1. verbose is specified, and
255
# 2. the revision is a mainline revision
256
yield revision, cur_deltas.get(revision.revision_id)
257
revision_ids = revision_ids[num:]
258
num = min(int(num * 1.5), 200)
260
# now we just print all the revisions
261
for ((rev_id, revno, merge_depth), (rev, delta)) in \
262
izip(view_revisions, iter_revisions()):
265
if not searchRE.search(rev.message):
269
# a mainline revision.
270
lf.show(revno, rev, delta)
272
if show_merge_revno is None:
273
lf.show_merge(rev, merge_depth)
275
lf.show_merge_revno(rev, merge_depth, revno)
278
def _get_revisions_touching_file_id(branch, file_id, mainline_revisions,
280
"""Return the list of revision ids which touch a given file id.
282
This includes the revisions which directly change the file id,
283
and the revisions which merge these changes. So if the
291
And 'C' changes a file, then both C and D will be returned.
293
This will also can be restricted based on a subset of the mainline.
295
# find all the revisions that change the specific file
296
file_weave = branch.repository.weave_store.get_weave(file_id,
297
branch.repository.get_transaction())
298
weave_modifed_revisions = set(file_weave.versions())
299
# build the ancestry of each revision in the graph
300
# - only listing the ancestors that change the specific file.
301
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
302
sorted_rev_list = topo_sort(rev_graph)
304
for rev in sorted_rev_list:
306
if rev in weave_modifed_revisions:
307
rev_ancestry.add(rev)
308
for parent in rev_graph[rev]:
309
rev_ancestry = rev_ancestry.union(ancestry[parent])
310
ancestry[rev] = rev_ancestry
312
def is_merging_rev(r):
313
parents = rev_graph[r]
315
leftparent = parents[0]
316
for rightparent in parents[1:]:
317
if not ancestry[leftparent].issuperset(
318
ancestry[rightparent]):
322
# filter from the view the revisions that did not change or merge
324
return [(r, n, d) for r, n, d in view_revs_iter
325
if r in weave_modifed_revisions or is_merging_rev(r)]
328
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
329
include_merges=True):
330
"""Produce an iterator of revisions to show
331
:return: an iterator of (revision_id, revno, merge_depth)
332
(if there is no revno for a revision, None is supplied)
334
if include_merges is False:
335
revision_ids = mainline_revs[1:]
336
if direction == 'reverse':
337
revision_ids.reverse()
338
for revision_id in revision_ids:
339
yield revision_id, str(rev_nos[revision_id]), 0
341
merge_sorted_revisions = merge_sort(
342
branch.repository.get_revision_graph(mainline_revs[-1]),
347
if direction == 'forward':
348
# forward means oldest first.
349
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
350
elif direction != 'reverse':
351
raise ValueError('invalid direction %r' % direction)
353
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
354
yield rev_id, '.'.join(map(str, revno)), merge_depth
357
def reverse_by_depth(merge_sorted_revisions, _depth=0):
358
"""Reverse revisions by depth.
360
Revisions with a different depth are sorted as a group with the previous
361
revision of that depth. There may be no topological justification for this,
362
but it looks much nicer.
365
for val in merge_sorted_revisions:
367
zd_revisions.append([val])
369
assert val[2] > _depth
370
zd_revisions[-1].append(val)
371
for revisions in zd_revisions:
372
if len(revisions) > 1:
373
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
374
zd_revisions.reverse()
376
for chunk in zd_revisions:
381
class LogFormatter(object):
382
"""Abstract class to display log messages."""
384
def __init__(self, to_file, show_ids=False, show_timezone='original'):
385
self.to_file = to_file
386
self.show_ids = show_ids
387
self.show_timezone = show_timezone
389
def show(self, revno, rev, delta):
390
raise NotImplementedError('not implemented in abstract base')
392
def short_committer(self, rev):
393
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
396
class LongLogFormatter(LogFormatter):
397
def show(self, revno, rev, delta):
398
return self._show_helper(revno=revno, rev=rev, delta=delta)
400
@deprecated_method(zero_eleven)
401
def show_merge(self, rev, merge_depth):
402
return self._show_helper(rev=rev, indent=' '*merge_depth, merged=True, delta=None)
404
def show_merge_revno(self, rev, merge_depth, revno):
405
"""Show a merged revision rev, with merge_depth and a revno."""
406
return self._show_helper(rev=rev, revno=revno,
407
indent=' '*merge_depth, merged=True, delta=None)
409
def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
410
"""Show a revision, either merged or not."""
411
from bzrlib.osutils import format_date
412
to_file = self.to_file
413
print >>to_file, indent+'-' * 60
414
if revno is not None:
415
print >>to_file, indent+'revno:', revno
417
print >>to_file, indent+'merged:', rev.revision_id
419
print >>to_file, indent+'revision-id:', rev.revision_id
421
for parent_id in rev.parent_ids:
422
print >>to_file, indent+'parent:', parent_id
423
print >>to_file, indent+'committer:', rev.committer
425
print >>to_file, indent+'branch nick: %s' % \
426
rev.properties['branch-nick']
429
date_str = format_date(rev.timestamp,
432
print >>to_file, indent+'timestamp: %s' % date_str
434
print >>to_file, indent+'message:'
436
print >>to_file, indent+' (no message)'
438
message = rev.message.rstrip('\r\n')
439
for l in message.split('\n'):
440
print >>to_file, indent+' ' + l
441
if delta is not None:
442
delta.show(to_file, self.show_ids)
445
class ShortLogFormatter(LogFormatter):
446
def show(self, revno, rev, delta):
447
from bzrlib.osutils import format_date
449
to_file = self.to_file
450
date_str = format_date(rev.timestamp, rev.timezone or 0,
452
print >>to_file, "%5s %s\t%s" % (revno, self.short_committer(rev),
453
format_date(rev.timestamp, rev.timezone or 0,
454
self.show_timezone, date_fmt="%Y-%m-%d",
457
print >>to_file, ' revision-id:', rev.revision_id
459
print >>to_file, ' (no message)'
461
message = rev.message.rstrip('\r\n')
462
for l in message.split('\n'):
463
print >>to_file, ' ' + l
465
# TODO: Why not show the modified files in a shorter form as
466
# well? rewrap them single lines of appropriate length
467
if delta is not None:
468
delta.show(to_file, self.show_ids)
472
class LineLogFormatter(LogFormatter):
473
def truncate(self, str, max_len):
474
if len(str) <= max_len:
476
return str[:max_len-3]+'...'
478
def date_string(self, rev):
479
from bzrlib.osutils import format_date
480
return format_date(rev.timestamp, rev.timezone or 0,
481
self.show_timezone, date_fmt="%Y-%m-%d",
484
def message(self, rev):
486
return '(no message)'
490
def show(self, revno, rev, delta):
491
from bzrlib.osutils import terminal_width
492
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
494
def log_string(self, revno, rev, max_chars):
495
"""Format log info into one string. Truncate tail of string
496
:param revno: revision number (int) or None.
497
Revision numbers counts from 1.
498
:param rev: revision info object
499
:param max_chars: maximum length of resulting string
500
:return: formatted truncated string
504
# show revno only when is not None
505
out.append("%s:" % revno)
506
out.append(self.truncate(self.short_committer(rev), 20))
507
out.append(self.date_string(rev))
508
out.append(rev.get_summary())
509
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
512
def line_log(rev, max_chars):
513
lf = LineLogFormatter(None)
514
return lf.log_string(None, rev, max_chars)
517
class LogFormatterRegistry(registry.Registry):
518
"""Registry for log formatters"""
520
def make_formatter(self, name, *args, **kwargs):
521
"""Construct a formatter from arguments.
523
:param name: Name of the formatter to construct. 'short', 'long' and
526
return self.get(name)(*args, **kwargs)
528
def get_default(self, branch):
529
return self.get(branch.get_config().log_format())
532
log_formatter_registry = LogFormatterRegistry()
535
log_formatter_registry.register('short', ShortLogFormatter,
536
'Moderately short log format')
537
log_formatter_registry.register('long', LongLogFormatter,
538
'Detailed log format')
539
log_formatter_registry.register('line', LineLogFormatter,
540
'Log format with one line per revision')
543
def register_formatter(name, formatter):
544
log_formatter_registry.register(name, formatter)
547
def log_formatter(name, *args, **kwargs):
548
"""Construct a formatter from arguments.
550
name -- Name of the formatter to construct; currently 'long', 'short' and
551
'line' are supported.
553
from bzrlib.errors import BzrCommandError
555
return log_formatter_registry.make_formatter(name, *args, **kwargs)
557
raise BzrCommandError("unknown log formatter: %r" % name)
560
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
561
# deprecated; for compatibility
562
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
563
lf.show(revno, rev, delta)
565
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
566
"""Show the change in revision history comparing the old revision history to the new one.
568
:param branch: The branch where the revisions exist
569
:param old_rh: The old revision history
570
:param new_rh: The new revision history
571
:param to_file: A file to write the results to. If None, stdout will be used
577
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
578
lf = log_formatter(log_format,
581
show_timezone='original')
583
# This is the first index which is different between
586
for i in xrange(max(len(new_rh),
590
or new_rh[i] != old_rh[i]):
595
to_file.write('Nothing seems to have changed\n')
597
## TODO: It might be nice to do something like show_log
598
## and show the merged entries. But since this is the
599
## removed revisions, it shouldn't be as important
600
if base_idx < len(old_rh):
601
to_file.write('*'*60)
602
to_file.write('\nRemoved Revisions:\n')
603
for i in range(base_idx, len(old_rh)):
604
rev = branch.repository.get_revision(old_rh[i])
605
lf.show(i+1, rev, None)
606
to_file.write('*'*60)
607
to_file.write('\n\n')
608
if base_idx < len(new_rh):
609
to_file.write('Added Revisions:\n')
615
start_revision=base_idx+1,
616
end_revision=len(new_rh),
added
removed
bzrlib/log.py
