2 * ReactOS W32 Subsystem
3 * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003 ReactOS Team
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * COPYRIGHT: See COPYING in the top level directory
22 * PROJECT: ReactOS kernel
23 * PURPOSE: Window hooks
24 * FILE: subsys/win32k/ntuser/hook.c
25 * PROGRAMER: Casper S. Hornstrup (chorns@users.sourceforge.net)
27 * 06-06-2001 CSH Created
28 * NOTE: Most of this code was adapted from Wine,
29 * Copyright (C) 2002 Alexandre Julliard
35 #include <win32k/debug1.h>
37 #define HOOKID_TO_INDEX(HookId) (HookId - WH_MINHOOK)
39 STATIC PHOOKTABLE GlobalHooks
;
41 /* create a new hook table */
42 STATIC FASTCALL PHOOKTABLE
43 IntAllocHookTable(void)
48 Table
= ExAllocatePoolWithTag(PagedPool
, sizeof(HOOKTABLE
), TAG_HOOK
);
51 ExInitializeFastMutex(&Table
->Lock
);
52 for (i
= 0; i
< NB_HOOKS
; i
++)
54 InitializeListHead(&Table
->Hooks
[i
]);
62 /* create a new hook and add it to the specified table */
64 IntAddHook(PETHREAD Thread
, int HookId
, BOOLEAN Global
, PWINSTATION_OBJECT WinStaObj
)
67 PHOOKTABLE Table
= Global
? GlobalHooks
: MsqGetHooks(Thread
->Tcb
.Win32Thread
->MessageQueue
);
72 Table
= IntAllocHookTable();
83 MsqSetHooks(Thread
->Tcb
.Win32Thread
->MessageQueue
, Table
);
87 Hook
= ObmCreateObject(WinStaObj
->HandleTable
, &Handle
,
88 otHookProc
, sizeof(HOOK
));
95 Hook
->Thread
= Thread
;
96 Hook
->HookId
= HookId
;
97 RtlInitUnicodeString(&Hook
->ModuleName
, NULL
);
99 IntLockHookTable(Table
);
100 InsertHeadList(&Table
->Hooks
[HOOKID_TO_INDEX(HookId
)], &Hook
->Chain
);
101 IntUnLockHookTable(Table
);
106 /* get the hook table that a given hook belongs to */
107 STATIC PHOOKTABLE FASTCALL
108 IntGetTable(PHOOK Hook
)
110 if (NULL
== Hook
->Thread
|| WH_KEYBOARD_LL
== Hook
->HookId
||
111 WH_MOUSE_LL
== Hook
->HookId
)
116 return MsqGetHooks(Hook
->Thread
->Tcb
.Win32Thread
->MessageQueue
);
119 /* get the first hook in the chain */
120 STATIC PHOOK FASTCALL
121 IntGetFirstHook(PHOOKTABLE Table
, int HookId
)
123 PLIST_ENTRY Elem
= Table
->Hooks
[HOOKID_TO_INDEX(HookId
)].Flink
;
124 return Elem
== &Table
->Hooks
[HOOKID_TO_INDEX(HookId
)]
125 ? NULL
: CONTAINING_RECORD(Elem
, HOOK
, Chain
);
128 /* find the first non-deleted hook in the chain */
129 STATIC PHOOK FASTCALL
130 IntGetFirstValidHook(PHOOKTABLE Table
, int HookId
)
135 IntLockHookTable(Table
);
136 Hook
= IntGetFirstHook(Table
, HookId
);
137 while (NULL
!= Hook
&& NULL
== Hook
->Proc
)
139 Elem
= Hook
->Chain
.Flink
;
140 Hook
= (Elem
== &Table
->Hooks
[HOOKID_TO_INDEX(HookId
)]
141 ? NULL
: CONTAINING_RECORD(Elem
, HOOK
, Chain
));
143 IntUnLockHookTable(Table
);
148 /* find the next hook in the chain, skipping the deleted ones */
149 STATIC PHOOK FASTCALL
150 IntGetNextHook(PHOOK Hook
)
152 PHOOKTABLE Table
= IntGetTable(Hook
);
153 int HookId
= Hook
->HookId
;
156 IntLockHookTable(Table
);
157 Elem
= Hook
->Chain
.Flink
;
158 while (Elem
!= &Table
->Hooks
[HOOKID_TO_INDEX(HookId
)])
160 Hook
= CONTAINING_RECORD(Elem
, HOOK
, Chain
);
161 if (NULL
!= Hook
->Proc
)
163 IntUnLockHookTable(Table
);
167 IntUnLockHookTable(Table
);
169 if (NULL
!= GlobalHooks
&& Table
!= GlobalHooks
) /* now search through the global table */
171 return IntGetFirstValidHook(GlobalHooks
, HookId
);
177 /* free a hook, removing it from its chain */
179 IntFreeHook(PHOOKTABLE Table
, PHOOK Hook
, PWINSTATION_OBJECT WinStaObj
)
181 RemoveEntryList(&Hook
->Chain
);
182 RtlFreeUnicodeString(&Hook
->ModuleName
);
184 /* Dereference thread if required */
185 if (Hook
->Flags
& HOOK_THREAD_REFERENCED
)
187 ObDereferenceObject(Hook
->Thread
);
191 ObmCloseHandle(WinStaObj
->HandleTable
, Hook
->Self
);
194 /* remove a hook, freeing it if the chain is not in use */
196 IntRemoveHook(PHOOK Hook
, PWINSTATION_OBJECT WinStaObj
, BOOL TableAlreadyLocked
)
198 PHOOKTABLE Table
= IntGetTable(Hook
);
200 ASSERT(NULL
!= Table
);
206 if (! TableAlreadyLocked
)
208 IntLockHookTable(Table
);
210 if (0 != Table
->Counts
[HOOKID_TO_INDEX(Hook
->HookId
)])
212 Hook
->Proc
= NULL
; /* chain is in use, just mark it and return */
216 IntFreeHook(Table
, Hook
, WinStaObj
);
218 if (! TableAlreadyLocked
)
220 IntUnLockHookTable(Table
);
224 /* release a hook chain, removing deleted hooks if the use count drops to 0 */
226 IntReleaseHookChain(PHOOKTABLE Table
, int HookId
, PWINSTATION_OBJECT WinStaObj
)
236 IntLockHookTable(Table
);
237 /* use count shouldn't already be 0 */
238 ASSERT(0 != Table
->Counts
[HOOKID_TO_INDEX(HookId
)]);
239 if (0 == Table
->Counts
[HOOKID_TO_INDEX(HookId
)])
241 IntUnLockHookTable(Table
);
244 if (0 == --Table
->Counts
[HOOKID_TO_INDEX(HookId
)])
246 Elem
= Table
->Hooks
[HOOKID_TO_INDEX(HookId
)].Flink
;
247 while (Elem
!= &Table
->Hooks
[HOOKID_TO_INDEX(HookId
)])
249 HookObj
= CONTAINING_RECORD(Elem
, HOOK
, Chain
);
251 if (NULL
== HookObj
->Proc
)
253 IntFreeHook(Table
, HookObj
, WinStaObj
);
257 IntUnLockHookTable(Table
);
260 static LRESULT FASTCALL
261 IntCallLowLevelHook(INT HookId
, INT Code
, WPARAM wParam
, LPARAM lParam
, PHOOK Hook
)
266 /* FIXME should get timeout from
267 * HKEY_CURRENT_USER\Control Panel\Desktop\LowLevelHooksTimeout */
268 Status
= MsqSendMessage(Hook
->Thread
->Tcb
.Win32Thread
->MessageQueue
, (HWND
) Code
, HookId
,
269 wParam
, lParam
, 5000, TRUE
, TRUE
, &uResult
);
271 return NT_SUCCESS(Status
) ? uResult
: 0;
275 HOOK_CallHooks(INT HookId
, INT Code
, WPARAM wParam
, LPARAM lParam
)
278 PW32THREAD Win32Thread
;
281 PWINSTATION_OBJECT WinStaObj
;
284 ASSERT(WH_MINHOOK
<= HookId
&& HookId
<= WH_MAXHOOK
);
286 Win32Thread
= PsGetWin32Thread();
287 if (NULL
== Win32Thread
)
293 Table
= MsqGetHooks(Win32Thread
->MessageQueue
);
296 if (NULL
== Table
|| ! (Hook
= IntGetFirstValidHook(Table
, HookId
)))
298 /* try global table */
300 if (NULL
== Table
|| ! (Hook
= IntGetFirstValidHook(Table
, HookId
)))
302 return 0; /* no hook set */
306 if (Hook
->Thread
!= PsGetCurrentThread()
307 && (WH_KEYBOARD_LL
== HookId
|| WH_MOUSE_LL
== HookId
))
309 DPRINT("Calling hook in owning thread\n");
310 return IntCallLowLevelHook(HookId
, Code
, wParam
, lParam
, Hook
);
313 if (Hook
->Thread
!= PsGetCurrentThread())
315 DPRINT1("Calling hooks in other threads not implemented yet");
319 IntLockHookTable(Table
);
320 Table
->Counts
[HOOKID_TO_INDEX(HookId
)]++;
321 IntUnLockHookTable(Table
);
322 if (Table
!= GlobalHooks
&& GlobalHooks
!= NULL
)
324 IntLockHookTable(GlobalHooks
);
325 GlobalHooks
->Counts
[HOOKID_TO_INDEX(HookId
)]++;
326 IntUnLockHookTable(GlobalHooks
);
329 Result
= IntCallHookProc(HookId
, Code
, wParam
, lParam
, Hook
->Proc
,
330 Hook
->Ansi
, &Hook
->ModuleName
);
332 Status
= IntValidateWindowStationHandle(PsGetCurrentProcess()->Win32WindowStation
,
337 if (! NT_SUCCESS(Status
))
339 DPRINT1("Invalid window station????\n");
343 IntReleaseHookChain(MsqGetHooks(PsGetWin32Thread()->MessageQueue
), HookId
, WinStaObj
);
344 IntReleaseHookChain(GlobalHooks
, HookId
, WinStaObj
);
345 ObDereferenceObject(WinStaObj
);
352 HOOK_DestroyThreadHooks(PETHREAD Thread
)
357 PWINSTATION_OBJECT WinStaObj
;
360 if (NULL
!= GlobalHooks
)
362 Status
= IntValidateWindowStationHandle(PsGetCurrentProcess()->Win32WindowStation
,
367 if (! NT_SUCCESS(Status
))
369 DPRINT1("Invalid window station????\n");
372 IntLockHookTable(GlobalHooks
);
373 for (HookId
= WH_MINHOOK
; HookId
<= WH_MAXHOOK
; HookId
++)
375 /* only low-level keyboard/mouse global hooks can be owned by a thread */
380 Elem
= GlobalHooks
->Hooks
[HOOKID_TO_INDEX(HookId
)].Flink
;
381 while (Elem
!= &GlobalHooks
->Hooks
[HOOKID_TO_INDEX(HookId
)])
383 HookObj
= CONTAINING_RECORD(Elem
, HOOK
, Chain
);
385 if (HookObj
->Thread
== Thread
)
387 IntRemoveHook(HookObj
, WinStaObj
, TRUE
);
393 IntUnLockHookTable(GlobalHooks
);
394 ObDereferenceObject(WinStaObj
);
400 NtUserCallNextHookEx(
406 PHOOK HookObj
, NextObj
;
407 PWINSTATION_OBJECT WinStaObj
;
410 Status
= IntValidateWindowStationHandle(PsGetCurrentProcess()->Win32WindowStation
,
415 if (! NT_SUCCESS(Status
))
417 SetLastNtError(Status
);
421 Status
= ObmReferenceObjectByHandle(WinStaObj
->HandleTable
, Hook
,
422 otHookProc
, (PVOID
*) &HookObj
);
423 ObDereferenceObject(WinStaObj
);
424 if (! NT_SUCCESS(Status
))
426 DPRINT1("Invalid handle passed to NtUserCallNextHookEx\n");
427 SetLastNtError(Status
);
430 ASSERT(Hook
== HookObj
->Self
);
432 if (NULL
!= HookObj
->Thread
&& (HookObj
->Thread
!= PsGetCurrentThread()))
434 DPRINT1("Thread mismatch\n");
435 ObmDereferenceObject(HookObj
);
436 SetLastWin32Error(ERROR_INVALID_HANDLE
);
440 NextObj
= IntGetNextHook(HookObj
);
441 ObmDereferenceObject(HookObj
);
444 DPRINT1("Calling next hook not implemented\n");
446 SetLastWin32Error(ERROR_NOT_SUPPORTED
);
455 NtUserSetWindowsHookAW(
467 NtUserSetWindowsHookEx(
469 PUNICODE_STRING UnsafeModuleName
,
475 PWINSTATION_OBJECT WinStaObj
;
479 UNICODE_STRING ModuleName
;
483 if (HookId
< WH_MINHOOK
|| WH_MAXHOOK
< HookId
|| NULL
== HookProc
)
485 SetLastWin32Error(ERROR_INVALID_PARAMETER
);
489 if (ThreadId
) /* thread-local hook */
491 if (HookId
== WH_JOURNALRECORD
||
492 HookId
== WH_JOURNALPLAYBACK
||
493 HookId
== WH_KEYBOARD_LL
||
494 HookId
== WH_MOUSE_LL
||
495 HookId
== WH_SYSMSGFILTER
)
497 /* these can only be global */
498 SetLastWin32Error(ERROR_INVALID_PARAMETER
);
503 if (! NT_SUCCESS(PsLookupThreadByThreadId((HANDLE
) ThreadId
, &Thread
)))
505 DPRINT1("Invalid thread id 0x%x\n", ThreadId
);
506 SetLastWin32Error(ERROR_INVALID_PARAMETER
);
509 if (Thread
->ThreadsProcess
!= PsGetCurrentProcess())
511 ObDereferenceObject(Thread
);
512 DPRINT1("Can't specify thread belonging to another process\n");
513 SetLastWin32Error(ERROR_INVALID_PARAMETER
);
517 else /* system-global hook */
519 if (HookId
== WH_KEYBOARD_LL
|| HookId
== WH_MOUSE_LL
)
522 Thread
= PsGetCurrentThread();
523 Status
= ObReferenceObjectByPointer(Thread
,
528 if (! NT_SUCCESS(Status
))
530 SetLastNtError(Status
);
531 return (HANDLE
) NULL
;
534 else if (NULL
== Mod
)
536 SetLastWin32Error(ERROR_INVALID_PARAMETER
);
546 /* We only (partially) support local WH_CBT hooks and
547 * WH_KEYBOARD_LL/WH_MOUSE_LL hooks for now */
548 if ((WH_CBT
!= HookId
|| Global
)
549 && WH_KEYBOARD_LL
!= HookId
&& WH_MOUSE_LL
!= HookId
)
551 #if 0 /* Removed to get winEmbed working again */
554 DPRINT1("Not implemented: HookId %d Global %s\n", HookId
, Global
? "TRUE" : "FALSE");
558 ObDereferenceObject(Thread
);
560 SetLastWin32Error(ERROR_NOT_SUPPORTED
);
564 Status
= IntValidateWindowStationHandle(PsGetCurrentProcess()->Win32WindowStation
,
569 if (! NT_SUCCESS(Status
))
573 ObDereferenceObject(Thread
);
575 SetLastNtError(Status
);
576 return (HANDLE
) NULL
;
579 Hook
= IntAddHook(Thread
, HookId
, Global
, WinStaObj
);
584 ObDereferenceObject(Thread
);
586 ObDereferenceObject(WinStaObj
);
592 Hook
->Flags
|= HOOK_THREAD_REFERENCED
;
597 Status
= MmCopyFromCaller(&ModuleName
, UnsafeModuleName
, sizeof(UNICODE_STRING
));
598 if (! NT_SUCCESS(Status
))
600 ObmDereferenceObject(Hook
);
601 IntRemoveHook(Hook
, WinStaObj
, FALSE
);
604 ObDereferenceObject(Thread
);
606 ObDereferenceObject(WinStaObj
);
607 SetLastNtError(Status
);
610 Hook
->ModuleName
.Buffer
= ExAllocatePoolWithTag(PagedPool
,
611 ModuleName
.MaximumLength
,
613 if (NULL
== Hook
->ModuleName
.Buffer
)
615 ObmDereferenceObject(Hook
);
616 IntRemoveHook(Hook
, WinStaObj
, FALSE
);
619 ObDereferenceObject(Thread
);
621 ObDereferenceObject(WinStaObj
);
622 SetLastWin32Error(ERROR_NOT_ENOUGH_MEMORY
);
625 Hook
->ModuleName
.MaximumLength
= ModuleName
.MaximumLength
;
626 Status
= MmCopyFromCaller(Hook
->ModuleName
.Buffer
,
628 ModuleName
.MaximumLength
);
629 if (! NT_SUCCESS(Status
))
631 ObmDereferenceObject(Hook
);
632 IntRemoveHook(Hook
, WinStaObj
, FALSE
);
635 ObDereferenceObject(Thread
);
637 ObDereferenceObject(WinStaObj
);
638 SetLastNtError(Status
);
641 Hook
->ModuleName
.Length
= ModuleName
.Length
;
644 Hook
->Proc
= HookProc
;
648 ObmDereferenceObject(Hook
);
649 ObDereferenceObject(WinStaObj
);
656 NtUserSetWinEventHook(
673 NtUserUnhookWindowsHookEx(
676 PWINSTATION_OBJECT WinStaObj
;
680 Status
= IntValidateWindowStationHandle(PsGetCurrentProcess()->Win32WindowStation
,
685 if (! NT_SUCCESS(Status
))
687 SetLastNtError(Status
);
691 Status
= ObmReferenceObjectByHandle(WinStaObj
->HandleTable
, Hook
,
692 otHookProc
, (PVOID
*) &HookObj
);
693 if (! NT_SUCCESS(Status
))
695 DPRINT1("Invalid handle passed to NtUserUnhookWindowsHookEx\n");
696 ObDereferenceObject(WinStaObj
);
697 SetLastNtError(Status
);
700 ASSERT(Hook
== HookObj
->Self
);
702 IntRemoveHook(HookObj
, WinStaObj
, FALSE
);
704 ObmDereferenceObject(HookObj
);
705 ObDereferenceObject(WinStaObj
);
712 NtUserUnhookWinEvent(