xref: /openbsd-src/usr.bin/tmux/cmd-new-session.c (revision 6a13ef69787db04ae501a22e92fa10865b44fd7c)
1 /* $OpenBSD: cmd-new-session.c,v 1.96 2017/01/13 11:56:43 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;
72 	struct session		*groupwith = item->state.tflag.s;
73 	struct window		*w;
74 	struct environ		*env;
75 	struct termios		 tio, *tiop;
76 	const char		*newname, *target, *update, *errstr, *template;
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 	if ((target = args_get(args, 't')) != NULL) {
123 		if (groupwith == NULL) {
124 			cmdq_error(item, "no such session: %s", target);
125 			goto error;
126 		}
127 	} else
128 		groupwith = NULL;
129 
130 	/* Set -d if no client. */
131 	detached = args_has(args, 'd');
132 	if (c == NULL)
133 		detached = 1;
134 
135 	/* Is this client already attached? */
136 	already_attached = 0;
137 	if (c != NULL && c->session != NULL)
138 		already_attached = 1;
139 
140 	/* Get the new session working directory. */
141 	if (args_has(args, 'c')) {
142 		ft = format_create(item, 0);
143 		format_defaults(ft, c, NULL, NULL, NULL);
144 		to_free = cwd = format_expand(ft, args_get(args, 'c'));
145 		format_free(ft);
146 	} else if (c != NULL && c->session == NULL && c->cwd != NULL)
147 		cwd = c->cwd;
148 	else
149 		cwd = ".";
150 
151 	/*
152 	 * If this is a new client, check for nesting and save the termios
153 	 * settings (part of which is used for new windows in this session).
154 	 *
155 	 * tcgetattr() is used rather than using tty.tio since if the client is
156 	 * detached, tty_open won't be called. It must be done before opening
157 	 * the terminal as that calls tcsetattr() to prepare for tmux taking
158 	 * over.
159 	 */
160 	if (!detached && !already_attached && c->tty.fd != -1) {
161 		if (server_client_check_nested(item->client)) {
162 			cmdq_error(item, "sessions should be nested with care, "
163 			    "unset $TMUX to force");
164 			return (CMD_RETURN_ERROR);
165 		}
166 		if (tcgetattr(c->tty.fd, &tio) != 0)
167 			fatal("tcgetattr failed");
168 		tiop = &tio;
169 	} else
170 		tiop = NULL;
171 
172 	/* Open the terminal if necessary. */
173 	if (!detached && !already_attached) {
174 		if (server_client_open(c, &cause) != 0) {
175 			cmdq_error(item, "open terminal failed: %s", cause);
176 			free(cause);
177 			goto error;
178 		}
179 	}
180 
181 	/* Find new session size. */
182 	if (c != NULL) {
183 		sx = c->tty.sx;
184 		sy = c->tty.sy;
185 	} else {
186 		sx = 80;
187 		sy = 24;
188 	}
189 	if (detached && args_has(args, 'x')) {
190 		sx = strtonum(args_get(args, 'x'), 1, USHRT_MAX, &errstr);
191 		if (errstr != NULL) {
192 			cmdq_error(item, "width %s", errstr);
193 			goto error;
194 		}
195 	}
196 	if (detached && args_has(args, 'y')) {
197 		sy = strtonum(args_get(args, 'y'), 1, USHRT_MAX, &errstr);
198 		if (errstr != NULL) {
199 			cmdq_error(item, "height %s", errstr);
200 			goto error;
201 		}
202 	}
203 	if (sy > 0 && options_get_number(global_s_options, "status"))
204 		sy--;
205 	if (sx == 0)
206 		sx = 1;
207 	if (sy == 0)
208 		sy = 1;
209 
210 	/* Figure out the command for the new window. */
211 	argc = -1;
212 	argv = NULL;
213 	if (!args_has(args, 't') && args->argc != 0) {
214 		argc = args->argc;
215 		argv = args->argv;
216 	} else if (groupwith == NULL) {
217 		cmd = options_get_string(global_s_options, "default-command");
218 		if (cmd != NULL && *cmd != '\0') {
219 			argc = 1;
220 			argv = (char **)&cmd;
221 		} else {
222 			argc = 0;
223 			argv = NULL;
224 		}
225 	}
226 
227 	path = NULL;
228 	if (c != NULL && c->session == NULL)
229 		envent = environ_find(c->environ, "PATH");
230 	else
231 		envent = environ_find(global_environ, "PATH");
232 	if (envent != NULL)
233 		path = envent->value;
234 
235 	/* Construct the environment. */
236 	env = environ_create();
237 	if (c != NULL && !args_has(args, 'E')) {
238 		update = options_get_string(global_s_options,
239 		    "update-environment");
240 		environ_update(update, c->environ, env);
241 	}
242 
243 	/* Create the new session. */
244 	idx = -1 - options_get_number(global_s_options, "base-index");
245 	s = session_create(newname, argc, argv, path, cwd, env, tiop, idx, sx,
246 	    sy, &cause);
247 	environ_free(env);
248 	if (s == NULL) {
249 		cmdq_error(item, "create session failed: %s", cause);
250 		free(cause);
251 		goto error;
252 	}
253 
254 	/* Set the initial window name if one given. */
255 	if (argc >= 0 && args_has(args, 'n')) {
256 		w = s->curw->window;
257 		window_set_name(w, args_get(args, 'n'));
258 		options_set_number(w->options, "automatic-rename", 0);
259 	}
260 
261 	/*
262 	 * If a target session is given, this is to be part of a session group,
263 	 * so add it to the group and synchronize.
264 	 */
265 	if (groupwith != NULL) {
266 		session_group_add(groupwith, s);
267 		session_group_synchronize_to(s);
268 		session_select(s, RB_MIN(winlinks, &s->windows)->idx);
269 	}
270 	notify_session("session-created", s);
271 
272 	/*
273 	 * Set the client to the new session. If a command client exists, it is
274 	 * taking this session and needs to get MSG_READY and stay around.
275 	 */
276 	if (!detached) {
277 		if (!already_attached) {
278 			if (~c->flags & CLIENT_CONTROL)
279 				proc_send(c->peer, MSG_READY, -1, NULL, 0);
280 		} else if (c->session != NULL)
281 			c->last_session = c->session;
282 		c->session = s;
283 		server_client_set_key_table(c, NULL);
284 		status_timer_start(c);
285 		notify_client("client-session-changed", c);
286 		session_update_activity(s, NULL);
287 		gettimeofday(&s->last_attached_time, NULL);
288 		server_redraw_client(c);
289 	}
290 	recalculate_sizes();
291 	server_update_socket();
292 
293 	/*
294 	 * If there are still configuration file errors to display, put the new
295 	 * session's current window into more mode and display them now.
296 	 */
297 	if (cfg_finished)
298 		cfg_show_causes(s);
299 
300 	/* Print if requested. */
301 	if (args_has(args, 'P')) {
302 		if ((template = args_get(args, 'F')) == NULL)
303 			template = NEW_SESSION_TEMPLATE;
304 
305 		ft = format_create(item, 0);
306 		format_defaults(ft, c, s, NULL, NULL);
307 
308 		cp = format_expand(ft, template);
309 		cmdq_print(item, "%s", cp);
310 		free(cp);
311 
312 		format_free(ft);
313 	}
314 
315 	if (!detached)
316 		c->flags |= CLIENT_ATTACHED;
317 
318 	if (to_free != NULL)
319 		free((void *)to_free);
320 
321 	cmd_find_from_session(&fs, s);
322 	hooks_insert(s->hooks, item, &fs, "after-new-session");
323 
324 	return (CMD_RETURN_NORMAL);
325 
326 error:
327 	if (to_free != NULL)
328 		free((void *)to_free);
329 	return (CMD_RETURN_ERROR);
330 }
331