1
# Copyright (C) 2005-2010 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
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 cStringIO import StringIO
54
from itertools import (
60
from warnings import (
64
from bzrlib.lazy_import import lazy_import
65
lazy_import(globals(), """
73
repository as _mod_repository,
74
revision as _mod_revision,
84
from bzrlib.osutils import (
86
format_date_with_offset_in_original_timezone,
87
get_terminal_encoding,
91
from bzrlib.symbol_versioning import (
97
def find_touching_revisions(branch, file_id):
98
"""Yield a description of revisions which affect the file_id.
100
Each returned element is (revno, revision_id, description)
102
This is the list of revisions where the file is either added,
103
modified, renamed or deleted.
105
TODO: Perhaps some way to limit this to only particular revisions,
106
or to traverse a non-mainline set of revisions?
111
for revision_id in branch.revision_history():
112
this_inv = branch.repository.get_inventory(revision_id)
113
if file_id in this_inv:
114
this_ie = this_inv[file_id]
115
this_path = this_inv.id2path(file_id)
117
this_ie = this_path = None
119
# now we know how it was last time, and how it is in this revision.
120
# are those two states effectively the same or not?
122
if not this_ie and not last_ie:
123
# not present in either
125
elif this_ie and not last_ie:
126
yield revno, revision_id, "added " + this_path
127
elif not this_ie and last_ie:
129
yield revno, revision_id, "deleted " + last_path
130
elif this_path != last_path:
131
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
132
elif (this_ie.text_size != last_ie.text_size
133
or this_ie.text_sha1 != last_ie.text_sha1):
134
yield revno, revision_id, "modified " + this_path
137
last_path = this_path
141
def _enumerate_history(branch):
144
for rev_id in branch.revision_history():
145
rh.append((revno, rev_id))
152
specific_fileid=None,
160
"""Write out human-readable log of commits to this branch.
162
This function is being retained for backwards compatibility but
163
should not be extended with new parameters. Use the new Logger class
164
instead, eg. Logger(branch, rqst).show(lf), adding parameters to the
165
make_log_request_dict function.
167
:param lf: The LogFormatter object showing the output.
169
:param specific_fileid: If not None, list only the commits affecting the
170
specified file, rather than all commits.
172
:param verbose: If True show added/changed/deleted/renamed files.
174
:param direction: 'reverse' (default) is latest to earliest; 'forward' is
177
:param start_revision: If not None, only show revisions >= start_revision
179
:param end_revision: If not None, only show revisions <= end_revision
181
:param search: If not None, only show revisions with matching commit
184
:param limit: If set, shows only 'limit' revisions, all revisions are shown
187
:param show_diff: If True, output a diff after each revision.
189
# Convert old-style parameters to new-style parameters
190
if specific_fileid is not None:
191
file_ids = [specific_fileid]
196
delta_type = 'partial'
203
diff_type = 'partial'
209
# Build the request and execute it
210
rqst = make_log_request_dict(direction=direction, specific_fileids=file_ids,
211
start_revision=start_revision, end_revision=end_revision,
212
limit=limit, message_search=search,
213
delta_type=delta_type, diff_type=diff_type)
214
Logger(branch, rqst).show(lf)
217
# Note: This needs to be kept this in sync with the defaults in
218
# make_log_request_dict() below
219
_DEFAULT_REQUEST_PARAMS = {
220
'direction': 'reverse',
222
'generate_tags': True,
223
'_match_using_deltas': True,
227
def make_log_request_dict(direction='reverse', specific_fileids=None,
228
start_revision=None, end_revision=None, limit=None,
229
message_search=None, levels=1, generate_tags=True, delta_type=None,
230
diff_type=None, _match_using_deltas=True):
231
"""Convenience function for making a logging request dictionary.
233
Using this function may make code slightly safer by ensuring
234
parameters have the correct names. It also provides a reference
235
point for documenting the supported parameters.
237
:param direction: 'reverse' (default) is latest to earliest;
238
'forward' is earliest to latest.
240
:param specific_fileids: If not None, only include revisions
241
affecting the specified files, rather than all revisions.
243
:param start_revision: If not None, only generate
244
revisions >= start_revision
246
:param end_revision: If not None, only generate
247
revisions <= end_revision
249
:param limit: If set, generate only 'limit' revisions, all revisions
250
are shown if None or 0.
252
:param message_search: If not None, only include revisions with
253
matching commit messages
255
:param levels: the number of levels of revisions to
256
generate; 1 for just the mainline; 0 for all levels.
258
:param generate_tags: If True, include tags for matched revisions.
260
:param delta_type: Either 'full', 'partial' or None.
261
'full' means generate the complete delta - adds/deletes/modifies/etc;
262
'partial' means filter the delta using specific_fileids;
263
None means do not generate any delta.
265
:param diff_type: Either 'full', 'partial' or None.
266
'full' means generate the complete diff - adds/deletes/modifies/etc;
267
'partial' means filter the diff using specific_fileids;
268
None means do not generate any diff.
270
:param _match_using_deltas: a private parameter controlling the
271
algorithm used for matching specific_fileids. This parameter
272
may be removed in the future so bzrlib client code should NOT
276
'direction': direction,
277
'specific_fileids': specific_fileids,
278
'start_revision': start_revision,
279
'end_revision': end_revision,
281
'message_search': message_search,
283
'generate_tags': generate_tags,
284
'delta_type': delta_type,
285
'diff_type': diff_type,
286
# Add 'private' attributes for features that may be deprecated
287
'_match_using_deltas': _match_using_deltas,
291
def _apply_log_request_defaults(rqst):
292
"""Apply default values to a request dictionary."""
293
result = _DEFAULT_REQUEST_PARAMS
299
class LogGenerator(object):
300
"""A generator of log revisions."""
302
def iter_log_revisions(self):
303
"""Iterate over LogRevision objects.
305
:return: An iterator yielding LogRevision objects.
307
raise NotImplementedError(self.iter_log_revisions)
310
class Logger(object):
311
"""An object that generates, formats and displays a log."""
313
def __init__(self, branch, rqst):
316
:param branch: the branch to log
317
:param rqst: A dictionary specifying the query parameters.
318
See make_log_request_dict() for supported values.
321
self.rqst = _apply_log_request_defaults(rqst)
326
:param lf: The LogFormatter object to send the output to.
328
if not isinstance(lf, LogFormatter):
329
warn("not a LogFormatter instance: %r" % lf)
331
self.branch.lock_read()
333
if getattr(lf, 'begin_log', None):
336
if getattr(lf, 'end_log', None):
341
def _show_body(self, lf):
342
"""Show the main log output.
344
Subclasses may wish to override this.
346
# Tweak the LogRequest based on what the LogFormatter can handle.
347
# (There's no point generating stuff if the formatter can't display it.)
349
rqst['levels'] = lf.get_levels()
350
if not getattr(lf, 'supports_tags', False):
351
rqst['generate_tags'] = False
352
if not getattr(lf, 'supports_delta', False):
353
rqst['delta_type'] = None
354
if not getattr(lf, 'supports_diff', False):
355
rqst['diff_type'] = None
357
# Find and print the interesting revisions
358
generator = self._generator_factory(self.branch, rqst)
359
for lr in generator.iter_log_revisions():
363
def _generator_factory(self, branch, rqst):
364
"""Make the LogGenerator object to use.
366
Subclasses may wish to override this.
368
return _DefaultLogGenerator(branch, rqst)
371
class _StartNotLinearAncestor(Exception):
372
"""Raised when a start revision is not found walking left-hand history."""
375
class _DefaultLogGenerator(LogGenerator):
376
"""The default generator of log revisions."""
378
def __init__(self, branch, rqst):
381
if rqst.get('generate_tags') and branch.supports_tags():
382
self.rev_tag_dict = branch.tags.get_reverse_tag_dict()
384
self.rev_tag_dict = {}
386
def iter_log_revisions(self):
387
"""Iterate over LogRevision objects.
389
:return: An iterator yielding LogRevision objects.
392
levels = rqst.get('levels')
393
limit = rqst.get('limit')
394
diff_type = rqst.get('diff_type')
396
revision_iterator = self._create_log_revision_iterator()
397
for revs in revision_iterator:
398
for (rev_id, revno, merge_depth), rev, delta in revs:
399
# 0 levels means show everything; merge_depth counts from 0
400
if levels != 0 and merge_depth >= levels:
402
if diff_type is None:
405
diff = self._format_diff(rev, rev_id, diff_type)
406
yield LogRevision(rev, revno, merge_depth, delta,
407
self.rev_tag_dict.get(rev_id), diff)
410
if log_count >= limit:
413
def _format_diff(self, rev, rev_id, diff_type):
414
repo = self.branch.repository
415
if len(rev.parent_ids) == 0:
416
ancestor_id = _mod_revision.NULL_REVISION
418
ancestor_id = rev.parent_ids[0]
419
tree_1 = repo.revision_tree(ancestor_id)
420
tree_2 = repo.revision_tree(rev_id)
421
file_ids = self.rqst.get('specific_fileids')
422
if diff_type == 'partial' and file_ids is not None:
423
specific_files = [tree_2.id2path(id) for id in file_ids]
425
specific_files = None
427
diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
431
def _create_log_revision_iterator(self):
432
"""Create a revision iterator for log.
434
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
437
self.start_rev_id, self.end_rev_id = _get_revision_limits(
438
self.branch, self.rqst.get('start_revision'),
439
self.rqst.get('end_revision'))
440
if self.rqst.get('_match_using_deltas'):
441
return self._log_revision_iterator_using_delta_matching()
443
# We're using the per-file-graph algorithm. This scales really
444
# well but only makes sense if there is a single file and it's
446
file_count = len(self.rqst.get('specific_fileids'))
448
raise BzrError("illegal LogRequest: must match-using-deltas "
449
"when logging %d files" % file_count)
450
return self._log_revision_iterator_using_per_file_graph()
452
def _log_revision_iterator_using_delta_matching(self):
453
# Get the base revisions, filtering by the revision range
455
generate_merge_revisions = rqst.get('levels') != 1
456
delayed_graph_generation = not rqst.get('specific_fileids') and (
457
rqst.get('limit') or self.start_rev_id or self.end_rev_id)
458
view_revisions = _calc_view_revisions(
459
self.branch, self.start_rev_id, self.end_rev_id,
460
rqst.get('direction'),
461
generate_merge_revisions=generate_merge_revisions,
462
delayed_graph_generation=delayed_graph_generation)
464
# Apply the other filters
465
return make_log_rev_iterator(self.branch, view_revisions,
466
rqst.get('delta_type'), rqst.get('message_search'),
467
file_ids=rqst.get('specific_fileids'),
468
direction=rqst.get('direction'))
470
def _log_revision_iterator_using_per_file_graph(self):
471
# Get the base revisions, filtering by the revision range.
472
# Note that we always generate the merge revisions because
473
# filter_revisions_touching_file_id() requires them ...
475
view_revisions = _calc_view_revisions(
476
self.branch, self.start_rev_id, self.end_rev_id,
477
rqst.get('direction'), generate_merge_revisions=True)
478
if not isinstance(view_revisions, list):
479
view_revisions = list(view_revisions)
480
view_revisions = _filter_revisions_touching_file_id(self.branch,
481
rqst.get('specific_fileids')[0], view_revisions,
482
include_merges=rqst.get('levels') != 1)
483
return make_log_rev_iterator(self.branch, view_revisions,
484
rqst.get('delta_type'), rqst.get('message_search'))
487
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
488
generate_merge_revisions, delayed_graph_generation=False):
489
"""Calculate the revisions to view.
491
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
492
a list of the same tuples.
494
if direction not in ('reverse', 'forward'):
495
raise ValueError('invalid direction %r' % direction)
496
br_revno, br_rev_id = branch.last_revision_info()
500
if (end_rev_id and start_rev_id == end_rev_id
501
and (not generate_merge_revisions
502
or not _has_merges(branch, end_rev_id))):
503
# If a single revision is requested, check we can handle it
504
iter_revs = _generate_one_revision(branch, end_rev_id, br_rev_id,
506
elif not generate_merge_revisions:
507
# If we only want to see linear revisions, we can iterate ...
508
iter_revs = _generate_flat_revisions(branch, start_rev_id, end_rev_id,
510
if direction == 'forward':
511
iter_revs = reversed(iter_revs)
513
iter_revs = _generate_all_revisions(branch, start_rev_id, end_rev_id,
514
direction, delayed_graph_generation)
515
if direction == 'forward':
516
iter_revs = _rebase_merge_depth(reverse_by_depth(list(iter_revs)))
520
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
521
if rev_id == br_rev_id:
523
return [(br_rev_id, br_revno, 0)]
525
revno = branch.revision_id_to_dotted_revno(rev_id)
526
revno_str = '.'.join(str(n) for n in revno)
527
return [(rev_id, revno_str, 0)]
530
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction):
531
result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
532
# If a start limit was given and it's not obviously an
533
# ancestor of the end limit, check it before outputting anything
534
if direction == 'forward' or (start_rev_id
535
and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
537
result = list(result)
538
except _StartNotLinearAncestor:
539
raise errors.BzrCommandError('Start revision not found in'
540
' left-hand history of end revision.')
544
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
545
delayed_graph_generation):
546
# On large trees, generating the merge graph can take 30-60 seconds
547
# so we delay doing it until a merge is detected, incrementally
548
# returning initial (non-merge) revisions while we can.
550
# The above is only true for old formats (<= 0.92), for newer formats, a
551
# couple of seconds only should be needed to load the whole graph and the
552
# other graph operations needed are even faster than that -- vila 100201
553
initial_revisions = []
554
if delayed_graph_generation:
556
for rev_id, revno, depth in _linear_view_revisions(
557
branch, start_rev_id, end_rev_id):
558
if _has_merges(branch, rev_id):
559
# The end_rev_id can be nested down somewhere. We need an
560
# explicit ancestry check. There is an ambiguity here as we
561
# may not raise _StartNotLinearAncestor for a revision that
562
# is an ancestor but not a *linear* one. But since we have
563
# loaded the graph to do the check (or calculate a dotted
564
# revno), we may as well accept to show the log... We need
565
# the check only if start_rev_id is not None as all
566
# revisions have _mod_revision.NULL_REVISION as an ancestor
568
graph = branch.repository.get_graph()
569
if (start_rev_id is not None
570
and not graph.is_ancestor(start_rev_id, end_rev_id)):
571
raise _StartNotLinearAncestor()
572
# Since we collected the revisions so far, we need to
577
initial_revisions.append((rev_id, revno, depth))
579
# No merged revisions found
580
return initial_revisions
581
except _StartNotLinearAncestor:
582
# A merge was never detected so the lower revision limit can't
583
# be nested down somewhere
584
raise errors.BzrCommandError('Start revision not found in'
585
' history of end revision.')
587
# We exit the loop above because we encounter a revision with merges, from
588
# this revision, we need to switch to _graph_view_revisions.
590
# A log including nested merges is required. If the direction is reverse,
591
# we rebase the initial merge depths so that the development line is
592
# shown naturally, i.e. just like it is for linear logging. We can easily
593
# make forward the exact opposite display, but showing the merge revisions
594
# indented at the end seems slightly nicer in that case.
595
view_revisions = chain(iter(initial_revisions),
596
_graph_view_revisions(branch, start_rev_id, end_rev_id,
597
rebase_initial_depths=(direction == 'reverse')))
598
return view_revisions
601
def _has_merges(branch, rev_id):
602
"""Does a revision have multiple parents or not?"""
603
parents = branch.repository.get_parent_map([rev_id]).get(rev_id, [])
604
return len(parents) > 1
607
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
608
"""Is start_rev_id an obvious ancestor of end_rev_id?"""
609
if start_rev_id and end_rev_id:
610
start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
611
end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
612
if len(start_dotted) == 1 and len(end_dotted) == 1:
614
return start_dotted[0] <= end_dotted[0]
615
elif (len(start_dotted) == 3 and len(end_dotted) == 3 and
616
start_dotted[0:1] == end_dotted[0:1]):
617
# both on same development line
618
return start_dotted[2] <= end_dotted[2]
622
# if either start or end is not specified then we use either the first or
623
# the last revision and *they* are obvious ancestors.
627
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
628
"""Calculate a sequence of revisions to view, newest to oldest.
630
:param start_rev_id: the lower revision-id
631
:param end_rev_id: the upper revision-id
632
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
633
:raises _StartNotLinearAncestor: if a start_rev_id is specified but
634
is not found walking the left-hand history
636
br_revno, br_rev_id = branch.last_revision_info()
637
repo = branch.repository
638
if start_rev_id is None and end_rev_id is None:
640
for revision_id in repo.iter_reverse_revision_history(br_rev_id):
641
yield revision_id, str(cur_revno), 0
644
if end_rev_id is None:
645
end_rev_id = br_rev_id
646
found_start = start_rev_id is None
647
for revision_id in repo.iter_reverse_revision_history(end_rev_id):
648
revno = branch.revision_id_to_dotted_revno(revision_id)
649
revno_str = '.'.join(str(n) for n in revno)
650
if not found_start and revision_id == start_rev_id:
651
yield revision_id, revno_str, 0
655
yield revision_id, revno_str, 0
658
raise _StartNotLinearAncestor()
661
def _graph_view_revisions(branch, start_rev_id, end_rev_id,
662
rebase_initial_depths=True):
663
"""Calculate revisions to view including merges, newest to oldest.
665
:param branch: the branch
666
:param start_rev_id: the lower revision-id
667
:param end_rev_id: the upper revision-id
668
:param rebase_initial_depth: should depths be rebased until a mainline
670
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
672
view_revisions = branch.iter_merge_sorted_revisions(
673
start_revision_id=end_rev_id, stop_revision_id=start_rev_id,
674
stop_rule="with-merges")
675
if not rebase_initial_depths:
676
for (rev_id, merge_depth, revno, end_of_merge
678
yield rev_id, '.'.join(map(str, revno)), merge_depth
680
# We're following a development line starting at a merged revision.
681
# We need to adjust depths down by the initial depth until we find
682
# a depth less than it. Then we use that depth as the adjustment.
683
# If and when we reach the mainline, depth adjustment ends.
684
depth_adjustment = None
685
for (rev_id, merge_depth, revno, end_of_merge
687
if depth_adjustment is None:
688
depth_adjustment = merge_depth
690
if merge_depth < depth_adjustment:
691
# From now on we reduce the depth adjustement, this can be
692
# surprising for users. The alternative requires two passes
693
# which breaks the fast display of the first revision
695
depth_adjustment = merge_depth
696
merge_depth -= depth_adjustment
697
yield rev_id, '.'.join(map(str, revno)), merge_depth
700
@deprecated_function(deprecated_in((2, 2, 0)))
701
def calculate_view_revisions(branch, start_revision, end_revision, direction,
702
specific_fileid, generate_merge_revisions):
703
"""Calculate the revisions to view.
705
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
706
a list of the same tuples.
708
start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
710
view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
711
direction, generate_merge_revisions or specific_fileid))
713
view_revisions = _filter_revisions_touching_file_id(branch,
714
specific_fileid, view_revisions,
715
include_merges=generate_merge_revisions)
716
return _rebase_merge_depth(view_revisions)
719
def _rebase_merge_depth(view_revisions):
720
"""Adjust depths upwards so the top level is 0."""
721
# If either the first or last revision have a merge_depth of 0, we're done
722
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
723
min_depth = min([d for r,n,d in view_revisions])
725
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
726
return view_revisions
729
def make_log_rev_iterator(branch, view_revisions, generate_delta, search,
730
file_ids=None, direction='reverse'):
731
"""Create a revision iterator for log.
733
:param branch: The branch being logged.
734
:param view_revisions: The revisions being viewed.
735
:param generate_delta: Whether to generate a delta for each revision.
736
Permitted values are None, 'full' and 'partial'.
737
:param search: A user text search string.
738
:param file_ids: If non empty, only revisions matching one or more of
739
the file-ids are to be kept.
740
:param direction: the direction in which view_revisions is sorted
741
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
744
# Convert view_revisions into (view, None, None) groups to fit with
745
# the standard interface here.
746
if type(view_revisions) == list:
747
# A single batch conversion is faster than many incremental ones.
748
# As we have all the data, do a batch conversion.
749
nones = [None] * len(view_revisions)
750
log_rev_iterator = iter([zip(view_revisions, nones, nones)])
753
for view in view_revisions:
754
yield (view, None, None)
755
log_rev_iterator = iter([_convert()])
756
for adapter in log_adapters:
757
# It would be nicer if log adapters were first class objects
758
# with custom parameters. This will do for now. IGC 20090127
759
if adapter == _make_delta_filter:
760
log_rev_iterator = adapter(branch, generate_delta,
761
search, log_rev_iterator, file_ids, direction)
763
log_rev_iterator = adapter(branch, generate_delta,
764
search, log_rev_iterator)
765
return log_rev_iterator
768
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
769
"""Create a filtered iterator of log_rev_iterator matching on a regex.
771
:param branch: The branch being logged.
772
:param generate_delta: Whether to generate a delta for each revision.
773
:param search: A user text search string.
774
:param log_rev_iterator: An input iterator containing all revisions that
775
could be displayed, in lists.
776
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
780
return log_rev_iterator
781
searchRE = re_compile_checked(search, re.IGNORECASE,
782
'log message filter')
783
return _filter_message_re(searchRE, log_rev_iterator)
786
def _filter_message_re(searchRE, log_rev_iterator):
787
for revs in log_rev_iterator:
789
for (rev_id, revno, merge_depth), rev, delta in revs:
790
if searchRE.search(rev.message):
791
new_revs.append(((rev_id, revno, merge_depth), rev, delta))
795
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
796
fileids=None, direction='reverse'):
797
"""Add revision deltas to a log iterator if needed.
799
:param branch: The branch being logged.
800
:param generate_delta: Whether to generate a delta for each revision.
801
Permitted values are None, 'full' and 'partial'.
802
:param search: A user text search string.
803
:param log_rev_iterator: An input iterator containing all revisions that
804
could be displayed, in lists.
805
:param fileids: If non empty, only revisions matching one or more of
806
the file-ids are to be kept.
807
:param direction: the direction in which view_revisions is sorted
808
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
811
if not generate_delta and not fileids:
812
return log_rev_iterator
813
return _generate_deltas(branch.repository, log_rev_iterator,
814
generate_delta, fileids, direction)
817
def _generate_deltas(repository, log_rev_iterator, delta_type, fileids,
819
"""Create deltas for each batch of revisions in log_rev_iterator.
821
If we're only generating deltas for the sake of filtering against
822
file-ids, we stop generating deltas once all file-ids reach the
823
appropriate life-cycle point. If we're receiving data newest to
824
oldest, then that life-cycle point is 'add', otherwise it's 'remove'.
826
check_fileids = fileids is not None and len(fileids) > 0
828
fileid_set = set(fileids)
829
if direction == 'reverse':
835
for revs in log_rev_iterator:
836
# If we were matching against fileids and we've run out,
837
# there's nothing left to do
838
if check_fileids and not fileid_set:
840
revisions = [rev[1] for rev in revs]
842
if delta_type == 'full' and not check_fileids:
843
deltas = repository.get_deltas_for_revisions(revisions)
844
for rev, delta in izip(revs, deltas):
845
new_revs.append((rev[0], rev[1], delta))
847
deltas = repository.get_deltas_for_revisions(revisions, fileid_set)
848
for rev, delta in izip(revs, deltas):
850
if delta is None or not delta.has_changed():
853
_update_fileids(delta, fileid_set, stop_on)
854
if delta_type is None:
856
elif delta_type == 'full':
857
# If the file matches all the time, rebuilding
858
# a full delta like this in addition to a partial
859
# one could be slow. However, it's likely that
860
# most revisions won't get this far, making it
861
# faster to filter on the partial deltas and
862
# build the occasional full delta than always
863
# building full deltas and filtering those.
865
delta = repository.get_revision_delta(rev_id)
866
new_revs.append((rev[0], rev[1], delta))
870
def _update_fileids(delta, fileids, stop_on):
871
"""Update the set of file-ids to search based on file lifecycle events.
873
:param fileids: a set of fileids to update
874
:param stop_on: either 'add' or 'remove' - take file-ids out of the
875
fileids set once their add or remove entry is detected respectively
878
for item in delta.added:
879
if item[1] in fileids:
880
fileids.remove(item[1])
881
elif stop_on == 'delete':
882
for item in delta.removed:
883
if item[1] in fileids:
884
fileids.remove(item[1])
887
def _make_revision_objects(branch, generate_delta, search, log_rev_iterator):
888
"""Extract revision objects from the repository
890
:param branch: The branch being logged.
891
:param generate_delta: Whether to generate a delta for each revision.
892
:param search: A user text search string.
893
:param log_rev_iterator: An input iterator containing all revisions that
894
could be displayed, in lists.
895
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
898
repository = branch.repository
899
for revs in log_rev_iterator:
900
# r = revision_id, n = revno, d = merge depth
901
revision_ids = [view[0] for view, _, _ in revs]
902
revisions = repository.get_revisions(revision_ids)
903
revs = [(rev[0], revision, rev[2]) for rev, revision in
904
izip(revs, revisions)]
908
def _make_batch_filter(branch, generate_delta, search, log_rev_iterator):
909
"""Group up a single large batch into smaller ones.
911
:param branch: The branch being logged.
912
:param generate_delta: Whether to generate a delta for each revision.
913
:param search: A user text search string.
914
:param log_rev_iterator: An input iterator containing all revisions that
915
could be displayed, in lists.
916
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
919
repository = branch.repository
921
for batch in log_rev_iterator:
924
step = [detail for _, detail in zip(range(num), batch)]
928
num = min(int(num * 1.5), 200)
931
def _get_revision_limits(branch, start_revision, end_revision):
932
"""Get and check revision limits.
934
:param branch: The branch containing the revisions.
936
:param start_revision: The first revision to be logged.
937
For backwards compatibility this may be a mainline integer revno,
938
but for merge revision support a RevisionInfo is expected.
940
:param end_revision: The last revision to be logged.
941
For backwards compatibility this may be a mainline integer revno,
942
but for merge revision support a RevisionInfo is expected.
944
:return: (start_rev_id, end_rev_id) tuple.
946
branch_revno, branch_rev_id = branch.last_revision_info()
948
if start_revision is None:
951
if isinstance(start_revision, revisionspec.RevisionInfo):
952
start_rev_id = start_revision.rev_id
953
start_revno = start_revision.revno or 1
955
branch.check_real_revno(start_revision)
956
start_revno = start_revision
957
start_rev_id = branch.get_rev_id(start_revno)
960
if end_revision is None:
961
end_revno = branch_revno
963
if isinstance(end_revision, revisionspec.RevisionInfo):
964
end_rev_id = end_revision.rev_id
965
end_revno = end_revision.revno or branch_revno
967
branch.check_real_revno(end_revision)
968
end_revno = end_revision
969
end_rev_id = branch.get_rev_id(end_revno)
971
if branch_revno != 0:
972
if (start_rev_id == _mod_revision.NULL_REVISION
973
or end_rev_id == _mod_revision.NULL_REVISION):
974
raise errors.BzrCommandError('Logging revision 0 is invalid.')
975
if start_revno > end_revno:
976
raise errors.BzrCommandError("Start revision must be older than "
978
return (start_rev_id, end_rev_id)
981
def _get_mainline_revs(branch, start_revision, end_revision):
982
"""Get the mainline revisions from the branch.
984
Generates the list of mainline revisions for the branch.
986
:param branch: The branch containing the revisions.
988
:param start_revision: The first revision to be logged.
989
For backwards compatibility this may be a mainline integer revno,
990
but for merge revision support a RevisionInfo is expected.
992
:param end_revision: The last revision to be logged.
993
For backwards compatibility this may be a mainline integer revno,
994
but for merge revision support a RevisionInfo is expected.
996
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
998
branch_revno, branch_last_revision = branch.last_revision_info()
999
if branch_revno == 0:
1000
return None, None, None, None
1002
# For mainline generation, map start_revision and end_revision to
1003
# mainline revnos. If the revision is not on the mainline choose the
1004
# appropriate extreme of the mainline instead - the extra will be
1006
# Also map the revisions to rev_ids, to be used in the later filtering
1009
if start_revision is None:
1012
if isinstance(start_revision, revisionspec.RevisionInfo):
1013
start_rev_id = start_revision.rev_id
1014
start_revno = start_revision.revno or 1
1016
branch.check_real_revno(start_revision)
1017
start_revno = start_revision
1020
if end_revision is None:
1021
end_revno = branch_revno
1023
if isinstance(end_revision, revisionspec.RevisionInfo):
1024
end_rev_id = end_revision.rev_id
1025
end_revno = end_revision.revno or branch_revno
1027
branch.check_real_revno(end_revision)
1028
end_revno = end_revision
1030
if ((start_rev_id == _mod_revision.NULL_REVISION)
1031
or (end_rev_id == _mod_revision.NULL_REVISION)):
1032
raise errors.BzrCommandError('Logging revision 0 is invalid.')
1033
if start_revno > end_revno:
1034
raise errors.BzrCommandError("Start revision must be older than "
1035
"the end revision.")
1037
if end_revno < start_revno:
1038
return None, None, None, None
1039
cur_revno = branch_revno
1042
for revision_id in branch.repository.iter_reverse_revision_history(
1043
branch_last_revision):
1044
if cur_revno < start_revno:
1045
# We have gone far enough, but we always add 1 more revision
1046
rev_nos[revision_id] = cur_revno
1047
mainline_revs.append(revision_id)
1049
if cur_revno <= end_revno:
1050
rev_nos[revision_id] = cur_revno
1051
mainline_revs.append(revision_id)
1054
# We walked off the edge of all revisions, so we add a 'None' marker
1055
mainline_revs.append(None)
1057
mainline_revs.reverse()
1059
# override the mainline to look like the revision history.
1060
return mainline_revs, rev_nos, start_rev_id, end_rev_id
1063
@deprecated_function(deprecated_in((2, 2, 0)))
1064
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
1065
"""Filter view_revisions based on revision ranges.
1067
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1068
tuples to be filtered.
1070
:param start_rev_id: If not NONE specifies the first revision to be logged.
1071
If NONE then all revisions up to the end_rev_id are logged.
1073
:param end_rev_id: If not NONE specifies the last revision to be logged.
1074
If NONE then all revisions up to the end of the log are logged.
1076
:return: The filtered view_revisions.
1078
if start_rev_id or end_rev_id:
1079
revision_ids = [r for r, n, d in view_revisions]
1081
start_index = revision_ids.index(start_rev_id)
1084
if start_rev_id == end_rev_id:
1085
end_index = start_index
1088
end_index = revision_ids.index(end_rev_id)
1090
end_index = len(view_revisions) - 1
1091
# To include the revisions merged into the last revision,
1092
# extend end_rev_id down to, but not including, the next rev
1093
# with the same or lesser merge_depth
1094
end_merge_depth = view_revisions[end_index][2]
1096
for index in xrange(end_index+1, len(view_revisions)+1):
1097
if view_revisions[index][2] <= end_merge_depth:
1098
end_index = index - 1
1101
# if the search falls off the end then log to the end as well
1102
end_index = len(view_revisions) - 1
1103
view_revisions = view_revisions[start_index:end_index+1]
1104
return view_revisions
1107
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1108
include_merges=True):
1109
r"""Return the list of revision ids which touch a given file id.
1111
The function filters view_revisions and returns a subset.
1112
This includes the revisions which directly change the file id,
1113
and the revisions which merge these changes. So if the
1125
And 'C' changes a file, then both C and D will be returned. F will not be
1126
returned even though it brings the changes to C into the branch starting
1127
with E. (Note that if we were using F as the tip instead of G, then we
1130
This will also be restricted based on a subset of the mainline.
1132
:param branch: The branch where we can get text revision information.
1134
:param file_id: Filter out revisions that do not touch file_id.
1136
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1137
tuples. This is the list of revisions which will be filtered. It is
1138
assumed that view_revisions is in merge_sort order (i.e. newest
1141
:param include_merges: include merge revisions in the result or not
1143
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
1145
# Lookup all possible text keys to determine which ones actually modified
1147
text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
1149
# Looking up keys in batches of 1000 can cut the time in half, as well as
1150
# memory consumption. GraphIndex *does* like to look for a few keys in
1151
# parallel, it just doesn't like looking for *lots* of keys in parallel.
1152
# TODO: This code needs to be re-evaluated periodically as we tune the
1153
# indexing layer. We might consider passing in hints as to the known
1154
# access pattern (sparse/clustered, high success rate/low success
1155
# rate). This particular access is clustered with a low success rate.
1156
get_parent_map = branch.repository.texts.get_parent_map
1157
modified_text_revisions = set()
1159
for start in xrange(0, len(text_keys), chunk_size):
1160
next_keys = text_keys[start:start + chunk_size]
1161
# Only keep the revision_id portion of the key
1162
modified_text_revisions.update(
1163
[k[1] for k in get_parent_map(next_keys)])
1164
del text_keys, next_keys
1167
# Track what revisions will merge the current revision, replace entries
1168
# with 'None' when they have been added to result
1169
current_merge_stack = [None]
1170
for info in view_revisions:
1171
rev_id, revno, depth = info
1172
if depth == len(current_merge_stack):
1173
current_merge_stack.append(info)
1175
del current_merge_stack[depth + 1:]
1176
current_merge_stack[-1] = info
1178
if rev_id in modified_text_revisions:
1179
# This needs to be logged, along with the extra revisions
1180
for idx in xrange(len(current_merge_stack)):
1181
node = current_merge_stack[idx]
1182
if node is not None:
1183
if include_merges or node[2] == 0:
1185
current_merge_stack[idx] = None
1189
@deprecated_function(deprecated_in((2, 2, 0)))
1190
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
1191
include_merges=True):
1192
"""Produce an iterator of revisions to show
1193
:return: an iterator of (revision_id, revno, merge_depth)
1194
(if there is no revno for a revision, None is supplied)
1196
if not include_merges:
1197
revision_ids = mainline_revs[1:]
1198
if direction == 'reverse':
1199
revision_ids.reverse()
1200
for revision_id in revision_ids:
1201
yield revision_id, str(rev_nos[revision_id]), 0
1203
graph = branch.repository.get_graph()
1204
# This asks for all mainline revisions, which means we only have to spider
1205
# sideways, rather than depth history. That said, its still size-of-history
1206
# and should be addressed.
1207
# mainline_revisions always includes an extra revision at the beginning, so
1209
parent_map = dict(((key, value) for key, value in
1210
graph.iter_ancestry(mainline_revs[1:]) if value is not None))
1211
# filter out ghosts; merge_sort errors on ghosts.
1212
rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
1213
merge_sorted_revisions = tsort.merge_sort(
1217
generate_revno=True)
1219
if direction == 'forward':
1220
# forward means oldest first.
1221
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
1222
elif direction != 'reverse':
1223
raise ValueError('invalid direction %r' % direction)
1225
for (sequence, rev_id, merge_depth, revno, end_of_merge
1226
) in merge_sorted_revisions:
1227
yield rev_id, '.'.join(map(str, revno)), merge_depth
1230
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1231
"""Reverse revisions by depth.
1233
Revisions with a different depth are sorted as a group with the previous
1234
revision of that depth. There may be no topological justification for this,
1235
but it looks much nicer.
1237
# Add a fake revision at start so that we can always attach sub revisions
1238
merge_sorted_revisions = [(None, None, _depth)] + merge_sorted_revisions
1240
for val in merge_sorted_revisions:
1241
if val[2] == _depth:
1242
# Each revision at the current depth becomes a chunk grouping all
1243
# higher depth revisions.
1244
zd_revisions.append([val])
1246
zd_revisions[-1].append(val)
1247
for revisions in zd_revisions:
1248
if len(revisions) > 1:
1249
# We have higher depth revisions, let reverse them locally
1250
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
1251
zd_revisions.reverse()
1253
for chunk in zd_revisions:
1254
result.extend(chunk)
1256
# Top level call, get rid of the fake revisions that have been added
1257
result = [r for r in result if r[0] is not None and r[1] is not None]
1261
class LogRevision(object):
1262
"""A revision to be logged (by LogFormatter.log_revision).
1264
A simple wrapper for the attributes of a revision to be logged.
1265
The attributes may or may not be populated, as determined by the
1266
logging options and the log formatter capabilities.
1269
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1270
tags=None, diff=None):
1272
self.revno = str(revno)
1273
self.merge_depth = merge_depth
1279
class LogFormatter(object):
1280
"""Abstract class to display log messages.
1282
At a minimum, a derived class must implement the log_revision method.
1284
If the LogFormatter needs to be informed of the beginning or end of
1285
a log it should implement the begin_log and/or end_log hook methods.
1287
A LogFormatter should define the following supports_XXX flags
1288
to indicate which LogRevision attributes it supports:
1290
- supports_delta must be True if this log formatter supports delta.
1291
Otherwise the delta attribute may not be populated. The 'delta_format'
1292
attribute describes whether the 'short_status' format (1) or the long
1293
one (2) should be used.
1295
- supports_merge_revisions must be True if this log formatter supports
1296
merge revisions. If not, then only mainline revisions will be passed
1299
- preferred_levels is the number of levels this formatter defaults to.
1300
The default value is zero meaning display all levels.
1301
This value is only relevant if supports_merge_revisions is True.
1303
- supports_tags must be True if this log formatter supports tags.
1304
Otherwise the tags attribute may not be populated.
1306
- supports_diff must be True if this log formatter supports diffs.
1307
Otherwise the diff attribute may not be populated.
1309
Plugins can register functions to show custom revision properties using
1310
the properties_handler_registry. The registered function
1311
must respect the following interface description:
1312
def my_show_properties(properties_dict):
1313
# code that returns a dict {'name':'value'} of the properties
1316
preferred_levels = 0
1318
def __init__(self, to_file, show_ids=False, show_timezone='original',
1319
delta_format=None, levels=None, show_advice=False,
1320
to_exact_file=None):
1321
"""Create a LogFormatter.
1323
:param to_file: the file to output to
1324
:param to_exact_file: if set, gives an output stream to which
1325
non-Unicode diffs are written.
1326
:param show_ids: if True, revision-ids are to be displayed
1327
:param show_timezone: the timezone to use
1328
:param delta_format: the level of delta information to display
1329
or None to leave it to the formatter to decide
1330
:param levels: the number of levels to display; None or -1 to
1331
let the log formatter decide.
1332
:param show_advice: whether to show advice at the end of the
1335
self.to_file = to_file
1336
# 'exact' stream used to show diff, it should print content 'as is'
1337
# and should not try to decode/encode it to unicode to avoid bug #328007
1338
if to_exact_file is not None:
1339
self.to_exact_file = to_exact_file
1341
# XXX: somewhat hacky; this assumes it's a codec writer; it's better
1342
# for code that expects to get diffs to pass in the exact file
1344
self.to_exact_file = getattr(to_file, 'stream', to_file)
1345
self.show_ids = show_ids
1346
self.show_timezone = show_timezone
1347
if delta_format is None:
1348
# Ensures backward compatibility
1349
delta_format = 2 # long format
1350
self.delta_format = delta_format
1351
self.levels = levels
1352
self._show_advice = show_advice
1353
self._merge_count = 0
1355
def get_levels(self):
1356
"""Get the number of levels to display or 0 for all."""
1357
if getattr(self, 'supports_merge_revisions', False):
1358
if self.levels is None or self.levels == -1:
1359
self.levels = self.preferred_levels
1364
def log_revision(self, revision):
1367
:param revision: The LogRevision to be logged.
1369
raise NotImplementedError('not implemented in abstract base')
1371
def show_advice(self):
1372
"""Output user advice, if any, when the log is completed."""
1373
if self._show_advice and self.levels == 1 and self._merge_count > 0:
1374
advice_sep = self.get_advice_separator()
1376
self.to_file.write(advice_sep)
1378
"Use --include-merges or -n0 to see merged revisions.\n")
1380
def get_advice_separator(self):
1381
"""Get the text separating the log from the closing advice."""
1384
def short_committer(self, rev):
1385
name, address = config.parse_username(rev.committer)
1390
def short_author(self, rev):
1391
name, address = config.parse_username(rev.get_apparent_authors()[0])
1396
def merge_marker(self, revision):
1397
"""Get the merge marker to include in the output or '' if none."""
1398
if len(revision.rev.parent_ids) > 1:
1399
self._merge_count += 1
1404
def show_properties(self, revision, indent):
1405
"""Displays the custom properties returned by each registered handler.
1407
If a registered handler raises an error it is propagated.
1409
for line in self.custom_properties(revision):
1410
self.to_file.write("%s%s\n" % (indent, line))
1412
def custom_properties(self, revision):
1413
"""Format the custom properties returned by each registered handler.
1415
If a registered handler raises an error it is propagated.
1417
:return: a list of formatted lines (excluding trailing newlines)
1419
lines = self._foreign_info_properties(revision)
1420
for key, handler in properties_handler_registry.iteritems():
1421
lines.extend(self._format_properties(handler(revision)))
1424
def _foreign_info_properties(self, rev):
1425
"""Custom log displayer for foreign revision identifiers.
1427
:param rev: Revision object.
1429
# Revision comes directly from a foreign repository
1430
if isinstance(rev, foreign.ForeignRevision):
1431
return self._format_properties(
1432
rev.mapping.vcs.show_foreign_revid(rev.foreign_revid))
1434
# Imported foreign revision revision ids always contain :
1435
if not ":" in rev.revision_id:
1438
# Revision was once imported from a foreign repository
1440
foreign_revid, mapping = \
1441
foreign.foreign_vcs_registry.parse_revision_id(rev.revision_id)
1442
except errors.InvalidRevisionId:
1445
return self._format_properties(
1446
mapping.vcs.show_foreign_revid(foreign_revid))
1448
def _format_properties(self, properties):
1450
for key, value in properties.items():
1451
lines.append(key + ': ' + value)
1454
def show_diff(self, to_file, diff, indent):
1455
for l in diff.rstrip().split('\n'):
1456
to_file.write(indent + '%s\n' % (l,))
1459
# Separator between revisions in long format
1460
_LONG_SEP = '-' * 60
1463
class LongLogFormatter(LogFormatter):
1465
supports_merge_revisions = True
1466
preferred_levels = 1
1467
supports_delta = True
1468
supports_tags = True
1469
supports_diff = True
1471
def __init__(self, *args, **kwargs):
1472
super(LongLogFormatter, self).__init__(*args, **kwargs)
1473
if self.show_timezone == 'original':
1474
self.date_string = self._date_string_original_timezone
1476
self.date_string = self._date_string_with_timezone
1478
def _date_string_with_timezone(self, rev):
1479
return format_date(rev.timestamp, rev.timezone or 0,
1482
def _date_string_original_timezone(self, rev):
1483
return format_date_with_offset_in_original_timezone(rev.timestamp,
1486
def log_revision(self, revision):
1487
"""Log a revision, either merged or not."""
1488
indent = ' ' * revision.merge_depth
1490
if revision.revno is not None:
1491
lines.append('revno: %s%s' % (revision.revno,
1492
self.merge_marker(revision)))
1494
lines.append('tags: %s' % (', '.join(revision.tags)))
1496
lines.append('revision-id: %s' % (revision.rev.revision_id,))
1497
for parent_id in revision.rev.parent_ids:
1498
lines.append('parent: %s' % (parent_id,))
1499
lines.extend(self.custom_properties(revision.rev))
1501
committer = revision.rev.committer
1502
authors = revision.rev.get_apparent_authors()
1503
if authors != [committer]:
1504
lines.append('author: %s' % (", ".join(authors),))
1505
lines.append('committer: %s' % (committer,))
1507
branch_nick = revision.rev.properties.get('branch-nick', None)
1508
if branch_nick is not None:
1509
lines.append('branch nick: %s' % (branch_nick,))
1511
lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1513
lines.append('message:')
1514
if not revision.rev.message:
1515
lines.append(' (no message)')
1517
message = revision.rev.message.rstrip('\r\n')
1518
for l in message.split('\n'):
1519
lines.append(' %s' % (l,))
1521
# Dump the output, appending the delta and diff if requested
1522
to_file = self.to_file
1523
to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
1524
if revision.delta is not None:
1525
# Use the standard status output to display changes
1526
from bzrlib.delta import report_delta
1527
report_delta(to_file, revision.delta, short_status=False,
1528
show_ids=self.show_ids, indent=indent)
1529
if revision.diff is not None:
1530
to_file.write(indent + 'diff:\n')
1532
# Note: we explicitly don't indent the diff (relative to the
1533
# revision information) so that the output can be fed to patch -p0
1534
self.show_diff(self.to_exact_file, revision.diff, indent)
1535
self.to_exact_file.flush()
1537
def get_advice_separator(self):
1538
"""Get the text separating the log from the closing advice."""
1539
return '-' * 60 + '\n'
1542
class ShortLogFormatter(LogFormatter):
1544
supports_merge_revisions = True
1545
preferred_levels = 1
1546
supports_delta = True
1547
supports_tags = True
1548
supports_diff = True
1550
def __init__(self, *args, **kwargs):
1551
super(ShortLogFormatter, self).__init__(*args, **kwargs)
1552
self.revno_width_by_depth = {}
1554
def log_revision(self, revision):
1555
# We need two indents: one per depth and one for the information
1556
# relative to that indent. Most mainline revnos are 5 chars or
1557
# less while dotted revnos are typically 11 chars or less. Once
1558
# calculated, we need to remember the offset for a given depth
1559
# as we might be starting from a dotted revno in the first column
1560
# and we want subsequent mainline revisions to line up.
1561
depth = revision.merge_depth
1562
indent = ' ' * depth
1563
revno_width = self.revno_width_by_depth.get(depth)
1564
if revno_width is None:
1565
if revision.revno.find('.') == -1:
1566
# mainline revno, e.g. 12345
1569
# dotted revno, e.g. 12345.10.55
1571
self.revno_width_by_depth[depth] = revno_width
1572
offset = ' ' * (revno_width + 1)
1574
to_file = self.to_file
1577
tags = ' {%s}' % (', '.join(revision.tags))
1578
to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1579
revision.revno, self.short_author(revision.rev),
1580
format_date(revision.rev.timestamp,
1581
revision.rev.timezone or 0,
1582
self.show_timezone, date_fmt="%Y-%m-%d",
1584
tags, self.merge_marker(revision)))
1585
self.show_properties(revision.rev, indent+offset)
1587
to_file.write(indent + offset + 'revision-id:%s\n'
1588
% (revision.rev.revision_id,))
1589
if not revision.rev.message:
1590
to_file.write(indent + offset + '(no message)\n')
1592
message = revision.rev.message.rstrip('\r\n')
1593
for l in message.split('\n'):
1594
to_file.write(indent + offset + '%s\n' % (l,))
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,
1600
short_status=self.delta_format==1,
1601
show_ids=self.show_ids, indent=indent + offset)
1602
if revision.diff is not None:
1603
self.show_diff(self.to_exact_file, revision.diff, ' ')
1607
class LineLogFormatter(LogFormatter):
1609
supports_merge_revisions = True
1610
preferred_levels = 1
1611
supports_tags = True
1613
def __init__(self, *args, **kwargs):
1614
super(LineLogFormatter, self).__init__(*args, **kwargs)
1615
width = terminal_width()
1616
if width is not None:
1617
# we need one extra space for terminals that wrap on last char
1619
self._max_chars = width
1621
def truncate(self, str, max_len):
1622
if max_len is None or len(str) <= max_len:
1624
return str[:max_len-3] + '...'
1626
def date_string(self, rev):
1627
return format_date(rev.timestamp, rev.timezone or 0,
1628
self.show_timezone, date_fmt="%Y-%m-%d",
1631
def message(self, rev):
1633
return '(no message)'
1637
def log_revision(self, revision):
1638
indent = ' ' * revision.merge_depth
1639
self.to_file.write(self.log_string(revision.revno, revision.rev,
1640
self._max_chars, revision.tags, indent))
1641
self.to_file.write('\n')
1643
def log_string(self, revno, rev, max_chars, tags=None, prefix=''):
1644
"""Format log info into one string. Truncate tail of string
1645
:param revno: revision number or None.
1646
Revision numbers counts from 1.
1647
:param rev: revision object
1648
:param max_chars: maximum length of resulting string
1649
:param tags: list of tags or None
1650
:param prefix: string to prefix each line
1651
:return: formatted truncated string
1655
# show revno only when is not None
1656
out.append("%s:" % revno)
1657
out.append(self.truncate(self.short_author(rev), 20))
1658
out.append(self.date_string(rev))
1659
if len(rev.parent_ids) > 1:
1660
out.append('[merge]')
1662
tag_str = '{%s}' % (', '.join(tags))
1664
out.append(rev.get_summary())
1665
return self.truncate(prefix + " ".join(out).rstrip('\n'), max_chars)
1668
class GnuChangelogLogFormatter(LogFormatter):
1670
supports_merge_revisions = True
1671
supports_delta = True
1673
def log_revision(self, revision):
1674
"""Log a revision, either merged or not."""
1675
to_file = self.to_file
1677
date_str = format_date(revision.rev.timestamp,
1678
revision.rev.timezone or 0,
1680
date_fmt='%Y-%m-%d',
1682
committer_str = revision.rev.get_apparent_authors()[0].replace (' <', ' <')
1683
to_file.write('%s %s\n\n' % (date_str,committer_str))
1685
if revision.delta is not None and revision.delta.has_changed():
1686
for c in revision.delta.added + revision.delta.removed + revision.delta.modified:
1688
to_file.write('\t* %s:\n' % (path,))
1689
for c in revision.delta.renamed:
1690
oldpath,newpath = c[:2]
1691
# For renamed files, show both the old and the new path
1692
to_file.write('\t* %s:\n\t* %s:\n' % (oldpath,newpath))
1695
if not revision.rev.message:
1696
to_file.write('\tNo commit message\n')
1698
message = revision.rev.message.rstrip('\r\n')
1699
for l in message.split('\n'):
1700
to_file.write('\t%s\n' % (l.lstrip(),))
1704
def line_log(rev, max_chars):
1705
lf = LineLogFormatter(None)
1706
return lf.log_string(None, rev, max_chars)
1709
class LogFormatterRegistry(registry.Registry):
1710
"""Registry for log formatters"""
1712
def make_formatter(self, name, *args, **kwargs):
1713
"""Construct a formatter from arguments.
1715
:param name: Name of the formatter to construct. 'short', 'long' and
1716
'line' are built-in.
1718
return self.get(name)(*args, **kwargs)
1720
def get_default(self, branch):
1721
return self.get(branch.get_config().log_format())
1724
log_formatter_registry = LogFormatterRegistry()
1727
log_formatter_registry.register('short', ShortLogFormatter,
1728
'Moderately short log format')
1729
log_formatter_registry.register('long', LongLogFormatter,
1730
'Detailed log format')
1731
log_formatter_registry.register('line', LineLogFormatter,
1732
'Log format with one line per revision')
1733
log_formatter_registry.register('gnu-changelog', GnuChangelogLogFormatter,
1734
'Format used by GNU ChangeLog files')
1737
def register_formatter(name, formatter):
1738
log_formatter_registry.register(name, formatter)
1741
def log_formatter(name, *args, **kwargs):
1742
"""Construct a formatter from arguments.
1744
name -- Name of the formatter to construct; currently 'long', 'short' and
1745
'line' are supported.
1748
return log_formatter_registry.make_formatter(name, *args, **kwargs)
1750
raise errors.BzrCommandError("unknown log formatter: %r" % name)
1753
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
1754
# deprecated; for compatibility
1755
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
1756
lf.show(revno, rev, delta)
1759
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
1761
"""Show the change in revision history comparing the old revision history to the new one.
1763
:param branch: The branch where the revisions exist
1764
:param old_rh: The old revision history
1765
:param new_rh: The new revision history
1766
:param to_file: A file to write the results to. If None, stdout will be used
1769
to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
1771
lf = log_formatter(log_format,
1774
show_timezone='original')
1776
# This is the first index which is different between
1779
for i in xrange(max(len(new_rh),
1781
if (len(new_rh) <= i
1783
or new_rh[i] != old_rh[i]):
1787
if base_idx is None:
1788
to_file.write('Nothing seems to have changed\n')
1790
## TODO: It might be nice to do something like show_log
1791
## and show the merged entries. But since this is the
1792
## removed revisions, it shouldn't be as important
1793
if base_idx < len(old_rh):
1794
to_file.write('*'*60)
1795
to_file.write('\nRemoved Revisions:\n')
1796
for i in range(base_idx, len(old_rh)):
1797
rev = branch.repository.get_revision(old_rh[i])
1798
lr = LogRevision(rev, i+1, 0, None)
1800
to_file.write('*'*60)
1801
to_file.write('\n\n')
1802
if base_idx < len(new_rh):
1803
to_file.write('Added Revisions:\n')
1808
direction='forward',
1809
start_revision=base_idx+1,
1810
end_revision=len(new_rh),
1814
def get_history_change(old_revision_id, new_revision_id, repository):
1815
"""Calculate the uncommon lefthand history between two revisions.
1817
:param old_revision_id: The original revision id.
1818
:param new_revision_id: The new revision id.
1819
:param repository: The repository to use for the calculation.
1821
return old_history, new_history
1824
old_revisions = set()
1826
new_revisions = set()
1827
new_iter = repository.iter_reverse_revision_history(new_revision_id)
1828
old_iter = repository.iter_reverse_revision_history(old_revision_id)
1829
stop_revision = None
1832
while do_new or do_old:
1835
new_revision = new_iter.next()
1836
except StopIteration:
1839
new_history.append(new_revision)
1840
new_revisions.add(new_revision)
1841
if new_revision in old_revisions:
1842
stop_revision = new_revision
1846
old_revision = old_iter.next()
1847
except StopIteration:
1850
old_history.append(old_revision)
1851
old_revisions.add(old_revision)
1852
if old_revision in new_revisions:
1853
stop_revision = old_revision
1855
new_history.reverse()
1856
old_history.reverse()
1857
if stop_revision is not None:
1858
new_history = new_history[new_history.index(stop_revision) + 1:]
1859
old_history = old_history[old_history.index(stop_revision) + 1:]
1860
return old_history, new_history
1863
def show_branch_change(branch, output, old_revno, old_revision_id):
1864
"""Show the changes made to a branch.
1866
:param branch: The branch to show changes about.
1867
:param output: A file-like object to write changes to.
1868
:param old_revno: The revno of the old tip.
1869
:param old_revision_id: The revision_id of the old tip.
1871
new_revno, new_revision_id = branch.last_revision_info()
1872
old_history, new_history = get_history_change(old_revision_id,
1875
if old_history == [] and new_history == []:
1876
output.write('Nothing seems to have changed\n')
1879
log_format = log_formatter_registry.get_default(branch)
1880
lf = log_format(show_ids=False, to_file=output, show_timezone='original')
1881
if old_history != []:
1882
output.write('*'*60)
1883
output.write('\nRemoved Revisions:\n')
1884
show_flat_log(branch.repository, old_history, old_revno, lf)
1885
output.write('*'*60)
1886
output.write('\n\n')
1887
if new_history != []:
1888
output.write('Added Revisions:\n')
1889
start_revno = new_revno - len(new_history) + 1
1890
show_log(branch, lf, None, verbose=False, direction='forward',
1891
start_revision=start_revno,)
1894
def show_flat_log(repository, history, last_revno, lf):
1895
"""Show a simple log of the specified history.
1897
:param repository: The repository to retrieve revisions from.
1898
:param history: A list of revision_ids indicating the lefthand history.
1899
:param last_revno: The revno of the last revision_id in the history.
1900
:param lf: The log formatter to use.
1902
start_revno = last_revno - len(history) + 1
1903
revisions = repository.get_revisions(history)
1904
for i, rev in enumerate(revisions):
1905
lr = LogRevision(rev, i + last_revno, 0, None)
1909
def _get_info_for_log_files(revisionspec_list, file_list):
1910
"""Find file-ids and kinds given a list of files and a revision range.
1912
We search for files at the end of the range. If not found there,
1913
we try the start of the range.
1915
:param revisionspec_list: revision range as parsed on the command line
1916
:param file_list: the list of paths given on the command line;
1917
the first of these can be a branch location or a file path,
1918
the remainder must be file paths
1919
:return: (branch, info_list, start_rev_info, end_rev_info) where
1920
info_list is a list of (relative_path, file_id, kind) tuples where
1921
kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
1922
branch will be read-locked.
1924
from builtins import _get_revision_range, safe_relpath_files
1925
tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
1927
# XXX: It's damn messy converting a list of paths to relative paths when
1928
# those paths might be deleted ones, they might be on a case-insensitive
1929
# filesystem and/or they might be in silly locations (like another branch).
1930
# For example, what should "log bzr://branch/dir/file1 file2" do? (Is
1931
# file2 implicitly in the same dir as file1 or should its directory be
1932
# taken from the current tree somehow?) For now, this solves the common
1933
# case of running log in a nested directory, assuming paths beyond the
1934
# first one haven't been deleted ...
1936
relpaths = [path] + safe_relpath_files(tree, file_list[1:])
1938
relpaths = [path] + file_list[1:]
1940
start_rev_info, end_rev_info = _get_revision_range(revisionspec_list, b,
1942
if relpaths in ([], [u'']):
1943
return b, [], start_rev_info, end_rev_info
1944
if start_rev_info is None and end_rev_info is None:
1946
tree = b.basis_tree()
1949
file_id = tree.path2id(fp)
1950
kind = _get_kind_for_file_id(tree, file_id)
1952
# go back to when time began
1955
rev1 = b.get_rev_id(1)
1956
except errors.NoSuchRevision:
1961
tree1 = b.repository.revision_tree(rev1)
1963
file_id = tree1.path2id(fp)
1964
kind = _get_kind_for_file_id(tree1, file_id)
1965
info_list.append((fp, file_id, kind))
1967
elif start_rev_info == end_rev_info:
1968
# One revision given - file must exist in it
1969
tree = b.repository.revision_tree(end_rev_info.rev_id)
1971
file_id = tree.path2id(fp)
1972
kind = _get_kind_for_file_id(tree, file_id)
1973
info_list.append((fp, file_id, kind))
1976
# Revision range given. Get the file-id from the end tree.
1977
# If that fails, try the start tree.
1978
rev_id = end_rev_info.rev_id
1980
tree = b.basis_tree()
1982
tree = b.repository.revision_tree(rev_id)
1985
file_id = tree.path2id(fp)
1986
kind = _get_kind_for_file_id(tree, file_id)
1989
rev_id = start_rev_info.rev_id
1991
rev1 = b.get_rev_id(1)
1992
tree1 = b.repository.revision_tree(rev1)
1994
tree1 = b.repository.revision_tree(rev_id)
1995
file_id = tree1.path2id(fp)
1996
kind = _get_kind_for_file_id(tree1, file_id)
1997
info_list.append((fp, file_id, kind))
1998
return b, info_list, start_rev_info, end_rev_info
2001
def _get_kind_for_file_id(tree, file_id):
2002
"""Return the kind of a file-id or None if it doesn't exist."""
2003
if file_id is not None:
2004
return tree.kind(file_id)
2009
properties_handler_registry = registry.Registry()
2011
# Use the properties handlers to print out bug information if available
2012
def _bugs_properties_handler(revision):
2013
if revision.properties.has_key('bugs'):
2014
bug_lines = revision.properties['bugs'].split('\n')
2015
bug_rows = [line.split(' ', 1) for line in bug_lines]
2016
fixed_bug_urls = [row[0] for row in bug_rows if
2017
len(row) > 1 and row[1] == 'fixed']
2020
return {'fixes bug(s)': ' '.join(fixed_bug_urls)}
2023
properties_handler_registry.register('bugs_properties_handler',
2024
_bugs_properties_handler)
2027
# adapters which revision ids to log are filtered. When log is called, the
2028
# log_rev_iterator is adapted through each of these factory methods.
2029
# Plugins are welcome to mutate this list in any way they like - as long
2030
# as the overall behaviour is preserved. At this point there is no extensible
2031
# mechanism for getting parameters to each factory method, and until there is
2032
# this won't be considered a stable api.
2036
# read revision objects
2037
_make_revision_objects,
2038
# filter on log messages
2039
_make_search_filter,
2040
# generate deltas for things we will show
added
removed
bzrlib/log.py
