VirtualBox

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

Last change on this file since 7466 was 5999, checked in by vboxsync, 17 years ago

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