2 * Windows hook functions
4 * Copyright 2002 Alexandre Julliard
5 * Copyright 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
22 * Status of the various hooks:
24 * WH_JOURNALRECORD Partially implemented
25 * WH_JOURNALPLAYBACK Partially implemented
27 * WH_GETMESSAGE OK (FIXME: A/W mapping?)
28 * WH_CALLWNDPROC OK (FIXME: A/W mapping?)
36 * HCBT_CLICKSKIPPED OK
42 * WH_HARDWARE Not supported in Win32
43 * WH_DEBUG Not implemented
45 * HSHELL_WINDOWCREATED OK
46 * HSHELL_WINDOWDESTROYED OK
47 * HSHELL_ACTIVATESHELLWINDOW Not implemented
48 * HSHELL_WINDOWACTIVATED Not implemented
49 * HSHELL_GETMINRECT Not implemented
50 * HSHELL_REDRAW Not implemented
51 * HSHELL_TASKMAN Not implemented
52 * HSHELL_LANGUAGE Not implemented
53 * HSHELL_SYSMENU Not implemented
54 * HSHELL_ENDTASK Not implemented
55 * HSHELL_ACCESSIBILITYSTATE Not implemented
56 * HSHELL_APPCOMMAND Not implemented
57 * HSHELL_WINDOWREPLACED Not implemented
58 * HSHELL_WINDOWREPLACING Not implemented
59 * WH_FOREGROUNDIDLE Not implemented
60 * WH_CALLWNDPROCRET OK (FIXME: A/W mapping?)
61 * WH_KEYBOARD_LL Implemented but should use SendMessage instead
62 * WH_MOUSE_LL Implemented but should use SendMessage instead
66 #include "wine/port.h"
76 #include "user_private.h"
77 #include "wine/server.h"
78 #include "wine/unicode.h"
79 #include "wine/debug.h"
82 WINE_DEFAULT_DEBUG_CHANNEL(hook);
83 WINE_DECLARE_DEBUG_CHANNEL(relay);
90 WCHAR module[MAX_PATH];
93 #define WH_WINEVENT (WH_MAXHOOK+1)
95 static const char * const hook_names[WH_WINEVENT - WH_MINHOOK + 1] =
117 /***********************************************************************
118 * get_ll_hook_timeout
121 static UINT get_ll_hook_timeout(void)
123 /* FIXME: should retrieve LowLevelHooksTimeout in HKEY_CURRENT_USER\Control Panel\Desktop */
128 /***********************************************************************
131 * Implementation of SetWindowsHookExA and SetWindowsHookExW.
133 static HHOOK set_windows_hook( INT id, HOOKPROC proc, HINSTANCE inst, DWORD tid, BOOL unicode )
136 WCHAR module[MAX_PATH];
141 SetLastError( ERROR_INVALID_FILTER_PROC );
147 SetLastError( ERROR_INVALID_FILTER_PROC );
151 /* FIXME: what if the tid belongs to another process? */
152 if (tid) /* thread-local hook */
154 if (id == WH_JOURNALRECORD ||
155 id == WH_JOURNALPLAYBACK ||
156 id == WH_KEYBOARD_LL ||
158 id == WH_SYSMSGFILTER)
160 /* these can only be global */
161 SetLastError( ERROR_INVALID_PARAMETER );
166 else /* system-global hook */
168 if (id == WH_KEYBOARD_LL || id == WH_MOUSE_LL) inst = 0;
169 else if (!inst || !(len = GetModuleFileNameW( inst, module, MAX_PATH )) || len >= MAX_PATH)
171 SetLastError( ERROR_HOOK_NEEDS_HMOD );
176 SERVER_START_REQ( set_hook )
181 req->event_min = EVENT_MIN;
182 req->event_max = EVENT_MAX;
183 req->flags = WINEVENT_INCONTEXT;
184 req->unicode = unicode;
185 if (inst) /* make proc relative to the module base */
187 req->proc = (void *)((char *)proc - (char *)inst);
188 wine_server_add_data( req, module, strlenW(module) * sizeof(WCHAR) );
190 else req->proc = proc;
192 if (!wine_server_call_err( req )) handle = reply->handle;
196 TRACE( "%s %p %lx -> %p\n", hook_names[id-WH_MINHOOK], proc, tid, handle );
201 /***********************************************************************
204 static LRESULT call_hook_AtoW( HOOKPROC proc, INT id, INT code, WPARAM wparam, LPARAM lparam )
207 UNICODE_STRING usBuffer;
208 if (id != WH_CBT || code != HCBT_CREATEWND) ret = proc( code, wparam, lparam );
211 CBT_CREATEWNDA *cbtcwA = (CBT_CREATEWNDA *)lparam;
212 CBT_CREATEWNDW cbtcwW;
216 cbtcwW.hwndInsertAfter = cbtcwA->hwndInsertAfter;
217 csW = *(CREATESTRUCTW *)cbtcwA->lpcs;
219 if (HIWORD(cbtcwA->lpcs->lpszName))
221 RtlCreateUnicodeStringFromAsciiz(&usBuffer,cbtcwA->lpcs->lpszName);
222 csW.lpszName = usBuffer.Buffer;
224 if (HIWORD(cbtcwA->lpcs->lpszClass))
226 RtlCreateUnicodeStringFromAsciiz(&usBuffer,cbtcwA->lpcs->lpszClass);
227 csW.lpszClass = usBuffer.Buffer;
229 ret = proc( code, wparam, (LPARAM)&cbtcwW );
230 cbtcwA->hwndInsertAfter = cbtcwW.hwndInsertAfter;
231 if (HIWORD(csW.lpszName)) HeapFree( GetProcessHeap(), 0, (LPWSTR)csW.lpszName );
232 if (HIWORD(csW.lpszClass)) HeapFree( GetProcessHeap(), 0, (LPWSTR)csW.lpszClass );
238 /***********************************************************************
241 static LRESULT call_hook_WtoA( HOOKPROC proc, INT id, INT code, WPARAM wparam, LPARAM lparam )
245 if (id != WH_CBT || code != HCBT_CREATEWND) ret = proc( code, wparam, lparam );
248 CBT_CREATEWNDW *cbtcwW = (CBT_CREATEWNDW *)lparam;
249 CBT_CREATEWNDA cbtcwA;
254 cbtcwA.hwndInsertAfter = cbtcwW->hwndInsertAfter;
255 csA = *(CREATESTRUCTA *)cbtcwW->lpcs;
257 if (HIWORD(cbtcwW->lpcs->lpszName)) {
258 len = WideCharToMultiByte( CP_ACP, 0, cbtcwW->lpcs->lpszName, -1, NULL, 0, NULL, NULL );
259 csA.lpszName = HeapAlloc( GetProcessHeap(), 0, len*sizeof(CHAR) );
260 WideCharToMultiByte( CP_ACP, 0, cbtcwW->lpcs->lpszName, -1, (LPSTR)csA.lpszName, len, NULL, NULL );
263 if (HIWORD(cbtcwW->lpcs->lpszClass)) {
264 len = WideCharToMultiByte( CP_ACP, 0, cbtcwW->lpcs->lpszClass, -1, NULL, 0, NULL, NULL );
265 csA.lpszClass = HeapAlloc( GetProcessHeap(), 0, len*sizeof(CHAR) );
266 WideCharToMultiByte( CP_ACP, 0, cbtcwW->lpcs->lpszClass, -1, (LPSTR)csA.lpszClass, len, NULL, NULL );
269 ret = proc( code, wparam, (LPARAM)&cbtcwA );
270 cbtcwW->hwndInsertAfter = cbtcwA.hwndInsertAfter;
271 if (HIWORD(csA.lpszName)) HeapFree( GetProcessHeap(), 0, (LPSTR)csA.lpszName );
272 if (HIWORD(csA.lpszClass)) HeapFree( GetProcessHeap(), 0, (LPSTR)csA.lpszClass );
278 /***********************************************************************
281 static LRESULT call_hook( HOOKPROC proc, INT id, INT code, WPARAM wparam, LPARAM lparam,
282 BOOL prev_unicode, BOOL next_unicode )
287 DPRINTF( "%04lx:Call hook proc %p (id=%s,code=%x,wp=%08x,lp=%08lx)\n",
288 GetCurrentThreadId(), proc, hook_names[id-WH_MINHOOK], code, wparam, lparam );
290 if (!prev_unicode == !next_unicode) ret = proc( code, wparam, lparam );
291 else if (prev_unicode) ret = call_hook_WtoA( proc, id, code, wparam, lparam );
292 else ret = call_hook_AtoW( proc, id, code, wparam, lparam );
295 DPRINTF( "%04lx:Ret hook proc %p (id=%s,code=%x,wp=%08x,lp=%08lx) retval=%08lx\n",
296 GetCurrentThreadId(), proc, hook_names[id-WH_MINHOOK], code, wparam, lparam, ret );
302 /***********************************************************************
305 * Retrieve the hook procedure real value for a module-relative proc
307 static void *get_hook_proc( void *proc, const WCHAR *module )
311 if (!(mod = GetModuleHandleW(module)))
313 TRACE( "loading %s\n", debugstr_w(module) );
314 /* FIXME: the library will never be freed */
315 if (!(mod = LoadLibraryW(module))) return NULL;
317 return (char *)mod + (ULONG_PTR)proc;
321 /***********************************************************************
324 LRESULT HOOK_CallHooks( INT id, INT code, WPARAM wparam, LPARAM lparam, BOOL unicode )
326 struct user_thread_info *thread_info = get_user_thread_info();
327 HOOKPROC proc = NULL;
329 DWORD pid = 0, tid = 0;
330 WCHAR module[MAX_PATH];
331 BOOL unicode_hook = FALSE;
336 SERVER_START_REQ( start_hook_chain )
339 req->event = EVENT_MIN;
340 wine_server_set_reply( req, module, sizeof(module)-sizeof(WCHAR) );
341 if (!wine_server_call( req ))
343 module[wine_server_reply_size(req) / sizeof(WCHAR)] = 0;
344 handle = reply->handle;
348 unicode_hook = reply->unicode;
355 TRACE( "calling hook in thread %04lx %s code %x wp %x lp %lx\n",
356 tid, hook_names[id-WH_MINHOOK], code, wparam, lparam );
361 MSG_SendInternalMessageTimeout( pid, tid, WM_WINE_KEYBOARD_LL_HOOK, wparam, lparam,
362 SMTO_ABORTIFHUNG, get_ll_hook_timeout(), &ret );
365 MSG_SendInternalMessageTimeout( pid, tid, WM_WINE_MOUSE_LL_HOOK, wparam, lparam,
366 SMTO_ABORTIFHUNG, get_ll_hook_timeout(), &ret );
369 ERR("Unknown hook id %d\n", id);
376 TRACE( "calling hook %p %s code %x wp %x lp %lx module %s\n",
377 proc, hook_names[id-WH_MINHOOK], code, wparam, lparam, debugstr_w(module) );
379 if (!module[0] || (proc = get_hook_proc( proc, module )) != NULL)
381 HHOOK prev = thread_info->hook;
382 thread_info->hook = handle;
383 ret = call_hook( proc, id, code, wparam, lparam, unicode, unicode_hook );
384 thread_info->hook = prev;
390 SERVER_START_REQ( finish_hook_chain )
393 wine_server_call( req );
400 /***********************************************************************
403 BOOL HOOK_IsHooked( INT id )
405 return TRUE; /* FIXME */
409 /***********************************************************************
410 * SetWindowsHookA (USER32.@)
412 HHOOK WINAPI SetWindowsHookA( INT id, HOOKPROC proc )
414 return SetWindowsHookExA( id, proc, 0, GetCurrentThreadId() );
418 /***********************************************************************
419 * SetWindowsHookW (USER32.@)
421 HHOOK WINAPI SetWindowsHookW( INT id, HOOKPROC proc )
423 return SetWindowsHookExW( id, proc, 0, GetCurrentThreadId() );
427 /***********************************************************************
428 * SetWindowsHookExA (USER32.@)
430 HHOOK WINAPI SetWindowsHookExA( INT id, HOOKPROC proc, HINSTANCE inst, DWORD tid )
432 return set_windows_hook( id, proc, inst, tid, FALSE );
435 /***********************************************************************
436 * SetWindowsHookExW (USER32.@)
438 HHOOK WINAPI SetWindowsHookExW( INT id, HOOKPROC proc, HINSTANCE inst, DWORD tid )
440 return set_windows_hook( id, proc, inst, tid, TRUE );
444 /***********************************************************************
445 * UnhookWindowsHook (USER32.@)
447 BOOL WINAPI UnhookWindowsHook( INT id, HOOKPROC proc )
451 TRACE( "%s %p\n", hook_names[id-WH_MINHOOK], proc );
453 SERVER_START_REQ( remove_hook )
458 ret = !wine_server_call_err( req );
461 if (!ret && GetLastError() == ERROR_INVALID_HANDLE) SetLastError( ERROR_INVALID_HOOK_HANDLE );
467 /***********************************************************************
468 * UnhookWindowsHookEx (USER32.@)
470 BOOL WINAPI UnhookWindowsHookEx( HHOOK hhook )
474 TRACE( "%p\n", hhook );
476 SERVER_START_REQ( remove_hook )
480 ret = !wine_server_call_err( req );
483 if (!ret && GetLastError() == ERROR_INVALID_HANDLE) SetLastError( ERROR_INVALID_HOOK_HANDLE );
488 /***********************************************************************
489 * CallNextHookEx (USER32.@)
491 LRESULT WINAPI CallNextHookEx( HHOOK hhook, INT code, WPARAM wparam, LPARAM lparam )
493 struct user_thread_info *thread_info = get_user_thread_info();
494 HOOKPROC proc = NULL;
495 WCHAR module[MAX_PATH];
497 DWORD pid = 0, tid = 0;
499 BOOL prev_unicode = FALSE, next_unicode = FALSE;
502 SERVER_START_REQ( get_next_hook )
504 req->handle = thread_info->hook;
505 req->event = EVENT_MIN;
506 wine_server_set_reply( req, module, sizeof(module)-sizeof(WCHAR) );
507 if (!wine_server_call_err( req ))
509 module[wine_server_reply_size(req) / sizeof(WCHAR)] = 0;
510 handle = reply->next;
515 prev_unicode = reply->prev_unicode;
516 next_unicode = reply->next_unicode;
523 TRACE( "calling hook in thread %04lx %s code %x wp %x lp %lx\n",
524 tid, hook_names[id-WH_MINHOOK], code, wparam, lparam );
529 MSG_SendInternalMessageTimeout( pid, tid, WM_WINE_KEYBOARD_LL_HOOK, wparam, lparam,
530 SMTO_ABORTIFHUNG, get_ll_hook_timeout(), &ret );
533 MSG_SendInternalMessageTimeout( pid, tid, WM_WINE_MOUSE_LL_HOOK, wparam, lparam,
534 SMTO_ABORTIFHUNG, get_ll_hook_timeout(), &ret );
537 ERR("Unknown hook id %d\n", id);
544 TRACE( "calling hook %p %s code %x wp %x lp %lx module %s\n",
545 proc, hook_names[id-WH_MINHOOK], code, wparam, lparam, debugstr_w(module) );
547 if (!module[0] || (proc = get_hook_proc( proc, module )) != NULL)
549 HHOOK prev = thread_info->hook;
550 thread_info->hook = handle;
551 ret = call_hook( proc, id, code, wparam, lparam, prev_unicode, next_unicode );
552 thread_info->hook = prev;
559 /***********************************************************************
560 * CallMsgFilterA (USER32.@)
562 BOOL WINAPI CallMsgFilterA( LPMSG msg, INT code )
564 if (HOOK_CallHooks( WH_SYSMSGFILTER, code, 0, (LPARAM)msg, FALSE )) return TRUE;
565 return HOOK_CallHooks( WH_MSGFILTER, code, 0, (LPARAM)msg, FALSE );
569 /***********************************************************************
570 * CallMsgFilterW (USER32.@)
572 BOOL WINAPI CallMsgFilterW( LPMSG msg, INT code )
574 if (HOOK_CallHooks( WH_SYSMSGFILTER, code, 0, (LPARAM)msg, TRUE )) return TRUE;
575 return HOOK_CallHooks( WH_MSGFILTER, code, 0, (LPARAM)msg, TRUE );
579 /***********************************************************************
580 * SetWinEventHook [USER32.@]
582 * Set up an event hook for a set of events.
585 * event_min [I] Lowest event handled by pfnProc
586 * event_max [I] Highest event handled by pfnProc
587 * inst [I] DLL containing pfnProc
588 * proc [I] Callback event hook function
589 * pid [I] Process to get events from, or 0 for all processes
590 * tid [I] Thread to get events from, or 0 for all threads
591 * flags [I] Flags indicating the status of pfnProc
594 * Success: A handle representing the hook.
595 * Failure: A NULL handle.
597 HWINEVENTHOOK WINAPI SetWinEventHook(DWORD event_min, DWORD event_max,
598 HMODULE inst, WINEVENTPROC proc,
599 DWORD pid, DWORD tid, DWORD flags)
601 HWINEVENTHOOK handle = 0;
602 WCHAR module[MAX_PATH];
605 TRACE("%ld,%ld,%p,%p,%08lx,%04lx,%08lx\n", event_min, event_max, inst,
606 proc, pid, tid, flags);
610 if (!(len = GetModuleFileNameW(inst, module, MAX_PATH)) || len >= MAX_PATH)
614 if ((flags & WINEVENT_INCONTEXT) && !inst)
616 SetLastError(ERROR_HOOK_NEEDS_HMOD);
620 if (event_min > event_max)
622 SetLastError(ERROR_INVALID_HOOK_FILTER);
626 /* FIXME: what if the tid or pid belongs to another process? */
627 if (tid) /* thread-local hook */
630 SERVER_START_REQ( set_hook )
632 req->id = WH_WINEVENT;
635 req->event_min = event_min;
636 req->event_max = event_max;
639 if (inst) /* make proc relative to the module base */
641 req->proc = (void *)((char *)proc - (char *)inst);
642 wine_server_add_data( req, module, strlenW(module) * sizeof(WCHAR) );
644 else req->proc = proc;
646 if (!wine_server_call_err( req )) handle = reply->handle;
650 TRACE("-> %p\n", handle);
655 /***********************************************************************
656 * UnhookWinEvent [USER32.@]
658 * Remove an event hook for a set of events.
661 * hEventHook [I] Event hook to remove
664 * Success: TRUE. The event hook has been removed.
665 * Failure: FALSE, if hEventHook is invalid.
667 BOOL WINAPI UnhookWinEvent(HWINEVENTHOOK hEventHook)
671 TRACE( "%p\n", hEventHook );
673 SERVER_START_REQ( remove_hook )
675 req->handle = hEventHook;
676 req->id = WH_WINEVENT;
677 ret = !wine_server_call_err( req );
683 inline static BOOL find_first_hook(DWORD id, DWORD event, HWND hwnd, LONG object_id,
684 LONG child_id, struct hook_info *info)
688 SERVER_START_REQ( start_hook_chain )
693 req->object_id = object_id;
694 req->child_id = child_id;
695 wine_server_set_reply( req, info->module, sizeof(info->module)-sizeof(WCHAR) );
696 ret = !wine_server_call( req );
699 info->module[wine_server_reply_size(req) / sizeof(WCHAR)] = 0;
700 info->handle = reply->handle;
701 info->proc = reply->proc;
702 info->tid = reply->tid;
706 return ret && (info->tid || info->proc);
709 inline static BOOL find_next_hook(DWORD event, HWND hwnd, LONG object_id,
710 LONG child_id, struct hook_info *info)
714 SERVER_START_REQ( get_next_hook )
716 req->handle = info->handle;
719 req->object_id = object_id;
720 req->child_id = child_id;
721 wine_server_set_reply( req, info->module, sizeof(info->module)-sizeof(WCHAR) );
722 ret = !wine_server_call( req );
725 info->module[wine_server_reply_size(req) / sizeof(WCHAR)] = 0;
726 info->handle = reply->next;
727 info->proc = reply->proc;
728 info->tid = reply->tid;
735 inline static void find_hook_close(DWORD id)
737 SERVER_START_REQ( finish_hook_chain )
740 wine_server_call( req );
745 /***********************************************************************
746 * NotifyWinEvent [USER32.@]
748 * Inform the OS that an event has occurred.
751 * event [I] Id of the event
752 * hwnd [I] Window holding the object that created the event
753 * object_id [I] Type of object that created the event
754 * child_id [I] Child object of nId, or CHILDID_SELF.
759 void WINAPI NotifyWinEvent(DWORD event, HWND hwnd, LONG object_id, LONG child_id)
761 struct hook_info info;
763 TRACE("%04lx,%p,%ld,%ld\n", event, hwnd, object_id, child_id);
767 SetLastError(ERROR_INVALID_WINDOW_HANDLE);
774 if (event & 0x80000000)
776 /* FIXME: on 64-bit platforms we need to invent some other way for
777 * passing parameters, nId and nChildId can't hold full [W|L]PARAM.
778 * struct call_hook *hook = (LRESULT *)hWnd;
779 * wparam = hook->wparam;
780 * lparam = hook->lparam;
782 LRESULT *ret = (LRESULT *)hwnd;
783 INT id, code, unicode;
785 id = (dwEvent & 0x7fff0000) >> 16;
786 code = event & 0x7fff;
787 unicode = event & 0x8000;
788 *ret = HOOK_CallHooks(id, code, object_id, child_id, unicode);
793 if (!find_first_hook(WH_WINEVENT, event, hwnd, object_id, child_id, &info)) return;
799 TRACE( "calling WH_WINEVENT hook %p event %lx hwnd %p %lx %lx module %s\n",
800 info.proc, event, hwnd, object_id, child_id, debugstr_w(info.module) );
802 if (!info.module[0] || (info.proc = get_hook_proc( info.proc, info.module )) != NULL)
805 DPRINTF( "%04lx:Call winevent hook proc %p (hhook=%p,event=%lx,hwnd=%p,object_id=%lx,child_id=%lx,tid=%04lx,time=%lx)\n",
806 GetCurrentThreadId(), info.proc, info.handle, event, hwnd, object_id,
807 child_id, GetCurrentThreadId(), GetCurrentTime());
809 info.proc(info.handle, event, hwnd, object_id, child_id,
810 GetCurrentThreadId(), GetCurrentTime());
813 DPRINTF( "%04lx:Ret winevent hook proc %p (hhook=%p,event=%lx,hwnd=%p,object_id=%lx,child_id=%lx,tid=%04lx,time=%lx)\n",
814 GetCurrentThreadId(), info.proc, info.handle, event, hwnd, object_id,
815 child_id, GetCurrentThreadId(), GetCurrentTime());
821 while (find_next_hook(event, hwnd, object_id, child_id, &info));
823 find_hook_close(WH_WINEVENT);
827 /***********************************************************************
828 * IsWinEventHookInstalled [USER32.@]
830 * Determine if an event hook is installed for an event.
833 * dwEvent [I] Id of the event
836 * TRUE, If there are any hooks installed for the event.
842 BOOL WINAPI IsWinEventHookInstalled(DWORD dwEvent)
844 FIXME("(%ld)-stub!\n", dwEvent);