git.sur5r.net Git - i3/i3/blob - i3bar/src/child.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  * child.c: Getting input for the statusline
   8  *
   9  */
  10 #include <stdlib.h>
  11 #include <unistd.h>
  12 #include <sys/types.h>
  13 #include <sys/wait.h>
  14 #include <signal.h>
  15 #include <stdio.h>
  16 #include <stdarg.h>
  17 #include <fcntl.h>
  18 #include <string.h>
  19 #include <errno.h>
  20 #include <err.h>
  21 #include <ev.h>
  22 #include <yajl/yajl_common.h>
  23 #include <yajl/yajl_parse.h>
  24 #include <yajl/yajl_version.h>
  25 #include <yajl/yajl_gen.h>
  26 #include <paths.h>
  27
  28 #include "common.h"
  29
  30 /* Global variables for child_*() */
  31 i3bar_child child;
  32
  33 /* stdin- and SIGCHLD-watchers */
  34 ev_io *stdin_io;
  35 ev_child *child_sig;
  36
  37 /* JSON parser for stdin */
  38 yajl_handle parser;
  39
  40 /* JSON generator for stdout */
  41 yajl_gen gen;
  42
  43 typedef struct parser_ctx {
  44     /* True if one of the parsed blocks was urgent */
  45     bool has_urgent;
  46
  47     /* A copy of the last JSON map key. */
  48     char *last_map_key;
  49
  50     /* The current block. Will be filled, then copied and put into the list of
  51      * blocks. */
  52     struct status_block block;
  53 } parser_ctx;
  54
  55 parser_ctx parser_context;
  56
  57 struct statusline_head statusline_head = TAILQ_HEAD_INITIALIZER(statusline_head);
  58 /* Used temporarily while reading a statusline */
  59 struct statusline_head statusline_buffer = TAILQ_HEAD_INITIALIZER(statusline_buffer);
  60
  61 int child_stdin;
  62
  63 /*
  64  * Remove all blocks from the given statusline.
  65  * If free_resources is set, the fields of each status block will be free'd.
  66  */
  67 static void clear_statusline(struct statusline_head *head, bool free_resources) {
  68     struct status_block *first;
  69     while (!TAILQ_EMPTY(head)) {
  70         first = TAILQ_FIRST(head);
  71         if (free_resources) {
  72             I3STRING_FREE(first->full_text);
  73             I3STRING_FREE(first->short_text);
  74             FREE(first->color);
  75             FREE(first->name);
  76             FREE(first->instance);
  77             FREE(first->min_width_str);
  78         }
  79
  80         TAILQ_REMOVE(head, first, blocks);
  81         free(first);
  82     }
  83 }
  84
  85 static void copy_statusline(struct statusline_head *from, struct statusline_head *to) {
  86     struct status_block *current;
  87     TAILQ_FOREACH(current, from, blocks) {
  88         struct status_block *new_block = smalloc(sizeof(struct status_block));
  89         memcpy(new_block, current, sizeof(struct status_block));
  90         TAILQ_INSERT_TAIL(to, new_block, blocks);
  91     }
  92 }
  93
  94 /*
  95  * Replaces the statusline in memory with an error message. Pass a format
  96  * string and format parameters as you would in `printf'. The next time
  97  * `draw_bars' is called, the error message text will be drawn on the bar in
  98  * the space allocated for the statusline.
  99  */
 100 __attribute__((format(printf, 1, 2))) static void set_statusline_error(const char *format, ...) {
 101     clear_statusline(&statusline_head, true);
 102
 103     char *message;
 104     va_list args;
 105     va_start(args, format);
 106     (void)vasprintf(&message, format, args);
 107
 108     struct status_block *err_block = scalloc(1, sizeof(struct status_block));
 109     err_block->full_text = i3string_from_utf8("Error: ");
 110     err_block->name = sstrdup("error");
 111     err_block->color = sstrdup("red");
 112     err_block->no_separator = true;
 113
 114     struct status_block *message_block = scalloc(1, sizeof(struct status_block));
 115     message_block->full_text = i3string_from_utf8(message);
 116     message_block->name = sstrdup("error_message");
 117     message_block->color = sstrdup("red");
 118     message_block->no_separator = true;
 119
 120     TAILQ_INSERT_HEAD(&statusline_head, err_block, blocks);
 121     TAILQ_INSERT_TAIL(&statusline_head, message_block, blocks);
 122
 123     FREE(message);
 124     va_end(args);
 125 }
 126
 127 /*
 128  * Stop and free() the stdin- and SIGCHLD-watchers
 129  *
 130  */
 131 void cleanup(void) {
 132     if (stdin_io != NULL) {
 133         ev_io_stop(main_loop, stdin_io);
 134         FREE(stdin_io);
 135     }
 136
 137     if (child_sig != NULL) {
 138         ev_child_stop(main_loop, child_sig);
 139         FREE(child_sig);
 140     }
 141
 142     memset(&child, 0, sizeof(i3bar_child));
 143 }
 144
 145 /*
 146  * The start of a new array is the start of a new status line, so we clear all
 147  * previous entries from the buffer.
 148  */
 149 static int stdin_start_array(void *context) {
 150     // the blocks are still used by statusline_head, so we won't free the
 151     // resources here.
 152     clear_statusline(&statusline_buffer, false);
 153     return 1;
 154 }
 155
 156 /*
 157  * The start of a map is the start of a single block of the status line.
 158  *
 159  */
 160 static int stdin_start_map(void *context) {
 161     parser_ctx *ctx = context;
 162     memset(&(ctx->block), '\0', sizeof(struct status_block));
 163
 164     /* Default width of the separator block. */
 165     if (config.separator_symbol == NULL)
 166         ctx->block.sep_block_width = logical_px(9);
 167     else
 168         ctx->block.sep_block_width = logical_px(8) + separator_symbol_width;
 169
 170     return 1;
 171 }
 172
 173 static int stdin_map_key(void *context, const unsigned char *key, size_t len) {
 174     parser_ctx *ctx = context;
 175     FREE(ctx->last_map_key);
 176     sasprintf(&(ctx->last_map_key), "%.*s", len, key);
 177     return 1;
 178 }
 179
 180 static int stdin_boolean(void *context, int val) {
 181     parser_ctx *ctx = context;
 182     if (strcasecmp(ctx->last_map_key, "urgent") == 0) {
 183         ctx->block.urgent = val;
 184         return 1;
 185     }
 186     if (strcasecmp(ctx->last_map_key, "separator") == 0) {
 187         ctx->block.no_separator = !val;
 188         return 1;
 189     }
 190
 191     return 1;
 192 }
 193
 194 static int stdin_string(void *context, const unsigned char *val, size_t len) {
 195     parser_ctx *ctx = context;
 196     if (strcasecmp(ctx->last_map_key, "full_text") == 0) {
 197         ctx->block.full_text = i3string_from_markup_with_length((const char *)val, len);
 198         return 1;
 199     }
 200     if (strcasecmp(ctx->last_map_key, "short_text") == 0) {
 201         ctx->block.short_text = i3string_from_markup_with_length((const char *)val, len);
 202         return 1;
 203     }
 204     if (strcasecmp(ctx->last_map_key, "color") == 0) {
 205         sasprintf(&(ctx->block.color), "%.*s", len, val);
 206         return 1;
 207     }
 208     if (strcasecmp(ctx->last_map_key, "markup") == 0) {
 209         ctx->block.is_markup = (len == strlen("pango") && !strncasecmp((const char *)val, "pango", strlen("pango")));
 210         return 1;
 211     }
 212     if (strcasecmp(ctx->last_map_key, "align") == 0) {
 213         if (len == strlen("center") && !strncmp((const char *)val, "center", strlen("center"))) {
 214             ctx->block.align = ALIGN_CENTER;
 215         } else if (len == strlen("right") && !strncmp((const char *)val, "right", strlen("right"))) {
 216             ctx->block.align = ALIGN_RIGHT;
 217         } else {
 218             ctx->block.align = ALIGN_LEFT;
 219         }
 220         return 1;
 221     }
 222     if (strcasecmp(ctx->last_map_key, "min_width") == 0) {
 223         char *copy = (char *)malloc(len + 1);
 224         strncpy(copy, (const char *)val, len);
 225         copy[len] = 0;
 226         ctx->block.min_width_str = copy;
 227         return 1;
 228     }
 229     if (strcasecmp(ctx->last_map_key, "name") == 0) {
 230         char *copy = (char *)malloc(len + 1);
 231         strncpy(copy, (const char *)val, len);
 232         copy[len] = 0;
 233         ctx->block.name = copy;
 234         return 1;
 235     }
 236     if (strcasecmp(ctx->last_map_key, "instance") == 0) {
 237         char *copy = (char *)malloc(len + 1);
 238         strncpy(copy, (const char *)val, len);
 239         copy[len] = 0;
 240         ctx->block.instance = copy;
 241         return 1;
 242     }
 243
 244     return 1;
 245 }
 246
 247 static int stdin_integer(void *context, long long val) {
 248     parser_ctx *ctx = context;
 249     if (strcasecmp(ctx->last_map_key, "min_width") == 0) {
 250         ctx->block.min_width = (uint32_t)val;
 251         return 1;
 252     }
 253     if (strcasecmp(ctx->last_map_key, "separator_block_width") == 0) {
 254         ctx->block.sep_block_width = (uint32_t)val;
 255         return 1;
 256     }
 257
 258     return 1;
 259 }
 260
 261 /*
 262  * When a map is finished, we have an entire status block.
 263  * Move it from the parser's context to the statusline buffer.
 264  */
 265 static int stdin_end_map(void *context) {
 266     parser_ctx *ctx = context;
 267     struct status_block *new_block = smalloc(sizeof(struct status_block));
 268     memcpy(new_block, &(ctx->block), sizeof(struct status_block));
 269     /* Ensure we have a full_text set, so that when it is missing (or null),
 270      * i3bar doesn’t crash and the user gets an annoying message. */
 271     if (!new_block->full_text)
 272         new_block->full_text = i3string_from_utf8("SPEC VIOLATION: full_text is NULL!");
 273     if (new_block->urgent)
 274         ctx->has_urgent = true;
 275
 276     if (new_block->min_width_str) {
 277         i3String *text = i3string_from_utf8(new_block->min_width_str);
 278         i3string_set_markup(text, new_block->is_markup);
 279         new_block->min_width = (uint32_t)predict_text_width(text);
 280         i3string_free(text);
 281     }
 282
 283     i3string_set_markup(new_block->full_text, new_block->is_markup);
 284
 285     if (new_block->short_text != NULL)
 286         i3string_set_markup(new_block->short_text, new_block->is_markup);
 287
 288     TAILQ_INSERT_TAIL(&statusline_buffer, new_block, blocks);
 289     return 1;
 290 }
 291
 292 /*
 293  * When an array is finished, we have an entire statusline.
 294  * Copy it from the buffer to the actual statusline.
 295  */
 296 static int stdin_end_array(void *context) {
 297     DLOG("copying statusline_buffer to statusline_head\n");
 298     clear_statusline(&statusline_head, true);
 299     copy_statusline(&statusline_buffer, &statusline_head);
 300
 301     DLOG("dumping statusline:\n");
 302     struct status_block *current;
 303     TAILQ_FOREACH(current, &statusline_head, blocks) {
 304         DLOG("full_text = %s\n", i3string_as_utf8(current->full_text));
 305         DLOG("short_text = %s\n", (current->short_text == NULL ? NULL : i3string_as_utf8(current->short_text)));
 306         DLOG("color = %s\n", current->color);
 307     }
 308     DLOG("end of dump\n");
 309     return 1;
 310 }
 311
 312 /*
 313  * Helper function to read stdin
 314  *
 315  * Returns NULL on EOF.
 316  *
 317  */
 318 static unsigned char *get_buffer(ev_io *watcher, int *ret_buffer_len) {
 319     int fd = watcher->fd;
 320     int n = 0;
 321     int rec = 0;
 322     int buffer_len = STDIN_CHUNK_SIZE;
 323     unsigned char *buffer = smalloc(buffer_len + 1);
 324     buffer[0] = '\0';
 325     while (1) {
 326         n = read(fd, buffer + rec, buffer_len - rec);
 327         if (n == -1) {
 328             if (errno == EAGAIN) {
 329                 /* finish up */
 330                 break;
 331             }
 332             ELOG("read() failed!: %s\n", strerror(errno));
 333             exit(EXIT_FAILURE);
 334         }
 335         if (n == 0) {
 336             ELOG("stdin: received EOF\n");
 337             *ret_buffer_len = -1;
 338             return NULL;
 339         }
 340         rec += n;
 341
 342         if (rec == buffer_len) {
 343             buffer_len += STDIN_CHUNK_SIZE;
 344             buffer = srealloc(buffer, buffer_len);
 345         }
 346     }
 347     if (*buffer == '\0') {
 348         FREE(buffer);
 349         rec = -1;
 350     }
 351     *ret_buffer_len = rec;
 352     return buffer;
 353 }
 354
 355 static void read_flat_input(char *buffer, int length) {
 356     struct status_block *first = TAILQ_FIRST(&statusline_head);
 357     /* Clear the old buffer if any. */
 358     I3STRING_FREE(first->full_text);
 359     /* Remove the trailing newline and terminate the string at the same
 360      * time. */
 361     if (buffer[length - 1] == '\n' || buffer[length - 1] == '\r')
 362         buffer[length - 1] = '\0';
 363     else
 364         buffer[length] = '\0';
 365     first->full_text = i3string_from_markup(buffer);
 366 }
 367
 368 static bool read_json_input(unsigned char *input, int length) {
 369     yajl_status status = yajl_parse(parser, input, length);
 370     bool has_urgent = false;
 371     if (status != yajl_status_ok) {
 372         char *message = (char *)yajl_get_error(parser, 0, input, length);
 373
 374         /* strip the newline yajl adds to the error message */
 375         if (message[strlen(message) - 1] == '\n')
 376             message[strlen(message) - 1] = '\0';
 377
 378         fprintf(stderr, "[i3bar] Could not parse JSON input (code = %d, message = %s): %.*s\n",
 379                 status, message, length, input);
 380
 381         set_statusline_error("Could not parse JSON (%s)", message);
 382         yajl_free_error(parser, (unsigned char *)message);
 383         draw_bars(false);
 384     } else if (parser_context.has_urgent) {
 385         has_urgent = true;
 386     }
 387     return has_urgent;
 388 }
 389
 390 /*
 391  * Callbalk for stdin. We read a line from stdin and store the result
 392  * in statusline
 393  *
 394  */
 395 void stdin_io_cb(struct ev_loop *loop, ev_io *watcher, int revents) {
 396     int rec;
 397     unsigned char *buffer = get_buffer(watcher, &rec);
 398     if (buffer == NULL)
 399         return;
 400     bool has_urgent = false;
 401     if (child.version > 0) {
 402         has_urgent = read_json_input(buffer, rec);
 403     } else {
 404         read_flat_input((char *)buffer, rec);
 405     }
 406     free(buffer);
 407     draw_bars(has_urgent);
 408 }
 409
 410 /*
 411  * Callbalk for stdin first line. We read the first line to detect
 412  * whether this is JSON or plain text
 413  *
 414  */
 415 void stdin_io_first_line_cb(struct ev_loop *loop, ev_io *watcher, int revents) {
 416     int rec;
 417     unsigned char *buffer = get_buffer(watcher, &rec);
 418     if (buffer == NULL)
 419         return;
 420     DLOG("Detecting input type based on buffer *%.*s*\n", rec, buffer);
 421     /* Detect whether this is JSON or plain text. */
 422     unsigned int consumed = 0;
 423     /* At the moment, we don’t care for the version. This might change
 424      * in the future, but for now, we just discard it. */
 425     parse_json_header(&child, buffer, rec, &consumed);
 426     if (child.version > 0) {
 427         /* If hide-on-modifier is set, we start of by sending the
 428          * child a SIGSTOP, because the bars aren't mapped at start */
 429         if (config.hide_on_modifier) {
 430             stop_child();
 431         }
 432         draw_bars(read_json_input(buffer + consumed, rec - consumed));
 433     } else {
 434         /* In case of plaintext, we just add a single block and change its
 435          * full_text pointer later. */
 436         struct status_block *new_block = scalloc(1, sizeof(struct status_block));
 437         TAILQ_INSERT_TAIL(&statusline_head, new_block, blocks);
 438         read_flat_input((char *)buffer, rec);
 439     }
 440     free(buffer);
 441     ev_io_stop(main_loop, stdin_io);
 442     ev_io_init(stdin_io, &stdin_io_cb, STDIN_FILENO, EV_READ);
 443     ev_io_start(main_loop, stdin_io);
 444 }
 445
 446 /*
 447  * We received a SIGCHLD, meaning, that the child process terminated.
 448  * We simply free the respective data structures and don't care for input
 449  * anymore
 450  *
 451  */
 452 void child_sig_cb(struct ev_loop *loop, ev_child *watcher, int revents) {
 453     int exit_status = WEXITSTATUS(watcher->rstatus);
 454
 455     ELOG("Child (pid: %d) unexpectedly exited with status %d\n",
 456          child.pid,
 457          exit_status);
 458
 459     /* this error is most likely caused by a user giving a nonexecutable or
 460      * nonexistent file, so we will handle those cases separately. */
 461     if (exit_status == 126)
 462         set_statusline_error("status_command is not executable (exit %d)", exit_status);
 463     else if (exit_status == 127)
 464         set_statusline_error("status_command not found or is missing a library dependency (exit %d)", exit_status);
 465     else
 466         set_statusline_error("status_command process exited unexpectedly (exit %d)", exit_status);
 467
 468     cleanup();
 469     draw_bars(false);
 470 }
 471
 472 void child_write_output(void) {
 473     if (child.click_events) {
 474         const unsigned char *output;
 475         size_t size;
 476         ssize_t n;
 477
 478         yajl_gen_get_buf(gen, &output, &size);
 479
 480         n = writeall(child_stdin, output, size);
 481         if (n != -1)
 482             n = writeall(child_stdin, "\n", 1);
 483
 484         yajl_gen_clear(gen);
 485
 486         if (n == -1) {
 487             child.click_events = false;
 488             kill_child();
 489             set_statusline_error("child_write_output failed");
 490             draw_bars(false);
 491         }
 492     }
 493 }
 494
 495 /*
 496  * Start a child process with the specified command and reroute stdin.
 497  * We actually start a $SHELL to execute the command so we don't have to care
 498  * about arguments and such.
 499  *
 500  * If `command' is NULL, such as in the case when no `status_command' is given
 501  * in the bar config, no child will be started.
 502  *
 503  */
 504 void start_child(char *command) {
 505     if (command == NULL)
 506         return;
 507
 508     /* Allocate a yajl parser which will be used to parse stdin. */
 509     static yajl_callbacks callbacks = {
 510         .yajl_boolean = stdin_boolean,
 511         .yajl_integer = stdin_integer,
 512         .yajl_string = stdin_string,
 513         .yajl_start_map = stdin_start_map,
 514         .yajl_map_key = stdin_map_key,
 515         .yajl_end_map = stdin_end_map,
 516         .yajl_start_array = stdin_start_array,
 517         .yajl_end_array = stdin_end_array,
 518     };
 519     parser = yajl_alloc(&callbacks, NULL, &parser_context);
 520
 521     gen = yajl_gen_alloc(NULL);
 522
 523     int pipe_in[2];  /* pipe we read from */
 524     int pipe_out[2]; /* pipe we write to */
 525
 526     if (pipe(pipe_in) == -1)
 527         err(EXIT_FAILURE, "pipe(pipe_in)");
 528     if (pipe(pipe_out) == -1)
 529         err(EXIT_FAILURE, "pipe(pipe_out)");
 530
 531     child.pid = fork();
 532     switch (child.pid) {
 533         case -1:
 534             ELOG("Couldn't fork(): %s\n", strerror(errno));
 535             exit(EXIT_FAILURE);
 536         case 0:
 537             /* Child-process. Reroute streams and start shell */
 538
 539             close(pipe_in[0]);
 540             close(pipe_out[1]);
 541
 542             dup2(pipe_in[1], STDOUT_FILENO);
 543             dup2(pipe_out[0], STDIN_FILENO);
 544
 545             setpgid(child.pid, 0);
 546             execl(_PATH_BSHELL, _PATH_BSHELL, "-c", command, (char *)NULL);
 547             return;
 548         default:
 549             /* Parent-process. Reroute streams */
 550
 551             close(pipe_in[1]);
 552             close(pipe_out[0]);
 553
 554             dup2(pipe_in[0], STDIN_FILENO);
 555             child_stdin = pipe_out[1];
 556
 557             break;
 558     }
 559
 560     /* We set O_NONBLOCK because blocking is evil in event-driven software */
 561     fcntl(STDIN_FILENO, F_SETFL, O_NONBLOCK);
 562
 563     stdin_io = smalloc(sizeof(ev_io));
 564     ev_io_init(stdin_io, &stdin_io_first_line_cb, STDIN_FILENO, EV_READ);
 565     ev_io_start(main_loop, stdin_io);
 566
 567     /* We must cleanup, if the child unexpectedly terminates */
 568     child_sig = smalloc(sizeof(ev_child));
 569     ev_child_init(child_sig, &child_sig_cb, child.pid, 0);
 570     ev_child_start(main_loop, child_sig);
 571
 572     atexit(kill_child_at_exit);
 573 }
 574
 575 void child_click_events_initialize(void) {
 576     if (!child.click_events_init) {
 577         yajl_gen_array_open(gen);
 578         child_write_output();
 579         child.click_events_init = true;
 580     }
 581 }
 582
 583 void child_click_events_key(const char *key) {
 584     yajl_gen_string(gen, (const unsigned char *)key, strlen(key));
 585 }
 586
 587 /*
 588  * Generates a click event, if enabled.
 589  *
 590  */
 591 void send_block_clicked(int button, const char *name, const char *instance, int x, int y) {
 592     if (!child.click_events) {
 593         return;
 594     }
 595
 596     child_click_events_initialize();
 597
 598     yajl_gen_map_open(gen);
 599
 600     if (name) {
 601         child_click_events_key("name");
 602         yajl_gen_string(gen, (const unsigned char *)name, strlen(name));
 603     }
 604
 605     if (instance) {
 606         child_click_events_key("instance");
 607         yajl_gen_string(gen, (const unsigned char *)instance, strlen(instance));
 608     }
 609
 610     child_click_events_key("button");
 611     yajl_gen_integer(gen, button);
 612
 613     child_click_events_key("x");
 614     yajl_gen_integer(gen, x);
 615
 616     child_click_events_key("y");
 617     yajl_gen_integer(gen, y);
 618
 619     yajl_gen_map_close(gen);
 620     child_write_output();
 621 }
 622
 623 /*
 624  * kill()s the child process (if any). Called when exit()ing.
 625  *
 626  */
 627 void kill_child_at_exit(void) {
 628     if (child.pid > 0) {
 629         if (child.cont_signal > 0 && child.stopped)
 630             killpg(child.pid, child.cont_signal);
 631         killpg(child.pid, SIGTERM);
 632     }
 633 }
 634
 635 /*
 636  * kill()s the child process (if existent) and closes and
 637  * free()s the stdin- and SIGCHLD-watchers
 638  *
 639  */
 640 void kill_child(void) {
 641     if (child.pid > 0) {
 642         if (child.cont_signal > 0 && child.stopped)
 643             killpg(child.pid, child.cont_signal);
 644         killpg(child.pid, SIGTERM);
 645         int status;
 646         waitpid(child.pid, &status, 0);
 647         cleanup();
 648     }
 649 }
 650
 651 /*
 652  * Sends a SIGSTOP to the child process (if existent)
 653  *
 654  */
 655 void stop_child(void) {
 656     if (child.stop_signal > 0 && !child.stopped) {
 657         child.stopped = true;
 658         killpg(child.pid, child.stop_signal);
 659     }
 660 }
 661
 662 /*
 663  * Sends a SIGCONT to the child process (if existent)
 664  *
 665  */
 666 void cont_child(void) {
 667     if (child.cont_signal > 0 && child.stopped) {
 668         child.stopped = false;
 669         killpg(child.pid, child.cont_signal);
 670     }
 671 }
 672
 673 /*
 674  * Whether or not the child want click events
 675  *
 676  */
 677 bool child_want_click_events(void) {
 678     return child.click_events;
 679 }