| 1 | /* $Id: ConsoleVRDPServer.h 13607 2008-10-28 10:43:42Z vboxsync $ */
|
|---|
| 2 |
|
|---|
| 3 | /** @file
|
|---|
| 4 | *
|
|---|
| 5 | * VBox Console VRDP Helper class and implementation of IRemoteDisplayInfo
|
|---|
| 6 | */
|
|---|
| 7 |
|
|---|
| 8 | /*
|
|---|
| 9 | * Copyright (C) 2006-2008 Sun Microsystems, Inc.
|
|---|
| 10 | *
|
|---|
| 11 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 12 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 13 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 14 | * General Public License (GPL) as published by the Free Software
|
|---|
| 15 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 16 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 17 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 18 | *
|
|---|
| 19 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
|
|---|
| 20 | * Clara, CA 95054 USA or visit http://www.sun.com if you need
|
|---|
| 21 | * additional information or have any questions.
|
|---|
| 22 | */
|
|---|
| 23 |
|
|---|
| 24 | #ifndef ____H_CONSOLEVRDPSERVER
|
|---|
| 25 | #define ____H_CONSOLEVRDPSERVER
|
|---|
| 26 |
|
|---|
| 27 | #include "RemoteUSBBackend.h"
|
|---|
| 28 | #include <hgcm/HGCM.h>
|
|---|
| 29 |
|
|---|
| 30 | #include <VBox/VRDPAuth.h>
|
|---|
| 31 |
|
|---|
| 32 | #include <VBox/HostServices/VBoxClipboardExt.h>
|
|---|
| 33 |
|
|---|
| 34 | #include "SchemaDefs.h"
|
|---|
| 35 |
|
|---|
| 36 | // ConsoleVRDPServer
|
|---|
| 37 | ///////////////////////////////////////////////////////////////////////////////
|
|---|
| 38 |
|
|---|
| 39 | #ifdef VBOX_WITH_VRDP
|
|---|
| 40 | typedef struct _VRDPInputSynch
|
|---|
| 41 | {
|
|---|
| 42 | int cGuestNumLockAdaptions;
|
|---|
| 43 | int cGuestCapsLockAdaptions;
|
|---|
| 44 |
|
|---|
| 45 | bool fGuestNumLock;
|
|---|
| 46 | bool fGuestCapsLock;
|
|---|
| 47 | bool fGuestScrollLock;
|
|---|
| 48 |
|
|---|
| 49 | bool fClientNumLock;
|
|---|
| 50 | bool fClientCapsLock;
|
|---|
| 51 | bool fClientScrollLock;
|
|---|
| 52 | } VRDPInputSynch;
|
|---|
| 53 | #endif /* VBOX_WITH_VRDP */
|
|---|
| 54 |
|
|---|
| 55 | /* Member of Console. Helper class for VRDP server management. Not a COM class. */
|
|---|
| 56 | class ConsoleVRDPServer
|
|---|
| 57 | {
|
|---|
| 58 | public:
|
|---|
| 59 | ConsoleVRDPServer (Console *console);
|
|---|
| 60 | ~ConsoleVRDPServer ();
|
|---|
| 61 |
|
|---|
| 62 | int Launch (void);
|
|---|
| 63 |
|
|---|
| 64 | void NotifyAbsoluteMouse (bool fGuestWantsAbsolute)
|
|---|
| 65 | {
|
|---|
| 66 | #ifdef VBOX_WITH_VRDP
|
|---|
| 67 | m_fGuestWantsAbsolute = fGuestWantsAbsolute;
|
|---|
| 68 | #else
|
|---|
| 69 | NOREF(fGuestWantsAbsolute);
|
|---|
| 70 | #endif /* VBOX_WITH_VRDP */
|
|---|
| 71 | }
|
|---|
| 72 |
|
|---|
| 73 | void NotifyKeyboardLedsChange (BOOL fNumLock, BOOL fCapsLock, BOOL fScrollLock)
|
|---|
| 74 | {
|
|---|
| 75 | #ifdef VBOX_WITH_VRDP
|
|---|
| 76 | bool fGuestNumLock = (fNumLock != FALSE);
|
|---|
| 77 | bool fGuestCapsLock = (fCapsLock != FALSE);
|
|---|
| 78 | bool fGuestScrollLock = (fScrollLock != FALSE);
|
|---|
| 79 |
|
|---|
| 80 | /* Might need to resynch in case the guest itself changed the LED status. */
|
|---|
| 81 | if (m_InputSynch.fClientNumLock != fGuestNumLock)
|
|---|
| 82 | {
|
|---|
| 83 | m_InputSynch.cGuestNumLockAdaptions = 2;
|
|---|
| 84 | }
|
|---|
| 85 |
|
|---|
| 86 | if (m_InputSynch.fClientCapsLock != fGuestCapsLock)
|
|---|
| 87 | {
|
|---|
| 88 | m_InputSynch.cGuestCapsLockAdaptions = 2;
|
|---|
| 89 | }
|
|---|
| 90 |
|
|---|
| 91 | m_InputSynch.fGuestNumLock = fGuestNumLock;
|
|---|
| 92 | m_InputSynch.fGuestCapsLock = fGuestCapsLock;
|
|---|
| 93 | m_InputSynch.fGuestScrollLock = fGuestScrollLock;
|
|---|
| 94 | #else
|
|---|
| 95 | NOREF(fNumLock);
|
|---|
| 96 | NOREF(fCapsLock);
|
|---|
| 97 | NOREF(fScrollLock);
|
|---|
| 98 | #endif /* VBOX_WITH_VRDP */
|
|---|
| 99 | }
|
|---|
| 100 |
|
|---|
| 101 | void EnableConnections (void);
|
|---|
| 102 | void DisconnectClient (uint32_t u32ClientId, bool fReconnect);
|
|---|
| 103 | void MousePointerUpdate (const VRDPCOLORPOINTER *pPointer);
|
|---|
| 104 | void MousePointerHide (void);
|
|---|
| 105 |
|
|---|
| 106 | void Stop (void);
|
|---|
| 107 |
|
|---|
| 108 | VRDPAuthResult Authenticate (const Guid &uuid, VRDPAuthGuestJudgement guestJudgement,
|
|---|
| 109 | const char *pszUser, const char *pszPassword, const char *pszDomain,
|
|---|
| 110 | uint32_t u32ClientId);
|
|---|
| 111 |
|
|---|
| 112 | void AuthDisconnect (const Guid &uuid, uint32_t u32ClientId);
|
|---|
| 113 |
|
|---|
| 114 | void USBBackendCreate (uint32_t u32ClientId, void **ppvIntercept);
|
|---|
| 115 | void USBBackendDelete (uint32_t u32ClientId);
|
|---|
| 116 |
|
|---|
| 117 | void *USBBackendRequestPointer (uint32_t u32ClientId, const Guid *pGuid);
|
|---|
| 118 | void USBBackendReleasePointer (const Guid *pGuid);
|
|---|
| 119 |
|
|---|
| 120 | /* Private interface for the RemoteUSBBackend destructor. */
|
|---|
| 121 | void usbBackendRemoveFromList (RemoteUSBBackend *pRemoteUSBBackend);
|
|---|
| 122 |
|
|---|
| 123 | /* Private methods for the Remote USB thread. */
|
|---|
| 124 | RemoteUSBBackend *usbBackendGetNext (RemoteUSBBackend *pRemoteUSBBackend);
|
|---|
| 125 |
|
|---|
| 126 | void notifyRemoteUSBThreadRunning (RTTHREAD thread);
|
|---|
| 127 | bool isRemoteUSBThreadRunning (void);
|
|---|
| 128 | void waitRemoteUSBThreadEvent (unsigned cMillies);
|
|---|
| 129 |
|
|---|
| 130 | void ClipboardCreate (uint32_t u32ClientId);
|
|---|
| 131 | void ClipboardDelete (uint32_t u32ClientId);
|
|---|
| 132 |
|
|---|
| 133 | /*
|
|---|
| 134 | * Forwarders to VRDP server library.
|
|---|
| 135 | */
|
|---|
| 136 | void SendUpdate (unsigned uScreenId, void *pvUpdate, uint32_t cbUpdate) const;
|
|---|
| 137 | void SendResize (void) const;
|
|---|
| 138 | void SendUpdateBitmap (unsigned uScreenId, uint32_t x, uint32_t y, uint32_t w, uint32_t h) const;
|
|---|
| 139 |
|
|---|
| 140 | void SendAudioSamples (void *pvSamples, uint32_t cSamples, VRDPAUDIOFORMAT format) const;
|
|---|
| 141 | void SendAudioVolume (uint16_t left, uint16_t right) const;
|
|---|
| 142 | void SendUSBRequest (uint32_t u32ClientId, void *pvParms, uint32_t cbParms) const;
|
|---|
| 143 |
|
|---|
| 144 | void QueryInfo (uint32_t index, void *pvBuffer, uint32_t cbBuffer, uint32_t *pcbOut) const;
|
|---|
| 145 |
|
|---|
| 146 | private:
|
|---|
| 147 | /* Note: This is not a ComObjPtr here, because the ConsoleVRDPServer object
|
|---|
| 148 | * is actually just a part of the Console.
|
|---|
| 149 | */
|
|---|
| 150 | Console *mConsole;
|
|---|
| 151 |
|
|---|
| 152 | #ifdef VBOX_WITH_VRDP
|
|---|
| 153 | HVRDPSERVER mhServer;
|
|---|
| 154 |
|
|---|
| 155 | static bool loadVRDPLibrary (void);
|
|---|
| 156 |
|
|---|
| 157 | /** Static because will never load this more than once! */
|
|---|
| 158 | static RTLDRMOD mVRDPLibrary;
|
|---|
| 159 |
|
|---|
| 160 | static PFNVRDPCREATESERVER mpfnVRDPCreateServer;
|
|---|
| 161 |
|
|---|
| 162 | static VRDPENTRYPOINTS_1 *mpEntryPoints;
|
|---|
| 163 | static VRDPCALLBACKS_1 mCallbacks;
|
|---|
| 164 |
|
|---|
| 165 | static DECLCALLBACK(int) VRDPCallbackQueryProperty (void *pvCallback, uint32_t index, void *pvBuffer, uint32_t cbBuffer, uint32_t *pcbOut);
|
|---|
| 166 | static DECLCALLBACK(int) VRDPCallbackClientLogon (void *pvCallback, uint32_t u32ClientId, const char *pszUser, const char *pszPassword, const char *pszDomain);
|
|---|
| 167 | static DECLCALLBACK(void) VRDPCallbackClientConnect (void *pvCallback, uint32_t u32ClientId);
|
|---|
| 168 | static DECLCALLBACK(void) VRDPCallbackClientDisconnect (void *pvCallback, uint32_t u32ClientId, uint32_t fu32Intercepted);
|
|---|
| 169 | static DECLCALLBACK(int) VRDPCallbackIntercept (void *pvCallback, uint32_t u32ClientId, uint32_t fu32Intercept, void **ppvIntercept);
|
|---|
| 170 | static DECLCALLBACK(int) VRDPCallbackUSB (void *pvCallback, void *pvIntercept, uint32_t u32ClientId, uint8_t u8Code, const void *pvRet, uint32_t cbRet);
|
|---|
| 171 | static DECLCALLBACK(int) VRDPCallbackClipboard (void *pvCallback, void *pvIntercept, uint32_t u32ClientId, uint32_t u32Function, uint32_t u32Format, const void *pvData, uint32_t cbData);
|
|---|
| 172 | static DECLCALLBACK(bool) VRDPCallbackFramebufferQuery (void *pvCallback, unsigned uScreenId, VRDPFRAMEBUFFERINFO *pInfo);
|
|---|
| 173 | static DECLCALLBACK(void) VRDPCallbackFramebufferLock (void *pvCallback, unsigned uScreenId);
|
|---|
| 174 | static DECLCALLBACK(void) VRDPCallbackFramebufferUnlock (void *pvCallback, unsigned uScreenId);
|
|---|
| 175 | static DECLCALLBACK(void) VRDPCallbackInput (void *pvCallback, int type, const void *pvInput, unsigned cbInput);
|
|---|
| 176 | static DECLCALLBACK(void) VRDPCallbackVideoModeHint (void *pvCallback, unsigned cWidth, unsigned cHeight, unsigned cBitsPerPixel, unsigned uScreenId);
|
|---|
| 177 |
|
|---|
| 178 | bool m_fGuestWantsAbsolute;
|
|---|
| 179 | int m_mousex;
|
|---|
| 180 | int m_mousey;
|
|---|
| 181 |
|
|---|
| 182 | IFramebuffer *maFramebuffers[SchemaDefs::MaxGuestMonitors];
|
|---|
| 183 |
|
|---|
| 184 | IConsoleCallback *mConsoleCallback;
|
|---|
| 185 |
|
|---|
| 186 | VRDPInputSynch m_InputSynch;
|
|---|
| 187 | #endif /* VBOX_WITH_VRDP */
|
|---|
| 188 |
|
|---|
| 189 | RTCRITSECT mCritSect;
|
|---|
| 190 |
|
|---|
| 191 | int lockConsoleVRDPServer (void);
|
|---|
| 192 | void unlockConsoleVRDPServer (void);
|
|---|
| 193 |
|
|---|
| 194 | int mcClipboardRefs;
|
|---|
| 195 | HGCMSVCEXTHANDLE mhClipboard;
|
|---|
| 196 | PFNVRDPCLIPBOARDEXTCALLBACK mpfnClipboardCallback;
|
|---|
| 197 |
|
|---|
| 198 | static DECLCALLBACK(int) ClipboardCallback (void *pvCallback, uint32_t u32ClientId, uint32_t u32Function, uint32_t u32Format, const void *pvData, uint32_t cbData);
|
|---|
| 199 | static DECLCALLBACK(int) ClipboardServiceExtension (void *pvExtension, uint32_t u32Function, void *pvParm, uint32_t cbParms);
|
|---|
| 200 |
|
|---|
| 201 | #ifdef VBOX_WITH_USB
|
|---|
| 202 | RemoteUSBBackend *usbBackendFindByUUID (const Guid *pGuid);
|
|---|
| 203 | RemoteUSBBackend *usbBackendFind (uint32_t u32ClientId);
|
|---|
| 204 |
|
|---|
| 205 | typedef struct _USBBackends
|
|---|
| 206 | {
|
|---|
| 207 | RemoteUSBBackend *pHead;
|
|---|
| 208 | RemoteUSBBackend *pTail;
|
|---|
| 209 |
|
|---|
| 210 | RTTHREAD thread;
|
|---|
| 211 |
|
|---|
| 212 | bool fThreadRunning;
|
|---|
| 213 |
|
|---|
| 214 | RTSEMEVENT event;
|
|---|
| 215 | } USBBackends;
|
|---|
| 216 |
|
|---|
| 217 | USBBackends mUSBBackends;
|
|---|
| 218 |
|
|---|
| 219 | void remoteUSBThreadStart (void);
|
|---|
| 220 | void remoteUSBThreadStop (void);
|
|---|
| 221 | #endif /* VBOX_WITH_USB */
|
|---|
| 222 |
|
|---|
| 223 | /* External authentication library handle. The library is loaded in the
|
|---|
| 224 | * Authenticate method and unloaded at the object destructor.
|
|---|
| 225 | */
|
|---|
| 226 | RTLDRMOD mAuthLibrary;
|
|---|
| 227 | PVRDPAUTHENTRY mpfnAuthEntry;
|
|---|
| 228 | PVRDPAUTHENTRY2 mpfnAuthEntry2;
|
|---|
| 229 | };
|
|---|
| 230 |
|
|---|
| 231 |
|
|---|
| 232 | class Console;
|
|---|
| 233 |
|
|---|
| 234 | class ATL_NO_VTABLE RemoteDisplayInfo :
|
|---|
| 235 | public VirtualBoxBaseNEXT,
|
|---|
| 236 | public VirtualBoxSupportErrorInfoImpl <RemoteDisplayInfo, IRemoteDisplayInfo>,
|
|---|
| 237 | public VirtualBoxSupportTranslation <RemoteDisplayInfo>,
|
|---|
| 238 | public IRemoteDisplayInfo
|
|---|
| 239 | {
|
|---|
| 240 | public:
|
|---|
| 241 |
|
|---|
| 242 | VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT (RemoteDisplayInfo)
|
|---|
| 243 |
|
|---|
| 244 | DECLARE_NOT_AGGREGATABLE(RemoteDisplayInfo)
|
|---|
| 245 |
|
|---|
| 246 | DECLARE_PROTECT_FINAL_CONSTRUCT()
|
|---|
| 247 |
|
|---|
| 248 | BEGIN_COM_MAP(RemoteDisplayInfo)
|
|---|
| 249 | COM_INTERFACE_ENTRY(ISupportErrorInfo)
|
|---|
| 250 | COM_INTERFACE_ENTRY(IRemoteDisplayInfo)
|
|---|
| 251 | END_COM_MAP()
|
|---|
| 252 |
|
|---|
| 253 | NS_DECL_ISUPPORTS
|
|---|
| 254 |
|
|---|
| 255 | DECLARE_EMPTY_CTOR_DTOR (RemoteDisplayInfo)
|
|---|
| 256 |
|
|---|
| 257 | HRESULT FinalConstruct();
|
|---|
| 258 | void FinalRelease();
|
|---|
| 259 |
|
|---|
| 260 | /* Public initializer/uninitializer for internal purposes only. */
|
|---|
| 261 | HRESULT init (Console *aParent);
|
|---|
| 262 | void uninit();
|
|---|
| 263 |
|
|---|
| 264 | /* IRemoteDisplayInfo properties */
|
|---|
| 265 | #define DECL_GETTER(_aType, _aName) STDMETHOD(COMGETTER(_aName)) (_aType *a##_aName)
|
|---|
| 266 | DECL_GETTER (BOOL, Active);
|
|---|
| 267 | DECL_GETTER (ULONG, NumberOfClients);
|
|---|
| 268 | DECL_GETTER (LONG64, BeginTime);
|
|---|
| 269 | DECL_GETTER (LONG64, EndTime);
|
|---|
| 270 | DECL_GETTER (ULONG64, BytesSent);
|
|---|
| 271 | DECL_GETTER (ULONG64, BytesSentTotal);
|
|---|
| 272 | DECL_GETTER (ULONG64, BytesReceived);
|
|---|
| 273 | DECL_GETTER (ULONG64, BytesReceivedTotal);
|
|---|
| 274 | DECL_GETTER (BSTR, User);
|
|---|
| 275 | DECL_GETTER (BSTR, Domain);
|
|---|
| 276 | DECL_GETTER (BSTR, ClientName);
|
|---|
| 277 | DECL_GETTER (BSTR, ClientIP);
|
|---|
| 278 | DECL_GETTER (ULONG, ClientVersion);
|
|---|
| 279 | DECL_GETTER (ULONG, EncryptionStyle);
|
|---|
| 280 | #undef DECL_GETTER
|
|---|
| 281 |
|
|---|
| 282 | /* For VirtualBoxSupportErrorInfoImpl. */
|
|---|
| 283 | static const wchar_t *getComponentName() { return L"RemoteDisplayInfo"; }
|
|---|
| 284 |
|
|---|
| 285 | private:
|
|---|
| 286 |
|
|---|
| 287 | const ComObjPtr <Console, ComWeakRef> mParent;
|
|---|
| 288 | };
|
|---|
| 289 |
|
|---|
| 290 | #endif // ____H_CONSOLEVRDPSERVER
|
|---|
