1
# Copyright (C) 2005, 2006 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
31
from bzrlib.errors import BzrError, BadCommitMessageEncoding
32
from bzrlib.hooks import HookPoint, Hooks
36
"""Return a sequence of possible editor binaries for the current platform"""
38
yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
42
e = config.GlobalConfig().get_editor()
44
yield e, config.config_filename()
46
for varname in 'VISUAL', 'EDITOR':
47
if varname in os.environ:
48
yield os.environ[varname], '$' + varname
50
if sys.platform == 'win32':
51
for editor in 'wordpad.exe', 'notepad.exe':
54
for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
58
def _run_editor(filename):
59
"""Try to execute an editor to edit the commit message."""
60
for candidate, candidate_source in _get_editor():
61
edargs = candidate.split(' ')
63
## mutter("trying editor: %r", (edargs +[filename]))
64
x = call(edargs + [filename])
66
# We're searching for an editor, so catch safe errors and continue
67
if e.errno in (errno.ENOENT, errno.EACCES):
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)
145
if not msgfilename or not _run_editor(msgfilename):
150
lastline, nlines = 0, 0
151
# codecs.open() ALWAYS opens file in binary mode but we need text mode
152
# 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
153
f = file(msgfilename, 'rU')
156
for line in codecs.getreader(osutils.get_user_encoding())(f):
157
stripped_line = line.strip()
158
# strip empty line before the log message starts
160
if stripped_line != "":
164
# check for the ignore line only if there
165
# is additional information at the end
166
if hasinfo and stripped_line == ignoreline:
169
# keep track of the last line that had some content
170
if stripped_line != "":
173
except UnicodeDecodeError:
174
raise BadCommitMessageEncoding()
180
# delete empty lines at the end
182
# add a newline at the end, if needed
183
if not msg[-1].endswith("\n"):
184
return "%s%s" % ("".join(msg), "\n")
188
# delete the msg file in any case
189
if msgfilename is not None:
191
os.unlink(msgfilename)
194
"failed to unlink %s: %s; ignored", msgfilename, e)
197
def _create_temp_file_with_commit_template(infotext,
198
ignoreline=DEFAULT_IGNORE_LINE,
200
"""Create temp file and write commit template in it.
202
:param infotext: Text to be displayed at bottom of message
203
for the user's reference;
204
currently similar to 'bzr status'.
205
The text is already encoded.
207
:param ignoreline: The separator to use above the infotext.
209
:param start_message: The text to place above the separator, if any.
210
This will not be removed from the message
211
after the user has edited it.
212
The string is already encoded
214
:return: 2-tuple (temp file name, hasinfo)
217
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
220
msgfilename = osutils.basename(msgfilename)
221
msgfile = os.fdopen(tmp_fileno, 'w')
223
if start_message is not None:
224
msgfile.write("%s\n" % start_message)
226
if infotext is not None and infotext != "":
228
msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
234
return (msgfilename, hasinfo)
237
def make_commit_message_template(working_tree, specific_files):
238
"""Prepare a template file for a commit into a branch.
240
Returns a unicode string containing the template.
242
# TODO: make provision for this to be overridden or modified by a hook
244
# TODO: Rather than running the status command, should prepare a draft of
245
# the revision to be committed, then pause and ask the user to
246
# confirm/write a message.
247
from StringIO import StringIO # must be unicode-safe
248
from bzrlib.status import show_tree_status
249
status_tmp = StringIO()
250
show_tree_status(working_tree, specific_files=specific_files,
251
to_file=status_tmp, verbose=True)
252
return status_tmp.getvalue()
255
def make_commit_message_template_encoded(working_tree, specific_files,
256
diff=None, output_encoding='utf-8'):
257
"""Prepare a template file for a commit into a branch.
259
Returns an encoded string.
261
# TODO: make provision for this to be overridden or modified by a hook
263
# TODO: Rather than running the status command, should prepare a draft of
264
# the revision to be committed, then pause and ask the user to
265
# confirm/write a message.
266
from StringIO import StringIO # must be unicode-safe
267
from bzrlib.diff import show_diff_trees
269
template = make_commit_message_template(working_tree, specific_files)
270
template = template.encode(output_encoding, "replace")
274
show_diff_trees(working_tree.basis_tree(),
275
working_tree, stream, specific_files,
276
path_encoding=output_encoding)
277
template = template + '\n' + stream.getvalue()
282
class MessageEditorHooks(Hooks):
283
"""A dictionary mapping hook name to a list of callables for message editor
286
e.g. ['commit_message_template'] is the list of items to be called to
287
generate a commit message template
291
"""Create the default hooks.
293
These are all empty initially.
296
self.create_hook(HookPoint('commit_message_template',
297
"Called when a commit message is being generated. "
298
"commit_message_template is called with the bzrlib.commit.Commit "
299
"object and the message that is known so far. "
300
"commit_message_template must return a new message to use (which "
301
"could be the same as it was given. When there are multiple "
302
"hooks registered for commit_message_template, they are chained "
303
"with the result from the first passed into the second, and so "
304
"on.", (1, 10), None))
307
hooks = MessageEditorHooks()
310
def generate_commit_message_template(commit, start_message=None):
311
"""Generate a commit message template.
313
:param commit: Commit object for the active commit.
314
:param start_message: Message to start with.
315
:return: A start commit message or None for an empty start commit message.
318
for hook in hooks['commit_message_template']:
319
start_message = hook(commit, start_message)
added
removed
bzrlib/msgeditor.py
