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
* from last to first or (not anymore) from first to last;
32
the default is "reversed" because it shows the likely most
33
relevant and interesting information first
35
* (not yet) in XML format
39
from trace import mutter
41
def find_touching_revisions(branch, file_id):
42
"""Yield a description of revisions which affect the file_id.
44
Each returned element is (revno, revision_id, description)
46
This is the list of revisions where the file is either added,
47
modified, renamed or deleted.
49
TODO: Perhaps some way to limit this to only particular revisions,
50
or to traverse a non-mainline set of revisions?
55
for revision_id in branch.revision_history():
56
this_inv = branch.get_revision_inventory(revision_id)
57
if file_id in this_inv:
58
this_ie = this_inv[file_id]
59
this_path = this_inv.id2path(file_id)
61
this_ie = this_path = None
63
# now we know how it was last time, and how it is in this revision.
64
# are those two states effectively the same or not?
66
if not this_ie and not last_ie:
67
# not present in either
69
elif this_ie and not last_ie:
70
yield revno, revision_id, "added " + this_path
71
elif not this_ie and last_ie:
73
yield revno, revision_id, "deleted " + last_path
74
elif this_path != last_path:
75
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
76
elif (this_ie.text_size != last_ie.text_size
77
or this_ie.text_sha1 != last_ie.text_sha1):
78
yield revno, revision_id, "modified " + this_path
94
"""Write out human-readable log of commits to this branch.
97
LogFormatter object to show the output.
100
If true, list only the commits affecting the specified
101
file, rather than all commits.
104
If true show added/changed/deleted/renamed files.
107
'reverse' (default) is latest to earliest;
108
'forward' is earliest to latest.
111
If not None, only show revisions >= start_revision
114
If not None, only show revisions <= end_revision
116
from bzrlib.osutils import format_date
117
from bzrlib.errors import BzrCheckError
118
from bzrlib.textui import show_status
120
from warnings import warn
122
if not isinstance(lf, LogFormatter):
123
warn("not a LogFormatter instance: %r" % lf)
126
mutter('get log for file_id %r' % specific_fileid)
128
if search is not None:
130
searchRE = re.compile(search, re.IGNORECASE)
134
which_revs = branch.enum_history(direction)
135
which_revs = [x for x in which_revs if (
136
(start_revision is None or x[0] >= start_revision)
137
and (end_revision is None or x[0] <= end_revision))]
139
if not (verbose or specific_fileid):
140
# no need to know what changed between revisions
141
with_deltas = deltas_for_log_dummy(branch, which_revs)
142
elif direction == 'reverse':
143
with_deltas = deltas_for_log_reverse(branch, which_revs)
145
with_deltas = deltas_for_log_forward(branch, which_revs)
147
for revno, rev, delta in with_deltas:
149
if not delta.touches_file_id(specific_fileid):
153
# although we calculated it, throw it away without display
156
if searchRE is None or searchRE.search(rev.message):
157
lf.show(revno, rev, delta)
161
def deltas_for_log_dummy(branch, which_revs):
162
for revno, revision_id in which_revs:
163
yield revno, branch.get_revision(revision_id), None
166
def deltas_for_log_reverse(branch, which_revs):
167
"""Compute deltas for display in reverse log.
169
Given a sequence of (revno, revision_id) pairs, return
172
The delta is from the given revision to the next one in the
173
sequence, which makes sense if the log is being displayed from
176
from tree import EmptyTree
177
from diff import compare_trees
179
last_revno = last_revision_id = last_tree = None
180
for revno, revision_id in which_revs:
181
this_tree = branch.revision_tree(revision_id)
182
this_revision = branch.get_revision(revision_id)
185
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
187
this_tree = EmptyTree(branch.get_root_id())
190
last_revision = this_revision
191
last_tree = this_tree
195
this_tree = EmptyTree(branch.get_root_id())
197
this_revno = last_revno - 1
198
this_revision_id = branch.revision_history()[this_revno]
199
this_tree = branch.revision_tree(this_revision_id)
200
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
203
def deltas_for_log_forward(branch, which_revs):
204
"""Compute deltas for display in forward log.
206
Given a sequence of (revno, revision_id) pairs, return
209
The delta is from the given revision to the next one in the
210
sequence, which makes sense if the log is being displayed from
213
from tree import EmptyTree
214
from diff import compare_trees
216
last_revno = last_revision_id = last_tree = None
217
prev_tree = EmptyTree(branch.get_root_id())
219
for revno, revision_id in which_revs:
220
this_tree = branch.revision_tree(revision_id)
221
this_revision = branch.get_revision(revision_id)
225
last_tree = EmptyTree(branch.get_root_id())
227
last_revno = revno - 1
228
last_revision_id = branch.revision_history()[last_revno]
229
last_tree = branch.revision_tree(last_revision_id)
231
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
234
last_revision = this_revision
235
last_tree = this_tree
238
class LogFormatter(object):
239
"""Abstract class to display log messages."""
240
def __init__(self, to_file, show_ids=False, show_timezone='original'):
241
self.to_file = to_file
242
self.show_ids = show_ids
243
self.show_timezone = show_timezone
246
def show(self, revno, rev, delta):
247
raise NotImplementedError('not implemented in abstract base')
254
class LongLogFormatter(LogFormatter):
255
def show(self, revno, rev, delta):
256
from osutils import format_date
258
to_file = self.to_file
260
print >>to_file, '-' * 60
261
print >>to_file, 'revno:', revno
263
print >>to_file, 'revision-id:', rev.revision_id
264
print >>to_file, 'committer:', rev.committer
266
date_str = format_date(rev.timestamp,
269
print >>to_file, 'timestamp: %s' % date_str
271
print >>to_file, 'message:'
273
print >>to_file, ' (no message)'
275
for l in rev.message.split('\n'):
276
print >>to_file, ' ' + l
279
delta.show(to_file, self.show_ids)
283
class ShortLogFormatter(LogFormatter):
284
def show(self, revno, rev, delta):
285
from bzrlib.osutils import format_date
287
to_file = self.to_file
289
print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
290
format_date(rev.timestamp, rev.timezone or 0,
293
print >>to_file, ' revision-id:', rev.revision_id
295
print >>to_file, ' (no message)'
297
for l in rev.message.split('\n'):
298
print >>to_file, ' ' + l
301
delta.show(to_file, self.show_ids)
306
FORMATTERS = {'long': LongLogFormatter,
307
'short': ShortLogFormatter,
311
def log_formatter(name, *args, **kwargs):
312
from bzrlib.errors import BzrCommandError
315
return FORMATTERS[name](*args, **kwargs)
317
raise BzrCommandError("unknown log formatter: %r" % name)
319
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
320
# deprecated; for compatability
321
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
322
lf.show(revno, rev, delta)
added
removed
bzrlib/log.py
