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-2012 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 <sys/socket.h>
  13 #include <sys/un.h>
  14 #include <fcntl.h>
  15 #include <libgen.h>
  16 #include <ev.h>
  17 #include <yajl/yajl_gen.h>
  18 #include <yajl/yajl_parse.h>
  19 #include <yajl/yajl_version.h>
  20
  21 char *current_socketpath = NULL;
  22
  23 /* Shorter names for all those yajl_gen_* functions */
  24 #define y(x, ...) yajl_gen_ ## x (gen, ##__VA_ARGS__)
  25 #define ystr(str) yajl_gen_string(gen, (unsigned char*)str, strlen(str))
  26
  27 TAILQ_HEAD(ipc_client_head, ipc_client) all_clients = TAILQ_HEAD_INITIALIZER(all_clients);
  28
  29 /*
  30  * Puts the given socket file descriptor into non-blocking mode or dies if
  31  * setting O_NONBLOCK failed. Non-blocking sockets are a good idea for our
  32  * IPC model because we should by no means block the window manager.
  33  *
  34  */
  35 static void set_nonblock(int sockfd) {
  36     int flags = fcntl(sockfd, F_GETFL, 0);
  37     flags |= O_NONBLOCK;
  38     if (fcntl(sockfd, F_SETFL, flags) < 0)
  39         err(-1, "Could not set O_NONBLOCK");
  40 }
  41
  42 /*
  43  * Emulates mkdir -p (creates any missing folders)
  44  *
  45  */
  46 static bool mkdirp(const char *path) {
  47     if (mkdir(path, S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH) == 0)
  48         return true;
  49     if (errno != ENOENT) {
  50         ELOG("mkdir(%s) failed: %s\n", path, strerror(errno));
  51         return false;
  52     }
  53     char *copy = strdup(path);
  54     /* strip trailing slashes, if any */
  55     while (copy[strlen(copy)-1] == '/')
  56         copy[strlen(copy)-1] = '\0';
  57
  58     char *sep = strrchr(copy, '/');
  59     if (sep == NULL) {
  60         FREE(copy);
  61         return false;
  62     }
  63     *sep = '\0';
  64     bool result = false;
  65     if (mkdirp(copy))
  66         result = mkdirp(path);
  67     free(copy);
  68
  69     return result;
  70 }
  71
  72 /*
  73  * Sends the specified event to all IPC clients which are currently connected
  74  * and subscribed to this kind of event.
  75  *
  76  */
  77 void ipc_send_event(const char *event, uint32_t message_type, const char *payload) {
  78     ipc_client *current;
  79     TAILQ_FOREACH(current, &all_clients, clients) {
  80         /* see if this client is interested in this event */
  81         bool interested = false;
  82         for (int i = 0; i < current->num_events; i++) {
  83             if (strcasecmp(current->events[i], event) != 0)
  84                 continue;
  85             interested = true;
  86             break;
  87         }
  88         if (!interested)
  89             continue;
  90
  91         ipc_send_message(current->fd, strlen(payload), message_type, (const uint8_t*)payload);
  92     }
  93 }
  94
  95 /*
  96  * Calls shutdown() on each socket and closes it. This function to be called
  97  * when exiting or restarting only!
  98  *
  99  */
 100 void ipc_shutdown(void) {
 101     ipc_client *current;
 102     while (!TAILQ_EMPTY(&all_clients)) {
 103         current = TAILQ_FIRST(&all_clients);
 104         shutdown(current->fd, SHUT_RDWR);
 105         close(current->fd);
 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);
 120     strncpy(command, (const char*)message, message_size);
 121     LOG("IPC: received: *%s*\n", command);
 122     struct CommandResult *command_output = parse_command((const char*)command);
 123     free(command);
 124
 125     if (command_output->needs_tree_render)
 126         tree_render();
 127
 128     const unsigned char *reply;
 129 #if YAJL_MAJOR >= 2
 130     size_t length;
 131 #else
 132     unsigned int length;
 133 #endif
 134     yajl_gen_get_buf(command_output->json_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(command_output->json_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 void dump_node(yajl_gen gen, struct Con *con, bool inplace_restart) {
 157     y(map_open);
 158     ystr("id");
 159     y(integer, (long int)con);
 160
 161     ystr("type");
 162     y(integer, con->type);
 163
 164     /* provided for backwards compatibility only. */
 165     ystr("orientation");
 166     if (!con->split)
 167         ystr("none");
 168     else {
 169         if (con_orientation(con) == HORIZ)
 170             ystr("horizontal");
 171         else ystr("vertical");
 172     }
 173
 174     ystr("scratchpad_state");
 175     switch (con->scratchpad_state) {
 176         case SCRATCHPAD_NONE:
 177             ystr("none");
 178             break;
 179         case SCRATCHPAD_FRESH:
 180             ystr("fresh");
 181             break;
 182         case SCRATCHPAD_CHANGED:
 183             ystr("changed");
 184             break;
 185     }
 186
 187     ystr("percent");
 188     if (con->percent == 0.0)
 189         y(null);
 190     else y(double, con->percent);
 191
 192     ystr("urgent");
 193     y(bool, con->urgent);
 194
 195     if (con->mark != NULL) {
 196         ystr("mark");
 197         ystr(con->mark);
 198     }
 199
 200     ystr("focused");
 201     y(bool, (con == focused));
 202
 203     ystr("split");
 204     y(bool, con->split);
 205
 206     ystr("layout");
 207     switch (con->layout) {
 208         case L_DEFAULT:
 209             DLOG("About to dump layout=default, this is a bug in the code.\n");
 210             assert(false);
 211             break;
 212         case L_SPLITV:
 213             ystr("splitv");
 214             break;
 215         case L_SPLITH:
 216             ystr("splith");
 217             break;
 218         case L_STACKED:
 219             ystr("stacked");
 220             break;
 221         case L_TABBED:
 222             ystr("tabbed");
 223             break;
 224         case L_DOCKAREA:
 225             ystr("dockarea");
 226             break;
 227         case L_OUTPUT:
 228             ystr("output");
 229             break;
 230     }
 231
 232     ystr("last_split_layout");
 233     switch (con->layout) {
 234         case L_SPLITV:
 235             ystr("splitv");
 236             break;
 237         default:
 238             ystr("splith");
 239             break;
 240     }
 241
 242     ystr("border");
 243     switch (con->border_style) {
 244         case BS_NORMAL:
 245             ystr("normal");
 246             break;
 247         case BS_NONE:
 248             ystr("none");
 249             break;
 250         case BS_1PIXEL:
 251             ystr("1pixel");
 252             break;
 253     }
 254
 255     dump_rect(gen, "rect", con->rect);
 256     dump_rect(gen, "window_rect", con->window_rect);
 257     dump_rect(gen, "geometry", con->geometry);
 258
 259     ystr("name");
 260     if (con->window && con->window->name_json)
 261         ystr(con->window->name_json);
 262     else
 263         ystr(con->name);
 264
 265     if (con->type == CT_WORKSPACE) {
 266         ystr("num");
 267         y(integer, con->num);
 268     }
 269
 270     ystr("window");
 271     if (con->window)
 272         y(integer, con->window->id);
 273     else y(null);
 274
 275     ystr("nodes");
 276     y(array_open);
 277     Con *node;
 278     if (con->type != CT_DOCKAREA || !inplace_restart) {
 279         TAILQ_FOREACH(node, &(con->nodes_head), nodes) {
 280             dump_node(gen, node, inplace_restart);
 281         }
 282     }
 283     y(array_close);
 284
 285     ystr("floating_nodes");
 286     y(array_open);
 287     TAILQ_FOREACH(node, &(con->floating_head), floating_windows) {
 288         dump_node(gen, node, inplace_restart);
 289     }
 290     y(array_close);
 291
 292     ystr("focus");
 293     y(array_open);
 294     TAILQ_FOREACH(node, &(con->focus_head), focused) {
 295         y(integer, (long int)node);
 296     }
 297     y(array_close);
 298
 299     ystr("fullscreen_mode");
 300     y(integer, con->fullscreen_mode);
 301
 302     ystr("floating");
 303     switch (con->floating) {
 304         case FLOATING_AUTO_OFF:
 305             ystr("auto_off");
 306             break;
 307         case FLOATING_AUTO_ON:
 308             ystr("auto_on");
 309             break;
 310         case FLOATING_USER_OFF:
 311             ystr("user_off");
 312             break;
 313         case FLOATING_USER_ON:
 314             ystr("user_on");
 315             break;
 316     }
 317
 318     ystr("swallows");
 319     y(array_open);
 320     Match *match;
 321     TAILQ_FOREACH(match, &(con->swallow_head), matches) {
 322         if (match->dock != -1) {
 323             y(map_open);
 324             ystr("dock");
 325             y(integer, match->dock);
 326             ystr("insert_where");
 327             y(integer, match->insert_where);
 328             y(map_close);
 329         }
 330
 331         /* TODO: the other swallow keys */
 332     }
 333
 334     if (inplace_restart) {
 335         if (con->window != NULL) {
 336             y(map_open);
 337             ystr("id");
 338             y(integer, con->window->id);
 339             ystr("restart_mode");
 340             y(bool, true);
 341             y(map_close);
 342         }
 343     }
 344     y(array_close);
 345
 346     y(map_close);
 347 }
 348
 349 IPC_HANDLER(tree) {
 350     setlocale(LC_NUMERIC, "C");
 351 #if YAJL_MAJOR >= 2
 352     yajl_gen gen = yajl_gen_alloc(NULL);
 353 #else
 354     yajl_gen gen = yajl_gen_alloc(NULL, NULL);
 355 #endif
 356     dump_node(gen, croot, false);
 357     setlocale(LC_NUMERIC, "");
 358
 359     const unsigned char *payload;
 360 #if YAJL_MAJOR >= 2
 361     size_t length;
 362 #else
 363     unsigned int length;
 364 #endif
 365     y(get_buf, &payload, &length);
 366
 367     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_TREE, payload);
 368     y(free);
 369 }
 370
 371
 372 /*
 373  * Formats the reply message for a GET_WORKSPACES request and sends it to the
 374  * client
 375  *
 376  */
 377 IPC_HANDLER(get_workspaces) {
 378 #if YAJL_MAJOR >= 2
 379     yajl_gen gen = yajl_gen_alloc(NULL);
 380 #else
 381     yajl_gen gen = yajl_gen_alloc(NULL, NULL);
 382 #endif
 383     y(array_open);
 384
 385     Con *focused_ws = con_get_workspace(focused);
 386
 387     Con *output;
 388     TAILQ_FOREACH(output, &(croot->nodes_head), nodes) {
 389         if (output->name[0] == '_' && output->name[1] == '_')
 390             continue;
 391         Con *ws;
 392         TAILQ_FOREACH(ws, &(output_get_content(output)->nodes_head), nodes) {
 393             assert(ws->type == CT_WORKSPACE);
 394             y(map_open);
 395
 396             ystr("num");
 397             if (ws->num == -1)
 398                 y(null);
 399             else y(integer, ws->num);
 400
 401             ystr("name");
 402             ystr(ws->name);
 403
 404             ystr("visible");
 405             y(bool, workspace_is_visible(ws));
 406
 407             ystr("focused");
 408             y(bool, ws == focused_ws);
 409
 410             ystr("rect");
 411             y(map_open);
 412             ystr("x");
 413             y(integer, ws->rect.x);
 414             ystr("y");
 415             y(integer, ws->rect.y);
 416             ystr("width");
 417             y(integer, ws->rect.width);
 418             ystr("height");
 419             y(integer, ws->rect.height);
 420             y(map_close);
 421
 422             ystr("output");
 423             ystr(output->name);
 424
 425             ystr("urgent");
 426             y(bool, ws->urgent);
 427
 428             y(map_close);
 429         }
 430     }
 431
 432     y(array_close);
 433
 434     const unsigned char *payload;
 435 #if YAJL_MAJOR >= 2
 436     size_t length;
 437 #else
 438     unsigned int length;
 439 #endif
 440     y(get_buf, &payload, &length);
 441
 442     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_WORKSPACES, payload);
 443     y(free);
 444 }
 445
 446 /*
 447  * Formats the reply message for a GET_OUTPUTS request and sends it to the
 448  * client
 449  *
 450  */
 451 IPC_HANDLER(get_outputs) {
 452 #if YAJL_MAJOR >= 2
 453     yajl_gen gen = yajl_gen_alloc(NULL);
 454 #else
 455     yajl_gen gen = yajl_gen_alloc(NULL, NULL);
 456 #endif
 457     y(array_open);
 458
 459     Output *output;
 460     TAILQ_FOREACH(output, &outputs, outputs) {
 461         y(map_open);
 462
 463         ystr("name");
 464         ystr(output->name);
 465
 466         ystr("active");
 467         y(bool, output->active);
 468
 469         ystr("primary");
 470         y(bool, output->primary);
 471
 472         ystr("rect");
 473         y(map_open);
 474         ystr("x");
 475         y(integer, output->rect.x);
 476         ystr("y");
 477         y(integer, output->rect.y);
 478         ystr("width");
 479         y(integer, output->rect.width);
 480         ystr("height");
 481         y(integer, output->rect.height);
 482         y(map_close);
 483
 484         ystr("current_workspace");
 485         Con *ws = NULL;
 486         if (output->con && (ws = con_get_fullscreen_con(output->con, CF_OUTPUT)))
 487             ystr(ws->name);
 488         else y(null);
 489
 490         y(map_close);
 491     }
 492
 493     y(array_close);
 494
 495     const unsigned char *payload;
 496 #if YAJL_MAJOR >= 2
 497     size_t length;
 498 #else
 499     unsigned int length;
 500 #endif
 501     y(get_buf, &payload, &length);
 502
 503     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_OUTPUTS, payload);
 504     y(free);
 505 }
 506
 507 /*
 508  * Formats the reply message for a GET_MARKS request and sends it to the
 509  * client
 510  *
 511  */
 512 IPC_HANDLER(get_marks) {
 513 #if YAJL_MAJOR >= 2
 514     yajl_gen gen = yajl_gen_alloc(NULL);
 515 #else
 516     yajl_gen gen = yajl_gen_alloc(NULL, NULL);
 517 #endif
 518     y(array_open);
 519
 520     Con *con;
 521     TAILQ_FOREACH(con, &all_cons, all_cons)
 522         if (con->mark != NULL)
 523             ystr(con->mark);
 524
 525     y(array_close);
 526
 527     const unsigned char *payload;
 528 #if YAJL_MAJOR >= 2
 529     size_t length;
 530 #else
 531     unsigned int length;
 532 #endif
 533     y(get_buf, &payload, &length);
 534
 535     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_MARKS, payload);
 536     y(free);
 537 }
 538
 539 /*
 540  * Formats the reply message for a GET_BAR_CONFIG request and sends it to the
 541  * client.
 542  *
 543  */
 544 IPC_HANDLER(get_bar_config) {
 545 #if YAJL_MAJOR >= 2
 546     yajl_gen gen = yajl_gen_alloc(NULL);
 547 #else
 548     yajl_gen gen = yajl_gen_alloc(NULL, NULL);
 549 #endif
 550
 551     /* If no ID was passed, we return a JSON array with all IDs */
 552     if (message_size == 0) {
 553         y(array_open);
 554         Barconfig *current;
 555         TAILQ_FOREACH(current, &barconfigs, configs) {
 556             ystr(current->id);
 557         }
 558         y(array_close);
 559
 560         const unsigned char *payload;
 561 #if YAJL_MAJOR >= 2
 562         size_t length;
 563 #else
 564         unsigned int length;
 565 #endif
 566         y(get_buf, &payload, &length);
 567
 568         ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
 569         y(free);
 570         return;
 571     }
 572
 573     /* To get a properly terminated buffer, we copy
 574      * message_size bytes out of the buffer */
 575     char *bar_id = scalloc(message_size + 1);
 576     strncpy(bar_id, (const char*)message, message_size);
 577     LOG("IPC: looking for config for bar ID \"%s\"\n", bar_id);
 578     Barconfig *current, *config = NULL;
 579     TAILQ_FOREACH(current, &barconfigs, configs) {
 580         if (strcmp(current->id, bar_id) != 0)
 581             continue;
 582
 583         config = current;
 584         break;
 585     }
 586
 587     y(map_open);
 588
 589     if (!config) {
 590         /* If we did not find a config for the given ID, the reply will contain
 591          * a null 'id' field. */
 592         ystr("id");
 593         y(null);
 594     } else {
 595         ystr("id");
 596         ystr(config->id);
 597
 598         if (config->num_outputs > 0) {
 599             ystr("outputs");
 600             y(array_open);
 601             for (int c = 0; c < config->num_outputs; c++)
 602                 ystr(config->outputs[c]);
 603             y(array_close);
 604         }
 605
 606 #define YSTR_IF_SET(name) \
 607         do { \
 608             if (config->name) { \
 609                 ystr( # name); \
 610                 ystr(config->name); \
 611             } \
 612         } while (0)
 613
 614         YSTR_IF_SET(tray_output);
 615         YSTR_IF_SET(socket_path);
 616
 617         ystr("mode");
 618         if (config->mode == M_HIDE)
 619             ystr("hide");
 620         else ystr("dock");
 621
 622         ystr("modifier");
 623         switch (config->modifier) {
 624             case M_CONTROL:
 625                 ystr("ctrl");
 626                 break;
 627             case M_SHIFT:
 628                 ystr("shift");
 629                 break;
 630             case M_MOD1:
 631                 ystr("Mod1");
 632                 break;
 633             case M_MOD2:
 634                 ystr("Mod2");
 635                 break;
 636             case M_MOD3:
 637                 ystr("Mod3");
 638                 break;
 639             /*
 640             case M_MOD4:
 641                 ystr("Mod4");
 642                 break;
 643             */
 644             case M_MOD5:
 645                 ystr("Mod5");
 646                 break;
 647             default:
 648                 ystr("Mod4");
 649                 break;
 650         }
 651
 652         ystr("position");
 653         if (config->position == P_BOTTOM)
 654             ystr("bottom");
 655         else ystr("top");
 656
 657         YSTR_IF_SET(status_command);
 658         YSTR_IF_SET(font);
 659
 660         ystr("workspace_buttons");
 661         y(bool, !config->hide_workspace_buttons);
 662
 663         ystr("verbose");
 664         y(bool, config->verbose);
 665
 666 #undef YSTR_IF_SET
 667 #define YSTR_IF_SET(name) \
 668         do { \
 669             if (config->colors.name) { \
 670                 ystr( # name); \
 671                 ystr(config->colors.name); \
 672             } \
 673         } while (0)
 674
 675         ystr("colors");
 676         y(map_open);
 677         YSTR_IF_SET(background);
 678         YSTR_IF_SET(statusline);
 679         YSTR_IF_SET(focused_workspace_border);
 680         YSTR_IF_SET(focused_workspace_bg);
 681         YSTR_IF_SET(focused_workspace_text);
 682         YSTR_IF_SET(active_workspace_border);
 683         YSTR_IF_SET(active_workspace_bg);
 684         YSTR_IF_SET(active_workspace_text);
 685         YSTR_IF_SET(inactive_workspace_border);
 686         YSTR_IF_SET(inactive_workspace_bg);
 687         YSTR_IF_SET(inactive_workspace_text);
 688         YSTR_IF_SET(urgent_workspace_border);
 689         YSTR_IF_SET(urgent_workspace_bg);
 690         YSTR_IF_SET(urgent_workspace_text);
 691         y(map_close);
 692
 693 #undef YSTR_IF_SET
 694     }
 695
 696     y(map_close);
 697
 698     const unsigned char *payload;
 699 #if YAJL_MAJOR >= 2
 700     size_t length;
 701 #else
 702     unsigned int length;
 703 #endif
 704     y(get_buf, &payload, &length);
 705
 706     ipc_send_message(fd, length, I3_IPC_REPLY_TYPE_BAR_CONFIG, payload);
 707     y(free);
 708 }
 709
 710 /*
 711  * Callback for the YAJL parser (will be called when a string is parsed).
 712  *
 713  */
 714 #if YAJL_MAJOR < 2
 715 static int add_subscription(void *extra, const unsigned char *s,
 716                             unsigned int len) {
 717 #else
 718 static int add_subscription(void *extra, const unsigned char *s,
 719                             size_t len) {
 720 #endif
 721     ipc_client *client = extra;
 722
 723     DLOG("should add subscription to extra %p, sub %.*s\n", client, len, s);
 724     int event = client->num_events;
 725
 726     client->num_events++;
 727     client->events = realloc(client->events, client->num_events * sizeof(char*));
 728     /* We copy the string because it is not null-terminated and strndup()
 729      * is missing on some BSD systems */
 730     client->events[event] = scalloc(len+1);
 731     memcpy(client->events[event], s, len);
 732
 733     DLOG("client is now subscribed to:\n");
 734     for (int i = 0; i < client->num_events; i++)
 735         DLOG("event %s\n", client->events[i]);
 736     DLOG("(done)\n");
 737
 738     return 1;
 739 }
 740
 741 /*
 742  * Subscribes this connection to the event types which were given as a JSON
 743  * serialized array in the payload field of the message.
 744  *
 745  */
 746 IPC_HANDLER(subscribe) {
 747     yajl_handle p;
 748     yajl_callbacks callbacks;
 749     yajl_status stat;
 750     ipc_client *current, *client = NULL;
 751
 752     /* Search the ipc_client structure for this connection */
 753     TAILQ_FOREACH(current, &all_clients, clients) {
 754         if (current->fd != fd)
 755             continue;
 756
 757         client = current;
 758         break;
 759     }
 760
 761     if (client == NULL) {
 762         ELOG("Could not find ipc_client data structure for fd %d\n", fd);
 763         return;
 764     }
 765
 766     /* Setup the JSON parser */
 767     memset(&callbacks, 0, sizeof(yajl_callbacks));
 768     callbacks.yajl_string = add_subscription;
 769
 770 #if YAJL_MAJOR >= 2
 771     p = yajl_alloc(&callbacks, NULL, (void*)client);
 772 #else
 773     p = yajl_alloc(&callbacks, NULL, NULL, (void*)client);
 774 #endif
 775     stat = yajl_parse(p, (const unsigned char*)message, message_size);
 776     if (stat != yajl_status_ok) {
 777         unsigned char *err;
 778         err = yajl_get_error(p, true, (const unsigned char*)message,
 779                              message_size);
 780         ELOG("YAJL parse error: %s\n", err);
 781         yajl_free_error(p, err);
 782
 783         const char *reply = "{\"success\":false}";
 784         ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t*)reply);
 785         yajl_free(p);
 786         return;
 787     }
 788     yajl_free(p);
 789     const char *reply = "{\"success\":true}";
 790     ipc_send_message(fd, strlen(reply), I3_IPC_REPLY_TYPE_SUBSCRIBE, (const uint8_t*)reply);
 791 }
 792
 793 /* The index of each callback function corresponds to the numeric
 794  * value of the message type (see include/i3/ipc.h) */
 795 handler_t handlers[7] = {
 796     handle_command,
 797     handle_get_workspaces,
 798     handle_subscribe,
 799     handle_get_outputs,
 800     handle_tree,
 801     handle_get_marks,
 802     handle_get_bar_config,
 803 };
 804
 805 /*
 806  * Handler for activity on a client connection, receives a message from a
 807  * client.
 808  *
 809  * For now, the maximum message size is 2048. I’m not sure for what the
 810  * IPC interface will be used in the future, thus I’m not implementing a
 811  * mechanism for arbitrarily long messages, as it seems like overkill
 812  * at the moment.
 813  *
 814  */
 815 static void ipc_receive_message(EV_P_ struct ev_io *w, int revents) {
 816     char buf[2048];
 817     int n = read(w->fd, buf, sizeof(buf));
 818
 819     /* On error or an empty message, we close the connection */
 820     if (n <= 0) {
 821 #if 0
 822         /* FIXME: I get these when closing a client socket,
 823          * therefore we just treat them as an error. Is this
 824          * correct? */
 825         if (errno == EAGAIN || errno == EWOULDBLOCK)
 826                 return;
 827 #endif
 828
 829         /* If not, there was some kind of error. We don’t bother
 830          * and close the connection */
 831         close(w->fd);
 832
 833         /* Delete the client from the list of clients */
 834         ipc_client *current;
 835         TAILQ_FOREACH(current, &all_clients, clients) {
 836             if (current->fd != w->fd)
 837                 continue;
 838
 839             for (int i = 0; i < current->num_events; i++)
 840                 free(current->events[i]);
 841             /* We can call TAILQ_REMOVE because we break out of the
 842              * TAILQ_FOREACH afterwards */
 843             TAILQ_REMOVE(&all_clients, current, clients);
 844             free(current);
 845             break;
 846         }
 847
 848         ev_io_stop(EV_A_ w);
 849         free(w);
 850
 851         DLOG("IPC: client disconnected\n");
 852         return;
 853     }
 854
 855     /* Terminate the message correctly */
 856     buf[n] = '\0';
 857
 858     /* Check if the message starts with the i3 IPC magic code */
 859     if (n < strlen(I3_IPC_MAGIC)) {
 860         DLOG("IPC: message too short, ignoring\n");
 861         return;
 862     }
 863
 864     if (strncmp(buf, I3_IPC_MAGIC, strlen(I3_IPC_MAGIC)) != 0) {
 865         DLOG("IPC: message does not start with the IPC magic\n");
 866         return;
 867     }
 868
 869     uint8_t *message = (uint8_t*)buf;
 870     while (n > 0) {
 871         DLOG("IPC: n = %d\n", n);
 872         message += strlen(I3_IPC_MAGIC);
 873         n -= strlen(I3_IPC_MAGIC);
 874
 875         /* The next 32 bit after the magic are the message size */
 876         uint32_t message_size;
 877         memcpy(&message_size, (uint32_t*)message, sizeof(uint32_t));
 878         message += sizeof(uint32_t);
 879         n -= sizeof(uint32_t);
 880
 881         if (message_size > n) {
 882             DLOG("IPC: Either the message size was wrong or the message was not read completely, dropping\n");
 883             return;
 884         }
 885
 886         /* The last 32 bits of the header are the message type */
 887         uint32_t message_type;
 888         memcpy(&message_type, (uint32_t*)message, sizeof(uint32_t));
 889         message += sizeof(uint32_t);
 890         n -= sizeof(uint32_t);
 891
 892         if (message_type >= (sizeof(handlers) / sizeof(handler_t)))
 893             DLOG("Unhandled message type: %d\n", message_type);
 894         else {
 895             handler_t h = handlers[message_type];
 896             h(w->fd, message, n, message_size, message_type);
 897         }
 898         n -= message_size;
 899         message += message_size;
 900     }
 901 }
 902
 903 /*
 904  * Handler for activity on the listening socket, meaning that a new client
 905  * has just connected and we should accept() him. Sets up the event handler
 906  * for activity on the new connection and inserts the file descriptor into
 907  * the list of clients.
 908  *
 909  */
 910 void ipc_new_client(EV_P_ struct ev_io *w, int revents) {
 911     struct sockaddr_un peer;
 912     socklen_t len = sizeof(struct sockaddr_un);
 913     int client;
 914     if ((client = accept(w->fd, (struct sockaddr*)&peer, &len)) < 0) {
 915         if (errno == EINTR)
 916             return;
 917         else perror("accept()");
 918         return;
 919     }
 920
 921     /* Close this file descriptor on exec() */
 922     (void)fcntl(client, F_SETFD, FD_CLOEXEC);
 923
 924     set_nonblock(client);
 925
 926     struct ev_io *package = scalloc(sizeof(struct ev_io));
 927     ev_io_init(package, ipc_receive_message, client, EV_READ);
 928     ev_io_start(EV_A_ package);
 929
 930     DLOG("IPC: new client connected on fd %d\n", w->fd);
 931
 932     ipc_client *new = scalloc(sizeof(ipc_client));
 933     new->fd = client;
 934
 935     TAILQ_INSERT_TAIL(&all_clients, new, clients);
 936 }
 937
 938 /*
 939  * Creates the UNIX domain socket at the given path, sets it to non-blocking
 940  * mode, bind()s and listen()s on it.
 941  *
 942  */
 943 int ipc_create_socket(const char *filename) {
 944     int sockfd;
 945
 946     FREE(current_socketpath);
 947
 948     char *resolved = resolve_tilde(filename);
 949     DLOG("Creating IPC-socket at %s\n", resolved);
 950     char *copy = sstrdup(resolved);
 951     const char *dir = dirname(copy);
 952     if (!path_exists(dir))
 953         mkdirp(dir);
 954     free(copy);
 955
 956     /* Unlink the unix domain socket before */
 957     unlink(resolved);
 958
 959     if ((sockfd = socket(AF_LOCAL, SOCK_STREAM, 0)) < 0) {
 960         perror("socket()");
 961         free(resolved);
 962         return -1;
 963     }
 964
 965     (void)fcntl(sockfd, F_SETFD, FD_CLOEXEC);
 966
 967     struct sockaddr_un addr;
 968     memset(&addr, 0, sizeof(struct sockaddr_un));
 969     addr.sun_family = AF_LOCAL;
 970     strncpy(addr.sun_path, resolved, sizeof(addr.sun_path) - 1);
 971     if (bind(sockfd, (struct sockaddr*)&addr, sizeof(struct sockaddr_un)) < 0) {
 972         perror("bind()");
 973         free(resolved);
 974         return -1;
 975     }
 976
 977     set_nonblock(sockfd);
 978
 979     if (listen(sockfd, 5) < 0) {
 980         perror("listen()");
 981         free(resolved);
 982         return -1;
 983     }
 984
 985     current_socketpath = resolved;
 986     return sockfd;
 987 }