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