187
175
: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():
179
if getattr(lf, 'begin_log', None):
182
_show_log(branch, lf, specific_fileid, verbose, direction,
183
start_revision, end_revision, search, limit, show_diff)
185
if getattr(lf, 'end_log', None):
191
def _show_log(branch,
193
specific_fileid=None,
201
"""Worker function for show_log - see show_log."""
202
if not isinstance(lf, LogFormatter):
203
warn("not a LogFormatter instance: %r" % lf)
205
trace.mutter('get log for file_id %r', specific_fileid)
207
# Consult the LogFormatter about what it needs and can handle
208
levels_to_display = lf.get_levels()
209
generate_merge_revisions = levels_to_display != 1
210
allow_single_merge_revision = True
211
if not getattr(lf, 'supports_merge_revisions', False):
212
allow_single_merge_revision = getattr(lf,
213
'supports_single_merge_revision', False)
214
generate_tags = getattr(lf, 'supports_tags', False)
215
if generate_tags and branch.supports_tags():
216
rev_tag_dict = branch.tags.get_reverse_tag_dict()
219
generate_delta = verbose and getattr(lf, 'supports_delta', False)
220
generate_diff = show_diff and getattr(lf, 'supports_diff', False)
222
# Find and print the interesting revisions
223
repo = branch.repository
225
revision_iterator = _create_log_revision_iterator(branch,
226
start_revision, end_revision, direction, specific_fileid, search,
227
generate_merge_revisions, allow_single_merge_revision,
228
generate_delta, limited_output=limit > 0)
229
for revs in revision_iterator:
230
for (rev_id, revno, merge_depth), rev, delta in revs:
231
# Note: 0 levels means show everything; merge_depth counts from 0
232
if levels_to_display != 0 and merge_depth >= levels_to_display:
235
diff = _format_diff(repo, rev, rev_id, specific_fileid)
238
lr = LogRevision(rev, revno, merge_depth, delta,
239
rev_tag_dict.get(rev_id), diff)
368
240
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)
243
if log_count >= limit:
247
def _format_diff(repo, rev, rev_id, specific_fileid):
248
if len(rev.parent_ids) == 0:
249
ancestor_id = _mod_revision.NULL_REVISION
251
ancestor_id = rev.parent_ids[0]
252
tree_1 = repo.revision_tree(ancestor_id)
253
tree_2 = repo.revision_tree(rev_id)
255
specific_files = [tree_2.id2path(specific_fileid)]
257
specific_files = None
259
diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
379
264
class _StartNotLinearAncestor(Exception):
380
265
"""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'))
268
def _create_log_revision_iterator(branch, start_revision, end_revision,
269
direction, specific_fileid, search, generate_merge_revisions,
270
allow_single_merge_revision, generate_delta, limited_output=False):
271
"""Create a revision iterator for log.
273
:param branch: The branch being logged.
274
:param start_revision: If not None, only show revisions >= start_revision
275
:param end_revision: If not None, only show revisions <= end_revision
276
:param direction: 'reverse' (default) is latest to earliest; 'forward' is
278
:param specific_fileid: If not None, list only the commits affecting the
280
:param search: If not None, only show revisions with matching commit
282
:param generate_merge_revisions: If False, show only mainline revisions.
283
:param allow_single_merge_revision: If True, logging of a single
284
revision off the mainline is to be allowed
285
:param generate_delta: Whether to generate a delta for each revision.
286
:param limited_output: if True, the user only wants a limited result
288
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
291
start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
294
# Decide how file-ids are matched: delta-filtering vs per-file graph.
295
# Delta filtering allows revisions to be displayed incrementally
296
# though the total time is much slower for huge repositories: log -v
297
# is the *lower* performance bound. At least until the split
298
# inventory format arrives, per-file-graph needs to remain the
299
# default except in verbose mode. Delta filtering should give more
300
# accurate results (e.g. inclusion of FILE deletions) so arguably
301
# it should always be used in the future.
302
use_deltas_for_matching = specific_fileid and generate_delta
303
delayed_graph_generation = not specific_fileid and (
304
start_rev_id or end_rev_id or limited_output)
305
generate_merges = generate_merge_revisions or (specific_fileid and
306
not use_deltas_for_matching)
307
view_revisions = _calc_view_revisions(branch, start_rev_id, end_rev_id,
308
direction, generate_merges, allow_single_merge_revision,
309
delayed_graph_generation=delayed_graph_generation)
310
search_deltas_for_fileids = None
311
if use_deltas_for_matching:
312
search_deltas_for_fileids = set([specific_fileid])
313
elif specific_fileid:
488
314
if not isinstance(view_revisions, list):
489
315
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'))
316
view_revisions = _filter_revisions_touching_file_id(branch,
317
specific_fileid, view_revisions,
318
include_merges=generate_merge_revisions)
319
return make_log_rev_iterator(branch, view_revisions, generate_delta,
320
search, file_ids=search_deltas_for_fileids, direction=direction)
497
323
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,
324
generate_merge_revisions, allow_single_merge_revision,
325
delayed_graph_generation=False):
502
326
"""Calculate the revisions to view.
504
328
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
505
329
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
331
br_revno, br_rev_id = branch.last_revision_info()
513
332
if br_revno == 0:
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):
335
# If a single revision is requested, check we can handle it
336
generate_single_revision = (end_rev_id and start_rev_id == end_rev_id and
337
(not generate_merge_revisions or not _has_merges(branch, end_rev_id)))
338
if generate_single_revision:
339
if end_rev_id == br_rev_id:
341
return [(br_rev_id, br_revno, 0)]
343
revno = branch.revision_id_to_dotted_revno(end_rev_id)
344
if len(revno) > 1 and not allow_single_merge_revision:
345
# It's a merge revision and the log formatter is
346
# completely brain dead. This "feature" of allowing
347
# log formatters incapable of displaying dotted revnos
348
# ought to be deprecated IMNSHO. IGC 20091022
349
raise errors.BzrCommandError('Selected log formatter only'
350
' supports mainline revisions.')
351
revno_str = '.'.join(str(n) for n in revno)
352
return [(end_rev_id, revno_str, 0)]
354
# If we only want to see linear revisions, we can iterate ...
355
if not generate_merge_revisions:
356
result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
357
# If a start limit was given and it's not obviously an
358
# ancestor of the end limit, check it before outputting anything
359
if direction == 'forward' or (start_rev_id
360
and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
362
result = list(result)
363
except _StartNotLinearAncestor:
364
raise errors.BzrCommandError('Start revision not found in'
365
' left-hand history of end revision.')
366
if direction == 'forward':
367
result = reversed(list(result))
564
370
# On large trees, generating the merge graph can take 30-60 seconds
565
371
# so we delay doing it until a merge is detected, incrementally
566
372
# 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
373
initial_revisions = []
572
374
if delayed_graph_generation:
574
for rev_id, revno, depth in _linear_view_revisions(
575
branch, start_rev_id, end_rev_id):
376
for rev_id, revno, depth in \
377
_linear_view_revisions(branch, start_rev_id, end_rev_id):
576
378
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
592
379
end_rev_id = rev_id
595
382
initial_revisions.append((rev_id, revno, depth))
597
384
# No merged revisions found
598
return initial_revisions
385
if direction == 'reverse':
386
return initial_revisions
387
elif direction == 'forward':
388
return reversed(initial_revisions)
390
raise ValueError('invalid direction %r' % direction)
599
391
except _StartNotLinearAncestor:
600
392
# A merge was never detected so the lower revision limit can't
601
393
# be nested down somewhere
602
394
raise errors.BzrCommandError('Start revision not found in'
603
395
' 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
397
# A log including nested merges is required. If the direction is reverse,
609
398
# we rebase the initial merge depths so that the development line is
610
399
# shown naturally, i.e. just like it is for linear logging. We can easily
1420
def merge_marker(self, revision):
1421
"""Get the merge marker to include in the output or '' if none."""
1422
if len(revision.rev.parent_ids) > 1:
1423
self._merge_count += 1
1428
1187
def show_properties(self, revision, indent):
1429
1188
"""Displays the custom properties returned by each registered handler.
1431
1190
If a registered handler raises an error it is propagated.
1433
for line in self.custom_properties(revision):
1434
self.to_file.write("%s%s\n" % (indent, line))
1436
def custom_properties(self, revision):
1437
"""Format the custom properties returned by each registered handler.
1439
If a registered handler raises an error it is propagated.
1441
:return: a list of formatted lines (excluding trailing newlines)
1443
lines = self._foreign_info_properties(revision)
1444
1192
for key, handler in properties_handler_registry.iteritems():
1445
lines.extend(self._format_properties(handler(revision)))
1448
def _foreign_info_properties(self, rev):
1449
"""Custom log displayer for foreign revision identifiers.
1451
:param rev: Revision object.
1453
# Revision comes directly from a foreign repository
1454
if isinstance(rev, foreign.ForeignRevision):
1455
return self._format_properties(
1456
rev.mapping.vcs.show_foreign_revid(rev.foreign_revid))
1458
# Imported foreign revision revision ids always contain :
1459
if not ":" in rev.revision_id:
1462
# Revision was once imported from a foreign repository
1464
foreign_revid, mapping = \
1465
foreign.foreign_vcs_registry.parse_revision_id(rev.revision_id)
1466
except errors.InvalidRevisionId:
1469
return self._format_properties(
1470
mapping.vcs.show_foreign_revid(foreign_revid))
1472
def _format_properties(self, properties):
1474
for key, value in properties.items():
1475
lines.append(key + ': ' + value)
1193
for key, value in handler(revision).items():
1194
self.to_file.write(indent + key + ': ' + value + '\n')
1478
1196
def show_diff(self, to_file, diff, indent):
1479
1197
for l in diff.rstrip().split('\n'):
1480
1198
to_file.write(indent + '%s\n' % (l,))
1483
# Separator between revisions in long format
1484
_LONG_SEP = '-' * 60
1487
1201
class LongLogFormatter(LogFormatter):
1489
1203
supports_merge_revisions = True
1490
preferred_levels = 1
1491
1204
supports_delta = True
1492
1205
supports_tags = True
1493
1206
supports_diff = True
1495
def __init__(self, *args, **kwargs):
1496
super(LongLogFormatter, self).__init__(*args, **kwargs)
1497
if self.show_timezone == 'original':
1498
self.date_string = self._date_string_original_timezone
1500
self.date_string = self._date_string_with_timezone
1502
def _date_string_with_timezone(self, rev):
1503
return format_date(rev.timestamp, rev.timezone or 0,
1506
def _date_string_original_timezone(self, rev):
1507
return format_date_with_offset_in_original_timezone(rev.timestamp,
1510
1208
def log_revision(self, revision):
1511
1209
"""Log a revision, either merged or not."""
1512
1210
indent = ' ' * revision.merge_depth
1211
to_file = self.to_file
1212
to_file.write(indent + '-' * 60 + '\n')
1514
1213
if revision.revno is not None:
1515
lines.append('revno: %s%s' % (revision.revno,
1516
self.merge_marker(revision)))
1214
to_file.write(indent + 'revno: %s\n' % (revision.revno,))
1517
1215
if revision.tags:
1518
lines.append('tags: %s' % (', '.join(revision.tags)))
1216
to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
1519
1217
if self.show_ids:
1520
lines.append('revision-id: %s' % (revision.rev.revision_id,))
1218
to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
1521
1220
for parent_id in revision.rev.parent_ids:
1522
lines.append('parent: %s' % (parent_id,))
1523
lines.extend(self.custom_properties(revision.rev))
1221
to_file.write(indent + 'parent: %s\n' % (parent_id,))
1222
self.show_properties(revision.rev, indent)
1525
1224
committer = revision.rev.committer
1526
1225
authors = revision.rev.get_apparent_authors()
1527
1226
if authors != [committer]:
1528
lines.append('author: %s' % (", ".join(authors),))
1529
lines.append('committer: %s' % (committer,))
1227
to_file.write(indent + 'author: %s\n' % (", ".join(authors),))
1228
to_file.write(indent + 'committer: %s\n' % (committer,))
1531
1230
branch_nick = revision.rev.properties.get('branch-nick', None)
1532
1231
if branch_nick is not None:
1533
lines.append('branch nick: %s' % (branch_nick,))
1535
lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1537
lines.append('message:')
1232
to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
1234
date_str = format_date(revision.rev.timestamp,
1235
revision.rev.timezone or 0,
1237
to_file.write(indent + 'timestamp: %s\n' % (date_str,))
1239
to_file.write(indent + 'message:\n')
1538
1240
if not revision.rev.message:
1539
lines.append(' (no message)')
1241
to_file.write(indent + ' (no message)\n')
1541
1243
message = revision.rev.message.rstrip('\r\n')
1542
1244
for l in message.split('\n'):
1543
lines.append(' %s' % (l,))
1545
# Dump the output, appending the delta and diff if requested
1546
to_file = self.to_file
1547
to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
1245
to_file.write(indent + ' %s\n' % (l,))
1548
1246
if revision.delta is not None:
1549
# Use the standard status output to display changes
1550
from bzrlib.delta import report_delta
1551
report_delta(to_file, revision.delta, short_status=False,
1552
show_ids=self.show_ids, indent=indent)
1247
# We don't respect delta_format for compatibility
1248
revision.delta.show(to_file, self.show_ids, indent=indent,
1553
1250
if revision.diff is not None:
1554
1251
to_file.write(indent + 'diff:\n')
1556
1252
# Note: we explicitly don't indent the diff (relative to the
1557
1253
# revision information) so that the output can be fed to patch -p0
1558
1254
self.show_diff(self.to_exact_file, revision.diff, indent)
1559
self.to_exact_file.flush()
1561
def get_advice_separator(self):
1562
"""Get the text separating the log from the closing advice."""
1563
return '-' * 60 + '\n'
1566
1257
class ShortLogFormatter(LogFormatter):
1930
1617
lf.log_revision(lr)
1933
def _get_info_for_log_files(revisionspec_list, file_list, add_cleanup):
1934
"""Find file-ids and kinds given a list of files and a revision range.
1936
We search for files at the end of the range. If not found there,
1937
we try the start of the range.
1939
:param revisionspec_list: revision range as parsed on the command line
1940
:param file_list: the list of paths given on the command line;
1941
the first of these can be a branch location or a file path,
1942
the remainder must be file paths
1943
:param add_cleanup: When the branch returned is read locked,
1944
an unlock call will be queued to the cleanup.
1945
:return: (branch, info_list, start_rev_info, end_rev_info) where
1946
info_list is a list of (relative_path, file_id, kind) tuples where
1947
kind is one of values 'directory', 'file', 'symlink', 'tree-reference'.
1948
branch will be read-locked.
1620
def _get_fileid_to_log(revision, tree, b, fp):
1621
"""Find the file-id to log for a file path in a revision range.
1623
:param revision: the revision range as parsed on the command line
1624
:param tree: the working tree, if any
1625
:param b: the branch
1626
:param fp: file path
1950
from builtins import _get_revision_range, safe_relpath_files
1951
tree, b, path = bzrdir.BzrDir.open_containing_tree_or_branch(file_list[0])
1952
add_cleanup(b.lock_read().unlock)
1953
# XXX: It's damn messy converting a list of paths to relative paths when
1954
# those paths might be deleted ones, they might be on a case-insensitive
1955
# filesystem and/or they might be in silly locations (like another branch).
1956
# For example, what should "log bzr://branch/dir/file1 file2" do? (Is
1957
# file2 implicitly in the same dir as file1 or should its directory be
1958
# taken from the current tree somehow?) For now, this solves the common
1959
# case of running log in a nested directory, assuming paths beyond the
1960
# first one haven't been deleted ...
1962
relpaths = [path] + safe_relpath_files(tree, file_list[1:])
1964
relpaths = [path] + file_list[1:]
1966
start_rev_info, end_rev_info = _get_revision_range(revisionspec_list, b,
1968
if relpaths in ([], [u'']):
1969
return b, [], start_rev_info, end_rev_info
1970
if start_rev_info is None and end_rev_info is None:
1628
if revision is None:
1971
1629
if tree is None:
1972
1630
tree = b.basis_tree()
1975
file_id = tree.path2id(fp)
1976
kind = _get_kind_for_file_id(tree, file_id)
1978
# go back to when time began
1981
rev1 = b.get_rev_id(1)
1982
except errors.NoSuchRevision:
1987
tree1 = b.repository.revision_tree(rev1)
1989
file_id = tree1.path2id(fp)
1990
kind = _get_kind_for_file_id(tree1, file_id)
1991
info_list.append((fp, file_id, kind))
1631
file_id = tree.path2id(fp)
1633
# go back to when time began
1635
rev1 = b.get_rev_id(1)
1636
except errors.NoSuchRevision:
1640
tree = b.repository.revision_tree(rev1)
1641
file_id = tree.path2id(fp)
1993
elif start_rev_info == end_rev_info:
1643
elif len(revision) == 1:
1994
1644
# One revision given - file must exist in it
1995
tree = b.repository.revision_tree(end_rev_info.rev_id)
1997
file_id = tree.path2id(fp)
1998
kind = _get_kind_for_file_id(tree, file_id)
1999
info_list.append((fp, file_id, kind))
1645
tree = revision[0].as_tree(b)
1646
file_id = tree.path2id(fp)
1648
elif len(revision) == 2:
2002
1649
# Revision range given. Get the file-id from the end tree.
2003
1650
# If that fails, try the start tree.
2004
rev_id = end_rev_info.rev_id
1651
rev_id = revision[1].as_revision_id(b)
2005
1652
if rev_id is None:
2006
1653
tree = b.basis_tree()
2008
tree = b.repository.revision_tree(rev_id)
1655
tree = revision[1].as_tree(b)
1656
file_id = tree.path2id(fp)
1658
rev_id = revision[0].as_revision_id(b)
1660
rev1 = b.get_rev_id(1)
1661
tree = b.repository.revision_tree(rev1)
1663
tree = revision[0].as_tree(b)
2011
1664
file_id = tree.path2id(fp)
2012
kind = _get_kind_for_file_id(tree, file_id)
2015
rev_id = start_rev_info.rev_id
2017
rev1 = b.get_rev_id(1)
2018
tree1 = b.repository.revision_tree(rev1)
2020
tree1 = b.repository.revision_tree(rev_id)
2021
file_id = tree1.path2id(fp)
2022
kind = _get_kind_for_file_id(tree1, file_id)
2023
info_list.append((fp, file_id, kind))
2024
return b, info_list, start_rev_info, end_rev_info
2027
def _get_kind_for_file_id(tree, file_id):
2028
"""Return the kind of a file-id or None if it doesn't exist."""
2029
if file_id is not None:
2030
return tree.kind(file_id)
1666
raise errors.BzrCommandError(
1667
'bzr log --revision takes one or two values.')
2035
1671
properties_handler_registry = registry.Registry()
2037
# Use the properties handlers to print out bug information if available
2038
def _bugs_properties_handler(revision):
2039
if revision.properties.has_key('bugs'):
2040
bug_lines = revision.properties['bugs'].split('\n')
2041
bug_rows = [line.split(' ', 1) for line in bug_lines]
2042
fixed_bug_urls = [row[0] for row in bug_rows if
2043
len(row) > 1 and row[1] == 'fixed']
2046
return {'fixes bug(s)': ' '.join(fixed_bug_urls)}
2049
properties_handler_registry.register('bugs_properties_handler',
2050
_bugs_properties_handler)
1672
properties_handler_registry.register_lazy("foreign",
1674
"show_foreign_properties")
2053
1677
# adapters which revision ids to log are filtered. When log is called, the
added
removed
bzrlib/log.py
