1 #include "cache.h"
2 #include "config.h"
3 #include "strbuf.h"
4 #include "run-command.h"
5 #include "sigchain.h"
6 
7 #ifndef DEFAULT_EDITOR
8 #define DEFAULT_EDITOR "vi"
9 #endif
10 
is_terminal_dumb(void)11 int is_terminal_dumb(void)
12 {
13 	const char *terminal = getenv("TERM");
14 	return !terminal || !strcmp(terminal, "dumb");
15 }
16 
git_editor(void)17 const char *git_editor(void)
18 {
19 	const char *editor = getenv("GIT_EDITOR");
20 	int terminal_is_dumb = is_terminal_dumb();
21 
22 	if (!editor && editor_program)
23 		editor = editor_program;
24 	if (!editor && !terminal_is_dumb)
25 		editor = getenv("VISUAL");
26 	if (!editor)
27 		editor = getenv("EDITOR");
28 
29 	if (!editor && terminal_is_dumb)
30 		return NULL;
31 
32 	if (!editor)
33 		editor = DEFAULT_EDITOR;
34 
35 	return editor;
36 }
37 
git_sequence_editor(void)38 const char *git_sequence_editor(void)
39 {
40 	const char *editor = getenv("GIT_SEQUENCE_EDITOR");
41 
42 	if (!editor)
43 		git_config_get_string_tmp("sequence.editor", &editor);
44 	if (!editor)
45 		editor = git_editor();
46 
47 	return editor;
48 }
49 
launch_specified_editor(const char * editor,const char * path,struct strbuf * buffer,const char * const * env)50 static int launch_specified_editor(const char *editor, const char *path,
51 				   struct strbuf *buffer, const char *const *env)
52 {
53 	if (!editor)
54 		return error("Terminal is dumb, but EDITOR unset");
55 
56 	if (strcmp(editor, ":")) {
57 		struct strbuf realpath = STRBUF_INIT;
58 		const char *args[] = { editor, NULL, NULL };
59 		struct child_process p = CHILD_PROCESS_INIT;
60 		int ret, sig;
61 		int print_waiting_for_editor = advice_enabled(ADVICE_WAITING_FOR_EDITOR) && isatty(2);
62 
63 		if (print_waiting_for_editor) {
64 			/*
65 			 * A dumb terminal cannot erase the line later on. Add a
66 			 * newline to separate the hint from subsequent output.
67 			 *
68 			 * Make sure that our message is separated with a whitespace
69 			 * from further cruft that may be written by the editor.
70 			 */
71 			const char term = is_terminal_dumb() ? '\n' : ' ';
72 
73 			fprintf(stderr,
74 				_("hint: Waiting for your editor to close the file...%c"),
75 				term);
76 			fflush(stderr);
77 		}
78 
79 		strbuf_realpath(&realpath, path, 1);
80 		args[1] = realpath.buf;
81 
82 		p.argv = args;
83 		p.env = env;
84 		p.use_shell = 1;
85 		p.trace2_child_class = "editor";
86 		if (start_command(&p) < 0) {
87 			strbuf_release(&realpath);
88 			return error("unable to start editor '%s'", editor);
89 		}
90 
91 		sigchain_push(SIGINT, SIG_IGN);
92 		sigchain_push(SIGQUIT, SIG_IGN);
93 		ret = finish_command(&p);
94 		strbuf_release(&realpath);
95 		sig = ret - 128;
96 		sigchain_pop(SIGINT);
97 		sigchain_pop(SIGQUIT);
98 		if (sig == SIGINT || sig == SIGQUIT)
99 			raise(sig);
100 		if (ret)
101 			return error("There was a problem with the editor '%s'.",
102 					editor);
103 
104 		if (print_waiting_for_editor && !is_terminal_dumb())
105 			/*
106 			 * Erase the entire line to avoid wasting the
107 			 * vertical space.
108 			 */
109 			term_clear_line();
110 	}
111 
112 	if (!buffer)
113 		return 0;
114 	if (strbuf_read_file(buffer, path, 0) < 0)
115 		return error_errno("could not read file '%s'", path);
116 	return 0;
117 }
118 
launch_editor(const char * path,struct strbuf * buffer,const char * const * env)119 int launch_editor(const char *path, struct strbuf *buffer, const char *const *env)
120 {
121 	return launch_specified_editor(git_editor(), path, buffer, env);
122 }
123 
launch_sequence_editor(const char * path,struct strbuf * buffer,const char * const * env)124 int launch_sequence_editor(const char *path, struct strbuf *buffer,
125 			   const char *const *env)
126 {
127 	return launch_specified_editor(git_sequence_editor(), path, buffer, env);
128 }
129