1
# Copyright (C) 2005-2011 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
17
"""Commit message editor support."""
19
from __future__ import absolute_import
23
from subprocess import call
34
from bzrlib.errors import BzrError, BadCommitMessageEncoding
35
from bzrlib.hooks import Hooks
39
"""Return a sequence of possible editor binaries for the current platform"""
41
yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
45
e = config.GlobalStack().get('editor')
47
yield e, config.config_filename()
49
for varname in 'VISUAL', 'EDITOR':
50
if varname in os.environ:
51
yield os.environ[varname], '$' + varname
53
if sys.platform == 'win32':
54
for editor in 'wordpad.exe', 'notepad.exe':
57
for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
61
def _run_editor(filename):
62
"""Try to execute an editor to edit the commit message."""
63
for candidate, candidate_source in _get_editor():
64
edargs = cmdline.split(candidate)
66
## mutter("trying editor: %r", (edargs +[filename]))
67
x = call(edargs + [filename])
69
if candidate_source is not None:
70
# We tried this editor because some user configuration (an
71
# environment variable or config file) said to try it. Let
72
# the user know their configuration is broken.
74
'Could not start editor "%s" (specified by %s): %s\n'
75
% (candidate, candidate_source, str(e)))
84
raise BzrError("Could not start any editor.\nPlease specify one with:\n"
85
" - $BZR_EDITOR\n - editor=/some/path in %s\n"
86
" - $VISUAL\n - $EDITOR" % \
87
config.config_filename())
90
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
91
{ 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
94
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
96
"""Let the user edit a commit message in a temp file.
98
This is run if they don't give a message or
99
message-containing file on the command line.
101
:param infotext: Text to be displayed at bottom of message
102
for the user's reference;
103
currently similar to 'bzr status'.
105
:param ignoreline: The separator to use above the infotext.
107
:param start_message: The text to place above the separator, if any.
108
This will not be removed from the message
109
after the user has edited it.
111
:return: commit message or None.
114
if not start_message is None:
115
start_message = start_message.encode(osutils.get_user_encoding())
116
infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
117
return edit_commit_message_encoded(infotext, ignoreline, start_message)
120
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
122
"""Let the user edit a commit message in a temp file.
124
This is run if they don't give a message or
125
message-containing file on the command line.
127
:param infotext: Text to be displayed at bottom of message
128
for the user's reference;
129
currently similar to 'bzr status'.
130
The string is already encoded
132
:param ignoreline: The separator to use above the infotext.
134
:param start_message: The text to place above the separator, if any.
135
This will not be removed from the message
136
after the user has edited it.
137
The string is already encoded
139
:return: commit message or None.
143
msgfilename, hasinfo = _create_temp_file_with_commit_template(
144
infotext, ignoreline, start_message)
147
basename = osutils.basename(msgfilename)
148
msg_transport = transport.get_transport_from_path(osutils.dirname(msgfilename))
149
reference_content = msg_transport.get_bytes(basename)
150
if not _run_editor(msgfilename):
152
edited_content = msg_transport.get_bytes(basename)
153
if edited_content == reference_content:
154
if not ui.ui_factory.confirm_action(
155
u"Commit message was not edited, use anyway",
156
"bzrlib.msgeditor.unchanged",
158
# Returning "" makes cmd_commit raise 'empty commit message
159
# specified' which is a reasonable error, given the user has
160
# rejected using the unedited template.
164
lastline, nlines = 0, 0
165
# codecs.open() ALWAYS opens file in binary mode but we need text mode
166
# 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
167
f = file(msgfilename, 'rU')
170
for line in codecs.getreader(osutils.get_user_encoding())(f):
171
stripped_line = line.strip()
172
# strip empty line before the log message starts
174
if stripped_line != "":
178
# check for the ignore line only if there
179
# is additional information at the end
180
if hasinfo and stripped_line == ignoreline:
183
# keep track of the last line that had some content
184
if stripped_line != "":
187
except UnicodeDecodeError:
188
raise BadCommitMessageEncoding()
194
# delete empty lines at the end
196
# add a newline at the end, if needed
197
if not msg[-1].endswith("\n"):
198
return "%s%s" % ("".join(msg), "\n")
202
# delete the msg file in any case
203
if msgfilename is not None:
205
os.unlink(msgfilename)
208
"failed to unlink %s: %s; ignored", msgfilename, e)
211
def _create_temp_file_with_commit_template(infotext,
212
ignoreline=DEFAULT_IGNORE_LINE,
215
"""Create temp file and write commit template in it.
217
:param infotext: Text to be displayed at bottom of message for the
218
user's reference; currently similar to 'bzr status'. The text is
221
:param ignoreline: The separator to use above the infotext.
223
:param start_message: The text to place above the separator, if any.
224
This will not be removed from the message after the user has edited
225
it. The string is already encoded
227
:return: 2-tuple (temp file name, hasinfo)
230
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
231
dir=tmpdir, text=True)
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.
306
Hooks.__init__(self, "bzrlib.msgeditor", "hooks")
307
self.add_hook('set_commit_message',
308
"Set a fixed commit message. "
309
"set_commit_message is called with the "
310
"bzrlib.commit.Commit object (so you can also change e.g. revision "
311
"properties by editing commit.builder._revprops) and the message "
312
"so far. set_commit_message must return the message to use or None"
313
" if it should use the message editor as normal.", (2, 4))
314
self.add_hook('commit_message_template',
315
"Called when a commit message is being generated. "
316
"commit_message_template is called with the bzrlib.commit.Commit "
317
"object and the message that is known so far. "
318
"commit_message_template must return a new message to use (which "
319
"could be the same as it was given). When there are multiple "
320
"hooks registered for commit_message_template, they are chained "
321
"with the result from the first passed into the second, and so "
325
hooks = MessageEditorHooks()
328
def set_commit_message(commit, start_message=None):
329
"""Sets the commit message.
330
:param commit: Commit object for the active commit.
331
:return: The commit message or None to continue using the message editor
334
for hook in hooks['set_commit_message']:
335
start_message = hook(commit, start_message)
339
def generate_commit_message_template(commit, start_message=None):
340
"""Generate a commit message template.
342
:param commit: Commit object for the active commit.
343
:param start_message: Message to start with.
344
:return: A start commit message or None for an empty start commit message.
347
for hook in hooks['commit_message_template']:
348
start_message = hook(commit, start_message)
added
removed
bzrlib/msgeditor.py
