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.errors import BzrError, BadCommitMessageEncoding
29
from bzrlib.trace import warning, mutter
33
"""Return a sequence of possible editor binaries for the current platform"""
35
yield os.environ["BZR_EDITOR"]
39
e = config.GlobalConfig().get_editor()
43
for varname in 'VISUAL', 'EDITOR':
44
if varname in os.environ:
45
yield os.environ[varname]
47
if sys.platform == 'win32':
48
for editor in 'wordpad.exe', 'notepad.exe':
51
for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
55
def _run_editor(filename):
56
"""Try to execute an editor to edit the commit message."""
57
for e in _get_editor():
60
## mutter("trying editor: %r", (edargs +[filename]))
61
x = call(edargs + [filename])
63
# We're searching for an editor, so catch safe errors and continue
64
if e.errno in (errno.ENOENT, ):
73
raise BzrError("Could not start any editor.\nPlease specify one with:\n"
74
" - $BZR_EDITOR\n - editor=/some/path in %s\n"
75
" - $VISUAL\n - $EDITOR" % \
76
config.config_filename())
79
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
80
{ 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
83
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
85
"""Let the user edit a commit message in a temp file.
87
This is run if they don't give a message or
88
message-containing file on the command line.
90
:param infotext: Text to be displayed at bottom of message
91
for the user's reference;
92
currently similar to 'bzr status'.
94
:param ignoreline: The separator to use above the infotext.
96
:param start_message: The text to place above the separator, if any.
97
This will not be removed from the message
98
after the user has edited it.
100
:return: commit message or None.
104
msgfilename, hasinfo = _create_temp_file_with_commit_template(
105
infotext, ignoreline, start_message)
107
if not msgfilename or not _run_editor(msgfilename):
112
lastline, nlines = 0, 0
113
# codecs.open() ALWAYS opens file in binary mode but we need text mode
114
# 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
115
f = file(msgfilename, 'rU')
118
for line in codecs.getreader(bzrlib.user_encoding)(f):
119
stripped_line = line.strip()
120
# strip empty line before the log message starts
122
if stripped_line != "":
126
# check for the ignore line only if there
127
# is additional information at the end
128
if hasinfo and stripped_line == ignoreline:
131
# keep track of the last line that had some content
132
if stripped_line != "":
135
except UnicodeDecodeError:
136
raise BadCommitMessageEncoding()
142
# delete empty lines at the end
144
# add a newline at the end, if needed
145
if not msg[-1].endswith("\n"):
146
return "%s%s" % ("".join(msg), "\n")
150
# delete the msg file in any case
151
if msgfilename is not None:
153
os.unlink(msgfilename)
155
warning("failed to unlink %s: %s; ignored", msgfilename, e)
158
def _create_temp_file_with_commit_template(infotext,
159
ignoreline=DEFAULT_IGNORE_LINE,
161
"""Create temp file and write commit template in it.
163
:param infotext: Text to be displayed at bottom of message
164
for the user's reference;
165
currently similar to 'bzr status'.
167
:param ignoreline: The separator to use above the infotext.
169
:param start_message: The text to place above the separator, if any.
170
This will not be removed from the message
171
after the user has edited it.
173
:return: 2-tuple (temp file name, hasinfo)
176
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
179
msgfile = os.fdopen(tmp_fileno, 'w')
181
if start_message is not None:
182
msgfile.write("%s\n" % start_message.encode(
183
bzrlib.user_encoding, 'replace'))
185
if infotext is not None and infotext != "":
187
msgfile.write("\n\n%s\n\n%s" % (ignoreline,
188
infotext.encode(bzrlib.user_encoding,
195
return (msgfilename, hasinfo)
198
def make_commit_message_template(working_tree, specific_files):
199
"""Prepare a template file for a commit into a branch.
201
Returns a unicode string containing the template.
203
# TODO: Should probably be given the WorkingTree not the branch
205
# TODO: make provision for this to be overridden or modified by a hook
207
# TODO: Rather than running the status command, should prepare a draft of
208
# the revision to be committed, then pause and ask the user to
209
# confirm/write a message.
210
from StringIO import StringIO # must be unicode-safe
211
from bzrlib.status import show_tree_status
212
status_tmp = StringIO()
213
show_tree_status(working_tree, specific_files=specific_files,
215
return status_tmp.getvalue()
added
removed
bzrlib/msgeditor.py
