Handle NULL client (in config file) when showing a status message; also
[tmux-openbsd.git] / session.c
blob1d3b8d0eb93d23893757104808651391d1c5bb6a
1 /* $OpenBSD$ */
3 /*
4 * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
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.
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.
19 #include <sys/types.h>
20 #include <sys/time.h>
22 #include <paths.h>
23 #include <string.h>
24 #include <stdlib.h>
25 #include <unistd.h>
26 #include <vis.h>
27 #include <time.h>
29 #include "tmux.h"
31 struct sessions sessions;
32 u_int next_session_id;
33 struct session_groups session_groups = RB_INITIALIZER(&session_groups);
35 static void session_free(int, short, void *);
37 static void session_lock_timer(int, short, void *);
39 static struct winlink *session_next_alert(struct winlink *);
40 static struct winlink *session_previous_alert(struct winlink *);
42 static void session_group_remove(struct session *);
43 static void session_group_synchronize1(struct session *, struct session *);
45 int
46 session_cmp(struct session *s1, struct session *s2)
48 return (strcmp(s1->name, s2->name));
50 RB_GENERATE(sessions, session, entry, session_cmp);
52 static int
53 session_group_cmp(struct session_group *s1, struct session_group *s2)
55 return (strcmp(s1->name, s2->name));
57 RB_GENERATE_STATIC(session_groups, session_group, entry, session_group_cmp);
60 * Find if session is still alive. This is true if it is still on the global
61 * sessions list.
63 int
64 session_alive(struct session *s)
66 struct session *s_loop;
68 RB_FOREACH(s_loop, sessions, &sessions) {
69 if (s_loop == s)
70 return (1);
72 return (0);
75 /* Find session by name. */
76 struct session *
77 session_find(const char *name)
79 struct session s;
81 s.name = (char *) name;
82 return (RB_FIND(sessions, &sessions, &s));
85 /* Find session by id parsed from a string. */
86 struct session *
87 session_find_by_id_str(const char *s)
89 const char *errstr;
90 u_int id;
92 if (*s != '$')
93 return (NULL);
95 id = strtonum(s + 1, 0, UINT_MAX, &errstr);
96 if (errstr != NULL)
97 return (NULL);
98 return (session_find_by_id(id));
101 /* Find session by id. */
102 struct session *
103 session_find_by_id(u_int id)
105 struct session *s;
107 RB_FOREACH(s, sessions, &sessions) {
108 if (s->id == id)
109 return (s);
111 return (NULL);
114 /* Create a new session. */
115 struct session *
116 session_create(const char *prefix, const char *name, const char *cwd,
117 struct environ *env, struct options *oo, struct termios *tio)
119 struct session *s;
121 s = xcalloc(1, sizeof *s);
122 s->references = 1;
123 s->flags = 0;
125 s->cwd = xstrdup(cwd);
127 TAILQ_INIT(&s->lastw);
128 RB_INIT(&s->windows);
130 s->environ = env;
131 s->options = oo;
133 status_update_cache(s);
135 s->tio = NULL;
136 if (tio != NULL) {
137 s->tio = xmalloc(sizeof *s->tio);
138 memcpy(s->tio, tio, sizeof *s->tio);
141 if (name != NULL) {
142 s->name = xstrdup(name);
143 s->id = next_session_id++;
144 } else {
145 do {
146 s->id = next_session_id++;
147 free(s->name);
148 if (prefix != NULL)
149 xasprintf(&s->name, "%s-%u", prefix, s->id);
150 else
151 xasprintf(&s->name, "%u", s->id);
152 } while (RB_FIND(sessions, &sessions, s) != NULL);
154 RB_INSERT(sessions, &sessions, s);
156 log_debug("new session %s $%u", s->name, s->id);
158 if (gettimeofday(&s->creation_time, NULL) != 0)
159 fatal("gettimeofday failed");
160 session_update_activity(s, &s->creation_time);
162 return (s);
165 /* Add a reference to a session. */
166 void
167 session_add_ref(struct session *s, const char *from)
169 s->references++;
170 log_debug("%s: %s %s, now %d", __func__, s->name, from, s->references);
173 /* Remove a reference from a session. */
174 void
175 session_remove_ref(struct session *s, const char *from)
177 s->references--;
178 log_debug("%s: %s %s, now %d", __func__, s->name, from, s->references);
180 if (s->references == 0)
181 event_once(-1, EV_TIMEOUT, session_free, s, NULL);
184 /* Free session. */
185 static void
186 session_free(__unused int fd, __unused short events, void *arg)
188 struct session *s = arg;
190 log_debug("session %s freed (%d references)", s->name, s->references);
192 if (s->references == 0) {
193 environ_free(s->environ);
194 options_free(s->options);
196 free(s->name);
197 free(s);
201 /* Destroy a session. */
202 void
203 session_destroy(struct session *s, int notify, const char *from)
205 struct winlink *wl;
207 log_debug("session %s destroyed (%s)", s->name, from);
209 if (s->curw == NULL)
210 return;
211 s->curw = NULL;
213 RB_REMOVE(sessions, &sessions, s);
214 if (notify)
215 notify_session("session-closed", s);
217 free(s->tio);
219 if (event_initialized(&s->lock_timer))
220 event_del(&s->lock_timer);
222 session_group_remove(s);
224 while (!TAILQ_EMPTY(&s->lastw))
225 winlink_stack_remove(&s->lastw, TAILQ_FIRST(&s->lastw));
226 while (!RB_EMPTY(&s->windows)) {
227 wl = RB_ROOT(&s->windows);
228 notify_session_window("window-unlinked", s, wl->window);
229 winlink_remove(&s->windows, wl);
232 free((void *)s->cwd);
234 session_remove_ref(s, __func__);
237 /* Sanitize session name. */
238 char *
239 session_check_name(const char *name)
241 char *copy, *cp, *new_name;
243 if (*name == '\0')
244 return (NULL);
245 copy = xstrdup(name);
246 for (cp = copy; *cp != '\0'; cp++) {
247 if (*cp == ':' || *cp == '.')
248 *cp = '_';
250 utf8_stravis(&new_name, copy, VIS_OCTAL|VIS_CSTYLE|VIS_TAB|VIS_NL);
251 free(copy);
252 return (new_name);
255 /* Lock session if it has timed out. */
256 static void
257 session_lock_timer(__unused int fd, __unused short events, void *arg)
259 struct session *s = arg;
261 if (s->attached == 0)
262 return;
264 log_debug("session %s locked, activity time %lld", s->name,
265 (long long)s->activity_time.tv_sec);
267 server_lock_session(s);
268 recalculate_sizes();
271 /* Update activity time. */
272 void
273 session_update_activity(struct session *s, struct timeval *from)
275 struct timeval *last = &s->last_activity_time;
276 struct timeval tv;
278 memcpy(last, &s->activity_time, sizeof *last);
279 if (from == NULL)
280 gettimeofday(&s->activity_time, NULL);
281 else
282 memcpy(&s->activity_time, from, sizeof s->activity_time);
284 log_debug("session $%u %s activity %lld.%06d (last %lld.%06d)", s->id,
285 s->name, (long long)s->activity_time.tv_sec,
286 (int)s->activity_time.tv_usec, (long long)last->tv_sec,
287 (int)last->tv_usec);
289 if (evtimer_initialized(&s->lock_timer))
290 evtimer_del(&s->lock_timer);
291 else
292 evtimer_set(&s->lock_timer, session_lock_timer, s);
294 if (s->attached != 0) {
295 timerclear(&tv);
296 tv.tv_sec = options_get_number(s->options, "lock-after-time");
297 if (tv.tv_sec != 0)
298 evtimer_add(&s->lock_timer, &tv);
302 /* Find the next usable session. */
303 struct session *
304 session_next_session(struct session *s)
306 struct session *s2;
308 if (RB_EMPTY(&sessions) || !session_alive(s))
309 return (NULL);
311 s2 = RB_NEXT(sessions, &sessions, s);
312 if (s2 == NULL)
313 s2 = RB_MIN(sessions, &sessions);
314 if (s2 == s)
315 return (NULL);
316 return (s2);
319 /* Find the previous usable session. */
320 struct session *
321 session_previous_session(struct session *s)
323 struct session *s2;
325 if (RB_EMPTY(&sessions) || !session_alive(s))
326 return (NULL);
328 s2 = RB_PREV(sessions, &sessions, s);
329 if (s2 == NULL)
330 s2 = RB_MAX(sessions, &sessions);
331 if (s2 == s)
332 return (NULL);
333 return (s2);
336 /* Attach a window to a session. */
337 struct winlink *
338 session_attach(struct session *s, struct window *w, int idx, char **cause)
340 struct winlink *wl;
342 if ((wl = winlink_add(&s->windows, idx)) == NULL) {
343 xasprintf(cause, "index in use: %d", idx);
344 return (NULL);
346 wl->session = s;
347 winlink_set_window(wl, w);
348 notify_session_window("window-linked", s, w);
350 session_group_synchronize_from(s);
351 return (wl);
354 /* Detach a window from a session. */
356 session_detach(struct session *s, struct winlink *wl)
358 if (s->curw == wl &&
359 session_last(s) != 0 &&
360 session_previous(s, 0) != 0)
361 session_next(s, 0);
363 wl->flags &= ~WINLINK_ALERTFLAGS;
364 notify_session_window("window-unlinked", s, wl->window);
365 winlink_stack_remove(&s->lastw, wl);
366 winlink_remove(&s->windows, wl);
368 session_group_synchronize_from(s);
370 if (RB_EMPTY(&s->windows))
371 return (1);
372 return (0);
375 /* Return if session has window. */
377 session_has(struct session *s, struct window *w)
379 struct winlink *wl;
381 TAILQ_FOREACH(wl, &w->winlinks, wentry) {
382 if (wl->session == s)
383 return (1);
385 return (0);
389 * Return 1 if a window is linked outside this session (not including session
390 * groups). The window must be in this session!
393 session_is_linked(struct session *s, struct window *w)
395 struct session_group *sg;
397 if ((sg = session_group_contains(s)) != NULL)
398 return (w->references != session_group_count(sg));
399 return (w->references != 1);
402 static struct winlink *
403 session_next_alert(struct winlink *wl)
405 while (wl != NULL) {
406 if (wl->flags & WINLINK_ALERTFLAGS)
407 break;
408 wl = winlink_next(wl);
410 return (wl);
413 /* Move session to next window. */
415 session_next(struct session *s, int alert)
417 struct winlink *wl;
419 if (s->curw == NULL)
420 return (-1);
422 wl = winlink_next(s->curw);
423 if (alert)
424 wl = session_next_alert(wl);
425 if (wl == NULL) {
426 wl = RB_MIN(winlinks, &s->windows);
427 if (alert && ((wl = session_next_alert(wl)) == NULL))
428 return (-1);
430 return (session_set_current(s, wl));
433 static struct winlink *
434 session_previous_alert(struct winlink *wl)
436 while (wl != NULL) {
437 if (wl->flags & WINLINK_ALERTFLAGS)
438 break;
439 wl = winlink_previous(wl);
441 return (wl);
444 /* Move session to previous window. */
446 session_previous(struct session *s, int alert)
448 struct winlink *wl;
450 if (s->curw == NULL)
451 return (-1);
453 wl = winlink_previous(s->curw);
454 if (alert)
455 wl = session_previous_alert(wl);
456 if (wl == NULL) {
457 wl = RB_MAX(winlinks, &s->windows);
458 if (alert && (wl = session_previous_alert(wl)) == NULL)
459 return (-1);
461 return (session_set_current(s, wl));
464 /* Move session to specific window. */
466 session_select(struct session *s, int idx)
468 struct winlink *wl;
470 wl = winlink_find_by_index(&s->windows, idx);
471 return (session_set_current(s, wl));
474 /* Move session to last used window. */
476 session_last(struct session *s)
478 struct winlink *wl;
480 wl = TAILQ_FIRST(&s->lastw);
481 if (wl == NULL)
482 return (-1);
483 if (wl == s->curw)
484 return (1);
486 return (session_set_current(s, wl));
489 /* Set current winlink to wl .*/
491 session_set_current(struct session *s, struct winlink *wl)
493 struct winlink *old = s->curw;
495 if (wl == NULL)
496 return (-1);
497 if (wl == s->curw)
498 return (1);
500 winlink_stack_remove(&s->lastw, wl);
501 winlink_stack_push(&s->lastw, s->curw);
502 s->curw = wl;
503 if (options_get_number(global_options, "focus-events")) {
504 if (old != NULL)
505 window_update_focus(old->window);
506 window_update_focus(wl->window);
508 winlink_clear_flags(wl);
509 window_update_activity(wl->window);
510 tty_update_window_offset(wl->window);
511 notify_session("session-window-changed", s);
512 return (0);
515 /* Find the session group containing a session. */
516 struct session_group *
517 session_group_contains(struct session *target)
519 struct session_group *sg;
520 struct session *s;
522 RB_FOREACH(sg, session_groups, &session_groups) {
523 TAILQ_FOREACH(s, &sg->sessions, gentry) {
524 if (s == target)
525 return (sg);
528 return (NULL);
531 /* Find session group by name. */
532 struct session_group *
533 session_group_find(const char *name)
535 struct session_group sg;
537 sg.name = name;
538 return (RB_FIND(session_groups, &session_groups, &sg));
541 /* Create a new session group. */
542 struct session_group *
543 session_group_new(const char *name)
545 struct session_group *sg;
547 if ((sg = session_group_find(name)) != NULL)
548 return (sg);
550 sg = xcalloc(1, sizeof *sg);
551 sg->name = xstrdup(name);
552 TAILQ_INIT(&sg->sessions);
554 RB_INSERT(session_groups, &session_groups, sg);
555 return (sg);
558 /* Add a session to a session group. */
559 void
560 session_group_add(struct session_group *sg, struct session *s)
562 if (session_group_contains(s) == NULL)
563 TAILQ_INSERT_TAIL(&sg->sessions, s, gentry);
566 /* Remove a session from its group and destroy the group if empty. */
567 static void
568 session_group_remove(struct session *s)
570 struct session_group *sg;
572 if ((sg = session_group_contains(s)) == NULL)
573 return;
574 TAILQ_REMOVE(&sg->sessions, s, gentry);
575 if (TAILQ_EMPTY(&sg->sessions)) {
576 RB_REMOVE(session_groups, &session_groups, sg);
577 free((void *)sg->name);
578 free(sg);
582 /* Count number of sessions in session group. */
583 u_int
584 session_group_count(struct session_group *sg)
586 struct session *s;
587 u_int n;
589 n = 0;
590 TAILQ_FOREACH(s, &sg->sessions, gentry)
591 n++;
592 return (n);
595 /* Count number of clients attached to sessions in session group. */
596 u_int
597 session_group_attached_count(struct session_group *sg)
599 struct session *s;
600 u_int n;
602 n = 0;
603 TAILQ_FOREACH(s, &sg->sessions, gentry)
604 n += s->attached;
605 return (n);
608 /* Synchronize a session to its session group. */
609 void
610 session_group_synchronize_to(struct session *s)
612 struct session_group *sg;
613 struct session *target;
615 if ((sg = session_group_contains(s)) == NULL)
616 return;
618 target = NULL;
619 TAILQ_FOREACH(target, &sg->sessions, gentry) {
620 if (target != s)
621 break;
623 if (target != NULL)
624 session_group_synchronize1(target, s);
627 /* Synchronize a session group to a session. */
628 void
629 session_group_synchronize_from(struct session *target)
631 struct session_group *sg;
632 struct session *s;
634 if ((sg = session_group_contains(target)) == NULL)
635 return;
637 TAILQ_FOREACH(s, &sg->sessions, gentry) {
638 if (s != target)
639 session_group_synchronize1(target, s);
644 * Synchronize a session with a target session. This means destroying all
645 * winlinks then recreating them, then updating the current window, last window
646 * stack and alerts.
648 static void
649 session_group_synchronize1(struct session *target, struct session *s)
651 struct winlinks old_windows, *ww;
652 struct winlink_stack old_lastw;
653 struct winlink *wl, *wl2;
655 /* Don't do anything if the session is empty (it'll be destroyed). */
656 ww = &target->windows;
657 if (RB_EMPTY(ww))
658 return;
660 /* If the current window has vanished, move to the next now. */
661 if (s->curw != NULL &&
662 winlink_find_by_index(ww, s->curw->idx) == NULL &&
663 session_last(s) != 0 && session_previous(s, 0) != 0)
664 session_next(s, 0);
666 /* Save the old pointer and reset it. */
667 memcpy(&old_windows, &s->windows, sizeof old_windows);
668 RB_INIT(&s->windows);
670 /* Link all the windows from the target. */
671 RB_FOREACH(wl, winlinks, ww) {
672 wl2 = winlink_add(&s->windows, wl->idx);
673 wl2->session = s;
674 winlink_set_window(wl2, wl->window);
675 notify_session_window("window-linked", s, wl2->window);
676 wl2->flags |= wl->flags & WINLINK_ALERTFLAGS;
679 /* Fix up the current window. */
680 if (s->curw != NULL)
681 s->curw = winlink_find_by_index(&s->windows, s->curw->idx);
682 else
683 s->curw = winlink_find_by_index(&s->windows, target->curw->idx);
685 /* Fix up the last window stack. */
686 memcpy(&old_lastw, &s->lastw, sizeof old_lastw);
687 TAILQ_INIT(&s->lastw);
688 TAILQ_FOREACH(wl, &old_lastw, sentry) {
689 wl2 = winlink_find_by_index(&s->windows, wl->idx);
690 if (wl2 != NULL) {
691 TAILQ_INSERT_TAIL(&s->lastw, wl2, sentry);
692 wl2->flags |= WINLINK_VISITED;
696 /* Then free the old winlinks list. */
697 while (!RB_EMPTY(&old_windows)) {
698 wl = RB_ROOT(&old_windows);
699 wl2 = winlink_find_by_window_id(&s->windows, wl->window->id);
700 if (wl2 == NULL)
701 notify_session_window("window-unlinked", s, wl->window);
702 winlink_remove(&old_windows, wl);
706 /* Renumber the windows across winlinks attached to a specific session. */
707 void
708 session_renumber_windows(struct session *s)
710 struct winlink *wl, *wl1, *wl_new;
711 struct winlinks old_wins;
712 struct winlink_stack old_lastw;
713 int new_idx, new_curw_idx, marked_idx = -1;
715 /* Save and replace old window list. */
716 memcpy(&old_wins, &s->windows, sizeof old_wins);
717 RB_INIT(&s->windows);
719 /* Start renumbering from the base-index if it's set. */
720 new_idx = options_get_number(s->options, "base-index");
721 new_curw_idx = 0;
723 /* Go through the winlinks and assign new indexes. */
724 RB_FOREACH(wl, winlinks, &old_wins) {
725 wl_new = winlink_add(&s->windows, new_idx);
726 wl_new->session = s;
727 winlink_set_window(wl_new, wl->window);
728 wl_new->flags |= wl->flags & WINLINK_ALERTFLAGS;
730 if (wl == marked_pane.wl)
731 marked_idx = wl_new->idx;
732 if (wl == s->curw)
733 new_curw_idx = wl_new->idx;
735 new_idx++;
738 /* Fix the stack of last windows now. */
739 memcpy(&old_lastw, &s->lastw, sizeof old_lastw);
740 TAILQ_INIT(&s->lastw);
741 TAILQ_FOREACH(wl, &old_lastw, sentry) {
742 wl->flags &= ~WINLINK_VISITED;
743 wl_new = winlink_find_by_window(&s->windows, wl->window);
744 if (wl_new != NULL) {
745 TAILQ_INSERT_TAIL(&s->lastw, wl_new, sentry);
746 wl_new->flags |= WINLINK_VISITED;
750 /* Set the current window. */
751 if (marked_idx != -1) {
752 marked_pane.wl = winlink_find_by_index(&s->windows, marked_idx);
753 if (marked_pane.wl == NULL)
754 server_clear_marked();
756 s->curw = winlink_find_by_index(&s->windows, new_curw_idx);
758 /* Free the old winlinks (reducing window references too). */
759 RB_FOREACH_SAFE(wl, winlinks, &old_wins, wl1)
760 winlink_remove(&old_wins, wl);