2 * vim:ts=4:sw=4:expandtab
4 * © 2010-2011 Michael Stapelberg
6 * See LICENSE for licensing information
17 #include <xcb/xcb_keysyms.h>
20 #include <security/pam_appl.h>
21 /* FIXME: can we get rid of this header? */
22 #include <X11/keysym.h>
28 #include <cairo/cairo-xcb.h>
31 #include "keysym2ucs.h"
32 #include "ucs2_to_utf8.h"
36 static xcb_connection_t *conn;
37 static xcb_cursor_t cursor;
38 static xcb_key_symbols_t *symbols;
39 static xcb_screen_t *scr;
40 static pam_handle_t *pam_handle;
41 static int input_position = 0;
42 /* holds the password you enter (in UTF-8) */
43 static char password[512];
44 static bool modeswitch_active = false;
45 static int modeswitchmask;
46 static int numlockmask;
47 static bool beep = false;
50 static cairo_surface_t *img = NULL;
51 static bool tile = false;
55 * Draws global image with fill color onto a pixmap with the given
56 * resolution and returns it.
59 xcb_pixmap_t draw_image(xcb_visualtype_t *vistype, u_int32_t* resolution, char* color) {
60 xcb_pixmap_t bg_pixmap = XCB_NONE;
66 bg_pixmap = create_bg_pixmap(conn, scr, resolution, color);
67 /* Initialize cairo */
68 cairo_surface_t *output;
69 output = cairo_xcb_surface_create(conn, bg_pixmap, vistype,
70 resolution[0], resolution[1]);
71 cairo_t *ctx = cairo_create(output);
73 cairo_set_source_surface(ctx, img, 0, 0);
76 /* create a pattern and fill a rectangle as big as the screen */
77 cairo_pattern_t *pattern;
78 pattern = cairo_pattern_create_for_surface(img);
79 cairo_set_source(ctx, pattern);
80 cairo_pattern_set_extend(pattern, CAIRO_EXTEND_REPEAT);
81 cairo_rectangle(ctx, 0, 0, resolution[0], resolution[1]);
83 cairo_pattern_destroy(pattern);
85 cairo_surface_destroy(output);
91 static void input_done() {
92 if (input_position == 0)
95 /* TODO: change cursor during authentication? */
96 if (pam_authenticate(pam_handle, 0) == PAM_SUCCESS) {
97 printf("successfully authenticated\n");
101 fprintf(stderr, "Authentication failure\n");
103 /* beep on authentication failure, if enabled */
111 * Called when the user releases a key. We need to leave the Mode_switch
112 * state when the user releases the Mode_switch key.
115 static void handle_key_release(xcb_key_release_event_t *event) {
116 //printf("releasing %d, state raw = %d\n", event->detail, event->state);
119 event->state &= ~numlockmask;
121 xcb_keysym_t sym = xcb_key_press_lookup_keysym(symbols, event, event->state);
122 if (sym == XK_Mode_switch) {
123 //printf("Mode switch disabled\n");
124 modeswitch_active = false;
129 * Handle key presses. Fixes state, then looks up the key symbol for the
130 * given keycode, then looks up the key symbol (as UCS-2), converts it to
131 * UTF-8 and stores it in the password array.
134 static void handle_key_press(xcb_key_press_event_t *event) {
135 //printf("keypress %d, state raw = %d\n", event->detail, event->state);
137 xcb_keysym_t sym0, sym1, sym;
138 if (modeswitch_active) {
139 sym0 = xcb_key_press_lookup_keysym(symbols, event, 4);
140 sym1 = xcb_key_press_lookup_keysym(symbols, event, 5);
142 sym0 = xcb_key_press_lookup_keysym(symbols, event, 0);
143 sym1 = xcb_key_press_lookup_keysym(symbols, event, 1);
147 //printf("Mode switch enabled\n");
148 modeswitch_active = true;
156 password[input_position] = '\0';
160 if (input_position == 0)
163 /* decrement input_position to point to the previous glyph */
164 u8_dec(password, &input_position);
165 password[input_position] = '\0';
166 //printf("new input position = %d, new password = %s\n", input_position, password);
170 if ((input_position + 8) >= sizeof(password))
173 if ((event->state & numlockmask) && xcb_is_keypad_key(sym1)) {
174 /* this key was a keypad key */
175 if ((event->state & XCB_MOD_MASK_SHIFT))
179 if ((event->state & XCB_MOD_MASK_SHIFT))
185 /* FIXME: handle all of these? */
186 printf("is_keypad_key = %d\n", xcb_is_keypad_key(sym));
187 printf("is_private_keypad_key = %d\n", xcb_is_private_keypad_key(sym));
188 printf("xcb_is_cursor_key = %d\n", xcb_is_cursor_key(sym));
189 printf("xcb_is_pf_key = %d\n", xcb_is_pf_key(sym));
190 printf("xcb_is_function_key = %d\n", xcb_is_function_key(sym));
191 printf("xcb_is_misc_function_key = %d\n", xcb_is_misc_function_key(sym));
192 printf("xcb_is_modifier_key = %d\n", xcb_is_modifier_key(sym));
195 if (xcb_is_modifier_key(sym) || xcb_is_cursor_key(sym))
198 //printf("sym = %c (%d)\n", sym, sym);
200 /* convert the keysym to UCS */
201 uint16_t ucs = keysym2ucs(sym);
202 if ((int16_t)ucs == -1) {
203 fprintf(stderr, "Keysym could not be converted to UCS, skipping\n");
207 /* store the UCS in a string to convert it */
208 uint8_t inp[3] = {(ucs & 0xFF00) >> 8, (ucs & 0xFF), 0};
210 /* store it in the password array as UTF-8 */
211 input_position += convert_ucs_to_utf8((char*)inp, password + input_position);
212 password[input_position] = '\0';
213 //printf("current password = %s\n", password);
217 * A visibility notify event will be received when the visibility (= can the
218 * user view the complete window) changes, so for example when a popup overlays
219 * some area of the i3lock window.
221 * In this case, we raise our window on top so that the popup (or whatever is
222 * hiding us) gets hidden.
225 static void handle_visibility_notify(xcb_visibility_notify_event_t *event) {
226 if (event->state != XCB_VISIBILITY_UNOBSCURED) {
227 uint32_t values[] = { XCB_STACK_MODE_ABOVE };
228 xcb_configure_window(conn, event->window, XCB_CONFIG_WINDOW_STACK_MODE, values);
234 * Called when the keyboard mapping changes. We update our symbols and re-grab
238 static void handle_mapping_notify(xcb_mapping_notify_event_t *event) {
239 xcb_refresh_keyboard_mapping(symbols, event);
241 xcb_ungrab_pointer(conn, XCB_CURRENT_TIME);
242 xcb_ungrab_keyboard(conn, XCB_CURRENT_TIME);
243 grab_pointer_and_keyboard(conn, scr, cursor);
245 modeswitchmask = get_mod_mask(conn, symbols, XK_Mode_switch);
246 numlockmask = get_mod_mask(conn, symbols, XK_Num_Lock);
252 * Called when the properties on the root window change, e.g. when the screen
253 * resolution changes. If so we update the window to cover the whole screen
254 * and also redraw the image, if any.
257 void handle_screen_resize(xcb_visualtype_t *vistype, xcb_window_t win, uint32_t* last_resolution, char* color) {
258 xcb_get_geometry_cookie_t geomc;
259 xcb_get_geometry_reply_t *geom;
260 geomc = xcb_get_geometry(conn, scr->root);
261 if ((geom = xcb_get_geometry_reply(conn, geomc, 0)) == NULL) {
265 if (last_resolution[0] == geom->width && last_resolution[1] == geom->height)
268 last_resolution[0] = geom->width;
269 last_resolution[1] = geom->height;
273 xcb_pixmap_t bg_pixmap = draw_image(vistype, last_resolution, color);
274 xcb_change_window_attributes(conn, win, XCB_CW_BACK_PIXMAP, (uint32_t[1]){ bg_pixmap });
278 uint32_t mask = XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT;
279 xcb_configure_window(conn, win, mask, last_resolution);
284 * Callback function for PAM. We only react on password request callbacks.
287 static int conv_callback(int num_msg, const struct pam_message **msg,
288 struct pam_response **resp, void *appdata_ptr)
293 /* PAM expects an array of responses, one for each message */
294 if ((*resp = calloc(num_msg, sizeof(struct pam_message))) == NULL) {
299 for (int c = 0; c < num_msg; c++) {
300 if (msg[c]->msg_style != PAM_PROMPT_ECHO_OFF &&
301 msg[c]->msg_style != PAM_PROMPT_ECHO_ON)
304 /* return code is currently not used but should be set to zero */
305 resp[c]->resp_retcode = 0;
306 if ((resp[c]->resp = strdup(password)) == NULL) {
315 int main(int argc, char *argv[]) {
316 bool dont_fork = false;
318 char color[7] = "ffffff";
321 char *image_path = NULL;
324 struct pam_conv conv = {conv_callback, NULL};
326 xcb_visualtype_t *vistype;
327 xcb_generic_event_t *event;
329 int curs_choice = CURS_NONE;
332 struct option longopts[] = {
333 {"version", no_argument, NULL, 'v'},
334 {"nofork", no_argument, NULL, 'n'},
335 {"beep", no_argument, NULL, 'b'},
336 {"dpms", no_argument, NULL, 'd'},
337 {"color", required_argument, NULL, 'c'},
338 {"pointer", required_argument, NULL , 'p'},
340 {"image", required_argument, NULL, 'i'},
341 {"tiling", no_argument, NULL, 't'},
343 {NULL, no_argument, NULL, 0}
346 if ((username = getenv("USER")) == NULL)
347 errx(1, "USER environment variable not set, please set it.\n");
349 while ((o = getopt_long(argc, argv, "vnbdc:p:"
353 , longopts, &optind)) != -1) {
356 errx(EXIT_SUCCESS, "version " VERSION " © 2010-2011 Michael Stapelberg\n");
369 /* Skip # if present */
373 if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", color) != 1)
374 errx(1, "color is invalid, color must be given in 6-byte format: rrggbb\n");
380 image_path = strdup(optarg);
387 if (!strcmp(optarg, "win")) {
388 curs_choice = CURS_WIN;
389 } else if (!strcmp(optarg, "default")) {
390 curs_choice = CURS_DEFAULT;
392 errx(1, "i3lock: Invalid pointer type given. Expected one of \"win\" or \"default\".\n");
396 errx(1, "i3lock: Unknown option. Syntax: i3lock [-v] [-n] [-b] [-d] [-c color] [-p win|default]"
398 " [-i image.png] [-t]"
400 " (compiled with NOLIBCAIRO)"
407 ret = pam_start("i3lock", username, &conv, &pam_handle);
408 if (ret != PAM_SUCCESS)
409 errx(EXIT_FAILURE, "PAM: %s\n", pam_strerror(pam_handle, ret));
411 /* Initialize connection to X11 */
412 if ((conn = xcb_connect(NULL, &screen)) == NULL ||
413 xcb_connection_has_error(conn))
414 errx(EXIT_FAILURE, "Could not connect to X11, maybe you need to set DISPLAY?");
417 /* In the parent process, we exit */
422 /* if DPMS is enabled, check if the X server really supports it */
424 xcb_dpms_capable_cookie_t dpmsc = xcb_dpms_capable(conn);
425 xcb_dpms_capable_reply_t *dpmsr;
426 if ((dpmsr = xcb_dpms_capable_reply(conn, dpmsc, NULL)) && !dpmsr->capable) {
427 fprintf(stderr, "Disabling DPMS, X server not DPMS capable\n");
432 scr = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
433 vistype = get_root_visual_type(scr);
435 uint32_t last_resolution[2] = {scr->width_in_pixels, scr->height_in_pixels};
441 /* Create a pixmap to render on, fill it with the background color */
442 img = cairo_image_surface_create_from_png(image_path);
446 /* Pixmap on which the image is rendered to (if any) */
447 xcb_pixmap_t bg_pixmap = draw_image(vistype, last_resolution, color);
449 /* open the fullscreen window, already with the correct pixmap in place */
450 win = open_fullscreen_window(conn, scr, color, bg_pixmap);
452 cursor = create_cursor(conn, scr, win, curs_choice);
454 grab_pointer_and_keyboard(conn, scr, cursor);
456 symbols = xcb_key_symbols_alloc(conn);
457 modeswitchmask = get_mod_mask(conn, symbols, XK_Mode_switch);
458 numlockmask = get_mod_mask(conn, symbols, XK_Num_Lock);
461 dpms_turn_off_screen(conn);
463 while ((event = xcb_wait_for_event(conn))) {
464 if (event->response_type == 0)
465 errx(1, "XCB: Invalid event received");
467 /* Strip off the highest bit (set if the event is generated) */
468 int type = (event->response_type & 0x7F);
470 if (type == XCB_KEY_PRESS) {
471 handle_key_press((xcb_key_press_event_t*)event);
475 if (type == XCB_KEY_RELEASE) {
476 handle_key_release((xcb_key_release_event_t*)event);
478 /* If this was the backspace or escape key we are back at an
479 * empty input, so turn off the screen if DPMS is enabled */
480 if (dpms && input_position == 0)
481 dpms_turn_off_screen(conn);
486 if (type == XCB_VISIBILITY_NOTIFY) {
487 handle_visibility_notify((xcb_visibility_notify_event_t*)event);
491 if (type == XCB_MAPPING_NOTIFY) {
492 handle_mapping_notify((xcb_mapping_notify_event_t*)event);
496 if (type == XCB_CONFIGURE_NOTIFY) {
497 handle_screen_resize(vistype, win, last_resolution, color);
501 printf("WARNING: unhandled event of type %d\n", type);