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
import bzrlib.errors as errors
54
from bzrlib.tree import EmptyTree
55
from bzrlib.delta import compare_trees
56
from bzrlib.trace import mutter
59
def find_touching_revisions(branch, file_id):
60
"""Yield a description of revisions which affect the file_id.
62
Each returned element is (revno, revision_id, description)
64
This is the list of revisions where the file is either added,
65
modified, renamed or deleted.
67
TODO: Perhaps some way to limit this to only particular revisions,
68
or to traverse a non-mainline set of revisions?
73
for revision_id in branch.revision_history():
74
this_inv = branch.get_revision_inventory(revision_id)
75
if file_id in this_inv:
76
this_ie = this_inv[file_id]
77
this_path = this_inv.id2path(file_id)
79
this_ie = this_path = None
81
# now we know how it was last time, and how it is in this revision.
82
# are those two states effectively the same or not?
84
if not this_ie and not last_ie:
85
# not present in either
87
elif this_ie and not last_ie:
88
yield revno, revision_id, "added " + this_path
89
elif not this_ie and last_ie:
91
yield revno, revision_id, "deleted " + last_path
92
elif this_path != last_path:
93
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
94
elif (this_ie.text_size != last_ie.text_size
95
or this_ie.text_sha1 != last_ie.text_sha1):
96
yield revno, revision_id, "modified " + this_path
104
def _enumerate_history(branch):
107
for rev_id in branch.revision_history():
108
rh.append((revno, rev_id))
113
def _get_revision_delta(branch, revno):
114
"""Return the delta for a mainline revision.
116
This is used to show summaries in verbose logs, and also for finding
117
revisions which touch a given file."""
118
# XXX: What are we supposed to do when showing a summary for something
119
# other than a mainline revision. The delta to it's first parent, or
120
# (more useful) the delta to a nominated other revision.
121
return branch.get_revision_delta(revno)
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
172
from bzrlib.textui import show_status
174
from warnings import warn
176
if not isinstance(lf, LogFormatter):
177
warn("not a LogFormatter instance: %r" % lf)
180
mutter('get log for file_id %r' % specific_fileid)
182
if search is not None:
184
searchRE = re.compile(search, re.IGNORECASE)
188
which_revs = _enumerate_history(branch)
190
if start_revision is None:
193
branch.check_real_revno(start_revision)
195
if end_revision is None:
196
end_revision = len(which_revs)
198
branch.check_real_revno(end_revision)
200
# list indexes are 0-based; revisions are 1-based
201
cut_revs = which_revs[(start_revision-1):(end_revision)]
203
if direction == 'reverse':
205
elif direction == 'forward':
208
raise ValueError('invalid direction %r' % direction)
210
revision_history = branch.revision_history()
211
for revno, rev_id in cut_revs:
212
if verbose or specific_fileid:
213
delta = _get_revision_delta(branch, revno)
216
if not delta.touches_file_id(specific_fileid):
220
# although we calculated it, throw it away without display
223
rev = branch.get_revision(rev_id)
226
if not searchRE.search(rev.message):
229
lf.show(revno, rev, delta)
233
# revno is 1 based, so -2 to get back 1 less.
234
excludes = set(branch.get_ancestry(revision_history[revno - 2]))
235
pending = list(rev.parent_ids)
237
rev_id = pending.pop()
238
if rev_id in excludes:
240
# prevent showing merged revs twice if they multi-path.
243
rev = branch.get_revision(rev_id)
244
except errors.NoSuchRevision:
246
pending.extend(rev.parent_ids)
250
def deltas_for_log_dummy(branch, which_revs):
251
"""Return all the revisions without intermediate deltas.
253
Useful for log commands that won't need the delta information.
256
for revno, revision_id in which_revs:
257
yield revno, branch.get_revision(revision_id), None
260
def deltas_for_log_reverse(branch, which_revs):
261
"""Compute deltas for display in latest-to-earliest order.
267
Sequence of (revno, revision_id) for the subset of history to examine
270
Sequence of (revno, rev, delta)
272
The delta is from the given revision to the next one in the
273
sequence, which makes sense if the log is being displayed from
276
last_revno = last_revision_id = last_tree = None
277
for revno, revision_id in which_revs:
278
this_tree = branch.revision_tree(revision_id)
279
this_revision = branch.get_revision(revision_id)
282
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
284
this_tree = EmptyTree(branch.get_root_id())
287
last_revision = this_revision
288
last_tree = this_tree
292
this_tree = EmptyTree(branch.get_root_id())
294
this_revno = last_revno - 1
295
this_revision_id = branch.revision_history()[this_revno]
296
this_tree = branch.revision_tree(this_revision_id)
297
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
300
def deltas_for_log_forward(branch, which_revs):
301
"""Compute deltas for display in forward log.
303
Given a sequence of (revno, revision_id) pairs, return
306
The delta is from the given revision to the next one in the
307
sequence, which makes sense if the log is being displayed from
310
last_revno = last_revision_id = last_tree = None
311
prev_tree = EmptyTree(branch.get_root_id())
313
for revno, revision_id in which_revs:
314
this_tree = branch.revision_tree(revision_id)
315
this_revision = branch.get_revision(revision_id)
319
last_tree = EmptyTree(branch.get_root_id())
321
last_revno = revno - 1
322
last_revision_id = branch.revision_history()[last_revno]
323
last_tree = branch.revision_tree(last_revision_id)
325
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
328
last_revision = this_revision
329
last_tree = this_tree
332
class LogFormatter(object):
333
"""Abstract class to display log messages."""
334
def __init__(self, to_file, show_ids=False, show_timezone='original'):
335
self.to_file = to_file
336
self.show_ids = show_ids
337
self.show_timezone = show_timezone
340
def show(self, revno, rev, delta):
341
raise NotImplementedError('not implemented in abstract base')
343
def show_merge(self, rev):
347
class LongLogFormatter(LogFormatter):
348
def show(self, revno, rev, delta):
349
from osutils import format_date
351
to_file = self.to_file
353
print >>to_file, '-' * 60
354
print >>to_file, 'revno:', revno
356
print >>to_file, 'revision-id:', rev.revision_id
358
for parent_id in rev.parent_ids:
359
print >>to_file, 'parent:', parent_id
361
print >>to_file, 'committer:', rev.committer
363
date_str = format_date(rev.timestamp,
366
print >>to_file, 'timestamp: %s' % date_str
368
print >>to_file, 'message:'
370
print >>to_file, ' (no message)'
372
for l in rev.message.split('\n'):
373
print >>to_file, ' ' + l
376
delta.show(to_file, self.show_ids)
378
def show_merge(self, rev):
379
from osutils import format_date
381
to_file = self.to_file
385
print >>to_file, indent+'-' * 60
386
print >>to_file, indent+'merged:', rev.revision_id
388
for parent_id in rev.parent_ids:
389
print >>to_file, indent+'parent:', parent_id
391
print >>to_file, indent+'committer:', rev.committer
393
date_str = format_date(rev.timestamp,
396
print >>to_file, indent+'timestamp: %s' % date_str
398
print >>to_file, indent+'message:'
400
print >>to_file, indent+' (no message)'
402
for l in rev.message.split('\n'):
403
print >>to_file, indent+' ' + l
406
class ShortLogFormatter(LogFormatter):
407
def show(self, revno, rev, delta):
408
from bzrlib.osutils import format_date
410
to_file = self.to_file
412
print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
413
format_date(rev.timestamp, rev.timezone or 0,
416
print >>to_file, ' revision-id:', rev.revision_id
418
print >>to_file, ' (no message)'
420
for l in rev.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)
431
FORMATTERS = {'long': LongLogFormatter,
432
'short': ShortLogFormatter,
436
def log_formatter(name, *args, **kwargs):
437
"""Construct a formatter from arguments.
439
name -- Name of the formatter to construct; currently 'long' and
440
'short' are supported.
442
from bzrlib.errors import BzrCommandError
444
return FORMATTERS[name](*args, **kwargs)
446
raise BzrCommandError("unknown log formatter: %r" % name)
448
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
449
# deprecated; for compatability
450
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
451
lf.show(revno, rev, delta)
added
removed
bzrlib/log.py
