1
# Bazaar-NG -- distributed version control
3
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005-2011 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."""
24
22
from subprocess import call
26
import bzrlib.config as config
27
from bzrlib.errors import BzrError
33
from bzrlib.errors import BzrError, BadCommitMessageEncoding
34
from bzrlib.hooks import Hooks
30
38
"""Return a sequence of possible editor binaries for the current platform"""
32
yield os.environ["BZR_EDITOR"]
40
yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
36
e = config.GlobalConfig().get_editor()
44
e = config.GlobalStack().get('editor')
41
yield os.environ["EDITOR"]
47
elif os.name == "posix":
46
yield e, config.config_filename()
48
for varname in 'VISUAL', 'EDITOR':
49
if varname in os.environ:
50
yield os.environ[varname], '$' + varname
52
if sys.platform == 'win32':
53
for editor in 'wordpad.exe', 'notepad.exe':
56
for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
51
60
def _run_editor(filename):
52
61
"""Try to execute an editor to edit the commit message."""
53
for e in _get_editor():
62
for candidate, candidate_source in _get_editor():
63
edargs = cmdline.split(candidate)
65
## mutter("trying editor: %r", (edargs +[filename]))
56
66
x = call(edargs + [filename])
58
# ENOENT means no such editor
59
if e.errno == errno.ENOENT:
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)))
68
raise BzrError("Could not start any editor. "
69
"Please specify $EDITOR or use ~/.bzr.conf/editor")
83
raise BzrError("Could not start any editor.\nPlease specify one with:\n"
84
" - $BZR_EDITOR\n - editor=/some/path in %s\n"
85
" - $VISUAL\n - $EDITOR" % \
86
config.config_filename())
72
89
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
73
90
{ 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
76
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
77
"""Let the user edit a commit message in a temp file.
79
This is run if they don't give a message or
80
message-containing file on the command line.
83
Text to be displayed at bottom of message for
84
the user's reference; currently similar to
93
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
95
"""Let the user edit a commit message in a temp file.
97
This is run if they don't give a message or
98
message-containing file on the command line.
100
:param infotext: Text to be displayed at bottom of message
101
for the user's reference;
102
currently similar to 'bzr status'.
104
:param ignoreline: The separator to use above the infotext.
106
:param start_message: The text to place above the separator, if any.
107
This will not be removed from the message
108
after the user has edited it.
110
:return: commit message or None.
113
if not start_message is None:
114
start_message = start_message.encode(osutils.get_user_encoding())
115
infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
116
return edit_commit_message_encoded(infotext, ignoreline, start_message)
119
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
121
"""Let the user edit a commit message in a temp file.
123
This is run if they don't give a message or
124
message-containing file on the command line.
126
:param infotext: Text to be displayed at bottom of message
127
for the user's reference;
128
currently similar to 'bzr status'.
129
The string is already encoded
131
:param ignoreline: The separator to use above the infotext.
133
:param start_message: The text to place above the separator, if any.
134
This will not be removed from the message
135
after the user has edited it.
136
The string is already encoded
138
:return: commit message or None.
90
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
91
msgfile = os.close(tmp_fileno)
92
if infotext is not None and infotext != "":
94
msgfile = file(msgfilename, "w")
95
msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
142
msgfilename, hasinfo = _create_temp_file_with_commit_template(
143
infotext, ignoreline, start_message)
146
basename = osutils.basename(msgfilename)
147
msg_transport = transport.get_transport(osutils.dirname(msgfilename))
148
reference_content = msg_transport.get_bytes(basename)
100
149
if not _run_editor(msgfilename):
151
edited_content = msg_transport.get_bytes(basename)
152
if edited_content == reference_content:
153
if not ui.ui_factory.confirm_action(
154
u"Commit message was not edited, use anyway",
155
"bzrlib.msgeditor.unchanged",
157
# Returning "" makes cmd_commit raise 'empty commit message
158
# specified' which is a reasonable error, given the user has
159
# rejected using the unedited template.
105
163
lastline, nlines = 0, 0
106
for line in file(msgfilename, "r"):
107
stripped_line = line.strip()
108
# strip empty line before the log message starts
110
if stripped_line != "":
114
# check for the ignore line only if there
115
# is additional information at the end
116
if hasinfo and stripped_line == ignoreline:
119
# keep track of the last line that had some content
120
if stripped_line != "":
164
# codecs.open() ALWAYS opens file in binary mode but we need text mode
165
# 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
166
f = file(msgfilename, 'rU')
169
for line in codecs.getreader(osutils.get_user_encoding())(f):
170
stripped_line = line.strip()
171
# strip empty line before the log message starts
173
if stripped_line != "":
177
# check for the ignore line only if there
178
# is additional information at the end
179
if hasinfo and stripped_line == ignoreline:
182
# keep track of the last line that had some content
183
if stripped_line != "":
186
except UnicodeDecodeError:
187
raise BadCommitMessageEncoding()
124
191
if len(msg) == 0:
126
193
# delete empty lines at the end
151
257
from StringIO import StringIO # must be unicode-safe
152
258
from bzrlib.status import show_tree_status
153
259
status_tmp = StringIO()
154
show_tree_status(working_tree, specific_files=specific_files,
260
show_tree_status(working_tree, specific_files=specific_files,
261
to_file=status_tmp, verbose=True)
156
262
return status_tmp.getvalue()
265
def make_commit_message_template_encoded(working_tree, specific_files,
266
diff=None, output_encoding='utf-8'):
267
"""Prepare a template file for a commit into a branch.
269
Returns an encoded string.
271
# TODO: make provision for this to be overridden or modified by a hook
273
# TODO: Rather than running the status command, should prepare a draft of
274
# the revision to be committed, then pause and ask the user to
275
# confirm/write a message.
276
from StringIO import StringIO # must be unicode-safe
277
from bzrlib.diff import show_diff_trees
279
template = make_commit_message_template(working_tree, specific_files)
280
template = template.encode(output_encoding, "replace")
284
show_diff_trees(working_tree.basis_tree(),
285
working_tree, stream, specific_files,
286
path_encoding=output_encoding)
287
template = template + '\n' + stream.getvalue()
292
class MessageEditorHooks(Hooks):
293
"""A dictionary mapping hook name to a list of callables for message editor
296
e.g. ['commit_message_template'] is the list of items to be called to
297
generate a commit message template
301
"""Create the default hooks.
303
These are all empty initially.
305
Hooks.__init__(self, "bzrlib.msgeditor", "hooks")
306
self.add_hook('commit_message_template',
307
"Called when a commit message is being generated. "
308
"commit_message_template is called with the bzrlib.commit.Commit "
309
"object and the message that is known so far. "
310
"commit_message_template must return a new message to use (which "
311
"could be the same as it was given). When there are multiple "
312
"hooks registered for commit_message_template, they are chained "
313
"with the result from the first passed into the second, and so "
317
hooks = MessageEditorHooks()
320
def generate_commit_message_template(commit, start_message=None):
321
"""Generate a commit message template.
323
:param commit: Commit object for the active commit.
324
:param start_message: Message to start with.
325
:return: A start commit message or None for an empty start commit message.
328
for hook in hooks['commit_message_template']:
329
start_message = hook(commit, start_message)
added
removed
bzrlib/msgeditor.py
