2 * vim:ts=4:sw=4:expandtab
4 * © 2010 Michael Stapelberg
6 * See LICENSE for licensing information
17 #include <xcb/xcb_keysyms.h>
20 #include <cairo/cairo-xcb.h>
22 #include <security/pam_appl.h>
23 /* FIXME: can we get rid of this header? */
24 #include <X11/keysym.h>
28 #include "keysym2ucs.h"
29 #include "ucs2_to_utf8.h"
33 static xcb_connection_t *conn;
34 static xcb_key_symbols_t *symbols;
35 static cairo_surface_t *img = NULL;
36 static cairo_t *ctx = NULL;
37 static xcb_screen_t *scr;
38 static pam_handle_t *pam_handle;
39 static int input_position = 0;
40 /* holds the password you enter (in UTF-8) */
41 static char password[512];
42 static bool modeswitch_active = false;
43 static int modeswitchmask;
44 static int numlockmask;
45 static bool beep = false;
46 static bool tile = false;
48 static void input_done() {
49 if (input_position == 0)
52 /* TODO: change cursor during authentication? */
53 if (pam_authenticate(pam_handle, 0) == PAM_SUCCESS) {
54 printf("successfully authenticated\n");
58 /* beep on authentication failure, if enabled */
66 * Called when we should draw the image (if any).
69 static void handle_expose_event() {
74 /* create a pattern and fill a rectangle as big as the screen */
75 cairo_pattern_t *pattern;
76 pattern = cairo_pattern_create_for_surface(img);
77 cairo_set_source(ctx, pattern);
78 cairo_pattern_set_extend(pattern, CAIRO_EXTEND_REPEAT);
79 cairo_rectangle(ctx, 0, 0, scr->width_in_pixels, scr->height_in_pixels);
82 /* otherwise, just paint the image */
90 * Called when the user releases a key. We need to leave the Mode_switch
91 * state when the user releases the Mode_switch key.
94 static void handle_key_release(xcb_key_release_event_t *event) {
95 //printf("releasing %d, state raw = %d\n", event->detail, event->state);
98 event->state &= ~numlockmask;
100 xcb_keysym_t sym = xcb_key_press_lookup_keysym(symbols, event, event->state);
101 if (sym == XK_Mode_switch) {
102 //printf("Mode switch disabled\n");
103 modeswitch_active = false;
108 * Handle key presses. Fixes state, then looks up the key symbol for the
109 * given keycode, then looks up the key symbol (as UCS-2), converts it to
110 * UTF-8 and stores it in the password array.
113 static void handle_key_press(xcb_key_press_event_t *event) {
114 //printf("keypress %d, state raw = %d\n", event->detail, event->state);
117 if (modeswitch_active)
118 event->state |= modeswitchmask;
120 /* Apparantly, after activating numlock once, the numlock modifier
121 * stays turned on (use xev(1) to verify). So, to resolve useful
122 * keysyms, we remove the numlock flag from the event state */
123 event->state &= ~numlockmask;
125 if ((input_position + 8) >= sizeof(password))
128 xcb_keysym_t sym = xcb_key_press_lookup_keysym(symbols, event, event->state);
131 //printf("Mode switch enabled\n");
132 modeswitch_active = true;
139 password[input_position] = '\0';
143 if (input_position == 0)
146 /* decrement input_position to point to the previous glyph */
147 u8_dec(password, &input_position);
148 password[input_position] = '\0';
149 printf("new input position = %d, new password = %s\n", input_position, password);
154 /* FIXME: handle all of these? */
155 printf("is_keypad_key = %d\n", xcb_is_keypad_key(sym));
156 printf("is_private_keypad_key = %d\n", xcb_is_private_keypad_key(sym));
157 printf("xcb_is_cursor_key = %d\n", xcb_is_cursor_key(sym));
158 printf("xcb_is_pf_key = %d\n", xcb_is_pf_key(sym));
159 printf("xcb_is_function_key = %d\n", xcb_is_function_key(sym));
160 printf("xcb_is_misc_function_key = %d\n", xcb_is_misc_function_key(sym));
161 printf("xcb_is_modifier_key = %d\n", xcb_is_modifier_key(sym));
164 if (xcb_is_modifier_key(sym) || xcb_is_cursor_key(sym))
167 //printf("sym = %c (%d)\n", sym, sym);
169 /* convert the keysym to UCS */
170 uint16_t ucs = keysym2ucs(sym);
171 if ((int16_t)ucs == -1) {
172 fprintf(stderr, "Keysym could not be converted to UCS, skipping\n");
176 /* store the UCS in a string to convert it */
177 uint8_t inp[3] = {(ucs & 0xFF00) >> 8, (ucs & 0xFF), 0};
179 /* store it in the password array as UTF-8 */
180 input_position += convert_ucs_to_utf8((char*)inp, password + input_position);
181 password[input_position] = '\0';
182 //printf("current password = %s\n", password);
186 * A visibility notify event will be received when the visibility (= can the
187 * user view the complete window) changes, so for example when a popup overlays
188 * some area of the i3lock window.
190 * In this case, we raise our window on top so that the popup (or whatever is
191 * hiding us) gets hidden.
194 void handle_visibility_notify(xcb_visibility_notify_event_t *event) {
195 printf("visibility notify (window 0x%08x, state %d)\n", event->window, event->state);
196 if (event->state != XCB_VISIBILITY_UNOBSCURED) {
197 printf("window is obscured (not fully visible), raising\n");
198 uint32_t values[] = { XCB_STACK_MODE_ABOVE };
199 xcb_configure_window(conn, event->window, XCB_CONFIG_WINDOW_STACK_MODE, values);
205 * Callback function for PAM. We only react on password request callbacks.
208 static int conv_callback(int num_msg, const struct pam_message **msg,
209 struct pam_response **resp, void *appdata_ptr)
214 /* PAM expects an array of responses, one for each message */
215 if ((*resp = calloc(num_msg, sizeof(struct pam_message))) == NULL) {
220 for (int c = 0; c < num_msg; c++) {
221 if (msg[c]->msg_style != PAM_PROMPT_ECHO_OFF &&
222 msg[c]->msg_style != PAM_PROMPT_ECHO_ON)
225 /* return code is currently not used but should be set to zero */
226 resp[c]->resp_retcode = 0;
227 if ((resp[c]->resp = strdup(password)) == NULL) {
236 int main(int argc, char *argv[]) {
237 bool dont_fork = false;
239 char color[7] = "ffffff";
241 char *image_path = NULL;
243 struct pam_conv conv = {conv_callback, NULL};
245 xcb_visualtype_t *vistype;
246 xcb_generic_event_t *event;
249 int curs_choice = CURS_NONE;
252 struct option longopts[] = {
253 {"version", no_argument, NULL, 'v'},
254 {"nofork", no_argument, NULL, 'n'},
255 {"beep", no_argument, NULL, 'b'},
256 {"dpms", no_argument, NULL, 'd'},
257 {"image", required_argument, NULL, 'i'},
258 {"color", required_argument, NULL, 'c'},
259 {"tiling", no_argument, NULL, 't'},
260 {"pointer", required_argument, NULL , 'p'},
261 {NULL, no_argument, NULL, 0}
264 if ((username = getenv("USER")) == NULL)
265 errx(1, "USER environment variable not set, please set it.\n");
267 while ((o = getopt_long(argc, argv, "vnbdi:c:tp:", longopts, &optind)) != -1) {
270 errx(EXIT_SUCCESS, "version " VERSION " © 2010 Michael Stapelberg\n");
281 image_path = strdup(optarg);
286 /* Skip # if present */
290 if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", color) != 1)
291 errx(1, "color is invalid, color must be given in 6-byte format: rrggbb\n");
299 if (!strcmp(optarg, "win")) {
300 curs_choice = CURS_WIN;
302 if (!strcmp(optarg, "default")) {
303 curs_choice = CURS_DEFAULT;
307 errx(1, "i3lock: Unknown option. Syntax: i3lock [-v] [-n] [-b] [-d] [-i image.png] [-c color] [-t] [-p win|default]\n");
312 ret = pam_start("i3lock", username, &conv, &pam_handle);
313 if (ret != PAM_SUCCESS)
314 errx(EXIT_FAILURE, "PAM: %s\n", pam_strerror(pam_handle, ret));
316 /* Initialize connection to X11 */
317 if ((conn = xcb_connect(NULL, &screen)) == NULL)
318 err(EXIT_FAILURE, "xcb_connect()");
321 /* In the parent process, we exit */
326 /* if DPMS is enabled, check if the X server really supports it */
328 xcb_dpms_capable_cookie_t dpmsc = xcb_dpms_capable(conn);
329 xcb_dpms_capable_reply_t *dpmsr;
330 if ((dpmsr = xcb_dpms_capable_reply(conn, dpmsc, NULL)) && !dpmsr->capable) {
331 fprintf(stderr, "Disabling DPMS, X server not DPMS capable\n");
336 scr = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
337 vistype = get_root_visual_type(scr);
339 /* open the fullscreen window and flush immediately afterwards so that X11
340 * can generate an expose event while we load the PNG file (so that we are
341 * ready to handle the expose event immediately afterwards) */
342 win = open_fullscreen_window(conn, scr, color);
344 cursor = create_cursor(conn, scr, win, curs_choice);
346 grab_pointer_and_keyboard(conn, scr, cursor);
349 img = cairo_image_surface_create_from_png(image_path);
351 symbols = xcb_key_symbols_alloc(conn);
352 modeswitchmask = get_mod_mask(conn, symbols, XK_Mode_switch);
353 numlockmask = get_mod_mask(conn, symbols, XK_Num_Lock);
357 /* Initialize cairo */
358 cairo_surface_t *output;
359 output = cairo_xcb_surface_create(conn, win, vistype,
360 scr->width_in_pixels, scr->height_in_pixels);
361 ctx = cairo_create(output);
363 cairo_set_source_surface(ctx, img, 0, 0);
365 handle_expose_event();
369 dpms_turn_off_screen(conn);
371 while ((event = xcb_wait_for_event(conn))) {
372 if (event->response_type == 0)
373 errx(1, "XCB: Invalid event received");
375 /* Strip off the highest bit (set if the event is generated) */
376 int type = (event->response_type & 0x7F);
378 if (type == XCB_EXPOSE) {
379 handle_expose_event();
383 if (type == XCB_KEY_PRESS) {
384 handle_key_press((xcb_key_press_event_t*)event);
388 if (type == XCB_KEY_RELEASE) {
389 handle_key_release((xcb_key_release_event_t*)event);
391 /* If this was the backspace or escape key we are back at an
392 * empty input, so turn off the screen if DPMS is enabled */
393 if (dpms && input_position == 0)
394 dpms_turn_off_screen(conn);
399 if (type == XCB_VISIBILITY_NOTIFY) {
400 handle_visibility_notify((xcb_visibility_notify_event_t*)event);
404 printf("WARNING: unhandled event of type %d\n", type);