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."""
22
from subprocess import call
32
from bzrlib.errors import BzrError, BadCommitMessageEncoding
33
from bzrlib.hooks import HookPoint, Hooks
37
"""Return a sequence of possible editor binaries for the current platform"""
39
yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
43
e = config.GlobalConfig().get_editor()
45
yield e, config.config_filename()
47
for varname in 'VISUAL', 'EDITOR':
48
if varname in os.environ:
49
yield os.environ[varname], '$' + varname
51
if sys.platform == 'win32':
52
for editor in 'wordpad.exe', 'notepad.exe':
55
for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
59
def _run_editor(filename):
60
"""Try to execute an editor to edit the commit message."""
61
for candidate, candidate_source in _get_editor():
62
edargs = candidate.split(' ')
64
## mutter("trying editor: %r", (edargs +[filename]))
65
x = call(edargs + [filename])
67
if candidate_source is not None:
68
# We tried this editor because some user configuration (an
69
# environment variable or config file) said to try it. Let
70
# the user know their configuration is broken.
72
'Could not start editor "%s" (specified by %s): %s\n'
73
% (candidate, candidate_source, str(e)))
82
raise BzrError("Could not start any editor.\nPlease specify one with:\n"
83
" - $BZR_EDITOR\n - editor=/some/path in %s\n"
84
" - $VISUAL\n - $EDITOR" % \
85
config.config_filename())
88
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
89
{ 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
92
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
94
"""Let the user edit a commit message in a temp file.
96
This is run if they don't give a message or
97
message-containing file on the command line.
99
:param infotext: Text to be displayed at bottom of message
100
for the user's reference;
101
currently similar to 'bzr status'.
103
:param ignoreline: The separator to use above the infotext.
105
:param start_message: The text to place above the separator, if any.
106
This will not be removed from the message
107
after the user has edited it.
109
:return: commit message or None.
112
if not start_message is None:
113
start_message = start_message.encode(osutils.get_user_encoding())
114
infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
115
return edit_commit_message_encoded(infotext, ignoreline, start_message)
118
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
120
"""Let the user edit a commit message in a temp file.
122
This is run if they don't give a message or
123
message-containing file on the command line.
125
:param infotext: Text to be displayed at bottom of message
126
for the user's reference;
127
currently similar to 'bzr status'.
128
The string is already encoded
130
:param ignoreline: The separator to use above the infotext.
132
:param start_message: The text to place above the separator, if any.
133
This will not be removed from the message
134
after the user has edited it.
135
The string is already encoded
137
:return: commit message or None.
141
msgfilename, hasinfo = _create_temp_file_with_commit_template(
142
infotext, ignoreline, start_message)
145
basename = osutils.basename(msgfilename)
146
msg_transport = transport.get_transport(osutils.dirname(msgfilename))
147
reference_content = msg_transport.get_bytes(basename)
148
if not _run_editor(msgfilename):
150
edited_content = msg_transport.get_bytes(basename)
151
if edited_content == reference_content:
152
if not ui.ui_factory.confirm_action(
153
"Commit message was not edited, use anyway",
154
"bzrlib.msgeditor.unchanged",
156
# Returning "" makes cmd_commit raise 'empty commit message
157
# specified' which is a reasonable error, given the user has
158
# rejected using the unedited template.
162
lastline, nlines = 0, 0
163
# codecs.open() ALWAYS opens file in binary mode but we need text mode
164
# 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
165
f = file(msgfilename, 'rU')
168
for line in codecs.getreader(osutils.get_user_encoding())(f):
169
stripped_line = line.strip()
170
# strip empty line before the log message starts
172
if stripped_line != "":
176
# check for the ignore line only if there
177
# is additional information at the end
178
if hasinfo and stripped_line == ignoreline:
181
# keep track of the last line that had some content
182
if stripped_line != "":
185
except UnicodeDecodeError:
186
raise BadCommitMessageEncoding()
192
# delete empty lines at the end
194
# add a newline at the end, if needed
195
if not msg[-1].endswith("\n"):
196
return "%s%s" % ("".join(msg), "\n")
200
# delete the msg file in any case
201
if msgfilename is not None:
203
os.unlink(msgfilename)
206
"failed to unlink %s: %s; ignored", msgfilename, e)
209
def _create_temp_file_with_commit_template(infotext,
210
ignoreline=DEFAULT_IGNORE_LINE,
212
"""Create temp file and write commit template in it.
214
:param infotext: Text to be displayed at bottom of message
215
for the user's reference;
216
currently similar to 'bzr status'.
217
The text is already encoded.
219
:param ignoreline: The separator to use above the infotext.
221
:param start_message: The text to place above the separator, if any.
222
This will not be removed from the message
223
after the user has edited it.
224
The string is already encoded
226
:return: 2-tuple (temp file name, hasinfo)
229
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
232
msgfilename = osutils.basename(msgfilename)
233
msgfile = os.fdopen(tmp_fileno, 'w')
235
if start_message is not None:
236
msgfile.write("%s\n" % start_message)
238
if infotext is not None and infotext != "":
240
msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
246
return (msgfilename, hasinfo)
249
def make_commit_message_template(working_tree, specific_files):
250
"""Prepare a template file for a commit into a branch.
252
Returns a unicode string containing the template.
254
# TODO: make provision for this to be overridden or modified by a hook
256
# TODO: Rather than running the status command, should prepare a draft of
257
# the revision to be committed, then pause and ask the user to
258
# confirm/write a message.
259
from StringIO import StringIO # must be unicode-safe
260
from bzrlib.status import show_tree_status
261
status_tmp = StringIO()
262
show_tree_status(working_tree, specific_files=specific_files,
263
to_file=status_tmp, verbose=True)
264
return status_tmp.getvalue()
267
def make_commit_message_template_encoded(working_tree, specific_files,
268
diff=None, output_encoding='utf-8'):
269
"""Prepare a template file for a commit into a branch.
271
Returns an encoded string.
273
# TODO: make provision for this to be overridden or modified by a hook
275
# TODO: Rather than running the status command, should prepare a draft of
276
# the revision to be committed, then pause and ask the user to
277
# confirm/write a message.
278
from StringIO import StringIO # must be unicode-safe
279
from bzrlib.diff import show_diff_trees
281
template = make_commit_message_template(working_tree, specific_files)
282
template = template.encode(output_encoding, "replace")
286
show_diff_trees(working_tree.basis_tree(),
287
working_tree, stream, specific_files,
288
path_encoding=output_encoding)
289
template = template + '\n' + stream.getvalue()
294
class MessageEditorHooks(Hooks):
295
"""A dictionary mapping hook name to a list of callables for message editor
298
e.g. ['commit_message_template'] is the list of items to be called to
299
generate a commit message template
303
"""Create the default hooks.
305
These are all empty initially.
308
self.create_hook(HookPoint('commit_message_template',
309
"Called when a commit message is being generated. "
310
"commit_message_template is called with the bzrlib.commit.Commit "
311
"object and the message that is known so far. "
312
"commit_message_template must return a new message to use (which "
313
"could be the same as it was given. When there are multiple "
314
"hooks registered for commit_message_template, they are chained "
315
"with the result from the first passed into the second, and so "
316
"on.", (1, 10), None))
319
hooks = MessageEditorHooks()
322
def generate_commit_message_template(commit, start_message=None):
323
"""Generate a commit message template.
325
:param commit: Commit object for the active commit.
326
:param start_message: Message to start with.
327
:return: A start commit message or None for an empty start commit message.
330
for hook in hooks['commit_message_template']:
331
start_message = hook(commit, start_message)
added
removed
bzrlib/msgeditor.py
