/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 breezy/msgeditor.py

  • Committer: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

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