1
# Copyright (C) 2005 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.
53
# TODO: option to show delta summaries for merged-in revisions
56
from bzrlib.delta import compare_trees
57
import bzrlib.errors as errors
58
from bzrlib.trace import mutter
59
from bzrlib.tree import EmptyTree
60
from bzrlib.tsort import merge_sort
63
def find_touching_revisions(branch, file_id):
64
"""Yield a description of revisions which affect the file_id.
66
Each returned element is (revno, revision_id, description)
68
This is the list of revisions where the file is either added,
69
modified, renamed or deleted.
71
TODO: Perhaps some way to limit this to only particular revisions,
72
or to traverse a non-mainline set of revisions?
77
for revision_id in branch.revision_history():
78
this_inv = branch.repository.get_revision_inventory(revision_id)
79
if file_id in this_inv:
80
this_ie = this_inv[file_id]
81
this_path = this_inv.id2path(file_id)
83
this_ie = this_path = None
85
# now we know how it was last time, and how it is in this revision.
86
# are those two states effectively the same or not?
88
if not this_ie and not last_ie:
89
# not present in either
91
elif this_ie and not last_ie:
92
yield revno, revision_id, "added " + this_path
93
elif not this_ie and last_ie:
95
yield revno, revision_id, "deleted " + last_path
96
elif this_path != last_path:
97
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
98
elif (this_ie.text_size != last_ie.text_size
99
or this_ie.text_sha1 != last_ie.text_sha1):
100
yield revno, revision_id, "modified " + this_path
103
last_path = this_path
108
def _enumerate_history(branch):
111
for rev_id in branch.revision_history():
112
rh.append((revno, rev_id))
117
def _get_revision_delta(branch, revno):
118
"""Return the delta for a mainline revision.
120
This is used to show summaries in verbose logs, and also for finding
121
revisions which touch a given file."""
122
# XXX: What are we supposed to do when showing a summary for something
123
# other than a mainline revision. The delta to it's first parent, or
124
# (more useful) the delta to a nominated other revision.
125
return branch.get_revision_delta(revno)
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)]
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])
214
merge_sorted_revisions = merge_sort(
215
branch.repository.get_revision_graph(mainline_revs[-1]),
219
if direction == 'reverse':
221
elif direction == 'forward':
222
# forward means oldest first.
223
merge_sorted_revisions.reverse()
225
raise ValueError('invalid direction %r' % direction)
227
revision_history = branch.revision_history()
229
# convert the revision history to a dictionary:
231
for index, rev_id in cut_revs:
232
rev_nos[rev_id] = index
234
revisions = branch.repository.get_revisions([r for s, r, m, e in
235
merge_sorted_revisions])
237
# now we just print all the revisions
238
for ((sequence, rev_id, merge_depth, end_of_merge), rev) in \
239
zip(merge_sorted_revisions, revisions):
242
if not searchRE.search(rev.message):
246
# a mainline revision.
247
if verbose or specific_fileid:
248
delta = _get_revision_delta(branch, rev_nos[rev_id])
251
if not delta.touches_file_id(specific_fileid):
255
# although we calculated it, throw it away without display
258
lf.show(rev_nos[rev_id], rev, delta)
259
elif hasattr(lf, 'show_merge'):
260
lf.show_merge(rev, merge_depth)
263
def deltas_for_log_dummy(branch, which_revs):
264
"""Return all the revisions without intermediate deltas.
266
Useful for log commands that won't need the delta information.
269
for revno, revision_id in which_revs:
270
yield revno, branch.get_revision(revision_id), None
273
def deltas_for_log_reverse(branch, which_revs):
274
"""Compute deltas for display in latest-to-earliest order.
280
Sequence of (revno, revision_id) for the subset of history to examine
283
Sequence of (revno, rev, delta)
285
The delta is from the given revision to the next one in the
286
sequence, which makes sense if the log is being displayed from
289
last_revno = last_revision_id = last_tree = None
290
for revno, revision_id in which_revs:
291
this_tree = branch.revision_tree(revision_id)
292
this_revision = branch.get_revision(revision_id)
295
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
297
this_tree = EmptyTree(branch.get_root_id())
300
last_revision = this_revision
301
last_tree = this_tree
305
this_tree = EmptyTree(branch.get_root_id())
307
this_revno = last_revno - 1
308
this_revision_id = branch.revision_history()[this_revno]
309
this_tree = branch.revision_tree(this_revision_id)
310
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
313
def deltas_for_log_forward(branch, which_revs):
314
"""Compute deltas for display in forward log.
316
Given a sequence of (revno, revision_id) pairs, return
319
The delta is from the given revision to the next one in the
320
sequence, which makes sense if the log is being displayed from
323
last_revno = last_revision_id = last_tree = None
324
prev_tree = EmptyTree(branch.get_root_id())
326
for revno, revision_id in which_revs:
327
this_tree = branch.revision_tree(revision_id)
328
this_revision = branch.get_revision(revision_id)
332
last_tree = EmptyTree(branch.get_root_id())
334
last_revno = revno - 1
335
last_revision_id = branch.revision_history()[last_revno]
336
last_tree = branch.revision_tree(last_revision_id)
338
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
341
last_revision = this_revision
342
last_tree = this_tree
345
class LogFormatter(object):
346
"""Abstract class to display log messages."""
348
def __init__(self, to_file, show_ids=False, show_timezone='original'):
349
self.to_file = to_file
350
self.show_ids = show_ids
351
self.show_timezone = show_timezone
353
def show(self, revno, rev, delta):
354
raise NotImplementedError('not implemented in abstract base')
356
def short_committer(self, rev):
357
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
360
class LongLogFormatter(LogFormatter):
361
def show(self, revno, rev, delta):
362
return self._show_helper(revno=revno, rev=rev, delta=delta)
364
def show_merge(self, rev, merge_depth):
365
return self._show_helper(rev=rev, indent=' '*merge_depth, merged=True, delta=None)
367
def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
368
"""Show a revision, either merged or not."""
369
from bzrlib.osutils import format_date
370
to_file = self.to_file
371
print >>to_file, indent+'-' * 60
372
if revno is not None:
373
print >>to_file, 'revno:', revno
375
print >>to_file, indent+'merged:', rev.revision_id
377
print >>to_file, indent+'revision-id:', rev.revision_id
379
for parent_id in rev.parent_ids:
380
print >>to_file, indent+'parent:', parent_id
381
print >>to_file, indent+'committer:', rev.committer
383
print >>to_file, indent+'branch nick: %s' % \
384
rev.properties['branch-nick']
387
date_str = format_date(rev.timestamp,
390
print >>to_file, indent+'timestamp: %s' % date_str
392
print >>to_file, indent+'message:'
394
print >>to_file, indent+' (no message)'
396
message = rev.message.rstrip('\r\n')
397
for l in message.split('\n'):
398
print >>to_file, indent+' ' + l
400
delta.show(to_file, self.show_ids)
403
class ShortLogFormatter(LogFormatter):
404
def show(self, revno, rev, delta):
405
from bzrlib.osutils import format_date
407
to_file = self.to_file
408
date_str = format_date(rev.timestamp, rev.timezone or 0,
410
print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
411
format_date(rev.timestamp, rev.timezone or 0,
412
self.show_timezone, date_fmt="%Y-%m-%d",
415
print >>to_file, ' revision-id:', rev.revision_id
417
print >>to_file, ' (no message)'
419
message = rev.message.rstrip('\r\n')
420
for l in message.split('\n'):
421
print >>to_file, ' ' + l
423
# TODO: Why not show the modified files in a shorter form as
424
# well? rewrap them single lines of appropriate length
426
delta.show(to_file, self.show_ids)
430
class LineLogFormatter(LogFormatter):
431
def truncate(self, str, max_len):
432
if len(str) <= max_len:
434
return str[:max_len-3]+'...'
436
def date_string(self, rev):
437
from bzrlib.osutils import format_date
438
return format_date(rev.timestamp, rev.timezone or 0,
439
self.show_timezone, date_fmt="%Y-%m-%d",
442
def message(self, rev):
444
return '(no message)'
448
def show(self, revno, rev, delta):
449
from bzrlib.osutils import terminal_width
450
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
452
def log_string(self, revno, rev, max_chars):
453
"""Format log info into one string. Truncate tail of string
454
:param revno: revision number (int) or None.
455
Revision numbers counts from 1.
456
:param rev: revision info object
457
:param max_chars: maximum length of resulting string
458
:return: formatted truncated string
462
# show revno only when is not None
463
out.append("%d:" % revno)
464
out.append(self.truncate(self.short_committer(rev), 20))
465
out.append(self.date_string(rev))
466
out.append(rev.get_summary())
467
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
470
def line_log(rev, max_chars):
471
lf = LineLogFormatter(None)
472
return lf.log_string(None, rev, max_chars)
475
'long': LongLogFormatter,
476
'short': ShortLogFormatter,
477
'line': LineLogFormatter,
480
def register_formatter(name, formatter):
481
FORMATTERS[name] = formatter
483
def log_formatter(name, *args, **kwargs):
484
"""Construct a formatter from arguments.
486
name -- Name of the formatter to construct; currently 'long', 'short' and
487
'line' are supported.
489
from bzrlib.errors import BzrCommandError
491
return FORMATTERS[name](*args, **kwargs)
493
raise BzrCommandError("unknown log formatter: %r" % name)
495
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
496
# deprecated; for compatibility
497
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
498
lf.show(revno, rev, delta)
500
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
501
"""Show the change in revision history comparing the old revision history to the new one.
503
:param branch: The branch where the revisions exist
504
:param old_rh: The old revision history
505
:param new_rh: The new revision history
506
:param to_file: A file to write the results to. If None, stdout will be used
512
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
513
lf = log_formatter(log_format,
516
show_timezone='original')
518
# This is the first index which is different between
521
for i in xrange(max(len(new_rh),
525
or new_rh[i] != old_rh[i]):
530
to_file.write('Nothing seems to have changed\n')
532
## TODO: It might be nice to do something like show_log
533
## and show the merged entries. But since this is the
534
## removed revisions, it shouldn't be as important
535
if base_idx < len(old_rh):
536
to_file.write('*'*60)
537
to_file.write('\nRemoved Revisions:\n')
538
for i in range(base_idx, len(old_rh)):
539
rev = branch.repository.get_revision(old_rh[i])
540
lf.show(i+1, rev, None)
541
to_file.write('*'*60)
542
to_file.write('\n\n')
543
if base_idx < len(new_rh):
544
to_file.write('Added Revisions:\n')
550
start_revision=base_idx+1,
551
end_revision=len(new_rh),
added
removed
bzrlib/log.py
