1
# Copyright (C) 2005, 2006 by 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
29
from bzrlib.trace import warning
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 os.environ.has_key(varname):
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
x = call(edargs + [filename])
62
# We're searching for an editor, so catch safe errors and continue
63
if e.errno in (errno.ENOENT, ):
72
raise BzrError("Could not start any editor.\nPlease specify one with:\n"
73
" - $BZR_EDITOR\n - editor=/some/path in %s\n - $EDITOR" % \
74
config.config_filename())
77
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
78
{ 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
81
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
82
"""Let the user edit a commit message in a temp file.
84
This is run if they don't give a message or
85
message-containing file on the command line.
88
Text to be displayed at bottom of message for
89
the user's reference; currently similar to
96
tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
97
msgfile = os.close(tmp_fileno)
98
if infotext is not None and infotext != "":
100
msgfile = file(msgfilename, "w")
101
msgfile.write("\n\n%s\n\n%s" % (ignoreline,
102
infotext.encode(bzrlib.user_encoding, 'replace')))
107
if not _run_editor(msgfilename):
112
lastline, nlines = 0, 0
113
for line in codecs.open(msgfilename, 'r', bzrlib.user_encoding):
114
stripped_line = line.strip()
115
# strip empty line before the log message starts
117
if stripped_line != "":
121
# check for the ignore line only if there
122
# is additional information at the end
123
if hasinfo and stripped_line == ignoreline:
126
# keep track of the last line that had some content
127
if stripped_line != "":
133
# delete empty lines at the end
135
# add a newline at the end, if needed
136
if not msg[-1].endswith("\n"):
137
return "%s%s" % ("".join(msg), "\n")
141
# delete the msg file in any case
142
if msgfilename is not None:
144
os.unlink(msgfilename)
146
warning("failed to unlink %s: %s; ignored", msgfilename, e)
149
def make_commit_message_template(working_tree, specific_files):
150
"""Prepare a template file for a commit into a branch.
152
Returns a unicode string containing the template.
154
# TODO: Should probably be given the WorkingTree not the branch
156
# TODO: make provision for this to be overridden or modified by a hook
158
# TODO: Rather than running the status command, should prepare a draft of
159
# the revision to be committed, then pause and ask the user to
160
# confirm/write a message.
161
from StringIO import StringIO # must be unicode-safe
162
from bzrlib.status import show_tree_status
163
status_tmp = StringIO()
164
show_tree_status(working_tree, specific_files=specific_files,
166
return status_tmp.getvalue()
added
removed
bzrlib/msgeditor.py
