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