← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
18
"""Commit message editor support."""
19
19
 
20
20
import codecs
21
 
import errno
22
21
import os
23
22
from subprocess import call
24
23
import sys
25
24
 
26
25
from bzrlib import (
 
26
    cmdline,
27
27
    config,
28
28
    osutils,
29
29
    trace,
 
30
    transport,
 
31
    ui,
30
32
    )
31
33
from bzrlib.errors import BzrError, BadCommitMessageEncoding
32
34
from bzrlib.hooks import Hooks
39
41
    except KeyError:
40
42
        pass
41
43
 
42
 
    e = config.GlobalConfig().get_editor()
 
44
    e = config.GlobalStack().get('editor')
43
45
    if e is not None:
44
46
        yield e, config.config_filename()
45
 
        
 
47
 
46
48
    for varname in 'VISUAL', 'EDITOR':
47
49
        if varname in os.environ:
48
50
            yield os.environ[varname], '$' + varname
58
60
def _run_editor(filename):
59
61
    """Try to execute an editor to edit the commit message."""
60
62
    for candidate, candidate_source in _get_editor():
61
 
        edargs = candidate.split(' ')
 
63
        edargs = cmdline.split(candidate)
62
64
        try:
63
65
            ## mutter("trying editor: %r", (edargs +[filename]))
64
66
            x = call(edargs + [filename])
65
67
        except OSError, e:
66
 
            # We're searching for an editor, so catch safe errors and continue
67
 
            if e.errno in (errno.ENOENT, errno.EACCES):
68
 
                if candidate_source is not None:
69
 
                    # We tried this editor because some user configuration (an
70
 
                    # environment variable or config file) said to try it.  Let
71
 
                    # the user know their configuration is broken.
72
 
                    trace.warning(
73
 
                        'Could not start editor "%s" (specified by %s): %s\n'
74
 
                        % (candidate, candidate_source, str(e)))
75
 
                continue
 
68
            if candidate_source is not None:
 
69
                # We tried this editor because some user configuration (an
 
70
                # environment variable or config file) said to try it.  Let
 
71
                # the user know their configuration is broken.
 
72
                trace.warning(
 
73
                    'Could not start editor "%s" (specified by %s): %s\n'
 
74
                    % (candidate, candidate_source, str(e)))
 
75
            continue
76
76
            raise
77
77
        if x == 0:
78
78
            return True
141
141
    try:
142
142
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
143
143
                                    infotext, ignoreline, start_message)
144
 
 
145
 
        if not msgfilename or not _run_editor(msgfilename):
146
 
            return None
147
 
        
 
144
        if not msgfilename:
 
145
            return None
 
146
        basename = osutils.basename(msgfilename)
 
147
        msg_transport = transport.get_transport_from_path(osutils.dirname(msgfilename))
 
148
        reference_content = msg_transport.get_bytes(basename)
 
149
        if not _run_editor(msgfilename):
 
150
            return None
 
151
        edited_content = msg_transport.get_bytes(basename)
 
152
        if edited_content == reference_content:
 
153
            if not ui.ui_factory.confirm_action(
 
154
                u"Commit message was not edited, use anyway",
 
155
                "bzrlib.msgeditor.unchanged",
 
156
                {}):
 
157
                # Returning "" makes cmd_commit raise 'empty commit message
 
158
                # specified' which is a reasonable error, given the user has
 
159
                # rejected using the unedited template.
 
160
                return ""
148
161
        started = False
149
162
        msg = []
150
163
        lastline, nlines = 0, 0
196
209
 
197
210
def _create_temp_file_with_commit_template(infotext,
198
211
                                           ignoreline=DEFAULT_IGNORE_LINE,
199
 
                                           start_message=None):
 
212
                                           start_message=None,
 
213
                                           tmpdir=None):
200
214
    """Create temp file and write commit template in it.
201
215
 
202
 
    :param infotext:    Text to be displayed at bottom of message
203
 
                        for the user's reference;
204
 
                        currently similar to 'bzr status'.
205
 
                        The text is already encoded.
 
216
    :param infotext: Text to be displayed at bottom of message for the
 
217
        user's reference; currently similar to 'bzr status'.  The text is
 
218
        already encoded.
206
219
 
207
220
    :param ignoreline:  The separator to use above the infotext.
208
221
 
209
 
    :param start_message:   The text to place above the separator, if any.
210
 
                            This will not be removed from the message
211
 
                            after the user has edited it.
212
 
                            The string is already encoded
 
222
    :param start_message: The text to place above the separator, if any.
 
223
        This will not be removed from the message after the user has edited
 
224
        it.  The string is already encoded
213
225
 
214
226
    :return:    2-tuple (temp file name, hasinfo)
215
227
    """
216
228
    import tempfile
217
229
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
218
 
                                               dir='.',
219
 
                                               text=True)
220
 
    msgfilename = osutils.basename(msgfilename)
 
230
                                               dir=tmpdir, text=True)
221
231
    msgfile = os.fdopen(tmp_fileno, 'w')
222
232
    try:
223
233
        if start_message is not None:
247
257
    from StringIO import StringIO       # must be unicode-safe
248
258
    from bzrlib.status import show_tree_status
249
259
    status_tmp = StringIO()
250
 
    show_tree_status(working_tree, specific_files=specific_files, 
 
260
    show_tree_status(working_tree, specific_files=specific_files,
251
261
                     to_file=status_tmp, verbose=True)
252
262
    return status_tmp.getvalue()
253
263
 
283
293
    """A dictionary mapping hook name to a list of callables for message editor
284
294
    hooks.
285
295
 
286
 
    e.g. ['commit_message_template'] is the list of items to be called to 
 
296
    e.g. ['commit_message_template'] is the list of items to be called to
287
297
    generate a commit message template
288
298
    """
289
299
 
292
302
 
293
303
        These are all empty initially.
294
304
        """
295
 
        Hooks.__init__(self)
296
 
        # Introduced in 1.10:
297
 
        # Invoked to generate the commit message template shown in the editor
298
 
        # The api signature is:
299
 
        # (commit, message), and the function should return the new message
300
 
        # There is currently no way to modify the order in which 
301
 
        # template hooks are invoked
302
 
        self['commit_message_template'] = []
 
305
        Hooks.__init__(self, "bzrlib.msgeditor", "hooks")
 
306
        self.add_hook('set_commit_message',
 
307
            "Set a fixed commit message. "
 
308
            "set_commit_message is called with the "
 
309
            "bzrlib.commit.Commit object (so you can also change e.g. revision "
 
310
            "properties by editing commit.builder._revprops) and the message "
 
311
            "so far. set_commit_message must return the message to use or None"
 
312
            " if it should use the message editor as normal.", (2, 4))
 
313
        self.add_hook('commit_message_template',
 
314
            "Called when a commit message is being generated. "
 
315
            "commit_message_template is called with the bzrlib.commit.Commit "
 
316
            "object and the message that is known so far. "
 
317
            "commit_message_template must return a new message to use (which "
 
318
            "could be the same as it was given). When there are multiple "
 
319
            "hooks registered for commit_message_template, they are chained "
 
320
            "with the result from the first passed into the second, and so "
 
321
            "on.", (1, 10))
303
322
 
304
323
 
305
324
hooks = MessageEditorHooks()
306
325
 
307
326
 
 
327
def set_commit_message(commit, start_message=None):
 
328
    """Sets the commit message.
 
329
    :param commit: Commit object for the active commit.
 
330
    :return: The commit message or None to continue using the message editor
 
331
    """
 
332
    start_message = None
 
333
    for hook in hooks['set_commit_message']:
 
334
        start_message = hook(commit, start_message)
 
335
    return start_message
 
336
 
 
337
 
308
338
def generate_commit_message_template(commit, start_message=None):
309
339
    """Generate a commit message template.
310
340