← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Martin Pool
  • Date: 2007-04-04 06:17:31 UTC
  • mto: This revision was merged to the branch mainline in revision 2397.
  • Revision ID: mbp@sourcefrog.net-20070404061731-tt2xrzllqhbodn83
Contents of TODO file moved into bug tracker

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
 
1
# Copyright (C) 2005, 2006 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 codecs
 
21
import errno
 
22
import os
 
23
from subprocess import call
 
24
import sys
 
25
 
 
26
import bzrlib
 
27
import bzrlib.config as config
 
28
from bzrlib.errors import BzrError
 
29
from bzrlib.trace import warning, mutter
 
30
 
 
31
 
 
32
def _get_editor():
 
33
    """Return a sequence of possible editor binaries for the current platform"""
 
34
    try:
 
35
        yield os.environ["BZR_EDITOR"]
 
36
    except KeyError:
 
37
        pass
 
38
 
 
39
    e = config.GlobalConfig().get_editor()
 
40
    if e is not None:
 
41
        yield e
 
42
        
 
43
    for varname in 'VISUAL', 'EDITOR':
 
44
        if varname in os.environ:
 
45
            yield os.environ[varname]
 
46
 
 
47
    if sys.platform == 'win32':
 
48
        for editor in 'wordpad.exe', 'notepad.exe':
 
49
            yield editor
 
50
    else:
 
51
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
 
52
            yield editor
 
53
 
 
54
 
 
55
def _run_editor(filename):
 
56
    """Try to execute an editor to edit the commit message."""
 
57
    for e in _get_editor():
 
58
        edargs = e.split(' ')
 
59
        try:
 
60
            ## mutter("trying editor: %r", (edargs +[filename]))
 
61
            x = call(edargs + [filename])
 
62
        except OSError, e:
 
63
           # We're searching for an editor, so catch safe errors and continue
 
64
           if e.errno in (errno.ENOENT, ):
 
65
               continue
 
66
           raise
 
67
        if x == 0:
 
68
            return True
 
69
        elif x == 127:
 
70
            continue
 
71
        else:
 
72
            break
 
73
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
 
74
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n"
 
75
                   " - $VISUAL\n - $EDITOR" % \
 
76
                    config.config_filename())
 
77
 
 
78
 
 
79
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
 
80
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
 
81
 
 
82
 
 
83
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE,
 
84
                        start_message=None):
 
85
    """Let the user edit a commit message in a temp file.
 
86
 
 
87
    This is run if they don't give a message or
 
88
    message-containing file on the command line.
 
89
 
 
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
 
 
104
    msgfilename = None
 
105
    try:
 
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):
 
124
            return None
 
125
        
 
126
        started = False
 
127
        msg = []
 
128
        lastline, nlines = 0, 0
 
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
            
 
147
        if len(msg) == 0:
 
148
            return ""
 
149
        # delete empty lines at the end
 
150
        del msg[lastline:]
 
151
        # add a newline at the end, if needed
 
152
        if not msg[-1].endswith("\n"):
 
153
            return "%s%s" % ("".join(msg), "\n")
 
154
        else:
 
155
            return "".join(msg)
 
156
    finally:
 
157
        # delete the msg file in any case
 
158
        if msgfilename is not None:
 
159
            try:
 
160
                os.unlink(msgfilename)
 
161
            except IOError, e:
 
162
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
 
163
 
 
164
 
 
165
def make_commit_message_template(working_tree, specific_files):
 
166
    """Prepare a template file for a commit into a branch.
 
167
 
 
168
    Returns a unicode string containing the template.
 
169
    """
 
170
    # TODO: Should probably be given the WorkingTree not the branch
 
171
    #
 
172
    # TODO: make provision for this to be overridden or modified by a hook
 
173
    #
 
174
    # TODO: Rather than running the status command, should prepare a draft of
 
175
    # the revision to be committed, then pause and ask the user to
 
176
    # confirm/write a message.
 
177
    from StringIO import StringIO       # must be unicode-safe
 
178
    from bzrlib.status import show_tree_status
 
179
    status_tmp = StringIO()
 
180
    show_tree_status(working_tree, specific_files=specific_files, 
 
181
                     to_file=status_tmp)
 
182
    return status_tmp.getvalue()