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-2012 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(sizeof(struct status_block));
 109     err_block->full_text = i3string_from_utf8("Error: ");
 110     err_block->name = "error";
 111     err_block->color = "red";
 112     err_block->no_separator = true;
 113
 114     struct status_block *message_block = scalloc(sizeof(struct status_block));
 115     message_block->full_text = i3string_from_utf8(message);
 116     message_block->name = "error_message";
 117     message_block->color = "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     ctx->block.sep_block_width = logical_px(9);
 166
 167     /* Use markup by default */
 168     ctx->block.is_markup = true;
 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     }
 185     if (strcasecmp(ctx->last_map_key, "separator") == 0) {
 186         ctx->block.no_separator = !val;
 187     }
 188     return 1;
 189 }
 190
 191 static int stdin_string(void *context, const unsigned char *val, size_t len) {
 192     parser_ctx *ctx = context;
 193     if (strcasecmp(ctx->last_map_key, "full_text") == 0) {
 194         ctx->block.full_text = i3string_from_markup_with_length((const char *)val, len);
 195     }
 196     if (strcasecmp(ctx->last_map_key, "short_text") == 0) {
 197         ctx->block.short_text = i3string_from_markup_with_length((const char *)val, len);
 198     }
 199     if (strcasecmp(ctx->last_map_key, "color") == 0) {
 200         sasprintf(&(ctx->block.color), "%.*s", len, val);
 201     }
 202     if (strcasecmp(ctx->last_map_key, "markup") == 0) {
 203         ctx->block.is_markup = (len == strlen("pango") && !strncasecmp((const char *)val, "pango", strlen("pango")));
 204     }
 205     if (strcasecmp(ctx->last_map_key, "align") == 0) {
 206         if (len == strlen("center") && !strncmp((const char *)val, "center", strlen("center"))) {
 207             ctx->block.align = ALIGN_CENTER;
 208         } else if (len == strlen("right") && !strncmp((const char *)val, "right", strlen("right"))) {
 209             ctx->block.align = ALIGN_RIGHT;
 210         } else {
 211             ctx->block.align = ALIGN_LEFT;
 212         }
 213     } else if (strcasecmp(ctx->last_map_key, "min_width") == 0) {
 214         char *copy = (char *)malloc(len + 1);
 215         strncpy(copy, (const char *)val, len);
 216         copy[len] = 0;
 217         ctx->block.min_width_str = copy;
 218     }
 219     if (strcasecmp(ctx->last_map_key, "name") == 0) {
 220         char *copy = (char *)malloc(len + 1);
 221         strncpy(copy, (const char *)val, len);
 222         copy[len] = 0;
 223         ctx->block.name = copy;
 224     }
 225     if (strcasecmp(ctx->last_map_key, "instance") == 0) {
 226         char *copy = (char *)malloc(len + 1);
 227         strncpy(copy, (const char *)val, len);
 228         copy[len] = 0;
 229         ctx->block.instance = copy;
 230     }
 231     return 1;
 232 }
 233
 234 static int stdin_integer(void *context, long long val) {
 235     parser_ctx *ctx = context;
 236     if (strcasecmp(ctx->last_map_key, "min_width") == 0) {
 237         ctx->block.min_width = (uint32_t)val;
 238     }
 239     if (strcasecmp(ctx->last_map_key, "separator_block_width") == 0) {
 240         ctx->block.sep_block_width = (uint32_t)val;
 241     }
 242     return 1;
 243 }
 244
 245 /*
 246  * When a map is finished, we have an entire status block.
 247  * Move it from the parser's context to the statusline buffer.
 248  */
 249 static int stdin_end_map(void *context) {
 250     parser_ctx *ctx = context;
 251     struct status_block *new_block = smalloc(sizeof(struct status_block));
 252     memcpy(new_block, &(ctx->block), sizeof(struct status_block));
 253     /* Ensure we have a full_text set, so that when it is missing (or null),
 254      * i3bar doesn’t crash and the user gets an annoying message. */
 255     if (!new_block->full_text)
 256         new_block->full_text = i3string_from_utf8("SPEC VIOLATION: full_text is NULL!");
 257     if (new_block->urgent)
 258         ctx->has_urgent = true;
 259
 260     if (new_block->min_width_str) {
 261         i3String *text = i3string_from_utf8(new_block->min_width_str);
 262         i3string_set_markup(text, new_block->is_markup);
 263         new_block->min_width = (uint32_t)predict_text_width(text);
 264         i3string_free(text);
 265     }
 266
 267     i3string_set_markup(new_block->full_text, new_block->is_markup);
 268     i3string_set_markup(new_block->short_text, new_block->is_markup);
 269
 270     TAILQ_INSERT_TAIL(&statusline_buffer, new_block, blocks);
 271     return 1;
 272 }
 273
 274 /*
 275  * When an array is finished, we have an entire statusline.
 276  * Copy it from the buffer to the actual statusline.
 277  */
 278 static int stdin_end_array(void *context) {
 279     DLOG("copying statusline_buffer to statusline_head\n");
 280     clear_statusline(&statusline_head, true);
 281     copy_statusline(&statusline_buffer, &statusline_head);
 282
 283     DLOG("dumping statusline:\n");
 284     struct status_block *current;
 285     TAILQ_FOREACH(current, &statusline_head, blocks) {
 286         DLOG("full_text = %s\n", i3string_as_utf8(current->full_text));
 287         DLOG("short_text = %s\n", i3string_as_utf8(current->short_text));
 288         DLOG("color = %s\n", current->color);
 289     }
 290     DLOG("end of dump\n");
 291     return 1;
 292 }
 293
 294 /*
 295  * Helper function to read stdin
 296  *
 297  * Returns NULL on EOF.
 298  *
 299  */
 300 static unsigned char *get_buffer(ev_io *watcher, int *ret_buffer_len) {
 301     int fd = watcher->fd;
 302     int n = 0;
 303     int rec = 0;
 304     int buffer_len = STDIN_CHUNK_SIZE;
 305     unsigned char *buffer = smalloc(buffer_len + 1);
 306     buffer[0] = '\0';
 307     while (1) {
 308         n = read(fd, buffer + rec, buffer_len - rec);
 309         if (n == -1) {
 310             if (errno == EAGAIN) {
 311                 /* finish up */
 312                 break;
 313             }
 314             ELOG("read() failed!: %s\n", strerror(errno));
 315             exit(EXIT_FAILURE);
 316         }
 317         if (n == 0) {
 318             ELOG("stdin: received EOF\n");
 319             *ret_buffer_len = -1;
 320             return NULL;
 321         }
 322         rec += n;
 323
 324         if (rec == buffer_len) {
 325             buffer_len += STDIN_CHUNK_SIZE;
 326             buffer = srealloc(buffer, buffer_len);
 327         }
 328     }
 329     if (*buffer == '\0') {
 330         FREE(buffer);
 331         rec = -1;
 332     }
 333     *ret_buffer_len = rec;
 334     return buffer;
 335 }
 336
 337 static void read_flat_input(char *buffer, int length) {
 338     struct status_block *first = TAILQ_FIRST(&statusline_head);
 339     /* Clear the old buffer if any. */
 340     I3STRING_FREE(first->full_text);
 341     /* Remove the trailing newline and terminate the string at the same
 342      * time. */
 343     if (buffer[length - 1] == '\n' || buffer[length - 1] == '\r')
 344         buffer[length - 1] = '\0';
 345     else
 346         buffer[length] = '\0';
 347     first->full_text = i3string_from_markup(buffer);
 348 }
 349
 350 static bool read_json_input(unsigned char *input, int length) {
 351     yajl_status status = yajl_parse(parser, input, length);
 352     bool has_urgent = false;
 353     if (status != yajl_status_ok) {
 354         char *message = (char *)yajl_get_error(parser, 0, input, length);
 355
 356         /* strip the newline yajl adds to the error message */
 357         if (message[strlen(message) - 1] == '\n')
 358             message[strlen(message) - 1] = '\0';
 359
 360         fprintf(stderr, "[i3bar] Could not parse JSON input (code = %d, message = %s): %.*s\n",
 361                 status, message, length, input);
 362
 363         set_statusline_error("Could not parse JSON (%s)", message);
 364         yajl_free_error(parser, (unsigned char *)message);
 365         draw_bars(false);
 366     } else if (parser_context.has_urgent) {
 367         has_urgent = true;
 368     }
 369     return has_urgent;
 370 }
 371
 372 /*
 373  * Callbalk for stdin. We read a line from stdin and store the result
 374  * in statusline
 375  *
 376  */
 377 void stdin_io_cb(struct ev_loop *loop, ev_io *watcher, int revents) {
 378     int rec;
 379     unsigned char *buffer = get_buffer(watcher, &rec);
 380     if (buffer == NULL)
 381         return;
 382     bool has_urgent = false;
 383     if (child.version > 0) {
 384         has_urgent = read_json_input(buffer, rec);
 385     } else {
 386         read_flat_input((char *)buffer, rec);
 387     }
 388     free(buffer);
 389     draw_bars(has_urgent);
 390 }
 391
 392 /*
 393  * Callbalk for stdin first line. We read the first line to detect
 394  * whether this is JSON or plain text
 395  *
 396  */
 397 void stdin_io_first_line_cb(struct ev_loop *loop, ev_io *watcher, int revents) {
 398     int rec;
 399     unsigned char *buffer = get_buffer(watcher, &rec);
 400     if (buffer == NULL)
 401         return;
 402     DLOG("Detecting input type based on buffer *%.*s*\n", rec, buffer);
 403     /* Detect whether this is JSON or plain text. */
 404     unsigned int consumed = 0;
 405     /* At the moment, we don’t care for the version. This might change
 406      * in the future, but for now, we just discard it. */
 407     parse_json_header(&child, buffer, rec, &consumed);
 408     if (child.version > 0) {
 409         /* If hide-on-modifier is set, we start of by sending the
 410          * child a SIGSTOP, because the bars aren't mapped at start */
 411         if (config.hide_on_modifier) {
 412             stop_child();
 413         }
 414         draw_bars(read_json_input(buffer + consumed, rec - consumed));
 415     } else {
 416         /* In case of plaintext, we just add a single block and change its
 417          * full_text pointer later. */
 418         struct status_block *new_block = scalloc(sizeof(struct status_block));
 419         TAILQ_INSERT_TAIL(&statusline_head, new_block, blocks);
 420         read_flat_input((char *)buffer, rec);
 421     }
 422     free(buffer);
 423     ev_io_stop(main_loop, stdin_io);
 424     ev_io_init(stdin_io, &stdin_io_cb, STDIN_FILENO, EV_READ);
 425     ev_io_start(main_loop, stdin_io);
 426 }
 427
 428 /*
 429  * We received a SIGCHLD, meaning, that the child process terminated.
 430  * We simply free the respective data structures and don't care for input
 431  * anymore
 432  *
 433  */
 434 void child_sig_cb(struct ev_loop *loop, ev_child *watcher, int revents) {
 435     int exit_status = WEXITSTATUS(watcher->rstatus);
 436
 437     ELOG("Child (pid: %d) unexpectedly exited with status %d\n",
 438          child.pid,
 439          exit_status);
 440
 441     /* this error is most likely caused by a user giving a nonexecutable or
 442      * nonexistent file, so we will handle those cases separately. */
 443     if (exit_status == 126)
 444         set_statusline_error("status_command is not executable (exit %d)", exit_status);
 445     else if (exit_status == 127)
 446         set_statusline_error("status_command not found or is missing a library dependency (exit %d)", exit_status);
 447     else
 448         set_statusline_error("status_command process exited unexpectedly (exit %d)", exit_status);
 449
 450     cleanup();
 451     draw_bars(false);
 452 }
 453
 454 void child_write_output(void) {
 455     if (child.click_events) {
 456         const unsigned char *output;
 457         size_t size;
 458         ssize_t n;
 459
 460         yajl_gen_get_buf(gen, &output, &size);
 461
 462         n = writeall(child_stdin, output, size);
 463         if (n != -1)
 464             n = writeall(child_stdin, "\n", 1);
 465
 466         yajl_gen_clear(gen);
 467
 468         if (n == -1) {
 469             child.click_events = false;
 470             kill_child();
 471             set_statusline_error("child_write_output failed");
 472             draw_bars(false);
 473         }
 474     }
 475 }
 476
 477 /*
 478  * Start a child process with the specified command and reroute stdin.
 479  * We actually start a $SHELL to execute the command so we don't have to care
 480  * about arguments and such.
 481  *
 482  * If `command' is NULL, such as in the case when no `status_command' is given
 483  * in the bar config, no child will be started.
 484  *
 485  */
 486 void start_child(char *command) {
 487     if (command == NULL)
 488         return;
 489
 490     /* Allocate a yajl parser which will be used to parse stdin. */
 491     static yajl_callbacks callbacks = {
 492         .yajl_boolean = stdin_boolean,
 493         .yajl_integer = stdin_integer,
 494         .yajl_string = stdin_string,
 495         .yajl_start_map = stdin_start_map,
 496         .yajl_map_key = stdin_map_key,
 497         .yajl_end_map = stdin_end_map,
 498         .yajl_start_array = stdin_start_array,
 499         .yajl_end_array = stdin_end_array,
 500     };
 501     parser = yajl_alloc(&callbacks, NULL, &parser_context);
 502
 503     gen = yajl_gen_alloc(NULL);
 504
 505     int pipe_in[2];  /* pipe we read from */
 506     int pipe_out[2]; /* pipe we write to */
 507
 508     if (pipe(pipe_in) == -1)
 509         err(EXIT_FAILURE, "pipe(pipe_in)");
 510     if (pipe(pipe_out) == -1)
 511         err(EXIT_FAILURE, "pipe(pipe_out)");
 512
 513     child.pid = fork();
 514     switch (child.pid) {
 515         case -1:
 516             ELOG("Couldn't fork(): %s\n", strerror(errno));
 517             exit(EXIT_FAILURE);
 518         case 0:
 519             /* Child-process. Reroute streams and start shell */
 520
 521             close(pipe_in[0]);
 522             close(pipe_out[1]);
 523
 524             dup2(pipe_in[1], STDOUT_FILENO);
 525             dup2(pipe_out[0], STDIN_FILENO);
 526
 527             setpgid(child.pid, 0);
 528             execl(_PATH_BSHELL, _PATH_BSHELL, "-c", command, (char *)NULL);
 529             return;
 530         default:
 531             /* Parent-process. Reroute streams */
 532
 533             close(pipe_in[1]);
 534             close(pipe_out[0]);
 535
 536             dup2(pipe_in[0], STDIN_FILENO);
 537             child_stdin = pipe_out[1];
 538
 539             break;
 540     }
 541
 542     /* We set O_NONBLOCK because blocking is evil in event-driven software */
 543     fcntl(STDIN_FILENO, F_SETFL, O_NONBLOCK);
 544
 545     stdin_io = smalloc(sizeof(ev_io));
 546     ev_io_init(stdin_io, &stdin_io_first_line_cb, STDIN_FILENO, EV_READ);
 547     ev_io_start(main_loop, stdin_io);
 548
 549     /* We must cleanup, if the child unexpectedly terminates */
 550     child_sig = smalloc(sizeof(ev_child));
 551     ev_child_init(child_sig, &child_sig_cb, child.pid, 0);
 552     ev_child_start(main_loop, child_sig);
 553
 554     atexit(kill_child_at_exit);
 555 }
 556
 557 void child_click_events_initialize(void) {
 558     if (!child.click_events_init) {
 559         yajl_gen_array_open(gen);
 560         child_write_output();
 561         child.click_events_init = true;
 562     }
 563 }
 564
 565 void child_click_events_key(const char *key) {
 566     yajl_gen_string(gen, (const unsigned char *)key, strlen(key));
 567 }
 568
 569 /*
 570  * Generates a click event, if enabled.
 571  *
 572  */
 573 void send_block_clicked(int button, const char *name, const char *instance, int x, int y) {
 574     if (!child.click_events) {
 575         return;
 576     }
 577
 578     child_click_events_initialize();
 579
 580     yajl_gen_map_open(gen);
 581
 582     if (name) {
 583         child_click_events_key("name");
 584         yajl_gen_string(gen, (const unsigned char *)name, strlen(name));
 585     }
 586
 587     if (instance) {
 588         child_click_events_key("instance");
 589         yajl_gen_string(gen, (const unsigned char *)instance, strlen(instance));
 590     }
 591
 592     child_click_events_key("button");
 593     yajl_gen_integer(gen, button);
 594
 595     child_click_events_key("x");
 596     yajl_gen_integer(gen, x);
 597
 598     child_click_events_key("y");
 599     yajl_gen_integer(gen, y);
 600
 601     yajl_gen_map_close(gen);
 602     child_write_output();
 603 }
 604
 605 /*
 606  * kill()s the child process (if any). Called when exit()ing.
 607  *
 608  */
 609 void kill_child_at_exit(void) {
 610     if (child.pid > 0) {
 611         if (child.cont_signal > 0 && child.stopped)
 612             killpg(child.pid, child.cont_signal);
 613         killpg(child.pid, SIGTERM);
 614     }
 615 }
 616
 617 /*
 618  * kill()s the child process (if existent) and closes and
 619  * free()s the stdin- and SIGCHLD-watchers
 620  *
 621  */
 622 void kill_child(void) {
 623     if (child.pid > 0) {
 624         if (child.cont_signal > 0 && child.stopped)
 625             killpg(child.pid, child.cont_signal);
 626         killpg(child.pid, SIGTERM);
 627         int status;
 628         waitpid(child.pid, &status, 0);
 629         cleanup();
 630     }
 631 }
 632
 633 /*
 634  * Sends a SIGSTOP to the child process (if existent)
 635  *
 636  */
 637 void stop_child(void) {
 638     if (child.stop_signal > 0 && !child.stopped) {
 639         child.stopped = true;
 640         killpg(child.pid, child.stop_signal);
 641     }
 642 }
 643
 644 /*
 645  * Sends a SIGCONT to the child process (if existent)
 646  *
 647  */
 648 void cont_child(void) {
 649     if (child.cont_signal > 0 && child.stopped) {
 650         child.stopped = false;
 651         killpg(child.pid, child.cont_signal);
 652     }
 653 }
 654
 655 /*
 656  * Whether or not the child want click events
 657  *
 658  */
 659 bool child_want_click_events(void) {
 660     return child.click_events;
 661 }