[BACK]Return to cmd-run-shell.c CVS log [TXT][DIR] Up to [local] / src / usr.bin / tmux

Annotation of src/usr.bin/tmux/cmd-run-shell.c, Revision 1.84

1.84    ! nicm        1: /* $OpenBSD: cmd-run-shell.c,v 1.83 2022/05/30 13:00:18 nicm Exp $ */
1.1       nicm        2:
                      3: /*
                      4:  * Copyright (c) 2009 Tiago Cunha <me@tiagocunha.org>
1.3       nicm        5:  * Copyright (c) 2009 Nicholas Marriott <nicm@openbsd.org>
1.1       nicm        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:
1.72      nicm       23: #include <ctype.h>
1.12      nicm       24: #include <stdlib.h>
1.1       nicm       25: #include <string.h>
                     26:
                     27: #include "tmux.h"
                     28:
                     29: /*
                     30:  * Runs a command without a window.
                     31:  */
                     32:
1.78      nicm       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 *);
1.14      nicm       37:
1.60      nicm       38: static void    cmd_run_shell_timer(int, short, void *);
1.38      nicm       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 *);
1.2       nicm       42:
1.1       nicm       43: const struct cmd_entry cmd_run_shell_entry = {
1.34      nicm       44:        .name = "run-shell",
                     45:        .alias = "run",
                     46:
1.78      nicm       47:        .args = { "bd:Ct:", 0, 1, cmd_run_shell_args_parse },
1.70      nicm       48:        .usage = "[-bC] [-d delay] " CMD_TARGET_PANE_USAGE " [shell-command]",
1.34      nicm       49:
1.49      nicm       50:        .target = { 't', CMD_FIND_PANE, CMD_FIND_CANFAIL },
1.35      nicm       51:
                     52:        .flags = 0,
1.34      nicm       53:        .exec = cmd_run_shell_exec
1.1       nicm       54: };
                     55:
1.2       nicm       56: struct cmd_run_shell_data {
1.80      nicm       57:        struct client                   *client;
                     58:        char                            *cmd;
                     59:        struct args_command_state       *state;
                     60:        char                            *cwd;
                     61:        struct cmdq_item                *item;
                     62:        struct session                  *s;
                     63:        int                              wp_id;
                     64:        struct event                     timer;
                     65:        int                              flags;
1.2       nicm       66: };
1.78      nicm       67:
                     68: static enum args_parse_type
                     69: cmd_run_shell_args_parse(struct args *args, __unused u_int idx,
                     70:     __unused char **cause)
                     71: {
                     72:        if (args_has(args, 'C'))
                     73:                return (ARGS_PARSE_COMMANDS_OR_STRING);
                     74:        return (ARGS_PARSE_STRING);
                     75: }
1.2       nicm       76:
1.38      nicm       77: static void
1.14      nicm       78: cmd_run_shell_print(struct job *job, const char *msg)
                     79: {
1.54      nicm       80:        struct cmd_run_shell_data       *cdata = job_get_data(job);
1.21      nicm       81:        struct window_pane              *wp = NULL;
1.43      nicm       82:        struct cmd_find_state            fs;
1.58      nicm       83:        struct window_mode_entry        *wme;
1.14      nicm       84:
1.21      nicm       85:        if (cdata->wp_id != -1)
                     86:                wp = window_pane_find_by_id(cdata->wp_id);
1.84    ! nicm       87:        if (wp == NULL && cdata->item != NULL && cdata->client != NULL)
1.83      nicm       88:                wp = server_client_get_pane(cdata->client);
                     89:        if (wp == NULL && cmd_find_from_nothing(&fs, 0) == 0)
1.43      nicm       90:                wp = fs.wp;
1.83      nicm       91:        if (wp == NULL)
                     92:                return;
1.14      nicm       93:
1.58      nicm       94:        wme = TAILQ_FIRST(&wp->modes);
                     95:        if (wme == NULL || wme->mode != &window_view_mode)
1.64      nicm       96:                window_pane_set_mode(wp, NULL, &window_view_mode, NULL, NULL);
1.83      nicm       97:        window_copy_add(wp, 1, "%s", msg);
1.14      nicm       98: }
                     99:
1.38      nicm      100: static enum cmd_retval
1.41      nicm      101: cmd_run_shell_exec(struct cmd *self, struct cmdq_item *item)
1.1       nicm      102: {
1.65      nicm      103:        struct args                     *args = cmd_get_args(self);
1.66      nicm      104:        struct cmd_find_state           *target = cmdq_get_target(item);
1.2       nicm      105:        struct cmd_run_shell_data       *cdata;
1.70      nicm      106:        struct client                   *tc = cmdq_get_target_client(item);
1.66      nicm      107:        struct session                  *s = target->s;
                    108:        struct window_pane              *wp = target->wp;
1.77      nicm      109:        const char                      *delay, *cmd;
1.60      nicm      110:        double                           d;
                    111:        struct timeval                   tv;
                    112:        char                            *end;
1.70      nicm      113:        int                              wait = !args_has(args, 'b');
                    114:
                    115:        if ((delay = args_get(args, 'd')) != NULL) {
                    116:                d = strtod(delay, &end);
                    117:                if (*end != '\0') {
                    118:                        cmdq_error(item, "invalid delay time: %s", delay);
                    119:                        return (CMD_RETURN_ERROR);
                    120:                }
1.75      nicm      121:        } else if (args_count(args) == 0)
1.70      nicm      122:                return (CMD_RETURN_NORMAL);
1.40      nicm      123:
1.37      nicm      124:        cdata = xcalloc(1, sizeof *cdata);
1.77      nicm      125:        if (!args_has(args, 'C')) {
                    126:                cmd = args_string(args, 0);
                    127:                if (cmd != NULL)
                    128:                        cdata->cmd = format_single_from_target(item, cmd);
                    129:        } else {
1.80      nicm      130:                cdata->state = args_make_commands_prepare(self, item, 0, NULL,
                    131:                    wait, 1);
1.70      nicm      132:        }
                    133:
1.40      nicm      134:        if (args_has(args, 't') && wp != NULL)
                    135:                cdata->wp_id = wp->id;
                    136:        else
                    137:                cdata->wp_id = -1;
                    138:
1.70      nicm      139:        if (wait) {
                    140:                cdata->client = cmdq_get_client(item);
1.41      nicm      141:                cdata->item = item;
1.70      nicm      142:        } else {
                    143:                cdata->client = tc;
1.69      nicm      144:                cdata->flags |= JOB_NOWAIT;
1.70      nicm      145:        }
                    146:        if (cdata->client != NULL)
                    147:                cdata->client->references++;
1.2       nicm      148:
1.66      nicm      149:        cdata->cwd = xstrdup(server_client_get_cwd(cmdq_get_client(item), s));
1.70      nicm      150:
1.60      nicm      151:        cdata->s = s;
1.61      nicm      152:        if (s != NULL)
                    153:                session_add_ref(s, __func__);
1.60      nicm      154:
                    155:        evtimer_set(&cdata->timer, cmd_run_shell_timer, cdata);
1.70      nicm      156:        if (delay != NULL) {
1.60      nicm      157:                timerclear(&tv);
                    158:                tv.tv_sec = (time_t)d;
                    159:                tv.tv_usec = (d - (double)tv.tv_sec) * 1000000U;
                    160:                evtimer_add(&cdata->timer, &tv);
                    161:        } else
1.70      nicm      162:                event_active(&cdata->timer, EV_TIMEOUT, 1);
1.2       nicm      163:
1.70      nicm      164:        if (!wait)
1.18      nicm      165:                return (CMD_RETURN_NORMAL);
                    166:        return (CMD_RETURN_WAIT);
1.2       nicm      167: }
1.1       nicm      168:
1.38      nicm      169: static void
1.60      nicm      170: cmd_run_shell_timer(__unused int fd, __unused short events, void* arg)
                    171: {
                    172:        struct cmd_run_shell_data       *cdata = arg;
1.70      nicm      173:        struct client                   *c = cdata->client;
                    174:        const char                      *cmd = cdata->cmd;
1.77      nicm      175:        struct cmdq_item                *item = cdata->item, *new_item;
1.80      nicm      176:        struct cmd_list                 *cmdlist;
                    177:        char                            *error;
1.60      nicm      178:
1.81      nicm      179:        if (cdata->state == NULL) {
                    180:                if (cmd == NULL) {
                    181:                        if (cdata->item != NULL)
                    182:                                cmdq_continue(cdata->item);
                    183:                        cmd_run_shell_free(cdata);
                    184:                        return;
                    185:                }
1.82      nicm      186:                if (job_run(cmd, 0, NULL, NULL, cdata->s, cdata->cwd, NULL,
1.69      nicm      187:                    cmd_run_shell_callback, cmd_run_shell_free, cdata,
                    188:                    cdata->flags, -1, -1) == NULL)
1.60      nicm      189:                        cmd_run_shell_free(cdata);
1.70      nicm      190:                return;
                    191:        }
                    192:
1.80      nicm      193:        cmdlist = args_make_commands(cdata->state, 0, NULL, &error);
                    194:        if (cmdlist == NULL) {
                    195:                if (cdata->item == NULL) {
                    196:                        *error = toupper((u_char)*error);
                    197:                        status_message_set(c, -1, 1, 0, "%s", error);
                    198:                } else
                    199:                        cmdq_error(cdata->item, "%s", error);
                    200:                free(error);
                    201:        } else if (item == NULL) {
                    202:                new_item = cmdq_get_command(cmdlist, NULL);
                    203:                cmdq_append(c, new_item);
                    204:        } else {
                    205:                new_item = cmdq_get_command(cmdlist, cmdq_get_state(item));
                    206:                cmdq_insert_after(item, new_item);
1.60      nicm      207:        }
1.70      nicm      208:
                    209:        if (cdata->item != NULL)
                    210:                cmdq_continue(cdata->item);
                    211:        cmd_run_shell_free(cdata);
1.60      nicm      212: }
                    213:
                    214: static void
1.2       nicm      215: cmd_run_shell_callback(struct job *job)
                    216: {
1.54      nicm      217:        struct cmd_run_shell_data       *cdata = job_get_data(job);
                    218:        struct bufferevent              *event = job_get_event(job);
1.63      nicm      219:        struct cmdq_item                *item = cdata->item;
1.54      nicm      220:        char                            *cmd = cdata->cmd, *msg = NULL, *line;
1.5       nicm      221:        size_t                           size;
1.54      nicm      222:        int                              retcode, status;
1.7       nicm      223:
1.5       nicm      224:        do {
1.83      nicm      225:                line = evbuffer_readln(event->input, NULL, EVBUFFER_EOL_LF);
                    226:                if (line != NULL) {
1.18      nicm      227:                        cmd_run_shell_print(job, line);
1.16      nicm      228:                        free(line);
1.5       nicm      229:                }
                    230:        } while (line != NULL);
                    231:
1.54      nicm      232:        size = EVBUFFER_LENGTH(event->input);
1.5       nicm      233:        if (size != 0) {
                    234:                line = xmalloc(size + 1);
1.54      nicm      235:                memcpy(line, EVBUFFER_DATA(event->input), size);
1.5       nicm      236:                line[size] = '\0';
1.2       nicm      237:
1.14      nicm      238:                cmd_run_shell_print(job, line);
1.2       nicm      239:
1.12      nicm      240:                free(line);
1.1       nicm      241:        }
                    242:
1.54      nicm      243:        status = job_get_status(job);
                    244:        if (WIFEXITED(status)) {
                    245:                if ((retcode = WEXITSTATUS(status)) != 0)
1.2       nicm      246:                        xasprintf(&msg, "'%s' returned %d", cmd, retcode);
1.54      nicm      247:        } else if (WIFSIGNALED(status)) {
                    248:                retcode = WTERMSIG(status);
1.2       nicm      249:                xasprintf(&msg, "'%s' terminated by signal %d", cmd, retcode);
1.63      nicm      250:                retcode += 128;
1.68      nicm      251:        } else
                    252:                retcode = 0;
1.25      nicm      253:        if (msg != NULL)
                    254:                cmd_run_shell_print(job, msg);
                    255:        free(msg);
1.40      nicm      256:
1.63      nicm      257:        if (item != NULL) {
1.66      nicm      258:                if (cmdq_get_client(item) != NULL &&
                    259:                    cmdq_get_client(item)->session == NULL)
                    260:                        cmdq_get_client(item)->retval = retcode;
1.63      nicm      261:                cmdq_continue(item);
                    262:        }
1.2       nicm      263: }
                    264:
1.38      nicm      265: static void
1.2       nicm      266: cmd_run_shell_free(void *data)
                    267: {
                    268:        struct cmd_run_shell_data       *cdata = data;
                    269:
1.60      nicm      270:        evtimer_del(&cdata->timer);
1.61      nicm      271:        if (cdata->s != NULL)
                    272:                session_remove_ref(cdata->s, __func__);
1.70      nicm      273:        if (cdata->client != NULL)
                    274:                server_client_unref(cdata->client);
1.80      nicm      275:        if (cdata->state != NULL)
                    276:                args_make_commands_free(cdata->state);
1.60      nicm      277:        free(cdata->cwd);
1.12      nicm      278:        free(cdata->cmd);
                    279:        free(cdata);
1.1       nicm      280: }