← 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-02-17 17:11:16 UTC
  • mfrom: (4797.2.17 2.1)
  • mto: (4797.2.18 2.1)
  • mto: This revision was merged to the branch mainline in revision 5055.
  • Revision ID: john@arbash-meinel.com-20100217171116-h7t9223ystbnx5h8
merge bzr.2.1 in preparation for NEWS entry.

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
 
26
from bzrlib import (
 
27
    config,
 
28
    osutils,
 
29
    trace,
 
30
    )
28
31
from bzrlib.errors import BzrError, BadCommitMessageEncoding
29
 
from bzrlib.trace import warning, mutter
 
32
from bzrlib.hooks import HookPoint, Hooks
30
33
 
31
34
 
32
35
def _get_editor():
33
36
    """Return a sequence of possible editor binaries for the current platform"""
34
37
    try:
35
 
        yield os.environ["BZR_EDITOR"]
 
38
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
36
39
    except KeyError:
37
40
        pass
38
41
 
39
42
    e = config.GlobalConfig().get_editor()
40
43
    if e is not None:
41
 
        yield e
42
 
        
 
44
        yield e, config.config_filename()
 
45
 
43
46
    for varname in 'VISUAL', 'EDITOR':
44
47
        if varname in os.environ:
45
 
            yield os.environ[varname]
 
48
            yield os.environ[varname], '$' + varname
46
49
 
47
50
    if sys.platform == 'win32':
48
51
        for editor in 'wordpad.exe', 'notepad.exe':
49
 
            yield editor
 
52
            yield editor, None
50
53
    else:
51
54
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
52
 
            yield editor
 
55
            yield editor, None
53
56
 
54
57
 
55
58
def _run_editor(filename):
56
59
    """Try to execute an editor to edit the commit message."""
57
 
    for e in _get_editor():
58
 
        edargs = e.split(' ')
 
60
    for candidate, candidate_source in _get_editor():
 
61
        edargs = candidate.split(' ')
59
62
        try:
60
63
            ## mutter("trying editor: %r", (edargs +[filename]))
61
64
            x = call(edargs + [filename])
62
65
        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
 
66
            if candidate_source is not None:
 
67
                # We tried this editor because some user configuration (an
 
68
                # environment variable or config file) said to try it.  Let
 
69
                # the user know their configuration is broken.
 
70
                trace.warning(
 
71
                    'Could not start editor "%s" (specified by %s): %s\n'
 
72
                    % (candidate, candidate_source, str(e)))
 
73
            continue
 
74
            raise
67
75
        if x == 0:
68
76
            return True
69
77
        elif x == 127:
101
109
    """
102
110
 
103
111
    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)
 
112
        start_message = start_message.encode(osutils.get_user_encoding())
 
113
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
 
114
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
107
115
 
108
116
 
109
117
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
134
142
 
135
143
        if not msgfilename or not _run_editor(msgfilename):
136
144
            return None
137
 
        
 
145
 
138
146
        started = False
139
147
        msg = []
140
148
        lastline, nlines = 0, 0
143
151
        f = file(msgfilename, 'rU')
144
152
        try:
145
153
            try:
146
 
                for line in codecs.getreader(bzrlib.user_encoding)(f):
 
154
                for line in codecs.getreader(osutils.get_user_encoding())(f):
147
155
                    stripped_line = line.strip()
148
156
                    # strip empty line before the log message starts
149
157
                    if not started:
180
188
            try:
181
189
                os.unlink(msgfilename)
182
190
            except IOError, e:
183
 
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
 
191
                trace.warning(
 
192
                    "failed to unlink %s: %s; ignored", msgfilename, e)
184
193
 
185
194
 
186
195
def _create_temp_file_with_commit_template(infotext,
204
213
    """
205
214
    import tempfile
206
215
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
207
 
                                               dir=u'.',
 
216
                                               dir='.',
208
217
                                               text=True)
 
218
    msgfilename = osutils.basename(msgfilename)
209
219
    msgfile = os.fdopen(tmp_fileno, 'w')
210
220
    try:
211
221
        if start_message is not None:
235
245
    from StringIO import StringIO       # must be unicode-safe
236
246
    from bzrlib.status import show_tree_status
237
247
    status_tmp = StringIO()
238
 
    show_tree_status(working_tree, specific_files=specific_files, 
239
 
                     to_file=status_tmp)
 
248
    show_tree_status(working_tree, specific_files=specific_files,
 
249
                     to_file=status_tmp, verbose=True)
240
250
    return status_tmp.getvalue()
241
251
 
242
252
 
265
275
        template = template + '\n' + stream.getvalue()
266
276
 
267
277
    return template
 
278
 
 
279
 
 
280
class MessageEditorHooks(Hooks):
 
281
    """A dictionary mapping hook name to a list of callables for message editor
 
282
    hooks.
 
283
 
 
284
    e.g. ['commit_message_template'] is the list of items to be called to
 
285
    generate a commit message template
 
286
    """
 
287
 
 
288
    def __init__(self):
 
289
        """Create the default hooks.
 
290
 
 
291
        These are all empty initially.
 
292
        """
 
293
        Hooks.__init__(self)
 
294
        self.create_hook(HookPoint('commit_message_template',
 
295
            "Called when a commit message is being generated. "
 
296
            "commit_message_template is called with the bzrlib.commit.Commit "
 
297
            "object and the message that is known so far. "
 
298
            "commit_message_template must return a new message to use (which "
 
299
            "could be the same as it was given. When there are multiple "
 
300
            "hooks registered for commit_message_template, they are chained "
 
301
            "with the result from the first passed into the second, and so "
 
302
            "on.", (1, 10), None))
 
303
 
 
304
 
 
305
hooks = MessageEditorHooks()
 
306
 
 
307
 
 
308
def generate_commit_message_template(commit, start_message=None):
 
309
    """Generate a commit message template.
 
310
 
 
311
    :param commit: Commit object for the active commit.
 
312
    :param start_message: Message to start with.
 
313
    :return: A start commit message or None for an empty start commit message.
 
314
    """
 
315
    start_message = None
 
316
    for hook in hooks['commit_message_template']:
 
317
        start_message = hook(commit, start_message)
 
318
    return start_message