Coverage Report

Created: 2026-06-10 06:31

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