155
144
start_revision=None,
156
145
end_revision=None,
160
148
"""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
'exclude_common_ancestry': False,
224
'_match_using_deltas': True,
228
def make_log_request_dict(direction='reverse', specific_fileids=None,
229
start_revision=None, end_revision=None, limit=None,
230
message_search=None, levels=1, generate_tags=True,
232
diff_type=None, _match_using_deltas=True,
233
exclude_common_ancestry=False,
235
"""Convenience function for making a logging request dictionary.
237
Using this function may make code slightly safer by ensuring
238
parameters have the correct names. It also provides a reference
239
point for documenting the supported parameters.
241
:param direction: 'reverse' (default) is latest to earliest;
242
'forward' is earliest to latest.
244
:param specific_fileids: If not None, only include revisions
245
affecting the specified files, rather than all revisions.
247
:param start_revision: If not None, only generate
248
revisions >= start_revision
250
:param end_revision: If not None, only generate
251
revisions <= end_revision
253
:param limit: If set, generate only 'limit' revisions, all revisions
254
are shown if None or 0.
256
:param message_search: If not None, only include revisions with
257
matching commit messages
259
:param levels: the number of levels of revisions to
260
generate; 1 for just the mainline; 0 for all levels.
262
:param generate_tags: If True, include tags for matched revisions.
264
:param delta_type: Either 'full', 'partial' or None.
265
'full' means generate the complete delta - adds/deletes/modifies/etc;
266
'partial' means filter the delta using specific_fileids;
267
None means do not generate any delta.
269
:param diff_type: Either 'full', 'partial' or None.
270
'full' means generate the complete diff - adds/deletes/modifies/etc;
271
'partial' means filter the diff using specific_fileids;
272
None means do not generate any diff.
274
:param _match_using_deltas: a private parameter controlling the
275
algorithm used for matching specific_fileids. This parameter
276
may be removed in the future so bzrlib client code should NOT
279
:param exclude_common_ancestry: Whether -rX..Y should be interpreted as a
280
range operator or as a graph difference.
283
'direction': direction,
284
'specific_fileids': specific_fileids,
285
'start_revision': start_revision,
286
'end_revision': end_revision,
288
'message_search': message_search,
290
'generate_tags': generate_tags,
291
'delta_type': delta_type,
292
'diff_type': diff_type,
293
'exclude_common_ancestry': exclude_common_ancestry,
294
# Add 'private' attributes for features that may be deprecated
295
'_match_using_deltas': _match_using_deltas,
299
def _apply_log_request_defaults(rqst):
300
"""Apply default values to a request dictionary."""
301
result = _DEFAULT_REQUEST_PARAMS
307
class LogGenerator(object):
308
"""A generator of log revisions."""
310
def iter_log_revisions(self):
311
"""Iterate over LogRevision objects.
313
:return: An iterator yielding LogRevision objects.
315
raise NotImplementedError(self.iter_log_revisions)
318
class Logger(object):
319
"""An object that generates, formats and displays a log."""
321
def __init__(self, branch, rqst):
324
:param branch: the branch to log
325
:param rqst: A dictionary specifying the query parameters.
326
See make_log_request_dict() for supported values.
329
self.rqst = _apply_log_request_defaults(rqst)
334
:param lf: The LogFormatter object to send the output to.
336
if not isinstance(lf, LogFormatter):
337
warn("not a LogFormatter instance: %r" % lf)
339
self.branch.lock_read()
341
if getattr(lf, 'begin_log', None):
344
if getattr(lf, 'end_log', None):
349
def _show_body(self, lf):
350
"""Show the main log output.
352
Subclasses may wish to override this.
354
# Tweak the LogRequest based on what the LogFormatter can handle.
355
# (There's no point generating stuff if the formatter can't display it.)
357
rqst['levels'] = lf.get_levels()
358
if not getattr(lf, 'supports_tags', False):
359
rqst['generate_tags'] = False
360
if not getattr(lf, 'supports_delta', False):
361
rqst['delta_type'] = None
362
if not getattr(lf, 'supports_diff', False):
363
rqst['diff_type'] = None
365
# Find and print the interesting revisions
366
generator = self._generator_factory(self.branch, rqst)
367
for lr in generator.iter_log_revisions():
151
LogFormatter object to show the output.
154
If true, list only the commits affecting the specified
155
file, rather than all commits.
158
If true show added/changed/deleted/renamed files.
161
'reverse' (default) is latest to earliest;
162
'forward' is earliest to latest.
165
If not None, only show revisions >= start_revision
168
If not None, only show revisions <= end_revision
171
If not None, only show revisions with matching commit messages
174
If not None or 0, only show limit revisions
178
if getattr(lf, 'begin_log', None):
181
_show_log(branch, lf, specific_fileid, verbose, direction,
182
start_revision, end_revision, search, limit)
184
if getattr(lf, 'end_log', None):
190
def _show_log(branch,
192
specific_fileid=None,
199
"""Worker function for show_log - see show_log."""
200
if not isinstance(lf, LogFormatter):
201
warn("not a LogFormatter instance: %r" % lf)
204
trace.mutter('get log for file_id %r', specific_fileid)
205
generate_merge_revisions = getattr(lf, 'supports_merge_revisions', False)
206
allow_single_merge_revision = getattr(lf,
207
'supports_single_merge_revision', False)
208
view_revisions = calculate_view_revisions(branch, start_revision,
209
end_revision, direction,
211
generate_merge_revisions,
212
allow_single_merge_revision)
214
generate_tags = getattr(lf, 'supports_tags', False)
216
if branch.supports_tags():
217
rev_tag_dict = branch.tags.get_reverse_tag_dict()
219
generate_delta = verbose and getattr(lf, 'supports_delta', False)
221
# now we just print all the revisions
223
revision_iterator = make_log_rev_iterator(branch, view_revisions,
224
generate_delta, search)
225
for revs in revision_iterator:
226
for (rev_id, revno, merge_depth), rev, delta in revs:
227
lr = LogRevision(rev, revno, merge_depth, delta,
228
rev_tag_dict.get(rev_id))
368
229
lf.log_revision(lr)
371
def _generator_factory(self, branch, rqst):
372
"""Make the LogGenerator object to use.
374
Subclasses may wish to override this.
376
return _DefaultLogGenerator(branch, rqst)
379
class _StartNotLinearAncestor(Exception):
380
"""Raised when a start revision is not found walking left-hand history."""
383
class _DefaultLogGenerator(LogGenerator):
384
"""The default generator of log revisions."""
386
def __init__(self, branch, rqst):
389
if rqst.get('generate_tags') and branch.supports_tags():
390
self.rev_tag_dict = branch.tags.get_reverse_tag_dict()
392
self.rev_tag_dict = {}
394
def iter_log_revisions(self):
395
"""Iterate over LogRevision objects.
397
:return: An iterator yielding LogRevision objects.
400
levels = rqst.get('levels')
401
limit = rqst.get('limit')
402
diff_type = rqst.get('diff_type')
404
revision_iterator = self._create_log_revision_iterator()
405
for revs in revision_iterator:
406
for (rev_id, revno, merge_depth), rev, delta in revs:
407
# 0 levels means show everything; merge_depth counts from 0
408
if levels != 0 and merge_depth >= levels:
410
if diff_type is None:
413
diff = self._format_diff(rev, rev_id, diff_type)
414
yield LogRevision(rev, revno, merge_depth, delta,
415
self.rev_tag_dict.get(rev_id), diff)
418
if log_count >= limit:
421
def _format_diff(self, rev, rev_id, diff_type):
422
repo = self.branch.repository
423
if len(rev.parent_ids) == 0:
424
ancestor_id = _mod_revision.NULL_REVISION
426
ancestor_id = rev.parent_ids[0]
427
tree_1 = repo.revision_tree(ancestor_id)
428
tree_2 = repo.revision_tree(rev_id)
429
file_ids = self.rqst.get('specific_fileids')
430
if diff_type == 'partial' and file_ids is not None:
431
specific_files = [tree_2.id2path(id) for id in file_ids]
433
specific_files = None
435
diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
439
def _create_log_revision_iterator(self):
440
"""Create a revision iterator for log.
442
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
445
self.start_rev_id, self.end_rev_id = _get_revision_limits(
446
self.branch, self.rqst.get('start_revision'),
447
self.rqst.get('end_revision'))
448
if self.rqst.get('_match_using_deltas'):
449
return self._log_revision_iterator_using_delta_matching()
451
# We're using the per-file-graph algorithm. This scales really
452
# well but only makes sense if there is a single file and it's
454
file_count = len(self.rqst.get('specific_fileids'))
456
raise BzrError("illegal LogRequest: must match-using-deltas "
457
"when logging %d files" % file_count)
458
return self._log_revision_iterator_using_per_file_graph()
460
def _log_revision_iterator_using_delta_matching(self):
461
# Get the base revisions, filtering by the revision range
463
generate_merge_revisions = rqst.get('levels') != 1
464
delayed_graph_generation = not rqst.get('specific_fileids') and (
465
rqst.get('limit') or self.start_rev_id or self.end_rev_id)
466
view_revisions = _calc_view_revisions(
467
self.branch, self.start_rev_id, self.end_rev_id,
468
rqst.get('direction'),
469
generate_merge_revisions=generate_merge_revisions,
470
delayed_graph_generation=delayed_graph_generation,
471
exclude_common_ancestry=rqst.get('exclude_common_ancestry'))
473
# Apply the other filters
474
return make_log_rev_iterator(self.branch, view_revisions,
475
rqst.get('delta_type'), rqst.get('message_search'),
476
file_ids=rqst.get('specific_fileids'),
477
direction=rqst.get('direction'))
479
def _log_revision_iterator_using_per_file_graph(self):
480
# Get the base revisions, filtering by the revision range.
481
# Note that we always generate the merge revisions because
482
# filter_revisions_touching_file_id() requires them ...
484
view_revisions = _calc_view_revisions(
485
self.branch, self.start_rev_id, self.end_rev_id,
486
rqst.get('direction'), generate_merge_revisions=True,
487
exclude_common_ancestry=rqst.get('exclude_common_ancestry'))
488
if not isinstance(view_revisions, list):
489
view_revisions = list(view_revisions)
490
view_revisions = _filter_revisions_touching_file_id(self.branch,
491
rqst.get('specific_fileids')[0], view_revisions,
492
include_merges=rqst.get('levels') != 1)
493
return make_log_rev_iterator(self.branch, view_revisions,
494
rqst.get('delta_type'), rqst.get('message_search'))
497
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
498
generate_merge_revisions,
499
delayed_graph_generation=False,
500
exclude_common_ancestry=False,
502
"""Calculate the revisions to view.
504
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
505
a list of the same tuples.
507
if (exclude_common_ancestry and start_rev_id == end_rev_id):
508
raise errors.BzrCommandError(
509
'--exclude-common-ancestry requires two different revisions')
510
if direction not in ('reverse', 'forward'):
511
raise ValueError('invalid direction %r' % direction)
512
br_revno, br_rev_id = branch.last_revision_info()
516
if (end_rev_id and start_rev_id == end_rev_id
517
and (not generate_merge_revisions
518
or not _has_merges(branch, end_rev_id))):
519
# If a single revision is requested, check we can handle it
520
iter_revs = _generate_one_revision(branch, end_rev_id, br_rev_id,
522
elif not generate_merge_revisions:
523
# If we only want to see linear revisions, we can iterate ...
524
iter_revs = _generate_flat_revisions(branch, start_rev_id, end_rev_id,
526
if direction == 'forward':
527
iter_revs = reversed(iter_revs)
529
iter_revs = _generate_all_revisions(branch, start_rev_id, end_rev_id,
530
direction, delayed_graph_generation,
531
exclude_common_ancestry)
532
if direction == 'forward':
533
iter_revs = _rebase_merge_depth(reverse_by_depth(list(iter_revs)))
537
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
538
if rev_id == br_rev_id:
540
return [(br_rev_id, br_revno, 0)]
542
revno = branch.revision_id_to_dotted_revno(rev_id)
543
revno_str = '.'.join(str(n) for n in revno)
544
return [(rev_id, revno_str, 0)]
547
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction):
548
result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
549
# If a start limit was given and it's not obviously an
550
# ancestor of the end limit, check it before outputting anything
551
if direction == 'forward' or (start_rev_id
552
and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
554
result = list(result)
555
except _StartNotLinearAncestor:
556
raise errors.BzrCommandError('Start revision not found in'
557
' left-hand history of end revision.')
561
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
562
delayed_graph_generation,
563
exclude_common_ancestry=False):
564
# On large trees, generating the merge graph can take 30-60 seconds
565
# so we delay doing it until a merge is detected, incrementally
566
# returning initial (non-merge) revisions while we can.
568
# The above is only true for old formats (<= 0.92), for newer formats, a
569
# couple of seconds only should be needed to load the whole graph and the
570
# other graph operations needed are even faster than that -- vila 100201
571
initial_revisions = []
572
if delayed_graph_generation:
574
for rev_id, revno, depth in _linear_view_revisions(
575
branch, start_rev_id, end_rev_id):
576
if _has_merges(branch, rev_id):
577
# The end_rev_id can be nested down somewhere. We need an
578
# explicit ancestry check. There is an ambiguity here as we
579
# may not raise _StartNotLinearAncestor for a revision that
580
# is an ancestor but not a *linear* one. But since we have
581
# loaded the graph to do the check (or calculate a dotted
582
# revno), we may as well accept to show the log... We need
583
# the check only if start_rev_id is not None as all
584
# revisions have _mod_revision.NULL_REVISION as an ancestor
586
graph = branch.repository.get_graph()
587
if (start_rev_id is not None
588
and not graph.is_ancestor(start_rev_id, end_rev_id)):
589
raise _StartNotLinearAncestor()
590
# Since we collected the revisions so far, we need to
595
initial_revisions.append((rev_id, revno, depth))
597
# No merged revisions found
598
return initial_revisions
599
except _StartNotLinearAncestor:
600
# A merge was never detected so the lower revision limit can't
601
# be nested down somewhere
602
raise errors.BzrCommandError('Start revision not found in'
603
' history of end revision.')
605
# We exit the loop above because we encounter a revision with merges, from
606
# this revision, we need to switch to _graph_view_revisions.
608
# A log including nested merges is required. If the direction is reverse,
609
# we rebase the initial merge depths so that the development line is
610
# shown naturally, i.e. just like it is for linear logging. We can easily
611
# make forward the exact opposite display, but showing the merge revisions
612
# indented at the end seems slightly nicer in that case.
613
view_revisions = chain(iter(initial_revisions),
614
_graph_view_revisions(branch, start_rev_id, end_rev_id,
615
rebase_initial_depths=(direction == 'reverse'),
616
exclude_common_ancestry=exclude_common_ancestry))
617
return view_revisions
620
def _has_merges(branch, rev_id):
621
"""Does a revision have multiple parents or not?"""
622
parents = branch.repository.get_parent_map([rev_id]).get(rev_id, [])
623
return len(parents) > 1
626
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
627
"""Is start_rev_id an obvious ancestor of end_rev_id?"""
628
if start_rev_id and end_rev_id:
629
start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
630
end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
631
if len(start_dotted) == 1 and len(end_dotted) == 1:
633
return start_dotted[0] <= end_dotted[0]
634
elif (len(start_dotted) == 3 and len(end_dotted) == 3 and
635
start_dotted[0:1] == end_dotted[0:1]):
636
# both on same development line
637
return start_dotted[2] <= end_dotted[2]
641
# if either start or end is not specified then we use either the first or
642
# the last revision and *they* are obvious ancestors.
646
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
647
"""Calculate a sequence of revisions to view, newest to oldest.
649
:param start_rev_id: the lower revision-id
650
:param end_rev_id: the upper revision-id
651
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
652
:raises _StartNotLinearAncestor: if a start_rev_id is specified but
653
is not found walking the left-hand history
655
br_revno, br_rev_id = branch.last_revision_info()
656
repo = branch.repository
657
if start_rev_id is None and end_rev_id is None:
659
for revision_id in repo.iter_reverse_revision_history(br_rev_id):
660
yield revision_id, str(cur_revno), 0
663
if end_rev_id is None:
664
end_rev_id = br_rev_id
665
found_start = start_rev_id is None
666
for revision_id in repo.iter_reverse_revision_history(end_rev_id):
667
revno = branch.revision_id_to_dotted_revno(revision_id)
668
revno_str = '.'.join(str(n) for n in revno)
669
if not found_start and revision_id == start_rev_id:
670
yield revision_id, revno_str, 0
674
yield revision_id, revno_str, 0
677
raise _StartNotLinearAncestor()
680
def _graph_view_revisions(branch, start_rev_id, end_rev_id,
681
rebase_initial_depths=True,
682
exclude_common_ancestry=False):
683
"""Calculate revisions to view including merges, newest to oldest.
685
:param branch: the branch
686
:param start_rev_id: the lower revision-id
687
:param end_rev_id: the upper revision-id
688
:param rebase_initial_depth: should depths be rebased until a mainline
690
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
692
if exclude_common_ancestry:
693
stop_rule = 'with-merges-without-common-ancestry'
695
stop_rule = 'with-merges'
696
view_revisions = branch.iter_merge_sorted_revisions(
697
start_revision_id=end_rev_id, stop_revision_id=start_rev_id,
699
if not rebase_initial_depths:
700
for (rev_id, merge_depth, revno, end_of_merge
702
yield rev_id, '.'.join(map(str, revno)), merge_depth
704
# We're following a development line starting at a merged revision.
705
# We need to adjust depths down by the initial depth until we find
706
# a depth less than it. Then we use that depth as the adjustment.
707
# If and when we reach the mainline, depth adjustment ends.
708
depth_adjustment = None
709
for (rev_id, merge_depth, revno, end_of_merge
711
if depth_adjustment is None:
712
depth_adjustment = merge_depth
714
if merge_depth < depth_adjustment:
715
# From now on we reduce the depth adjustement, this can be
716
# surprising for users. The alternative requires two passes
717
# which breaks the fast display of the first revision
719
depth_adjustment = merge_depth
720
merge_depth -= depth_adjustment
721
yield rev_id, '.'.join(map(str, revno)), merge_depth
724
@deprecated_function(deprecated_in((2, 2, 0)))
232
if log_count >= limit:
725
236
def calculate_view_revisions(branch, start_revision, end_revision, direction,
726
specific_fileid, generate_merge_revisions):
727
"""Calculate the revisions to view.
729
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
730
a list of the same tuples.
732
start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
734
view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
735
direction, generate_merge_revisions or specific_fileid))
237
specific_fileid, generate_merge_revisions,
238
allow_single_merge_revision):
239
if (not generate_merge_revisions and start_revision is end_revision is
240
None and direction == 'reverse' and specific_fileid is None):
241
return _linear_view_revisions(branch)
243
mainline_revs, rev_nos, start_rev_id, end_rev_id = \
244
_get_mainline_revs(branch, start_revision, end_revision)
245
if not mainline_revs:
248
if direction == 'reverse':
249
start_rev_id, end_rev_id = end_rev_id, start_rev_id
251
generate_single_revision = False
252
if ((not generate_merge_revisions)
253
and ((start_rev_id and (start_rev_id not in rev_nos))
254
or (end_rev_id and (end_rev_id not in rev_nos)))):
255
generate_single_revision = ((start_rev_id == end_rev_id)
256
and allow_single_merge_revision)
257
if not generate_single_revision:
258
raise errors.BzrCommandError('Selected log formatter only supports'
259
' mainline revisions.')
260
generate_merge_revisions = generate_single_revision
261
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
262
direction, include_merges=generate_merge_revisions)
263
view_revisions = _filter_revision_range(list(view_revs_iter),
266
if view_revisions and generate_single_revision:
267
view_revisions = view_revisions[0:1]
736
268
if specific_fileid:
737
269
view_revisions = _filter_revisions_touching_file_id(branch,
738
specific_fileid, view_revisions,
739
include_merges=generate_merge_revisions)
740
return _rebase_merge_depth(view_revisions)
743
def _rebase_merge_depth(view_revisions):
744
"""Adjust depths upwards so the top level is 0."""
745
# If either the first or last revision have a merge_depth of 0, we're done
274
# rebase merge_depth - unless there are no revisions or
275
# either the first or last revision have merge_depth = 0.
746
276
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
747
277
min_depth = min([d for r,n,d in view_revisions])
748
278
if min_depth != 0:
1417
754
def short_author(self, rev):
1418
return self.authors(rev, 'first', short=True, sep=', ')
1420
def authors(self, rev, who, short=False, sep=None):
1421
"""Generate list of authors, taking --authors option into account.
1423
The caller has to specify the name of a author list handler,
1424
as provided by the author list registry, using the ``who``
1425
argument. That name only sets a default, though: when the
1426
user selected a different author list generation using the
1427
``--authors`` command line switch, as represented by the
1428
``author_list_handler`` constructor argument, that value takes
1431
:param rev: The revision for which to generate the list of authors.
1432
:param who: Name of the default handler.
1433
:param short: Whether to shorten names to either name or address.
1434
:param sep: What separator to use for automatic concatenation.
1436
if self._author_list_handler is not None:
1437
# The user did specify --authors, which overrides the default
1438
author_list_handler = self._author_list_handler
1440
# The user didn't specify --authors, so we use the caller's default
1441
author_list_handler = author_list_registry.get(who)
1442
names = author_list_handler(rev)
1444
for i in range(len(names)):
1445
name, address = config.parse_username(names[i])
1451
names = sep.join(names)
1454
def merge_marker(self, revision):
1455
"""Get the merge marker to include in the output or '' if none."""
1456
if len(revision.rev.parent_ids) > 1:
1457
self._merge_count += 1
755
name, address = config.parse_username(rev.get_apparent_author())
1462
760
def show_properties(self, revision, indent):
1463
761
"""Displays the custom properties returned by each registered handler.
1465
If a registered handler raises an error it is propagated.
1467
for line in self.custom_properties(revision):
1468
self.to_file.write("%s%s\n" % (indent, line))
1470
def custom_properties(self, revision):
1471
"""Format the custom properties returned by each registered handler.
1473
If a registered handler raises an error it is propagated.
1475
:return: a list of formatted lines (excluding trailing newlines)
1477
lines = self._foreign_info_properties(revision)
763
If a registered handler raises an error it is propagated.
1478
765
for key, handler in properties_handler_registry.iteritems():
1479
lines.extend(self._format_properties(handler(revision)))
1482
def _foreign_info_properties(self, rev):
1483
"""Custom log displayer for foreign revision identifiers.
1485
:param rev: Revision object.
1487
# Revision comes directly from a foreign repository
1488
if isinstance(rev, foreign.ForeignRevision):
1489
return self._format_properties(
1490
rev.mapping.vcs.show_foreign_revid(rev.foreign_revid))
1492
# Imported foreign revision revision ids always contain :
1493
if not ":" in rev.revision_id:
1496
# Revision was once imported from a foreign repository
1498
foreign_revid, mapping = \
1499
foreign.foreign_vcs_registry.parse_revision_id(rev.revision_id)
1500
except errors.InvalidRevisionId:
1503
return self._format_properties(
1504
mapping.vcs.show_foreign_revid(foreign_revid))
1506
def _format_properties(self, properties):
1508
for key, value in properties.items():
1509
lines.append(key + ': ' + value)
1512
def show_diff(self, to_file, diff, indent):
1513
for l in diff.rstrip().split('\n'):
1514
to_file.write(indent + '%s\n' % (l,))
1517
# Separator between revisions in long format
1518
_LONG_SEP = '-' * 60
766
for key, value in handler(revision).items():
767
self.to_file.write(indent + key + ': ' + value + '\n')
1521
770
class LongLogFormatter(LogFormatter):
1523
772
supports_merge_revisions = True
1524
preferred_levels = 1
1525
773
supports_delta = True
1526
774
supports_tags = True
1527
supports_diff = True
1529
def __init__(self, *args, **kwargs):
1530
super(LongLogFormatter, self).__init__(*args, **kwargs)
1531
if self.show_timezone == 'original':
1532
self.date_string = self._date_string_original_timezone
1534
self.date_string = self._date_string_with_timezone
1536
def _date_string_with_timezone(self, rev):
1537
return format_date(rev.timestamp, rev.timezone or 0,
1540
def _date_string_original_timezone(self, rev):
1541
return format_date_with_offset_in_original_timezone(rev.timestamp,
1544
776
def log_revision(self, revision):
1545
777
"""Log a revision, either merged or not."""
1546
778
indent = ' ' * revision.merge_depth
779
to_file = self.to_file
780
to_file.write(indent + '-' * 60 + '\n')
1548
781
if revision.revno is not None:
1549
lines.append('revno: %s%s' % (revision.revno,
1550
self.merge_marker(revision)))
782
to_file.write(indent + 'revno: %s\n' % (revision.revno,))
1551
783
if revision.tags:
1552
lines.append('tags: %s' % (', '.join(revision.tags)))
784
to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
1553
785
if self.show_ids:
1554
lines.append('revision-id: %s' % (revision.rev.revision_id,))
786
to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
1555
788
for parent_id in revision.rev.parent_ids:
1556
lines.append('parent: %s' % (parent_id,))
1557
lines.extend(self.custom_properties(revision.rev))
789
to_file.write(indent + 'parent: %s\n' % (parent_id,))
790
self.show_properties(revision.rev, indent)
1559
committer = revision.rev.committer
1560
authors = self.authors(revision.rev, 'all')
1561
if authors != [committer]:
1562
lines.append('author: %s' % (", ".join(authors),))
1563
lines.append('committer: %s' % (committer,))
792
author = revision.rev.properties.get('author', None)
793
if author is not None:
794
to_file.write(indent + 'author: %s\n' % (author,))
795
to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
1565
797
branch_nick = revision.rev.properties.get('branch-nick', None)
1566
798
if branch_nick is not None:
1567
lines.append('branch nick: %s' % (branch_nick,))
1569
lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1571
lines.append('message:')
799
to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
801
date_str = format_date(revision.rev.timestamp,
802
revision.rev.timezone or 0,
804
to_file.write(indent + 'timestamp: %s\n' % (date_str,))
806
to_file.write(indent + 'message:\n')
1572
807
if not revision.rev.message:
1573
lines.append(' (no message)')
808
to_file.write(indent + ' (no message)\n')
1575
810
message = revision.rev.message.rstrip('\r\n')
1576
811
for l in message.split('\n'):
1577
lines.append(' %s' % (l,))
1579
# Dump the output, appending the delta and diff if requested
1580
to_file = self.to_file
1581
to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
812
to_file.write(indent + ' %s\n' % (l,))
1582
813
if revision.delta is not None:
1583
# Use the standard status output to display changes
1584
from bzrlib.delta import report_delta
1585
report_delta(to_file, revision.delta, short_status=False,
1586
show_ids=self.show_ids, indent=indent)
1587
if revision.diff is not None:
1588
to_file.write(indent + 'diff:\n')
1590
# Note: we explicitly don't indent the diff (relative to the
1591
# revision information) so that the output can be fed to patch -p0
1592
self.show_diff(self.to_exact_file, revision.diff, indent)
1593
self.to_exact_file.flush()
1595
def get_advice_separator(self):
1596
"""Get the text separating the log from the closing advice."""
1597
return '-' * 60 + '\n'
814
revision.delta.show(to_file, self.show_ids, indent=indent)
1600
817
class ShortLogFormatter(LogFormatter):
1602
supports_merge_revisions = True
1603
preferred_levels = 1
1604
819
supports_delta = True
1605
supports_tags = True
1606
supports_diff = True
1608
def __init__(self, *args, **kwargs):
1609
super(ShortLogFormatter, self).__init__(*args, **kwargs)
1610
self.revno_width_by_depth = {}
820
supports_single_merge_revision = True
1612
822
def log_revision(self, revision):
1613
# We need two indents: one per depth and one for the information
1614
# relative to that indent. Most mainline revnos are 5 chars or
1615
# less while dotted revnos are typically 11 chars or less. Once
1616
# calculated, we need to remember the offset for a given depth
1617
# as we might be starting from a dotted revno in the first column
1618
# and we want subsequent mainline revisions to line up.
1619
depth = revision.merge_depth
1620
indent = ' ' * depth
1621
revno_width = self.revno_width_by_depth.get(depth)
1622
if revno_width is None:
1623
if revision.revno.find('.') == -1:
1624
# mainline revno, e.g. 12345
1627
# dotted revno, e.g. 12345.10.55
1629
self.revno_width_by_depth[depth] = revno_width
1630
offset = ' ' * (revno_width + 1)
1632
823
to_file = self.to_file
1635
tags = ' {%s}' % (', '.join(revision.tags))
1636
to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1637
revision.revno, self.short_author(revision.rev),
825
if len(revision.rev.parent_ids) > 1:
826
is_merge = ' [merge]'
827
to_file.write("%5s %s\t%s%s\n" % (revision.revno,
828
self.short_author(revision.rev),
1638
829
format_date(revision.rev.timestamp,
1639
830
revision.rev.timezone or 0,
1640
831
self.show_timezone, date_fmt="%Y-%m-%d",
1641
832
show_offset=False),
1642
tags, self.merge_marker(revision)))
1643
self.show_properties(revision.rev, indent+offset)
1644
834
if self.show_ids:
1645
to_file.write(indent + offset + 'revision-id:%s\n'
1646
% (revision.rev.revision_id,))
835
to_file.write(' revision-id:%s\n' % (revision.rev.revision_id,))
1647
836
if not revision.rev.message:
1648
to_file.write(indent + offset + '(no message)\n')
837
to_file.write(' (no message)\n')
1650
839
message = revision.rev.message.rstrip('\r\n')
1651
840
for l in message.split('\n'):
1652
to_file.write(indent + offset + '%s\n' % (l,))
841
to_file.write(' %s\n' % (l,))
843
# TODO: Why not show the modified files in a shorter form as
844
# well? rewrap them single lines of appropriate length
1654
845
if revision.delta is not None:
1655
# Use the standard status output to display changes
1656
from bzrlib.delta import report_delta
1657
report_delta(to_file, revision.delta,
1658
short_status=self.delta_format==1,
1659
show_ids=self.show_ids, indent=indent + offset)
1660
if revision.diff is not None:
1661
self.show_diff(self.to_exact_file, revision.diff, ' ')
846
revision.delta.show(to_file, self.show_ids)
1662
847
to_file.write('\n')
1665
850
class LineLogFormatter(LogFormatter):
1667
supports_merge_revisions = True
1668
preferred_levels = 1
1669
supports_tags = True
852
supports_single_merge_revision = True
1671
854
def __init__(self, *args, **kwargs):
1672
855
super(LineLogFormatter, self).__init__(*args, **kwargs)
1673
width = terminal_width()
1674
if width is not None:
1675
# we need one extra space for terminals that wrap on last char
1677
self._max_chars = width
856
self._max_chars = terminal_width() - 1
1679
858
def truncate(self, str, max_len):
1680
if max_len is None or len(str) <= max_len:
859
if len(str) <= max_len:
1682
return str[:max_len-3] + '...'
861
return str[:max_len-3]+'...'
1684
863
def date_string(self, rev):
1685
return format_date(rev.timestamp, rev.timezone or 0,
864
return format_date(rev.timestamp, rev.timezone or 0,
1686
865
self.show_timezone, date_fmt="%Y-%m-%d",
1687
866
show_offset=False)
1901
def get_history_change(old_revision_id, new_revision_id, repository):
1902
"""Calculate the uncommon lefthand history between two revisions.
1904
:param old_revision_id: The original revision id.
1905
:param new_revision_id: The new revision id.
1906
:param repository: The repository to use for the calculation.
1908
return old_history, new_history
1911
old_revisions = set()
1913
new_revisions = set()
1914
new_iter = repository.iter_reverse_revision_history(new_revision_id)
1915
old_iter = repository.iter_reverse_revision_history(old_revision_id)
1916
stop_revision = None
1919
while do_new or do_old:
1922
new_revision = new_iter.next()
1923
except StopIteration:
1926
new_history.append(new_revision)
1927
new_revisions.add(new_revision)
1928
if new_revision in old_revisions:
1929
stop_revision = new_revision
1933
old_revision = old_iter.next()
1934
except StopIteration:
1937
old_history.append(old_revision)
1938
old_revisions.add(old_revision)
1939
if old_revision in new_revisions:
1940
stop_revision = old_revision
1942
new_history.reverse()
1943
old_history.reverse()
1944
if stop_revision is not None:
1945
new_history = new_history[new_history.index(stop_revision) + 1:]
1946
old_history = old_history[old_history.index(stop_revision) + 1:]
1947
return old_history, new_history
1950
def show_branch_change(branch, output, old_revno, old_revision_id):
1951
"""Show the changes made to a branch.
1953
:param branch: The branch to show changes about.
1954
:param output: A file-like object to write changes to.
1955
:param old_revno: The revno of the old tip.
1956
:param old_revision_id: The revision_id of the old tip.
1958
new_revno, new_revision_id = branch.last_revision_info()
1959
old_history, new_history = get_history_change(old_revision_id,
1962
if old_history == [] and new_history == []:
1963
output.write('Nothing seems to have changed\n')
1966
log_format = log_formatter_registry.get_default(branch)
1967
lf = log_format(show_ids=False, to_file=output, show_timezone='original')
1968
if old_history != []:
1969
output.write('*'*60)
1970
output.write('\nRemoved Revisions:\n')
1971
show_flat_log(branch.repository, old_history, old_revno, lf)
1972
output.write('*'*60)
1973
output.write('\n\n')
1974
if new_history != []:
1975
output.write('Added Revisions:\n')
1976
start_revno = new_revno - len(new_history) + 1
1977
show_log(branch, lf, None, verbose=False, direction='forward',
1978
start_revision=start_revno,)
1981
def show_flat_log(repository, history, last_revno, lf):
1982
"""Show a simple log of the specified history.
1984
:param repository: The repository to retrieve revisions from.
1985
:param history: A list of revision_ids indicating the lefthand history.
1986
:param last_revno: The revno of the last revision_id in the history.
1987
:param lf: The log formatter to use.
1989
start_revno = last_revno - len(history) + 1
1990
revisions = repository.get_revisions(history)
1991
for i, rev in enumerate(revisions):
1992
lr = LogRevision(rev, i + last_revno, 0, None)
1996
def _get_info_for_log_files(revisionspec_list, file_list, add_cleanup):
1997
"""Find file-ids and kinds given a list of files and a revision range.
1999
We search for files at the end of the range. If not found there,
2000
we try the start of the range.
2002
:param revisionspec_list: revision range as parsed on the command line
2003
:param file_list: the list of paths given on the command line;
2004
the first of these can be a branch location or a file path,
2005
the remainder must be file paths
2006
:param add_cleanup: When the branch returned is read locked,
2007
an unlock call will be queued to the cleanup.
2008
:return: (branch, info_list, start_rev_info, end_rev_info) where
2009
info_list is a list of (relative_path, file_id, kind) tuples where
2010
kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
2011
branch will be read-locked.
2013
from builtins import _get_revision_range, safe_relpath_files
2014
tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
2015
add_cleanup(b.lock_read().unlock)
2016
# XXX: It's damn messy converting a list of paths to relative paths when
2017
# those paths might be deleted ones, they might be on a case-insensitive
2018
# filesystem and/or they might be in silly locations (like another branch).
2019
# For example, what should "log bzr://branch/dir/file1 file2" do? (Is
2020
# file2 implicitly in the same dir as file1 or should its directory be
2021
# taken from the current tree somehow?) For now, this solves the common
2022
# case of running log in a nested directory, assuming paths beyond the
2023
# first one haven't been deleted ...
2025
relpaths = [path] + safe_relpath_files(tree, file_list[1:])
2027
relpaths = [path] + file_list[1:]
2029
start_rev_info, end_rev_info = _get_revision_range(revisionspec_list, b,
2031
if relpaths in ([], [u'']):
2032
return b, [], start_rev_info, end_rev_info
2033
if start_rev_info is None and end_rev_info is None:
2035
tree = b.basis_tree()
2038
file_id = tree.path2id(fp)
2039
kind = _get_kind_for_file_id(tree, file_id)
2041
# go back to when time began
2044
rev1 = b.get_rev_id(1)
2045
except errors.NoSuchRevision:
2050
tree1 = b.repository.revision_tree(rev1)
2052
file_id = tree1.path2id(fp)
2053
kind = _get_kind_for_file_id(tree1, file_id)
2054
info_list.append((fp, file_id, kind))
2056
elif start_rev_info == end_rev_info:
2057
# One revision given - file must exist in it
2058
tree = b.repository.revision_tree(end_rev_info.rev_id)
2060
file_id = tree.path2id(fp)
2061
kind = _get_kind_for_file_id(tree, file_id)
2062
info_list.append((fp, file_id, kind))
2065
# Revision range given. Get the file-id from the end tree.
2066
# If that fails, try the start tree.
2067
rev_id = end_rev_info.rev_id
2069
tree = b.basis_tree()
2071
tree = b.repository.revision_tree(rev_id)
2074
file_id = tree.path2id(fp)
2075
kind = _get_kind_for_file_id(tree, file_id)
2078
rev_id = start_rev_info.rev_id
2080
rev1 = b.get_rev_id(1)
2081
tree1 = b.repository.revision_tree(rev1)
2083
tree1 = b.repository.revision_tree(rev_id)
2084
file_id = tree1.path2id(fp)
2085
kind = _get_kind_for_file_id(tree1, file_id)
2086
info_list.append((fp, file_id, kind))
2087
return b, info_list, start_rev_info, end_rev_info
2090
def _get_kind_for_file_id(tree, file_id):
2091
"""Return the kind of a file-id or None if it doesn't exist."""
2092
if file_id is not None:
2093
return tree.kind(file_id)
2098
1005
properties_handler_registry = registry.Registry()
2100
# Use the properties handlers to print out bug information if available
2101
def _bugs_properties_handler(revision):
2102
if revision.properties.has_key('bugs'):
2103
bug_lines = revision.properties['bugs'].split('\n')
2104
bug_rows = [line.split(' ', 1) for line in bug_lines]
2105
fixed_bug_urls = [row[0] for row in bug_rows if
2106
len(row) > 1 and row[1] == 'fixed']
2109
return {'fixes bug(s)': ' '.join(fixed_bug_urls)}
2112
properties_handler_registry.register('bugs_properties_handler',
2113
_bugs_properties_handler)
2116
1007
# adapters which revision ids to log are filtered. When log is called, the
2117
1008
# log_rev_iterator is adapted through each of these factory methods.
2118
1009
# Plugins are welcome to mutate this list in any way they like - as long
added
removed
bzrlib/log.py
