← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: John Arbash Meinel
  • Date: 2010-08-02 17:16:12 UTC
  • mto: This revision was merged to the branch mainline in revision 5369.
  • Revision ID: john@arbash-meinel.com-20100802171612-rdh5ods70w2bl3j7
We also have to re-implement it for _simple_set_pyx.pyx

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."""
19
19
 
20
20
import codecs
21
 
import errno
22
21
import os
23
22
from subprocess import call
24
23
import sys
25
24
 
26
 
import bzrlib
27
 
import bzrlib.config as config
 
25
from bzrlib import (
 
26
    config,
 
27
    osutils,
 
28
    trace,
 
29
    transport,
 
30
    ui,
 
31
    )
28
32
from bzrlib.errors import BzrError, BadCommitMessageEncoding
29
 
from bzrlib.trace import warning, mutter
 
33
from bzrlib.hooks import HookPoint, Hooks
30
34
 
31
35
 
32
36
def _get_editor():
33
37
    """Return a sequence of possible editor binaries for the current platform"""
34
38
    try:
35
 
        yield os.environ["BZR_EDITOR"]
 
39
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
36
40
    except KeyError:
37
41
        pass
38
42
 
39
43
    e = config.GlobalConfig().get_editor()
40
44
    if e is not None:
41
 
        yield e
42
 
        
 
45
        yield e, config.config_filename()
 
46
 
43
47
    for varname in 'VISUAL', 'EDITOR':
44
48
        if varname in os.environ:
45
 
            yield os.environ[varname]
 
49
            yield os.environ[varname], '$' + varname
46
50
 
47
51
    if sys.platform == 'win32':
48
52
        for editor in 'wordpad.exe', 'notepad.exe':
49
 
            yield editor
 
53
            yield editor, None
50
54
    else:
51
55
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
52
 
            yield editor
 
56
            yield editor, None
53
57
 
54
58
 
55
59
def _run_editor(filename):
56
60
    """Try to execute an editor to edit the commit message."""
57
 
    for e in _get_editor():
58
 
        edargs = e.split(' ')
 
61
    for candidate, candidate_source in _get_editor():
 
62
        edargs = candidate.split(' ')
59
63
        try:
60
64
            ## mutter("trying editor: %r", (edargs +[filename]))
61
65
            x = call(edargs + [filename])
62
66
        except OSError, e:
63
 
           # We're searching for an editor, so catch safe errors and continue
64
 
           if e.errno in (errno.ENOENT, ):
65
 
               continue
66
 
           raise
 
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
 
75
            raise
67
76
        if x == 0:
68
77
            return True
69
78
        elif x == 127:
101
110
    """
102
111
 
103
112
    if not start_message is None:
104
 
        start_message = start_message.encode(bzrlib.user_encoding)
105
 
    return edit_commit_message_encoded(infotext.encode(bzrlib.user_encoding),
106
 
                                       ignoreline, start_message)
 
113
        start_message = start_message.encode(osutils.get_user_encoding())
 
114
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
 
115
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
107
116
 
108
117
 
109
118
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
131
140
    try:
132
141
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
133
142
                                    infotext, ignoreline, start_message)
134
 
 
135
 
        if not msgfilename or not _run_editor(msgfilename):
136
 
            return None
137
 
        
 
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 ""
138
158
        started = False
139
159
        msg = []
140
160
        lastline, nlines = 0, 0
143
163
        f = file(msgfilename, 'rU')
144
164
        try:
145
165
            try:
146
 
                for line in codecs.getreader(bzrlib.user_encoding)(f):
 
166
                for line in codecs.getreader(osutils.get_user_encoding())(f):
147
167
                    stripped_line = line.strip()
148
168
                    # strip empty line before the log message starts
149
169
                    if not started:
180
200
            try:
181
201
                os.unlink(msgfilename)
182
202
            except IOError, e:
183
 
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
 
203
                trace.warning(
 
204
                    "failed to unlink %s: %s; ignored", msgfilename, e)
184
205
 
185
206
 
186
207
def _create_temp_file_with_commit_template(infotext,
204
225
    """
205
226
    import tempfile
206
227
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
207
 
                                               dir=u'.',
 
228
                                               dir='.',
208
229
                                               text=True)
 
230
    msgfilename = osutils.basename(msgfilename)
209
231
    msgfile = os.fdopen(tmp_fileno, 'w')
210
232
    try:
211
233
        if start_message is not None:
235
257
    from StringIO import StringIO       # must be unicode-safe
236
258
    from bzrlib.status import show_tree_status
237
259
    status_tmp = StringIO()
238
 
    show_tree_status(working_tree, specific_files=specific_files, 
239
 
                     to_file=status_tmp)
 
260
    show_tree_status(working_tree, specific_files=specific_files,
 
261
                     to_file=status_tmp, verbose=True)
240
262
    return status_tmp.getvalue()
241
263
 
242
264
 
265
287
        template = template + '\n' + stream.getvalue()
266
288
 
267
289
    return template
 
290
 
 
291
 
 
292
class MessageEditorHooks(Hooks):
 
293
    """A dictionary mapping hook name to a list of callables for message editor
 
294
    hooks.
 
295
 
 
296
    e.g. ['commit_message_template'] is the list of items to be called to
 
297
    generate a commit message template
 
298
    """
 
299
 
 
300
    def __init__(self):
 
301
        """Create the default hooks.
 
302
 
 
303
        These are all empty initially.
 
304
        """
 
305
        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))
 
315
 
 
316
 
 
317
hooks = MessageEditorHooks()
 
318
 
 
319
 
 
320
def generate_commit_message_template(commit, start_message=None):
 
321
    """Generate a commit message template.
 
322
 
 
323
    :param commit: Commit object for the active commit.
 
324
    :param start_message: Message to start with.
 
325
    :return: A start commit message or None for an empty start commit message.
 
326
    """
 
327
    start_message = None
 
328
    for hook in hooks['commit_message_template']:
 
329
        start_message = hook(commit, start_message)
 
330
    return start_message