git.sur5r.net Git - i3/i3/blob - i3-nagbar/main.c

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009-2013 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * i3-nagbar is a utility which displays a nag message, for example in the case
   8  * when the user has an error in their configuration file.
   9  *
  10  */
  11 #include <stdio.h>
  12 #include <sys/types.h>
  13 #include <sys/stat.h>
  14 #include <sys/wait.h>
  15 #include <stdlib.h>
  16 #include <stdbool.h>
  17 #include <unistd.h>
  18 #include <string.h>
  19 #include <errno.h>
  20 #include <err.h>
  21 #include <stdint.h>
  22 #include <getopt.h>
  23 #include <limits.h>
  24 #include <fcntl.h>
  25 #include <paths.h>
  26
  27 #include <xcb/xcb.h>
  28 #include <xcb/xcb_aux.h>
  29 #include <xcb/xcb_event.h>
  30
  31 #include "libi3.h"
  32 #include "i3-nagbar.h"
  33
  34 static char *argv0 = NULL;
  35
  36 typedef struct {
  37     i3String *label;
  38     char *action;
  39     int16_t x;
  40     uint16_t width;
  41 } button_t;
  42
  43 static xcb_window_t win;
  44 static xcb_pixmap_t pixmap;
  45 static xcb_gcontext_t pixmap_gc;
  46 static xcb_rectangle_t rect = {0, 0, 600, 20};
  47 static i3Font font;
  48 static i3String *prompt;
  49 static button_t *buttons;
  50 static int buttoncnt;
  51
  52 /* Result of get_colorpixel() for the various colors. */
  53 static uint32_t color_background;        /* background of the bar */
  54 static uint32_t color_button_background; /* background for buttons */
  55 static uint32_t color_border;            /* color of the button border */
  56 static uint32_t color_border_bottom;     /* color of the bottom border */
  57 static uint32_t color_text;              /* color of the text */
  58
  59 xcb_window_t root;
  60 xcb_connection_t *conn;
  61 xcb_screen_t *root_screen;
  62
  63 /*
  64  * Having verboselog(), errorlog() and debuglog() is necessary when using libi3.
  65  *
  66  */
  67 void verboselog(char *fmt, ...) {
  68     va_list args;
  69
  70     va_start(args, fmt);
  71     vfprintf(stdout, fmt, args);
  72     va_end(args);
  73 }
  74
  75 void errorlog(char *fmt, ...) {
  76     va_list args;
  77
  78     va_start(args, fmt);
  79     vfprintf(stderr, fmt, args);
  80     va_end(args);
  81 }
  82
  83 void debuglog(char *fmt, ...) {
  84 }
  85
  86 /*
  87  * Starts the given application by passing it through a shell. We use double fork
  88  * to avoid zombie processes. As the started application’s parent exits (immediately),
  89  * the application is reparented to init (process-id 1), which correctly handles
  90  * childs, so we don’t have to do it :-).
  91  *
  92  * The shell is determined by looking for the SHELL environment variable. If it
  93  * does not exist, /bin/sh is used.
  94  *
  95  */
  96 static void start_application(const char *command) {
  97     printf("executing: %s\n", command);
  98     if (fork() == 0) {
  99         /* Child process */
 100         setsid();
 101         if (fork() == 0) {
 102             /* This is the child */
 103             execl(_PATH_BSHELL, _PATH_BSHELL, "-c", command, (void *)NULL);
 104             /* not reached */
 105         }
 106         exit(0);
 107     }
 108     wait(0);
 109 }
 110
 111 static button_t *get_button_at(int16_t x, int16_t y) {
 112     for (int c = 0; c < buttoncnt; c++)
 113         if (x >= (buttons[c].x) && x <= (buttons[c].x + buttons[c].width))
 114             return &buttons[c];
 115
 116     return NULL;
 117 }
 118
 119 static void handle_button_press(xcb_connection_t *conn, xcb_button_press_event_t *event) {
 120     printf("button pressed on x = %d, y = %d\n",
 121            event->event_x, event->event_y);
 122     /* TODO: set a flag for the button, re-render */
 123 }
 124
 125 /*
 126  * Called when the user releases the mouse button. Checks whether the
 127  * coordinates are over a button and executes the appropriate action.
 128  *
 129  */
 130 static void handle_button_release(xcb_connection_t *conn, xcb_button_release_event_t *event) {
 131     printf("button released on x = %d, y = %d\n",
 132            event->event_x, event->event_y);
 133     /* If the user hits the close button, we exit(0) */
 134     if (event->event_x >= (rect.width - logical_px(32)))
 135         exit(0);
 136     button_t *button = get_button_at(event->event_x, event->event_y);
 137     if (!button)
 138         return;
 139
 140     /* We need to create a custom script containing our actual command
 141      * since not every terminal emulator which is contained in
 142      * i3-sensible-terminal supports -e with multiple arguments (and not
 143      * all of them support -e with one quoted argument either).
 144      *
 145      * NB: The paths need to be unique, that is, don’t assume users close
 146      * their nagbars at any point in time (and they still need to work).
 147      * */
 148     char *script_path = get_process_filename("nagbar-cmd");
 149
 150     int fd = open(script_path, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
 151     if (fd == -1) {
 152         warn("Could not create temporary script to store the nagbar command");
 153         return;
 154     }
 155     FILE *script = fdopen(fd, "w");
 156     if (script == NULL) {
 157         warn("Could not fdopen() temporary script to store the nagbar command");
 158         return;
 159     }
 160     fprintf(script, "#!/bin/sh\nrm %s\n%s", script_path, button->action);
 161     /* Also closes fd */
 162     fclose(script);
 163
 164     char *link_path;
 165     char *exe_path = get_exe_path(argv0);
 166     sasprintf(&link_path, "%s.nagbar_cmd", script_path);
 167     if (symlink(exe_path, link_path) == -1) {
 168         err(EXIT_FAILURE, "Failed to symlink %s to %s", link_path, exe_path);
 169     }
 170
 171     char *terminal_cmd;
 172     sasprintf(&terminal_cmd, "i3-sensible-terminal -e %s", link_path);
 173     printf("argv0 = %s\n", argv0);
 174     printf("terminal_cmd = %s\n", terminal_cmd);
 175
 176     start_application(terminal_cmd);
 177
 178     free(link_path);
 179     free(terminal_cmd);
 180     free(script_path);
 181     free(exe_path);
 182
 183     /* TODO: unset flag, re-render */
 184 }
 185
 186 /*
 187  * Handles expose events (redraws of the window) and rendering in general. Will
 188  * be called from the code with event == NULL or from X with event != NULL.
 189  *
 190  */
 191 static int handle_expose(xcb_connection_t *conn, xcb_expose_event_t *event) {
 192     /* re-draw the background */
 193     xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){color_background});
 194     xcb_poly_fill_rectangle(conn, pixmap, pixmap_gc, 1, &rect);
 195
 196     /* restore font color */
 197     set_font_colors(pixmap_gc, color_text, color_background);
 198     draw_text(prompt, pixmap, pixmap_gc,
 199               logical_px(4) + logical_px(4),
 200               logical_px(4) + logical_px(4),
 201               rect.width - logical_px(4) - logical_px(4));
 202
 203     /* render close button */
 204     const char *close_button_label = "X";
 205     int line_width = logical_px(4);
 206     /* set width to the width of the label */
 207     int w = predict_text_width(i3string_from_utf8(close_button_label));
 208     /* account for left/right padding, which seems to be set to 8px (total) below */
 209     w += logical_px(8);
 210     int y = rect.width;
 211     uint32_t values[3];
 212     values[0] = color_button_background;
 213     values[1] = line_width;
 214     xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND | XCB_GC_LINE_WIDTH, values);
 215
 216     xcb_rectangle_t close = {y - w - (2 * line_width), 0, w + (2 * line_width), rect.height};
 217     xcb_poly_fill_rectangle(conn, pixmap, pixmap_gc, 1, &close);
 218
 219     xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){color_border});
 220     xcb_point_t points[] = {
 221         {y - w - (2 * line_width), line_width / 2},
 222         {y - (line_width / 2), line_width / 2},
 223         {y - (line_width / 2), (rect.height - (line_width / 2)) - logical_px(2)},
 224         {y - w - (2 * line_width), (rect.height - (line_width / 2)) - logical_px(2)},
 225         {y - w - (2 * line_width), line_width / 2}};
 226     xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, pixmap, pixmap_gc, 5, points);
 227
 228     values[0] = 1;
 229     set_font_colors(pixmap_gc, color_text, color_button_background);
 230     /* the x term here seems to set left/right padding */
 231     draw_text_ascii(close_button_label, pixmap, pixmap_gc,
 232                     y - w - line_width + w / 2 - logical_px(4),
 233                     logical_px(4) + logical_px(3),
 234                     rect.width - y + w + line_width - w / 2 + logical_px(4));
 235     y -= w;
 236
 237     y -= logical_px(20);
 238
 239     /* render custom buttons */
 240     line_width = 1;
 241     for (int c = 0; c < buttoncnt; c++) {
 242         /* set w to the width of the label */
 243         w = predict_text_width(buttons[c].label);
 244         /* account for left/right padding, which seems to be set to 12px (total) below */
 245         w += logical_px(12);
 246         y -= logical_px(30);
 247         xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){color_button_background});
 248         close = (xcb_rectangle_t){y - w - (2 * line_width), logical_px(2), w + (2 * line_width), rect.height - logical_px(6)};
 249         xcb_poly_fill_rectangle(conn, pixmap, pixmap_gc, 1, &close);
 250
 251         xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){color_border});
 252         buttons[c].x = y - w - (2 * line_width);
 253         buttons[c].width = w;
 254         xcb_point_t points2[] = {
 255             {y - w - (2 * line_width), (line_width / 2) + logical_px(2)},
 256             {y - (line_width / 2), (line_width / 2) + logical_px(2)},
 257             {y - (line_width / 2), (rect.height - logical_px(4) - (line_width / 2))},
 258             {y - w - (2 * line_width), (rect.height - logical_px(4) - (line_width / 2))},
 259             {y - w - (2 * line_width), (line_width / 2) + logical_px(2)}};
 260         xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, pixmap, pixmap_gc, 5, points2);
 261
 262         values[0] = color_text;
 263         values[1] = color_button_background;
 264         set_font_colors(pixmap_gc, color_text, color_button_background);
 265         /* the x term seems to set left/right padding */
 266         draw_text(buttons[c].label, pixmap, pixmap_gc,
 267                   y - w - line_width + logical_px(6),
 268                   logical_px(4) + logical_px(3),
 269                   rect.width - y + w + line_width - logical_px(6));
 270
 271         y -= w;
 272     }
 273
 274     /* border line at the bottom */
 275     line_width = logical_px(2);
 276     values[0] = color_border_bottom;
 277     values[1] = line_width;
 278     xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND | XCB_GC_LINE_WIDTH, values);
 279     xcb_point_t bottom[] = {
 280         {0, rect.height - 0},
 281         {rect.width, rect.height - 0}};
 282     xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, pixmap, pixmap_gc, 2, bottom);
 283
 284     /* Copy the contents of the pixmap to the real window */
 285     xcb_copy_area(conn, pixmap, win, pixmap_gc, 0, 0, 0, 0, rect.width, rect.height);
 286     xcb_flush(conn);
 287
 288     return 1;
 289 }
 290
 291 int main(int argc, char *argv[]) {
 292     /* The following lines are a terribly horrible kludge. Because terminal
 293      * emulators have different ways of interpreting the -e command line
 294      * argument (some need -e "less /etc/fstab", others need -e less
 295      * /etc/fstab), we need to write commands to a script and then just run
 296      * that script. However, since on some machines, $XDG_RUNTIME_DIR and
 297      * $TMPDIR are mounted with noexec, we cannot directly execute the script
 298      * either.
 299      *
 300      * Initially, we tried to pass the command via the environment variable
 301      * _I3_NAGBAR_CMD. But turns out that some terminal emulators such as
 302      * xfce4-terminal run all windows from a single master process and only
 303      * pass on the command (not the environment) to that master process.
 304      *
 305      * Therefore, we symlink i3-nagbar (which MUST reside on an executable
 306      * filesystem) with a special name and run that symlink. When i3-nagbar
 307      * recognizes it’s started as a binary ending in .nagbar_cmd, it strips off
 308      * the .nagbar_cmd suffix and runs /bin/sh on argv[0]. That way, we can run
 309      * a shell script on a noexec filesystem.
 310      *
 311      * From a security point of view, i3-nagbar is just an alias to /bin/sh in
 312      * certain circumstances. This should not open any new security issues, I
 313      * hope. */
 314     char *cmd = NULL;
 315     const size_t argv0_len = strlen(argv[0]);
 316     if (argv0_len > strlen(".nagbar_cmd") &&
 317         strcmp(argv[0] + argv0_len - strlen(".nagbar_cmd"), ".nagbar_cmd") == 0) {
 318         unlink(argv[0]);
 319         cmd = strdup(argv[0]);
 320         *(cmd + argv0_len - strlen(".nagbar_cmd")) = '\0';
 321         execl("/bin/sh", "/bin/sh", cmd, NULL);
 322         err(EXIT_FAILURE, "execv(/bin/sh, /bin/sh, %s)", cmd);
 323     }
 324
 325     argv0 = argv[0];
 326
 327     char *pattern = sstrdup("pango:monospace 8");
 328     int o, option_index = 0;
 329     enum { TYPE_ERROR = 0,
 330            TYPE_WARNING = 1 } bar_type = TYPE_ERROR;
 331
 332     static struct option long_options[] = {
 333         {"version", no_argument, 0, 'v'},
 334         {"font", required_argument, 0, 'f'},
 335         {"button", required_argument, 0, 'b'},
 336         {"help", no_argument, 0, 'h'},
 337         {"message", required_argument, 0, 'm'},
 338         {"type", required_argument, 0, 't'},
 339         {0, 0, 0, 0}};
 340
 341     char *options_string = "b:f:m:t:vh";
 342
 343     prompt = i3string_from_utf8("Please do not run this program.");
 344
 345     while ((o = getopt_long(argc, argv, options_string, long_options, &option_index)) != -1) {
 346         switch (o) {
 347             case 'v':
 348                 printf("i3-nagbar " I3_VERSION "\n");
 349                 return 0;
 350             case 'f':
 351                 FREE(pattern);
 352                 pattern = sstrdup(optarg);
 353                 break;
 354             case 'm':
 355                 i3string_free(prompt);
 356                 prompt = i3string_from_utf8(optarg);
 357                 break;
 358             case 't':
 359                 bar_type = (strcasecmp(optarg, "warning") == 0 ? TYPE_WARNING : TYPE_ERROR);
 360                 break;
 361             case 'h':
 362                 printf("i3-nagbar " I3_VERSION "\n");
 363                 printf("i3-nagbar [-m <message>] [-b <button> <action>] [-t warning|error] [-f <font>] [-v]\n");
 364                 return 0;
 365             case 'b':
 366                 buttons = realloc(buttons, sizeof(button_t) * (buttoncnt + 1));
 367                 buttons[buttoncnt].label = i3string_from_utf8(optarg);
 368                 buttons[buttoncnt].action = argv[optind];
 369                 printf("button with label *%s* and action *%s*\n",
 370                        i3string_as_utf8(buttons[buttoncnt].label),
 371                        buttons[buttoncnt].action);
 372                 buttoncnt++;
 373                 printf("now %d buttons\n", buttoncnt);
 374                 if (optind < argc)
 375                     optind++;
 376                 break;
 377         }
 378     }
 379
 380     int screens;
 381     if ((conn = xcb_connect(NULL, &screens)) == NULL ||
 382         xcb_connection_has_error(conn))
 383         die("Cannot open display\n");
 384
 385 /* Place requests for the atoms we need as soon as possible */
 386 #define xmacro(atom) \
 387     xcb_intern_atom_cookie_t atom##_cookie = xcb_intern_atom(conn, 0, strlen(#atom), #atom);
 388 #include "atoms.xmacro"
 389 #undef xmacro
 390
 391     root_screen = xcb_aux_get_screen(conn, screens);
 392     root = root_screen->root;
 393
 394     if (bar_type == TYPE_ERROR) {
 395         /* Red theme for error messages */
 396         color_button_background = get_colorpixel("#680a0a");
 397         color_background = get_colorpixel("#900000");
 398         color_text = get_colorpixel("#ffffff");
 399         color_border = get_colorpixel("#d92424");
 400         color_border_bottom = get_colorpixel("#470909");
 401     } else {
 402         /* Yellowish theme for warnings */
 403         color_button_background = get_colorpixel("#ffc100");
 404         color_background = get_colorpixel("#ffa8000");
 405         color_text = get_colorpixel("#000000");
 406         color_border = get_colorpixel("#ab7100");
 407         color_border_bottom = get_colorpixel("#ab7100");
 408     }
 409
 410     font = load_font(pattern, true);
 411     set_font(&font);
 412
 413     /* Open an input window */
 414     win = xcb_generate_id(conn);
 415
 416     xcb_create_window(
 417         conn,
 418         XCB_COPY_FROM_PARENT,
 419         win,                                                                         /* the window id */
 420         root,                                                                        /* parent == root */
 421         50, 50, 500, font.height + logical_px(8) + logical_px(8) /* 8 px padding */, /* dimensions */
 422         0,                                                                           /* x11 border = 0, we draw our own */
 423         XCB_WINDOW_CLASS_INPUT_OUTPUT,
 424         XCB_WINDOW_CLASS_COPY_FROM_PARENT, /* copy visual from parent */
 425         XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK,
 426         (uint32_t[]){
 427             0, /* back pixel: black */
 428             XCB_EVENT_MASK_EXPOSURE |
 429                 XCB_EVENT_MASK_STRUCTURE_NOTIFY |
 430                 XCB_EVENT_MASK_BUTTON_PRESS |
 431                 XCB_EVENT_MASK_BUTTON_RELEASE});
 432
 433     /* Map the window (make it visible) */
 434     xcb_map_window(conn, win);
 435
 436 /* Setup NetWM atoms */
 437 #define xmacro(name)                                                                       \
 438     do {                                                                                   \
 439         xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply(conn, name##_cookie, NULL); \
 440         if (!reply)                                                                        \
 441             die("Could not get atom " #name "\n");                                         \
 442                                                                                            \
 443         A_##name = reply->atom;                                                            \
 444         free(reply);                                                                       \
 445     } while (0);
 446 #include "atoms.xmacro"
 447 #undef xmacro
 448
 449     /* Set dock mode */
 450     xcb_change_property(conn,
 451                         XCB_PROP_MODE_REPLACE,
 452                         win,
 453                         A__NET_WM_WINDOW_TYPE,
 454                         A_ATOM,
 455                         32,
 456                         1,
 457                         (unsigned char *)&A__NET_WM_WINDOW_TYPE_DOCK);
 458
 459     /* Reserve some space at the top of the screen */
 460     struct {
 461         uint32_t left;
 462         uint32_t right;
 463         uint32_t top;
 464         uint32_t bottom;
 465         uint32_t left_start_y;
 466         uint32_t left_end_y;
 467         uint32_t right_start_y;
 468         uint32_t right_end_y;
 469         uint32_t top_start_x;
 470         uint32_t top_end_x;
 471         uint32_t bottom_start_x;
 472         uint32_t bottom_end_x;
 473     } __attribute__((__packed__)) strut_partial;
 474     memset(&strut_partial, 0, sizeof(strut_partial));
 475
 476     strut_partial.top = font.height + logical_px(6);
 477     strut_partial.top_start_x = 0;
 478     strut_partial.top_end_x = 800;
 479
 480     xcb_change_property(conn,
 481                         XCB_PROP_MODE_REPLACE,
 482                         win,
 483                         A__NET_WM_STRUT_PARTIAL,
 484                         A_CARDINAL,
 485                         32,
 486                         12,
 487                         &strut_partial);
 488
 489     /* Create pixmap */
 490     pixmap = xcb_generate_id(conn);
 491     pixmap_gc = xcb_generate_id(conn);
 492     xcb_create_pixmap(conn, root_screen->root_depth, pixmap, win, 500, font.height + logical_px(8));
 493     xcb_create_gc(conn, pixmap_gc, pixmap, 0, 0);
 494
 495     /* Grab the keyboard to get all input */
 496     xcb_flush(conn);
 497
 498     xcb_generic_event_t *event;
 499     while ((event = xcb_wait_for_event(conn)) != NULL) {
 500         if (event->response_type == 0) {
 501             fprintf(stderr, "X11 Error received! sequence %x\n", event->sequence);
 502             continue;
 503         }
 504
 505         /* Strip off the highest bit (set if the event is generated) */
 506         int type = (event->response_type & 0x7F);
 507
 508         switch (type) {
 509             case XCB_EXPOSE:
 510                 handle_expose(conn, (xcb_expose_event_t *)event);
 511                 break;
 512
 513             case XCB_BUTTON_PRESS:
 514                 handle_button_press(conn, (xcb_button_press_event_t *)event);
 515                 break;
 516
 517             case XCB_BUTTON_RELEASE:
 518                 handle_button_release(conn, (xcb_button_release_event_t *)event);
 519                 break;
 520
 521             case XCB_CONFIGURE_NOTIFY: {
 522                 xcb_configure_notify_event_t *configure_notify = (xcb_configure_notify_event_t *)event;
 523                 rect = (xcb_rectangle_t){
 524                     configure_notify->x,
 525                     configure_notify->y,
 526                     configure_notify->width,
 527                     configure_notify->height};
 528
 529                 /* Recreate the pixmap / gc */
 530                 xcb_free_pixmap(conn, pixmap);
 531                 xcb_free_gc(conn, pixmap_gc);
 532
 533                 xcb_create_pixmap(conn, root_screen->root_depth, pixmap, win, rect.width, rect.height);
 534                 xcb_create_gc(conn, pixmap_gc, pixmap, 0, 0);
 535                 break;
 536             }
 537         }
 538
 539         free(event);
 540     }
 541
 542     FREE(pattern);
 543
 544     return 0;
 545 }