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

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3bar - an xcb-based status- and ws-bar for i3
   5  * © 2010 Axel Wagner and contributors (see also: LICENSE)
   6  *
   7  * ipc.c: Communicating with i3
   8  *
   9  */
  10 #include "common.h"
  11
  12 #include <stdlib.h>
  13 #include <stdio.h>
  14 #include <unistd.h>
  15 #include <stdint.h>
  16 #include <string.h>
  17 #include <errno.h>
  18 #include <sys/socket.h>
  19 #include <sys/un.h>
  20 #include <i3/ipc.h>
  21 #include <ev.h>
  22 #ifdef I3_ASAN_ENABLED
  23 #include <sanitizer/lsan_interface.h>
  24 #endif
  25
  26 ev_io *i3_connection;
  27
  28 const char *sock_path;
  29
  30 typedef void (*handler_t)(char *);
  31
  32 /*
  33  * Called, when we get a reply to a command from i3.
  34  * Since i3 does not give us much feedback on commands, we do not much
  35  *
  36  */
  37 void got_command_reply(char *reply) {
  38     /* TODO: Error handling for command replies */
  39 }
  40
  41 /*
  42  * Called, when we get a reply with workspaces data
  43  *
  44  */
  45 void got_workspace_reply(char *reply) {
  46     DLOG("Got workspace data!\n");
  47     parse_workspaces_json(reply);
  48     draw_bars(false);
  49 }
  50
  51 /*
  52  * Called, when we get a reply for a subscription.
  53  * Since i3 does not give us much feedback on commands, we do not much
  54  *
  55  */
  56 void got_subscribe_reply(char *reply) {
  57     DLOG("Got subscribe reply: %s\n", reply);
  58     /* TODO: Error handling for subscribe commands */
  59 }
  60
  61 /*
  62  * Called, when we get a reply with outputs data
  63  *
  64  */
  65 void got_output_reply(char *reply) {
  66     DLOG("Clearing old output configuration...\n");
  67     i3_output *o_walk;
  68     SLIST_FOREACH(o_walk, outputs, slist) {
  69         destroy_window(o_walk);
  70     }
  71     FREE_SLIST(outputs, i3_output);
  72
  73     DLOG("Parsing outputs JSON...\n");
  74     parse_outputs_json(reply);
  75     DLOG("Reconfiguring windows...\n");
  76     reconfig_windows(false);
  77
  78     SLIST_FOREACH(o_walk, outputs, slist) {
  79         kick_tray_clients(o_walk);
  80     }
  81
  82     if (!config.disable_ws) {
  83         i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_WORKSPACES, NULL);
  84     }
  85
  86     draw_bars(false);
  87 }
  88
  89 /*
  90  * Called when we get the configuration for our bar instance
  91  *
  92  */
  93 void got_bar_config(char *reply) {
  94     DLOG("Received bar config \"%s\"\n", reply);
  95     /* We initiate the main function by requesting infos about the outputs and
  96      * workspaces. Everything else (creating the bars, showing the right workspace-
  97      * buttons and more) is taken care of by the event-drivenness of the code */
  98     i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_OUTPUTS, NULL);
  99
 100     free_colors(&(config.colors));
 101     parse_config_json(reply);
 102
 103     /* Now we can actually use 'config', so let's subscribe to the appropriate
 104      * events and request the workspaces if necessary. */
 105     subscribe_events();
 106     if (!config.disable_ws)
 107         i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_WORKSPACES, NULL);
 108
 109     /* Initialize the rest of XCB */
 110     init_xcb_late(config.fontname);
 111
 112     /* Resolve color strings to colorpixels and save them, then free the strings. */
 113     init_colors(&(config.colors));
 114
 115     start_child(config.command);
 116     FREE(config.command);
 117 }
 118
 119 /* Data structure to easily call the reply handlers later */
 120 handler_t reply_handlers[] = {
 121     &got_command_reply,
 122     &got_workspace_reply,
 123     &got_subscribe_reply,
 124     &got_output_reply,
 125     NULL,
 126     NULL,
 127     &got_bar_config,
 128 };
 129
 130 /*
 131  * Called, when a workspace event arrives (i.e. the user changed the workspace)
 132  *
 133  */
 134 void got_workspace_event(char *event) {
 135     DLOG("Got workspace event!\n");
 136     i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_WORKSPACES, NULL);
 137 }
 138
 139 /*
 140  * Called, when an output event arrives (i.e. the screen configuration changed)
 141  *
 142  */
 143 void got_output_event(char *event) {
 144     DLOG("Got output event!\n");
 145     i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_OUTPUTS, NULL);
 146     if (!config.disable_ws) {
 147         i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_WORKSPACES, NULL);
 148     }
 149 }
 150
 151 /*
 152  * Called, when a mode event arrives (i3 changed binding mode).
 153  *
 154  */
 155 void got_mode_event(char *event) {
 156     DLOG("Got mode event!\n");
 157     parse_mode_json(event);
 158     draw_bars(false);
 159 }
 160
 161 /*
 162  * Called, when a barconfig_update event arrives (i.e. i3 changed the bar hidden_state or mode)
 163  *
 164  */
 165 void got_bar_config_update(char *event) {
 166     /* check whether this affect this bar instance by checking the bar_id */
 167     char *expected_id;
 168     sasprintf(&expected_id, "\"id\":\"%s\"", config.bar_id);
 169     char *found_id = strstr(event, expected_id);
 170     FREE(expected_id);
 171     if (found_id == NULL)
 172         return;
 173
 174     /* reconfigure the bar based on the current outputs */
 175     i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_OUTPUTS, NULL);
 176
 177     free_colors(&(config.colors));
 178
 179     /* update the configuration with the received settings */
 180     DLOG("Received bar config update \"%s\"\n", event);
 181     bar_display_mode_t old_mode = config.hide_on_modifier;
 182     parse_config_json(event);
 183     if (old_mode != config.hide_on_modifier) {
 184         reconfig_windows(true);
 185     }
 186
 187     /* update fonts and colors */
 188     init_xcb_late(config.fontname);
 189     init_colors(&(config.colors));
 190
 191     /* restart status command process */
 192     kill_child();
 193     start_child(config.command);
 194     FREE(config.command);
 195
 196     draw_bars(false);
 197 }
 198
 199 /* Data structure to easily call the event handlers later */
 200 handler_t event_handlers[] = {
 201     &got_workspace_event,
 202     &got_output_event,
 203     &got_mode_event,
 204     NULL,
 205     &got_bar_config_update,
 206 };
 207
 208 /*
 209  * Called, when we get a message from i3
 210  *
 211  */
 212 void got_data(struct ev_loop *loop, ev_io *watcher, int events) {
 213     DLOG("Got data!\n");
 214     int fd = watcher->fd;
 215
 216     /* First we only read the header, because we know its length */
 217     uint32_t header_len = strlen(I3_IPC_MAGIC) + sizeof(uint32_t) * 2;
 218     char *header = smalloc(header_len);
 219
 220     /* We first parse the fixed-length IPC header, to know, how much data
 221      * we have to expect */
 222     uint32_t rec = 0;
 223     while (rec < header_len) {
 224         int n = read(fd, header + rec, header_len - rec);
 225         if (n == -1) {
 226             ELOG("read() failed: %s\n", strerror(errno));
 227             exit(EXIT_FAILURE);
 228         }
 229         if (n == 0) {
 230             /* EOF received. Since i3 will restart i3bar instances as appropriate,
 231              * we exit here. */
 232             DLOG("EOF received, exiting...\n");
 233 #ifdef I3_ASAN_ENABLED
 234             __lsan_do_leak_check();
 235 #endif
 236             clean_xcb();
 237             exit(EXIT_SUCCESS);
 238         }
 239         rec += n;
 240     }
 241
 242     if (strncmp(header, I3_IPC_MAGIC, strlen(I3_IPC_MAGIC))) {
 243         ELOG("Wrong magic code: %.*s\n Expected: %s\n",
 244              (int)strlen(I3_IPC_MAGIC),
 245              header,
 246              I3_IPC_MAGIC);
 247         exit(EXIT_FAILURE);
 248     }
 249
 250     char *walk = header + strlen(I3_IPC_MAGIC);
 251     uint32_t size;
 252     memcpy(&size, (uint32_t *)walk, sizeof(uint32_t));
 253     walk += sizeof(uint32_t);
 254     uint32_t type;
 255     memcpy(&type, (uint32_t *)walk, sizeof(uint32_t));
 256
 257     /* Now that we know, what to expect, we can start read()ing the rest
 258      * of the message */
 259     char *buffer = smalloc(size + 1);
 260     rec = 0;
 261
 262     while (rec < size) {
 263         int n = read(fd, buffer + rec, size - rec);
 264         if (n == -1) {
 265             ELOG("read() failed: %s\n", strerror(errno));
 266             exit(EXIT_FAILURE);
 267         }
 268         if (n == 0) {
 269             ELOG("Nothing to read!\n");
 270             exit(EXIT_FAILURE);
 271         }
 272         rec += n;
 273     }
 274     buffer[size] = '\0';
 275
 276     /* And call the callback (indexed by the type) */
 277     if (type & (1 << 31)) {
 278         type ^= 1 << 31;
 279         event_handlers[type](buffer);
 280     } else {
 281         if (reply_handlers[type])
 282             reply_handlers[type](buffer);
 283     }
 284
 285     FREE(header);
 286     FREE(buffer);
 287 }
 288
 289 /*
 290  * Sends a message to i3.
 291  * type must be a valid I3_IPC_MESSAGE_TYPE (see i3/ipc.h for further information)
 292  *
 293  */
 294 int i3_send_msg(uint32_t type, const char *payload) {
 295     uint32_t len = 0;
 296     if (payload != NULL) {
 297         len = strlen(payload);
 298     }
 299
 300     /* We are a wellbehaved client and send a proper header first */
 301     uint32_t to_write = strlen(I3_IPC_MAGIC) + sizeof(uint32_t) * 2 + len;
 302     /* TODO: I'm not entirely sure if this buffer really has to contain more
 303      * than the pure header (why not just write() the payload from *payload?),
 304      * but we leave it for now */
 305     char *buffer = smalloc(to_write);
 306     char *walk = buffer;
 307
 308     strncpy(buffer, I3_IPC_MAGIC, strlen(I3_IPC_MAGIC));
 309     walk += strlen(I3_IPC_MAGIC);
 310     memcpy(walk, &len, sizeof(uint32_t));
 311     walk += sizeof(uint32_t);
 312     memcpy(walk, &type, sizeof(uint32_t));
 313     walk += sizeof(uint32_t);
 314
 315     if (payload != NULL)
 316         strncpy(walk, payload, len);
 317
 318     swrite(i3_connection->fd, buffer, to_write);
 319
 320     FREE(buffer);
 321
 322     return 1;
 323 }
 324
 325 /*
 326  * Initiate a connection to i3.
 327  * socket_path must be a valid path to the ipc_socket of i3
 328  *
 329  */
 330 int init_connection(const char *socket_path) {
 331     sock_path = socket_path;
 332     int sockfd = ipc_connect(socket_path);
 333     i3_connection = smalloc(sizeof(ev_io));
 334     ev_io_init(i3_connection, &got_data, sockfd, EV_READ);
 335     ev_io_start(main_loop, i3_connection);
 336     return 1;
 337 }
 338
 339 /*
 340  * Destroy the connection to i3.
 341  */
 342 void destroy_connection(void) {
 343     close(i3_connection->fd);
 344     ev_io_stop(main_loop, i3_connection);
 345 }
 346
 347 /*
 348  * Subscribe to all the i3-events, we need
 349  *
 350  */
 351 void subscribe_events(void) {
 352     if (config.disable_ws) {
 353         i3_send_msg(I3_IPC_MESSAGE_TYPE_SUBSCRIBE, "[ \"output\", \"mode\", \"barconfig_update\" ]");
 354     } else {
 355         i3_send_msg(I3_IPC_MESSAGE_TYPE_SUBSCRIBE, "[ \"workspace\", \"output\", \"mode\", \"barconfig_update\" ]");
 356     }
 357 }