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
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 for (i
= 0; i
< NB_HOOKS
; i
++)
53 InitializeListHead(&Table
->Hooks
[i
]);
61 /* create a new hook and add it to the specified table */
63 IntAddHook(PETHREAD Thread
, int HookId
, BOOLEAN Global
, PWINSTATION_OBJECT WinStaObj
)
66 PHOOKTABLE Table
= Global
? GlobalHooks
: MsqGetHooks(Thread
->Tcb
.Win32Thread
->MessageQueue
);
71 Table
= IntAllocHookTable();
82 MsqSetHooks(Thread
->Tcb
.Win32Thread
->MessageQueue
, Table
);
86 Hook
= ObmCreateObject(WinStaObj
->HandleTable
, &Handle
,
87 otHookProc
, sizeof(HOOK
));
94 Hook
->Thread
= Thread
;
95 Hook
->HookId
= HookId
;
96 RtlInitUnicodeString(&Hook
->ModuleName
, NULL
);
98 InsertHeadList(&Table
->Hooks
[HOOKID_TO_INDEX(HookId
)], &Hook
->Chain
);
103 /* get the hook table that a given hook belongs to */
104 STATIC PHOOKTABLE FASTCALL
105 IntGetTable(PHOOK Hook
)
107 if (NULL
== Hook
->Thread
|| WH_KEYBOARD_LL
== Hook
->HookId
||
108 WH_MOUSE_LL
== Hook
->HookId
)
113 return MsqGetHooks(Hook
->Thread
->Tcb
.Win32Thread
->MessageQueue
);
116 /* get the first hook in the chain */
117 STATIC PHOOK FASTCALL
118 IntGetFirstHook(PHOOKTABLE Table
, int HookId
)
120 PLIST_ENTRY Elem
= Table
->Hooks
[HOOKID_TO_INDEX(HookId
)].Flink
;
121 return Elem
== &Table
->Hooks
[HOOKID_TO_INDEX(HookId
)]
122 ? NULL
: CONTAINING_RECORD(Elem
, HOOK
, Chain
);
125 /* find the first non-deleted hook in the chain */
126 STATIC PHOOK FASTCALL
127 IntGetFirstValidHook(PHOOKTABLE Table
, int HookId
)
132 Hook
= IntGetFirstHook(Table
, HookId
);
133 while (NULL
!= Hook
&& NULL
== Hook
->Proc
)
135 Elem
= Hook
->Chain
.Flink
;
136 Hook
= (Elem
== &Table
->Hooks
[HOOKID_TO_INDEX(HookId
)]
137 ? NULL
: CONTAINING_RECORD(Elem
, HOOK
, Chain
));
143 /* find the next hook in the chain, skipping the deleted ones */
144 STATIC PHOOK FASTCALL
145 IntGetNextHook(PHOOK Hook
)
147 PHOOKTABLE Table
= IntGetTable(Hook
);
148 int HookId
= Hook
->HookId
;
151 Elem
= Hook
->Chain
.Flink
;
152 while (Elem
!= &Table
->Hooks
[HOOKID_TO_INDEX(HookId
)])
154 Hook
= CONTAINING_RECORD(Elem
, HOOK
, Chain
);
155 if (NULL
!= Hook
->Proc
)
161 if (NULL
!= GlobalHooks
&& Table
!= GlobalHooks
) /* now search through the global table */
163 return IntGetFirstValidHook(GlobalHooks
, HookId
);
169 /* free a hook, removing it from its chain */
171 IntFreeHook(PHOOKTABLE Table
, PHOOK Hook
, PWINSTATION_OBJECT WinStaObj
)
173 RemoveEntryList(&Hook
->Chain
);
174 RtlFreeUnicodeString(&Hook
->ModuleName
);
176 /* Dereference thread if required */
177 if (Hook
->Flags
& HOOK_THREAD_REFERENCED
)
179 ObDereferenceObject(Hook
->Thread
);
183 ObmCloseHandle(WinStaObj
->HandleTable
, Hook
->Self
);
186 /* remove a hook, freeing it if the chain is not in use */
188 IntRemoveHook(PHOOK Hook
, PWINSTATION_OBJECT WinStaObj
, BOOL TableAlreadyLocked
)
190 PHOOKTABLE Table
= IntGetTable(Hook
);
192 ASSERT(NULL
!= Table
);
198 if (0 != Table
->Counts
[HOOKID_TO_INDEX(Hook
->HookId
)])
200 Hook
->Proc
= NULL
; /* chain is in use, just mark it and return */
204 IntFreeHook(Table
, Hook
, WinStaObj
);
208 /* release a hook chain, removing deleted hooks if the use count drops to 0 */
210 IntReleaseHookChain(PHOOKTABLE Table
, int HookId
, PWINSTATION_OBJECT WinStaObj
)
220 /* use count shouldn't already be 0 */
221 ASSERT(0 != Table
->Counts
[HOOKID_TO_INDEX(HookId
)]);
222 if (0 == Table
->Counts
[HOOKID_TO_INDEX(HookId
)])
226 if (0 == --Table
->Counts
[HOOKID_TO_INDEX(HookId
)])
228 Elem
= Table
->Hooks
[HOOKID_TO_INDEX(HookId
)].Flink
;
229 while (Elem
!= &Table
->Hooks
[HOOKID_TO_INDEX(HookId
)])
231 HookObj
= CONTAINING_RECORD(Elem
, HOOK
, Chain
);
233 if (NULL
== HookObj
->Proc
)
235 IntFreeHook(Table
, HookObj
, WinStaObj
);
241 static LRESULT FASTCALL
242 IntCallLowLevelHook(INT HookId
, INT Code
, WPARAM wParam
, LPARAM lParam
, PHOOK Hook
)
247 /* FIXME should get timeout from
248 * HKEY_CURRENT_USER\Control Panel\Desktop\LowLevelHooksTimeout */
249 Status
= co_MsqSendMessage(Hook
->Thread
->Tcb
.Win32Thread
->MessageQueue
, (HWND
) Code
, HookId
,
250 wParam
, lParam
, 5000, TRUE
, TRUE
, &uResult
);
252 return NT_SUCCESS(Status
) ? uResult
: 0;
256 co_HOOK_CallHooks(INT HookId
, INT Code
, WPARAM wParam
, LPARAM lParam
)
259 PW32THREAD Win32Thread
;
262 PWINSTATION_OBJECT WinStaObj
;
265 ASSERT(WH_MINHOOK
<= HookId
&& HookId
<= WH_MAXHOOK
);
267 Win32Thread
= PsGetWin32Thread();
268 if (NULL
== Win32Thread
)
274 Table
= MsqGetHooks(Win32Thread
->MessageQueue
);
277 if (NULL
== Table
|| ! (Hook
= IntGetFirstValidHook(Table
, HookId
)))
279 /* try global table */
281 if (NULL
== Table
|| ! (Hook
= IntGetFirstValidHook(Table
, HookId
)))
283 return 0; /* no hook set */
287 if (Hook
->Thread
!= PsGetCurrentThread()
288 && (WH_KEYBOARD_LL
== HookId
|| WH_MOUSE_LL
== HookId
))
290 DPRINT("Calling hook in owning thread\n");
291 return IntCallLowLevelHook(HookId
, Code
, wParam
, lParam
, Hook
);
294 if (Hook
->Thread
!= PsGetCurrentThread())
296 DPRINT1("Calling hooks in other threads not implemented yet");
300 Table
->Counts
[HOOKID_TO_INDEX(HookId
)]++;
301 if (Table
!= GlobalHooks
&& GlobalHooks
!= NULL
)
303 GlobalHooks
->Counts
[HOOKID_TO_INDEX(HookId
)]++;
306 Result
= co_IntCallHookProc(HookId
, Code
, wParam
, lParam
, Hook
->Proc
,
307 Hook
->Ansi
, &Hook
->ModuleName
);
309 Status
= IntValidateWindowStationHandle(PsGetCurrentProcess()->Win32WindowStation
,
314 if (! NT_SUCCESS(Status
))
316 DPRINT1("Invalid window station????\n");
320 IntReleaseHookChain(MsqGetHooks(PsGetWin32Thread()->MessageQueue
), HookId
, WinStaObj
);
321 IntReleaseHookChain(GlobalHooks
, HookId
, WinStaObj
);
322 ObDereferenceObject(WinStaObj
);
329 HOOK_DestroyThreadHooks(PETHREAD Thread
)
334 PWINSTATION_OBJECT WinStaObj
;
337 if (NULL
!= GlobalHooks
)
339 Status
= IntValidateWindowStationHandle(PsGetCurrentProcess()->Win32WindowStation
,
344 if (! NT_SUCCESS(Status
))
346 DPRINT1("Invalid window station????\n");
350 for (HookId
= WH_MINHOOK
; HookId
<= WH_MAXHOOK
; HookId
++)
352 /* only low-level keyboard/mouse global hooks can be owned by a thread */
357 Elem
= GlobalHooks
->Hooks
[HOOKID_TO_INDEX(HookId
)].Flink
;
358 while (Elem
!= &GlobalHooks
->Hooks
[HOOKID_TO_INDEX(HookId
)])
360 HookObj
= CONTAINING_RECORD(Elem
, HOOK
, Chain
);
362 if (HookObj
->Thread
== Thread
)
364 IntRemoveHook(HookObj
, WinStaObj
, TRUE
);
371 ObDereferenceObject(WinStaObj
);
377 NtUserCallNextHookEx(
383 PHOOK HookObj
, NextObj
;
384 PWINSTATION_OBJECT WinStaObj
;
386 DECLARE_RETURN(LRESULT
);
388 DPRINT("Enter NtUserCallNextHookEx\n");
389 UserEnterExclusive();
391 Status
= IntValidateWindowStationHandle(PsGetCurrentProcess()->Win32WindowStation
,
396 if (! NT_SUCCESS(Status
))
398 SetLastNtError(Status
);
402 Status
= ObmReferenceObjectByHandle(WinStaObj
->HandleTable
, Hook
,
403 otHookProc
, (PVOID
*) &HookObj
);
404 ObDereferenceObject(WinStaObj
);
405 if (! NT_SUCCESS(Status
))
407 DPRINT1("Invalid handle passed to NtUserCallNextHookEx\n");
408 SetLastNtError(Status
);
411 ASSERT(Hook
== HookObj
->Self
);
413 if (NULL
!= HookObj
->Thread
&& (HookObj
->Thread
!= PsGetCurrentThread()))
415 DPRINT1("Thread mismatch\n");
416 ObmDereferenceObject(HookObj
);
417 SetLastWin32Error(ERROR_INVALID_HANDLE
);
421 NextObj
= IntGetNextHook(HookObj
);
422 ObmDereferenceObject(HookObj
);
425 DPRINT1("Calling next hook not implemented\n");
427 SetLastWin32Error(ERROR_NOT_SUPPORTED
);
434 DPRINT("Leave NtUserCallNextHookEx, ret=%i\n",_ret_
);
441 NtUserSetWindowsHookAW(
453 NtUserSetWindowsHookEx(
455 PUNICODE_STRING UnsafeModuleName
,
461 PWINSTATION_OBJECT WinStaObj
;
465 UNICODE_STRING ModuleName
;
468 DECLARE_RETURN(HHOOK
);
470 DPRINT("Enter NtUserSetWindowsHookEx\n");
471 UserEnterExclusive();
473 if (HookId
< WH_MINHOOK
|| WH_MAXHOOK
< HookId
|| NULL
== HookProc
)
475 SetLastWin32Error(ERROR_INVALID_PARAMETER
);
479 if (ThreadId
) /* thread-local hook */
481 if (HookId
== WH_JOURNALRECORD
||
482 HookId
== WH_JOURNALPLAYBACK
||
483 HookId
== WH_KEYBOARD_LL
||
484 HookId
== WH_MOUSE_LL
||
485 HookId
== WH_SYSMSGFILTER
)
487 /* these can only be global */
488 SetLastWin32Error(ERROR_INVALID_PARAMETER
);
493 if (! NT_SUCCESS(PsLookupThreadByThreadId((HANDLE
) ThreadId
, &Thread
)))
495 DPRINT1("Invalid thread id 0x%x\n", ThreadId
);
496 SetLastWin32Error(ERROR_INVALID_PARAMETER
);
499 if (Thread
->ThreadsProcess
!= PsGetCurrentProcess())
501 ObDereferenceObject(Thread
);
502 DPRINT1("Can't specify thread belonging to another process\n");
503 SetLastWin32Error(ERROR_INVALID_PARAMETER
);
507 else /* system-global hook */
509 if (HookId
== WH_KEYBOARD_LL
|| HookId
== WH_MOUSE_LL
)
512 Thread
= PsGetCurrentThread();
513 Status
= ObReferenceObjectByPointer(Thread
,
518 if (! NT_SUCCESS(Status
))
520 SetLastNtError(Status
);
521 RETURN( (HANDLE
) NULL
);
524 else if (NULL
== Mod
)
526 SetLastWin32Error(ERROR_INVALID_PARAMETER
);
536 /* We only (partially) support local WH_CBT hooks and
537 * WH_KEYBOARD_LL/WH_MOUSE_LL hooks for now */
538 if ((WH_CBT
!= HookId
|| Global
)
539 && WH_KEYBOARD_LL
!= HookId
&& WH_MOUSE_LL
!= HookId
)
541 #if 0 /* Removed to get winEmbed working again */
544 DPRINT1("Not implemented: HookId %d Global %s\n", HookId
, Global
? "TRUE" : "FALSE");
548 ObDereferenceObject(Thread
);
550 SetLastWin32Error(ERROR_NOT_SUPPORTED
);
554 Status
= IntValidateWindowStationHandle(PsGetCurrentProcess()->Win32WindowStation
,
559 if (! NT_SUCCESS(Status
))
563 ObDereferenceObject(Thread
);
565 SetLastNtError(Status
);
566 RETURN( (HANDLE
) NULL
);
569 Hook
= IntAddHook(Thread
, HookId
, Global
, WinStaObj
);
574 ObDereferenceObject(Thread
);
576 ObDereferenceObject(WinStaObj
);
582 Hook
->Flags
|= HOOK_THREAD_REFERENCED
;
587 Status
= MmCopyFromCaller(&ModuleName
, UnsafeModuleName
, sizeof(UNICODE_STRING
));
588 if (! NT_SUCCESS(Status
))
590 ObmDereferenceObject(Hook
);
591 IntRemoveHook(Hook
, WinStaObj
, FALSE
);
594 ObDereferenceObject(Thread
);
596 ObDereferenceObject(WinStaObj
);
597 SetLastNtError(Status
);
600 Hook
->ModuleName
.Buffer
= ExAllocatePoolWithTag(PagedPool
,
601 ModuleName
.MaximumLength
,
603 if (NULL
== Hook
->ModuleName
.Buffer
)
605 ObmDereferenceObject(Hook
);
606 IntRemoveHook(Hook
, WinStaObj
, FALSE
);
609 ObDereferenceObject(Thread
);
611 ObDereferenceObject(WinStaObj
);
612 SetLastWin32Error(ERROR_NOT_ENOUGH_MEMORY
);
615 Hook
->ModuleName
.MaximumLength
= ModuleName
.MaximumLength
;
616 Status
= MmCopyFromCaller(Hook
->ModuleName
.Buffer
,
618 ModuleName
.MaximumLength
);
619 if (! NT_SUCCESS(Status
))
621 ObmDereferenceObject(Hook
);
622 IntRemoveHook(Hook
, WinStaObj
, FALSE
);
625 ObDereferenceObject(Thread
);
627 ObDereferenceObject(WinStaObj
);
628 SetLastNtError(Status
);
631 Hook
->ModuleName
.Length
= ModuleName
.Length
;
634 Hook
->Proc
= HookProc
;
638 ObmDereferenceObject(Hook
);
639 ObDereferenceObject(WinStaObj
);
644 DPRINT("Leave NtUserSetWindowsHookEx, ret=%i\n",_ret_
);
651 NtUserSetWinEventHook(
668 NtUserUnhookWindowsHookEx(
671 PWINSTATION_OBJECT WinStaObj
;
674 DECLARE_RETURN(BOOL
);
676 DPRINT("Enter NtUserUnhookWindowsHookEx\n");
677 UserEnterExclusive();
679 Status
= IntValidateWindowStationHandle(PsGetCurrentProcess()->Win32WindowStation
,
684 if (! NT_SUCCESS(Status
))
686 SetLastNtError(Status
);
690 Status
= ObmReferenceObjectByHandle(WinStaObj
->HandleTable
, Hook
,
691 otHookProc
, (PVOID
*) &HookObj
);
692 if (! NT_SUCCESS(Status
))
694 DPRINT1("Invalid handle passed to NtUserUnhookWindowsHookEx\n");
695 ObDereferenceObject(WinStaObj
);
696 SetLastNtError(Status
);
699 ASSERT(Hook
== HookObj
->Self
);
701 IntRemoveHook(HookObj
, WinStaObj
, FALSE
);
703 ObmDereferenceObject(HookObj
);
704 ObDereferenceObject(WinStaObj
);
709 DPRINT("Leave NtUserUnhookWindowsHookEx, ret=%i\n",_ret_
);
716 NtUserUnhookWinEvent(