← 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: 2015-09-30 16:43:21 UTC
  • mfrom: (6603.2.2 fix-keep-dirty)
  • Revision ID: pqm@pqm.ubuntu.com-20150930164321-ct2v2qnmvimqt8qf
(vila) Avoid associating dirty patch headers with the previous file in the
 patch. (Colin Watson)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005-2010 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
32
    ui,
32
33
    )
33
34
from bzrlib.errors import BzrError, BadCommitMessageEncoding
34
 
from bzrlib.hooks import HookPoint, Hooks
 
35
from bzrlib.hooks import Hooks
35
36
 
36
37
 
37
38
def _get_editor():
41
42
    except KeyError:
42
43
        pass
43
44
 
44
 
    e = config.GlobalConfig().get_editor()
 
45
    e = config.GlobalStack().get('editor')
45
46
    if e is not None:
46
47
        yield e, config.config_filename()
47
48
 
60
61
def _run_editor(filename):
61
62
    """Try to execute an editor to edit the commit message."""
62
63
    for candidate, candidate_source in _get_editor():
63
 
        edargs = candidate.split(' ')
 
64
        edargs = cmdline.split(candidate)
64
65
        try:
65
66
            ## mutter("trying editor: %r", (edargs +[filename]))
66
67
            x = call(edargs + [filename])
144
145
        if not msgfilename:
145
146
            return None
146
147
        basename = osutils.basename(msgfilename)
147
 
        msg_transport = transport.get_transport(osutils.dirname(msgfilename))
 
148
        msg_transport = transport.get_transport_from_path(osutils.dirname(msgfilename))
148
149
        reference_content = msg_transport.get_bytes(basename)
149
150
        if not _run_editor(msgfilename):
150
151
            return None
151
152
        edited_content = msg_transport.get_bytes(basename)
152
153
        if edited_content == reference_content:
153
 
            if not ui.ui_factory.get_boolean(
154
 
                "Commit message was not edited, use anyway"):
 
154
            if not ui.ui_factory.confirm_action(
 
155
                u"Commit message was not edited, use anyway",
 
156
                "bzrlib.msgeditor.unchanged",
 
157
                {}):
155
158
                # Returning "" makes cmd_commit raise 'empty commit message
156
159
                # specified' which is a reasonable error, given the user has
157
160
                # rejected using the unedited template.
207
210
 
208
211
def _create_temp_file_with_commit_template(infotext,
209
212
                                           ignoreline=DEFAULT_IGNORE_LINE,
210
 
                                           start_message=None):
 
213
                                           start_message=None,
 
214
                                           tmpdir=None):
211
215
    """Create temp file and write commit template in it.
212
216
 
213
 
    :param infotext:    Text to be displayed at bottom of message
214
 
                        for the user's reference;
215
 
                        currently similar to 'bzr status'.
216
 
                        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.
217
220
 
218
221
    :param ignoreline:  The separator to use above the infotext.
219
222
 
220
 
    :param start_message:   The text to place above the separator, if any.
221
 
                            This will not be removed from the message
222
 
                            after the user has edited it.
223
 
                            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
224
226
 
225
227
    :return:    2-tuple (temp file name, hasinfo)
226
228
    """
227
229
    import tempfile
228
230
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
229
 
                                               dir='.',
230
 
                                               text=True)
231
 
    msgfilename = osutils.basename(msgfilename)
 
231
                                               dir=tmpdir, text=True)
232
232
    msgfile = os.fdopen(tmp_fileno, 'w')
233
233
    try:
234
234
        if start_message is not None:
303
303
 
304
304
        These are all empty initially.
305
305
        """
306
 
        Hooks.__init__(self)
307
 
        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',
308
315
            "Called when a commit message is being generated. "
309
316
            "commit_message_template is called with the bzrlib.commit.Commit "
310
317
            "object and the message that is known so far. "
311
318
            "commit_message_template must return a new message to use (which "
312
 
            "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 "
313
320
            "hooks registered for commit_message_template, they are chained "
314
321
            "with the result from the first passed into the second, and so "
315
 
            "on.", (1, 10), None))
 
322
            "on.", (1, 10))
316
323
 
317
324
 
318
325
hooks = MessageEditorHooks()
319
326
 
320
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
 
321
339
def generate_commit_message_template(commit, start_message=None):
322
340
    """Generate a commit message template.
323
341