1
# Bazaar-NG -- distributed version control
3
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
11
# GNU General Public License for more details.
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20
18
"""Commit message editor support."""
23
23
from subprocess import call
25
import bzrlib.config as config
26
from bzrlib.errors import BzrError
31
from bzrlib.errors import BzrError, BadCommitMessageEncoding
32
from bzrlib.hooks import HookPoint, Hooks
29
36
"""Return a sequence of possible editor binaries for the current platform"""
31
yield os.environ["BZR_EDITOR"]
38
yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
35
42
e = config.GlobalConfig().get_editor()
40
yield os.environ["EDITOR"]
46
elif os.name == "posix":
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']:
50
58
def _run_editor(filename):
51
59
"""Try to execute an editor to edit the commit message."""
52
for e in _get_editor():
54
x = call(edargs + [filename])
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
if candidate_source is not None:
67
# We tried this editor because some user configuration (an
68
# environment variable or config file) said to try it. Let
69
# the user know their configuration is broken.
71
'Could not start editor "%s" (specified by %s): %s\n'
72
% (candidate, candidate_source, str(e)))
61
raise BzrError("Could not start any editor. "
62
"Please specify $EDITOR or use ~/.bzr.conf/editor")
65
def edit_commit_message(infotext, ignoreline=None):
66
"""Let the user edit a commit message in a temp file.
68
This is run if they don't give a message or
69
message-containing file on the command line.
72
Text to be displayed at bottom of message for
73
the user's reference; currently similar to
78
if ignoreline is None:
79
ignoreline = "-- This line and the following will be ignored --"
81
raise BzrError("Could not start any editor.\nPlease specify one with:\n"
82
" - $BZR_EDITOR\n - editor=/some/path in %s\n"
83
" - $VISUAL\n - $EDITOR" % \
84
config.config_filename())
87
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
88
{ 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
91
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
93
"""Let the user edit a commit message in a temp file.
95
This is run if they don't give a message or
96
message-containing file on the command line.
98
:param infotext: Text to be displayed at bottom of message
99
for the user's reference;
100
currently similar to 'bzr status'.
102
:param ignoreline: The separator to use above the infotext.
104
:param start_message: The text to place above the separator, if any.
105
This will not be removed from the message
106
after the user has edited it.
108
:return: commit message or None.
111
if not start_message is None:
112
start_message = start_message.encode(osutils.get_user_encoding())
113
infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
114
return edit_commit_message_encoded(infotext, ignoreline, start_message)
117
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
119
"""Let the user edit a commit message in a temp file.
121
This is run if they don't give a message or
122
message-containing file on the command line.
124
:param infotext: Text to be displayed at bottom of message
125
for the user's reference;
126
currently similar to 'bzr status'.
127
The string is already encoded
129
:param ignoreline: The separator to use above the infotext.
131
:param start_message: The text to place above the separator, if any.
132
This will not be removed from the message
133
after the user has edited it.
134
The string is already encoded
136
:return: commit message or None.
82
tmp_fileno, msgfilename = tempfile.mkstemp()
83
msgfile = os.close(tmp_fileno)
84
if infotext is not None and infotext != "":
86
msgfile = file(msgfilename, "w")
87
msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
140
msgfilename, hasinfo = _create_temp_file_with_commit_template(
141
infotext, ignoreline, start_message)
92
if not _run_editor(msgfilename):
143
if not msgfilename or not _run_editor(msgfilename):
97
148
lastline, nlines = 0, 0
98
for line in file(msgfilename, "r"):
99
stripped_line = line.strip()
100
# strip empty line before the log message starts
102
if stripped_line != "":
106
# check for the ignore line only if there
107
# is additional information at the end
108
if hasinfo and stripped_line == ignoreline:
111
# keep track of the last line that had some content
112
if stripped_line != "":
149
# codecs.open() ALWAYS opens file in binary mode but we need text mode
150
# 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
151
f = file(msgfilename, 'rU')
154
for line in codecs.getreader(osutils.get_user_encoding())(f):
155
stripped_line = line.strip()
156
# strip empty line before the log message starts
158
if stripped_line != "":
162
# check for the ignore line only if there
163
# is additional information at the end
164
if hasinfo and stripped_line == ignoreline:
167
# keep track of the last line that had some content
168
if stripped_line != "":
171
except UnicodeDecodeError:
172
raise BadCommitMessageEncoding()
116
176
if len(msg) == 0:
118
178
# delete empty lines at the end
124
184
return "".join(msg)
126
186
# delete the msg file in any case
127
try: os.unlink(msgfilename)
187
if msgfilename is not None:
189
os.unlink(msgfilename)
192
"failed to unlink %s: %s; ignored", msgfilename, e)
195
def _create_temp_file_with_commit_template(infotext,
196
ignoreline=DEFAULT_IGNORE_LINE,
198
"""Create temp file and write commit template in it.
200
:param infotext: Text to be displayed at bottom of message
201
for the user's reference;
202
currently similar to 'bzr status'.
203
The text is already encoded.
205
:param ignoreline: The separator to use above the infotext.
207
:param start_message: The text to place above the separator, if any.
208
This will not be removed from the message
209
after the user has edited it.
210
The string is already encoded
212
:return: 2-tuple (temp file name, hasinfo)
215
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
218
msgfilename = osutils.basename(msgfilename)
219
msgfile = os.fdopen(tmp_fileno, 'w')
221
if start_message is not None:
222
msgfile.write("%s\n" % start_message)
224
if infotext is not None and infotext != "":
226
msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
232
return (msgfilename, hasinfo)
235
def make_commit_message_template(working_tree, specific_files):
236
"""Prepare a template file for a commit into a branch.
238
Returns a unicode string containing the template.
240
# TODO: make provision for this to be overridden or modified by a hook
242
# TODO: Rather than running the status command, should prepare a draft of
243
# the revision to be committed, then pause and ask the user to
244
# confirm/write a message.
245
from StringIO import StringIO # must be unicode-safe
246
from bzrlib.status import show_tree_status
247
status_tmp = StringIO()
248
show_tree_status(working_tree, specific_files=specific_files,
249
to_file=status_tmp, verbose=True)
250
return status_tmp.getvalue()
253
def make_commit_message_template_encoded(working_tree, specific_files,
254
diff=None, output_encoding='utf-8'):
255
"""Prepare a template file for a commit into a branch.
257
Returns an encoded string.
259
# TODO: make provision for this to be overridden or modified by a hook
261
# TODO: Rather than running the status command, should prepare a draft of
262
# the revision to be committed, then pause and ask the user to
263
# confirm/write a message.
264
from StringIO import StringIO # must be unicode-safe
265
from bzrlib.diff import show_diff_trees
267
template = make_commit_message_template(working_tree, specific_files)
268
template = template.encode(output_encoding, "replace")
272
show_diff_trees(working_tree.basis_tree(),
273
working_tree, stream, specific_files,
274
path_encoding=output_encoding)
275
template = template + '\n' + stream.getvalue()
280
class MessageEditorHooks(Hooks):
281
"""A dictionary mapping hook name to a list of callables for message editor
284
e.g. ['commit_message_template'] is the list of items to be called to
285
generate a commit message template
289
"""Create the default hooks.
291
These are all empty initially.
294
self.create_hook(HookPoint('commit_message_template',
295
"Called when a commit message is being generated. "
296
"commit_message_template is called with the bzrlib.commit.Commit "
297
"object and the message that is known so far. "
298
"commit_message_template must return a new message to use (which "
299
"could be the same as it was given. When there are multiple "
300
"hooks registered for commit_message_template, they are chained "
301
"with the result from the first passed into the second, and so "
302
"on.", (1, 10), None))
305
hooks = MessageEditorHooks()
308
def generate_commit_message_template(commit, start_message=None):
309
"""Generate a commit message template.
311
:param commit: Commit object for the active commit.
312
:param start_message: Message to start with.
313
:return: A start commit message or None for an empty start commit message.
316
for hook in hooks['commit_message_template']:
317
start_message = hook(commit, start_message)
added
removed
bzrlib/msgeditor.py
