← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Alexander Belchenko
  • Date: 2007-10-26 21:49:15 UTC
  • mto: (2947.4.2 0.92)
  • mto: This revision was merged to the branch mainline in revision 2971.
  • Revision ID: bialix@ukr.net-20071026214915-5eacqh9k2ps6jagj
windows python-based installer: shortcut for uninstall action

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005, 2006, 2009 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."""
23
23
from subprocess import call
24
24
import sys
25
25
 
26
 
from bzrlib import (
27
 
    config,
28
 
    osutils,
29
 
    trace,
30
 
    )
 
26
import bzrlib
 
27
import bzrlib.config as config
31
28
from bzrlib.errors import BzrError, BadCommitMessageEncoding
32
 
from bzrlib.hooks import HookPoint, Hooks
 
29
from bzrlib.trace import warning, mutter
33
30
 
34
31
 
35
32
def _get_editor():
36
33
    """Return a sequence of possible editor binaries for the current platform"""
37
34
    try:
38
 
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
 
35
        yield os.environ["BZR_EDITOR"]
39
36
    except KeyError:
40
37
        pass
41
38
 
42
39
    e = config.GlobalConfig().get_editor()
43
40
    if e is not None:
44
 
        yield e, config.config_filename()
45
 
 
 
41
        yield e
 
42
        
46
43
    for varname in 'VISUAL', 'EDITOR':
47
44
        if varname in os.environ:
48
 
            yield os.environ[varname], '$' + varname
 
45
            yield os.environ[varname]
49
46
 
50
47
    if sys.platform == 'win32':
51
48
        for editor in 'wordpad.exe', 'notepad.exe':
52
 
            yield editor, None
 
49
            yield editor
53
50
    else:
54
51
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
55
 
            yield editor, None
 
52
            yield editor
56
53
 
57
54
 
58
55
def _run_editor(filename):
59
56
    """Try to execute an editor to edit the commit message."""
60
 
    for candidate, candidate_source in _get_editor():
61
 
        edargs = candidate.split(' ')
 
57
    for e in _get_editor():
 
58
        edargs = e.split(' ')
62
59
        try:
63
60
            ## mutter("trying editor: %r", (edargs +[filename]))
64
61
            x = call(edargs + [filename])
65
62
        except OSError, e:
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
 
63
           # We're searching for an editor, so catch safe errors and continue
 
64
           if e.errno in (errno.ENOENT, ):
 
65
               continue
 
66
           raise
75
67
        if x == 0:
76
68
            return True
77
69
        elif x == 127:
109
101
    """
110
102
 
111
103
    if not start_message is None:
112
 
        start_message = start_message.encode(osutils.get_user_encoding())
113
 
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
 
104
        start_message = start_message.encode(bzrlib.user_encoding)
 
105
    infotext = infotext.encode(bzrlib.user_encoding, 'replace')
114
106
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
115
107
 
116
108
 
142
134
 
143
135
        if not msgfilename or not _run_editor(msgfilename):
144
136
            return None
145
 
 
 
137
        
146
138
        started = False
147
139
        msg = []
148
140
        lastline, nlines = 0, 0
151
143
        f = file(msgfilename, 'rU')
152
144
        try:
153
145
            try:
154
 
                for line in codecs.getreader(osutils.get_user_encoding())(f):
 
146
                for line in codecs.getreader(bzrlib.user_encoding)(f):
155
147
                    stripped_line = line.strip()
156
148
                    # strip empty line before the log message starts
157
149
                    if not started:
188
180
            try:
189
181
                os.unlink(msgfilename)
190
182
            except IOError, e:
191
 
                trace.warning(
192
 
                    "failed to unlink %s: %s; ignored", msgfilename, e)
 
183
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
193
184
 
194
185
 
195
186
def _create_temp_file_with_commit_template(infotext,
213
204
    """
214
205
    import tempfile
215
206
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
216
 
                                               dir='.',
 
207
                                               dir=u'.',
217
208
                                               text=True)
218
 
    msgfilename = osutils.basename(msgfilename)
219
209
    msgfile = os.fdopen(tmp_fileno, 'w')
220
210
    try:
221
211
        if start_message is not None:
245
235
    from StringIO import StringIO       # must be unicode-safe
246
236
    from bzrlib.status import show_tree_status
247
237
    status_tmp = StringIO()
248
 
    show_tree_status(working_tree, specific_files=specific_files,
249
 
                     to_file=status_tmp, verbose=True)
 
238
    show_tree_status(working_tree, specific_files=specific_files, 
 
239
                     to_file=status_tmp)
250
240
    return status_tmp.getvalue()
251
241
 
252
242
 
275
265
        template = template + '\n' + stream.getvalue()
276
266
 
277
267
    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