git.sur5r.net Git - i3/i3lock/blob - unlock_indicator.c

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * © 2010 Michael Stapelberg
   5  *
   6  * See LICENSE for licensing information
   7  *
   8  */
   9 #include <stdbool.h>
  10 #include <stdlib.h>
  11 #include <stdio.h>
  12 #include <string.h>
  13 #include <math.h>
  14 #include <xcb/xcb.h>
  15 #include <ev.h>
  16 #include <cairo.h>
  17 #include <cairo/cairo-xcb.h>
  18
  19 #include "i3lock.h"
  20 #include "xcb.h"
  21 #include "unlock_indicator.h"
  22 #include "xinerama.h"
  23
  24 #define BUTTON_RADIUS 90
  25 #define BUTTON_SPACE (BUTTON_RADIUS + 5)
  26 #define BUTTON_CENTER (BUTTON_RADIUS + 5)
  27 #define BUTTON_DIAMETER (2 * BUTTON_SPACE)
  28
  29 /*******************************************************************************
  30  * Variables defined in i3lock.c.
  31  ******************************************************************************/
  32
  33 extern bool debug_mode;
  34
  35 /* The current position in the input buffer. Useful to determine if any
  36  * characters of the password have already been entered or not. */
  37 int input_position;
  38
  39 /* The lock window. */
  40 extern xcb_window_t win;
  41
  42 /* The current resolution of the X11 root window. */
  43 extern uint32_t last_resolution[2];
  44
  45 /* Whether the unlock indicator is enabled (defaults to true). */
  46 extern bool unlock_indicator;
  47
  48 /* List of pressed modifiers, or NULL if none are pressed. */
  49 extern char *modifier_string;
  50
  51 /* A Cairo surface containing the specified image (-i), if any. */
  52 extern cairo_surface_t *img;
  53
  54 /* Whether the image should be tiled. */
  55 extern bool tile;
  56 /* The background color to use (in hex). */
  57 extern char color[7];
  58
  59 /* Whether the failed attempts should be displayed. */
  60 extern bool show_failed_attempts;
  61 /* Number of failed unlock attempts. */
  62 extern int failed_attempts;
  63
  64 /*******************************************************************************
  65  * Variables defined in xcb.c.
  66  ******************************************************************************/
  67
  68 /* The root screen, to determine the DPI. */
  69 extern xcb_screen_t *screen;
  70
  71 /*******************************************************************************
  72  * Local variables.
  73  ******************************************************************************/
  74
  75 /* Cache the screen’s visual, necessary for creating a Cairo context. */
  76 static xcb_visualtype_t *vistype;
  77
  78 /* Maintain the current unlock/PAM state to draw the appropriate unlock
  79  * indicator. */
  80 unlock_state_t unlock_state;
  81 pam_state_t pam_state;
  82
  83 /*
  84  * Returns the scaling factor of the current screen. E.g., on a 227 DPI MacBook
  85  * Pro 13" Retina screen, the scaling factor is 227/96 = 2.36.
  86  *
  87  */
  88 static double scaling_factor(void) {
  89     const int dpi = (double)screen->height_in_pixels * 25.4 /
  90                     (double)screen->height_in_millimeters;
  91     return (dpi / 96.0);
  92 }
  93
  94 /*
  95  * Draws global image with fill color onto a pixmap with the given
  96  * resolution and returns it.
  97  *
  98  */
  99 xcb_pixmap_t draw_image(uint32_t *resolution) {
 100     xcb_pixmap_t bg_pixmap = XCB_NONE;
 101     int button_diameter_physical = ceil(scaling_factor() * BUTTON_DIAMETER);
 102     DEBUG("scaling_factor is %.f, physical diameter is %d px\n",
 103           scaling_factor(), button_diameter_physical);
 104
 105     if (!vistype)
 106         vistype = get_root_visual_type(screen);
 107     bg_pixmap = create_bg_pixmap(conn, screen, resolution, color);
 108     /* Initialize cairo: Create one in-memory surface to render the unlock
 109      * indicator on, create one XCB surface to actually draw (one or more,
 110      * depending on the amount of screens) unlock indicators on. */
 111     cairo_surface_t *output = cairo_image_surface_create(CAIRO_FORMAT_ARGB32, button_diameter_physical, button_diameter_physical);
 112     cairo_t *ctx = cairo_create(output);
 113
 114     cairo_surface_t *xcb_output = cairo_xcb_surface_create(conn, bg_pixmap, vistype, resolution[0], resolution[1]);
 115     cairo_t *xcb_ctx = cairo_create(xcb_output);
 116
 117     if (img) {
 118         if (!tile) {
 119             cairo_set_source_surface(xcb_ctx, img, 0, 0);
 120             cairo_paint(xcb_ctx);
 121         } else {
 122             /* create a pattern and fill a rectangle as big as the screen */
 123             cairo_pattern_t *pattern;
 124             pattern = cairo_pattern_create_for_surface(img);
 125             cairo_set_source(xcb_ctx, pattern);
 126             cairo_pattern_set_extend(pattern, CAIRO_EXTEND_REPEAT);
 127             cairo_rectangle(xcb_ctx, 0, 0, resolution[0], resolution[1]);
 128             cairo_fill(xcb_ctx);
 129             cairo_pattern_destroy(pattern);
 130         }
 131     } else {
 132         char strgroups[3][3] = {{color[0], color[1], '\0'},
 133                                 {color[2], color[3], '\0'},
 134                                 {color[4], color[5], '\0'}};
 135         uint32_t rgb16[3] = {(strtol(strgroups[0], NULL, 16)),
 136                              (strtol(strgroups[1], NULL, 16)),
 137                              (strtol(strgroups[2], NULL, 16))};
 138         cairo_set_source_rgb(xcb_ctx, rgb16[0] / 255.0, rgb16[1] / 255.0, rgb16[2] / 255.0);
 139         cairo_rectangle(xcb_ctx, 0, 0, resolution[0], resolution[1]);
 140         cairo_fill(xcb_ctx);
 141     }
 142
 143     if (unlock_indicator &&
 144         (unlock_state >= STATE_KEY_PRESSED || pam_state > STATE_PAM_IDLE)) {
 145         cairo_scale(ctx, scaling_factor(), scaling_factor());
 146         /* Draw a (centered) circle with transparent background. */
 147         cairo_set_line_width(ctx, 10.0);
 148         cairo_arc(ctx,
 149                   BUTTON_CENTER /* x */,
 150                   BUTTON_CENTER /* y */,
 151                   BUTTON_RADIUS /* radius */,
 152                   0 /* start */,
 153                   2 * M_PI /* end */);
 154
 155         /* Use the appropriate color for the different PAM states
 156          * (currently verifying, wrong password, or default) */
 157         switch (pam_state) {
 158             case STATE_PAM_VERIFY:
 159                 cairo_set_source_rgba(ctx, 0, 114.0 / 255, 255.0 / 255, 0.75);
 160                 break;
 161             case STATE_PAM_WRONG:
 162                 cairo_set_source_rgba(ctx, 250.0 / 255, 0, 0, 0.75);
 163                 break;
 164             default:
 165                 cairo_set_source_rgba(ctx, 0, 0, 0, 0.75);
 166                 break;
 167         }
 168         cairo_fill_preserve(ctx);
 169
 170         switch (pam_state) {
 171             case STATE_PAM_VERIFY:
 172                 cairo_set_source_rgb(ctx, 51.0 / 255, 0, 250.0 / 255);
 173                 break;
 174             case STATE_PAM_WRONG:
 175                 cairo_set_source_rgb(ctx, 125.0 / 255, 51.0 / 255, 0);
 176                 break;
 177             case STATE_PAM_IDLE:
 178                 cairo_set_source_rgb(ctx, 51.0 / 255, 125.0 / 255, 0);
 179                 break;
 180         }
 181         cairo_stroke(ctx);
 182
 183         /* Draw an inner seperator line. */
 184         cairo_set_source_rgb(ctx, 0, 0, 0);
 185         cairo_set_line_width(ctx, 2.0);
 186         cairo_arc(ctx,
 187                   BUTTON_CENTER /* x */,
 188                   BUTTON_CENTER /* y */,
 189                   BUTTON_RADIUS - 5 /* radius */,
 190                   0,
 191                   2 * M_PI);
 192         cairo_stroke(ctx);
 193
 194         cairo_set_line_width(ctx, 10.0);
 195
 196         /* Display a (centered) text of the current PAM state. */
 197         char *text = NULL;
 198         /* We don't want to show more than a 3-digit number. */
 199         char buf[4];
 200
 201         cairo_set_source_rgb(ctx, 0, 0, 0);
 202         cairo_select_font_face(ctx, "sans-serif", CAIRO_FONT_SLANT_NORMAL, CAIRO_FONT_WEIGHT_NORMAL);
 203         cairo_set_font_size(ctx, 28.0);
 204         switch (pam_state) {
 205             case STATE_PAM_VERIFY:
 206                 text = "verifying…";
 207                 break;
 208             case STATE_PAM_WRONG:
 209                 text = "wrong!";
 210                 break;
 211             default:
 212                 if (show_failed_attempts && failed_attempts > 0) {
 213                     if (failed_attempts > 999) {
 214                         text = "> 999";
 215                     } else {
 216                         snprintf(buf, sizeof(buf), "%d", failed_attempts);
 217                         text = buf;
 218                     }
 219                     cairo_set_source_rgb(ctx, 1, 0, 0);
 220                     cairo_set_font_size(ctx, 32.0);
 221                 }
 222                 break;
 223         }
 224
 225         if (text) {
 226             cairo_text_extents_t extents;
 227             double x, y;
 228
 229             cairo_text_extents(ctx, text, &extents);
 230             x = BUTTON_CENTER - ((extents.width / 2) + extents.x_bearing);
 231             y = BUTTON_CENTER - ((extents.height / 2) + extents.y_bearing);
 232
 233             cairo_move_to(ctx, x, y);
 234             cairo_show_text(ctx, text);
 235             cairo_close_path(ctx);
 236         }
 237
 238         if (pam_state == STATE_PAM_WRONG && (modifier_string != NULL)) {
 239             cairo_text_extents_t extents;
 240             double x, y;
 241
 242             cairo_set_font_size(ctx, 14.0);
 243
 244             cairo_text_extents(ctx, modifier_string, &extents);
 245             x = BUTTON_CENTER - ((extents.width / 2) + extents.x_bearing);
 246             y = BUTTON_CENTER - ((extents.height / 2) + extents.y_bearing) + 28.0;
 247
 248             cairo_move_to(ctx, x, y);
 249             cairo_show_text(ctx, modifier_string);
 250             cairo_close_path(ctx);
 251         }
 252
 253         /* After the user pressed any valid key or the backspace key, we
 254          * highlight a random part of the unlock indicator to confirm this
 255          * keypress. */
 256         if (unlock_state == STATE_KEY_ACTIVE ||
 257             unlock_state == STATE_BACKSPACE_ACTIVE) {
 258             cairo_new_sub_path(ctx);
 259             double highlight_start = (rand() % (int)(2 * M_PI * 100)) / 100.0;
 260             cairo_arc(ctx,
 261                       BUTTON_CENTER /* x */,
 262                       BUTTON_CENTER /* y */,
 263                       BUTTON_RADIUS /* radius */,
 264                       highlight_start,
 265                       highlight_start + (M_PI / 3.0));
 266             if (unlock_state == STATE_KEY_ACTIVE) {
 267                 /* For normal keys, we use a lighter green. */
 268                 cairo_set_source_rgb(ctx, 51.0 / 255, 219.0 / 255, 0);
 269             } else {
 270                 /* For backspace, we use red. */
 271                 cairo_set_source_rgb(ctx, 219.0 / 255, 51.0 / 255, 0);
 272             }
 273             cairo_stroke(ctx);
 274
 275             /* Draw two little separators for the highlighted part of the
 276              * unlock indicator. */
 277             cairo_set_source_rgb(ctx, 0, 0, 0);
 278             cairo_arc(ctx,
 279                       BUTTON_CENTER /* x */,
 280                       BUTTON_CENTER /* y */,
 281                       BUTTON_RADIUS /* radius */,
 282                       highlight_start /* start */,
 283                       highlight_start + (M_PI / 128.0) /* end */);
 284             cairo_stroke(ctx);
 285             cairo_arc(ctx,
 286                       BUTTON_CENTER /* x */,
 287                       BUTTON_CENTER /* y */,
 288                       BUTTON_RADIUS /* radius */,
 289                       highlight_start + (M_PI / 3.0) /* start */,
 290                       (highlight_start + (M_PI / 3.0)) + (M_PI / 128.0) /* end */);
 291             cairo_stroke(ctx);
 292         }
 293     }
 294
 295     if (xr_screens > 0) {
 296         /* Composite the unlock indicator in the middle of each screen. */
 297         for (int screen = 0; screen < xr_screens; screen++) {
 298             int x = (xr_resolutions[screen].x + ((xr_resolutions[screen].width / 2) - (button_diameter_physical / 2)));
 299             int y = (xr_resolutions[screen].y + ((xr_resolutions[screen].height / 2) - (button_diameter_physical / 2)));
 300             cairo_set_source_surface(xcb_ctx, output, x, y);
 301             cairo_rectangle(xcb_ctx, x, y, button_diameter_physical, button_diameter_physical);
 302             cairo_fill(xcb_ctx);
 303         }
 304     } else {
 305         /* We have no information about the screen sizes/positions, so we just
 306          * place the unlock indicator in the middle of the X root window and
 307          * hope for the best. */
 308         int x = (last_resolution[0] / 2) - (button_diameter_physical / 2);
 309         int y = (last_resolution[1] / 2) - (button_diameter_physical / 2);
 310         cairo_set_source_surface(xcb_ctx, output, x, y);
 311         cairo_rectangle(xcb_ctx, x, y, button_diameter_physical, button_diameter_physical);
 312         cairo_fill(xcb_ctx);
 313     }
 314
 315     cairo_surface_destroy(xcb_output);
 316     cairo_surface_destroy(output);
 317     cairo_destroy(ctx);
 318     cairo_destroy(xcb_ctx);
 319     return bg_pixmap;
 320 }
 321
 322 /*
 323  * Calls draw_image on a new pixmap and swaps that with the current pixmap
 324  *
 325  */
 326 void redraw_screen(void) {
 327     DEBUG("redraw_screen(unlock_state = %d, pam_state = %d)\n", unlock_state, pam_state);
 328     xcb_pixmap_t bg_pixmap = draw_image(last_resolution);
 329     xcb_change_window_attributes(conn, win, XCB_CW_BACK_PIXMAP, (uint32_t[1]){bg_pixmap});
 330     /* XXX: Possible optimization: Only update the area in the middle of the
 331      * screen instead of the whole screen. */
 332     xcb_clear_area(conn, 0, win, 0, 0, last_resolution[0], last_resolution[1]);
 333     xcb_free_pixmap(conn, bg_pixmap);
 334     xcb_flush(conn);
 335 }
 336
 337 /*
 338  * Hides the unlock indicator completely when there is no content in the
 339  * password buffer.
 340  *
 341  */
 342 void clear_indicator(void) {
 343     if (input_position == 0) {
 344         unlock_state = STATE_STARTED;
 345     } else
 346         unlock_state = STATE_KEY_PRESSED;
 347     redraw_screen();
 348 }