← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/msgeditor.py

  • Committer: John Arbash Meinel
  • Date: 2006-05-16 20:14:27 UTC
  • mto: This revision was merged to the branch mainline in revision 1724.
  • Revision ID: john@arbash-meinel.com-20060516201427-b709d09c3ce07f80
fixing more tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/msgeditor.py
1
 
# Bazaar-NG -- distributed version control
2
 
 
3
 
# Copyright (C) 2005 by Canonical Ltd
 
1
# Copyright (C) 2005, 2006 by Canonical Ltd
4
2
 
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
19
17
 
20
18
"""Commit message editor support."""
21
19
 
 
20
 
 
21
import errno
22
22
import os
 
23
from subprocess import call
 
24
import sys
 
25
 
 
26
import bzrlib.config as config
23
27
from bzrlib.errors import BzrError
24
28
 
 
29
 
25
30
def _get_editor():
26
31
    """Return a sequence of possible editor binaries for the current platform"""
27
 
    from bzrlib.osutils import _read_config_value
28
 
    
29
 
    e = _read_config_value("editor")
 
32
    try:
 
33
        yield os.environ["BZR_EDITOR"]
 
34
    except KeyError:
 
35
        pass
 
36
 
 
37
    e = config.GlobalConfig().get_editor()
30
38
    if e is not None:
31
39
        yield e
32
40
        
33
 
    if os.name == "windows":
34
 
        yield "notepad.exe"
35
 
    elif os.name == "posix":
36
 
        try:
37
 
            yield os.environ["EDITOR"]
38
 
        except KeyError:
39
 
            yield "/usr/bin/vi"
 
41
    try:
 
42
        yield os.environ["EDITOR"]
 
43
    except KeyError:
 
44
        pass
 
45
 
 
46
    if sys.platform == 'win32':
 
47
        for editor in 'wordpad.exe', 'notepad.exe':
 
48
            yield editor
 
49
    else:
 
50
        for editor in ['vi', 'pico', 'nano', 'joe']:
 
51
            yield editor
40
52
 
41
53
 
42
54
def _run_editor(filename):
43
55
    """Try to execute an editor to edit the commit message."""
44
56
    for e in _get_editor():
45
57
        edargs = e.split(' ')
46
 
        x = os.spawnvp(os.P_WAIT, edargs[0],
47
 
                       edargs + [filename])
 
58
        try:
 
59
            x = call(edargs + [filename])
 
60
        except OSError, e:
 
61
           # We're searching for an editor, so catch safe errors and continue
 
62
           if e.errno in (errno.ENOENT, ):
 
63
               continue
 
64
           raise
48
65
        if x == 0:
49
66
            return True
50
67
        elif x == 127:
51
68
            continue
52
69
        else:
53
70
            break
54
 
    raise BzrError("Could not start any editor. "
55
 
                   "Please specify $EDITOR or use ~/.bzr.conf/editor")
56
 
                          
57
 
 
58
 
def edit_commit_message(infotext, ignoreline=None):
 
71
    raise BzrError("Could not start any editor.\nPlease specify one with:\n"
 
72
                   " - $BZR_EDITOR\n - editor=/some/path in %s\n - $EDITOR" % \
 
73
                    config.config_filename())
 
74
 
 
75
 
 
76
DEFAULT_IGNORE_LINE = "%(bar)s %(msg)s %(bar)s" % \
 
77
    { 'bar' : '-' * 14, 'msg' : 'This line and the following will be ignored' }
 
78
 
 
79
 
 
80
def edit_commit_message(infotext, ignoreline=DEFAULT_IGNORE_LINE):
59
81
    """Let the user edit a commit message in a temp file.
60
82
 
61
83
    This is run if they don't give a message or
67
89
        'bzr status'.
68
90
    """
69
91
    import tempfile
70
 
    
71
 
    if ignoreline is None:
72
 
        ignoreline = "-- This line and the following will be ignored --"
73
 
        
 
92
 
74
93
    try:
75
 
        tmp_fileno, msgfilename = tempfile.mkstemp()
 
94
        tmp_fileno, msgfilename = tempfile.mkstemp(prefix='bzr_log.', dir=u'.')
76
95
        msgfile = os.close(tmp_fileno)
77
96
        if infotext is not None and infotext != "":
78
97
            hasinfo = True
79
98
            msgfile = file(msgfilename, "w")
80
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
 
99
            msgfile.write("\n%s\n\n%s" % (ignoreline, infotext))
81
100
            msgfile.close()
82
101
        else:
83
102
            hasinfo = False
107
126
            msg.append(line)
108
127
            
109
128
        if len(msg) == 0:
110
 
            return None
 
129
            return ""
111
130
        # delete empty lines at the end
112
131
        del msg[lastline:]
113
132
        # add a newline at the end, if needed
120
139
        try: os.unlink(msgfilename)
121
140
        except IOError: pass
122
141
 
 
142
 
 
143
def make_commit_message_template(working_tree, specific_files):
 
144
    """Prepare a template file for a commit into a branch.
 
145
 
 
146
    Returns a unicode string containing the template.
 
147
    """
 
148
    # TODO: Should probably be given the WorkingTree not the branch
 
149
    #
 
150
    # TODO: make provision for this to be overridden or modified by a hook
 
151
    #
 
152
    # TODO: Rather than running the status command, should prepare a draft of
 
153
    # the revision to be committed, then pause and ask the user to
 
154
    # confirm/write a message.
 
155
    from StringIO import StringIO       # must be unicode-safe
 
156
    from bzrlib.status import show_tree_status
 
157
    status_tmp = StringIO()
 
158
    show_tree_status(working_tree, specific_files=specific_files, 
 
159
                     to_file=status_tmp)
 
160
    return status_tmp.getvalue()