git.sur5r.net Git - i3/i3/blob - src/ipc.c

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