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.
150
:param lf: The LogFormatter object showing the output.
152
:param specific_fileid: If not None, list only the commits affecting the
153
specified file, rather than all commits.
155
:param verbose: If True show added/changed/deleted/renamed files.
157
:param direction: 'reverse' (default) is latest to earliest; 'forward' is
160
:param start_revision: If not None, only show revisions >= start_revision
162
:param end_revision: If not None, only show revisions <= end_revision
164
:param search: If not None, only show revisions with matching commit
167
:param limit: If set, shows only 'limit' revisions, all revisions are shown
172
if getattr(lf, 'begin_log', None):
175
_show_log(branch, lf, specific_fileid, verbose, direction,
176
start_revision, end_revision, search, limit)
178
if getattr(lf, 'end_log', None):
184
def _show_log(branch,
186
specific_fileid=None,
193
"""Worker function for show_log - see show_log."""
194
if not isinstance(lf, LogFormatter):
195
warn("not a LogFormatter instance: %r" % lf)
198
trace.mutter('get log for file_id %r', specific_fileid)
199
generate_merge_revisions = getattr(lf, 'supports_merge_revisions', False)
200
allow_single_merge_revision = getattr(lf,
201
'supports_single_merge_revision', False)
202
view_revisions = calculate_view_revisions(branch, start_revision,
203
end_revision, direction,
205
generate_merge_revisions,
206
allow_single_merge_revision)
208
generate_tags = getattr(lf, 'supports_tags', False)
210
if branch.supports_tags():
211
rev_tag_dict = branch.tags.get_reverse_tag_dict()
213
generate_delta = verbose and getattr(lf, 'supports_delta', False)
215
# now we just print all the revisions
217
revision_iterator = make_log_rev_iterator(branch, view_revisions,
218
generate_delta, search)
219
for revs in revision_iterator:
220
for (rev_id, revno, merge_depth), rev, delta in revs:
221
lr = LogRevision(rev, revno, merge_depth, delta,
222
rev_tag_dict.get(rev_id))
226
if log_count >= limit:
230
def calculate_view_revisions(branch, start_revision, end_revision, direction,
231
specific_fileid, generate_merge_revisions,
232
allow_single_merge_revision):
233
if ( not generate_merge_revisions
234
and start_revision is end_revision is None
235
and direction == 'reverse'
236
and specific_fileid is None):
237
return _linear_view_revisions(branch)
239
mainline_revs, rev_nos, start_rev_id, end_rev_id = _get_mainline_revs(
240
branch, start_revision, end_revision)
241
if not mainline_revs:
244
generate_single_revision = False
245
if ((not generate_merge_revisions)
246
and ((start_rev_id and (start_rev_id not in rev_nos))
247
or (end_rev_id and (end_rev_id not in rev_nos)))):
248
generate_single_revision = ((start_rev_id == end_rev_id)
249
and allow_single_merge_revision)
250
if not generate_single_revision:
251
raise errors.BzrCommandError('Selected log formatter only supports'
252
' mainline revisions.')
253
generate_merge_revisions = generate_single_revision
254
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
255
direction, include_merges=generate_merge_revisions)
257
if direction == 'reverse':
258
start_rev_id, end_rev_id = end_rev_id, start_rev_id
259
view_revisions = _filter_revision_range(list(view_revs_iter),
262
if view_revisions and generate_single_revision:
263
view_revisions = view_revisions[0:1]
265
view_revisions = _filter_revisions_touching_file_id(branch,
269
# rebase merge_depth - unless there are no revisions or
270
# either the first or last revision have merge_depth = 0.
271
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
272
min_depth = min([d for r,n,d in view_revisions])
274
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
275
return view_revisions
278
def _linear_view_revisions(branch):
279
start_revno, start_revision_id = branch.last_revision_info()
280
repo = branch.repository
281
revision_ids = repo.iter_reverse_revision_history(start_revision_id)
282
for num, revision_id in enumerate(revision_ids):
283
yield revision_id, str(start_revno - num), 0
286
def make_log_rev_iterator(branch, view_revisions, generate_delta, search):
287
"""Create a revision iterator for log.
289
:param branch: The branch being logged.
290
:param view_revisions: The revisions being viewed.
291
:param generate_delta: Whether to generate a delta for each revision.
292
:param search: A user text search string.
293
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
296
# Convert view_revisions into (view, None, None) groups to fit with
297
# the standard interface here.
298
if type(view_revisions) == list:
299
# A single batch conversion is faster than many incremental ones.
300
# As we have all the data, do a batch conversion.
301
nones = [None] * len(view_revisions)
302
log_rev_iterator = iter([zip(view_revisions, nones, nones)])
305
for view in view_revisions:
306
yield (view, None, None)
307
log_rev_iterator = iter([_convert()])
308
for adapter in log_adapters:
309
log_rev_iterator = adapter(branch, generate_delta, search,
311
return log_rev_iterator
314
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
315
"""Create a filtered iterator of log_rev_iterator matching on a regex.
317
:param branch: The branch being logged.
318
:param generate_delta: Whether to generate a delta for each revision.
319
:param search: A user text search string.
320
:param log_rev_iterator: An input iterator containing all revisions that
321
could be displayed, in lists.
322
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
326
return log_rev_iterator
327
# Compile the search now to get early errors.
328
searchRE = re.compile(search, re.IGNORECASE)
329
return _filter_message_re(searchRE, log_rev_iterator)
332
def _filter_message_re(searchRE, log_rev_iterator):
333
for revs in log_rev_iterator:
335
for (rev_id, revno, merge_depth), rev, delta in revs:
336
if searchRE.search(rev.message):
337
new_revs.append(((rev_id, revno, merge_depth), rev, delta))
341
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator):
342
"""Add revision deltas to a log iterator if needed.
344
:param branch: The branch being logged.
345
:param generate_delta: Whether to generate a delta for each revision.
346
:param search: A user text search string.
347
:param log_rev_iterator: An input iterator containing all revisions that
348
could be displayed, in lists.
349
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
352
if not generate_delta:
353
return log_rev_iterator
354
return _generate_deltas(branch.repository, log_rev_iterator)
357
def _generate_deltas(repository, log_rev_iterator):
358
"""Create deltas for each batch of revisions in log_rev_iterator."""
359
for revs in log_rev_iterator:
360
revisions = [rev[1] for rev in revs]
361
deltas = repository.get_deltas_for_revisions(revisions)
362
revs = [(rev[0], rev[1], delta) for rev, delta in izip(revs, deltas)]
366
def _make_revision_objects(branch, generate_delta, search, log_rev_iterator):
367
"""Extract revision objects from the repository
369
:param branch: The branch being logged.
370
:param generate_delta: Whether to generate a delta for each revision.
371
:param search: A user text search string.
372
:param log_rev_iterator: An input iterator containing all revisions that
373
could be displayed, in lists.
374
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
377
repository = branch.repository
378
for revs in log_rev_iterator:
379
# r = revision_id, n = revno, d = merge depth
380
revision_ids = [view[0] for view, _, _ in revs]
381
revisions = repository.get_revisions(revision_ids)
382
revs = [(rev[0], revision, rev[2]) for rev, revision in
383
izip(revs, revisions)]
387
def _make_batch_filter(branch, generate_delta, search, log_rev_iterator):
388
"""Group up a single large batch into smaller ones.
390
:param branch: The branch being logged.
391
:param generate_delta: Whether to generate a delta for each revision.
392
:param search: A user text search string.
393
:param log_rev_iterator: An input iterator containing all revisions that
394
could be displayed, in lists.
395
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
398
repository = branch.repository
400
for batch in log_rev_iterator:
403
step = [detail for _, detail in zip(range(num), batch)]
407
num = min(int(num * 1.5), 200)
410
def _get_mainline_revs(branch, start_revision, end_revision):
411
"""Get the mainline revisions from the branch.
413
Generates the list of mainline revisions for the branch.
415
:param branch: The branch containing the revisions.
417
:param start_revision: The first revision to be logged.
418
For backwards compatibility this may be a mainline integer revno,
419
but for merge revision support a RevisionInfo is expected.
421
:param end_revision: The last 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
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
427
branch_revno, branch_last_revision = branch.last_revision_info()
428
if branch_revno == 0:
429
return None, None, None, None
431
# For mainline generation, map start_revision and end_revision to
432
# mainline revnos. If the revision is not on the mainline choose the
433
# appropriate extreme of the mainline instead - the extra will be
435
# Also map the revisions to rev_ids, to be used in the later filtering
438
if start_revision is None:
441
if isinstance(start_revision, revisionspec.RevisionInfo):
442
start_rev_id = start_revision.rev_id
443
start_revno = start_revision.revno or 1
445
branch.check_real_revno(start_revision)
446
start_revno = start_revision
449
if end_revision is None:
450
end_revno = branch_revno
452
if isinstance(end_revision, revisionspec.RevisionInfo):
453
end_rev_id = end_revision.rev_id
454
end_revno = end_revision.revno or branch_revno
456
branch.check_real_revno(end_revision)
457
end_revno = end_revision
459
if ((start_rev_id == _mod_revision.NULL_REVISION)
460
or (end_rev_id == _mod_revision.NULL_REVISION)):
461
raise errors.BzrCommandError('Logging revision 0 is invalid.')
462
if start_revno > end_revno:
463
raise errors.BzrCommandError("Start revision must be older than "
466
if end_revno < start_revno:
467
return None, None, None, None
468
cur_revno = branch_revno
471
for revision_id in branch.repository.iter_reverse_revision_history(
472
branch_last_revision):
473
if cur_revno < start_revno:
474
# We have gone far enough, but we always add 1 more revision
475
rev_nos[revision_id] = cur_revno
476
mainline_revs.append(revision_id)
478
if cur_revno <= end_revno:
479
rev_nos[revision_id] = cur_revno
480
mainline_revs.append(revision_id)
483
# We walked off the edge of all revisions, so we add a 'None' marker
484
mainline_revs.append(None)
486
mainline_revs.reverse()
488
# override the mainline to look like the revision history.
489
return mainline_revs, rev_nos, start_rev_id, end_rev_id
492
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
493
"""Filter view_revisions based on revision ranges.
495
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
496
tuples to be filtered.
498
:param start_rev_id: If not NONE specifies the first revision to be logged.
499
If NONE then all revisions up to the end_rev_id are logged.
501
:param end_rev_id: If not NONE specifies the last revision to be logged.
502
If NONE then all revisions up to the end of the log are logged.
504
:return: The filtered view_revisions.
506
if start_rev_id or end_rev_id:
507
revision_ids = [r for r, n, d in view_revisions]
509
start_index = revision_ids.index(start_rev_id)
512
if start_rev_id == end_rev_id:
513
end_index = start_index
516
end_index = revision_ids.index(end_rev_id)
518
end_index = len(view_revisions) - 1
519
# To include the revisions merged into the last revision,
520
# extend end_rev_id down to, but not including, the next rev
521
# with the same or lesser merge_depth
522
end_merge_depth = view_revisions[end_index][2]
524
for index in xrange(end_index+1, len(view_revisions)+1):
525
if view_revisions[index][2] <= end_merge_depth:
526
end_index = index - 1
529
# if the search falls off the end then log to the end as well
530
end_index = len(view_revisions) - 1
531
view_revisions = view_revisions[start_index:end_index+1]
532
return view_revisions
535
def _filter_revisions_touching_file_id(branch, file_id, view_revisions):
536
r"""Return the list of revision ids which touch a given file id.
538
The function filters view_revisions and returns a subset.
539
This includes the revisions which directly change the file id,
540
and the revisions which merge these changes. So if the
552
And 'C' changes a file, then both C and D will be returned. F will not be
553
returned even though it brings the changes to C into the branch starting
554
with E. (Note that if we were using F as the tip instead of G, then we
557
This will also be restricted based on a subset of the mainline.
559
:param branch: The branch where we can get text revision information.
561
:param file_id: Filter out revisions that do not touch file_id.
563
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
564
tuples. This is the list of revisions which will be filtered. It is
565
assumed that view_revisions is in merge_sort order (i.e. newest
568
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
570
# Lookup all possible text keys to determine which ones actually modified
572
text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
573
# Looking up keys in batches of 1000 can cut the time in half, as well as
574
# memory consumption. GraphIndex *does* like to look for a few keys in
575
# parallel, it just doesn't like looking for *lots* of keys in parallel.
576
# TODO: This code needs to be re-evaluated periodically as we tune the
577
# indexing layer. We might consider passing in hints as to the known
578
# access pattern (sparse/clustered, high success rate/low success
579
# rate). This particular access is clustered with a low success rate.
580
get_parent_map = branch.repository.texts.get_parent_map
581
modified_text_revisions = set()
583
for start in xrange(0, len(text_keys), chunk_size):
584
next_keys = text_keys[start:start + chunk_size]
585
# Only keep the revision_id portion of the key
586
modified_text_revisions.update(
587
[k[1] for k in get_parent_map(next_keys)])
588
del text_keys, next_keys
591
# Track what revisions will merge the current revision, replace entries
592
# with 'None' when they have been added to result
593
current_merge_stack = [None]
594
for info in view_revisions:
595
rev_id, revno, depth = info
596
if depth == len(current_merge_stack):
597
current_merge_stack.append(info)
599
del current_merge_stack[depth + 1:]
600
current_merge_stack[-1] = info
602
if rev_id in modified_text_revisions:
603
# This needs to be logged, along with the extra revisions
604
for idx in xrange(len(current_merge_stack)):
605
node = current_merge_stack[idx]
608
current_merge_stack[idx] = None
612
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
613
include_merges=True):
614
"""Produce an iterator of revisions to show
615
:return: an iterator of (revision_id, revno, merge_depth)
616
(if there is no revno for a revision, None is supplied)
618
if include_merges is False:
619
revision_ids = mainline_revs[1:]
620
if direction == 'reverse':
621
revision_ids.reverse()
622
for revision_id in revision_ids:
623
yield revision_id, str(rev_nos[revision_id]), 0
625
graph = branch.repository.get_graph()
626
# This asks for all mainline revisions, which means we only have to spider
627
# sideways, rather than depth history. That said, its still size-of-history
628
# and should be addressed.
629
# mainline_revisions always includes an extra revision at the beginning, so
631
parent_map = dict(((key, value) for key, value in
632
graph.iter_ancestry(mainline_revs[1:]) if value is not None))
633
# filter out ghosts; merge_sort errors on ghosts.
634
rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
635
merge_sorted_revisions = tsort.merge_sort(
641
if direction == 'forward':
642
# forward means oldest first.
643
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
644
elif direction != 'reverse':
645
raise ValueError('invalid direction %r' % direction)
647
for (sequence, rev_id, merge_depth, revno, end_of_merge
648
) in merge_sorted_revisions:
649
yield rev_id, '.'.join(map(str, revno)), merge_depth
652
def reverse_by_depth(merge_sorted_revisions, _depth=0):
653
"""Reverse revisions by depth.
655
Revisions with a different depth are sorted as a group with the previous
656
revision of that depth. There may be no topological justification for this,
657
but it looks much nicer.
659
# Add a fake revision at start so that we can always attach sub revisions
660
merge_sorted_revisions = [(None, None, _depth)] + merge_sorted_revisions
662
for val in merge_sorted_revisions:
664
# Each revision at the current depth becomes a chunk grouping all
665
# higher depth revisions.
666
zd_revisions.append([val])
668
zd_revisions[-1].append(val)
669
for revisions in zd_revisions:
670
if len(revisions) > 1:
671
# We have higher depth revisions, let reverse them locally
672
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
673
zd_revisions.reverse()
675
for chunk in zd_revisions:
678
# Top level call, get rid of the fake revisions that have been added
679
result = [r for r in result if r[0] is not None and r[1] is not None]
683
class LogRevision(object):
684
"""A revision to be logged (by LogFormatter.log_revision).
686
A simple wrapper for the attributes of a revision to be logged.
687
The attributes may or may not be populated, as determined by the
688
logging options and the log formatter capabilities.
691
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
695
self.merge_depth = merge_depth
700
class LogFormatter(object):
701
"""Abstract class to display log messages.
703
At a minimum, a derived class must implement the log_revision method.
705
If the LogFormatter needs to be informed of the beginning or end of
706
a log it should implement the begin_log and/or end_log hook methods.
708
A LogFormatter should define the following supports_XXX flags
709
to indicate which LogRevision attributes it supports:
711
- supports_delta must be True if this log formatter supports delta.
712
Otherwise the delta attribute may not be populated. The 'delta_format'
713
attribute describes whether the 'short_status' format (1) or the long
714
one (2) sould be used.
716
- supports_merge_revisions must be True if this log formatter supports
717
merge revisions. If not, and if supports_single_merge_revisions is
718
also not True, then only mainline revisions will be passed to the
720
- supports_single_merge_revision must be True if this log formatter
721
supports logging only a single merge revision. This flag is
722
only relevant if supports_merge_revisions is not True.
723
- supports_tags must be True if this log formatter supports tags.
724
Otherwise the tags attribute may not be populated.
726
Plugins can register functions to show custom revision properties using
727
the properties_handler_registry. The registered function
728
must respect the following interface description:
729
def my_show_properties(properties_dict):
730
# code that returns a dict {'name':'value'} of the properties
734
def __init__(self, to_file, show_ids=False, show_timezone='original',
736
self.to_file = to_file
737
self.show_ids = show_ids
738
self.show_timezone = show_timezone
739
if delta_format is None:
740
# Ensures backward compatibility
741
delta_format = 2 # long format
742
self.delta_format = delta_format
744
# TODO: uncomment this block after show() has been removed.
745
# Until then defining log_revision would prevent _show_log calling show()
746
# in legacy formatters.
747
# def log_revision(self, revision):
750
# :param revision: The LogRevision to be logged.
752
# raise NotImplementedError('not implemented in abstract base')
754
def short_committer(self, rev):
755
name, address = config.parse_username(rev.committer)
760
def short_author(self, rev):
761
name, address = config.parse_username(rev.get_apparent_author())
766
def show_properties(self, revision, indent):
767
"""Displays the custom properties returned by each registered handler.
769
If a registered handler raises an error it is propagated.
771
for key, handler in properties_handler_registry.iteritems():
772
for key, value in handler(revision).items():
773
self.to_file.write(indent + key + ': ' + value + '\n')
776
class LongLogFormatter(LogFormatter):
778
supports_merge_revisions = True
779
supports_delta = True
782
def log_revision(self, revision):
783
"""Log a revision, either merged or not."""
784
indent = ' ' * revision.merge_depth
785
to_file = self.to_file
786
to_file.write(indent + '-' * 60 + '\n')
787
if revision.revno is not None:
788
to_file.write(indent + 'revno: %s\n' % (revision.revno,))
790
to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
792
to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
794
for parent_id in revision.rev.parent_ids:
795
to_file.write(indent + 'parent: %s\n' % (parent_id,))
796
self.show_properties(revision.rev, indent)
798
author = revision.rev.properties.get('author', None)
799
if author is not None:
800
to_file.write(indent + 'author: %s\n' % (author,))
801
to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
803
branch_nick = revision.rev.properties.get('branch-nick', None)
804
if branch_nick is not None:
805
to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
807
date_str = format_date(revision.rev.timestamp,
808
revision.rev.timezone or 0,
810
to_file.write(indent + 'timestamp: %s\n' % (date_str,))
812
to_file.write(indent + 'message:\n')
813
if not revision.rev.message:
814
to_file.write(indent + ' (no message)\n')
816
message = revision.rev.message.rstrip('\r\n')
817
for l in message.split('\n'):
818
to_file.write(indent + ' %s\n' % (l,))
819
if revision.delta is not None:
820
revision.delta.show(to_file, self.show_ids, indent=indent,
821
short_status=self.delta_format==1)
824
class ShortLogFormatter(LogFormatter):
826
supports_delta = True
827
supports_single_merge_revision = True
829
def log_revision(self, revision):
830
to_file = self.to_file
832
if len(revision.rev.parent_ids) > 1:
833
is_merge = ' [merge]'
834
to_file.write("%5s %s\t%s%s\n" % (revision.revno,
835
self.short_author(revision.rev),
836
format_date(revision.rev.timestamp,
837
revision.rev.timezone or 0,
838
self.show_timezone, date_fmt="%Y-%m-%d",
842
to_file.write(' revision-id:%s\n'
843
% (revision.rev.revision_id,))
844
if not revision.rev.message:
845
to_file.write(' (no message)\n')
847
message = revision.rev.message.rstrip('\r\n')
848
for l in message.split('\n'):
849
to_file.write(' %s\n' % (l,))
851
if revision.delta is not None:
852
revision.delta.show(to_file, self.show_ids,
853
short_status=self.delta_format==1)
857
class LineLogFormatter(LogFormatter):
859
supports_single_merge_revision = True
861
def __init__(self, *args, **kwargs):
862
super(LineLogFormatter, self).__init__(*args, **kwargs)
863
self._max_chars = terminal_width() - 1
865
def truncate(self, str, max_len):
866
if len(str) <= max_len:
868
return str[:max_len-3]+'...'
870
def date_string(self, rev):
871
return format_date(rev.timestamp, rev.timezone or 0,
872
self.show_timezone, date_fmt="%Y-%m-%d",
875
def message(self, rev):
877
return '(no message)'
881
def log_revision(self, revision):
882
self.to_file.write(self.log_string(revision.revno, revision.rev,
884
self.to_file.write('\n')
886
def log_string(self, revno, rev, max_chars):
887
"""Format log info into one string. Truncate tail of string
888
:param revno: revision number or None.
889
Revision numbers counts from 1.
890
:param rev: revision info object
891
:param max_chars: maximum length of resulting string
892
:return: formatted truncated string
896
# show revno only when is not None
897
out.append("%s:" % revno)
898
out.append(self.truncate(self.short_author(rev), 20))
899
out.append(self.date_string(rev))
900
out.append(rev.get_summary())
901
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
904
def line_log(rev, max_chars):
905
lf = LineLogFormatter(None)
906
return lf.log_string(None, rev, max_chars)
909
class LogFormatterRegistry(registry.Registry):
910
"""Registry for log formatters"""
912
def make_formatter(self, name, *args, **kwargs):
913
"""Construct a formatter from arguments.
915
:param name: Name of the formatter to construct. 'short', 'long' and
918
return self.get(name)(*args, **kwargs)
920
def get_default(self, branch):
921
return self.get(branch.get_config().log_format())
924
log_formatter_registry = LogFormatterRegistry()
927
log_formatter_registry.register('short', ShortLogFormatter,
928
'Moderately short log format')
929
log_formatter_registry.register('long', LongLogFormatter,
930
'Detailed log format')
931
log_formatter_registry.register('line', LineLogFormatter,
932
'Log format with one line per revision')
935
def register_formatter(name, formatter):
936
log_formatter_registry.register(name, formatter)
939
def log_formatter(name, *args, **kwargs):
940
"""Construct a formatter from arguments.
942
name -- Name of the formatter to construct; currently 'long', 'short' and
943
'line' are supported.
946
return log_formatter_registry.make_formatter(name, *args, **kwargs)
948
raise errors.BzrCommandError("unknown log formatter: %r" % name)
951
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
952
# deprecated; for compatibility
953
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
954
lf.show(revno, rev, delta)
957
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
959
"""Show the change in revision history comparing the old revision history to the new one.
961
:param branch: The branch where the revisions exist
962
:param old_rh: The old revision history
963
:param new_rh: The new revision history
964
:param to_file: A file to write the results to. If None, stdout will be used
967
to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
969
lf = log_formatter(log_format,
972
show_timezone='original')
974
# This is the first index which is different between
977
for i in xrange(max(len(new_rh),
981
or new_rh[i] != old_rh[i]):
986
to_file.write('Nothing seems to have changed\n')
988
## TODO: It might be nice to do something like show_log
989
## and show the merged entries. But since this is the
990
## removed revisions, it shouldn't be as important
991
if base_idx < len(old_rh):
992
to_file.write('*'*60)
993
to_file.write('\nRemoved Revisions:\n')
994
for i in range(base_idx, len(old_rh)):
995
rev = branch.repository.get_revision(old_rh[i])
996
lr = LogRevision(rev, i+1, 0, None)
998
to_file.write('*'*60)
999
to_file.write('\n\n')
1000
if base_idx < len(new_rh):
1001
to_file.write('Added Revisions:\n')
1006
direction='forward',
1007
start_revision=base_idx+1,
1008
end_revision=len(new_rh),
1012
properties_handler_registry = registry.Registry()
1013
properties_handler_registry.register_lazy("foreign",
1015
"show_foreign_properties")
1018
# adapters which revision ids to log are filtered. When log is called, the
1019
# log_rev_iterator is adapted through each of these factory methods.
1020
# Plugins are welcome to mutate this list in any way they like - as long
1021
# as the overall behaviour is preserved. At this point there is no extensible
1022
# mechanism for getting parameters to each factory method, and until there is
1023
# this won't be considered a stable api.
1027
# read revision objects
1028
_make_revision_objects,
1029
# filter on log messages
1030
_make_search_filter,
1031
# generate deltas for things we will show
added
removed
bzrlib/log.py
