/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

Multiple merges:
 * push should work with branches without a working tree.
 * Knit pushes on SFTP are now much faster (removed a bad latency multiplier).
 * Reconciles at the end of fetch now skip non-dataloss issues. The command line
   reconcile will still check all data.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
 
1
# Copyright (C) 2005, 2006 by 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
"""Commit message editor support."""
 
19
 
 
20
import os
 
21
import errno
 
22
from subprocess import call
 
23
 
 
24
import bzrlib.config as config
 
25
from bzrlib.errors import BzrError
 
26
 
 
27
def _get_editor():
 
28
    """Return a sequence of possible editor binaries for the current platform"""
 
29
    try:
 
30
        yield os.environ["BZR_EDITOR"]
 
31
    except KeyError:
 
32
        pass
 
33
 
 
34
    e = config.GlobalConfig().get_editor()
 
35
    if e is not None:
 
36
        yield e
 
37
        
 
38
    try:
 
39
        yield os.environ["EDITOR"]
 
40
    except KeyError:
 
41
        pass
 
42
 
 
43
    if sys.platform == 'win32':
 
44
        for editor in 'wordpad.exe', 'notepad.exe':
 
45
            yield editor
 
46
    else:
 
47
        for editor in ['vi', 'pico', 'nano', 'joe']:
 
48
            yield editor
 
49
 
 
50
 
 
51
def _run_editor(filename):
 
52
    """Try to execute an editor to edit the commit message."""
 
53
    for e in _get_editor():
 
54
        edargs = e.split(' ')
 
55
        try:
 
56
            x = call(edargs + [filename])
 
57
        except OSError, e:
 
58
           # We're searching for an editor, so catch safe errors and continue
 
59
           if e.errno in (errno.ENOENT, ):
 
60
               continue
 
61
           raise
 
62
        if x == 0:
 
63
            return True
 
64
        elif x == 127:
 
65
            continue
 
66
        else:
 
67
            break
 
68
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
 
69
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n - $EDITOR" % \
 
70
                    config.config_filename())
 
71
 
 
72
 
 
73
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
 
74
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
 
75
 
 
76
 
 
77
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
 
78
    """Let the user edit a commit message in a temp file.
 
79
 
 
80
    This is run if they don't give a message or
 
81
    message-containing file on the command line.
 
82
 
 
83
    infotext:
 
84
        Text to be displayed at bottom of message for
 
85
        the user's reference; currently similar to
 
86
        'bzr status'.
 
87
    """
 
88
    import tempfile
 
89
 
 
90
    try:
 
91
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
 
92
        msgfile = os.close(tmp_fileno)
 
93
        if infotext is not None and infotext != "":
 
94
            hasinfo = True
 
95
            msgfile = file(msgfilename, "w")
 
96
            msgfile.write("\n%s\n\n%s" % (ignoreline, infotext))
 
97
            msgfile.close()
 
98
        else:
 
99
            hasinfo = False
 
100
 
 
101
        if not _run_editor(msgfilename):
 
102
            return None
 
103
        
 
104
        started = False
 
105
        msg = []
 
106
        lastline, nlines = 0, 0
 
107
        for line in file(msgfilename, "r"):
 
108
            stripped_line = line.strip()
 
109
            # strip empty line before the log message starts
 
110
            if not started:
 
111
                if stripped_line != "":
 
112
                    started = True
 
113
                else:
 
114
                    continue
 
115
            # check for the ignore line only if there
 
116
            # is additional information at the end
 
117
            if hasinfo and stripped_line == ignoreline:
 
118
                break
 
119
            nlines += 1
 
120
            # keep track of the last line that had some content
 
121
            if stripped_line != "":
 
122
                lastline = nlines
 
123
            msg.append(line)
 
124
            
 
125
        if len(msg) == 0:
 
126
            return ""
 
127
        # delete empty lines at the end
 
128
        del msg[lastline:]
 
129
        # add a newline at the end, if needed
 
130
        if not msg[-1].endswith("\n"):
 
131
            return "%s%s" % ("".join(msg), "\n")
 
132
        else:
 
133
            return "".join(msg)
 
134
    finally:
 
135
        # delete the msg file in any case
 
136
        try: os.unlink(msgfilename)
 
137
        except IOError: pass
 
138
 
 
139
 
 
140
def make_commit_message_template(working_tree, specific_files):
 
141
    """Prepare a template file for a commit into a branch.
 
142
 
 
143
    Returns a unicode string containing the template.
 
144
    """
 
145
    # TODO: Should probably be given the WorkingTree not the branch
 
146
    #
 
147
    # TODO: make provision for this to be overridden or modified by a hook
 
148
    #
 
149
    # TODO: Rather than running the status command, should prepare a draft of
 
150
    # the revision to be committed, then pause and ask the user to
 
151
    # confirm/write a message.
 
152
    from StringIO import StringIO       # must be unicode-safe
 
153
    from bzrlib.status import show_tree_status
 
154
    status_tmp = StringIO()
 
155
    show_tree_status(working_tree, specific_files=specific_files, 
 
156
                     to_file=status_tmp)
 
157
    return status_tmp.getvalue()