← 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-03-25 00:02:51 UTC
  • mfrom: (5106.1.1 version-bump)
  • Revision ID: pqm@pqm.ubuntu.com-20100325000251-bwsv5c5d3l9x3lnn
(Jelmer) Bump API version for 2.2.0.

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
 
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,
28
27
    config,
29
28
    osutils,
30
29
    trace,
31
 
    transport,
32
 
    ui,
33
30
    )
34
31
from bzrlib.errors import BzrError, BadCommitMessageEncoding
35
 
from bzrlib.hooks import Hooks
 
32
from bzrlib.hooks import HookPoint, Hooks
36
33
 
37
34
 
38
35
def _get_editor():
42
39
    except KeyError:
43
40
        pass
44
41
 
45
 
    e = config.GlobalStack().get('editor')
 
42
    e = config.GlobalConfig().get_editor()
46
43
    if e is not None:
47
44
        yield e, config.config_filename()
48
45
 
61
58
def _run_editor(filename):
62
59
    """Try to execute an editor to edit the commit message."""
63
60
    for candidate, candidate_source in _get_editor():
64
 
        edargs = cmdline.split(candidate)
 
61
        edargs = candidate.split(' ')
65
62
        try:
66
63
            ## mutter("trying editor: %r", (edargs +[filename]))
67
64
            x = call(edargs + [filename])
142
139
    try:
143
140
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
144
141
                                    infotext, ignoreline, start_message)
145
 
        if not msgfilename:
146
 
            return None
147
 
        basename = osutils.basename(msgfilename)
148
 
        msg_transport = transport.get_transport_from_path(osutils.dirname(msgfilename))
149
 
        reference_content = msg_transport.get_bytes(basename)
150
 
        if not _run_editor(msgfilename):
151
 
            return None
152
 
        edited_content = msg_transport.get_bytes(basename)
153
 
        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
 
                {}):
158
 
                # Returning "" makes cmd_commit raise 'empty commit message
159
 
                # specified' which is a reasonable error, given the user has
160
 
                # rejected using the unedited template.
161
 
                return ""
 
142
 
 
143
        if not msgfilename or not _run_editor(msgfilename):
 
144
            return None
 
145
 
162
146
        started = False
163
147
        msg = []
164
148
        lastline, nlines = 0, 0
210
194
 
211
195
def _create_temp_file_with_commit_template(infotext,
212
196
                                           ignoreline=DEFAULT_IGNORE_LINE,
213
 
                                           start_message=None,
214
 
                                           tmpdir=None):
 
197
                                           start_message=None):
215
198
    """Create temp file and write commit template in it.
216
199
 
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.
 
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.
220
204
 
221
205
    :param ignoreline:  The separator to use above the infotext.
222
206
 
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
 
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
226
211
 
227
212
    :return:    2-tuple (temp file name, hasinfo)
228
213
    """
229
214
    import tempfile
230
215
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
231
 
                                               dir=tmpdir, text=True)
 
216
                                               dir='.',
 
217
                                               text=True)
 
218
    msgfilename = osutils.basename(msgfilename)
232
219
    msgfile = os.fdopen(tmp_fileno, 'w')
233
220
    try:
234
221
        if start_message is not None:
303
290
 
304
291
        These are all empty initially.
305
292
        """
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',
 
293
        Hooks.__init__(self)
 
294
        self.create_hook(HookPoint('commit_message_template',
315
295
            "Called when a commit message is being generated. "
316
296
            "commit_message_template is called with the bzrlib.commit.Commit "
317
297
            "object and the message that is known so far. "
318
298
            "commit_message_template must return a new message to use (which "
319
 
            "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 "
320
300
            "hooks registered for commit_message_template, they are chained "
321
301
            "with the result from the first passed into the second, and so "
322
 
            "on.", (1, 10))
 
302
            "on.", (1, 10), None))
323
303
 
324
304
 
325
305
hooks = MessageEditorHooks()
326
306
 
327
307
 
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
308
def generate_commit_message_template(commit, start_message=None):
340
309
    """Generate a commit message template.
341
310