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
56
from bzrlib.errors import InvalidRevisionNumber
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))
115
specific_fileid=None,
121
"""Write out human-readable log of commits to this branch.
124
LogFormatter object to show the output.
127
If true, list only the commits affecting the specified
128
file, rather than all commits.
131
If true show added/changed/deleted/renamed files.
134
'reverse' (default) is latest to earliest;
135
'forward' is earliest to latest.
138
If not None, only show revisions >= start_revision
141
If not None, only show revisions <= end_revision
143
from bzrlib.osutils import format_date
144
from bzrlib.errors import BzrCheckError
145
from bzrlib.textui import show_status
147
from warnings import warn
149
if not isinstance(lf, LogFormatter):
150
warn("not a LogFormatter instance: %r" % lf)
153
mutter('get log for file_id %r' % specific_fileid)
155
if search is not None:
157
searchRE = re.compile(search, re.IGNORECASE)
161
which_revs = _enumerate_history(branch)
163
if start_revision is None:
165
elif start_revision < 1 or start_revision >= len(which_revs):
166
raise InvalidRevisionNumber(start_revision)
168
if end_revision is None:
169
end_revision = len(which_revs)
170
elif end_revision < 1 or end_revision >= len(which_revs):
171
raise InvalidRevisionNumber(end_revision)
173
# list indexes are 0-based; revisions are 1-based
174
cut_revs = which_revs[(start_revision-1):(end_revision)]
176
if direction == 'reverse':
178
elif direction == 'forward':
181
raise ValueError('invalid direction %r' % direction)
183
for revno, rev_id in cut_revs:
184
if verbose or specific_fileid:
185
delta = branch.get_revision_delta(revno)
188
if not delta.touches_file_id(specific_fileid):
192
# although we calculated it, throw it away without display
195
rev = branch.get_revision(rev_id)
198
if not searchRE.search(rev.message):
201
lf.show(revno, rev, delta)
205
def deltas_for_log_dummy(branch, which_revs):
206
"""Return all the revisions without intermediate deltas.
208
Useful for log commands that won't need the delta information.
211
for revno, revision_id in which_revs:
212
yield revno, branch.get_revision(revision_id), None
215
def deltas_for_log_reverse(branch, which_revs):
216
"""Compute deltas for display in latest-to-earliest order.
222
Sequence of (revno, revision_id) for the subset of history to examine
225
Sequence of (revno, rev, delta)
227
The delta is from the given revision to the next one in the
228
sequence, which makes sense if the log is being displayed from
231
last_revno = last_revision_id = last_tree = None
232
for revno, revision_id in which_revs:
233
this_tree = branch.revision_tree(revision_id)
234
this_revision = branch.get_revision(revision_id)
237
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
239
this_tree = EmptyTree(branch.get_root_id())
242
last_revision = this_revision
243
last_tree = this_tree
247
this_tree = EmptyTree(branch.get_root_id())
249
this_revno = last_revno - 1
250
this_revision_id = branch.revision_history()[this_revno]
251
this_tree = branch.revision_tree(this_revision_id)
252
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
255
def deltas_for_log_forward(branch, which_revs):
256
"""Compute deltas for display in forward log.
258
Given a sequence of (revno, revision_id) pairs, return
261
The delta is from the given revision to the next one in the
262
sequence, which makes sense if the log is being displayed from
265
last_revno = last_revision_id = last_tree = None
266
prev_tree = EmptyTree(branch.get_root_id())
268
for revno, revision_id in which_revs:
269
this_tree = branch.revision_tree(revision_id)
270
this_revision = branch.get_revision(revision_id)
274
last_tree = EmptyTree(branch.get_root_id())
276
last_revno = revno - 1
277
last_revision_id = branch.revision_history()[last_revno]
278
last_tree = branch.revision_tree(last_revision_id)
280
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
283
last_revision = this_revision
284
last_tree = this_tree
287
class LogFormatter(object):
288
"""Abstract class to display log messages."""
289
def __init__(self, to_file, show_ids=False, show_timezone='original'):
290
self.to_file = to_file
291
self.show_ids = show_ids
292
self.show_timezone = show_timezone
295
def show(self, revno, rev, delta):
296
raise NotImplementedError('not implemented in abstract base')
303
class LongLogFormatter(LogFormatter):
304
def show(self, revno, rev, delta):
305
from osutils import format_date
307
to_file = self.to_file
309
print >>to_file, '-' * 60
310
print >>to_file, 'revno:', revno
312
print >>to_file, 'revision-id:', rev.revision_id
314
for parent in rev.parents:
315
print >>to_file, 'parent:', parent.revision_id
317
print >>to_file, 'committer:', rev.committer
319
date_str = format_date(rev.timestamp,
322
print >>to_file, 'timestamp: %s' % date_str
324
print >>to_file, 'message:'
326
print >>to_file, ' (no message)'
328
for l in rev.message.split('\n'):
329
print >>to_file, ' ' + l
332
delta.show(to_file, self.show_ids)
336
class ShortLogFormatter(LogFormatter):
337
def show(self, revno, rev, delta):
338
from bzrlib.osutils import format_date
340
to_file = self.to_file
342
print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
343
format_date(rev.timestamp, rev.timezone or 0,
346
print >>to_file, ' revision-id:', rev.revision_id
348
print >>to_file, ' (no message)'
350
for l in rev.message.split('\n'):
351
print >>to_file, ' ' + l
353
# TODO: Why not show the modified files in a shorter form as
354
# well? rewrap them single lines of appropriate length
356
delta.show(to_file, self.show_ids)
361
FORMATTERS = {'long': LongLogFormatter,
362
'short': ShortLogFormatter,
366
def log_formatter(name, *args, **kwargs):
367
from bzrlib.errors import BzrCommandError
370
return FORMATTERS[name](*args, **kwargs)
372
raise BzrCommandError("unknown log formatter: %r" % name)
374
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
375
# deprecated; for compatability
376
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
377
lf.show(revno, rev, delta)
added
removed
bzrlib/log.py
