← 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: 2011-08-17 18:13:57 UTC
  • mfrom: (5268.7.29 transport-segments)
  • Revision ID: pqm@pqm.ubuntu.com-20110817181357-y5q5eth1hk8bl3om
(jelmer) Allow specifying the colocated branch to use in the branch URL,
 and retrieving the branch name using ControlDir._get_selected_branch.
 (Jelmer Vernooij)

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-2011 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
    cmdline,
 
27
    config,
 
28
    osutils,
 
29
    trace,
 
30
    transport,
 
31
    ui,
 
32
    )
29
33
from bzrlib.errors import BzrError, BadCommitMessageEncoding
30
 
from bzrlib.trace import warning, mutter
 
34
from bzrlib.hooks import Hooks
31
35
 
32
36
 
33
37
def _get_editor():
34
38
    """Return a sequence of possible editor binaries for the current platform"""
35
39
    try:
36
 
        yield os.environ["BZR_EDITOR"]
 
40
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
37
41
    except KeyError:
38
42
        pass
39
43
 
40
 
    e = config.GlobalConfig().get_editor()
 
44
    e = config.GlobalStack().get('editor')
41
45
    if e is not None:
42
 
        yield e
43
 
        
 
46
        yield e, config.config_filename()
 
47
 
44
48
    for varname in 'VISUAL', 'EDITOR':
45
49
        if varname in os.environ:
46
 
            yield os.environ[varname]
 
50
            yield os.environ[varname], '$' + varname
47
51
 
48
52
    if sys.platform == 'win32':
49
53
        for editor in 'wordpad.exe', 'notepad.exe':
50
 
            yield editor
 
54
            yield editor, None
51
55
    else:
52
56
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
53
 
            yield editor
 
57
            yield editor, None
54
58
 
55
59
 
56
60
def _run_editor(filename):
57
61
    """Try to execute an editor to edit the commit message."""
58
 
    for e in _get_editor():
59
 
        edargs = e.split(' ')
 
62
    for candidate, candidate_source in _get_editor():
 
63
        edargs = cmdline.split(candidate)
60
64
        try:
61
65
            ## mutter("trying editor: %r", (edargs +[filename]))
62
66
            x = call(edargs + [filename])
63
67
        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
 
68
            if candidate_source is not None:
 
69
                # We tried this editor because some user configuration (an
 
70
                # environment variable or config file) said to try it.  Let
 
71
                # the user know their configuration is broken.
 
72
                trace.warning(
 
73
                    'Could not start editor "%s" (specified by %s): %s\n'
 
74
                    % (candidate, candidate_source, str(e)))
 
75
            continue
67
76
            raise
68
77
        if x == 0:
69
78
            return True
102
111
    """
103
112
 
104
113
    if not start_message is None:
105
 
        start_message = start_message.encode(bzrlib.user_encoding)
106
 
    infotext = infotext.encode(bzrlib.user_encoding, 'replace')
 
114
        start_message = start_message.encode(osutils.get_user_encoding())
 
115
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
107
116
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
108
117
 
109
118
 
132
141
    try:
133
142
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
134
143
                                    infotext, ignoreline, start_message)
135
 
 
136
 
        if not msgfilename or not _run_editor(msgfilename):
137
 
            return None
138
 
        
 
144
        if not msgfilename:
 
145
            return None
 
146
        basename = osutils.basename(msgfilename)
 
147
        msg_transport = transport.get_transport_from_path(osutils.dirname(msgfilename))
 
148
        reference_content = msg_transport.get_bytes(basename)
 
149
        if not _run_editor(msgfilename):
 
150
            return None
 
151
        edited_content = msg_transport.get_bytes(basename)
 
152
        if edited_content == reference_content:
 
153
            if not ui.ui_factory.confirm_action(
 
154
                u"Commit message was not edited, use anyway",
 
155
                "bzrlib.msgeditor.unchanged",
 
156
                {}):
 
157
                # Returning "" makes cmd_commit raise 'empty commit message
 
158
                # specified' which is a reasonable error, given the user has
 
159
                # rejected using the unedited template.
 
160
                return ""
139
161
        started = False
140
162
        msg = []
141
163
        lastline, nlines = 0, 0
144
166
        f = file(msgfilename, 'rU')
145
167
        try:
146
168
            try:
147
 
                for line in codecs.getreader(bzrlib.user_encoding)(f):
 
169
                for line in codecs.getreader(osutils.get_user_encoding())(f):
148
170
                    stripped_line = line.strip()
149
171
                    # strip empty line before the log message starts
150
172
                    if not started:
181
203
            try:
182
204
                os.unlink(msgfilename)
183
205
            except IOError, e:
184
 
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
 
206
                trace.warning(
 
207
                    "failed to unlink %s: %s; ignored", msgfilename, e)
185
208
 
186
209
 
187
210
def _create_temp_file_with_commit_template(infotext,
188
211
                                           ignoreline=DEFAULT_IGNORE_LINE,
189
 
                                           start_message=None):
 
212
                                           start_message=None,
 
213
                                           tmpdir=None):
190
214
    """Create temp file and write commit template in it.
191
215
 
192
 
    :param infotext:    Text to be displayed at bottom of message
193
 
                        for the user's reference;
194
 
                        currently similar to 'bzr status'.
195
 
                        The text is already encoded.
 
216
    :param infotext: Text to be displayed at bottom of message for the
 
217
        user's reference; currently similar to 'bzr status'.  The text is
 
218
        already encoded.
196
219
 
197
220
    :param ignoreline:  The separator to use above the infotext.
198
221
 
199
 
    :param start_message:   The text to place above the separator, if any.
200
 
                            This will not be removed from the message
201
 
                            after the user has edited it.
202
 
                            The string is already encoded
 
222
    :param start_message: The text to place above the separator, if any.
 
223
        This will not be removed from the message after the user has edited
 
224
        it.  The string is already encoded
203
225
 
204
226
    :return:    2-tuple (temp file name, hasinfo)
205
227
    """
206
228
    import tempfile
207
229
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
208
 
                                               dir='.',
209
 
                                               text=True)
210
 
    msgfilename = osutils.basename(msgfilename)
 
230
                                               dir=tmpdir, text=True)
211
231
    msgfile = os.fdopen(tmp_fileno, 'w')
212
232
    try:
213
233
        if start_message is not None:
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, "bzrlib.msgeditor", "hooks")
 
306
        self.add_hook('set_commit_message',
 
307
            "Set a fixed commit message. "
 
308
            "set_commit_message is called with the "
 
309
            "bzrlib.commit.Commit object (so you can also change e.g. revision "
 
310
            "properties by editing commit.builder._revprops) and the message "
 
311
            "so far. set_commit_message must return the message to use or None"
 
312
            " if it should use the message editor as normal.", (2, 4))
 
313
        self.add_hook('commit_message_template',
 
314
            "Called when a commit message is being generated. "
 
315
            "commit_message_template is called with the bzrlib.commit.Commit "
 
316
            "object and the message that is known so far. "
 
317
            "commit_message_template must return a new message to use (which "
 
318
            "could be the same as it was given). When there are multiple "
 
319
            "hooks registered for commit_message_template, they are chained "
 
320
            "with the result from the first passed into the second, and so "
 
321
            "on.", (1, 10))
 
322
 
 
323
 
 
324
hooks = MessageEditorHooks()
 
325
 
 
326
 
 
327
def set_commit_message(commit, start_message=None):
 
328
    """Sets the commit message.
 
329
    :param commit: Commit object for the active commit.
 
330
    :return: The commit message or None to continue using the message editor
 
331
    """
 
332
    start_message = None
 
333
    for hook in hooks['set_commit_message']:
 
334
        start_message = hook(commit, start_message)
 
335
    return start_message
 
336
 
 
337
 
 
338
def generate_commit_message_template(commit, start_message=None):
 
339
    """Generate a commit message template.
 
340
 
 
341
    :param commit: Commit object for the active commit.
 
342
    :param start_message: Message to start with.
 
343
    :return: A start commit message or None for an empty start commit message.
 
344
    """
 
345
    start_message = None
 
346
    for hook in hooks['commit_message_template']:
 
347
        start_message = hook(commit, start_message)
 
348
    return start_message