← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Vincent Ladeuil
  • Date: 2008-01-29 15:16:31 UTC
  • mto: (3206.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 3207.
  • Revision ID: v.ladeuil+lp@free.fr-20080129151631-vqjd13tb405mobx6
Fix two more leaking tmp dirs, by reworking TransformPreview lock handling.

* bzrlib/tests/test_transform.py:
(TestTransformMerge): Revert previous patch and cleanly call
preview.finalize now that we can.

* bzrlib/tests/test_merge.py:
(TestMerge.test_make_preview_transform): Catch TransformPreview
leak.

* bzrlib/builtins.py:
(cmd_merge._do_preview): Finalize the TransformPreview or the
limbodir will stay in /tmp.

* bzrlib/transform.py:
(TreeTransformBase.__init__): Create the _deletiondir since it's
reffered to by finalize.
(TreeTransformBase.finalize): Delete the dir only if _deletiondir
is set.
(TreeTransform.__init__): Use a temp var for deletiondir and set
the attribute after the base class __init__ has been called.
(TransformPreview.__init__): Read locks the tree since finalize
wants to unlock it (as suggested by Aaron).

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
17
 
18
18
"""Commit message editor support."""
19
19
 
20
 
 
 
20
import codecs
21
21
import errno
22
22
import os
23
23
from subprocess import call
24
24
import sys
25
25
 
 
26
import bzrlib
26
27
import bzrlib.config as config
27
 
from bzrlib.errors import BzrError
 
28
from bzrlib import osutils
 
29
from bzrlib.errors import BzrError, BadCommitMessageEncoding
 
30
from bzrlib.trace import warning, mutter
28
31
 
29
32
 
30
33
def _get_editor():
39
42
        yield e
40
43
        
41
44
    for varname in 'VISUAL', 'EDITOR':
42
 
        if os.environ.has_key(varname):
 
45
        if varname in os.environ:
43
46
            yield os.environ[varname]
44
47
 
45
48
    if sys.platform == 'win32':
55
58
    for e in _get_editor():
56
59
        edargs = e.split(' ')
57
60
        try:
 
61
            ## mutter("trying editor: %r", (edargs +[filename]))
58
62
            x = call(edargs + [filename])
59
63
        except OSError, e:
60
64
           # We're searching for an editor, so catch safe errors and continue
68
72
        else:
69
73
            break
70
74
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
71
 
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n - $EDITOR" % \
 
75
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n"
 
76
                   " - $VISUAL\n - $EDITOR" % \
72
77
                    config.config_filename())
73
78
 
74
79
 
76
81
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
77
82
 
78
83
 
79
 
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
80
 
    """Let the user edit a commit message in a temp file.
81
 
 
82
 
    This is run if they don't give a message or
83
 
    message-containing file on the command line.
84
 
 
85
 
    infotext:
86
 
        Text to be displayed at bottom of message for
87
 
        the user's reference; currently similar to
88
 
        'bzr status'.
89
 
    """
90
 
    import tempfile
91
 
 
 
84
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
 
85
                        start_message=None):
 
86
    """Let the user edit a commit message in a temp file.
 
87
 
 
88
    This is run if they don't give a message or
 
89
    message-containing file on the command line.
 
90
 
 
91
    :param infotext:    Text to be displayed at bottom of message
 
92
                        for the user's reference;
 
93
                        currently similar to 'bzr status'.
 
94
 
 
95
    :param ignoreline:  The separator to use above the infotext.
 
96
 
 
97
    :param start_message:   The text to place above the separator, if any.
 
98
                            This will not be removed from the message
 
99
                            after the user has edited it.
 
100
 
 
101
    :return:    commit message or None.
 
102
    """
 
103
 
 
104
    if not start_message is None:
 
105
        start_message = start_message.encode(bzrlib.user_encoding)
 
106
    infotext = infotext.encode(bzrlib.user_encoding, 'replace')
 
107
    return edit_commit_message_encoded(infotext, ignoreline, start_message)
 
108
 
 
109
 
 
110
def edit_commit_message_encoded(infotext, ignoreline=DEFAULT_IGNORE_LINE,
 
111
                                start_message=None):
 
112
    """Let the user edit a commit message in a temp file.
 
113
 
 
114
    This is run if they don't give a message or
 
115
    message-containing file on the command line.
 
116
 
 
117
    :param infotext:    Text to be displayed at bottom of message
 
118
                        for the user's reference;
 
119
                        currently similar to 'bzr status'.
 
120
                        The string is already encoded
 
121
 
 
122
    :param ignoreline:  The separator to use above the infotext.
 
123
 
 
124
    :param start_message:   The text to place above the separator, if any.
 
125
                            This will not be removed from the message
 
126
                            after the user has edited it.
 
127
                            The string is already encoded
 
128
 
 
129
    :return:    commit message or None.
 
130
    """
92
131
    msgfilename = None
93
132
    try:
94
 
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
95
 
        msgfile = os.close(tmp_fileno)
96
 
        if infotext is not None and infotext != "":
97
 
            hasinfo = True
98
 
            msgfile = file(msgfilename, "w")
99
 
            msgfile.write("\n%s\n\n%s" % (ignoreline, infotext))
100
 
            msgfile.close()
101
 
        else:
102
 
            hasinfo = False
 
133
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
 
134
                                    infotext, ignoreline, start_message)
103
135
 
104
 
        if not _run_editor(msgfilename):
 
136
        if not msgfilename or not _run_editor(msgfilename):
105
137
            return None
106
138
        
107
139
        started = False
108
140
        msg = []
109
141
        lastline, nlines = 0, 0
110
 
        for line in file(msgfilename, "r"):
111
 
            stripped_line = line.strip()
112
 
            # strip empty line before the log message starts
113
 
            if not started:
114
 
                if stripped_line != "":
115
 
                    started = True
116
 
                else:
117
 
                    continue
118
 
            # check for the ignore line only if there
119
 
            # is additional information at the end
120
 
            if hasinfo and stripped_line == ignoreline:
121
 
                break
122
 
            nlines += 1
123
 
            # keep track of the last line that had some content
124
 
            if stripped_line != "":
125
 
                lastline = nlines
126
 
            msg.append(line)
127
 
            
 
142
        # codecs.open() ALWAYS opens file in binary mode but we need text mode
 
143
        # 'rU' mode useful when bzr.exe used on Cygwin (bialix 20070430)
 
144
        f = file(msgfilename, 'rU')
 
145
        try:
 
146
            try:
 
147
                for line in codecs.getreader(bzrlib.user_encoding)(f):
 
148
                    stripped_line = line.strip()
 
149
                    # strip empty line before the log message starts
 
150
                    if not started:
 
151
                        if stripped_line != "":
 
152
                            started = True
 
153
                        else:
 
154
                            continue
 
155
                    # check for the ignore line only if there
 
156
                    # is additional information at the end
 
157
                    if hasinfo and stripped_line == ignoreline:
 
158
                        break
 
159
                    nlines += 1
 
160
                    # keep track of the last line that had some content
 
161
                    if stripped_line != "":
 
162
                        lastline = nlines
 
163
                    msg.append(line)
 
164
            except UnicodeDecodeError:
 
165
                raise BadCommitMessageEncoding()
 
166
        finally:
 
167
            f.close()
 
168
 
128
169
        if len(msg) == 0:
129
170
            return ""
130
171
        # delete empty lines at the end
140
181
            try:
141
182
                os.unlink(msgfilename)
142
183
            except IOError, e:
143
 
                mutter("failed to unlink %s: %s; ignored", msgfilename, e)
 
184
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
 
185
 
 
186
 
 
187
def _create_temp_file_with_commit_template(infotext,
 
188
                                           ignoreline=DEFAULT_IGNORE_LINE,
 
189
                                           start_message=None):
 
190
    """Create temp file and write commit template in it.
 
191
 
 
192
    :param infotext:    Text to be displayed at bottom of message
 
193
                        for the user's reference;
 
194
                        currently similar to 'bzr status'.
 
195
                        The text is already encoded.
 
196
 
 
197
    :param ignoreline:  The separator to use above the infotext.
 
198
 
 
199
    :param start_message:   The text to place above the separator, if any.
 
200
                            This will not be removed from the message
 
201
                            after the user has edited it.
 
202
                            The string is already encoded
 
203
 
 
204
    :return:    2-tuple (temp file name, hasinfo)
 
205
    """
 
206
    import tempfile
 
207
    tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.',
 
208
                                               dir='.',
 
209
                                               text=True)
 
210
    msgfilename = osutils.basename(msgfilename)
 
211
    msgfile = os.fdopen(tmp_fileno, 'w')
 
212
    try:
 
213
        if start_message is not None:
 
214
            msgfile.write("%s\n" % start_message)
 
215
 
 
216
        if infotext is not None and infotext != "":
 
217
            hasinfo = True
 
218
            msgfile.write("\n\n%s\n\n%s" %(ignoreline, infotext))
 
219
        else:
 
220
            hasinfo = False
 
221
    finally:
 
222
        msgfile.close()
 
223
 
 
224
    return (msgfilename, hasinfo)
144
225
 
145
226
 
146
227
def make_commit_message_template(working_tree, specific_files):
148
229
 
149
230
    Returns a unicode string containing the template.
150
231
    """
151
 
    # TODO: Should probably be given the WorkingTree not the branch
152
 
    #
153
232
    # TODO: make provision for this to be overridden or modified by a hook
154
233
    #
155
234
    # TODO: Rather than running the status command, should prepare a draft of
161
240
    show_tree_status(working_tree, specific_files=specific_files, 
162
241
                     to_file=status_tmp)
163
242
    return status_tmp.getvalue()
 
243
 
 
244
 
 
245
def make_commit_message_template_encoded(working_tree, specific_files,
 
246
                                         diff=None, output_encoding='utf-8'):
 
247
    """Prepare a template file for a commit into a branch.
 
248
 
 
249
    Returns an encoded string.
 
250
    """
 
251
    # TODO: make provision for this to be overridden or modified by a hook
 
252
    #
 
253
    # TODO: Rather than running the status command, should prepare a draft of
 
254
    # the revision to be committed, then pause and ask the user to
 
255
    # confirm/write a message.
 
256
    from StringIO import StringIO       # must be unicode-safe
 
257
    from bzrlib.diff import show_diff_trees
 
258
 
 
259
    template = make_commit_message_template(working_tree, specific_files)
 
260
    template = template.encode(output_encoding, "replace")
 
261
 
 
262
    if diff:
 
263
        stream = StringIO()
 
264
        show_diff_trees(working_tree.basis_tree(),
 
265
                        working_tree, stream, specific_files,
 
266
                        path_encoding=output_encoding)
 
267
        template = template + '\n' + stream.getvalue()
 
268
 
 
269
    return template