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