xref: /openbsd/usr.bin/tmux/server-fn.c (revision 898184e3)
1 /* $OpenBSD: server-fn.c,v 1.68 2013/03/25 11:36:59 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 
21 #include <stdlib.h>
22 #include <string.h>
23 #include <time.h>
24 #include <unistd.h>
25 
26 #include "tmux.h"
27 
28 struct session *server_next_session(struct session *);
29 void		server_callback_identify(int, short, void *);
30 
31 void
32 server_fill_environ(struct session *s, struct environ *env)
33 {
34 	char	var[MAXPATHLEN], *term;
35 	u_int	idx;
36 	long	pid;
37 
38 	if (s != NULL) {
39 		term = options_get_string(&s->options, "default-terminal");
40 		environ_set(env, "TERM", term);
41 
42 		idx = s->id;
43 	} else
44 		idx = -1;
45 	pid = getpid();
46 	xsnprintf(var, sizeof var, "%s,%ld,%d", socket_path, pid, idx);
47 	environ_set(env, "TMUX", var);
48 }
49 
50 void
51 server_write_ready(struct client *c)
52 {
53 	if (c->flags & CLIENT_CONTROL)
54 		return;
55 	server_write_client(c, MSG_READY, NULL, 0);
56 }
57 
58 int
59 server_write_client(
60     struct client *c, enum msgtype type, const void *buf, size_t len)
61 {
62 	struct imsgbuf	*ibuf = &c->ibuf;
63 	int              error;
64 
65 	if (c->flags & CLIENT_BAD)
66 		return (-1);
67 	log_debug("writing %d to client %d", type, c->ibuf.fd);
68 	error = imsg_compose(ibuf, type, PROTOCOL_VERSION, -1, -1,
69 	    (void *) buf, len);
70 	if (error == 1)
71 		server_update_event(c);
72 	return (error == 1 ? 0 : -1);
73 }
74 
75 void
76 server_write_session(
77     struct session *s, enum msgtype type, const void *buf, size_t len)
78 {
79 	struct client	*c;
80 	u_int		 i;
81 
82 	for (i = 0; i < ARRAY_LENGTH(&clients); i++) {
83 		c = ARRAY_ITEM(&clients, i);
84 		if (c == NULL || c->session == NULL)
85 			continue;
86 		if (c->session == s)
87 			server_write_client(c, type, buf, len);
88 	}
89 }
90 
91 void
92 server_redraw_client(struct client *c)
93 {
94 	c->flags |= CLIENT_REDRAW;
95 }
96 
97 void
98 server_status_client(struct client *c)
99 {
100 	c->flags |= CLIENT_STATUS;
101 }
102 
103 void
104 server_redraw_session(struct session *s)
105 {
106 	struct client	*c;
107 	u_int		 i;
108 
109 	for (i = 0; i < ARRAY_LENGTH(&clients); i++) {
110 		c = ARRAY_ITEM(&clients, i);
111 		if (c == NULL || c->session == NULL)
112 			continue;
113 		if (c->session == s)
114 			server_redraw_client(c);
115 	}
116 }
117 
118 void
119 server_redraw_session_group(struct session *s)
120 {
121 	struct session_group	*sg;
122 
123 	if ((sg = session_group_find(s)) == NULL)
124 		server_redraw_session(s);
125 	else {
126 		TAILQ_FOREACH(s, &sg->sessions, gentry)
127 			server_redraw_session(s);
128 	}
129 }
130 
131 void
132 server_status_session(struct session *s)
133 {
134 	struct client	*c;
135 	u_int		 i;
136 
137 	for (i = 0; i < ARRAY_LENGTH(&clients); i++) {
138 		c = ARRAY_ITEM(&clients, i);
139 		if (c == NULL || c->session == NULL)
140 			continue;
141 		if (c->session == s)
142 			server_status_client(c);
143 	}
144 }
145 
146 void
147 server_status_session_group(struct session *s)
148 {
149 	struct session_group	*sg;
150 
151 	if ((sg = session_group_find(s)) == NULL)
152 		server_status_session(s);
153 	else {
154 		TAILQ_FOREACH(s, &sg->sessions, gentry)
155 			server_status_session(s);
156 	}
157 }
158 
159 void
160 server_redraw_window(struct window *w)
161 {
162 	struct client	*c;
163 	u_int		 i;
164 
165 	for (i = 0; i < ARRAY_LENGTH(&clients); i++) {
166 		c = ARRAY_ITEM(&clients, i);
167 		if (c == NULL || c->session == NULL)
168 			continue;
169 		if (c->session->curw->window == w)
170 			server_redraw_client(c);
171 	}
172 	w->flags |= WINDOW_REDRAW;
173 }
174 
175 void
176 server_redraw_window_borders(struct window *w)
177 {
178 	struct client	*c;
179 	u_int		 i;
180 
181 	for (i = 0; i < ARRAY_LENGTH(&clients); i++) {
182 		c = ARRAY_ITEM(&clients, i);
183 		if (c == NULL || c->session == NULL)
184 			continue;
185 		if (c->session->curw->window == w)
186 			c->flags |= CLIENT_BORDERS;
187 	}
188 }
189 
190 void
191 server_status_window(struct window *w)
192 {
193 	struct session	*s;
194 
195 	/*
196 	 * This is slightly different. We want to redraw the status line of any
197 	 * clients containing this window rather than anywhere it is the
198 	 * current window.
199 	 */
200 
201 	RB_FOREACH(s, sessions, &sessions) {
202 		if (session_has(s, w) != NULL)
203 			server_status_session(s);
204 	}
205 }
206 
207 void
208 server_lock(void)
209 {
210 	struct client	*c;
211 	u_int		 i;
212 
213 	for (i = 0; i < ARRAY_LENGTH(&clients); i++) {
214 		c = ARRAY_ITEM(&clients, i);
215 		if (c == NULL || c->session == NULL)
216 			continue;
217 		server_lock_client(c);
218 	}
219 }
220 
221 void
222 server_lock_session(struct session *s)
223 {
224 	struct client	*c;
225 	u_int		 i;
226 
227 	for (i = 0; i < ARRAY_LENGTH(&clients); i++) {
228 		c = ARRAY_ITEM(&clients, i);
229 		if (c == NULL || c->session == NULL || c->session != s)
230 			continue;
231 		server_lock_client(c);
232 	}
233 }
234 
235 void
236 server_lock_client(struct client *c)
237 {
238 	const char		*cmd;
239 	size_t			 cmdlen;
240 	struct msg_lock_data	 lockdata;
241 
242 	if (c->flags & CLIENT_CONTROL)
243 		return;
244 
245 	if (c->flags & CLIENT_SUSPENDED)
246 		return;
247 
248 	cmd = options_get_string(&c->session->options, "lock-command");
249 	cmdlen = strlcpy(lockdata.cmd, cmd, sizeof lockdata.cmd);
250 	if (cmdlen >= sizeof lockdata.cmd)
251 		return;
252 
253 	tty_stop_tty(&c->tty);
254 	tty_raw(&c->tty, tty_term_string(c->tty.term, TTYC_SMCUP));
255 	tty_raw(&c->tty, tty_term_string(c->tty.term, TTYC_CLEAR));
256 	tty_raw(&c->tty, tty_term_string(c->tty.term, TTYC_E3));
257 
258 	c->flags |= CLIENT_SUSPENDED;
259 	server_write_client(c, MSG_LOCK, &lockdata, sizeof lockdata);
260 }
261 
262 void
263 server_kill_window(struct window *w)
264 {
265 	struct session	*s, *next_s;
266 	struct winlink	*wl;
267 
268 	next_s = RB_MIN(sessions, &sessions);
269 	while (next_s != NULL) {
270 		s = next_s;
271 		next_s = RB_NEXT(sessions, &sessions, s);
272 
273 		if (session_has(s, w) == NULL)
274 			continue;
275 		while ((wl = winlink_find_by_window(&s->windows, w)) != NULL) {
276 			if (session_detach(s, wl)) {
277 				server_destroy_session_group(s);
278 				break;
279 			} else
280 				server_redraw_session_group(s);
281 		}
282 
283 		if (options_get_number(&s->options, "renumber-windows"))
284 			session_renumber_windows(s);
285 	}
286 }
287 
288 int
289 server_link_window(struct session *src, struct winlink *srcwl,
290     struct session *dst, int dstidx, int killflag, int selectflag, char **cause)
291 {
292 	struct winlink		*dstwl;
293 	struct session_group	*srcsg, *dstsg;
294 
295 	srcsg = session_group_find(src);
296 	dstsg = session_group_find(dst);
297 	if (src != dst && srcsg != NULL && dstsg != NULL && srcsg == dstsg) {
298 		xasprintf(cause, "sessions are grouped");
299 		return (-1);
300 	}
301 
302 	dstwl = NULL;
303 	if (dstidx != -1)
304 		dstwl = winlink_find_by_index(&dst->windows, dstidx);
305 	if (dstwl != NULL) {
306 		if (dstwl->window == srcwl->window) {
307 			xasprintf(cause, "same index: %d", dstidx);
308 			return (-1);
309 		}
310 		if (killflag) {
311 			/*
312 			 * Can't use session_detach as it will destroy session
313 			 * if this makes it empty.
314 			 */
315 			notify_window_unlinked(dst, dstwl->window);
316 			dstwl->flags &= ~WINLINK_ALERTFLAGS;
317 			winlink_stack_remove(&dst->lastw, dstwl);
318 			winlink_remove(&dst->windows, dstwl);
319 
320 			/* Force select/redraw if current. */
321 			if (dstwl == dst->curw) {
322 				selectflag = 1;
323 				dst->curw = NULL;
324 			}
325 		}
326 	}
327 
328 	if (dstidx == -1)
329 		dstidx = -1 - options_get_number(&dst->options, "base-index");
330 	dstwl = session_attach(dst, srcwl->window, dstidx, cause);
331 	if (dstwl == NULL)
332 		return (-1);
333 
334 	if (selectflag)
335 		session_select(dst, dstwl->idx);
336 	server_redraw_session_group(dst);
337 
338 	return (0);
339 }
340 
341 void
342 server_unlink_window(struct session *s, struct winlink *wl)
343 {
344 	if (session_detach(s, wl))
345 		server_destroy_session_group(s);
346 	else
347 		server_redraw_session_group(s);
348 }
349 
350 void
351 server_destroy_pane(struct window_pane *wp)
352 {
353 	struct window		*w = wp->window;
354 	int			 old_fd;
355 	struct screen_write_ctx	 ctx;
356 	struct grid_cell	 gc;
357 
358 	old_fd = wp->fd;
359 	if (wp->fd != -1) {
360 		bufferevent_free(wp->event);
361 		close(wp->fd);
362 		wp->fd = -1;
363 	}
364 
365 	if (options_get_number(&w->options, "remain-on-exit")) {
366 		if (old_fd == -1)
367 			return;
368 		screen_write_start(&ctx, wp, &wp->base);
369 		screen_write_scrollregion(&ctx, 0, screen_size_y(ctx.s) - 1);
370 		screen_write_cursormove(&ctx, 0, screen_size_y(ctx.s) - 1);
371 		screen_write_linefeed(&ctx, 1);
372 		memcpy(&gc, &grid_default_cell, sizeof gc);
373 		gc.attr |= GRID_ATTR_BRIGHT;
374 		screen_write_puts(&ctx, &gc, "Pane is dead");
375 		screen_write_stop(&ctx);
376 		wp->flags |= PANE_REDRAW;
377 		return;
378 	}
379 
380 	server_unzoom_window(w);
381 	layout_close_pane(wp);
382 	window_remove_pane(w, wp);
383 
384 	if (TAILQ_EMPTY(&w->panes))
385 		server_kill_window(w);
386 	else
387 		server_redraw_window(w);
388 }
389 
390 void
391 server_destroy_session_group(struct session *s)
392 {
393 	struct session_group	*sg;
394 
395 	if ((sg = session_group_find(s)) == NULL)
396 		server_destroy_session(s);
397 	else {
398 		TAILQ_FOREACH(s, &sg->sessions, gentry)
399 			server_destroy_session(s);
400 		TAILQ_REMOVE(&session_groups, sg, entry);
401 		free(sg);
402 	}
403 }
404 
405 struct session *
406 server_next_session(struct session *s)
407 {
408 	struct session *s_loop, *s_out;
409 
410 	s_out = NULL;
411 	RB_FOREACH(s_loop, sessions, &sessions) {
412 		if (s_loop == s)
413 			continue;
414 		if (s_out == NULL ||
415 		    timercmp(&s_loop->activity_time, &s_out->activity_time, <))
416 			s_out = s_loop;
417 	}
418 	return (s_out);
419 }
420 
421 void
422 server_destroy_session(struct session *s)
423 {
424 	struct client	*c;
425 	struct session	*s_new;
426 	u_int		 i;
427 
428 	if (!options_get_number(&s->options, "detach-on-destroy"))
429 		s_new = server_next_session(s);
430 	else
431 		s_new = NULL;
432 
433 	for (i = 0; i < ARRAY_LENGTH(&clients); i++) {
434 		c = ARRAY_ITEM(&clients, i);
435 		if (c == NULL || c->session != s)
436 			continue;
437 		if (s_new == NULL) {
438 			c->session = NULL;
439 			c->flags |= CLIENT_EXIT;
440 		} else {
441 			c->last_session = NULL;
442 			c->session = s_new;
443 			notify_attached_session_changed(c);
444 			session_update_activity(s_new);
445 			server_redraw_client(c);
446 		}
447 	}
448 	recalculate_sizes();
449 }
450 
451 void
452 server_check_unattached (void)
453 {
454 	struct session	*s;
455 
456 	/*
457 	 * If any sessions are no longer attached and have destroy-unattached
458 	 * set, collect them.
459 	 */
460 	RB_FOREACH(s, sessions, &sessions) {
461 		if (!(s->flags & SESSION_UNATTACHED))
462 			continue;
463 		if (options_get_number (&s->options, "destroy-unattached"))
464 			session_destroy(s);
465 	}
466 }
467 
468 void
469 server_set_identify(struct client *c)
470 {
471 	struct timeval	tv;
472 	int		delay;
473 
474 	delay = options_get_number(&c->session->options, "display-panes-time");
475 	tv.tv_sec = delay / 1000;
476 	tv.tv_usec = (delay % 1000) * 1000L;
477 
478 	if (event_initialized (&c->identify_timer))
479 		evtimer_del(&c->identify_timer);
480 	evtimer_set(&c->identify_timer, server_callback_identify, c);
481 	evtimer_add(&c->identify_timer, &tv);
482 
483 	c->flags |= CLIENT_IDENTIFY;
484 	c->tty.flags |= (TTY_FREEZE|TTY_NOCURSOR);
485 	server_redraw_client(c);
486 }
487 
488 void
489 server_clear_identify(struct client *c)
490 {
491 	if (c->flags & CLIENT_IDENTIFY) {
492 		c->flags &= ~CLIENT_IDENTIFY;
493 		c->tty.flags &= ~(TTY_FREEZE|TTY_NOCURSOR);
494 		server_redraw_client(c);
495 	}
496 }
497 
498 void
499 server_callback_identify(unused int fd, unused short events, void *data)
500 {
501 	struct client	*c = data;
502 
503 	server_clear_identify(c);
504 }
505 
506 void
507 server_update_event(struct client *c)
508 {
509 	short	events;
510 
511 	events = 0;
512 	if (!(c->flags & CLIENT_BAD))
513 		events |= EV_READ;
514 	if (c->ibuf.w.queued > 0)
515 		events |= EV_WRITE;
516 	if (event_initialized(&c->event))
517 		event_del(&c->event);
518 	event_set(&c->event, c->ibuf.fd, events, server_client_callback, c);
519 	event_add(&c->event, NULL);
520 }
521 
522 /* Push stdout to client if possible. */
523 void
524 server_push_stdout(struct client *c)
525 {
526 	struct msg_stdout_data data;
527 	size_t                 size;
528 
529 	size = EVBUFFER_LENGTH(c->stdout_data);
530 	if (size == 0)
531 		return;
532 	if (size > sizeof data.data)
533 		size = sizeof data.data;
534 
535 	memcpy(data.data, EVBUFFER_DATA(c->stdout_data), size);
536 	data.size = size;
537 
538 	if (server_write_client(c, MSG_STDOUT, &data, sizeof data) == 0)
539 		evbuffer_drain(c->stdout_data, size);
540 }
541 
542 /* Push stderr to client if possible. */
543 void
544 server_push_stderr(struct client *c)
545 {
546 	struct msg_stderr_data data;
547 	size_t                 size;
548 
549 	if (c->stderr_data == c->stdout_data) {
550 		server_push_stdout(c);
551 		return;
552 	}
553 	size = EVBUFFER_LENGTH(c->stderr_data);
554 	if (size == 0)
555 		return;
556 	if (size > sizeof data.data)
557 		size = sizeof data.data;
558 
559 	memcpy(data.data, EVBUFFER_DATA(c->stderr_data), size);
560 	data.size = size;
561 
562 	if (server_write_client(c, MSG_STDERR, &data, sizeof data) == 0)
563 		evbuffer_drain(c->stderr_data, size);
564 }
565 
566 /* Set stdin callback. */
567 int
568 server_set_stdin_callback(struct client *c, void (*cb)(struct client *, int,
569     void *), void *cb_data, char **cause)
570 {
571 	if (c == NULL || c->session != NULL) {
572 		*cause = xstrdup("no client with stdin");
573 		return (-1);
574 	}
575 	if (c->flags & CLIENT_TERMINAL) {
576 		*cause = xstrdup("stdin is a tty");
577 		return (-1);
578 	}
579 	if (c->stdin_callback != NULL) {
580 		*cause = xstrdup("stdin in use");
581 		return (-1);
582 	}
583 
584 	c->stdin_callback_data = cb_data;
585 	c->stdin_callback = cb;
586 
587 	c->references++;
588 
589 	if (c->stdin_closed)
590 		c->stdin_callback (c, 1, c->stdin_callback_data);
591 
592 	server_write_client(c, MSG_STDIN, NULL, 0);
593 
594 	return (0);
595 }
596 
597 void
598 server_unzoom_window(struct window *w)
599 {
600 	window_unzoom(w);
601 	server_redraw_window(w);
602 	server_status_window(w);
603 }
604