xref: /openbsd-src/usr.bin/tmux/notify.c (revision 4e1ee0786f11cc571bd0be17d38e46f635c719fc)
1 /* $OpenBSD: notify.c,v 1.39 2021/08/12 08:10:20 nicm Exp $ */
2 
3 /*
4  * Copyright (c) 2012 George Nachman <tmux@georgester.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 #include <sys/queue.h>
21 
22 #include <stdlib.h>
23 #include <string.h>
24 
25 #include "tmux.h"
26 
27 struct notify_entry {
28 	const char		*name;
29 	struct cmd_find_state	 fs;
30 	struct format_tree	*formats;
31 
32 	struct client		*client;
33 	struct session		*session;
34 	struct window		*window;
35 	int			 pane;
36 };
37 
38 static void
39 notify_insert_hook(struct cmdq_item *item, struct notify_entry *ne)
40 {
41 	struct cmd_find_state		 fs;
42 	struct options			*oo;
43 	struct cmdq_item		*new_item;
44 	struct cmdq_state		*new_state;
45 	struct options_entry		*o;
46 	struct options_array_item	*a;
47 	struct cmd_list			*cmdlist;
48 
49 	log_debug("%s: %s", __func__, ne->name);
50 
51 	cmd_find_clear_state(&fs, 0);
52 	if (cmd_find_empty_state(&ne->fs) || !cmd_find_valid_state(&ne->fs))
53 		cmd_find_from_nothing(&fs, 0);
54 	else
55 		cmd_find_copy_state(&fs, &ne->fs);
56 
57 	if (fs.s == NULL)
58 		oo = global_s_options;
59 	else
60 		oo = fs.s->options;
61 	o = options_get(oo, ne->name);
62 	if (o == NULL && fs.wp != NULL) {
63 		oo = fs.wp->options;
64 		o = options_get(oo, ne->name);
65 	}
66 	if (o == NULL && fs.wl != NULL) {
67 		oo = fs.wl->window->options;
68 		o = options_get(oo, ne->name);
69 	}
70 	if (o == NULL)
71 		return;
72 
73 	new_state = cmdq_new_state(&fs, NULL, CMDQ_STATE_NOHOOKS);
74 	cmdq_add_formats(new_state, ne->formats);
75 
76 	a = options_array_first(o);
77 	while (a != NULL) {
78 		cmdlist = options_array_item_value(a)->cmdlist;
79 		if (cmdlist != NULL) {
80 			new_item = cmdq_get_command(cmdlist, new_state);
81 			item = cmdq_insert_after(item, new_item);
82 		}
83 		a = options_array_next(a);
84 	}
85 
86 	cmdq_free_state(new_state);
87 }
88 
89 static enum cmd_retval
90 notify_callback(struct cmdq_item *item, void *data)
91 {
92 	struct notify_entry	*ne = data;
93 
94 	log_debug("%s: %s", __func__, ne->name);
95 
96 	if (strcmp(ne->name, "pane-mode-changed") == 0)
97 		control_notify_pane_mode_changed(ne->pane);
98 	if (strcmp(ne->name, "window-layout-changed") == 0)
99 		control_notify_window_layout_changed(ne->window);
100 	if (strcmp(ne->name, "window-pane-changed") == 0)
101 		control_notify_window_pane_changed(ne->window);
102 	if (strcmp(ne->name, "window-unlinked") == 0)
103 		control_notify_window_unlinked(ne->session, ne->window);
104 	if (strcmp(ne->name, "window-linked") == 0)
105 		control_notify_window_linked(ne->session, ne->window);
106 	if (strcmp(ne->name, "window-renamed") == 0)
107 		control_notify_window_renamed(ne->window);
108 	if (strcmp(ne->name, "client-session-changed") == 0)
109 		control_notify_client_session_changed(ne->client);
110 	if (strcmp(ne->name, "client-detached") == 0)
111 		control_notify_client_detached(ne->client);
112 	if (strcmp(ne->name, "session-renamed") == 0)
113 		control_notify_session_renamed(ne->session);
114 	if (strcmp(ne->name, "session-created") == 0)
115 		control_notify_session_created(ne->session);
116 	if (strcmp(ne->name, "session-closed") == 0)
117 		control_notify_session_closed(ne->session);
118 	if (strcmp(ne->name, "session-window-changed") == 0)
119 		control_notify_session_window_changed(ne->session);
120 
121 	notify_insert_hook(item, ne);
122 
123 	if (ne->client != NULL)
124 		server_client_unref(ne->client);
125 	if (ne->session != NULL)
126 		session_remove_ref(ne->session, __func__);
127 	if (ne->window != NULL)
128 		window_remove_ref(ne->window, __func__);
129 
130 	if (ne->fs.s != NULL)
131 		session_remove_ref(ne->fs.s, __func__);
132 
133 	format_free(ne->formats);
134 	free((void *)ne->name);
135 	free(ne);
136 
137 	return (CMD_RETURN_NORMAL);
138 }
139 
140 static void
141 notify_add(const char *name, struct cmd_find_state *fs, struct client *c,
142     struct session *s, struct window *w, struct window_pane *wp)
143 {
144 	struct notify_entry	*ne;
145 	struct cmdq_item	*item;
146 
147 	item = cmdq_running(NULL);
148 	if (item != NULL && (cmdq_get_flags(item) & CMDQ_STATE_NOHOOKS))
149 		return;
150 
151 	ne = xcalloc(1, sizeof *ne);
152 	ne->name = xstrdup(name);
153 
154 	ne->client = c;
155 	ne->session = s;
156 	ne->window = w;
157 	ne->pane = (wp != NULL ? wp->id : -1);
158 
159 	ne->formats = format_create(NULL, NULL, 0, FORMAT_NOJOBS);
160 	format_add(ne->formats, "hook", "%s", name);
161 	if (c != NULL)
162 		format_add(ne->formats, "hook_client", "%s", c->name);
163 	if (s != NULL) {
164 		format_add(ne->formats, "hook_session", "$%u", s->id);
165 		format_add(ne->formats, "hook_session_name", "%s", s->name);
166 	}
167 	if (w != NULL) {
168 		format_add(ne->formats, "hook_window", "@%u", w->id);
169 		format_add(ne->formats, "hook_window_name", "%s", w->name);
170 	}
171 	if (wp != NULL)
172 		format_add(ne->formats, "hook_pane", "%%%d", wp->id);
173 	format_log_debug(ne->formats, __func__);
174 
175 	if (c != NULL)
176 		c->references++;
177 	if (s != NULL)
178 		session_add_ref(s, __func__);
179 	if (w != NULL)
180 		window_add_ref(w, __func__);
181 
182 	cmd_find_copy_state(&ne->fs, fs);
183 	if (ne->fs.s != NULL) /* cmd_find_valid_state needs session */
184 		session_add_ref(ne->fs.s, __func__);
185 
186 	cmdq_append(NULL, cmdq_get_callback(notify_callback, ne));
187 }
188 
189 void
190 notify_hook(struct cmdq_item *item, const char *name)
191 {
192 	struct cmd_find_state	*target = cmdq_get_target(item);
193 	struct notify_entry	 ne;
194 
195 	memset(&ne, 0, sizeof ne);
196 
197 	ne.name = name;
198 	cmd_find_copy_state(&ne.fs, target);
199 
200 	ne.client = cmdq_get_client(item);
201 	ne.session = target->s;
202 	ne.window = target->w;
203 	ne.pane = (target->wp != NULL ? target->wp->id : -1);
204 
205 	ne.formats = format_create(NULL, NULL, 0, FORMAT_NOJOBS);
206 	format_add(ne.formats, "hook", "%s", name);
207 	format_log_debug(ne.formats, __func__);
208 
209 	notify_insert_hook(item, &ne);
210 	format_free(ne.formats);
211 }
212 
213 void
214 notify_client(const char *name, struct client *c)
215 {
216 	struct cmd_find_state	fs;
217 
218 	cmd_find_from_client(&fs, c, 0);
219 	notify_add(name, &fs, c, NULL, NULL, NULL);
220 }
221 
222 void
223 notify_session(const char *name, struct session *s)
224 {
225 	struct cmd_find_state	fs;
226 
227 	if (session_alive(s))
228 		cmd_find_from_session(&fs, s, 0);
229 	else
230 		cmd_find_from_nothing(&fs, 0);
231 	notify_add(name, &fs, NULL, s, NULL, NULL);
232 }
233 
234 void
235 notify_winlink(const char *name, struct winlink *wl)
236 {
237 	struct cmd_find_state	fs;
238 
239 	cmd_find_from_winlink(&fs, wl, 0);
240 	notify_add(name, &fs, NULL, wl->session, wl->window, NULL);
241 }
242 
243 void
244 notify_session_window(const char *name, struct session *s, struct window *w)
245 {
246 	struct cmd_find_state	fs;
247 
248 	cmd_find_from_session_window(&fs, s, w, 0);
249 	notify_add(name, &fs, NULL, s, w, NULL);
250 }
251 
252 void
253 notify_window(const char *name, struct window *w)
254 {
255 	struct cmd_find_state	fs;
256 
257 	cmd_find_from_window(&fs, w, 0);
258 	notify_add(name, &fs, NULL, NULL, w, NULL);
259 }
260 
261 void
262 notify_pane(const char *name, struct window_pane *wp)
263 {
264 	struct cmd_find_state	fs;
265 
266 	cmd_find_from_pane(&fs, wp, 0);
267 	notify_add(name, &fs, NULL, NULL, NULL, wp);
268 }
269