144
155
start_revision=None,
145
156
end_revision=None,
148
160
"""Write out human-readable log of commits to this branch.
151
LogFormatter object to show the output.
154
If true, list only the commits affecting the specified
155
file, rather than all commits.
158
If true show added/changed/deleted/renamed files.
161
'reverse' (default) is latest to earliest;
162
'forward' is earliest to latest.
165
If not None, only show revisions >= start_revision
168
If not None, only show revisions <= end_revision
171
If not None, only show revisions with matching commit messages
174
If not None or 0, only show limit revisions
178
if getattr(lf, 'begin_log', None):
181
_show_log(branch, lf, specific_fileid, verbose, direction,
182
start_revision, end_revision, search, limit)
184
if getattr(lf, 'end_log', None):
190
def _show_log(branch,
192
specific_fileid=None,
199
"""Worker function for show_log - see show_log."""
200
if not isinstance(lf, LogFormatter):
201
warn("not a LogFormatter instance: %r" % lf)
204
trace.mutter('get log for file_id %r', specific_fileid)
205
generate_merge_revisions = getattr(lf, 'supports_merge_revisions', False)
206
allow_single_merge_revision = getattr(lf,
207
'supports_single_merge_revision', False)
208
view_revisions = calculate_view_revisions(branch, start_revision,
209
end_revision, direction,
211
generate_merge_revisions,
212
allow_single_merge_revision)
214
generate_tags = getattr(lf, 'supports_tags', False)
216
if branch.supports_tags():
217
rev_tag_dict = branch.tags.get_reverse_tag_dict()
219
generate_delta = verbose and getattr(lf, 'supports_delta', False)
221
# now we just print all the revisions
223
revision_iterator = make_log_rev_iterator(branch, view_revisions,
224
generate_delta, search)
225
for revs in revision_iterator:
226
for (rev_id, revno, merge_depth), rev, delta in revs:
227
lr = LogRevision(rev, revno, merge_depth, delta,
228
rev_tag_dict.get(rev_id))
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():
229
360
lf.log_revision(lr)
232
if log_count >= limit:
236
def calculate_view_revisions(branch, start_revision, end_revision, direction,
237
specific_fileid, generate_merge_revisions,
238
allow_single_merge_revision):
239
if (not generate_merge_revisions and start_revision is end_revision is
240
None and direction == 'reverse' and specific_fileid is None):
241
return _linear_view_revisions(branch)
243
mainline_revs, rev_nos, start_rev_id, end_rev_id = \
244
_get_mainline_revs(branch, start_revision, end_revision)
245
if not mainline_revs:
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(self.branch, self.start_rev_id,
459
self.end_rev_id, rqst.get('direction'), generate_merge_revisions,
460
delayed_graph_generation=delayed_graph_generation)
462
# Apply the other filters
463
return make_log_rev_iterator(self.branch, view_revisions,
464
rqst.get('delta_type'), rqst.get('message_search'),
465
file_ids=rqst.get('specific_fileids'),
466
direction=rqst.get('direction'))
468
def _log_revision_iterator_using_per_file_graph(self):
469
# Get the base revisions, filtering by the revision range.
470
# Note that we always generate the merge revisions because
471
# filter_revisions_touching_file_id() requires them ...
473
view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
474
self.end_rev_id, rqst.get('direction'), True)
475
if not isinstance(view_revisions, list):
476
view_revisions = list(view_revisions)
477
view_revisions = _filter_revisions_touching_file_id(self.branch,
478
rqst.get('specific_fileids')[0], view_revisions,
479
include_merges=rqst.get('levels') != 1)
480
return make_log_rev_iterator(self.branch, view_revisions,
481
rqst.get('delta_type'), rqst.get('message_search'))
484
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
485
generate_merge_revisions, delayed_graph_generation=False):
486
"""Calculate the revisions to view.
488
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
489
a list of the same tuples.
491
br_revno, br_rev_id = branch.last_revision_info()
495
# If a single revision is requested, check we can handle it
496
generate_single_revision = (end_rev_id and start_rev_id == end_rev_id and
497
(not generate_merge_revisions or not _has_merges(branch, end_rev_id)))
498
if generate_single_revision:
499
return _generate_one_revision(branch, end_rev_id, br_rev_id, br_revno)
501
# If we only want to see linear revisions, we can iterate ...
502
if not generate_merge_revisions:
503
return _generate_flat_revisions(branch, start_rev_id, end_rev_id,
506
return _generate_all_revisions(branch, start_rev_id, end_rev_id,
507
direction, delayed_graph_generation)
510
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
511
if rev_id == br_rev_id:
513
return [(br_rev_id, br_revno, 0)]
515
revno = branch.revision_id_to_dotted_revno(rev_id)
516
revno_str = '.'.join(str(n) for n in revno)
517
return [(rev_id, revno_str, 0)]
520
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction):
521
result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
522
# If a start limit was given and it's not obviously an
523
# ancestor of the end limit, check it before outputting anything
524
if direction == 'forward' or (start_rev_id
525
and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
527
result = list(result)
528
except _StartNotLinearAncestor:
529
raise errors.BzrCommandError('Start revision not found in'
530
' left-hand history of end revision.')
531
if direction == 'forward':
532
result = reversed(result)
536
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
537
delayed_graph_generation):
538
# On large trees, generating the merge graph can take 30-60 seconds
539
# so we delay doing it until a merge is detected, incrementally
540
# returning initial (non-merge) revisions while we can.
542
# The above is only true for old formats (<= 0.92), for newer formats, a
543
# couple of seconds only should be needed to load the whole graph and the
544
# other graph operations needed are even faster than that -- vila 100201
545
initial_revisions = []
546
if delayed_graph_generation:
548
for rev_id, revno, depth in _linear_view_revisions(
549
branch, start_rev_id, end_rev_id):
550
if _has_merges(branch, rev_id):
551
# The end_rev_id can be nested down somewhere. We need an
552
# explicit ancestry check. There is an ambiguity here as we
553
# may not raise _StartNotLinearAncestor for a revision that
554
# is an ancestor but not a *linear* one. But since we have
555
# loaded the graph to do the check (or calculate a dotted
556
# revno), we may as well accept to show the log... We need
557
# the check only if start_rev_id is not None as all
558
# revisions have _mod_revision.NULL_REVISION as an ancestor
560
graph = branch.repository.get_graph()
561
if (start_rev_id is not None
562
and not graph.is_ancestor(start_rev_id, end_rev_id)):
563
raise _StartNotLinearAncestor()
564
# Since we collected the revisions so far, we need to
569
initial_revisions.append((rev_id, revno, depth))
571
# No merged revisions found
572
if direction == 'reverse':
573
return initial_revisions
574
elif direction == 'forward':
575
return reversed(initial_revisions)
577
raise ValueError('invalid direction %r' % direction)
578
except _StartNotLinearAncestor:
579
# A merge was never detected so the lower revision limit can't
580
# be nested down somewhere
581
raise errors.BzrCommandError('Start revision not found in'
582
' history of end revision.')
584
# We exit the loop above because we encounter a revision with merges, from
585
# this revision, we need to switch to _graph_view_revisions.
587
# A log including nested merges is required. If the direction is reverse,
588
# we rebase the initial merge depths so that the development line is
589
# shown naturally, i.e. just like it is for linear logging. We can easily
590
# make forward the exact opposite display, but showing the merge revisions
591
# indented at the end seems slightly nicer in that case.
592
view_revisions = chain(iter(initial_revisions),
593
_graph_view_revisions(branch, start_rev_id, end_rev_id,
594
rebase_initial_depths=(direction == 'reverse')))
248
595
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]
596
return view_revisions
597
elif direction == 'forward':
598
# Forward means oldest first, adjusting for depth.
599
view_revisions = reverse_by_depth(list(view_revisions))
600
return _rebase_merge_depth(view_revisions)
602
raise ValueError('invalid direction %r' % direction)
605
def _has_merges(branch, rev_id):
606
"""Does a revision have multiple parents or not?"""
607
parents = branch.repository.get_parent_map([rev_id]).get(rev_id, [])
608
return len(parents) > 1
611
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
612
"""Is start_rev_id an obvious ancestor of end_rev_id?"""
613
if start_rev_id and end_rev_id:
614
start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
615
end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
616
if len(start_dotted) == 1 and len(end_dotted) == 1:
618
return start_dotted[0] <= end_dotted[0]
619
elif (len(start_dotted) == 3 and len(end_dotted) == 3 and
620
start_dotted[0:1] == end_dotted[0:1]):
621
# both on same development line
622
return start_dotted[2] <= end_dotted[2]
626
# if either start or end is not specified then we use either the first or
627
# the last revision and *they* are obvious ancestors.
631
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
632
"""Calculate a sequence of revisions to view, newest to oldest.
634
:param start_rev_id: the lower revision-id
635
:param end_rev_id: the upper revision-id
636
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
637
:raises _StartNotLinearAncestor: if a start_rev_id is specified but
638
is not found walking the left-hand history
640
br_revno, br_rev_id = branch.last_revision_info()
641
repo = branch.repository
642
if start_rev_id is None and end_rev_id is None:
644
for revision_id in repo.iter_reverse_revision_history(br_rev_id):
645
yield revision_id, str(cur_revno), 0
648
if end_rev_id is None:
649
end_rev_id = br_rev_id
650
found_start = start_rev_id is None
651
for revision_id in repo.iter_reverse_revision_history(end_rev_id):
652
revno = branch.revision_id_to_dotted_revno(revision_id)
653
revno_str = '.'.join(str(n) for n in revno)
654
if not found_start and revision_id == start_rev_id:
655
yield revision_id, revno_str, 0
659
yield revision_id, revno_str, 0
662
raise _StartNotLinearAncestor()
665
def _graph_view_revisions(branch, start_rev_id, end_rev_id,
666
rebase_initial_depths=True):
667
"""Calculate revisions to view including merges, newest to oldest.
669
:param branch: the branch
670
:param start_rev_id: the lower revision-id
671
:param end_rev_id: the upper revision-id
672
:param rebase_initial_depth: should depths be rebased until a mainline
674
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
676
view_revisions = branch.iter_merge_sorted_revisions(
677
start_revision_id=end_rev_id, stop_revision_id=start_rev_id,
678
stop_rule="with-merges")
679
if not rebase_initial_depths:
680
for (rev_id, merge_depth, revno, end_of_merge
682
yield rev_id, '.'.join(map(str, revno)), merge_depth
684
# We're following a development line starting at a merged revision.
685
# We need to adjust depths down by the initial depth until we find
686
# a depth less than it. Then we use that depth as the adjustment.
687
# If and when we reach the mainline, depth adjustment ends.
688
depth_adjustment = None
689
for (rev_id, merge_depth, revno, end_of_merge
691
if depth_adjustment is None:
692
depth_adjustment = merge_depth
694
if merge_depth < depth_adjustment:
695
# From now on we reduce the depth adjustement, this can be
696
# surprising for users. The alternative requires two passes
697
# which breaks the fast display of the first revision
699
depth_adjustment = merge_depth
700
merge_depth -= depth_adjustment
701
yield rev_id, '.'.join(map(str, revno)), merge_depth
704
@deprecated_function(deprecated_in((2, 2, 0)))
705
def calculate_view_revisions(branch, start_revision, end_revision, direction,
706
specific_fileid, generate_merge_revisions):
707
"""Calculate the revisions to view.
709
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
710
a list of the same tuples.
712
start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
714
view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
715
direction, generate_merge_revisions or specific_fileid))
268
716
if specific_fileid:
269
717
view_revisions = _filter_revisions_touching_file_id(branch,
274
# rebase merge_depth - unless there are no revisions or
275
# either the first or last revision have merge_depth = 0.
718
specific_fileid, view_revisions,
719
include_merges=generate_merge_revisions)
720
return _rebase_merge_depth(view_revisions)
723
def _rebase_merge_depth(view_revisions):
724
"""Adjust depths upwards so the top level is 0."""
725
# If either the first or last revision have a merge_depth of 0, we're done
276
726
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
277
727
min_depth = min([d for r,n,d in view_revisions])
278
728
if min_depth != 0:
754
1394
def short_author(self, rev):
755
name, address = config.parse_username(rev.get_apparent_author())
1395
name, address = config.parse_username(rev.get_apparent_authors()[0])
1400
def merge_marker(self, revision):
1401
"""Get the merge marker to include in the output or '' if none."""
1402
if len(revision.rev.parent_ids) > 1:
1403
self._merge_count += 1
760
1408
def show_properties(self, revision, indent):
761
1409
"""Displays the custom properties returned by each registered handler.
763
If a registered handler raises an error it is propagated.
1411
If a registered handler raises an error it is propagated.
1413
for line in self.custom_properties(revision):
1414
self.to_file.write("%s%s\n" % (indent, line))
1416
def custom_properties(self, revision):
1417
"""Format the custom properties returned by each registered handler.
1419
If a registered handler raises an error it is propagated.
1421
:return: a list of formatted lines (excluding trailing newlines)
1423
lines = self._foreign_info_properties(revision)
765
1424
for key, handler in properties_handler_registry.iteritems():
766
for key, value in handler(revision).items():
767
self.to_file.write(indent + key + ': ' + value + '\n')
1425
lines.extend(self._format_properties(handler(revision)))
1428
def _foreign_info_properties(self, rev):
1429
"""Custom log displayer for foreign revision identifiers.
1431
:param rev: Revision object.
1433
# Revision comes directly from a foreign repository
1434
if isinstance(rev, foreign.ForeignRevision):
1435
return self._format_properties(
1436
rev.mapping.vcs.show_foreign_revid(rev.foreign_revid))
1438
# Imported foreign revision revision ids always contain :
1439
if not ":" in rev.revision_id:
1442
# Revision was once imported from a foreign repository
1444
foreign_revid, mapping = \
1445
foreign.foreign_vcs_registry.parse_revision_id(rev.revision_id)
1446
except errors.InvalidRevisionId:
1449
return self._format_properties(
1450
mapping.vcs.show_foreign_revid(foreign_revid))
1452
def _format_properties(self, properties):
1454
for key, value in properties.items():
1455
lines.append(key + ': ' + value)
1458
def show_diff(self, to_file, diff, indent):
1459
for l in diff.rstrip().split('\n'):
1460
to_file.write(indent + '%s\n' % (l,))
1463
# Separator between revisions in long format
1464
_LONG_SEP = '-' * 60
770
1467
class LongLogFormatter(LogFormatter):
772
1469
supports_merge_revisions = True
1470
preferred_levels = 1
773
1471
supports_delta = True
774
1472
supports_tags = True
1473
supports_diff = True
1475
def __init__(self, *args, **kwargs):
1476
super(LongLogFormatter, self).__init__(*args, **kwargs)
1477
if self.show_timezone == 'original':
1478
self.date_string = self._date_string_original_timezone
1480
self.date_string = self._date_string_with_timezone
1482
def _date_string_with_timezone(self, rev):
1483
return format_date(rev.timestamp, rev.timezone or 0,
1486
def _date_string_original_timezone(self, rev):
1487
return format_date_with_offset_in_original_timezone(rev.timestamp,
776
1490
def log_revision(self, revision):
777
1491
"""Log a revision, either merged or not."""
778
1492
indent = ' ' * revision.merge_depth
779
to_file = self.to_file
780
to_file.write(indent + '-' * 60 + '\n')
781
1494
if revision.revno is not None:
782
to_file.write(indent + 'revno: %s\n' % (revision.revno,))
1495
lines.append('revno: %s%s' % (revision.revno,
1496
self.merge_marker(revision)))
783
1497
if revision.tags:
784
to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
1498
lines.append('tags: %s' % (', '.join(revision.tags)))
785
1499
if self.show_ids:
786
to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
1500
lines.append('revision-id: %s' % (revision.rev.revision_id,))
788
1501
for parent_id in revision.rev.parent_ids:
789
to_file.write(indent + 'parent: %s\n' % (parent_id,))
790
self.show_properties(revision.rev, indent)
1502
lines.append('parent: %s' % (parent_id,))
1503
lines.extend(self.custom_properties(revision.rev))
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,))
1505
committer = revision.rev.committer
1506
authors = revision.rev.get_apparent_authors()
1507
if authors != [committer]:
1508
lines.append('author: %s' % (", ".join(authors),))
1509
lines.append('committer: %s' % (committer,))
797
1511
branch_nick = revision.rev.properties.get('branch-nick', None)
798
1512
if branch_nick is not None:
799
to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
801
date_str = format_date(revision.rev.timestamp,
802
revision.rev.timezone or 0,
804
to_file.write(indent + 'timestamp: %s\n' % (date_str,))
806
to_file.write(indent + 'message:\n')
1513
lines.append('branch nick: %s' % (branch_nick,))
1515
lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1517
lines.append('message:')
807
1518
if not revision.rev.message:
808
to_file.write(indent + ' (no message)\n')
1519
lines.append(' (no message)')
810
1521
message = revision.rev.message.rstrip('\r\n')
811
1522
for l in message.split('\n'):
812
to_file.write(indent + ' %s\n' % (l,))
1523
lines.append(' %s' % (l,))
1525
# Dump the output, appending the delta and diff if requested
1526
to_file = self.to_file
1527
to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
813
1528
if revision.delta is not None:
814
revision.delta.show(to_file, self.show_ids, indent=indent)
1529
# Use the standard status output to display changes
1530
from bzrlib.delta import report_delta
1531
report_delta(to_file, revision.delta, short_status=False,
1532
show_ids=self.show_ids, indent=indent)
1533
if revision.diff is not None:
1534
to_file.write(indent + 'diff:\n')
1536
# Note: we explicitly don't indent the diff (relative to the
1537
# revision information) so that the output can be fed to patch -p0
1538
self.show_diff(self.to_exact_file, revision.diff, indent)
1539
self.to_exact_file.flush()
1541
def get_advice_separator(self):
1542
"""Get the text separating the log from the closing advice."""
1543
return '-' * 60 + '\n'
817
1546
class ShortLogFormatter(LogFormatter):
1548
supports_merge_revisions = True
1549
preferred_levels = 1
819
1550
supports_delta = True
820
supports_single_merge_revision = True
1551
supports_tags = True
1552
supports_diff = True
1554
def __init__(self, *args, **kwargs):
1555
super(ShortLogFormatter, self).__init__(*args, **kwargs)
1556
self.revno_width_by_depth = {}
822
1558
def log_revision(self, revision):
1559
# We need two indents: one per depth and one for the information
1560
# relative to that indent. Most mainline revnos are 5 chars or
1561
# less while dotted revnos are typically 11 chars or less. Once
1562
# calculated, we need to remember the offset for a given depth
1563
# as we might be starting from a dotted revno in the first column
1564
# and we want subsequent mainline revisions to line up.
1565
depth = revision.merge_depth
1566
indent = ' ' * depth
1567
revno_width = self.revno_width_by_depth.get(depth)
1568
if revno_width is None:
1569
if revision.revno.find('.') == -1:
1570
# mainline revno, e.g. 12345
1573
# dotted revno, e.g. 12345.10.55
1575
self.revno_width_by_depth[depth] = revno_width
1576
offset = ' ' * (revno_width + 1)
823
1578
to_file = self.to_file
825
if len(revision.rev.parent_ids) > 1:
826
is_merge = ' [merge]'
827
to_file.write("%5s %s\t%s%s\n" % (revision.revno,
828
self.short_author(revision.rev),
1581
tags = ' {%s}' % (', '.join(revision.tags))
1582
to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1583
revision.revno, self.short_author(revision.rev),
829
1584
format_date(revision.rev.timestamp,
830
1585
revision.rev.timezone or 0,
831
1586
self.show_timezone, date_fmt="%Y-%m-%d",
832
1587
show_offset=False),
1588
tags, self.merge_marker(revision)))
1589
self.show_properties(revision.rev, indent+offset)
834
1590
if self.show_ids:
835
to_file.write(' revision-id:%s\n' % (revision.rev.revision_id,))
1591
to_file.write(indent + offset + 'revision-id:%s\n'
1592
% (revision.rev.revision_id,))
836
1593
if not revision.rev.message:
837
to_file.write(' (no message)\n')
1594
to_file.write(indent + offset + '(no message)\n')
839
1596
message = revision.rev.message.rstrip('\r\n')
840
1597
for l in message.split('\n'):
841
to_file.write(' %s\n' % (l,))
1598
to_file.write(indent + offset + '%s\n' % (l,))
843
# TODO: Why not show the modified files in a shorter form as
844
# well? rewrap them single lines of appropriate length
845
1600
if revision.delta is not None:
846
revision.delta.show(to_file, self.show_ids)
1601
# Use the standard status output to display changes
1602
from bzrlib.delta import report_delta
1603
report_delta(to_file, revision.delta,
1604
short_status=self.delta_format==1,
1605
show_ids=self.show_ids, indent=indent + offset)
1606
if revision.diff is not None:
1607
self.show_diff(self.to_exact_file, revision.diff, ' ')
847
1608
to_file.write('\n')
850
1611
class LineLogFormatter(LogFormatter):
852
supports_single_merge_revision = True
1613
supports_merge_revisions = True
1614
preferred_levels = 1
1615
supports_tags = True
854
1617
def __init__(self, *args, **kwargs):
855
1618
super(LineLogFormatter, self).__init__(*args, **kwargs)
856
self._max_chars = terminal_width() - 1
1619
width = terminal_width()
1620
if width is not None:
1621
# we need one extra space for terminals that wrap on last char
1623
self._max_chars = width
858
1625
def truncate(self, str, max_len):
859
if len(str) <= max_len:
1626
if max_len is None or len(str) <= max_len:
861
return str[:max_len-3]+'...'
1628
return str[:max_len-3] + '...'
863
1630
def date_string(self, rev):
864
return format_date(rev.timestamp, rev.timezone or 0,
1631
return format_date(rev.timestamp, rev.timezone or 0,
865
1632
self.show_timezone, date_fmt="%Y-%m-%d",
866
1633
show_offset=False)
1818
def get_history_change(old_revision_id, new_revision_id, repository):
1819
"""Calculate the uncommon lefthand history between two revisions.
1821
:param old_revision_id: The original revision id.
1822
:param new_revision_id: The new revision id.
1823
:param repository: The repository to use for the calculation.
1825
return old_history, new_history
1828
old_revisions = set()
1830
new_revisions = set()
1831
new_iter = repository.iter_reverse_revision_history(new_revision_id)
1832
old_iter = repository.iter_reverse_revision_history(old_revision_id)
1833
stop_revision = None
1836
while do_new or do_old:
1839
new_revision = new_iter.next()
1840
except StopIteration:
1843
new_history.append(new_revision)
1844
new_revisions.add(new_revision)
1845
if new_revision in old_revisions:
1846
stop_revision = new_revision
1850
old_revision = old_iter.next()
1851
except StopIteration:
1854
old_history.append(old_revision)
1855
old_revisions.add(old_revision)
1856
if old_revision in new_revisions:
1857
stop_revision = old_revision
1859
new_history.reverse()
1860
old_history.reverse()
1861
if stop_revision is not None:
1862
new_history = new_history[new_history.index(stop_revision) + 1:]
1863
old_history = old_history[old_history.index(stop_revision) + 1:]
1864
return old_history, new_history
1867
def show_branch_change(branch, output, old_revno, old_revision_id):
1868
"""Show the changes made to a branch.
1870
:param branch: The branch to show changes about.
1871
:param output: A file-like object to write changes to.
1872
:param old_revno: The revno of the old tip.
1873
:param old_revision_id: The revision_id of the old tip.
1875
new_revno, new_revision_id = branch.last_revision_info()
1876
old_history, new_history = get_history_change(old_revision_id,
1879
if old_history == [] and new_history == []:
1880
output.write('Nothing seems to have changed\n')
1883
log_format = log_formatter_registry.get_default(branch)
1884
lf = log_format(show_ids=False, to_file=output, show_timezone='original')
1885
if old_history != []:
1886
output.write('*'*60)
1887
output.write('\nRemoved Revisions:\n')
1888
show_flat_log(branch.repository, old_history, old_revno, lf)
1889
output.write('*'*60)
1890
output.write('\n\n')
1891
if new_history != []:
1892
output.write('Added Revisions:\n')
1893
start_revno = new_revno - len(new_history) + 1
1894
show_log(branch, lf, None, verbose=False, direction='forward',
1895
start_revision=start_revno,)
1898
def show_flat_log(repository, history, last_revno, lf):
1899
"""Show a simple log of the specified history.
1901
:param repository: The repository to retrieve revisions from.
1902
:param history: A list of revision_ids indicating the lefthand history.
1903
:param last_revno: The revno of the last revision_id in the history.
1904
:param lf: The log formatter to use.
1906
start_revno = last_revno - len(history) + 1
1907
revisions = repository.get_revisions(history)
1908
for i, rev in enumerate(revisions):
1909
lr = LogRevision(rev, i + last_revno, 0, None)
1913
def _get_info_for_log_files(revisionspec_list, file_list):
1914
"""Find file-ids and kinds given a list of files and a revision range.
1916
We search for files at the end of the range. If not found there,
1917
we try the start of the range.
1919
:param revisionspec_list: revision range as parsed on the command line
1920
:param file_list: the list of paths given on the command line;
1921
the first of these can be a branch location or a file path,
1922
the remainder must be file paths
1923
:return: (branch, info_list, start_rev_info, end_rev_info) where
1924
info_list is a list of (relative_path, file_id, kind) tuples where
1925
kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
1926
branch will be read-locked.
1928
from builtins import _get_revision_range, safe_relpath_files
1929
tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
1931
# XXX: It's damn messy converting a list of paths to relative paths when
1932
# those paths might be deleted ones, they might be on a case-insensitive
1933
# filesystem and/or they might be in silly locations (like another branch).
1934
# For example, what should "log bzr://branch/dir/file1 file2" do? (Is
1935
# file2 implicitly in the same dir as file1 or should its directory be
1936
# taken from the current tree somehow?) For now, this solves the common
1937
# case of running log in a nested directory, assuming paths beyond the
1938
# first one haven't been deleted ...
1940
relpaths = [path] + safe_relpath_files(tree, file_list[1:])
1942
relpaths = [path] + file_list[1:]
1944
start_rev_info, end_rev_info = _get_revision_range(revisionspec_list, b,
1946
if relpaths in ([], [u'']):
1947
return b, [], start_rev_info, end_rev_info
1948
if start_rev_info is None and end_rev_info is None:
1950
tree = b.basis_tree()
1953
file_id = tree.path2id(fp)
1954
kind = _get_kind_for_file_id(tree, file_id)
1956
# go back to when time began
1959
rev1 = b.get_rev_id(1)
1960
except errors.NoSuchRevision:
1965
tree1 = b.repository.revision_tree(rev1)
1967
file_id = tree1.path2id(fp)
1968
kind = _get_kind_for_file_id(tree1, file_id)
1969
info_list.append((fp, file_id, kind))
1971
elif start_rev_info == end_rev_info:
1972
# One revision given - file must exist in it
1973
tree = b.repository.revision_tree(end_rev_info.rev_id)
1975
file_id = tree.path2id(fp)
1976
kind = _get_kind_for_file_id(tree, file_id)
1977
info_list.append((fp, file_id, kind))
1980
# Revision range given. Get the file-id from the end tree.
1981
# If that fails, try the start tree.
1982
rev_id = end_rev_info.rev_id
1984
tree = b.basis_tree()
1986
tree = b.repository.revision_tree(rev_id)
1989
file_id = tree.path2id(fp)
1990
kind = _get_kind_for_file_id(tree, file_id)
1993
rev_id = start_rev_info.rev_id
1995
rev1 = b.get_rev_id(1)
1996
tree1 = b.repository.revision_tree(rev1)
1998
tree1 = b.repository.revision_tree(rev_id)
1999
file_id = tree1.path2id(fp)
2000
kind = _get_kind_for_file_id(tree1, file_id)
2001
info_list.append((fp, file_id, kind))
2002
return b, info_list, start_rev_info, end_rev_info
2005
def _get_kind_for_file_id(tree, file_id):
2006
"""Return the kind of a file-id or None if it doesn't exist."""
2007
if file_id is not None:
2008
return tree.kind(file_id)
1005
2013
properties_handler_registry = registry.Registry()
2015
# Use the properties handlers to print out bug information if available
2016
def _bugs_properties_handler(revision):
2017
if revision.properties.has_key('bugs'):
2018
bug_lines = revision.properties['bugs'].split('\n')
2019
bug_rows = [line.split(' ', 1) for line in bug_lines]
2020
fixed_bug_urls = [row[0] for row in bug_rows if
2021
len(row) > 1 and row[1] == 'fixed']
2024
return {'fixes bug(s)': ' '.join(fixed_bug_urls)}
2027
properties_handler_registry.register('bugs_properties_handler',
2028
_bugs_properties_handler)
1007
2031
# adapters which revision ids to log are filtered. When log is called, the
1008
2032
# log_rev_iterator is adapted through each of these factory methods.
1009
2033
# Plugins are welcome to mutate this list in any way they like - as long
added
removed
bzrlib/log.py
