1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005, 2006 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
18
"""Commit message editor support."""
19
from __future__ import absolute_import
23
23
from subprocess import call
26
26
from bzrlib import (
34
31
from bzrlib.errors import BzrError, BadCommitMessageEncoding
35
from bzrlib.hooks import Hooks
32
from bzrlib.hooks import HookPoint, Hooks
61
58
def _run_editor(filename):
62
59
"""Try to execute an editor to edit the commit message."""
63
60
for candidate, candidate_source in _get_editor():
64
edargs = cmdline.split(candidate)
61
edargs = candidate.split(' ')
66
63
## mutter("trying editor: %r", (edargs +[filename]))
67
64
x = call(edargs + [filename])
69
if candidate_source is not None:
70
# We tried this editor because some user configuration (an
71
# environment variable or config file) said to try it. Let
72
# the user know their configuration is broken.
74
'Could not start editor "%s" (specified by %s): %s\n'
75
% (candidate, candidate_source, str(e)))
66
# We're searching for an editor, so catch safe errors and continue
67
if e.errno in (errno.ENOENT, errno.EACCES):
68
if candidate_source is not None:
69
# We tried this editor because some user configuration (an
70
# environment variable or config file) said to try it. Let
71
# the user know their configuration is broken.
73
'Could not start editor "%s" (specified by %s): %s\n'
74
% (candidate, candidate_source, str(e)))
143
142
msgfilename, hasinfo = _create_temp_file_with_commit_template(
144
143
infotext, ignoreline, start_message)
147
basename = osutils.basename(msgfilename)
148
msg_transport = transport.get_transport_from_path(osutils.dirname(msgfilename))
149
reference_content = msg_transport.get_bytes(basename)
150
if not _run_editor(msgfilename):
152
edited_content = msg_transport.get_bytes(basename)
153
if edited_content == reference_content:
154
if not ui.ui_factory.confirm_action(
155
u"Commit message was not edited, use anyway",
156
"bzrlib.msgeditor.unchanged",
158
# Returning "" makes cmd_commit raise 'empty commit message
159
# specified' which is a reasonable error, given the user has
160
# rejected using the unedited template.
145
if not msgfilename or not _run_editor(msgfilename):
164
150
lastline, nlines = 0, 0
211
197
def _create_temp_file_with_commit_template(infotext,
212
198
ignoreline=DEFAULT_IGNORE_LINE,
215
200
"""Create temp file and write commit template in it.
217
:param infotext: Text to be displayed at bottom of message for the
218
user's reference; currently similar to 'bzr status'. The text is
202
:param infotext: Text to be displayed at bottom of message
203
for the user's reference;
204
currently similar to 'bzr status'.
205
The text is already encoded.
221
207
:param ignoreline: The separator to use above the infotext.
223
:param start_message: The text to place above the separator, if any.
224
This will not be removed from the message after the user has edited
225
it. The string is already encoded
209
:param start_message: The text to place above the separator, if any.
210
This will not be removed from the message
211
after the user has edited it.
212
The string is already encoded
227
214
:return: 2-tuple (temp file name, hasinfo)
230
217
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
231
dir=tmpdir, text=True)
220
msgfilename = osutils.basename(msgfilename)
232
221
msgfile = os.fdopen(tmp_fileno, 'w')
234
223
if start_message is not None:
304
293
These are all empty initially.
306
Hooks.__init__(self, "bzrlib.msgeditor", "hooks")
307
self.add_hook('set_commit_message',
308
"Set a fixed commit message. "
309
"set_commit_message is called with the "
310
"bzrlib.commit.Commit object (so you can also change e.g. revision "
311
"properties by editing commit.builder._revprops) and the message "
312
"so far. set_commit_message must return the message to use or None"
313
" if it should use the message editor as normal.", (2, 4))
314
self.add_hook('commit_message_template',
296
self.create_hook(HookPoint('commit_message_template',
315
297
"Called when a commit message is being generated. "
316
298
"commit_message_template is called with the bzrlib.commit.Commit "
317
299
"object and the message that is known so far. "
318
300
"commit_message_template must return a new message to use (which "
319
"could be the same as it was given). When there are multiple "
301
"could be the same as it was given. When there are multiple "
320
302
"hooks registered for commit_message_template, they are chained "
321
303
"with the result from the first passed into the second, and so "
304
"on.", (1, 10), None))
325
307
hooks = MessageEditorHooks()
328
def set_commit_message(commit, start_message=None):
329
"""Sets the commit message.
330
:param commit: Commit object for the active commit.
331
:return: The commit message or None to continue using the message editor
334
for hook in hooks['set_commit_message']:
335
start_message = hook(commit, start_message)
339
310
def generate_commit_message_template(commit, start_message=None):
340
311
"""Generate a commit message template.
added
removed
bzrlib/msgeditor.py
