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