xref: /openbsd-src/usr.bin/tmux/cfg.c (revision 25c4e8bd056e974b28f4a0ffd39d76c190a56013)
1 /* $OpenBSD: cfg.c,v 1.86 2022/06/20 07:59:37 nicm Exp $ */
2 
3 /*
4  * Copyright (c) 2008 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 <ctype.h>
22 #include <errno.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <util.h>
27 
28 #include "tmux.h"
29 
30 struct client		 *cfg_client;
31 int			  cfg_finished;
32 static char		**cfg_causes;
33 static u_int		  cfg_ncauses;
34 static struct cmdq_item	 *cfg_item;
35 
36 int                       cfg_quiet = 1;
37 char                    **cfg_files;
38 u_int                     cfg_nfiles;
39 
40 static enum cmd_retval
41 cfg_client_done(__unused struct cmdq_item *item, __unused void *data)
42 {
43 	if (!cfg_finished)
44 		return (CMD_RETURN_WAIT);
45 	return (CMD_RETURN_NORMAL);
46 }
47 
48 static enum cmd_retval
49 cfg_done(__unused struct cmdq_item *item, __unused void *data)
50 {
51 	if (cfg_finished)
52 		return (CMD_RETURN_NORMAL);
53 	cfg_finished = 1;
54 
55 	cfg_show_causes(NULL);
56 
57 	if (cfg_item != NULL)
58 		cmdq_continue(cfg_item);
59 
60 	status_prompt_load_history();
61 
62 	return (CMD_RETURN_NORMAL);
63 }
64 
65 void
66 start_cfg(void)
67 {
68 	struct client	 *c;
69 	u_int		  i;
70 
71 	/*
72 	 * Configuration files are loaded without a client, so commands are run
73 	 * in the global queue with item->client NULL.
74 	 *
75 	 * However, we must block the initial client (but just the initial
76 	 * client) so that its command runs after the configuration is loaded.
77 	 * Because start_cfg() is called so early, we can be sure the client's
78 	 * command queue is currently empty and our callback will be at the
79 	 * front - we need to get in before MSG_COMMAND.
80 	 */
81 	cfg_client = c = TAILQ_FIRST(&clients);
82 	if (c != NULL) {
83 		cfg_item = cmdq_get_callback(cfg_client_done, NULL);
84 		cmdq_append(c, cfg_item);
85 	}
86 
87 	for (i = 0; i < cfg_nfiles; i++) {
88 		if (cfg_quiet)
89 			load_cfg(cfg_files[i], c, NULL, CMD_PARSE_QUIET, NULL);
90 		else
91 			load_cfg(cfg_files[i], c, NULL, 0, NULL);
92 	}
93 
94 	cmdq_append(NULL, cmdq_get_callback(cfg_done, NULL));
95 }
96 
97 int
98 load_cfg(const char *path, struct client *c, struct cmdq_item *item, int flags,
99     struct cmdq_item **new_item)
100 {
101 	FILE			*f;
102 	struct cmd_parse_input	 pi;
103 	struct cmd_parse_result	*pr;
104 	struct cmdq_item	*new_item0;
105 	struct cmdq_state	*state;
106 
107 	if (new_item != NULL)
108 		*new_item = NULL;
109 
110 	log_debug("loading %s", path);
111 	if ((f = fopen(path, "rb")) == NULL) {
112 		if (errno == ENOENT && (flags & CMD_PARSE_QUIET))
113 			return (0);
114 		cfg_add_cause("%s: %s", path, strerror(errno));
115 		return (-1);
116 	}
117 
118 	memset(&pi, 0, sizeof pi);
119 	pi.flags = flags;
120 	pi.file = path;
121 	pi.line = 1;
122 	pi.item = item;
123 	pi.c = c;
124 
125 	pr = cmd_parse_from_file(f, &pi);
126 	fclose(f);
127 	if (pr->status == CMD_PARSE_ERROR) {
128 		cfg_add_cause("%s", pr->error);
129 		free(pr->error);
130 		return (-1);
131 	}
132 	if (flags & CMD_PARSE_PARSEONLY) {
133 		cmd_list_free(pr->cmdlist);
134 		return (0);
135 	}
136 
137 	if (item != NULL)
138 		state = cmdq_copy_state(cmdq_get_state(item));
139 	else
140 		state = cmdq_new_state(NULL, NULL, 0);
141 	cmdq_add_format(state, "current_file", "%s", pi.file);
142 
143 	new_item0 = cmdq_get_command(pr->cmdlist, state);
144 	if (item != NULL)
145 		new_item0 = cmdq_insert_after(item, new_item0);
146 	else
147 		new_item0 = cmdq_append(NULL, new_item0);
148 	cmd_list_free(pr->cmdlist);
149 	cmdq_free_state(state);
150 
151 	if (new_item != NULL)
152 		*new_item = new_item0;
153 	return (0);
154 }
155 
156 int
157 load_cfg_from_buffer(const void *buf, size_t len, const char *path,
158     struct client *c, struct cmdq_item *item, int flags,
159     struct cmdq_item **new_item)
160 {
161 	struct cmd_parse_input	 pi;
162 	struct cmd_parse_result	*pr;
163 	struct cmdq_item	*new_item0;
164 	struct cmdq_state	*state;
165 
166 	if (new_item != NULL)
167 		*new_item = NULL;
168 
169 	log_debug("loading %s", path);
170 
171 	memset(&pi, 0, sizeof pi);
172 	pi.flags = flags;
173 	pi.file = path;
174 	pi.line = 1;
175 	pi.item = item;
176 	pi.c = c;
177 
178 	pr = cmd_parse_from_buffer(buf, len, &pi);
179 	if (pr->status == CMD_PARSE_ERROR) {
180 		cfg_add_cause("%s", pr->error);
181 		free(pr->error);
182 		return (-1);
183 	}
184 	if (flags & CMD_PARSE_PARSEONLY) {
185 		cmd_list_free(pr->cmdlist);
186 		return (0);
187 	}
188 
189 	if (item != NULL)
190 		state = cmdq_copy_state(cmdq_get_state(item));
191 	else
192 		state = cmdq_new_state(NULL, NULL, 0);
193 	cmdq_add_format(state, "current_file", "%s", pi.file);
194 
195 	new_item0 = cmdq_get_command(pr->cmdlist, state);
196 	if (item != NULL)
197 		new_item0 = cmdq_insert_after(item, new_item0);
198 	else
199 		new_item0 = cmdq_append(NULL, new_item0);
200 	cmd_list_free(pr->cmdlist);
201 	cmdq_free_state(state);
202 
203 	if (new_item != NULL)
204 		*new_item = new_item0;
205 	return (0);
206 }
207 
208 void
209 cfg_add_cause(const char *fmt, ...)
210 {
211 	va_list	 ap;
212 	char	*msg;
213 
214 	va_start(ap, fmt);
215 	xvasprintf(&msg, fmt, ap);
216 	va_end(ap);
217 
218 	cfg_ncauses++;
219 	cfg_causes = xreallocarray(cfg_causes, cfg_ncauses, sizeof *cfg_causes);
220 	cfg_causes[cfg_ncauses - 1] = msg;
221 }
222 
223 void
224 cfg_print_causes(struct cmdq_item *item)
225 {
226 	u_int	 i;
227 
228 	for (i = 0; i < cfg_ncauses; i++) {
229 		cmdq_print(item, "%s", cfg_causes[i]);
230 		free(cfg_causes[i]);
231 	}
232 
233 	free(cfg_causes);
234 	cfg_causes = NULL;
235 	cfg_ncauses = 0;
236 }
237 
238 void
239 cfg_show_causes(struct session *s)
240 {
241 	struct client			*c = TAILQ_FIRST(&clients);
242 	struct window_pane		*wp;
243 	struct window_mode_entry	*wme;
244 	u_int				 i;
245 
246 	if (cfg_ncauses == 0)
247 		return;
248 
249 	if (c != NULL && (c->flags & CLIENT_CONTROL)) {
250 		for (i = 0; i < cfg_ncauses; i++) {
251 			control_write(c, "%%config-error %s", cfg_causes[i]);
252 			free(cfg_causes[i]);
253 		}
254 		goto out;
255 	}
256 
257 	if (s == NULL) {
258 		if (c != NULL && c->session != NULL)
259 			s = c->session;
260 		else
261 			s = RB_MIN(sessions, &sessions);
262 	}
263 	if (s == NULL || s->attached == 0) /* wait for an attached session */
264 		return;
265 	wp = s->curw->window->active;
266 
267 	wme = TAILQ_FIRST(&wp->modes);
268 	if (wme == NULL || wme->mode != &window_view_mode)
269 		window_pane_set_mode(wp, NULL, &window_view_mode, NULL, NULL);
270 	for (i = 0; i < cfg_ncauses; i++) {
271 		window_copy_add(wp, 0, "%s", cfg_causes[i]);
272 		free(cfg_causes[i]);
273 	}
274 
275 out:
276 	free(cfg_causes);
277 	cfg_causes = NULL;
278 	cfg_ncauses = 0;
279 }
280