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 .errors import BzrError
35
from .hooks import Hooks
41
class BadCommitMessageEncoding(BzrError):
43
_fmt = 'The specified commit message contains characters unsupported by '\
44
'the current encoding.'
48
"""Return a sequence of possible editor binaries for the current platform"""
50
yield os.environ["BRZ_EDITOR"], '$BRZ_EDITOR'
54
e = config.GlobalStack().get('editor')
56
yield e, config.config_filename()
58
for varname in 'VISUAL', 'EDITOR':
59
if varname in os.environ:
60
yield os.environ[varname], '$' + varname
62
if sys.platform == 'win32':
63
for editor in 'wordpad.exe', 'notepad.exe':
66
for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
70
def _run_editor(filename):
71
"""Try to execute an editor to edit the commit message."""
72
for candidate, candidate_source in _get_editor():
73
edargs = cmdline.split(candidate)
75
## mutter("trying editor: %r", (edargs +[filename]))
76
x = call(edargs + [filename])
78
if candidate_source is not None:
79
# We tried this editor because some user configuration (an
80
# environment variable or config file) said to try it. Let
81
# the user know their configuration is broken.
83
'Could not start editor "%s" (specified by %s): %s\n'
84
% (candidate, candidate_source, str(e)))
93
raise BzrError("Could not start any editor.\nPlease specify one with:\n"
94
" - $BRZ_EDITOR\n - editor=/some/path in %s\n"
95
" - $VISUAL\n - $EDITOR" % \
96
config.config_filename())
99
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
100
{ 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
103
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
105
"""Let the user edit a commit message in a temp file.
107
This is run if they don't give a message or
108
message-containing file on the command line.
110
:param infotext: Text to be displayed at bottom of message
111
for the user's reference;
112
currently similar to 'bzr status'.
114
:param ignoreline: The separator to use above the infotext.
116
:param start_message: The text to place above the separator, if any.
117
This will not be removed from the message
118
after the user has edited it.
120
:return: commit message or None.
123
if not start_message is None:
124
start_message = start_message.encode(osutils.get_user_encoding())
125
infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
126
return edit_commit_message_encoded(infotext, ignoreline, start_message)
129
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
131
"""Let the user edit a commit message in a temp file.
133
This is run if they don't give a message or
134
message-containing file on the command line.
136
:param infotext: Text to be displayed at bottom of message
137
for the user's reference;
138
currently similar to 'bzr status'.
139
The string is already encoded
141
:param ignoreline: The separator to use above the infotext.
143
:param start_message: The text to place above the separator, if any.
144
This will not be removed from the message
145
after the user has edited it.
146
The string is already encoded
148
:return: commit message or None.
152
msgfilename, hasinfo = _create_temp_file_with_commit_template(
153
infotext, ignoreline, start_message)
156
basename = osutils.basename(msgfilename)
157
msg_transport = transport.get_transport_from_path(osutils.dirname(msgfilename))
158
reference_content = msg_transport.get_bytes(basename)
159
if not _run_editor(msgfilename):
161
edited_content = msg_transport.get_bytes(basename)
162
if edited_content == reference_content:
163
if not ui.ui_factory.confirm_action(
164
u"Commit message was not edited, use anyway",
165
"breezy.msgeditor.unchanged",
167
# Returning "" makes cmd_commit raise 'empty commit message
168
# specified' which is a reasonable error, given the user has
169
# rejected using the unedited template.
173
lastline, nlines = 0, 0
174
# codecs.open() ALWAYS opens file in binary mode but we need text mode
175
# 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
176
f = file(msgfilename, 'rU')
179
for line in codecs.getreader(osutils.get_user_encoding())(f):
180
stripped_line = line.strip()
181
# strip empty line before the log message starts
183
if stripped_line != "":
187
# check for the ignore line only if there
188
# is additional information at the end
189
if hasinfo and stripped_line == ignoreline:
192
# keep track of the last line that had some content
193
if stripped_line != "":
196
except UnicodeDecodeError:
197
raise BadCommitMessageEncoding()
203
# delete empty lines at the end
205
# add a newline at the end, if needed
206
if not msg[-1].endswith("\n"):
207
return "%s%s" % ("".join(msg), "\n")
211
# delete the msg file in any case
212
if msgfilename is not None:
214
os.unlink(msgfilename)
217
"failed to unlink %s: %s; ignored", msgfilename, e)
220
def _create_temp_file_with_commit_template(infotext,
221
ignoreline=DEFAULT_IGNORE_LINE,
224
"""Create temp file and write commit template in it.
226
:param infotext: Text to be displayed at bottom of message for the
227
user's reference; currently similar to 'bzr status'. The text is
230
:param ignoreline: The separator to use above the infotext.
232
:param start_message: The text to place above the separator, if any.
233
This will not be removed from the message after the user has edited
234
it. The string is already encoded
236
:return: 2-tuple (temp file name, hasinfo)
239
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
240
dir=tmpdir, text=True)
241
msgfile = os.fdopen(tmp_fileno, 'w')
243
if start_message is not None:
244
msgfile.write("%s\n" % start_message)
246
if infotext is not None and infotext != "":
248
msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
254
return (msgfilename, hasinfo)
257
def make_commit_message_template(working_tree, specific_files):
258
"""Prepare a template file for a commit into a branch.
260
Returns a unicode string containing the template.
262
# TODO: make provision for this to be overridden or modified by a hook
264
# TODO: Rather than running the status command, should prepare a draft of
265
# the revision to be committed, then pause and ask the user to
266
# confirm/write a message.
267
from .status import show_tree_status
268
status_tmp = StringIO()
269
show_tree_status(working_tree, specific_files=specific_files,
270
to_file=status_tmp, verbose=True)
271
return status_tmp.getvalue()
274
def make_commit_message_template_encoded(working_tree, specific_files,
275
diff=None, output_encoding='utf-8'):
276
"""Prepare a template file for a commit into a branch.
278
Returns an encoded string.
280
# TODO: make provision for this to be overridden or modified by a hook
282
# TODO: Rather than running the status command, should prepare a draft of
283
# the revision to be committed, then pause and ask the user to
284
# confirm/write a message.
285
from .diff import show_diff_trees
287
template = make_commit_message_template(working_tree, specific_files)
288
template = template.encode(output_encoding, "replace")
292
show_diff_trees(working_tree.basis_tree(),
293
working_tree, stream, specific_files,
294
path_encoding=output_encoding)
295
template = template + '\n' + stream.getvalue()
300
class MessageEditorHooks(Hooks):
301
"""A dictionary mapping hook name to a list of callables for message editor
304
e.g. ['commit_message_template'] is the list of items to be called to
305
generate a commit message template
309
"""Create the default hooks.
311
These are all empty initially.
313
Hooks.__init__(self, "breezy.msgeditor", "hooks")
314
self.add_hook('set_commit_message',
315
"Set a fixed commit message. "
316
"set_commit_message is called with the "
317
"breezy.commit.Commit object (so you can also change e.g. revision "
318
"properties by editing commit.builder._revprops) and the message "
319
"so far. set_commit_message must return the message to use or None"
320
" if it should use the message editor as normal.", (2, 4))
321
self.add_hook('commit_message_template',
322
"Called when a commit message is being generated. "
323
"commit_message_template is called with the breezy.commit.Commit "
324
"object and the message that is known so far. "
325
"commit_message_template must return a new message to use (which "
326
"could be the same as it was given). When there are multiple "
327
"hooks registered for commit_message_template, they are chained "
328
"with the result from the first passed into the second, and so "
332
hooks = MessageEditorHooks()
335
def set_commit_message(commit, start_message=None):
336
"""Sets the commit message.
337
:param commit: Commit object for the active commit.
338
:return: The commit message or None to continue using the message editor
341
for hook in hooks['set_commit_message']:
342
start_message = hook(commit, start_message)
346
def generate_commit_message_template(commit, start_message=None):
347
"""Generate a commit message template.
349
:param commit: Commit object for the active commit.
350
:param start_message: Message to start with.
351
:return: A start commit message or None for an empty start commit message.
354
for hook in hooks['commit_message_template']:
355
start_message = hook(commit, start_message)
added
removed
breezy/msgeditor.py
