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