← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Andrew Bennetts
  • Date: 2007-03-26 06:24:01 UTC
  • mto: This revision was merged to the branch mainline in revision 2376.
  • Revision ID: andrew.bennetts@canonical.com-20070326062401-k3nbefzje5332jaf
Deal with review comments from Robert:

  * Add my name to the NEWS file
  * Move the test case to a new module in branch_implementations
  * Remove revision_history cruft from identitymap and test_identitymap
  * Improve some docstrings

Also, this fixes a bug where revision_history was not returning a copy of the
cached data, allowing the cache to be corrupted.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
25
25
 
26
26
import bzrlib
27
27
import bzrlib.config as config
28
 
from bzrlib import osutils
29
 
from bzrlib.errors import BzrError, BadCommitMessageEncoding
 
28
from bzrlib.errors import BzrError
30
29
from bzrlib.trace import warning, mutter
31
30
 
32
31
 
61
60
            ## mutter("trying editor: %r", (edargs +[filename]))
62
61
            x = call(edargs + [filename])
63
62
        except OSError, e:
64
 
            # We're searching for an editor, so catch safe errors and continue
65
 
            if e.errno in (errno.ENOENT, ):
66
 
                continue
67
 
            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
68
67
        if x == 0:
69
68
            return True
70
69
        elif x == 127:
88
87
    This is run if they don't give a message or
89
88
    message-containing file on the command line.
90
89
 
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
 
    """
 
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
 
131
104
    msgfilename = None
132
105
    try:
133
 
        msgfilename, hasinfo = _create_temp_file_with_commit_template(
134
 
                                    infotext, ignoreline, start_message)
135
 
 
136
 
        if not msgfilename or not _run_editor(msgfilename):
 
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
 
 
123
        if not _run_editor(msgfilename):
137
124
            return None
138
125
        
139
126
        started = False
140
127
        msg = []
141
128
        lastline, nlines = 0, 0
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
 
 
 
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
            
169
147
        if len(msg) == 0:
170
148
            return ""
171
149
        # delete empty lines at the end
184
162
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
185
163
 
186
164
 
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)
225
 
 
226
 
 
227
165
def make_commit_message_template(working_tree, specific_files):
228
166
    """Prepare a template file for a commit into a branch.
229
167
 
230
168
    Returns a unicode string containing the template.
231
169
    """
 
170
    # TODO: Should probably be given the WorkingTree not the branch
 
171
    #
232
172
    # TODO: make provision for this to be overridden or modified by a hook
233
173
    #
234
174
    # TODO: Rather than running the status command, should prepare a draft of
240
180
    show_tree_status(working_tree, specific_files=specific_files, 
241
181
                     to_file=status_tmp)
242
182
    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