← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-09-01 08:02:42 UTC
  • mfrom: (5390.3.3 faster-revert-593560)
  • Revision ID: pqm@pqm.ubuntu.com-20100901080242-esg62ody4frwmy66
(spiv) Avoid repeatedly calling self.target.all_file_ids() in
 InterTree.iter_changes. (Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

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