← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-09-20 02:40:52 UTC
  • mfrom: (2835.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070920024052-y2l7r5o00zrpnr73
No longer propagate index differences automatically (Robert Collins)

Show diffs side-by-side

added added

removed removed

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