← 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: 2009-01-13 03:06:36 UTC
  • mfrom: (3932.2.3 1.11)
  • mto: This revision was merged to the branch mainline in revision 3937.
  • Revision ID: mbp@sourcefrog.net-20090113030636-dqx4t8yaaqgdvam5
Merge 1.11rc1

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, 2006 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
32
from bzrlib.hooks import Hooks
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
        
49
46
    for varname in 'VISUAL', 'EDITOR':
50
47
        if varname in os.environ:
51
48
            yield os.environ[varname], '$' + varname
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])
68
65
        except OSError, e:
69
 
            if candidate_source is not None:
70
 
                # We tried this editor because some user configuration (an
71
 
                # environment variable or config file) said to try it.  Let
72
 
                # the user know their configuration is broken.
73
 
                trace.warning(
74
 
                    'Could not start editor "%s" (specified by %s): %s\n'
75
 
                    % (candidate, candidate_source, str(e)))
76
 
            continue
 
66
            # We're searching for an editor, so catch safe errors and continue
 
67
            if e.errno in (errno.ENOENT, errno.EACCES):
 
68
                if candidate_source is not None:
 
69
                    # We tried this editor because some user configuration (an
 
70
                    # environment variable or config file) said to try it.  Let
 
71
                    # the user know their configuration is broken.
 
72
                    trace.warning(
 
73
                        'Could not start editor "%s" (specified by %s): %s\n'
 
74
                        % (candidate, candidate_source, str(e)))
 
75
                continue
77
76
            raise
78
77
        if x == 0:
79
78
            return True
142
141
    try:
143
142
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
144
143
                                    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 ""
 
144
 
 
145
        if not msgfilename or not _run_editor(msgfilename):
 
146
            return None
 
147
        
162
148
        started = False
163
149
        msg = []
164
150
        lastline, nlines = 0, 0
210
196
 
211
197
def _create_temp_file_with_commit_template(infotext,
212
198
                                           ignoreline=DEFAULT_IGNORE_LINE,
213
 
                                           start_message=None,
214
 
                                           tmpdir=None):
 
199
                                           start_message=None):
215
200
    """Create temp file and write commit template in it.
216
201
 
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.
 
202
    :param infotext:    Text to be displayed at bottom of message
 
203
                        for the user's reference;
 
204
                        currently similar to 'bzr status'.
 
205
                        The text is already encoded.
220
206
 
221
207
    :param ignoreline:  The separator to use above the infotext.
222
208
 
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
 
209
    :param start_message:   The text to place above the separator, if any.
 
210
                            This will not be removed from the message
 
211
                            after the user has edited it.
 
212
                            The string is already encoded
226
213
 
227
214
    :return:    2-tuple (temp file name, hasinfo)
228
215
    """
229
216
    import tempfile
230
217
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
231
 
                                               dir=tmpdir, text=True)
 
218
                                               dir='.',
 
219
                                               text=True)
 
220
    msgfilename = osutils.basename(msgfilename)
232
221
    msgfile = os.fdopen(tmp_fileno, 'w')
233
222
    try:
234
223
        if start_message is not None:
258
247
    from StringIO import StringIO       # must be unicode-safe
259
248
    from bzrlib.status import show_tree_status
260
249
    status_tmp = StringIO()
261
 
    show_tree_status(working_tree, specific_files=specific_files,
262
 
                     to_file=status_tmp, verbose=True)
 
250
    show_tree_status(working_tree, specific_files=specific_files, 
 
251
                     to_file=status_tmp)
263
252
    return status_tmp.getvalue()
264
253
 
265
254
 
294
283
    """A dictionary mapping hook name to a list of callables for message editor
295
284
    hooks.
296
285
 
297
 
    e.g. ['commit_message_template'] is the list of items to be called to
 
286
    e.g. ['commit_message_template'] is the list of items to be called to 
298
287
    generate a commit message template
299
288
    """
300
289
 
303
292
 
304
293
        These are all empty initially.
305
294
        """
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',
315
 
            "Called when a commit message is being generated. "
316
 
            "commit_message_template is called with the bzrlib.commit.Commit "
317
 
            "object and the message that is known so far. "
318
 
            "commit_message_template must return a new message to use (which "
319
 
            "could be the same as it was given). When there are multiple "
320
 
            "hooks registered for commit_message_template, they are chained "
321
 
            "with the result from the first passed into the second, and so "
322
 
            "on.", (1, 10))
 
295
        Hooks.__init__(self)
 
296
        # Introduced in 1.10:
 
297
        # Invoked to generate the commit message template shown in the editor
 
298
        # The api signature is:
 
299
        # (commit, message), and the function should return the new message
 
300
        # There is currently no way to modify the order in which 
 
301
        # template hooks are invoked
 
302
        self['commit_message_template'] = []
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