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