2 * vim:ts=4:sw=4:expandtab
4 * © 2010 Michael Stapelberg
6 * See LICENSE for licensing information
17 #include <xcb/xcb_keysyms.h>
21 #include <security/pam_appl.h>
22 /* FIXME: can we get rid of this header? */
23 #include <X11/keysym.h>
27 #include "keysym2ucs.h"
28 #include "ucs2_to_utf8.h"
32 static xcb_connection_t *conn;
33 static xcb_key_symbols_t *symbols;
34 static cairo_t *ctx = NULL;
35 static pam_handle_t *pam_handle;
36 static int input_position = 0;
37 /* holds the password you enter (in UTF-8) */
38 static char password[512];
39 static bool modeswitch_active = false;
40 static int modeswitchmask;
41 static int numlockmask;
42 static bool beep = false;
44 static void input_done() {
45 if (input_position == 0)
48 /* TODO: change cursor during authentication? */
49 if (pam_authenticate(pam_handle, 0) == PAM_SUCCESS) {
50 printf("successfully authenticated\n");
54 /* beep on authentication failure, if enabled */
62 * Called when we should draw the image (if any).
65 static void handle_expose_event() {
74 * Called when the user releases a key. We need to leave the Mode_switch
75 * state when the user releases the Mode_switch key.
78 static void handle_key_release(xcb_key_release_event_t *event) {
79 //printf("releasing %d, state raw = %d\n", event->detail, event->state);
82 event->state &= ~numlockmask;
84 xcb_keysym_t sym = xcb_key_press_lookup_keysym(symbols, event, event->state);
85 if (sym == XK_Mode_switch) {
86 //printf("Mode switch disabled\n");
87 modeswitch_active = false;
92 * Handle key presses. Fixes state, then looks up the key symbol for the
93 * given keycode, then looks up the key symbol (as UCS-2), converts it to
94 * UTF-8 and stores it in the password array.
97 static void handle_key_press(xcb_key_press_event_t *event) {
98 //printf("keypress %d, state raw = %d\n", event->detail, event->state);
101 if (modeswitch_active)
102 event->state |= modeswitchmask;
104 /* Apparantly, after activating numlock once, the numlock modifier
105 * stays turned on (use xev(1) to verify). So, to resolve useful
106 * keysyms, we remove the numlock flag from the event state */
107 event->state &= ~numlockmask;
109 if ((input_position + 8) >= sizeof(password))
112 xcb_keysym_t sym = xcb_key_press_lookup_keysym(symbols, event, event->state);
115 //printf("Mode switch enabled\n");
116 modeswitch_active = true;
123 password[input_position] = '\0';
127 if (input_position == 0)
130 /* decrement input_position to point to the previous glyph */
131 u8_dec(password, &input_position);
132 password[input_position] = '\0';
133 printf("new input position = %d, new password = %s\n", input_position, password);
138 /* FIXME: handle all of these? */
139 printf("is_keypad_key = %d\n", xcb_is_keypad_key(sym));
140 printf("is_private_keypad_key = %d\n", xcb_is_private_keypad_key(sym));
141 printf("xcb_is_cursor_key = %d\n", xcb_is_cursor_key(sym));
142 printf("xcb_is_pf_key = %d\n", xcb_is_pf_key(sym));
143 printf("xcb_is_function_key = %d\n", xcb_is_function_key(sym));
144 printf("xcb_is_misc_function_key = %d\n", xcb_is_misc_function_key(sym));
145 printf("xcb_is_modifier_key = %d\n", xcb_is_modifier_key(sym));
148 if (xcb_is_modifier_key(sym) || xcb_is_cursor_key(sym))
151 //printf("sym = %c (%d)\n", sym, sym);
153 /* convert the keysym to UCS */
154 uint16_t ucs = keysym2ucs(sym);
155 if ((int16_t)ucs == -1) {
156 fprintf(stderr, "Keysym could not be converted to UCS, skipping\n");
160 /* store the UCS in a string to convert it */
161 uint8_t inp[3] = {(ucs & 0xFF00) >> 8, (ucs & 0xFF), 0};
163 /* store it in the password array as UTF-8 */
164 input_position += convert_ucs_to_utf8((char*)inp, password + input_position);
165 password[input_position] = '\0';
166 //printf("current password = %s\n", password);
170 * A visibility notify event will be received when the visibility (= can the
171 * user view the complete window) changes, so for example when a popup overlays
172 * some area of the i3lock window.
174 * In this case, we raise our window on top so that the popup (or whatever is
175 * hiding us) gets hidden.
178 void handle_visibility_notify(xcb_visibility_notify_event_t *event) {
179 printf("visibility notify (window 0x%08x, state %d)\n", event->window, event->state);
180 if (event->state != XCB_VISIBILITY_UNOBSCURED) {
181 printf("window is obscured (not fully visible), raising\n");
182 uint32_t values[] = { XCB_STACK_MODE_ABOVE };
183 xcb_configure_window(conn, event->window, XCB_CONFIG_WINDOW_STACK_MODE, values);
189 * Callback function for PAM. We only react on password request callbacks.
192 static int conv_callback(int num_msg, const struct pam_message **msg,
193 struct pam_response **resp, void *appdata_ptr)
198 /* PAM expects an array of responses, one for each message */
199 if ((*resp = calloc(num_msg, sizeof(struct pam_message))) == NULL) {
204 for (int c = 0; c < num_msg; c++) {
205 if (msg[c]->msg_style != PAM_PROMPT_ECHO_OFF &&
206 msg[c]->msg_style != PAM_PROMPT_ECHO_ON)
209 /* return code is currently not used but should be set to zero */
210 resp[c]->resp_retcode = 0;
211 if ((resp[c]->resp = strdup(password)) == NULL) {
220 int main(int argc, char *argv[]) {
221 bool dont_fork = false;
223 char color[7] = "ffffff";
225 char *image_path = NULL;
227 struct pam_conv conv = {conv_callback, NULL};
229 cairo_surface_t *img = NULL;
230 xcb_visualtype_t *vistype;
231 xcb_generic_event_t *event;
235 int curs_choice = CURS_NONE;
238 struct option longopts[] = {
239 {"version", no_argument, NULL, 'v'},
240 {"nofork", no_argument, NULL, 'n'},
241 {"beep", no_argument, NULL, 'b'},
242 {"dpms", no_argument, NULL, 'd'},
243 {"image", required_argument, NULL, 'i'},
244 {"color", required_argument, NULL, 'c'},
245 {"tiling", no_argument, NULL, 't'},
246 {"pointer", required_argument, NULL , 'p'},
247 {NULL, no_argument, NULL, 0}
250 if ((username = getenv("USER")) == NULL)
251 errx(1, "USER environment variable not set, please set it.\n");
253 while ((o = getopt_long(argc, argv, "vnbdi:c:tp:", longopts, &optind)) != -1) {
256 errx(EXIT_SUCCESS, "i3lock © 2010 Michael Stapelberg\n");
267 image_path = strdup(optarg);
272 /* Skip # if present */
276 if (strlen(arg) != 6 || sscanf(arg, "%06[0-9a-fA-F]", color) != 1)
277 errx(1, "color is invalid, color must be given in 6-byte format: rrggbb\n");
282 /* TODO: tile image */
285 if (!strcmp(optarg, "win")) {
286 curs_choice = CURS_WIN;
288 if (!strcmp(optarg, "default")) {
289 curs_choice = CURS_DEFAULT;
293 errx(1, "i3lock: Unknown option. Syntax: i3lock [-v] [-n] [-b] [-d] [-i image.png] [-c color] [-t] [-p win|default]\n");
298 ret = pam_start("i3lock", username, &conv, &pam_handle);
299 if (ret != PAM_SUCCESS)
300 errx(EXIT_FAILURE, "PAM: %s\n", pam_strerror(pam_handle, ret));
302 /* Initialize connection to X11 */
303 if ((conn = xcb_connect(NULL, &screen)) == NULL)
304 err(EXIT_FAILURE, "xcb_connect()");
307 /* In the parent process, we exit */
312 /* if DPMS is enabled, check if the X server really supports it */
314 xcb_dpms_capable_cookie_t dpmsc = xcb_dpms_capable(conn);
315 xcb_dpms_capable_reply_t *dpmsr;
316 if ((dpmsr = xcb_dpms_capable_reply(conn, dpmsc, NULL)) && !dpmsr->capable) {
317 fprintf(stderr, "Disabling DPMS, X server not DPMS capable\n");
322 scr = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
323 vistype = get_root_visual_type(scr);
325 /* open the fullscreen window and flush immediately afterwards so that X11
326 * can generate an expose event while we load the PNG file (so that we are
327 * ready to handle the expose event immediately afterwards) */
328 win = open_fullscreen_window(conn, scr, color);
330 cursor = create_cursor(conn, scr, win, curs_choice);
332 grab_pointer_and_keyboard(conn, scr, cursor);
335 img = cairo_image_surface_create_from_png(image_path);
337 symbols = xcb_key_symbols_alloc(conn);
338 modeswitchmask = get_mod_mask(conn, symbols, XK_Mode_switch);
339 numlockmask = get_mod_mask(conn, symbols, XK_Num_Lock);
343 /* Initialize cairo */
344 cairo_surface_t *output;
345 output = cairo_xcb_surface_create(conn, win, vistype,
346 scr->width_in_pixels, scr->height_in_pixels);
347 /* TODO: tiling of the image */
348 ctx = cairo_create(output);
349 cairo_set_source_surface(ctx, img, 0, 0);
351 handle_expose_event();
355 dpms_turn_off_screen(conn);
357 while ((event = xcb_wait_for_event(conn))) {
358 if (event->response_type == 0)
359 errx(1, "XCB: Invalid event received");
361 /* Strip off the highest bit (set if the event is generated) */
362 int type = (event->response_type & 0x7F);
364 if (type == XCB_EXPOSE) {
365 handle_expose_event();
369 if (type == XCB_KEY_PRESS) {
370 handle_key_press((xcb_key_press_event_t*)event);
374 if (type == XCB_KEY_RELEASE) {
375 handle_key_release((xcb_key_release_event_t*)event);
377 /* If this was the backspace or escape key we are back at an
378 * empty input, so turn off the screen if DPMS is enabled */
379 if (dpms && input_position == 0)
380 dpms_turn_off_screen(conn);
385 if (type == XCB_VISIBILITY_NOTIFY) {
386 handle_visibility_notify((xcb_visibility_notify_event_t*)event);
390 printf("WARNING: unhandled event of type %d\n", type);