1
# Copyright (C) 2005-2011 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
20
"""Code to show logs of changes.
22
Various flavors of log can be produced:
24
* for one file, or the whole tree, and (not done yet) for
25
files in a given directory
27
* in "verbose" mode with a description of what changed from one
30
* with file-ids and revision-ids shown
32
Logs are actually written out through an abstract LogFormatter
33
interface, which allows for different preferred formats. Plugins can
36
Logs can be produced in either forward (oldest->newest) or reverse
37
(newest->oldest) order.
39
Logs can be filtered to show only revisions matching a particular
40
search string, or within a particular range of revisions. The range
41
can be given as date/times, which are reduced to revisions before
44
In verbose mode we show a summary of what changed in each particular
45
revision. Note that this is the delta for changes in that revision
46
relative to its left-most parent, not the delta relative to the last
47
logged revision. So for example if you ask for a verbose log of
48
changes touching hello.c you will get a list of those revisions also
49
listing other things that were changed in the same revision, but not
50
all the changes since the previous revision that touched hello.c.
54
from cStringIO import StringIO
55
from itertools import (
61
from warnings import (
65
from bzrlib.lazy_import import lazy_import
66
lazy_import(globals(), """
74
repository as _mod_repository,
75
revision as _mod_revision,
79
from bzrlib.i18n import gettext, ngettext
86
from bzrlib.osutils import (
88
format_date_with_offset_in_original_timezone,
89
get_diff_header_encoding,
90
get_terminal_encoding,
95
def find_touching_revisions(branch, file_id):
96
"""Yield a description of revisions which affect the file_id.
98
Each returned element is (revno, revision_id, description)
100
This is the list of revisions where the file is either added,
101
modified, renamed or deleted.
103
TODO: Perhaps some way to limit this to only particular revisions,
104
or to traverse a non-mainline set of revisions?
109
graph = branch.repository.get_graph()
110
history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
111
[_mod_revision.NULL_REVISION]))
112
for revision_id in reversed(history):
113
this_inv = branch.repository.get_inventory(revision_id)
114
if this_inv.has_id(file_id):
115
this_ie = this_inv[file_id]
116
this_path = this_inv.id2path(file_id)
118
this_ie = this_path = None
120
# now we know how it was last time, and how it is in this revision.
121
# are those two states effectively the same or not?
123
if not this_ie and not last_ie:
124
# not present in either
126
elif this_ie and not last_ie:
127
yield revno, revision_id, "added " + this_path
128
elif not this_ie and last_ie:
130
yield revno, revision_id, "deleted " + last_path
131
elif this_path != last_path:
132
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
133
elif (this_ie.text_size != last_ie.text_size
134
or this_ie.text_sha1 != last_ie.text_sha1):
135
yield revno, revision_id, "modified " + this_path
138
last_path = this_path
142
def _enumerate_history(branch):
145
for rev_id in branch.revision_history():
146
rh.append((revno, rev_id))
153
specific_fileid=None,
162
"""Write out human-readable log of commits to this branch.
164
This function is being retained for backwards compatibility but
165
should not be extended with new parameters. Use the new Logger class
166
instead, eg. Logger(branch, rqst).show(lf), adding parameters to the
167
make_log_request_dict function.
169
:param lf: The LogFormatter object showing the output.
171
:param specific_fileid: If not None, list only the commits affecting the
172
specified file, rather than all commits.
174
:param verbose: If True show added/changed/deleted/renamed files.
176
:param direction: 'reverse' (default) is latest to earliest; 'forward' is
179
:param start_revision: If not None, only show revisions >= start_revision
181
:param end_revision: If not None, only show revisions <= end_revision
183
:param search: If not None, only show revisions with matching commit
186
:param limit: If set, shows only 'limit' revisions, all revisions are shown
189
:param show_diff: If True, output a diff after each revision.
191
:param match: Dictionary of search lists to use when matching revision
194
# Convert old-style parameters to new-style parameters
195
if specific_fileid is not None:
196
file_ids = [specific_fileid]
201
delta_type = 'partial'
208
diff_type = 'partial'
214
# Build the request and execute it
215
rqst = make_log_request_dict(direction=direction, specific_fileids=file_ids,
216
start_revision=start_revision, end_revision=end_revision,
217
limit=limit, message_search=search,
218
delta_type=delta_type, diff_type=diff_type)
219
Logger(branch, rqst).show(lf)
222
# Note: This needs to be kept in sync with the defaults in
223
# make_log_request_dict() below
224
_DEFAULT_REQUEST_PARAMS = {
225
'direction': 'reverse',
227
'generate_tags': True,
228
'exclude_common_ancestry': False,
229
'_match_using_deltas': True,
233
def make_log_request_dict(direction='reverse', specific_fileids=None,
234
start_revision=None, end_revision=None, limit=None,
235
message_search=None, levels=None, generate_tags=True,
237
diff_type=None, _match_using_deltas=True,
238
exclude_common_ancestry=False, match=None,
239
signature=False, omit_merges=False,
241
"""Convenience function for making a logging request dictionary.
243
Using this function may make code slightly safer by ensuring
244
parameters have the correct names. It also provides a reference
245
point for documenting the supported parameters.
247
:param direction: 'reverse' (default) is latest to earliest;
248
'forward' is earliest to latest.
250
:param specific_fileids: If not None, only include revisions
251
affecting the specified files, rather than all revisions.
253
:param start_revision: If not None, only generate
254
revisions >= start_revision
256
:param end_revision: If not None, only generate
257
revisions <= end_revision
259
:param limit: If set, generate only 'limit' revisions, all revisions
260
are shown if None or 0.
262
:param message_search: If not None, only include revisions with
263
matching commit messages
265
:param levels: the number of levels of revisions to
266
generate; 1 for just the mainline; 0 for all levels, or None for
269
:param generate_tags: If True, include tags for matched revisions.
271
:param delta_type: Either 'full', 'partial' or None.
272
'full' means generate the complete delta - adds/deletes/modifies/etc;
273
'partial' means filter the delta using specific_fileids;
274
None means do not generate any delta.
276
:param diff_type: Either 'full', 'partial' or None.
277
'full' means generate the complete diff - adds/deletes/modifies/etc;
278
'partial' means filter the diff using specific_fileids;
279
None means do not generate any diff.
281
:param _match_using_deltas: a private parameter controlling the
282
algorithm used for matching specific_fileids. This parameter
283
may be removed in the future so bzrlib client code should NOT
286
:param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
287
range operator or as a graph difference.
289
:param signature: show digital signature information
291
:param match: Dictionary of list of search strings to use when filtering
292
revisions. Keys can be 'message', 'author', 'committer', 'bugs' or
293
the empty string to match any of the preceding properties.
295
:param omit_merges: If True, commits with more than one parent are
299
# Take care of old style message_search parameter
302
if 'message' in match:
303
match['message'].append(message_search)
305
match['message'] = [message_search]
307
match={ 'message': [message_search] }
309
'direction': direction,
310
'specific_fileids': specific_fileids,
311
'start_revision': start_revision,
312
'end_revision': end_revision,
315
'generate_tags': generate_tags,
316
'delta_type': delta_type,
317
'diff_type': diff_type,
318
'exclude_common_ancestry': exclude_common_ancestry,
319
'signature': signature,
321
'omit_merges': omit_merges,
322
# Add 'private' attributes for features that may be deprecated
323
'_match_using_deltas': _match_using_deltas,
327
def _apply_log_request_defaults(rqst):
328
"""Apply default values to a request dictionary."""
329
result = _DEFAULT_REQUEST_PARAMS.copy()
335
def format_signature_validity(rev_id, repo):
336
"""get the signature validity
338
:param rev_id: revision id to validate
339
:param repo: repository of revision
340
:return: human readable string to print to log
342
from bzrlib import gpg
344
gpg_strategy = gpg.GPGStrategy(None)
345
result = repo.verify_revision_signature(rev_id, gpg_strategy)
346
if result[0] == gpg.SIGNATURE_VALID:
347
return "valid signature from {0}".format(result[1])
348
if result[0] == gpg.SIGNATURE_KEY_MISSING:
349
return "unknown key {0}".format(result[1])
350
if result[0] == gpg.SIGNATURE_NOT_VALID:
351
return "invalid signature!"
352
if result[0] == gpg.SIGNATURE_NOT_SIGNED:
353
return "no signature"
356
class LogGenerator(object):
357
"""A generator of log revisions."""
359
def iter_log_revisions(self):
360
"""Iterate over LogRevision objects.
362
:return: An iterator yielding LogRevision objects.
364
raise NotImplementedError(self.iter_log_revisions)
367
class Logger(object):
368
"""An object that generates, formats and displays a log."""
370
def __init__(self, branch, rqst):
373
:param branch: the branch to log
374
:param rqst: A dictionary specifying the query parameters.
375
See make_log_request_dict() for supported values.
378
self.rqst = _apply_log_request_defaults(rqst)
383
:param lf: The LogFormatter object to send the output to.
385
if not isinstance(lf, LogFormatter):
386
warn("not a LogFormatter instance: %r" % lf)
388
self.branch.lock_read()
390
if getattr(lf, 'begin_log', None):
393
if getattr(lf, 'end_log', None):
398
def _show_body(self, lf):
399
"""Show the main log output.
401
Subclasses may wish to override this.
403
# Tweak the LogRequest based on what the LogFormatter can handle.
404
# (There's no point generating stuff if the formatter can't display it.)
406
if rqst['levels'] is None or lf.get_levels() > rqst['levels']:
407
# user didn't specify levels, use whatever the LF can handle:
408
rqst['levels'] = lf.get_levels()
410
if not getattr(lf, 'supports_tags', False):
411
rqst['generate_tags'] = False
412
if not getattr(lf, 'supports_delta', False):
413
rqst['delta_type'] = None
414
if not getattr(lf, 'supports_diff', False):
415
rqst['diff_type'] = None
416
if not getattr(lf, 'supports_signatures', False):
417
rqst['signature'] = False
419
# Find and print the interesting revisions
420
generator = self._generator_factory(self.branch, rqst)
421
for lr in generator.iter_log_revisions():
425
def _generator_factory(self, branch, rqst):
426
"""Make the LogGenerator object to use.
428
Subclasses may wish to override this.
430
return _DefaultLogGenerator(branch, rqst)
433
class _StartNotLinearAncestor(Exception):
434
"""Raised when a start revision is not found walking left-hand history."""
437
class _DefaultLogGenerator(LogGenerator):
438
"""The default generator of log revisions."""
440
def __init__(self, branch, rqst):
443
if rqst.get('generate_tags') and branch.supports_tags():
444
self.rev_tag_dict = branch.tags.get_reverse_tag_dict()
446
self.rev_tag_dict = {}
448
def iter_log_revisions(self):
449
"""Iterate over LogRevision objects.
451
:return: An iterator yielding LogRevision objects.
454
levels = rqst.get('levels')
455
limit = rqst.get('limit')
456
diff_type = rqst.get('diff_type')
457
show_signature = rqst.get('signature')
458
omit_merges = rqst.get('omit_merges')
460
revision_iterator = self._create_log_revision_iterator()
461
for revs in revision_iterator:
462
for (rev_id, revno, merge_depth), rev, delta in revs:
463
# 0 levels means show everything; merge_depth counts from 0
464
if levels != 0 and merge_depth >= levels:
466
if omit_merges and len(rev.parent_ids) > 1:
468
if diff_type is None:
471
diff = self._format_diff(rev, rev_id, diff_type)
473
signature = format_signature_validity(rev_id,
474
self.branch.repository)
477
yield LogRevision(rev, revno, merge_depth, delta,
478
self.rev_tag_dict.get(rev_id), diff, signature)
481
if log_count >= limit:
484
def _format_diff(self, rev, rev_id, diff_type):
485
repo = self.branch.repository
486
if len(rev.parent_ids) == 0:
487
ancestor_id = _mod_revision.NULL_REVISION
489
ancestor_id = rev.parent_ids[0]
490
tree_1 = repo.revision_tree(ancestor_id)
491
tree_2 = repo.revision_tree(rev_id)
492
file_ids = self.rqst.get('specific_fileids')
493
if diff_type == 'partial' and file_ids is not None:
494
specific_files = [tree_2.id2path(id) for id in file_ids]
496
specific_files = None
498
path_encoding = get_diff_header_encoding()
499
diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
500
new_label='', path_encoding=path_encoding)
503
def _create_log_revision_iterator(self):
504
"""Create a revision iterator for log.
506
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
509
self.start_rev_id, self.end_rev_id = _get_revision_limits(
510
self.branch, self.rqst.get('start_revision'),
511
self.rqst.get('end_revision'))
512
if self.rqst.get('_match_using_deltas'):
513
return self._log_revision_iterator_using_delta_matching()
515
# We're using the per-file-graph algorithm. This scales really
516
# well but only makes sense if there is a single file and it's
518
file_count = len(self.rqst.get('specific_fileids'))
520
raise BzrError("illegal LogRequest: must match-using-deltas "
521
"when logging %d files" % file_count)
522
return self._log_revision_iterator_using_per_file_graph()
524
def _log_revision_iterator_using_delta_matching(self):
525
# Get the base revisions, filtering by the revision range
527
generate_merge_revisions = rqst.get('levels') != 1
528
delayed_graph_generation = not rqst.get('specific_fileids') and (
529
rqst.get('limit') or self.start_rev_id or self.end_rev_id)
530
view_revisions = _calc_view_revisions(
531
self.branch, self.start_rev_id, self.end_rev_id,
532
rqst.get('direction'),
533
generate_merge_revisions=generate_merge_revisions,
534
delayed_graph_generation=delayed_graph_generation,
535
exclude_common_ancestry=rqst.get('exclude_common_ancestry'))
537
# Apply the other filters
538
return make_log_rev_iterator(self.branch, view_revisions,
539
rqst.get('delta_type'), rqst.get('match'),
540
file_ids=rqst.get('specific_fileids'),
541
direction=rqst.get('direction'))
543
def _log_revision_iterator_using_per_file_graph(self):
544
# Get the base revisions, filtering by the revision range.
545
# Note that we always generate the merge revisions because
546
# filter_revisions_touching_file_id() requires them ...
548
view_revisions = _calc_view_revisions(
549
self.branch, self.start_rev_id, self.end_rev_id,
550
rqst.get('direction'), generate_merge_revisions=True,
551
exclude_common_ancestry=rqst.get('exclude_common_ancestry'))
552
if not isinstance(view_revisions, list):
553
view_revisions = list(view_revisions)
554
view_revisions = _filter_revisions_touching_file_id(self.branch,
555
rqst.get('specific_fileids')[0], view_revisions,
556
include_merges=rqst.get('levels') != 1)
557
return make_log_rev_iterator(self.branch, view_revisions,
558
rqst.get('delta_type'), rqst.get('match'))
561
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
562
generate_merge_revisions,
563
delayed_graph_generation=False,
564
exclude_common_ancestry=False,
566
"""Calculate the revisions to view.
568
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
569
a list of the same tuples.
571
if (exclude_common_ancestry and start_rev_id == end_rev_id):
572
raise errors.BzrCommandError(gettext(
573
'--exclude-common-ancestry requires two different revisions'))
574
if direction not in ('reverse', 'forward'):
575
raise ValueError(gettext('invalid direction %r') % direction)
576
br_revno, br_rev_id = branch.last_revision_info()
580
if (end_rev_id and start_rev_id == end_rev_id
581
and (not generate_merge_revisions
582
or not _has_merges(branch, end_rev_id))):
583
# If a single revision is requested, check we can handle it
584
return _generate_one_revision(branch, end_rev_id, br_rev_id,
586
if not generate_merge_revisions:
588
# If we only want to see linear revisions, we can iterate ...
589
iter_revs = _linear_view_revisions(
590
branch, start_rev_id, end_rev_id,
591
exclude_common_ancestry=exclude_common_ancestry)
592
# If a start limit was given and it's not obviously an
593
# ancestor of the end limit, check it before outputting anything
594
if (direction == 'forward'
595
or (start_rev_id and not _is_obvious_ancestor(
596
branch, start_rev_id, end_rev_id))):
597
iter_revs = list(iter_revs)
598
if direction == 'forward':
599
iter_revs = reversed(iter_revs)
601
except _StartNotLinearAncestor:
602
# Switch to the slower implementation that may be able to find a
603
# non-obvious ancestor out of the left-hand history.
605
iter_revs = _generate_all_revisions(branch, start_rev_id, end_rev_id,
606
direction, delayed_graph_generation,
607
exclude_common_ancestry)
608
if direction == 'forward':
609
iter_revs = _rebase_merge_depth(reverse_by_depth(list(iter_revs)))
613
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
614
if rev_id == br_rev_id:
616
return [(br_rev_id, br_revno, 0)]
618
revno_str = _compute_revno_str(branch, rev_id)
619
return [(rev_id, revno_str, 0)]
622
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
623
delayed_graph_generation,
624
exclude_common_ancestry=False):
625
# On large trees, generating the merge graph can take 30-60 seconds
626
# so we delay doing it until a merge is detected, incrementally
627
# returning initial (non-merge) revisions while we can.
629
# The above is only true for old formats (<= 0.92), for newer formats, a
630
# couple of seconds only should be needed to load the whole graph and the
631
# other graph operations needed are even faster than that -- vila 100201
632
initial_revisions = []
633
if delayed_graph_generation:
635
for rev_id, revno, depth in _linear_view_revisions(
636
branch, start_rev_id, end_rev_id, exclude_common_ancestry):
637
if _has_merges(branch, rev_id):
638
# The end_rev_id can be nested down somewhere. We need an
639
# explicit ancestry check. There is an ambiguity here as we
640
# may not raise _StartNotLinearAncestor for a revision that
641
# is an ancestor but not a *linear* one. But since we have
642
# loaded the graph to do the check (or calculate a dotted
643
# revno), we may as well accept to show the log... We need
644
# the check only if start_rev_id is not None as all
645
# revisions have _mod_revision.NULL_REVISION as an ancestor
647
graph = branch.repository.get_graph()
648
if (start_rev_id is not None
649
and not graph.is_ancestor(start_rev_id, end_rev_id)):
650
raise _StartNotLinearAncestor()
651
# Since we collected the revisions so far, we need to
656
initial_revisions.append((rev_id, revno, depth))
658
# No merged revisions found
659
return initial_revisions
660
except _StartNotLinearAncestor:
661
# A merge was never detected so the lower revision limit can't
662
# be nested down somewhere
663
raise errors.BzrCommandError(gettext('Start revision not found in'
664
' history of end revision.'))
666
# We exit the loop above because we encounter a revision with merges, from
667
# this revision, we need to switch to _graph_view_revisions.
669
# A log including nested merges is required. If the direction is reverse,
670
# we rebase the initial merge depths so that the development line is
671
# shown naturally, i.e. just like it is for linear logging. We can easily
672
# make forward the exact opposite display, but showing the merge revisions
673
# indented at the end seems slightly nicer in that case.
674
view_revisions = chain(iter(initial_revisions),
675
_graph_view_revisions(branch, start_rev_id, end_rev_id,
676
rebase_initial_depths=(direction == 'reverse'),
677
exclude_common_ancestry=exclude_common_ancestry))
678
return view_revisions
681
def _has_merges(branch, rev_id):
682
"""Does a revision have multiple parents or not?"""
683
parents = branch.repository.get_parent_map([rev_id]).get(rev_id, [])
684
return len(parents) > 1
687
def _compute_revno_str(branch, rev_id):
688
"""Compute the revno string from a rev_id.
690
:return: The revno string, or None if the revision is not in the supplied
694
revno = branch.revision_id_to_dotted_revno(rev_id)
695
except errors.NoSuchRevision:
696
# The revision must be outside of this branch
699
return '.'.join(str(n) for n in revno)
702
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
703
"""Is start_rev_id an obvious ancestor of end_rev_id?"""
704
if start_rev_id and end_rev_id:
706
start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
707
end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
708
except errors.NoSuchRevision:
709
# one or both is not in the branch; not obvious
711
if len(start_dotted) == 1 and len(end_dotted) == 1:
713
return start_dotted[0] <= end_dotted[0]
714
elif (len(start_dotted) == 3 and len(end_dotted) == 3 and
715
start_dotted[0:1] == end_dotted[0:1]):
716
# both on same development line
717
return start_dotted[2] <= end_dotted[2]
721
# if either start or end is not specified then we use either the first or
722
# the last revision and *they* are obvious ancestors.
726
def _linear_view_revisions(branch, start_rev_id, end_rev_id,
727
exclude_common_ancestry=False):
728
"""Calculate a sequence of revisions to view, newest to oldest.
730
:param start_rev_id: the lower revision-id
731
:param end_rev_id: the upper revision-id
732
:param exclude_common_ancestry: Whether the start_rev_id should be part of
733
the iterated revisions.
734
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
735
:raises _StartNotLinearAncestor: if a start_rev_id is specified but
736
is not found walking the left-hand history
738
br_revno, br_rev_id = branch.last_revision_info()
739
repo = branch.repository
740
graph = repo.get_graph()
741
if start_rev_id is None and end_rev_id is None:
743
for revision_id in graph.iter_lefthand_ancestry(br_rev_id,
744
(_mod_revision.NULL_REVISION,)):
745
yield revision_id, str(cur_revno), 0
748
if end_rev_id is None:
749
end_rev_id = br_rev_id
750
found_start = start_rev_id is None
751
for revision_id in graph.iter_lefthand_ancestry(end_rev_id,
752
(_mod_revision.NULL_REVISION,)):
753
revno_str = _compute_revno_str(branch, revision_id)
754
if not found_start and revision_id == start_rev_id:
755
if not exclude_common_ancestry:
756
yield revision_id, revno_str, 0
760
yield revision_id, revno_str, 0
763
raise _StartNotLinearAncestor()
766
def _graph_view_revisions(branch, start_rev_id, end_rev_id,
767
rebase_initial_depths=True,
768
exclude_common_ancestry=False):
769
"""Calculate revisions to view including merges, newest to oldest.
771
:param branch: the branch
772
:param start_rev_id: the lower revision-id
773
:param end_rev_id: the upper revision-id
774
:param rebase_initial_depth: should depths be rebased until a mainline
776
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
778
if exclude_common_ancestry:
779
stop_rule = 'with-merges-without-common-ancestry'
781
stop_rule = 'with-merges'
782
view_revisions = branch.iter_merge_sorted_revisions(
783
start_revision_id=end_rev_id, stop_revision_id=start_rev_id,
785
if not rebase_initial_depths:
786
for (rev_id, merge_depth, revno, end_of_merge
788
yield rev_id, '.'.join(map(str, revno)), merge_depth
790
# We're following a development line starting at a merged revision.
791
# We need to adjust depths down by the initial depth until we find
792
# a depth less than it. Then we use that depth as the adjustment.
793
# If and when we reach the mainline, depth adjustment ends.
794
depth_adjustment = None
795
for (rev_id, merge_depth, revno, end_of_merge
797
if depth_adjustment is None:
798
depth_adjustment = merge_depth
800
if merge_depth < depth_adjustment:
801
# From now on we reduce the depth adjustement, this can be
802
# surprising for users. The alternative requires two passes
803
# which breaks the fast display of the first revision
805
depth_adjustment = merge_depth
806
merge_depth -= depth_adjustment
807
yield rev_id, '.'.join(map(str, revno)), merge_depth
810
def _rebase_merge_depth(view_revisions):
811
"""Adjust depths upwards so the top level is 0."""
812
# If either the first or last revision have a merge_depth of 0, we're done
813
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
814
min_depth = min([d for r,n,d in view_revisions])
816
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
817
return view_revisions
820
def make_log_rev_iterator(branch, view_revisions, generate_delta, search,
821
file_ids=None, direction='reverse'):
822
"""Create a revision iterator for log.
824
:param branch: The branch being logged.
825
:param view_revisions: The revisions being viewed.
826
:param generate_delta: Whether to generate a delta for each revision.
827
Permitted values are None, 'full' and 'partial'.
828
:param search: A user text search string.
829
:param file_ids: If non empty, only revisions matching one or more of
830
the file-ids are to be kept.
831
:param direction: the direction in which view_revisions is sorted
832
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
835
# Convert view_revisions into (view, None, None) groups to fit with
836
# the standard interface here.
837
if type(view_revisions) == list:
838
# A single batch conversion is faster than many incremental ones.
839
# As we have all the data, do a batch conversion.
840
nones = [None] * len(view_revisions)
841
log_rev_iterator = iter([zip(view_revisions, nones, nones)])
844
for view in view_revisions:
845
yield (view, None, None)
846
log_rev_iterator = iter([_convert()])
847
for adapter in log_adapters:
848
# It would be nicer if log adapters were first class objects
849
# with custom parameters. This will do for now. IGC 20090127
850
if adapter == _make_delta_filter:
851
log_rev_iterator = adapter(branch, generate_delta,
852
search, log_rev_iterator, file_ids, direction)
854
log_rev_iterator = adapter(branch, generate_delta,
855
search, log_rev_iterator)
856
return log_rev_iterator
859
def _make_search_filter(branch, generate_delta, match, log_rev_iterator):
860
"""Create a filtered iterator of log_rev_iterator matching on a regex.
862
:param branch: The branch being logged.
863
:param generate_delta: Whether to generate a delta for each revision.
864
:param match: A dictionary with properties as keys and lists of strings
865
as values. To match, a revision may match any of the supplied strings
866
within a single property but must match at least one string for each
868
:param log_rev_iterator: An input iterator containing all revisions that
869
could be displayed, in lists.
870
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
874
return log_rev_iterator
875
searchRE = [(k, [re.compile(x, re.IGNORECASE) for x in v])
876
for (k,v) in match.iteritems()]
877
return _filter_re(searchRE, log_rev_iterator)
880
def _filter_re(searchRE, log_rev_iterator):
881
for revs in log_rev_iterator:
882
new_revs = [rev for rev in revs if _match_filter(searchRE, rev[1])]
886
def _match_filter(searchRE, rev):
888
'message': (rev.message,),
889
'committer': (rev.committer,),
890
'author': (rev.get_apparent_authors()),
891
'bugs': list(rev.iter_bugs())
893
strings[''] = [item for inner_list in strings.itervalues()
894
for item in inner_list]
895
for (k,v) in searchRE:
896
if k in strings and not _match_any_filter(strings[k], v):
900
def _match_any_filter(strings, res):
901
return any([filter(None, map(re.search, strings)) for re in res])
903
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
904
fileids=None, direction='reverse'):
905
"""Add revision deltas to a log iterator if needed.
907
:param branch: The branch being logged.
908
:param generate_delta: Whether to generate a delta for each revision.
909
Permitted values are None, 'full' and 'partial'.
910
:param search: A user text search string.
911
:param log_rev_iterator: An input iterator containing all revisions that
912
could be displayed, in lists.
913
:param fileids: If non empty, only revisions matching one or more of
914
the file-ids are to be kept.
915
:param direction: the direction in which view_revisions is sorted
916
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
919
if not generate_delta and not fileids:
920
return log_rev_iterator
921
return _generate_deltas(branch.repository, log_rev_iterator,
922
generate_delta, fileids, direction)
925
def _generate_deltas(repository, log_rev_iterator, delta_type, fileids,
927
"""Create deltas for each batch of revisions in log_rev_iterator.
929
If we're only generating deltas for the sake of filtering against
930
file-ids, we stop generating deltas once all file-ids reach the
931
appropriate life-cycle point. If we're receiving data newest to
932
oldest, then that life-cycle point is 'add', otherwise it's 'remove'.
934
check_fileids = fileids is not None and len(fileids) > 0
936
fileid_set = set(fileids)
937
if direction == 'reverse':
943
for revs in log_rev_iterator:
944
# If we were matching against fileids and we've run out,
945
# there's nothing left to do
946
if check_fileids and not fileid_set:
948
revisions = [rev[1] for rev in revs]
950
if delta_type == 'full' and not check_fileids:
951
deltas = repository.get_deltas_for_revisions(revisions)
952
for rev, delta in izip(revs, deltas):
953
new_revs.append((rev[0], rev[1], delta))
955
deltas = repository.get_deltas_for_revisions(revisions, fileid_set)
956
for rev, delta in izip(revs, deltas):
958
if delta is None or not delta.has_changed():
961
_update_fileids(delta, fileid_set, stop_on)
962
if delta_type is None:
964
elif delta_type == 'full':
965
# If the file matches all the time, rebuilding
966
# a full delta like this in addition to a partial
967
# one could be slow. However, it's likely that
968
# most revisions won't get this far, making it
969
# faster to filter on the partial deltas and
970
# build the occasional full delta than always
971
# building full deltas and filtering those.
973
delta = repository.get_revision_delta(rev_id)
974
new_revs.append((rev[0], rev[1], delta))
978
def _update_fileids(delta, fileids, stop_on):
979
"""Update the set of file-ids to search based on file lifecycle events.
981
:param fileids: a set of fileids to update
982
:param stop_on: either 'add' or 'remove' - take file-ids out of the
983
fileids set once their add or remove entry is detected respectively
986
for item in delta.added:
987
if item[1] in fileids:
988
fileids.remove(item[1])
989
elif stop_on == 'delete':
990
for item in delta.removed:
991
if item[1] in fileids:
992
fileids.remove(item[1])
995
def _make_revision_objects(branch, generate_delta, search, log_rev_iterator):
996
"""Extract revision objects from the repository
998
:param branch: The branch being logged.
999
:param generate_delta: Whether to generate a delta for each revision.
1000
:param search: A user text search string.
1001
:param log_rev_iterator: An input iterator containing all revisions that
1002
could be displayed, in lists.
1003
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
1006
repository = branch.repository
1007
for revs in log_rev_iterator:
1008
# r = revision_id, n = revno, d = merge depth
1009
revision_ids = [view[0] for view, _, _ in revs]
1010
revisions = repository.get_revisions(revision_ids)
1011
revs = [(rev[0], revision, rev[2]) for rev, revision in
1012
izip(revs, revisions)]
1016
def _make_batch_filter(branch, generate_delta, search, log_rev_iterator):
1017
"""Group up a single large batch into smaller ones.
1019
:param branch: The branch being logged.
1020
:param generate_delta: Whether to generate a delta for each revision.
1021
:param search: A user text search string.
1022
:param log_rev_iterator: An input iterator containing all revisions that
1023
could be displayed, in lists.
1024
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
1028
for batch in log_rev_iterator:
1031
step = [detail for _, detail in zip(range(num), batch)]
1035
num = min(int(num * 1.5), 200)
1038
def _get_revision_limits(branch, start_revision, end_revision):
1039
"""Get and check revision limits.
1041
:param branch: The branch containing the revisions.
1043
:param start_revision: The first revision to be logged.
1044
For backwards compatibility this may be a mainline integer revno,
1045
but for merge revision support a RevisionInfo is expected.
1047
:param end_revision: The last revision to be logged.
1048
For backwards compatibility this may be a mainline integer revno,
1049
but for merge revision support a RevisionInfo is expected.
1051
:return: (start_rev_id, end_rev_id) tuple.
1053
branch_revno, branch_rev_id = branch.last_revision_info()
1055
if start_revision is None:
1058
if isinstance(start_revision, revisionspec.RevisionInfo):
1059
start_rev_id = start_revision.rev_id
1060
start_revno = start_revision.revno or 1
1062
branch.check_real_revno(start_revision)
1063
start_revno = start_revision
1064
start_rev_id = branch.get_rev_id(start_revno)
1067
if end_revision is None:
1068
end_revno = branch_revno
1070
if isinstance(end_revision, revisionspec.RevisionInfo):
1071
end_rev_id = end_revision.rev_id
1072
end_revno = end_revision.revno or branch_revno
1074
branch.check_real_revno(end_revision)
1075
end_revno = end_revision
1076
end_rev_id = branch.get_rev_id(end_revno)
1078
if branch_revno != 0:
1079
if (start_rev_id == _mod_revision.NULL_REVISION
1080
or end_rev_id == _mod_revision.NULL_REVISION):
1081
raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
1082
if start_revno > end_revno:
1083
raise errors.BzrCommandError(gettext("Start revision must be "
1084
"older than the end revision."))
1085
return (start_rev_id, end_rev_id)
1088
def _get_mainline_revs(branch, start_revision, end_revision):
1089
"""Get the mainline revisions from the branch.
1091
Generates the list of mainline revisions for the branch.
1093
:param branch: The branch containing the revisions.
1095
:param start_revision: The first revision to be logged.
1096
For backwards compatibility this may be a mainline integer revno,
1097
but for merge revision support a RevisionInfo is expected.
1099
:param end_revision: The last revision to be logged.
1100
For backwards compatibility this may be a mainline integer revno,
1101
but for merge revision support a RevisionInfo is expected.
1103
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
1105
branch_revno, branch_last_revision = branch.last_revision_info()
1106
if branch_revno == 0:
1107
return None, None, None, None
1109
# For mainline generation, map start_revision and end_revision to
1110
# mainline revnos. If the revision is not on the mainline choose the
1111
# appropriate extreme of the mainline instead - the extra will be
1113
# Also map the revisions to rev_ids, to be used in the later filtering
1116
if start_revision is None:
1119
if isinstance(start_revision, revisionspec.RevisionInfo):
1120
start_rev_id = start_revision.rev_id
1121
start_revno = start_revision.revno or 1
1123
branch.check_real_revno(start_revision)
1124
start_revno = start_revision
1127
if end_revision is None:
1128
end_revno = branch_revno
1130
if isinstance(end_revision, revisionspec.RevisionInfo):
1131
end_rev_id = end_revision.rev_id
1132
end_revno = end_revision.revno or branch_revno
1134
branch.check_real_revno(end_revision)
1135
end_revno = end_revision
1137
if ((start_rev_id == _mod_revision.NULL_REVISION)
1138
or (end_rev_id == _mod_revision.NULL_REVISION)):
1139
raise errors.BzrCommandError(gettext('Logging revision 0 is invalid.'))
1140
if start_revno > end_revno:
1141
raise errors.BzrCommandError(gettext("Start revision must be older "
1142
"than the end revision."))
1144
if end_revno < start_revno:
1145
return None, None, None, None
1146
cur_revno = branch_revno
1149
graph = branch.repository.get_graph()
1150
for revision_id in graph.iter_lefthand_ancestry(
1151
branch_last_revision, (_mod_revision.NULL_REVISION,)):
1152
if cur_revno < start_revno:
1153
# We have gone far enough, but we always add 1 more revision
1154
rev_nos[revision_id] = cur_revno
1155
mainline_revs.append(revision_id)
1157
if cur_revno <= end_revno:
1158
rev_nos[revision_id] = cur_revno
1159
mainline_revs.append(revision_id)
1162
# We walked off the edge of all revisions, so we add a 'None' marker
1163
mainline_revs.append(None)
1165
mainline_revs.reverse()
1167
# override the mainline to look like the revision history.
1168
return mainline_revs, rev_nos, start_rev_id, end_rev_id
1171
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1172
include_merges=True):
1173
r"""Return the list of revision ids which touch a given file id.
1175
The function filters view_revisions and returns a subset.
1176
This includes the revisions which directly change the file id,
1177
and the revisions which merge these changes. So if the
1190
And 'C' changes a file, then both C and D will be returned. F will not be
1191
returned even though it brings the changes to C into the branch starting
1192
with E. (Note that if we were using F as the tip instead of G, then we
1195
This will also be restricted based on a subset of the mainline.
1197
:param branch: The branch where we can get text revision information.
1199
:param file_id: Filter out revisions that do not touch file_id.
1201
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1202
tuples. This is the list of revisions which will be filtered. It is
1203
assumed that view_revisions is in merge_sort order (i.e. newest
1206
:param include_merges: include merge revisions in the result or not
1208
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
1210
# Lookup all possible text keys to determine which ones actually modified
1212
graph = branch.repository.get_file_graph()
1213
get_parent_map = graph.get_parent_map
1214
text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
1216
# Looking up keys in batches of 1000 can cut the time in half, as well as
1217
# memory consumption. GraphIndex *does* like to look for a few keys in
1218
# parallel, it just doesn't like looking for *lots* of keys in parallel.
1219
# TODO: This code needs to be re-evaluated periodically as we tune the
1220
# indexing layer. We might consider passing in hints as to the known
1221
# access pattern (sparse/clustered, high success rate/low success
1222
# rate). This particular access is clustered with a low success rate.
1223
modified_text_revisions = set()
1225
for start in xrange(0, len(text_keys), chunk_size):
1226
next_keys = text_keys[start:start + chunk_size]
1227
# Only keep the revision_id portion of the key
1228
modified_text_revisions.update(
1229
[k[1] for k in get_parent_map(next_keys)])
1230
del text_keys, next_keys
1233
# Track what revisions will merge the current revision, replace entries
1234
# with 'None' when they have been added to result
1235
current_merge_stack = [None]
1236
for info in view_revisions:
1237
rev_id, revno, depth = info
1238
if depth == len(current_merge_stack):
1239
current_merge_stack.append(info)
1241
del current_merge_stack[depth + 1:]
1242
current_merge_stack[-1] = info
1244
if rev_id in modified_text_revisions:
1245
# This needs to be logged, along with the extra revisions
1246
for idx in xrange(len(current_merge_stack)):
1247
node = current_merge_stack[idx]
1248
if node is not None:
1249
if include_merges or node[2] == 0:
1251
current_merge_stack[idx] = None
1255
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1256
"""Reverse revisions by depth.
1258
Revisions with a different depth are sorted as a group with the previous
1259
revision of that depth. There may be no topological justification for this,
1260
but it looks much nicer.
1262
# Add a fake revision at start so that we can always attach sub revisions
1263
merge_sorted_revisions = [(None, None, _depth)] + merge_sorted_revisions
1265
for val in merge_sorted_revisions:
1266
if val[2] == _depth:
1267
# Each revision at the current depth becomes a chunk grouping all
1268
# higher depth revisions.
1269
zd_revisions.append([val])
1271
zd_revisions[-1].append(val)
1272
for revisions in zd_revisions:
1273
if len(revisions) > 1:
1274
# We have higher depth revisions, let reverse them locally
1275
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
1276
zd_revisions.reverse()
1278
for chunk in zd_revisions:
1279
result.extend(chunk)
1281
# Top level call, get rid of the fake revisions that have been added
1282
result = [r for r in result if r[0] is not None and r[1] is not None]
1286
class LogRevision(object):
1287
"""A revision to be logged (by LogFormatter.log_revision).
1289
A simple wrapper for the attributes of a revision to be logged.
1290
The attributes may or may not be populated, as determined by the
1291
logging options and the log formatter capabilities.
1294
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1295
tags=None, diff=None, signature=None):
1300
self.revno = str(revno)
1301
self.merge_depth = merge_depth
1305
self.signature = signature
1308
class LogFormatter(object):
1309
"""Abstract class to display log messages.
1311
At a minimum, a derived class must implement the log_revision method.
1313
If the LogFormatter needs to be informed of the beginning or end of
1314
a log it should implement the begin_log and/or end_log hook methods.
1316
A LogFormatter should define the following supports_XXX flags
1317
to indicate which LogRevision attributes it supports:
1319
- supports_delta must be True if this log formatter supports delta.
1320
Otherwise the delta attribute may not be populated. The 'delta_format'
1321
attribute describes whether the 'short_status' format (1) or the long
1322
one (2) should be used.
1324
- supports_merge_revisions must be True if this log formatter supports
1325
merge revisions. If not, then only mainline revisions will be passed
1328
- preferred_levels is the number of levels this formatter defaults to.
1329
The default value is zero meaning display all levels.
1330
This value is only relevant if supports_merge_revisions is True.
1332
- supports_tags must be True if this log formatter supports tags.
1333
Otherwise the tags attribute may not be populated.
1335
- supports_diff must be True if this log formatter supports diffs.
1336
Otherwise the diff attribute may not be populated.
1338
- supports_signatures must be True if this log formatter supports GPG
1341
Plugins can register functions to show custom revision properties using
1342
the properties_handler_registry. The registered function
1343
must respect the following interface description::
1345
def my_show_properties(properties_dict):
1346
# code that returns a dict {'name':'value'} of the properties
1349
preferred_levels = 0
1351
def __init__(self, to_file, show_ids=False, show_timezone='original',
1352
delta_format=None, levels=None, show_advice=False,
1353
to_exact_file=None, author_list_handler=None):
1354
"""Create a LogFormatter.
1356
:param to_file: the file to output to
1357
:param to_exact_file: if set, gives an output stream to which
1358
non-Unicode diffs are written.
1359
:param show_ids: if True, revision-ids are to be displayed
1360
:param show_timezone: the timezone to use
1361
:param delta_format: the level of delta information to display
1362
or None to leave it to the formatter to decide
1363
:param levels: the number of levels to display; None or -1 to
1364
let the log formatter decide.
1365
:param show_advice: whether to show advice at the end of the
1367
:param author_list_handler: callable generating a list of
1368
authors to display for a given revision
1370
self.to_file = to_file
1371
# 'exact' stream used to show diff, it should print content 'as is'
1372
# and should not try to decode/encode it to unicode to avoid bug #328007
1373
if to_exact_file is not None:
1374
self.to_exact_file = to_exact_file
1376
# XXX: somewhat hacky; this assumes it's a codec writer; it's better
1377
# for code that expects to get diffs to pass in the exact file
1379
self.to_exact_file = getattr(to_file, 'stream', to_file)
1380
self.show_ids = show_ids
1381
self.show_timezone = show_timezone
1382
if delta_format is None:
1383
# Ensures backward compatibility
1384
delta_format = 2 # long format
1385
self.delta_format = delta_format
1386
self.levels = levels
1387
self._show_advice = show_advice
1388
self._merge_count = 0
1389
self._author_list_handler = author_list_handler
1391
def get_levels(self):
1392
"""Get the number of levels to display or 0 for all."""
1393
if getattr(self, 'supports_merge_revisions', False):
1394
if self.levels is None or self.levels == -1:
1395
self.levels = self.preferred_levels
1400
def log_revision(self, revision):
1403
:param revision: The LogRevision to be logged.
1405
raise NotImplementedError('not implemented in abstract base')
1407
def show_advice(self):
1408
"""Output user advice, if any, when the log is completed."""
1409
if self._show_advice and self.levels == 1 and self._merge_count > 0:
1410
advice_sep = self.get_advice_separator()
1412
self.to_file.write(advice_sep)
1414
"Use --include-merged or -n0 to see merged revisions.\n")
1416
def get_advice_separator(self):
1417
"""Get the text separating the log from the closing advice."""
1420
def short_committer(self, rev):
1421
name, address = config.parse_username(rev.committer)
1426
def short_author(self, rev):
1427
return self.authors(rev, 'first', short=True, sep=', ')
1429
def authors(self, rev, who, short=False, sep=None):
1430
"""Generate list of authors, taking --authors option into account.
1432
The caller has to specify the name of a author list handler,
1433
as provided by the author list registry, using the ``who``
1434
argument. That name only sets a default, though: when the
1435
user selected a different author list generation using the
1436
``--authors`` command line switch, as represented by the
1437
``author_list_handler`` constructor argument, that value takes
1440
:param rev: The revision for which to generate the list of authors.
1441
:param who: Name of the default handler.
1442
:param short: Whether to shorten names to either name or address.
1443
:param sep: What separator to use for automatic concatenation.
1445
if self._author_list_handler is not None:
1446
# The user did specify --authors, which overrides the default
1447
author_list_handler = self._author_list_handler
1449
# The user didn't specify --authors, so we use the caller's default
1450
author_list_handler = author_list_registry.get(who)
1451
names = author_list_handler(rev)
1453
for i in range(len(names)):
1454
name, address = config.parse_username(names[i])
1460
names = sep.join(names)
1463
def merge_marker(self, revision):
1464
"""Get the merge marker to include in the output or '' if none."""
1465
if len(revision.rev.parent_ids) > 1:
1466
self._merge_count += 1
1471
def show_properties(self, revision, indent):
1472
"""Displays the custom properties returned by each registered handler.
1474
If a registered handler raises an error it is propagated.
1476
for line in self.custom_properties(revision):
1477
self.to_file.write("%s%s\n" % (indent, line))
1479
def custom_properties(self, revision):
1480
"""Format the custom properties returned by each registered handler.
1482
If a registered handler raises an error it is propagated.
1484
:return: a list of formatted lines (excluding trailing newlines)
1486
lines = self._foreign_info_properties(revision)
1487
for key, handler in properties_handler_registry.iteritems():
1488
lines.extend(self._format_properties(handler(revision)))
1491
def _foreign_info_properties(self, rev):
1492
"""Custom log displayer for foreign revision identifiers.
1494
:param rev: Revision object.
1496
# Revision comes directly from a foreign repository
1497
if isinstance(rev, foreign.ForeignRevision):
1498
return self._format_properties(
1499
rev.mapping.vcs.show_foreign_revid(rev.foreign_revid))
1501
# Imported foreign revision revision ids always contain :
1502
if not ":" in rev.revision_id:
1505
# Revision was once imported from a foreign repository
1507
foreign_revid, mapping = \
1508
foreign.foreign_vcs_registry.parse_revision_id(rev.revision_id)
1509
except errors.InvalidRevisionId:
1512
return self._format_properties(
1513
mapping.vcs.show_foreign_revid(foreign_revid))
1515
def _format_properties(self, properties):
1517
for key, value in properties.items():
1518
lines.append(key + ': ' + value)
1521
def show_diff(self, to_file, diff, indent):
1522
for l in diff.rstrip().split('\n'):
1523
to_file.write(indent + '%s\n' % (l,))
1526
# Separator between revisions in long format
1527
_LONG_SEP = '-' * 60
1530
class LongLogFormatter(LogFormatter):
1532
supports_merge_revisions = True
1533
preferred_levels = 1
1534
supports_delta = True
1535
supports_tags = True
1536
supports_diff = True
1537
supports_signatures = True
1539
def __init__(self, *args, **kwargs):
1540
super(LongLogFormatter, self).__init__(*args, **kwargs)
1541
if self.show_timezone == 'original':
1542
self.date_string = self._date_string_original_timezone
1544
self.date_string = self._date_string_with_timezone
1546
def _date_string_with_timezone(self, rev):
1547
return format_date(rev.timestamp, rev.timezone or 0,
1550
def _date_string_original_timezone(self, rev):
1551
return format_date_with_offset_in_original_timezone(rev.timestamp,
1554
def log_revision(self, revision):
1555
"""Log a revision, either merged or not."""
1556
indent = ' ' * revision.merge_depth
1558
if revision.revno is not None:
1559
lines.append('revno: %s%s' % (revision.revno,
1560
self.merge_marker(revision)))
1562
lines.append('tags: %s' % (', '.join(revision.tags)))
1563
if self.show_ids or revision.revno is None:
1564
lines.append('revision-id: %s' % (revision.rev.revision_id,))
1566
for parent_id in revision.rev.parent_ids:
1567
lines.append('parent: %s' % (parent_id,))
1568
lines.extend(self.custom_properties(revision.rev))
1570
committer = revision.rev.committer
1571
authors = self.authors(revision.rev, 'all')
1572
if authors != [committer]:
1573
lines.append('author: %s' % (", ".join(authors),))
1574
lines.append('committer: %s' % (committer,))
1576
branch_nick = revision.rev.properties.get('branch-nick', None)
1577
if branch_nick is not None:
1578
lines.append('branch nick: %s' % (branch_nick,))
1580
lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1582
if revision.signature is not None:
1583
lines.append('signature: ' + revision.signature)
1585
lines.append('message:')
1586
if not revision.rev.message:
1587
lines.append(' (no message)')
1589
message = revision.rev.message.rstrip('\r\n')
1590
for l in message.split('\n'):
1591
lines.append(' %s' % (l,))
1593
# Dump the output, appending the delta and diff if requested
1594
to_file = self.to_file
1595
to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
1596
if revision.delta is not None:
1597
# Use the standard status output to display changes
1598
from bzrlib.delta import report_delta
1599
report_delta(to_file, revision.delta, short_status=False,
1600
show_ids=self.show_ids, indent=indent)
1601
if revision.diff is not None:
1602
to_file.write(indent + 'diff:\n')
1604
# Note: we explicitly don't indent the diff (relative to the
1605
# revision information) so that the output can be fed to patch -p0
1606
self.show_diff(self.to_exact_file, revision.diff, indent)
1607
self.to_exact_file.flush()
1609
def get_advice_separator(self):
1610
"""Get the text separating the log from the closing advice."""
1611
return '-' * 60 + '\n'
1614
class ShortLogFormatter(LogFormatter):
1616
supports_merge_revisions = True
1617
preferred_levels = 1
1618
supports_delta = True
1619
supports_tags = True
1620
supports_diff = True
1622
def __init__(self, *args, **kwargs):
1623
super(ShortLogFormatter, self).__init__(*args, **kwargs)
1624
self.revno_width_by_depth = {}
1626
def log_revision(self, revision):
1627
# We need two indents: one per depth and one for the information
1628
# relative to that indent. Most mainline revnos are 5 chars or
1629
# less while dotted revnos are typically 11 chars or less. Once
1630
# calculated, we need to remember the offset for a given depth
1631
# as we might be starting from a dotted revno in the first column
1632
# and we want subsequent mainline revisions to line up.
1633
depth = revision.merge_depth
1634
indent = ' ' * depth
1635
revno_width = self.revno_width_by_depth.get(depth)
1636
if revno_width is None:
1637
if revision.revno is None or revision.revno.find('.') == -1:
1638
# mainline revno, e.g. 12345
1641
# dotted revno, e.g. 12345.10.55
1643
self.revno_width_by_depth[depth] = revno_width
1644
offset = ' ' * (revno_width + 1)
1646
to_file = self.to_file
1649
tags = ' {%s}' % (', '.join(revision.tags))
1650
to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1651
revision.revno or "", self.short_author(revision.rev),
1652
format_date(revision.rev.timestamp,
1653
revision.rev.timezone or 0,
1654
self.show_timezone, date_fmt="%Y-%m-%d",
1656
tags, self.merge_marker(revision)))
1657
self.show_properties(revision.rev, indent+offset)
1658
if self.show_ids or revision.revno is None:
1659
to_file.write(indent + offset + 'revision-id:%s\n'
1660
% (revision.rev.revision_id,))
1661
if not revision.rev.message:
1662
to_file.write(indent + offset + '(no message)\n')
1664
message = revision.rev.message.rstrip('\r\n')
1665
for l in message.split('\n'):
1666
to_file.write(indent + offset + '%s\n' % (l,))
1668
if revision.delta is not None:
1669
# Use the standard status output to display changes
1670
from bzrlib.delta import report_delta
1671
report_delta(to_file, revision.delta,
1672
short_status=self.delta_format==1,
1673
show_ids=self.show_ids, indent=indent + offset)
1674
if revision.diff is not None:
1675
self.show_diff(self.to_exact_file, revision.diff, ' ')
1679
class LineLogFormatter(LogFormatter):
1681
supports_merge_revisions = True
1682
preferred_levels = 1
1683
supports_tags = True
1685
def __init__(self, *args, **kwargs):
1686
super(LineLogFormatter, self).__init__(*args, **kwargs)
1687
width = terminal_width()
1688
if width is not None:
1689
# we need one extra space for terminals that wrap on last char
1691
self._max_chars = width
1693
def truncate(self, str, max_len):
1694
if max_len is None or len(str) <= max_len:
1696
return str[:max_len-3] + '...'
1698
def date_string(self, rev):
1699
return format_date(rev.timestamp, rev.timezone or 0,
1700
self.show_timezone, date_fmt="%Y-%m-%d",
1703
def message(self, rev):
1705
return '(no message)'
1709
def log_revision(self, revision):
1710
indent = ' ' * revision.merge_depth
1711
self.to_file.write(self.log_string(revision.revno, revision.rev,
1712
self._max_chars, revision.tags, indent))
1713
self.to_file.write('\n')
1715
def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1716
"""Format log info into one string. Truncate tail of string
1718
:param revno: revision number or None.
1719
Revision numbers counts from 1.
1720
:param rev: revision object
1721
:param max_chars: maximum length of resulting string
1722
:param tags: list of tags or None
1723
:param prefix: string to prefix each line
1724
:return: formatted truncated string
1728
# show revno only when is not None
1729
out.append("%s:" % revno)
1730
if max_chars is not None:
1731
out.append(self.truncate(self.short_author(rev), (max_chars+3)/4))
1733
out.append(self.short_author(rev))
1734
out.append(self.date_string(rev))
1735
if len(rev.parent_ids) > 1:
1736
out.append('[merge]')
1738
tag_str = '{%s}' % (', '.join(tags))
1740
out.append(rev.get_summary())
1741
return self.truncate(prefix + " ".join(out).rstrip('\n'), max_chars)
1744
class GnuChangelogLogFormatter(LogFormatter):
1746
supports_merge_revisions = True
1747
supports_delta = True
1749
def log_revision(self, revision):
1750
"""Log a revision, either merged or not."""
1751
to_file = self.to_file
1753
date_str = format_date(revision.rev.timestamp,
1754
revision.rev.timezone or 0,
1756
date_fmt='%Y-%m-%d',
1758
committer_str = self.authors(revision.rev, 'first', sep=', ')
1759
committer_str = committer_str.replace(' <', ' <')
1760
to_file.write('%s %s\n\n' % (date_str,committer_str))
1762
if revision.delta is not None and revision.delta.has_changed():
1763
for c in revision.delta.added + revision.delta.removed + revision.delta.modified:
1765
to_file.write('\t* %s:\n' % (path,))
1766
for c in revision.delta.renamed:
1767
oldpath,newpath = c[:2]
1768
# For renamed files, show both the old and the new path
1769
to_file.write('\t* %s:\n\t* %s:\n' % (oldpath,newpath))
1772
if not revision.rev.message:
1773
to_file.write('\tNo commit message\n')
1775
message = revision.rev.message.rstrip('\r\n')
1776
for l in message.split('\n'):
1777
to_file.write('\t%s\n' % (l.lstrip(),))
1781
def line_log(rev, max_chars):
1782
lf = LineLogFormatter(None)
1783
return lf.log_string(None, rev, max_chars)
1786
class LogFormatterRegistry(registry.Registry):
1787
"""Registry for log formatters"""
1789
def make_formatter(self, name, *args, **kwargs):
1790
"""Construct a formatter from arguments.
1792
:param name: Name of the formatter to construct. 'short', 'long' and
1793
'line' are built-in.
1795
return self.get(name)(*args, **kwargs)
1797
def get_default(self, branch):
1798
c = branch.get_config_stack()
1799
return self.get(c.get('log_format'))
1802
log_formatter_registry = LogFormatterRegistry()
1805
log_formatter_registry.register('short', ShortLogFormatter,
1806
'Moderately short log format.')
1807
log_formatter_registry.register('long', LongLogFormatter,
1808
'Detailed log format.')
1809
log_formatter_registry.register('line', LineLogFormatter,
1810
'Log format with one line per revision.')
1811
log_formatter_registry.register('gnu-changelog', GnuChangelogLogFormatter,
1812
'Format used by GNU ChangeLog files.')
1815
def register_formatter(name, formatter):
1816
log_formatter_registry.register(name, formatter)
1819
def log_formatter(name, *args, **kwargs):
1820
"""Construct a formatter from arguments.
1822
name -- Name of the formatter to construct; currently 'long', 'short' and
1823
'line' are supported.
1826
return log_formatter_registry.make_formatter(name, *args, **kwargs)
1828
raise errors.BzrCommandError(gettext("unknown log formatter: %r") % name)
1831
def author_list_all(rev):
1832
return rev.get_apparent_authors()[:]
1835
def author_list_first(rev):
1836
lst = rev.get_apparent_authors()
1843
def author_list_committer(rev):
1844
return [rev.committer]
1847
author_list_registry = registry.Registry()
1849
author_list_registry.register('all', author_list_all,
1852
author_list_registry.register('first', author_list_first,
1855
author_list_registry.register('committer', author_list_committer,
1859
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1861
"""Show the change in revision history comparing the old revision history to the new one.
1863
:param branch: The branch where the revisions exist
1864
:param old_rh: The old revision history
1865
:param new_rh: The new revision history
1866
:param to_file: A file to write the results to. If None, stdout will be used
1869
to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
1871
lf = log_formatter(log_format,
1874
show_timezone='original')
1876
# This is the first index which is different between
1879
for i in xrange(max(len(new_rh),
1881
if (len(new_rh) <= i
1883
or new_rh[i] != old_rh[i]):
1887
if base_idx is None:
1888
to_file.write('Nothing seems to have changed\n')
1890
## TODO: It might be nice to do something like show_log
1891
## and show the merged entries. But since this is the
1892
## removed revisions, it shouldn't be as important
1893
if base_idx < len(old_rh):
1894
to_file.write('*'*60)
1895
to_file.write('\nRemoved Revisions:\n')
1896
for i in range(base_idx, len(old_rh)):
1897
rev = branch.repository.get_revision(old_rh[i])
1898
lr = LogRevision(rev, i+1, 0, None)
1900
to_file.write('*'*60)
1901
to_file.write('\n\n')
1902
if base_idx < len(new_rh):
1903
to_file.write('Added Revisions:\n')
1908
direction='forward',
1909
start_revision=base_idx+1,
1910
end_revision=len(new_rh),
1914
def get_history_change(old_revision_id, new_revision_id, repository):
1915
"""Calculate the uncommon lefthand history between two revisions.
1917
:param old_revision_id: The original revision id.
1918
:param new_revision_id: The new revision id.
1919
:param repository: The repository to use for the calculation.
1921
return old_history, new_history
1924
old_revisions = set()
1926
new_revisions = set()
1927
graph = repository.get_graph()
1928
new_iter = graph.iter_lefthand_ancestry(new_revision_id)
1929
old_iter = graph.iter_lefthand_ancestry(old_revision_id)
1930
stop_revision = None
1933
while do_new or do_old:
1936
new_revision = new_iter.next()
1937
except StopIteration:
1940
new_history.append(new_revision)
1941
new_revisions.add(new_revision)
1942
if new_revision in old_revisions:
1943
stop_revision = new_revision
1947
old_revision = old_iter.next()
1948
except StopIteration:
1951
old_history.append(old_revision)
1952
old_revisions.add(old_revision)
1953
if old_revision in new_revisions:
1954
stop_revision = old_revision
1956
new_history.reverse()
1957
old_history.reverse()
1958
if stop_revision is not None:
1959
new_history = new_history[new_history.index(stop_revision) + 1:]
1960
old_history = old_history[old_history.index(stop_revision) + 1:]
1961
return old_history, new_history
1964
def show_branch_change(branch, output, old_revno, old_revision_id):
1965
"""Show the changes made to a branch.
1967
:param branch: The branch to show changes about.
1968
:param output: A file-like object to write changes to.
1969
:param old_revno: The revno of the old tip.
1970
:param old_revision_id: The revision_id of the old tip.
1972
new_revno, new_revision_id = branch.last_revision_info()
1973
old_history, new_history = get_history_change(old_revision_id,
1976
if old_history == [] and new_history == []:
1977
output.write('Nothing seems to have changed\n')
1980
log_format = log_formatter_registry.get_default(branch)
1981
lf = log_format(show_ids=False, to_file=output, show_timezone='original')
1982
if old_history != []:
1983
output.write('*'*60)
1984
output.write('\nRemoved Revisions:\n')
1985
show_flat_log(branch.repository, old_history, old_revno, lf)
1986
output.write('*'*60)
1987
output.write('\n\n')
1988
if new_history != []:
1989
output.write('Added Revisions:\n')
1990
start_revno = new_revno - len(new_history) + 1
1991
show_log(branch, lf, None, verbose=False, direction='forward',
1992
start_revision=start_revno,)
1995
def show_flat_log(repository, history, last_revno, lf):
1996
"""Show a simple log of the specified history.
1998
:param repository: The repository to retrieve revisions from.
1999
:param history: A list of revision_ids indicating the lefthand history.
2000
:param last_revno: The revno of the last revision_id in the history.
2001
:param lf: The log formatter to use.
2003
start_revno = last_revno - len(history) + 1
2004
revisions = repository.get_revisions(history)
2005
for i, rev in enumerate(revisions):
2006
lr = LogRevision(rev, i + last_revno, 0, None)
2010
def _get_info_for_log_files(revisionspec_list, file_list, add_cleanup):
2011
"""Find file-ids and kinds given a list of files and a revision range.
2013
We search for files at the end of the range. If not found there,
2014
we try the start of the range.
2016
:param revisionspec_list: revision range as parsed on the command line
2017
:param file_list: the list of paths given on the command line;
2018
the first of these can be a branch location or a file path,
2019
the remainder must be file paths
2020
:param add_cleanup: When the branch returned is read locked,
2021
an unlock call will be queued to the cleanup.
2022
:return: (branch, info_list, start_rev_info, end_rev_info) where
2023
info_list is a list of (relative_path, file_id, kind) tuples where
2024
kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
2025
branch will be read-locked.
2027
from bzrlib.builtins import _get_revision_range
2028
tree, b, path = controldir.ControlDir.open_containing_tree_or_branch(
2030
add_cleanup(b.lock_read().unlock)
2031
# XXX: It's damn messy converting a list of paths to relative paths when
2032
# those paths might be deleted ones, they might be on a case-insensitive
2033
# filesystem and/or they might be in silly locations (like another branch).
2034
# For example, what should "log bzr://branch/dir/file1 file2" do? (Is
2035
# file2 implicitly in the same dir as file1 or should its directory be
2036
# taken from the current tree somehow?) For now, this solves the common
2037
# case of running log in a nested directory, assuming paths beyond the
2038
# first one haven't been deleted ...
2040
relpaths = [path] + tree.safe_relpath_files(file_list[1:])
2042
relpaths = [path] + file_list[1:]
2044
start_rev_info, end_rev_info = _get_revision_range(revisionspec_list, b,
2046
if relpaths in ([], [u'']):
2047
return b, [], start_rev_info, end_rev_info
2048
if start_rev_info is None and end_rev_info is None:
2050
tree = b.basis_tree()
2053
file_id = tree.path2id(fp)
2054
kind = _get_kind_for_file_id(tree, file_id)
2056
# go back to when time began
2059
rev1 = b.get_rev_id(1)
2060
except errors.NoSuchRevision:
2065
tree1 = b.repository.revision_tree(rev1)
2067
file_id = tree1.path2id(fp)
2068
kind = _get_kind_for_file_id(tree1, file_id)
2069
info_list.append((fp, file_id, kind))
2071
elif start_rev_info == end_rev_info:
2072
# One revision given - file must exist in it
2073
tree = b.repository.revision_tree(end_rev_info.rev_id)
2075
file_id = tree.path2id(fp)
2076
kind = _get_kind_for_file_id(tree, file_id)
2077
info_list.append((fp, file_id, kind))
2080
# Revision range given. Get the file-id from the end tree.
2081
# If that fails, try the start tree.
2082
rev_id = end_rev_info.rev_id
2084
tree = b.basis_tree()
2086
tree = b.repository.revision_tree(rev_id)
2089
file_id = tree.path2id(fp)
2090
kind = _get_kind_for_file_id(tree, file_id)
2093
rev_id = start_rev_info.rev_id
2095
rev1 = b.get_rev_id(1)
2096
tree1 = b.repository.revision_tree(rev1)
2098
tree1 = b.repository.revision_tree(rev_id)
2099
file_id = tree1.path2id(fp)
2100
kind = _get_kind_for_file_id(tree1, file_id)
2101
info_list.append((fp, file_id, kind))
2102
return b, info_list, start_rev_info, end_rev_info
2105
def _get_kind_for_file_id(tree, file_id):
2106
"""Return the kind of a file-id or None if it doesn't exist."""
2107
if file_id is not None:
2108
return tree.kind(file_id)
2113
properties_handler_registry = registry.Registry()
2115
# Use the properties handlers to print out bug information if available
2116
def _bugs_properties_handler(revision):
2117
if revision.properties.has_key('bugs'):
2118
bug_lines = revision.properties['bugs'].split('\n')
2119
bug_rows = [line.split(' ', 1) for line in bug_lines]
2120
fixed_bug_urls = [row[0] for row in bug_rows if
2121
len(row) > 1 and row[1] == 'fixed']
2124
return {ngettext('fixes bug', 'fixes bugs', len(fixed_bug_urls)):\
2125
' '.join(fixed_bug_urls)}
2128
properties_handler_registry.register('bugs_properties_handler',
2129
_bugs_properties_handler)
2132
# adapters which revision ids to log are filtered. When log is called, the
2133
# log_rev_iterator is adapted through each of these factory methods.
2134
# Plugins are welcome to mutate this list in any way they like - as long
2135
# as the overall behaviour is preserved. At this point there is no extensible
2136
# mechanism for getting parameters to each factory method, and until there is
2137
# this won't be considered a stable api.
2141
# read revision objects
2142
_make_revision_objects,
2143
# filter on log messages
2144
_make_search_filter,
2145
# generate deltas for things we will show
added
removed
bzrlib/log.py
