← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

(jelmer) Use the absolute_import feature everywhere in bzrlib,
 and add a source test to make sure it's used everywhere. (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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
 
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
26
from bzrlib import (
 
27
    cmdline,
27
28
    config,
28
29
    osutils,
29
30
    trace,
 
31
    transport,
 
32
    ui,
30
33
    )
31
34
from bzrlib.errors import BzrError, BadCommitMessageEncoding
32
 
from bzrlib.hooks import HookPoint, Hooks
 
35
from bzrlib.hooks import Hooks
33
36
 
34
37
 
35
38
def _get_editor():
39
42
    except KeyError:
40
43
        pass
41
44
 
42
 
    e = config.GlobalConfig().get_editor()
 
45
    e = config.GlobalStack().get('editor')
43
46
    if e is not None:
44
47
        yield e, config.config_filename()
45
48
 
58
61
def _run_editor(filename):
59
62
    """Try to execute an editor to edit the commit message."""
60
63
    for candidate, candidate_source in _get_editor():
61
 
        edargs = candidate.split(' ')
 
64
        edargs = cmdline.split(candidate)
62
65
        try:
63
66
            ## mutter("trying editor: %r", (edargs +[filename]))
64
67
            x = call(edargs + [filename])
65
68
        except OSError, e:
66
 
            # We're searching for an editor, so catch safe errors and continue
67
 
            # errno 193 is ERROR_BAD_EXE_FORMAT on Windows. Python2.4 uses the
68
 
            # winerror for errno. Python2.5+ use errno ENOEXEC and set winerror
69
 
            # to 193. However, catching 193 here should be fine. Other
70
 
            # platforms aren't likely to have that high of an error. And even
71
 
            # if they do, it is still reasonable to fall back to the next
72
 
            # editor.
73
 
            if e.errno in (errno.ENOENT, errno.EACCES, errno.ENOEXEC, 193):
74
 
                if candidate_source is not None:
75
 
                    # We tried this editor because some user configuration (an
76
 
                    # environment variable or config file) said to try it.  Let
77
 
                    # the user know their configuration is broken.
78
 
                    trace.warning(
79
 
                        'Could not start editor "%s" (specified by %s): %s\n'
80
 
                        % (candidate, candidate_source, str(e)))
81
 
                continue
 
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
82
77
            raise
83
78
        if x == 0:
84
79
            return True
147
142
    try:
148
143
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
149
144
                                    infotext, ignoreline, start_message)
150
 
 
151
 
        if not msgfilename or not _run_editor(msgfilename):
152
 
            return None
153
 
 
 
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 ""
154
162
        started = False
155
163
        msg = []
156
164
        lastline, nlines = 0, 0
202
210
 
203
211
def _create_temp_file_with_commit_template(infotext,
204
212
                                           ignoreline=DEFAULT_IGNORE_LINE,
205
 
                                           start_message=None):
 
213
                                           start_message=None,
 
214
                                           tmpdir=None):
206
215
    """Create temp file and write commit template in it.
207
216
 
208
 
    :param infotext:    Text to be displayed at bottom of message
209
 
                        for the user's reference;
210
 
                        currently similar to 'bzr status'.
211
 
                        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.
212
220
 
213
221
    :param ignoreline:  The separator to use above the infotext.
214
222
 
215
 
    :param start_message:   The text to place above the separator, if any.
216
 
                            This will not be removed from the message
217
 
                            after the user has edited it.
218
 
                            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
219
226
 
220
227
    :return:    2-tuple (temp file name, hasinfo)
221
228
    """
222
229
    import tempfile
223
230
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
224
 
                                               dir='.',
225
 
                                               text=True)
226
 
    msgfilename = osutils.basename(msgfilename)
 
231
                                               dir=tmpdir, text=True)
227
232
    msgfile = os.fdopen(tmp_fileno, 'w')
228
233
    try:
229
234
        if start_message is not None:
298
303
 
299
304
        These are all empty initially.
300
305
        """
301
 
        Hooks.__init__(self)
302
 
        self.create_hook(HookPoint('commit_message_template',
 
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',
303
315
            "Called when a commit message is being generated. "
304
316
            "commit_message_template is called with the bzrlib.commit.Commit "
305
317
            "object and the message that is known so far. "
306
318
            "commit_message_template must return a new message to use (which "
307
 
            "could be the same as it was given. When there are multiple "
 
319
            "could be the same as it was given). When there are multiple "
308
320
            "hooks registered for commit_message_template, they are chained "
309
321
            "with the result from the first passed into the second, and so "
310
 
            "on.", (1, 10), None))
 
322
            "on.", (1, 10))
311
323
 
312
324
 
313
325
hooks = MessageEditorHooks()
314
326
 
315
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
 
316
339
def generate_commit_message_template(commit, start_message=None):
317
340
    """Generate a commit message template.
318
341