1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
33
from .lazy_import import lazy_import
34
lazy_import(globals(), """
47
extract_email_address,
49
from .repository import _strip_NULL_ghosts
50
from .revision import (
37
from bzrlib.config import extract_email_address
38
from bzrlib.repository import _strip_NULL_ghosts
39
from bzrlib.revision import CURRENT_REVISION, Revision
42
def annotate_file(branch, rev_id, file_id, verbose=False, full=False,
43
to_file=None, show_ids=False):
44
"""Annotate file_id at revision rev_id in branch.
46
The branch should already be read_locked() when annotate_file is called.
48
:param branch: The branch to look for revision numbers and history from.
49
:param rev_id: The revision id to annotate.
50
:param file_id: The file_id to annotate.
51
:param verbose: Show all details rather than truncating to ensure
52
reasonable text width.
53
:param full: XXXX Not sure what this does.
54
:param to_file: The file to output the annotation to; if None stdout is
56
:param show_ids: Show revision ids in the annotation output.
61
# Handle the show_ids case
62
annotations = _annotations(branch.repository, file_id, rev_id)
64
return _show_id_annotations(annotations, to_file, full)
66
# Calculate the lengths of the various columns
67
annotation = list(_expand_annotations(annotations, branch))
68
_print_annotations(annotation, verbose, to_file, full)
56
71
def annotate_file_tree(tree, file_id, to_file, verbose=False, full=False,
57
show_ids=False, branch=None):
58
73
"""Annotate file_id in a tree.
60
75
The tree should already be read_locked() when annotate_file_tree is called.
66
81
reasonable text width.
67
82
:param full: XXXX Not sure what this does.
68
83
:param show_ids: Show revision ids in the annotation output.
69
:param branch: Branch to use for revision revno lookups
85
rev_id = tree.last_revision()
76
88
# Handle the show_ids case
77
89
annotations = list(tree.annotate_iter(file_id))
79
91
return _show_id_annotations(annotations, to_file, full)
81
if not getattr(tree, "get_revision_id", False):
82
# Create a virtual revision to represent the current tree state.
83
# Should get some more pending commit attributes, like pending tags,
85
current_rev = Revision(CURRENT_REVISION)
86
current_rev.parent_ids = tree.get_parent_ids()
88
current_rev.committer = branch.get_config_stack().get('email')
90
current_rev.committer = 'local user'
91
current_rev.message = "?"
92
current_rev.timestamp = round(time.time(), 3)
93
current_rev.timezone = osutils.local_time_offset()
96
annotation = list(_expand_annotations(annotations, branch,
93
# Create a virtual revision to represent the current tree state.
94
# Should get some more pending commit attributes, like pending tags,
96
current_rev = Revision(CURRENT_REVISION)
97
current_rev.parent_ids = tree.get_parent_ids()
98
current_rev.committer = tree.branch.get_config().username()
99
current_rev.message = "?"
100
current_rev.timestamp = round(time.time(), 3)
101
current_rev.timezone = osutils.local_time_offset()
102
annotation = list(_expand_annotations(annotations, tree.branch,
98
104
_print_annotations(annotation, verbose, to_file, full)
119
125
# Output the annotations
127
encoding = getattr(to_file, 'encoding', None) or \
128
osutils.get_terminal_encoding()
121
129
for (revno_str, author, date_str, line_rev_id, text) in annotation:
123
131
anno = '%-*s %-*s %8s ' % (max_revno_len, revno_str,
128
136
anno = "%-*s %-7s " % (max_revno_len, revno_str, author[:7])
129
137
if anno.lstrip() == "" and full:
131
# GZ 2017-05-21: Writing both unicode annotation and bytes from file
132
# which the given to_file must cope with.
141
except UnicodeEncodeError:
142
# cmd_annotate should be passing in an 'exact' object, which means
143
# we have a direct handle to sys.stdout or equivalent. It may not
144
# be able to handle the exact Unicode characters, but 'annotate' is
145
# a user function (non-scripting), so shouldn't die because of
146
# unrepresentable annotation characters. So encode using 'replace',
147
# and write them again.
148
to_file.write(anno.encode(encoding, 'replace'))
134
149
to_file.write('| %s\n' % (text,))
168
def _annotations(repo, file_id, rev_id):
169
"""Return the list of (origin_revision_id, line_text) for a revision of a file in a repository."""
170
annotations = repo.texts.annotate((file_id, rev_id))
172
return [(key[-1], line) for (key, line) in annotations]
153
175
def _expand_annotations(annotations, branch, current_rev=None):
154
176
"""Expand a file's annotations into command line UI ready tuples.
163
185
repository = branch.repository
164
186
if current_rev is not None:
165
# This can probably become a function on MutableTree, get_revno_map
166
# there, or something.
187
# This can probably become a function on MutableTree, get_revno_map there,
167
189
last_revision = current_rev.revision_id
168
190
# XXX: Partially Cloned from branch, uses the old_get_graph, eep.
169
191
# XXX: The main difficulty is that we need to inject a single new node
192
214
revision_id_to_revno[CURRENT_REVISION] = (
193
215
"%d?" % (branch.revno() + 1),)
194
216
revisions[CURRENT_REVISION] = current_rev
197
repository.iter_revisions(revision_ids)
198
if entry[1] is not None)
217
revision_ids = [o for o in revision_ids if
218
repository.has_revision(o)]
219
revisions.update((r.revision_id, r) for r in
220
repository.get_revisions(revision_ids))
199
221
for origin, text in annotations:
200
222
text = text.rstrip('\r\n')
201
223
if origin == last_origin:
210
232
rev = revisions[origin]
211
233
tz = rev.timezone or 0
212
234
date_str = time.strftime('%Y%m%d',
213
osutils.gmtime(rev.timestamp + tz))
235
time.gmtime(rev.timestamp + tz))
214
236
# a lazy way to get something like the email address
215
237
# TODO: Get real email address
216
238
author = rev.get_apparent_authors()[0]
218
240
author = extract_email_address(author)
219
except NoEmailInUsername:
241
except errors.NoEmailInUsername:
220
242
pass # use the whole name
221
243
yield (revno_str, author, date_str, origin, text)
292
314
def _get_matching_blocks(old, new):
293
matcher = patiencediff.PatienceSequenceMatcher(None, old, new)
315
matcher = patiencediff.PatienceSequenceMatcher(None,
294
317
return matcher.get_matching_blocks()
354
377
if child_idx > last_child_idx:
355
378
output_extend(child_lines[start_child + last_child_idx
356
379
:start_child + child_idx])
357
for offset in range(match_len):
380
for offset in xrange(match_len):
358
381
left = child_lines[start_child+child_idx+offset]
359
382
right = right_lines[start_right+right_idx+offset]
360
383
if left[0] == right[0]:
372
395
heads = heads_provider.heads((left[0], right[0]))
373
396
if len(heads) == 1:
374
output_append((next(iter(heads)), left[1]))
397
output_append((iter(heads).next(), left[1]))
376
399
# Both claim different origins, get a stable result.
377
400
# If the result is not stable, there is a risk a
437
from breezy._annotator_pyx import Annotator
438
except ImportError as e:
460
from bzrlib._annotator_pyx import Annotator
461
except ImportError, e:
439
462
osutils.failed_to_load_extension(e)
440
from breezy._annotator_py import Annotator
463
from bzrlib._annotator_py import Annotator