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(run_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     }
 272
 273     /* provided for backwards compatibility only. */
 274     ystr("orientation");
 275     if (!con_is_split(con))
 276         ystr("none");
 277     else {
 278         if (con_orientation(con) == HORIZ)
 279             ystr("horizontal");
 280         else
 281             ystr("vertical");
 282     }
 283
 284     ystr("scratchpad_state");
 285     switch (con->scratchpad_state) {
 286         case SCRATCHPAD_NONE:
 287             ystr("none");
 288             break;
 289         case SCRATCHPAD_FRESH:
 290             ystr("fresh");
 291             break;
 292         case SCRATCHPAD_CHANGED:
 293             ystr("changed");
 294             break;
 295     }
 296
 297     ystr("percent");
 298     if (con->percent == 0.0)
 299         y(null);
 300     else
 301         y(double, con->percent);
 302
 303     ystr("urgent");
 304     y(bool, con->urgent);
 305
 306     if (!TAILQ_EMPTY(&(con->marks_head))) {
 307         ystr("marks");
 308         y(array_open);
 309
 310         mark_t *mark;
 311         TAILQ_FOREACH(mark, &(con->marks_head), marks) {
 312             ystr(mark->name);
 313         }
 314
 315         y(array_close);
 316     }
 317
 318     ystr("focused");
 319     y(bool, (con == focused));
 320
 321     if (con->type != CT_ROOT && con->type != CT_OUTPUT) {
 322         ystr("output");
 323         ystr(con_get_output(con)->name);
 324     }
 325
 326     ystr("layout");
 327     switch (con->layout) {
 328         case L_DEFAULT:
 329             DLOG("About to dump layout=default, this is a bug in the code.\n");
 330             assert(false);
 331             break;
 332         case L_SPLITV:
 333             ystr("splitv");
 334             break;
 335         case L_SPLITH:
 336             ystr("splith");
 337             break;
 338         case L_STACKED:
 339             ystr("stacked");
 340             break;
 341         case L_TABBED:
 342             ystr("tabbed");
 343             break;
 344         case L_DOCKAREA:
 345             ystr("dockarea");
 346             break;
 347         case L_OUTPUT:
 348             ystr("output");
 349             break;
 350     }
 351
 352     ystr("workspace_layout");
 353     switch (con->workspace_layout) {
 354         case L_DEFAULT:
 355             ystr("default");
 356             break;
 357         case L_STACKED:
 358             ystr("stacked");
 359             break;
 360         case L_TABBED:
 361             ystr("tabbed");
 362             break;
 363         default:
 364             DLOG("About to dump workspace_layout=%d (none of default/stacked/tabbed), this is a bug.\n", con->workspace_layout);
 365             assert(false);
 366             break;
 367     }
 368
 369     ystr("last_split_layout");
 370     switch (con->layout) {
 371         case L_SPLITV:
 372             ystr("splitv");
 373             break;
 374         default:
 375             ystr("splith");
 376             break;
 377     }
 378
 379     ystr("border");
 380     switch (con->border_style) {
 381         case BS_NORMAL:
 382             ystr("normal");
 383             break;
 384         case BS_NONE:
 385             ystr("none");
 386             break;
 387         case BS_PIXEL:
 388             ystr("pixel");
 389             break;
 390     }
 391
 392     ystr("current_border_width");
 393     y(integer, con->current_border_width);
 394
 395     dump_rect(gen, "rect", con->rect);
 396     dump_rect(gen, "deco_rect", con->deco_rect);
 397     dump_rect(gen, "window_rect", con->window_rect);
 398     dump_rect(gen, "geometry", con->geometry);
 399
 400     ystr("name");
 401     if (con->window && con->window->name)
 402         ystr(i3string_as_utf8(con->window->name));
 403     else if (con->name != NULL)
 404         ystr(con->name);
 405     else
 406         y(null);
 407
 408     if (con->title_format != NULL) {
 409         ystr("title_format");
 410         ystr(con->title_format);
 411     }
 412
 413     if (con->type == CT_WORKSPACE) {
 414         ystr("num");
 415         y(integer, con->num);
 416     }
 417
 418     ystr("window");
 419     if (con->window)
 420         y(integer, con->window->id);
 421     else
 422         y(null);
 423
 424     if (con->window && !inplace_restart) {
 425         /* Window properties are useless to preserve when restarting because
 426          * they will be queried again anyway. However, for i3-save-tree(1),
 427          * they are very useful and save i3-save-tree dealing with X11. */
 428         ystr("window_properties");
 429         y(map_open);
 430
 431 #define DUMP_PROPERTY(key, prop_name)         \
 432     do {                                      \
 433         if (con->window->prop_name != NULL) { \
 434             ystr(key);                        \
 435             ystr(con->window->prop_name);     \
 436         }                                     \
 437     } while (0)
 438
 439         DUMP_PROPERTY("class", class_class);
 440         DUMP_PROPERTY("instance", class_instance);
 441         DUMP_PROPERTY("window_role", role);
 442
 443         if (con->window->name != NULL) {
 444             ystr("title");
 445             ystr(i3string_as_utf8(con->window->name));
 446         }
 447
 448         ystr("transient_for");
 449         if (con->window->transient_for == XCB_NONE)
 450             y(null);
 451         else
 452             y(integer, con->window->transient_for);
 453
 454         y(map_close);
 455     }
 456
 457     ystr("nodes");
 458     y(array_open);
 459     Con *node;
 460     if (con->type != CT_DOCKAREA || !inplace_restart) {
 461         TAILQ_FOREACH(node, &(con->nodes_head), nodes) {
 462             dump_node(gen, node, inplace_restart);
 463         }
 464     }
 465     y(array_close);
 466
 467     ystr("floating_nodes");
 468     y(array_open);
 469     TAILQ_FOREACH(node, &(con->floating_head), floating_windows) {
 470         dump_node(gen, node, inplace_restart);
 471     }
 472     y(array_close);
 473
 474     ystr("focus");
 475     y(array_open);
 476     TAILQ_FOREACH(node, &(con->focus_head), focused) {
 477         y(integer, (uintptr_t)node);
 478     }
 479     y(array_close);
 480
 481     ystr("fullscreen_mode");
 482     y(integer, con->fullscreen_mode);
 483
 484     ystr("sticky");
 485     y(bool, con->sticky);
 486
 487     ystr("floating");
 488     switch (con->floating) {
 489         case FLOATING_AUTO_OFF:
 490             ystr("auto_off");
 491             break;
 492         case FLOATING_AUTO_ON:
 493             ystr("auto_on");
 494             break;
 495         case FLOATING_USER_OFF:
 496             ystr("user_off");
 497             break;
 498         case FLOATING_USER_ON:
 499             ystr("user_on");
 500             break;
 501     }
 502
 503     ystr("swallows");
 504     y(array_open);
 505     Match *match;
 506     TAILQ_FOREACH(match, &(con->swallow_head), matches) {
 507         /* We will generate a new restart_mode match specification after this
 508          * loop, so skip this one. */
 509         if (match->restart_mode)
 510             continue;
 511         y(map_open);
 512         if (match->dock != M_DONTCHECK) {
 513             ystr("dock");
 514             y(integer, match->dock);
 515             ystr("insert_where");
 516             y(integer, match->insert_where);
 517         }
 518
 519 #define DUMP_REGEX(re_name)                \
 520     do {                                   \
 521         if (match->re_name != NULL) {      \
 522             ystr(#re_name);                \
 523             ystr(match->re_name->pattern); \
 524         }                                  \
 525     } while (0)
 526
 527         DUMP_REGEX(class);
 528         DUMP_REGEX(instance);
 529         DUMP_REGEX(window_role);
 530         DUMP_REGEX(title);
 531
 532 #undef DUMP_REGEX
 533         y(map_close);
 534     }
 535
 536     if (inplace_restart) {
 537         if (con->window != NULL) {
 538             y(map_open);
 539             ystr("id");
 540             y(integer, con->window->id);
 541             ystr("restart_mode");
 542             y(bool, true);
 543             y(map_close);
 544         }
 545     }
 546     y(array_close);
 547
 548     if (inplace_restart && con->window != NULL) {
 549         ystr("depth");
 550         y(integer, con->depth);
 551     }
 552
 553     y(map_close);
 554 }
 555
 556 static void dump_bar_bindings(yajl_gen gen, Barconfig *config) {
 557     if (TAILQ_EMPTY(&(config->bar_bindings)))
 558         return;
 559
 560     ystr("bindings");
 561     y(array_open);
 562
 563     struct Barbinding *current;
 564     TAILQ_FOREACH(current, &(config->bar_bindings), bindings) {
 565         y(map_open);
 566
 567         ystr("input_code");
 568         y(integer, current->input_code);
 569         ystr("command");
 570         ystr(current->command);
 571         ystr("release");
 572         y(bool, current->release == B_UPON_KEYRELEASE);
 573
 574         y(map_close);
 575     }
 576
 577     y(array_close);
 578 }
 579
 580 static char *canonicalize_output_name(char *name) {
 581     /* Do not canonicalize special output names. */
 582     if (strcasecmp(name, "primary") == 0) {
 583         return name;
 584     }
 585     Output *output = get_output_by_name(name, false);
 586     return output ? output_primary_name(output) : name;
 587 }
 588
 589 static void dump_bar_config(yajl_gen gen, Barconfig *config) {
 590     y(map_open);
 591
 592     ystr("id");
 593     ystr(config->id);
 594
 595     if (config->num_outputs > 0) {
 596         ystr("outputs");
 597         y(array_open);
 598         for (int c = 0; c < config->num_outputs; c++) {
 599             /* Convert monitor names (RandR ≥ 1.5) or output names
 600              * (RandR < 1.5) into monitor names. This way, existing
 601              * configs which use output names transparently keep
 602              * working. */
 603             ystr(canonicalize_output_name(config->outputs[c]));
 604         }
 605         y(array_close);
 606     }
 607
 608     if (!TAILQ_EMPTY(&(config->tray_outputs))) {
 609         ystr("tray_outputs");
 610         y(array_open);
 611
 612         struct tray_output_t *tray_output;
 613         TAILQ_FOREACH(tray_output, &(config->tray_outputs), tray_outputs) {
 614             ystr(canonicalize_output_name(tray_output->output));
 615         }
 616
 617         y(array_close);
 618     }
 619
 620 #define YSTR_IF_SET(name)       \
 621     do {                        \
 622         if (config->name) {     \
 623             ystr(#name);        \
 624             ystr(config->name); \
 625         }                       \
 626     } while (0)
 627
 628     ystr("tray_padding");
 629     y(integer, config->tray_padding);
 630
 631     YSTR_IF_SET(socket_path);
 632
 633     ystr("mode");
 634     switch (config->mode) {
 635         case M_HIDE:
 636             ystr("hide");
 637             break;
 638         case M_INVISIBLE:
 639             ystr("invisible");
 640             break;
 641         case M_DOCK:
 642         default:
 643             ystr("dock");
 644             break;
 645     }
 646
 647     ystr("hidden_state");
 648     switch (config->hidden_state) {
 649         case S_SHOW:
 650             ystr("show");
 651             break;
 652         case S_HIDE:
 653         default:
 654             ystr("hide");
 655             break;
 656     }
 657
 658     ystr("modifier");
 659     y(integer, config->modifier);
 660
 661     dump_bar_bindings(gen, config);
 662
 663     ystr("position");
 664     if (config->position == P_BOTTOM)
 665         ystr("bottom");
 666     else
 667         ystr("top");
 668
 669     YSTR_IF_SET(status_command);
 670     YSTR_IF_SET(font);
 671
 672     if (config->separator_symbol) {
 673         ystr("separator_symbol");
 674         ystr(config->separator_symbol);
 675     }
 676
 677     ystr("workspace_buttons");
 678     y(bool, !config->hide_workspace_buttons);
 679
 680     ystr("strip_workspace_numbers");
 681     y(bool, config->strip_workspace_numbers);
 682
 683     ystr("strip_workspace_name");
 684     y(bool, config->strip_workspace_name);
 685
 686     ystr("binding_mode_indicator");
 687     y(bool, !config->hide_binding_mode_indicator);
 688
 689     ystr("verbose");
 690     y(bool, config->verbose);
 691
 692 #undef YSTR_IF_SET
 693 #define YSTR_IF_SET(name)              \
 694     do {                               \
 695         if (config->colors.name) {     \
 696             ystr(#name);               \
 697             ystr(config->colors.name); \
 698         }                              \
 699     } while (0)
 700
 701     ystr("colors");
 702     y(map_open);
 703     YSTR_IF_SET(background);
 704     YSTR_IF_SET(statusline);
 705     YSTR_IF_SET(separator);
 706     YSTR_IF_SET(focused_background);
 707     YSTR_IF_SET(focused_statusline);
 708     YSTR_IF_SET(focused_separator);
 709     YSTR_IF_SET(focused_workspace_border);
 710     YSTR_IF_SET(focused_workspace_bg);
 711     YSTR_IF_SET(focused_workspace_text);
 712     YSTR_IF_SET(active_workspace_border);
 713     YSTR_IF_SET(active_workspace_bg);
 714     YSTR_IF_SET(active_workspace_text);
 715     YSTR_IF_SET(inactive_workspace_border);
 716     YSTR_IF_SET(inactive_workspace_bg);
 717     YSTR_IF_SET(inactive_workspace_text);
 718     YSTR_IF_SET(urgent_workspace_border);
 719     YSTR_IF_SET(urgent_workspace_bg);
 720     YSTR_IF_SET(urgent_workspace_text);
 721     YSTR_IF_SET(binding_mode_border);
 722     YSTR_IF_SET(binding_mode_bg);
 723     YSTR_IF_SET(binding_mode_text);
 724     y(map_close);
 725
 726     y(map_close);
 727 #undef YSTR_IF_SET
 728 }
 729
 730 IPC_HANDLER(tree) {
 731     setlocale(LC_NUMERIC, "C");
 732     yajl_gen gen = ygenalloc();
 733     dump_node(gen, croot, false);
 734     setlocale(LC_NUMERIC, "");
 735
 736     const unsigned char *payload;
 737     ylength length;
 738     y(get_buf, &payload, &length);
 739
 740     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_TREE, payload);
 741     y(free);
 742 }
 743
 744 /*
 745  * Formats the reply message for a GET_WORKSPACES request and sends it to the
 746  * client
 747  *
 748  */
 749 IPC_HANDLER(get_workspaces) {
 750     yajl_gen gen = ygenalloc();
 751     y(array_open);
 752
 753     Con *focused_ws = con_get_workspace(focused);
 754
 755     Con *output;
 756     TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
 757         if (con_is_internal(output))
 758             continue;
 759         Con *ws;
 760         TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
 761             assert(ws->type == CT_WORKSPACE);
 762             y(map_open);
 763
 764             ystr("num");
 765             y(integer, ws->num);
 766
 767             ystr("name");
 768             ystr(ws->name);
 769
 770             ystr("visible");
 771             y(bool, workspace_is_visible(ws));
 772
 773             ystr("focused");
 774             y(bool, ws == focused_ws);
 775
 776             ystr("rect");
 777             y(map_open);
 778             ystr("x");
 779             y(integer, ws->rect.x);
 780             ystr("y");
 781             y(integer, ws->rect.y);
 782             ystr("width");
 783             y(integer, ws->rect.width);
 784             ystr("height");
 785             y(integer, ws->rect.height);
 786             y(map_close);
 787
 788             ystr("output");
 789             ystr(output->name);
 790
 791             ystr("urgent");
 792             y(bool, ws->urgent);
 793
 794             y(map_close);
 795         }
 796     }
 797
 798     y(array_close);
 799
 800     const unsigned char *payload;
 801     ylength length;
 802     y(get_buf, &payload, &length);
 803
 804     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_WORKSPACES, payload);
 805     y(free);
 806 }
 807
 808 /*
 809  * Formats the reply message for a GET_OUTPUTS request and sends it to the
 810  * client
 811  *
 812  */
 813 IPC_HANDLER(get_outputs) {
 814     yajl_gen gen = ygenalloc();
 815     y(array_open);
 816
 817     Output *output;
 818     TAILQ_FOREACH(output, &outputs, outputs) {
 819         y(map_open);
 820
 821         ystr("name");
 822         ystr(output_primary_name(output));
 823
 824         ystr("active");
 825         y(bool, output->active);
 826
 827         ystr("primary");
 828         y(bool, output->primary);
 829
 830         ystr("rect");
 831         y(map_open);
 832         ystr("x");
 833         y(integer, output->rect.x);
 834         ystr("y");
 835         y(integer, output->rect.y);
 836         ystr("width");
 837         y(integer, output->rect.width);
 838         ystr("height");
 839         y(integer, output->rect.height);
 840         y(map_close);
 841
 842         ystr("current_workspace");
 843         Con *ws = NULL;
 844         if (output->con && (ws = con_get_fullscreen_con(output->con, CF_OUTPUT)))
 845             ystr(ws->name);
 846         else
 847             y(null);
 848
 849         y(map_close);
 850     }
 851
 852     y(array_close);
 853
 854     const unsigned char *payload;
 855     ylength length;
 856     y(get_buf, &payload, &length);
 857
 858     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_OUTPUTS, payload);
 859     y(free);
 860 }
 861
 862 /*
 863  * Formats the reply message for a GET_MARKS request and sends it to the
 864  * client
 865  *
 866  */
 867 IPC_HANDLER(get_marks) {
 868     yajl_gen gen = ygenalloc();
 869     y(array_open);
 870
 871     Con *con;
 872     TAILQ_FOREACH(con, &all_cons, all_cons) {
 873         mark_t *mark;
 874         TAILQ_FOREACH(mark, &(con->marks_head), marks) {
 875             ystr(mark->name);
 876         }
 877     }
 878
 879     y(array_close);
 880
 881     const unsigned char *payload;
 882     ylength length;
 883     y(get_buf, &payload, &length);
 884
 885     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_MARKS, payload);
 886     y(free);
 887 }
 888
 889 /*
 890  * Returns the version of i3
 891  *
 892  */
 893 IPC_HANDLER(get_version) {
 894     yajl_gen gen = ygenalloc();
 895     y(map_open);
 896
 897     ystr("major");
 898     y(integer, MAJOR_VERSION);
 899
 900     ystr("minor");
 901     y(integer, MINOR_VERSION);
 902
 903     ystr("patch");
 904     y(integer, PATCH_VERSION);
 905
 906     ystr("human_readable");
 907     ystr(i3_version);
 908
 909     ystr("loaded_config_file_name");
 910     ystr(current_configpath);
 911
 912     y(map_close);
 913
 914     const unsigned char *payload;
 915     ylength length;
 916     y(get_buf, &payload, &length);
 917
 918     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_VERSION, payload);
 919     y(free);
 920 }
 921
 922 /*
 923  * Formats the reply message for a GET_BAR_CONFIG request and sends it to the
 924  * client.
 925  *
 926  */
 927 IPC_HANDLER(get_bar_config) {
 928     yajl_gen gen = ygenalloc();
 929
 930     /* If no ID was passed, we return a JSON array with all IDs */
 931     if (message_size == 0) {
 932         y(array_open);
 933         Barconfig *current;
 934         TAILQ_FOREACH(current, &barconfigs, configs) {
 935             ystr(current->id);
 936         }
 937         y(array_close);
 938
 939         const unsigned char *payload;
 940         ylength length;
 941         y(get_buf, &payload, &length);
 942
 943         ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
 944         y(free);
 945         return;
 946     }
 947
 948     /* To get a properly terminated buffer, we copy
 949      * message_size bytes out of the buffer */
 950     char *bar_id = NULL;
 951     sasprintf(&bar_id, "%.*s", message_size, message);
 952     LOG("IPC: looking for config for bar ID \"%s\"\n", bar_id);
 953     Barconfig *current, *config = NULL;
 954     TAILQ_FOREACH(current, &barconfigs, configs) {
 955         if (strcmp(current->id, bar_id) != 0)
 956             continue;
 957
 958         config = current;
 959         break;
 960     }
 961     free(bar_id);
 962
 963     if (!config) {
 964         /* If we did not find a config for the given ID, the reply will contain
 965          * a null 'id' field. */
 966         y(map_open);
 967
 968         ystr("id");
 969         y(null);
 970
 971         y(map_close);
 972     } else {
 973         dump_bar_config(gen, config);
 974     }
 975
 976     const unsigned char *payload;
 977     ylength length;
 978     y(get_buf, &payload, &length);
 979
 980     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
 981     y(free);
 982 }
 983
 984 /*
 985  * Returns a list of configured binding modes
 986  *
 987  */
 988 IPC_HANDLER(get_binding_modes) {
 989     yajl_gen gen = ygenalloc();
 990
 991     y(array_open);
 992     struct Mode *mode;
 993     SLIST_FOREACH(mode, &modes, modes) {
 994         ystr(mode->name);
 995     }
 996     y(array_close);
 997
 998     const unsigned char *payload;
 999     ylength length;
1000     y(get_buf, &payload, &length);
1001
1002     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BINDING_MODES, payload);
1003     y(free);
1004 }
1005
1006 /*
1007  * Callback for the YAJL parser (will be called when a string is parsed).
1008  *
1009  */
1010 static int add_subscription(void *extra, const unsigned char *s,
1011                             ylength len) {
1012     ipc_client *client = extra;
1013
1014     DLOG("should add subscription to extra %p, sub %.*s\n", client, (int)len, s);
1015     int event = client->num_events;
1016
1017     client->num_events++;
1018     client->events = srealloc(client->events, client->num_events * sizeof(char *));
1019     /* We copy the string because it is not null-terminated and strndup()
1020      * is missing on some BSD systems */
1021     client->events[event] = scalloc(len + 1, 1);
1022     memcpy(client->events[event], s, len);
1023
1024     DLOG("client is now subscribed to:\n");
1025     for (int i = 0; i < client->num_events; i++) {
1026         DLOG("event %s\n", client->events[i]);
1027     }
1028     DLOG("(done)\n");
1029
1030     return 1;
1031 }
1032
1033 /*
1034  * Subscribes this connection to the event types which were given as a JSON
1035  * serialized array in the payload field of the message.
1036  *
1037  */
1038 IPC_HANDLER(subscribe) {
1039     yajl_handle p;
1040     yajl_status stat;
1041     ipc_client *current, *client = NULL;
1042
1043     /* Search the ipc_client structure for this connection */
1044     TAILQ_FOREACH(current, &all_clients, clients) {
1045         if (current->fd != fd)
1046             continue;
1047
1048         client = current;
1049         break;
1050     }
1051
1052     if (client == NULL) {
1053         ELOG("Could not find ipc_client data structure for fd %d\n", fd);
1054         return;
1055     }
1056
1057     /* Setup the JSON parser */
1058     static yajl_callbacks callbacks = {
1059         .yajl_string = add_subscription,
1060     };
1061
1062     p = yalloc(&callbacks, (void *)client);
1063     stat = yajl_parse(p, (const unsigned char *)message, message_size);
1064     if (stat != yajl_status_ok) {
1065         unsigned char *err;
1066         err = yajl_get_error(p, true, (const unsigned char *)message,
1067                              message_size);
1068         ELOG("YAJL parse error: %s\n", err);
1069         yajl_free_error(p, err);
1070
1071         const char *reply = "{\"success\":false}";
1072         ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t *)reply);
1073         yajl_free(p);
1074         return;
1075     }
1076     yajl_free(p);
1077     const char *reply = "{\"success\":true}";
1078     ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t *)reply);
1079
1080     if (client->first_tick_sent) {
1081         return;
1082     }
1083
1084     bool is_tick = false;
1085     for (int i = 0; i < client->num_events; i++) {
1086         if (strcmp(client->events[i], "tick") == 0) {
1087             is_tick = true;
1088             break;
1089         }
1090     }
1091     if (!is_tick) {
1092         return;
1093     }
1094
1095     client->first_tick_sent = true;
1096     const char *payload = "{\"first\":true,\"payload\":\"\"}";
1097     ipc_send_message(client->fd, strlen(payload), I3_IPC_EVENT_TICK, (const uint8_t *)payload);
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 /*
1122  * Sends the tick event from the message payload to subscribers. Establishes a
1123  * synchronization point in event-related tests.
1124  */
1125 IPC_HANDLER(send_tick) {
1126     yajl_gen gen = ygenalloc();
1127
1128     y(map_open);
1129
1130     ystr("payload");
1131     yajl_gen_string(gen, (unsigned char *)message, message_size);
1132
1133     y(map_close);
1134
1135     const unsigned char *payload;
1136     ylength length;
1137     y(get_buf, &payload, &length);
1138
1139     ipc_send_event("tick", I3_IPC_EVENT_TICK, (const char *)payload);
1140     y(free);
1141
1142     const char *reply = "{\"success\":true}";
1143     ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_TICK, (const uint8_t *)reply);
1144     DLOG("Sent tick event\n");
1145 }
1146
1147 struct sync_state {
1148     char *last_key;
1149     uint32_t rnd;
1150     xcb_window_t window;
1151 };
1152
1153 static int _sync_json_key(void *extra, const unsigned char *val, size_t len) {
1154     struct sync_state *state = extra;
1155     FREE(state->last_key);
1156     state->last_key = scalloc(len + 1, 1);
1157     memcpy(state->last_key, val, len);
1158     return 1;
1159 }
1160
1161 static int _sync_json_int(void *extra, long long val) {
1162     struct sync_state *state = extra;
1163     if (strcasecmp(state->last_key, "rnd") == 0) {
1164         state->rnd = val;
1165     } else if (strcasecmp(state->last_key, "window") == 0) {
1166         state->window = (xcb_window_t)val;
1167     }
1168     return 1;
1169 }
1170
1171 IPC_HANDLER(sync) {
1172     yajl_handle p;
1173     yajl_status stat;
1174
1175     /* Setup the JSON parser */
1176     static yajl_callbacks callbacks = {
1177         .yajl_map_key = _sync_json_key,
1178         .yajl_integer = _sync_json_int,
1179     };
1180
1181     struct sync_state state;
1182     memset(&state, '\0', sizeof(struct sync_state));
1183     p = yalloc(&callbacks, (void *)&state);
1184     stat = yajl_parse(p, (const unsigned char *)message, message_size);
1185     FREE(state.last_key);
1186     if (stat != yajl_status_ok) {
1187         unsigned char *err;
1188         err = yajl_get_error(p, true, (const unsigned char *)message,
1189                              message_size);
1190         ELOG("YAJL parse error: %s\n", err);
1191         yajl_free_error(p, err);
1192
1193         const char *reply = "{\"success\":false}";
1194         ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SYNC, (const uint8_t *)reply);
1195         yajl_free(p);
1196         return;
1197     }
1198     yajl_free(p);
1199
1200     DLOG("received IPC sync request (rnd = %d, window = 0x%08x)\n", state.rnd, state.window);
1201     sync_respond(state.window, state.rnd);
1202     const char *reply = "{\"success\":true}";
1203     ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SYNC, (const uint8_t *)reply);
1204 }
1205
1206 /* The index of each callback function corresponds to the numeric
1207  * value of the message type (see include/i3/ipc.h) */
1208 handler_t handlers[12] = {
1209     handle_run_command,
1210     handle_get_workspaces,
1211     handle_subscribe,
1212     handle_get_outputs,
1213     handle_tree,
1214     handle_get_marks,
1215     handle_get_bar_config,
1216     handle_get_version,
1217     handle_get_binding_modes,
1218     handle_get_config,
1219     handle_send_tick,
1220     handle_sync,
1221 };
1222
1223 /*
1224  * Handler for activity on a client connection, receives a message from a
1225  * client.
1226  *
1227  * For now, the maximum message size is 2048. I’m not sure for what the
1228  * IPC interface will be used in the future, thus I’m not implementing a
1229  * mechanism for arbitrarily long messages, as it seems like overkill
1230  * at the moment.
1231  *
1232  */
1233 static void ipc_receive_message(EV_P_ struct ev_io *w, int revents) {
1234     uint32_t message_type;
1235     uint32_t message_length;
1236     uint8_t *message = NULL;
1237
1238     int ret = ipc_recv_message(w->fd, &message_type, &message_length, &message);
1239     /* EOF or other error */
1240     if (ret < 0) {
1241         /* Was this a spurious read? See ev(3) */
1242         if (ret == -1 && errno == EAGAIN) {
1243             FREE(message);
1244             return;
1245         }
1246
1247         /* If not, there was some kind of error. We don’t bother
1248          * and close the connection */
1249         close(w->fd);
1250
1251         /* Delete the client from the list of clients */
1252         ipc_client *current;
1253         TAILQ_FOREACH(current, &all_clients, clients) {
1254             if (current->fd != w->fd)
1255                 continue;
1256
1257             for (int i = 0; i < current->num_events; i++)
1258                 free(current->events[i]);
1259             free(current->events);
1260             /* We can call TAILQ_REMOVE because we break out of the
1261              * TAILQ_FOREACH afterwards */
1262             TAILQ_REMOVE(&all_clients, current, clients);
1263             free(current);
1264             break;
1265         }
1266
1267         ev_io_stop(EV_A_ w);
1268         free(w);
1269         FREE(message);
1270
1271         DLOG("IPC: client disconnected\n");
1272         return;
1273     }
1274
1275     if (message_type >= (sizeof(handlers) / sizeof(handler_t)))
1276         DLOG("Unhandled message type: %d\n", message_type);
1277     else {
1278         handler_t h = handlers[message_type];
1279         h(w->fd, message, 0, message_length, message_type);
1280     }
1281
1282     FREE(message);
1283 }
1284
1285 /*
1286  * Handler for activity on the listening socket, meaning that a new client
1287  * has just connected and we should accept() him. Sets up the event handler
1288  * for activity on the new connection and inserts the file descriptor into
1289  * the list of clients.
1290  *
1291  */
1292 void ipc_new_client(EV_P_ struct ev_io *w, int revents) {
1293     struct sockaddr_un peer;
1294     socklen_t len = sizeof(struct sockaddr_un);
1295     int client;
1296     if ((client = accept(w->fd, (struct sockaddr *)&peer, &len)) < 0) {
1297         if (errno == EINTR)
1298             return;
1299         else
1300             perror("accept()");
1301         return;
1302     }
1303
1304     /* Close this file descriptor on exec() */
1305     (void)fcntl(client, F_SETFD, FD_CLOEXEC);
1306
1307     set_nonblock(client);
1308
1309     struct ev_io *package = scalloc(1, sizeof(struct ev_io));
1310     ev_io_init(package, ipc_receive_message, client, EV_READ);
1311     ev_io_start(EV_A_ package);
1312
1313     DLOG("IPC: new client connected on fd %d\n", w->fd);
1314
1315     ipc_client *new = scalloc(1, sizeof(ipc_client));
1316     new->fd = client;
1317
1318     TAILQ_INSERT_TAIL(&all_clients, new, clients);
1319 }
1320
1321 /*
1322  * Creates the UNIX domain socket at the given path, sets it to non-blocking
1323  * mode, bind()s and listen()s on it.
1324  *
1325  */
1326 int ipc_create_socket(const char *filename) {
1327     int sockfd;
1328
1329     FREE(current_socketpath);
1330
1331     char *resolved = resolve_tilde(filename);
1332     DLOG("Creating IPC-socket at %s\n", resolved);
1333     char *copy = sstrdup(resolved);
1334     const char *dir = dirname(copy);
1335     if (!path_exists(dir))
1336         mkdirp(dir, DEFAULT_DIR_MODE);
1337     free(copy);
1338
1339     /* Unlink the unix domain socket before */
1340     unlink(resolved);
1341
1342     if ((sockfd = socket(AF_LOCAL, SOCK_STREAM, 0)) < 0) {
1343         perror("socket()");
1344         free(resolved);
1345         return -1;
1346     }
1347
1348     (void)fcntl(sockfd, F_SETFD, FD_CLOEXEC);
1349
1350     struct sockaddr_un addr;
1351     memset(&addr, 0, sizeof(struct sockaddr_un));
1352     addr.sun_family = AF_LOCAL;
1353     strncpy(addr.sun_path, resolved, sizeof(addr.sun_path) - 1);
1354     if (bind(sockfd, (struct sockaddr *)&addr, sizeof(struct sockaddr_un)) < 0) {
1355         perror("bind()");
1356         free(resolved);
1357         return -1;
1358     }
1359
1360     set_nonblock(sockfd);
1361
1362     if (listen(sockfd, 5) < 0) {
1363         perror("listen()");
1364         free(resolved);
1365         return -1;
1366     }
1367
1368     current_socketpath = resolved;
1369     return sockfd;
1370 }
1371
1372 /*
1373  * Generates a json workspace event. Returns a dynamically allocated yajl
1374  * generator. Free with yajl_gen_free().
1375  */
1376 yajl_gen ipc_marshal_workspace_event(const char *change, Con *current, Con *old) {
1377     setlocale(LC_NUMERIC, "C");
1378     yajl_gen gen = ygenalloc();
1379
1380     y(map_open);
1381
1382     ystr("change");
1383     ystr(change);
1384
1385     ystr("current");
1386     if (current == NULL)
1387         y(null);
1388     else
1389         dump_node(gen, current, false);
1390
1391     ystr("old");
1392     if (old == NULL)
1393         y(null);
1394     else
1395         dump_node(gen, old, false);
1396
1397     y(map_close);
1398
1399     setlocale(LC_NUMERIC, "");
1400
1401     return gen;
1402 }
1403
1404 /*
1405  * For the workspace events we send, along with the usual "change" field, also
1406  * the workspace container in "current". For focus events, we send the
1407  * previously focused workspace in "old".
1408  */
1409 void ipc_send_workspace_event(const char *change, Con *current, Con *old) {
1410     yajl_gen gen = ipc_marshal_workspace_event(change, current, old);
1411
1412     const unsigned char *payload;
1413     ylength length;
1414     y(get_buf, &payload, &length);
1415
1416     ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, (const char *)payload);
1417
1418     y(free);
1419 }
1420
1421 /**
1422  * For the window events we send, along the usual "change" field,
1423  * also the window container, in "container".
1424  */
1425 void ipc_send_window_event(const char *property, Con *con) {
1426     DLOG("Issue IPC window %s event (con = %p, window = 0x%08x)\n",
1427          property, con, (con->window ? con->window->id : XCB_WINDOW_NONE));
1428
1429     setlocale(LC_NUMERIC, "C");
1430     yajl_gen gen = ygenalloc();
1431
1432     y(map_open);
1433
1434     ystr("change");
1435     ystr(property);
1436
1437     ystr("container");
1438     dump_node(gen, con, false);
1439
1440     y(map_close);
1441
1442     const unsigned char *payload;
1443     ylength length;
1444     y(get_buf, &payload, &length);
1445
1446     ipc_send_event("window", I3_IPC_EVENT_WINDOW, (const char *)payload);
1447     y(free);
1448     setlocale(LC_NUMERIC, "");
1449 }
1450
1451 /**
1452  * For the barconfig update events, we send the serialized barconfig.
1453  */
1454 void ipc_send_barconfig_update_event(Barconfig *barconfig) {
1455     DLOG("Issue barconfig_update event for id = %s\n", barconfig->id);
1456     setlocale(LC_NUMERIC, "C");
1457     yajl_gen gen = ygenalloc();
1458
1459     dump_bar_config(gen, barconfig);
1460
1461     const unsigned char *payload;
1462     ylength length;
1463     y(get_buf, &payload, &length);
1464
1465     ipc_send_event("barconfig_update", I3_IPC_EVENT_BARCONFIG_UPDATE, (const char *)payload);
1466     y(free);
1467     setlocale(LC_NUMERIC, "");
1468 }
1469
1470 /*
1471  * For the binding events, we send the serialized binding struct.
1472  */
1473 void ipc_send_binding_event(const char *event_type, Binding *bind) {
1474     DLOG("Issue IPC binding %s event (sym = %s, code = %d)\n", event_type, bind->symbol, bind->keycode);
1475
1476     setlocale(LC_NUMERIC, "C");
1477
1478     yajl_gen gen = ygenalloc();
1479
1480     y(map_open);
1481
1482     ystr("change");
1483     ystr(event_type);
1484
1485     ystr("binding");
1486     dump_binding(gen, bind);
1487
1488     y(map_close);
1489
1490     const unsigned char *payload;
1491     ylength length;
1492     y(get_buf, &payload, &length);
1493
1494     ipc_send_event("binding", I3_IPC_EVENT_BINDING, (const char *)payload);
1495
1496     y(free);
1497     setlocale(LC_NUMERIC, "");
1498 }