← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-12-12 01:24:50 UTC
  • mfrom: (3882.4.2 doc-hacking)
  • Revision ID: pqm@pqm.ubuntu.com-20081212012450-3gw576prpztxziib
(mbp) Developer documentation about when to add new exception classes

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
25
26
from bzrlib import (
26
27
    config,
27
28
    osutils,
28
 
    trace,
29
 
    transport,
30
 
    ui,
31
29
    )
32
30
from bzrlib.errors import BzrError, BadCommitMessageEncoding
33
 
from bzrlib.hooks import HookPoint, Hooks
 
31
from bzrlib.hooks import Hooks
 
32
from bzrlib.trace import warning, mutter
34
33
 
35
34
 
36
35
def _get_editor():
37
36
    """Return a sequence of possible editor binaries for the current platform"""
38
37
    try:
39
 
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
 
38
        yield os.environ["BZR_EDITOR"]
40
39
    except KeyError:
41
40
        pass
42
41
 
43
42
    e = config.GlobalConfig().get_editor()
44
43
    if e is not None:
45
 
        yield e, config.config_filename()
46
 
 
 
44
        yield e
 
45
        
47
46
    for varname in 'VISUAL', 'EDITOR':
48
47
        if varname in os.environ:
49
 
            yield os.environ[varname], '$' + varname
 
48
            yield os.environ[varname]
50
49
 
51
50
    if sys.platform == 'win32':
52
51
        for editor in 'wordpad.exe', 'notepad.exe':
53
 
            yield editor, None
 
52
            yield editor
54
53
    else:
55
54
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
56
 
            yield editor, None
 
55
            yield editor
57
56
 
58
57
 
59
58
def _run_editor(filename):
60
59
    """Try to execute an editor to edit the commit message."""
61
 
    for candidate, candidate_source in _get_editor():
62
 
        edargs = candidate.split(' ')
 
60
    for e in _get_editor():
 
61
        edargs = e.split(' ')
63
62
        try:
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, ):
 
68
                continue
75
69
            raise
76
70
        if x == 0:
77
71
            return True
140
134
    try:
141
135
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
142
136
                                    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 ""
 
137
 
 
138
        if not msgfilename or not _run_editor(msgfilename):
 
139
            return None
 
140
        
158
141
        started = False
159
142
        msg = []
160
143
        lastline, nlines = 0, 0
200
183
            try:
201
184
                os.unlink(msgfilename)
202
185
            except IOError, e:
203
 
                trace.warning(
204
 
                    "failed to unlink %s: %s; ignored", msgfilename, e)
 
186
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
205
187
 
206
188
 
207
189
def _create_temp_file_with_commit_template(infotext,
257
239
    from StringIO import StringIO       # must be unicode-safe
258
240
    from bzrlib.status import show_tree_status
259
241
    status_tmp = StringIO()
260
 
    show_tree_status(working_tree, specific_files=specific_files,
261
 
                     to_file=status_tmp, verbose=True)
 
242
    show_tree_status(working_tree, specific_files=specific_files, 
 
243
                     to_file=status_tmp)
262
244
    return status_tmp.getvalue()
263
245
 
264
246
 
293
275
    """A dictionary mapping hook name to a list of callables for message editor
294
276
    hooks.
295
277
 
296
 
    e.g. ['commit_message_template'] is the list of items to be called to
 
278
    e.g. ['commit_message_template'] is the list of items to be called to 
297
279
    generate a commit message template
298
280
    """
299
281
 
303
285
        These are all empty initially.
304
286
        """
305
287
        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))
 
288
        # Introduced in 1.10:
 
289
        # Invoked to generate the commit message template shown in the editor
 
290
        # The api signature is:
 
291
        # (commit, message), and the function should return the new message
 
292
        # There is currently no way to modify the order in which 
 
293
        # template hooks are invoked
 
294
        self['commit_message_template'] = []
315
295
 
316
296
 
317
297
hooks = MessageEditorHooks()