2 * Server-side window hooks support
4 * Copyright (C) 2002 Alexandre Julliard
5 * Copyright (C) 2005 Dmitry Timoshkov
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include "wine/port.h"
42 struct list chain
; /* hook chain entry */
43 user_handle_t handle
; /* user handle for this hook */
44 struct process
*process
; /* process the hook is set to */
45 struct thread
*thread
; /* thread the hook is set to */
46 struct thread
*owner
; /* owner of the out of context hook */
47 struct hook_table
*table
; /* hook table that contains this hook */
48 int index
; /* hook table index */
52 void *proc
; /* hook function */
53 int unicode
; /* is it a unicode hook? */
54 WCHAR
*module
; /* module name for global hooks */
58 #define WH_WINEVENT (WH_MAXHOOK+1)
60 #define NB_HOOKS (WH_WINEVENT-WH_MINHOOK+1)
61 #define HOOK_ENTRY(p) LIST_ENTRY( (p), struct hook, chain )
65 struct object obj
; /* object header */
66 struct list hooks
[NB_HOOKS
]; /* array of hook chains */
67 int counts
[NB_HOOKS
]; /* use counts for each hook chain */
70 static void hook_table_dump( struct object
*obj
, int verbose
);
71 static void hook_table_destroy( struct object
*obj
);
73 static const struct object_ops hook_table_ops
=
75 sizeof(struct hook_table
), /* size */
76 hook_table_dump
, /* dump */
77 no_add_queue
, /* add_queue */
78 NULL
, /* remove_queue */
81 no_signal
, /* signal */
82 no_get_fd
, /* get_fd */
83 no_lookup_name
, /* lookup_name */
84 no_close_handle
, /* close_handle */
85 hook_table_destroy
/* destroy */
89 /* create a new hook table */
90 static struct hook_table
*alloc_hook_table(void)
92 struct hook_table
*table
;
95 if ((table
= alloc_object( &hook_table_ops
)))
97 for (i
= 0; i
< NB_HOOKS
; i
++)
99 list_init( &table
->hooks
[i
] );
100 table
->counts
[i
] = 0;
106 static struct hook_table
*get_global_hooks( struct thread
*thread
)
108 struct hook_table
*table
;
109 struct desktop
*desktop
= get_thread_desktop( thread
, 0 );
111 if (!desktop
) return NULL
;
112 table
= desktop
->global_hooks
;
113 release_object( desktop
);
117 /* create a new hook and add it to the specified table */
118 static struct hook
*add_hook( struct desktop
*desktop
, struct thread
*thread
, int index
, int global
)
121 struct hook_table
*table
= global
? desktop
->global_hooks
: get_queue_hooks(thread
);
125 if (!(table
= alloc_hook_table())) return NULL
;
126 if (global
) desktop
->global_hooks
= table
;
127 else set_queue_hooks( thread
, table
);
129 if (!(hook
= mem_alloc( sizeof(*hook
) ))) return NULL
;
131 if (!(hook
->handle
= alloc_user_handle( hook
, USER_HOOK
)))
136 hook
->thread
= thread
? (struct thread
*)grab_object( thread
) : NULL
;
139 list_add_head( &table
->hooks
[index
], &hook
->chain
);
140 if (thread
) thread
->desktop_users
++;
144 /* free a hook, removing it from its chain */
145 static void free_hook( struct hook
*hook
)
147 free_user_handle( hook
->handle
);
148 if (hook
->module
) free( hook
->module
);
151 assert( hook
->thread
->desktop_users
> 0 );
152 hook
->thread
->desktop_users
--;
153 release_object( hook
->thread
);
155 if (hook
->process
) release_object( hook
->process
);
156 release_object( hook
->owner
);
157 list_remove( &hook
->chain
);
161 /* find a hook from its index and proc */
162 static struct hook
*find_hook( struct thread
*thread
, int index
, void *proc
)
165 struct hook_table
*table
= get_queue_hooks( thread
);
169 LIST_FOR_EACH( p
, &table
->hooks
[index
] )
171 struct hook
*hook
= HOOK_ENTRY( p
);
172 if (hook
->proc
== proc
) return hook
;
178 /* get the first hook in the chain */
179 inline static struct hook
*get_first_hook( struct hook_table
*table
, int index
)
181 struct list
*elem
= list_head( &table
->hooks
[index
] );
182 return elem
? HOOK_ENTRY( elem
) : NULL
;
185 /* check if a given hook should run in the current thread */
186 inline static int run_hook_in_current_thread( struct hook
*hook
)
188 if ((!hook
->process
|| hook
->process
== current
->process
) &&
189 (!(hook
->flags
& WINEVENT_SKIPOWNPROCESS
) || hook
->process
!= current
->process
))
191 if ((!hook
->thread
|| hook
->thread
== current
) &&
192 (!(hook
->flags
& WINEVENT_SKIPOWNTHREAD
) || hook
->thread
!= current
))
198 /* find the first non-deleted hook in the chain */
199 inline static struct hook
*get_first_valid_hook( struct hook_table
*table
, int index
,
200 int event
, user_handle_t win
,
201 int object_id
, int child_id
)
203 struct hook
*hook
= get_first_hook( table
, index
);
207 if (hook
->proc
&& run_hook_in_current_thread( hook
))
209 if (event
>= hook
->event_min
&& event
<= hook
->event_max
)
211 if (hook
->flags
& WINEVENT_INCONTEXT
) return hook
;
213 /* only winevent hooks may be out of context */
214 assert(hook
->index
+ WH_MINHOOK
== WH_WINEVENT
);
215 post_win_event( hook
->owner
, event
, win
, object_id
, child_id
,
216 hook
->proc
, hook
->module
, hook
->module_size
,
220 hook
= HOOK_ENTRY( list_next( &table
->hooks
[index
], &hook
->chain
) );
225 /* find the next hook in the chain, skipping the deleted ones */
226 static struct hook
*get_next_hook( struct thread
*thread
, struct hook
*hook
, int event
,
227 user_handle_t win
, int object_id
, int child_id
)
229 struct hook_table
*global_hooks
, *table
= hook
->table
;
230 int index
= hook
->index
;
232 while ((hook
= HOOK_ENTRY( list_next( &table
->hooks
[index
], &hook
->chain
) )))
234 if (hook
->proc
&& run_hook_in_current_thread( hook
))
236 if (event
>= hook
->event_min
&& event
<= hook
->event_max
)
238 if (hook
->flags
& WINEVENT_INCONTEXT
) return hook
;
240 /* only winevent hooks may be out of context */
241 assert(hook
->index
+ WH_MINHOOK
== WH_WINEVENT
);
242 post_win_event( hook
->owner
, event
, win
, object_id
, child_id
,
243 hook
->proc
, hook
->module
, hook
->module_size
,
248 global_hooks
= get_global_hooks( thread
);
249 if (global_hooks
&& table
!= global_hooks
) /* now search through the global table */
251 hook
= get_first_valid_hook( global_hooks
, index
, event
, win
, object_id
, child_id
);
256 static void hook_table_dump( struct object
*obj
, int verbose
)
258 /* struct hook_table *table = (struct hook_table *)obj; */
259 fprintf( stderr
, "Hook table\n" );
262 static void hook_table_destroy( struct object
*obj
)
266 struct hook_table
*table
= (struct hook_table
*)obj
;
268 for (i
= 0; i
< NB_HOOKS
; i
++)
270 while ((hook
= get_first_hook( table
, i
)) != NULL
) free_hook( hook
);
274 /* remove a hook, freeing it if the chain is not in use */
275 static void remove_hook( struct hook
*hook
)
277 if (hook
->table
->counts
[hook
->index
])
278 hook
->proc
= NULL
; /* chain is in use, just mark it and return */
283 /* release a hook chain, removing deleted hooks if the use count drops to 0 */
284 static void release_hook_chain( struct hook_table
*table
, int index
)
286 if (!table
->counts
[index
]) /* use count shouldn't already be 0 */
288 set_error( STATUS_INVALID_PARAMETER
);
291 if (!--table
->counts
[index
])
293 struct hook
*hook
= get_first_hook( table
, index
);
296 struct hook
*next
= HOOK_ENTRY( list_next( &table
->hooks
[hook
->index
], &hook
->chain
) );
297 if (!hook
->proc
) free_hook( hook
);
303 /* remove all global hooks owned by a given thread */
304 void remove_thread_hooks( struct thread
*thread
)
306 struct hook_table
*global_hooks
= get_global_hooks( thread
);
309 if (!global_hooks
) return;
311 /* only low-level keyboard/mouse global hooks can be owned by a thread */
312 for (index
= WH_KEYBOARD_LL
- WH_MINHOOK
; index
<= WH_MOUSE_LL
- WH_MINHOOK
; index
++)
314 struct hook
*hook
= get_first_hook( global_hooks
, index
);
317 struct hook
*next
= HOOK_ENTRY( list_next( &global_hooks
->hooks
[index
], &hook
->chain
) );
318 if (hook
->thread
== thread
) remove_hook( hook
);
324 /* get a bitmap of active hooks in a hook table */
325 static int is_hook_active( struct hook_table
*table
, int index
)
327 struct hook
*hook
= get_first_hook( table
, index
);
331 if (hook
->proc
&& run_hook_in_current_thread( hook
)) return 1;
332 hook
= HOOK_ENTRY( list_next( &table
->hooks
[index
], &hook
->chain
) );
337 /* get a bitmap of all active hooks for the current thread */
338 unsigned int get_active_hooks(void)
340 struct hook_table
*table
= get_queue_hooks( current
);
341 struct hook_table
*global_hooks
= get_global_hooks( current
);
342 unsigned int ret
= 1 << 31; /* set high bit to indicate that the bitmap is valid */
345 for (id
= WH_MINHOOK
; id
<= WH_WINEVENT
; id
++)
347 if ((table
&& is_hook_active( table
, id
- WH_MINHOOK
)) ||
348 (global_hooks
&& is_hook_active( global_hooks
, id
- WH_MINHOOK
)))
349 ret
|= 1 << (id
- WH_MINHOOK
);
354 /* set a window hook */
355 DECL_HANDLER(set_hook
)
357 struct process
*process
= NULL
;
358 struct thread
*thread
= NULL
;
359 struct desktop
*desktop
;
363 size_t module_size
= get_req_data_size();
365 if (!req
->proc
|| req
->id
< WH_MINHOOK
|| req
->id
> WH_WINEVENT
)
367 set_error( STATUS_INVALID_PARAMETER
);
371 if (!(desktop
= get_thread_desktop( current
, DESKTOP_HOOKCONTROL
))) return;
373 if (req
->pid
&& !(process
= get_process_from_id( req
->pid
))) goto done
;
377 if (!(thread
= get_thread_from_id( req
->tid
))) goto done
;
378 if (process
&& process
!= thread
->process
)
380 set_error( STATUS_INVALID_PARAMETER
);
385 if (req
->id
== WH_KEYBOARD_LL
|| req
->id
== WH_MOUSE_LL
)
387 /* low-level hardware hooks are special: always global, but without a module */
388 thread
= (struct thread
*)grab_object( current
);
394 /* out of context hooks do not need a module handle */
395 if (!module_size
&& (req
->flags
& WINEVENT_INCONTEXT
))
397 set_error( STATUS_INVALID_PARAMETER
);
400 if (!(module
= memdup( get_req_data(), module_size
))) goto done
;
409 if ((hook
= add_hook( desktop
, thread
, req
->id
- WH_MINHOOK
, global
)))
411 hook
->owner
= (struct thread
*)grab_object( current
);
412 hook
->process
= process
? (struct process
*)grab_object( process
) : NULL
;
413 hook
->event_min
= req
->event_min
;
414 hook
->event_max
= req
->event_max
;
415 hook
->flags
= req
->flags
;
416 hook
->proc
= req
->proc
;
417 hook
->unicode
= req
->unicode
;
418 hook
->module
= module
;
419 hook
->module_size
= module_size
;
420 reply
->handle
= hook
->handle
;
421 reply
->active_hooks
= get_active_hooks();
423 else if (module
) free( module
);
426 if (process
) release_object( process
);
427 if (thread
) release_object( thread
);
428 release_object( desktop
);
432 /* remove a window hook */
433 DECL_HANDLER(remove_hook
)
439 if (!(hook
= get_user_object( req
->handle
, USER_HOOK
)))
441 set_error( STATUS_INVALID_HANDLE
);
447 if (!req
->proc
|| req
->id
< WH_MINHOOK
|| req
->id
> WH_WINEVENT
)
449 set_error( STATUS_INVALID_PARAMETER
);
452 if (!(hook
= find_hook( current
, req
->id
- WH_MINHOOK
, req
->proc
)))
454 set_error( STATUS_INVALID_PARAMETER
);
459 reply
->active_hooks
= get_active_hooks();
463 /* start calling a hook chain */
464 DECL_HANDLER(start_hook_chain
)
467 struct hook_table
*table
= get_queue_hooks( current
);
469 if (req
->id
< WH_MINHOOK
|| req
->id
> WH_WINEVENT
)
471 set_error( STATUS_INVALID_PARAMETER
);
475 reply
->active_hooks
= get_active_hooks();
477 if (!table
|| !(hook
= get_first_valid_hook( table
, req
->id
- WH_MINHOOK
, req
->event
,
478 req
->window
, req
->object_id
, req
->child_id
)))
480 /* try global table */
481 if (!(table
= get_global_hooks( current
)) ||
482 !(hook
= get_first_valid_hook( table
, req
->id
- WH_MINHOOK
, req
->event
,
483 req
->window
, req
->object_id
, req
->child_id
)))
484 return; /* no hook set */
487 if (hook
->thread
&& hook
->thread
!= current
) /* must run in other thread */
489 reply
->pid
= get_process_id( hook
->thread
->process
);
490 reply
->tid
= get_thread_id( hook
->thread
);
497 reply
->proc
= hook
->proc
;
498 reply
->handle
= hook
->handle
;
499 reply
->unicode
= hook
->unicode
;
500 table
->counts
[hook
->index
]++;
501 if (hook
->module
) set_reply_data( hook
->module
, hook
->module_size
);
505 /* finished calling a hook chain */
506 DECL_HANDLER(finish_hook_chain
)
508 struct hook_table
*table
= get_queue_hooks( current
);
509 struct hook_table
*global_hooks
= get_global_hooks( current
);
510 int index
= req
->id
- WH_MINHOOK
;
512 if (req
->id
< WH_MINHOOK
|| req
->id
> WH_WINEVENT
)
514 set_error( STATUS_INVALID_PARAMETER
);
517 if (table
) release_hook_chain( table
, index
);
518 if (global_hooks
) release_hook_chain( global_hooks
, index
);
522 /* get the next hook to call */
523 DECL_HANDLER(get_next_hook
)
525 struct hook
*hook
, *next
;
527 if (!(hook
= get_user_object( req
->handle
, USER_HOOK
))) return;
528 if (hook
->thread
&& (hook
->thread
!= current
))
530 set_error( STATUS_INVALID_HANDLE
);
533 if ((next
= get_next_hook( current
, hook
, req
->event
, req
->window
, req
->object_id
, req
->child_id
)))
535 reply
->next
= next
->handle
;
536 reply
->id
= next
->index
+ WH_MINHOOK
;
537 reply
->prev_unicode
= hook
->unicode
;
538 reply
->next_unicode
= next
->unicode
;
539 if (next
->module
) set_reply_data( next
->module
, next
->module_size
);
540 if (next
->thread
&& next
->thread
!= current
)
542 reply
->pid
= get_process_id( next
->thread
->process
);
543 reply
->tid
= get_thread_id( next
->thread
);
550 reply
->proc
= next
->proc
;