← 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: 2010-04-08 04:34:03 UTC
  • mfrom: (5138 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5139.
  • Revision ID: robertc@robertcollins.net-20100408043403-56z0d07vdqrx7f3t
Update bugfix for 528114 to trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005, 2006 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
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
18
"""Commit message editor support."""
23
23
from subprocess import call
24
24
import sys
25
25
 
26
 
import bzrlib
27
 
import bzrlib.config as config
28
 
from bzrlib import osutils
 
26
from bzrlib import (
 
27
    config,
 
28
    osutils,
 
29
    trace,
 
30
    transport,
 
31
    ui,
 
32
    )
29
33
from bzrlib.errors import BzrError, BadCommitMessageEncoding
30
 
from bzrlib.trace import warning, mutter
 
34
from bzrlib.hooks import HookPoint, Hooks
31
35
 
32
36
 
33
37
def _get_editor():
34
38
    """Return a sequence of possible editor binaries for the current platform"""
35
39
    try:
36
 
        yield os.environ["BZR_EDITOR"]
 
40
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
37
41
    except KeyError:
38
42
        pass
39
43
 
40
44
    e = config.GlobalConfig().get_editor()
41
45
    if e is not None:
42
 
        yield e
43
 
        
 
46
        yield e, config.config_filename()
 
47
 
44
48
    for varname in 'VISUAL', 'EDITOR':
45
49
        if varname in os.environ:
46
 
            yield os.environ[varname]
 
50
            yield os.environ[varname], '$' + varname
47
51
 
48
52
    if sys.platform == 'win32':
49
53
        for editor in 'wordpad.exe', 'notepad.exe':
50
 
            yield editor
 
54
            yield editor, None
51
55
    else:
52
56
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
53
 
            yield editor
 
57
            yield editor, None
54
58
 
55
59
 
56
60
def _run_editor(filename):
57
61
    """Try to execute an editor to edit the commit message."""
58
 
    for e in _get_editor():
59
 
        edargs = e.split(' ')
 
62
    for candidate, candidate_source in _get_editor():
 
63
        edargs = candidate.split(' ')
60
64
        try:
61
65
            ## mutter("trying editor: %r", (edargs +[filename]))
62
66
            x = call(edargs + [filename])
63
67
        except OSError, e:
64
 
           # We're searching for an editor, so catch safe errors and continue
65
 
           if e.errno in (errno.ENOENT, ):
66
 
               continue
67
 
           raise
 
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
 
76
            raise
68
77
        if x == 0:
69
78
            return True
70
79
        elif x == 127:
102
111
    """
103
112
 
104
113
    if not start_message is None:
105
 
        start_message = start_message.encode(bzrlib.user_encoding)
106
 
    infotext = infotext.encode(bzrlib.user_encoding, 'replace')
 
114
        start_message = start_message.encode(osutils.get_user_encoding())
 
115
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
107
116
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
108
117
 
109
118
 
132
141
    try:
133
142
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
134
143
                                    infotext, ignoreline, start_message)
135
 
 
136
 
        if not msgfilename or not _run_editor(msgfilename):
137
 
            return None
138
 
        
 
144
        if not msgfilename:
 
145
            return None
 
146
        basename = osutils.basename(msgfilename)
 
147
        msg_transport = transport.get_transport(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.get_boolean(
 
154
                "Commit message was not edited, use anyway"):
 
155
                # Returning "" makes cmd_commit raise 'empty commit message
 
156
                # specified' which is a reasonable error, given the user has
 
157
                # rejected using the unedited template.
 
158
                return ""
139
159
        started = False
140
160
        msg = []
141
161
        lastline, nlines = 0, 0
144
164
        f = file(msgfilename, 'rU')
145
165
        try:
146
166
            try:
147
 
                for line in codecs.getreader(bzrlib.user_encoding)(f):
 
167
                for line in codecs.getreader(osutils.get_user_encoding())(f):
148
168
                    stripped_line = line.strip()
149
169
                    # strip empty line before the log message starts
150
170
                    if not started:
181
201
            try:
182
202
                os.unlink(msgfilename)
183
203
            except IOError, e:
184
 
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
 
204
                trace.warning(
 
205
                    "failed to unlink %s: %s; ignored", msgfilename, e)
185
206
 
186
207
 
187
208
def _create_temp_file_with_commit_template(infotext,
237
258
    from StringIO import StringIO       # must be unicode-safe
238
259
    from bzrlib.status import show_tree_status
239
260
    status_tmp = StringIO()
240
 
    show_tree_status(working_tree, specific_files=specific_files, 
241
 
                     to_file=status_tmp)
 
261
    show_tree_status(working_tree, specific_files=specific_files,
 
262
                     to_file=status_tmp, verbose=True)
242
263
    return status_tmp.getvalue()
243
264
 
244
265
 
267
288
        template = template + '\n' + stream.getvalue()
268
289
 
269
290
    return template
 
291
 
 
292
 
 
293
class MessageEditorHooks(Hooks):
 
294
    """A dictionary mapping hook name to a list of callables for message editor
 
295
    hooks.
 
296
 
 
297
    e.g. ['commit_message_template'] is the list of items to be called to
 
298
    generate a commit message template
 
299
    """
 
300
 
 
301
    def __init__(self):
 
302
        """Create the default hooks.
 
303
 
 
304
        These are all empty initially.
 
305
        """
 
306
        Hooks.__init__(self)
 
307
        self.create_hook(HookPoint('commit_message_template',
 
308
            "Called when a commit message is being generated. "
 
309
            "commit_message_template is called with the bzrlib.commit.Commit "
 
310
            "object and the message that is known so far. "
 
311
            "commit_message_template must return a new message to use (which "
 
312
            "could be the same as it was given. When there are multiple "
 
313
            "hooks registered for commit_message_template, they are chained "
 
314
            "with the result from the first passed into the second, and so "
 
315
            "on.", (1, 10), None))
 
316
 
 
317
 
 
318
hooks = MessageEditorHooks()
 
319
 
 
320
 
 
321
def generate_commit_message_template(commit, start_message=None):
 
322
    """Generate a commit message template.
 
323
 
 
324
    :param commit: Commit object for the active commit.
 
325
    :param start_message: Message to start with.
 
326
    :return: A start commit message or None for an empty start commit message.
 
327
    """
 
328
    start_message = None
 
329
    for hook in hooks['commit_message_template']:
 
330
        start_message = hook(commit, start_message)
 
331
    return start_message