/src/tmux/cmd-run-shell.c

Source
/* $OpenBSD: cmd-run-shell.c,v 1.96 2026/10/09 13:12:14 nicm Exp $ */

/*
 * Copyright (c) 2009 Tiago Cunha <me@tiagocunha.org>
 * Copyright (c) 2009 Nicholas Marriott <nicm@openbsd.org>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#include <sys/types.h>
#include <sys/wait.h>

#include <ctype.h>
#include <stdlib.h>
#include <string.h>

#include "tmux.h"

/*
 * Runs a command without a window.
 */

static enum args_parse_type cmd_run_shell_args_parse(struct args *, u_int,
            char **);
static enum cmd_retval    cmd_run_shell_exec(struct cmd *,
            struct cmdq_item *);

static void cmd_run_shell_timer(int, short, void *);
static void cmd_run_shell_callback(struct job *);
static void cmd_run_shell_free(void *);
static void cmd_run_shell_print(struct job *, const char *);

const struct cmd_entry cmd_run_shell_entry = {
  .name = "run-shell",
  .description = "Run a shell command.",
  .alias = "run",

  .args = { "bd:Ct:Es:c:", 0, -1, cmd_run_shell_args_parse },
  .usage = "[-bCE] [-c start-directory] [-d delay] " CMD_TARGET_PANE_USAGE
           " [shell-command [argument ...]]",

  .target = { 't', CMD_FIND_PANE, CMD_FIND_CANFAIL },

  .flags = 0,
  .exec = cmd_run_shell_exec
};

struct cmd_run_shell_data {
  struct client     *client;
  char        *cmd;
  struct args_command_state *state;
  char        *cwd;
  struct cmdq_item    *item;
  struct session      *s;
  int        wp_id;
  struct event       timer;
  int        flags;
};

static enum args_parse_type
cmd_run_shell_args_parse(struct args *args, __unused u_int idx,
    __unused char **cause)
{
  if (args_has(args, 'C'))
    return (ARGS_PARSE_COMMANDS_OR_STRING);
  return (ARGS_PARSE_STRING);
}

static void
cmd_run_shell_print(struct job *job, const char *msg)
{
  struct cmd_run_shell_data *cdata = job_get_data(job);
  struct window_pane    *wp = NULL;
  struct cmd_find_state    fs;
  struct window_mode_entry  *wme;

  if (cdata->wp_id != -1)
    wp = window_pane_find_by_id(cdata->wp_id);
  if (wp == NULL) {
    if (cdata->item != NULL) {
      cmdq_print(cdata->item, "%s", msg);
      return;
    }
    if (cdata->client != NULL && cdata->client->session != NULL)
      wp = cdata->client->session->curw->window->active;
    if (wp == NULL && cmd_find_from_nothing(&fs, 0) == 0)
      wp = fs.wp;
    if (wp == NULL)
      return;
  }

  wme = TAILQ_FIRST(&wp->modes);
  if (wme == NULL || wme->mode != &window_view_mode)
    window_pane_set_mode(wp, NULL, &window_view_mode, NULL, NULL,
        NULL);
  window_copy_add(wp, 1, "%s", msg);
}

static enum cmd_retval
cmd_run_shell_exec(struct cmd *self, struct cmdq_item *item)
{
  struct args     *args = cmd_get_args(self);
  struct cmd_find_state   *target = cmdq_get_target(item);
  struct cmd_run_shell_data *cdata;
  struct client     *c = cmdq_get_client(item);
  struct client     *tc = cmdq_get_target_client(item);
  struct session      *s = target->s;
  struct window_pane    *wp = target->wp;
  const char      *delay, *cmd;
  struct format_tree    *ft;
  double         d;
  struct timeval       tv;
  char        *end, key[16];
  u_int        i;
  int        wait = !args_has(args, 'b');

  if ((delay = args_get(args, 'd')) != NULL) {
    d = strtod(delay, &end);
    if (*end != '\0') {
      cmdq_error(item, "invalid delay time: %s", delay);
      return (CMD_RETURN_ERROR);
    }
  } else if (args_count(args) == 0)
    return (CMD_RETURN_NORMAL);

  cdata = xcalloc(1, sizeof *cdata);
  if (!args_has(args, 'C')) {
    cmd = args_string(args, 0);
    if (cmd != NULL) {
      ft = format_create_from_target(item);
      for (i = 1; i < args_count(args); i++) {
        xsnprintf(key, sizeof key, "%u", i);
        format_add(ft, key, "%s", args_string(args, i));
      }
      cdata->cmd = format_expand(ft, cmd);
      format_free(ft);
    }
  } else {
    cdata->state = args_make_commands_prepare(self, item, 0, NULL,
        wait, 1);
  }

  if (args_has(args, 't') && wp != NULL)
    cdata->wp_id = wp->id;
  else
    cdata->wp_id = -1;

  if (wait) {
    cdata->client = c;
    cdata->item = item;
  } else {
    cdata->client = tc;
    cdata->flags |= JOB_NOWAIT;
  }
  if (cdata->client != NULL)
    cdata->client->references++;
  if (args_has(args, 'c'))
    cdata->cwd = format_single_from_target(item, args_get(args, 'c'));
  else
    cdata->cwd = xstrdup(server_client_get_cwd(c, s));

  if (args_has(args, 'E'))
    cdata->flags |= JOB_SHOWSTDERR;

  cdata->s = s;
  if (s != NULL)
    session_add_ref(s, __func__);

  evtimer_set(&cdata->timer, cmd_run_shell_timer, cdata);
  if (delay != NULL) {
    timerclear(&tv);
    tv.tv_sec = (time_t)d;
    tv.tv_usec = (d - (double)tv.tv_sec) * 1000000U;
    evtimer_add(&cdata->timer, &tv);
  } else
    event_active(&cdata->timer, EV_TIMEOUT, 1);

  if (!wait)
    return (CMD_RETURN_NORMAL);
  return (CMD_RETURN_WAIT);
}

static void
cmd_run_shell_timer(__unused int fd, __unused short events, void* arg)
{
  struct cmd_run_shell_data *cdata = arg;
  struct client     *c = cdata->client;
  const char      *cmd = cdata->cmd;
  struct cmdq_item    *item = cdata->item, *new_item;
  struct cmd_list     *cmdlist;
  char        *error;

  if (cdata->state == NULL) {
    if (cmd == NULL) {
      if (cdata->item != NULL)
        cmdq_continue(cdata->item);
      cmd_run_shell_free(cdata);
      return;
    }
    if (job_run(cmd, 0, NULL, NULL, cdata->s, cdata->cwd, NULL,
        cmd_run_shell_callback, cmd_run_shell_free, cdata,
        cdata->flags, -1, -1) == NULL) {
      if (cdata->item == NULL)
        status_message_set(c, -1, 1, 0, 0,
            "failed to run command: %s", cmd);
      else {
        cmdq_error(cdata->item,
            "failed to run command: %s", cmd);
        cmdq_continue(cdata->item);
      }
      cmd_run_shell_free(cdata);
    }
    return;
  }

  cmdlist = args_make_commands(cdata->state, 0, NULL, &error);
  if (cmdlist == NULL) {
    if (cdata->item == NULL) {
      *error = toupper((u_char)*error);
      status_message_set(c, -1, 1, 0, 0, "%s", error);
    } else
      cmdq_error(cdata->item, "%s", error);
    free(error);
  } else if (item == NULL) {
    new_item = cmdq_get_command(cmdlist, NULL);
    cmdq_append(c, new_item);
    cmd_list_free(cmdlist);
  } else {
    new_item = cmdq_get_command(cmdlist, cmdq_get_state(item));
    cmdq_insert_after(item, new_item);
    cmd_list_free(cmdlist);
  }

  if (cdata->item != NULL)
    cmdq_continue(cdata->item);
  cmd_run_shell_free(cdata);
}

static void
cmd_run_shell_callback(struct job *job)
{
  struct cmd_run_shell_data *cdata = job_get_data(job);
  struct bufferevent    *event = job_get_event(job);
  struct cmdq_item    *item = cdata->item;
  char        *cmd = cdata->cmd, *msg = NULL, *line;
  size_t         size;
  int        retcode, status;

  do {
    line = evbuffer_readln(event->input, NULL, EVBUFFER_EOL_LF);
    if (line != NULL) {
      cmd_run_shell_print(job, line);
      free(line);
    }
  } while (line != NULL);

  size = EVBUFFER_LENGTH(event->input);
  if (size != 0) {
    line = xmalloc(size + 1);
    memcpy(line, EVBUFFER_DATA(event->input), size);
    line[size] = '\0';

    cmd_run_shell_print(job, line);

    free(line);
  }

  status = job_get_status(job);
  if (WIFEXITED(status)) {
    if ((retcode = WEXITSTATUS(status)) != 0)
      xasprintf(&msg, "'%s' returned %d", cmd, retcode);
  } else if (WIFSIGNALED(status)) {
    retcode = WTERMSIG(status);
    xasprintf(&msg, "'%s' terminated by signal %d", cmd, retcode);
    retcode += 128;
  } else
    retcode = 0;
  if (msg != NULL)
    cmd_run_shell_print(job, msg);
  free(msg);

  if (item != NULL) {
    if (cmdq_get_client(item) != NULL &&
        cmdq_get_client(item)->session == NULL)
      cmdq_get_client(item)->retval = retcode;
    cmdq_continue(item);
  }
}

static void
cmd_run_shell_free(void *data)
{
  struct cmd_run_shell_data *cdata = data;

  evtimer_del(&cdata->timer);
  if (cdata->s != NULL)
    session_remove_ref(cdata->s, __func__);
  if (cdata->client != NULL)
    server_client_unref(cdata->client);
  if (cdata->state != NULL)
    args_make_commands_free(cdata->state);
  free(cdata->cwd);
  free(cdata->cmd);
  free(cdata);
}

Coverage Report

Created: 2026-10-17 06:19

Line	Count	Source
1		/* $OpenBSD: cmd-run-shell.c,v 1.96 2026/10/09 13:12:14 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 <ctype.h>
24		#include <stdlib.h>
25		#include <string.h>
26
27		#include "tmux.h"
28
29		/*
30		* Runs a command without a window.
31		*/
32
33		static enum args_parse_type cmd_run_shell_args_parse(struct args *, u_int,
34		char **);
35		static enum cmd_retval cmd_run_shell_exec(struct cmd *,
36		struct cmdq_item *);
37
38		static void cmd_run_shell_timer(int, short, void *);
39		static void cmd_run_shell_callback(struct job *);
40		static void cmd_run_shell_free(void *);
41		static void cmd_run_shell_print(struct job , const char );
42
43		const struct cmd_entry cmd_run_shell_entry = {
44		.name = "run-shell",
45		.description = "Run a shell command.",
46		.alias = "run",
47
48		.args = { "bd:Ct:Es:c:", 0, -1, cmd_run_shell_args_parse },
49		.usage = "[-bCE] [-c start-directory] [-d delay] " CMD_TARGET_PANE_USAGE
50		" [shell-command [argument ...]]",
51
52		.target = { 't', CMD_FIND_PANE, CMD_FIND_CANFAIL },
53
54		.flags = 0,
55		.exec = cmd_run_shell_exec
56		};
57
58		struct cmd_run_shell_data {
59		struct client *client;
60		char *cmd;
61		struct args_command_state *state;
62		char *cwd;
63		struct cmdq_item *item;
64		struct session *s;
65		int wp_id;
66		struct event timer;
67		int flags;
68		};
69
70		static enum args_parse_type
71		cmd_run_shell_args_parse(struct args *args, __unused u_int idx,
72		__unused char **cause)
73	724	{
74	724	if (args_has(args, 'C'))
75	201	return (ARGS_PARSE_COMMANDS_OR_STRING);
76	523	return (ARGS_PARSE_STRING);
77	724	}
78
79		static void
80		cmd_run_shell_print(struct job job, const char msg)
81	0	{
82	0	struct cmd_run_shell_data *cdata = job_get_data(job);
83	0	struct window_pane *wp = NULL;
84	0	struct cmd_find_state fs;
85	0	struct window_mode_entry *wme;
86
87	0	if (cdata->wp_id != -1)
88	0	wp = window_pane_find_by_id(cdata->wp_id);
89	0	if (wp == NULL) {
90	0	if (cdata->item != NULL) {
91	0	cmdq_print(cdata->item, "%s", msg);
92	0	return;
93	0	}
94	0	if (cdata->client != NULL && cdata->client->session != NULL)
95	0	wp = cdata->client->session->curw->window->active;
96	0	if (wp == NULL && cmd_find_from_nothing(&fs, 0) == 0)
97	0	wp = fs.wp;
98	0	if (wp == NULL)
99	0	return;
100	0	}
101
102	0	wme = TAILQ_FIRST(&wp->modes);
103	0	if (wme == NULL \|\| wme->mode != &window_view_mode)
104	0	window_pane_set_mode(wp, NULL, &window_view_mode, NULL, NULL,
105	0	NULL);
106	0	window_copy_add(wp, 1, "%s", msg);
107	0	}
108
109		static enum cmd_retval
110		cmd_run_shell_exec(struct cmd self, struct cmdq_item item)
111	0	{
112	0	struct args *args = cmd_get_args(self);
113	0	struct cmd_find_state *target = cmdq_get_target(item);
114	0	struct cmd_run_shell_data *cdata;
115	0	struct client *c = cmdq_get_client(item);
116	0	struct client *tc = cmdq_get_target_client(item);
117	0	struct session *s = target->s;
118	0	struct window_pane *wp = target->wp;
119	0	const char delay, cmd;
120	0	struct format_tree *ft;
121	0	double d;
122	0	struct timeval tv;
123	0	char *end, key[16];
124	0	u_int i;
125	0	int wait = !args_has(args, 'b');
126
127	0	if ((delay = args_get(args, 'd')) != NULL) {
128	0	d = strtod(delay, &end);
129	0	if (*end != '\0') {
130	0	cmdq_error(item, "invalid delay time: %s", delay);
131	0	return (CMD_RETURN_ERROR);
132	0	}
133	0	} else if (args_count(args) == 0)
134	0	return (CMD_RETURN_NORMAL);
135
136	0	cdata = xcalloc(1, sizeof *cdata);
137	0	if (!args_has(args, 'C')) {
138	0	cmd = args_string(args, 0);
139	0	if (cmd != NULL) {
140	0	ft = format_create_from_target(item);
141	0	for (i = 1; i < args_count(args); i++) {
142	0	xsnprintf(key, sizeof key, "%u", i);
143	0	format_add(ft, key, "%s", args_string(args, i));
144	0	}
145	0	cdata->cmd = format_expand(ft, cmd);
146	0	format_free(ft);
147	0	}
148	0	} else {
149	0	cdata->state = args_make_commands_prepare(self, item, 0, NULL,
150	0	wait, 1);
151	0	}
152
153	0	if (args_has(args, 't') && wp != NULL)
154	0	cdata->wp_id = wp->id;
155	0	else
156	0	cdata->wp_id = -1;
157
158	0	if (wait) {
159	0	cdata->client = c;
160	0	cdata->item = item;
161	0	} else {
162	0	cdata->client = tc;
163	0	cdata->flags \|= JOB_NOWAIT;
164	0	}
165	0	if (cdata->client != NULL)
166	0	cdata->client->references++;
167	0	if (args_has(args, 'c'))
168	0	cdata->cwd = format_single_from_target(item, args_get(args, 'c'));
169	0	else
170	0	cdata->cwd = xstrdup(server_client_get_cwd(c, s));
171
172	0	if (args_has(args, 'E'))
173	0	cdata->flags \|= JOB_SHOWSTDERR;
174
175	0	cdata->s = s;
176	0	if (s != NULL)
177	0	session_add_ref(s, __func__);
178
179	0	evtimer_set(&cdata->timer, cmd_run_shell_timer, cdata);
180	0	if (delay != NULL) {
181	0	timerclear(&tv);
182	0	tv.tv_sec = (time_t)d;
183	0	tv.tv_usec = (d - (double)tv.tv_sec) * 1000000U;
184	0	evtimer_add(&cdata->timer, &tv);
185	0	} else
186	0	event_active(&cdata->timer, EV_TIMEOUT, 1);
187
188	0	if (!wait)
189	0	return (CMD_RETURN_NORMAL);
190	0	return (CMD_RETURN_WAIT);
191	0	}
192
193		static void
194		cmd_run_shell_timer(__unused int fd, __unused short events, void* arg)
195	0	{
196	0	struct cmd_run_shell_data *cdata = arg;
197	0	struct client *c = cdata->client;
198	0	const char *cmd = cdata->cmd;
199	0	struct cmdq_item item = cdata->item, new_item;
200	0	struct cmd_list *cmdlist;
201	0	char *error;
202
203	0	if (cdata->state == NULL) {
204	0	if (cmd == NULL) {
205	0	if (cdata->item != NULL)
206	0	cmdq_continue(cdata->item);
207	0	cmd_run_shell_free(cdata);
208	0	return;
209	0	}
210	0	if (job_run(cmd, 0, NULL, NULL, cdata->s, cdata->cwd, NULL,
211	0	cmd_run_shell_callback, cmd_run_shell_free, cdata,
212	0	cdata->flags, -1, -1) == NULL) {
213	0	if (cdata->item == NULL)
214	0	status_message_set(c, -1, 1, 0, 0,
215	0	"failed to run command: %s", cmd);
216	0	else {
217	0	cmdq_error(cdata->item,
218	0	"failed to run command: %s", cmd);
219	0	cmdq_continue(cdata->item);
220	0	}
221	0	cmd_run_shell_free(cdata);
222	0	}
223	0	return;
224	0	}
225
226	0	cmdlist = args_make_commands(cdata->state, 0, NULL, &error);
227	0	if (cmdlist == NULL) {
228	0	if (cdata->item == NULL) {
229	0	error = toupper((u_char)error);
230	0	status_message_set(c, -1, 1, 0, 0, "%s", error);
231	0	} else
232	0	cmdq_error(cdata->item, "%s", error);
233	0	free(error);
234	0	} else if (item == NULL) {
235	0	new_item = cmdq_get_command(cmdlist, NULL);
236	0	cmdq_append(c, new_item);
237	0	cmd_list_free(cmdlist);
238	0	} else {
239	0	new_item = cmdq_get_command(cmdlist, cmdq_get_state(item));
240	0	cmdq_insert_after(item, new_item);
241	0	cmd_list_free(cmdlist);
242	0	}
243
244	0	if (cdata->item != NULL)
245	0	cmdq_continue(cdata->item);
246	0	cmd_run_shell_free(cdata);
247	0	}
248
249		static void
250		cmd_run_shell_callback(struct job *job)
251	0	{
252	0	struct cmd_run_shell_data *cdata = job_get_data(job);
253	0	struct bufferevent *event = job_get_event(job);
254	0	struct cmdq_item *item = cdata->item;
255	0	char cmd = cdata->cmd, msg = NULL, *line;
256	0	size_t size;
257	0	int retcode, status;
258
259	0	do {
260	0	line = evbuffer_readln(event->input, NULL, EVBUFFER_EOL_LF);
261	0	if (line != NULL) {
262	0	cmd_run_shell_print(job, line);
263	0	free(line);
264	0	}
265	0	} while (line != NULL);
266
267	0	size = EVBUFFER_LENGTH(event->input);
268	0	if (size != 0) {
269	0	line = xmalloc(size + 1);
270	0	memcpy(line, EVBUFFER_DATA(event->input), size);
271	0	line[size] = '\0';
272
273	0	cmd_run_shell_print(job, line);
274
275	0	free(line);
276	0	}
277
278	0	status = job_get_status(job);
279	0	if (WIFEXITED(status)) {
280	0	if ((retcode = WEXITSTATUS(status)) != 0)
281	0	xasprintf(&msg, "'%s' returned %d", cmd, retcode);
282	0	} else if (WIFSIGNALED(status)) {
283	0	retcode = WTERMSIG(status);
284	0	xasprintf(&msg, "'%s' terminated by signal %d", cmd, retcode);
285	0	retcode += 128;
286	0	} else
287	0	retcode = 0;
288	0	if (msg != NULL)
289	0	cmd_run_shell_print(job, msg);
290	0	free(msg);
291
292	0	if (item != NULL) {
293	0	if (cmdq_get_client(item) != NULL &&
294	0	cmdq_get_client(item)->session == NULL)
295	0	cmdq_get_client(item)->retval = retcode;
296	0	cmdq_continue(item);
297	0	}
298	0	}
299
300		static void
301		cmd_run_shell_free(void *data)
302	0	{
303	0	struct cmd_run_shell_data *cdata = data;
304
305	0	evtimer_del(&cdata->timer);
306	0	if (cdata->s != NULL)
307	0	session_remove_ref(cdata->s, __func__);
308	0	if (cdata->client != NULL)
309	0	server_client_unref(cdata->client);
310	0	if (cdata->state != NULL)
311	0	args_make_commands_free(cdata->state);
312	0	free(cdata->cwd);
313	0	free(cdata->cmd);
314	0	free(cdata);
315	0	}