← 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-05-06 23:54:05 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506235405-wii4elupfhzl3jvy
Add __str__ to the new helper classes.

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
28
 
from bzrlib import osutils
 
25
from bzrlib import (
 
26
    config,
 
27
    osutils,
 
28
    trace,
 
29
    transport,
 
30
    ui,
 
31
    )
29
32
from bzrlib.errors import BzrError, BadCommitMessageEncoding
30
 
from bzrlib.trace import warning, mutter
 
33
from bzrlib.hooks import HookPoint, Hooks
31
34
 
32
35
 
33
36
def _get_editor():
34
37
    """Return a sequence of possible editor binaries for the current platform"""
35
38
    try:
36
 
        yield os.environ["BZR_EDITOR"]
 
39
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
37
40
    except KeyError:
38
41
        pass
39
42
 
40
43
    e = config.GlobalConfig().get_editor()
41
44
    if e is not None:
42
 
        yield e
43
 
        
 
45
        yield e, config.config_filename()
 
46
 
44
47
    for varname in 'VISUAL', 'EDITOR':
45
48
        if varname in os.environ:
46
 
            yield os.environ[varname]
 
49
            yield os.environ[varname], '$' + varname
47
50
 
48
51
    if sys.platform == 'win32':
49
52
        for editor in 'wordpad.exe', 'notepad.exe':
50
 
            yield editor
 
53
            yield editor, None
51
54
    else:
52
55
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
53
 
            yield editor
 
56
            yield editor, None
54
57
 
55
58
 
56
59
def _run_editor(filename):
57
60
    """Try to execute an editor to edit the commit message."""
58
 
    for e in _get_editor():
59
 
        edargs = e.split(' ')
 
61
    for candidate, candidate_source in _get_editor():
 
62
        edargs = candidate.split(' ')
60
63
        try:
61
64
            ## mutter("trying editor: %r", (edargs +[filename]))
62
65
            x = call(edargs + [filename])
63
66
        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
            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
67
75
            raise
68
76
        if x == 0:
69
77
            return True
102
110
    """
103
111
 
104
112
    if not start_message is None:
105
 
        start_message = start_message.encode(bzrlib.user_encoding)
106
 
    infotext = infotext.encode(bzrlib.user_encoding, 'replace')
 
113
        start_message = start_message.encode(osutils.get_user_encoding())
 
114
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
107
115
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
108
116
 
109
117
 
132
140
    try:
133
141
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
134
142
                                    infotext, ignoreline, start_message)
135
 
 
136
 
        if not msgfilename or not _run_editor(msgfilename):
137
 
            return None
138
 
        
 
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 ""
139
158
        started = False
140
159
        msg = []
141
160
        lastline, nlines = 0, 0
144
163
        f = file(msgfilename, 'rU')
145
164
        try:
146
165
            try:
147
 
                for line in codecs.getreader(bzrlib.user_encoding)(f):
 
166
                for line in codecs.getreader(osutils.get_user_encoding())(f):
148
167
                    stripped_line = line.strip()
149
168
                    # strip empty line before the log message starts
150
169
                    if not started:
181
200
            try:
182
201
                os.unlink(msgfilename)
183
202
            except IOError, e:
184
 
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
 
203
                trace.warning(
 
204
                    "failed to unlink %s: %s; ignored", msgfilename, e)
185
205
 
186
206
 
187
207
def _create_temp_file_with_commit_template(infotext,
237
257
    from StringIO import StringIO       # must be unicode-safe
238
258
    from bzrlib.status import show_tree_status
239
259
    status_tmp = StringIO()
240
 
    show_tree_status(working_tree, specific_files=specific_files, 
241
 
                     to_file=status_tmp)
 
260
    show_tree_status(working_tree, specific_files=specific_files,
 
261
                     to_file=status_tmp, verbose=True)
242
262
    return status_tmp.getvalue()
243
263
 
244
264
 
267
287
        template = template + '\n' + stream.getvalue()
268
288
 
269
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