xref: /openbsd-src/usr.bin/tmux/tmux.c (revision eca05f1fc0ec6fc9c207193ddcba9f00995f6fdc)
1 /* $OpenBSD: tmux.c,v 1.98 2010/12/30 23:16:18 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 
22 #include <errno.h>
23 #include <event.h>
24 #include <fcntl.h>
25 #include <paths.h>
26 #include <pwd.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <unistd.h>
30 
31 #include "tmux.h"
32 
33 #ifdef DEBUG
34 extern char	*malloc_options;
35 #endif
36 
37 struct options	 global_options;	/* server options */
38 struct options	 global_s_options;	/* session options */
39 struct options	 global_w_options;	/* window options */
40 struct environ	 global_environ;
41 
42 struct event_base *ev_base;
43 
44 char		*cfg_file;
45 char		*shell_cmd;
46 int		 debug_level;
47 time_t		 start_time;
48 char		 socket_path[MAXPATHLEN];
49 int		 login_shell;
50 char		*environ_path;
51 pid_t		 environ_pid;
52 u_int		 environ_idx;
53 
54 __dead void	 usage(void);
55 void	 	 parseenvironment(void);
56 char 		*makesocketpath(const char *);
57 
58 __dead void
59 usage(void)
60 {
61 	fprintf(stderr,
62 	    "usage: %s [-28lquv] [-c shell-command] [-f file] [-L socket-name]\n"
63 	    "            [-S socket-path] [command [flags]]\n",
64 	    __progname);
65 	exit(1);
66 }
67 
68 void
69 logfile(const char *name)
70 {
71 	char	*path;
72 
73 	log_close();
74 	if (debug_level > 0) {
75 		xasprintf(&path, "tmux-%s-%ld.log", name, (long) getpid());
76 		log_open_file(debug_level, path);
77 		xfree(path);
78 	}
79 }
80 
81 const char *
82 getshell(void)
83 {
84 	struct passwd	*pw;
85 	const char	*shell;
86 
87 	shell = getenv("SHELL");
88 	if (checkshell(shell))
89 		return (shell);
90 
91 	pw = getpwuid(getuid());
92 	if (pw != NULL && checkshell(pw->pw_shell))
93 		return (pw->pw_shell);
94 
95 	return (_PATH_BSHELL);
96 }
97 
98 int
99 checkshell(const char *shell)
100 {
101 	if (shell == NULL || *shell == '\0' || areshell(shell))
102 		return (0);
103 	if (access(shell, X_OK) != 0)
104 		return (0);
105 	return (1);
106 }
107 
108 int
109 areshell(const char *shell)
110 {
111 	const char	*progname, *ptr;
112 
113 	if ((ptr = strrchr(shell, '/')) != NULL)
114 		ptr++;
115 	else
116 		ptr = shell;
117 	progname = __progname;
118 	if (*progname == '-')
119 		progname++;
120 	if (strcmp(ptr, progname) == 0)
121 		return (1);
122 	return (0);
123 }
124 
125 void
126 parseenvironment(void)
127 {
128 	char		*env, *path_pid, *pid_idx, buf[256];
129 	size_t		 len;
130 	const char	*errstr;
131 	long long	 ll;
132 
133 	environ_pid = -1;
134 	if ((env = getenv("TMUX")) == NULL)
135 		return;
136 
137 	if ((path_pid = strchr(env, ',')) == NULL || path_pid == env)
138 		return;
139 	if ((pid_idx = strchr(path_pid + 1, ',')) == NULL)
140 		return;
141 	if ((pid_idx == path_pid + 1 || pid_idx[1] == '\0'))
142 		return;
143 
144 	/* path */
145 	len = path_pid - env;
146 	environ_path = xmalloc(len + 1);
147 	memcpy(environ_path, env, len);
148 	environ_path[len] = '\0';
149 
150 	/* pid */
151 	len = pid_idx - path_pid - 1;
152 	if (len > (sizeof buf) - 1)
153 		return;
154 	memcpy(buf, path_pid + 1, len);
155 	buf[len] = '\0';
156 
157 	ll = strtonum(buf, 0, LONG_MAX, &errstr);
158 	if (errstr != NULL)
159 		return;
160 	environ_pid = ll;
161 
162 	/* idx */
163 	ll = strtonum(pid_idx + 1, 0, UINT_MAX, &errstr);
164 	if (errstr != NULL)
165 		return;
166 	environ_idx = ll;
167 }
168 
169 char *
170 makesocketpath(const char *label)
171 {
172 	char		base[MAXPATHLEN], *path;
173 	struct stat	sb;
174 	u_int		uid;
175 
176 	uid = getuid();
177 	xsnprintf(base, MAXPATHLEN, "%s/tmux-%d", _PATH_TMP, uid);
178 
179 	if (mkdir(base, S_IRWXU) != 0 && errno != EEXIST)
180 		return (NULL);
181 
182 	if (lstat(base, &sb) != 0)
183 		return (NULL);
184 	if (!S_ISDIR(sb.st_mode)) {
185 		errno = ENOTDIR;
186 		return (NULL);
187 	}
188 	if (sb.st_uid != uid || (sb.st_mode & (S_IRWXG|S_IRWXO)) != 0) {
189 		errno = EACCES;
190 		return (NULL);
191 	}
192 
193 	xasprintf(&path, "%s/%s", base, label);
194 	return (path);
195 }
196 
197 __dead void
198 shell_exec(const char *shell, const char *shellcmd)
199 {
200 	const char	*shellname, *ptr;
201 	char		*argv0;
202 	int		 mode;
203 
204 	ptr = strrchr(shell, '/');
205 	if (ptr != NULL && *(ptr + 1) != '\0')
206 		shellname = ptr + 1;
207 	else
208 		shellname = shell;
209 	if (login_shell)
210 		xasprintf(&argv0, "-%s", shellname);
211 	else
212 		xasprintf(&argv0, "%s", shellname);
213 	setenv("SHELL", shell, 1);
214 
215 	if ((mode = fcntl(STDIN_FILENO, F_GETFL)) != -1)
216 		fcntl(STDIN_FILENO, F_SETFL, mode & ~O_NONBLOCK);
217 	if ((mode = fcntl(STDOUT_FILENO, F_GETFL)) != -1)
218 		fcntl(STDOUT_FILENO, F_SETFL, mode & ~O_NONBLOCK);
219 	if ((mode = fcntl(STDERR_FILENO, F_GETFL)) != -1)
220 		fcntl(STDERR_FILENO, F_SETFL, mode & ~O_NONBLOCK);
221 	closefrom(STDERR_FILENO + 1);
222 
223 	execl(shell, argv0, "-c", shellcmd, (char *) NULL);
224 	fatal("execl failed");
225 }
226 
227 int
228 main(int argc, char **argv)
229 {
230 	struct passwd	*pw;
231 	struct options	*oo, *so, *wo;
232 	struct keylist	*keylist;
233 	char		*s, *path, *label, *home, **var;
234 	int	 	 opt, flags, quiet, keys;
235 
236 #ifdef DEBUG
237 	malloc_options = (char *) "AFGJPX";
238 #endif
239 
240 	quiet = flags = 0;
241 	label = path = NULL;
242 	login_shell = (**argv == '-');
243 	while ((opt = getopt(argc, argv, "28c:df:lL:qS:uUv")) != -1) {
244 		switch (opt) {
245 		case '2':
246 			flags |= IDENTIFY_256COLOURS;
247 			flags &= ~IDENTIFY_88COLOURS;
248 			break;
249 		case '8':
250 			flags |= IDENTIFY_88COLOURS;
251 			flags &= ~IDENTIFY_256COLOURS;
252 			break;
253 		case 'c':
254 			if (shell_cmd != NULL)
255 				xfree(shell_cmd);
256 			shell_cmd = xstrdup(optarg);
257 			break;
258 		case 'f':
259 			if (cfg_file != NULL)
260 				xfree(cfg_file);
261 			cfg_file = xstrdup(optarg);
262 			break;
263 		case 'l':
264 			login_shell = 1;
265 			break;
266 		case 'L':
267 			if (label != NULL)
268 				xfree(label);
269 			label = xstrdup(optarg);
270 			break;
271 		case 'q':
272 			quiet = 1;
273 			break;
274 		case 'S':
275 			if (path != NULL)
276 				xfree(path);
277 			path = xstrdup(optarg);
278 			break;
279 		case 'u':
280 			flags |= IDENTIFY_UTF8;
281 			break;
282 		case 'v':
283 			debug_level++;
284 			break;
285 		default:
286 			usage();
287 		}
288 	}
289 	argc -= optind;
290 	argv += optind;
291 
292 	if (shell_cmd != NULL && argc != 0)
293 		usage();
294 
295 	log_open_tty(debug_level);
296 
297 	if (!(flags & IDENTIFY_UTF8)) {
298 		/*
299 		 * If the user has set whichever of LC_ALL, LC_CTYPE or LANG
300 		 * exist (in that order) to contain UTF-8, it is a safe
301 		 * assumption that either they are using a UTF-8 terminal, or
302 		 * if not they know that output from UTF-8-capable programs may
303 		 * be wrong.
304 		 */
305 		if ((s = getenv("LC_ALL")) == NULL) {
306 			if ((s = getenv("LC_CTYPE")) == NULL)
307 				s = getenv("LANG");
308 		}
309 		if (s != NULL && (strcasestr(s, "UTF-8") != NULL ||
310 		    strcasestr(s, "UTF8") != NULL))
311 			flags |= IDENTIFY_UTF8;
312 	}
313 
314 	environ_init(&global_environ);
315 	for (var = environ; *var != NULL; var++)
316 		environ_put(&global_environ, *var);
317 
318 	options_init(&global_options, NULL);
319 	oo = &global_options;
320 	options_set_number(oo, "quiet", quiet);
321 	options_set_number(oo, "escape-time", 500);
322 	options_set_number(oo, "exit-unattached", 0);
323 	options_set_number(oo, "buffer-limit", 9);
324 
325 	options_init(&global_s_options, NULL);
326 	so = &global_s_options;
327 	options_set_number(so, "base-index", 0);
328 	options_set_number(so, "bell-action", BELL_ANY);
329 	options_set_string(so, "default-command", "%s", "");
330 	options_set_string(so, "default-path", "%s", "");
331 	options_set_string(so, "default-shell", "%s", getshell());
332 	options_set_string(so, "default-terminal", "screen");
333 	options_set_number(so, "destroy-unattached", 0);
334 	options_set_number(so, "detach-on-destroy", 1);
335 	options_set_number(so, "display-panes-active-colour", 1);
336 	options_set_number(so, "display-panes-colour", 4);
337 	options_set_number(so, "display-panes-time", 1000);
338 	options_set_number(so, "display-time", 750);
339 	options_set_number(so, "history-limit", 2000);
340 	options_set_number(so, "lock-after-time", 0);
341 	options_set_string(so, "lock-command", "lock -np");
342 	options_set_number(so, "lock-server", 1);
343 	options_set_number(so, "message-attr", 0);
344 	options_set_number(so, "message-bg", 3);
345 	options_set_number(so, "message-fg", 0);
346 	options_set_number(so, "message-limit", 20);
347 	options_set_number(so, "mouse-select-pane", 0);
348 	options_set_number(so, "pane-active-border-bg", 8);
349 	options_set_number(so, "pane-active-border-fg", 2);
350 	options_set_number(so, "pane-border-bg", 8);
351 	options_set_number(so, "pane-border-fg", 8);
352 	options_set_number(so, "repeat-time", 500);
353 	options_set_number(so, "set-remain-on-exit", 0);
354 	options_set_number(so, "set-titles", 0);
355 	options_set_string(so, "set-titles-string", "#S:#I:#W - \"#T\"");
356 	options_set_number(so, "status", 1);
357 	options_set_number(so, "status-attr", 0);
358 	options_set_number(so, "status-bg", 2);
359 	options_set_number(so, "status-fg", 0);
360 	options_set_number(so, "status-interval", 15);
361 	options_set_number(so, "status-justify", 0);
362 	options_set_string(so, "status-left", "[#S]");
363 	options_set_number(so, "status-left-attr", 0);
364 	options_set_number(so, "status-left-bg", 8);
365 	options_set_number(so, "status-left-fg", 8);
366 	options_set_number(so, "status-left-length", 10);
367 	options_set_string(so, "status-right", "\"#22T\" %%H:%%M %%d-%%b-%%y");
368 	options_set_number(so, "status-right-attr", 0);
369 	options_set_number(so, "status-right-bg", 8);
370 	options_set_number(so, "status-right-fg", 8);
371 	options_set_number(so, "status-right-length", 40);
372 	options_set_string(so, "terminal-overrides",
373 	    "*88col*:colors=88,*256col*:colors=256");
374 	options_set_string(so, "update-environment",
375 	    "DISPLAY "
376 	    "SSH_ASKPASS SSH_AUTH_SOCK SSH_AGENT_PID SSH_CONNECTION "
377 	    "WINDOWID "
378 	    "XAUTHORITY");
379 	options_set_number(so, "visual-activity", 0);
380 	options_set_number(so, "visual-bell", 0);
381 	options_set_number(so, "visual-content", 0);
382 	options_set_number(so, "visual-silence", 0);
383 
384 	keylist = xmalloc(sizeof *keylist);
385 	ARRAY_INIT(keylist);
386 	ARRAY_ADD(keylist, '\002');
387 	options_set_data(so, "prefix", keylist, xfree);
388 
389 	options_init(&global_w_options, NULL);
390 	wo = &global_w_options;
391 	options_set_number(wo, "aggressive-resize", 0);
392 	options_set_number(wo, "alternate-screen", 1);
393 	options_set_number(wo, "automatic-rename", 1);
394 	options_set_number(wo, "clock-mode-colour", 4);
395 	options_set_number(wo, "clock-mode-style", 1);
396 	options_set_number(wo, "force-height", 0);
397 	options_set_number(wo, "force-width", 0);
398 	options_set_number(wo, "main-pane-height", 24);
399 	options_set_number(wo, "main-pane-width", 80);
400 	options_set_number(wo, "mode-attr", 0);
401 	options_set_number(wo, "mode-bg", 3);
402 	options_set_number(wo, "mode-fg", 0);
403 	options_set_number(wo, "mode-mouse", 0);
404 	options_set_number(wo, "monitor-activity", 0);
405 	options_set_string(wo, "monitor-content", "%s", "");
406 	options_set_number(wo, "monitor-silence", 0);
407 	options_set_number(wo, "other-pane-height", 0);
408 	options_set_number(wo, "other-pane-width", 0);
409 	options_set_number(wo, "window-status-attr", 0);
410 	options_set_number(wo, "window-status-bg", 8);
411 	options_set_number(wo, "window-status-current-attr", 0);
412 	options_set_number(wo, "window-status-current-bg", 8);
413 	options_set_number(wo, "window-status-current-fg", 8);
414 	options_set_number(wo, "window-status-fg", 8);
415 	options_set_number(wo, "window-status-alert-attr", GRID_ATTR_REVERSE);
416 	options_set_number(wo, "window-status-alert-bg", 8);
417 	options_set_number(wo, "window-status-alert-fg", 8);
418 	options_set_string(wo, "window-status-format", "#I:#W#F");
419 	options_set_string(wo, "window-status-current-format", "#I:#W#F");
420 	options_set_string(wo, "word-separators", " -_@");
421 	options_set_number(wo, "xterm-keys", 0);
422 	options_set_number(wo, "remain-on-exit", 0);
423 	options_set_number(wo, "synchronize-panes", 0);
424 
425 	if (flags & IDENTIFY_UTF8) {
426 		options_set_number(so, "status-utf8", 1);
427 		options_set_number(wo, "utf8", 1);
428 	} else {
429 		options_set_number(so, "status-utf8", 0);
430 		options_set_number(wo, "utf8", 0);
431 	}
432 
433 	keys = MODEKEY_EMACS;
434 	if ((s = getenv("VISUAL")) != NULL || (s = getenv("EDITOR")) != NULL) {
435 		if (strrchr(s, '/') != NULL)
436 			s = strrchr(s, '/') + 1;
437 		if (strstr(s, "vi") != NULL)
438 			keys = MODEKEY_VI;
439 	}
440 	options_set_number(so, "status-keys", keys);
441 	options_set_number(wo, "mode-keys", keys);
442 
443 	/* Locate the configuration file. */
444 	if (cfg_file == NULL) {
445 		home = getenv("HOME");
446 		if (home == NULL || *home == '\0') {
447 			pw = getpwuid(getuid());
448 			if (pw != NULL)
449 				home = pw->pw_dir;
450 		}
451 		xasprintf(&cfg_file, "%s/%s", home, DEFAULT_CFG);
452 		if (access(cfg_file, R_OK) != 0 && errno == ENOENT) {
453 			xfree(cfg_file);
454 			cfg_file = NULL;
455 		}
456 	}
457 
458 	/*
459 	 * Figure out the socket path. If specified on the command-line with -S
460 	 * or -L, use it, otherwise try $TMUX or assume -L default.
461 	 */
462 	parseenvironment();
463 	if (path == NULL) {
464 		/* If no -L, use the environment. */
465 		if (label == NULL) {
466 			if (environ_path != NULL)
467 				path = xstrdup(environ_path);
468 			else
469 				label = xstrdup("default");
470 		}
471 
472 		/* -L or default set. */
473 		if (label != NULL) {
474 			if ((path = makesocketpath(label)) == NULL) {
475 				log_warn("can't create socket");
476 				exit(1);
477 			}
478 		}
479 	}
480 	if (label != NULL)
481 		xfree(label);
482 	if (realpath(path, socket_path) == NULL)
483 		strlcpy(socket_path, path, sizeof socket_path);
484 	xfree(path);
485 
486 	/* Set process title. */
487 	setproctitle("%s (%s)", __progname, socket_path);
488 
489 	/* Pass control to the client. */
490 	ev_base = event_init();
491 	exit(client_main(argc, argv, flags));
492 }
493