1 /* $OpenBSD: tmux.c,v 1.76 2010/05/03 16:06:32 nicm Exp $ */ 2 3 /* 4 * Copyright (c) 2007 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 #include <sys/stat.h> 21 #include <sys/wait.h> 22 23 #include <errno.h> 24 #include <event.h> 25 #include <paths.h> 26 #include <pwd.h> 27 #include <signal.h> 28 #include <stdlib.h> 29 #include <string.h> 30 #include <syslog.h> 31 #include <unistd.h> 32 33 #include "tmux.h" 34 35 #ifdef DEBUG 36 extern char *malloc_options; 37 #endif 38 39 char *cfg_file; 40 struct options global_options; /* server options */ 41 struct options global_s_options; /* session options */ 42 struct options global_w_options; /* window options */ 43 struct environ global_environ; 44 45 struct event_base *ev_base; 46 47 int debug_level; 48 time_t start_time; 49 char *socket_path; 50 int login_shell; 51 52 struct env_data { 53 char *path; 54 pid_t pid; 55 u_int idx; 56 }; 57 58 __dead void usage(void); 59 void parse_env(struct env_data *); 60 char *makesockpath(const char *); 61 __dead void shell_exec(const char *, const char *); 62 63 struct imsgbuf *main_ibuf; 64 int main_exitval; 65 66 void main_signal(int, short, unused void *); 67 void main_callback(int, short, void *); 68 void main_dispatch(const char *); 69 70 __dead void 71 usage(void) 72 { 73 fprintf(stderr, 74 "usage: %s [-28lquv] [-c shell-command] [-f file] [-L socket-name]\n" 75 " [-S socket-path] [command [flags]]\n", 76 __progname); 77 exit(1); 78 } 79 80 void 81 logfile(const char *name) 82 { 83 char *path; 84 85 log_close(); 86 if (debug_level > 0) { 87 xasprintf(&path, "tmux-%s-%ld.log", name, (long) getpid()); 88 log_open_file(debug_level, path); 89 xfree(path); 90 } 91 } 92 93 const char * 94 getshell(void) 95 { 96 struct passwd *pw; 97 const char *shell; 98 99 shell = getenv("SHELL"); 100 if (checkshell(shell)) 101 return (shell); 102 103 pw = getpwuid(getuid()); 104 if (pw != NULL && checkshell(pw->pw_shell)) 105 return (pw->pw_shell); 106 107 return (_PATH_BSHELL); 108 } 109 110 int 111 checkshell(const char *shell) 112 { 113 if (shell == NULL || *shell == '\0' || areshell(shell)) 114 return (0); 115 if (access(shell, X_OK) != 0) 116 return (0); 117 return (1); 118 } 119 120 int 121 areshell(const char *shell) 122 { 123 const char *progname, *ptr; 124 125 if ((ptr = strrchr(shell, '/')) != NULL) 126 ptr++; 127 else 128 ptr = shell; 129 progname = __progname; 130 if (*progname == '-') 131 progname++; 132 if (strcmp(ptr, progname) == 0) 133 return (1); 134 return (0); 135 } 136 137 void 138 parse_env(struct env_data *data) 139 { 140 char *env, *path_pid, *pid_idx, buf[256]; 141 size_t len; 142 const char *errstr; 143 long long ll; 144 145 data->pid = -1; 146 if ((env = getenv("TMUX")) == NULL) 147 return; 148 149 if ((path_pid = strchr(env, ',')) == NULL || path_pid == env) 150 return; 151 if ((pid_idx = strchr(path_pid + 1, ',')) == NULL) 152 return; 153 if ((pid_idx == path_pid + 1 || pid_idx[1] == '\0')) 154 return; 155 156 /* path */ 157 len = path_pid - env; 158 data->path = xmalloc (len + 1); 159 memcpy(data->path, env, len); 160 data->path[len] = '\0'; 161 162 /* pid */ 163 len = pid_idx - path_pid - 1; 164 if (len > (sizeof buf) - 1) 165 return; 166 memcpy(buf, path_pid + 1, len); 167 buf[len] = '\0'; 168 169 ll = strtonum(buf, 0, LONG_MAX, &errstr); 170 if (errstr != NULL) 171 return; 172 data->pid = ll; 173 174 /* idx */ 175 ll = strtonum(pid_idx+1, 0, UINT_MAX, &errstr); 176 if (errstr != NULL) 177 return; 178 data->idx = ll; 179 } 180 181 char * 182 makesockpath(const char *label) 183 { 184 char base[MAXPATHLEN], *path; 185 struct stat sb; 186 u_int uid; 187 188 uid = getuid(); 189 xsnprintf(base, MAXPATHLEN, "%s/tmux-%d", _PATH_TMP, uid); 190 191 if (mkdir(base, S_IRWXU) != 0 && errno != EEXIST) 192 return (NULL); 193 194 if (lstat(base, &sb) != 0) 195 return (NULL); 196 if (!S_ISDIR(sb.st_mode)) { 197 errno = ENOTDIR; 198 return (NULL); 199 } 200 if (sb.st_uid != uid || (sb.st_mode & (S_IRWXG|S_IRWXO)) != 0) { 201 errno = EACCES; 202 return (NULL); 203 } 204 205 xasprintf(&path, "%s/%s", base, label); 206 return (path); 207 } 208 209 __dead void 210 shell_exec(const char *shell, const char *shellcmd) 211 { 212 const char *shellname, *ptr; 213 char *argv0; 214 215 ptr = strrchr(shell, '/'); 216 if (ptr != NULL && *(ptr + 1) != '\0') 217 shellname = ptr + 1; 218 else 219 shellname = shell; 220 if (login_shell) 221 xasprintf(&argv0, "-%s", shellname); 222 else 223 xasprintf(&argv0, "%s", shellname); 224 setenv("SHELL", shell, 1); 225 226 execl(shell, argv0, "-c", shellcmd, (char *) NULL); 227 fatal("execl failed"); 228 } 229 230 int 231 main(int argc, char **argv) 232 { 233 struct cmd_list *cmdlist; 234 struct cmd *cmd; 235 enum msgtype msg; 236 struct passwd *pw; 237 struct options *oo, *so, *wo; 238 struct keylist *keylist; 239 struct env_data envdata; 240 struct msg_command_data cmddata; 241 char *s, *shellcmd, *path, *label, *home, *cause; 242 char cwd[MAXPATHLEN], **var; 243 void *buf; 244 size_t len; 245 int opt, flags, quiet = 0, cmdflags = 0; 246 short events; 247 248 #ifdef DEBUG 249 malloc_options = (char *) "AFGJPX"; 250 #endif 251 252 flags = 0; 253 shellcmd = label = path = NULL; 254 envdata.path = NULL; 255 login_shell = (**argv == '-'); 256 while ((opt = getopt(argc, argv, "28c:df:lL:qS:uUv")) != -1) { 257 switch (opt) { 258 case '2': 259 flags |= IDENTIFY_256COLOURS; 260 flags &= ~IDENTIFY_88COLOURS; 261 break; 262 case '8': 263 flags |= IDENTIFY_88COLOURS; 264 flags &= ~IDENTIFY_256COLOURS; 265 break; 266 case 'c': 267 if (shellcmd != NULL) 268 xfree(shellcmd); 269 shellcmd = xstrdup(optarg); 270 break; 271 case 'f': 272 if (cfg_file != NULL) 273 xfree(cfg_file); 274 cfg_file = xstrdup(optarg); 275 break; 276 case 'l': 277 login_shell = 1; 278 break; 279 case 'L': 280 if (label != NULL) 281 xfree(label); 282 label = xstrdup(optarg); 283 break; 284 case 'q': 285 quiet = 1; 286 break; 287 case 'S': 288 if (path != NULL) 289 xfree(path); 290 path = xstrdup(optarg); 291 break; 292 case 'u': 293 flags |= IDENTIFY_UTF8; 294 break; 295 case 'v': 296 debug_level++; 297 break; 298 default: 299 usage(); 300 } 301 } 302 argc -= optind; 303 argv += optind; 304 305 if (shellcmd != NULL && argc != 0) 306 usage(); 307 308 log_open_tty(debug_level); 309 310 if (!(flags & IDENTIFY_UTF8)) { 311 /* 312 * If the user has set whichever of LC_ALL, LC_CTYPE or LANG 313 * exist (in that order) to contain UTF-8, it is a safe 314 * assumption that either they are using a UTF-8 terminal, or 315 * if not they know that output from UTF-8-capable programs may 316 * be wrong. 317 */ 318 if ((s = getenv("LC_ALL")) == NULL) { 319 if ((s = getenv("LC_CTYPE")) == NULL) 320 s = getenv("LANG"); 321 } 322 if (s != NULL && (strcasestr(s, "UTF-8") != NULL || 323 strcasestr(s, "UTF8") != NULL)) 324 flags |= IDENTIFY_UTF8; 325 } 326 327 environ_init(&global_environ); 328 for (var = environ; *var != NULL; var++) 329 environ_put(&global_environ, *var); 330 331 options_init(&global_options, NULL); 332 oo = &global_options; 333 options_set_number(oo, "quiet", quiet); 334 options_set_number(oo, "escape-time", 500); 335 336 options_init(&global_s_options, NULL); 337 so = &global_s_options; 338 options_set_number(so, "base-index", 0); 339 options_set_number(so, "bell-action", BELL_ANY); 340 options_set_number(so, "buffer-limit", 9); 341 options_set_string(so, "default-command", "%s", ""); 342 options_set_string(so, "default-shell", "%s", getshell()); 343 options_set_string(so, "default-terminal", "screen"); 344 options_set_number(so, "display-panes-colour", 4); 345 options_set_number(so, "display-panes-active-colour", 1); 346 options_set_number(so, "display-panes-time", 1000); 347 options_set_number(so, "display-time", 750); 348 options_set_number(so, "history-limit", 2000); 349 options_set_number(so, "lock-after-time", 0); 350 options_set_string(so, "lock-command", "lock -np"); 351 options_set_number(so, "lock-server", 1); 352 options_set_number(so, "message-attr", 0); 353 options_set_number(so, "message-bg", 3); 354 options_set_number(so, "message-fg", 0); 355 options_set_number(so, "message-limit", 20); 356 options_set_number(so, "mouse-select-pane", 0); 357 options_set_number(so, "pane-active-border-bg", 8); 358 options_set_number(so, "pane-active-border-fg", 2); 359 options_set_number(so, "pane-border-bg", 8); 360 options_set_number(so, "pane-border-fg", 8); 361 options_set_number(so, "repeat-time", 500); 362 options_set_number(so, "set-remain-on-exit", 0); 363 options_set_number(so, "set-titles", 0); 364 options_set_string(so, "set-titles-string", "#S:#I:#W - \"#T\""); 365 options_set_number(so, "status", 1); 366 options_set_number(so, "status-attr", 0); 367 options_set_number(so, "status-bg", 2); 368 options_set_number(so, "status-fg", 0); 369 options_set_number(so, "status-interval", 15); 370 options_set_number(so, "status-justify", 0); 371 options_set_number(so, "status-keys", MODEKEY_EMACS); 372 options_set_string(so, "status-left", "[#S]"); 373 options_set_number(so, "status-left-attr", 0); 374 options_set_number(so, "status-left-bg", 8); 375 options_set_number(so, "status-left-fg", 8); 376 options_set_number(so, "status-left-length", 10); 377 options_set_string(so, "status-right", "\"#22T\" %%H:%%M %%d-%%b-%%y"); 378 options_set_number(so, "status-right-attr", 0); 379 options_set_number(so, "status-right-bg", 8); 380 options_set_number(so, "status-right-fg", 8); 381 options_set_number(so, "status-right-length", 40); 382 options_set_string(so, "terminal-overrides", 383 "*88col*:colors=88,*256col*:colors=256"); 384 options_set_string(so, "update-environment", "DISPLAY " 385 "WINDOWID SSH_ASKPASS SSH_AUTH_SOCK SSH_AGENT_PID SSH_CONNECTION"); 386 options_set_number(so, "visual-activity", 0); 387 options_set_number(so, "visual-bell", 0); 388 options_set_number(so, "visual-content", 0); 389 390 keylist = xmalloc(sizeof *keylist); 391 ARRAY_INIT(keylist); 392 ARRAY_ADD(keylist, '\002'); 393 options_set_data(so, "prefix", keylist, xfree); 394 395 options_init(&global_w_options, NULL); 396 wo = &global_w_options; 397 options_set_number(wo, "aggressive-resize", 0); 398 options_set_number(wo, "alternate-screen", 1); 399 options_set_number(wo, "automatic-rename", 1); 400 options_set_number(wo, "clock-mode-colour", 4); 401 options_set_number(wo, "clock-mode-style", 1); 402 options_set_number(wo, "force-height", 0); 403 options_set_number(wo, "force-width", 0); 404 options_set_number(wo, "main-pane-height", 24); 405 options_set_number(wo, "main-pane-width", 81); 406 options_set_number(wo, "mode-attr", 0); 407 options_set_number(wo, "mode-bg", 3); 408 options_set_number(wo, "mode-fg", 0); 409 options_set_number(wo, "mode-keys", MODEKEY_EMACS); 410 options_set_number(wo, "mode-mouse", 0); 411 options_set_number(wo, "monitor-activity", 0); 412 options_set_string(wo, "monitor-content", "%s", ""); 413 options_set_number(wo, "window-status-attr", 0); 414 options_set_number(wo, "window-status-bg", 8); 415 options_set_number(wo, "window-status-current-attr", 0); 416 options_set_number(wo, "window-status-current-bg", 8); 417 options_set_number(wo, "window-status-current-fg", 8); 418 options_set_number(wo, "window-status-fg", 8); 419 options_set_string(wo, "window-status-format", "#I:#W#F"); 420 options_set_string(wo, "window-status-current-format", "#I:#W#F"); 421 options_set_string(wo, "word-separators", " -_@"); 422 options_set_number(wo, "xterm-keys", 0); 423 options_set_number(wo, "remain-on-exit", 0); 424 options_set_number(wo, "synchronize-panes", 0); 425 426 if (flags & IDENTIFY_UTF8) { 427 options_set_number(so, "status-utf8", 1); 428 options_set_number(wo, "utf8", 1); 429 } else { 430 options_set_number(so, "status-utf8", 0); 431 options_set_number(wo, "utf8", 0); 432 } 433 434 if (getcwd(cwd, sizeof cwd) == NULL) { 435 pw = getpwuid(getuid()); 436 if (pw->pw_dir != NULL && *pw->pw_dir != '\0') 437 strlcpy(cwd, pw->pw_dir, sizeof cwd); 438 else 439 strlcpy(cwd, "/", sizeof cwd); 440 } 441 options_set_string(so, "default-path", "%s", cwd); 442 443 if (cfg_file == NULL) { 444 home = getenv("HOME"); 445 if (home == NULL || *home == '\0') { 446 pw = getpwuid(getuid()); 447 if (pw != NULL) 448 home = pw->pw_dir; 449 } 450 xasprintf(&cfg_file, "%s/%s", home, DEFAULT_CFG); 451 if (access(cfg_file, R_OK) != 0 && errno == ENOENT) { 452 xfree(cfg_file); 453 cfg_file = NULL; 454 } 455 } 456 457 /* 458 * Figure out the socket path. If specified on the command-line with 459 * -S or -L, use it, otherwise try $TMUX or assume -L default. 460 */ 461 parse_env(&envdata); 462 if (path == NULL) { 463 /* No -L. Try $TMUX, or default. */ 464 if (label == NULL) { 465 path = envdata.path; 466 if (path == NULL) 467 label = xstrdup("default"); 468 } 469 470 /* -L or default set. */ 471 if (label != NULL) { 472 if ((path = makesockpath(label)) == NULL) { 473 log_warn("can't create socket"); 474 exit(1); 475 } 476 } 477 } 478 if (label != NULL) 479 xfree(label); 480 481 if (shellcmd != NULL) { 482 msg = MSG_SHELL; 483 buf = NULL; 484 len = 0; 485 } else { 486 cmddata.pid = envdata.pid; 487 cmddata.idx = envdata.idx; 488 489 /* Prepare command for server. */ 490 cmddata.argc = argc; 491 if (cmd_pack_argv( 492 argc, argv, cmddata.argv, sizeof cmddata.argv) != 0) { 493 log_warnx("command too long"); 494 exit(1); 495 } 496 497 msg = MSG_COMMAND; 498 buf = &cmddata; 499 len = sizeof cmddata; 500 } 501 502 if (shellcmd != NULL) 503 cmdflags |= CMD_STARTSERVER; 504 else if (argc == 0) /* new-session is the default */ 505 cmdflags |= CMD_STARTSERVER|CMD_SENDENVIRON|CMD_CANTNEST; 506 else { 507 /* 508 * It sucks parsing the command string twice (in client and 509 * later in server) but it is necessary to get the start server 510 * flag. 511 */ 512 if ((cmdlist = cmd_list_parse(argc, argv, &cause)) == NULL) { 513 log_warnx("%s", cause); 514 exit(1); 515 } 516 cmdflags &= ~CMD_STARTSERVER; 517 TAILQ_FOREACH(cmd, cmdlist, qentry) { 518 if (cmd->entry->flags & CMD_STARTSERVER) 519 cmdflags |= CMD_STARTSERVER; 520 if (cmd->entry->flags & CMD_SENDENVIRON) 521 cmdflags |= CMD_SENDENVIRON; 522 if (cmd->entry->flags & CMD_CANTNEST) 523 cmdflags |= CMD_CANTNEST; 524 } 525 cmd_list_free(cmdlist); 526 } 527 528 /* 529 * Check if this could be a nested session, if the command can't nest: 530 * if the socket path matches $TMUX, this is probably the same server. 531 */ 532 if (shellcmd == NULL && envdata.path != NULL && 533 cmdflags & CMD_CANTNEST && 534 (path == envdata.path || strcmp(path, envdata.path) == 0)) { 535 log_warnx("sessions should be nested with care. " 536 "unset $TMUX to force."); 537 exit(1); 538 } 539 540 /* Initialise the client socket/start the server. */ 541 if ((main_ibuf = client_init(path, cmdflags, flags)) == NULL) 542 exit(1); 543 xfree(path); 544 545 ev_base = event_init(); 546 547 set_signals(main_signal); 548 549 /* Initialise the client socket/start the server. */ 550 if ((main_ibuf = client_init(path, cmdflags, flags)) == NULL) 551 exit(1); 552 xfree(path); 553 554 imsg_compose(main_ibuf, msg, PROTOCOL_VERSION, -1, -1, buf, len); 555 556 events = EV_READ; 557 if (main_ibuf->w.queued > 0) 558 events |= EV_WRITE; 559 event_once(main_ibuf->fd, events, main_callback, shellcmd, NULL); 560 561 main_exitval = 0; 562 event_dispatch(); 563 564 clear_signals(); 565 566 client_main(); /* doesn't return */ 567 } 568 569 /* ARGSUSED */ 570 void 571 main_signal(int sig, unused short events, unused void *data) 572 { 573 switch (sig) { 574 case SIGTERM: 575 exit(1); 576 case SIGCHLD: 577 waitpid(WAIT_ANY, NULL, WNOHANG); 578 break; 579 } 580 } 581 582 /* ARGSUSED */ 583 void 584 main_callback(unused int fd, short events, void *data) 585 { 586 char *shellcmd = data; 587 588 if (events & EV_READ) 589 main_dispatch(shellcmd); 590 591 if (events & EV_WRITE) { 592 if (msgbuf_write(&main_ibuf->w) < 0) 593 fatalx("msgbuf_write failed"); 594 } 595 596 events = EV_READ; 597 if (main_ibuf->w.queued > 0) 598 events |= EV_WRITE; 599 event_once(main_ibuf->fd, events, main_callback, shellcmd, NULL); 600 } 601 602 void 603 main_dispatch(const char *shellcmd) 604 { 605 struct imsg imsg; 606 ssize_t n, datalen; 607 struct msg_print_data printdata; 608 struct msg_shell_data shelldata; 609 610 if ((n = imsg_read(main_ibuf)) == -1 || n == 0) 611 fatalx("imsg_read failed"); 612 613 for (;;) { 614 if ((n = imsg_get(main_ibuf, &imsg)) == -1) 615 fatalx("imsg_get failed"); 616 if (n == 0) 617 return; 618 datalen = imsg.hdr.len - IMSG_HEADER_SIZE; 619 620 switch (imsg.hdr.type) { 621 case MSG_EXIT: 622 case MSG_SHUTDOWN: 623 if (datalen != 0) 624 fatalx("bad MSG_EXIT size"); 625 626 exit(main_exitval); 627 case MSG_ERROR: 628 case MSG_PRINT: 629 if (datalen != sizeof printdata) 630 fatalx("bad MSG_PRINT size"); 631 memcpy(&printdata, imsg.data, sizeof printdata); 632 printdata.msg[(sizeof printdata.msg) - 1] = '\0'; 633 634 log_info("%s", printdata.msg); 635 if (imsg.hdr.type == MSG_ERROR) 636 main_exitval = 1; 637 break; 638 case MSG_READY: 639 if (datalen != 0) 640 fatalx("bad MSG_READY size"); 641 642 event_loopexit(NULL); /* move to client_main() */ 643 break; 644 case MSG_VERSION: 645 if (datalen != 0) 646 fatalx("bad MSG_VERSION size"); 647 648 log_warnx("protocol version mismatch (client %u, " 649 "server %u)", PROTOCOL_VERSION, imsg.hdr.peerid); 650 exit(1); 651 case MSG_SHELL: 652 if (datalen != sizeof shelldata) 653 fatalx("bad MSG_SHELL size"); 654 memcpy(&shelldata, imsg.data, sizeof shelldata); 655 shelldata.shell[(sizeof shelldata.shell) - 1] = '\0'; 656 657 clear_signals(); 658 659 shell_exec(shelldata.shell, shellcmd); 660 default: 661 fatalx("unexpected message"); 662 } 663 664 imsg_free(&imsg); 665 } 666 } 667