← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

[merge] fix \t in commit messages

Show diffs side-by-side

added added

removed removed

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