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
from bzrlib.tree import EmptyTree
54
from bzrlib.delta import compare_trees
55
from bzrlib.trace import mutter
58
def find_touching_revisions(branch, file_id):
59
"""Yield a description of revisions which affect the file_id.
61
Each returned element is (revno, revision_id, description)
63
This is the list of revisions where the file is either added,
64
modified, renamed or deleted.
66
TODO: Perhaps some way to limit this to only particular revisions,
67
or to traverse a non-mainline set of revisions?
72
for revision_id in branch.revision_history():
73
this_inv = branch.get_revision_inventory(revision_id)
74
if file_id in this_inv:
75
this_ie = this_inv[file_id]
76
this_path = this_inv.id2path(file_id)
78
this_ie = this_path = None
80
# now we know how it was last time, and how it is in this revision.
81
# are those two states effectively the same or not?
83
if not this_ie and not last_ie:
84
# not present in either
86
elif this_ie and not last_ie:
87
yield revno, revision_id, "added " + this_path
88
elif not this_ie and last_ie:
90
yield revno, revision_id, "deleted " + last_path
91
elif this_path != last_path:
92
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
93
elif (this_ie.text_size != last_ie.text_size
94
or this_ie.text_sha1 != last_ie.text_sha1):
95
yield revno, revision_id, "modified " + this_path
103
def _enumerate_history(branch):
106
for rev_id in branch.revision_history():
107
rh.append((revno, rev_id))
112
def _get_revision_delta(branch, revno):
113
"""Return the delta for a mainline revision.
115
This is used to show summaries in verbose logs, and also for finding
116
revisions which touch a given file."""
117
# FIXME: The current version is very inefficient; it retrieves all revisions
118
# twice and reads the weave twice. We ought to keep revisions in memory
119
# in case they're used again, either in a general cache or perhaps
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
157
from bzrlib.osutils import format_date
158
from bzrlib.errors import BzrCheckError
159
from bzrlib.textui import show_status
161
from warnings import warn
163
if not isinstance(lf, LogFormatter):
164
warn("not a LogFormatter instance: %r" % lf)
167
mutter('get log for file_id %r' % specific_fileid)
169
if search is not None:
171
searchRE = re.compile(search, re.IGNORECASE)
175
which_revs = _enumerate_history(branch)
177
if start_revision is None:
180
branch.check_real_revno(start_revision)
182
if end_revision is None:
183
end_revision = len(which_revs)
185
branch.check_real_revno(end_revision)
187
# list indexes are 0-based; revisions are 1-based
188
cut_revs = which_revs[(start_revision-1):(end_revision)]
190
if direction == 'reverse':
192
elif direction == 'forward':
195
raise ValueError('invalid direction %r' % direction)
197
for revno, rev_id in cut_revs:
198
if verbose or specific_fileid:
199
delta = _get_revision_delta(branch, revno)
202
if not delta.touches_file_id(specific_fileid):
206
# although we calculated it, throw it away without display
209
rev = branch.get_revision(rev_id)
212
if not searchRE.search(rev.message):
215
lf.show(revno, rev, delta)
219
def deltas_for_log_dummy(branch, which_revs):
220
"""Return all the revisions without intermediate deltas.
222
Useful for log commands that won't need the delta information.
225
for revno, revision_id in which_revs:
226
yield revno, branch.get_revision(revision_id), None
229
def deltas_for_log_reverse(branch, which_revs):
230
"""Compute deltas for display in latest-to-earliest order.
236
Sequence of (revno, revision_id) for the subset of history to examine
239
Sequence of (revno, rev, delta)
241
The delta is from the given revision to the next one in the
242
sequence, which makes sense if the log is being displayed from
245
last_revno = last_revision_id = last_tree = None
246
for revno, revision_id in which_revs:
247
this_tree = branch.revision_tree(revision_id)
248
this_revision = branch.get_revision(revision_id)
251
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
253
this_tree = EmptyTree(branch.get_root_id())
256
last_revision = this_revision
257
last_tree = this_tree
261
this_tree = EmptyTree(branch.get_root_id())
263
this_revno = last_revno - 1
264
this_revision_id = branch.revision_history()[this_revno]
265
this_tree = branch.revision_tree(this_revision_id)
266
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
269
def deltas_for_log_forward(branch, which_revs):
270
"""Compute deltas for display in forward log.
272
Given a sequence of (revno, revision_id) pairs, return
275
The delta is from the given revision to the next one in the
276
sequence, which makes sense if the log is being displayed from
279
last_revno = last_revision_id = last_tree = None
280
prev_tree = EmptyTree(branch.get_root_id())
282
for revno, revision_id in which_revs:
283
this_tree = branch.revision_tree(revision_id)
284
this_revision = branch.get_revision(revision_id)
288
last_tree = EmptyTree(branch.get_root_id())
290
last_revno = revno - 1
291
last_revision_id = branch.revision_history()[last_revno]
292
last_tree = branch.revision_tree(last_revision_id)
294
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
297
last_revision = this_revision
298
last_tree = this_tree
301
class LogFormatter(object):
302
"""Abstract class to display log messages."""
303
def __init__(self, to_file, show_ids=False, show_timezone='original'):
304
self.to_file = to_file
305
self.show_ids = show_ids
306
self.show_timezone = show_timezone
309
def show(self, revno, rev, delta):
310
raise NotImplementedError('not implemented in abstract base')
313
class LongLogFormatter(LogFormatter):
314
def show(self, revno, rev, delta):
315
from osutils import format_date
317
to_file = self.to_file
319
print >>to_file, '-' * 60
320
print >>to_file, 'revno:', revno
322
print >>to_file, 'revision-id:', rev.revision_id
324
for parent_id in rev.parent_ids:
325
print >>to_file, 'parent:', parent_id
327
print >>to_file, 'committer:', rev.committer
329
date_str = format_date(rev.timestamp,
332
print >>to_file, 'timestamp: %s' % date_str
334
print >>to_file, 'message:'
336
print >>to_file, ' (no message)'
338
for l in rev.message.split('\n'):
339
print >>to_file, ' ' + l
342
delta.show(to_file, self.show_ids)
346
class ShortLogFormatter(LogFormatter):
347
def show(self, revno, rev, delta):
348
from bzrlib.osutils import format_date
350
to_file = self.to_file
352
print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
353
format_date(rev.timestamp, rev.timezone or 0,
356
print >>to_file, ' revision-id:', rev.revision_id
358
print >>to_file, ' (no message)'
360
for l in rev.message.split('\n'):
361
print >>to_file, ' ' + l
363
# TODO: Why not show the modified files in a shorter form as
364
# well? rewrap them single lines of appropriate length
366
delta.show(to_file, self.show_ids)
371
FORMATTERS = {'long': LongLogFormatter,
372
'short': ShortLogFormatter,
376
def log_formatter(name, *args, **kwargs):
377
"""Construct a formatter from arguments.
379
name -- Name of the formatter to construct; currently 'long' and
380
'short' are supported.
382
from bzrlib.errors import BzrCommandError
384
return FORMATTERS[name](*args, **kwargs)
386
raise BzrCommandError("unknown log formatter: %r" % name)
388
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
389
# deprecated; for compatability
390
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
391
lf.show(revno, rev, delta)
added
removed
bzrlib/log.py
