xref: /openbsd/usr.bin/tmux/cmd-new-session.c (revision 8e309d18)
1 /* $OpenBSD: cmd-new-session.c,v 1.146 2022/07/06 08:40:52 nicm Exp $ */
2 
3 /*
4  * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
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 <errno.h>
22 #include <fcntl.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <termios.h>
26 #include <unistd.h>
27 
28 #include "tmux.h"
29 
30 /*
31  * Create a new session and attach to the current terminal unless -d is given.
32  */
33 
34 #define NEW_SESSION_TEMPLATE "#{session_name}:"
35 
36 static enum cmd_retval	cmd_new_session_exec(struct cmd *, struct cmdq_item *);
37 
38 const struct cmd_entry cmd_new_session_entry = {
39 	.name = "new-session",
40 	.alias = "new",
41 
42 	.args = { "Ac:dDe:EF:f:n:Ps:t:x:Xy:", 0, -1, NULL },
43 	.usage = "[-AdDEPX] [-c start-directory] [-e environment] [-F format] "
44 		 "[-f flags] [-n window-name] [-s session-name] "
45 		 CMD_TARGET_SESSION_USAGE " [-x width] [-y height] "
46 		 "[shell-command]",
47 
48 	.target = { 't', CMD_FIND_SESSION, CMD_FIND_CANFAIL },
49 
50 	.flags = CMD_STARTSERVER,
51 	.exec = cmd_new_session_exec
52 };
53 
54 const struct cmd_entry cmd_has_session_entry = {
55 	.name = "has-session",
56 	.alias = "has",
57 
58 	.args = { "t:", 0, 0, NULL },
59 	.usage = CMD_TARGET_SESSION_USAGE,
60 
61 	.target = { 't', CMD_FIND_SESSION, 0 },
62 
63 	.flags = 0,
64 	.exec = cmd_new_session_exec
65 };
66 
67 static enum cmd_retval
cmd_new_session_exec(struct cmd * self,struct cmdq_item * item)68 cmd_new_session_exec(struct cmd *self, struct cmdq_item *item)
69 {
70 	struct args		*args = cmd_get_args(self);
71 	struct cmd_find_state	*current = cmdq_get_current(item);
72 	struct cmd_find_state	*target = cmdq_get_target(item);
73 	struct client		*c = cmdq_get_client(item);
74 	struct session		*s, *as, *groupwith = NULL;
75 	struct environ		*env;
76 	struct options		*oo;
77 	struct termios		 tio, *tiop;
78 	struct session_group	*sg = NULL;
79 	const char		*errstr, *template, *group, *tmp;
80 	char			*cause, *cwd = NULL, *cp, *newname = NULL;
81 	char			*name, *prefix = NULL;
82 	int			 detached, already_attached, is_control = 0;
83 	u_int			 sx, sy, dsx, dsy, count = args_count(args);
84 	struct spawn_context	 sc = { 0 };
85 	enum cmd_retval		 retval;
86 	struct cmd_find_state    fs;
87 	struct args_value	*av;
88 
89 	if (cmd_get_entry(self) == &cmd_has_session_entry) {
90 		/*
91 		 * cmd_find_target() will fail if the session cannot be found,
92 		 * so always return success here.
93 		 */
94 		return (CMD_RETURN_NORMAL);
95 	}
96 
97 	if (args_has(args, 't') && (count != 0 || args_has(args, 'n'))) {
98 		cmdq_error(item, "command or window name given with target");
99 		return (CMD_RETURN_ERROR);
100 	}
101 
102 	tmp = args_get(args, 's');
103 	if (tmp != NULL) {
104 		name = format_single(item, tmp, c, NULL, NULL, NULL);
105 		newname = session_check_name(name);
106 		if (newname == NULL) {
107 			cmdq_error(item, "invalid session: %s", name);
108 			free(name);
109 			return (CMD_RETURN_ERROR);
110 		}
111 		free(name);
112 	}
113 	if (args_has(args, 'A')) {
114 		if (newname != NULL)
115 			as = session_find(newname);
116 		else
117 			as = target->s;
118 		if (as != NULL) {
119 			retval = cmd_attach_session(item, as->name,
120 			    args_has(args, 'D'), args_has(args, 'X'), 0, NULL,
121 			    args_has(args, 'E'), args_get(args, 'f'));
122 			free(newname);
123 			return (retval);
124 		}
125 	}
126 	if (newname != NULL && session_find(newname) != NULL) {
127 		cmdq_error(item, "duplicate session: %s", newname);
128 		goto fail;
129 	}
130 
131 	/* Is this going to be part of a session group? */
132 	group = args_get(args, 't');
133 	if (group != NULL) {
134 		groupwith = target->s;
135 		if (groupwith == NULL)
136 			sg = session_group_find(group);
137 		else
138 			sg = session_group_contains(groupwith);
139 		if (sg != NULL)
140 			prefix = xstrdup(sg->name);
141 		else if (groupwith != NULL)
142 			prefix = xstrdup(groupwith->name);
143 		else {
144 			prefix = session_check_name(group);
145 			if (prefix == NULL) {
146 				cmdq_error(item, "invalid session group: %s",
147 				    group);
148 				goto fail;
149 			}
150 		}
151 	}
152 
153 	/* Set -d if no client. */
154 	detached = args_has(args, 'd');
155 	if (c == NULL)
156 		detached = 1;
157 	else if (c->flags & CLIENT_CONTROL)
158 		is_control = 1;
159 
160 	/* Is this client already attached? */
161 	already_attached = 0;
162 	if (c != NULL && c->session != NULL)
163 		already_attached = 1;
164 
165 	/* Get the new session working directory. */
166 	if ((tmp = args_get(args, 'c')) != NULL)
167 		cwd = format_single(item, tmp, c, NULL, NULL, NULL);
168 	else
169 		cwd = xstrdup(server_client_get_cwd(c, NULL));
170 
171 	/*
172 	 * If this is a new client, check for nesting and save the termios
173 	 * settings (part of which is used for new windows in this session).
174 	 *
175 	 * tcgetattr() is used rather than using tty.tio since if the client is
176 	 * detached, tty_open won't be called. It must be done before opening
177 	 * the terminal as that calls tcsetattr() to prepare for tmux taking
178 	 * over.
179 	 */
180 	if (!detached &&
181 	    !already_attached &&
182 	    c->fd != -1 &&
183 	    (~c->flags & CLIENT_CONTROL)) {
184 		if (server_client_check_nested(cmdq_get_client(item))) {
185 			cmdq_error(item, "sessions should be nested with care, "
186 			    "unset $TMUX to force");
187 			goto fail;
188 		}
189 		if (tcgetattr(c->fd, &tio) != 0)
190 			fatal("tcgetattr failed");
191 		tiop = &tio;
192 	} else
193 		tiop = NULL;
194 
195 	/* Open the terminal if necessary. */
196 	if (!detached && !already_attached) {
197 		if (server_client_open(c, &cause) != 0) {
198 			cmdq_error(item, "open terminal failed: %s", cause);
199 			free(cause);
200 			goto fail;
201 		}
202 	}
203 
204 	/* Get default session size. */
205 	if (args_has(args, 'x')) {
206 		tmp = args_get(args, 'x');
207 		if (strcmp(tmp, "-") == 0) {
208 			if (c != NULL)
209 				dsx = c->tty.sx;
210 			else
211 				dsx = 80;
212 		} else {
213 			dsx = strtonum(tmp, 1, USHRT_MAX, &errstr);
214 			if (errstr != NULL) {
215 				cmdq_error(item, "width %s", errstr);
216 				goto fail;
217 			}
218 		}
219 	} else
220 		dsx = 80;
221 	if (args_has(args, 'y')) {
222 		tmp = args_get(args, 'y');
223 		if (strcmp(tmp, "-") == 0) {
224 			if (c != NULL)
225 				dsy = c->tty.sy;
226 			else
227 				dsy = 24;
228 		} else {
229 			dsy = strtonum(tmp, 1, USHRT_MAX, &errstr);
230 			if (errstr != NULL) {
231 				cmdq_error(item, "height %s", errstr);
232 				goto fail;
233 			}
234 		}
235 	} else
236 		dsy = 24;
237 
238 	/* Find new session size. */
239 	if (!detached && !is_control) {
240 		sx = c->tty.sx;
241 		sy = c->tty.sy;
242 		if (sy > 0 && options_get_number(global_s_options, "status"))
243 			sy--;
244 	} else {
245 		tmp = options_get_string(global_s_options, "default-size");
246 		if (sscanf(tmp, "%ux%u", &sx, &sy) != 2) {
247 			sx = dsx;
248 			sy = dsy;
249 		} else {
250 			if (args_has(args, 'x'))
251 				sx = dsx;
252 			if (args_has(args, 'y'))
253 				sy = dsy;
254 		}
255 	}
256 	if (sx == 0)
257 		sx = 1;
258 	if (sy == 0)
259 		sy = 1;
260 
261 	/* Create the new session. */
262 	oo = options_create(global_s_options);
263 	if (args_has(args, 'x') || args_has(args, 'y')) {
264 		if (!args_has(args, 'x'))
265 			dsx = sx;
266 		if (!args_has(args, 'y'))
267 			dsy = sy;
268 		options_set_string(oo, "default-size", 0, "%ux%u", dsx, dsy);
269 	}
270 	env = environ_create();
271 	if (c != NULL && !args_has(args, 'E'))
272 		environ_update(global_s_options, c->environ, env);
273 	av = args_first_value(args, 'e');
274 	while (av != NULL) {
275 		environ_put(env, av->string, 0);
276 		av = args_next_value(av);
277 	}
278 	s = session_create(prefix, newname, cwd, env, oo, tiop);
279 
280 	/* Spawn the initial window. */
281 	sc.item = item;
282 	sc.s = s;
283 	if (!detached)
284 		sc.tc = c;
285 
286 	sc.name = args_get(args, 'n');
287 	args_to_vector(args, &sc.argc, &sc.argv);
288 
289 	sc.idx = -1;
290 	sc.cwd = args_get(args, 'c');
291 
292 	sc.flags = 0;
293 
294 	if (spawn_window(&sc, &cause) == NULL) {
295 		session_destroy(s, 0, __func__);
296 		cmdq_error(item, "create window failed: %s", cause);
297 		free(cause);
298 		goto fail;
299 	}
300 
301 	/*
302 	 * If a target session is given, this is to be part of a session group,
303 	 * so add it to the group and synchronize.
304 	 */
305 	if (group != NULL) {
306 		if (sg == NULL) {
307 			if (groupwith != NULL) {
308 				sg = session_group_new(groupwith->name);
309 				session_group_add(sg, groupwith);
310 			} else
311 				sg = session_group_new(group);
312 		}
313 		session_group_add(sg, s);
314 		session_group_synchronize_to(s);
315 		session_select(s, RB_MIN(winlinks, &s->windows)->idx);
316 	}
317 	notify_session("session-created", s);
318 
319 	/*
320 	 * Set the client to the new session. If a command client exists, it is
321 	 * taking this session and needs to get MSG_READY and stay around.
322 	 */
323 	if (!detached) {
324 		if (args_has(args, 'f'))
325 			server_client_set_flags(c, args_get(args, 'f'));
326 		if (!already_attached) {
327 			if (~c->flags & CLIENT_CONTROL)
328 				proc_send(c->peer, MSG_READY, -1, NULL, 0);
329 		} else if (c->session != NULL)
330 			c->last_session = c->session;
331 		server_client_set_session(c, s);
332 		if (~cmdq_get_flags(item) & CMDQ_STATE_REPEAT)
333 			server_client_set_key_table(c, NULL);
334 	}
335 
336 	/* Print if requested. */
337 	if (args_has(args, 'P')) {
338 		if ((template = args_get(args, 'F')) == NULL)
339 			template = NEW_SESSION_TEMPLATE;
340 		cp = format_single(item, template, c, s, s->curw, NULL);
341 		cmdq_print(item, "%s", cp);
342 		free(cp);
343 	}
344 
345 	if (!detached)
346 		c->flags |= CLIENT_ATTACHED;
347 	if (!args_has(args, 'd'))
348 		cmd_find_from_session(current, s, 0);
349 
350 	cmd_find_from_session(&fs, s, 0);
351 	cmdq_insert_hook(s, item, &fs, "after-new-session");
352 
353 	if (cfg_finished)
354 		cfg_show_causes(s);
355 
356 	if (sc.argv != NULL)
357 		cmd_free_argv(sc.argc, sc.argv);
358 	free(cwd);
359 	free(newname);
360 	free(prefix);
361 	return (CMD_RETURN_NORMAL);
362 
363 fail:
364 	if (sc.argv != NULL)
365 		cmd_free_argv(sc.argc, sc.argv);
366 	free(cwd);
367 	free(newname);
368 	free(prefix);
369 	return (CMD_RETURN_ERROR);
370 }
371