~bzr-pqm/bzr/bzr.dev

2052.3.2 by John Arbash Meinel
Change Copyright .. by Canonical to Copyright ... Canonical
1
# Copyright (C) 2005, 2006 Canonical Ltd
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
2
#
1167 by Martin Pool
- split commit message editor functions out into own file
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
7
#
1167 by Martin Pool
- split commit message editor functions out into own file
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
12
#
1167 by Martin Pool
- split commit message editor functions out into own file
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
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1167 by Martin Pool
- split commit message editor functions out into own file
16
17
18
"""Commit message editor support."""
19
1185.85.2 by John Arbash Meinel
[patch] from Ivan Vilata i Balaguer: infotext should be encoded from unicode to flat strings
20
import codecs
1185.50.91 by John Arbash Meinel
Fix import order for msgeditor.py
21
import errno
1167 by Martin Pool
- split commit message editor functions out into own file
22
import os
1185.50.91 by John Arbash Meinel
Fix import order for msgeditor.py
23
from subprocess import call
1185.50.90 by John Arbash Meinel
[patch] Olaf Conradi: missing sys import in msgeditor.py after platform test fix
24
import sys
1442.1.3 by Robert Collins
move editor into the config file too
25
3224.5.33 by Andrew Bennetts
Tidy imports in bzrlib/msgeditor.py as suggested by John's review.
26
from bzrlib import (
27
    config,
28
    osutils,
3910.1.1 by Andrew Bennetts
Improve error handling in msgeditor._run_editor.
29
    trace,
3224.5.33 by Andrew Bennetts
Tidy imports in bzrlib/msgeditor.py as suggested by John's review.
30
    )
2625.9.4 by Daniel Watkins
Fixed editor commit message to die cleanly if a UnicodeDecodeError is thrown.
31
from bzrlib.errors import BzrError, BadCommitMessageEncoding
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
32
from bzrlib.hooks import HookPoint, Hooks
1167 by Martin Pool
- split commit message editor functions out into own file
33
1185.50.90 by John Arbash Meinel
[patch] Olaf Conradi: missing sys import in msgeditor.py after platform test fix
34
1167 by Martin Pool
- split commit message editor functions out into own file
35
def _get_editor():
36
    """Return a sequence of possible editor binaries for the current platform"""
1185.1.30 by Robert Collins
Accept and tweak David Clymers BZREDITOR support patch
37
    try:
3910.1.1 by Andrew Bennetts
Improve error handling in msgeditor._run_editor.
38
        yield os.environ["BZR_EDITOR"], '$BZR_EDITOR'
1185.1.30 by Robert Collins
Accept and tweak David Clymers BZREDITOR support patch
39
    except KeyError:
40
        pass
41
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
42
    e = config.GlobalConfig().get_editor()
1167 by Martin Pool
- split commit message editor functions out into own file
43
    if e is not None:
3910.1.1 by Andrew Bennetts
Improve error handling in msgeditor._run_editor.
44
        yield e, config.config_filename()
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
45
1668.1.13 by Martin Pool
msgeditor and bzr info improvements (olaf)
46
    for varname in 'VISUAL', 'EDITOR':
1963.2.1 by Robey Pointer
remove usage of has_key()
47
        if varname in os.environ:
3910.1.2 by Andrew Bennetts
Fix thinko.
48
            yield os.environ[varname], '$' + varname
1185.1.30 by Robert Collins
Accept and tweak David Clymers BZREDITOR support patch
49
1684.1.7 by Martin Pool
(patch) better detection of the write commit message editor to use (mpe, robertc)
50
    if sys.platform == 'win32':
51
        for editor in 'wordpad.exe', 'notepad.exe':
3910.1.1 by Andrew Bennetts
Improve error handling in msgeditor._run_editor.
52
            yield editor, None
1684.1.7 by Martin Pool
(patch) better detection of the write commit message editor to use (mpe, robertc)
53
    else:
1668.4.1 by Olaf Conradi
Make msgeditor invocation comply with Debian Policy.
54
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
3910.1.1 by Andrew Bennetts
Improve error handling in msgeditor._run_editor.
55
            yield editor, None
1167 by Martin Pool
- split commit message editor functions out into own file
56
57
58
def _run_editor(filename):
1168 by Martin Pool
- work properly when $EDITOR contains multiple words
59
    """Try to execute an editor to edit the commit message."""
3910.1.1 by Andrew Bennetts
Improve error handling in msgeditor._run_editor.
60
    for candidate, candidate_source in _get_editor():
61
        edargs = candidate.split(' ')
1185.62.19 by John Arbash Meinel
Fix error when we can't find an editor
62
        try:
1711.4.2 by jfmeinel
current python may be running in a path that has a space, so properly quote the python exe name. for test_msgeditor
63
            ## mutter("trying editor: %r", (edargs +[filename]))
1185.62.19 by John Arbash Meinel
Fix error when we can't find an editor
64
            x = call(edargs + [filename])
65
        except OSError, e:
3376.1.1 by Martin Pool
Fix incorrect indentation (#220333)
66
            # We're searching for an editor, so catch safe errors and continue
3910.1.1 by Andrew Bennetts
Improve error handling in msgeditor._run_editor.
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(
3910.1.3 by Andrew Bennetts
Tweak warning slightly.
73
                        'Could not start editor "%s" (specified by %s): %s\n'
74
                        % (candidate, candidate_source, str(e)))
3376.1.1 by Martin Pool
Fix incorrect indentation (#220333)
75
                continue
76
            raise
1167 by Martin Pool
- split commit message editor functions out into own file
77
        if x == 0:
78
            return True
79
        elif x == 127:
80
            continue
81
        else:
82
            break
1684.1.7 by Martin Pool
(patch) better detection of the write commit message editor to use (mpe, robertc)
83
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
2135.1.3 by Matthew Fuller
Include $VISUAL in the list of env variables when we can't start an
84
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n"
85
                   " - $VISUAL\n - $EDITOR" % \
1684.1.7 by Martin Pool
(patch) better detection of the write commit message editor to use (mpe, robertc)
86
                    config.config_filename())
1553.4.9 by Michael Ellerman
Make the "ignore line" in the commit message editor the "right" width, so
87
88
89
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
90
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
91
92
2258.3.1 by James Westby
Add a way to specify a template commit message.
93
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
2598.6.12 by ghigo
Move the encoding of the commit message at the command line level
94
                        start_message=None):
1167 by Martin Pool
- split commit message editor functions out into own file
95
    """Let the user edit a commit message in a temp file.
96
97
    This is run if they don't give a message or
98
    message-containing file on the command line.
99
2472.4.1 by Alexander Belchenko
Bugfix #110901: commit message template written with native line-endings; corresponding unit tests added
100
    :param infotext:    Text to be displayed at bottom of message
101
                        for the user's reference;
102
                        currently similar to 'bzr status'.
2598.6.17 by ghigo
Revert the behaviour of the function make_commit_message_template() and make_commit_message_template() to the original one.
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
2598.6.18 by ghigo
Update the tests to the new *_encoded() functions
113
    if not start_message is None:
3224.5.1 by Andrew Bennetts
Lots of assorted hackery to reduce the number of imports for common operations. Improves 'rocks', 'st' and 'help' times by ~50ms on my laptop.
114
        start_message = start_message.encode(osutils.get_user_encoding())
115
    infotext = infotext.encode(osutils.get_user_encoding(), 'replace')
2804.4.1 by Alexander Belchenko
some win32-specific fixes for selftest
116
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
2598.6.17 by ghigo
Revert the behaviour of the function make_commit_message_template() and make_commit_message_template() to the original one.
117
2598.6.21 by ghigo
updates on the basis of Jhon email
118
2598.6.17 by ghigo
Revert the behaviour of the function make_commit_message_template() and make_commit_message_template() to the original one.
119
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
2598.6.23 by ghigo
Cosmetic clean up
120
                                start_message=None):
2598.6.17 by ghigo
Revert the behaviour of the function make_commit_message_template() and make_commit_message_template() to the original one.
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'.
2598.6.12 by ghigo
Move the encoding of the commit message at the command line level
129
                        The string is already encoded
2472.4.1 by Alexander Belchenko
Bugfix #110901: commit message template written with native line-endings; corresponding unit tests added
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.
2598.6.15 by ghigo
Update the param description
136
                            The string is already encoded
2472.4.1 by Alexander Belchenko
Bugfix #110901: commit message template written with native line-endings; corresponding unit tests added
137
138
    :return:    commit message or None.
1167 by Martin Pool
- split commit message editor functions out into own file
139
    """
1704.2.21 by Martin Pool
Fix unbound local when handling failure to write message template
140
    msgfilename = None
1167 by Martin Pool
- split commit message editor functions out into own file
141
    try:
2472.4.1 by Alexander Belchenko
Bugfix #110901: commit message template written with native line-endings; corresponding unit tests added
142
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
2598.6.12 by ghigo
Move the encoding of the commit message at the command line level
143
                                    infotext, ignoreline, start_message)
2472.4.1 by Alexander Belchenko
Bugfix #110901: commit message template written with native line-endings; corresponding unit tests added
144
145
        if not msgfilename or not _run_editor(msgfilename):
1167 by Martin Pool
- split commit message editor functions out into own file
146
            return None
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
147
1167 by Martin Pool
- split commit message editor functions out into own file
148
        started = False
149
        msg = []
150
        lastline, nlines = 0, 0
2472.4.1 by Alexander Belchenko
Bugfix #110901: commit message template written with native line-endings; corresponding unit tests added
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')
2625.9.4 by Daniel Watkins
Fixed editor commit message to die cleanly if a UnicodeDecodeError is thrown.
154
        try:
2765.1.2 by Ian Clatworthy
fix try/except/finally nesting for Python 2.4
155
            try:
3224.5.1 by Andrew Bennetts
Lots of assorted hackery to reduce the number of imports for common operations. Improves 'rocks', 'st' and 'help' times by ~50ms on my laptop.
156
                for line in codecs.getreader(osutils.get_user_encoding())(f):
2765.1.2 by Ian Clatworthy
fix try/except/finally nesting for Python 2.4
157
                    stripped_line = line.strip()
158
                    # strip empty line before the log message starts
159
                    if not started:
160
                        if stripped_line != "":
161
                            started = True
162
                        else:
163
                            continue
164
                    # check for the ignore line only if there
165
                    # is additional information at the end
166
                    if hasinfo and stripped_line == ignoreline:
167
                        break
168
                    nlines += 1
169
                    # keep track of the last line that had some content
2625.9.4 by Daniel Watkins
Fixed editor commit message to die cleanly if a UnicodeDecodeError is thrown.
170
                    if stripped_line != "":
2765.1.2 by Ian Clatworthy
fix try/except/finally nesting for Python 2.4
171
                        lastline = nlines
172
                    msg.append(line)
173
            except UnicodeDecodeError:
174
                raise BadCommitMessageEncoding()
2625.9.8 by Daniel Watkins
Updated as per poolie's !tweak.
175
        finally:
176
            f.close()
2472.4.1 by Alexander Belchenko
Bugfix #110901: commit message template written with native line-endings; corresponding unit tests added
177
1393.3.3 by Jelmer Vernooij
Add test for empty commit messages.
178
        if len(msg) == 0:
1393.3.2 by Jelmer Vernooij
Fix error message when an empty commit message was specified (when using an editor). Previously bzr warned that it wanted either --message or --file.
179
            return ""
1167 by Martin Pool
- split commit message editor functions out into own file
180
        # delete empty lines at the end
181
        del msg[lastline:]
182
        # add a newline at the end, if needed
183
        if not msg[-1].endswith("\n"):
184
            return "%s%s" % ("".join(msg), "\n")
185
        else:
186
            return "".join(msg)
187
    finally:
188
        # delete the msg file in any case
1704.2.21 by Martin Pool
Fix unbound local when handling failure to write message template
189
        if msgfilename is not None:
190
            try:
191
                os.unlink(msgfilename)
192
            except IOError, e:
3910.1.1 by Andrew Bennetts
Improve error handling in msgeditor._run_editor.
193
                trace.warning(
194
                    "failed to unlink %s: %s; ignored", msgfilename, e)
1167 by Martin Pool
- split commit message editor functions out into own file
195
1185.33.72 by Martin Pool
Fix commit message template for non-ascii files, and add test for handling of
196
2472.4.1 by Alexander Belchenko
Bugfix #110901: commit message template written with native line-endings; corresponding unit tests added
197
def _create_temp_file_with_commit_template(infotext,
198
                                           ignoreline=DEFAULT_IGNORE_LINE,
2598.6.12 by ghigo
Move the encoding of the commit message at the command line level
199
                                           start_message=None):
2472.4.1 by Alexander Belchenko
Bugfix #110901: commit message template written with native line-endings; corresponding unit tests added
200
    """Create temp file and write commit template in it.
201
202
    :param infotext:    Text to be displayed at bottom of message
203
                        for the user's reference;
204
                        currently similar to 'bzr status'.
2598.6.12 by ghigo
Move the encoding of the commit message at the command line level
205
                        The text is already encoded.
2472.4.1 by Alexander Belchenko
Bugfix #110901: commit message template written with native line-endings; corresponding unit tests added
206
207
    :param ignoreline:  The separator to use above the infotext.
208
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.
2598.6.15 by ghigo
Update the param description
212
                            The string is already encoded
2472.4.1 by Alexander Belchenko
Bugfix #110901: commit message template written with native line-endings; corresponding unit tests added
213
214
    :return:    2-tuple (temp file name, hasinfo)
215
    """
216
    import tempfile
217
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
3004.1.4 by Daniel Watkins
Modified fix as suggested by John on-list.
218
                                               dir='.',
2472.4.1 by Alexander Belchenko
Bugfix #110901: commit message template written with native line-endings; corresponding unit tests added
219
                                               text=True)
3004.1.2 by Daniel Watkins
Temp files containing a commit message can now be created in a folder with a Unicode name.
220
    msgfilename = osutils.basename(msgfilename)
3004.1.4 by Daniel Watkins
Modified fix as suggested by John on-list.
221
    msgfile = os.fdopen(tmp_fileno, 'w')
2472.4.1 by Alexander Belchenko
Bugfix #110901: commit message template written with native line-endings; corresponding unit tests added
222
    try:
223
        if start_message is not None:
2598.6.12 by ghigo
Move the encoding of the commit message at the command line level
224
            msgfile.write("%s\n" % start_message)
2472.4.1 by Alexander Belchenko
Bugfix #110901: commit message template written with native line-endings; corresponding unit tests added
225
2598.6.20 by ghigo
Small clean up
226
        if infotext is not None and infotext != "":
2472.4.1 by Alexander Belchenko
Bugfix #110901: commit message template written with native line-endings; corresponding unit tests added
227
            hasinfo = True
2598.6.12 by ghigo
Move the encoding of the commit message at the command line level
228
            msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
2472.4.1 by Alexander Belchenko
Bugfix #110901: commit message template written with native line-endings; corresponding unit tests added
229
        else:
230
            hasinfo = False
231
    finally:
232
        msgfile.close()
233
234
    return (msgfilename, hasinfo)
235
2598.6.20 by ghigo
Small clean up
236
2598.6.17 by ghigo
Revert the behaviour of the function make_commit_message_template() and make_commit_message_template() to the original one.
237
def make_commit_message_template(working_tree, specific_files):
1185.33.72 by Martin Pool
Fix commit message template for non-ascii files, and add test for handling of
238
    """Prepare a template file for a commit into a branch.
239
2598.6.17 by ghigo
Revert the behaviour of the function make_commit_message_template() and make_commit_message_template() to the original one.
240
    Returns a unicode string containing the template.
1185.33.72 by Martin Pool
Fix commit message template for non-ascii files, and add test for handling of
241
    """
242
    # TODO: make provision for this to be overridden or modified by a hook
243
    #
244
    # TODO: Rather than running the status command, should prepare a draft of
245
    # the revision to be committed, then pause and ask the user to
246
    # confirm/write a message.
247
    from StringIO import StringIO       # must be unicode-safe
1551.2.9 by Aaron Bentley
Fix status to work with checkouts
248
    from bzrlib.status import show_tree_status
2598.6.5 by ghigo
On the basis of the email from Martin, Aaron I changed the encoding logic
249
    status_tmp = StringIO()
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
250
    show_tree_status(working_tree, specific_files=specific_files,
3968.1.1 by Colin D Bennett
Show all pending merge revisions in the commit message template.
251
                     to_file=status_tmp, verbose=True)
2598.6.17 by ghigo
Revert the behaviour of the function make_commit_message_template() and make_commit_message_template() to the original one.
252
    return status_tmp.getvalue()
253
254
255
def make_commit_message_template_encoded(working_tree, specific_files,
2598.6.30 by ghigo
- Updated the identation on the basis of Aaron suggestions
256
                                         diff=None, output_encoding='utf-8'):
2598.6.17 by ghigo
Revert the behaviour of the function make_commit_message_template() and make_commit_message_template() to the original one.
257
    """Prepare a template file for a commit into a branch.
258
259
    Returns an encoded string.
260
    """
261
    # TODO: make provision for this to be overridden or modified by a hook
262
    #
263
    # TODO: Rather than running the status command, should prepare a draft of
264
    # the revision to be committed, then pause and ask the user to
265
    # confirm/write a message.
266
    from StringIO import StringIO       # must be unicode-safe
267
    from bzrlib.diff import show_diff_trees
268
2598.6.24 by ghigo
update on the basis of Aaron suggestions
269
    template = make_commit_message_template(working_tree, specific_files)
270
    template = template.encode(output_encoding, "replace")
2598.6.17 by ghigo
Revert the behaviour of the function make_commit_message_template() and make_commit_message_template() to the original one.
271
2598.6.1 by ghigo
add support for the diff at the end of the commit messages
272
    if diff:
2598.6.5 by ghigo
On the basis of the email from Martin, Aaron I changed the encoding logic
273
        stream = StringIO()
2598.6.12 by ghigo
Move the encoding of the commit message at the command line level
274
        show_diff_trees(working_tree.basis_tree(),
2598.6.26 by ghigo
small cleanup
275
                        working_tree, stream, specific_files,
276
                        path_encoding=output_encoding)
2598.6.21 by ghigo
updates on the basis of Jhon email
277
        template = template + '\n' + stream.getvalue()
2598.6.12 by ghigo
Move the encoding of the commit message at the command line level
278
279
    return template
3642.2.1 by Jelmer Vernooij
Add simple commit message template hook.
280
281
282
class MessageEditorHooks(Hooks):
283
    """A dictionary mapping hook name to a list of callables for message editor
284
    hooks.
285
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
286
    e.g. ['commit_message_template'] is the list of items to be called to
3642.2.1 by Jelmer Vernooij
Add simple commit message template hook.
287
    generate a commit message template
288
    """
289
290
    def __init__(self):
291
        """Create the default hooks.
292
293
        These are all empty initially.
294
        """
295
        Hooks.__init__(self)
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
296
        self.create_hook(HookPoint('commit_message_template',
297
            "Called when a commit message is being generated. "
298
            "commit_message_template is called with the bzrlib.commit.Commit "
299
            "object and the message that is known so far. "
300
            "commit_message_template must return a new message to use (which "
301
            "could be the same as it was given. When there are multiple "
302
            "hooks registered for commit_message_template, they are chained "
303
            "with the result from the first passed into the second, and so "
304
            "on.", (1, 10), None))
3642.2.1 by Jelmer Vernooij
Add simple commit message template hook.
305
306
307
hooks = MessageEditorHooks()
308
309
310
def generate_commit_message_template(commit, start_message=None):
311
    """Generate a commit message template.
312
313
    :param commit: Commit object for the active commit.
314
    :param start_message: Message to start with.
315
    :return: A start commit message or None for an empty start commit message.
316
    """
317
    start_message = None
318
    for hook in hooks['commit_message_template']:
3642.2.2 by Jelmer Vernooij
Add tests for commit_message_template hooks.
319
        start_message = hook(commit, start_message)
3642.2.1 by Jelmer Vernooij
Add simple commit message template hook.
320
    return start_message