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>
29 struct sessions sessions
;
30 u_int next_session_id
;
31 struct session_groups session_groups
= RB_INITIALIZER(&session_groups
);
33 static void session_free(int, short, void *);
34 static void session_lock_timer(int, short, void *);
35 static struct winlink
*session_next_alert(struct winlink
*);
36 static struct winlink
*session_previous_alert(struct winlink
*);
37 static void session_group_remove(struct session
*);
38 static void session_group_synchronize1(struct session
*, struct session
*);
41 session_cmp(struct session
*s1
, struct session
*s2
)
43 return (strcmp(s1
->name
, s2
->name
));
45 RB_GENERATE(sessions
, session
, entry
, session_cmp
);
48 session_group_cmp(struct session_group
*s1
, struct session_group
*s2
)
50 return (strcmp(s1
->name
, s2
->name
));
52 RB_GENERATE(session_groups
, session_group
, entry
, session_group_cmp
);
55 * Find if session is still alive. This is true if it is still on the global
59 session_alive(struct session
*s
)
61 struct session
*s_loop
;
63 RB_FOREACH(s_loop
, sessions
, &sessions
) {
70 /* Find session by name. */
72 session_find(const char *name
)
76 s
.name
= (char *) name
;
77 return (RB_FIND(sessions
, &sessions
, &s
));
80 /* Find session by id parsed from a string. */
82 session_find_by_id_str(const char *s
)
90 id
= strtonum(s
+ 1, 0, UINT_MAX
, &errstr
);
93 return (session_find_by_id(id
));
96 /* Find session by id. */
98 session_find_by_id(u_int id
)
102 RB_FOREACH(s
, sessions
, &sessions
) {
109 /* Create a new session. */
111 session_create(const char *prefix
, const char *name
, const char *cwd
,
112 struct environ
*env
, struct options
*oo
, struct termios
*tio
)
116 s
= xcalloc(1, sizeof *s
);
120 s
->cwd
= xstrdup(cwd
);
122 TAILQ_INIT(&s
->lastw
);
123 RB_INIT(&s
->windows
);
128 status_update_cache(s
);
132 s
->tio
= xmalloc(sizeof *s
->tio
);
133 memcpy(s
->tio
, tio
, sizeof *s
->tio
);
137 s
->name
= xstrdup(name
);
138 s
->id
= next_session_id
++;
141 s
->id
= next_session_id
++;
144 xasprintf(&s
->name
, "%s-%u", prefix
, s
->id
);
146 xasprintf(&s
->name
, "%u", s
->id
);
147 } while (RB_FIND(sessions
, &sessions
, s
) != NULL
);
149 RB_INSERT(sessions
, &sessions
, s
);
151 log_debug("new session %s $%u", s
->name
, s
->id
);
153 if (gettimeofday(&s
->creation_time
, NULL
) != 0)
154 fatal("gettimeofday failed");
155 session_update_activity(s
, &s
->creation_time
);
160 /* Add a reference to a session. */
162 session_add_ref(struct session
*s
, const char *from
)
165 log_debug("%s: %s %s, now %d", __func__
, s
->name
, from
, s
->references
);
168 /* Remove a reference from a session. */
170 session_remove_ref(struct session
*s
, const char *from
)
173 log_debug("%s: %s %s, now %d", __func__
, s
->name
, from
, s
->references
);
175 if (s
->references
== 0)
176 event_once(-1, EV_TIMEOUT
, session_free
, s
, NULL
);
181 session_free(__unused
int fd
, __unused
short events
, void *arg
)
183 struct session
*s
= arg
;
185 log_debug("session %s freed (%d references)", s
->name
, s
->references
);
187 if (s
->references
== 0) {
188 environ_free(s
->environ
);
189 options_free(s
->options
);
196 /* Destroy a session. */
198 session_destroy(struct session
*s
, int notify
, const char *from
)
202 log_debug("session %s destroyed (%s)", s
->name
, from
);
208 RB_REMOVE(sessions
, &sessions
, s
);
210 notify_session("session-closed", s
);
214 if (event_initialized(&s
->lock_timer
))
215 event_del(&s
->lock_timer
);
217 session_group_remove(s
);
219 while (!TAILQ_EMPTY(&s
->lastw
))
220 winlink_stack_remove(&s
->lastw
, TAILQ_FIRST(&s
->lastw
));
221 while (!RB_EMPTY(&s
->windows
)) {
222 wl
= RB_ROOT(&s
->windows
);
223 notify_session_window("window-unlinked", s
, wl
->window
);
224 winlink_remove(&s
->windows
, wl
);
227 free((void *)s
->cwd
);
229 session_remove_ref(s
, __func__
);
232 /* Sanitize session name. */
234 session_check_name(const char *name
)
236 char *copy
, *cp
, *new_name
;
240 copy
= xstrdup(name
);
241 for (cp
= copy
; *cp
!= '\0'; cp
++) {
242 if (*cp
== ':' || *cp
== '.')
245 utf8_stravis(&new_name
, copy
, VIS_OCTAL
|VIS_CSTYLE
|VIS_TAB
|VIS_NL
);
250 /* Lock session if it has timed out. */
252 session_lock_timer(__unused
int fd
, __unused
short events
, void *arg
)
254 struct session
*s
= arg
;
256 if (s
->attached
== 0)
259 log_debug("session %s locked, activity time %lld", s
->name
,
260 (long long)s
->activity_time
.tv_sec
);
262 server_lock_session(s
);
266 /* Update activity time. */
268 session_update_activity(struct session
*s
, struct timeval
*from
)
273 gettimeofday(&s
->activity_time
, NULL
);
275 memcpy(&s
->activity_time
, from
, sizeof s
->activity_time
);
277 log_debug("session $%u %s activity %lld.%06d", s
->id
,
278 s
->name
, (long long)s
->activity_time
.tv_sec
,
279 (int)s
->activity_time
.tv_usec
);
281 if (evtimer_initialized(&s
->lock_timer
))
282 evtimer_del(&s
->lock_timer
);
284 evtimer_set(&s
->lock_timer
, session_lock_timer
, s
);
286 if (s
->attached
!= 0) {
288 tv
.tv_sec
= options_get_number(s
->options
, "lock-after-time");
290 evtimer_add(&s
->lock_timer
, &tv
);
294 /* Find the next usable session. */
296 session_next_session(struct session
*s
)
300 if (RB_EMPTY(&sessions
) || !session_alive(s
))
303 s2
= RB_NEXT(sessions
, &sessions
, s
);
305 s2
= RB_MIN(sessions
, &sessions
);
311 /* Find the previous usable session. */
313 session_previous_session(struct session
*s
)
317 if (RB_EMPTY(&sessions
) || !session_alive(s
))
320 s2
= RB_PREV(sessions
, &sessions
, s
);
322 s2
= RB_MAX(sessions
, &sessions
);
328 /* Attach a window to a session. */
330 session_attach(struct session
*s
, struct window
*w
, int idx
, char **cause
)
334 if ((wl
= winlink_add(&s
->windows
, idx
)) == NULL
) {
335 xasprintf(cause
, "index in use: %d", idx
);
339 winlink_set_window(wl
, w
);
340 notify_session_window("window-linked", s
, w
);
342 session_group_synchronize_from(s
);
346 /* Detach a window from a session. */
348 session_detach(struct session
*s
, struct winlink
*wl
)
351 session_last(s
) != 0 &&
352 session_previous(s
, 0) != 0)
355 wl
->flags
&= ~WINLINK_ALERTFLAGS
;
356 notify_session_window("window-unlinked", s
, wl
->window
);
357 winlink_stack_remove(&s
->lastw
, wl
);
358 winlink_remove(&s
->windows
, wl
);
360 session_group_synchronize_from(s
);
362 if (RB_EMPTY(&s
->windows
))
367 /* Return if session has window. */
369 session_has(struct session
*s
, struct window
*w
)
373 TAILQ_FOREACH(wl
, &w
->winlinks
, wentry
) {
374 if (wl
->session
== s
)
381 * Return 1 if a window is linked outside this session (not including session
382 * groups). The window must be in this session!
385 session_is_linked(struct session
*s
, struct window
*w
)
387 struct session_group
*sg
;
389 if ((sg
= session_group_contains(s
)) != NULL
)
390 return (w
->references
!= session_group_count(sg
));
391 return (w
->references
!= 1);
394 static struct winlink
*
395 session_next_alert(struct winlink
*wl
)
398 if (wl
->flags
& WINLINK_ALERTFLAGS
)
400 wl
= winlink_next(wl
);
405 /* Move session to next window. */
407 session_next(struct session
*s
, int alert
)
414 wl
= winlink_next(s
->curw
);
416 wl
= session_next_alert(wl
);
418 wl
= RB_MIN(winlinks
, &s
->windows
);
419 if (alert
&& ((wl
= session_next_alert(wl
)) == NULL
))
422 return (session_set_current(s
, wl
));
425 static struct winlink
*
426 session_previous_alert(struct winlink
*wl
)
429 if (wl
->flags
& WINLINK_ALERTFLAGS
)
431 wl
= winlink_previous(wl
);
436 /* Move session to previous window. */
438 session_previous(struct session
*s
, int alert
)
445 wl
= winlink_previous(s
->curw
);
447 wl
= session_previous_alert(wl
);
449 wl
= RB_MAX(winlinks
, &s
->windows
);
450 if (alert
&& (wl
= session_previous_alert(wl
)) == NULL
)
453 return (session_set_current(s
, wl
));
456 /* Move session to specific window. */
458 session_select(struct session
*s
, int idx
)
462 wl
= winlink_find_by_index(&s
->windows
, idx
);
463 return (session_set_current(s
, wl
));
466 /* Move session to last used window. */
468 session_last(struct session
*s
)
472 wl
= TAILQ_FIRST(&s
->lastw
);
478 return (session_set_current(s
, wl
));
481 /* Set current winlink to wl .*/
483 session_set_current(struct session
*s
, struct winlink
*wl
)
485 struct winlink
*old
= s
->curw
;
492 winlink_stack_remove(&s
->lastw
, wl
);
493 winlink_stack_push(&s
->lastw
, s
->curw
);
495 if (options_get_number(global_options
, "focus-events")) {
497 window_update_focus(old
->window
);
498 window_update_focus(wl
->window
);
500 winlink_clear_flags(wl
);
501 window_update_activity(wl
->window
);
502 tty_update_window_offset(wl
->window
);
503 notify_session("session-window-changed", s
);
507 /* Find the session group containing a session. */
508 struct session_group
*
509 session_group_contains(struct session
*target
)
511 struct session_group
*sg
;
514 RB_FOREACH(sg
, session_groups
, &session_groups
) {
515 TAILQ_FOREACH(s
, &sg
->sessions
, gentry
) {
523 /* Find session group by name. */
524 struct session_group
*
525 session_group_find(const char *name
)
527 struct session_group sg
;
530 return (RB_FIND(session_groups
, &session_groups
, &sg
));
533 /* Create a new session group. */
534 struct session_group
*
535 session_group_new(const char *name
)
537 struct session_group
*sg
;
539 if ((sg
= session_group_find(name
)) != NULL
)
542 sg
= xcalloc(1, sizeof *sg
);
543 sg
->name
= xstrdup(name
);
544 TAILQ_INIT(&sg
->sessions
);
546 RB_INSERT(session_groups
, &session_groups
, sg
);
550 /* Add a session to a session group. */
552 session_group_add(struct session_group
*sg
, struct session
*s
)
554 if (session_group_contains(s
) == NULL
)
555 TAILQ_INSERT_TAIL(&sg
->sessions
, s
, gentry
);
558 /* Remove a session from its group and destroy the group if empty. */
560 session_group_remove(struct session
*s
)
562 struct session_group
*sg
;
564 if ((sg
= session_group_contains(s
)) == NULL
)
566 TAILQ_REMOVE(&sg
->sessions
, s
, gentry
);
567 if (TAILQ_EMPTY(&sg
->sessions
)) {
568 RB_REMOVE(session_groups
, &session_groups
, sg
);
569 free((void *)sg
->name
);
574 /* Count number of sessions in session group. */
576 session_group_count(struct session_group
*sg
)
582 TAILQ_FOREACH(s
, &sg
->sessions
, gentry
)
587 /* Count number of clients attached to sessions in session group. */
589 session_group_attached_count(struct session_group
*sg
)
595 TAILQ_FOREACH(s
, &sg
->sessions
, gentry
)
600 /* Synchronize a session to its session group. */
602 session_group_synchronize_to(struct session
*s
)
604 struct session_group
*sg
;
605 struct session
*target
;
607 if ((sg
= session_group_contains(s
)) == NULL
)
611 TAILQ_FOREACH(target
, &sg
->sessions
, gentry
) {
616 session_group_synchronize1(target
, s
);
619 /* Synchronize a session group to a session. */
621 session_group_synchronize_from(struct session
*target
)
623 struct session_group
*sg
;
626 if ((sg
= session_group_contains(target
)) == NULL
)
629 TAILQ_FOREACH(s
, &sg
->sessions
, gentry
) {
631 session_group_synchronize1(target
, s
);
636 * Synchronize a session with a target session. This means destroying all
637 * winlinks then recreating them, then updating the current window, last window
641 session_group_synchronize1(struct session
*target
, struct session
*s
)
643 struct winlinks old_windows
, *ww
;
644 struct winlink_stack old_lastw
;
645 struct winlink
*wl
, *wl2
;
647 /* Don't do anything if the session is empty (it'll be destroyed). */
648 ww
= &target
->windows
;
652 /* If the current window has vanished, move to the next now. */
653 if (s
->curw
!= NULL
&&
654 winlink_find_by_index(ww
, s
->curw
->idx
) == NULL
&&
655 session_last(s
) != 0 && session_previous(s
, 0) != 0)
658 /* Save the old pointer and reset it. */
659 memcpy(&old_windows
, &s
->windows
, sizeof old_windows
);
660 RB_INIT(&s
->windows
);
662 /* Link all the windows from the target. */
663 RB_FOREACH(wl
, winlinks
, ww
) {
664 wl2
= winlink_add(&s
->windows
, wl
->idx
);
666 winlink_set_window(wl2
, wl
->window
);
667 notify_session_window("window-linked", s
, wl2
->window
);
668 wl2
->flags
|= wl
->flags
& WINLINK_ALERTFLAGS
;
671 /* Fix up the current window. */
673 s
->curw
= winlink_find_by_index(&s
->windows
, s
->curw
->idx
);
675 s
->curw
= winlink_find_by_index(&s
->windows
, target
->curw
->idx
);
677 /* Fix up the last window stack. */
678 memcpy(&old_lastw
, &s
->lastw
, sizeof old_lastw
);
679 TAILQ_INIT(&s
->lastw
);
680 TAILQ_FOREACH(wl
, &old_lastw
, sentry
) {
681 wl2
= winlink_find_by_index(&s
->windows
, wl
->idx
);
683 TAILQ_INSERT_TAIL(&s
->lastw
, wl2
, sentry
);
684 wl2
->flags
|= WINLINK_VISITED
;
688 /* Then free the old winlinks list. */
689 while (!RB_EMPTY(&old_windows
)) {
690 wl
= RB_ROOT(&old_windows
);
691 wl2
= winlink_find_by_window_id(&s
->windows
, wl
->window
->id
);
693 notify_session_window("window-unlinked", s
, wl
->window
);
694 winlink_remove(&old_windows
, wl
);
698 /* Renumber the windows across winlinks attached to a specific session. */
700 session_renumber_windows(struct session
*s
)
702 struct winlink
*wl
, *wl1
, *wl_new
;
703 struct winlinks old_wins
;
704 struct winlink_stack old_lastw
;
705 int new_idx
, new_curw_idx
, marked_idx
= -1;
707 /* Save and replace old window list. */
708 memcpy(&old_wins
, &s
->windows
, sizeof old_wins
);
709 RB_INIT(&s
->windows
);
711 /* Start renumbering from the base-index if it's set. */
712 new_idx
= options_get_number(s
->options
, "base-index");
715 /* Go through the winlinks and assign new indexes. */
716 RB_FOREACH(wl
, winlinks
, &old_wins
) {
717 wl_new
= winlink_add(&s
->windows
, new_idx
);
719 winlink_set_window(wl_new
, wl
->window
);
720 wl_new
->flags
|= wl
->flags
& WINLINK_ALERTFLAGS
;
722 if (wl
== marked_pane
.wl
)
723 marked_idx
= wl_new
->idx
;
725 new_curw_idx
= wl_new
->idx
;
730 /* Fix the stack of last windows now. */
731 memcpy(&old_lastw
, &s
->lastw
, sizeof old_lastw
);
732 TAILQ_INIT(&s
->lastw
);
733 TAILQ_FOREACH(wl
, &old_lastw
, sentry
) {
734 wl
->flags
&= ~WINLINK_VISITED
;
735 wl_new
= winlink_find_by_window(&s
->windows
, wl
->window
);
736 if (wl_new
!= NULL
) {
737 TAILQ_INSERT_TAIL(&s
->lastw
, wl_new
, sentry
);
738 wl_new
->flags
|= WINLINK_VISITED
;
742 /* Set the current window. */
743 if (marked_idx
!= -1) {
744 marked_pane
.wl
= winlink_find_by_index(&s
->windows
, marked_idx
);
745 if (marked_pane
.wl
== NULL
)
746 server_clear_marked();
748 s
->curw
= winlink_find_by_index(&s
->windows
, new_curw_idx
);
750 /* Free the old winlinks (reducing window references too). */
751 RB_FOREACH_SAFE(wl
, winlinks
, &old_wins
, wl1
)
752 winlink_remove(&old_wins
, wl
);