← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-01-03 07:39:47 UTC
  • mfrom: (2215.5.1 bzr_man.rstx)
  • Revision ID: pqm@pqm.ubuntu.com-20070103073947-f9906c0b1f425aa9
(bialix) Fix generation of rstx man page

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
    """Let the user edit a commit message in a temp file.
 
85
 
 
86
    This is run if they don't give a message or
 
87
    message-containing file on the command line.
 
88
 
 
89
    infotext:
 
90
        Text to be displayed at bottom of message for
 
91
        the user's reference; currently similar to
 
92
        'bzr status'.
 
93
    """
 
94
    import tempfile
 
95
 
 
96
    msgfilename = None
 
97
    try:
 
98
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
 
99
        msgfile = os.close(tmp_fileno)
 
100
        if infotext is not None and infotext != "":
 
101
            hasinfo = True
 
102
            msgfile = file(msgfilename, "w")
 
103
            msgfile.write("\n\n%s\n\n%s" % (ignoreline,
 
104
                infotext.encode(bzrlib.user_encoding, 'replace')))
 
105
            msgfile.close()
 
106
        else:
 
107
            hasinfo = False
 
108
 
 
109
        if not _run_editor(msgfilename):
 
110
            return None
 
111
        
 
112
        started = False
 
113
        msg = []
 
114
        lastline, nlines = 0, 0
 
115
        for line in codecs.open(msgfilename, 'r', bzrlib.user_encoding):
 
116
            stripped_line = line.strip()
 
117
            # strip empty line before the log message starts
 
118
            if not started:
 
119
                if stripped_line != "":
 
120
                    started = True
 
121
                else:
 
122
                    continue
 
123
            # check for the ignore line only if there
 
124
            # is additional information at the end
 
125
            if hasinfo and stripped_line == ignoreline:
 
126
                break
 
127
            nlines += 1
 
128
            # keep track of the last line that had some content
 
129
            if stripped_line != "":
 
130
                lastline = nlines
 
131
            msg.append(line)
 
132
            
 
133
        if len(msg) == 0:
 
134
            return ""
 
135
        # delete empty lines at the end
 
136
        del msg[lastline:]
 
137
        # add a newline at the end, if needed
 
138
        if not msg[-1].endswith("\n"):
 
139
            return "%s%s" % ("".join(msg), "\n")
 
140
        else:
 
141
            return "".join(msg)
 
142
    finally:
 
143
        # delete the msg file in any case
 
144
        if msgfilename is not None:
 
145
            try:
 
146
                os.unlink(msgfilename)
 
147
            except IOError, e:
 
148
                warning("failed to unlink %s: %s; ignored", msgfilename, e)
 
149
 
 
150
 
 
151
def make_commit_message_template(working_tree, specific_files):
 
152
    """Prepare a template file for a commit into a branch.
 
153
 
 
154
    Returns a unicode string containing the template.
 
155
    """
 
156
    # TODO: Should probably be given the WorkingTree not the branch
 
157
    #
 
158
    # TODO: make provision for this to be overridden or modified by a hook
 
159
    #
 
160
    # TODO: Rather than running the status command, should prepare a draft of
 
161
    # the revision to be committed, then pause and ask the user to
 
162
    # confirm/write a message.
 
163
    from StringIO import StringIO       # must be unicode-safe
 
164
    from bzrlib.status import show_tree_status
 
165
    status_tmp = StringIO()
 
166
    show_tree_status(working_tree, specific_files=specific_files, 
 
167
                     to_file=status_tmp)
 
168
    return status_tmp.getvalue()