1 /* $OpenBSD: cmd-queue.c,v 1.21 2015/02/05 10:26:29 nicm Exp $ */ 2 3 /* 4 * Copyright (c) 2013 Nicholas Marriott <nicm@users.sourceforge.net> 5 * 6 * Permission to use, copy, modify, and distribute this software for any 7 * purpose with or without fee is hereby granted, provided that the above 8 * copyright notice and this permission notice appear in all copies. 9 * 10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER 15 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING 16 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17 */ 18 19 #include <sys/types.h> 20 21 #include <ctype.h> 22 #include <stdlib.h> 23 #include <time.h> 24 25 #include "tmux.h" 26 27 /* Create new command queue. */ 28 struct cmd_q * 29 cmdq_new(struct client *c) 30 { 31 struct cmd_q *cmdq; 32 33 cmdq = xcalloc(1, sizeof *cmdq); 34 cmdq->references = 1; 35 cmdq->dead = 0; 36 37 cmdq->client = c; 38 cmdq->client_exit = -1; 39 40 TAILQ_INIT(&cmdq->queue); 41 cmdq->item = NULL; 42 cmdq->cmd = NULL; 43 44 return (cmdq); 45 } 46 47 /* Free command queue */ 48 int 49 cmdq_free(struct cmd_q *cmdq) 50 { 51 if (--cmdq->references != 0) 52 return (cmdq->dead); 53 54 cmdq_flush(cmdq); 55 free(cmdq); 56 return (1); 57 } 58 59 /* Show message from command. */ 60 void 61 cmdq_print(struct cmd_q *cmdq, const char *fmt, ...) 62 { 63 struct client *c = cmdq->client; 64 struct window *w; 65 va_list ap; 66 67 va_start(ap, fmt); 68 69 if (c == NULL) 70 /* nothing */; 71 else if (c->session == NULL || (c->flags & CLIENT_CONTROL)) { 72 evbuffer_add_vprintf(c->stdout_data, fmt, ap); 73 74 evbuffer_add(c->stdout_data, "\n", 1); 75 server_push_stdout(c); 76 } else { 77 w = c->session->curw->window; 78 if (w->active->mode != &window_copy_mode) { 79 window_pane_reset_mode(w->active); 80 window_pane_set_mode(w->active, &window_copy_mode); 81 window_copy_init_for_output(w->active); 82 } 83 window_copy_vadd(w->active, fmt, ap); 84 } 85 86 va_end(ap); 87 } 88 89 /* Show error from command. */ 90 void 91 cmdq_error(struct cmd_q *cmdq, const char *fmt, ...) 92 { 93 struct client *c = cmdq->client; 94 struct cmd *cmd = cmdq->cmd; 95 va_list ap; 96 char *msg; 97 size_t msglen; 98 99 va_start(ap, fmt); 100 msglen = xvasprintf(&msg, fmt, ap); 101 va_end(ap); 102 103 if (c == NULL) 104 cfg_add_cause("%s:%u: %s", cmd->file, cmd->line, msg); 105 else if (c->session == NULL || (c->flags & CLIENT_CONTROL)) { 106 evbuffer_add(c->stderr_data, msg, msglen); 107 evbuffer_add(c->stderr_data, "\n", 1); 108 109 server_push_stderr(c); 110 c->retval = 1; 111 } else { 112 *msg = toupper((u_char) *msg); 113 status_message_set(c, "%s", msg); 114 } 115 116 free(msg); 117 } 118 119 /* Print a guard line. */ 120 void 121 cmdq_guard(struct cmd_q *cmdq, const char *guard, int flags) 122 { 123 struct client *c = cmdq->client; 124 125 if (c == NULL || !(c->flags & CLIENT_CONTROL)) 126 return; 127 128 evbuffer_add_printf(c->stdout_data, "%%%s %ld %u %d\n", guard, 129 (long) cmdq->time, cmdq->number, flags); 130 server_push_stdout(c); 131 } 132 133 /* Add command list to queue and begin processing if needed. */ 134 void 135 cmdq_run(struct cmd_q *cmdq, struct cmd_list *cmdlist) 136 { 137 cmdq_append(cmdq, cmdlist); 138 139 if (cmdq->item == NULL) { 140 cmdq->cmd = NULL; 141 cmdq_continue(cmdq); 142 } 143 } 144 145 /* Add command list to queue. */ 146 void 147 cmdq_append(struct cmd_q *cmdq, struct cmd_list *cmdlist) 148 { 149 struct cmd_q_item *item; 150 151 item = xcalloc(1, sizeof *item); 152 item->cmdlist = cmdlist; 153 TAILQ_INSERT_TAIL(&cmdq->queue, item, qentry); 154 cmdlist->references++; 155 } 156 157 /* Continue processing command queue. Returns 1 if finishes empty. */ 158 int 159 cmdq_continue(struct cmd_q *cmdq) 160 { 161 struct cmd_q_item *next; 162 enum cmd_retval retval; 163 int empty, flags; 164 char s[1024]; 165 166 notify_disable(); 167 168 empty = TAILQ_EMPTY(&cmdq->queue); 169 if (empty) 170 goto empty; 171 172 if (cmdq->item == NULL) { 173 cmdq->item = TAILQ_FIRST(&cmdq->queue); 174 cmdq->cmd = TAILQ_FIRST(&cmdq->item->cmdlist->list); 175 } else 176 cmdq->cmd = TAILQ_NEXT(cmdq->cmd, qentry); 177 178 do { 179 while (cmdq->cmd != NULL) { 180 cmd_print(cmdq->cmd, s, sizeof s); 181 log_debug("cmdq %p: %s (client %d)", cmdq, s, 182 cmdq->client != NULL ? cmdq->client->ibuf.fd : -1); 183 184 cmdq->time = time(NULL); 185 cmdq->number++; 186 187 flags = !!(cmdq->cmd->flags & CMD_CONTROL); 188 cmdq_guard(cmdq, "begin", flags); 189 190 retval = cmdq->cmd->entry->exec(cmdq->cmd, cmdq); 191 192 if (retval == CMD_RETURN_ERROR) 193 cmdq_guard(cmdq, "error", flags); 194 else 195 cmdq_guard(cmdq, "end", flags); 196 197 if (retval == CMD_RETURN_ERROR) 198 break; 199 if (retval == CMD_RETURN_WAIT) 200 goto out; 201 if (retval == CMD_RETURN_STOP) { 202 cmdq_flush(cmdq); 203 goto empty; 204 } 205 206 cmdq->cmd = TAILQ_NEXT(cmdq->cmd, qentry); 207 } 208 next = TAILQ_NEXT(cmdq->item, qentry); 209 210 TAILQ_REMOVE(&cmdq->queue, cmdq->item, qentry); 211 cmd_list_free(cmdq->item->cmdlist); 212 free(cmdq->item); 213 214 cmdq->item = next; 215 if (cmdq->item != NULL) 216 cmdq->cmd = TAILQ_FIRST(&cmdq->item->cmdlist->list); 217 } while (cmdq->item != NULL); 218 219 empty: 220 if (cmdq->client_exit > 0) 221 cmdq->client->flags |= CLIENT_EXIT; 222 if (cmdq->emptyfn != NULL) 223 cmdq->emptyfn(cmdq); /* may free cmdq */ 224 empty = 1; 225 226 out: 227 notify_enable(); 228 return (empty); 229 } 230 231 /* Flush command queue. */ 232 void 233 cmdq_flush(struct cmd_q *cmdq) 234 { 235 struct cmd_q_item *item, *item1; 236 237 TAILQ_FOREACH_SAFE(item, &cmdq->queue, qentry, item1) { 238 TAILQ_REMOVE(&cmdq->queue, item, qentry); 239 cmd_list_free(item->cmdlist); 240 free(item); 241 } 242 cmdq->item = NULL; 243 } 244