/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

Make msgeditor invocation comply with Debian Policy.

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
 
 
21
import errno
 
22
import os
 
23
from subprocess import call
 
24
import sys
 
25
 
 
26
import bzrlib.config as config
 
27
from bzrlib.errors import BzrError
 
28
 
 
29
 
 
30
def _get_editor():
 
31
    """Return a sequence of possible editor binaries for the current platform"""
 
32
    try:
 
33
        yield os.environ["BZR_EDITOR"]
 
34
    except KeyError:
 
35
        pass
 
36
 
 
37
    e = config.GlobalConfig().get_editor()
 
38
    if e is not None:
 
39
        yield e
 
40
        
 
41
    try:
 
42
        yield os.environ["VISUAL"]
 
43
    except KeyError:
 
44
        pass
 
45
        
 
46
    try:
 
47
        yield os.environ["EDITOR"]
 
48
    except KeyError:
 
49
        pass
 
50
 
 
51
    if sys.platform == 'win32':
 
52
        for editor in 'wordpad.exe', 'notepad.exe':
 
53
            yield editor
 
54
    else:
 
55
        for editor in ['/usr/bin/editor', 'vi', 'pico', 'nano', 'joe']:
 
56
            yield editor
 
57
 
 
58
 
 
59
def _run_editor(filename):
 
60
    """Try to execute an editor to edit the commit message."""
 
61
    for e in _get_editor():
 
62
        edargs = e.split(' ')
 
63
        try:
 
64
            x = call(edargs + [filename])
 
65
        except OSError, e:
 
66
           # We're searching for an editor, so catch safe errors and continue
 
67
           if e.errno in (errno.ENOENT, ):
 
68
               continue
 
69
           raise
 
70
        if x == 0:
 
71
            return True
 
72
        elif x == 127:
 
73
            continue
 
74
        else:
 
75
            break
 
76
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
 
77
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n - $EDITOR" % \
 
78
                    config.config_filename())
 
79
 
 
80
 
 
81
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
 
82
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
 
83
 
 
84
 
 
85
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
 
86
    """Let the user edit a commit message in a temp file.
 
87
 
 
88
    This is run if they don't give a message or
 
89
    message-containing file on the command line.
 
90
 
 
91
    infotext:
 
92
        Text to be displayed at bottom of message for
 
93
        the user's reference; currently similar to
 
94
        'bzr status'.
 
95
    """
 
96
    import tempfile
 
97
 
 
98
    try:
 
99
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
 
100
        msgfile = os.close(tmp_fileno)
 
101
        if infotext is not None and infotext != "":
 
102
            hasinfo = True
 
103
            msgfile = file(msgfilename, "w")
 
104
            msgfile.write("\n%s\n\n%s" % (ignoreline, infotext))
 
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 file(msgfilename, "r"):
 
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
        try: os.unlink(msgfilename)
 
145
        except IOError: pass
 
146
 
 
147
 
 
148
def make_commit_message_template(working_tree, specific_files):
 
149
    """Prepare a template file for a commit into a branch.
 
150
 
 
151
    Returns a unicode string containing the template.
 
152
    """
 
153
    # TODO: Should probably be given the WorkingTree not the branch
 
154
    #
 
155
    # TODO: make provision for this to be overridden or modified by a hook
 
156
    #
 
157
    # TODO: Rather than running the status command, should prepare a draft of
 
158
    # the revision to be committed, then pause and ask the user to
 
159
    # confirm/write a message.
 
160
    from StringIO import StringIO       # must be unicode-safe
 
161
    from bzrlib.status import show_tree_status
 
162
    status_tmp = StringIO()
 
163
    show_tree_status(working_tree, specific_files=specific_files, 
 
164
                     to_file=status_tmp)
 
165
    return status_tmp.getvalue()