2 #include "e_mod_main_wl.h"
3 #include <device/power.h>
4 #include <device/callback.h>
5 #include <device/display.h>
7 #define KRT_IPD_INPUT_CONFIG 444
9 E_KeyrouterPtr krt = NULL;
10 E_API E_Module_Api e_modapi = { E_MODULE_API_VERSION, "Keyrouter Module of Window Manager" };
12 static E_Keyrouter_Config_Data *_e_keyrouter_init(E_Module *m);
13 static void _e_keyrouter_init_handlers(void);
14 static void _e_keyrouter_deinit_handlers(void);
16 static Eina_Bool _e_keyrouter_query_tizen_key_table(void);
17 static int _e_keyrouter_wl_array_length(const struct wl_array *array);
19 static Eina_Bool _e_keyrouter_client_cb_stack(void *data, int type, void *event);
20 static Eina_Bool _e_keyrouter_client_cb_remove(void *data, int type, void *event);
21 static void _e_keyrouter_wl_client_cb_destroy(struct wl_listener *l, void *data);
22 static void _e_keyrouter_wl_surface_cb_destroy(struct wl_listener *l, void *data);
24 static int _e_keyrouter_keygrab_set(struct wl_client *client, struct wl_resource *surface, uint32_t key, uint32_t mode);
25 static int _e_keyrouter_keygrab_unset(struct wl_client *client, struct wl_resource *surface, uint32_t key);
26 static Eina_Bool _e_keyrouter_cb_idler(void *data);
27 static void _e_keyrouter_cb_power_change(device_callback_e type, void* value, void* user_data);
29 static void _e_keyrouter_util_cynara_log(const char *func_name, int err);
30 static Eina_Bool _e_keyrouter_util_do_privilege_check(struct wl_client *client, uint32_t mode, uint32_t keycode);
32 #define E_KEYROUTER_CYNARA_ERROR_CHECK_GOTO(func_name, ret, label) \
35 if (EINA_UNLIKELY(CYNARA_API_SUCCESS != ret)) \
37 _e_keyrouter_util_cynara_log(func_name, ret); \
44 int _keyrouter_log_dom = -1;
47 _e_keyrouter_keygrab_set(struct wl_client *client, struct wl_resource *surface, uint32_t key, uint32_t mode)
52 if (EINA_FALSE == _e_keyrouter_util_do_privilege_check(client, mode, key))
54 KLINF("No permission for %d grab mode ! (key=%d)", mode, key);
55 return TIZEN_KEYROUTER_ERROR_NO_PERMISSION;
61 /* Regarding topmost mode, a client must request to grab a key with a valid surface. */
62 if (mode == TIZEN_KEYROUTER_MODE_TOPMOST ||
63 mode == TIZEN_KEYROUTER_MODE_REGISTERED)
65 KLWRN("Invalid surface for %d grab mode ! (key=%d)", mode, key);
67 return TIZEN_KEYROUTER_ERROR_INVALID_SURFACE;
71 /* Check the given key range */
72 if (krt->max_tizen_hwkeys < key)
74 KLWRN("Invalid range of key ! (keycode:%d)", key);
75 return TIZEN_KEYROUTER_ERROR_INVALID_KEY;
78 /* Check whether the key can be grabbed or not !
79 * Only key listed in Tizen key layout file can be grabbed. */
80 if (0 == krt->HardKeys[key].keycode)
82 KLWRN("Invalid key ! Disabled to grab ! (keycode:%d)", key);
83 return TIZEN_KEYROUTER_ERROR_INVALID_KEY;
86 /* Check whether the mode is valid or not */
87 if (TIZEN_KEYROUTER_MODE_REGISTERED < mode)
89 KLWRN("Invalid range of mode ! (mode:%d)", mode);
90 return TIZEN_KEYROUTER_ERROR_INVALID_MODE;
93 /* Check whether the request key can be grabbed or not */
94 res = e_keyrouter_set_keygrab_in_list(surface, client, key, mode);
100 _e_keyrouter_keycancel_send(struct wl_client *client, struct wl_resource *surface, unsigned int key)
103 struct wl_resource *resource = NULL;
104 struct wl_client *wc = NULL;
105 E_Keyrouter_Key_List_NodePtr data;
107 if (surface) wc = wl_resource_get_client(surface);
110 EINA_SAFETY_ON_NULL_RETURN(wc);
112 EINA_LIST_FOREACH(krt->HardKeys[key].press_ptr, l, data)
116 if (surface == data->surface)
118 EINA_LIST_FOREACH(krt->resources, l, resource)
120 if (wl_resource_get_client(resource) != wc) continue;
122 tizen_keyrouter_send_key_cancel(resource, key-8);
126 else if (client == data->wc)
128 EINA_LIST_FOREACH(krt->resources, l, resource)
130 if (wl_resource_get_client(resource) != wc) continue;
132 tizen_keyrouter_send_key_cancel(resource, key-8);
139 _e_keyrouter_keygrab_unset(struct wl_client *client, struct wl_resource *surface, uint32_t key)
141 /* Ungrab top position grabs first. This grab mode do not need privilege */
143 e_keyrouter_find_and_remove_client_from_list(NULL, client, key, TIZEN_KEYROUTER_MODE_TOPMOST);
145 e_keyrouter_find_and_remove_client_from_list(surface, client, key, TIZEN_KEYROUTER_MODE_TOPMOST);
148 if (EINA_FALSE == _e_keyrouter_util_do_privilege_check(client, TIZEN_KEYROUTER_MODE_NONE, key))
157 e_keyrouter_find_and_remove_client_from_list(NULL, client, key, TIZEN_KEYROUTER_MODE_EXCLUSIVE);
159 /* OVERRIDABLE_EXCLUSIVE grab */
160 e_keyrouter_find_and_remove_client_from_list(NULL, client, key, TIZEN_KEYROUTER_MODE_OVERRIDABLE_EXCLUSIVE);
163 e_keyrouter_find_and_remove_client_from_list(NULL, client, key, TIZEN_KEYROUTER_MODE_SHARED);
166 e_keyrouter_find_and_remove_client_from_list(NULL, client, key, TIZEN_KEYROUTER_MODE_PRESSED);
171 e_keyrouter_find_and_remove_client_from_list(surface, client, key, TIZEN_KEYROUTER_MODE_EXCLUSIVE);
173 /* OVERRIDABLE_EXCLUSIVE grab */
174 e_keyrouter_find_and_remove_client_from_list(surface, client, key, TIZEN_KEYROUTER_MODE_OVERRIDABLE_EXCLUSIVE);
177 e_keyrouter_find_and_remove_client_from_list(surface, client, key, TIZEN_KEYROUTER_MODE_SHARED);
179 /* REGISTERED grab */
180 e_keyrouter_unset_keyregister(surface, client, key);
183 e_keyrouter_find_and_remove_client_from_list(surface, client, key, TIZEN_KEYROUTER_MODE_PRESSED);
187 _e_keyrouter_keycancel_send(client, surface, key);
189 return TIZEN_KEYROUTER_ERROR_NONE;
192 /* tizen_keyrouter_set_keygrab request handler */
194 _e_keyrouter_cb_keygrab_set(struct wl_client *client, struct wl_resource *resource, struct wl_resource *surface, uint32_t key, uint32_t mode)
198 TRACE_INPUT_BEGIN(_e_keyrouter_cb_keygrab_set);
200 res = _e_keyrouter_keygrab_set(client, surface, key, mode);
204 if (res == TIZEN_KEYROUTER_ERROR_NONE)
205 KLDBG("Success to %d key %s grab request (wl_client: %p, wl_surface: %p, pid: %d)", key, e_keyrouter_mode_to_string(mode),
206 client, surface, e_keyrouter_util_get_pid(client, surface));
208 KLINF("Failed to %d key %s grab request (wl_client: %p, wl_surface: %p, pid: %d): res: %d", key, e_keyrouter_mode_to_string(mode),
209 client, surface, e_keyrouter_util_get_pid(client, surface), res);
210 tizen_keyrouter_send_keygrab_notify(resource, surface, key, mode, res);
213 /* tizen_keyrouter unset_keygrab request handler */
215 _e_keyrouter_cb_keygrab_unset(struct wl_client *client, struct wl_resource *resource, struct wl_resource *surface, uint32_t key)
219 TRACE_INPUT_BEGIN(_e_keyrouter_cb_keygrab_unset);
221 res = _e_keyrouter_keygrab_unset(client, surface, key);
225 if (res == TIZEN_KEYROUTER_ERROR_NONE)
226 KLDBG("Success to %d key ungrab request (wl_client: %p, wl_surface: %p, pid: %d)", key, client, surface,
227 e_keyrouter_util_get_pid(client, surface));
229 KLINF("Failed to %d key ungrab request (wl_client: %p, wl_surface: %p, pid: %d): res: %d", key, client, surface,
230 e_keyrouter_util_get_pid(client, surface), res);
231 tizen_keyrouter_send_keygrab_notify(resource, surface, key, TIZEN_KEYROUTER_MODE_NONE, res);
234 /* tizen_keyrouter get_keygrab_status request handler */
236 _e_keyrouter_cb_get_keygrab_status(struct wl_client *client, struct wl_resource *resource, struct wl_resource *surface, uint32_t key)
242 int mode = TIZEN_KEYROUTER_MODE_NONE;
244 TRACE_INPUT_BEGIN(_e_keyrouter_cb_get_keygrab_status);
245 mode = e_keyrouter_find_key_in_list(surface, client, key);
248 tizen_keyrouter_send_keygrab_notify(resource, surface, key, mode, TIZEN_KEYROUTER_ERROR_NONE);
252 _e_keyrouter_cb_keygrab_set_list(struct wl_client *client, struct wl_resource *resource, struct wl_resource *surface, struct wl_array *grab_list)
254 E_Keyrouter_Grab_Request *grab_request = NULL;
255 int res = TIZEN_KEYROUTER_ERROR_NONE;
258 TRACE_INPUT_BEGIN(_e_keyrouter_cb_keygrab_set_list);
260 array_len = _e_keyrouter_wl_array_length(grab_list);
262 if (0 != (array_len % 3))
264 /* FIX ME: Which way is effectively to notify invalid pair to client */
265 KLWRN("Invalid keycode and grab mode pair. Check arguments in a list");
267 tizen_keyrouter_send_keygrab_notify_list(resource, surface, NULL);
271 wl_array_for_each(grab_request, grab_list)
273 res = _e_keyrouter_keygrab_set(client, surface, grab_request->key, grab_request->mode);
274 grab_request->err = res;
275 if (res == TIZEN_KEYROUTER_ERROR_NONE)
276 KLDBG("Success to %d key %s grab using list(wl_client: %p, wl_surface: %p, pid: %d)",
277 grab_request->key, e_keyrouter_mode_to_string(grab_request->mode),
278 client, surface, e_keyrouter_util_get_pid(client, surface));
280 KLINF("Failed to %d key %s grab using list(wl_client: %p, wl_surface: %p, pid: %d): res: %d",
281 grab_request->key, e_keyrouter_mode_to_string(grab_request->mode),
282 client, surface, e_keyrouter_util_get_pid(client, surface), grab_request->err);
287 tizen_keyrouter_send_keygrab_notify_list(resource, surface, grab_list);
291 _e_keyrouter_cb_keygrab_unset_list(struct wl_client *client, struct wl_resource *resource, struct wl_resource *surface, struct wl_array *ungrab_list)
293 E_Keyrouter_Ungrab_Request *ungrab_request = NULL;
294 int res = TIZEN_KEYROUTER_ERROR_NONE;
297 TRACE_INPUT_BEGIN(_e_keyrouter_cb_keygrab_unset_list);
299 array_len = _e_keyrouter_wl_array_length(ungrab_list);
301 if (0 != (array_len % 2))
303 /* FIX ME: Which way is effectively to notify invalid pair to client */
304 KLWRN("Invalid keycode and error pair. Check arguments in a list");
306 tizen_keyrouter_send_keygrab_notify_list(resource, surface, ungrab_list);
310 wl_array_for_each(ungrab_request, ungrab_list)
312 res = _e_keyrouter_keygrab_unset(client, surface, ungrab_request->key);
313 ungrab_request->err = res;
314 if (res == TIZEN_KEYROUTER_ERROR_NONE)
315 KLDBG("Success to ungrab using list: %d key (wl_client: %p, wl_surface: %p, pid: %d)",
316 ungrab_request->key, client, surface, e_keyrouter_util_get_pid(client, surface));
318 KLINF("Failed to ungrab using list: %d key (wl_client: %p, wl_surface: %p, pid: %d): res: %d",
319 ungrab_request->key, client, surface, e_keyrouter_util_get_pid(client, surface), ungrab_request->err);
323 tizen_keyrouter_send_keygrab_notify_list(resource, surface, ungrab_list);
327 _e_keyrouter_cb_get_keyregister_status(struct wl_client *client, struct wl_resource *resource, uint32_t key)
332 int delivery_mode = TIZEN_KEYROUTER_MODE_NONE;
333 Eina_Bool below_focus = EINA_FALSE;
334 E_Client *ec_top = NULL, *ec_focus = NULL;
335 struct wl_resource *surface = NULL, *surface_focus = NULL;
336 Eina_List* key_list = NULL, *l = NULL, *l_next = NULL;
337 E_Keyrouter_Key_List_NodePtr key_node_data = NULL;
339 int *key_data = NULL;
340 int deliver_invisible = 0;
342 // Check for exclusive & or_exclusive mode delivery
343 if (krt->HardKeys[key].excl_ptr)
345 delivery_mode = TIZEN_KEYROUTER_MODE_EXCLUSIVE;
348 if (krt->HardKeys[key].or_excl_ptr)
350 delivery_mode = TIZEN_KEYROUTER_MODE_OVERRIDABLE_EXCLUSIVE;
354 ec_top = e_client_top_get();
355 ec_focus = e_client_focused_get();
356 surface_focus = e_keyrouter_util_get_surface_from_eclient(ec_focus);
358 for (; ec_top != NULL; ec_top = e_client_below_get(ec_top))
360 surface = e_keyrouter_util_get_surface_from_eclient(ec_top);
364 // Not a valid surface.
368 if (ec_top->is_cursor) continue;
370 //Check Top-Most Delivery
371 if( below_focus == EINA_FALSE)
373 EINA_LIST_FOREACH_SAFE(krt->HardKeys[key].top_ptr, l, l_next, key_node_data)
375 if (!key_node_data) continue;
376 if ((ec_top->visible) && (ec_top == wl_resource_get_user_data(key_node_data->surface)))
378 delivery_mode = TIZEN_KEYROUTER_MODE_TOPMOST;
384 // Check if window stack reaches to focus window
385 if (ec_top == ec_focus)
387 below_focus = EINA_TRUE;
390 // Check for FORCE DELIVER to INVISIBLE WINDOW
391 if (deliver_invisible && IsInvisibleGetWindow(surface))
396 // Check for visible window first <Consider VISIBILITY>
397 // return if not visible
398 if (ec_top->visibility.obscured == E_VISIBILITY_FULLY_OBSCURED || ec_top->visibility.obscured == E_VISIBILITY_UNKNOWN)
403 // Set key Event Delivery for INVISIBLE WINDOW
404 if (IsInvisibleSetWindow(surface))
406 deliver_invisible = 1;
409 if (IsNoneKeyRegisterWindow(surface))
414 if (e_keyrouter_is_registered_window(surface))
416 // get the key list and deliver events if it has registered for that key
417 key_list = _e_keyrouter_registered_window_key_list(surface);
420 EINA_LIST_FOREACH(key_list, l, key_data)
429 delivery_mode = TIZEN_KEYROUTER_MODE_REGISTERED;
436 if (surface != surface_focus)
438 if (below_focus == EINA_FALSE)
443 // Deliver to below Non Registered window
444 else if (!e_keyrouter_is_registered_window(surface))
455 // Deliver to Focus Surface window from FOCUS MODE
456 if (!e_keyrouter_is_registered_window(surface))
468 tizen_keyrouter_send_keyregister_notify(resource, (int)delivery_mode);
472 _e_keyrouter_cb_set_input_config(struct wl_client *client, struct wl_resource *resource, struct wl_resource *surface, uint32_t config_mode, uint32_t value)
474 Eina_Bool res = EINA_TRUE;
476 if (surface == NULL && config_mode != TIZEN_KEYROUTER_CONFIG_MODE_PICTURE_OFF)
478 KLWRN("Error Surface is NULL");
480 goto send_input_config_notify;
485 case TIZEN_KEYROUTER_CONFIG_MODE_INVISIBLE_SET:
488 krt->invisible_set_window_list= eina_list_append(krt->invisible_set_window_list, surface);
492 krt->invisible_set_window_list= eina_list_remove(krt->invisible_set_window_list, surface);
496 case KRT_IPD_INPUT_CONFIG:
497 krt->playback_daemon_surface = surface;
498 KLINF("Registered playback daemon wl_surface: %p",surface);
501 case TIZEN_KEYROUTER_CONFIG_MODE_INVISIBLE_GET:
504 krt->invisible_get_window_list= eina_list_append(krt->invisible_get_window_list, surface);
508 krt->invisible_get_window_list= eina_list_remove(krt->invisible_get_window_list, surface);
512 case TIZEN_KEYROUTER_CONFIG_MODE_NUM_KEY_FOCUS:
516 case TIZEN_KEYROUTER_CONFIG_MODE_PICTURE_OFF:
517 res = e_keyrouter_prepend_to_keylist(surface, surface ? NULL : client, value, TIZEN_KEYROUTER_MODE_PICTURE_OFF, EINA_FALSE);
518 /* As surface/client destroy listener got added in e_keyrouter_prepend_to_keylist() function already */
523 KLWRN("Invalid mode: %d", config_mode);
525 goto send_input_config_notify;
530 KLDBG("Add a wl_surface(%p) to destory listener", surface);
531 e_keyrouter_add_surface_destroy_listener(surface);
534 send_input_config_notify:
535 if (res == TIZEN_KEYROUTER_ERROR_NONE)
537 KLDBG("Success to set input config: wl_surface (%p) for mode %d with value (%d)", surface, config_mode, value);
541 KLINF("Failed to set input config (res: %d): wl_surface (%p) for mode %d with value (%d)", res, surface, config_mode, value);
543 tizen_keyrouter_send_set_input_config_notify(resource, (int)res);
546 /* tizen_keyrouter check if given surface in register none key list */
548 IsNoneKeyRegisterWindow(struct wl_resource *surface)
550 struct wl_resource *surface_ldata = NULL;
551 Eina_List *l = NULL, *l_next = NULL;
553 EINA_LIST_FOREACH_SAFE (krt->registered_none_key_window_list, l, l_next, surface_ldata)
555 if (surface_ldata == surface)
557 KLDBG("Given wl_surface(%p) is in NoneKeyRegisterWindow", surface);
564 /* tizen_keyrouter check if given surface in register invisible set list */
566 IsInvisibleSetWindow(struct wl_resource *surface)
568 struct wl_resource *surface_ldata = NULL;
569 Eina_List *l = NULL, *l_next = NULL;
571 EINA_LIST_FOREACH_SAFE(krt->invisible_set_window_list, l, l_next, surface_ldata)
573 if (surface_ldata == surface)
581 /* tizen_keyrouter check if given surface in register invisible get list */
583 IsInvisibleGetWindow(struct wl_resource *surface)
585 struct wl_resource *surface_ldata = NULL;
586 Eina_List *l = NULL, *l_next = NULL;
588 EINA_LIST_FOREACH_SAFE(krt->invisible_get_window_list, l, l_next, surface_ldata)
590 if (surface_ldata == surface)
599 _e_keyrouter_cb_set_register_none_key(struct wl_client *client, struct wl_resource *resource, struct wl_resource *surface, uint32_t data)
603 // Register None key set/get
604 krt->register_none_key = data;
605 if (krt->register_none_key)
607 krt->registered_none_key_window_list = eina_list_append(krt->registered_none_key_window_list, surface);
610 e_keyrouter_add_surface_destroy_listener(surface);
611 /* TODO: if failed add surface_destory_listener, remove keygrabs */
616 krt->registered_none_key_window_list = eina_list_remove(krt->registered_none_key_window_list, surface);
619 KLDBG("Set Registered None Key called on wl_surface (%p) with data (%d)", surface, krt->register_none_key);
620 tizen_keyrouter_send_set_register_none_key_notify(resource, NULL, krt->register_none_key);
624 _e_keyrouter_cb_keygrab_get_list(struct wl_client *client, struct wl_resource *resource, struct wl_resource *surface)
626 E_Keyrouter_Key_List_NodePtr key_node_data = NULL;
627 struct wl_array grab_result_list = {0,};
628 E_Keyrouter_Grab_Request *grab_result = NULL;
629 E_Keyrouter_Registered_Window_Info *rwin_info = NULL;
630 Eina_List *l = NULL, *ll = NULL, *l_next = NULL;
634 wl_array_init(&grab_result_list);
636 for (i = 0; i < krt->max_tizen_hwkeys; i++)
638 if (0 == krt->HardKeys[i].keycode) continue;
640 EINA_LIST_FOREACH_SAFE(krt->HardKeys[i].excl_ptr, l, l_next, key_node_data)
642 if (surface == key_node_data->surface)
644 grab_result = wl_array_add(&grab_result_list, sizeof(E_Keyrouter_Grab_Request));
647 grab_result->key = i;
648 grab_result->mode = TIZEN_KEYROUTER_MODE_EXCLUSIVE;
649 grab_result->err = TIZEN_KEYROUTER_ERROR_NONE;
653 EINA_LIST_FOREACH_SAFE(krt->HardKeys[i].or_excl_ptr, l, l_next, key_node_data)
655 if (surface == key_node_data->surface)
657 grab_result = wl_array_add(&grab_result_list, sizeof(E_Keyrouter_Grab_Request));
660 grab_result->key = i;
661 grab_result->mode = TIZEN_KEYROUTER_MODE_OVERRIDABLE_EXCLUSIVE;
662 grab_result->err = TIZEN_KEYROUTER_ERROR_NONE;
666 EINA_LIST_FOREACH_SAFE(krt->HardKeys[i].top_ptr, l, l_next, key_node_data)
668 if (surface == key_node_data->surface)
670 grab_result = wl_array_add(&grab_result_list, sizeof(E_Keyrouter_Grab_Request));
673 grab_result->key = i;
674 grab_result->mode = TIZEN_KEYROUTER_MODE_TOPMOST;
675 grab_result->err = TIZEN_KEYROUTER_ERROR_NONE;
679 EINA_LIST_FOREACH_SAFE(krt->HardKeys[i].shared_ptr, l, l_next, key_node_data)
681 if (surface == key_node_data->surface)
683 grab_result = wl_array_add(&grab_result_list, sizeof(E_Keyrouter_Grab_Request));
686 grab_result->key = i;
687 grab_result->mode = TIZEN_KEYROUTER_MODE_SHARED;
688 grab_result->err = TIZEN_KEYROUTER_ERROR_NONE;
693 // handle register mode here
694 EINA_LIST_FOREACH(krt->registered_window_list, l, rwin_info)
696 if (rwin_info->surface == surface)
698 EINA_LIST_FOREACH(rwin_info->keys, ll, key_data)
700 grab_result = wl_array_add(&grab_result_list, sizeof(E_Keyrouter_Grab_Request));
703 grab_result->key = *key_data;
704 grab_result->mode = TIZEN_KEYROUTER_MODE_REGISTERED;
705 grab_result->err = TIZEN_KEYROUTER_ERROR_NONE;
711 tizen_keyrouter_send_getgrab_notify_list(resource, surface, &grab_result_list);
712 wl_array_release(&grab_result_list);
715 /* Function for registering wl_client destroy listener */
717 e_keyrouter_add_client_destroy_listener(struct wl_client *client)
719 struct wl_listener *destroy_listener = NULL;
721 struct wl_client *wc_data;
723 if (!client) return TIZEN_KEYROUTER_ERROR_NONE;
725 EINA_LIST_FOREACH(krt->grab_client_list, l, wc_data)
729 if (wc_data == client)
731 return TIZEN_KEYROUTER_ERROR_NONE;
736 destroy_listener = E_NEW(struct wl_listener, 1);
738 if (!destroy_listener)
740 KLERR("Failed to allocate memory for wl_client destroy listener !");
741 return TIZEN_KEYROUTER_ERROR_NO_SYSTEM_RESOURCES;
744 destroy_listener->notify = _e_keyrouter_wl_client_cb_destroy;
745 wl_client_add_destroy_listener(client, destroy_listener);
746 krt->grab_client_list = eina_list_append(krt->grab_client_list, client);
748 return TIZEN_KEYROUTER_ERROR_NONE;
751 /* Function for registering wl_surface destroy listener */
753 e_keyrouter_add_surface_destroy_listener(struct wl_resource *surface)
755 struct wl_listener *destroy_listener = NULL;
757 struct wl_resource *surface_data;
759 if (!surface) return TIZEN_KEYROUTER_ERROR_NONE;
761 EINA_LIST_FOREACH(krt->grab_surface_list, l, surface_data)
765 if (surface_data == surface)
767 return TIZEN_KEYROUTER_ERROR_NONE;
772 destroy_listener = E_NEW(struct wl_listener, 1);
774 if (!destroy_listener)
776 KLERR("Failed to allocate memory for wl_surface destroy listener !");
777 return TIZEN_KEYROUTER_ERROR_NO_SYSTEM_RESOURCES;
780 destroy_listener->notify = _e_keyrouter_wl_surface_cb_destroy;
781 wl_resource_add_destroy_listener(surface, destroy_listener);
782 krt->grab_surface_list = eina_list_append(krt->grab_surface_list, surface);
784 return TIZEN_KEYROUTER_ERROR_NONE;
788 static const struct tizen_keyrouter_interface _e_keyrouter_implementation = {
789 _e_keyrouter_cb_keygrab_set,
790 _e_keyrouter_cb_keygrab_unset,
791 _e_keyrouter_cb_get_keygrab_status,
792 _e_keyrouter_cb_keygrab_set_list,
793 _e_keyrouter_cb_keygrab_unset_list,
794 _e_keyrouter_cb_keygrab_get_list,
795 _e_keyrouter_cb_set_register_none_key,
796 _e_keyrouter_cb_get_keyregister_status,
797 _e_keyrouter_cb_set_input_config
800 /* tizen_keyrouter global object destroy function */
802 _e_keyrouter_cb_destory(struct wl_resource *resource)
804 krt->resources = eina_list_remove(krt->resources, resource);
807 /* tizen_keyrouter global object bind function */
809 _e_keyrouter_cb_bind(struct wl_client *client, void *data, uint32_t version, uint32_t id)
811 E_KeyrouterPtr krt_instance = data;
812 struct wl_resource *resource;
814 resource = wl_resource_create(client, &tizen_keyrouter_interface, MIN(version, 1), id);
816 KLDBG("wl_resource_create(...,&tizen_keyrouter_interface,...)");
820 KLERR("Failed to create resource ! (version :%d, id:%d)", version, id);
821 wl_client_post_no_memory(client);
825 krt->resources = eina_list_append(krt->resources, resource);
827 wl_resource_set_implementation(resource, &_e_keyrouter_implementation, krt_instance, _e_keyrouter_cb_destory);
831 _e_keyrouter_keygrab_status_print(FILE *log_fl, Eina_List *list)
834 E_Keyrouter_Key_List_NodePtr kdata;
838 EINA_LIST_FOREACH(list, l, kdata)
840 pid = e_keyrouter_util_get_pid(kdata->wc, kdata->surface);
841 cmd = e_keyrouter_util_cmd_get_from_pid(pid);
842 fprintf(log_fl, " [surface: %p, client: %p, pid: %d(%s)]\n", kdata->surface, kdata->wc, pid, cmd ?: "Unknown");
846 fprintf(log_fl, " -- Surface Information --\n");
847 fprintf(log_fl, " = client: %p\n", wl_resource_get_client(kdata->surface));
848 fprintf(log_fl, " = resource: %s(%d)\n", wl_resource_get_name(kdata->surface), wl_resource_get_id(kdata->surface));
852 fprintf(log_fl, " -- Client Information --\n");
853 fprintf(log_fl, " = connected fd: %d\n", wl_client_get_fd(kdata->wc));
860 _e_keyrouter_info_print(void *data, const char *log_path)
863 int i, c, pid, *idata;
866 E_Keyrouter_Registered_Window_Info *rdata;
868 log_fl = fopen(log_path, "a");
871 KLERR("failed: open file(%s)", log_path);
875 setvbuf(log_fl, NULL, _IOLBF, 512);
877 fprintf(log_fl, "\n===== Keyrouter Information =====\n");
878 fprintf(log_fl, " ----- Grabbable Keys -----\n");
879 for (i = 8; i < krt->max_tizen_hwkeys; i++)
881 if (!krt->HardKeys[i].keycode) continue;
883 keyname = e_keyrouter_util_keyname_get_from_keycode(i);
885 fprintf(log_fl, " Key [%3d], Keyname: %s\n", i, keyname);
890 fprintf(log_fl, " ----- End -----\n\n");
892 fprintf(log_fl, " ----- Register Window List -----\n");
893 EINA_LIST_FOREACH(krt->registered_window_list, l, rdata)
895 pid = e_keyrouter_util_get_pid(NULL, rdata->surface);
896 cmd = e_keyrouter_util_cmd_get_from_pid(pid);
897 fprintf(log_fl, " [ surface: %p, client: %p, pid: %d(%s) ]\n",
898 rdata->surface, wl_resource_get_client(rdata->surface), pid, cmd ?: "Unknown");
901 EINA_LIST_FOREACH(rdata->keys, ll, idata)
903 keyname = e_keyrouter_util_keyname_get_from_keycode(*idata);
905 fprintf(log_fl, " registered key: Key [%3d], Keyname: %s\n", *idata, keyname);
907 fprintf(log_fl, " Key [%3d], Keyname: %s\n", *idata, keyname);
913 fprintf(log_fl, " ----- End -----\n\n");
920 _e_keyrouter_keygrab_print(void *data, const char *log_path)
923 E_Keyrouter_Key_List_NodePtr kdata;
925 struct wl_resource *surface_focus;
926 struct wl_client *wc_focus;
927 int pid_focus, pid, i;
928 char *cmd_focus, *cmd, *keyname;
933 log_fl = fopen(log_path, "a");
936 KLERR("failed: open file(%s)", log_path);
940 setvbuf(log_fl, NULL, _IOLBF, 512);
942 fprintf(log_fl, "\n===== Keygrab Status =====\n");
944 ec_focus = e_client_focused_get();
945 fprintf(log_fl, " ----- Focus Window Info -----\n");
948 surface_focus = e_keyrouter_util_get_surface_from_eclient(ec_focus);
949 wc_focus = wl_resource_get_client(surface_focus);
950 pid_focus = e_keyrouter_util_get_pid(NULL, surface_focus);
951 cmd_focus = e_keyrouter_util_cmd_get_from_pid(pid_focus);
953 fprintf(log_fl, " Focus Client: E_Client: %p\n", ec_focus);
954 fprintf(log_fl, " Surface: %p, Client: %p\n", surface_focus, wc_focus);
955 fprintf(log_fl, " pid: %d, cmd: %s\n", pid_focus, cmd_focus ?: "Unknown");
956 if(cmd_focus) E_FREE(cmd_focus);
960 fprintf(log_fl, " No Focus Client\n");
962 fprintf(log_fl, " ----- End -----\n\n");
964 fprintf(log_fl, " ----- Grabbed keys Info -----\n\n");
965 for (i = 8; i < krt->max_tizen_hwkeys; i++)
967 if (!krt->HardKeys[i].keycode) continue;
968 if (!krt->HardKeys[i].excl_ptr &&
969 !krt->HardKeys[i].or_excl_ptr &&
970 !krt->HardKeys[i].top_ptr &&
971 !krt->HardKeys[i].shared_ptr &&
972 !krt->HardKeys[i].registered_ptr)
975 keyname = e_keyrouter_util_keyname_get_from_keycode(i);
977 fprintf(log_fl, " [ Keycode: %d, Keyname: %s ]\n", i, keyname);
982 if (krt->HardKeys[i].excl_ptr)
984 fprintf(log_fl, " == Exclusive Grab ==\n");
985 EINA_LIST_FOREACH(krt->HardKeys[i].excl_ptr, l, kdata)
987 pid = e_keyrouter_util_get_pid(kdata->wc, kdata->surface);
988 cmd = e_keyrouter_util_cmd_get_from_pid(pid);
989 fprintf(log_fl, " [surface: %p, client: %p, pid: %d(%s)]\n", kdata->surface, kdata->wc, pid, cmd ?: "Unknown");
993 fprintf(log_fl, " -- Surface Information --\n");
994 fprintf(log_fl, " = wl_client: %p\n", wl_resource_get_client(kdata->surface));
995 fprintf(log_fl, " = resource: %s(%d)\n", wl_resource_get_name(kdata->surface), wl_resource_get_id(kdata->surface));
999 fprintf(log_fl, " -- Client Information --\n");
1000 fprintf(log_fl, " = connected fd: %d\n", wl_client_get_fd(kdata->wc));
1006 if (krt->HardKeys[i].or_excl_ptr)
1008 fprintf(log_fl, " == Overidable Exclusive Grab ==\n");
1009 _e_keyrouter_keygrab_status_print(log_fl, krt->HardKeys[i].or_excl_ptr);
1012 if (krt->HardKeys[i].top_ptr)
1014 fprintf(log_fl, " == Top Position Grab ==\n");
1015 _e_keyrouter_keygrab_status_print(log_fl, krt->HardKeys[i].top_ptr);
1018 if (krt->HardKeys[i].shared_ptr)
1020 fprintf(log_fl, " == Shared Grab ==\n");
1021 _e_keyrouter_keygrab_status_print(log_fl, krt->HardKeys[i].shared_ptr);
1024 fprintf(log_fl, "\n");
1027 fprintf(log_fl, " ----- End -----\n\n");
1034 _event_filter(void *data, void *loop_data EINA_UNUSED, int type, void *event)
1040 Ecore_Event_Key *ev;
1042 /* Filter only for key down/up event */
1043 if (ECORE_EVENT_KEY_DOWN == type || ECORE_EVENT_KEY_UP == type)
1047 if (ECORE_EVENT_KEY_DOWN == type)
1051 TRACE_INPUT_BEGIN(event_filter:KEY_PRESS(%d), ev->keycode);
1056 TRACE_INPUT_BEGIN(event_filter:KEY_PRESS);
1061 else if (ECORE_EVENT_KEY_UP == type)
1066 TRACE_INPUT_BEGIN(event_filter:KEY_RELEASE(%d), ev->keycode);
1071 TRACE_INPUT_BEGIN(event_filter:KEY_RELEASE);
1076 return e_keyrouter_process_key_event(event, type);
1083 _e_keyrouter_cb_power_change(device_callback_e type, void* value, void* user_data)
1085 if (type != DEVICE_CALLBACK_DISPLAY_STATE)
1087 KLWRN("type is not DISPLAY_STATE");
1091 display_state_e state = (display_state_e)value;
1094 case DISPLAY_STATE_SCREEN_OFF:
1095 krt->isPictureOffEnabled = 1;
1097 case DISPLAY_STATE_NORMAL:
1098 krt->isPictureOffEnabled = 0;
1100 case DISPLAY_STATE_SCREEN_DIM:
1101 krt->isPictureOffEnabled = 0;
1104 krt->isPictureOffEnabled = 0;
1107 KLDBG("Picture off flag changed to %d", krt->isPictureOffEnabled);
1110 static Eina_Bool _e_keyrouter_cb_idler(void *data)
1112 device_add_callback(DEVICE_CALLBACK_DISPLAY_STATE,_e_keyrouter_cb_power_change,NULL);
1113 return ECORE_CALLBACK_CANCEL;
1117 static E_Keyrouter_Config_Data *
1118 _e_keyrouter_init(E_Module *m)
1120 E_Keyrouter_Config_Data *kconfig = NULL;
1121 krt = E_NEW(E_Keyrouter, 1);
1122 Eina_Bool res = EINA_FALSE;
1125 TRACE_INPUT_BEGIN(_e_keyrouter_init);
1127 _keyrouter_log_dom = eina_log_domain_register("e-keyrouter", EINA_COLOR_RED);
1128 if (_keyrouter_log_dom < 0)
1130 KLERR("Failed to set eina_log_domain (%d)\n", _keyrouter_log_dom);
1133 eina_log_domain_level_set("e-keyrouter", EINA_LOG_LEVEL_INFO);
1137 KLERR("Failed to allocate memory for krt !");
1144 KLERR("Failed to initialize keyrouter module ! (e_comp == NULL)");
1148 kconfig = E_NEW(E_Keyrouter_Config_Data, 1);
1149 EINA_SAFETY_ON_NULL_GOTO(kconfig, err);
1151 kconfig->module = m;
1153 e_keyrouter_conf_init(kconfig);
1154 EINA_SAFETY_ON_NULL_GOTO(kconfig->conf, err);
1155 krt->conf = kconfig;
1156 krt->pictureoff_disabled = !!kconfig->conf->pictureoff_disabled;
1158 /* Get keyname and keycode pair from Tizen Key Layout file */
1159 res = _e_keyrouter_query_tizen_key_table();
1160 EINA_SAFETY_ON_FALSE_GOTO(res, err);
1162 /* Add filtering mechanism */
1163 krt->ef_handler = ecore_event_filter_add(NULL, _event_filter, NULL, NULL);
1164 //ecore handler add for power callback registration
1165 if (!krt->pictureoff_disabled)
1166 ecore_idle_enterer_add(_e_keyrouter_cb_idler, NULL);
1167 _e_keyrouter_init_handlers();
1169 krt->global = wl_global_create(e_comp_wl->wl.disp, &tizen_keyrouter_interface, 1, krt, _e_keyrouter_cb_bind);
1172 KLERR("Failed to create global !");
1176 #ifdef ENABLE_CYNARA
1177 ret = cynara_initialize(&krt->p_cynara, NULL);
1178 if (EINA_UNLIKELY(CYNARA_API_SUCCESS != ret))
1180 _e_keyrouter_util_cynara_log("cynara_initialize", ret);
1181 krt->p_cynara = NULL;
1191 e_keyrouter_conf_deinit(kconfig);
1194 _e_keyrouter_deinit_handlers();
1195 if (krt && krt->ef_handler) ecore_event_filter_del(krt->ef_handler);
1196 if (krt) E_FREE(krt);
1203 e_modapi_init(E_Module *m)
1205 return _e_keyrouter_init(m);
1209 e_modapi_shutdown(E_Module *m)
1212 Eina_List *l, *l_next;
1213 E_Keyrouter_Config_Data *kconfig = m->data;
1214 struct wl_resource *resource;
1215 struct wl_client *client;
1216 struct wl_listener *destroy_listener;
1218 e_keyrouter_conf_deinit(kconfig);
1221 _e_keyrouter_deinit_handlers();
1223 for (i = 0; i < krt->max_tizen_hwkeys+1; i++)
1225 if (krt->HardKeys[i].keyname)
1226 eina_stringshare_del(krt->HardKeys[i].keyname);
1228 E_FREE(krt->HardKeys);
1230 EINA_LIST_FOREACH_SAFE(krt->grab_client_list, l, l_next, client)
1232 destroy_listener = wl_client_get_destroy_listener(client, _e_keyrouter_wl_client_cb_destroy);
1233 if (destroy_listener)
1235 wl_list_remove(&destroy_listener->link);
1236 E_FREE(destroy_listener);
1238 krt->grab_client_list = eina_list_remove(krt->grab_client_list, client);
1240 EINA_LIST_FOREACH_SAFE(krt->grab_surface_list, l, l_next, resource)
1242 destroy_listener = wl_resource_get_destroy_listener(resource, _e_keyrouter_wl_surface_cb_destroy);
1243 if (destroy_listener)
1245 wl_list_remove(&destroy_listener->link);
1246 E_FREE(destroy_listener);
1248 krt->grab_surface_list = eina_list_remove(krt->grab_surface_list, client);
1251 EINA_LIST_FREE(krt->registered_window_list, resource);
1253 EINA_LIST_FREE(krt->resources, resource)
1254 wl_resource_destroy(resource);
1256 wl_global_destroy(krt->global);
1258 #ifdef ENABLE_CYNARA
1259 if (krt->p_cynara) cynara_finish(krt->p_cynara);
1263 /* TODO: free allocated memory */
1265 eina_log_domain_unregister(_keyrouter_log_dom);
1271 e_modapi_save(E_Module *m)
1273 /* Save something to be kept */
1274 E_Keyrouter_Config_Data *kconfig = m->data;
1275 e_config_domain_save("module.keyrouter",
1282 /* Function for getting keyname/keycode information from a key layout file */
1284 _e_keyrouter_query_tizen_key_table(void)
1286 E_Keyrouter_Conf_Edd *kconf = krt->conf->conf;
1288 E_Keyrouter_Tizen_HWKey *data;
1290 struct xkb_rule_names names={0,};
1292 /* TODO: Make struct in HardKeys to pointer.
1293 If a key is defined, allocate memory to pointer,
1294 that makes to save unnecessary memory */
1295 krt->HardKeys = E_NEW(E_Keyrouter_Grabbed_Key, kconf->max_keycode + 1);
1296 EINA_SAFETY_ON_NULL_RETURN_VAL(krt->HardKeys, EINA_FALSE);
1298 krt->numTizenHWKeys = kconf->num_keycode;
1299 krt->max_tizen_hwkeys = kconf->max_keycode;
1301 EINA_LIST_FOREACH(kconf->KeyList, l, data)
1303 if (!data) continue;
1305 if (0 > data->keycode || krt->max_tizen_hwkeys < data->keycode)
1307 KLWRN("Given keycode(%d) is invalid. It must be bigger than zero, smaller than the maximum value(%d) or equal to it.", data->keycode, kconf->max_keycode);
1311 krt->HardKeys[data->keycode].keycode = data->keycode;
1312 krt->HardKeys[data->keycode].keyname = (char *)eina_stringshare_add(data->name);
1313 krt->HardKeys[data->keycode].no_privcheck = data->no_privcheck ? EINA_TRUE : EINA_FALSE;
1314 krt->HardKeys[data->keycode].repeat = data->repeat ? EINA_TRUE : EINA_FALSE;
1316 if (e_comp_wl_input_keymap_cache_file_use_get() == EINA_FALSE)
1318 if (krt->HardKeys[data->keycode].repeat == EINA_FALSE)
1320 res = xkb_keymap_key_set_repeats(e_comp_wl->xkb.keymap, data->keycode, 0);
1323 KLWRN("Failed to set repeat key(%d), value(%d)", data->keycode, 0);
1329 if (e_comp_wl_input_keymap_cache_file_use_get() == EINA_FALSE)
1331 KLINF("Server create a new cache file: %s", e_comp_wl_input_keymap_path_get(names));
1332 res = unlink(e_comp_wl_input_keymap_path_get(names));
1334 e_comp_wl_input_keymap_set(NULL, NULL, NULL, NULL, NULL, xkb_context_ref(e_comp_wl->xkb.context), xkb_keymap_ref(e_comp_wl->xkb.keymap));
1337 KLINF("Currently cache file is exist. Do not change it.");
1343 _e_keyrouter_wl_array_length(const struct wl_array *array)
1348 wl_array_for_each(data, array)
1357 _e_keyrouter_deinit_handlers(void)
1359 Ecore_Event_Handler *h = NULL;
1361 if (!krt || !krt->handlers) return;
1363 EINA_LIST_FREE(krt->handlers, h)
1364 ecore_event_handler_del(h);
1366 e_info_server_hook_set("keyrouter", NULL, NULL);
1367 e_info_server_hook_set("keygrab", NULL, NULL);
1371 _e_keyrouter_init_handlers(void)
1373 E_LIST_HANDLER_APPEND(krt->handlers, E_EVENT_CLIENT_STACK, _e_keyrouter_client_cb_stack, NULL);
1374 E_LIST_HANDLER_APPEND(krt->handlers, E_EVENT_CLIENT_REMOVE, _e_keyrouter_client_cb_remove, NULL);
1376 e_info_server_hook_set("keyrouter", _e_keyrouter_info_print, NULL);
1377 e_info_server_hook_set("keygrab", _e_keyrouter_keygrab_print, NULL);
1381 _e_keyrouter_client_cb_stack(void *data, int type, void *event)
1383 E_Event_Client *ev = event;
1384 E_Client *ec = ev->ec;
1392 //KLDBG("ec: %p, visibile: %d, focused: %d, take_focus: %d, want_focus: %d, bordername: %s, input_only: %d",
1393 // ec, ec->visible, ec->focused, ec->take_focus, ec->want_focus, ec->bordername, ec->input_only);
1395 krt->isWindowStackChanged = EINA_TRUE;
1396 e_keyrouter_clear_registered_window();
1398 return ECORE_CALLBACK_PASS_ON;
1402 _e_keyrouter_client_cb_remove(void *data, int type, void *event)
1404 E_Event_Client *ev = event;
1405 E_Client *ec = ev->ec;
1412 /* FIXME: Remove this callback or do something others.
1413 * It was moved to _e_keyrouter_wl_surface_cb_destroy() where it had here.
1416 return ECORE_CALLBACK_PASS_ON;
1420 _e_keyrouter_wl_client_cb_destroy(struct wl_listener *l, void *data)
1422 struct wl_client *client = data;
1424 KLDBG("Listener(%p) called: wl_client: %p is died", l, client);
1425 e_keyrouter_remove_client_from_list(NULL, client);
1427 wl_list_remove(&l->link);
1430 krt->grab_client_list = eina_list_remove(krt->grab_client_list, client);
1434 _e_keyrouter_wl_surface_cb_destroy(struct wl_listener *l, void *data)
1436 struct wl_resource *surface = (struct wl_resource *)data;
1438 KLDBG("Listener(%p) called: surface: %p is died", l, surface);
1439 e_keyrouter_remove_client_from_list(surface, NULL);
1441 wl_list_remove(&l->link);
1444 krt->grab_surface_list = eina_list_remove(krt->grab_surface_list, surface);
1445 krt->registered_none_key_window_list = eina_list_remove(krt->registered_none_key_window_list, surface);
1446 krt->invisible_set_window_list= eina_list_remove(krt->invisible_set_window_list, surface);
1447 krt->invisible_get_window_list= eina_list_remove(krt->invisible_get_window_list, surface);
1448 if (surface == krt->playback_daemon_surface)
1450 krt->playback_daemon_surface = NULL;
1451 KLDBG("playback daemon surface destroyed!");
1455 #ifdef ENABLE_CYNARA
1457 _e_keyrouter_util_cynara_log(const char *func_name, int err)
1459 #define CYNARA_BUFSIZE 128
1460 char buf[CYNARA_BUFSIZE] = "\0";
1463 ret = cynara_strerror(err, buf, CYNARA_BUFSIZE);
1464 if (ret != CYNARA_API_SUCCESS)
1466 KLWRN("Failed to cynara_strerror: %d (error log about %s: %d)", ret, func_name, err);
1469 KLWRN("%s is failed: %s", func_name, buf);
1473 _e_keyrouter_util_do_privilege_check(struct wl_client *client, uint32_t mode, uint32_t keycode)
1475 int ret, retry_cnt=0, len=0;
1476 char *clientSmack=NULL, *client_session=NULL, uid2[16]={0, };
1477 Eina_Bool res = EINA_FALSE;
1479 struct wl_client *wc_data;
1480 static Eina_Bool retried = EINA_FALSE;
1485 /* Top position grab is always allowed. This mode do not need privilege.*/
1486 if (mode == TIZEN_KEYROUTER_MODE_TOPMOST)
1489 if (krt->HardKeys[keycode].no_privcheck == EINA_TRUE)
1492 if (!client) return EINA_FALSE;
1494 /* If initialize cynara is failed, allow keygrabs regardless of the previlege permition. */
1495 if (krt->p_cynara == NULL)
1497 if (retried == EINA_FALSE)
1499 retried = EINA_TRUE;
1500 for(retry_cnt = 0; retry_cnt < 5; retry_cnt++)
1502 KLDBG("Retry cynara initialize: %d", retry_cnt+1);
1503 ret = cynara_initialize(&krt->p_cynara, NULL);
1504 if (EINA_UNLIKELY(CYNARA_API_SUCCESS != ret))
1506 _e_keyrouter_util_cynara_log("cynara_initialize", ret);
1507 krt->p_cynara = NULL;
1511 KLDBG("Success cynara initialize to try %d times", retry_cnt+1);
1519 EINA_LIST_FOREACH(krt->grab_client_list, l, wc_data)
1521 if (wc_data == client)
1528 wl_client_get_credentials(client, &pid, &uid, &gid);
1530 len = smack_new_label_from_process((int)pid, &clientSmack);
1531 if (len <= 0) goto finish;
1533 snprintf(uid2, 15, "%d", (int)uid);
1534 client_session = cynara_session_from_pid(pid);
1536 ret = cynara_check(krt->p_cynara, clientSmack, client_session, uid2, "http://tizen.org/privilege/keygrab");
1537 if (CYNARA_API_ACCESS_ALLOWED == ret)
1543 KLINF("Fail to check cynara, error : %d (pid : %d)", ret, pid);
1546 if (client_session) E_FREE(client_session);
1547 if (clientSmack) E_FREE(clientSmack);