~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: Robert Collins
  • Date: 2006-05-24 08:14:45 UTC
  • mfrom: (1725.1.1 benchmark)
  • mto: (1725.2.6 commit)
  • mto: This revision was merged to the branch mainline in revision 1729.
  • Revision ID: robertc@robertcollins.net-20060524081445-c046b4406ffc8dfa
(rbc)Merge in benchmark --lsprof-timed lsprofiling feature. (Robert Collins, Martin Pool).

Show diffs side-by-side

added added

removed removed

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