xref: /openbsd-src/usr.bin/tmux/cmd-run-shell.c (revision 035dc73d1aa2b06694f1c8fe08a74fa3650b6b4b)
1 /* $OpenBSD: cmd-run-shell.c,v 1.67 2020/04/13 20:51:57 nicm Exp $ */
2 
3 /*
4  * Copyright (c) 2009 Tiago Cunha <me@tiagocunha.org>
5  * Copyright (c) 2009 Nicholas Marriott <nicm@openbsd.org>
6  *
7  * Permission to use, copy, modify, and distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
16  * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
17  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 #include <sys/types.h>
21 #include <sys/wait.h>
22 
23 #include <stdlib.h>
24 #include <string.h>
25 
26 #include "tmux.h"
27 
28 /*
29  * Runs a command without a window.
30  */
31 
32 static enum cmd_retval	cmd_run_shell_exec(struct cmd *, struct cmdq_item *);
33 
34 static void	cmd_run_shell_timer(int, short, void *);
35 static void	cmd_run_shell_callback(struct job *);
36 static void	cmd_run_shell_free(void *);
37 static void	cmd_run_shell_print(struct job *, const char *);
38 
39 const struct cmd_entry cmd_run_shell_entry = {
40 	.name = "run-shell",
41 	.alias = "run",
42 
43 	.args = { "bd:t:", 0, 1 },
44 	.usage = "[-b] [-d delay] " CMD_TARGET_PANE_USAGE " [shell-command]",
45 
46 	.target = { 't', CMD_FIND_PANE, CMD_FIND_CANFAIL },
47 
48 	.flags = 0,
49 	.exec = cmd_run_shell_exec
50 };
51 
52 struct cmd_run_shell_data {
53 	char			*cmd;
54 	char			*cwd;
55 	struct cmdq_item	*item;
56 	struct session		*s;
57 	int			 wp_id;
58 	struct event		 timer;
59 };
60 
61 static void
62 cmd_run_shell_print(struct job *job, const char *msg)
63 {
64 	struct cmd_run_shell_data	*cdata = job_get_data(job);
65 	struct window_pane		*wp = NULL;
66 	struct cmd_find_state		 fs;
67 	struct window_mode_entry	*wme;
68 
69 	if (cdata->wp_id != -1)
70 		wp = window_pane_find_by_id(cdata->wp_id);
71 	if (wp == NULL) {
72 		if (cdata->item != NULL) {
73 			cmdq_print(cdata->item, "%s", msg);
74 			return;
75 		}
76 		if (cmd_find_from_nothing(&fs, 0) != 0)
77 			return;
78 		wp = fs.wp;
79 		if (wp == NULL)
80 			return;
81 	}
82 
83 	wme = TAILQ_FIRST(&wp->modes);
84 	if (wme == NULL || wme->mode != &window_view_mode)
85 		window_pane_set_mode(wp, NULL, &window_view_mode, NULL, NULL);
86 	window_copy_add(wp, "%s", msg);
87 }
88 
89 static enum cmd_retval
90 cmd_run_shell_exec(struct cmd *self, struct cmdq_item *item)
91 {
92 	struct args			*args = cmd_get_args(self);
93 	struct cmd_find_state		*target = cmdq_get_target(item);
94 	struct cmd_run_shell_data	*cdata;
95 	struct session			*s = target->s;
96 	struct window_pane		*wp = target->wp;
97 	const char			*delay;
98 	double				 d;
99 	struct timeval			 tv;
100 	char				*end;
101 
102 	cdata = xcalloc(1, sizeof *cdata);
103 	if (args->argc != 0)
104 		cdata->cmd = format_single_from_target(item, args->argv[0]);
105 
106 	if (args_has(args, 't') && wp != NULL)
107 		cdata->wp_id = wp->id;
108 	else
109 		cdata->wp_id = -1;
110 
111 	if (!args_has(args, 'b'))
112 		cdata->item = item;
113 
114 	cdata->cwd = xstrdup(server_client_get_cwd(cmdq_get_client(item), s));
115 	cdata->s = s;
116 	if (s != NULL)
117 		session_add_ref(s, __func__);
118 
119 	evtimer_set(&cdata->timer, cmd_run_shell_timer, cdata);
120 
121 	if ((delay = args_get(args, 'd')) != NULL) {
122 		d = strtod(delay, &end);
123 		if (*end != '\0') {
124 			cmdq_error(item, "invalid delay time: %s", delay);
125 			cmd_run_shell_free(cdata);
126 			return (CMD_RETURN_ERROR);
127 		}
128 		timerclear(&tv);
129 		tv.tv_sec = (time_t)d;
130 		tv.tv_usec = (d - (double)tv.tv_sec) * 1000000U;
131 		evtimer_add(&cdata->timer, &tv);
132 	} else
133 		cmd_run_shell_timer(-1, 0, cdata);
134 
135 	if (args_has(args, 'b'))
136 		return (CMD_RETURN_NORMAL);
137 	return (CMD_RETURN_WAIT);
138 }
139 
140 static void
141 cmd_run_shell_timer(__unused int fd, __unused short events, void* arg)
142 {
143 	struct cmd_run_shell_data	*cdata = arg;
144 
145 	if (cdata->cmd != NULL) {
146 		if (job_run(cdata->cmd, cdata->s, cdata->cwd, NULL,
147 		    cmd_run_shell_callback, cmd_run_shell_free, cdata, 0, -1,
148 		    -1) == NULL)
149 			cmd_run_shell_free(cdata);
150 	} else {
151 		if (cdata->item != NULL)
152 			cmdq_continue(cdata->item);
153 		cmd_run_shell_free(cdata);
154 	}
155 }
156 
157 static void
158 cmd_run_shell_callback(struct job *job)
159 {
160 	struct cmd_run_shell_data	*cdata = job_get_data(job);
161 	struct bufferevent		*event = job_get_event(job);
162 	struct cmdq_item		*item = cdata->item;
163 	char				*cmd = cdata->cmd, *msg = NULL, *line;
164 	size_t				 size;
165 	int				 retcode, status;
166 
167 	do {
168 		if ((line = evbuffer_readline(event->input)) != NULL) {
169 			cmd_run_shell_print(job, line);
170 			free(line);
171 		}
172 	} while (line != NULL);
173 
174 	size = EVBUFFER_LENGTH(event->input);
175 	if (size != 0) {
176 		line = xmalloc(size + 1);
177 		memcpy(line, EVBUFFER_DATA(event->input), size);
178 		line[size] = '\0';
179 
180 		cmd_run_shell_print(job, line);
181 
182 		free(line);
183 	}
184 
185 	status = job_get_status(job);
186 	if (WIFEXITED(status)) {
187 		if ((retcode = WEXITSTATUS(status)) != 0)
188 			xasprintf(&msg, "'%s' returned %d", cmd, retcode);
189 	} else if (WIFSIGNALED(status)) {
190 		retcode = WTERMSIG(status);
191 		xasprintf(&msg, "'%s' terminated by signal %d", cmd, retcode);
192 		retcode += 128;
193 	}
194 	if (msg != NULL)
195 		cmd_run_shell_print(job, msg);
196 	free(msg);
197 
198 	if (item != NULL) {
199 		if (cmdq_get_client(item) != NULL &&
200 		    cmdq_get_client(item)->session == NULL)
201 			cmdq_get_client(item)->retval = retcode;
202 		cmdq_continue(item);
203 	}
204 }
205 
206 static void
207 cmd_run_shell_free(void *data)
208 {
209 	struct cmd_run_shell_data	*cdata = data;
210 
211 	evtimer_del(&cdata->timer);
212 	if (cdata->s != NULL)
213 		session_remove_ref(cdata->s, __func__);
214 	free(cdata->cwd);
215 	free(cdata->cmd);
216 	free(cdata);
217 }
218