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