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