← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

Hacking notes on TDD

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005-2011 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
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
18
 
16
19
 
17
20
"""Commit message editor support."""
18
21
 
19
 
from __future__ import absolute_import
20
 
 
21
 
import codecs
22
22
import os
23
23
from subprocess import call
24
 
import sys
25
 
 
26
 
from bzrlib import (
27
 
    cmdline,
28
 
    config,
29
 
    osutils,
30
 
    trace,
31
 
    transport,
32
 
    ui,
33
 
    )
34
 
from bzrlib.errors import BzrError, BadCommitMessageEncoding
35
 
from bzrlib.hooks import Hooks
36
 
 
 
24
 
 
25
import bzrlib.config as config
 
26
from bzrlib.errors import BzrError
37
27
 
38
28
def _get_editor():
39
29
    """Return a sequence of possible editor binaries for the current platform"""
40
30
    try:
41
 
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
 
31
        yield os.environ["BZR_EDITOR"]
42
32
    except KeyError:
43
33
        pass
44
34
 
45
 
    e = config.GlobalStack().get('editor')
 
35
    e = config.GlobalConfig().get_editor()
46
36
    if e is not None:
47
 
        yield e, config.config_filename()
48
 
 
49
 
    for varname in 'VISUAL', 'EDITOR':
50
 
        if varname in os.environ:
51
 
            yield os.environ[varname], '$' + varname
52
 
 
53
 
    if sys.platform == 'win32':
54
 
        for editor in 'wordpad.exe', 'notepad.exe':
55
 
            yield editor, None
56
 
    else:
57
 
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
58
 
            yield editor, None
 
37
        yield e
 
38
        
 
39
    try:
 
40
        yield os.environ["EDITOR"]
 
41
    except KeyError:
 
42
        pass
 
43
 
 
44
    if os.name == "nt":
 
45
        yield "notepad.exe"
 
46
    elif os.name == "posix":
 
47
        yield "/usr/bin/vi"
59
48
 
60
49
 
61
50
def _run_editor(filename):
62
51
    """Try to execute an editor to edit the commit message."""
63
 
    for candidate, candidate_source in _get_editor():
64
 
        edargs = cmdline.split(candidate)
65
 
        try:
66
 
            ## mutter("trying editor: %r", (edargs +[filename]))
67
 
            x = call(edargs + [filename])
68
 
        except OSError, e:
69
 
            if candidate_source is not None:
70
 
                # We tried this editor because some user configuration (an
71
 
                # environment variable or config file) said to try it.  Let
72
 
                # the user know their configuration is broken.
73
 
                trace.warning(
74
 
                    'Could not start editor "%s" (specified by %s): %s\n'
75
 
                    % (candidate, candidate_source, str(e)))
76
 
            continue
77
 
            raise
 
52
    for e in _get_editor():
 
53
        edargs = e.split(' ')
 
54
        x = call(edargs + [filename])
78
55
        if x == 0:
79
56
            return True
80
57
        elif x == 127:
81
58
            continue
82
59
        else:
83
60
            break
84
 
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
85
 
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n"
86
 
                   " - $VISUAL\n - $EDITOR" % \
87
 
                    config.config_filename())
88
 
 
89
 
 
90
 
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
91
 
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
92
 
 
93
 
 
94
 
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
95
 
                        start_message=None):
96
 
    """Let the user edit a commit message in a temp file.
97
 
 
98
 
    This is run if they don't give a message or
99
 
    message-containing file on the command line.
100
 
 
101
 
    :param infotext:    Text to be displayed at bottom of message
102
 
                        for the user's reference;
103
 
                        currently similar to 'bzr status'.
104
 
 
105
 
    :param ignoreline:  The separator to use above the infotext.
106
 
 
107
 
    :param start_message:   The text to place above the separator, if any.
108
 
                            This will not be removed from the message
109
 
                            after the user has edited it.
110
 
 
111
 
    :return:    commit message or None.
112
 
    """
113
 
 
114
 
    if not start_message is None:
115
 
        start_message = start_message.encode(osutils.get_user_encoding())
116
 
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
117
 
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
118
 
 
119
 
 
120
 
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
121
 
                                start_message=None):
122
 
    """Let the user edit a commit message in a temp file.
123
 
 
124
 
    This is run if they don't give a message or
125
 
    message-containing file on the command line.
126
 
 
127
 
    :param infotext:    Text to be displayed at bottom of message
128
 
                        for the user's reference;
129
 
                        currently similar to 'bzr status'.
130
 
                        The string is already encoded
131
 
 
132
 
    :param ignoreline:  The separator to use above the infotext.
133
 
 
134
 
    :param start_message:   The text to place above the separator, if any.
135
 
                            This will not be removed from the message
136
 
                            after the user has edited it.
137
 
                            The string is already encoded
138
 
 
139
 
    :return:    commit message or None.
140
 
    """
141
 
    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
        
142
81
    try:
143
 
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
144
 
                                    infotext, ignoreline, start_message)
145
 
        if not msgfilename:
146
 
            return None
147
 
        basename = osutils.basename(msgfilename)
148
 
        msg_transport = transport.get_transport_from_path(osutils.dirname(msgfilename))
149
 
        reference_content = msg_transport.get_bytes(basename)
 
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
 
91
 
150
92
        if not _run_editor(msgfilename):
151
93
            return None
152
 
        edited_content = msg_transport.get_bytes(basename)
153
 
        if edited_content == reference_content:
154
 
            if not ui.ui_factory.confirm_action(
155
 
                u"Commit message was not edited, use anyway",
156
 
                "bzrlib.msgeditor.unchanged",
157
 
                {}):
158
 
                # Returning "" makes cmd_commit raise 'empty commit message
159
 
                # specified' which is a reasonable error, given the user has
160
 
                # rejected using the unedited template.
161
 
                return ""
 
94
        
162
95
        started = False
163
96
        msg = []
164
97
        lastline, nlines = 0, 0
165
 
        # codecs.open() ALWAYS opens file in binary mode but we need text mode
166
 
        # 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
167
 
        f = file(msgfilename, 'rU')
168
 
        try:
169
 
            try:
170
 
                for line in codecs.getreader(osutils.get_user_encoding())(f):
171
 
                    stripped_line = line.strip()
172
 
                    # strip empty line before the log message starts
173
 
                    if not started:
174
 
                        if stripped_line != "":
175
 
                            started = True
176
 
                        else:
177
 
                            continue
178
 
                    # check for the ignore line only if there
179
 
                    # is additional information at the end
180
 
                    if hasinfo and stripped_line == ignoreline:
181
 
                        break
182
 
                    nlines += 1
183
 
                    # keep track of the last line that had some content
184
 
                    if stripped_line != "":
185
 
                        lastline = nlines
186
 
                    msg.append(line)
187
 
            except UnicodeDecodeError:
188
 
                raise BadCommitMessageEncoding()
189
 
        finally:
190
 
            f.close()
191
 
 
 
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
            
192
116
        if len(msg) == 0:
193
117
            return ""
194
118
        # delete empty lines at the end
200
124
            return "".join(msg)
201
125
    finally:
202
126
        # delete the msg file in any case
203
 
        if msgfilename is not None:
204
 
            try:
205
 
                os.unlink(msgfilename)
206
 
            except IOError, e:
207
 
                trace.warning(
208
 
                    "failed to unlink %s: %s; ignored", msgfilename, e)
209
 
 
210
 
 
211
 
def _create_temp_file_with_commit_template(infotext,
212
 
                                           ignoreline=DEFAULT_IGNORE_LINE,
213
 
                                           start_message=None,
214
 
                                           tmpdir=None):
215
 
    """Create temp file and write commit template in it.
216
 
 
217
 
    :param infotext: Text to be displayed at bottom of message for the
218
 
        user's reference; currently similar to 'bzr status'.  The text is
219
 
        already encoded.
220
 
 
221
 
    :param ignoreline:  The separator to use above the infotext.
222
 
 
223
 
    :param start_message: The text to place above the separator, if any.
224
 
        This will not be removed from the message after the user has edited
225
 
        it.  The string is already encoded
226
 
 
227
 
    :return:    2-tuple (temp file name, hasinfo)
228
 
    """
229
 
    import tempfile
230
 
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
231
 
                                               dir=tmpdir, text=True)
232
 
    msgfile = os.fdopen(tmp_fileno, 'w')
233
 
    try:
234
 
        if start_message is not None:
235
 
            msgfile.write("%s\n" % start_message)
236
 
 
237
 
        if infotext is not None and infotext != "":
238
 
            hasinfo = True
239
 
            msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
240
 
        else:
241
 
            hasinfo = False
242
 
    finally:
243
 
        msgfile.close()
244
 
 
245
 
    return (msgfilename, hasinfo)
246
 
 
247
 
 
248
 
def make_commit_message_template(working_tree, specific_files):
249
 
    """Prepare a template file for a commit into a branch.
250
 
 
251
 
    Returns a unicode string containing the template.
252
 
    """
253
 
    # TODO: make provision for this to be overridden or modified by a hook
254
 
    #
255
 
    # TODO: Rather than running the status command, should prepare a draft of
256
 
    # the revision to be committed, then pause and ask the user to
257
 
    # confirm/write a message.
258
 
    from StringIO import StringIO       # must be unicode-safe
259
 
    from bzrlib.status import show_tree_status
260
 
    status_tmp = StringIO()
261
 
    show_tree_status(working_tree, specific_files=specific_files,
262
 
                     to_file=status_tmp, verbose=True)
263
 
    return status_tmp.getvalue()
264
 
 
265
 
 
266
 
def make_commit_message_template_encoded(working_tree, specific_files,
267
 
                                         diff=None, output_encoding='utf-8'):
268
 
    """Prepare a template file for a commit into a branch.
269
 
 
270
 
    Returns an encoded string.
271
 
    """
272
 
    # TODO: make provision for this to be overridden or modified by a hook
273
 
    #
274
 
    # TODO: Rather than running the status command, should prepare a draft of
275
 
    # the revision to be committed, then pause and ask the user to
276
 
    # confirm/write a message.
277
 
    from StringIO import StringIO       # must be unicode-safe
278
 
    from bzrlib.diff import show_diff_trees
279
 
 
280
 
    template = make_commit_message_template(working_tree, specific_files)
281
 
    template = template.encode(output_encoding, "replace")
282
 
 
283
 
    if diff:
284
 
        stream = StringIO()
285
 
        show_diff_trees(working_tree.basis_tree(),
286
 
                        working_tree, stream, specific_files,
287
 
                        path_encoding=output_encoding)
288
 
        template = template + '\n' + stream.getvalue()
289
 
 
290
 
    return template
291
 
 
292
 
 
293
 
class MessageEditorHooks(Hooks):
294
 
    """A dictionary mapping hook name to a list of callables for message editor
295
 
    hooks.
296
 
 
297
 
    e.g. ['commit_message_template'] is the list of items to be called to
298
 
    generate a commit message template
299
 
    """
300
 
 
301
 
    def __init__(self):
302
 
        """Create the default hooks.
303
 
 
304
 
        These are all empty initially.
305
 
        """
306
 
        Hooks.__init__(self, "bzrlib.msgeditor", "hooks")
307
 
        self.add_hook('set_commit_message',
308
 
            "Set a fixed commit message. "
309
 
            "set_commit_message is called with the "
310
 
            "bzrlib.commit.Commit object (so you can also change e.g. revision "
311
 
            "properties by editing commit.builder._revprops) and the message "
312
 
            "so far. set_commit_message must return the message to use or None"
313
 
            " if it should use the message editor as normal.", (2, 4))
314
 
        self.add_hook('commit_message_template',
315
 
            "Called when a commit message is being generated. "
316
 
            "commit_message_template is called with the bzrlib.commit.Commit "
317
 
            "object and the message that is known so far. "
318
 
            "commit_message_template must return a new message to use (which "
319
 
            "could be the same as it was given). When there are multiple "
320
 
            "hooks registered for commit_message_template, they are chained "
321
 
            "with the result from the first passed into the second, and so "
322
 
            "on.", (1, 10))
323
 
 
324
 
 
325
 
hooks = MessageEditorHooks()
326
 
 
327
 
 
328
 
def set_commit_message(commit, start_message=None):
329
 
    """Sets the commit message.
330
 
    :param commit: Commit object for the active commit.
331
 
    :return: The commit message or None to continue using the message editor
332
 
    """
333
 
    start_message = None
334
 
    for hook in hooks['set_commit_message']:
335
 
        start_message = hook(commit, start_message)
336
 
    return start_message
337
 
 
338
 
 
339
 
def generate_commit_message_template(commit, start_message=None):
340
 
    """Generate a commit message template.
341
 
 
342
 
    :param commit: Commit object for the active commit.
343
 
    :param start_message: Message to start with.
344
 
    :return: A start commit message or None for an empty start commit message.
345
 
    """
346
 
    start_message = None
347
 
    for hook in hooks['commit_message_template']:
348
 
        start_message = hook(commit, start_message)
349
 
    return start_message
 
127
        try: os.unlink(msgfilename)
 
128
        except IOError: pass
 
129