VirtualBox

source: vbox/trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxTray.cpp@ 10374

Last change on this file since 10374 was 10374, checked in by vboxsync, 16 years ago

Corrected log messages.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 18.3 KB
Line 
1/** @file
2 * VBoxTray - Guest Additions Tray Application
3 */
4
5/*
6 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
17 * Clara, CA 95054 USA or visit http://www.sun.com if you need
18 * additional information or have any questions.
19 */
20
21#include "VBoxTray.h"
22#include "VBoxSeamless.h"
23#include "VBoxClipboard.h"
24#include "VBoxDisplay.h"
25#include "VBoxRestore.h"
26#include "VBoxVRDP.h"
27#include "VBoxStatistics.h"
28#include "VBoxMemBalloon.h"
29#include <VBoxHook.h>
30#include "resource.h"
31#include <malloc.h>
32#include <VBoxGuestInternal.h>
33#include <iprt/string.h>
34
35#include "helpers.h"
36#include <sddl.h>
37
38/* global variables */
39HANDLE gVBoxDriver;
40HANDLE gStopSem;
41HANDLE ghSeamlessNotifyEvent = 0;
42SERVICE_STATUS gVBoxServiceStatus;
43SERVICE_STATUS_HANDLE gVBoxServiceStatusHandle;
44HINSTANCE gInstance;
45HWND gToolWindow;
46
47
48/* prototypes */
49VOID DisplayChangeThread(void *dummy);
50LRESULT CALLBACK VBoxToolWndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam);
51
52
53#ifdef DEBUG
54/**
55 * Helper function to send a message to WinDbg
56 *
57 * @param String message string
58 */
59void WriteLog(char *String, ...)
60{
61 DWORD cbReturned;
62 CHAR Buffer[1024];
63 VMMDevReqLogString *pReq = (VMMDevReqLogString *)Buffer;
64
65 va_list va;
66
67 va_start(va, String);
68
69 vmmdevInitRequest(&pReq->header, VMMDevReq_LogString);
70 RTStrPrintfV(pReq->szString, sizeof(Buffer)-sizeof(*pReq), String, va);
71 OutputDebugStringA(pReq->szString);
72 pReq->header.size += strlen(pReq->szString);
73
74 printf("%s\n", pReq->szString);
75
76 FILE* pFh = fopen("c:\\VBoxTrayDebug.txt", "at");
77
78 /* Does maybe not work on Vista (write protection when starting without admin rights),
79 so do this check! */
80 if (NULL != pFh)
81 {
82 fprintf(pFh, "%s", pReq->szString);
83 fclose(pFh);
84 }
85
86 DeviceIoControl(gVBoxDriver, IOCTL_VBOXGUEST_VMMREQUEST, pReq, pReq->header.size,
87 pReq, pReq->header.size, &cbReturned, NULL);
88
89 va_end (va);
90 return;
91}
92#endif
93
94
95
96/* The service table. */
97static VBOXSERVICEINFO vboxServiceTable[] =
98{
99 {
100 "Display",
101 VBoxDisplayInit,
102 VBoxDisplayThread,
103 VBoxDisplayDestroy,
104 },
105 {
106 "Shared Clipboard",
107 VBoxClipboardInit,
108 VBoxClipboardThread,
109 VBoxClipboardDestroy
110 },
111 {
112 "Seamless Windows",
113 VBoxSeamlessInit,
114 VBoxSeamlessThread,
115 VBoxSeamlessDestroy
116 },
117#ifdef VBOX_WITH_MANAGEMENT
118 {
119 "Memory Balloon",
120 VBoxMemBalloonInit,
121 VBoxMemBalloonThread,
122 VBoxMemBalloonDestroy,
123 },
124 {
125 "Guest Statistics",
126 VBoxStatsInit,
127 VBoxStatsThread,
128 VBoxStatsDestroy,
129 },
130#endif
131#ifdef VBOX_WITH_VRDP_SESSION_HANDLING
132 {
133 "Restore",
134 VBoxRestoreInit,
135 VBoxRestoreThread,
136 VBoxRestoreDestroy,
137 },
138#endif
139 {
140 "VRDP",
141 VBoxVRDPInit,
142 VBoxVRDPThread,
143 VBoxVRDPDestroy,
144 },
145 {
146 NULL
147 }
148};
149
150static int vboxStartServices (VBOXSERVICEENV *pEnv, VBOXSERVICEINFO *pTable)
151{
152 dprintf(("VBoxTray: Starting services...\n"));
153
154 pEnv->hStopEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
155
156 if (!pEnv->hStopEvent)
157 {
158 /* Could not create event. */
159 return VERR_NOT_SUPPORTED;
160 }
161
162 while (pTable->pszName)
163 {
164 dprintf(("Starting %s...\n", pTable->pszName));
165
166 int rc = VINF_SUCCESS;
167
168 bool fStartThread = false;
169
170 pTable->hThread = (HANDLE)0;
171 pTable->pInstance = NULL;
172 pTable->fStarted = false;
173
174 if (pTable->pfnInit)
175 {
176 rc = pTable->pfnInit (pEnv, &pTable->pInstance, &fStartThread);
177 }
178
179 if (VBOX_FAILURE (rc))
180 {
181 dprintf(("Failed to initialize rc = %Vrc.\n", rc));
182 }
183 else
184 {
185 if (pTable->pfnThread && fStartThread)
186 {
187 unsigned threadid;
188
189 pTable->hThread = (HANDLE)_beginthreadex (NULL, /* security */
190 0, /* stacksize */
191 pTable->pfnThread,
192 pTable->pInstance,
193 0, /* initflag */
194 &threadid);
195
196 if (pTable->hThread == (HANDLE)(0))
197 {
198 rc = VERR_NOT_SUPPORTED;
199 }
200 }
201
202 if (VBOX_FAILURE (rc))
203 {
204 dprintf(("Failed to start the thread.\n"));
205
206 if (pTable->pfnDestroy)
207 {
208 pTable->pfnDestroy (pEnv, pTable->pInstance);
209 }
210 }
211 else
212 {
213 pTable->fStarted = true;
214 }
215 }
216
217 /* Advance to next table element. */
218 pTable++;
219 }
220
221 return VINF_SUCCESS;
222}
223
224static void vboxStopServices (VBOXSERVICEENV *pEnv, VBOXSERVICEINFO *pTable)
225{
226 if (!pEnv->hStopEvent)
227 {
228 return;
229 }
230
231 /* Signal to all threads. */
232 SetEvent(pEnv->hStopEvent);
233
234 while (pTable->pszName)
235 {
236 if (pTable->fStarted)
237 {
238 if (pTable->pfnThread)
239 {
240 /* There is a thread, wait for termination. */
241 WaitForSingleObject(pTable->hThread, INFINITE);
242
243 CloseHandle (pTable->hThread);
244 pTable->hThread = 0;
245 }
246
247 if (pTable->pfnDestroy)
248 {
249 pTable->pfnDestroy (pEnv, pTable->pInstance);
250 }
251
252 pTable->fStarted = false;
253 }
254
255 /* Advance to next table element. */
256 pTable++;
257 }
258
259 CloseHandle (pEnv->hStopEvent);
260}
261
262
263void WINAPI VBoxServiceStart(void)
264{
265 dprintf(("VBoxTray: Start\n"));
266
267 VBOXSERVICEENV svcEnv;
268
269 DWORD status = NO_ERROR;
270
271 /* open VBox guest driver */
272 gVBoxDriver = CreateFile(VBOXGUEST_DEVICE_NAME,
273 GENERIC_READ | GENERIC_WRITE,
274 FILE_SHARE_READ | FILE_SHARE_WRITE,
275 NULL,
276 OPEN_EXISTING,
277 FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED,
278 NULL);
279 if (gVBoxDriver == INVALID_HANDLE_VALUE)
280 {
281 dprintf(("VBoxTray: could not open VBox Guest Additions driver! Please install / start it first! rc = %d\n", GetLastError()));
282 status = ERROR_GEN_FAILURE;
283 }
284
285 dprintf(("VBoxTray: Driver h %p, st %p\n", gVBoxDriver, status));
286
287 if (status == NO_ERROR)
288 {
289 /* create a custom window class */
290 WNDCLASS windowClass = {0};
291 windowClass.style = CS_NOCLOSE;
292 windowClass.lpfnWndProc = (WNDPROC)VBoxToolWndProc;
293 windowClass.hInstance = gInstance;
294 windowClass.hCursor = LoadCursor(NULL, IDC_ARROW);
295 windowClass.lpszClassName = "VirtualBoxTool";
296 if (!RegisterClass(&windowClass))
297 status = GetLastError();
298 }
299
300 dprintf(("VBoxTray: Class st %p\n", status));
301
302 if (status == NO_ERROR)
303 {
304 /* create our window */
305 gToolWindow = CreateWindowEx(WS_EX_TOOLWINDOW | WS_EX_TRANSPARENT | WS_EX_TOPMOST,
306 "VirtualBoxTool", "VirtualBoxTool",
307 WS_POPUPWINDOW,
308 -200, -200, 100, 100, NULL, NULL, gInstance, NULL);
309 if (!gToolWindow)
310 status = GetLastError();
311 else
312 {
313 /* move the window beneach the mouse pointer so that we get access to it */
314 POINT mousePos;
315 GetCursorPos(&mousePos);
316 SetWindowPos(gToolWindow, HWND_TOPMOST, mousePos.x - 10, mousePos.y - 10, 0, 0,
317 SWP_NOACTIVATE | SWP_SHOWWINDOW | SWP_NOCOPYBITS | SWP_NOREDRAW | SWP_NOSIZE);
318 /* change the mouse pointer so that we can go for a hardware shape */
319 SetCursor(LoadCursor(NULL, IDC_APPSTARTING));
320 SetCursor(LoadCursor(NULL, IDC_ARROW));
321 /* move back our tool window */
322 SetWindowPos(gToolWindow, HWND_TOPMOST, -200, -200, 0, 0,
323 SWP_NOACTIVATE | SWP_HIDEWINDOW | SWP_NOCOPYBITS | SWP_NOREDRAW | SWP_NOSIZE);
324 }
325 }
326
327 dprintf(("VBoxTray: Window h %p, st %p\n", gToolWindow, status));
328
329 if (status == NO_ERROR)
330 {
331 gStopSem = CreateEvent(NULL, TRUE, FALSE, NULL);
332 if (gStopSem == NULL)
333 {
334 dprintf(("VBoxTray: CreateEvent for Stopping failed: rc = %d\n", GetLastError()));
335 return;
336 }
337
338 /* We need to setup a security descriptor to allow other processes modify access to the seamless notification event semaphore */
339 SECURITY_ATTRIBUTES SecAttr;
340 OSVERSIONINFO info;
341 char secDesc[SECURITY_DESCRIPTOR_MIN_LENGTH];
342 DWORD dwMajorVersion = 5; /* default XP */
343 BOOL ret;
344
345 SecAttr.nLength = sizeof(SecAttr);
346 SecAttr.bInheritHandle = FALSE;
347 SecAttr.lpSecurityDescriptor = &secDesc;
348 InitializeSecurityDescriptor(SecAttr.lpSecurityDescriptor, SECURITY_DESCRIPTOR_REVISION);
349 ret = SetSecurityDescriptorDacl(SecAttr.lpSecurityDescriptor, TRUE, 0, FALSE);
350 if (!ret)
351 dprintf(("SetSecurityDescriptorDacl failed with %d\n", GetLastError()));
352
353 info.dwOSVersionInfoSize = sizeof(info);
354 if (GetVersionEx(&info))
355 {
356 dprintf(("VBoxTray: Windows version major %d minor %d\n", info.dwMajorVersion, info.dwMinorVersion));
357 dwMajorVersion = info.dwMajorVersion;
358 }
359
360 /* For Vista and up we need to change the integrity of the security descriptor too */
361 if (dwMajorVersion >= 6)
362 {
363 HMODULE hModule;
364
365 BOOL (WINAPI * pfnConvertStringSecurityDescriptorToSecurityDescriptorA)(LPCSTR StringSecurityDescriptor, DWORD StringSDRevision, PSECURITY_DESCRIPTOR *SecurityDescriptor, PULONG SecurityDescriptorSize);
366
367 hModule = LoadLibrary("ADVAPI32.DLL");
368 if (hModule)
369 {
370 PSECURITY_DESCRIPTOR pSD;
371 PACL pSacl = NULL;
372 BOOL fSaclPresent = FALSE;
373 BOOL fSaclDefaulted = FALSE;
374
375 *(uintptr_t *)&pfnConvertStringSecurityDescriptorToSecurityDescriptorA = (uintptr_t)GetProcAddress(hModule, "ConvertStringSecurityDescriptorToSecurityDescriptorA");
376
377 dprintf(("pfnConvertStringSecurityDescriptorToSecurityDescriptorA = %x\n", pfnConvertStringSecurityDescriptorToSecurityDescriptorA));
378 if (pfnConvertStringSecurityDescriptorToSecurityDescriptorA)
379 {
380 ret = pfnConvertStringSecurityDescriptorToSecurityDescriptorA("S:(ML;;NW;;;LW)", /* this means "low integrity" */
381 SDDL_REVISION_1, &pSD, NULL);
382 if (!ret)
383 dprintf(("ConvertStringSecurityDescriptorToSecurityDescriptorA failed with %d\n", GetLastError()));
384
385 ret = GetSecurityDescriptorSacl(pSD, &fSaclPresent, &pSacl, &fSaclDefaulted);
386 if (!ret)
387 dprintf(("GetSecurityDescriptorSacl failed with %d\n", GetLastError()));
388
389 ret = SetSecurityDescriptorSacl(SecAttr.lpSecurityDescriptor, TRUE, pSacl, FALSE);
390 if (!ret)
391 dprintf(("SetSecurityDescriptorSacl failed with %d\n", GetLastError()));
392 }
393 }
394 }
395
396 if (dwMajorVersion >= 5) /* Only for W2K and up ... */
397 {
398 ghSeamlessNotifyEvent = CreateEvent(&SecAttr, FALSE, FALSE, VBOXHOOK_GLOBAL_EVENT_NAME);
399 if (ghSeamlessNotifyEvent == NULL)
400 {
401 dprintf(("VBoxTray: CreateEvent for Seamless failed: rc = %d\n", GetLastError()));
402 return;
403 }
404 }
405 }
406
407 /*
408 * Start services listed in the vboxServiceTable.
409 */
410 svcEnv.hInstance = gInstance;
411 svcEnv.hDriver = gVBoxDriver;
412
413 if (status == NO_ERROR)
414 {
415 int rc = vboxStartServices (&svcEnv, vboxServiceTable);
416
417 if (VBOX_FAILURE (rc))
418 {
419 status = ERROR_GEN_FAILURE;
420 }
421 }
422
423 /* terminate service if something went wrong */
424 if (status != NO_ERROR)
425 {
426 vboxStopServices (&svcEnv, vboxServiceTable);
427 return;
428 }
429
430 BOOL fTrayIconCreated = false;
431
432 /* prepare the system tray icon */
433 NOTIFYICONDATA ndata;
434 memset (&ndata, 0, sizeof (ndata));
435 ndata.cbSize = NOTIFYICONDATA_V1_SIZE; // sizeof(NOTIFYICONDATA);
436 ndata.hWnd = gToolWindow;
437 ndata.uID = 2000;
438 ndata.uFlags = NIF_ICON | NIF_MESSAGE | NIF_TIP;
439 ndata.uCallbackMessage = WM_USER;
440 ndata.hIcon = LoadIcon(gInstance, MAKEINTRESOURCE(IDI_VIRTUALBOX));
441 sprintf(ndata.szTip, "Sun xVM VirtualBox Guest Additions %d.%d.%dr%d", VBOX_VERSION_MAJOR, VBOX_VERSION_MINOR, VBOX_VERSION_BUILD, VBOX_SVN_REV);
442
443 dprintf(("VBoxTray: ndata.hWnd %08X, ndata.hIcon = %p\n", ndata.hWnd, ndata.hIcon));
444
445 /* Boost thread priority to make sure we wake up early for seamless window notifications (not sure if it actually makes any difference though) */
446 SetThreadPriority(GetCurrentThread(), THREAD_PRIORITY_HIGHEST);
447
448 /*
449 * Main execution loop
450 * Wait for the stop semaphore to be posted or a window event to arrive
451 */
452
453 DWORD dwEventCount = 2;
454 HANDLE hWaitEvent[2] = {gStopSem, ghSeamlessNotifyEvent};
455
456 if (0 == ghSeamlessNotifyEvent) /* If seamless mode is not active / supported, reduce event array count */
457 dwEventCount = 1;
458
459 dprintf(("VBoxTray: Number of events to wait in main loop: %ld\n", dwEventCount));
460
461 while(true)
462 {
463 DWORD waitResult = MsgWaitForMultipleObjectsEx(dwEventCount, hWaitEvent, 500, QS_ALLINPUT, 0);
464 waitResult = waitResult - WAIT_OBJECT_0;
465
466 dprintf(("VBoxTray: Wait result = %ld.\n", waitResult));
467
468 if (waitResult == 0)
469 {
470 dprintf(("VBoxTray: Event 'Exit' triggered.\n"));
471 /* exit */
472 break;
473 }
474 else if ((waitResult == 1) && (ghSeamlessNotifyEvent!=0)) /* Only jump in, if seamless is active! */
475 {
476 dprintf(("VBoxTray: Event 'Seamless' triggered.\n"));
477
478 /* seamless window notification */
479 VBoxSeamlessCheckWindows();
480 }
481 else
482 {
483 /* timeout or a window message, handle it */
484 MSG msg;
485 while (PeekMessage(&msg, NULL, 0, 0, PM_REMOVE))
486 {
487 dprintf(("VBoxTray: msg %p\n", msg.message));
488 if (msg.message == WM_QUIT)
489 {
490 dprintf(("VBoxTray: WM_QUIT!\n"));
491 SetEvent(gStopSem);
492 continue;
493 }
494 TranslateMessage(&msg);
495 DispatchMessage(&msg);
496 }
497 /* we might have to repeat this operation because the shell might not be loaded yet */
498 if (!fTrayIconCreated)
499 {
500 fTrayIconCreated = Shell_NotifyIcon(NIM_ADD, &ndata);
501 dprintf(("VBoxTray: fTrayIconCreated = %d, err %08X\n", fTrayIconCreated, GetLastError ()));
502 }
503 }
504 }
505
506 dprintf(("VBoxTray: returned from main loop, exiting...\n"));
507
508 /* remove the system tray icon */
509 Shell_NotifyIcon(NIM_DELETE, &ndata);
510
511 dprintf(("VBoxTray: waiting for display change thread...\n"));
512
513 vboxStopServices (&svcEnv, vboxServiceTable);
514
515 dprintf(("VBoxTray: destroying tool window...\n"));
516
517 /* destroy the tool window */
518 DestroyWindow(gToolWindow);
519
520 UnregisterClass("VirtualBoxTool", gInstance);
521
522 CloseHandle(gVBoxDriver);
523 CloseHandle(gStopSem);
524 CloseHandle(ghSeamlessNotifyEvent);
525
526 dprintf(("VBoxTray: leaving service main function\n"));
527
528 return;
529}
530
531
532/**
533 * Main function
534 */
535int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine, int nCmdShow)
536{
537 /* Do not use a global namespace ("Global\\") for mutex name here, will blow up NT4 compatibility! */
538 HANDLE hMutexAppRunning = CreateMutex (NULL, FALSE, "VBoxTray");
539 if ( (hMutexAppRunning != NULL)
540 && (GetLastError() == ERROR_ALREADY_EXISTS))
541 {
542 /* Close the mutex for this application instance. */
543 CloseHandle (hMutexAppRunning);
544 hMutexAppRunning = NULL;
545 return 0;
546 }
547
548 dprintf(("VBoxTray: Started.\n"));
549
550 gInstance = hInstance;
551 VBoxServiceStart();
552
553 dprintf(("VBoxTray: Ended.\n"));
554
555 /* Release instance mutex. */
556 if (hMutexAppRunning != NULL) {
557 CloseHandle (hMutexAppRunning);
558 hMutexAppRunning = NULL;
559 }
560
561 return 0;
562}
563
564/**
565 * Window procedure for our tool window
566 */
567LRESULT CALLBACK VBoxToolWndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
568{
569 switch (msg)
570 {
571 case WM_CLOSE:
572 break;
573
574 case WM_DESTROY:
575 break;
576
577 case WM_VBOX_INSTALL_SEAMLESS_HOOK:
578 VBoxSeamlessInstallHook();
579 break;
580
581 case WM_VBOX_REMOVE_SEAMLESS_HOOK:
582 VBoxSeamlessRemoveHook();
583 break;
584
585 case WM_VBOX_SEAMLESS_UPDATE:
586 VBoxSeamlessCheckWindows();
587 break;
588
589 case WM_VBOX_RESTORED:
590 VBoxRestoreSession();
591 break;
592
593 case WM_VBOX_CHECK_VRDP:
594 VBoxRestoreCheckVRDP();
595 break;
596
597 default:
598 return DefWindowProc(hwnd, msg, wParam, lParam);
599 }
600 return 0;
601}
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette