← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Martin Pool
  • Date: 2010-02-25 06:17:27 UTC
  • mfrom: (5055 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5057.
  • Revision ID: mbp@sourcefrog.net-20100225061727-4sd9lt0qmdc6087t
merge news

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
18
18
"""Commit message editor support."""
19
19
 
20
20
import codecs
 
21
import errno
21
22
import os
22
23
from subprocess import call
23
24
import sys
24
25
 
25
26
from bzrlib import (
26
 
    cmdline,
27
27
    config,
28
28
    osutils,
29
29
    trace,
30
 
    transport,
31
 
    ui,
32
30
    )
33
31
from bzrlib.errors import BzrError, BadCommitMessageEncoding
34
 
from bzrlib.hooks import Hooks
 
32
from bzrlib.hooks import HookPoint, Hooks
35
33
 
36
34
 
37
35
def _get_editor():
41
39
    except KeyError:
42
40
        pass
43
41
 
44
 
    e = config.GlobalStack().get('editor')
 
42
    e = config.GlobalConfig().get_editor()
45
43
    if e is not None:
46
44
        yield e, config.config_filename()
47
45
 
60
58
def _run_editor(filename):
61
59
    """Try to execute an editor to edit the commit message."""
62
60
    for candidate, candidate_source in _get_editor():
63
 
        edargs = cmdline.split(candidate)
 
61
        edargs = candidate.split(' ')
64
62
        try:
65
63
            ## mutter("trying editor: %r", (edargs +[filename]))
66
64
            x = call(edargs + [filename])
141
139
    try:
142
140
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
143
141
                                    infotext, ignoreline, start_message)
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 ""
 
142
 
 
143
        if not msgfilename or not _run_editor(msgfilename):
 
144
            return None
 
145
 
161
146
        started = False
162
147
        msg = []
163
148
        lastline, nlines = 0, 0
209
194
 
210
195
def _create_temp_file_with_commit_template(infotext,
211
196
                                           ignoreline=DEFAULT_IGNORE_LINE,
212
 
                                           start_message=None,
213
 
                                           tmpdir=None):
 
197
                                           start_message=None):
214
198
    """Create temp file and write commit template in it.
215
199
 
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.
 
200
    :param infotext:    Text to be displayed at bottom of message
 
201
                        for the user's reference;
 
202
                        currently similar to 'bzr status'.
 
203
                        The text is already encoded.
219
204
 
220
205
    :param ignoreline:  The separator to use above the infotext.
221
206
 
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
 
207
    :param start_message:   The text to place above the separator, if any.
 
208
                            This will not be removed from the message
 
209
                            after the user has edited it.
 
210
                            The string is already encoded
225
211
 
226
212
    :return:    2-tuple (temp file name, hasinfo)
227
213
    """
228
214
    import tempfile
229
215
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
230
 
                                               dir=tmpdir, text=True)
 
216
                                               dir='.',
 
217
                                               text=True)
 
218
    msgfilename = osutils.basename(msgfilename)
231
219
    msgfile = os.fdopen(tmp_fileno, 'w')
232
220
    try:
233
221
        if start_message is not None:
302
290
 
303
291
        These are all empty initially.
304
292
        """
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',
 
293
        Hooks.__init__(self)
 
294
        self.create_hook(HookPoint('commit_message_template',
314
295
            "Called when a commit message is being generated. "
315
296
            "commit_message_template is called with the bzrlib.commit.Commit "
316
297
            "object and the message that is known so far. "
317
298
            "commit_message_template must return a new message to use (which "
318
 
            "could be the same as it was given). When there are multiple "
 
299
            "could be the same as it was given. When there are multiple "
319
300
            "hooks registered for commit_message_template, they are chained "
320
301
            "with the result from the first passed into the second, and so "
321
 
            "on.", (1, 10))
 
302
            "on.", (1, 10), None))
322
303
 
323
304
 
324
305
hooks = MessageEditorHooks()
325
306
 
326
307
 
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
 
 
338
308
def generate_commit_message_template(commit, start_message=None):
339
309
    """Generate a commit message template.
340
310