← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Robert Collins
  • Date: 2009-02-20 08:26:50 UTC
  • mto: This revision was merged to the branch mainline in revision 4028.
  • Revision ID: robertc@robertcollins.net-20090220082650-wmzch4en338bymkm
Cherrypick and polish the RemoteSink for streaming push.

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, 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
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
26
27
    config,
27
28
    osutils,
28
29
    trace,
29
 
    transport,
30
 
    ui,
31
30
    )
32
31
from bzrlib.errors import BzrError, BadCommitMessageEncoding
33
 
from bzrlib.hooks import HookPoint, Hooks
 
32
from bzrlib.hooks import Hooks
34
33
 
35
34
 
36
35
def _get_editor():
43
42
    e = config.GlobalConfig().get_editor()
44
43
    if e is not None:
45
44
        yield e, config.config_filename()
46
 
 
 
45
        
47
46
    for varname in 'VISUAL', 'EDITOR':
48
47
        if varname in os.environ:
49
48
            yield os.environ[varname], '$' + varname
64
63
            ## mutter("trying editor: %r", (edargs +[filename]))
65
64
            x = call(edargs + [filename])
66
65
        except OSError, e:
67
 
            if candidate_source is not None:
68
 
                # We tried this editor because some user configuration (an
69
 
                # environment variable or config file) said to try it.  Let
70
 
                # the user know their configuration is broken.
71
 
                trace.warning(
72
 
                    'Could not start editor "%s" (specified by %s): %s\n'
73
 
                    % (candidate, candidate_source, str(e)))
74
 
            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
75
76
            raise
76
77
        if x == 0:
77
78
            return True
140
141
    try:
141
142
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
142
143
                                    infotext, ignoreline, start_message)
143
 
        if not msgfilename:
144
 
            return None
145
 
        basename = osutils.basename(msgfilename)
146
 
        msg_transport = transport.get_transport(osutils.dirname(msgfilename))
147
 
        reference_content = msg_transport.get_bytes(basename)
148
 
        if not _run_editor(msgfilename):
149
 
            return None
150
 
        edited_content = msg_transport.get_bytes(basename)
151
 
        if edited_content == reference_content:
152
 
            if not ui.ui_factory.get_boolean(
153
 
                "Commit message was not edited, use anyway"):
154
 
                # Returning "" makes cmd_commit raise 'empty commit message
155
 
                # specified' which is a reasonable error, given the user has
156
 
                # rejected using the unedited template.
157
 
                return ""
 
144
 
 
145
        if not msgfilename or not _run_editor(msgfilename):
 
146
            return None
 
147
        
158
148
        started = False
159
149
        msg = []
160
150
        lastline, nlines = 0, 0
257
247
    from StringIO import StringIO       # must be unicode-safe
258
248
    from bzrlib.status import show_tree_status
259
249
    status_tmp = StringIO()
260
 
    show_tree_status(working_tree, specific_files=specific_files,
 
250
    show_tree_status(working_tree, specific_files=specific_files, 
261
251
                     to_file=status_tmp, verbose=True)
262
252
    return status_tmp.getvalue()
263
253
 
293
283
    """A dictionary mapping hook name to a list of callables for message editor
294
284
    hooks.
295
285
 
296
 
    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 
297
287
    generate a commit message template
298
288
    """
299
289
 
303
293
        These are all empty initially.
304
294
        """
305
295
        Hooks.__init__(self)
306
 
        self.create_hook(HookPoint('commit_message_template',
307
 
            "Called when a commit message is being generated. "
308
 
            "commit_message_template is called with the bzrlib.commit.Commit "
309
 
            "object and the message that is known so far. "
310
 
            "commit_message_template must return a new message to use (which "
311
 
            "could be the same as it was given. When there are multiple "
312
 
            "hooks registered for commit_message_template, they are chained "
313
 
            "with the result from the first passed into the second, and so "
314
 
            "on.", (1, 10), None))
 
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'] = []
315
303
 
316
304
 
317
305
hooks = MessageEditorHooks()