/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: Jelmer Vernooij
  • Date: 2010-04-30 11:03:59 UTC
  • mto: This revision was merged to the branch mainline in revision 5197.
  • Revision ID: jelmer@samba.org-20100430110359-ow3e3grh7sxy93pa
Remove more unused imports.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
 
1
# Copyright (C) 2005-2010 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
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
 
16
 
 
17
 
 
18
"""Commit message editor support."""
 
19
 
 
20
import codecs
 
21
import os
 
22
from subprocess import call
 
23
import sys
 
24
 
 
25
from bzrlib import (
 
26
    config,
 
27
    osutils,
 
28
    trace,
 
29
    )
 
30
from bzrlib.errors import BzrError, BadCommitMessageEncoding
 
31
from bzrlib.hooks import HookPoint, Hooks
 
32
 
 
33
 
 
34
def _get_editor():
 
35
    """Return a sequence of possible editor binaries for the current platform"""
 
36
    try:
 
37
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
 
38
    except KeyError:
 
39
        pass
 
40
 
 
41
    e = config.GlobalConfig().get_editor()
 
42
    if e is not None:
 
43
        yield e, config.config_filename()
 
44
 
 
45
    for varname in 'VISUAL', 'EDITOR':
 
46
        if varname in os.environ:
 
47
            yield os.environ[varname], '$' + varname
 
48
 
 
49
    if sys.platform == 'win32':
 
50
        for editor in 'wordpad.exe', 'notepad.exe':
 
51
            yield editor, None
 
52
    else:
 
53
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
 
54
            yield editor, None
 
55
 
 
56
 
 
57
def _run_editor(filename):
 
58
    """Try to execute an editor to edit the commit message."""
 
59
    for candidate, candidate_source in _get_editor():
 
60
        edargs = candidate.split(' ')
 
61
        try:
 
62
            ## mutter("trying editor: %r", (edargs +[filename]))
 
63
            x = call(edargs + [filename])
 
64
        except OSError, e:
 
65
            if candidate_source is not None:
 
66
                # We tried this editor because some user configuration (an
 
67
                # environment variable or config file) said to try it.  Let
 
68
                # the user know their configuration is broken.
 
69
                trace.warning(
 
70
                    'Could not start editor "%s" (specified by %s): %s\n'
 
71
                    % (candidate, candidate_source, str(e)))
 
72
            continue
 
73
            raise
 
74
        if x == 0:
 
75
            return True
 
76
        elif x == 127:
 
77
            continue
 
78
        else:
 
79
            break
 
80
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
 
81
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n"
 
82
                   " - $VISUAL\n - $EDITOR" % \
 
83
                    config.config_filename())
 
84
 
 
85
 
 
86
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
 
87
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
 
88
 
 
89
 
 
90
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
 
91
                        start_message=None):
 
92
    """Let the user edit a commit message in a temp file.
 
93
 
 
94
    This is run if they don't give a message or
 
95
    message-containing file on the command line.
 
96
 
 
97
    :param infotext:    Text to be displayed at bottom of message
 
98
                        for the user's reference;
 
99
                        currently similar to 'bzr status'.
 
100
 
 
101
    :param ignoreline:  The separator to use above the infotext.
 
102
 
 
103
    :param start_message:   The text to place above the separator, if any.
 
104
                            This will not be removed from the message
 
105
                            after the user has edited it.
 
106
 
 
107
    :return:    commit message or None.
 
108
    """
 
109
 
 
110
    if not start_message is None:
 
111
        start_message = start_message.encode(osutils.get_user_encoding())
 
112
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
 
113
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
 
114
 
 
115
 
 
116
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
 
117
                                start_message=None):
 
118
    """Let the user edit a commit message in a temp file.
 
119
 
 
120
    This is run if they don't give a message or
 
121
    message-containing file on the command line.
 
122
 
 
123
    :param infotext:    Text to be displayed at bottom of message
 
124
                        for the user's reference;
 
125
                        currently similar to 'bzr status'.
 
126
                        The string is already encoded
 
127
 
 
128
    :param ignoreline:  The separator to use above the infotext.
 
129
 
 
130
    :param start_message:   The text to place above the separator, if any.
 
131
                            This will not be removed from the message
 
132
                            after the user has edited it.
 
133
                            The string is already encoded
 
134
 
 
135
    :return:    commit message or None.
 
136
    """
 
137
    msgfilename = None
 
138
    try:
 
139
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
 
140
                                    infotext, ignoreline, start_message)
 
141
 
 
142
        if not msgfilename or not _run_editor(msgfilename):
 
143
            return None
 
144
 
 
145
        started = False
 
146
        msg = []
 
147
        lastline, nlines = 0, 0
 
148
        # codecs.open() ALWAYS opens file in binary mode but we need text mode
 
149
        # 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
 
150
        f = file(msgfilename, 'rU')
 
151
        try:
 
152
            try:
 
153
                for line in codecs.getreader(osutils.get_user_encoding())(f):
 
154
                    stripped_line = line.strip()
 
155
                    # strip empty line before the log message starts
 
156
                    if not started:
 
157
                        if stripped_line != "":
 
158
                            started = True
 
159
                        else:
 
160
                            continue
 
161
                    # check for the ignore line only if there
 
162
                    # is additional information at the end
 
163
                    if hasinfo and stripped_line == ignoreline:
 
164
                        break
 
165
                    nlines += 1
 
166
                    # keep track of the last line that had some content
 
167
                    if stripped_line != "":
 
168
                        lastline = nlines
 
169
                    msg.append(line)
 
170
            except UnicodeDecodeError:
 
171
                raise BadCommitMessageEncoding()
 
172
        finally:
 
173
            f.close()
 
174
 
 
175
        if len(msg) == 0:
 
176
            return ""
 
177
        # delete empty lines at the end
 
178
        del msg[lastline:]
 
179
        # add a newline at the end, if needed
 
180
        if not msg[-1].endswith("\n"):
 
181
            return "%s%s" % ("".join(msg), "\n")
 
182
        else:
 
183
            return "".join(msg)
 
184
    finally:
 
185
        # delete the msg file in any case
 
186
        if msgfilename is not None:
 
187
            try:
 
188
                os.unlink(msgfilename)
 
189
            except IOError, e:
 
190
                trace.warning(
 
191
                    "failed to unlink %s: %s; ignored", msgfilename, e)
 
192
 
 
193
 
 
194
def _create_temp_file_with_commit_template(infotext,
 
195
                                           ignoreline=DEFAULT_IGNORE_LINE,
 
196
                                           start_message=None):
 
197
    """Create temp file and write commit template in it.
 
198
 
 
199
    :param infotext:    Text to be displayed at bottom of message
 
200
                        for the user's reference;
 
201
                        currently similar to 'bzr status'.
 
202
                        The text is already encoded.
 
203
 
 
204
    :param ignoreline:  The separator to use above the infotext.
 
205
 
 
206
    :param start_message:   The text to place above the separator, if any.
 
207
                            This will not be removed from the message
 
208
                            after the user has edited it.
 
209
                            The string is already encoded
 
210
 
 
211
    :return:    2-tuple (temp file name, hasinfo)
 
212
    """
 
213
    import tempfile
 
214
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
 
215
                                               dir='.',
 
216
                                               text=True)
 
217
    msgfilename = osutils.basename(msgfilename)
 
218
    msgfile = os.fdopen(tmp_fileno, 'w')
 
219
    try:
 
220
        if start_message is not None:
 
221
            msgfile.write("%s\n" % start_message)
 
222
 
 
223
        if infotext is not None and infotext != "":
 
224
            hasinfo = True
 
225
            msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
 
226
        else:
 
227
            hasinfo = False
 
228
    finally:
 
229
        msgfile.close()
 
230
 
 
231
    return (msgfilename, hasinfo)
 
232
 
 
233
 
 
234
def make_commit_message_template(working_tree, specific_files):
 
235
    """Prepare a template file for a commit into a branch.
 
236
 
 
237
    Returns a unicode string containing the template.
 
238
    """
 
239
    # TODO: make provision for this to be overridden or modified by a hook
 
240
    #
 
241
    # TODO: Rather than running the status command, should prepare a draft of
 
242
    # the revision to be committed, then pause and ask the user to
 
243
    # confirm/write a message.
 
244
    from StringIO import StringIO       # must be unicode-safe
 
245
    from bzrlib.status import show_tree_status
 
246
    status_tmp = StringIO()
 
247
    show_tree_status(working_tree, specific_files=specific_files,
 
248
                     to_file=status_tmp, verbose=True)
 
249
    return status_tmp.getvalue()
 
250
 
 
251
 
 
252
def make_commit_message_template_encoded(working_tree, specific_files,
 
253
                                         diff=None, output_encoding='utf-8'):
 
254
    """Prepare a template file for a commit into a branch.
 
255
 
 
256
    Returns an encoded string.
 
257
    """
 
258
    # TODO: make provision for this to be overridden or modified by a hook
 
259
    #
 
260
    # TODO: Rather than running the status command, should prepare a draft of
 
261
    # the revision to be committed, then pause and ask the user to
 
262
    # confirm/write a message.
 
263
    from StringIO import StringIO       # must be unicode-safe
 
264
    from bzrlib.diff import show_diff_trees
 
265
 
 
266
    template = make_commit_message_template(working_tree, specific_files)
 
267
    template = template.encode(output_encoding, "replace")
 
268
 
 
269
    if diff:
 
270
        stream = StringIO()
 
271
        show_diff_trees(working_tree.basis_tree(),
 
272
                        working_tree, stream, specific_files,
 
273
                        path_encoding=output_encoding)
 
274
        template = template + '\n' + stream.getvalue()
 
275
 
 
276
    return template
 
277
 
 
278
 
 
279
class MessageEditorHooks(Hooks):
 
280
    """A dictionary mapping hook name to a list of callables for message editor
 
281
    hooks.
 
282
 
 
283
    e.g. ['commit_message_template'] is the list of items to be called to
 
284
    generate a commit message template
 
285
    """
 
286
 
 
287
    def __init__(self):
 
288
        """Create the default hooks.
 
289
 
 
290
        These are all empty initially.
 
291
        """
 
292
        Hooks.__init__(self)
 
293
        self.create_hook(HookPoint('commit_message_template',
 
294
            "Called when a commit message is being generated. "
 
295
            "commit_message_template is called with the bzrlib.commit.Commit "
 
296
            "object and the message that is known so far. "
 
297
            "commit_message_template must return a new message to use (which "
 
298
            "could be the same as it was given. When there are multiple "
 
299
            "hooks registered for commit_message_template, they are chained "
 
300
            "with the result from the first passed into the second, and so "
 
301
            "on.", (1, 10), None))
 
302
 
 
303
 
 
304
hooks = MessageEditorHooks()
 
305
 
 
306
 
 
307
def generate_commit_message_template(commit, start_message=None):
 
308
    """Generate a commit message template.
 
309
 
 
310
    :param commit: Commit object for the active commit.
 
311
    :param start_message: Message to start with.
 
312
    :return: A start commit message or None for an empty start commit message.
 
313
    """
 
314
    start_message = None
 
315
    for hook in hooks['commit_message_template']:
 
316
        start_message = hook(commit, start_message)
 
317
    return start_message