session.c

   1 /* $OpenBSD$ */
   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/time.h>
  21
  22 #include <paths.h>
  23 #include <string.h>
  24 #include <stdlib.h>
  25 #include <unistd.h>
  26 #include <time.h>
  27
  28 #include "tmux.h"
  29
  30 /* Global session list. */
  31 struct sessions sessions;
  32 struct sessions dead_sessions;
  33 u_int           next_session;
  34 struct session_groups session_groups;
  35
  36 struct winlink *session_next_alert(struct winlink *);
  37 struct winlink *session_previous_alert(struct winlink *);
  38
  39 RB_GENERATE(sessions, session, entry, session_cmp);
  40
  41 int
  42 session_cmp(struct session *s1, struct session *s2)
  43 {
  44         return (strcmp(s1->name, s2->name));
  45 }
  46
  47 /*
  48  * Find if session is still alive. This is true if it is still on the global
  49  * sessions list.
  50  */
  51 int
  52 session_alive(struct session *s)
  53 {
  54         struct session *s_loop;
  55
  56         RB_FOREACH(s_loop, sessions, &sessions) {
  57                 if (s_loop == s)
  58                         return (1);
  59         }
  60         return (0);
  61 }
  62
  63 /* Find session by name. */
  64 struct session *
  65 session_find(const char *name)
  66 {
  67         struct session  s;
  68
  69         s.name = (char *) name;
  70         return (RB_FIND(sessions, &sessions, &s));
  71 }
  72
  73 /* Find session by index. */
  74 struct session *
  75 session_find_by_index(u_int idx)
  76 {
  77         struct session  *s;
  78
  79         RB_FOREACH(s, sessions, &sessions) {
  80                 if (s->idx == idx)
  81                         return (s);
  82         }
  83         return (NULL);
  84 }
  85
  86 /* Create a new session. */
  87 struct session *
  88 session_create(const char *name, const char *cmd, const char *cwd,
  89     struct environ *env, struct termios *tio, int idx, u_int sx, u_int sy,
  90     char **cause)
  91 {
  92         struct session  *s;
  93
  94         s = xmalloc(sizeof *s);
  95         s->references = 0;
  96         s->flags = 0;
  97
  98         if (gettimeofday(&s->creation_time, NULL) != 0)
  99                 fatal("gettimeofday failed");
 100         session_update_activity(s);
 101
 102         s->cwd = xstrdup(cwd);
 103
 104         s->curw = NULL;
 105         TAILQ_INIT(&s->lastw);
 106         RB_INIT(&s->windows);
 107
 108         options_init(&s->options, &global_s_options);
 109         environ_init(&s->environ);
 110         if (env != NULL)
 111                 environ_copy(env, &s->environ);
 112
 113         s->tio = NULL;
 114         if (tio != NULL) {
 115                 s->tio = xmalloc(sizeof *s->tio);
 116                 memcpy(s->tio, tio, sizeof *s->tio);
 117         }
 118
 119         s->sx = sx;
 120         s->sy = sy;
 121
 122         s->idx = next_session++;
 123         if (name != NULL)
 124                 s->name = xstrdup(name);
 125         else
 126                 xasprintf(&s->name, "%u", s->idx);
 127         RB_INSERT(sessions, &sessions, s);
 128
 129         if (cmd != NULL) {
 130                 if (session_new(s, NULL, cmd, cwd, idx, cause) == NULL) {
 131                         session_destroy(s);
 132                         return (NULL);
 133                 }
 134                 session_select(s, RB_ROOT(&s->windows)->idx);
 135         }
 136
 137         log_debug("session %s created", s->name);
 138
 139         return (s);
 140 }
 141
 142 /* Destroy a session. */
 143 void
 144 session_destroy(struct session *s)
 145 {
 146         log_debug("session %s destroyed", s->name);
 147
 148         RB_REMOVE(sessions, &sessions, s);
 149
 150         if (s->tio != NULL)
 151                 xfree(s->tio);
 152
 153         session_group_remove(s);
 154         environ_free(&s->environ);
 155         options_free(&s->options);
 156
 157         while (!TAILQ_EMPTY(&s->lastw))
 158                 winlink_stack_remove(&s->lastw, TAILQ_FIRST(&s->lastw));
 159         while (!RB_EMPTY(&s->windows))
 160                 winlink_remove(&s->windows, RB_ROOT(&s->windows));
 161
 162         xfree(s->cwd);
 163
 164         RB_INSERT(sessions, &dead_sessions, s);
 165 }
 166
 167 /* Update session active time. */
 168 void
 169 session_update_activity(struct session *s)
 170 {
 171         if (gettimeofday(&s->activity_time, NULL) != 0)
 172                 fatal("gettimeofday");
 173 }
 174
 175 /* Find the next usable session. */
 176 struct session *
 177 session_next_session(struct session *s)
 178 {
 179         struct session *s2;
 180
 181         if (RB_EMPTY(&sessions) || !session_alive(s))
 182                 return (NULL);
 183
 184         s2 = RB_NEXT(sessions, &sessions, s);
 185         if (s2 == NULL)
 186                 s2 = RB_MIN(sessions, &sessions);
 187         if (s2 == s)
 188                 return (NULL);
 189         return (s2);
 190 }
 191
 192 /* Find the previous usable session. */
 193 struct session *
 194 session_previous_session(struct session *s)
 195 {
 196         struct session *s2;
 197
 198         if (RB_EMPTY(&sessions) || !session_alive(s))
 199                 return (NULL);
 200
 201         s2 = RB_PREV(sessions, &sessions, s);
 202         if (s2 == NULL)
 203                 s2 = RB_MAX(sessions, &sessions);
 204         if (s2 == s)
 205                 return (NULL);
 206         return (s2);
 207 }
 208
 209 /* Create a new window on a session. */
 210 struct winlink *
 211 session_new(struct session *s,
 212     const char *name, const char *cmd, const char *cwd, int idx, char **cause)
 213 {
 214         struct window   *w;
 215         struct winlink  *wl;
 216         struct environ   env;
 217         const char      *shell;
 218         u_int            hlimit;
 219
 220         if ((wl = winlink_add(&s->windows, idx)) == NULL) {
 221                 xasprintf(cause, "index in use: %d", idx);
 222                 return (NULL);
 223         }
 224
 225         environ_init(&env);
 226         environ_copy(&global_environ, &env);
 227         environ_copy(&s->environ, &env);
 228         server_fill_environ(s, &env);
 229
 230         shell = options_get_string(&s->options, "default-shell");
 231         if (*shell == '\0' || areshell(shell))
 232                 shell = _PATH_BSHELL;
 233
 234         hlimit = options_get_number(&s->options, "history-limit");
 235         w = window_create(
 236             name, cmd, shell, cwd, &env, s->tio, s->sx, s->sy, hlimit, cause);
 237         if (w == NULL) {
 238                 winlink_remove(&s->windows, wl);
 239                 environ_free(&env);
 240                 return (NULL);
 241         }
 242         winlink_set_window(wl, w);
 243         environ_free(&env);
 244
 245         if (options_get_number(&s->options, "set-remain-on-exit"))
 246                 options_set_number(&w->options, "remain-on-exit", 1);
 247
 248         session_group_synchronize_from(s);
 249         return (wl);
 250 }
 251
 252 /* Attach a window to a session. */
 253 struct winlink *
 254 session_attach(struct session *s, struct window *w, int idx, char **cause)
 255 {
 256         struct winlink  *wl;
 257
 258         if ((wl = winlink_add(&s->windows, idx)) == NULL) {
 259                 xasprintf(cause, "index in use: %d", idx);
 260                 return (NULL);
 261         }
 262         winlink_set_window(wl, w);
 263
 264         session_group_synchronize_from(s);
 265         return (wl);
 266 }
 267
 268 /* Detach a window from a session. */
 269 int
 270 session_detach(struct session *s, struct winlink *wl)
 271 {
 272         if (s->curw == wl &&
 273             session_last(s) != 0 && session_previous(s, 0) != 0)
 274                 session_next(s, 0);
 275
 276         wl->flags &= ~WINLINK_ALERTFLAGS;
 277         winlink_stack_remove(&s->lastw, wl);
 278         winlink_remove(&s->windows, wl);
 279         session_group_synchronize_from(s);
 280         if (RB_EMPTY(&s->windows)) {
 281                 session_destroy(s);
 282                 return (1);
 283         }
 284         return (0);
 285 }
 286
 287 /* Return if session has window. */
 288 struct winlink *
 289 session_has(struct session *s, struct window *w)
 290 {
 291         struct winlink  *wl;
 292
 293         RB_FOREACH(wl, winlinks, &s->windows) {
 294                 if (wl->window == w)
 295                         return (wl);
 296         }
 297         return (NULL);
 298 }
 299
 300 struct winlink *
 301 session_next_alert(struct winlink *wl)
 302 {
 303         while (wl != NULL) {
 304                 if (wl->flags & WINLINK_ALERTFLAGS)
 305                         break;
 306                 wl = winlink_next(wl);
 307         }
 308         return (wl);
 309 }
 310
 311 /* Move session to next window. */
 312 int
 313 session_next(struct session *s, int alert)
 314 {
 315         struct winlink  *wl;
 316
 317         if (s->curw == NULL)
 318                 return (-1);
 319
 320         wl = winlink_next(s->curw);
 321         if (alert)
 322                 wl = session_next_alert(wl);
 323         if (wl == NULL) {
 324                 wl = RB_MIN(winlinks, &s->windows);
 325                 if (alert && ((wl = session_next_alert(wl)) == NULL))
 326                         return (-1);
 327         }
 328         if (wl == s->curw)
 329                 return (1);
 330         winlink_stack_remove(&s->lastw, wl);
 331         winlink_stack_push(&s->lastw, s->curw);
 332         s->curw = wl;
 333         wl->flags &= ~WINLINK_ALERTFLAGS;
 334         return (0);
 335 }
 336
 337 struct winlink *
 338 session_previous_alert(struct winlink *wl)
 339 {
 340         while (wl != NULL) {
 341                 if (wl->flags & WINLINK_ALERTFLAGS)
 342                         break;
 343                 wl = winlink_previous(wl);
 344         }
 345         return (wl);
 346 }
 347
 348 /* Move session to previous window. */
 349 int
 350 session_previous(struct session *s, int alert)
 351 {
 352         struct winlink  *wl;
 353
 354         if (s->curw == NULL)
 355                 return (-1);
 356
 357         wl = winlink_previous(s->curw);
 358         if (alert)
 359                 wl = session_previous_alert(wl);
 360         if (wl == NULL) {
 361                 wl = RB_MAX(winlinks, &s->windows);
 362                 if (alert && (wl = session_previous_alert(wl)) == NULL)
 363                         return (-1);
 364         }
 365         if (wl == s->curw)
 366                 return (1);
 367         winlink_stack_remove(&s->lastw, wl);
 368         winlink_stack_push(&s->lastw, s->curw);
 369         s->curw = wl;
 370         wl->flags &= ~WINLINK_ALERTFLAGS;
 371         return (0);
 372 }
 373
 374 /* Move session to specific window. */
 375 int
 376 session_select(struct session *s, int idx)
 377 {
 378         struct winlink  *wl;
 379
 380         wl = winlink_find_by_index(&s->windows, idx);
 381         if (wl == NULL)
 382                 return (-1);
 383         if (wl == s->curw)
 384                 return (1);
 385         winlink_stack_remove(&s->lastw, wl);
 386         winlink_stack_push(&s->lastw, s->curw);
 387         s->curw = wl;
 388         wl->flags &= ~WINLINK_ALERTFLAGS;
 389         return (0);
 390 }
 391
 392 /* Move session to last used window. */
 393 int
 394 session_last(struct session *s)
 395 {
 396         struct winlink  *wl;
 397
 398         wl = TAILQ_FIRST(&s->lastw);
 399         if (wl == NULL)
 400                 return (-1);
 401         if (wl == s->curw)
 402                 return (1);
 403
 404         winlink_stack_remove(&s->lastw, wl);
 405         winlink_stack_push(&s->lastw, s->curw);
 406         s->curw = wl;
 407         wl->flags &= ~WINLINK_ALERTFLAGS;
 408         return (0);
 409 }
 410
 411 /* Find the session group containing a session. */
 412 struct session_group *
 413 session_group_find(struct session *target)
 414 {
 415         struct session_group    *sg;
 416         struct session          *s;
 417
 418         TAILQ_FOREACH(sg, &session_groups, entry) {
 419                 TAILQ_FOREACH(s, &sg->sessions, gentry) {
 420                         if (s == target)
 421                                 return (sg);
 422                 }
 423         }
 424         return (NULL);
 425 }
 426
 427 /* Find session group index. */
 428 u_int
 429 session_group_index(struct session_group *sg)
 430 {
 431         struct session_group   *sg2;
 432         u_int                   i;
 433
 434         i = 0;
 435         TAILQ_FOREACH(sg2, &session_groups, entry) {
 436                 if (sg == sg2)
 437                         return (i);
 438                 i++;
 439         }
 440
 441         fatalx("session group not found");
 442 }
 443
 444 /*
 445  * Add a session to the session group containing target, creating it if
 446  * necessary.
 447  */
 448 void
 449 session_group_add(struct session *target, struct session *s)
 450 {
 451         struct session_group    *sg;
 452
 453         if ((sg = session_group_find(target)) == NULL) {
 454                 sg = xmalloc(sizeof *sg);
 455                 TAILQ_INSERT_TAIL(&session_groups, sg, entry);
 456                 TAILQ_INIT(&sg->sessions);
 457                 TAILQ_INSERT_TAIL(&sg->sessions, target, gentry);
 458         }
 459         TAILQ_INSERT_TAIL(&sg->sessions, s, gentry);
 460 }
 461
 462 /* Remove a session from its group and destroy the group if empty. */
 463 void
 464 session_group_remove(struct session *s)
 465 {
 466         struct session_group    *sg;
 467
 468         if ((sg = session_group_find(s)) == NULL)
 469                 return;
 470         TAILQ_REMOVE(&sg->sessions, s, gentry);
 471         if (TAILQ_NEXT(TAILQ_FIRST(&sg->sessions), gentry) == NULL)
 472                 TAILQ_REMOVE(&sg->sessions, TAILQ_FIRST(&sg->sessions), gentry);
 473         if (TAILQ_EMPTY(&sg->sessions)) {
 474                 TAILQ_REMOVE(&session_groups, sg, entry);
 475                 xfree(sg);
 476         }
 477 }
 478
 479 /* Synchronize a session to its session group. */
 480 void
 481 session_group_synchronize_to(struct session *s)
 482 {
 483         struct session_group    *sg;
 484         struct session          *target;
 485
 486         if ((sg = session_group_find(s)) == NULL)
 487                 return;
 488
 489         target = NULL;
 490         TAILQ_FOREACH(target, &sg->sessions, gentry) {
 491                 if (target != s)
 492                         break;
 493         }
 494         session_group_synchronize1(target, s);
 495 }
 496
 497 /* Synchronize a session group to a session. */
 498 void
 499 session_group_synchronize_from(struct session *target)
 500 {
 501         struct session_group    *sg;
 502         struct session          *s;
 503
 504         if ((sg = session_group_find(target)) == NULL)
 505                 return;
 506
 507         TAILQ_FOREACH(s, &sg->sessions, gentry) {
 508                 if (s != target)
 509                         session_group_synchronize1(target, s);
 510         }
 511 }
 512
 513 /*
 514  * Synchronize a session with a target session. This means destroying all
 515  * winlinks then recreating them, then updating the current window, last window
 516  * stack and alerts.
 517  */
 518 void
 519 session_group_synchronize1(struct session *target, struct session *s)
 520 {
 521         struct winlinks          old_windows, *ww;
 522         struct winlink_stack     old_lastw;
 523         struct winlink          *wl, *wl2;
 524
 525         /* Don't do anything if the session is empty (it'll be destroyed). */
 526         ww = &target->windows;
 527         if (RB_EMPTY(ww))
 528                 return;
 529
 530         /* If the current window has vanished, move to the next now. */
 531         if (s->curw != NULL &&
 532             winlink_find_by_index(ww, s->curw->idx) == NULL &&
 533             session_last(s) != 0 && session_previous(s, 0) != 0)
 534                 session_next(s, 0);
 535
 536         /* Save the old pointer and reset it. */
 537         memcpy(&old_windows, &s->windows, sizeof old_windows);
 538         RB_INIT(&s->windows);
 539
 540         /* Link all the windows from the target. */
 541         RB_FOREACH(wl, winlinks, ww) {
 542                 wl2 = winlink_add(&s->windows, wl->idx);
 543                 winlink_set_window(wl2, wl->window);
 544                 wl2->flags |= wl->flags & WINLINK_ALERTFLAGS;
 545         }
 546
 547         /* Fix up the current window. */
 548         if (s->curw != NULL)
 549                 s->curw = winlink_find_by_index(&s->windows, s->curw->idx);
 550         else
 551                 s->curw = winlink_find_by_index(&s->windows, target->curw->idx);
 552
 553         /* Fix up the last window stack. */
 554         memcpy(&old_lastw, &s->lastw, sizeof old_lastw);
 555         TAILQ_INIT(&s->lastw);
 556         TAILQ_FOREACH(wl, &old_lastw, sentry) {
 557                 wl2 = winlink_find_by_index(&s->windows, wl->idx);
 558                 if (wl2 != NULL)
 559                         TAILQ_INSERT_TAIL(&s->lastw, wl2, sentry);
 560         }
 561
 562         /* Then free the old winlinks list. */
 563         while (!RB_EMPTY(&old_windows)) {
 564                 wl = RB_ROOT(&old_windows);
 565                 winlink_remove(&old_windows, wl);
 566         }
 567 }