/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
18
"""Commit message editor support."""
19
19
 
20
20
import codecs
 
21
import errno
21
22
import os
22
23
from subprocess import call
23
24
import sys
24
25
 
25
 
from bzrlib import (
26
 
    cmdline,
27
 
    config,
28
 
    osutils,
29
 
    trace,
30
 
    transport,
31
 
    ui,
32
 
    )
33
 
from bzrlib.errors import BzrError, BadCommitMessageEncoding
34
 
from bzrlib.hooks import Hooks
 
26
import bzrlib
 
27
import bzrlib.config as config
 
28
from bzrlib.errors import BzrError
 
29
from bzrlib.trace import warning, mutter
35
30
 
36
31
 
37
32
def _get_editor():
38
33
    """Return a sequence of possible editor binaries for the current platform"""
39
34
    try:
40
 
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
 
35
        yield os.environ["BZR_EDITOR"]
41
36
    except KeyError:
42
37
        pass
43
38
 
44
39
    e = config.GlobalConfig().get_editor()
45
40
    if e is not None:
46
 
        yield e, config.config_filename()
47
 
 
 
41
        yield e
 
42
        
48
43
    for varname in 'VISUAL', 'EDITOR':
49
44
        if varname in os.environ:
50
 
            yield os.environ[varname], '$' + varname
 
45
            yield os.environ[varname]
51
46
 
52
47
    if sys.platform == 'win32':
53
48
        for editor in 'wordpad.exe', 'notepad.exe':
54
 
            yield editor, None
 
49
            yield editor
55
50
    else:
56
51
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
57
 
            yield editor, None
 
52
            yield editor
58
53
 
59
54
 
60
55
def _run_editor(filename):
61
56
    """Try to execute an editor to edit the commit message."""
62
 
    for candidate, candidate_source in _get_editor():
63
 
        edargs = cmdline.split(candidate)
 
57
    for e in _get_editor():
 
58
        edargs = e.split(' ')
64
59
        try:
65
60
            ## mutter("trying editor: %r", (edargs +[filename]))
66
61
            x = call(edargs + [filename])
67
62
        except OSError, e:
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
76
 
            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
77
67
        if x == 0:
78
68
            return True
79
69
        elif x == 127:
97
87
    This is run if they don't give a message or
98
88
    message-containing file on the command line.
99
89
 
100
 
    :param infotext:    Text to be displayed at bottom of message
101
 
                        for the user's reference;
102
 
                        currently similar to 'bzr status'.
103
 
 
104
 
    :param ignoreline:  The separator to use above the infotext.
105
 
 
106
 
    :param start_message:   The text to place above the separator, if any.
107
 
                            This will not be removed from the message
108
 
                            after the user has edited it.
109
 
 
110
 
    :return:    commit message or None.
111
 
    """
112
 
 
113
 
    if not start_message is None:
114
 
        start_message = start_message.encode(osutils.get_user_encoding())
115
 
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
116
 
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
117
 
 
118
 
 
119
 
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
120
 
                                start_message=None):
121
 
    """Let the user edit a commit message in a temp file.
122
 
 
123
 
    This is run if they don't give a message or
124
 
    message-containing file on the command line.
125
 
 
126
 
    :param infotext:    Text to be displayed at bottom of message
127
 
                        for the user's reference;
128
 
                        currently similar to 'bzr status'.
129
 
                        The string is already encoded
130
 
 
131
 
    :param ignoreline:  The separator to use above the infotext.
132
 
 
133
 
    :param start_message:   The text to place above the separator, if any.
134
 
                            This will not be removed from the message
135
 
                            after the user has edited it.
136
 
                            The string is already encoded
137
 
 
138
 
    :return:    commit message or None.
139
 
    """
 
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
 
140
104
    msgfilename = None
141
105
    try:
142
 
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
143
 
                                    infotext, ignoreline, start_message)
144
 
        if not msgfilename:
145
 
            return None
146
 
        basename = osutils.basename(msgfilename)
147
 
        msg_transport = transport.get_transport(osutils.dirname(msgfilename))
148
 
        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
 
149
123
        if not _run_editor(msgfilename):
150
124
            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
 
                "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 ""
 
125
        
161
126
        started = False
162
127
        msg = []
163
128
        lastline, nlines = 0, 0
164
 
        # codecs.open() ALWAYS opens file in binary mode but we need text mode
165
 
        # 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
166
 
        f = file(msgfilename, 'rU')
167
 
        try:
168
 
            try:
169
 
                for line in codecs.getreader(osutils.get_user_encoding())(f):
170
 
                    stripped_line = line.strip()
171
 
                    # strip empty line before the log message starts
172
 
                    if not started:
173
 
                        if stripped_line != "":
174
 
                            started = True
175
 
                        else:
176
 
                            continue
177
 
                    # check for the ignore line only if there
178
 
                    # is additional information at the end
179
 
                    if hasinfo and stripped_line == ignoreline:
180
 
                        break
181
 
                    nlines += 1
182
 
                    # keep track of the last line that had some content
183
 
                    if stripped_line != "":
184
 
                        lastline = nlines
185
 
                    msg.append(line)
186
 
            except UnicodeDecodeError:
187
 
                raise BadCommitMessageEncoding()
188
 
        finally:
189
 
            f.close()
190
 
 
 
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
            
191
147
        if len(msg) == 0:
192
148
            return ""
193
149
        # delete empty lines at the end
203
159
            try:
204
160
                os.unlink(msgfilename)
205
161
            except IOError, e:
206
 
                trace.warning(
207
 
                    "failed to unlink %s: %s; ignored", msgfilename, e)
208
 
 
209
 
 
210
 
def _create_temp_file_with_commit_template(infotext,
211
 
                                           ignoreline=DEFAULT_IGNORE_LINE,
212
 
                                           start_message=None,
213
 
                                           tmpdir=None):
214
 
    """Create temp file and write commit template in it.
215
 
 
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.
219
 
 
220
 
    :param ignoreline:  The separator to use above the infotext.
221
 
 
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
225
 
 
226
 
    :return:    2-tuple (temp file name, hasinfo)
227
 
    """
228
 
    import tempfile
229
 
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
230
 
                                               dir=tmpdir, text=True)
231
 
    msgfile = os.fdopen(tmp_fileno, 'w')
232
 
    try:
233
 
        if start_message is not None:
234
 
            msgfile.write("%s\n" % start_message)
235
 
 
236
 
        if infotext is not None and infotext != "":
237
 
            hasinfo = True
238
 
            msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
239
 
        else:
240
 
            hasinfo = False
241
 
    finally:
242
 
        msgfile.close()
243
 
 
244
 
    return (msgfilename, hasinfo)
 
162
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
245
163
 
246
164
 
247
165
def make_commit_message_template(working_tree, specific_files):
249
167
 
250
168
    Returns a unicode string containing the template.
251
169
    """
 
170
    # TODO: Should probably be given the WorkingTree not the branch
 
171
    #
252
172
    # TODO: make provision for this to be overridden or modified by a hook
253
173
    #
254
174
    # TODO: Rather than running the status command, should prepare a draft of
257
177
    from StringIO import StringIO       # must be unicode-safe
258
178
    from bzrlib.status import show_tree_status
259
179
    status_tmp = StringIO()
260
 
    show_tree_status(working_tree, specific_files=specific_files,
261
 
                     to_file=status_tmp, verbose=True)
 
180
    show_tree_status(working_tree, specific_files=specific_files, 
 
181
                     to_file=status_tmp)
262
182
    return status_tmp.getvalue()
263
 
 
264
 
 
265
 
def make_commit_message_template_encoded(working_tree, specific_files,
266
 
                                         diff=None, output_encoding='utf-8'):
267
 
    """Prepare a template file for a commit into a branch.
268
 
 
269
 
    Returns an encoded string.
270
 
    """
271
 
    # TODO: make provision for this to be overridden or modified by a hook
272
 
    #
273
 
    # TODO: Rather than running the status command, should prepare a draft of
274
 
    # the revision to be committed, then pause and ask the user to
275
 
    # confirm/write a message.
276
 
    from StringIO import StringIO       # must be unicode-safe
277
 
    from bzrlib.diff import show_diff_trees
278
 
 
279
 
    template = make_commit_message_template(working_tree, specific_files)
280
 
    template = template.encode(output_encoding, "replace")
281
 
 
282
 
    if diff:
283
 
        stream = StringIO()
284
 
        show_diff_trees(working_tree.basis_tree(),
285
 
                        working_tree, stream, specific_files,
286
 
                        path_encoding=output_encoding)
287
 
        template = template + '\n' + stream.getvalue()
288
 
 
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('commit_message_template',
307
 
            "Called when a commit message is being generated. "
308
 
            "commit_message_template is called with the bzrlib.commit.Commit "
309
 
            "object and the message that is known so far. "
310
 
            "commit_message_template must return a new message to use (which "
311
 
            "could be the same as it was given. When there are multiple "
312
 
            "hooks registered for commit_message_template, they are chained "
313
 
            "with the result from the first passed into the second, and so "
314
 
            "on.", (1, 10))
315
 
 
316
 
 
317
 
hooks = MessageEditorHooks()
318
 
 
319
 
 
320
 
def generate_commit_message_template(commit, start_message=None):
321
 
    """Generate a commit message template.
322
 
 
323
 
    :param commit: Commit object for the active commit.
324
 
    :param start_message: Message to start with.
325
 
    :return: A start commit message or None for an empty start commit message.
326
 
    """
327
 
    start_message = None
328
 
    for hook in hooks['commit_message_template']:
329
 
        start_message = hook(commit, start_message)
330
 
    return start_message