]> git.sur5r.net Git - i3/i3/blob - src/ipc.c
Implement i3's logic for maintaining a list of 'bindsym' directives and passing it...
[i3/i3] / src / ipc.c
1 #undef I3__FILE__
2 #define I3__FILE__ "ipc.c"
3 /*
4  * vim:ts=4:sw=4:expandtab
5  *
6  * i3 - an improved dynamic tiling window manager
7  * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
8  *
9  * ipc.c: UNIX domain socket IPC (initialization, client handling, protocol).
10  *
11  */
12 #include "all.h"
13 #include "yajl_utils.h"
14
15 #include <sys/socket.h>
16 #include <sys/un.h>
17 #include <fcntl.h>
18 #include <libgen.h>
19 #include <ev.h>
20 #include <yajl/yajl_gen.h>
21 #include <yajl/yajl_parse.h>
22
23 char *current_socketpath = NULL;
24
25 TAILQ_HEAD(ipc_client_head, ipc_client) all_clients = TAILQ_HEAD_INITIALIZER(all_clients);
26
27 /*
28  * Puts the given socket file descriptor into non-blocking mode or dies if
29  * setting O_NONBLOCK failed. Non-blocking sockets are a good idea for our
30  * IPC model because we should by no means block the window manager.
31  *
32  */
33 static void set_nonblock(int sockfd) {
34     int flags = fcntl(sockfd, F_GETFL, 0);
35     flags |= O_NONBLOCK;
36     if (fcntl(sockfd, F_SETFL, flags) < 0)
37         err(-1, "Could not set O_NONBLOCK");
38 }
39
40 /*
41  * Sends the specified event to all IPC clients which are currently connected
42  * and subscribed to this kind of event.
43  *
44  */
45 void ipc_send_event(const char *event, uint32_t message_type, const char *payload) {
46     ipc_client *current;
47     TAILQ_FOREACH(current, &all_clients, clients) {
48         /* see if this client is interested in this event */
49         bool interested = false;
50         for (int i = 0; i < current->num_events; i++) {
51             if (strcasecmp(current->events[i], event) != 0)
52                 continue;
53             interested = true;
54             break;
55         }
56         if (!interested)
57             continue;
58
59         ipc_send_message(current->fd, strlen(payload), message_type, (const uint8_t *)payload);
60     }
61 }
62
63 /*
64  * Calls shutdown() on each socket and closes it. This function to be called
65  * when exiting or restarting only!
66  *
67  */
68 void ipc_shutdown(void) {
69     ipc_client *current;
70     while (!TAILQ_EMPTY(&all_clients)) {
71         current = TAILQ_FIRST(&all_clients);
72         shutdown(current->fd, SHUT_RDWR);
73         close(current->fd);
74         TAILQ_REMOVE(&all_clients, current, clients);
75         free(current);
76     }
77 }
78
79 /*
80  * Executes the command and returns whether it could be successfully parsed
81  * or not (at the moment, always returns true).
82  *
83  */
84 IPC_HANDLER(command) {
85     /* To get a properly terminated buffer, we copy
86      * message_size bytes out of the buffer */
87     char *command = scalloc(message_size + 1);
88     strncpy(command, (const char *)message, message_size);
89     LOG("IPC: received: *%s*\n", command);
90     yajl_gen gen = yajl_gen_alloc(NULL);
91
92     CommandResult *result = parse_command((const char *)command, gen);
93     free(command);
94
95     if (result->needs_tree_render)
96         tree_render();
97
98     command_result_free(result);
99
100     const unsigned char *reply;
101     ylength length;
102     yajl_gen_get_buf(gen, &reply, &length);
103
104     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_COMMAND,
105                      (const uint8_t *)reply);
106
107     yajl_gen_free(gen);
108 }
109
110 static void dump_rect(yajl_gen gen, const char *name, Rect r) {
111     ystr(name);
112     y(map_open);
113     ystr("x");
114     y(integer, r.x);
115     ystr("y");
116     y(integer, r.y);
117     ystr("width");
118     y(integer, r.width);
119     ystr("height");
120     y(integer, r.height);
121     y(map_close);
122 }
123
124 static void dump_binding(yajl_gen gen, Binding *bind) {
125     y(map_open);
126     ystr("input_code");
127     y(integer, bind->keycode);
128
129     ystr("input_type");
130     ystr((const char *)(bind->input_type == B_KEYBOARD ? "keyboard" : "mouse"));
131
132     ystr("symbol");
133     if (bind->symbol == NULL)
134         y(null);
135     else
136         ystr(bind->symbol);
137
138     ystr("command");
139     ystr(bind->command);
140
141     ystr("mods");
142     y(array_open);
143     for (int i = 0; i < 8; i++) {
144         if (bind->mods & (1 << i)) {
145             switch (1 << i) {
146                 case XCB_MOD_MASK_SHIFT:
147                     ystr("shift");
148                     break;
149                 case XCB_MOD_MASK_LOCK:
150                     ystr("lock");
151                     break;
152                 case XCB_MOD_MASK_CONTROL:
153                     ystr("ctrl");
154                     break;
155                 case XCB_MOD_MASK_1:
156                     ystr("Mod1");
157                     break;
158                 case XCB_MOD_MASK_2:
159                     ystr("Mod2");
160                     break;
161                 case XCB_MOD_MASK_3:
162                     ystr("Mod3");
163                     break;
164                 case XCB_MOD_MASK_4:
165                     ystr("Mod4");
166                     break;
167                 case XCB_MOD_MASK_5:
168                     ystr("Mod5");
169                     break;
170             }
171         }
172     }
173     y(array_close);
174
175     y(map_close);
176 }
177
178 void dump_node(yajl_gen gen, struct Con *con, bool inplace_restart) {
179     y(map_open);
180     ystr("id");
181     y(integer, (long int)con);
182
183     ystr("type");
184     switch (con->type) {
185         case CT_ROOT:
186             ystr("root");
187             break;
188         case CT_OUTPUT:
189             ystr("output");
190             break;
191         case CT_CON:
192             ystr("con");
193             break;
194         case CT_FLOATING_CON:
195             ystr("floating_con");
196             break;
197         case CT_WORKSPACE:
198             ystr("workspace");
199             break;
200         case CT_DOCKAREA:
201             ystr("dockarea");
202             break;
203         default:
204             DLOG("About to dump unknown container type=%d. This is a bug.\n", con->type);
205             assert(false);
206             break;
207     }
208
209     /* provided for backwards compatibility only. */
210     ystr("orientation");
211     if (!con_is_split(con))
212         ystr("none");
213     else {
214         if (con_orientation(con) == HORIZ)
215             ystr("horizontal");
216         else
217             ystr("vertical");
218     }
219
220     ystr("scratchpad_state");
221     switch (con->scratchpad_state) {
222         case SCRATCHPAD_NONE:
223             ystr("none");
224             break;
225         case SCRATCHPAD_FRESH:
226             ystr("fresh");
227             break;
228         case SCRATCHPAD_CHANGED:
229             ystr("changed");
230             break;
231     }
232
233     ystr("percent");
234     if (con->percent == 0.0)
235         y(null);
236     else
237         y(double, con->percent);
238
239     ystr("urgent");
240     y(bool, con->urgent);
241
242     if (con->mark != NULL) {
243         ystr("mark");
244         ystr(con->mark);
245     }
246
247     ystr("focused");
248     y(bool, (con == focused));
249
250     ystr("layout");
251     switch (con->layout) {
252         case L_DEFAULT:
253             DLOG("About to dump layout=default, this is a bug in the code.\n");
254             assert(false);
255             break;
256         case L_SPLITV:
257             ystr("splitv");
258             break;
259         case L_SPLITH:
260             ystr("splith");
261             break;
262         case L_STACKED:
263             ystr("stacked");
264             break;
265         case L_TABBED:
266             ystr("tabbed");
267             break;
268         case L_DOCKAREA:
269             ystr("dockarea");
270             break;
271         case L_OUTPUT:
272             ystr("output");
273             break;
274     }
275
276     ystr("workspace_layout");
277     switch (con->workspace_layout) {
278         case L_DEFAULT:
279             ystr("default");
280             break;
281         case L_STACKED:
282             ystr("stacked");
283             break;
284         case L_TABBED:
285             ystr("tabbed");
286             break;
287         default:
288             DLOG("About to dump workspace_layout=%d (none of default/stacked/tabbed), this is a bug.\n", con->workspace_layout);
289             assert(false);
290             break;
291     }
292
293     ystr("last_split_layout");
294     switch (con->layout) {
295         case L_SPLITV:
296             ystr("splitv");
297             break;
298         default:
299             ystr("splith");
300             break;
301     }
302
303     ystr("border");
304     switch (con->border_style) {
305         case BS_NORMAL:
306             ystr("normal");
307             break;
308         case BS_NONE:
309             ystr("none");
310             break;
311         case BS_PIXEL:
312             ystr("pixel");
313             break;
314     }
315
316     ystr("current_border_width");
317     y(integer, con->current_border_width);
318
319     dump_rect(gen, "rect", con->rect);
320     dump_rect(gen, "deco_rect", con->deco_rect);
321     dump_rect(gen, "window_rect", con->window_rect);
322     dump_rect(gen, "geometry", con->geometry);
323
324     ystr("name");
325     if (con->window && con->window->name)
326         ystr(i3string_as_utf8(con->window->name));
327     else if (con->name != NULL)
328         ystr(con->name);
329     else
330         y(null);
331
332     if (con->type == CT_WORKSPACE) {
333         ystr("num");
334         y(integer, con->num);
335     }
336
337     ystr("window");
338     if (con->window)
339         y(integer, con->window->id);
340     else
341         y(null);
342
343     if (con->window && !inplace_restart) {
344         /* Window properties are useless to preserve when restarting because
345          * they will be queried again anyway. However, for i3-save-tree(1),
346          * they are very useful and save i3-save-tree dealing with X11. */
347         ystr("window_properties");
348         y(map_open);
349
350 #define DUMP_PROPERTY(key, prop_name)         \
351     do {                                      \
352         if (con->window->prop_name != NULL) { \
353             ystr(key);                        \
354             ystr(con->window->prop_name);     \
355         }                                     \
356     } while (0)
357
358         DUMP_PROPERTY("class", class_class);
359         DUMP_PROPERTY("instance", class_instance);
360         DUMP_PROPERTY("window_role", role);
361
362         if (con->window->name != NULL) {
363             ystr("title");
364             ystr(i3string_as_utf8(con->window->name));
365         }
366
367         ystr("transient_for");
368         if (con->window->transient_for == XCB_NONE)
369             y(null);
370         else
371             y(integer, con->window->transient_for);
372
373         y(map_close);
374     }
375
376     ystr("nodes");
377     y(array_open);
378     Con *node;
379     if (con->type != CT_DOCKAREA || !inplace_restart) {
380         TAILQ_FOREACH(node, &(con->nodes_head), nodes) {
381             dump_node(gen, node, inplace_restart);
382         }
383     }
384     y(array_close);
385
386     ystr("floating_nodes");
387     y(array_open);
388     TAILQ_FOREACH(node, &(con->floating_head), floating_windows) {
389         dump_node(gen, node, inplace_restart);
390     }
391     y(array_close);
392
393     ystr("focus");
394     y(array_open);
395     TAILQ_FOREACH(node, &(con->focus_head), focused) {
396         y(integer, (long int)node);
397     }
398     y(array_close);
399
400     ystr("fullscreen_mode");
401     y(integer, con->fullscreen_mode);
402
403     ystr("floating");
404     switch (con->floating) {
405         case FLOATING_AUTO_OFF:
406             ystr("auto_off");
407             break;
408         case FLOATING_AUTO_ON:
409             ystr("auto_on");
410             break;
411         case FLOATING_USER_OFF:
412             ystr("user_off");
413             break;
414         case FLOATING_USER_ON:
415             ystr("user_on");
416             break;
417     }
418
419     ystr("swallows");
420     y(array_open);
421     Match *match;
422     TAILQ_FOREACH(match, &(con->swallow_head), matches) {
423         /* We will generate a new restart_mode match specification after this
424          * loop, so skip this one. */
425         if (match->restart_mode)
426             continue;
427         y(map_open);
428         if (match->dock != -1) {
429             ystr("dock");
430             y(integer, match->dock);
431             ystr("insert_where");
432             y(integer, match->insert_where);
433         }
434
435 #define DUMP_REGEX(re_name)                \
436     do {                                   \
437         if (match->re_name != NULL) {      \
438             ystr(#re_name);                \
439             ystr(match->re_name->pattern); \
440         }                                  \
441     } while (0)
442
443         DUMP_REGEX(class);
444         DUMP_REGEX(instance);
445         DUMP_REGEX(window_role);
446         DUMP_REGEX(title);
447
448 #undef DUMP_REGEX
449         y(map_close);
450     }
451
452     if (inplace_restart) {
453         if (con->window != NULL) {
454             y(map_open);
455             ystr("id");
456             y(integer, con->window->id);
457             ystr("restart_mode");
458             y(bool, true);
459             y(map_close);
460         }
461     }
462     y(array_close);
463
464     if (inplace_restart && con->window != NULL) {
465         ystr("depth");
466         y(integer, con->depth);
467     }
468
469     y(map_close);
470 }
471
472 static void dump_mouse_commands(yajl_gen gen, Barconfig *config) {
473     ystr("mouse_commands");
474     y(map_open);
475
476     struct Mousecommand *current;
477     TAILQ_FOREACH(current, &(config->mouse_commands), commands) {
478         ystr(current->button);
479         ystr(current->command);
480     }
481
482     y(map_close);
483 }
484
485 static void dump_bar_config(yajl_gen gen, Barconfig *config) {
486     y(map_open);
487
488     ystr("id");
489     ystr(config->id);
490
491     if (config->num_outputs > 0) {
492         ystr("outputs");
493         y(array_open);
494         for (int c = 0; c < config->num_outputs; c++)
495             ystr(config->outputs[c]);
496         y(array_close);
497     }
498
499 #define YSTR_IF_SET(name)       \
500     do {                        \
501         if (config->name) {     \
502             ystr(#name);        \
503             ystr(config->name); \
504         }                       \
505     } while (0)
506
507     YSTR_IF_SET(tray_output);
508     YSTR_IF_SET(socket_path);
509
510     ystr("mode");
511     switch (config->mode) {
512         case M_HIDE:
513             ystr("hide");
514             break;
515         case M_INVISIBLE:
516             ystr("invisible");
517             break;
518         case M_DOCK:
519         default:
520             ystr("dock");
521             break;
522     }
523
524     ystr("hidden_state");
525     switch (config->hidden_state) {
526         case S_SHOW:
527             ystr("show");
528             break;
529         case S_HIDE:
530         default:
531             ystr("hide");
532             break;
533     }
534
535     ystr("modifier");
536     switch (config->modifier) {
537         case M_CONTROL:
538             ystr("ctrl");
539             break;
540         case M_SHIFT:
541             ystr("shift");
542             break;
543         case M_MOD1:
544             ystr("Mod1");
545             break;
546         case M_MOD2:
547             ystr("Mod2");
548             break;
549         case M_MOD3:
550             ystr("Mod3");
551             break;
552         /*
553                case M_MOD4:
554                ystr("Mod4");
555                break;
556                */
557         case M_MOD5:
558             ystr("Mod5");
559             break;
560         default:
561             ystr("Mod4");
562             break;
563     }
564
565     dump_mouse_commands(gen, config);
566
567     ystr("position");
568     if (config->position == P_BOTTOM)
569         ystr("bottom");
570     else
571         ystr("top");
572
573     YSTR_IF_SET(status_command);
574     YSTR_IF_SET(font);
575
576     if (config->separator_symbol) {
577         ystr("separator_symbol");
578         ystr(config->separator_symbol);
579     }
580
581     ystr("workspace_buttons");
582     y(bool, !config->hide_workspace_buttons);
583
584     ystr("strip_workspace_numbers");
585     y(bool, config->strip_workspace_numbers);
586
587     ystr("binding_mode_indicator");
588     y(bool, !config->hide_binding_mode_indicator);
589
590     ystr("verbose");
591     y(bool, config->verbose);
592
593 #undef YSTR_IF_SET
594 #define YSTR_IF_SET(name)              \
595     do {                               \
596         if (config->colors.name) {     \
597             ystr(#name);               \
598             ystr(config->colors.name); \
599         }                              \
600     } while (0)
601
602     ystr("colors");
603     y(map_open);
604     YSTR_IF_SET(background);
605     YSTR_IF_SET(statusline);
606     YSTR_IF_SET(separator);
607     YSTR_IF_SET(focused_workspace_border);
608     YSTR_IF_SET(focused_workspace_bg);
609     YSTR_IF_SET(focused_workspace_text);
610     YSTR_IF_SET(active_workspace_border);
611     YSTR_IF_SET(active_workspace_bg);
612     YSTR_IF_SET(active_workspace_text);
613     YSTR_IF_SET(inactive_workspace_border);
614     YSTR_IF_SET(inactive_workspace_bg);
615     YSTR_IF_SET(inactive_workspace_text);
616     YSTR_IF_SET(urgent_workspace_border);
617     YSTR_IF_SET(urgent_workspace_bg);
618     YSTR_IF_SET(urgent_workspace_text);
619     YSTR_IF_SET(binding_mode_border);
620     YSTR_IF_SET(binding_mode_bg);
621     YSTR_IF_SET(binding_mode_text);
622     y(map_close);
623
624     y(map_close);
625 #undef YSTR_IF_SET
626 }
627
628 IPC_HANDLER(tree) {
629     setlocale(LC_NUMERIC, "C");
630     yajl_gen gen = ygenalloc();
631     dump_node(gen, croot, false);
632     setlocale(LC_NUMERIC, "");
633
634     const unsigned char *payload;
635     ylength length;
636     y(get_buf, &payload, &length);
637
638     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_TREE, payload);
639     y(free);
640 }
641
642 /*
643  * Formats the reply message for a GET_WORKSPACES request and sends it to the
644  * client
645  *
646  */
647 IPC_HANDLER(get_workspaces) {
648     yajl_gen gen = ygenalloc();
649     y(array_open);
650
651     Con *focused_ws = con_get_workspace(focused);
652
653     Con *output;
654     TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
655         if (con_is_internal(output))
656             continue;
657         Con *ws;
658         TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
659             assert(ws->type == CT_WORKSPACE);
660             y(map_open);
661
662             ystr("num");
663             y(integer, ws->num);
664
665             ystr("name");
666             ystr(ws->name);
667
668             ystr("visible");
669             y(bool, workspace_is_visible(ws));
670
671             ystr("focused");
672             y(bool, ws == focused_ws);
673
674             ystr("rect");
675             y(map_open);
676             ystr("x");
677             y(integer, ws->rect.x);
678             ystr("y");
679             y(integer, ws->rect.y);
680             ystr("width");
681             y(integer, ws->rect.width);
682             ystr("height");
683             y(integer, ws->rect.height);
684             y(map_close);
685
686             ystr("output");
687             ystr(output->name);
688
689             ystr("urgent");
690             y(bool, ws->urgent);
691
692             y(map_close);
693         }
694     }
695
696     y(array_close);
697
698     const unsigned char *payload;
699     ylength length;
700     y(get_buf, &payload, &length);
701
702     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_WORKSPACES, payload);
703     y(free);
704 }
705
706 /*
707  * Formats the reply message for a GET_OUTPUTS request and sends it to the
708  * client
709  *
710  */
711 IPC_HANDLER(get_outputs) {
712     yajl_gen gen = ygenalloc();
713     y(array_open);
714
715     Output *output;
716     TAILQ_FOREACH(output, &outputs, outputs) {
717         y(map_open);
718
719         ystr("name");
720         ystr(output->name);
721
722         ystr("active");
723         y(bool, output->active);
724
725         ystr("primary");
726         y(bool, output->primary);
727
728         ystr("rect");
729         y(map_open);
730         ystr("x");
731         y(integer, output->rect.x);
732         ystr("y");
733         y(integer, output->rect.y);
734         ystr("width");
735         y(integer, output->rect.width);
736         ystr("height");
737         y(integer, output->rect.height);
738         y(map_close);
739
740         ystr("current_workspace");
741         Con *ws = NULL;
742         if (output->con && (ws = con_get_fullscreen_con(output->con, CF_OUTPUT)))
743             ystr(ws->name);
744         else
745             y(null);
746
747         y(map_close);
748     }
749
750     y(array_close);
751
752     const unsigned char *payload;
753     ylength length;
754     y(get_buf, &payload, &length);
755
756     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_OUTPUTS, payload);
757     y(free);
758 }
759
760 /*
761  * Formats the reply message for a GET_MARKS request and sends it to the
762  * client
763  *
764  */
765 IPC_HANDLER(get_marks) {
766     yajl_gen gen = ygenalloc();
767     y(array_open);
768
769     Con *con;
770     TAILQ_FOREACH(con, &all_cons, all_cons)
771     if (con->mark != NULL)
772         ystr(con->mark);
773
774     y(array_close);
775
776     const unsigned char *payload;
777     ylength length;
778     y(get_buf, &payload, &length);
779
780     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_MARKS, payload);
781     y(free);
782 }
783
784 /*
785  * Returns the version of i3
786  *
787  */
788 IPC_HANDLER(get_version) {
789     yajl_gen gen = ygenalloc();
790     y(map_open);
791
792     ystr("major");
793     y(integer, MAJOR_VERSION);
794
795     ystr("minor");
796     y(integer, MINOR_VERSION);
797
798     ystr("patch");
799     y(integer, PATCH_VERSION);
800
801     ystr("human_readable");
802     ystr(i3_version);
803
804     y(map_close);
805
806     const unsigned char *payload;
807     ylength length;
808     y(get_buf, &payload, &length);
809
810     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_VERSION, payload);
811     y(free);
812 }
813
814 /*
815  * Formats the reply message for a GET_BAR_CONFIG request and sends it to the
816  * client.
817  *
818  */
819 IPC_HANDLER(get_bar_config) {
820     yajl_gen gen = ygenalloc();
821
822     /* If no ID was passed, we return a JSON array with all IDs */
823     if (message_size == 0) {
824         y(array_open);
825         Barconfig *current;
826         TAILQ_FOREACH(current, &barconfigs, configs) {
827             ystr(current->id);
828         }
829         y(array_close);
830
831         const unsigned char *payload;
832         ylength length;
833         y(get_buf, &payload, &length);
834
835         ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
836         y(free);
837         return;
838     }
839
840     /* To get a properly terminated buffer, we copy
841      * message_size bytes out of the buffer */
842     char *bar_id = scalloc(message_size + 1);
843     strncpy(bar_id, (const char *)message, message_size);
844     LOG("IPC: looking for config for bar ID \"%s\"\n", bar_id);
845     Barconfig *current, *config = NULL;
846     TAILQ_FOREACH(current, &barconfigs, configs) {
847         if (strcmp(current->id, bar_id) != 0)
848             continue;
849
850         config = current;
851         break;
852     }
853
854     if (!config) {
855         /* If we did not find a config for the given ID, the reply will contain
856          * a null 'id' field. */
857         y(map_open);
858
859         ystr("id");
860         y(null);
861
862         y(map_close);
863     } else {
864         dump_bar_config(gen, config);
865     }
866
867     const unsigned char *payload;
868     ylength length;
869     y(get_buf, &payload, &length);
870
871     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
872     y(free);
873 }
874
875 /*
876  * Callback for the YAJL parser (will be called when a string is parsed).
877  *
878  */
879 static int add_subscription(void *extra, const unsigned char *s,
880                             ylength len) {
881     ipc_client *client = extra;
882
883     DLOG("should add subscription to extra %p, sub %.*s\n", client, (int)len, s);
884     int event = client->num_events;
885
886     client->num_events++;
887     client->events = realloc(client->events, client->num_events * sizeof(char *));
888     /* We copy the string because it is not null-terminated and strndup()
889      * is missing on some BSD systems */
890     client->events[event] = scalloc(len + 1);
891     memcpy(client->events[event], s, len);
892
893     DLOG("client is now subscribed to:\n");
894     for (int i = 0; i < client->num_events; i++)
895         DLOG("event %s\n", client->events[i]);
896     DLOG("(done)\n");
897
898     return 1;
899 }
900
901 /*
902  * Subscribes this connection to the event types which were given as a JSON
903  * serialized array in the payload field of the message.
904  *
905  */
906 IPC_HANDLER(subscribe) {
907     yajl_handle p;
908     yajl_status stat;
909     ipc_client *current, *client = NULL;
910
911     /* Search the ipc_client structure for this connection */
912     TAILQ_FOREACH(current, &all_clients, clients) {
913         if (current->fd != fd)
914             continue;
915
916         client = current;
917         break;
918     }
919
920     if (client == NULL) {
921         ELOG("Could not find ipc_client data structure for fd %d\n", fd);
922         return;
923     }
924
925     /* Setup the JSON parser */
926     static yajl_callbacks callbacks = {
927         .yajl_string = add_subscription,
928     };
929
930     p = yalloc(&callbacks, (void *)client);
931     stat = yajl_parse(p, (const unsigned char *)message, message_size);
932     if (stat != yajl_status_ok) {
933         unsigned char *err;
934         err = yajl_get_error(p, true, (const unsigned char *)message,
935                              message_size);
936         ELOG("YAJL parse error: %s\n", err);
937         yajl_free_error(p, err);
938
939         const char *reply = "{\"success\":false}";
940         ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t *)reply);
941         yajl_free(p);
942         return;
943     }
944     yajl_free(p);
945     const char *reply = "{\"success\":true}";
946     ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t *)reply);
947 }
948
949 /* The index of each callback function corresponds to the numeric
950  * value of the message type (see include/i3/ipc.h) */
951 handler_t handlers[8] = {
952     handle_command,
953     handle_get_workspaces,
954     handle_subscribe,
955     handle_get_outputs,
956     handle_tree,
957     handle_get_marks,
958     handle_get_bar_config,
959     handle_get_version,
960 };
961
962 /*
963  * Handler for activity on a client connection, receives a message from a
964  * client.
965  *
966  * For now, the maximum message size is 2048. I’m not sure for what the
967  * IPC interface will be used in the future, thus I’m not implementing a
968  * mechanism for arbitrarily long messages, as it seems like overkill
969  * at the moment.
970  *
971  */
972 static void ipc_receive_message(EV_P_ struct ev_io *w, int revents) {
973     uint32_t message_type;
974     uint32_t message_length;
975     uint8_t *message = NULL;
976
977     int ret = ipc_recv_message(w->fd, &message_type, &message_length, &message);
978     /* EOF or other error */
979     if (ret < 0) {
980         /* Was this a spurious read? See ev(3) */
981         if (ret == -1 && errno == EAGAIN) {
982             FREE(message);
983             return;
984         }
985
986         /* If not, there was some kind of error. We don’t bother
987          * and close the connection */
988         close(w->fd);
989
990         /* Delete the client from the list of clients */
991         ipc_client *current;
992         TAILQ_FOREACH(current, &all_clients, clients) {
993             if (current->fd != w->fd)
994                 continue;
995
996             for (int i = 0; i < current->num_events; i++)
997                 free(current->events[i]);
998             /* We can call TAILQ_REMOVE because we break out of the
999              * TAILQ_FOREACH afterwards */
1000             TAILQ_REMOVE(&all_clients, current, clients);
1001             free(current);
1002             break;
1003         }
1004
1005         ev_io_stop(EV_A_ w);
1006         free(w);
1007         FREE(message);
1008
1009         DLOG("IPC: client disconnected\n");
1010         return;
1011     }
1012
1013     if (message_type >= (sizeof(handlers) / sizeof(handler_t)))
1014         DLOG("Unhandled message type: %d\n", message_type);
1015     else {
1016         handler_t h = handlers[message_type];
1017         h(w->fd, message, 0, message_length, message_type);
1018     }
1019
1020     FREE(message);
1021 }
1022
1023 /*
1024  * Handler for activity on the listening socket, meaning that a new client
1025  * has just connected and we should accept() him. Sets up the event handler
1026  * for activity on the new connection and inserts the file descriptor into
1027  * the list of clients.
1028  *
1029  */
1030 void ipc_new_client(EV_P_ struct ev_io *w, int revents) {
1031     struct sockaddr_un peer;
1032     socklen_t len = sizeof(struct sockaddr_un);
1033     int client;
1034     if ((client = accept(w->fd, (struct sockaddr *)&peer, &len)) < 0) {
1035         if (errno == EINTR)
1036             return;
1037         else
1038             perror("accept()");
1039         return;
1040     }
1041
1042     /* Close this file descriptor on exec() */
1043     (void)fcntl(client, F_SETFD, FD_CLOEXEC);
1044
1045     set_nonblock(client);
1046
1047     struct ev_io *package = scalloc(sizeof(struct ev_io));
1048     ev_io_init(package, ipc_receive_message, client, EV_READ);
1049     ev_io_start(EV_A_ package);
1050
1051     DLOG("IPC: new client connected on fd %d\n", w->fd);
1052
1053     ipc_client *new = scalloc(sizeof(ipc_client));
1054     new->fd = client;
1055
1056     TAILQ_INSERT_TAIL(&all_clients, new, clients);
1057 }
1058
1059 /*
1060  * Creates the UNIX domain socket at the given path, sets it to non-blocking
1061  * mode, bind()s and listen()s on it.
1062  *
1063  */
1064 int ipc_create_socket(const char *filename) {
1065     int sockfd;
1066
1067     FREE(current_socketpath);
1068
1069     char *resolved = resolve_tilde(filename);
1070     DLOG("Creating IPC-socket at %s\n", resolved);
1071     char *copy = sstrdup(resolved);
1072     const char *dir = dirname(copy);
1073     if (!path_exists(dir))
1074         mkdirp(dir);
1075     free(copy);
1076
1077     /* Unlink the unix domain socket before */
1078     unlink(resolved);
1079
1080     if ((sockfd = socket(AF_LOCAL, SOCK_STREAM, 0)) < 0) {
1081         perror("socket()");
1082         free(resolved);
1083         return -1;
1084     }
1085
1086     (void)fcntl(sockfd, F_SETFD, FD_CLOEXEC);
1087
1088     struct sockaddr_un addr;
1089     memset(&addr, 0, sizeof(struct sockaddr_un));
1090     addr.sun_family = AF_LOCAL;
1091     strncpy(addr.sun_path, resolved, sizeof(addr.sun_path) - 1);
1092     if (bind(sockfd, (struct sockaddr *)&addr, sizeof(struct sockaddr_un)) < 0) {
1093         perror("bind()");
1094         free(resolved);
1095         return -1;
1096     }
1097
1098     set_nonblock(sockfd);
1099
1100     if (listen(sockfd, 5) < 0) {
1101         perror("listen()");
1102         free(resolved);
1103         return -1;
1104     }
1105
1106     current_socketpath = resolved;
1107     return sockfd;
1108 }
1109
1110 /*
1111  * Generates a json workspace event. Returns a dynamically allocated yajl
1112  * generator. Free with yajl_gen_free().
1113  */
1114 yajl_gen ipc_marshal_workspace_event(const char *change, Con *current, Con *old) {
1115     setlocale(LC_NUMERIC, "C");
1116     yajl_gen gen = ygenalloc();
1117
1118     y(map_open);
1119
1120     ystr("change");
1121     ystr(change);
1122
1123     ystr("current");
1124     if (current == NULL)
1125         y(null);
1126     else
1127         dump_node(gen, current, false);
1128
1129     ystr("old");
1130     if (old == NULL)
1131         y(null);
1132     else
1133         dump_node(gen, old, false);
1134
1135     y(map_close);
1136
1137     setlocale(LC_NUMERIC, "");
1138
1139     return gen;
1140 }
1141
1142 /*
1143  * For the workspace events we send, along with the usual "change" field, also
1144  * the workspace container in "current". For focus events, we send the
1145  * previously focused workspace in "old".
1146  */
1147 void ipc_send_workspace_event(const char *change, Con *current, Con *old) {
1148     yajl_gen gen = ipc_marshal_workspace_event(change, current, old);
1149
1150     const unsigned char *payload;
1151     ylength length;
1152     y(get_buf, &payload, &length);
1153
1154     ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, (const char *)payload);
1155
1156     y(free);
1157 }
1158
1159 /**
1160  * For the window events we send, along the usual "change" field,
1161  * also the window container, in "container".
1162  */
1163 void ipc_send_window_event(const char *property, Con *con) {
1164     DLOG("Issue IPC window %s event (con = %p, window = 0x%08x)\n",
1165          property, con, (con->window ? con->window->id : XCB_WINDOW_NONE));
1166
1167     setlocale(LC_NUMERIC, "C");
1168     yajl_gen gen = ygenalloc();
1169
1170     y(map_open);
1171
1172     ystr("change");
1173     ystr(property);
1174
1175     ystr("container");
1176     dump_node(gen, con, false);
1177
1178     y(map_close);
1179
1180     const unsigned char *payload;
1181     ylength length;
1182     y(get_buf, &payload, &length);
1183
1184     ipc_send_event("window", I3_IPC_EVENT_WINDOW, (const char *)payload);
1185     y(free);
1186     setlocale(LC_NUMERIC, "");
1187 }
1188
1189 /**
1190  * For the barconfig update events, we send the serialized barconfig.
1191  */
1192 void ipc_send_barconfig_update_event(Barconfig *barconfig) {
1193     DLOG("Issue barconfig_update event for id = %s\n", barconfig->id);
1194     setlocale(LC_NUMERIC, "C");
1195     yajl_gen gen = ygenalloc();
1196
1197     dump_bar_config(gen, barconfig);
1198
1199     const unsigned char *payload;
1200     ylength length;
1201     y(get_buf, &payload, &length);
1202
1203     ipc_send_event("barconfig_update", I3_IPC_EVENT_BARCONFIG_UPDATE, (const char *)payload);
1204     y(free);
1205     setlocale(LC_NUMERIC, "");
1206 }
1207
1208 /*
1209  * For the binding events, we send the serialized binding struct.
1210  */
1211 void ipc_send_binding_event(const char *event_type, Binding *bind) {
1212     DLOG("Issue IPC binding %s event (sym = %s, code = %d)\n", event_type, bind->symbol, bind->keycode);
1213
1214     setlocale(LC_NUMERIC, "C");
1215
1216     yajl_gen gen = ygenalloc();
1217
1218     y(map_open);
1219
1220     ystr("change");
1221     ystr(event_type);
1222
1223     ystr("binding");
1224     dump_binding(gen, bind);
1225
1226     y(map_close);
1227
1228     const unsigned char *payload;
1229     ylength length;
1230     y(get_buf, &payload, &length);
1231
1232     ipc_send_event("binding", I3_IPC_EVENT_BINDING, (const char *)payload);
1233
1234     y(free);
1235     setlocale(LC_NUMERIC, "");
1236 }