git.sur5r.net Git - i3/i3/blob - 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_bar_config(yajl_gen gen, Barconfig *config) {
 473     y(map_open);
 474
 475     ystr("id");
 476     ystr(config->id);
 477
 478     if (config->num_outputs > 0) {
 479         ystr("outputs");
 480         y(array_open);
 481         for (int c = 0; c < config->num_outputs; c++)
 482             ystr(config->outputs[c]);
 483         y(array_close);
 484     }
 485
 486 #define YSTR_IF_SET(name)       \
 487     do {                        \
 488         if (config->name) {     \
 489             ystr(#name);        \
 490             ystr(config->name); \
 491         }                       \
 492     } while (0)
 493
 494     YSTR_IF_SET(tray_output);
 495     YSTR_IF_SET(socket_path);
 496
 497     ystr("mode");
 498     switch (config->mode) {
 499         case M_HIDE:
 500             ystr("hide");
 501             break;
 502         case M_INVISIBLE:
 503             ystr("invisible");
 504             break;
 505         case M_DOCK:
 506         default:
 507             ystr("dock");
 508             break;
 509     }
 510
 511     ystr("hidden_state");
 512     switch (config->hidden_state) {
 513         case S_SHOW:
 514             ystr("show");
 515             break;
 516         case S_HIDE:
 517         default:
 518             ystr("hide");
 519             break;
 520     }
 521
 522     ystr("modifier");
 523     switch (config->modifier) {
 524         case M_CONTROL:
 525             ystr("ctrl");
 526             break;
 527         case M_SHIFT:
 528             ystr("shift");
 529             break;
 530         case M_MOD1:
 531             ystr("Mod1");
 532             break;
 533         case M_MOD2:
 534             ystr("Mod2");
 535             break;
 536         case M_MOD3:
 537             ystr("Mod3");
 538             break;
 539         /*
 540                case M_MOD4:
 541                ystr("Mod4");
 542                break;
 543                */
 544         case M_MOD5:
 545             ystr("Mod5");
 546             break;
 547         default:
 548             ystr("Mod4");
 549             break;
 550     }
 551
 552     if (config->wheel_up_cmd) {
 553         ystr("wheel_up_cmd");
 554         ystr(config->wheel_up_cmd);
 555     }
 556
 557     if (config->wheel_down_cmd) {
 558         ystr("wheel_down_cmd");
 559         ystr(config->wheel_down_cmd);
 560     }
 561
 562     ystr("position");
 563     if (config->position == P_BOTTOM)
 564         ystr("bottom");
 565     else
 566         ystr("top");
 567
 568     YSTR_IF_SET(status_command);
 569     YSTR_IF_SET(font);
 570
 571     if (config->separator_symbol) {
 572         ystr("separator_symbol");
 573         ystr(config->separator_symbol);
 574     }
 575
 576     ystr("workspace_buttons");
 577     y(bool, !config->hide_workspace_buttons);
 578
 579     ystr("strip_workspace_numbers");
 580     y(bool, config->strip_workspace_numbers);
 581
 582     ystr("binding_mode_indicator");
 583     y(bool, !config->hide_binding_mode_indicator);
 584
 585     ystr("verbose");
 586     y(bool, config->verbose);
 587
 588 #undef YSTR_IF_SET
 589 #define YSTR_IF_SET(name)              \
 590     do {                               \
 591         if (config->colors.name) {     \
 592             ystr(#name);               \
 593             ystr(config->colors.name); \
 594         }                              \
 595     } while (0)
 596
 597     ystr("colors");
 598     y(map_open);
 599     YSTR_IF_SET(background);
 600     YSTR_IF_SET(statusline);
 601     YSTR_IF_SET(separator);
 602     YSTR_IF_SET(focused_workspace_border);
 603     YSTR_IF_SET(focused_workspace_bg);
 604     YSTR_IF_SET(focused_workspace_text);
 605     YSTR_IF_SET(active_workspace_border);
 606     YSTR_IF_SET(active_workspace_bg);
 607     YSTR_IF_SET(active_workspace_text);
 608     YSTR_IF_SET(inactive_workspace_border);
 609     YSTR_IF_SET(inactive_workspace_bg);
 610     YSTR_IF_SET(inactive_workspace_text);
 611     YSTR_IF_SET(urgent_workspace_border);
 612     YSTR_IF_SET(urgent_workspace_bg);
 613     YSTR_IF_SET(urgent_workspace_text);
 614     YSTR_IF_SET(binding_mode_border);
 615     YSTR_IF_SET(binding_mode_bg);
 616     YSTR_IF_SET(binding_mode_text);
 617     y(map_close);
 618
 619     y(map_close);
 620 #undef YSTR_IF_SET
 621 }
 622
 623 IPC_HANDLER(tree) {
 624     setlocale(LC_NUMERIC, "C");
 625     yajl_gen gen = ygenalloc();
 626     dump_node(gen, croot, false);
 627     setlocale(LC_NUMERIC, "");
 628
 629     const unsigned char *payload;
 630     ylength length;
 631     y(get_buf, &payload, &length);
 632
 633     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_TREE, payload);
 634     y(free);
 635 }
 636
 637 /*
 638  * Formats the reply message for a GET_WORKSPACES request and sends it to the
 639  * client
 640  *
 641  */
 642 IPC_HANDLER(get_workspaces) {
 643     yajl_gen gen = ygenalloc();
 644     y(array_open);
 645
 646     Con *focused_ws = con_get_workspace(focused);
 647
 648     Con *output;
 649     TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
 650         if (con_is_internal(output))
 651             continue;
 652         Con *ws;
 653         TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
 654             assert(ws->type == CT_WORKSPACE);
 655             y(map_open);
 656
 657             ystr("num");
 658             y(integer, ws->num);
 659
 660             ystr("name");
 661             ystr(ws->name);
 662
 663             ystr("visible");
 664             y(bool, workspace_is_visible(ws));
 665
 666             ystr("focused");
 667             y(bool, ws == focused_ws);
 668
 669             ystr("rect");
 670             y(map_open);
 671             ystr("x");
 672             y(integer, ws->rect.x);
 673             ystr("y");
 674             y(integer, ws->rect.y);
 675             ystr("width");
 676             y(integer, ws->rect.width);
 677             ystr("height");
 678             y(integer, ws->rect.height);
 679             y(map_close);
 680
 681             ystr("output");
 682             ystr(output->name);
 683
 684             ystr("urgent");
 685             y(bool, ws->urgent);
 686
 687             y(map_close);
 688         }
 689     }
 690
 691     y(array_close);
 692
 693     const unsigned char *payload;
 694     ylength length;
 695     y(get_buf, &payload, &length);
 696
 697     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_WORKSPACES, payload);
 698     y(free);
 699 }
 700
 701 /*
 702  * Formats the reply message for a GET_OUTPUTS request and sends it to the
 703  * client
 704  *
 705  */
 706 IPC_HANDLER(get_outputs) {
 707     yajl_gen gen = ygenalloc();
 708     y(array_open);
 709
 710     Output *output;
 711     TAILQ_FOREACH(output, &outputs, outputs) {
 712         y(map_open);
 713
 714         ystr("name");
 715         ystr(output->name);
 716
 717         ystr("active");
 718         y(bool, output->active);
 719
 720         ystr("primary");
 721         y(bool, output->primary);
 722
 723         ystr("rect");
 724         y(map_open);
 725         ystr("x");
 726         y(integer, output->rect.x);
 727         ystr("y");
 728         y(integer, output->rect.y);
 729         ystr("width");
 730         y(integer, output->rect.width);
 731         ystr("height");
 732         y(integer, output->rect.height);
 733         y(map_close);
 734
 735         ystr("current_workspace");
 736         Con *ws = NULL;
 737         if (output->con && (ws = con_get_fullscreen_con(output->con, CF_OUTPUT)))
 738             ystr(ws->name);
 739         else
 740             y(null);
 741
 742         y(map_close);
 743     }
 744
 745     y(array_close);
 746
 747     const unsigned char *payload;
 748     ylength length;
 749     y(get_buf, &payload, &length);
 750
 751     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_OUTPUTS, payload);
 752     y(free);
 753 }
 754
 755 /*
 756  * Formats the reply message for a GET_MARKS request and sends it to the
 757  * client
 758  *
 759  */
 760 IPC_HANDLER(get_marks) {
 761     yajl_gen gen = ygenalloc();
 762     y(array_open);
 763
 764     Con *con;
 765     TAILQ_FOREACH(con, &all_cons, all_cons)
 766     if (con->mark != NULL)
 767         ystr(con->mark);
 768
 769     y(array_close);
 770
 771     const unsigned char *payload;
 772     ylength length;
 773     y(get_buf, &payload, &length);
 774
 775     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_MARKS, payload);
 776     y(free);
 777 }
 778
 779 /*
 780  * Returns the version of i3
 781  *
 782  */
 783 IPC_HANDLER(get_version) {
 784     yajl_gen gen = ygenalloc();
 785     y(map_open);
 786
 787     ystr("major");
 788     y(integer, MAJOR_VERSION);
 789
 790     ystr("minor");
 791     y(integer, MINOR_VERSION);
 792
 793     ystr("patch");
 794     y(integer, PATCH_VERSION);
 795
 796     ystr("human_readable");
 797     ystr(i3_version);
 798
 799     y(map_close);
 800
 801     const unsigned char *payload;
 802     ylength length;
 803     y(get_buf, &payload, &length);
 804
 805     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_VERSION, payload);
 806     y(free);
 807 }
 808
 809 /*
 810  * Formats the reply message for a GET_BAR_CONFIG request and sends it to the
 811  * client.
 812  *
 813  */
 814 IPC_HANDLER(get_bar_config) {
 815     yajl_gen gen = ygenalloc();
 816
 817     /* If no ID was passed, we return a JSON array with all IDs */
 818     if (message_size == 0) {
 819         y(array_open);
 820         Barconfig *current;
 821         TAILQ_FOREACH(current, &barconfigs, configs) {
 822             ystr(current->id);
 823         }
 824         y(array_close);
 825
 826         const unsigned char *payload;
 827         ylength length;
 828         y(get_buf, &payload, &length);
 829
 830         ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
 831         y(free);
 832         return;
 833     }
 834
 835     /* To get a properly terminated buffer, we copy
 836      * message_size bytes out of the buffer */
 837     char *bar_id = scalloc(message_size + 1);
 838     strncpy(bar_id, (const char *)message, message_size);
 839     LOG("IPC: looking for config for bar ID \"%s\"\n", bar_id);
 840     Barconfig *current, *config = NULL;
 841     TAILQ_FOREACH(current, &barconfigs, configs) {
 842         if (strcmp(current->id, bar_id) != 0)
 843             continue;
 844
 845         config = current;
 846         break;
 847     }
 848
 849     if (!config) {
 850         /* If we did not find a config for the given ID, the reply will contain
 851          * a null 'id' field. */
 852         y(map_open);
 853
 854         ystr("id");
 855         y(null);
 856
 857         y(map_close);
 858     } else {
 859         dump_bar_config(gen, config);
 860     }
 861
 862     const unsigned char *payload;
 863     ylength length;
 864     y(get_buf, &payload, &length);
 865
 866     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
 867     y(free);
 868 }
 869
 870 /*
 871  * Callback for the YAJL parser (will be called when a string is parsed).
 872  *
 873  */
 874 static int add_subscription(void *extra, const unsigned char *s,
 875                             ylength len) {
 876     ipc_client *client = extra;
 877
 878     DLOG("should add subscription to extra %p, sub %.*s\n", client, (int)len, s);
 879     int event = client->num_events;
 880
 881     client->num_events++;
 882     client->events = realloc(client->events, client->num_events * sizeof(char *));
 883     /* We copy the string because it is not null-terminated and strndup()
 884      * is missing on some BSD systems */
 885     client->events[event] = scalloc(len + 1);
 886     memcpy(client->events[event], s, len);
 887
 888     DLOG("client is now subscribed to:\n");
 889     for (int i = 0; i < client->num_events; i++)
 890         DLOG("event %s\n", client->events[i]);
 891     DLOG("(done)\n");
 892
 893     return 1;
 894 }
 895
 896 /*
 897  * Subscribes this connection to the event types which were given as a JSON
 898  * serialized array in the payload field of the message.
 899  *
 900  */
 901 IPC_HANDLER(subscribe) {
 902     yajl_handle p;
 903     yajl_status stat;
 904     ipc_client *current, *client = NULL;
 905
 906     /* Search the ipc_client structure for this connection */
 907     TAILQ_FOREACH(current, &all_clients, clients) {
 908         if (current->fd != fd)
 909             continue;
 910
 911         client = current;
 912         break;
 913     }
 914
 915     if (client == NULL) {
 916         ELOG("Could not find ipc_client data structure for fd %d\n", fd);
 917         return;
 918     }
 919
 920     /* Setup the JSON parser */
 921     static yajl_callbacks callbacks = {
 922         .yajl_string = add_subscription,
 923     };
 924
 925     p = yalloc(&callbacks, (void *)client);
 926     stat = yajl_parse(p, (const unsigned char *)message, message_size);
 927     if (stat != yajl_status_ok) {
 928         unsigned char *err;
 929         err = yajl_get_error(p, true, (const unsigned char *)message,
 930                              message_size);
 931         ELOG("YAJL parse error: %s\n", err);
 932         yajl_free_error(p, err);
 933
 934         const char *reply = "{\"success\":false}";
 935         ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t *)reply);
 936         yajl_free(p);
 937         return;
 938     }
 939     yajl_free(p);
 940     const char *reply = "{\"success\":true}";
 941     ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t *)reply);
 942 }
 943
 944 /* The index of each callback function corresponds to the numeric
 945  * value of the message type (see include/i3/ipc.h) */
 946 handler_t handlers[8] = {
 947     handle_command,
 948     handle_get_workspaces,
 949     handle_subscribe,
 950     handle_get_outputs,
 951     handle_tree,
 952     handle_get_marks,
 953     handle_get_bar_config,
 954     handle_get_version,
 955 };
 956
 957 /*
 958  * Handler for activity on a client connection, receives a message from a
 959  * client.
 960  *
 961  * For now, the maximum message size is 2048. I’m not sure for what the
 962  * IPC interface will be used in the future, thus I’m not implementing a
 963  * mechanism for arbitrarily long messages, as it seems like overkill
 964  * at the moment.
 965  *
 966  */
 967 static void ipc_receive_message(EV_P_ struct ev_io *w, int revents) {
 968     uint32_t message_type;
 969     uint32_t message_length;
 970     uint8_t *message = NULL;
 971
 972     int ret = ipc_recv_message(w->fd, &message_type, &message_length, &message);
 973     /* EOF or other error */
 974     if (ret < 0) {
 975         /* Was this a spurious read? See ev(3) */
 976         if (ret == -1 && errno == EAGAIN) {
 977             FREE(message);
 978             return;
 979         }
 980
 981         /* If not, there was some kind of error. We don’t bother
 982          * and close the connection */
 983         close(w->fd);
 984
 985         /* Delete the client from the list of clients */
 986         ipc_client *current;
 987         TAILQ_FOREACH(current, &all_clients, clients) {
 988             if (current->fd != w->fd)
 989                 continue;
 990
 991             for (int i = 0; i < current->num_events; i++)
 992                 free(current->events[i]);
 993             /* We can call TAILQ_REMOVE because we break out of the
 994              * TAILQ_FOREACH afterwards */
 995             TAILQ_REMOVE(&all_clients, current, clients);
 996             free(current);
 997             break;
 998         }
 999
1000         ev_io_stop(EV_A_ w);
1001         free(w);
1002         FREE(message);
1003
1004         DLOG("IPC: client disconnected\n");
1005         return;
1006     }
1007
1008     if (message_type >= (sizeof(handlers) / sizeof(handler_t)))
1009         DLOG("Unhandled message type: %d\n", message_type);
1010     else {
1011         handler_t h = handlers[message_type];
1012         h(w->fd, message, 0, message_length, message_type);
1013     }
1014
1015     FREE(message);
1016 }
1017
1018 /*
1019  * Handler for activity on the listening socket, meaning that a new client
1020  * has just connected and we should accept() him. Sets up the event handler
1021  * for activity on the new connection and inserts the file descriptor into
1022  * the list of clients.
1023  *
1024  */
1025 void ipc_new_client(EV_P_ struct ev_io *w, int revents) {
1026     struct sockaddr_un peer;
1027     socklen_t len = sizeof(struct sockaddr_un);
1028     int client;
1029     if ((client = accept(w->fd, (struct sockaddr *)&peer, &len)) < 0) {
1030         if (errno == EINTR)
1031             return;
1032         else
1033             perror("accept()");
1034         return;
1035     }
1036
1037     /* Close this file descriptor on exec() */
1038     (void)fcntl(client, F_SETFD, FD_CLOEXEC);
1039
1040     set_nonblock(client);
1041
1042     struct ev_io *package = scalloc(sizeof(struct ev_io));
1043     ev_io_init(package, ipc_receive_message, client, EV_READ);
1044     ev_io_start(EV_A_ package);
1045
1046     DLOG("IPC: new client connected on fd %d\n", w->fd);
1047
1048     ipc_client *new = scalloc(sizeof(ipc_client));
1049     new->fd = client;
1050
1051     TAILQ_INSERT_TAIL(&all_clients, new, clients);
1052 }
1053
1054 /*
1055  * Creates the UNIX domain socket at the given path, sets it to non-blocking
1056  * mode, bind()s and listen()s on it.
1057  *
1058  */
1059 int ipc_create_socket(const char *filename) {
1060     int sockfd;
1061
1062     FREE(current_socketpath);
1063
1064     char *resolved = resolve_tilde(filename);
1065     DLOG("Creating IPC-socket at %s\n", resolved);
1066     char *copy = sstrdup(resolved);
1067     const char *dir = dirname(copy);
1068     if (!path_exists(dir))
1069         mkdirp(dir);
1070     free(copy);
1071
1072     /* Unlink the unix domain socket before */
1073     unlink(resolved);
1074
1075     if ((sockfd = socket(AF_LOCAL, SOCK_STREAM, 0)) < 0) {
1076         perror("socket()");
1077         free(resolved);
1078         return -1;
1079     }
1080
1081     (void)fcntl(sockfd, F_SETFD, FD_CLOEXEC);
1082
1083     struct sockaddr_un addr;
1084     memset(&addr, 0, sizeof(struct sockaddr_un));
1085     addr.sun_family = AF_LOCAL;
1086     strncpy(addr.sun_path, resolved, sizeof(addr.sun_path) - 1);
1087     if (bind(sockfd, (struct sockaddr *)&addr, sizeof(struct sockaddr_un)) < 0) {
1088         perror("bind()");
1089         free(resolved);
1090         return -1;
1091     }
1092
1093     set_nonblock(sockfd);
1094
1095     if (listen(sockfd, 5) < 0) {
1096         perror("listen()");
1097         free(resolved);
1098         return -1;
1099     }
1100
1101     current_socketpath = resolved;
1102     return sockfd;
1103 }
1104
1105 /*
1106  * Generates a json workspace event. Returns a dynamically allocated yajl
1107  * generator. Free with yajl_gen_free().
1108  */
1109 yajl_gen ipc_marshal_workspace_event(const char *change, Con *current, Con *old) {
1110     setlocale(LC_NUMERIC, "C");
1111     yajl_gen gen = ygenalloc();
1112
1113     y(map_open);
1114
1115     ystr("change");
1116     ystr(change);
1117
1118     ystr("current");
1119     if (current == NULL)
1120         y(null);
1121     else
1122         dump_node(gen, current, false);
1123
1124     ystr("old");
1125     if (old == NULL)
1126         y(null);
1127     else
1128         dump_node(gen, old, false);
1129
1130     y(map_close);
1131
1132     setlocale(LC_NUMERIC, "");
1133
1134     return gen;
1135 }
1136
1137 /*
1138  * For the workspace events we send, along with the usual "change" field, also
1139  * the workspace container in "current". For focus events, we send the
1140  * previously focused workspace in "old".
1141  */
1142 void ipc_send_workspace_event(const char *change, Con *current, Con *old) {
1143     yajl_gen gen = ipc_marshal_workspace_event(change, current, old);
1144
1145     const unsigned char *payload;
1146     ylength length;
1147     y(get_buf, &payload, &length);
1148
1149     ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, (const char *)payload);
1150
1151     y(free);
1152 }
1153
1154 /**
1155  * For the window events we send, along the usual "change" field,
1156  * also the window container, in "container".
1157  */
1158 void ipc_send_window_event(const char *property, Con *con) {
1159     DLOG("Issue IPC window %s event (con = %p, window = 0x%08x)\n",
1160          property, con, (con->window ? con->window->id : XCB_WINDOW_NONE));
1161
1162     setlocale(LC_NUMERIC, "C");
1163     yajl_gen gen = ygenalloc();
1164
1165     y(map_open);
1166
1167     ystr("change");
1168     ystr(property);
1169
1170     ystr("container");
1171     dump_node(gen, con, false);
1172
1173     y(map_close);
1174
1175     const unsigned char *payload;
1176     ylength length;
1177     y(get_buf, &payload, &length);
1178
1179     ipc_send_event("window", I3_IPC_EVENT_WINDOW, (const char *)payload);
1180     y(free);
1181     setlocale(LC_NUMERIC, "");
1182 }
1183
1184 /**
1185  * For the barconfig update events, we send the serialized barconfig.
1186  */
1187 void ipc_send_barconfig_update_event(Barconfig *barconfig) {
1188     DLOG("Issue barconfig_update event for id = %s\n", barconfig->id);
1189     setlocale(LC_NUMERIC, "C");
1190     yajl_gen gen = ygenalloc();
1191
1192     dump_bar_config(gen, barconfig);
1193
1194     const unsigned char *payload;
1195     ylength length;
1196     y(get_buf, &payload, &length);
1197
1198     ipc_send_event("barconfig_update", I3_IPC_EVENT_BARCONFIG_UPDATE, (const char *)payload);
1199     y(free);
1200     setlocale(LC_NUMERIC, "");
1201 }
1202
1203 /*
1204  * For the binding events, we send the serialized binding struct.
1205  */
1206 void ipc_send_binding_event(const char *event_type, Binding *bind) {
1207     DLOG("Issue IPC binding %s event (sym = %s, code = %d)\n", event_type, bind->symbol, bind->keycode);
1208
1209     setlocale(LC_NUMERIC, "C");
1210
1211     yajl_gen gen = ygenalloc();
1212
1213     y(map_open);
1214
1215     ystr("change");
1216     ystr(event_type);
1217
1218     ystr("binding");
1219     dump_binding(gen, bind);
1220
1221     y(map_close);
1222
1223     const unsigned char *payload;
1224     ylength length;
1225     y(get_buf, &payload, &length);
1226
1227     ipc_send_event("binding", I3_IPC_EVENT_BINDING, (const char *)payload);
1228
1229     y(free);
1230     setlocale(LC_NUMERIC, "");
1231 }