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