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.
52
# TODO: option to show delta summaries for merged-in revisions
54
from itertools import izip
57
import bzrlib.errors as errors
58
from bzrlib.trace import mutter
59
from bzrlib.tsort import merge_sort
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.repository.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))
118
specific_fileid=None,
124
"""Write out human-readable log of commits to this branch.
127
LogFormatter object to show the output.
130
If true, list only the commits affecting the specified
131
file, rather than all commits.
134
If true show added/changed/deleted/renamed files.
137
'reverse' (default) is latest to earliest;
138
'forward' is earliest to latest.
141
If not None, only show revisions >= start_revision
144
If not None, only show revisions <= end_revision
148
_show_log(branch, lf, specific_fileid, verbose, direction,
149
start_revision, end_revision, search)
153
def _show_log(branch,
155
specific_fileid=None,
161
"""Worker function for show_log - see show_log."""
162
from bzrlib.osutils import format_date
163
from bzrlib.errors import BzrCheckError
164
from bzrlib.textui import show_status
166
from warnings import warn
168
if not isinstance(lf, LogFormatter):
169
warn("not a LogFormatter instance: %r" % lf)
172
mutter('get log for file_id %r', specific_fileid)
174
if search is not None:
176
searchRE = re.compile(search, re.IGNORECASE)
180
which_revs = _enumerate_history(branch)
182
if start_revision is None:
185
branch.check_real_revno(start_revision)
187
if end_revision is None:
188
end_revision = len(which_revs)
190
branch.check_real_revno(end_revision)
192
# list indexes are 0-based; revisions are 1-based
193
cut_revs = which_revs[(start_revision-1):(end_revision)]
197
# convert the revision history to a dictionary:
198
rev_nos = dict((k, v) for v, k in cut_revs)
200
# override the mainline to look like the revision history.
201
mainline_revs = [revision_id for index, revision_id in cut_revs]
202
if cut_revs[0][0] == 1:
203
mainline_revs.insert(0, None)
205
mainline_revs.insert(0, which_revs[start_revision-2][1])
206
if getattr(lf, 'show_merge', None) is not None:
207
include_merges = True
209
include_merges = False
210
view_revisions = list(get_view_revisions(mainline_revs, rev_nos, branch,
211
direction, include_merges=include_merges))
213
def iter_revisions():
214
# r = revision, n = revno, d = merge depth
215
revision_ids = [r for r, n, d in view_revisions]
216
zeros = set(r for r, n, d in view_revisions if d == 0)
218
repository = branch.repository
221
revisions = repository.get_revisions(revision_ids[:num])
222
if verbose or specific_fileid:
223
delta_revisions = [r for r in revisions if
224
r.revision_id in zeros]
225
deltas = repository.get_deltas_for_revisions(delta_revisions)
226
cur_deltas = dict(izip((r.revision_id for r in
227
delta_revisions), deltas))
228
for revision in revisions:
229
# The delta value will be None unless
230
# 1. verbose or specific_fileid is specified, and
231
# 2. the revision is a mainline revision
232
yield revision, cur_deltas.get(revision.revision_id)
233
revision_ids = revision_ids[num:]
236
# now we just print all the revisions
237
for ((rev_id, revno, merge_depth), (rev, delta)) in \
238
izip(view_revisions, iter_revisions()):
241
if not searchRE.search(rev.message):
245
# a mainline revision.
248
if not delta.touches_file_id(specific_fileid):
252
# although we calculated it, throw it away without display
255
lf.show(revno, rev, delta)
257
lf.show_merge(rev, merge_depth)
260
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
261
include_merges=True):
262
"""Produce an iterator of revisions to show
263
:return: an iterator of (revision_id, revno, merge_depth)
264
(if there is no revno for a revision, None is supplied)
266
if include_merges is False:
267
revision_ids = mainline_revs[1:]
268
if direction == 'reverse':
269
revision_ids.reverse()
270
for revision_id in revision_ids:
271
yield revision_id, rev_nos[revision_id], 0
273
merge_sorted_revisions = merge_sort(
274
branch.repository.get_revision_graph(mainline_revs[-1]),
278
if direction == 'forward':
279
# forward means oldest first.
280
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
281
elif direction != 'reverse':
282
raise ValueError('invalid direction %r' % direction)
284
revision_history = branch.revision_history()
286
for sequence, rev_id, merge_depth, end_of_merge in merge_sorted_revisions:
287
yield rev_id, rev_nos.get(rev_id), merge_depth
290
def reverse_by_depth(merge_sorted_revisions, _depth=0):
291
"""Reverse revisions by depth.
293
Revisions with a different depth are sorted as a group with the previous
294
revision of that depth. There may be no topological justification for this,
295
but it looks much nicer.
298
for val in merge_sorted_revisions:
300
zd_revisions.append([val])
302
assert val[2] > _depth
303
zd_revisions[-1].append(val)
304
for revisions in zd_revisions:
305
if len(revisions) > 1:
306
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
307
zd_revisions.reverse()
309
for chunk in zd_revisions:
314
class LogFormatter(object):
315
"""Abstract class to display log messages."""
317
def __init__(self, to_file, show_ids=False, show_timezone='original'):
318
self.to_file = to_file
319
self.show_ids = show_ids
320
self.show_timezone = show_timezone
322
def show(self, revno, rev, delta):
323
raise NotImplementedError('not implemented in abstract base')
325
def short_committer(self, rev):
326
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
329
class LongLogFormatter(LogFormatter):
330
def show(self, revno, rev, delta):
331
return self._show_helper(revno=revno, rev=rev, delta=delta)
333
def show_merge(self, rev, merge_depth):
334
return self._show_helper(rev=rev, indent=' '*merge_depth, merged=True, delta=None)
336
def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
337
"""Show a revision, either merged or not."""
338
from bzrlib.osutils import format_date
339
to_file = self.to_file
340
print >>to_file, indent+'-' * 60
341
if revno is not None:
342
print >>to_file, 'revno:', revno
344
print >>to_file, indent+'merged:', rev.revision_id
346
print >>to_file, indent+'revision-id:', rev.revision_id
348
for parent_id in rev.parent_ids:
349
print >>to_file, indent+'parent:', parent_id
350
print >>to_file, indent+'committer:', rev.committer
352
print >>to_file, indent+'branch nick: %s' % \
353
rev.properties['branch-nick']
356
date_str = format_date(rev.timestamp,
359
print >>to_file, indent+'timestamp: %s' % date_str
361
print >>to_file, indent+'message:'
363
print >>to_file, indent+' (no message)'
365
message = rev.message.rstrip('\r\n')
366
for l in message.split('\n'):
367
print >>to_file, indent+' ' + l
369
delta.show(to_file, self.show_ids)
372
class ShortLogFormatter(LogFormatter):
373
def show(self, revno, rev, delta):
374
from bzrlib.osutils import format_date
376
to_file = self.to_file
377
date_str = format_date(rev.timestamp, rev.timezone or 0,
379
print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
380
format_date(rev.timestamp, rev.timezone or 0,
381
self.show_timezone, date_fmt="%Y-%m-%d",
384
print >>to_file, ' revision-id:', rev.revision_id
386
print >>to_file, ' (no message)'
388
message = rev.message.rstrip('\r\n')
389
for l in message.split('\n'):
390
print >>to_file, ' ' + l
392
# TODO: Why not show the modified files in a shorter form as
393
# well? rewrap them single lines of appropriate length
395
delta.show(to_file, self.show_ids)
399
class LineLogFormatter(LogFormatter):
400
def truncate(self, str, max_len):
401
if len(str) <= max_len:
403
return str[:max_len-3]+'...'
405
def date_string(self, rev):
406
from bzrlib.osutils import format_date
407
return format_date(rev.timestamp, rev.timezone or 0,
408
self.show_timezone, date_fmt="%Y-%m-%d",
411
def message(self, rev):
413
return '(no message)'
417
def show(self, revno, rev, delta):
418
from bzrlib.osutils import terminal_width
419
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
421
def log_string(self, revno, rev, max_chars):
422
"""Format log info into one string. Truncate tail of string
423
:param revno: revision number (int) or None.
424
Revision numbers counts from 1.
425
:param rev: revision info object
426
:param max_chars: maximum length of resulting string
427
:return: formatted truncated string
431
# show revno only when is not None
432
out.append("%d:" % revno)
433
out.append(self.truncate(self.short_committer(rev), 20))
434
out.append(self.date_string(rev))
435
out.append(rev.get_summary())
436
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
439
def line_log(rev, max_chars):
440
lf = LineLogFormatter(None)
441
return lf.log_string(None, rev, max_chars)
444
'long': LongLogFormatter,
445
'short': ShortLogFormatter,
446
'line': LineLogFormatter,
449
def register_formatter(name, formatter):
450
FORMATTERS[name] = formatter
452
def log_formatter(name, *args, **kwargs):
453
"""Construct a formatter from arguments.
455
name -- Name of the formatter to construct; currently 'long', 'short' and
456
'line' are supported.
458
from bzrlib.errors import BzrCommandError
460
return FORMATTERS[name](*args, **kwargs)
462
raise BzrCommandError("unknown log formatter: %r" % name)
464
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
465
# deprecated; for compatibility
466
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
467
lf.show(revno, rev, delta)
469
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
470
"""Show the change in revision history comparing the old revision history to the new one.
472
:param branch: The branch where the revisions exist
473
:param old_rh: The old revision history
474
:param new_rh: The new revision history
475
:param to_file: A file to write the results to. If None, stdout will be used
481
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
482
lf = log_formatter(log_format,
485
show_timezone='original')
487
# This is the first index which is different between
490
for i in xrange(max(len(new_rh),
494
or new_rh[i] != old_rh[i]):
499
to_file.write('Nothing seems to have changed\n')
501
## TODO: It might be nice to do something like show_log
502
## and show the merged entries. But since this is the
503
## removed revisions, it shouldn't be as important
504
if base_idx < len(old_rh):
505
to_file.write('*'*60)
506
to_file.write('\nRemoved Revisions:\n')
507
for i in range(base_idx, len(old_rh)):
508
rev = branch.repository.get_revision(old_rh[i])
509
lf.show(i+1, rev, None)
510
to_file.write('*'*60)
511
to_file.write('\n\n')
512
if base_idx < len(new_rh):
513
to_file.write('Added Revisions:\n')
519
start_revision=base_idx+1,
520
end_revision=len(new_rh),
added
removed
bzrlib/log.py
