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
61
import bzrlib.errors as errors
62
from bzrlib.symbol_versioning import deprecated_method, zero_eleven
63
from bzrlib.trace import mutter
64
from bzrlib.tsort import merge_sort
67
def find_touching_revisions(branch, file_id):
68
"""Yield a description of revisions which affect the file_id.
70
Each returned element is (revno, revision_id, description)
72
This is the list of revisions where the file is either added,
73
modified, renamed or deleted.
75
TODO: Perhaps some way to limit this to only particular revisions,
76
or to traverse a non-mainline set of revisions?
81
for revision_id in branch.revision_history():
82
this_inv = branch.repository.get_revision_inventory(revision_id)
83
if file_id in this_inv:
84
this_ie = this_inv[file_id]
85
this_path = this_inv.id2path(file_id)
87
this_ie = this_path = None
89
# now we know how it was last time, and how it is in this revision.
90
# are those two states effectively the same or not?
92
if not this_ie and not last_ie:
93
# not present in either
95
elif this_ie and not last_ie:
96
yield revno, revision_id, "added " + this_path
97
elif not this_ie and last_ie:
99
yield revno, revision_id, "deleted " + last_path
100
elif this_path != last_path:
101
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
102
elif (this_ie.text_size != last_ie.text_size
103
or this_ie.text_sha1 != last_ie.text_sha1):
104
yield revno, revision_id, "modified " + this_path
107
last_path = this_path
112
def _enumerate_history(branch):
115
for rev_id in branch.revision_history():
116
rh.append((revno, rev_id))
123
specific_fileid=None,
129
"""Write out human-readable log of commits to this branch.
132
LogFormatter object to show the output.
135
If true, list only the commits affecting the specified
136
file, rather than all commits.
139
If true show added/changed/deleted/renamed files.
142
'reverse' (default) is latest to earliest;
143
'forward' is earliest to latest.
146
If not None, only show revisions >= start_revision
149
If not None, only show revisions <= end_revision
153
_show_log(branch, lf, specific_fileid, verbose, direction,
154
start_revision, end_revision, search)
158
def _show_log(branch,
160
specific_fileid=None,
166
"""Worker function for show_log - see show_log."""
167
from bzrlib.osutils import format_date
168
from bzrlib.errors import BzrCheckError
170
from warnings import warn
172
if not isinstance(lf, LogFormatter):
173
warn("not a LogFormatter instance: %r" % lf)
176
mutter('get log for file_id %r', specific_fileid)
178
if search is not None:
180
searchRE = re.compile(search, re.IGNORECASE)
184
which_revs = _enumerate_history(branch)
186
if start_revision is None:
189
branch.check_real_revno(start_revision)
191
if end_revision is None:
192
end_revision = len(which_revs)
194
branch.check_real_revno(end_revision)
196
# list indexes are 0-based; revisions are 1-based
197
cut_revs = which_revs[(start_revision-1):(end_revision)]
201
# convert the revision history to a dictionary:
202
rev_nos = dict((k, v) for v, k in cut_revs)
204
# override the mainline to look like the revision history.
205
mainline_revs = [revision_id for index, revision_id in cut_revs]
206
if cut_revs[0][0] == 1:
207
mainline_revs.insert(0, None)
209
mainline_revs.insert(0, which_revs[start_revision-2][1])
210
# how should we show merged revisions ?
211
# old api: show_merge. New api: show_merge_revno
212
show_merge_revno = getattr(lf, 'show_merge_revno', None)
213
show_merge = getattr(lf, 'show_merge', None)
214
if show_merge is None and show_merge_revno is None:
215
# no merged-revno support
216
include_merges = False
218
include_merges = True
219
if show_merge is not None and show_merge_revno is None:
220
# tell developers to update their code
221
symbol_versioning.warn('LogFormatters should provide show_merge_revno '
222
'instead of show_merge since bzr 0.11.',
223
DeprecationWarning, stacklevel=3)
224
view_revisions = list(get_view_revisions(mainline_revs, rev_nos, branch,
225
direction, include_merges=include_merges))
227
use_tags = getattr(lf, 'supports_tags', False)
230
if branch.supports_tags():
231
rev_tag_dict = branch.tags.get_reverse_tag_dict()
233
def iter_revisions():
234
# r = revision, n = revno, d = merge depth
235
revision_ids = [r for r, n, d in view_revisions]
236
zeros = set(r for r, n, d in view_revisions if d == 0)
238
repository = branch.repository
241
revisions = repository.get_revisions(revision_ids[:num])
242
if verbose or specific_fileid:
243
delta_revisions = [r for r in revisions if
244
r.revision_id in zeros]
245
deltas = repository.get_deltas_for_revisions(delta_revisions)
246
cur_deltas = dict(izip((r.revision_id for r in
247
delta_revisions), deltas))
248
for revision in revisions:
249
# The delta value will be None unless
250
# 1. verbose or specific_fileid is specified, and
251
# 2. the revision is a mainline revision
252
yield revision, cur_deltas.get(revision.revision_id)
253
revision_ids = revision_ids[num:]
256
# now we just print all the revisions
257
for ((rev_id, revno, merge_depth), (rev, delta)) in \
258
izip(view_revisions, iter_revisions()):
261
if not searchRE.search(rev.message):
265
# a mainline revision.
268
if not delta.touches_file_id(specific_fileid):
272
# although we calculated it, throw it away without display
276
lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
278
lf.show(revno, rev, delta)
280
if show_merge_revno is None:
281
lf.show_merge(rev, merge_depth)
284
lf.show_merge_revno(rev, merge_depth, revno,
285
rev_tag_dict.get(rev_id))
287
lf.show_merge_revno(rev, merge_depth, revno)
290
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
291
include_merges=True):
292
"""Produce an iterator of revisions to show
293
:return: an iterator of (revision_id, revno, merge_depth)
294
(if there is no revno for a revision, None is supplied)
296
if include_merges is False:
297
revision_ids = mainline_revs[1:]
298
if direction == 'reverse':
299
revision_ids.reverse()
300
for revision_id in revision_ids:
301
yield revision_id, str(rev_nos[revision_id]), 0
303
merge_sorted_revisions = merge_sort(
304
branch.repository.get_revision_graph(mainline_revs[-1]),
309
if direction == 'forward':
310
# forward means oldest first.
311
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
312
elif direction != 'reverse':
313
raise ValueError('invalid direction %r' % direction)
315
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
316
yield rev_id, '.'.join(map(str, revno)), merge_depth
319
def reverse_by_depth(merge_sorted_revisions, _depth=0):
320
"""Reverse revisions by depth.
322
Revisions with a different depth are sorted as a group with the previous
323
revision of that depth. There may be no topological justification for this,
324
but it looks much nicer.
327
for val in merge_sorted_revisions:
329
zd_revisions.append([val])
331
assert val[2] > _depth
332
zd_revisions[-1].append(val)
333
for revisions in zd_revisions:
334
if len(revisions) > 1:
335
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
336
zd_revisions.reverse()
338
for chunk in zd_revisions:
343
class LogFormatter(object):
344
"""Abstract class to display log messages."""
346
def __init__(self, to_file, show_ids=False, show_timezone='original'):
347
self.to_file = to_file
348
self.show_ids = show_ids
349
self.show_timezone = show_timezone
351
def show(self, revno, rev, delta):
352
raise NotImplementedError('not implemented in abstract base')
354
def short_committer(self, rev):
355
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
358
class LongLogFormatter(LogFormatter):
360
supports_tags = True # must exist and be True
361
# if this log formatter support tags.
362
# .show() and .show_merge_revno() must then accept
363
# the 'tags'-argument with list of tags
365
def show(self, revno, rev, delta, tags=None):
366
return self._show_helper(revno=revno, rev=rev, delta=delta, tags=tags)
368
@deprecated_method(zero_eleven)
369
def show_merge(self, rev, merge_depth):
370
return self._show_helper(rev=rev, indent=' '*merge_depth,
371
merged=True, delta=None)
373
def show_merge_revno(self, rev, merge_depth, revno, tags=None):
374
"""Show a merged revision rev, with merge_depth and a revno."""
375
return self._show_helper(rev=rev, revno=revno,
376
indent=' '*merge_depth, merged=True, delta=None, tags=tags)
378
def _show_helper(self, rev=None, revno=None, indent='', merged=False,
379
delta=None, tags=None):
380
"""Show a revision, either merged or not."""
381
from bzrlib.osutils import format_date
382
to_file = self.to_file
383
print >>to_file, indent+'-' * 60
384
if revno is not None:
385
print >>to_file, indent+'revno:', revno
387
print >>to_file, indent+'tags: %s' % (', '.join(tags))
389
print >>to_file, indent+'merged:', rev.revision_id
391
print >>to_file, indent+'revision-id:', rev.revision_id
393
for parent_id in rev.parent_ids:
394
print >>to_file, indent+'parent:', parent_id
395
print >>to_file, indent+'committer:', rev.committer
398
print >>to_file, indent+'branch nick: %s' % \
399
rev.properties['branch-nick']
402
date_str = format_date(rev.timestamp,
405
print >>to_file, indent+'timestamp: %s' % date_str
407
print >>to_file, indent+'message:'
409
print >>to_file, indent+' (no message)'
411
message = rev.message.rstrip('\r\n')
412
for l in message.split('\n'):
413
print >>to_file, indent+' ' + l
414
if delta is not None:
415
delta.show(to_file, self.show_ids)
418
class ShortLogFormatter(LogFormatter):
419
def show(self, revno, rev, delta):
420
from bzrlib.osutils import format_date
422
to_file = self.to_file
423
date_str = format_date(rev.timestamp, rev.timezone or 0,
425
print >>to_file, "%5s %s\t%s" % (revno, self.short_committer(rev),
426
format_date(rev.timestamp, rev.timezone or 0,
427
self.show_timezone, date_fmt="%Y-%m-%d",
430
print >>to_file, ' revision-id:', rev.revision_id
432
print >>to_file, ' (no message)'
434
message = rev.message.rstrip('\r\n')
435
for l in message.split('\n'):
436
print >>to_file, ' ' + l
438
# TODO: Why not show the modified files in a shorter form as
439
# well? rewrap them single lines of appropriate length
440
if delta is not None:
441
delta.show(to_file, self.show_ids)
445
class LineLogFormatter(LogFormatter):
446
def truncate(self, str, max_len):
447
if len(str) <= max_len:
449
return str[:max_len-3]+'...'
451
def date_string(self, rev):
452
from bzrlib.osutils import format_date
453
return format_date(rev.timestamp, rev.timezone or 0,
454
self.show_timezone, date_fmt="%Y-%m-%d",
457
def message(self, rev):
459
return '(no message)'
463
def show(self, revno, rev, delta):
464
from bzrlib.osutils import terminal_width
465
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
467
def log_string(self, revno, rev, max_chars):
468
"""Format log info into one string. Truncate tail of string
469
:param revno: revision number (int) or None.
470
Revision numbers counts from 1.
471
:param rev: revision info object
472
:param max_chars: maximum length of resulting string
473
:return: formatted truncated string
477
# show revno only when is not None
478
out.append("%s:" % revno)
479
out.append(self.truncate(self.short_committer(rev), 20))
480
out.append(self.date_string(rev))
481
out.append(rev.get_summary())
482
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
485
def line_log(rev, max_chars):
486
lf = LineLogFormatter(None)
487
return lf.log_string(None, rev, max_chars)
490
class LogFormatterRegistry(registry.Registry):
491
"""Registry for log formatters"""
493
def make_formatter(self, name, *args, **kwargs):
494
"""Construct a formatter from arguments.
496
:param name: Name of the formatter to construct. 'short', 'long' and
499
return self.get(name)(*args, **kwargs)
501
def get_default(self, branch):
502
return self.get(branch.get_config().log_format())
505
log_formatter_registry = LogFormatterRegistry()
508
log_formatter_registry.register('short', ShortLogFormatter,
509
'Moderately short log format')
510
log_formatter_registry.register('long', LongLogFormatter,
511
'Detailed log format')
512
log_formatter_registry.register('line', LineLogFormatter,
513
'Log format with one line per revision')
516
def register_formatter(name, formatter):
517
log_formatter_registry.register(name, formatter)
520
def log_formatter(name, *args, **kwargs):
521
"""Construct a formatter from arguments.
523
name -- Name of the formatter to construct; currently 'long', 'short' and
524
'line' are supported.
526
from bzrlib.errors import BzrCommandError
528
return log_formatter_registry.make_formatter(name, *args, **kwargs)
530
raise BzrCommandError("unknown log formatter: %r" % name)
533
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
534
# deprecated; for compatibility
535
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
536
lf.show(revno, rev, delta)
538
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
539
"""Show the change in revision history comparing the old revision history to the new one.
541
:param branch: The branch where the revisions exist
542
:param old_rh: The old revision history
543
:param new_rh: The new revision history
544
:param to_file: A file to write the results to. If None, stdout will be used
550
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
551
lf = log_formatter(log_format,
554
show_timezone='original')
556
# This is the first index which is different between
559
for i in xrange(max(len(new_rh),
563
or new_rh[i] != old_rh[i]):
568
to_file.write('Nothing seems to have changed\n')
570
## TODO: It might be nice to do something like show_log
571
## and show the merged entries. But since this is the
572
## removed revisions, it shouldn't be as important
573
if base_idx < len(old_rh):
574
to_file.write('*'*60)
575
to_file.write('\nRemoved Revisions:\n')
576
for i in range(base_idx, len(old_rh)):
577
rev = branch.repository.get_revision(old_rh[i])
578
lf.show(i+1, rev, None)
579
to_file.write('*'*60)
580
to_file.write('\n\n')
581
if base_idx < len(new_rh):
582
to_file.write('Added Revisions:\n')
588
start_revision=base_idx+1,
589
end_revision=len(new_rh),
added
removed
bzrlib/log.py
