/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005-2011 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
 
17
18
"""Commit message editor support."""
18
19
 
19
 
from __future__ import absolute_import
20
 
 
21
20
import codecs
22
21
import os
23
22
from subprocess import call
24
23
import sys
25
24
 
26
 
from . import (
27
 
    cmdline,
 
25
from bzrlib import (
28
26
    config,
29
27
    osutils,
30
28
    trace,
31
29
    transport,
32
30
    ui,
33
31
    )
34
 
from .errors import BzrError
35
 
from .hooks import Hooks
36
 
from .sixish import (
37
 
    StringIO,
38
 
    )
39
 
 
40
 
 
41
 
class BadCommitMessageEncoding(BzrError):
42
 
 
43
 
    _fmt = 'The specified commit message contains characters unsupported by '\
44
 
        'the current encoding.'
 
32
from bzrlib.errors import BzrError, BadCommitMessageEncoding
 
33
from bzrlib.hooks import HookPoint, Hooks
45
34
 
46
35
 
47
36
def _get_editor():
48
37
    """Return a sequence of possible editor binaries for the current platform"""
49
38
    try:
50
 
        yield os.environ["BRZ_EDITOR"], '$BRZ_EDITOR'
 
39
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
51
40
    except KeyError:
52
41
        pass
53
42
 
54
 
    e = config.GlobalStack().get('editor')
 
43
    e = config.GlobalConfig().get_editor()
55
44
    if e is not None:
56
45
        yield e, config.config_filename()
57
46
 
70
59
def _run_editor(filename):
71
60
    """Try to execute an editor to edit the commit message."""
72
61
    for candidate, candidate_source in _get_editor():
73
 
        edargs = cmdline.split(candidate)
 
62
        edargs = candidate.split(' ')
74
63
        try:
75
64
            ## mutter("trying editor: %r", (edargs +[filename]))
76
65
            x = call(edargs + [filename])
77
 
        except OSError as e:
 
66
        except OSError, e:
78
67
            if candidate_source is not None:
79
68
                # We tried this editor because some user configuration (an
80
69
                # environment variable or config file) said to try it.  Let
91
80
        else:
92
81
            break
93
82
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
94
 
                   " - $BRZ_EDITOR\n - editor=/some/path in %s\n"
 
83
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n"
95
84
                   " - $VISUAL\n - $EDITOR" % \
96
85
                    config.config_filename())
97
86
 
154
143
        if not msgfilename:
155
144
            return None
156
145
        basename = osutils.basename(msgfilename)
157
 
        msg_transport = transport.get_transport_from_path(osutils.dirname(msgfilename))
 
146
        msg_transport = transport.get_transport(osutils.dirname(msgfilename))
158
147
        reference_content = msg_transport.get_bytes(basename)
159
148
        if not _run_editor(msgfilename):
160
149
            return None
161
150
        edited_content = msg_transport.get_bytes(basename)
162
151
        if edited_content == reference_content:
163
 
            if not ui.ui_factory.confirm_action(
164
 
                u"Commit message was not edited, use anyway",
165
 
                "breezy.msgeditor.unchanged",
166
 
                {}):
 
152
            if not ui.ui_factory.get_boolean(
 
153
                "Commit message was not edited, use anyway"):
167
154
                # Returning "" makes cmd_commit raise 'empty commit message
168
155
                # specified' which is a reasonable error, given the user has
169
156
                # rejected using the unedited template.
173
160
        lastline, nlines = 0, 0
174
161
        # codecs.open() ALWAYS opens file in binary mode but we need text mode
175
162
        # 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
176
 
        f = open(msgfilename, 'rU')
 
163
        f = file(msgfilename, 'rU')
177
164
        try:
178
165
            try:
179
166
                for line in codecs.getreader(osutils.get_user_encoding())(f):
212
199
        if msgfilename is not None:
213
200
            try:
214
201
                os.unlink(msgfilename)
215
 
            except IOError as e:
 
202
            except IOError, e:
216
203
                trace.warning(
217
204
                    "failed to unlink %s: %s; ignored", msgfilename, e)
218
205
 
219
206
 
220
207
def _create_temp_file_with_commit_template(infotext,
221
208
                                           ignoreline=DEFAULT_IGNORE_LINE,
222
 
                                           start_message=None,
223
 
                                           tmpdir=None):
 
209
                                           start_message=None):
224
210
    """Create temp file and write commit template in it.
225
211
 
226
 
    :param infotext: Text to be displayed at bottom of message for the
227
 
        user's reference; currently similar to 'bzr status'.  The text is
228
 
        already encoded.
 
212
    :param infotext:    Text to be displayed at bottom of message
 
213
                        for the user's reference;
 
214
                        currently similar to 'bzr status'.
 
215
                        The text is already encoded.
229
216
 
230
217
    :param ignoreline:  The separator to use above the infotext.
231
218
 
232
 
    :param start_message: The text to place above the separator, if any.
233
 
        This will not be removed from the message after the user has edited
234
 
        it.  The string is already encoded
 
219
    :param start_message:   The text to place above the separator, if any.
 
220
                            This will not be removed from the message
 
221
                            after the user has edited it.
 
222
                            The string is already encoded
235
223
 
236
224
    :return:    2-tuple (temp file name, hasinfo)
237
225
    """
238
226
    import tempfile
239
227
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
240
 
                                               dir=tmpdir, text=True)
 
228
                                               dir='.',
 
229
                                               text=True)
 
230
    msgfilename = osutils.basename(msgfilename)
241
231
    msgfile = os.fdopen(tmp_fileno, 'w')
242
232
    try:
243
233
        if start_message is not None:
264
254
    # TODO: Rather than running the status command, should prepare a draft of
265
255
    # the revision to be committed, then pause and ask the user to
266
256
    # confirm/write a message.
267
 
    from .status import show_tree_status
 
257
    from StringIO import StringIO       # must be unicode-safe
 
258
    from bzrlib.status import show_tree_status
268
259
    status_tmp = StringIO()
269
260
    show_tree_status(working_tree, specific_files=specific_files,
270
261
                     to_file=status_tmp, verbose=True)
282
273
    # TODO: Rather than running the status command, should prepare a draft of
283
274
    # the revision to be committed, then pause and ask the user to
284
275
    # confirm/write a message.
285
 
    from .diff import show_diff_trees
 
276
    from StringIO import StringIO       # must be unicode-safe
 
277
    from bzrlib.diff import show_diff_trees
286
278
 
287
279
    template = make_commit_message_template(working_tree, specific_files)
288
280
    template = template.encode(output_encoding, "replace")
310
302
 
311
303
        These are all empty initially.
312
304
        """
313
 
        Hooks.__init__(self, "breezy.msgeditor", "hooks")
314
 
        self.add_hook('set_commit_message',
315
 
            "Set a fixed commit message. "
316
 
            "set_commit_message is called with the "
317
 
            "breezy.commit.Commit object (so you can also change e.g. revision "
318
 
            "properties by editing commit.builder._revprops) and the message "
319
 
            "so far. set_commit_message must return the message to use or None"
320
 
            " if it should use the message editor as normal.", (2, 4))
321
 
        self.add_hook('commit_message_template',
 
305
        Hooks.__init__(self)
 
306
        self.create_hook(HookPoint('commit_message_template',
322
307
            "Called when a commit message is being generated. "
323
 
            "commit_message_template is called with the breezy.commit.Commit "
 
308
            "commit_message_template is called with the bzrlib.commit.Commit "
324
309
            "object and the message that is known so far. "
325
310
            "commit_message_template must return a new message to use (which "
326
 
            "could be the same as it was given). When there are multiple "
 
311
            "could be the same as it was given. When there are multiple "
327
312
            "hooks registered for commit_message_template, they are chained "
328
313
            "with the result from the first passed into the second, and so "
329
 
            "on.", (1, 10))
 
314
            "on.", (1, 10), None))
330
315
 
331
316
 
332
317
hooks = MessageEditorHooks()
333
318
 
334
319
 
335
 
def set_commit_message(commit, start_message=None):
336
 
    """Sets the commit message.
337
 
    :param commit: Commit object for the active commit.
338
 
    :return: The commit message or None to continue using the message editor
339
 
    """
340
 
    start_message = None
341
 
    for hook in hooks['set_commit_message']:
342
 
        start_message = hook(commit, start_message)
343
 
    return start_message
344
 
 
345
 
 
346
320
def generate_commit_message_template(commit, start_message=None):
347
321
    """Generate a commit message template.
348
322