/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: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

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, 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
"""Commit message editor support."""
18
19
 
19
20
import codecs
20
 
from io import (
21
 
    BytesIO,
22
 
    StringIO,
23
 
    )
 
21
import errno
24
22
import os
25
23
from subprocess import call
26
24
import sys
27
25
 
28
 
from . import (
29
 
    bedding,
30
 
    cmdline,
31
 
    config,
32
 
    osutils,
33
 
    trace,
34
 
    transport,
35
 
    ui,
36
 
    )
37
 
from .errors import BzrError
38
 
from .hooks import Hooks
39
 
 
40
 
 
41
 
class BadCommitMessageEncoding(BzrError):
42
 
 
43
 
    _fmt = 'The specified commit message contains characters unsupported by '\
44
 
        'the current encoding.'
 
26
import bzrlib
 
27
import bzrlib.config as config
 
28
from bzrlib.errors import BzrError
 
29
from bzrlib.trace import warning, mutter
45
30
 
46
31
 
47
32
def _get_editor():
48
 
    """Return sequence of possible editor binaries for the current platform"""
 
33
    """Return a sequence of possible editor binaries for the current platform"""
49
34
    try:
50
 
        yield os.environ["BRZ_EDITOR"], '$BRZ_EDITOR'
 
35
        yield os.environ["BZR_EDITOR"]
51
36
    except KeyError:
52
37
        pass
53
38
 
54
 
    e = config.GlobalStack().get('editor')
 
39
    e = config.GlobalConfig().get_editor()
55
40
    if e is not None:
56
 
        yield e, bedding.config_path()
57
 
 
 
41
        yield e
 
42
        
58
43
    for varname in 'VISUAL', 'EDITOR':
59
44
        if varname in os.environ:
60
 
            yield os.environ[varname], '$' + varname
 
45
            yield os.environ[varname]
61
46
 
62
47
    if sys.platform == 'win32':
63
48
        for editor in 'wordpad.exe', 'notepad.exe':
64
 
            yield editor, None
 
49
            yield editor
65
50
    else:
66
51
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
67
 
            yield editor, None
 
52
            yield editor
68
53
 
69
54
 
70
55
def _run_editor(filename):
71
56
    """Try to execute an editor to edit the commit message."""
72
 
    for candidate, candidate_source in _get_editor():
73
 
        edargs = cmdline.split(candidate)
 
57
    for e in _get_editor():
 
58
        edargs = e.split(' ')
74
59
        try:
 
60
            ## mutter("trying editor: %r", (edargs +[filename]))
75
61
            x = call(edargs + [filename])
76
 
        except OSError as e:
77
 
            if candidate_source is not None:
78
 
                # We tried this editor because some user configuration (an
79
 
                # environment variable or config file) said to try it.  Let
80
 
                # the user know their configuration is broken.
81
 
                trace.warning(
82
 
                    'Could not start editor "%s" (specified by %s): %s\n'
83
 
                    % (candidate, candidate_source, str(e)))
84
 
            continue
85
 
            raise
 
62
        except OSError, e:
 
63
           # We're searching for an editor, so catch safe errors and continue
 
64
           if e.errno in (errno.ENOENT, ):
 
65
               continue
 
66
           raise
86
67
        if x == 0:
87
68
            return True
88
69
        elif x == 127:
90
71
        else:
91
72
            break
92
73
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
93
 
                   " - $BRZ_EDITOR\n - editor=/some/path in %s\n"
94
 
                   " - $VISUAL\n - $EDITOR" %
95
 
                   bedding.config_path())
 
74
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n"
 
75
                   " - $VISUAL\n - $EDITOR" % \
 
76
                    config.config_filename())
96
77
 
97
78
 
98
79
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
99
 
    {'bar': '-' * 14, 'msg': 'This line and the following will be ignored'}
 
80
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
100
81
 
101
82
 
102
83
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
106
87
    This is run if they don't give a message or
107
88
    message-containing file on the command line.
108
89
 
109
 
    :param infotext:    Text to be displayed at bottom of message
110
 
                        for the user's reference;
111
 
                        currently similar to 'bzr status'.
112
 
 
113
 
    :param ignoreline:  The separator to use above the infotext.
114
 
 
115
 
    :param start_message:   The text to place above the separator, if any.
116
 
                            This will not be removed from the message
117
 
                            after the user has edited it.
118
 
 
119
 
    :return:    commit message or None.
120
 
    """
121
 
 
122
 
    if start_message is not None:
123
 
        start_message = start_message.encode(osutils.get_user_encoding())
124
 
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
125
 
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
126
 
 
127
 
 
128
 
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
129
 
                                start_message=None):
130
 
    """Let the user edit a commit message in a temp file.
131
 
 
132
 
    This is run if they don't give a message or
133
 
    message-containing file on the command line.
134
 
 
135
 
    :param infotext:    Text to be displayed at bottom of message
136
 
                        for the user's reference;
137
 
                        currently similar to 'bzr status'.
138
 
                        The string is already encoded
139
 
 
140
 
    :param ignoreline:  The separator to use above the infotext.
141
 
 
142
 
    :param start_message:   The text to place above the separator, if any.
143
 
                            This will not be removed from the message
144
 
                            after the user has edited it.
145
 
                            The string is already encoded
146
 
 
147
 
    :return:    commit message or None.
148
 
    """
 
90
    infotext:
 
91
        Text to be displayed at bottom of message for
 
92
        the user's reference; currently similar to
 
93
        'bzr status'.
 
94
 
 
95
    ignoreline:
 
96
        The separator to use above the infotext.
 
97
 
 
98
    start_message:
 
99
        The text to place above the separator, if any. This will not be
 
100
        removed from the message after the user has edited it.
 
101
    """
 
102
    import tempfile
 
103
 
149
104
    msgfilename = None
150
105
    try:
151
 
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
152
 
            infotext, ignoreline, start_message)
153
 
        if not msgfilename:
154
 
            return None
155
 
        basename = osutils.basename(msgfilename)
156
 
        msg_transport = transport.get_transport_from_path(
157
 
            osutils.dirname(msgfilename))
158
 
        reference_content = msg_transport.get_bytes(basename)
 
106
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
 
107
        msgfile = os.fdopen(tmp_fileno, 'w')
 
108
        try:
 
109
            if start_message is not None:
 
110
                msgfile.write("%s\n" % start_message.encode(
 
111
                                           bzrlib.user_encoding, 'replace'))
 
112
 
 
113
            if infotext is not None and infotext != "":
 
114
                hasinfo = True
 
115
                msgfile.write("\n\n%s\n\n%s" % (ignoreline,
 
116
                              infotext.encode(bzrlib.user_encoding,
 
117
                                                    'replace')))
 
118
            else:
 
119
                hasinfo = False
 
120
        finally:
 
121
            msgfile.close()
 
122
 
159
123
        if not _run_editor(msgfilename):
160
124
            return None
161
 
        edited_content = msg_transport.get_bytes(basename)
162
 
        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
 
                    {}):
167
 
                # Returning "" makes cmd_commit raise 'empty commit message
168
 
                # specified' which is a reasonable error, given the user has
169
 
                # rejected using the unedited template.
170
 
                return ""
 
125
        
171
126
        started = False
172
127
        msg = []
173
128
        lastline, nlines = 0, 0
174
 
        with codecs.open(msgfilename, mode='rb', encoding=osutils.get_user_encoding()) as f:
175
 
            try:
176
 
                for line in f:
177
 
                    stripped_line = line.strip()
178
 
                    # strip empty line before the log message starts
179
 
                    if not started:
180
 
                        if stripped_line != "":
181
 
                            started = True
182
 
                        else:
183
 
                            continue
184
 
                    # check for the ignore line only if there
185
 
                    # is additional information at the end
186
 
                    if hasinfo and stripped_line == ignoreline:
187
 
                        break
188
 
                    nlines += 1
189
 
                    # keep track of the last line that had some content
190
 
                    if stripped_line != "":
191
 
                        lastline = nlines
192
 
                    msg.append(line)
193
 
            except UnicodeDecodeError:
194
 
                raise BadCommitMessageEncoding()
195
 
 
 
129
        for line in codecs.open(msgfilename, 'r', bzrlib.user_encoding):
 
130
            stripped_line = line.strip()
 
131
            # strip empty line before the log message starts
 
132
            if not started:
 
133
                if stripped_line != "":
 
134
                    started = True
 
135
                else:
 
136
                    continue
 
137
            # check for the ignore line only if there
 
138
            # is additional information at the end
 
139
            if hasinfo and stripped_line == ignoreline:
 
140
                break
 
141
            nlines += 1
 
142
            # keep track of the last line that had some content
 
143
            if stripped_line != "":
 
144
                lastline = nlines
 
145
            msg.append(line)
 
146
            
196
147
        if len(msg) == 0:
197
148
            return ""
198
149
        # delete empty lines at the end
207
158
        if msgfilename is not None:
208
159
            try:
209
160
                os.unlink(msgfilename)
210
 
            except IOError as e:
211
 
                trace.warning(
212
 
                    "failed to unlink %s: %s; ignored", msgfilename, e)
213
 
 
214
 
 
215
 
def _create_temp_file_with_commit_template(infotext,
216
 
                                           ignoreline=DEFAULT_IGNORE_LINE,
217
 
                                           start_message=None,
218
 
                                           tmpdir=None):
219
 
    """Create temp file and write commit template in it.
220
 
 
221
 
    :param infotext: Text to be displayed at bottom of message for the
222
 
        user's reference; currently similar to 'bzr status'.  The text is
223
 
        already encoded.
224
 
 
225
 
    :param ignoreline:  The separator to use above the infotext.
226
 
 
227
 
    :param start_message: The text to place above the separator, if any.
228
 
        This will not be removed from the message after the user has edited
229
 
        it.  The string is already encoded
230
 
 
231
 
    :return:    2-tuple (temp file name, hasinfo)
232
 
    """
233
 
    import tempfile
234
 
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
235
 
                                               dir=tmpdir, text=True)
236
 
    with os.fdopen(tmp_fileno, 'wb') as msgfile:
237
 
        if start_message is not None:
238
 
            msgfile.write(b"%s\n" % start_message)
239
 
 
240
 
        if infotext is not None and infotext != "":
241
 
            hasinfo = True
242
 
            trailer = b"\n\n%s\n\n%s" % (
243
 
                ignoreline.encode(osutils.get_user_encoding()), infotext)
244
 
            msgfile.write(trailer)
245
 
        else:
246
 
            hasinfo = False
247
 
 
248
 
    return (msgfilename, hasinfo)
 
161
            except IOError, e:
 
162
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
249
163
 
250
164
 
251
165
def make_commit_message_template(working_tree, specific_files):
253
167
 
254
168
    Returns a unicode string containing the template.
255
169
    """
 
170
    # TODO: Should probably be given the WorkingTree not the branch
 
171
    #
256
172
    # TODO: make provision for this to be overridden or modified by a hook
257
173
    #
258
174
    # TODO: Rather than running the status command, should prepare a draft of
259
175
    # the revision to be committed, then pause and ask the user to
260
176
    # confirm/write a message.
261
 
    from .status import show_tree_status
 
177
    from StringIO import StringIO       # must be unicode-safe
 
178
    from bzrlib.status import show_tree_status
262
179
    status_tmp = StringIO()
263
 
    show_tree_status(working_tree, specific_files=specific_files,
264
 
                     to_file=status_tmp, verbose=True)
 
180
    show_tree_status(working_tree, specific_files=specific_files, 
 
181
                     to_file=status_tmp)
265
182
    return status_tmp.getvalue()
266
 
 
267
 
 
268
 
def make_commit_message_template_encoded(working_tree, specific_files,
269
 
                                         diff=None, output_encoding='utf-8'):
270
 
    """Prepare a template file for a commit into a branch.
271
 
 
272
 
    Returns an encoded string.
273
 
    """
274
 
    # TODO: make provision for this to be overridden or modified by a hook
275
 
    #
276
 
    # TODO: Rather than running the status command, should prepare a draft of
277
 
    # the revision to be committed, then pause and ask the user to
278
 
    # confirm/write a message.
279
 
    from .diff import show_diff_trees
280
 
 
281
 
    template = make_commit_message_template(working_tree, specific_files)
282
 
    template = template.encode(output_encoding, "replace")
283
 
 
284
 
    if diff:
285
 
        stream = BytesIO()
286
 
        show_diff_trees(working_tree.basis_tree(),
287
 
                        working_tree, stream, specific_files,
288
 
                        path_encoding=output_encoding)
289
 
        template = template + b'\n' + stream.getvalue()
290
 
 
291
 
    return template
292
 
 
293
 
 
294
 
class MessageEditorHooks(Hooks):
295
 
    """A dictionary mapping hook name to a list of callables for message editor
296
 
    hooks.
297
 
 
298
 
    e.g. ['commit_message_template'] is the list of items to be called to
299
 
    generate a commit message template
300
 
    """
301
 
 
302
 
    def __init__(self):
303
 
        """Create the default hooks.
304
 
 
305
 
        These are all empty initially.
306
 
        """
307
 
        Hooks.__init__(self, "breezy.msgeditor", "hooks")
308
 
        self.add_hook(
309
 
            'set_commit_message',
310
 
            "Set a fixed commit message. "
311
 
            "set_commit_message is called with the "
312
 
            "breezy.commit.Commit object (so you can also change e.g. "
313
 
            "revision properties by editing commit.builder._revprops) and the "
314
 
            "message so far. set_commit_message must return the message to "
315
 
            "use or None if it should use the message editor as normal.",
316
 
            (2, 4))
317
 
        self.add_hook(
318
 
            'commit_message_template',
319
 
            "Called when a commit message is being generated. "
320
 
            "commit_message_template is called with the breezy.commit.Commit "
321
 
            "object and the message that is known so far. "
322
 
            "commit_message_template must return a new message to use (which "
323
 
            "could be the same as it was given). When there are multiple "
324
 
            "hooks registered for commit_message_template, they are chained "
325
 
            "with the result from the first passed into the second, and so "
326
 
            "on.", (1, 10))
327
 
 
328
 
 
329
 
hooks = MessageEditorHooks()
330
 
 
331
 
 
332
 
def set_commit_message(commit, start_message=None):
333
 
    """Sets the commit message.
334
 
    :param commit: Commit object for the active commit.
335
 
    :return: The commit message or None to continue using the message editor
336
 
    """
337
 
    start_message = None
338
 
    for hook in hooks['set_commit_message']:
339
 
        start_message = hook(commit, start_message)
340
 
    return start_message
341
 
 
342
 
 
343
 
def generate_commit_message_template(commit, start_message=None):
344
 
    """Generate a commit message template.
345
 
 
346
 
    :param commit: Commit object for the active commit.
347
 
    :param start_message: Message to start with.
348
 
    :return: A start commit message or None for an empty start commit message.
349
 
    """
350
 
    start_message = None
351
 
    for hook in hooks['commit_message_template']:
352
 
        start_message = hook(commit, start_message)
353
 
    return start_message