← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

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 import osutils
 
26
from bzrlib import (
 
27
    cmdline,
 
28
    config,
 
29
    osutils,
 
30
    trace,
 
31
    transport,
 
32
    ui,
 
33
    )
29
34
from bzrlib.errors import BzrError, BadCommitMessageEncoding
30
 
from bzrlib.trace import warning, mutter
 
35
from bzrlib.hooks import Hooks
31
36
 
32
37
 
33
38
def _get_editor():
34
39
    """Return a sequence of possible editor binaries for the current platform"""
35
40
    try:
36
 
        yield os.environ["BZR_EDITOR"]
 
41
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
37
42
    except KeyError:
38
43
        pass
39
44
 
40
 
    e = config.GlobalConfig().get_editor()
 
45
    e = config.GlobalStack().get('editor')
41
46
    if e is not None:
42
 
        yield e
43
 
        
 
47
        yield e, config.config_filename()
 
48
 
44
49
    for varname in 'VISUAL', 'EDITOR':
45
50
        if varname in os.environ:
46
 
            yield os.environ[varname]
 
51
            yield os.environ[varname], '$' + varname
47
52
 
48
53
    if sys.platform == 'win32':
49
54
        for editor in 'wordpad.exe', 'notepad.exe':
50
 
            yield editor
 
55
            yield editor, None
51
56
    else:
52
57
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
53
 
            yield editor
 
58
            yield editor, None
54
59
 
55
60
 
56
61
def _run_editor(filename):
57
62
    """Try to execute an editor to edit the commit message."""
58
 
    for e in _get_editor():
59
 
        edargs = e.split(' ')
 
63
    for candidate, candidate_source in _get_editor():
 
64
        edargs = cmdline.split(candidate)
60
65
        try:
61
66
            ## mutter("trying editor: %r", (edargs +[filename]))
62
67
            x = call(edargs + [filename])
63
68
        except OSError, e:
64
 
           # We're searching for an editor, so catch safe errors and continue
65
 
           if e.errno in (errno.ENOENT, ):
66
 
               continue
67
 
           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
68
78
        if x == 0:
69
79
            return True
70
80
        elif x == 127:
102
112
    """
103
113
 
104
114
    if not start_message is None:
105
 
        start_message = start_message.encode(bzrlib.user_encoding)
106
 
    infotext = infotext.encode(bzrlib.user_encoding, 'replace')
 
115
        start_message = start_message.encode(osutils.get_user_encoding())
 
116
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
107
117
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
108
118
 
109
119
 
132
142
    try:
133
143
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
134
144
                                    infotext, ignoreline, start_message)
135
 
 
136
 
        if not msgfilename or not _run_editor(msgfilename):
137
 
            return None
138
 
        
 
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)
 
150
        if not _run_editor(msgfilename):
 
151
            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 ""
139
162
        started = False
140
163
        msg = []
141
164
        lastline, nlines = 0, 0
144
167
        f = file(msgfilename, 'rU')
145
168
        try:
146
169
            try:
147
 
                for line in codecs.getreader(bzrlib.user_encoding)(f):
 
170
                for line in codecs.getreader(osutils.get_user_encoding())(f):
148
171
                    stripped_line = line.strip()
149
172
                    # strip empty line before the log message starts
150
173
                    if not started:
181
204
            try:
182
205
                os.unlink(msgfilename)
183
206
            except IOError, e:
184
 
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
 
207
                trace.warning(
 
208
                    "failed to unlink %s: %s; ignored", msgfilename, e)
185
209
 
186
210
 
187
211
def _create_temp_file_with_commit_template(infotext,
188
212
                                           ignoreline=DEFAULT_IGNORE_LINE,
189
 
                                           start_message=None):
 
213
                                           start_message=None,
 
214
                                           tmpdir=None):
190
215
    """Create temp file and write commit template in it.
191
216
 
192
 
    :param infotext:    Text to be displayed at bottom of message
193
 
                        for the user's reference;
194
 
                        currently similar to 'bzr status'.
195
 
                        The text is already encoded.
 
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.
196
220
 
197
221
    :param ignoreline:  The separator to use above the infotext.
198
222
 
199
 
    :param start_message:   The text to place above the separator, if any.
200
 
                            This will not be removed from the message
201
 
                            after the user has edited it.
202
 
                            The string is already encoded
 
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
203
226
 
204
227
    :return:    2-tuple (temp file name, hasinfo)
205
228
    """
206
229
    import tempfile
207
230
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
208
 
                                               dir='.',
209
 
                                               text=True)
210
 
    msgfilename = osutils.basename(msgfilename)
 
231
                                               dir=tmpdir, text=True)
211
232
    msgfile = os.fdopen(tmp_fileno, 'w')
212
233
    try:
213
234
        if start_message is not None:
237
258
    from StringIO import StringIO       # must be unicode-safe
238
259
    from bzrlib.status import show_tree_status
239
260
    status_tmp = StringIO()
240
 
    show_tree_status(working_tree, specific_files=specific_files, 
241
 
                     to_file=status_tmp)
 
261
    show_tree_status(working_tree, specific_files=specific_files,
 
262
                     to_file=status_tmp, verbose=True)
242
263
    return status_tmp.getvalue()
243
264
 
244
265
 
267
288
        template = template + '\n' + stream.getvalue()
268
289
 
269
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