1 /* $OpenBSD: cmd.c,v 1.140 2018/08/02 18:35:21 nicm Exp $ */ 2 3 /* 4 * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com> 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 #include <sys/time.h> 21 22 #include <fnmatch.h> 23 #include <paths.h> 24 #include <pwd.h> 25 #include <stdlib.h> 26 #include <string.h> 27 #include <unistd.h> 28 29 #include "tmux.h" 30 31 extern const struct cmd_entry cmd_attach_session_entry; 32 extern const struct cmd_entry cmd_bind_key_entry; 33 extern const struct cmd_entry cmd_break_pane_entry; 34 extern const struct cmd_entry cmd_capture_pane_entry; 35 extern const struct cmd_entry cmd_choose_buffer_entry; 36 extern const struct cmd_entry cmd_choose_client_entry; 37 extern const struct cmd_entry cmd_choose_tree_entry; 38 extern const struct cmd_entry cmd_clear_history_entry; 39 extern const struct cmd_entry cmd_clock_mode_entry; 40 extern const struct cmd_entry cmd_command_prompt_entry; 41 extern const struct cmd_entry cmd_confirm_before_entry; 42 extern const struct cmd_entry cmd_copy_mode_entry; 43 extern const struct cmd_entry cmd_delete_buffer_entry; 44 extern const struct cmd_entry cmd_detach_client_entry; 45 extern const struct cmd_entry cmd_display_message_entry; 46 extern const struct cmd_entry cmd_display_panes_entry; 47 extern const struct cmd_entry cmd_down_pane_entry; 48 extern const struct cmd_entry cmd_find_window_entry; 49 extern const struct cmd_entry cmd_has_session_entry; 50 extern const struct cmd_entry cmd_if_shell_entry; 51 extern const struct cmd_entry cmd_join_pane_entry; 52 extern const struct cmd_entry cmd_kill_pane_entry; 53 extern const struct cmd_entry cmd_kill_server_entry; 54 extern const struct cmd_entry cmd_kill_session_entry; 55 extern const struct cmd_entry cmd_kill_window_entry; 56 extern const struct cmd_entry cmd_last_pane_entry; 57 extern const struct cmd_entry cmd_last_window_entry; 58 extern const struct cmd_entry cmd_link_window_entry; 59 extern const struct cmd_entry cmd_list_buffers_entry; 60 extern const struct cmd_entry cmd_list_clients_entry; 61 extern const struct cmd_entry cmd_list_commands_entry; 62 extern const struct cmd_entry cmd_list_keys_entry; 63 extern const struct cmd_entry cmd_list_panes_entry; 64 extern const struct cmd_entry cmd_list_sessions_entry; 65 extern const struct cmd_entry cmd_list_windows_entry; 66 extern const struct cmd_entry cmd_load_buffer_entry; 67 extern const struct cmd_entry cmd_lock_client_entry; 68 extern const struct cmd_entry cmd_lock_server_entry; 69 extern const struct cmd_entry cmd_lock_session_entry; 70 extern const struct cmd_entry cmd_move_pane_entry; 71 extern const struct cmd_entry cmd_move_window_entry; 72 extern const struct cmd_entry cmd_new_session_entry; 73 extern const struct cmd_entry cmd_new_window_entry; 74 extern const struct cmd_entry cmd_next_layout_entry; 75 extern const struct cmd_entry cmd_next_window_entry; 76 extern const struct cmd_entry cmd_paste_buffer_entry; 77 extern const struct cmd_entry cmd_pipe_pane_entry; 78 extern const struct cmd_entry cmd_previous_layout_entry; 79 extern const struct cmd_entry cmd_previous_window_entry; 80 extern const struct cmd_entry cmd_refresh_client_entry; 81 extern const struct cmd_entry cmd_rename_session_entry; 82 extern const struct cmd_entry cmd_rename_window_entry; 83 extern const struct cmd_entry cmd_resize_pane_entry; 84 extern const struct cmd_entry cmd_respawn_pane_entry; 85 extern const struct cmd_entry cmd_respawn_window_entry; 86 extern const struct cmd_entry cmd_rotate_window_entry; 87 extern const struct cmd_entry cmd_run_shell_entry; 88 extern const struct cmd_entry cmd_save_buffer_entry; 89 extern const struct cmd_entry cmd_select_layout_entry; 90 extern const struct cmd_entry cmd_select_pane_entry; 91 extern const struct cmd_entry cmd_select_window_entry; 92 extern const struct cmd_entry cmd_send_keys_entry; 93 extern const struct cmd_entry cmd_send_prefix_entry; 94 extern const struct cmd_entry cmd_set_buffer_entry; 95 extern const struct cmd_entry cmd_set_environment_entry; 96 extern const struct cmd_entry cmd_set_hook_entry; 97 extern const struct cmd_entry cmd_set_option_entry; 98 extern const struct cmd_entry cmd_set_window_option_entry; 99 extern const struct cmd_entry cmd_show_buffer_entry; 100 extern const struct cmd_entry cmd_show_environment_entry; 101 extern const struct cmd_entry cmd_show_hooks_entry; 102 extern const struct cmd_entry cmd_show_messages_entry; 103 extern const struct cmd_entry cmd_show_options_entry; 104 extern const struct cmd_entry cmd_show_window_options_entry; 105 extern const struct cmd_entry cmd_source_file_entry; 106 extern const struct cmd_entry cmd_split_window_entry; 107 extern const struct cmd_entry cmd_start_server_entry; 108 extern const struct cmd_entry cmd_suspend_client_entry; 109 extern const struct cmd_entry cmd_swap_pane_entry; 110 extern const struct cmd_entry cmd_swap_window_entry; 111 extern const struct cmd_entry cmd_switch_client_entry; 112 extern const struct cmd_entry cmd_unbind_key_entry; 113 extern const struct cmd_entry cmd_unlink_window_entry; 114 extern const struct cmd_entry cmd_up_pane_entry; 115 extern const struct cmd_entry cmd_wait_for_entry; 116 117 const struct cmd_entry *cmd_table[] = { 118 &cmd_attach_session_entry, 119 &cmd_bind_key_entry, 120 &cmd_break_pane_entry, 121 &cmd_capture_pane_entry, 122 &cmd_choose_buffer_entry, 123 &cmd_choose_client_entry, 124 &cmd_choose_tree_entry, 125 &cmd_clear_history_entry, 126 &cmd_clock_mode_entry, 127 &cmd_command_prompt_entry, 128 &cmd_confirm_before_entry, 129 &cmd_copy_mode_entry, 130 &cmd_delete_buffer_entry, 131 &cmd_detach_client_entry, 132 &cmd_display_message_entry, 133 &cmd_display_panes_entry, 134 &cmd_find_window_entry, 135 &cmd_has_session_entry, 136 &cmd_if_shell_entry, 137 &cmd_join_pane_entry, 138 &cmd_kill_pane_entry, 139 &cmd_kill_server_entry, 140 &cmd_kill_session_entry, 141 &cmd_kill_window_entry, 142 &cmd_last_pane_entry, 143 &cmd_last_window_entry, 144 &cmd_link_window_entry, 145 &cmd_list_buffers_entry, 146 &cmd_list_clients_entry, 147 &cmd_list_commands_entry, 148 &cmd_list_keys_entry, 149 &cmd_list_panes_entry, 150 &cmd_list_sessions_entry, 151 &cmd_list_windows_entry, 152 &cmd_load_buffer_entry, 153 &cmd_lock_client_entry, 154 &cmd_lock_server_entry, 155 &cmd_lock_session_entry, 156 &cmd_move_pane_entry, 157 &cmd_move_window_entry, 158 &cmd_new_session_entry, 159 &cmd_new_window_entry, 160 &cmd_next_layout_entry, 161 &cmd_next_window_entry, 162 &cmd_paste_buffer_entry, 163 &cmd_pipe_pane_entry, 164 &cmd_previous_layout_entry, 165 &cmd_previous_window_entry, 166 &cmd_refresh_client_entry, 167 &cmd_rename_session_entry, 168 &cmd_rename_window_entry, 169 &cmd_resize_pane_entry, 170 &cmd_respawn_pane_entry, 171 &cmd_respawn_window_entry, 172 &cmd_rotate_window_entry, 173 &cmd_run_shell_entry, 174 &cmd_save_buffer_entry, 175 &cmd_select_layout_entry, 176 &cmd_select_pane_entry, 177 &cmd_select_window_entry, 178 &cmd_send_keys_entry, 179 &cmd_send_prefix_entry, 180 &cmd_set_buffer_entry, 181 &cmd_set_environment_entry, 182 &cmd_set_hook_entry, 183 &cmd_set_option_entry, 184 &cmd_set_window_option_entry, 185 &cmd_show_buffer_entry, 186 &cmd_show_environment_entry, 187 &cmd_show_hooks_entry, 188 &cmd_show_messages_entry, 189 &cmd_show_options_entry, 190 &cmd_show_window_options_entry, 191 &cmd_source_file_entry, 192 &cmd_split_window_entry, 193 &cmd_start_server_entry, 194 &cmd_suspend_client_entry, 195 &cmd_swap_pane_entry, 196 &cmd_swap_window_entry, 197 &cmd_switch_client_entry, 198 &cmd_unbind_key_entry, 199 &cmd_unlink_window_entry, 200 &cmd_wait_for_entry, 201 NULL 202 }; 203 204 void 205 cmd_log_argv(int argc, char **argv, const char *prefix) 206 { 207 int i; 208 209 for (i = 0; i < argc; i++) 210 log_debug("%s: argv[%d]=%s", prefix, i, argv[i]); 211 } 212 213 int 214 cmd_pack_argv(int argc, char **argv, char *buf, size_t len) 215 { 216 size_t arglen; 217 int i; 218 219 if (argc == 0) 220 return (0); 221 cmd_log_argv(argc, argv, __func__); 222 223 *buf = '\0'; 224 for (i = 0; i < argc; i++) { 225 if (strlcpy(buf, argv[i], len) >= len) 226 return (-1); 227 arglen = strlen(argv[i]) + 1; 228 buf += arglen; 229 len -= arglen; 230 } 231 232 return (0); 233 } 234 235 int 236 cmd_unpack_argv(char *buf, size_t len, int argc, char ***argv) 237 { 238 int i; 239 size_t arglen; 240 241 if (argc == 0) 242 return (0); 243 *argv = xcalloc(argc, sizeof **argv); 244 245 buf[len - 1] = '\0'; 246 for (i = 0; i < argc; i++) { 247 if (len == 0) { 248 cmd_free_argv(argc, *argv); 249 return (-1); 250 } 251 252 arglen = strlen(buf) + 1; 253 (*argv)[i] = xstrdup(buf); 254 255 buf += arglen; 256 len -= arglen; 257 } 258 cmd_log_argv(argc, *argv, __func__); 259 260 return (0); 261 } 262 263 char ** 264 cmd_copy_argv(int argc, char **argv) 265 { 266 char **new_argv; 267 int i; 268 269 if (argc == 0) 270 return (NULL); 271 new_argv = xcalloc(argc + 1, sizeof *new_argv); 272 for (i = 0; i < argc; i++) { 273 if (argv[i] != NULL) 274 new_argv[i] = xstrdup(argv[i]); 275 } 276 return (new_argv); 277 } 278 279 void 280 cmd_free_argv(int argc, char **argv) 281 { 282 int i; 283 284 if (argc == 0) 285 return; 286 for (i = 0; i < argc; i++) 287 free(argv[i]); 288 free(argv); 289 } 290 291 char * 292 cmd_stringify_argv(int argc, char **argv) 293 { 294 char *buf; 295 int i; 296 size_t len; 297 298 if (argc == 0) 299 return (xstrdup("")); 300 301 len = 0; 302 buf = NULL; 303 304 for (i = 0; i < argc; i++) { 305 len += strlen(argv[i]) + 1; 306 buf = xrealloc(buf, len); 307 308 if (i == 0) 309 *buf = '\0'; 310 else 311 strlcat(buf, " ", len); 312 strlcat(buf, argv[i], len); 313 } 314 return (buf); 315 } 316 317 static int 318 cmd_try_alias(int *argc, char ***argv) 319 { 320 struct options_entry *o; 321 int old_argc = *argc, new_argc; 322 char **old_argv = *argv, **new_argv; 323 u_int size, idx; 324 int i; 325 size_t wanted; 326 const char *s, *cp = NULL; 327 328 o = options_get_only(global_options, "command-alias"); 329 if (o == NULL || options_array_size(o, &size) == -1 || size == 0) 330 return (-1); 331 332 wanted = strlen(old_argv[0]); 333 for (idx = 0; idx < size; idx++) { 334 s = options_array_get(o, idx); 335 if (s == NULL) 336 continue; 337 338 cp = strchr(s, '='); 339 if (cp == NULL || (size_t)(cp - s) != wanted) 340 continue; 341 if (strncmp(old_argv[0], s, wanted) == 0) 342 break; 343 } 344 if (idx == size) 345 return (-1); 346 347 if (cmd_string_split(cp + 1, &new_argc, &new_argv) != 0) 348 return (-1); 349 350 *argc = new_argc + old_argc - 1; 351 *argv = xcalloc((*argc) + 1, sizeof **argv); 352 353 for (i = 0; i < new_argc; i++) 354 (*argv)[i] = xstrdup(new_argv[i]); 355 for (i = 1; i < old_argc; i++) 356 (*argv)[new_argc + i - 1] = xstrdup(old_argv[i]); 357 358 log_debug("alias: %s=%s", old_argv[0], cp + 1); 359 for (i = 0; i < *argc; i++) 360 log_debug("alias: argv[%d] = %s", i, (*argv)[i]); 361 362 cmd_free_argv(new_argc, new_argv); 363 return (0); 364 } 365 366 struct cmd * 367 cmd_parse(int argc, char **argv, const char *file, u_int line, char **cause) 368 { 369 const char *name; 370 const struct cmd_entry **entryp, *entry; 371 struct cmd *cmd; 372 struct args *args; 373 char s[BUFSIZ]; 374 int ambiguous, allocated = 0; 375 376 *cause = NULL; 377 if (argc == 0) { 378 xasprintf(cause, "no command"); 379 return (NULL); 380 } 381 name = argv[0]; 382 383 retry: 384 ambiguous = 0; 385 entry = NULL; 386 for (entryp = cmd_table; *entryp != NULL; entryp++) { 387 if ((*entryp)->alias != NULL && 388 strcmp((*entryp)->alias, argv[0]) == 0) { 389 ambiguous = 0; 390 entry = *entryp; 391 break; 392 } 393 394 if (strncmp((*entryp)->name, argv[0], strlen(argv[0])) != 0) 395 continue; 396 if (entry != NULL) 397 ambiguous = 1; 398 entry = *entryp; 399 400 /* Bail now if an exact match. */ 401 if (strcmp(entry->name, argv[0]) == 0) 402 break; 403 } 404 if ((ambiguous || entry == NULL) && 405 server_proc != NULL && 406 !allocated && 407 cmd_try_alias(&argc, &argv) == 0) { 408 allocated = 1; 409 goto retry; 410 } 411 if (ambiguous) 412 goto ambiguous; 413 if (entry == NULL) { 414 xasprintf(cause, "unknown command: %s", name); 415 return (NULL); 416 } 417 cmd_log_argv(argc, argv, entry->name); 418 419 args = args_parse(entry->args.template, argc, argv); 420 if (args == NULL) 421 goto usage; 422 if (entry->args.lower != -1 && args->argc < entry->args.lower) 423 goto usage; 424 if (entry->args.upper != -1 && args->argc > entry->args.upper) 425 goto usage; 426 427 cmd = xcalloc(1, sizeof *cmd); 428 cmd->entry = entry; 429 cmd->args = args; 430 431 if (file != NULL) 432 cmd->file = xstrdup(file); 433 cmd->line = line; 434 435 if (allocated) 436 cmd_free_argv(argc, argv); 437 return (cmd); 438 439 ambiguous: 440 *s = '\0'; 441 for (entryp = cmd_table; *entryp != NULL; entryp++) { 442 if (strncmp((*entryp)->name, argv[0], strlen(argv[0])) != 0) 443 continue; 444 if (strlcat(s, (*entryp)->name, sizeof s) >= sizeof s) 445 break; 446 if (strlcat(s, ", ", sizeof s) >= sizeof s) 447 break; 448 } 449 s[strlen(s) - 2] = '\0'; 450 xasprintf(cause, "ambiguous command: %s, could be: %s", name, s); 451 return (NULL); 452 453 usage: 454 if (args != NULL) 455 args_free(args); 456 xasprintf(cause, "usage: %s %s", entry->name, entry->usage); 457 return (NULL); 458 } 459 460 char * 461 cmd_print(struct cmd *cmd) 462 { 463 char *out, *s; 464 465 s = args_print(cmd->args); 466 if (*s != '\0') 467 xasprintf(&out, "%s %s", cmd->entry->name, s); 468 else 469 out = xstrdup(cmd->entry->name); 470 free(s); 471 472 return (out); 473 } 474 475 /* Adjust current mouse position for a pane. */ 476 int 477 cmd_mouse_at(struct window_pane *wp, struct mouse_event *m, u_int *xp, 478 u_int *yp, int last) 479 { 480 u_int x, y; 481 482 if (last) { 483 x = m->lx; 484 y = m->ly; 485 } else { 486 x = m->x; 487 y = m->y; 488 } 489 490 if (m->statusat == 0 && y > 0) 491 y--; 492 else if (m->statusat > 0 && y >= (u_int)m->statusat) 493 y = m->statusat - 1; 494 495 if (x < wp->xoff || x >= wp->xoff + wp->sx) 496 return (-1); 497 if (y < wp->yoff || y >= wp->yoff + wp->sy) 498 return (-1); 499 500 if (xp != NULL) 501 *xp = x - wp->xoff; 502 if (yp != NULL) 503 *yp = y - wp->yoff; 504 return (0); 505 } 506 507 /* Get current mouse window if any. */ 508 struct winlink * 509 cmd_mouse_window(struct mouse_event *m, struct session **sp) 510 { 511 struct session *s; 512 struct window *w; 513 514 if (!m->valid || m->s == -1 || m->w == -1) 515 return (NULL); 516 if ((s = session_find_by_id(m->s)) == NULL) 517 return (NULL); 518 if ((w = window_find_by_id(m->w)) == NULL) 519 return (NULL); 520 521 if (sp != NULL) 522 *sp = s; 523 return (winlink_find_by_window(&s->windows, w)); 524 } 525 526 /* Get current mouse pane if any. */ 527 struct window_pane * 528 cmd_mouse_pane(struct mouse_event *m, struct session **sp, 529 struct winlink **wlp) 530 { 531 struct winlink *wl; 532 struct window_pane *wp; 533 534 if ((wl = cmd_mouse_window(m, sp)) == NULL) 535 return (NULL); 536 if ((wp = window_pane_find_by_id(m->wp)) == NULL) 537 return (NULL); 538 if (!window_has_pane(wl->window, wp)) 539 return (NULL); 540 541 if (wlp != NULL) 542 *wlp = wl; 543 return (wp); 544 } 545 546 /* Replace the first %% or %idx in template by s. */ 547 char * 548 cmd_template_replace(const char *template, const char *s, int idx) 549 { 550 char ch, *buf; 551 const char *ptr, *cp, quote[] = "\"\\$"; 552 int replaced, quoted; 553 size_t len; 554 555 if (strchr(template, '%') == NULL) 556 return (xstrdup(template)); 557 558 buf = xmalloc(1); 559 *buf = '\0'; 560 len = 0; 561 replaced = 0; 562 563 ptr = template; 564 while (*ptr != '\0') { 565 switch (ch = *ptr++) { 566 case '%': 567 if (*ptr < '1' || *ptr > '9' || *ptr - '0' != idx) { 568 if (*ptr != '%' || replaced) 569 break; 570 replaced = 1; 571 } 572 ptr++; 573 574 quoted = (*ptr == '%'); 575 if (quoted) 576 ptr++; 577 578 buf = xrealloc(buf, len + (strlen(s) * 3) + 1); 579 for (cp = s; *cp != '\0'; cp++) { 580 if (quoted && strchr(quote, *cp) != NULL) 581 buf[len++] = '\\'; 582 if (quoted && *cp == ';') { 583 buf[len++] = '\\'; 584 buf[len++] = '\\'; 585 } 586 buf[len++] = *cp; 587 } 588 buf[len] = '\0'; 589 continue; 590 } 591 buf = xrealloc(buf, len + 2); 592 buf[len++] = ch; 593 buf[len] = '\0'; 594 } 595 596 return (buf); 597 } 598