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
55
import bzrlib.errors as errors
56
from bzrlib.tree import EmptyTree
57
from bzrlib.delta import compare_trees
58
from bzrlib.trace import mutter
62
def find_touching_revisions(branch, file_id):
63
"""Yield a description of revisions which affect the file_id.
65
Each returned element is (revno, revision_id, description)
67
This is the list of revisions where the file is either added,
68
modified, renamed or deleted.
70
TODO: Perhaps some way to limit this to only particular revisions,
71
or to traverse a non-mainline set of revisions?
76
for revision_id in branch.revision_history():
77
this_inv = branch.get_revision_inventory(revision_id)
78
if file_id in this_inv:
79
this_ie = this_inv[file_id]
80
this_path = this_inv.id2path(file_id)
82
this_ie = this_path = None
84
# now we know how it was last time, and how it is in this revision.
85
# are those two states effectively the same or not?
87
if not this_ie and not last_ie:
88
# not present in either
90
elif this_ie and not last_ie:
91
yield revno, revision_id, "added " + this_path
92
elif not this_ie and last_ie:
94
yield revno, revision_id, "deleted " + last_path
95
elif this_path != last_path:
96
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
97
elif (this_ie.text_size != last_ie.text_size
98
or this_ie.text_sha1 != last_ie.text_sha1):
99
yield revno, revision_id, "modified " + this_path
102
last_path = this_path
107
def _enumerate_history(branch):
110
for rev_id in branch.revision_history():
111
rh.append((revno, rev_id))
116
def _get_revision_delta(branch, revno):
117
"""Return the delta for a mainline revision.
119
This is used to show summaries in verbose logs, and also for finding
120
revisions which touch a given file."""
121
# XXX: What are we supposed to do when showing a summary for something
122
# other than a mainline revision. The delta to it's first parent, or
123
# (more useful) the delta to a nominated other revision.
124
return branch.get_revision_delta(revno)
129
specific_fileid=None,
135
"""Write out human-readable log of commits to this branch.
138
LogFormatter object to show the output.
141
If true, list only the commits affecting the specified
142
file, rather than all commits.
145
If true show added/changed/deleted/renamed files.
148
'reverse' (default) is latest to earliest;
149
'forward' is earliest to latest.
152
If not None, only show revisions >= start_revision
155
If not None, only show revisions <= end_revision
159
_show_log(branch, lf, specific_fileid, verbose, direction,
160
start_revision, end_revision, search)
164
def _show_log(branch,
166
specific_fileid=None,
172
"""Worker function for show_log - see show_log."""
173
from bzrlib.osutils import format_date
174
from bzrlib.errors import BzrCheckError
175
from bzrlib.textui import show_status
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)]
206
if direction == 'reverse':
208
elif direction == 'forward':
211
raise ValueError('invalid direction %r' % direction)
213
revision_history = branch.revision_history()
214
for revno, rev_id in cut_revs:
215
if verbose or specific_fileid:
216
delta = _get_revision_delta(branch, revno)
219
if not delta.touches_file_id(specific_fileid):
223
# although we calculated it, throw it away without display
226
rev = branch.get_revision(rev_id)
229
if not searchRE.search(rev.message):
232
lf.show(revno, rev, delta)
233
if hasattr(lf, 'show_merge'):
237
# revno is 1 based, so -2 to get back 1 less.
238
excludes = set(branch.get_ancestry(revision_history[revno - 2]))
239
pending = list(rev.parent_ids)
241
rev_id = pending.pop()
242
if rev_id in excludes:
244
# prevent showing merged revs twice if they multi-path.
247
rev = branch.get_revision(rev_id)
248
except errors.NoSuchRevision:
250
pending.extend(rev.parent_ids)
254
def deltas_for_log_dummy(branch, which_revs):
255
"""Return all the revisions without intermediate deltas.
257
Useful for log commands that won't need the delta information.
260
for revno, revision_id in which_revs:
261
yield revno, branch.get_revision(revision_id), None
264
def deltas_for_log_reverse(branch, which_revs):
265
"""Compute deltas for display in latest-to-earliest order.
271
Sequence of (revno, revision_id) for the subset of history to examine
274
Sequence of (revno, rev, delta)
276
The delta is from the given revision to the next one in the
277
sequence, which makes sense if the log is being displayed from
280
last_revno = last_revision_id = last_tree = None
281
for revno, revision_id in which_revs:
282
this_tree = branch.revision_tree(revision_id)
283
this_revision = branch.get_revision(revision_id)
286
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
288
this_tree = EmptyTree(branch.get_root_id())
291
last_revision = this_revision
292
last_tree = this_tree
296
this_tree = EmptyTree(branch.get_root_id())
298
this_revno = last_revno - 1
299
this_revision_id = branch.revision_history()[this_revno]
300
this_tree = branch.revision_tree(this_revision_id)
301
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
304
def deltas_for_log_forward(branch, which_revs):
305
"""Compute deltas for display in forward log.
307
Given a sequence of (revno, revision_id) pairs, return
310
The delta is from the given revision to the next one in the
311
sequence, which makes sense if the log is being displayed from
314
last_revno = last_revision_id = last_tree = None
315
prev_tree = EmptyTree(branch.get_root_id())
317
for revno, revision_id in which_revs:
318
this_tree = branch.revision_tree(revision_id)
319
this_revision = branch.get_revision(revision_id)
323
last_tree = EmptyTree(branch.get_root_id())
325
last_revno = revno - 1
326
last_revision_id = branch.revision_history()[last_revno]
327
last_tree = branch.revision_tree(last_revision_id)
329
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
332
last_revision = this_revision
333
last_tree = this_tree
336
class LogFormatter(object):
337
"""Abstract class to display log messages."""
338
def __init__(self, to_file, show_ids=False, show_timezone='original'):
339
self.to_file = to_file
340
self.show_ids = show_ids
341
self.show_timezone = show_timezone
344
def show(self, revno, rev, delta):
345
raise NotImplementedError('not implemented in abstract base')
347
def short_committer(self, rev):
348
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
351
class LongLogFormatter(LogFormatter):
352
def show(self, revno, rev, delta):
353
return self._show_helper(revno=revno, rev=rev, delta=delta)
355
def show_merge(self, rev):
356
return self._show_helper(rev=rev, indent=' ', merged=True, delta=None)
358
def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
359
"""Show a revision, either merged or not."""
360
from bzrlib.osutils import format_date
361
to_file = self.to_file
362
print >>to_file, indent+'-' * 60
363
if revno is not None:
364
print >>to_file, 'revno:', revno
366
print >>to_file, indent+'merged:', rev.revision_id
368
print >>to_file, indent+'revision-id:', rev.revision_id
370
for parent_id in rev.parent_ids:
371
print >>to_file, indent+'parent:', parent_id
372
print >>to_file, indent+'committer:', rev.committer
374
print >>to_file, indent+'branch nick: %s' % \
375
rev.properties['branch-nick']
378
date_str = format_date(rev.timestamp,
381
print >>to_file, indent+'timestamp: %s' % date_str
383
print >>to_file, indent+'message:'
385
print >>to_file, indent+' (no message)'
387
message = rev.message.rstrip('\r\n')
388
for l in message.split('\n'):
389
print >>to_file, indent+' ' + l
391
delta.show(to_file, self.show_ids)
394
class ShortLogFormatter(LogFormatter):
395
def show(self, revno, rev, delta):
396
from bzrlib.osutils import format_date
398
to_file = self.to_file
399
date_str = format_date(rev.timestamp, rev.timezone or 0,
401
print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
402
format_date(rev.timestamp, rev.timezone or 0,
403
self.show_timezone, date_fmt="%Y-%m-%d",
406
print >>to_file, ' revision-id:', rev.revision_id
408
print >>to_file, ' (no message)'
410
message = rev.message.rstrip('\r\n')
411
for l in message.split('\n'):
412
print >>to_file, ' ' + l
414
# TODO: Why not show the modified files in a shorter form as
415
# well? rewrap them single lines of appropriate length
417
delta.show(to_file, self.show_ids)
420
class LineLogFormatter(LogFormatter):
421
def truncate(self, str, max_len):
422
if len(str) <= max_len:
424
return str[:max_len-3]+'...'
426
def date_string(self, rev):
427
from bzrlib.osutils import format_date
428
return format_date(rev.timestamp, rev.timezone or 0,
429
self.show_timezone, date_fmt="%Y-%m-%d",
432
def message(self, rev):
434
return '(no message)'
438
def show(self, revno, rev, delta):
439
print >> self.to_file, self.log_string(rev, 79)
441
def log_string(self, rev, max_chars):
442
out = [self.truncate(self.short_committer(rev), 20)]
443
out.append(self.date_string(rev))
444
out.append(self.message(rev).replace('\n', ' '))
445
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
447
def line_log(rev, max_chars):
448
lf = LineLogFormatter(None)
449
return lf.log_string(rev, max_chars)
451
FORMATTERS = {'long': LongLogFormatter,
452
'short': ShortLogFormatter,
453
'line': LineLogFormatter,
457
def log_formatter(name, *args, **kwargs):
458
"""Construct a formatter from arguments.
460
name -- Name of the formatter to construct; currently 'long', 'short' and
461
'line' are supported.
463
from bzrlib.errors import BzrCommandError
465
return FORMATTERS[name](*args, **kwargs)
467
raise BzrCommandError("unknown log formatter: %r" % name)
469
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
470
# deprecated; for compatability
471
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
472
lf.show(revno, rev, delta)
474
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
475
"""Show the change in revision history comparing the old revision history to the new one.
477
:param branch: The branch where the revisions exist
478
:param old_rh: The old revision history
479
:param new_rh: The new revision history
480
:param to_file: A file to write the results to. If None, stdout will be used
486
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
487
lf = log_formatter(log_format,
490
show_timezone='original')
492
# This is the first index which is different between
495
for i in xrange(max(len(new_rh),
499
or new_rh[i] != old_rh[i]):
504
to_file.write('Nothing seems to have changed\n')
506
## TODO: It might be nice to do something like show_log
507
## and show the merged entries. But since this is the
508
## removed revisions, it shouldn't be as important
509
if base_idx < len(old_rh):
510
to_file.write('*'*60)
511
to_file.write('\nRemoved Revisions:\n')
512
for i in range(base_idx, len(old_rh)):
513
rev = branch.get_revision(old_rh[i])
514
lf.show(i+1, rev, None)
515
to_file.write('*'*60)
516
to_file.write('\n\n')
517
if base_idx < len(new_rh):
518
to_file.write('Added Revisions:\n')
524
start_revision=base_idx+1,
525
end_revision=len(new_rh),
added
removed
bzrlib/log.py
