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
27
import bzrlib.config as config
28
from bzrlib import osutils
29
from bzrlib.errors import BzrError, BadCommitMessageEncoding
30
from bzrlib.trace import warning, mutter
34
"""Return a sequence of possible editor binaries for the current platform"""
36
yield os.environ["BZR_EDITOR"]
40
e = config.GlobalConfig().get_editor()
44
for varname in 'VISUAL', 'EDITOR':
45
if varname in os.environ:
46
yield os.environ[varname]
48
if sys.platform == 'win32':
49
for editor in 'wordpad.exe', 'notepad.exe':
52
for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
56
def _run_editor(filename):
57
"""Try to execute an editor to edit the commit message."""
58
for e in _get_editor():
61
## mutter("trying editor: %r", (edargs +[filename]))
62
x = call(edargs + [filename])
64
# We're searching for an editor, so catch safe errors and continue
65
if e.errno in (errno.ENOENT, ):
74
raise BzrError("Could not start any editor.\nPlease specify one with:\n"
75
" - $BZR_EDITOR\n - editor=/some/path in %s\n"
76
" - $VISUAL\n - $EDITOR" % \
77
config.config_filename())
80
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
81
{ 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
84
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
86
"""Let the user edit a commit message in a temp file.
88
This is run if they don't give a message or
89
message-containing file on the command line.
91
:param infotext: Text to be displayed at bottom of message
92
for the user's reference;
93
currently similar to 'bzr status'.
95
:param ignoreline: The separator to use above the infotext.
97
:param start_message: The text to place above the separator, if any.
98
This will not be removed from the message
99
after the user has edited it.
101
:return: commit message or None.
104
if not start_message is None:
105
start_message = start_message.encode(bzrlib.user_encoding)
106
infotext = infotext.encode(bzrlib.user_encoding, 'replace')
107
return edit_commit_message_encoded(infotext, ignoreline, start_message)
110
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
112
"""Let the user edit a commit message in a temp file.
114
This is run if they don't give a message or
115
message-containing file on the command line.
117
:param infotext: Text to be displayed at bottom of message
118
for the user's reference;
119
currently similar to 'bzr status'.
120
The string is already encoded
122
:param ignoreline: The separator to use above the infotext.
124
:param start_message: The text to place above the separator, if any.
125
This will not be removed from the message
126
after the user has edited it.
127
The string is already encoded
129
:return: commit message or None.
133
msgfilename, hasinfo = _create_temp_file_with_commit_template(
134
infotext, ignoreline, start_message)
136
if not msgfilename or not _run_editor(msgfilename):
141
lastline, nlines = 0, 0
142
# codecs.open() ALWAYS opens file in binary mode but we need text mode
143
# 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
144
f = file(msgfilename, 'rU')
147
for line in codecs.getreader(bzrlib.user_encoding)(f):
148
stripped_line = line.strip()
149
# strip empty line before the log message starts
151
if stripped_line != "":
155
# check for the ignore line only if there
156
# is additional information at the end
157
if hasinfo and stripped_line == ignoreline:
160
# keep track of the last line that had some content
161
if stripped_line != "":
164
except UnicodeDecodeError:
165
raise BadCommitMessageEncoding()
171
# delete empty lines at the end
173
# add a newline at the end, if needed
174
if not msg[-1].endswith("\n"):
175
return "%s%s" % ("".join(msg), "\n")
179
# delete the msg file in any case
180
if msgfilename is not None:
182
os.unlink(msgfilename)
184
warning("failed to unlink %s: %s; ignored", msgfilename, e)
187
def _create_temp_file_with_commit_template(infotext,
188
ignoreline=DEFAULT_IGNORE_LINE,
190
"""Create temp file and write commit template in it.
192
:param infotext: Text to be displayed at bottom of message
193
for the user's reference;
194
currently similar to 'bzr status'.
195
The text is already encoded.
197
:param ignoreline: The separator to use above the infotext.
199
:param start_message: The text to place above the separator, if any.
200
This will not be removed from the message
201
after the user has edited it.
202
The string is already encoded
204
:return: 2-tuple (temp file name, hasinfo)
207
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
210
msgfilename = osutils.basename(msgfilename)
211
msgfile = os.fdopen(tmp_fileno, 'w')
213
if start_message is not None:
214
msgfile.write("%s\n" % start_message)
216
if infotext is not None and infotext != "":
218
msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
224
return (msgfilename, hasinfo)
227
def make_commit_message_template(working_tree, specific_files):
228
"""Prepare a template file for a commit into a branch.
230
Returns a unicode string containing the template.
232
# TODO: make provision for this to be overridden or modified by a hook
234
# TODO: Rather than running the status command, should prepare a draft of
235
# the revision to be committed, then pause and ask the user to
236
# confirm/write a message.
237
from StringIO import StringIO # must be unicode-safe
238
from bzrlib.status import show_tree_status
239
status_tmp = StringIO()
240
show_tree_status(working_tree, specific_files=specific_files,
242
return status_tmp.getvalue()
245
def make_commit_message_template_encoded(working_tree, specific_files,
246
diff=None, output_encoding='utf-8'):
247
"""Prepare a template file for a commit into a branch.
249
Returns an encoded string.
251
# TODO: make provision for this to be overridden or modified by a hook
253
# TODO: Rather than running the status command, should prepare a draft of
254
# the revision to be committed, then pause and ask the user to
255
# confirm/write a message.
256
from StringIO import StringIO # must be unicode-safe
257
from bzrlib.diff import show_diff_trees
259
template = make_commit_message_template(working_tree, specific_files)
260
template = template.encode(output_encoding, "replace")
264
show_diff_trees(working_tree.basis_tree(),
265
working_tree, stream, specific_files,
266
path_encoding=output_encoding)
267
template = template + '\n' + stream.getvalue()
added
removed
bzrlib/msgeditor.py
