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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Commit message editor support."""
23
from subprocess import call
30
from bzrlib.errors import BzrError, BadCommitMessageEncoding
31
from bzrlib.trace import warning
35
"""Return a sequence of possible editor binaries for the current platform"""
37
yield os.environ["BZR_EDITOR"]
41
e = config.GlobalConfig().get_editor()
45
for varname in 'VISUAL', 'EDITOR':
46
if varname in os.environ:
47
yield os.environ[varname]
49
if sys.platform == 'win32':
50
for editor in 'wordpad.exe', 'notepad.exe':
53
for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
57
def _run_editor(filename):
58
"""Try to execute an editor to edit the commit message."""
59
for e in _get_editor():
62
## mutter("trying editor: %r", (edargs +[filename]))
63
x = call(edargs + [filename])
65
# We're searching for an editor, so catch safe errors and continue
66
if e.errno in (errno.ENOENT, ):
75
raise BzrError("Could not start any editor.\nPlease specify one with:\n"
76
" - $BZR_EDITOR\n - editor=/some/path in %s\n"
77
" - $VISUAL\n - $EDITOR" % \
78
config.config_filename())
81
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
82
{ 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
85
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
87
"""Let the user edit a commit message in a temp file.
89
This is run if they don't give a message or
90
message-containing file on the command line.
92
:param infotext: Text to be displayed at bottom of message
93
for the user's reference;
94
currently similar to 'bzr status'.
96
:param ignoreline: The separator to use above the infotext.
98
:param start_message: The text to place above the separator, if any.
99
This will not be removed from the message
100
after the user has edited it.
102
:return: commit message or None.
105
if not start_message is None:
106
start_message = start_message.encode(osutils.get_user_encoding())
107
infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
108
return edit_commit_message_encoded(infotext, ignoreline, start_message)
111
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
113
"""Let the user edit a commit message in a temp file.
115
This is run if they don't give a message or
116
message-containing file on the command line.
118
:param infotext: Text to be displayed at bottom of message
119
for the user's reference;
120
currently similar to 'bzr status'.
121
The string is already encoded
123
:param ignoreline: The separator to use above the infotext.
125
:param start_message: The text to place above the separator, if any.
126
This will not be removed from the message
127
after the user has edited it.
128
The string is already encoded
130
:return: commit message or None.
134
msgfilename, hasinfo = _create_temp_file_with_commit_template(
135
infotext, ignoreline, start_message)
137
if not msgfilename or not _run_editor(msgfilename):
142
lastline, nlines = 0, 0
143
# codecs.open() ALWAYS opens file in binary mode but we need text mode
144
# 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
145
f = file(msgfilename, 'rU')
148
for line in codecs.getreader(osutils.get_user_encoding())(f):
149
stripped_line = line.strip()
150
# strip empty line before the log message starts
152
if stripped_line != "":
156
# check for the ignore line only if there
157
# is additional information at the end
158
if hasinfo and stripped_line == ignoreline:
161
# keep track of the last line that had some content
162
if stripped_line != "":
165
except UnicodeDecodeError:
166
raise BadCommitMessageEncoding()
172
# delete empty lines at the end
174
# add a newline at the end, if needed
175
if not msg[-1].endswith("\n"):
176
return "%s%s" % ("".join(msg), "\n")
180
# delete the msg file in any case
181
if msgfilename is not None:
183
os.unlink(msgfilename)
185
warning("failed to unlink %s: %s; ignored", msgfilename, e)
188
def _create_temp_file_with_commit_template(infotext,
189
ignoreline=DEFAULT_IGNORE_LINE,
191
"""Create temp file and write commit template in it.
193
:param infotext: Text to be displayed at bottom of message
194
for the user's reference;
195
currently similar to 'bzr status'.
196
The text is already encoded.
198
:param ignoreline: The separator to use above the infotext.
200
:param start_message: The text to place above the separator, if any.
201
This will not be removed from the message
202
after the user has edited it.
203
The string is already encoded
205
:return: 2-tuple (temp file name, hasinfo)
208
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
211
msgfilename = osutils.basename(msgfilename)
212
msgfile = os.fdopen(tmp_fileno, 'w')
214
if start_message is not None:
215
msgfile.write("%s\n" % start_message)
217
if infotext is not None and infotext != "":
219
msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
225
return (msgfilename, hasinfo)
228
def make_commit_message_template(working_tree, specific_files):
229
"""Prepare a template file for a commit into a branch.
231
Returns a unicode string containing the template.
233
# TODO: make provision for this to be overridden or modified by a hook
235
# TODO: Rather than running the status command, should prepare a draft of
236
# the revision to be committed, then pause and ask the user to
237
# confirm/write a message.
238
from StringIO import StringIO # must be unicode-safe
239
from bzrlib.status import show_tree_status
240
status_tmp = StringIO()
241
show_tree_status(working_tree, specific_files=specific_files,
243
return status_tmp.getvalue()
246
def make_commit_message_template_encoded(working_tree, specific_files,
247
diff=None, output_encoding='utf-8'):
248
"""Prepare a template file for a commit into a branch.
250
Returns an encoded string.
252
# TODO: make provision for this to be overridden or modified by a hook
254
# TODO: Rather than running the status command, should prepare a draft of
255
# the revision to be committed, then pause and ask the user to
256
# confirm/write a message.
257
from StringIO import StringIO # must be unicode-safe
258
from bzrlib.diff import show_diff_trees
260
template = make_commit_message_template(working_tree, specific_files)
261
template = template.encode(output_encoding, "replace")
265
show_diff_trees(working_tree.basis_tree(),
266
working_tree, stream, specific_files,
267
path_encoding=output_encoding)
268
template = template + '\n' + stream.getvalue()
added
removed
bzrlib/msgeditor.py
