1
# Copyright (C) 2005, 2006, 2007 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 left-most 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 itertools import (
58
from warnings import (
62
from bzrlib.lazy_import import lazy_import
63
lazy_import(globals(), """
68
repository as _mod_repository,
69
revision as _mod_revision,
79
from bzrlib.osutils import (
81
get_terminal_encoding,
86
def find_touching_revisions(branch, file_id):
87
"""Yield a description of revisions which affect the file_id.
89
Each returned element is (revno, revision_id, description)
91
This is the list of revisions where the file is either added,
92
modified, renamed or deleted.
94
TODO: Perhaps some way to limit this to only particular revisions,
95
or to traverse a non-mainline set of revisions?
100
for revision_id in branch.revision_history():
101
this_inv = branch.repository.get_revision_inventory(revision_id)
102
if file_id in this_inv:
103
this_ie = this_inv[file_id]
104
this_path = this_inv.id2path(file_id)
106
this_ie = this_path = None
108
# now we know how it was last time, and how it is in this revision.
109
# are those two states effectively the same or not?
111
if not this_ie and not last_ie:
112
# not present in either
114
elif this_ie and not last_ie:
115
yield revno, revision_id, "added " + this_path
116
elif not this_ie and last_ie:
118
yield revno, revision_id, "deleted " + last_path
119
elif this_path != last_path:
120
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
121
elif (this_ie.text_size != last_ie.text_size
122
or this_ie.text_sha1 != last_ie.text_sha1):
123
yield revno, revision_id, "modified " + this_path
126
last_path = this_path
130
def _enumerate_history(branch):
133
for rev_id in branch.revision_history():
134
rh.append((revno, rev_id))
141
specific_fileid=None,
148
"""Write out human-readable log of commits to this branch.
151
LogFormatter object to show the output.
154
If true, list only the commits affecting the specified
155
file, rather than all commits.
158
If true show added/changed/deleted/renamed files.
161
'reverse' (default) is latest to earliest;
162
'forward' is earliest to latest.
165
If not None, only show revisions >= start_revision
168
If not None, only show revisions <= end_revision
171
If not None, only show revisions with matching commit messages
174
If not None or 0, only show limit revisions
178
if getattr(lf, 'begin_log', None):
181
_show_log(branch, lf, specific_fileid, verbose, direction,
182
start_revision, end_revision, search, limit)
184
if getattr(lf, 'end_log', None):
190
def _show_log(branch,
192
specific_fileid=None,
199
"""Worker function for show_log - see show_log."""
200
if not isinstance(lf, LogFormatter):
201
warn("not a LogFormatter instance: %r" % lf)
204
trace.mutter('get log for file_id %r', specific_fileid)
205
generate_merge_revisions = getattr(lf, 'supports_merge_revisions', False)
206
allow_single_merge_revision = getattr(lf,
207
'supports_single_merge_revision', False)
208
view_revisions = calculate_view_revisions(branch, start_revision,
209
end_revision, direction,
211
generate_merge_revisions,
212
allow_single_merge_revision)
214
generate_tags = getattr(lf, 'supports_tags', False)
216
if branch.supports_tags():
217
rev_tag_dict = branch.tags.get_reverse_tag_dict()
219
generate_delta = verbose and getattr(lf, 'supports_delta', False)
221
# now we just print all the revisions
223
revision_iterator = make_log_rev_iterator(branch, view_revisions,
224
generate_delta, search)
225
for revs in revision_iterator:
226
for (rev_id, revno, merge_depth), rev, delta in revs:
227
lr = LogRevision(rev, revno, merge_depth, delta,
228
rev_tag_dict.get(rev_id))
232
if log_count >= limit:
236
def calculate_view_revisions(branch, start_revision, end_revision, direction,
237
specific_fileid, generate_merge_revisions,
238
allow_single_merge_revision):
239
if (not generate_merge_revisions and start_revision is end_revision is
240
None and direction == 'reverse' and specific_fileid is None):
241
return _linear_view_revisions(branch)
243
mainline_revs, rev_nos, start_rev_id, end_rev_id = \
244
_get_mainline_revs(branch, start_revision, end_revision)
245
if not mainline_revs:
248
if direction == 'reverse':
249
start_rev_id, end_rev_id = end_rev_id, start_rev_id
251
generate_single_revision = False
252
if ((not generate_merge_revisions)
253
and ((start_rev_id and (start_rev_id not in rev_nos))
254
or (end_rev_id and (end_rev_id not in rev_nos)))):
255
generate_single_revision = ((start_rev_id == end_rev_id)
256
and allow_single_merge_revision)
257
if not generate_single_revision:
258
raise errors.BzrCommandError('Selected log formatter only supports'
259
' mainline revisions.')
260
generate_merge_revisions = generate_single_revision
261
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
262
direction, include_merges=generate_merge_revisions)
263
view_revisions = _filter_revision_range(list(view_revs_iter),
266
if view_revisions and generate_single_revision:
267
view_revisions = view_revisions[0:1]
269
view_revisions = _filter_revisions_touching_file_id(branch,
274
# rebase merge_depth - unless there are no revisions or
275
# either the first or last revision have merge_depth = 0.
276
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
277
min_depth = min([d for r,n,d in view_revisions])
279
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
280
return view_revisions
283
def _linear_view_revisions(branch):
284
start_revno, start_revision_id = branch.last_revision_info()
285
repo = branch.repository
286
revision_ids = repo.iter_reverse_revision_history(start_revision_id)
287
for num, revision_id in enumerate(revision_ids):
288
yield revision_id, str(start_revno - num), 0
291
def make_log_rev_iterator(branch, view_revisions, generate_delta, search):
292
"""Create a revision iterator for log.
294
:param branch: The branch being logged.
295
:param view_revisions: The revisions being viewed.
296
:param generate_delta: Whether to generate a delta for each revision.
297
:param search: A user text search string.
298
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
301
# Convert view_revisions into (view, None, None) groups to fit with
302
# the standard interface here.
303
if type(view_revisions) == list:
304
# A single batch conversion is faster than many incremental ones.
305
# As we have all the data, do a batch conversion.
306
nones = [None] * len(view_revisions)
307
log_rev_iterator = iter([zip(view_revisions, nones, nones)])
310
for view in view_revisions:
311
yield (view, None, None)
312
log_rev_iterator = iter([_convert()])
313
for adapter in log_adapters:
314
log_rev_iterator = adapter(branch, generate_delta, search,
316
return log_rev_iterator
319
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
320
"""Create a filtered iterator of log_rev_iterator matching on a regex.
322
:param branch: The branch being logged.
323
:param generate_delta: Whether to generate a delta for each revision.
324
:param search: A user text search string.
325
:param log_rev_iterator: An input iterator containing all revisions that
326
could be displayed, in lists.
327
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
331
return log_rev_iterator
332
# Compile the search now to get early errors.
333
searchRE = re.compile(search, re.IGNORECASE)
334
return _filter_message_re(searchRE, log_rev_iterator)
337
def _filter_message_re(searchRE, log_rev_iterator):
338
for revs in log_rev_iterator:
340
for (rev_id, revno, merge_depth), rev, delta in revs:
341
if searchRE.search(rev.message):
342
new_revs.append(((rev_id, revno, merge_depth), rev, delta))
346
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator):
347
"""Add revision deltas to a log iterator if needed.
349
:param branch: The branch being logged.
350
:param generate_delta: Whether to generate a delta for each revision.
351
:param search: A user text search string.
352
:param log_rev_iterator: An input iterator containing all revisions that
353
could be displayed, in lists.
354
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
357
if not generate_delta:
358
return log_rev_iterator
359
return _generate_deltas(branch.repository, log_rev_iterator)
362
def _generate_deltas(repository, log_rev_iterator):
363
"""Create deltas for each batch of revisions in log_rev_iterator."""
364
for revs in log_rev_iterator:
365
revisions = [rev[1] for rev in revs]
366
deltas = repository.get_deltas_for_revisions(revisions)
367
revs = [(rev[0], rev[1], delta) for rev, delta in izip(revs, deltas)]
371
def _make_revision_objects(branch, generate_delta, search, log_rev_iterator):
372
"""Extract revision objects from the repository
374
:param branch: The branch being logged.
375
:param generate_delta: Whether to generate a delta for each revision.
376
:param search: A user text search string.
377
:param log_rev_iterator: An input iterator containing all revisions that
378
could be displayed, in lists.
379
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
382
repository = branch.repository
383
for revs in log_rev_iterator:
384
# r = revision_id, n = revno, d = merge depth
385
revision_ids = [view[0] for view, _, _ in revs]
386
revisions = repository.get_revisions(revision_ids)
387
revs = [(rev[0], revision, rev[2]) for rev, revision in
388
izip(revs, revisions)]
392
def _make_batch_filter(branch, generate_delta, search, log_rev_iterator):
393
"""Group up a single large batch into smaller ones.
395
:param branch: The branch being logged.
396
:param generate_delta: Whether to generate a delta for each revision.
397
:param search: A user text search string.
398
:param log_rev_iterator: An input iterator containing all revisions that
399
could be displayed, in lists.
400
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev, delta).
402
repository = branch.repository
404
for batch in log_rev_iterator:
407
step = [detail for _, detail in zip(range(num), batch)]
411
num = min(int(num * 1.5), 200)
414
def _get_mainline_revs(branch, start_revision, end_revision):
415
"""Get the mainline revisions from the branch.
417
Generates the list of mainline revisions for the branch.
419
:param branch: The branch containing the revisions.
421
:param start_revision: The first revision to be logged.
422
For backwards compatibility this may be a mainline integer revno,
423
but for merge revision support a RevisionInfo is expected.
425
:param end_revision: The last revision to be logged.
426
For backwards compatibility this may be a mainline integer revno,
427
but for merge revision support a RevisionInfo is expected.
429
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
431
branch_revno, branch_last_revision = branch.last_revision_info()
432
if branch_revno == 0:
433
return None, None, None, None
435
# For mainline generation, map start_revision and end_revision to
436
# mainline revnos. If the revision is not on the mainline choose the
437
# appropriate extreme of the mainline instead - the extra will be
439
# Also map the revisions to rev_ids, to be used in the later filtering
442
if start_revision is None:
445
if isinstance(start_revision, revisionspec.RevisionInfo):
446
start_rev_id = start_revision.rev_id
447
start_revno = start_revision.revno or 1
449
branch.check_real_revno(start_revision)
450
start_revno = start_revision
453
if end_revision is None:
454
end_revno = branch_revno
456
if isinstance(end_revision, revisionspec.RevisionInfo):
457
end_rev_id = end_revision.rev_id
458
end_revno = end_revision.revno or branch_revno
460
branch.check_real_revno(end_revision)
461
end_revno = end_revision
463
if ((start_rev_id == _mod_revision.NULL_REVISION)
464
or (end_rev_id == _mod_revision.NULL_REVISION)):
465
raise errors.BzrCommandError('Logging revision 0 is invalid.')
466
if start_revno > end_revno:
467
raise errors.BzrCommandError("Start revision must be older than "
470
if end_revno < start_revno:
471
return None, None, None, None
472
cur_revno = branch_revno
475
for revision_id in branch.repository.iter_reverse_revision_history(
476
branch_last_revision):
477
if cur_revno < start_revno:
478
# We have gone far enough, but we always add 1 more revision
479
rev_nos[revision_id] = cur_revno
480
mainline_revs.append(revision_id)
482
if cur_revno <= end_revno:
483
rev_nos[revision_id] = cur_revno
484
mainline_revs.append(revision_id)
487
# We walked off the edge of all revisions, so we add a 'None' marker
488
mainline_revs.append(None)
490
mainline_revs.reverse()
492
# override the mainline to look like the revision history.
493
return mainline_revs, rev_nos, start_rev_id, end_rev_id
496
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
497
"""Filter view_revisions based on revision ranges.
499
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
500
tuples to be filtered.
502
:param start_rev_id: If not NONE specifies the first revision to be logged.
503
If NONE then all revisions up to the end_rev_id are logged.
505
:param end_rev_id: If not NONE specifies the last revision to be logged.
506
If NONE then all revisions up to the end of the log are logged.
508
:return: The filtered view_revisions.
510
if start_rev_id or end_rev_id:
511
revision_ids = [r for r, n, d in view_revisions]
513
start_index = revision_ids.index(start_rev_id)
516
if start_rev_id == end_rev_id:
517
end_index = start_index
520
end_index = revision_ids.index(end_rev_id)
522
end_index = len(view_revisions) - 1
523
# To include the revisions merged into the last revision,
524
# extend end_rev_id down to, but not including, the next rev
525
# with the same or lesser merge_depth
526
end_merge_depth = view_revisions[end_index][2]
528
for index in xrange(end_index+1, len(view_revisions)+1):
529
if view_revisions[index][2] <= end_merge_depth:
530
end_index = index - 1
533
# if the search falls off the end then log to the end as well
534
end_index = len(view_revisions) - 1
535
view_revisions = view_revisions[start_index:end_index+1]
536
return view_revisions
539
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
541
r"""Return the list of revision ids which touch a given file id.
543
The function filters view_revisions and returns a subset.
544
This includes the revisions which directly change the file id,
545
and the revisions which merge these changes. So if the
557
And 'C' changes a file, then both C and D will be returned. F will not be
558
returned even though it brings the changes to C into the branch starting
559
with E. (Note that if we were using F as the tip instead of G, then we
562
This will also be restricted based on a subset of the mainline.
564
:param branch: The branch where we can get text revision information.
565
:param file_id: Filter out revisions that do not touch file_id.
566
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
567
tuples. This is the list of revisions which will be filtered. It is
568
assumed that view_revisions is in merge_sort order (either forward or
570
:param direction: The direction of view_revisions. See also
571
reverse_by_depth, and get_view_revisions
572
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
574
# Lookup all possible text keys to determine which ones actually modified
576
text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
577
# Looking up keys in batches of 1000 can cut the time in half, as well as
578
# memory consumption. GraphIndex *does* like to look for a few keys in
579
# parallel, it just doesn't like looking for *lots* of keys in parallel.
580
# TODO: This code needs to be re-evaluated periodically as we tune the
581
# indexing layer. We might consider passing in hints as to the known
582
# access pattern (sparse/clustered, high success rate/low success
583
# rate). This particular access is clustered with a low success rate.
584
get_parent_map = branch.repository.texts.get_parent_map
585
modified_text_revisions = set()
587
for start in xrange(0, len(text_keys), chunk_size):
588
next_keys = text_keys[start:start + chunk_size]
589
# Only keep the revision_id portion of the key
590
modified_text_revisions.update(
591
[k[1] for k in get_parent_map(next_keys)])
592
del text_keys, next_keys
595
if direction == 'forward':
596
# TODO: The algorithm for finding 'merges' of file changes expects
597
# 'reverse' order (the default from 'merge_sort()'). Instead of
598
# forcing this, we could just use the reverse_by_depth order.
599
view_revisions = reverse_by_depth(view_revisions)
600
# Track what revisions will merge the current revision, replace entries
601
# with 'None' when they have been added to result
602
current_merge_stack = [None]
603
for info in view_revisions:
604
rev_id, revno, depth = info
605
if depth == len(current_merge_stack):
606
current_merge_stack.append(info)
608
del current_merge_stack[depth + 1:]
609
current_merge_stack[-1] = info
611
if rev_id in modified_text_revisions:
612
# This needs to be logged, along with the extra revisions
613
for idx in xrange(len(current_merge_stack)):
614
node = current_merge_stack[idx]
617
current_merge_stack[idx] = None
618
if direction == 'forward':
619
result = reverse_by_depth(result)
623
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
624
include_merges=True):
625
"""Produce an iterator of revisions to show
626
:return: an iterator of (revision_id, revno, merge_depth)
627
(if there is no revno for a revision, None is supplied)
629
if include_merges is False:
630
revision_ids = mainline_revs[1:]
631
if direction == 'reverse':
632
revision_ids.reverse()
633
for revision_id in revision_ids:
634
yield revision_id, str(rev_nos[revision_id]), 0
636
graph = branch.repository.get_graph()
637
# This asks for all mainline revisions, which means we only have to spider
638
# sideways, rather than depth history. That said, its still size-of-history
639
# and should be addressed.
640
# mainline_revisions always includes an extra revision at the beginning, so
642
parent_map = dict(((key, value) for key, value in
643
graph.iter_ancestry(mainline_revs[1:]) if value is not None))
644
# filter out ghosts; merge_sort errors on ghosts.
645
rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
646
merge_sorted_revisions = tsort.merge_sort(
652
if direction == 'forward':
653
# forward means oldest first.
654
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
655
elif direction != 'reverse':
656
raise ValueError('invalid direction %r' % direction)
658
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
659
yield rev_id, '.'.join(map(str, revno)), merge_depth
662
def reverse_by_depth(merge_sorted_revisions, _depth=0):
663
"""Reverse revisions by depth.
665
Revisions with a different depth are sorted as a group with the previous
666
revision of that depth. There may be no topological justification for this,
667
but it looks much nicer.
670
for val in merge_sorted_revisions:
672
zd_revisions.append([val])
674
zd_revisions[-1].append(val)
675
for revisions in zd_revisions:
676
if len(revisions) > 1:
677
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
678
zd_revisions.reverse()
680
for chunk in zd_revisions:
685
class LogRevision(object):
686
"""A revision to be logged (by LogFormatter.log_revision).
688
A simple wrapper for the attributes of a revision to be logged.
689
The attributes may or may not be populated, as determined by the
690
logging options and the log formatter capabilities.
693
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
697
self.merge_depth = merge_depth
702
class LogFormatter(object):
703
"""Abstract class to display log messages.
705
At a minimum, a derived class must implement the log_revision method.
707
If the LogFormatter needs to be informed of the beginning or end of
708
a log it should implement the begin_log and/or end_log hook methods.
710
A LogFormatter should define the following supports_XXX flags
711
to indicate which LogRevision attributes it supports:
713
- supports_delta must be True if this log formatter supports delta.
714
Otherwise the delta attribute may not be populated.
715
- supports_merge_revisions must be True if this log formatter supports
716
merge revisions. If not, and if supports_single_merge_revisions is
717
also not True, then only mainline revisions will be passed to the
719
- supports_single_merge_revision must be True if this log formatter
720
supports logging only a single merge revision. This flag is
721
only relevant if supports_merge_revisions is not True.
722
- supports_tags must be True if this log formatter supports tags.
723
Otherwise the tags attribute may not be populated.
725
Plugins can register functions to show custom revision properties using
726
the properties_handler_registry. The registered function
727
must respect the following interface description:
728
def my_show_properties(properties_dict):
729
# code that returns a dict {'name':'value'} of the properties
733
def __init__(self, to_file, show_ids=False, show_timezone='original'):
734
self.to_file = to_file
735
self.show_ids = show_ids
736
self.show_timezone = show_timezone
738
# TODO: uncomment this block after show() has been removed.
739
# Until then defining log_revision would prevent _show_log calling show()
740
# in legacy formatters.
741
# def log_revision(self, revision):
744
# :param revision: The LogRevision to be logged.
746
# raise NotImplementedError('not implemented in abstract base')
748
def short_committer(self, rev):
749
name, address = config.parse_username(rev.committer)
754
def short_author(self, rev):
755
name, address = config.parse_username(rev.get_apparent_author())
760
def show_properties(self, revision, indent):
761
"""Displays the custom properties returned by each registered handler.
763
If a registered handler raises an error it is propagated.
765
for key, handler in properties_handler_registry.iteritems():
766
for key, value in handler(revision).items():
767
self.to_file.write(indent + key + ': ' + value + '\n')
770
class LongLogFormatter(LogFormatter):
772
supports_merge_revisions = True
773
supports_delta = True
776
def log_revision(self, revision):
777
"""Log a revision, either merged or not."""
778
indent = ' ' * revision.merge_depth
779
to_file = self.to_file
780
to_file.write(indent + '-' * 60 + '\n')
781
if revision.revno is not None:
782
to_file.write(indent + 'revno: %s\n' % (revision.revno,))
784
to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
786
to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
788
for parent_id in revision.rev.parent_ids:
789
to_file.write(indent + 'parent: %s\n' % (parent_id,))
790
self.show_properties(revision.rev, indent)
792
author = revision.rev.properties.get('author', None)
793
if author is not None:
794
to_file.write(indent + 'author: %s\n' % (author,))
795
to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
797
branch_nick = revision.rev.properties.get('branch-nick', None)
798
if branch_nick is not None:
799
to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
801
date_str = format_date(revision.rev.timestamp,
802
revision.rev.timezone or 0,
804
to_file.write(indent + 'timestamp: %s\n' % (date_str,))
806
to_file.write(indent + 'message:\n')
807
if not revision.rev.message:
808
to_file.write(indent + ' (no message)\n')
810
message = revision.rev.message.rstrip('\r\n')
811
for l in message.split('\n'):
812
to_file.write(indent + ' %s\n' % (l,))
813
if revision.delta is not None:
814
revision.delta.show(to_file, self.show_ids, indent=indent)
817
class ShortLogFormatter(LogFormatter):
819
supports_delta = True
820
supports_single_merge_revision = True
822
def log_revision(self, revision):
823
to_file = self.to_file
825
if len(revision.rev.parent_ids) > 1:
826
is_merge = ' [merge]'
827
to_file.write("%5s %s\t%s%s\n" % (revision.revno,
828
self.short_author(revision.rev),
829
format_date(revision.rev.timestamp,
830
revision.rev.timezone or 0,
831
self.show_timezone, date_fmt="%Y-%m-%d",
835
to_file.write(' revision-id:%s\n' % (revision.rev.revision_id,))
836
if not revision.rev.message:
837
to_file.write(' (no message)\n')
839
message = revision.rev.message.rstrip('\r\n')
840
for l in message.split('\n'):
841
to_file.write(' %s\n' % (l,))
843
# TODO: Why not show the modified files in a shorter form as
844
# well? rewrap them single lines of appropriate length
845
if revision.delta is not None:
846
revision.delta.show(to_file, self.show_ids)
850
class LineLogFormatter(LogFormatter):
852
supports_single_merge_revision = True
854
def __init__(self, *args, **kwargs):
855
super(LineLogFormatter, self).__init__(*args, **kwargs)
856
self._max_chars = terminal_width() - 1
858
def truncate(self, str, max_len):
859
if len(str) <= max_len:
861
return str[:max_len-3]+'...'
863
def date_string(self, rev):
864
return format_date(rev.timestamp, rev.timezone or 0,
865
self.show_timezone, date_fmt="%Y-%m-%d",
868
def message(self, rev):
870
return '(no message)'
874
def log_revision(self, revision):
875
self.to_file.write(self.log_string(revision.revno, revision.rev,
877
self.to_file.write('\n')
879
def log_string(self, revno, rev, max_chars):
880
"""Format log info into one string. Truncate tail of string
881
:param revno: revision number or None.
882
Revision numbers counts from 1.
883
:param rev: revision info object
884
:param max_chars: maximum length of resulting string
885
:return: formatted truncated string
889
# show revno only when is not None
890
out.append("%s:" % revno)
891
out.append(self.truncate(self.short_author(rev), 20))
892
out.append(self.date_string(rev))
893
out.append(rev.get_summary())
894
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
897
def line_log(rev, max_chars):
898
lf = LineLogFormatter(None)
899
return lf.log_string(None, rev, max_chars)
902
class LogFormatterRegistry(registry.Registry):
903
"""Registry for log formatters"""
905
def make_formatter(self, name, *args, **kwargs):
906
"""Construct a formatter from arguments.
908
:param name: Name of the formatter to construct. 'short', 'long' and
911
return self.get(name)(*args, **kwargs)
913
def get_default(self, branch):
914
return self.get(branch.get_config().log_format())
917
log_formatter_registry = LogFormatterRegistry()
920
log_formatter_registry.register('short', ShortLogFormatter,
921
'Moderately short log format')
922
log_formatter_registry.register('long', LongLogFormatter,
923
'Detailed log format')
924
log_formatter_registry.register('line', LineLogFormatter,
925
'Log format with one line per revision')
928
def register_formatter(name, formatter):
929
log_formatter_registry.register(name, formatter)
932
def log_formatter(name, *args, **kwargs):
933
"""Construct a formatter from arguments.
935
name -- Name of the formatter to construct; currently 'long', 'short' and
936
'line' are supported.
939
return log_formatter_registry.make_formatter(name, *args, **kwargs)
941
raise errors.BzrCommandError("unknown log formatter: %r" % name)
944
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
945
# deprecated; for compatibility
946
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
947
lf.show(revno, rev, delta)
950
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
952
"""Show the change in revision history comparing the old revision history to the new one.
954
:param branch: The branch where the revisions exist
955
:param old_rh: The old revision history
956
:param new_rh: The new revision history
957
:param to_file: A file to write the results to. If None, stdout will be used
960
to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
962
lf = log_formatter(log_format,
965
show_timezone='original')
967
# This is the first index which is different between
970
for i in xrange(max(len(new_rh),
974
or new_rh[i] != old_rh[i]):
979
to_file.write('Nothing seems to have changed\n')
981
## TODO: It might be nice to do something like show_log
982
## and show the merged entries. But since this is the
983
## removed revisions, it shouldn't be as important
984
if base_idx < len(old_rh):
985
to_file.write('*'*60)
986
to_file.write('\nRemoved Revisions:\n')
987
for i in range(base_idx, len(old_rh)):
988
rev = branch.repository.get_revision(old_rh[i])
989
lr = LogRevision(rev, i+1, 0, None)
991
to_file.write('*'*60)
992
to_file.write('\n\n')
993
if base_idx < len(new_rh):
994
to_file.write('Added Revisions:\n')
1000
start_revision=base_idx+1,
1001
end_revision=len(new_rh),
1005
properties_handler_registry = registry.Registry()
1007
# adapters which revision ids to log are filtered. When log is called, the
1008
# log_rev_iterator is adapted through each of these factory methods.
1009
# Plugins are welcome to mutate this list in any way they like - as long
1010
# as the overall behaviour is preserved. At this point there is no extensible
1011
# mechanism for getting parameters to each factory method, and until there is
1012
# this won't be considered a stable api.
1016
# read revision objects
1017
_make_revision_objects,
1018
# filter on log messages
1019
_make_search_filter,
1020
# generate deltas for things we will show
added
removed
bzrlib/log.py
