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
branch.repository.lock_read()
162
_show_log(branch, lf, specific_fileid, verbose, direction,
163
start_revision, end_revision, search)
165
branch.repository.unlock()
169
def _show_log(branch,
171
specific_fileid=None,
177
"""Worker function for show_log - see show_log."""
178
from bzrlib.osutils import format_date
179
from bzrlib.errors import BzrCheckError
180
from bzrlib.textui import show_status
182
from warnings import warn
184
if not isinstance(lf, LogFormatter):
185
warn("not a LogFormatter instance: %r" % lf)
188
mutter('get log for file_id %r', specific_fileid)
190
if search is not None:
192
searchRE = re.compile(search, re.IGNORECASE)
196
which_revs = _enumerate_history(branch)
198
if start_revision is None:
201
branch.check_real_revno(start_revision)
203
if end_revision is None:
204
end_revision = len(which_revs)
206
branch.check_real_revno(end_revision)
208
# list indexes are 0-based; revisions are 1-based
209
cut_revs = which_revs[(start_revision-1):(end_revision)]
212
# override the mainline to look like the revision history.
213
mainline_revs = [revision_id for index, revision_id in cut_revs]
214
if cut_revs[0][0] == 1:
215
mainline_revs.insert(0, None)
217
mainline_revs.insert(0, which_revs[start_revision-2][1])
219
merge_sorted_revisions = merge_sort(
220
branch.repository.get_revision_graph(mainline_revs[-1]),
224
if direction == 'reverse':
226
elif direction == 'forward':
227
# forward means oldest first.
228
merge_sorted_revisions.reverse()
230
raise ValueError('invalid direction %r' % direction)
232
revision_history = branch.revision_history()
234
# convert the revision history to a dictionary:
236
for index, rev_id in cut_revs:
237
rev_nos[rev_id] = index
239
revisions = branch.repository.get_revisions([r for s, r, m, e in
240
merge_sorted_revisions])
242
# now we just print all the revisions
243
for ((sequence, rev_id, merge_depth, end_of_merge), rev) in \
244
zip(merge_sorted_revisions, revisions):
247
if not searchRE.search(rev.message):
251
# a mainline revision.
252
if verbose or specific_fileid:
253
delta = _get_revision_delta(branch, rev_nos[rev_id])
256
if not delta.touches_file_id(specific_fileid):
260
# although we calculated it, throw it away without display
263
lf.show(rev_nos[rev_id], rev, delta)
264
elif hasattr(lf, 'show_merge'):
265
lf.show_merge(rev, merge_depth)
268
def deltas_for_log_dummy(branch, which_revs):
269
"""Return all the revisions without intermediate deltas.
271
Useful for log commands that won't need the delta information.
274
for revno, revision_id in which_revs:
275
yield revno, branch.get_revision(revision_id), None
278
def deltas_for_log_reverse(branch, which_revs):
279
"""Compute deltas for display in latest-to-earliest order.
285
Sequence of (revno, revision_id) for the subset of history to examine
288
Sequence of (revno, rev, delta)
290
The delta is from the given revision to the next one in the
291
sequence, which makes sense if the log is being displayed from
294
last_revno = last_revision_id = last_tree = None
295
for revno, revision_id in which_revs:
296
this_tree = branch.revision_tree(revision_id)
297
this_revision = branch.get_revision(revision_id)
300
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
302
this_tree = EmptyTree(branch.get_root_id())
305
last_revision = this_revision
306
last_tree = this_tree
310
this_tree = EmptyTree(branch.get_root_id())
312
this_revno = last_revno - 1
313
this_revision_id = branch.revision_history()[this_revno]
314
this_tree = branch.revision_tree(this_revision_id)
315
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
318
def deltas_for_log_forward(branch, which_revs):
319
"""Compute deltas for display in forward log.
321
Given a sequence of (revno, revision_id) pairs, return
324
The delta is from the given revision to the next one in the
325
sequence, which makes sense if the log is being displayed from
328
last_revno = last_revision_id = last_tree = None
329
prev_tree = EmptyTree(branch.get_root_id())
331
for revno, revision_id in which_revs:
332
this_tree = branch.revision_tree(revision_id)
333
this_revision = branch.get_revision(revision_id)
337
last_tree = EmptyTree(branch.get_root_id())
339
last_revno = revno - 1
340
last_revision_id = branch.revision_history()[last_revno]
341
last_tree = branch.revision_tree(last_revision_id)
343
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
346
last_revision = this_revision
347
last_tree = this_tree
350
class LogFormatter(object):
351
"""Abstract class to display log messages."""
353
def __init__(self, to_file, show_ids=False, show_timezone='original'):
354
self.to_file = to_file
355
self.show_ids = show_ids
356
self.show_timezone = show_timezone
358
def show(self, revno, rev, delta):
359
raise NotImplementedError('not implemented in abstract base')
361
def short_committer(self, rev):
362
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
365
class LongLogFormatter(LogFormatter):
366
def show(self, revno, rev, delta):
367
return self._show_helper(revno=revno, rev=rev, delta=delta)
369
def show_merge(self, rev, merge_depth):
370
return self._show_helper(rev=rev, indent=' '*merge_depth, merged=True, delta=None)
372
def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
373
"""Show a revision, either merged or not."""
374
from bzrlib.osutils import format_date
375
to_file = self.to_file
376
print >>to_file, indent+'-' * 60
377
if revno is not None:
378
print >>to_file, 'revno:', revno
380
print >>to_file, indent+'merged:', rev.revision_id
382
print >>to_file, indent+'revision-id:', rev.revision_id
384
for parent_id in rev.parent_ids:
385
print >>to_file, indent+'parent:', parent_id
386
print >>to_file, indent+'committer:', rev.committer
388
print >>to_file, indent+'branch nick: %s' % \
389
rev.properties['branch-nick']
392
date_str = format_date(rev.timestamp,
395
print >>to_file, indent+'timestamp: %s' % date_str
397
print >>to_file, indent+'message:'
399
print >>to_file, indent+' (no message)'
401
message = rev.message.rstrip('\r\n')
402
for l in message.split('\n'):
403
print >>to_file, indent+' ' + l
405
delta.show(to_file, self.show_ids)
408
class ShortLogFormatter(LogFormatter):
409
def show(self, revno, rev, delta):
410
from bzrlib.osutils import format_date
412
to_file = self.to_file
413
date_str = format_date(rev.timestamp, rev.timezone or 0,
415
print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
416
format_date(rev.timestamp, rev.timezone or 0,
417
self.show_timezone, date_fmt="%Y-%m-%d",
420
print >>to_file, ' revision-id:', rev.revision_id
422
print >>to_file, ' (no message)'
424
message = rev.message.rstrip('\r\n')
425
for l in message.split('\n'):
426
print >>to_file, ' ' + l
428
# TODO: Why not show the modified files in a shorter form as
429
# well? rewrap them single lines of appropriate length
431
delta.show(to_file, self.show_ids)
435
class LineLogFormatter(LogFormatter):
436
def truncate(self, str, max_len):
437
if len(str) <= max_len:
439
return str[:max_len-3]+'...'
441
def date_string(self, rev):
442
from bzrlib.osutils import format_date
443
return format_date(rev.timestamp, rev.timezone or 0,
444
self.show_timezone, date_fmt="%Y-%m-%d",
447
def message(self, rev):
449
return '(no message)'
453
def show(self, revno, rev, delta):
454
from bzrlib.osutils import terminal_width
455
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
457
def log_string(self, revno, rev, max_chars):
458
"""Format log info into one string. Truncate tail of string
459
:param revno: revision number (int) or None.
460
Revision numbers counts from 1.
461
:param rev: revision info object
462
:param max_chars: maximum length of resulting string
463
:return: formatted truncated string
467
# show revno only when is not None
468
out.append("%d:" % revno)
469
out.append(self.truncate(self.short_committer(rev), 20))
470
out.append(self.date_string(rev))
471
out.append(rev.get_summary())
472
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
475
def line_log(rev, max_chars):
476
lf = LineLogFormatter(None)
477
return lf.log_string(None, rev, max_chars)
480
'long': LongLogFormatter,
481
'short': ShortLogFormatter,
482
'line': LineLogFormatter,
485
def register_formatter(name, formatter):
486
FORMATTERS[name] = formatter
488
def log_formatter(name, *args, **kwargs):
489
"""Construct a formatter from arguments.
491
name -- Name of the formatter to construct; currently 'long', 'short' and
492
'line' are supported.
494
from bzrlib.errors import BzrCommandError
496
return FORMATTERS[name](*args, **kwargs)
498
raise BzrCommandError("unknown log formatter: %r" % name)
500
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
501
# deprecated; for compatability
502
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
503
lf.show(revno, rev, delta)
505
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
506
"""Show the change in revision history comparing the old revision history to the new one.
508
:param branch: The branch where the revisions exist
509
:param old_rh: The old revision history
510
:param new_rh: The new revision history
511
:param to_file: A file to write the results to. If None, stdout will be used
517
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
518
lf = log_formatter(log_format,
521
show_timezone='original')
523
# This is the first index which is different between
526
for i in xrange(max(len(new_rh),
530
or new_rh[i] != old_rh[i]):
535
to_file.write('Nothing seems to have changed\n')
537
## TODO: It might be nice to do something like show_log
538
## and show the merged entries. But since this is the
539
## removed revisions, it shouldn't be as important
540
if base_idx < len(old_rh):
541
to_file.write('*'*60)
542
to_file.write('\nRemoved Revisions:\n')
543
for i in range(base_idx, len(old_rh)):
544
rev = branch.repository.get_revision(old_rh[i])
545
lf.show(i+1, rev, None)
546
to_file.write('*'*60)
547
to_file.write('\n\n')
548
if base_idx < len(new_rh):
549
to_file.write('Added Revisions:\n')
555
start_revision=base_idx+1,
556
end_revision=len(new_rh),
added
removed
bzrlib/log.py
