VBoxTray.cpp revision bce65c32ad6982f6113537cc2c90d8999f19ed78
/** @file
* VBoxTray - Guest Additions Tray Application
*/
/*
* Copyright (C) 2006-2010 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
#include "VBoxTray.h"
#include "VBoxHelpers.h"
#include "VBoxSeamless.h"
#include "VBoxClipboard.h"
#include "VBoxDisplay.h"
#include "VBoxRestore.h"
#include "VBoxVRDP.h"
#include "VBoxHostVersion.h"
#include "VBoxSharedFolders.h"
#include <VBoxHook.h>
#include "resource.h"
#include <malloc.h>
#include <VBoxGuestInternal.h>
#include <sddl.h>
#include <iprt/buildconfig.h>
/*******************************************************************************
* Global Variables *
*******************************************************************************/
/* Global message handler prototypes. */
/* Prototypes */
int vboxTrayCreateTrayIcon(void);
/* The service table. */
static VBOXSERVICEINFO vboxServiceTable[] =
{
{
"Display",
},
{
"Shared Clipboard",
},
{
"Seamless Windows",
},
{
"Restore",
},
#endif
{
"VRDP",
},
{
}
};
/* The global message table. */
static VBOXGLOBALMESSAGE s_vboxGlobalMessageTable[] =
{
/* Windows specific stuff. */
{
"TaskbarCreated",
},
/* VBoxTray specific stuff. */
{
"VBoxTrayShowBalloonMsg",
},
{
}
};
/**
* Gets called whenever the Windows main taskbar
* get (re-)created. Nice to install our tray icon.
*
* @return IPRT status code.
* @param wParam
* @param lParam
*/
{
return vboxTrayCreateTrayIcon();
}
/**
* Shows a balloon tooltip message in VBoxTray's
* message area in the Windows main taskbar.
*
* @return IPRT status code.
* @param wParam
* @param lParam
*/
{
/*
* If something went wrong while displaying, log the message into the
* the release log so that the user still is being informed, at least somehow.
*/
if (RT_FAILURE(rc))
return rc;
}
static int vboxTrayCreateTrayIcon(void)
{
{
return RTErrConvertFromWin32(dwErr);
}
/* Prepare the system tray icon. */
int rc = VINF_SUCCESS;
{
}
if (hIcon)
return rc;
}
static void vboxTrayRemoveTrayIcon()
{
if (gNotifyIconData.cbSize > 0)
{
/* Remove the system tray icon and refresh system tray. */
if (hTrayWnd)
{
if (hTrayNotifyWnd)
}
}
}
{
Log(("VBoxTray: Starting services ...\n"));
if (!pEnv->hStopEvent)
{
/* Could not create event. */
return VERR_NOT_SUPPORTED;
}
{
int rc = VINF_SUCCESS;
bool fStartThread = false;
if (RT_FAILURE(rc))
{
}
else
{
{
unsigned threadid;
0, /* stacksize */
0, /* initflag */
&threadid);
}
if (RT_SUCCESS(rc))
else
{
Log(("VBoxTray: Failed to start the thread\n"));
if (pTable->pfnDestroy)
}
}
/* Advance to next table element. */
pTable++;
}
return VINF_SUCCESS;
}
{
if (!pEnv->hStopEvent)
return;
/* Signal to all threads. */
{
{
{
/* There is a thread, wait for termination. */
}
if (pTable->pfnDestroy)
}
/* Advance to next table element. */
pTable++;
}
}
{
int rc = VINF_SUCCESS;
return rc;
&& RT_SUCCESS(rc))
{
/* Register global accessible window messages. */
{
}
/* Advance to next table element. */
pTable++;
}
return rc;
}
{
return false;
{
{
if (pTable->pfnHandler)
return true;
}
/* Advance to next table element. */
pTable++;
}
return false;
}
void WINAPI VBoxServiceStart(void)
{
Log(("VBoxTray: Entering service main function\n"));
/* Open VBox guest driver. */
NULL,
NULL);
if (gVBoxDriver == INVALID_HANDLE_VALUE)
{
dwErr = GetLastError();
LogRel(("VBoxTray: Could not open VirtualBox Guest Additions driver! Please install / start it first! Error = %08X\n", dwErr));
}
{
/* Create a custom window class. */
WNDCLASS windowClass = {0};
if (!RegisterClass(&windowClass))
{
dwErr = GetLastError();
}
}
{
/* Create our (invisible) tool window. */
/* Note: The window name ("VBoxTrayToolWnd") and class ("VBoxTrayToolWndClass") is
* needed for posting globally registered messages to VBoxTray and must not be
* changed! Otherwise things get broken! */
"VBoxTrayToolWndClass", "VBoxTrayToolWnd",
if (!gToolWindow)
{
dwErr = GetLastError();
}
else
{
}
}
if (GetVersionEx(&info))
{
}
{
{
return;
}
/* We need to setup a security descriptor to allow other processes modify access to the seamless notification event semaphore */
if (!ret)
/* For Vista and up we need to change the integrity of the security descriptor too */
if (gMajorVersion >= 6)
{
BOOL (WINAPI * pfnConvertStringSecurityDescriptorToSecurityDescriptorA)(LPCSTR StringSecurityDescriptor, DWORD StringSDRevision, PSECURITY_DESCRIPTOR *SecurityDescriptor, PULONG SecurityDescriptorSize);
if (hModule)
{
*(uintptr_t *)&pfnConvertStringSecurityDescriptorToSecurityDescriptorA = (uintptr_t)GetProcAddress(hModule, "ConvertStringSecurityDescriptorToSecurityDescriptorA");
Log(("VBoxTray: pfnConvertStringSecurityDescriptorToSecurityDescriptorA = %x\n", pfnConvertStringSecurityDescriptorToSecurityDescriptorA));
{
ret = pfnConvertStringSecurityDescriptorToSecurityDescriptorA("S:(ML;;NW;;;LW)", /* this means "low integrity" */
if (!ret)
Log(("VBoxTray: ConvertStringSecurityDescriptorToSecurityDescriptorA failed with error = %08X\n", GetLastError()));
if (!ret)
if (!ret)
}
}
}
{
if (ghSeamlessNotifyEvent == NULL)
{
return;
}
}
}
/*
* Start services listed in the vboxServiceTable.
*/
/* initializes disp-if to default (XPDM) mode */
#ifdef VBOX_WITH_WDDM
/*
* For now the display mode will be adjusted to WDDM mode if needed
* on display service initialization when it detects the display driver type.
*/
#endif
{
if (RT_FAILURE (rc))
{
}
}
/* terminate service if something went wrong */
{
return;
}
int rc = vboxTrayCreateTrayIcon();
if ( RT_SUCCESS(rc)
{
/* We're ready to create the tooltip balloon. */
/* Check in 10 seconds (@todo make seconds configurable) ... */
10 * 1000, /* 10 seconds */
NULL /* No timerproc */);
}
/* Do the Shared Folders auto-mounting stuff. */
/* Boost thread priority to make sure we wake up early for seamless window notifications (not sure if it actually makes any difference though) */
/*
* Main execution loop
* Wait for the stop semaphore to be posted or a window event to arrive
*/
if (0 == ghSeamlessNotifyEvent) /* If seamless mode is not active / supported, reduce event array count */
dwEventCount = 1;
while (true)
{
/* Only enable for message debugging, lots of traffic! */
//Log(("VBoxTray: Wait result = %ld\n", waitResult));
if (waitResult == 0)
{
Log(("VBoxTray: Event 'Exit' triggered\n"));
/* exit */
break;
}
else if ( (waitResult == 1)
&& (ghSeamlessNotifyEvent!=0)) /* Only jump in, if seamless is active! */
{
Log(("VBoxTray: Event 'Seamless' triggered\n"));
/* seamless window notification */
}
else
{
/* timeout or a window message, handle it */
{
{
Log(("VBoxTray: WM_QUIT!\n"));
continue;
}
}
}
}
Log(("VBoxTray: Returned from main loop, exiting ...\n"));
Log(("VBoxTray: Waiting for display change thread ...\n"));
Log(("VBoxTray: Destroying tool window ...\n"));
/* Destroy the tool window. */
Log(("VBoxTray: Leaving service main function\n"));
return;
}
/**
* Main function
*/
{
/* Do not use a global namespace ("Global\\") for mutex name here, will blow up NT4 compatibility! */
if ( hMutexAppRunning != NULL
&& GetLastError() == ERROR_ALREADY_EXISTS)
{
/* Close the mutex for this application instance. */
return 0;
}
if (RT_FAILURE(rc))
return rc;
rc = VbglR3Init();
if (RT_FAILURE(rc))
return rc;
LogRel(("VBoxTray: Ended\n"));
/* Release instance mutex. */
if (hMutexAppRunning != NULL)
{
}
VbglR3Term();
return 0;
}
/**
* Window procedure for our tool window
*/
{
switch (uMsg)
{
case WM_CREATE:
{
Log(("VBoxTray: Tool window created\n"));
if (RT_FAILURE(rc))
return 0;
}
case WM_CLOSE:
return 0;
case WM_DESTROY:
Log(("VBoxTray: Tool window destroyed\n"));
return 0;
case WM_TIMER:
switch (wParam)
{
if (RT_SUCCESS(VBoxCheckHostVersion()))
{
/* After successful run we don't need to check again. */
}
return 0;
default:
break;
}
break; /* Make sure other timers get processed the usual way! */
case WM_VBOXTRAY_TRAY_ICON:
switch (lParam)
{
case WM_LBUTTONDBLCLK:
break;
case WM_RBUTTONDOWN:
break;
}
return 0;
return 0;
return 0;
case WM_VBOX_SEAMLESS_UPDATE:
return 0;
case WM_VBOXTRAY_VM_RESTORED:
return 0;
case WM_VBOXTRAY_VRDP_CHECK:
return 0;
default:
/* Handle all globally registered window messages. */
{
return 0; /* We handled the message. @todo Add return value!*/
}
break; /* We did not handle the message, dispatch to DefWndProc. */
}
/* Only if message was *not* handled by our switch above, dispatch
* to DefWindowProc. */
}