← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: John Arbash Meinel
  • Date: 2013-05-19 14:29:37 UTC
  • mfrom: (6437.63.9 2.5)
  • mto: (6437.63.10 2.5)
  • mto: This revision was merged to the branch mainline in revision 6575.
  • Revision ID: john@arbash-meinel.com-20130519142937-21ykz2n2y2f22za9
Merge in the actual 2.5 branch. It seems I failed before

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
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
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
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
16
 
18
17
"""Commit message editor support."""
19
18
 
 
19
from __future__ import absolute_import
 
20
 
20
21
import codecs
21
 
import errno
22
22
import os
23
23
from subprocess import call
24
24
import sys
25
25
 
26
 
import bzrlib
27
 
import bzrlib.config as config
28
 
from bzrlib.errors import BzrError
29
 
from bzrlib.trace import warning, mutter
 
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
30
36
 
31
37
 
32
38
def _get_editor():
33
39
    """Return a sequence of possible editor binaries for the current platform"""
34
40
    try:
35
 
        yield os.environ["BZR_EDITOR"]
 
41
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
36
42
    except KeyError:
37
43
        pass
38
44
 
39
 
    e = config.GlobalConfig().get_editor()
 
45
    e = config.GlobalStack().get('editor')
40
46
    if e is not None:
41
 
        yield e
42
 
        
 
47
        yield e, config.config_filename()
 
48
 
43
49
    for varname in 'VISUAL', 'EDITOR':
44
50
        if varname in os.environ:
45
 
            yield os.environ[varname]
 
51
            yield os.environ[varname], '$' + varname
46
52
 
47
53
    if sys.platform == 'win32':
48
54
        for editor in 'wordpad.exe', 'notepad.exe':
49
 
            yield editor
 
55
            yield editor, None
50
56
    else:
51
57
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
52
 
            yield editor
 
58
            yield editor, None
53
59
 
54
60
 
55
61
def _run_editor(filename):
56
62
    """Try to execute an editor to edit the commit message."""
57
 
    for e in _get_editor():
58
 
        edargs = e.split(' ')
 
63
    for candidate, candidate_source in _get_editor():
 
64
        edargs = cmdline.split(candidate)
59
65
        try:
60
66
            ## mutter("trying editor: %r", (edargs +[filename]))
61
67
            x = call(edargs + [filename])
62
68
        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
 
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
67
78
        if x == 0:
68
79
            return True
69
80
        elif x == 127:
87
98
    This is run if they don't give a message or
88
99
    message-containing file on the command line.
89
100
 
90
 
    infotext:
91
 
        Text to be displayed at bottom of message for
92
 
        the user's reference; currently similar to
93
 
        'bzr status'.
94
 
 
95
 
    ignoreline:
96
 
        The separator to use above the infotext.
97
 
 
98
 
    start_message:
99
 
        The text to place above the separator, if any. This will not be
100
 
        removed from the message after the user has edited it.
101
 
    """
102
 
    import tempfile
103
 
 
 
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
    """
104
141
    msgfilename = None
105
142
    try:
106
 
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
107
 
        msgfile = os.fdopen(tmp_fileno, 'w')
108
 
        try:
109
 
            if start_message is not None:
110
 
                msgfile.write("%s\n" % start_message.encode(
111
 
                                           bzrlib.user_encoding, 'replace'))
112
 
 
113
 
            if infotext is not None and infotext != "":
114
 
                hasinfo = True
115
 
                msgfile.write("\n\n%s\n\n%s" % (ignoreline,
116
 
                              infotext.encode(bzrlib.user_encoding,
117
 
                                                    'replace')))
118
 
            else:
119
 
                hasinfo = False
120
 
        finally:
121
 
            msgfile.close()
122
 
 
 
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)
123
150
        if not _run_editor(msgfilename):
124
151
            return None
125
 
        
 
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 ""
126
162
        started = False
127
163
        msg = []
128
164
        lastline, nlines = 0, 0
129
 
        for line in codecs.open(msgfilename, 'r', bzrlib.user_encoding):
130
 
            stripped_line = line.strip()
131
 
            # strip empty line before the log message starts
132
 
            if not started:
133
 
                if stripped_line != "":
134
 
                    started = True
135
 
                else:
136
 
                    continue
137
 
            # check for the ignore line only if there
138
 
            # is additional information at the end
139
 
            if hasinfo and stripped_line == ignoreline:
140
 
                break
141
 
            nlines += 1
142
 
            # keep track of the last line that had some content
143
 
            if stripped_line != "":
144
 
                lastline = nlines
145
 
            msg.append(line)
146
 
            
 
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
 
147
192
        if len(msg) == 0:
148
193
            return ""
149
194
        # delete empty lines at the end
159
204
            try:
160
205
                os.unlink(msgfilename)
161
206
            except IOError, e:
162
 
                warning("failed to unlink %s: %s; ignored", msgfilename, 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)
163
246
 
164
247
 
165
248
def make_commit_message_template(working_tree, specific_files):
167
250
 
168
251
    Returns a unicode string containing the template.
169
252
    """
170
 
    # TODO: Should probably be given the WorkingTree not the branch
171
 
    #
172
253
    # TODO: make provision for this to be overridden or modified by a hook
173
254
    #
174
255
    # TODO: Rather than running the status command, should prepare a draft of
177
258
    from StringIO import StringIO       # must be unicode-safe
178
259
    from bzrlib.status import show_tree_status
179
260
    status_tmp = StringIO()
180
 
    show_tree_status(working_tree, specific_files=specific_files, 
181
 
                     to_file=status_tmp)
 
261
    show_tree_status(working_tree, specific_files=specific_files,
 
262
                     to_file=status_tmp, verbose=True)
182
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