/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: John Ferlito
  • Date: 2009-09-02 04:31:45 UTC
  • mto: (4665.7.1 serve-init)
  • mto: This revision was merged to the branch mainline in revision 4913.
  • Revision ID: johnf@inodes.org-20090902043145-gxdsfw03ilcwbyn5
Add a debian init script for bzr --serve

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
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
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,
 
26
from bzrlib import (
31
27
    config,
32
28
    osutils,
33
29
    trace,
34
 
    transport,
35
 
    ui,
36
30
    )
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.'
 
31
from bzrlib.errors import BzrError, BadCommitMessageEncoding
 
32
from bzrlib.hooks import HookPoint, Hooks
45
33
 
46
34
 
47
35
def _get_editor():
48
 
    """Return sequence of possible editor binaries for the current platform"""
 
36
    """Return a sequence of possible editor binaries for the current platform"""
49
37
    try:
50
 
        yield os.environ["BRZ_EDITOR"], '$BRZ_EDITOR'
 
38
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
51
39
    except KeyError:
52
40
        pass
53
41
 
54
 
    e = config.GlobalStack().get('editor')
 
42
    e = config.GlobalConfig().get_editor()
55
43
    if e is not None:
56
 
        yield e, bedding.config_path()
 
44
        yield e, config.config_filename()
57
45
 
58
46
    for varname in 'VISUAL', 'EDITOR':
59
47
        if varname in os.environ:
70
58
def _run_editor(filename):
71
59
    """Try to execute an editor to edit the commit message."""
72
60
    for candidate, candidate_source in _get_editor():
73
 
        edargs = cmdline.split(candidate)
 
61
        edargs = candidate.split(' ')
74
62
        try:
 
63
            ## mutter("trying editor: %r", (edargs +[filename]))
75
64
            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
 
65
        except OSError, e:
 
66
            # We're searching for an editor, so catch safe errors and continue
 
67
            if e.errno in (errno.ENOENT, errno.EACCES):
 
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
85
76
            raise
86
77
        if x == 0:
87
78
            return True
90
81
        else:
91
82
            break
92
83
    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())
 
84
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n"
 
85
                   " - $VISUAL\n - $EDITOR" % \
 
86
                    config.config_filename())
96
87
 
97
88
 
98
89
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
99
 
    {'bar': '-' * 14, 'msg': 'This line and the following will be ignored'}
 
90
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
100
91
 
101
92
 
102
93
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
119
110
    :return:    commit message or None.
120
111
    """
121
112
 
122
 
    if start_message is not None:
 
113
    if not start_message is None:
123
114
        start_message = start_message.encode(osutils.get_user_encoding())
124
115
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
125
116
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
149
140
    msgfilename = None
150
141
    try:
151
142
        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)
159
 
        if not _run_editor(msgfilename):
160
 
            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 ""
 
143
                                    infotext, ignoreline, start_message)
 
144
 
 
145
        if not msgfilename or not _run_editor(msgfilename):
 
146
            return None
 
147
 
171
148
        started = False
172
149
        msg = []
173
150
        lastline, nlines = 0, 0
174
 
        with codecs.open(msgfilename, mode='rb', encoding=osutils.get_user_encoding()) as f:
 
151
        # codecs.open() ALWAYS opens file in binary mode but we need text mode
 
152
        # 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
 
153
        f = file(msgfilename, 'rU')
 
154
        try:
175
155
            try:
176
 
                for line in f:
 
156
                for line in codecs.getreader(osutils.get_user_encoding())(f):
177
157
                    stripped_line = line.strip()
178
158
                    # strip empty line before the log message starts
179
159
                    if not started:
192
172
                    msg.append(line)
193
173
            except UnicodeDecodeError:
194
174
                raise BadCommitMessageEncoding()
 
175
        finally:
 
176
            f.close()
195
177
 
196
178
        if len(msg) == 0:
197
179
            return ""
207
189
        if msgfilename is not None:
208
190
            try:
209
191
                os.unlink(msgfilename)
210
 
            except IOError as e:
 
192
            except IOError, e:
211
193
                trace.warning(
212
194
                    "failed to unlink %s: %s; ignored", msgfilename, e)
213
195
 
214
196
 
215
197
def _create_temp_file_with_commit_template(infotext,
216
198
                                           ignoreline=DEFAULT_IGNORE_LINE,
217
 
                                           start_message=None,
218
 
                                           tmpdir=None):
 
199
                                           start_message=None):
219
200
    """Create temp file and write commit template in it.
220
201
 
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.
 
202
    :param infotext:    Text to be displayed at bottom of message
 
203
                        for the user's reference;
 
204
                        currently similar to 'bzr status'.
 
205
                        The text is already encoded.
224
206
 
225
207
    :param ignoreline:  The separator to use above the infotext.
226
208
 
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
 
209
    :param start_message:   The text to place above the separator, if any.
 
210
                            This will not be removed from the message
 
211
                            after the user has edited it.
 
212
                            The string is already encoded
230
213
 
231
214
    :return:    2-tuple (temp file name, hasinfo)
232
215
    """
233
216
    import tempfile
234
217
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
235
 
                                               dir=tmpdir, text=True)
236
 
    with os.fdopen(tmp_fileno, 'wb') as msgfile:
 
218
                                               dir='.',
 
219
                                               text=True)
 
220
    msgfilename = osutils.basename(msgfilename)
 
221
    msgfile = os.fdopen(tmp_fileno, 'w')
 
222
    try:
237
223
        if start_message is not None:
238
 
            msgfile.write(b"%s\n" % start_message)
 
224
            msgfile.write("%s\n" % start_message)
239
225
 
240
226
        if infotext is not None and infotext != "":
241
227
            hasinfo = True
242
 
            trailer = b"\n\n%s\n\n%s" % (
243
 
                ignoreline.encode(osutils.get_user_encoding()), infotext)
244
 
            msgfile.write(trailer)
 
228
            msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
245
229
        else:
246
230
            hasinfo = False
 
231
    finally:
 
232
        msgfile.close()
247
233
 
248
234
    return (msgfilename, hasinfo)
249
235
 
258
244
    # TODO: Rather than running the status command, should prepare a draft of
259
245
    # the revision to be committed, then pause and ask the user to
260
246
    # confirm/write a message.
261
 
    from .status import show_tree_status
 
247
    from StringIO import StringIO       # must be unicode-safe
 
248
    from bzrlib.status import show_tree_status
262
249
    status_tmp = StringIO()
263
250
    show_tree_status(working_tree, specific_files=specific_files,
264
251
                     to_file=status_tmp, verbose=True)
276
263
    # TODO: Rather than running the status command, should prepare a draft of
277
264
    # the revision to be committed, then pause and ask the user to
278
265
    # confirm/write a message.
279
 
    from .diff import show_diff_trees
 
266
    from StringIO import StringIO       # must be unicode-safe
 
267
    from bzrlib.diff import show_diff_trees
280
268
 
281
269
    template = make_commit_message_template(working_tree, specific_files)
282
270
    template = template.encode(output_encoding, "replace")
283
271
 
284
272
    if diff:
285
 
        stream = BytesIO()
 
273
        stream = StringIO()
286
274
        show_diff_trees(working_tree.basis_tree(),
287
275
                        working_tree, stream, specific_files,
288
276
                        path_encoding=output_encoding)
289
 
        template = template + b'\n' + stream.getvalue()
 
277
        template = template + '\n' + stream.getvalue()
290
278
 
291
279
    return template
292
280
 
304
292
 
305
293
        These are all empty initially.
306
294
        """
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',
 
295
        Hooks.__init__(self)
 
296
        self.create_hook(HookPoint('commit_message_template',
319
297
            "Called when a commit message is being generated. "
320
 
            "commit_message_template is called with the breezy.commit.Commit "
 
298
            "commit_message_template is called with the bzrlib.commit.Commit "
321
299
            "object and the message that is known so far. "
322
300
            "commit_message_template must return a new message to use (which "
323
 
            "could be the same as it was given). When there are multiple "
 
301
            "could be the same as it was given. When there are multiple "
324
302
            "hooks registered for commit_message_template, they are chained "
325
303
            "with the result from the first passed into the second, and so "
326
 
            "on.", (1, 10))
 
304
            "on.", (1, 10), None))
327
305
 
328
306
 
329
307
hooks = MessageEditorHooks()
330
308
 
331
309
 
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
310
def generate_commit_message_template(commit, start_message=None):
344
311
    """Generate a commit message template.
345
312