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