1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Bazaar-NG -- distributed version control
3
# Copyright (C) 2005 by Canonical Ltd
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
5
7
# the Free Software Foundation; either version 2 of the License, or
6
8
# (at your option) any later version.
8
10
# This program is distributed in the hope that it will be useful,
9
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
13
# GNU General Public License for more details.
13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
20
"""Commit message editor support."""
25
23
from subprocess import call
37
from .errors import BzrError
38
from .hooks import Hooks
41
class BadCommitMessageEncoding(BzrError):
43
_fmt = 'The specified commit message contains characters unsupported by '\
44
'the current encoding.'
25
import bzrlib.config as config
26
from bzrlib.errors import BzrError
48
"""Return sequence of possible editor binaries for the current platform"""
29
"""Return a sequence of possible editor binaries for the current platform"""
50
yield os.environ["BRZ_EDITOR"], '$BRZ_EDITOR'
31
yield os.environ["BZR_EDITOR"]
54
e = config.GlobalStack().get('editor')
35
e = config.GlobalConfig().get_editor()
56
yield e, bedding.config_path()
58
for varname in 'VISUAL', 'EDITOR':
59
if varname in os.environ:
60
yield os.environ[varname], '$' + varname
62
if sys.platform == 'win32':
63
for editor in 'wordpad.exe', 'notepad.exe':
66
for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
40
yield os.environ["EDITOR"]
46
elif os.name == "posix":
70
50
def _run_editor(filename):
71
51
"""Try to execute an editor to edit the commit message."""
72
for candidate, candidate_source in _get_editor():
73
edargs = cmdline.split(candidate)
75
x = call(edargs + [filename])
77
if candidate_source is not None:
78
# We tried this editor because some user configuration (an
79
# environment variable or config file) said to try it. Let
80
# the user know their configuration is broken.
82
'Could not start editor "%s" (specified by %s): %s\n'
83
% (candidate, candidate_source, str(e)))
52
for e in _get_editor():
54
x = call(edargs + [filename])
92
raise BzrError("Could not start any editor.\nPlease specify one with:\n"
93
" - $BRZ_EDITOR\n - editor=/some/path in %s\n"
94
" - $VISUAL\n - $EDITOR" %
95
bedding.config_path())
98
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
99
{'bar': '-' * 14, 'msg': 'This line and the following will be ignored'}
102
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
104
"""Let the user edit a commit message in a temp file.
106
This is run if they don't give a message or
107
message-containing file on the command line.
109
:param infotext: Text to be displayed at bottom of message
110
for the user's reference;
111
currently similar to 'bzr status'.
113
:param ignoreline: The separator to use above the infotext.
115
:param start_message: The text to place above the separator, if any.
116
This will not be removed from the message
117
after the user has edited it.
119
:return: commit message or None.
122
if start_message is not None:
123
start_message = start_message.encode(osutils.get_user_encoding())
124
infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
125
return edit_commit_message_encoded(infotext, ignoreline, start_message)
128
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
130
"""Let the user edit a commit message in a temp file.
132
This is run if they don't give a message or
133
message-containing file on the command line.
135
:param infotext: Text to be displayed at bottom of message
136
for the user's reference;
137
currently similar to 'bzr status'.
138
The string is already encoded
140
:param ignoreline: The separator to use above the infotext.
142
:param start_message: The text to place above the separator, if any.
143
This will not be removed from the message
144
after the user has edited it.
145
The string is already encoded
147
:return: commit message or None.
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 --"
151
msgfilename, hasinfo = _create_temp_file_with_commit_template(
152
infotext, ignoreline, start_message)
155
basename = osutils.basename(msgfilename)
156
msg_transport = transport.get_transport_from_path(
157
osutils.dirname(msgfilename))
158
reference_content = msg_transport.get_bytes(basename)
82
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
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))
159
92
if not _run_editor(msgfilename):
161
edited_content = msg_transport.get_bytes(basename)
162
if edited_content == reference_content:
163
if not ui.ui_factory.confirm_action(
164
u"Commit message was not edited, use anyway",
165
"breezy.msgeditor.unchanged",
167
# Returning "" makes cmd_commit raise 'empty commit message
168
# specified' which is a reasonable error, given the user has
169
# rejected using the unedited template.
173
97
lastline, nlines = 0, 0
174
with codecs.open(msgfilename, mode='rb', encoding=osutils.get_user_encoding()) as f:
177
stripped_line = line.strip()
178
# strip empty line before the log message starts
180
if stripped_line != "":
184
# check for the ignore line only if there
185
# is additional information at the end
186
if hasinfo and stripped_line == ignoreline:
189
# keep track of the last line that had some content
190
if stripped_line != "":
193
except UnicodeDecodeError:
194
raise BadCommitMessageEncoding()
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 != "":
196
116
if len(msg) == 0:
198
118
# delete empty lines at the end
204
124
return "".join(msg)
206
126
# delete the msg file in any case
207
if msgfilename is not None:
209
os.unlink(msgfilename)
212
"failed to unlink %s: %s; ignored", msgfilename, e)
215
def _create_temp_file_with_commit_template(infotext,
216
ignoreline=DEFAULT_IGNORE_LINE,
219
"""Create temp file and write commit template in it.
221
:param infotext: Text to be displayed at bottom of message for the
222
user's reference; currently similar to 'bzr status'. The text is
225
:param ignoreline: The separator to use above the infotext.
227
:param start_message: The text to place above the separator, if any.
228
This will not be removed from the message after the user has edited
229
it. The string is already encoded
231
:return: 2-tuple (temp file name, hasinfo)
234
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
235
dir=tmpdir, text=True)
236
with os.fdopen(tmp_fileno, 'wb') as msgfile:
237
if start_message is not None:
238
msgfile.write(b"%s\n" % start_message)
240
if infotext is not None and infotext != "":
242
trailer = b"\n\n%s\n\n%s" % (
243
ignoreline.encode(osutils.get_user_encoding()), infotext)
244
msgfile.write(trailer)
248
return (msgfilename, hasinfo)
127
try: os.unlink(msgfilename)
251
131
def make_commit_message_template(working_tree, specific_files):
254
134
Returns a unicode string containing the template.
136
# TODO: Should probably be given the WorkingTree not the branch
256
138
# TODO: make provision for this to be overridden or modified by a hook
258
140
# TODO: Rather than running the status command, should prepare a draft of
259
141
# the revision to be committed, then pause and ask the user to
260
142
# confirm/write a message.
261
from .status import show_tree_status
143
from StringIO import StringIO # must be unicode-safe
144
from bzrlib.status import show_status
262
145
status_tmp = StringIO()
263
show_tree_status(working_tree, specific_files=specific_files,
264
to_file=status_tmp, verbose=True)
146
show_status(working_tree.branch, specific_files=specific_files, to_file=status_tmp)
265
147
return status_tmp.getvalue()
268
def make_commit_message_template_encoded(working_tree, specific_files,
269
diff=None, output_encoding='utf-8'):
270
"""Prepare a template file for a commit into a branch.
272
Returns an encoded string.
274
# TODO: make provision for this to be overridden or modified by a hook
276
# TODO: Rather than running the status command, should prepare a draft of
277
# the revision to be committed, then pause and ask the user to
278
# confirm/write a message.
279
from .diff import show_diff_trees
281
template = make_commit_message_template(working_tree, specific_files)
282
template = template.encode(output_encoding, "replace")
286
show_diff_trees(working_tree.basis_tree(),
287
working_tree, stream, specific_files,
288
path_encoding=output_encoding)
289
template = template + b'\n' + stream.getvalue()
294
class MessageEditorHooks(Hooks):
295
"""A dictionary mapping hook name to a list of callables for message editor
298
e.g. ['commit_message_template'] is the list of items to be called to
299
generate a commit message template
303
"""Create the default hooks.
305
These are all empty initially.
307
Hooks.__init__(self, "breezy.msgeditor", "hooks")
309
'set_commit_message',
310
"Set a fixed commit message. "
311
"set_commit_message is called with the "
312
"breezy.commit.Commit object (so you can also change e.g. "
313
"revision properties by editing commit.builder._revprops) and the "
314
"message so far. set_commit_message must return the message to "
315
"use or None if it should use the message editor as normal.",
318
'commit_message_template',
319
"Called when a commit message is being generated. "
320
"commit_message_template is called with the breezy.commit.Commit "
321
"object and the message that is known so far. "
322
"commit_message_template must return a new message to use (which "
323
"could be the same as it was given). When there are multiple "
324
"hooks registered for commit_message_template, they are chained "
325
"with the result from the first passed into the second, and so "
329
hooks = MessageEditorHooks()
332
def set_commit_message(commit, start_message=None):
333
"""Sets the commit message.
334
:param commit: Commit object for the active commit.
335
:return: The commit message or None to continue using the message editor
338
for hook in hooks['set_commit_message']:
339
start_message = hook(commit, start_message)
343
def generate_commit_message_template(commit, start_message=None):
344
"""Generate a commit message template.
346
:param commit: Commit object for the active commit.
347
:param start_message: Message to start with.
348
:return: A start commit message or None for an empty start commit message.
351
for hook in hooks['commit_message_template']:
352
start_message = hook(commit, start_message)
added
removed
bzrlib/msgeditor.py
