← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Vincent Ladeuil
  • Date: 2012-03-13 17:25:29 UTC
  • mfrom: (6499 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6501.
  • Revision ID: v.ladeuil+lp@free.fr-20120313172529-i0suyjnepsor25i7
Merge trunk

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