23
23
from subprocess import call
31
from bzrlib.errors import BzrError, BadCommitMessageEncoding
32
from bzrlib.hooks import HookPoint, Hooks
27
import bzrlib.config as config
28
from bzrlib.errors import BzrError
29
from bzrlib.trace import warning, mutter
36
33
"""Return a sequence of possible editor binaries for the current platform"""
38
yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
35
yield os.environ["BZR_EDITOR"]
42
39
e = config.GlobalConfig().get_editor()
44
yield e, config.config_filename()
46
43
for varname in 'VISUAL', 'EDITOR':
47
44
if varname in os.environ:
48
yield os.environ[varname], '$' + varname
45
yield os.environ[varname]
50
47
if sys.platform == 'win32':
51
48
for editor in 'wordpad.exe', 'notepad.exe':
54
51
for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
58
55
def _run_editor(filename):
59
56
"""Try to execute an editor to edit the commit message."""
60
for candidate, candidate_source in _get_editor():
61
edargs = candidate.split(' ')
57
for e in _get_editor():
63
60
## mutter("trying editor: %r", (edargs +[filename]))
64
61
x = call(edargs + [filename])
66
if candidate_source is not None:
67
# We tried this editor because some user configuration (an
68
# environment variable or config file) said to try it. Let
69
# the user know their configuration is broken.
71
'Could not start editor "%s" (specified by %s): %s\n'
72
% (candidate, candidate_source, str(e)))
63
# We're searching for an editor, so catch safe errors and continue
64
if e.errno in (errno.ENOENT, ):
95
87
This is run if they don't give a message or
96
88
message-containing file on the command line.
98
:param infotext: Text to be displayed at bottom of message
99
for the user's reference;
100
currently similar to 'bzr status'.
102
:param ignoreline: The separator to use above the infotext.
104
:param start_message: The text to place above the separator, if any.
105
This will not be removed from the message
106
after the user has edited it.
108
:return: commit message or None.
111
if not start_message is None:
112
start_message = start_message.encode(osutils.get_user_encoding())
113
infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
114
return edit_commit_message_encoded(infotext, ignoreline, start_message)
117
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
119
"""Let the user edit a commit message in a temp file.
121
This is run if they don't give a message or
122
message-containing file on the command line.
124
:param infotext: Text to be displayed at bottom of message
125
for the user's reference;
126
currently similar to 'bzr status'.
127
The string is already encoded
129
:param ignoreline: The separator to use above the infotext.
131
:param start_message: The text to place above the separator, if any.
132
This will not be removed from the message
133
after the user has edited it.
134
The string is already encoded
136
:return: commit message or None.
91
Text to be displayed at bottom of message for
92
the user's reference; currently similar to
96
The separator to use above the infotext.
99
The text to place above the separator, if any. This will not be
100
removed from the message after the user has edited it.
138
104
msgfilename = None
140
msgfilename, hasinfo = _create_temp_file_with_commit_template(
141
infotext, ignoreline, start_message)
143
if not msgfilename or not _run_editor(msgfilename):
106
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
107
msgfile = os.fdopen(tmp_fileno, 'w')
109
if start_message is not None:
110
msgfile.write("%s\n" % start_message.encode(
111
bzrlib.user_encoding, 'replace'))
113
if infotext is not None and infotext != "":
115
msgfile.write("\n\n%s\n\n%s" % (ignoreline,
116
infotext.encode(bzrlib.user_encoding,
123
if not _run_editor(msgfilename):
148
128
lastline, nlines = 0, 0
149
# codecs.open() ALWAYS opens file in binary mode but we need text mode
150
# 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
151
f = file(msgfilename, 'rU')
154
for line in codecs.getreader(osutils.get_user_encoding())(f):
155
stripped_line = line.strip()
156
# strip empty line before the log message starts
158
if stripped_line != "":
162
# check for the ignore line only if there
163
# is additional information at the end
164
if hasinfo and stripped_line == ignoreline:
167
# keep track of the last line that had some content
168
if stripped_line != "":
171
except UnicodeDecodeError:
172
raise BadCommitMessageEncoding()
129
for line in codecs.open(msgfilename, 'r', bzrlib.user_encoding):
130
stripped_line = line.strip()
131
# strip empty line before the log message starts
133
if stripped_line != "":
137
# check for the ignore line only if there
138
# is additional information at the end
139
if hasinfo and stripped_line == ignoreline:
142
# keep track of the last line that had some content
143
if stripped_line != "":
176
147
if len(msg) == 0:
178
149
# delete empty lines at the end
189
160
os.unlink(msgfilename)
190
161
except IOError, e:
192
"failed to unlink %s: %s; ignored", msgfilename, e)
195
def _create_temp_file_with_commit_template(infotext,
196
ignoreline=DEFAULT_IGNORE_LINE,
198
"""Create temp file and write commit template in it.
200
:param infotext: Text to be displayed at bottom of message
201
for the user's reference;
202
currently similar to 'bzr status'.
203
The text is already encoded.
205
:param ignoreline: The separator to use above the infotext.
207
:param start_message: The text to place above the separator, if any.
208
This will not be removed from the message
209
after the user has edited it.
210
The string is already encoded
212
:return: 2-tuple (temp file name, hasinfo)
215
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
218
msgfilename = osutils.basename(msgfilename)
219
msgfile = os.fdopen(tmp_fileno, 'w')
221
if start_message is not None:
222
msgfile.write("%s\n" % start_message)
224
if infotext is not None and infotext != "":
226
msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
232
return (msgfilename, hasinfo)
162
warning("failed to unlink %s: %s; ignored", msgfilename, e)
235
165
def make_commit_message_template(working_tree, specific_files):
245
177
from StringIO import StringIO # must be unicode-safe
246
178
from bzrlib.status import show_tree_status
247
179
status_tmp = StringIO()
248
show_tree_status(working_tree, specific_files=specific_files,
249
to_file=status_tmp, verbose=True)
180
show_tree_status(working_tree, specific_files=specific_files,
250
182
return status_tmp.getvalue()
253
def make_commit_message_template_encoded(working_tree, specific_files,
254
diff=None, output_encoding='utf-8'):
255
"""Prepare a template file for a commit into a branch.
257
Returns an encoded string.
259
# TODO: make provision for this to be overridden or modified by a hook
261
# TODO: Rather than running the status command, should prepare a draft of
262
# the revision to be committed, then pause and ask the user to
263
# confirm/write a message.
264
from StringIO import StringIO # must be unicode-safe
265
from bzrlib.diff import show_diff_trees
267
template = make_commit_message_template(working_tree, specific_files)
268
template = template.encode(output_encoding, "replace")
272
show_diff_trees(working_tree.basis_tree(),
273
working_tree, stream, specific_files,
274
path_encoding=output_encoding)
275
template = template + '\n' + stream.getvalue()
280
class MessageEditorHooks(Hooks):
281
"""A dictionary mapping hook name to a list of callables for message editor
284
e.g. ['commit_message_template'] is the list of items to be called to
285
generate a commit message template
289
"""Create the default hooks.
291
These are all empty initially.
294
self.create_hook(HookPoint('commit_message_template',
295
"Called when a commit message is being generated. "
296
"commit_message_template is called with the bzrlib.commit.Commit "
297
"object and the message that is known so far. "
298
"commit_message_template must return a new message to use (which "
299
"could be the same as it was given. When there are multiple "
300
"hooks registered for commit_message_template, they are chained "
301
"with the result from the first passed into the second, and so "
302
"on.", (1, 10), None))
305
hooks = MessageEditorHooks()
308
def generate_commit_message_template(commit, start_message=None):
309
"""Generate a commit message template.
311
:param commit: Commit object for the active commit.
312
:param start_message: Message to start with.
313
:return: A start commit message or None for an empty start commit message.
316
for hook in hooks['commit_message_template']:
317
start_message = hook(commit, start_message)
added
removed
bzrlib/msgeditor.py
