]> git.sur5r.net Git - i3/i3lock/blobdiff - i3lock.c
fix ctrl-u handling
[i3/i3lock] / i3lock.c
index 4c9a8071bf12ad1b4d5c03791cdcaa3c12294618..5a87999f6b4b666b4e5dfa8bd4371e4ba97f48ae 100644 (file)
--- a/i3lock.c
+++ b/i3lock.c
 #include <stdint.h>
 #include <xcb/xcb.h>
 #include <xcb/dpms.h>
-#include <xcb/xcb_keysyms.h>
 #include <err.h>
 #include <assert.h>
 #include <security/pam_appl.h>
-/* FIXME: can we get rid of this header? */
-#include <X11/keysym.h>
+#include <X11/Xlib-xcb.h>
 #include <getopt.h>
 #include <string.h>
 #include <ev.h>
 #include <sys/mman.h>
-
-
-#ifndef NOLIBCAIRO
+#include <X11/XKBlib.h>
+#include <X11/extensions/XKBfile.h>
+#include <xkbcommon/xkbcommon.h>
 #include <cairo.h>
 #include <cairo/cairo-xcb.h>
-#endif
 
-#include "keysym2ucs.h"
-#include "ucs2_to_utf8.h"
+#include "i3lock.h"
 #include "xcb.h"
 #include "cursors.h"
 #include "unlock_indicator.h"
 #include "xinerama.h"
 
+/* We need this for libxkbfile */
+static Display *display;
 char color[7] = "ffffff";
 uint32_t last_resolution[2];
 xcb_window_t win;
 static xcb_cursor_t cursor;
-static xcb_key_symbols_t *symbols;
 static pam_handle_t *pam_handle;
 int input_position = 0;
 /* Holds the password you enter (in UTF-8). */
 static char password[512];
-static bool modeswitch_active = false;
-static bool iso_level3_shift_active = false;
-static bool iso_level5_shift_active = false;
-static int numlockmask;
 static bool beep = false;
-static bool debug_mode = false;
+bool debug_mode = false;
 static bool dpms = false;
 bool unlock_indicator = true;
 static bool dont_fork = false;
@@ -61,22 +54,95 @@ static struct ev_timer *clear_pam_wrong_timeout;
 extern unlock_state_t unlock_state;
 extern pam_state_t pam_state;
 
-#define DEBUG(fmt, ...) do { \
-    if (debug_mode) \
-        printf("[i3lock-debug] " fmt, ##__VA_ARGS__); \
-} while (0)
+static struct xkb_state *xkb_state;
+static struct xkb_context *xkb_context;
+static struct xkb_keymap *xkb_keymap;
 
-#ifndef NOLIBCAIRO
 cairo_surface_t *img = NULL;
 bool tile = false;
-#endif
+
+/* isutf, u8_dec © 2005 Jeff Bezanson, public domain */
+#define isutf(c) (((c) & 0xC0) != 0x80)
+
+/*
+ * Decrements i to point to the previous unicode glyph
+ *
+ */
+void u8_dec(char *s, int *i) {
+    (void)(isutf(s[--(*i)]) || isutf(s[--(*i)]) || isutf(s[--(*i)]) || --(*i));
+}
+
+/*
+ * Loads the XKB keymap from the X11 server and feeds it to xkbcommon.
+ * Necessary so that we can properly let xkbcommon track the keyboard state and
+ * translate keypresses to utf-8.
+ *
+ * Ideally, xkbcommon would ship something like this itself, but as of now
+ * (version 0.2.0), it doesn’t.
+ *
+ */
+static bool load_keymap(void) {
+    bool ret = false;
+    XkbFileInfo result;
+    memset(&result, '\0', sizeof(result));
+    result.xkb = XkbGetKeyboard(display, XkbAllMapComponentsMask, XkbUseCoreKbd);
+    if (result.xkb == NULL) {
+        fprintf(stderr, "[i3lock] XKB: XkbGetKeyboard failed\n");
+        return false;
+    }
+
+    FILE *temp = tmpfile();
+    if (temp == NULL) {
+        fprintf(stderr, "[i3lock] could not create tempfile\n");
+        return false;
+    }
+
+    bool ok = XkbWriteXKBKeymap(temp, &result, false, false, NULL, NULL);
+    if (!ok) {
+        fprintf(stderr, "[i3lock] XkbWriteXKBKeymap failed\n");
+        goto out;
+    }
+
+    rewind(temp);
+
+    if (xkb_context == NULL) {
+        if ((xkb_context = xkb_context_new(0)) == NULL) {
+            fprintf(stderr, "[i3lock] could not create xkbcommon context\n");
+            goto out;
+        }
+    }
+
+    if (xkb_keymap != NULL)
+        xkb_keymap_unref(xkb_keymap);
+
+    if ((xkb_keymap = xkb_keymap_new_from_file(xkb_context, temp, XKB_KEYMAP_FORMAT_TEXT_V1, 0)) == NULL) {
+        fprintf(stderr, "[i3lock] xkb_keymap_new_from_file failed\n");
+        goto out;
+    }
+
+    struct xkb_state *new_state = xkb_state_new(xkb_keymap);
+    if (new_state == NULL) {
+        fprintf(stderr, "[i3lock] xkb_state_new failed\n");
+        goto out;
+    }
+
+    if (xkb_state != NULL)
+        xkb_state_unref(xkb_state);
+    xkb_state = new_state;
+
+    ret = true;
+out:
+    XkbFreeKeyboard(result.xkb, XkbAllComponentsMask, true);
+    fclose(temp);
+    return ret;
+}
 
 /*
  * Clears the memory which stored the password to be a bit safer against
  * cold-boot attacks.
  *
  */
-static void clear_password_memory() {
+static void clear_password_memory(void) {
     /* A volatile pointer to the password buffer to prevent the compiler from
      * optimizing this out. */
     volatile char *vpassword = password;
@@ -106,10 +172,20 @@ static void clear_pam_wrong(EV_P_ ev_timer *w, int revents) {
     clear_pam_wrong_timeout = NULL;
 }
 
-static void input_done() {
-    if (input_position == 0)
-        return;
+static void clear_input(void) {
+    input_position = 0;
+    clear_password_memory();
+    password[input_position] = '\0';
+
+    /* Hide the unlock indicator after a bit if the password buffer is
+     * empty. */
+    start_clear_indicator_timeout();
+    unlock_state = STATE_BACKSPACE_ACTIVE;
+    redraw_screen();
+    unlock_state = STATE_KEY_PRESSED;
+}
 
+static void input_done(void) {
     if (clear_pam_wrong_timeout) {
         ev_timer_stop(main_loop, clear_pam_wrong_timeout);
         free(clear_pam_wrong_timeout);
@@ -120,14 +196,16 @@ static void input_done() {
     redraw_screen();
 
     if (pam_authenticate(pam_handle, 0) == PAM_SUCCESS) {
-        printf("successfully authenticated\n");
+        DEBUG("successfully authenticated\n");
         clear_password_memory();
         exit(0);
     }
 
-    fprintf(stderr, "Authentication failure\n");
+    if (debug_mode)
+        fprintf(stderr, "Authentication failure\n");
 
     pam_state = STATE_PAM_WRONG;
+    clear_input();
     redraw_screen();
 
     /* Clear this state after 2 seconds (unless the user enters another
@@ -155,24 +233,7 @@ static void input_done() {
  *
  */
 static void handle_key_release(xcb_key_release_event_t *event) {
-    DEBUG("releasing key %d, state raw = %d, modeswitch_active = %d, iso_level3_shift_active = %d, iso_level5_shift_active = %d\n",
-          event->detail, event->state, modeswitch_active, iso_level3_shift_active, iso_level5_shift_active);
-
-    /* We don’t care about the column here and just use the first symbol. Since
-     * we only check for Mode_switch and ISO_Level3_Shift, this *should* work.
-     * Also, if we would use the current column, we would look in the wrong
-     * place. */
-    xcb_keysym_t sym = xcb_key_press_lookup_keysym(symbols, event, 0);
-    if (sym == XK_Mode_switch) {
-        //printf("Mode switch disabled\n");
-        modeswitch_active = false;
-    } else if (sym == XK_ISO_Level3_Shift) {
-        iso_level3_shift_active = false;
-    } else if (sym == XK_ISO_Level5_Shift) {
-        iso_level5_shift_active = false;
-    }
-    DEBUG("release done. modeswitch_active = %d, iso_level3_shift_active = %d, iso_level5_shift_active = %d\n",
-          modeswitch_active, iso_level3_shift_active, iso_level5_shift_active);
+    xkb_state_update_key(xkb_state, event->detail, XKB_KEY_UP);
 }
 
 static void redraw_timeout(EV_P_ ev_timer *w, int revents) {
@@ -189,80 +250,42 @@ static void redraw_timeout(EV_P_ ev_timer *w, int revents) {
  *
  */
 static void handle_key_press(xcb_key_press_event_t *event) {
-    DEBUG("keypress %d, state raw = %d, modeswitch_active = %d, iso_level3_shift_active = %d\n",
-          event->detail, event->state, modeswitch_active, iso_level3_shift_active);
-
-    xcb_keysym_t sym0, sym1, sym;
-    /* For each keycode, there is a list of symbols. The list could look like this:
-     * $ xmodmap -pke | grep 'keycode  38'
-     * keycode  38 = a A adiaeresis Adiaeresis o O
-     * In non-X11 terminology, the symbols for the keycode 38 (the key labeled
-     * with "a" on my keyboard) are "a A ä Ä o O".
-     * Another form to display the same information is using xkbcomp:
-     * $ xkbcomp $DISPLAY /tmp/xkb.dump
-     * Then open /tmp/xkb.dump and search for '\<a\>' (in VIM regexp-language):
-     *
-     * symbols[Group1]= [               a,               A,               o,               O ],
-     * symbols[Group2]= [      adiaeresis,      Adiaeresis ]
-     *
-     * So there are two *groups*, one containing 'a A' and one containing 'ä
-     * Ä'. You can use Mode_switch to switch between these groups. You can use
-     * ISO_Level3_Shift to reach the 'o O' part of the first group (it’s the
-     * same group, just an even higher shift level).
-     *
-     * So, using the "logical" XKB information, the following lookup will be
-     * performed:
-     *
-     * Neither Mode_switch nor ISO_Level3_Shift active: group 1, column 0 and 1
-     * Mode_switch active: group 2, column 0 and 1
-     * ISO_Level3_Shift active: group 1, column 2 and 3
-     *
-     * Using the column index which xcb_key_press_lookup_keysym uses (and
-     * xmodmap prints out), the following lookup will be performed:
-     *
-     * Neither Mode_switch nor ISO_Level3_Shift active: column 0 and 1
-     * Mode_switch active: column 2 and 3
-     * ISO_Level3_Shift active: column 4 and 5
-     */
-    int base_column = 0;
-    if (modeswitch_active)
-        base_column = 2;
-    if (iso_level3_shift_active)
-        base_column = 4;
-    if (iso_level5_shift_active)
-        base_column = 6;
-    sym0 = xcb_key_press_lookup_keysym(symbols, event, base_column);
-    sym1 = xcb_key_press_lookup_keysym(symbols, event, base_column + 1);
-    switch (sym0) {
-    case XK_Mode_switch:
-        DEBUG("Mode switch enabled\n");
-        modeswitch_active = true;
-        return;
-    case XK_ISO_Level3_Shift:
-        DEBUG("ISO_Level3_Shift enabled\n");
-        iso_level3_shift_active = true;
-        return;
-    case XK_ISO_Level5_Shift:
-        DEBUG("ISO_Level5_Shift enabled\n");
-        iso_level5_shift_active = true;
-        return;
-    case XK_Return:
-    case XK_KP_Enter:
-        input_done();
-    case XK_Escape:
-        input_position = 0;
-        clear_password_memory();
+    xkb_keysym_t ksym;
+    char buffer[128];
+    int n;
+    bool ctrl;
+
+    ksym = xkb_state_key_get_one_sym(xkb_state, event->detail);
+    ctrl = xkb_state_mod_name_is_active(xkb_state, "Control", XKB_STATE_MODS_DEPRESSED);
+    xkb_state_update_key(xkb_state, event->detail, XKB_KEY_DOWN);
+
+    /* The buffer will be null-terminated, so n >= 2 for 1 actual character. */
+    memset(buffer, '\0', sizeof(buffer));
+    n = xkb_keysym_to_utf8(ksym, buffer, sizeof(buffer));
+
+    switch (ksym) {
+    case XKB_KEY_Return:
+    case XKB_KEY_KP_Enter:
+    case XKB_KEY_XF86ScreenSaver:
         password[input_position] = '\0';
-
-        /* Hide the unlock indicator after a bit if the password buffer is
-         * empty. */
-        start_clear_indicator_timeout();
-        unlock_state = STATE_BACKSPACE_ACTIVE;
-        redraw_screen();
         unlock_state = STATE_KEY_PRESSED;
+        redraw_screen();
+        input_done();
         return;
 
-    case XK_BackSpace:
+    case XKB_KEY_u:
+        if (ctrl) {
+            DEBUG("C-u pressed\n");
+            clear_input();
+            return;
+        }
+        break;
+
+    case XKB_KEY_Escape:
+        clear_input();
+        return;
+
+    case XKB_KEY_BackSpace:
         if (input_position == 0)
             return;
 
@@ -282,17 +305,6 @@ static void handle_key_press(xcb_key_press_event_t *event) {
     if ((input_position + 8) >= sizeof(password))
         return;
 
-    if ((event->state & numlockmask) && xcb_is_keypad_key(sym1)) {
-        /* this key was a keypad key */
-        if ((event->state & XCB_MOD_MASK_SHIFT))
-            sym = sym0;
-        else sym = sym1;
-    } else {
-        if ((event->state & XCB_MOD_MASK_SHIFT))
-            sym = sym1;
-        else sym = sym0;
-    }
-
 #if 0
     /* FIXME: handle all of these? */
     printf("is_keypad_key = %d\n", xcb_is_keypad_key(sym));
@@ -304,26 +316,13 @@ static void handle_key_press(xcb_key_press_event_t *event) {
     printf("xcb_is_modifier_key = %d\n", xcb_is_modifier_key(sym));
 #endif
 
-    if (xcb_is_modifier_key(sym) || xcb_is_cursor_key(sym))
+    if (n < 2)
         return;
 
-    DEBUG("resolved to keysym = %c (%d)\n", sym, sym);
-
-    /* convert the keysym to UCS */
-    uint16_t ucs = keysym2ucs(sym);
-    if ((int16_t)ucs == -1) {
-        fprintf(stderr, "Keysym could not be converted to UCS, skipping\n");
-        return;
-    }
-
-    /* store the UCS in a string to convert it */
-    uint8_t inp[3] = {(ucs & 0xFF00) >> 8, (ucs & 0xFF), 0};
-    DEBUG("input part = %s\n", inp);
-
     /* store it in the password array as UTF-8 */
-    input_position += convert_ucs_to_utf8((char*)inp, password + input_position);
-    password[input_position] = '\0';
-    DEBUG("current password = %s\n", password);
+    memcpy(password+input_position, buffer, n-1);
+    input_position += n-1;
+    DEBUG("current password = %.*s\n", input_position, password);
 
     unlock_state = STATE_KEY_ACTIVE;
     redraw_screen();
@@ -360,9 +359,9 @@ static void handle_visibility_notify(xcb_visibility_notify_event_t *event) {
  *
  */
 static void handle_mapping_notify(xcb_mapping_notify_event_t *event) {
-    xcb_refresh_keyboard_mapping(symbols, event);
-
-    numlockmask = get_mod_mask(conn, symbols, XK_Num_Lock);
+    /* We ignore errors — if the new keymap cannot be loaded it’s better if the
+     * screen stays locked and the user intervenes by using killall i3lock. */
+    (void)load_keymap();
 }
 
 /*
@@ -371,7 +370,7 @@ static void handle_mapping_notify(xcb_mapping_notify_event_t *event) {
  * and also redraw the image, if any.
  *
  */
-void handle_screen_resize() {
+void handle_screen_resize(void) {
     xcb_get_geometry_cookie_t geomc;
     xcb_get_geometry_reply_t *geom;
     geomc = xcb_get_geometry(conn, screen->root);
@@ -389,13 +388,14 @@ void handle_screen_resize() {
 
     free(geom);
 
-#ifndef NOLIBCAIRO
     redraw_screen();
-#endif
 
     uint32_t mask = XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT;
     xcb_configure_window(conn, win, mask, last_resolution);
     xcb_flush(conn);
+
+    xinerama_query_screens();
+    redraw_screen();
 }
 
 /*
@@ -409,7 +409,7 @@ static int conv_callback(int num_msg, const struct pam_message **msg,
         return 1;
 
     /* PAM expects an array of responses, one for each message */
-    if ((*resp = calloc(num_msg, sizeof(struct pam_message))) == NULL) {
+    if ((*resp = calloc(num_msg, sizeof(struct pam_response))) == NULL) {
         perror("calloc");
         return 1;
     }
@@ -458,8 +458,9 @@ static void xcb_check_cb(EV_P_ ev_check *w, int revents) {
     while ((event = xcb_poll_for_event(conn)) != NULL) {
         if (event->response_type == 0) {
             xcb_generic_error_t *error = (xcb_generic_error_t*)event;
-            fprintf(stderr, "X11 Error received! sequence 0x%x, error_code = %d\n",
-                    error->sequence, error->error_code);
+            if (debug_mode)
+                fprintf(stderr, "X11 Error received! sequence 0x%x, error_code = %d\n",
+                        error->sequence, error->error_code);
             free(event);
             continue;
         }
@@ -494,6 +495,8 @@ static void xcb_check_cb(EV_P_ ev_check *w, int revents) {
                     /* In the parent process, we exit */
                     if (fork() != 0)
                         exit(0);
+
+                    ev_loop_fork(EV_DEFAULT);
                 }
                 break;
 
@@ -512,14 +515,11 @@ static void xcb_check_cb(EV_P_ ev_check *w, int revents) {
 
 int main(int argc, char *argv[]) {
     char *username;
-#ifndef NOLIBCAIRO
     char *image_path = NULL;
-#endif
     int ret;
     struct pam_conv conv = {conv_callback, NULL};
-    int nscreen;
     int curs_choice = CURS_NONE;
-    char o;
+    int o;
     int optind = 0;
     struct option longopts[] = {
         {"version", no_argument, NULL, 'v'},
@@ -531,21 +531,15 @@ int main(int argc, char *argv[]) {
         {"debug", no_argument, NULL, 0},
         {"help", no_argument, NULL, 'h'},
         {"no-unlock-indicator", no_argument, NULL, 'u'},
-#ifndef NOLIBCAIRO
         {"image", required_argument, NULL, 'i'},
         {"tiling", no_argument, NULL, 't'},
-#endif
         {NULL, no_argument, NULL, 0}
     };
 
     if ((username = getenv("USER")) == NULL)
         errx(1, "USER environment variable not set, please set it.\n");
 
-    while ((o = getopt_long(argc, argv, "hvnbdc:p:u"
-#ifndef NOLIBCAIRO
-        "i:t"
-#endif
-        , longopts, &optind)) != -1) {
+    while ((o = getopt_long(argc, argv, "hvnbdc:p:ui:t", longopts, &optind)) != -1) {
         switch (o) {
         case 'v':
             errx(EXIT_SUCCESS, "version " VERSION " © 2010-2012 Michael Stapelberg");
@@ -566,21 +560,19 @@ int main(int argc, char *argv[]) {
                 arg++;
 
             if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", color) != 1)
-                errx(1, "color is invalid, color must be given in 6-byte format: rrggbb\n");
+                errx(1, "color is invalid, it must be given in 3-byte hexadecimal format: rrggbb\n");
 
             break;
         }
         case 'u':
             unlock_indicator = false;
             break;
-#ifndef NOLIBCAIRO
         case 'i':
             image_path = strdup(optarg);
             break;
         case 't':
             tile = true;
             break;
-#endif
         case 'p':
             if (!strcmp(optarg, "win")) {
                 curs_choice = CURS_WIN;
@@ -596,11 +588,7 @@ int main(int argc, char *argv[]) {
             break;
         default:
             errx(1, "Syntax: i3lock [-v] [-n] [-b] [-d] [-c color] [-u] [-p win|default]"
-#ifndef NOLIBCAIRO
             " [-i image.png] [-t]"
-#else
-            " (compiled with NOLIBCAIRO)"
-#endif
             );
         }
     }
@@ -614,17 +602,31 @@ int main(int argc, char *argv[]) {
     if (ret != PAM_SUCCESS)
         errx(EXIT_FAILURE, "PAM: %s", pam_strerror(pam_handle, ret));
 
+/* Using mlock() as non-super-user seems only possible in Linux. Users of other
+ * operating systems should use encrypted swap/no swap (or remove the ifdef and
+ * run i3lock as super-user). */
+#if defined(__linux__)
     /* Lock the area where we store the password in memory, we don’t want it to
      * be swapped to disk. Since Linux 2.6.9, this does not require any
      * privileges, just enough bytes in the RLIMIT_MEMLOCK limit. */
     if (mlock(password, sizeof(password)) != 0)
         err(EXIT_FAILURE, "Could not lock page in memory, check RLIMIT_MEMLOCK");
+#endif
 
     /* Initialize connection to X11 */
-    if ((conn = xcb_connect(NULL, &nscreen)) == NULL ||
-        xcb_connection_has_error(conn))
+    if ((display = XOpenDisplay(NULL)) == NULL)
+        errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?");
+    XSetEventQueueOwner(display, XCBOwnsEventQueue);
+    conn = XGetXCBConnection(display);
+
+    /* Double checking that connection is good and operatable with xcb */
+    if (xcb_connection_has_error(conn))
         errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?");
 
+    /* When we cannot initially load the keymap, we better exit */
+    if (!load_keymap())
+        errx(EXIT_FAILURE, "Could not load keymap");
+
     xinerama_init();
     xinerama_query_screens();
 
@@ -634,7 +636,8 @@ int main(int argc, char *argv[]) {
         xcb_dpms_capable_reply_t *dpmsr;
         if ((dpmsr = xcb_dpms_capable_reply(conn, dpmsc, NULL))) {
             if (!dpmsr->capable) {
-                fprintf(stderr, "Disabling DPMS, X server not DPMS capable\n");
+                if (debug_mode)
+                    fprintf(stderr, "Disabling DPMS, X server not DPMS capable\n");
                 dpms = false;
             }
             free(dpmsr);
@@ -646,13 +649,19 @@ int main(int argc, char *argv[]) {
     last_resolution[0] = screen->width_in_pixels;
     last_resolution[1] = screen->height_in_pixels;
 
+    xcb_change_window_attributes(conn, screen->root, XCB_CW_EVENT_MASK,
+            (uint32_t[]){ XCB_EVENT_MASK_STRUCTURE_NOTIFY });
 
-#ifndef NOLIBCAIRO
     if (image_path) {
         /* Create a pixmap to render on, fill it with the background color */
         img = cairo_image_surface_create_from_png(image_path);
+        /* In case loading failed, we just pretend no -i was specified. */
+        if (cairo_surface_status(img) != CAIRO_STATUS_SUCCESS) {
+            fprintf(stderr, "Could not load image \"%s\": cairo surface status %d\n",
+                    image_path, cairo_surface_status(img));
+            img = NULL;
+        }
     }
-#endif
 
     /* Pixmap on which the image is rendered to (if any) */
     xcb_pixmap_t bg_pixmap = draw_image(last_resolution);
@@ -665,9 +674,6 @@ int main(int argc, char *argv[]) {
 
     grab_pointer_and_keyboard(conn, screen, cursor);
 
-    symbols = xcb_key_symbols_alloc(conn);
-    numlockmask = get_mod_mask(conn, symbols, XK_Num_Lock);
-
     if (dpms)
         dpms_turn_off_screen(conn);
 
@@ -689,6 +695,9 @@ int main(int argc, char *argv[]) {
     ev_prepare_init(xcb_prepare, xcb_prepare_cb);
     ev_prepare_start(main_loop, xcb_prepare);
 
-    xcb_flush(conn);
+    /* Invoke the event callback once to catch all the events which were
+     * received up until now. ev will only pick up new events (when the X11
+     * file descriptor becomes readable). */
+    ev_invoke(main_loop, xcb_check, 0);
     ev_loop(main_loop, 0);
 }