root/usr.bin/tmux/cmd-new-session.c
/* $OpenBSD: cmd-new-session.c,v 1.148 2026/03/04 08:16:47 nicm Exp $ */

/*
 * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#include <sys/types.h>

#include <errno.h>
#include <fcntl.h>
#include <stdlib.h>
#include <string.h>
#include <termios.h>
#include <unistd.h>

#include "tmux.h"

/*
 * Create a new session and attach to the current terminal unless -d is given.
 */

#define NEW_SESSION_TEMPLATE "#{session_name}:"

static enum cmd_retval  cmd_new_session_exec(struct cmd *, struct cmdq_item *);

const struct cmd_entry cmd_new_session_entry = {
        .name = "new-session",
        .alias = "new",

        .args = { "Ac:dDe:EF:f:n:Ps:t:x:Xy:", 0, -1, NULL },
        .usage = "[-AdDEPX] [-c start-directory] [-e environment] [-F format] "
                 "[-f flags] [-n window-name] [-s session-name] "
                 CMD_TARGET_SESSION_USAGE " [-x width] [-y height] "
                 "[shell-command [argument ...]]",

        .target = { 't', CMD_FIND_SESSION, CMD_FIND_CANFAIL },

        .flags = CMD_STARTSERVER,
        .exec = cmd_new_session_exec
};

const struct cmd_entry cmd_has_session_entry = {
        .name = "has-session",
        .alias = "has",

        .args = { "t:", 0, 0, NULL },
        .usage = CMD_TARGET_SESSION_USAGE,

        .target = { 't', CMD_FIND_SESSION, 0 },

        .flags = 0,
        .exec = cmd_new_session_exec
};

static enum cmd_retval
cmd_new_session_exec(struct cmd *self, struct cmdq_item *item)
{
        struct args             *args = cmd_get_args(self);
        struct cmd_find_state   *current = cmdq_get_current(item);
        struct cmd_find_state   *target = cmdq_get_target(item);
        struct client           *c = cmdq_get_client(item);
        struct session          *s, *as, *groupwith = NULL;
        struct environ          *env;
        struct options          *oo;
        struct termios           tio, *tiop;
        struct session_group    *sg = NULL;
        const char              *errstr, *template, *group, *tmp;
        char                    *cause, *cwd = NULL, *cp, *newname = NULL;
        char                    *name, *prefix = NULL;
        int                      detached, already_attached, is_control = 0;
        u_int                    sx, sy, dsx, dsy, count = args_count(args);
        struct spawn_context     sc = { 0 };
        enum cmd_retval          retval;
        struct cmd_find_state    fs;
        struct args_value       *av;

        if (cmd_get_entry(self) == &cmd_has_session_entry) {
                /*
                 * cmd_find_target() will fail if the session cannot be found,
                 * so always return success here.
                 */
                return (CMD_RETURN_NORMAL);
        }

        if (args_has(args, 't') && (count != 0 || args_has(args, 'n'))) {
                cmdq_error(item, "command or window name given with target");
                return (CMD_RETURN_ERROR);
        }

        tmp = args_get(args, 's');
        if (tmp != NULL) {
                name = format_single(item, tmp, c, NULL, NULL, NULL);
                newname = session_check_name(name);
                if (newname == NULL) {
                        cmdq_error(item, "invalid session: %s", name);
                        free(name);
                        return (CMD_RETURN_ERROR);
                }
                free(name);
        }
        if (args_has(args, 'A')) {
                if (newname != NULL)
                        as = session_find(newname);
                else
                        as = target->s;
                if (as != NULL) {
                        retval = cmd_attach_session(item, as->name,
                            args_has(args, 'D'), args_has(args, 'X'), 0,
                            args_get(args, 'c'), args_has(args, 'E'),
                            args_get(args, 'f'));
                        free(newname);
                        return (retval);
                }
        }
        if (newname != NULL && session_find(newname) != NULL) {
                cmdq_error(item, "duplicate session: %s", newname);
                goto fail;
        }

        /* Is this going to be part of a session group? */
        group = args_get(args, 't');
        if (group != NULL) {
                groupwith = target->s;
                if (groupwith == NULL)
                        sg = session_group_find(group);
                else
                        sg = session_group_contains(groupwith);
                if (sg != NULL)
                        prefix = xstrdup(sg->name);
                else if (groupwith != NULL)
                        prefix = xstrdup(groupwith->name);
                else {
                        prefix = session_check_name(group);
                        if (prefix == NULL) {
                                cmdq_error(item, "invalid session group: %s",
                                    group);
                                goto fail;
                        }
                }
        }

        /* Set -d if no client. */
        detached = args_has(args, 'd');
        if (c == NULL)
                detached = 1;
        else if (c->flags & CLIENT_CONTROL)
                is_control = 1;

        /* Is this client already attached? */
        already_attached = 0;
        if (c != NULL && c->session != NULL)
                already_attached = 1;

        /* Get the new session working directory. */
        if ((tmp = args_get(args, 'c')) != NULL)
                cwd = format_single(item, tmp, c, NULL, NULL, NULL);
        else
                cwd = xstrdup(server_client_get_cwd(c, NULL));

        /*
         * If this is a new client, check for nesting and save the termios
         * settings (part of which is used for new windows in this session).
         *
         * tcgetattr() is used rather than using tty.tio since if the client is
         * detached, tty_open won't be called. It must be done before opening
         * the terminal as that calls tcsetattr() to prepare for tmux taking
         * over.
         */
        if (!detached &&
            !already_attached &&
            c->fd != -1 &&
            (~c->flags & CLIENT_CONTROL)) {
                if (server_client_check_nested(cmdq_get_client(item))) {
                        cmdq_error(item, "sessions should be nested with care, "
                            "unset $TMUX to force");
                        goto fail;
                }
                if (tcgetattr(c->fd, &tio) != 0)
                        fatal("tcgetattr failed");
                tiop = &tio;
        } else
                tiop = NULL;

        /* Open the terminal if necessary. */
        if (!detached && !already_attached) {
                if (server_client_open(c, &cause) != 0) {
                        cmdq_error(item, "open terminal failed: %s", cause);
                        free(cause);
                        goto fail;
                }
        }

        /* Get default session size. */
        if (args_has(args, 'x')) {
                tmp = args_get(args, 'x');
                if (strcmp(tmp, "-") == 0) {
                        if (c != NULL)
                                dsx = c->tty.sx;
                        else
                                dsx = 80;
                } else {
                        dsx = strtonum(tmp, 1, USHRT_MAX, &errstr);
                        if (errstr != NULL) {
                                cmdq_error(item, "width %s", errstr);
                                goto fail;
                        }
                }
        } else
                dsx = 80;
        if (args_has(args, 'y')) {
                tmp = args_get(args, 'y');
                if (strcmp(tmp, "-") == 0) {
                        if (c != NULL)
                                dsy = c->tty.sy;
                        else
                                dsy = 24;
                } else {
                        dsy = strtonum(tmp, 1, USHRT_MAX, &errstr);
                        if (errstr != NULL) {
                                cmdq_error(item, "height %s", errstr);
                                goto fail;
                        }
                }
        } else
                dsy = 24;

        /* Find new session size. */
        if (!detached && !is_control) {
                sx = c->tty.sx;
                sy = c->tty.sy;
                if (sy > 0 && options_get_number(global_s_options, "status"))
                        sy--;
        } else {
                tmp = options_get_string(global_s_options, "default-size");
                if (sscanf(tmp, "%ux%u", &sx, &sy) != 2) {
                        sx = dsx;
                        sy = dsy;
                } else {
                        if (args_has(args, 'x'))
                                sx = dsx;
                        if (args_has(args, 'y'))
                                sy = dsy;
                }
        }
        if (sx == 0)
                sx = 1;
        if (sy == 0)
                sy = 1;

        /* Create the new session. */
        oo = options_create(global_s_options);
        if (args_has(args, 'x') || args_has(args, 'y')) {
                if (!args_has(args, 'x'))
                        dsx = sx;
                if (!args_has(args, 'y'))
                        dsy = sy;
                options_set_string(oo, "default-size", 0, "%ux%u", dsx, dsy);
        }
        env = environ_create();
        if (c != NULL && !args_has(args, 'E'))
                environ_update(global_s_options, c->environ, env);
        av = args_first_value(args, 'e');
        while (av != NULL) {
                environ_put(env, av->string, 0);
                av = args_next_value(av);
        }
        s = session_create(prefix, newname, cwd, env, oo, tiop);

        /* Spawn the initial window. */
        sc.item = item;
        sc.s = s;
        if (!detached)
                sc.tc = c;

        sc.name = args_get(args, 'n');
        args_to_vector(args, &sc.argc, &sc.argv);

        sc.idx = -1;
        sc.cwd = args_get(args, 'c');

        sc.flags = 0;

        if (spawn_window(&sc, &cause) == NULL) {
                session_destroy(s, 0, __func__);
                cmdq_error(item, "create window failed: %s", cause);
                free(cause);
                goto fail;
        }

        /*
         * If a target session is given, this is to be part of a session group,
         * so add it to the group and synchronize.
         */
        if (group != NULL) {
                if (sg == NULL) {
                        if (groupwith != NULL) {
                                sg = session_group_new(groupwith->name);
                                session_group_add(sg, groupwith);
                        } else
                                sg = session_group_new(group);
                }
                session_group_add(sg, s);
                session_group_synchronize_to(s);
                session_select(s, RB_MIN(winlinks, &s->windows)->idx);
        }
        notify_session("session-created", s);

        /*
         * Set the client to the new session. If a command client exists, it is
         * taking this session and needs to get MSG_READY and stay around.
         */
        if (!detached) {
                if (args_has(args, 'f'))
                        server_client_set_flags(c, args_get(args, 'f'));
                if (!already_attached) {
                        if (~c->flags & CLIENT_CONTROL)
                                proc_send(c->peer, MSG_READY, -1, NULL, 0);
                } else if (c->session != NULL)
                        c->last_session = c->session;
                server_client_set_session(c, s);
                if (~cmdq_get_flags(item) & CMDQ_STATE_REPEAT)
                        server_client_set_key_table(c, NULL);
        }

        /* Print if requested. */
        if (args_has(args, 'P')) {
                if ((template = args_get(args, 'F')) == NULL)
                        template = NEW_SESSION_TEMPLATE;
                cp = format_single(item, template, c, s, s->curw, NULL);
                cmdq_print(item, "%s", cp);
                free(cp);
        }

        if (!detached)
                c->flags |= CLIENT_ATTACHED;
        if (!args_has(args, 'd'))
                cmd_find_from_session(current, s, 0);

        cmd_find_from_session(&fs, s, 0);
        cmdq_insert_hook(s, item, &fs, "after-new-session");

        if (cfg_finished)
                cfg_show_causes(s);

        if (sc.argv != NULL)
                cmd_free_argv(sc.argc, sc.argv);
        free(cwd);
        free(newname);
        free(prefix);
        return (CMD_RETURN_NORMAL);

fail:
        if (sc.argv != NULL)
                cmd_free_argv(sc.argc, sc.argv);
        free(cwd);
        free(newname);
        free(prefix);
        return (CMD_RETURN_ERROR);
}