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
from bzrlib import symbol_versioning
58
import bzrlib.errors as errors
59
from bzrlib.symbol_versioning import deprecated_method, zero_eleven
60
from bzrlib.trace import mutter
61
from bzrlib.tsort import merge_sort
64
def find_touching_revisions(branch, file_id):
65
"""Yield a description of revisions which affect the file_id.
67
Each returned element is (revno, revision_id, description)
69
This is the list of revisions where the file is either added,
70
modified, renamed or deleted.
72
TODO: Perhaps some way to limit this to only particular revisions,
73
or to traverse a non-mainline set of revisions?
78
for revision_id in branch.revision_history():
79
this_inv = branch.repository.get_revision_inventory(revision_id)
80
if file_id in this_inv:
81
this_ie = this_inv[file_id]
82
this_path = this_inv.id2path(file_id)
84
this_ie = this_path = None
86
# now we know how it was last time, and how it is in this revision.
87
# are those two states effectively the same or not?
89
if not this_ie and not last_ie:
90
# not present in either
92
elif this_ie and not last_ie:
93
yield revno, revision_id, "added " + this_path
94
elif not this_ie and last_ie:
96
yield revno, revision_id, "deleted " + last_path
97
elif this_path != last_path:
98
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
99
elif (this_ie.text_size != last_ie.text_size
100
or this_ie.text_sha1 != last_ie.text_sha1):
101
yield revno, revision_id, "modified " + this_path
104
last_path = this_path
109
def _enumerate_history(branch):
112
for rev_id in branch.revision_history():
113
rh.append((revno, rev_id))
120
specific_fileid=None,
126
"""Write out human-readable log of commits to this branch.
129
LogFormatter object to show the output.
132
If true, list only the commits affecting the specified
133
file, rather than all commits.
136
If true show added/changed/deleted/renamed files.
139
'reverse' (default) is latest to earliest;
140
'forward' is earliest to latest.
143
If not None, only show revisions >= start_revision
146
If not None, only show revisions <= end_revision
150
_show_log(branch, lf, specific_fileid, verbose, direction,
151
start_revision, end_revision, search)
155
def _show_log(branch,
157
specific_fileid=None,
163
"""Worker function for show_log - see show_log."""
164
from bzrlib.osutils import format_date
165
from bzrlib.errors import BzrCheckError
167
from warnings import warn
169
if not isinstance(lf, LogFormatter):
170
warn("not a LogFormatter instance: %r" % lf)
173
mutter('get log for file_id %r', specific_fileid)
175
if search is not None:
177
searchRE = re.compile(search, re.IGNORECASE)
181
which_revs = _enumerate_history(branch)
183
if start_revision is None:
186
branch.check_real_revno(start_revision)
188
if end_revision is None:
189
end_revision = len(which_revs)
191
branch.check_real_revno(end_revision)
193
# list indexes are 0-based; revisions are 1-based
194
cut_revs = which_revs[(start_revision-1):(end_revision)]
198
# convert the revision history to a dictionary:
199
rev_nos = dict((k, v) for v, k in cut_revs)
201
# override the mainline to look like the revision history.
202
mainline_revs = [revision_id for index, revision_id in cut_revs]
203
if cut_revs[0][0] == 1:
204
mainline_revs.insert(0, None)
206
mainline_revs.insert(0, which_revs[start_revision-2][1])
207
# how should we show merged revisions ?
208
# old api: show_merge. New api: show_merge_revno
209
show_merge_revno = getattr(lf, 'show_merge_revno', None)
210
show_merge = getattr(lf, 'show_merge', None)
211
if show_merge is None and show_merge_revno is None:
212
# no merged-revno support
213
include_merges = False
215
include_merges = True
216
if show_merge is not None and show_merge_revno is None:
217
# tell developers to update their code
218
symbol_versioning.warn('LogFormatters should provide show_merge_revno '
219
'instead of show_merge since bzr 0.11.',
220
DeprecationWarning, stacklevel=3)
221
view_revisions = list(get_view_revisions(mainline_revs, rev_nos, branch,
222
direction, include_merges=include_merges))
224
def iter_revisions():
225
# r = revision, n = revno, d = merge depth
226
revision_ids = [r for r, n, d in view_revisions]
227
zeros = set(r for r, n, d in view_revisions if d == 0)
229
repository = branch.repository
232
revisions = repository.get_revisions(revision_ids[:num])
233
if verbose or specific_fileid:
234
delta_revisions = [r for r in revisions if
235
r.revision_id in zeros]
236
deltas = repository.get_deltas_for_revisions(delta_revisions)
237
cur_deltas = dict(izip((r.revision_id for r in
238
delta_revisions), deltas))
239
for revision in revisions:
240
# The delta value will be None unless
241
# 1. verbose or specific_fileid is specified, and
242
# 2. the revision is a mainline revision
243
yield revision, cur_deltas.get(revision.revision_id)
244
revision_ids = revision_ids[num:]
247
# now we just print all the revisions
248
for ((rev_id, revno, merge_depth), (rev, delta)) in \
249
izip(view_revisions, iter_revisions()):
252
if not searchRE.search(rev.message):
256
# a mainline revision.
259
if not delta.touches_file_id(specific_fileid):
263
# although we calculated it, throw it away without display
266
lf.show(revno, rev, delta)
268
if show_merge_revno is None:
269
lf.show_merge(rev, merge_depth)
271
lf.show_merge_revno(rev, merge_depth, revno)
274
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
275
include_merges=True):
276
"""Produce an iterator of revisions to show
277
:return: an iterator of (revision_id, revno, merge_depth)
278
(if there is no revno for a revision, None is supplied)
280
if include_merges is False:
281
revision_ids = mainline_revs[1:]
282
if direction == 'reverse':
283
revision_ids.reverse()
284
for revision_id in revision_ids:
285
yield revision_id, str(rev_nos[revision_id]), 0
287
merge_sorted_revisions = merge_sort(
288
branch.repository.get_revision_graph(mainline_revs[-1]),
293
if direction == 'forward':
294
# forward means oldest first.
295
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
296
elif direction != 'reverse':
297
raise ValueError('invalid direction %r' % direction)
299
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
300
yield rev_id, '.'.join(map(str, revno)), merge_depth
303
def reverse_by_depth(merge_sorted_revisions, _depth=0):
304
"""Reverse revisions by depth.
306
Revisions with a different depth are sorted as a group with the previous
307
revision of that depth. There may be no topological justification for this,
308
but it looks much nicer.
311
for val in merge_sorted_revisions:
313
zd_revisions.append([val])
315
assert val[2] > _depth
316
zd_revisions[-1].append(val)
317
for revisions in zd_revisions:
318
if len(revisions) > 1:
319
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
320
zd_revisions.reverse()
322
for chunk in zd_revisions:
327
class LogFormatter(object):
328
"""Abstract class to display log messages."""
330
def __init__(self, to_file, show_ids=False, show_timezone='original'):
331
self.to_file = to_file
332
self.show_ids = show_ids
333
self.show_timezone = show_timezone
335
def show(self, revno, rev, delta):
336
raise NotImplementedError('not implemented in abstract base')
338
def short_committer(self, rev):
339
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
342
class LongLogFormatter(LogFormatter):
343
def show(self, revno, rev, delta):
344
return self._show_helper(revno=revno, rev=rev, delta=delta)
346
@deprecated_method(zero_eleven)
347
def show_merge(self, rev, merge_depth):
348
return self._show_helper(rev=rev, indent=' '*merge_depth, merged=True, delta=None)
350
def show_merge_revno(self, rev, merge_depth, revno):
351
"""Show a merged revision rev, with merge_depth and a revno."""
352
return self._show_helper(rev=rev, revno=revno,
353
indent=' '*merge_depth, merged=True, delta=None)
355
def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
356
"""Show a revision, either merged or not."""
357
from bzrlib.osutils import format_date
358
to_file = self.to_file
359
print >>to_file, indent+'-' * 60
360
if revno is not None:
361
print >>to_file, indent+'revno:', revno
363
print >>to_file, indent+'merged:', rev.revision_id
365
print >>to_file, indent+'revision-id:', rev.revision_id
367
for parent_id in rev.parent_ids:
368
print >>to_file, indent+'parent:', parent_id
369
print >>to_file, indent+'committer:', rev.committer
371
print >>to_file, indent+'branch nick: %s' % \
372
rev.properties['branch-nick']
375
date_str = format_date(rev.timestamp,
378
print >>to_file, indent+'timestamp: %s' % date_str
380
print >>to_file, indent+'message:'
382
print >>to_file, indent+' (no message)'
384
message = rev.message.rstrip('\r\n')
385
for l in message.split('\n'):
386
print >>to_file, indent+' ' + l
387
if delta is not None:
388
delta.show(to_file, self.show_ids)
391
class ShortLogFormatter(LogFormatter):
392
def show(self, revno, rev, delta):
393
from bzrlib.osutils import format_date
395
to_file = self.to_file
396
date_str = format_date(rev.timestamp, rev.timezone or 0,
398
print >>to_file, "%5s %s\t%s" % (revno, self.short_committer(rev),
399
format_date(rev.timestamp, rev.timezone or 0,
400
self.show_timezone, date_fmt="%Y-%m-%d",
403
print >>to_file, ' revision-id:', rev.revision_id
405
print >>to_file, ' (no message)'
407
message = rev.message.rstrip('\r\n')
408
for l in message.split('\n'):
409
print >>to_file, ' ' + l
411
# TODO: Why not show the modified files in a shorter form as
412
# well? rewrap them single lines of appropriate length
413
if delta is not None:
414
delta.show(to_file, self.show_ids)
418
class LineLogFormatter(LogFormatter):
419
def truncate(self, str, max_len):
420
if len(str) <= max_len:
422
return str[:max_len-3]+'...'
424
def date_string(self, rev):
425
from bzrlib.osutils import format_date
426
return format_date(rev.timestamp, rev.timezone or 0,
427
self.show_timezone, date_fmt="%Y-%m-%d",
430
def message(self, rev):
432
return '(no message)'
436
def show(self, revno, rev, delta):
437
from bzrlib.osutils import terminal_width
438
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
440
def log_string(self, revno, rev, max_chars):
441
"""Format log info into one string. Truncate tail of string
442
:param revno: revision number (int) or None.
443
Revision numbers counts from 1.
444
:param rev: revision info object
445
:param max_chars: maximum length of resulting string
446
:return: formatted truncated string
450
# show revno only when is not None
451
out.append("%s:" % revno)
452
out.append(self.truncate(self.short_committer(rev), 20))
453
out.append(self.date_string(rev))
454
out.append(rev.get_summary())
455
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
458
def line_log(rev, max_chars):
459
lf = LineLogFormatter(None)
460
return lf.log_string(None, rev, max_chars)
463
'long': LongLogFormatter,
464
'short': ShortLogFormatter,
465
'line': LineLogFormatter,
468
def register_formatter(name, formatter):
469
FORMATTERS[name] = formatter
471
def log_formatter(name, *args, **kwargs):
472
"""Construct a formatter from arguments.
474
name -- Name of the formatter to construct; currently 'long', 'short' and
475
'line' are supported.
477
from bzrlib.errors import BzrCommandError
479
return FORMATTERS[name](*args, **kwargs)
481
raise BzrCommandError("unknown log formatter: %r" % name)
483
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
484
# deprecated; for compatibility
485
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
486
lf.show(revno, rev, delta)
488
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
489
"""Show the change in revision history comparing the old revision history to the new one.
491
:param branch: The branch where the revisions exist
492
:param old_rh: The old revision history
493
:param new_rh: The new revision history
494
:param to_file: A file to write the results to. If None, stdout will be used
500
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
501
lf = log_formatter(log_format,
504
show_timezone='original')
506
# This is the first index which is different between
509
for i in xrange(max(len(new_rh),
513
or new_rh[i] != old_rh[i]):
518
to_file.write('Nothing seems to have changed\n')
520
## TODO: It might be nice to do something like show_log
521
## and show the merged entries. But since this is the
522
## removed revisions, it shouldn't be as important
523
if base_idx < len(old_rh):
524
to_file.write('*'*60)
525
to_file.write('\nRemoved Revisions:\n')
526
for i in range(base_idx, len(old_rh)):
527
rev = branch.repository.get_revision(old_rh[i])
528
lf.show(i+1, rev, None)
529
to_file.write('*'*60)
530
to_file.write('\n\n')
531
if base_idx < len(new_rh):
532
to_file.write('Added Revisions:\n')
538
start_revision=base_idx+1,
539
end_revision=len(new_rh),
added
removed
bzrlib/log.py
