1 /* $OpenBSD: cmd-queue.c,v 1.20 2014/10/27 22:23:47 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 int 121 cmdq_guard(struct cmd_q *cmdq, const char *guard, int flags) 122 { 123 struct client *c = cmdq->client; 124 125 if (c == NULL) 126 return (0); 127 if (!(c->flags & CLIENT_CONTROL)) 128 return (0); 129 130 evbuffer_add_printf(c->stdout_data, "%%%s %ld %u %d\n", guard, 131 (long) cmdq->time, cmdq->number, flags); 132 server_push_stdout(c); 133 return (1); 134 } 135 136 /* Add command list to queue and begin processing if needed. */ 137 void 138 cmdq_run(struct cmd_q *cmdq, struct cmd_list *cmdlist) 139 { 140 cmdq_append(cmdq, cmdlist); 141 142 if (cmdq->item == NULL) { 143 cmdq->cmd = NULL; 144 cmdq_continue(cmdq); 145 } 146 } 147 148 /* Add command list to queue. */ 149 void 150 cmdq_append(struct cmd_q *cmdq, struct cmd_list *cmdlist) 151 { 152 struct cmd_q_item *item; 153 154 item = xcalloc(1, sizeof *item); 155 item->cmdlist = cmdlist; 156 TAILQ_INSERT_TAIL(&cmdq->queue, item, qentry); 157 cmdlist->references++; 158 } 159 160 /* Continue processing command queue. Returns 1 if finishes empty. */ 161 int 162 cmdq_continue(struct cmd_q *cmdq) 163 { 164 struct cmd_q_item *next; 165 enum cmd_retval retval; 166 int empty, guard, flags; 167 char s[1024]; 168 169 notify_disable(); 170 171 empty = TAILQ_EMPTY(&cmdq->queue); 172 if (empty) 173 goto empty; 174 175 if (cmdq->item == NULL) { 176 cmdq->item = TAILQ_FIRST(&cmdq->queue); 177 cmdq->cmd = TAILQ_FIRST(&cmdq->item->cmdlist->list); 178 } else 179 cmdq->cmd = TAILQ_NEXT(cmdq->cmd, qentry); 180 181 do { 182 while (cmdq->cmd != NULL) { 183 cmd_print(cmdq->cmd, s, sizeof s); 184 log_debug("cmdq %p: %s (client %d)", cmdq, s, 185 cmdq->client != NULL ? cmdq->client->ibuf.fd : -1); 186 187 cmdq->time = time(NULL); 188 cmdq->number++; 189 190 flags = !!(cmdq->cmd->flags & CMD_CONTROL); 191 guard = cmdq_guard(cmdq, "begin", flags); 192 193 retval = cmdq->cmd->entry->exec(cmdq->cmd, cmdq); 194 195 if (guard) { 196 if (retval == CMD_RETURN_ERROR) 197 cmdq_guard(cmdq, "error", flags); 198 else 199 cmdq_guard(cmdq, "end", flags); 200 } 201 202 if (retval == CMD_RETURN_ERROR) 203 break; 204 if (retval == CMD_RETURN_WAIT) 205 goto out; 206 if (retval == CMD_RETURN_STOP) { 207 cmdq_flush(cmdq); 208 goto empty; 209 } 210 211 cmdq->cmd = TAILQ_NEXT(cmdq->cmd, qentry); 212 } 213 next = TAILQ_NEXT(cmdq->item, qentry); 214 215 TAILQ_REMOVE(&cmdq->queue, cmdq->item, qentry); 216 cmd_list_free(cmdq->item->cmdlist); 217 free(cmdq->item); 218 219 cmdq->item = next; 220 if (cmdq->item != NULL) 221 cmdq->cmd = TAILQ_FIRST(&cmdq->item->cmdlist->list); 222 } while (cmdq->item != NULL); 223 224 empty: 225 if (cmdq->client_exit > 0) 226 cmdq->client->flags |= CLIENT_EXIT; 227 if (cmdq->emptyfn != NULL) 228 cmdq->emptyfn(cmdq); /* may free cmdq */ 229 empty = 1; 230 231 out: 232 notify_enable(); 233 return (empty); 234 } 235 236 /* Flush command queue. */ 237 void 238 cmdq_flush(struct cmd_q *cmdq) 239 { 240 struct cmd_q_item *item, *item1; 241 242 TAILQ_FOREACH_SAFE(item, &cmdq->queue, qentry, item1) { 243 TAILQ_REMOVE(&cmdq->queue, item, qentry); 244 cmd_list_free(item->cmdlist); 245 free(item); 246 } 247 cmdq->item = NULL; 248 } 249