← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Aaron Bentley
  • Date: 2007-06-12 16:24:23 UTC
  • mto: (1551.19.24 Aaron's mergeable stuff)
  • mto: This revision was merged to the branch mainline in revision 2525.
  • Revision ID: abentley@panoramicfeedback.com-20070612162423-vm2vm5kzla75m4a9
Redo test skip

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Bazaar-NG -- distributed version control
2
 
 
3
 
# Copyright (C) 2005 by Canonical Ltd
4
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
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.
9
 
 
 
7
#
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.
14
 
 
 
12
#
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
17
 
20
18
"""Commit message editor support."""
21
19
 
 
20
import codecs
 
21
import errno
22
22
import os
23
23
from subprocess import call
 
24
import sys
 
25
 
 
26
import bzrlib
 
27
import bzrlib.config as config
24
28
from bzrlib.errors import BzrError
 
29
from bzrlib.trace import warning, mutter
 
30
 
25
31
 
26
32
def _get_editor():
27
33
    """Return a sequence of possible editor binaries for the current platform"""
28
 
    from bzrlib.osutils import _read_config_value
29
 
    
30
 
    e = _read_config_value("editor")
 
34
    try:
 
35
        yield os.environ["BZR_EDITOR"]
 
36
    except KeyError:
 
37
        pass
 
38
 
 
39
    e = config.GlobalConfig().get_editor()
31
40
    if e is not None:
32
41
        yield e
33
42
        
34
 
    try:
35
 
        yield os.environ["EDITOR"]
36
 
    except KeyError:
37
 
        if os.name == "nt":
38
 
            yield "notepad.exe"
39
 
        elif os.name == "posix":
40
 
            yield "/usr/bin/vi"
 
43
    for varname in 'VISUAL', 'EDITOR':
 
44
        if varname in os.environ:
 
45
            yield os.environ[varname]
 
46
 
 
47
    if sys.platform == 'win32':
 
48
        for editor in 'wordpad.exe', 'notepad.exe':
 
49
            yield editor
 
50
    else:
 
51
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
 
52
            yield editor
41
53
 
42
54
 
43
55
def _run_editor(filename):
44
56
    """Try to execute an editor to edit the commit message."""
45
57
    for e in _get_editor():
46
58
        edargs = e.split(' ')
47
 
        x = call(edargs + [filename])
 
59
        try:
 
60
            ## mutter("trying editor: %r", (edargs +[filename]))
 
61
            x = call(edargs + [filename])
 
62
        except OSError, e:
 
63
           # We're searching for an editor, so catch safe errors and continue
 
64
           if e.errno in (errno.ENOENT, ):
 
65
               continue
 
66
           raise
48
67
        if x == 0:
49
68
            return True
50
69
        elif x == 127:
51
70
            continue
52
71
        else:
53
72
            break
54
 
    raise BzrError("Could not start any editor. "
55
 
                   "Please specify $EDITOR or use ~/.bzr.conf/editor")
56
 
                          
57
 
 
58
 
def edit_commit_message(infotext, ignoreline=None):
 
73
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
 
74
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n"
 
75
                   " - $VISUAL\n - $EDITOR" % \
 
76
                    config.config_filename())
 
77
 
 
78
 
 
79
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
 
80
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
 
81
 
 
82
 
 
83
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
 
84
                        start_message=None):
59
85
    """Let the user edit a commit message in a temp file.
60
86
 
61
87
    This is run if they don't give a message or
62
88
    message-containing file on the command line.
63
89
 
64
 
    infotext:
65
 
        Text to be displayed at bottom of message for
66
 
        the user's reference; currently similar to
67
 
        'bzr status'.
 
90
    :param infotext:    Text to be displayed at bottom of message
 
91
                        for the user's reference;
 
92
                        currently similar to 'bzr status'.
 
93
 
 
94
    :param ignoreline:  The separator to use above the infotext.
 
95
 
 
96
    :param start_message:   The text to place above the separator, if any.
 
97
                            This will not be removed from the message
 
98
                            after the user has edited it.
 
99
 
 
100
    :return:    commit message or None.
68
101
    """
69
 
    import tempfile
70
 
    
71
 
    if ignoreline is None:
72
 
        ignoreline = "-- This line and the following will be ignored --"
73
 
        
 
102
    msgfilename = None
74
103
    try:
75
 
        tmp_fileno, msgfilename = tempfile.mkstemp()
76
 
        msgfile = os.close(tmp_fileno)
77
 
        if infotext is not None and infotext != "":
78
 
            hasinfo = True
79
 
            msgfile = file(msgfilename, "w")
80
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
81
 
            msgfile.close()
82
 
        else:
83
 
            hasinfo = False
 
104
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
 
105
                                    infotext, ignoreline, start_message)
84
106
 
85
 
        if not _run_editor(msgfilename):
 
107
        if not msgfilename or not _run_editor(msgfilename):
86
108
            return None
87
109
        
88
110
        started = False
89
111
        msg = []
90
112
        lastline, nlines = 0, 0
91
 
        for line in file(msgfilename, "r"):
 
113
        # codecs.open() ALWAYS opens file in binary mode but we need text mode
 
114
        # 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
 
115
        f = file(msgfilename, 'rU')
 
116
        for line in codecs.getreader(bzrlib.user_encoding)(f):
92
117
            stripped_line = line.strip()
93
118
            # strip empty line before the log message starts
94
119
            if not started:
105
130
            if stripped_line != "":
106
131
                lastline = nlines
107
132
            msg.append(line)
108
 
            
 
133
        f.close()
 
134
 
109
135
        if len(msg) == 0:
110
 
            return None
 
136
            return ""
111
137
        # delete empty lines at the end
112
138
        del msg[lastline:]
113
139
        # add a newline at the end, if needed
117
143
            return "".join(msg)
118
144
    finally:
119
145
        # delete the msg file in any case
120
 
        try: os.unlink(msgfilename)
121
 
        except IOError: pass
122
 
 
 
146
        if msgfilename is not None:
 
147
            try:
 
148
                os.unlink(msgfilename)
 
149
            except IOError, e:
 
150
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
 
151
 
 
152
 
 
153
def _create_temp_file_with_commit_template(infotext,
 
154
                                           ignoreline=DEFAULT_IGNORE_LINE,
 
155
                                           start_message=None):
 
156
    """Create temp file and write commit template in it.
 
157
 
 
158
    :param infotext:    Text to be displayed at bottom of message
 
159
                        for the user's reference;
 
160
                        currently similar to 'bzr status'.
 
161
 
 
162
    :param ignoreline:  The separator to use above the infotext.
 
163
 
 
164
    :param start_message:   The text to place above the separator, if any.
 
165
                            This will not be removed from the message
 
166
                            after the user has edited it.
 
167
 
 
168
    :return:    2-tuple (temp file name, hasinfo)
 
169
    """
 
170
    import tempfile
 
171
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
 
172
                                               dir=u'.',
 
173
                                               text=True)
 
174
    msgfile = os.fdopen(tmp_fileno, 'w')
 
175
    try:
 
176
        if start_message is not None:
 
177
            msgfile.write("%s\n" % start_message.encode(
 
178
                                       bzrlib.user_encoding, 'replace'))
 
179
 
 
180
        if infotext is not None and infotext != "":
 
181
            hasinfo = True
 
182
            msgfile.write("\n\n%s\n\n%s" % (ignoreline,
 
183
                          infotext.encode(bzrlib.user_encoding,
 
184
                                                'replace')))
 
185
        else:
 
186
            hasinfo = False
 
187
    finally:
 
188
        msgfile.close()
 
189
 
 
190
    return (msgfilename, hasinfo)
 
191
 
 
192
 
 
193
def make_commit_message_template(working_tree, specific_files):
 
194
    """Prepare a template file for a commit into a branch.
 
195
 
 
196
    Returns a unicode string containing the template.
 
197
    """
 
198
    # TODO: Should probably be given the WorkingTree not the branch
 
199
    #
 
200
    # TODO: make provision for this to be overridden or modified by a hook
 
201
    #
 
202
    # TODO: Rather than running the status command, should prepare a draft of
 
203
    # the revision to be committed, then pause and ask the user to
 
204
    # confirm/write a message.
 
205
    from StringIO import StringIO       # must be unicode-safe
 
206
    from bzrlib.status import show_tree_status
 
207
    status_tmp = StringIO()
 
208
    show_tree_status(working_tree, specific_files=specific_files, 
 
209
                     to_file=status_tmp)
 
210
    return status_tmp.getvalue()