VirtualBox

source: vbox/trunk/src/VBox/Main/include/ConsoleVRDPServer.h@ 8217

Last change on this file since 8217 was 8155, checked in by vboxsync, 17 years ago

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