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