2 * Windows hook functions
4 * Copyright 2002 Alexandre Julliard
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 * Status of the various hooks:
23 * WH_JOURNALRECORD Partially implemented
24 * WH_JOURNALPLAYBACK Partially implemented
26 * WH_GETMESSAGE OK (FIXME: A/W mapping?)
27 * WH_CALLWNDPROC OK (FIXME: A/W mapping?)
35 * HCBT_CLICKSKIPPED OK
41 * WH_HARDWARE Not supported in Win32
42 * WH_DEBUG Not implemented
44 * HSHELL_WINDOWCREATED OK
45 * HSHELL_WINDOWDESTROYED OK
46 * HSHELL_ACTIVATESHELLWINDOW Not implemented
47 * HSHELL_WINDOWACTIVATED Not implemented
48 * HSHELL_GETMINRECT Not implemented
49 * HSHELL_REDRAW Not implemented
50 * HSHELL_TASKMAN Not implemented
51 * HSHELL_LANGUAGE Not implemented
52 * HSHELL_SYSMENU Not implemented
53 * HSHELL_ENDTASK Not implemented
54 * HSHELL_ACCESSIBILITYSTATE Not implemented
55 * HSHELL_APPCOMMAND Not implemented
56 * HSHELL_WINDOWREPLACED Not implemented
57 * HSHELL_WINDOWREPLACING Not implemented
58 * WH_FOREGROUNDIDLE Not implemented
59 * WH_CALLWNDPROCRET OK (FIXME: A/W mapping?)
60 * WH_KEYBOARD_LL Implemented but should use SendMessage instead
61 * WH_MOUSE_LL Implemented but should use SendMessage instead
65 #include "wine/port.h"
75 #include "user_private.h"
76 #include "wine/server.h"
77 #include "wine/unicode.h"
78 #include "wine/debug.h"
81 WINE_DEFAULT_DEBUG_CHANNEL(hook);
82 WINE_DECLARE_DEBUG_CHANNEL(relay);
84 static const char * const hook_names[WH_MAXHOOK - WH_MINHOOK + 1] =
105 /***********************************************************************
106 * get_ll_hook_timeout
109 static UINT get_ll_hook_timeout(void)
111 /* FIXME: should retrieve LowLevelHooksTimeout in HKEY_CURRENT_USER\Control Panel\Desktop */
116 /***********************************************************************
119 * Implementation of SetWindowsHookExA and SetWindowsHookExW.
121 static HHOOK set_windows_hook( INT id, HOOKPROC proc, HINSTANCE inst, DWORD tid, BOOL unicode )
124 WCHAR module[MAX_PATH];
129 SetLastError( ERROR_INVALID_FILTER_PROC );
133 if (tid) /* thread-local hook */
135 if (id == WH_JOURNALRECORD ||
136 id == WH_JOURNALPLAYBACK ||
137 id == WH_KEYBOARD_LL ||
139 id == WH_SYSMSGFILTER)
141 /* these can only be global */
142 SetLastError( ERROR_INVALID_PARAMETER );
147 else /* system-global hook */
149 if (id == WH_KEYBOARD_LL || id == WH_MOUSE_LL) inst = 0;
150 else if (!inst || !(len = GetModuleFileNameW( inst, module, MAX_PATH )) || len >= MAX_PATH)
152 SetLastError( ERROR_HOOK_NEEDS_HMOD );
157 SERVER_START_REQ( set_hook )
161 req->unicode = unicode;
162 if (inst) /* make proc relative to the module base */
164 req->proc = (void *)((char *)proc - (char *)inst);
165 wine_server_add_data( req, module, strlenW(module) * sizeof(WCHAR) );
167 else req->proc = proc;
169 if (!wine_server_call_err( req )) handle = reply->handle;
173 TRACE( "%s %p %lx -> %p\n", hook_names[id-WH_MINHOOK], proc, tid, handle );
178 /***********************************************************************
181 static LRESULT call_hook_AtoW( HOOKPROC proc, INT id, INT code, WPARAM wparam, LPARAM lparam )
184 UNICODE_STRING usBuffer;
185 if (id != WH_CBT || code != HCBT_CREATEWND) ret = proc( code, wparam, lparam );
188 CBT_CREATEWNDA *cbtcwA = (CBT_CREATEWNDA *)lparam;
189 CBT_CREATEWNDW cbtcwW;
193 cbtcwW.hwndInsertAfter = cbtcwA->hwndInsertAfter;
194 csW = *(CREATESTRUCTW *)cbtcwA->lpcs;
196 if (HIWORD(cbtcwA->lpcs->lpszName))
198 RtlCreateUnicodeStringFromAsciiz(&usBuffer,cbtcwA->lpcs->lpszName);
199 csW.lpszName = usBuffer.Buffer;
201 if (HIWORD(cbtcwA->lpcs->lpszClass))
203 RtlCreateUnicodeStringFromAsciiz(&usBuffer,cbtcwA->lpcs->lpszClass);
204 csW.lpszClass = usBuffer.Buffer;
206 ret = proc( code, wparam, (LPARAM)&cbtcwW );
207 cbtcwA->hwndInsertAfter = cbtcwW.hwndInsertAfter;
208 if (HIWORD(csW.lpszName)) HeapFree( GetProcessHeap(), 0, (LPWSTR)csW.lpszName );
209 if (HIWORD(csW.lpszClass)) HeapFree( GetProcessHeap(), 0, (LPWSTR)csW.lpszClass );
215 /***********************************************************************
218 static LRESULT call_hook_WtoA( HOOKPROC proc, INT id, INT code, WPARAM wparam, LPARAM lparam )
222 if (id != WH_CBT || code != HCBT_CREATEWND) ret = proc( code, wparam, lparam );
225 CBT_CREATEWNDW *cbtcwW = (CBT_CREATEWNDW *)lparam;
226 CBT_CREATEWNDA cbtcwA;
231 cbtcwA.hwndInsertAfter = cbtcwW->hwndInsertAfter;
232 csA = *(CREATESTRUCTA *)cbtcwW->lpcs;
234 if (HIWORD(cbtcwW->lpcs->lpszName)) {
235 len = WideCharToMultiByte( CP_ACP, 0, cbtcwW->lpcs->lpszName, -1, NULL, 0, NULL, NULL );
236 csA.lpszName = HeapAlloc( GetProcessHeap(), 0, len*sizeof(CHAR) );
237 WideCharToMultiByte( CP_ACP, 0, cbtcwW->lpcs->lpszName, -1, (LPSTR)csA.lpszName, len, NULL, NULL );
240 if (HIWORD(cbtcwW->lpcs->lpszClass)) {
241 len = WideCharToMultiByte( CP_ACP, 0, cbtcwW->lpcs->lpszClass, -1, NULL, 0, NULL, NULL );
242 csA.lpszClass = HeapAlloc( GetProcessHeap(), 0, len*sizeof(CHAR) );
243 WideCharToMultiByte( CP_ACP, 0, cbtcwW->lpcs->lpszClass, -1, (LPSTR)csA.lpszClass, len, NULL, NULL );
246 ret = proc( code, wparam, (LPARAM)&cbtcwA );
247 cbtcwW->hwndInsertAfter = cbtcwA.hwndInsertAfter;
248 if (HIWORD(csA.lpszName)) HeapFree( GetProcessHeap(), 0, (LPSTR)csA.lpszName );
249 if (HIWORD(csA.lpszClass)) HeapFree( GetProcessHeap(), 0, (LPSTR)csA.lpszClass );
255 /***********************************************************************
258 static LRESULT call_hook( HOOKPROC proc, INT id, INT code, WPARAM wparam, LPARAM lparam,
259 BOOL prev_unicode, BOOL next_unicode )
264 DPRINTF( "%04lx:Call hook proc %p (id=%s,code=%x,wp=%08x,lp=%08lx)\n",
265 GetCurrentThreadId(), proc, hook_names[id-WH_MINHOOK], code, wparam, lparam );
267 if (!prev_unicode == !next_unicode) ret = proc( code, wparam, lparam );
268 else if (prev_unicode) ret = call_hook_WtoA( proc, id, code, wparam, lparam );
269 else ret = call_hook_AtoW( proc, id, code, wparam, lparam );
272 DPRINTF( "%04lx:Ret hook proc %p (id=%s,code=%x,wp=%08x,lp=%08lx) retval=%08lx\n",
273 GetCurrentThreadId(), proc, hook_names[id-WH_MINHOOK], code, wparam, lparam, ret );
279 /***********************************************************************
282 * Retrieve the hook procedure real value for a module-relative proc
284 static HOOKPROC get_hook_proc( HOOKPROC proc, const WCHAR *module )
288 if (!(mod = GetModuleHandleW(module)))
290 TRACE( "loading %s\n", debugstr_w(module) );
291 /* FIXME: the library will never be freed */
292 if (!(mod = LoadLibraryW(module))) return NULL;
294 return (HOOKPROC)((char *)mod + (ULONG_PTR)proc);
298 /***********************************************************************
301 LRESULT HOOK_CallHooks( INT id, INT code, WPARAM wparam, LPARAM lparam, BOOL unicode )
303 MESSAGEQUEUE *queue = QUEUE_Current();
304 HOOKPROC proc = NULL;
306 DWORD pid = 0, tid = 0;
307 WCHAR module[MAX_PATH];
308 BOOL unicode_hook = FALSE;
311 if (!queue) return 0;
312 SERVER_START_REQ( start_hook_chain )
315 wine_server_set_reply( req, module, sizeof(module)-sizeof(WCHAR) );
316 if (!wine_server_call( req ))
318 module[wine_server_reply_size(req) / sizeof(WCHAR)] = 0;
319 handle = reply->handle;
323 unicode_hook = reply->unicode;
330 TRACE( "calling hook in thread %04lx %s code %x wp %x lp %lx\n",
331 tid, hook_names[id-WH_MINHOOK], code, wparam, lparam );
336 MSG_SendInternalMessageTimeout( pid, tid, WM_WINE_KEYBOARD_LL_HOOK, wparam, lparam,
337 SMTO_ABORTIFHUNG, get_ll_hook_timeout(), &ret );
340 MSG_SendInternalMessageTimeout( pid, tid, WM_WINE_MOUSE_LL_HOOK, wparam, lparam,
341 SMTO_ABORTIFHUNG, get_ll_hook_timeout(), &ret );
347 TRACE( "calling hook %p %s code %x wp %x lp %lx module %s\n",
348 proc, hook_names[id-WH_MINHOOK], code, wparam, lparam, debugstr_w(module) );
350 if (!module[0] || (proc = get_hook_proc( proc, module )) != NULL)
352 int locks = WIN_SuspendWndsLock();
353 HHOOK prev = queue->hook;
354 queue->hook = handle;
355 ret = call_hook( proc, id, code, wparam, lparam, unicode, unicode_hook );
357 WIN_RestoreWndsLock( locks );
363 SERVER_START_REQ( finish_hook_chain )
366 wine_server_call( req );
373 /***********************************************************************
376 BOOL HOOK_IsHooked( INT id )
378 return TRUE; /* FIXME */
382 /***********************************************************************
383 * SetWindowsHookA (USER32.@)
385 HHOOK WINAPI SetWindowsHookA( INT id, HOOKPROC proc )
387 return SetWindowsHookExA( id, proc, 0, GetCurrentThreadId() );
391 /***********************************************************************
392 * SetWindowsHookW (USER32.@)
394 HHOOK WINAPI SetWindowsHookW( INT id, HOOKPROC proc )
396 return SetWindowsHookExW( id, proc, 0, GetCurrentThreadId() );
400 /***********************************************************************
401 * SetWindowsHookExA (USER32.@)
403 HHOOK WINAPI SetWindowsHookExA( INT id, HOOKPROC proc, HINSTANCE inst, DWORD tid )
405 return set_windows_hook( id, proc, inst, tid, FALSE );
408 /***********************************************************************
409 * SetWindowsHookExW (USER32.@)
411 HHOOK WINAPI SetWindowsHookExW( INT id, HOOKPROC proc, HINSTANCE inst, DWORD tid )
413 return set_windows_hook( id, proc, inst, tid, TRUE );
417 /***********************************************************************
418 * UnhookWindowsHook (USER32.@)
420 BOOL WINAPI UnhookWindowsHook( INT id, HOOKPROC proc )
424 TRACE( "%s %p\n", hook_names[id-WH_MINHOOK], proc );
426 SERVER_START_REQ( remove_hook )
431 ret = !wine_server_call_err( req );
439 /***********************************************************************
440 * UnhookWindowsHookEx (USER32.@)
442 BOOL WINAPI UnhookWindowsHookEx( HHOOK hhook )
446 TRACE( "%p\n", hhook );
448 SERVER_START_REQ( remove_hook )
451 ret = !wine_server_call_err( req );
458 /***********************************************************************
459 * CallNextHookEx (USER32.@)
461 LRESULT WINAPI CallNextHookEx( HHOOK hhook, INT code, WPARAM wparam, LPARAM lparam )
463 MESSAGEQUEUE *queue = QUEUE_Current();
464 HOOKPROC proc = NULL;
465 WCHAR module[MAX_PATH];
467 DWORD pid = 0, tid = 0;
469 BOOL prev_unicode = FALSE, next_unicode = FALSE;
472 if (!queue) return 0;
474 SERVER_START_REQ( get_next_hook )
476 req->handle = queue->hook;
477 wine_server_set_reply( req, module, sizeof(module)-sizeof(WCHAR) );
478 if (!wine_server_call_err( req ))
480 module[wine_server_reply_size(req) / sizeof(WCHAR)] = 0;
481 handle = reply->next;
486 prev_unicode = reply->prev_unicode;
487 next_unicode = reply->next_unicode;
494 TRACE( "calling hook in thread %04lx %s code %x wp %x lp %lx\n",
495 tid, hook_names[id-WH_MINHOOK], code, wparam, lparam );
500 MSG_SendInternalMessageTimeout( pid, tid, WM_WINE_KEYBOARD_LL_HOOK, wparam, lparam,
501 SMTO_ABORTIFHUNG, get_ll_hook_timeout(), &ret );
504 MSG_SendInternalMessageTimeout( pid, tid, WM_WINE_MOUSE_LL_HOOK, wparam, lparam,
505 SMTO_ABORTIFHUNG, get_ll_hook_timeout(), &ret );
511 TRACE( "calling hook %p %s code %x wp %x lp %lx module %s\n",
512 proc, hook_names[id-WH_MINHOOK], code, wparam, lparam, debugstr_w(module) );
514 if (!module[0] || (proc = get_hook_proc( proc, module )) != NULL)
516 HHOOK prev = queue->hook;
517 queue->hook = handle;
518 ret = call_hook( proc, id, code, wparam, lparam, prev_unicode, next_unicode );
526 /***********************************************************************
527 * CallMsgFilterA (USER32.@)
529 BOOL WINAPI CallMsgFilterA( LPMSG msg, INT code )
531 if (HOOK_CallHooks( WH_SYSMSGFILTER, code, 0, (LPARAM)msg, FALSE )) return TRUE;
532 return HOOK_CallHooks( WH_MSGFILTER, code, 0, (LPARAM)msg, FALSE );
536 /***********************************************************************
537 * CallMsgFilterW (USER32.@)
539 BOOL WINAPI CallMsgFilterW( LPMSG msg, INT code )
541 if (HOOK_CallHooks( WH_SYSMSGFILTER, code, 0, (LPARAM)msg, TRUE )) return TRUE;
542 return HOOK_CallHooks( WH_MSGFILTER, code, 0, (LPARAM)msg, TRUE );
546 /***********************************************************************
547 * SetWinEventHook [USER32.@]
549 * Set up an event hook for a set of events.
552 * dwMin [I] Lowest event handled by pfnProc
553 * dwMax [I] Highest event handled by pfnProc
554 * hModule [I] DLL containing pfnProc
555 * pfnProc [I] Callback event hook function
556 * dwProcess [I] Process to get events from, or 0 for all processes
557 * dwThread [I] Thread to get events from, or 0 for all threads
558 * dwFlags [I] Flags indicating the status of pfnProc
561 * Success: A handle representing the hook.
562 * Failure: A NULL handle.
567 HWINEVENTHOOK WINAPI SetWinEventHook(DWORD dwMin, DWORD dwMax, HMODULE hModule,
568 WINEVENTPROC pfnProc, DWORD dwProcess,
569 DWORD dwThread, DWORD dwFlags)
571 FIXME("(%ld,%ld,%p,%p,%ld,%ld,0x%08lx)-stub!\n", dwMin, dwMax, hModule,
572 pfnProc, dwProcess, dwThread, dwFlags);
577 /***********************************************************************
578 * UnhookWinEvent [USER32.@]
580 * Remove an event hook for a set of events.
583 * hEventHook [I] Event hook to remove
586 * Success: TRUE. The event hook has been removed.
587 * Failure: FALSE, if hEventHook is invalid.
592 BOOL WINAPI UnhookWinEvent(HWINEVENTHOOK hEventHook)
594 FIXME("(%p)-stub!\n", hEventHook);
596 return (hEventHook != 0);
600 /***********************************************************************
601 * NotifyWinEvent [USER32.@]
603 * Inform the OS that an event has occurred.
606 * dwEvent [I] Id of the event
607 * hWnd [I] Window holding the object that created the event
608 * nId [I] Type of object that created the event
609 * nChildId [I] Child object of nId, or CHILDID_SELF.
617 void WINAPI NotifyWinEvent(DWORD dwEvent, HWND hWnd, LONG nId, LONG nChildId)
619 FIXME("(%ld,%p,%ld,%ld)-stub!\n", dwEvent, hWnd, nId, nChildId);
623 /***********************************************************************
624 * IsWinEventHookInstalled [USER32.@]
626 * Determine if an event hook is installed for an event.
629 * dwEvent [I] Id of the event
632 * TRUE, If there are any hooks installed for the event.
638 BOOL WINAPI IsWinEventHookInstalled(DWORD dwEvent)
640 FIXME("(%ld)-stub!\n", dwEvent);