reactos/win32ss/user/ntuser/input.c

   1 /*
   2  * COPYRIGHT:        See COPYING in the top level directory
   3  * PROJECT:          ReactOS Win32k subsystem
   4  * PURPOSE:          General input functions
   5  * FILE:             subsystems/win32/win32k/ntuser/input.c
   6  * PROGRAMERS:       Casper S. Hornstrup (chorns@users.sourceforge.net)
   7  *                   Rafal Harabien (rafalh@reactos.org)
   8  */
   9
  10 #include <win32k.h>
  11 DBG_DEFAULT_CHANNEL(UserInput);
  12
  13 /* GLOBALS *******************************************************************/
  14
  15 PTHREADINFO ptiRawInput;
  16 PTHREADINFO ptiKeyboard;
  17 PTHREADINFO ptiMouse;
  18 PKTIMER MasterTimer = NULL;
  19 PATTACHINFO gpai = NULL;
  20 INT paiCount = 0;
  21 HANDLE ghKeyboardDevice;
  22
  23 static DWORD LastInputTick = 0;
  24 static HANDLE ghMouseDevice;
  25
  26 /* FUNCTIONS *****************************************************************/
  27
  28 /*
  29  * IntLastInputTick
  30  *
  31  * Updates or gets last input tick count
  32  */
  33 static DWORD FASTCALL
  34 IntLastInputTick(BOOL bUpdate)
  35 {
  36     if (bUpdate)
  37     {
  38         LARGE_INTEGER TickCount;
  39         KeQueryTickCount(&TickCount);
  40         LastInputTick = MsqCalculateMessageTime(&TickCount);
  41         if (gpsi) gpsi->dwLastRITEventTickCount = LastInputTick;
  42     }
  43     return LastInputTick;
  44 }
  45
  46 /*
  47  * DoTheScreenSaver
  48  *
  49  * Check if scrensaver should be started and sends message to SAS window
  50  */
  51 VOID FASTCALL
  52 DoTheScreenSaver(VOID)
  53 {
  54     LARGE_INTEGER TickCount;
  55     DWORD Test, TO;
  56
  57     if (gspv.iScrSaverTimeout > 0) // Zero means Off.
  58     {
  59         KeQueryTickCount(&TickCount);
  60         Test = MsqCalculateMessageTime(&TickCount);
  61         Test = Test - LastInputTick;
  62         TO = 1000 * gspv.iScrSaverTimeout;
  63         if (Test > TO)
  64         {
  65             TRACE("Screensaver Message Start! Tick %d Timeout %d \n", Test, gspv.iScrSaverTimeout);
  66
  67             if (ppiScrnSaver) // We are or we are not the screensaver, prevent reentry...
  68             {
  69                 if (!(ppiScrnSaver->W32PF_flags & W32PF_IDLESCREENSAVER))
  70                 {
  71                     ppiScrnSaver->W32PF_flags |= W32PF_IDLESCREENSAVER;
  72                     ERR("Screensaver is Idle\n");
  73                 }
  74             }
  75             else
  76             {
  77                 PUSER_MESSAGE_QUEUE ForegroundQueue = IntGetFocusMessageQueue();
  78                 if (ForegroundQueue && ForegroundQueue->spwndActive)
  79                     UserPostMessage(hwndSAS, WM_LOGONNOTIFY, LN_START_SCREENSAVE, 1); // lParam 1 == Secure
  80                 else
  81                     UserPostMessage(hwndSAS, WM_LOGONNOTIFY, LN_START_SCREENSAVE, 0);
  82             }
  83         }
  84     }
  85 }
  86
  87 /*
  88  * OpenInputDevice
  89  *
  90  * Opens input device for asynchronous access
  91  */
  92 static
  93 NTSTATUS NTAPI
  94 OpenInputDevice(PHANDLE pHandle, PFILE_OBJECT *ppObject, CONST WCHAR *pszDeviceName)
  95 {
  96     UNICODE_STRING DeviceName;
  97     OBJECT_ATTRIBUTES ObjectAttributes;
  98     NTSTATUS Status;
  99     IO_STATUS_BLOCK Iosb;
 100
 101     RtlInitUnicodeString(&DeviceName, pszDeviceName);
 102
 103     InitializeObjectAttributes(&ObjectAttributes,
 104                                &DeviceName,
 105                                0,
 106                                NULL,
 107                                NULL);
 108
 109     Status = ZwOpenFile(pHandle,
 110                         FILE_ALL_ACCESS,
 111                         &ObjectAttributes,
 112                         &Iosb,
 113                         0,
 114                         0);
 115     if (NT_SUCCESS(Status) && ppObject)
 116     {
 117         Status = ObReferenceObjectByHandle(*pHandle, SYNCHRONIZE, NULL, KernelMode, (PVOID*)ppObject, NULL);
 118         ASSERT(NT_SUCCESS(Status));
 119     }
 120
 121     return Status;
 122 }
 123
 124 /*
 125  * RawInputThreadMain
 126  *
 127  * Reads data from input devices and supports win32 timers
 128  */
 129 VOID NTAPI
 130 RawInputThreadMain()
 131 {
 132     NTSTATUS MouStatus = STATUS_UNSUCCESSFUL, KbdStatus = STATUS_UNSUCCESSFUL, Status;
 133     IO_STATUS_BLOCK MouIosb, KbdIosb;
 134     PFILE_OBJECT pKbdDevice, pMouDevice;
 135     LARGE_INTEGER ByteOffset;
 136     //LARGE_INTEGER WaitTimeout;
 137     PVOID WaitObjects[3], pSignaledObject = NULL;
 138     ULONG cWaitObjects = 0, cMaxWaitObjects = 1;
 139     MOUSE_INPUT_DATA MouseInput;
 140     KEYBOARD_INPUT_DATA KeyInput;
 141
 142     ByteOffset.QuadPart = (LONGLONG)0;
 143     //WaitTimeout.QuadPart = (LONGLONG)(-10000000);
 144
 145     ptiRawInput = GetW32ThreadInfo();
 146     ptiRawInput->TIF_flags |= TIF_SYSTEMTHREAD;
 147     ptiRawInput->pClientInfo->dwTIFlags = ptiRawInput->TIF_flags;
 148
 149     TRACE("Raw Input Thread 0x%x\n", ptiRawInput);
 150
 151     KeSetPriorityThread(&PsGetCurrentThread()->Tcb,
 152                         LOW_REALTIME_PRIORITY + 3);
 153
 154     UserEnterExclusive();
 155     StartTheTimers();
 156     UserLeave();
 157
 158     for(;;)
 159     {
 160         if (!ghMouseDevice)
 161         {
 162             /* Check if mouse device already exists */
 163             Status = OpenInputDevice(&ghMouseDevice, &pMouDevice, L"\\Device\\PointerClass0" );
 164             if (NT_SUCCESS(Status))
 165             {
 166                 ++cMaxWaitObjects;
 167                 TRACE("Mouse connected!\n");
 168             }
 169         }
 170         if (!ghKeyboardDevice)
 171         {
 172             /* Check if keyboard device already exists */
 173             Status = OpenInputDevice(&ghKeyboardDevice, &pKbdDevice, L"\\Device\\KeyboardClass0");
 174             if (NT_SUCCESS(Status))
 175             {
 176                 ++cMaxWaitObjects;
 177                 TRACE("Keyboard connected!\n");
 178             }
 179         }
 180
 181         /* Reset WaitHandles array */
 182         cWaitObjects = 0;
 183         WaitObjects[cWaitObjects++] = MasterTimer;
 184
 185         if (ghMouseDevice)
 186         {
 187             /* Try to read from mouse if previous reading is not pending */
 188             if (MouStatus != STATUS_PENDING)
 189             {
 190                 MouStatus = ZwReadFile(ghMouseDevice,
 191                                        NULL,
 192                                        NULL,
 193                                        NULL,
 194                                        &MouIosb,
 195                                        &MouseInput,
 196                                        sizeof(MOUSE_INPUT_DATA),
 197                                        &ByteOffset,
 198                                        NULL);
 199             }
 200
 201             if (MouStatus == STATUS_PENDING)
 202                 WaitObjects[cWaitObjects++] = &pMouDevice->Event;
 203         }
 204
 205         if (ghKeyboardDevice)
 206         {
 207             /* Try to read from keyboard if previous reading is not pending */
 208             if (KbdStatus != STATUS_PENDING)
 209             {
 210                 KbdStatus = ZwReadFile(ghKeyboardDevice,
 211                                        NULL,
 212                                        NULL,
 213                                        NULL,
 214                                        &KbdIosb,
 215                                        &KeyInput,
 216                                        sizeof(KEYBOARD_INPUT_DATA),
 217                                        &ByteOffset,
 218                                        NULL);
 219
 220             }
 221             if (KbdStatus == STATUS_PENDING)
 222                 WaitObjects[cWaitObjects++] = &pKbdDevice->Event;
 223         }
 224
 225         /* If all objects are pending, wait for them */
 226         if (cWaitObjects == cMaxWaitObjects)
 227         {
 228             Status = KeWaitForMultipleObjects(cWaitObjects,
 229                                               WaitObjects,
 230                                               WaitAny,
 231                                               UserRequest,
 232                                               KernelMode,
 233                                               TRUE,
 234                                               NULL,//&WaitTimeout,
 235                                               NULL);
 236
 237             if ((Status >= STATUS_WAIT_0) &&
 238                 (Status < (STATUS_WAIT_0 + (LONG)cWaitObjects)))
 239             {
 240                 /* Some device has finished reading */
 241                 pSignaledObject = WaitObjects[Status - STATUS_WAIT_0];
 242
 243                 /* Check if it is mouse or keyboard and update status */
 244                 if (pSignaledObject == &pMouDevice->Event)
 245                     MouStatus = MouIosb.Status;
 246                 else if (pSignaledObject == &pKbdDevice->Event)
 247                     KbdStatus = KbdIosb.Status;
 248                 else if (pSignaledObject == MasterTimer)
 249                 {
 250                     ProcessTimers();
 251                 }
 252                 else ASSERT(FALSE);
 253             }
 254         }
 255
 256         /* Have we successed reading from mouse? */
 257         if (NT_SUCCESS(MouStatus) && MouStatus != STATUS_PENDING)
 258         {
 259             TRACE("MouseEvent\n");
 260
 261             /* Set LastInputTick */
 262             IntLastInputTick(TRUE);
 263
 264             /* Process data */
 265             UserEnterExclusive();
 266             UserProcessMouseInput(&MouseInput);
 267             UserLeave();
 268         }
 269         else if (MouStatus != STATUS_PENDING)
 270             ERR("Failed to read from mouse: %x.\n", MouStatus);
 271
 272         /* Have we successed reading from keyboard? */
 273         if (NT_SUCCESS(KbdStatus) && KbdStatus != STATUS_PENDING)
 274         {
 275             TRACE("KeyboardEvent: %s %04x\n",
 276                   (KeyInput.Flags & KEY_BREAK) ? "up" : "down",
 277                   KeyInput.MakeCode);
 278
 279             /* Set LastInputTick */
 280             IntLastInputTick(TRUE);
 281
 282             /* Process data */
 283             UserEnterExclusive();
 284             UserProcessKeyboardInput(&KeyInput);
 285             UserLeave();
 286         }
 287         else if (KbdStatus != STATUS_PENDING)
 288             ERR("Failed to read from keyboard: %x.\n", KbdStatus);
 289     }
 290     ERR("Raw Input Thread Exit!\n");
 291 }
 292
 293 /*
 294  * CreateSystemThreads
 295  *
 296  * Called form dedicated thread in CSRSS. RIT is started in context of this
 297  * thread because it needs valid Win32 process with TEB initialized
 298  */
 299 DWORD NTAPI
 300 CreateSystemThreads(UINT Type)
 301 {
 302     UserLeave();
 303
 304     switch (Type)
 305     {
 306         case 0: RawInputThreadMain(); break;
 307         default: ERR("Wrong type: %x\n", Type);
 308     }
 309
 310     UserEnterShared();
 311
 312     return 0;
 313 }
 314
 315 /*
 316  * InitInputImpl
 317  *
 318  * Inits input implementation
 319  */
 320 INIT_FUNCTION
 321 NTSTATUS
 322 NTAPI
 323 InitInputImpl(VOID)
 324 {
 325     MasterTimer = ExAllocatePoolWithTag(NonPagedPool, sizeof(KTIMER), USERTAG_SYSTEM);
 326     if (!MasterTimer)
 327     {
 328         ERR("Failed to allocate memory\n");
 329         ASSERT(FALSE);
 330         return STATUS_UNSUCCESSFUL;
 331     }
 332     KeInitializeTimer(MasterTimer);
 333
 334     return STATUS_SUCCESS;
 335 }
 336
 337 BOOL FASTCALL
 338 IntBlockInput(PTHREADINFO pti, BOOL BlockIt)
 339 {
 340     PTHREADINFO OldBlock;
 341     ASSERT(pti);
 342
 343     if(!pti->rpdesk || ((pti->TIF_flags & TIF_INCLEANUP) && BlockIt))
 344     {
 345         /*
 346          * Fail blocking if exiting the thread
 347          */
 348
 349         return FALSE;
 350     }
 351
 352     /*
 353      * FIXME: Check access rights of the window station
 354      *        e.g. services running in the service window station cannot block input
 355      */
 356     if(!ThreadHasInputAccess(pti) ||
 357        !IntIsActiveDesktop(pti->rpdesk))
 358     {
 359         EngSetLastError(ERROR_ACCESS_DENIED);
 360         return FALSE;
 361     }
 362
 363     ASSERT(pti->rpdesk);
 364     OldBlock = pti->rpdesk->BlockInputThread;
 365     if(OldBlock)
 366     {
 367         if(OldBlock != pti)
 368         {
 369             EngSetLastError(ERROR_ACCESS_DENIED);
 370             return FALSE;
 371         }
 372         pti->rpdesk->BlockInputThread = (BlockIt ? pti : NULL);
 373         return OldBlock == NULL;
 374     }
 375
 376     pti->rpdesk->BlockInputThread = (BlockIt ? pti : NULL);
 377     return OldBlock == NULL;
 378 }
 379
 380 BOOL
 381 APIENTRY
 382 NtUserBlockInput(
 383     BOOL BlockIt)
 384 {
 385     BOOL ret;
 386
 387     TRACE("Enter NtUserBlockInput\n");
 388     UserEnterExclusive();
 389
 390     ret = IntBlockInput(PsGetCurrentThreadWin32Thread(), BlockIt);
 391
 392     UserLeave();
 393     TRACE("Leave NtUserBlockInput, ret=%i\n", ret);
 394
 395     return ret;
 396 }
 397
 398 PTHREADINFO FASTCALL
 399 IsThreadAttach(PTHREADINFO ptiTo)
 400 {
 401     PATTACHINFO pai;
 402
 403     if (!gpai) return NULL;
 404
 405     pai = gpai;
 406     do
 407     {
 408         if (pai->pti2 == ptiTo) break;
 409         pai = pai->paiNext;
 410     } while (pai);
 411
 412     if (!pai) return NULL;
 413
 414     // Return ptiFrom.
 415     return pai->pti1;
 416 }
 417
 418 NTSTATUS FASTCALL
 419 UserAttachThreadInput(PTHREADINFO ptiFrom, PTHREADINFO ptiTo, BOOL fAttach)
 420 {
 421     MSG msg;
 422     PATTACHINFO pai;
 423
 424     /* Can not be the same thread. */
 425     if (ptiFrom == ptiTo) return STATUS_INVALID_PARAMETER;
 426
 427     /* Do not attach to system threads or between different desktops. */
 428     if (ptiFrom->TIF_flags & TIF_DONTATTACHQUEUE ||
 429         ptiTo->TIF_flags & TIF_DONTATTACHQUEUE ||
 430         ptiFrom->rpdesk != ptiTo->rpdesk)
 431         return STATUS_ACCESS_DENIED;
 432
 433     /* MSDN Note:
 434        Keyboard and mouse events received by both threads are processed by the thread specified by the idAttachTo.
 435      */
 436
 437     /* If Attach set, allocate and link. */
 438     if (fAttach)
 439     {
 440         pai = ExAllocatePoolWithTag(PagedPool, sizeof(ATTACHINFO), USERTAG_ATTACHINFO);
 441         if (!pai) return STATUS_NO_MEMORY;
 442
 443         pai->paiNext = gpai;
 444         pai->pti1 = ptiFrom;
 445         pai->pti2 = ptiTo;
 446         gpai = pai;
 447         paiCount++;
 448         ERR("Attach Allocated! ptiFrom 0x%p  ptiTo 0x%p paiCount %d\n",ptiFrom,ptiTo,paiCount);
 449
 450         if (ptiTo->MessageQueue == ptiFrom->MessageQueue)
 451         {
 452            ERR("Attach Threads are already associated!\n");
 453         }
 454
 455         ptiTo->MessageQueue->iCursorLevel -= ptiFrom->iCursorLevel;
 456
 457         /* Keep the original queue in pqAttach (ie do not trash it in a second attachment) */
 458         if (ptiFrom->pqAttach == NULL)
 459            ptiFrom->pqAttach = ptiFrom->MessageQueue;
 460         ptiFrom->MessageQueue = ptiTo->MessageQueue;
 461
 462         ptiFrom->MessageQueue->cThreads++;
 463         ERR("ptiTo S Share count %d\n", ptiFrom->MessageQueue->cThreads);
 464
 465         // FIXME: conditions?
 466         if (ptiFrom->pqAttach == gpqForeground)
 467         {
 468            ERR("ptiFrom is Foreground\n");
 469         ptiFrom->MessageQueue->spwndActive = ptiFrom->pqAttach->spwndActive;
 470         ptiFrom->MessageQueue->spwndFocus = ptiFrom->pqAttach->spwndFocus;
 471         ptiFrom->MessageQueue->CursorObject = ptiFrom->pqAttach->CursorObject;
 472         ptiFrom->MessageQueue->spwndCapture = ptiFrom->pqAttach->spwndCapture;
 473         ptiFrom->MessageQueue->QF_flags ^= ((ptiFrom->MessageQueue->QF_flags ^ ptiFrom->pqAttach->QF_flags) & QF_CAPTURELOCKED);
 474         ptiFrom->MessageQueue->CaretInfo = ptiFrom->pqAttach->CaretInfo;
 475         }
 476         else
 477         {
 478            ERR("ptiFrom NOT Foreground\n");
 479         }
 480         if (ptiTo->MessageQueue == gpqForeground)
 481         {
 482            ERR("ptiTo is Foreground\n");
 483         }
 484         else
 485         {
 486            ERR("ptiTo NOT Foreground\n");
 487         }
 488     }
 489     else /* If clear, unlink and free it. */
 490     {
 491         BOOL Hit = FALSE;
 492         PATTACHINFO *ppai;
 493
 494         if (!gpai) return STATUS_INVALID_PARAMETER;
 495
 496         /* Search list and free if found or return false. */
 497         ppai = &gpai;
 498         while (*ppai != NULL)
 499         {
 500            if ( (*ppai)->pti2 == ptiTo && (*ppai)->pti1 == ptiFrom )
 501            {
 502               pai = *ppai;
 503               /* Remove it from the list */
 504               *ppai = (*ppai)->paiNext;
 505               ExFreePoolWithTag(pai, USERTAG_ATTACHINFO);
 506               paiCount--;
 507               Hit = TRUE;
 508               break;
 509            }
 510            ppai = &((*ppai)->paiNext);
 511         }
 512
 513         if (!Hit) return STATUS_INVALID_PARAMETER;
 514
 515         ASSERT(ptiFrom->pqAttach);
 516
 517         ERR("Attach Free! ptiFrom 0x%p  ptiTo 0x%p paiCount %d\n",ptiFrom,ptiTo,paiCount);
 518
 519         /* Search list and check if the thread is attached one more time */
 520         pai = gpai;
 521         while(pai)
 522         {
 523             /* If the thread is attached again , we are done */
 524             if (pai->pti1 == ptiFrom)
 525             {
 526                 ptiFrom->MessageQueue->cThreads--;
 527                 ERR("ptiTo L Share count %d\n", ptiFrom->MessageQueue->cThreads);
 528                 /* Use the message queue of the last attachment */
 529                 ptiFrom->MessageQueue = pai->pti2->MessageQueue;
 530                 ptiFrom->MessageQueue->CursorObject = NULL;
 531                 ptiFrom->MessageQueue->spwndActive = NULL;
 532                 ptiFrom->MessageQueue->spwndFocus = NULL;
 533                 ptiFrom->MessageQueue->spwndCapture = NULL;
 534                 return STATUS_SUCCESS;
 535             }
 536             pai = pai->paiNext;
 537         }
 538
 539         ptiFrom->MessageQueue->cThreads--;
 540         ERR("ptiTo E Share count %d\n", ptiFrom->MessageQueue->cThreads);
 541         ptiFrom->MessageQueue = ptiFrom->pqAttach;
 542         // FIXME: conditions?
 543         ptiFrom->MessageQueue->CursorObject = NULL;
 544         ptiFrom->MessageQueue->spwndActive = NULL;
 545         ptiFrom->MessageQueue->spwndFocus = NULL;
 546         ptiFrom->MessageQueue->spwndCapture = NULL;
 547         ptiFrom->pqAttach = NULL;
 548         ptiTo->MessageQueue->iCursorLevel -= ptiFrom->iCursorLevel;
 549     }
 550     /* Note that key state, which can be ascertained by calls to the GetKeyState
 551        or GetKeyboardState function, is reset after a call to AttachThreadInput.
 552        ATM which one?
 553      */
 554     RtlCopyMemory(ptiTo->MessageQueue->afKeyState, gafAsyncKeyState, sizeof(gafAsyncKeyState));
 555
 556     /* Generate mouse move message */
 557     msg.message = WM_MOUSEMOVE;
 558     msg.wParam = UserGetMouseButtonsState();
 559     msg.lParam = MAKELPARAM(gpsi->ptCursor.x, gpsi->ptCursor.y);
 560     msg.pt = gpsi->ptCursor;
 561     co_MsqInsertMouseMessage(&msg, 0, 0, TRUE);
 562
 563     return STATUS_SUCCESS;
 564 }
 565
 566 /*
 567  * NtUserSendInput
 568  *
 569  * Generates input events from software
 570  */
 571 UINT
 572 APIENTRY
 573 NtUserSendInput(
 574     UINT nInputs,
 575     LPINPUT pInput,
 576     INT cbSize)
 577 {
 578     PTHREADINFO pti;
 579     UINT uRet = 0;
 580
 581     TRACE("Enter NtUserSendInput\n");
 582     UserEnterExclusive();
 583
 584     pti = PsGetCurrentThreadWin32Thread();
 585     ASSERT(pti);
 586
 587     if (!pti->rpdesk)
 588     {
 589         goto cleanup;
 590     }
 591
 592     if (!nInputs || !pInput || cbSize != sizeof(INPUT))
 593     {
 594         EngSetLastError(ERROR_INVALID_PARAMETER);
 595         goto cleanup;
 596     }
 597
 598     /*
 599      * FIXME: Check access rights of the window station
 600      *        e.g. services running in the service window station cannot block input
 601      */
 602     if (!ThreadHasInputAccess(pti) ||
 603         !IntIsActiveDesktop(pti->rpdesk))
 604     {
 605         EngSetLastError(ERROR_ACCESS_DENIED);
 606         goto cleanup;
 607     }
 608
 609     while (nInputs--)
 610     {
 611         INPUT SafeInput;
 612         NTSTATUS Status;
 613
 614         Status = MmCopyFromCaller(&SafeInput, pInput++, sizeof(INPUT));
 615         if (!NT_SUCCESS(Status))
 616         {
 617             SetLastNtError(Status);
 618             goto cleanup;
 619         }
 620
 621         switch (SafeInput.type)
 622         {
 623             case INPUT_MOUSE:
 624                 if (UserSendMouseInput(&SafeInput.mi, TRUE))
 625                     uRet++;
 626                 break;
 627             case INPUT_KEYBOARD:
 628                 if (UserSendKeyboardInput(&SafeInput.ki, TRUE))
 629                     uRet++;
 630                 break;
 631             case INPUT_HARDWARE:
 632                 FIXME("INPUT_HARDWARE not supported!");
 633                 break;
 634             default:
 635                 ERR("SendInput(): Invalid input type: 0x%x\n", SafeInput.type);
 636                 break;
 637         }
 638     }
 639
 640 cleanup:
 641     TRACE("Leave NtUserSendInput, ret=%i\n", uRet);
 642     UserLeave();
 643     return uRet;
 644 }
 645
 646 /* EOF */