1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Commit message editor support."""
23
from subprocess import call
33
from bzrlib.errors import BzrError, BadCommitMessageEncoding
34
from bzrlib.hooks import HookPoint, Hooks
38
"""Return a sequence of possible editor binaries for the current platform"""
40
yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
44
e = config.GlobalConfig().get_editor()
46
yield e, config.config_filename()
48
for varname in 'VISUAL', 'EDITOR':
49
if varname in os.environ:
50
yield os.environ[varname], '$' + varname
52
if sys.platform == 'win32':
53
for editor in 'wordpad.exe', 'notepad.exe':
56
for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
60
def _run_editor(filename):
61
"""Try to execute an editor to edit the commit message."""
62
for candidate, candidate_source in _get_editor():
63
edargs = candidate.split(' ')
65
## mutter("trying editor: %r", (edargs +[filename]))
66
x = call(edargs + [filename])
68
if candidate_source is not None:
69
# We tried this editor because some user configuration (an
70
# environment variable or config file) said to try it. Let
71
# the user know their configuration is broken.
73
'Could not start editor "%s" (specified by %s): %s\n'
74
% (candidate, candidate_source, str(e)))
83
raise BzrError("Could not start any editor.\nPlease specify one with:\n"
84
" - $BZR_EDITOR\n - editor=/some/path in %s\n"
85
" - $VISUAL\n - $EDITOR" % \
86
config.config_filename())
89
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
90
{ 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
93
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
95
"""Let the user edit a commit message in a temp file.
97
This is run if they don't give a message or
98
message-containing file on the command line.
100
:param infotext: Text to be displayed at bottom of message
101
for the user's reference;
102
currently similar to 'bzr status'.
104
:param ignoreline: The separator to use above the infotext.
106
:param start_message: The text to place above the separator, if any.
107
This will not be removed from the message
108
after the user has edited it.
110
:return: commit message or None.
113
if not start_message is None:
114
start_message = start_message.encode(osutils.get_user_encoding())
115
infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
116
return edit_commit_message_encoded(infotext, ignoreline, start_message)
119
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
121
"""Let the user edit a commit message in a temp file.
123
This is run if they don't give a message or
124
message-containing file on the command line.
126
:param infotext: Text to be displayed at bottom of message
127
for the user's reference;
128
currently similar to 'bzr status'.
129
The string is already encoded
131
:param ignoreline: The separator to use above the infotext.
133
:param start_message: The text to place above the separator, if any.
134
This will not be removed from the message
135
after the user has edited it.
136
The string is already encoded
138
:return: commit message or None.
142
msgfilename, hasinfo = _create_temp_file_with_commit_template(
143
infotext, ignoreline, start_message)
146
basename = osutils.basename(msgfilename)
147
msg_transport = transport.get_transport(osutils.dirname(msgfilename))
148
reference_content = msg_transport.get_bytes(basename)
149
if not _run_editor(msgfilename):
151
edited_content = msg_transport.get_bytes(basename)
152
if edited_content == reference_content:
153
if not ui.ui_factory.get_boolean(
154
"Commit message was not edited, use anyway"):
155
# Returning "" makes cmd_commit raise 'empty commit message
156
# specified' which is a reasonable error, given the user has
157
# rejected using the unedited template.
161
lastline, nlines = 0, 0
162
# codecs.open() ALWAYS opens file in binary mode but we need text mode
163
# 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
164
f = file(msgfilename, 'rU')
167
for line in codecs.getreader(osutils.get_user_encoding())(f):
168
stripped_line = line.strip()
169
# strip empty line before the log message starts
171
if stripped_line != "":
175
# check for the ignore line only if there
176
# is additional information at the end
177
if hasinfo and stripped_line == ignoreline:
180
# keep track of the last line that had some content
181
if stripped_line != "":
184
except UnicodeDecodeError:
185
raise BadCommitMessageEncoding()
191
# delete empty lines at the end
193
# add a newline at the end, if needed
194
if not msg[-1].endswith("\n"):
195
return "%s%s" % ("".join(msg), "\n")
199
# delete the msg file in any case
200
if msgfilename is not None:
202
os.unlink(msgfilename)
205
"failed to unlink %s: %s; ignored", msgfilename, e)
208
def _create_temp_file_with_commit_template(infotext,
209
ignoreline=DEFAULT_IGNORE_LINE,
211
"""Create temp file and write commit template in it.
213
:param infotext: Text to be displayed at bottom of message
214
for the user's reference;
215
currently similar to 'bzr status'.
216
The text is already encoded.
218
:param ignoreline: The separator to use above the infotext.
220
:param start_message: The text to place above the separator, if any.
221
This will not be removed from the message
222
after the user has edited it.
223
The string is already encoded
225
:return: 2-tuple (temp file name, hasinfo)
228
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
231
msgfilename = osutils.basename(msgfilename)
232
msgfile = os.fdopen(tmp_fileno, 'w')
234
if start_message is not None:
235
msgfile.write("%s\n" % start_message)
237
if infotext is not None and infotext != "":
239
msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
245
return (msgfilename, hasinfo)
248
def make_commit_message_template(working_tree, specific_files):
249
"""Prepare a template file for a commit into a branch.
251
Returns a unicode string containing the template.
253
# TODO: make provision for this to be overridden or modified by a hook
255
# TODO: Rather than running the status command, should prepare a draft of
256
# the revision to be committed, then pause and ask the user to
257
# confirm/write a message.
258
from StringIO import StringIO # must be unicode-safe
259
from bzrlib.status import show_tree_status
260
status_tmp = StringIO()
261
show_tree_status(working_tree, specific_files=specific_files,
262
to_file=status_tmp, verbose=True)
263
return status_tmp.getvalue()
266
def make_commit_message_template_encoded(working_tree, specific_files,
267
diff=None, output_encoding='utf-8'):
268
"""Prepare a template file for a commit into a branch.
270
Returns an encoded string.
272
# TODO: make provision for this to be overridden or modified by a hook
274
# TODO: Rather than running the status command, should prepare a draft of
275
# the revision to be committed, then pause and ask the user to
276
# confirm/write a message.
277
from StringIO import StringIO # must be unicode-safe
278
from bzrlib.diff import show_diff_trees
280
template = make_commit_message_template(working_tree, specific_files)
281
template = template.encode(output_encoding, "replace")
285
show_diff_trees(working_tree.basis_tree(),
286
working_tree, stream, specific_files,
287
path_encoding=output_encoding)
288
template = template + '\n' + stream.getvalue()
293
class MessageEditorHooks(Hooks):
294
"""A dictionary mapping hook name to a list of callables for message editor
297
e.g. ['commit_message_template'] is the list of items to be called to
298
generate a commit message template
302
"""Create the default hooks.
304
These are all empty initially.
307
self.create_hook(HookPoint('commit_message_template',
308
"Called when a commit message is being generated. "
309
"commit_message_template is called with the bzrlib.commit.Commit "
310
"object and the message that is known so far. "
311
"commit_message_template must return a new message to use (which "
312
"could be the same as it was given. When there are multiple "
313
"hooks registered for commit_message_template, they are chained "
314
"with the result from the first passed into the second, and so "
315
"on.", (1, 10), None))
318
hooks = MessageEditorHooks()
321
def generate_commit_message_template(commit, start_message=None):
322
"""Generate a commit message template.
324
:param commit: Commit object for the active commit.
325
:param start_message: Message to start with.
326
:return: A start commit message or None for an empty start commit message.
329
for hook in hooks['commit_message_template']:
330
start_message = hook(commit, start_message)
added
removed
bzrlib/msgeditor.py
