VirtualBox

source: vbox/trunk/src/VBox/Main/ConsoleVRDPServer.cpp@ 21337

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

Main: make VBox interfaces scriptable (that is, callable from Python and VisualBasic)
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 65.2 KB
Line 
1/* $Id: ConsoleVRDPServer.cpp 19134 2009-04-23 09:21:43Z vboxsync $ */
2
3/** @file
4 *
5 * VBox Console VRDP Helper class
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#include "ConsoleVRDPServer.h"
25#include "ConsoleImpl.h"
26#include "DisplayImpl.h"
27#include "KeyboardImpl.h"
28#include "MouseImpl.h"
29
30#include "Logging.h"
31
32#include <iprt/asm.h>
33#include <iprt/ldr.h>
34#include <iprt/param.h>
35#include <iprt/path.h>
36#include <iprt/alloca.h>
37
38#include <VBox/err.h>
39#ifdef VBOX_WITH_VRDP
40#include <VBox/VRDPOrders.h>
41#endif /* VBOX_WITH_VRDP */
42
43class VRDPConsoleCallback :
44 VBOX_SCRIPTABLE_IMPL(IConsoleCallback)
45{
46public:
47 VRDPConsoleCallback (ConsoleVRDPServer *server) :
48 m_server(server)
49 {
50#ifndef VBOX_WITH_XPCOM
51 refcnt = 0;
52#endif /* !VBOX_WITH_XPCOM */
53 }
54
55 virtual ~VRDPConsoleCallback() {}
56
57 NS_DECL_ISUPPORTS
58
59#ifndef VBOX_WITH_XPCOM
60 STDMETHOD_(ULONG, AddRef)() {
61 return ::InterlockedIncrement (&refcnt);
62 }
63 STDMETHOD_(ULONG, Release)()
64 {
65 long cnt = ::InterlockedDecrement (&refcnt);
66 if (cnt == 0)
67 delete this;
68 return cnt;
69 }
70 STDMETHOD(QueryInterface) (REFIID riid , void **ppObj)
71 {
72 if (riid == IID_IUnknown) {
73 *ppObj = this;
74 AddRef();
75 return S_OK;
76 }
77 if (riid == IID_IConsoleCallback) {
78 *ppObj = this;
79 AddRef();
80 return S_OK;
81 }
82 *ppObj = NULL;
83 return E_NOINTERFACE;
84 }
85#endif /* !VBOX_WITH_XPCOM */
86
87
88 STDMETHOD(OnMousePointerShapeChange)(BOOL visible, BOOL alpha, ULONG xHot, ULONG yHot,
89 ULONG width, ULONG height, BYTE *shape);
90
91 STDMETHOD(OnMouseCapabilityChange)(BOOL supportsAbsolute, BOOL needsHostCursor)
92 {
93 if (m_server)
94 {
95 m_server->NotifyAbsoluteMouse(!!supportsAbsolute);
96 }
97 return S_OK;
98 }
99
100 STDMETHOD(OnKeyboardLedsChange)(BOOL fNumLock, BOOL fCapsLock, BOOL fScrollLock)
101 {
102 if (m_server)
103 {
104 m_server->NotifyKeyboardLedsChange (fNumLock, fCapsLock, fScrollLock);
105 }
106 return S_OK;
107 }
108
109 STDMETHOD(OnStateChange)(MachineState_T machineState)
110 {
111 return S_OK;
112 }
113
114 STDMETHOD(OnAdditionsStateChange)()
115 {
116 return S_OK;
117 }
118
119 STDMETHOD(OnDVDDriveChange)()
120 {
121 return S_OK;
122 }
123
124 STDMETHOD(OnFloppyDriveChange)()
125 {
126 return S_OK;
127 }
128
129 STDMETHOD(OnNetworkAdapterChange) (INetworkAdapter *aNetworkAdapter)
130 {
131 return S_OK;
132 }
133
134 STDMETHOD(OnSerialPortChange) (ISerialPort *aSerialPort)
135 {
136 return S_OK;
137 }
138
139 STDMETHOD(OnParallelPortChange) (IParallelPort *aParallelPort)
140 {
141 return S_OK;
142 }
143
144 STDMETHOD(OnStorageControllerChange) ()
145 {
146 return S_OK;
147 }
148
149 STDMETHOD(OnVRDPServerChange)()
150 {
151 return S_OK;
152 }
153
154 STDMETHOD(OnUSBControllerChange)()
155 {
156 return S_OK;
157 }
158
159 STDMETHOD(OnUSBDeviceStateChange)(IUSBDevice *aDevice, BOOL aAttached,
160 IVirtualBoxErrorInfo *aError)
161 {
162 return S_OK;
163 }
164
165 STDMETHOD(OnSharedFolderChange) (Scope_T aScope)
166 {
167 return S_OK;
168 }
169
170 STDMETHOD(OnRuntimeError)(BOOL fatal, IN_BSTR id, IN_BSTR message)
171 {
172 return S_OK;
173 }
174
175 STDMETHOD(OnCanShowWindow)(BOOL *canShow)
176 {
177 if (!canShow)
178 return E_POINTER;
179 /* we don't manage window activation here: always agree */
180 *canShow = TRUE;
181 return S_OK;
182 }
183
184 STDMETHOD(OnShowWindow) (ULONG64 *winId)
185 {
186 if (!winId)
187 return E_POINTER;
188 /* we don't manage window activation here */
189 *winId = 0;
190 return S_OK;
191 }
192
193private:
194 ConsoleVRDPServer *m_server;
195#ifndef VBOX_WITH_XPCOM
196 long refcnt;
197#endif /* !VBOX_WITH_XPCOM */
198};
199
200#ifdef VBOX_WITH_XPCOM
201#include <nsMemory.h>
202NS_DECL_CLASSINFO(VRDPConsoleCallback)
203NS_IMPL_THREADSAFE_ISUPPORTS1_CI(VRDPConsoleCallback, IConsoleCallback)
204#endif /* VBOX_WITH_XPCOM */
205
206#ifdef DEBUG_sunlover
207#define LOGDUMPPTR Log
208void dumpPointer (const uint8_t *pu8Shape, uint32_t width, uint32_t height, bool fXorMaskRGB32)
209{
210 unsigned i;
211
212 const uint8_t *pu8And = pu8Shape;
213
214 for (i = 0; i < height; i++)
215 {
216 unsigned j;
217 LOGDUMPPTR(("%p: ", pu8And));
218 for (j = 0; j < (width + 7) / 8; j++)
219 {
220 unsigned k;
221 for (k = 0; k < 8; k++)
222 {
223 LOGDUMPPTR(("%d", ((*pu8And) & (1 << (7 - k)))? 1: 0));
224 }
225
226 pu8And++;
227 }
228 LOGDUMPPTR(("\n"));
229 }
230
231 if (fXorMaskRGB32)
232 {
233 uint32_t *pu32Xor = (uint32_t *)(pu8Shape + ((((width + 7) / 8) * height + 3) & ~3));
234
235 for (i = 0; i < height; i++)
236 {
237 unsigned j;
238 LOGDUMPPTR(("%p: ", pu32Xor));
239 for (j = 0; j < width; j++)
240 {
241 LOGDUMPPTR(("%08X", *pu32Xor++));
242 }
243 LOGDUMPPTR(("\n"));
244 }
245 }
246 else
247 {
248 /* RDP 24 bit RGB mask. */
249 uint8_t *pu8Xor = (uint8_t *)(pu8Shape + ((((width + 7) / 8) * height + 3) & ~3));
250 for (i = 0; i < height; i++)
251 {
252 unsigned j;
253 LOGDUMPPTR(("%p: ", pu8Xor));
254 for (j = 0; j < width; j++)
255 {
256 LOGDUMPPTR(("%02X%02X%02X", pu8Xor[2], pu8Xor[1], pu8Xor[0]));
257 pu8Xor += 3;
258 }
259 LOGDUMPPTR(("\n"));
260 }
261 }
262}
263#else
264#define dumpPointer(a, b, c, d) do {} while (0)
265#endif /* DEBUG_sunlover */
266
267static void findTopLeftBorder (const uint8_t *pu8AndMask, const uint8_t *pu8XorMask, uint32_t width, uint32_t height, uint32_t *pxSkip, uint32_t *pySkip)
268{
269 /*
270 * Find the top border of the AND mask. First assign to special value.
271 */
272 uint32_t ySkipAnd = ~0;
273
274 const uint8_t *pu8And = pu8AndMask;
275 const uint32_t cbAndRow = (width + 7) / 8;
276 const uint8_t maskLastByte = (uint8_t)( 0xFF << (cbAndRow * 8 - width) );
277
278 Assert(cbAndRow > 0);
279
280 unsigned y;
281 unsigned x;
282
283 for (y = 0; y < height && ySkipAnd == ~(uint32_t)0; y++, pu8And += cbAndRow)
284 {
285 /* For each complete byte in the row. */
286 for (x = 0; x < cbAndRow - 1; x++)
287 {
288 if (pu8And[x] != 0xFF)
289 {
290 ySkipAnd = y;
291 break;
292 }
293 }
294
295 if (ySkipAnd == ~(uint32_t)0)
296 {
297 /* Last byte. */
298 if ((pu8And[cbAndRow - 1] & maskLastByte) != maskLastByte)
299 {
300 ySkipAnd = y;
301 }
302 }
303 }
304
305 if (ySkipAnd == ~(uint32_t)0)
306 {
307 ySkipAnd = 0;
308 }
309
310 /*
311 * Find the left border of the AND mask.
312 */
313 uint32_t xSkipAnd = ~0;
314
315 /* For all bit columns. */
316 for (x = 0; x < width && xSkipAnd == ~(uint32_t)0; x++)
317 {
318 pu8And = pu8AndMask + x/8; /* Currently checking byte. */
319 uint8_t mask = 1 << (7 - x%8); /* Currently checking bit in the byte. */
320
321 for (y = ySkipAnd; y < height; y++, pu8And += cbAndRow)
322 {
323 if ((*pu8And & mask) == 0)
324 {
325 xSkipAnd = x;
326 break;
327 }
328 }
329 }
330
331 if (xSkipAnd == ~(uint32_t)0)
332 {
333 xSkipAnd = 0;
334 }
335
336 /*
337 * Find the XOR mask top border.
338 */
339 uint32_t ySkipXor = ~0;
340
341 uint32_t *pu32XorStart = (uint32_t *)pu8XorMask;
342
343 uint32_t *pu32Xor = pu32XorStart;
344
345 for (y = 0; y < height && ySkipXor == ~(uint32_t)0; y++, pu32Xor += width)
346 {
347 for (x = 0; x < width; x++)
348 {
349 if (pu32Xor[x] != 0)
350 {
351 ySkipXor = y;
352 break;
353 }
354 }
355 }
356
357 if (ySkipXor == ~(uint32_t)0)
358 {
359 ySkipXor = 0;
360 }
361
362 /*
363 * Find the left border of the XOR mask.
364 */
365 uint32_t xSkipXor = ~(uint32_t)0;
366
367 /* For all columns. */
368 for (x = 0; x < width && xSkipXor == ~(uint32_t)0; x++)
369 {
370 pu32Xor = pu32XorStart + x; /* Currently checking dword. */
371
372 for (y = ySkipXor; y < height; y++, pu32Xor += width)
373 {
374 if (*pu32Xor != 0)
375 {
376 xSkipXor = x;
377 break;
378 }
379 }
380 }
381
382 if (xSkipXor == ~(uint32_t)0)
383 {
384 xSkipXor = 0;
385 }
386
387 *pxSkip = RT_MIN (xSkipAnd, xSkipXor);
388 *pySkip = RT_MIN (ySkipAnd, ySkipXor);
389}
390
391/* Generate an AND mask for alpha pointers here, because
392 * guest driver does not do that correctly for Vista pointers.
393 * Similar fix, changing the alpha threshold, could be applied
394 * for the guest driver, but then additions reinstall would be
395 * necessary, which we try to avoid.
396 */
397static void mousePointerGenerateANDMask (uint8_t *pu8DstAndMask, int cbDstAndMask, const uint8_t *pu8SrcAlpha, int w, int h)
398{
399 memset (pu8DstAndMask, 0xFF, cbDstAndMask);
400
401 int y;
402 for (y = 0; y < h; y++)
403 {
404 uint8_t bitmask = 0x80;
405
406 int x;
407 for (x = 0; x < w; x++, bitmask >>= 1)
408 {
409 if (bitmask == 0)
410 {
411 bitmask = 0x80;
412 }
413
414 /* Whether alpha channel value is not transparent enough for the pixel to be seen. */
415 if (pu8SrcAlpha[x * 4 + 3] > 0x7f)
416 {
417 pu8DstAndMask[x / 8] &= ~bitmask;
418 }
419 }
420
421 /* Point to next source and dest scans. */
422 pu8SrcAlpha += w * 4;
423 pu8DstAndMask += (w + 7) / 8;
424 }
425}
426
427STDMETHODIMP VRDPConsoleCallback::OnMousePointerShapeChange (
428 BOOL visible,
429 BOOL alpha,
430 ULONG xHot,
431 ULONG yHot,
432 ULONG width,
433 ULONG height,
434 BYTE *shape)
435{
436 LogSunlover(("VRDPConsoleCallback::OnMousePointerShapeChange: %d, %d, %lux%lu, @%lu,%lu\n", visible, alpha, width, height, xHot, yHot));
437
438 if (m_server)
439 {
440 if (!shape)
441 {
442 if (!visible)
443 {
444 m_server->MousePointerHide ();
445 }
446 }
447 else if (width != 0 && height != 0)
448 {
449 /* Pointer consists of 1 bpp AND and 24 BPP XOR masks.
450 * 'shape' AND mask followed by XOR mask.
451 * XOR mask contains 32 bit (lsb)BGR0(msb) values.
452 *
453 * We convert this to RDP color format which consist of
454 * one bpp AND mask and 24 BPP (BGR) color XOR image.
455 *
456 * RDP clients expect 8 aligned width and height of
457 * pointer (preferably 32x32).
458 *
459 * They even contain bugs which do not appear for
460 * 32x32 pointers but would appear for a 41x32 one.
461 *
462 * So set pointer size to 32x32. This can be done safely
463 * because most pointers are 32x32.
464 */
465
466 dumpPointer (shape, width, height, true);
467
468 int cbDstAndMask = (((width + 7) / 8) * height + 3) & ~3;
469
470 uint8_t *pu8AndMask = shape;
471 uint8_t *pu8XorMask = shape + cbDstAndMask;
472
473 if (alpha)
474 {
475 pu8AndMask = (uint8_t *)alloca (cbDstAndMask);
476
477 mousePointerGenerateANDMask (pu8AndMask, cbDstAndMask, pu8XorMask, width, height);
478 }
479
480 /* Windows guest alpha pointers are wider than 32 pixels.
481 * Try to find out the top-left border of the pointer and
482 * then copy only meaningful bits. All complete top rows
483 * and all complete left columns where (AND == 1 && XOR == 0)
484 * are skipped. Hot spot is adjusted.
485 */
486 uint32_t ySkip = 0; /* How many rows to skip at the top. */
487 uint32_t xSkip = 0; /* How many columns to skip at the left. */
488
489 findTopLeftBorder (pu8AndMask, pu8XorMask, width, height, &xSkip, &ySkip);
490
491 /* Must not skip the hot spot. */
492 xSkip = RT_MIN (xSkip, xHot);
493 ySkip = RT_MIN (ySkip, yHot);
494
495 /*
496 * Compute size and allocate memory for the pointer.
497 */
498 const uint32_t dstwidth = 32;
499 const uint32_t dstheight = 32;
500
501 VRDPCOLORPOINTER *pointer = NULL;
502
503 uint32_t dstmaskwidth = (dstwidth + 7) / 8;
504
505 uint32_t rdpmaskwidth = dstmaskwidth;
506 uint32_t rdpmasklen = dstheight * rdpmaskwidth;
507
508 uint32_t rdpdatawidth = dstwidth * 3;
509 uint32_t rdpdatalen = dstheight * rdpdatawidth;
510
511 pointer = (VRDPCOLORPOINTER *)RTMemTmpAlloc (sizeof (VRDPCOLORPOINTER) + rdpmasklen + rdpdatalen);
512
513 if (pointer)
514 {
515 uint8_t *maskarray = (uint8_t *)pointer + sizeof (VRDPCOLORPOINTER);
516 uint8_t *dataarray = maskarray + rdpmasklen;
517
518 memset (maskarray, 0xFF, rdpmasklen);
519 memset (dataarray, 0x00, rdpdatalen);
520
521 uint32_t srcmaskwidth = (width + 7) / 8;
522 uint32_t srcdatawidth = width * 4;
523
524 /* Copy AND mask. */
525 uint8_t *src = pu8AndMask + ySkip * srcmaskwidth;
526 uint8_t *dst = maskarray + (dstheight - 1) * rdpmaskwidth;
527
528 uint32_t minheight = RT_MIN (height - ySkip, dstheight);
529 uint32_t minwidth = RT_MIN (width - xSkip, dstwidth);
530
531 unsigned x, y;
532
533 for (y = 0; y < minheight; y++)
534 {
535 for (x = 0; x < minwidth; x++)
536 {
537 uint32_t byteIndex = (x + xSkip) / 8;
538 uint32_t bitIndex = (x + xSkip) % 8;
539
540 bool bit = (src[byteIndex] & (1 << (7 - bitIndex))) != 0;
541
542 if (!bit)
543 {
544 byteIndex = x / 8;
545 bitIndex = x % 8;
546
547 dst[byteIndex] &= ~(1 << (7 - bitIndex));
548 }
549 }
550
551 src += srcmaskwidth;
552 dst -= rdpmaskwidth;
553 }
554
555 /* Point src to XOR mask */
556 src = pu8XorMask + ySkip * srcdatawidth;
557 dst = dataarray + (dstheight - 1) * rdpdatawidth;
558
559 for (y = 0; y < minheight ; y++)
560 {
561 for (x = 0; x < minwidth; x++)
562 {
563 memcpy (dst + x * 3, &src[4 * (x + xSkip)], 3);
564 }
565
566 src += srcdatawidth;
567 dst -= rdpdatawidth;
568 }
569
570 pointer->u16HotX = (uint16_t)(xHot - xSkip);
571 pointer->u16HotY = (uint16_t)(yHot - ySkip);
572
573 pointer->u16Width = (uint16_t)dstwidth;
574 pointer->u16Height = (uint16_t)dstheight;
575
576 pointer->u16MaskLen = (uint16_t)rdpmasklen;
577 pointer->u16DataLen = (uint16_t)rdpdatalen;
578
579 dumpPointer ((uint8_t *)pointer + sizeof (*pointer), dstwidth, dstheight, false);
580
581 m_server->MousePointerUpdate (pointer);
582
583 RTMemTmpFree (pointer);
584 }
585 }
586 }
587
588 return S_OK;
589}
590
591
592// ConsoleVRDPServer
593////////////////////////////////////////////////////////////////////////////////
594
595#ifdef VBOX_WITH_VRDP
596RTLDRMOD ConsoleVRDPServer::mVRDPLibrary;
597
598PFNVRDPCREATESERVER ConsoleVRDPServer::mpfnVRDPCreateServer = NULL;
599
600VRDPENTRYPOINTS_1 *ConsoleVRDPServer::mpEntryPoints = NULL;
601
602VRDPCALLBACKS_1 ConsoleVRDPServer::mCallbacks =
603{
604 { VRDP_INTERFACE_VERSION_1, sizeof (VRDPCALLBACKS_1) },
605 ConsoleVRDPServer::VRDPCallbackQueryProperty,
606 ConsoleVRDPServer::VRDPCallbackClientLogon,
607 ConsoleVRDPServer::VRDPCallbackClientConnect,
608 ConsoleVRDPServer::VRDPCallbackClientDisconnect,
609 ConsoleVRDPServer::VRDPCallbackIntercept,
610 ConsoleVRDPServer::VRDPCallbackUSB,
611 ConsoleVRDPServer::VRDPCallbackClipboard,
612 ConsoleVRDPServer::VRDPCallbackFramebufferQuery,
613 ConsoleVRDPServer::VRDPCallbackFramebufferLock,
614 ConsoleVRDPServer::VRDPCallbackFramebufferUnlock,
615 ConsoleVRDPServer::VRDPCallbackInput,
616 ConsoleVRDPServer::VRDPCallbackVideoModeHint
617};
618
619DECLCALLBACK(int) ConsoleVRDPServer::VRDPCallbackQueryProperty (void *pvCallback, uint32_t index, void *pvBuffer, uint32_t cbBuffer, uint32_t *pcbOut)
620{
621 ConsoleVRDPServer *server = static_cast <ConsoleVRDPServer *> (pvCallback);
622
623 int rc = VERR_NOT_SUPPORTED;
624
625 switch (index)
626 {
627 case VRDP_QP_NETWORK_PORT:
628 {
629 ULONG port = 0;
630 server->mConsole->getVRDPServer ()->COMGETTER(Port) (&port);
631 if (port == 0)
632 {
633 port = VRDP_DEFAULT_PORT;
634 }
635
636 if (cbBuffer >= sizeof (uint32_t))
637 {
638 *(uint32_t *)pvBuffer = (uint32_t)port;
639 rc = VINF_SUCCESS;
640 }
641 else
642 {
643 rc = VINF_BUFFER_OVERFLOW;
644 }
645
646 *pcbOut = sizeof (uint32_t);
647 } break;
648
649 case VRDP_QP_NETWORK_ADDRESS:
650 {
651 com::Bstr bstr;
652 server->mConsole->getVRDPServer ()->COMGETTER(NetAddress) (bstr.asOutParam());
653
654 /* The server expects UTF8. */
655 com::Utf8Str address = bstr;
656
657 size_t cbAddress = address.length () + 1;
658
659 if (cbAddress >= 0x10000)
660 {
661 /* More than 64K seems to be an invalid address. */
662 rc = VERR_TOO_MUCH_DATA;
663 break;
664 }
665
666 if ((size_t)cbBuffer >= cbAddress)
667 {
668 if (cbAddress > 0)
669 {
670 if (address.raw())
671 {
672 memcpy (pvBuffer, address.raw(), cbAddress);
673 }
674 else
675 {
676 /* The value is an empty string. */
677 *(uint8_t *)pvBuffer = 0;
678 }
679 }
680
681 rc = VINF_SUCCESS;
682 }
683 else
684 {
685 rc = VINF_BUFFER_OVERFLOW;
686 }
687
688 *pcbOut = (uint32_t)cbAddress;
689 } break;
690
691 case VRDP_QP_NUMBER_MONITORS:
692 {
693 ULONG cMonitors = 1;
694
695 server->mConsole->machine ()->COMGETTER(MonitorCount)(&cMonitors);
696
697 if (cbBuffer >= sizeof (uint32_t))
698 {
699 *(uint32_t *)pvBuffer = (uint32_t)cMonitors;
700 rc = VINF_SUCCESS;
701 }
702 else
703 {
704 rc = VINF_BUFFER_OVERFLOW;
705 }
706
707 *pcbOut = sizeof (uint32_t);
708 } break;
709
710 default:
711 break;
712 }
713
714 return rc;
715}
716
717DECLCALLBACK(int) ConsoleVRDPServer::VRDPCallbackClientLogon (void *pvCallback, uint32_t u32ClientId, const char *pszUser, const char *pszPassword, const char *pszDomain)
718{
719 ConsoleVRDPServer *server = static_cast <ConsoleVRDPServer *> (pvCallback);
720
721 return server->mConsole->VRDPClientLogon (u32ClientId, pszUser, pszPassword, pszDomain);
722}
723
724DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackClientConnect (void *pvCallback, uint32_t u32ClientId)
725{
726 ConsoleVRDPServer *server = static_cast <ConsoleVRDPServer *> (pvCallback);
727
728 server->mConsole->VRDPClientConnect (u32ClientId);
729}
730
731DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackClientDisconnect (void *pvCallback, uint32_t u32ClientId, uint32_t fu32Intercepted)
732{
733 ConsoleVRDPServer *server = static_cast <ConsoleVRDPServer *> (pvCallback);
734
735 server->mConsole->VRDPClientDisconnect (u32ClientId, fu32Intercepted);
736}
737
738DECLCALLBACK(int) ConsoleVRDPServer::VRDPCallbackIntercept (void *pvCallback, uint32_t u32ClientId, uint32_t fu32Intercept, void **ppvIntercept)
739{
740 ConsoleVRDPServer *server = static_cast <ConsoleVRDPServer *> (pvCallback);
741
742 LogFlowFunc(("%x\n", fu32Intercept));
743
744 int rc = VERR_NOT_SUPPORTED;
745
746 switch (fu32Intercept)
747 {
748 case VRDP_CLIENT_INTERCEPT_AUDIO:
749 {
750 server->mConsole->VRDPInterceptAudio (u32ClientId);
751 if (ppvIntercept)
752 {
753 *ppvIntercept = server;
754 }
755 rc = VINF_SUCCESS;
756 } break;
757
758 case VRDP_CLIENT_INTERCEPT_USB:
759 {
760 server->mConsole->VRDPInterceptUSB (u32ClientId, ppvIntercept);
761 rc = VINF_SUCCESS;
762 } break;
763
764 case VRDP_CLIENT_INTERCEPT_CLIPBOARD:
765 {
766 server->mConsole->VRDPInterceptClipboard (u32ClientId);
767 if (ppvIntercept)
768 {
769 *ppvIntercept = server;
770 }
771 rc = VINF_SUCCESS;
772 } break;
773
774 default:
775 break;
776 }
777
778 return rc;
779}
780
781DECLCALLBACK(int) ConsoleVRDPServer::VRDPCallbackUSB (void *pvCallback, void *pvIntercept, uint32_t u32ClientId, uint8_t u8Code, const void *pvRet, uint32_t cbRet)
782{
783#ifdef VBOX_WITH_USB
784 return USBClientResponseCallback (pvIntercept, u32ClientId, u8Code, pvRet, cbRet);
785#else
786 return VERR_NOT_SUPPORTED;
787#endif
788}
789
790DECLCALLBACK(int) ConsoleVRDPServer::VRDPCallbackClipboard (void *pvCallback, void *pvIntercept, uint32_t u32ClientId, uint32_t u32Function, uint32_t u32Format, const void *pvData, uint32_t cbData)
791{
792 return ClipboardCallback (pvIntercept, u32ClientId, u32Function, u32Format, pvData, cbData);
793}
794
795DECLCALLBACK(bool) ConsoleVRDPServer::VRDPCallbackFramebufferQuery (void *pvCallback, unsigned uScreenId, VRDPFRAMEBUFFERINFO *pInfo)
796{
797 ConsoleVRDPServer *server = static_cast <ConsoleVRDPServer *> (pvCallback);
798
799 bool fAvailable = false;
800
801 IFramebuffer *pfb = NULL;
802 LONG xOrigin = 0;
803 LONG yOrigin = 0;
804
805 server->mConsole->getDisplay ()->GetFramebuffer (uScreenId, &pfb, &xOrigin, &yOrigin);
806
807 if (pfb)
808 {
809 pfb->Lock ();
810
811 /* Query framebuffer parameters. */
812 ULONG lineSize = 0;
813 pfb->COMGETTER(BytesPerLine) (&lineSize);
814
815 ULONG bitsPerPixel = 0;
816 pfb->COMGETTER(BitsPerPixel) (&bitsPerPixel);
817
818 BYTE *address = NULL;
819 pfb->COMGETTER(Address) (&address);
820
821 ULONG height = 0;
822 pfb->COMGETTER(Height) (&height);
823
824 ULONG width = 0;
825 pfb->COMGETTER(Width) (&width);
826
827 /* Now fill the information as requested by the caller. */
828 pInfo->pu8Bits = address;
829 pInfo->xOrigin = xOrigin;
830 pInfo->yOrigin = yOrigin;
831 pInfo->cWidth = width;
832 pInfo->cHeight = height;
833 pInfo->cBitsPerPixel = bitsPerPixel;
834 pInfo->cbLine = lineSize;
835
836 pfb->Unlock ();
837
838 fAvailable = true;
839 }
840
841 if (server->maFramebuffers[uScreenId])
842 {
843 server->maFramebuffers[uScreenId]->Release ();
844 }
845 server->maFramebuffers[uScreenId] = pfb;
846
847 return fAvailable;
848}
849
850DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackFramebufferLock (void *pvCallback, unsigned uScreenId)
851{
852 ConsoleVRDPServer *server = static_cast <ConsoleVRDPServer *> (pvCallback);
853
854 if (server->maFramebuffers[uScreenId])
855 {
856 server->maFramebuffers[uScreenId]->Lock ();
857 }
858}
859
860DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackFramebufferUnlock (void *pvCallback, unsigned uScreenId)
861{
862 ConsoleVRDPServer *server = static_cast <ConsoleVRDPServer *> (pvCallback);
863
864 if (server->maFramebuffers[uScreenId])
865 {
866 server->maFramebuffers[uScreenId]->Unlock ();
867 }
868}
869
870static void fixKbdLockStatus (VRDPInputSynch *pInputSynch, IKeyboard *pKeyboard)
871{
872 if ( pInputSynch->cGuestNumLockAdaptions
873 && (pInputSynch->fGuestNumLock != pInputSynch->fClientNumLock))
874 {
875 pInputSynch->cGuestNumLockAdaptions--;
876 pKeyboard->PutScancode(0x45);
877 pKeyboard->PutScancode(0x45 | 0x80);
878 }
879 if ( pInputSynch->cGuestCapsLockAdaptions
880 && (pInputSynch->fGuestCapsLock != pInputSynch->fClientCapsLock))
881 {
882 pInputSynch->cGuestCapsLockAdaptions--;
883 pKeyboard->PutScancode(0x3a);
884 pKeyboard->PutScancode(0x3a | 0x80);
885 }
886}
887
888DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackInput (void *pvCallback, int type, const void *pvInput, unsigned cbInput)
889{
890 ConsoleVRDPServer *server = static_cast <ConsoleVRDPServer *> (pvCallback);
891 Console *pConsole = server->mConsole;
892
893 switch (type)
894 {
895 case VRDP_INPUT_SCANCODE:
896 {
897 if (cbInput == sizeof (VRDPINPUTSCANCODE))
898 {
899 IKeyboard *pKeyboard = pConsole->getKeyboard ();
900
901 const VRDPINPUTSCANCODE *pInputScancode = (VRDPINPUTSCANCODE *)pvInput;
902
903 /* Track lock keys. */
904 if (pInputScancode->uScancode == 0x45)
905 {
906 server->m_InputSynch.fClientNumLock = !server->m_InputSynch.fClientNumLock;
907 }
908 else if (pInputScancode->uScancode == 0x3a)
909 {
910 server->m_InputSynch.fClientCapsLock = !server->m_InputSynch.fClientCapsLock;
911 }
912 else if (pInputScancode->uScancode == 0x46)
913 {
914 server->m_InputSynch.fClientScrollLock = !server->m_InputSynch.fClientScrollLock;
915 }
916 else if ((pInputScancode->uScancode & 0x80) == 0)
917 {
918 /* Key pressed. */
919 fixKbdLockStatus (&server->m_InputSynch, pKeyboard);
920 }
921
922 pKeyboard->PutScancode((LONG)pInputScancode->uScancode);
923 }
924 } break;
925
926 case VRDP_INPUT_POINT:
927 {
928 if (cbInput == sizeof (VRDPINPUTPOINT))
929 {
930 const VRDPINPUTPOINT *pInputPoint = (VRDPINPUTPOINT *)pvInput;
931
932 int mouseButtons = 0;
933 int iWheel = 0;
934
935 if (pInputPoint->uButtons & VRDP_INPUT_POINT_BUTTON1)
936 {
937 mouseButtons |= MouseButtonState_LeftButton;
938 }
939 if (pInputPoint->uButtons & VRDP_INPUT_POINT_BUTTON2)
940 {
941 mouseButtons |= MouseButtonState_RightButton;
942 }
943 if (pInputPoint->uButtons & VRDP_INPUT_POINT_BUTTON3)
944 {
945 mouseButtons |= MouseButtonState_MiddleButton;
946 }
947 if (pInputPoint->uButtons & VRDP_INPUT_POINT_WHEEL_UP)
948 {
949 mouseButtons |= MouseButtonState_WheelUp;
950 iWheel = -1;
951 }
952 if (pInputPoint->uButtons & VRDP_INPUT_POINT_WHEEL_DOWN)
953 {
954 mouseButtons |= MouseButtonState_WheelDown;
955 iWheel = 1;
956 }
957
958 if (server->m_fGuestWantsAbsolute)
959 {
960 pConsole->getMouse()->PutMouseEventAbsolute (pInputPoint->x + 1, pInputPoint->y + 1, iWheel, mouseButtons);
961 } else
962 {
963 pConsole->getMouse()->PutMouseEvent (pInputPoint->x - server->m_mousex,
964 pInputPoint->y - server->m_mousey,
965 iWheel, mouseButtons);
966 server->m_mousex = pInputPoint->x;
967 server->m_mousey = pInputPoint->y;
968 }
969 }
970 } break;
971
972 case VRDP_INPUT_CAD:
973 {
974 pConsole->getKeyboard ()->PutCAD();
975 } break;
976
977 case VRDP_INPUT_RESET:
978 {
979 pConsole->Reset();
980 } break;
981
982 case VRDP_INPUT_SYNCH:
983 {
984 if (cbInput == sizeof (VRDPINPUTSYNCH))
985 {
986 IKeyboard *pKeyboard = pConsole->getKeyboard ();
987
988 const VRDPINPUTSYNCH *pInputSynch = (VRDPINPUTSYNCH *)pvInput;
989
990 server->m_InputSynch.fClientNumLock = (pInputSynch->uLockStatus & VRDP_INPUT_SYNCH_NUMLOCK) != 0;
991 server->m_InputSynch.fClientCapsLock = (pInputSynch->uLockStatus & VRDP_INPUT_SYNCH_CAPITAL) != 0;
992 server->m_InputSynch.fClientScrollLock = (pInputSynch->uLockStatus & VRDP_INPUT_SYNCH_SCROLL) != 0;
993
994 /* The client initiated synchronization. Always make the guest to reflect the client state.
995 * Than means, when the guest changes the state itself, it is forced to return to the client
996 * state.
997 */
998 if (server->m_InputSynch.fClientNumLock != server->m_InputSynch.fGuestNumLock)
999 {
1000 server->m_InputSynch.cGuestNumLockAdaptions = 2;
1001 }
1002
1003 if (server->m_InputSynch.fClientCapsLock != server->m_InputSynch.fGuestCapsLock)
1004 {
1005 server->m_InputSynch.cGuestCapsLockAdaptions = 2;
1006 }
1007
1008 fixKbdLockStatus (&server->m_InputSynch, pKeyboard);
1009 }
1010 } break;
1011
1012 default:
1013 break;
1014 }
1015}
1016
1017DECLCALLBACK(void) ConsoleVRDPServer::VRDPCallbackVideoModeHint (void *pvCallback, unsigned cWidth, unsigned cHeight, unsigned cBitsPerPixel, unsigned uScreenId)
1018{
1019 ConsoleVRDPServer *server = static_cast <ConsoleVRDPServer *> (pvCallback);
1020
1021 server->mConsole->getDisplay ()->SetVideoModeHint(cWidth, cHeight, cBitsPerPixel, uScreenId);
1022}
1023#endif /* VBOX_WITH_VRDP */
1024
1025ConsoleVRDPServer::ConsoleVRDPServer (Console *console)
1026{
1027 mConsole = console;
1028
1029 int rc = RTCritSectInit (&mCritSect);
1030 AssertRC (rc);
1031
1032 mcClipboardRefs = 0;
1033 mpfnClipboardCallback = NULL;
1034
1035#ifdef VBOX_WITH_USB
1036 mUSBBackends.pHead = NULL;
1037 mUSBBackends.pTail = NULL;
1038
1039 mUSBBackends.thread = NIL_RTTHREAD;
1040 mUSBBackends.fThreadRunning = false;
1041 mUSBBackends.event = 0;
1042#endif
1043
1044#ifdef VBOX_WITH_VRDP
1045 mhServer = 0;
1046
1047 m_fGuestWantsAbsolute = false;
1048 m_mousex = 0;
1049 m_mousey = 0;
1050
1051 m_InputSynch.cGuestNumLockAdaptions = 2;
1052 m_InputSynch.cGuestCapsLockAdaptions = 2;
1053
1054 m_InputSynch.fGuestNumLock = false;
1055 m_InputSynch.fGuestCapsLock = false;
1056 m_InputSynch.fGuestScrollLock = false;
1057
1058 m_InputSynch.fClientNumLock = false;
1059 m_InputSynch.fClientCapsLock = false;
1060 m_InputSynch.fClientScrollLock = false;
1061
1062 memset (maFramebuffers, 0, sizeof (maFramebuffers));
1063
1064 mConsoleCallback = new VRDPConsoleCallback(this);
1065 mConsoleCallback->AddRef();
1066 console->RegisterCallback(mConsoleCallback);
1067#endif /* VBOX_WITH_VRDP */
1068
1069 mAuthLibrary = 0;
1070}
1071
1072ConsoleVRDPServer::~ConsoleVRDPServer ()
1073{
1074 Stop ();
1075
1076#ifdef VBOX_WITH_VRDP
1077 if (mConsoleCallback)
1078 {
1079 mConsole->UnregisterCallback(mConsoleCallback);
1080 mConsoleCallback->Release();
1081 mConsoleCallback = NULL;
1082 }
1083
1084 unsigned i;
1085 for (i = 0; i < RT_ELEMENTS(maFramebuffers); i++)
1086 {
1087 if (maFramebuffers[i])
1088 {
1089 maFramebuffers[i]->Release ();
1090 maFramebuffers[i] = NULL;
1091 }
1092 }
1093#endif /* VBOX_WITH_VRDP */
1094
1095 if (RTCritSectIsInitialized (&mCritSect))
1096 {
1097 RTCritSectDelete (&mCritSect);
1098 memset (&mCritSect, 0, sizeof (mCritSect));
1099 }
1100}
1101
1102int ConsoleVRDPServer::Launch (void)
1103{
1104 LogFlowMember(("ConsoleVRDPServer::Launch\n"));
1105#ifdef VBOX_WITH_VRDP
1106 int rc = VINF_SUCCESS;
1107 IVRDPServer *vrdpserver = mConsole->getVRDPServer ();
1108 Assert(vrdpserver);
1109 BOOL vrdpEnabled = FALSE;
1110
1111 HRESULT rc2 = vrdpserver->COMGETTER(Enabled) (&vrdpEnabled);
1112 AssertComRC(rc2);
1113
1114 if (SUCCEEDED (rc2) && vrdpEnabled)
1115 {
1116 if (loadVRDPLibrary ())
1117 {
1118 rc = mpfnVRDPCreateServer (&mCallbacks.header, this, (VRDPINTERFACEHDR **)&mpEntryPoints, &mhServer);
1119
1120 if (RT_SUCCESS(rc))
1121 {
1122#ifdef VBOX_WITH_USB
1123 remoteUSBThreadStart ();
1124#endif /* VBOX_WITH_USB */
1125 }
1126 else
1127 AssertMsgFailed(("Could not start VRDP server: rc = %Rrc\n", rc));
1128 }
1129 else
1130 {
1131 AssertMsgFailed(("Could not load the VRDP library\n"));
1132 rc = VERR_FILE_NOT_FOUND;
1133 }
1134 }
1135#else
1136 int rc = VERR_NOT_SUPPORTED;
1137 LogRel(("VRDP: this version does not include the VRDP server.\n"));
1138#endif /* VBOX_WITH_VRDP */
1139 return rc;
1140}
1141
1142void ConsoleVRDPServer::EnableConnections (void)
1143{
1144#ifdef VBOX_WITH_VRDP
1145 if (mpEntryPoints && mhServer)
1146 {
1147 mpEntryPoints->VRDPEnableConnections (mhServer, true);
1148 }
1149#endif /* VBOX_WITH_VRDP */
1150}
1151
1152void ConsoleVRDPServer::DisconnectClient (uint32_t u32ClientId, bool fReconnect)
1153{
1154#ifdef VBOX_WITH_VRDP
1155 if (mpEntryPoints && mhServer)
1156 {
1157 mpEntryPoints->VRDPDisconnect (mhServer, u32ClientId, fReconnect);
1158 }
1159#endif /* VBOX_WITH_VRDP */
1160}
1161
1162void ConsoleVRDPServer::MousePointerUpdate (const VRDPCOLORPOINTER *pPointer)
1163{
1164#ifdef VBOX_WITH_VRDP
1165 if (mpEntryPoints && mhServer)
1166 {
1167 mpEntryPoints->VRDPColorPointer (mhServer, pPointer);
1168 }
1169#endif /* VBOX_WITH_VRDP */
1170}
1171
1172void ConsoleVRDPServer::MousePointerHide (void)
1173{
1174#ifdef VBOX_WITH_VRDP
1175 if (mpEntryPoints && mhServer)
1176 {
1177 mpEntryPoints->VRDPHidePointer (mhServer);
1178 }
1179#endif /* VBOX_WITH_VRDP */
1180}
1181
1182void ConsoleVRDPServer::Stop (void)
1183{
1184 Assert(VALID_PTR(this)); /** @todo r=bird: there are(/was) some odd cases where this buster was invalid on
1185 * linux. Just remove this when it's 100% sure that problem has been fixed. */
1186#ifdef VBOX_WITH_VRDP
1187 if (mhServer)
1188 {
1189 HVRDPSERVER hServer = mhServer;
1190
1191 /* Reset the handle to avoid further calls to the server. */
1192 mhServer = 0;
1193
1194 if (mpEntryPoints && hServer)
1195 {
1196 mpEntryPoints->VRDPDestroy (hServer);
1197 }
1198 }
1199#endif /* VBOX_WITH_VRDP */
1200
1201#ifdef VBOX_WITH_USB
1202 remoteUSBThreadStop ();
1203#endif /* VBOX_WITH_USB */
1204
1205 mpfnAuthEntry = NULL;
1206 mpfnAuthEntry2 = NULL;
1207
1208 if (mAuthLibrary)
1209 {
1210 RTLdrClose(mAuthLibrary);
1211 mAuthLibrary = 0;
1212 }
1213}
1214
1215/* Worker thread for Remote USB. The thread polls the clients for
1216 * the list of attached USB devices.
1217 * The thread is also responsible for attaching/detaching devices
1218 * to/from the VM.
1219 *
1220 * It is expected that attaching/detaching is not a frequent operation.
1221 *
1222 * The thread is always running when the VRDP server is active.
1223 *
1224 * The thread scans backends and requests the device list every 2 seconds.
1225 *
1226 * When device list is available, the thread calls the Console to process it.
1227 *
1228 */
1229#define VRDP_DEVICE_LIST_PERIOD_MS (2000)
1230
1231#ifdef VBOX_WITH_USB
1232static DECLCALLBACK(int) threadRemoteUSB (RTTHREAD self, void *pvUser)
1233{
1234 ConsoleVRDPServer *pOwner = (ConsoleVRDPServer *)pvUser;
1235
1236 LogFlow(("Console::threadRemoteUSB: start. owner = %p.\n", pOwner));
1237
1238 pOwner->notifyRemoteUSBThreadRunning (self);
1239
1240 while (pOwner->isRemoteUSBThreadRunning ())
1241 {
1242 RemoteUSBBackend *pRemoteUSBBackend = NULL;
1243
1244 while ((pRemoteUSBBackend = pOwner->usbBackendGetNext (pRemoteUSBBackend)) != NULL)
1245 {
1246 pRemoteUSBBackend->PollRemoteDevices ();
1247 }
1248
1249 pOwner->waitRemoteUSBThreadEvent (VRDP_DEVICE_LIST_PERIOD_MS);
1250
1251 LogFlow(("Console::threadRemoteUSB: iteration. owner = %p.\n", pOwner));
1252 }
1253
1254 return VINF_SUCCESS;
1255}
1256
1257void ConsoleVRDPServer::notifyRemoteUSBThreadRunning (RTTHREAD thread)
1258{
1259 mUSBBackends.thread = thread;
1260 mUSBBackends.fThreadRunning = true;
1261 int rc = RTThreadUserSignal (thread);
1262 AssertRC (rc);
1263}
1264
1265bool ConsoleVRDPServer::isRemoteUSBThreadRunning (void)
1266{
1267 return mUSBBackends.fThreadRunning;
1268}
1269
1270void ConsoleVRDPServer::waitRemoteUSBThreadEvent (unsigned cMillies)
1271{
1272 int rc = RTSemEventWait (mUSBBackends.event, cMillies);
1273 Assert (RT_SUCCESS(rc) || rc == VERR_TIMEOUT);
1274 NOREF(rc);
1275}
1276
1277void ConsoleVRDPServer::remoteUSBThreadStart (void)
1278{
1279 int rc = RTSemEventCreate (&mUSBBackends.event);
1280
1281 if (RT_FAILURE (rc))
1282 {
1283 AssertFailed ();
1284 mUSBBackends.event = 0;
1285 }
1286
1287 if (RT_SUCCESS (rc))
1288 {
1289 rc = RTThreadCreate (&mUSBBackends.thread, threadRemoteUSB, this, 65536,
1290 RTTHREADTYPE_VRDP_IO, RTTHREADFLAGS_WAITABLE, "remote usb");
1291 }
1292
1293 if (RT_FAILURE (rc))
1294 {
1295 LogRel(("Warning: could not start the remote USB thread, rc = %Rrc!!!\n", rc));
1296 mUSBBackends.thread = NIL_RTTHREAD;
1297 }
1298 else
1299 {
1300 /* Wait until the thread is ready. */
1301 rc = RTThreadUserWait (mUSBBackends.thread, 60000);
1302 AssertRC (rc);
1303 Assert (mUSBBackends.fThreadRunning || RT_FAILURE (rc));
1304 }
1305}
1306
1307void ConsoleVRDPServer::remoteUSBThreadStop (void)
1308{
1309 mUSBBackends.fThreadRunning = false;
1310
1311 if (mUSBBackends.thread != NIL_RTTHREAD)
1312 {
1313 Assert (mUSBBackends.event != 0);
1314
1315 RTSemEventSignal (mUSBBackends.event);
1316
1317 int rc = RTThreadWait (mUSBBackends.thread, 60000, NULL);
1318 AssertRC (rc);
1319
1320 mUSBBackends.thread = NIL_RTTHREAD;
1321 }
1322
1323 if (mUSBBackends.event)
1324 {
1325 RTSemEventDestroy (mUSBBackends.event);
1326 mUSBBackends.event = 0;
1327 }
1328}
1329#endif /* VBOX_WITH_USB */
1330
1331VRDPAuthResult ConsoleVRDPServer::Authenticate (const Guid &uuid, VRDPAuthGuestJudgement guestJudgement,
1332 const char *pszUser, const char *pszPassword, const char *pszDomain,
1333 uint32_t u32ClientId)
1334{
1335 VRDPAUTHUUID rawuuid;
1336
1337 memcpy (rawuuid, ((Guid &)uuid).ptr (), sizeof (rawuuid));
1338
1339 LogFlow(("ConsoleVRDPServer::Authenticate: uuid = %RTuuid, guestJudgement = %d, pszUser = %s, pszPassword = %s, pszDomain = %s, u32ClientId = %d\n",
1340 rawuuid, guestJudgement, pszUser, pszPassword, pszDomain, u32ClientId));
1341
1342 /*
1343 * Called only from VRDP input thread. So thread safety is not required.
1344 */
1345
1346 if (!mAuthLibrary)
1347 {
1348 /* Load the external authentication library. */
1349
1350 ComPtr<IMachine> machine;
1351 mConsole->COMGETTER(Machine)(machine.asOutParam());
1352
1353 ComPtr<IVirtualBox> virtualBox;
1354 machine->COMGETTER(Parent)(virtualBox.asOutParam());
1355
1356 ComPtr<ISystemProperties> systemProperties;
1357 virtualBox->COMGETTER(SystemProperties)(systemProperties.asOutParam());
1358
1359 Bstr authLibrary;
1360 systemProperties->COMGETTER(RemoteDisplayAuthLibrary)(authLibrary.asOutParam());
1361
1362 Utf8Str filename = authLibrary;
1363
1364 LogRel(("VRDPAUTH: ConsoleVRDPServer::Authenticate: loading external authentication library '%ls'\n", authLibrary.raw()));
1365
1366 int rc = RTLdrLoad (filename.raw(), &mAuthLibrary);
1367 if (RT_FAILURE (rc))
1368 LogRel(("VRDPAUTH: Failed to load external authentication library. Error code: %Rrc\n", rc));
1369
1370 if (RT_SUCCESS (rc))
1371 {
1372 /* Get the entry point. */
1373 mpfnAuthEntry2 = NULL;
1374 int rc2 = RTLdrGetSymbol(mAuthLibrary, "VRDPAuth2", (void**)&mpfnAuthEntry2);
1375 if (RT_FAILURE (rc2))
1376 {
1377 LogRel(("VRDPAUTH: Could not resolve import '%s'. Error code: %Rrc\n", "VRDPAuth2", rc2));
1378 rc = rc2;
1379 }
1380
1381 /* Get the entry point. */
1382 mpfnAuthEntry = NULL;
1383 rc2 = RTLdrGetSymbol(mAuthLibrary, "VRDPAuth", (void**)&mpfnAuthEntry);
1384 if (RT_FAILURE (rc2))
1385 {
1386 LogRel(("VRDPAUTH: Could not resolve import '%s'. Error code: %Rrc\n", "VRDPAuth", rc2));
1387 rc = rc2;
1388 }
1389
1390 if (mpfnAuthEntry2 || mpfnAuthEntry)
1391 {
1392 LogRel(("VRDPAUTH: Using entry point '%s'.\n", mpfnAuthEntry2? "VRDPAuth2": "VRDPAuth"));
1393 rc = VINF_SUCCESS;
1394 }
1395 }
1396
1397 if (RT_FAILURE (rc))
1398 {
1399 mConsole->reportAuthLibraryError (filename.raw(), rc);
1400
1401 mpfnAuthEntry = NULL;
1402 mpfnAuthEntry2 = NULL;
1403
1404 if (mAuthLibrary)
1405 {
1406 RTLdrClose(mAuthLibrary);
1407 mAuthLibrary = 0;
1408 }
1409
1410 return VRDPAuthAccessDenied;
1411 }
1412 }
1413
1414 Assert (mAuthLibrary && (mpfnAuthEntry || mpfnAuthEntry2));
1415
1416 VRDPAuthResult result = mpfnAuthEntry2?
1417 mpfnAuthEntry2 (&rawuuid, guestJudgement, pszUser, pszPassword, pszDomain, true, u32ClientId):
1418 mpfnAuthEntry (&rawuuid, guestJudgement, pszUser, pszPassword, pszDomain);
1419
1420 switch (result)
1421 {
1422 case VRDPAuthAccessDenied:
1423 LogRel(("VRDPAUTH: external authentication module returned 'access denied'\n"));
1424 break;
1425 case VRDPAuthAccessGranted:
1426 LogRel(("VRDPAUTH: external authentication module returned 'access granted'\n"));
1427 break;
1428 case VRDPAuthDelegateToGuest:
1429 LogRel(("VRDPAUTH: external authentication module returned 'delegate request to guest'\n"));
1430 break;
1431 default:
1432 LogRel(("VRDPAUTH: external authentication module returned incorrect return code %d\n", result));
1433 result = VRDPAuthAccessDenied;
1434 }
1435
1436 LogFlow(("ConsoleVRDPServer::Authenticate: result = %d\n", result));
1437
1438 return result;
1439}
1440
1441void ConsoleVRDPServer::AuthDisconnect (const Guid &uuid, uint32_t u32ClientId)
1442{
1443 VRDPAUTHUUID rawuuid;
1444
1445 memcpy (rawuuid, ((Guid &)uuid).ptr (), sizeof (rawuuid));
1446
1447 LogFlow(("ConsoleVRDPServer::AuthDisconnect: uuid = %RTuuid, u32ClientId = %d\n",
1448 rawuuid, u32ClientId));
1449
1450 Assert (mAuthLibrary && (mpfnAuthEntry || mpfnAuthEntry2));
1451
1452 if (mpfnAuthEntry2)
1453 mpfnAuthEntry2 (&rawuuid, VRDPAuthGuestNotAsked, NULL, NULL, NULL, false, u32ClientId);
1454}
1455
1456int ConsoleVRDPServer::lockConsoleVRDPServer (void)
1457{
1458 int rc = RTCritSectEnter (&mCritSect);
1459 AssertRC (rc);
1460 return rc;
1461}
1462
1463void ConsoleVRDPServer::unlockConsoleVRDPServer (void)
1464{
1465 RTCritSectLeave (&mCritSect);
1466}
1467
1468DECLCALLBACK(int) ConsoleVRDPServer::ClipboardCallback (void *pvCallback,
1469 uint32_t u32ClientId,
1470 uint32_t u32Function,
1471 uint32_t u32Format,
1472 const void *pvData,
1473 uint32_t cbData)
1474{
1475 LogFlowFunc(("pvCallback = %p, u32ClientId = %d, u32Function = %d, u32Format = 0x%08X, pvData = %p, cbData = %d\n",
1476 pvCallback, u32ClientId, u32Function, u32Format, pvData, cbData));
1477
1478 int rc = VINF_SUCCESS;
1479
1480 ConsoleVRDPServer *pServer = static_cast <ConsoleVRDPServer *>(pvCallback);
1481
1482 NOREF(u32ClientId);
1483
1484 switch (u32Function)
1485 {
1486 case VRDP_CLIPBOARD_FUNCTION_FORMAT_ANNOUNCE:
1487 {
1488 if (pServer->mpfnClipboardCallback)
1489 {
1490 pServer->mpfnClipboardCallback (VBOX_CLIPBOARD_EXT_FN_FORMAT_ANNOUNCE,
1491 u32Format,
1492 (void *)pvData,
1493 cbData);
1494 }
1495 } break;
1496
1497 case VRDP_CLIPBOARD_FUNCTION_DATA_READ:
1498 {
1499 if (pServer->mpfnClipboardCallback)
1500 {
1501 pServer->mpfnClipboardCallback (VBOX_CLIPBOARD_EXT_FN_DATA_READ,
1502 u32Format,
1503 (void *)pvData,
1504 cbData);
1505 }
1506 } break;
1507
1508 default:
1509 rc = VERR_NOT_SUPPORTED;
1510 }
1511
1512 return rc;
1513}
1514
1515DECLCALLBACK(int) ConsoleVRDPServer::ClipboardServiceExtension (void *pvExtension,
1516 uint32_t u32Function,
1517 void *pvParms,
1518 uint32_t cbParms)
1519{
1520 LogFlowFunc(("pvExtension = %p, u32Function = %d, pvParms = %p, cbParms = %d\n",
1521 pvExtension, u32Function, pvParms, cbParms));
1522
1523 int rc = VINF_SUCCESS;
1524
1525#ifdef VBOX_WITH_VRDP
1526 ConsoleVRDPServer *pServer = static_cast <ConsoleVRDPServer *>(pvExtension);
1527
1528 VBOXCLIPBOARDEXTPARMS *pParms = (VBOXCLIPBOARDEXTPARMS *)pvParms;
1529
1530 switch (u32Function)
1531 {
1532 case VBOX_CLIPBOARD_EXT_FN_SET_CALLBACK:
1533 {
1534 pServer->mpfnClipboardCallback = pParms->u.pfnCallback;
1535 } break;
1536
1537 case VBOX_CLIPBOARD_EXT_FN_FORMAT_ANNOUNCE:
1538 {
1539 /* The guest announces clipboard formats. This must be delivered to all clients. */
1540 if (mpEntryPoints && pServer->mhServer)
1541 {
1542 mpEntryPoints->VRDPClipboard (pServer->mhServer,
1543 VRDP_CLIPBOARD_FUNCTION_FORMAT_ANNOUNCE,
1544 pParms->u32Format,
1545 NULL,
1546 0,
1547 NULL);
1548 }
1549 } break;
1550
1551 case VBOX_CLIPBOARD_EXT_FN_DATA_READ:
1552 {
1553 /* The clipboard service expects that the pvData buffer will be filled
1554 * with clipboard data. The server returns the data from the client that
1555 * announced the requested format most recently.
1556 */
1557 if (mpEntryPoints && pServer->mhServer)
1558 {
1559 mpEntryPoints->VRDPClipboard (pServer->mhServer,
1560 VRDP_CLIPBOARD_FUNCTION_DATA_READ,
1561 pParms->u32Format,
1562 pParms->u.pvData,
1563 pParms->cbData,
1564 &pParms->cbData);
1565 }
1566 } break;
1567
1568 case VBOX_CLIPBOARD_EXT_FN_DATA_WRITE:
1569 {
1570 if (mpEntryPoints && pServer->mhServer)
1571 {
1572 mpEntryPoints->VRDPClipboard (pServer->mhServer,
1573 VRDP_CLIPBOARD_FUNCTION_DATA_WRITE,
1574 pParms->u32Format,
1575 pParms->u.pvData,
1576 pParms->cbData,
1577 NULL);
1578 }
1579 } break;
1580
1581 default:
1582 rc = VERR_NOT_SUPPORTED;
1583 }
1584#endif /* VBOX_WITH_VRDP */
1585
1586 return rc;
1587}
1588
1589void ConsoleVRDPServer::ClipboardCreate (uint32_t u32ClientId)
1590{
1591 int rc = lockConsoleVRDPServer ();
1592
1593 if (RT_SUCCESS (rc))
1594 {
1595 if (mcClipboardRefs == 0)
1596 {
1597 rc = HGCMHostRegisterServiceExtension (&mhClipboard, "VBoxSharedClipboard", ClipboardServiceExtension, this);
1598
1599 if (RT_SUCCESS (rc))
1600 {
1601 mcClipboardRefs++;
1602 }
1603 }
1604
1605 unlockConsoleVRDPServer ();
1606 }
1607}
1608
1609void ConsoleVRDPServer::ClipboardDelete (uint32_t u32ClientId)
1610{
1611 int rc = lockConsoleVRDPServer ();
1612
1613 if (RT_SUCCESS (rc))
1614 {
1615 mcClipboardRefs--;
1616
1617 if (mcClipboardRefs == 0)
1618 {
1619 HGCMHostUnregisterServiceExtension (mhClipboard);
1620 }
1621
1622 unlockConsoleVRDPServer ();
1623 }
1624}
1625
1626/* That is called on INPUT thread of the VRDP server.
1627 * The ConsoleVRDPServer keeps a list of created backend instances.
1628 */
1629void ConsoleVRDPServer::USBBackendCreate (uint32_t u32ClientId, void **ppvIntercept)
1630{
1631#ifdef VBOX_WITH_USB
1632 LogFlow(("ConsoleVRDPServer::USBBackendCreate: u32ClientId = %d\n", u32ClientId));
1633
1634 /* Create a new instance of the USB backend for the new client. */
1635 RemoteUSBBackend *pRemoteUSBBackend = new RemoteUSBBackend (mConsole, this, u32ClientId);
1636
1637 if (pRemoteUSBBackend)
1638 {
1639 pRemoteUSBBackend->AddRef (); /* 'Release' called in USBBackendDelete. */
1640
1641 /* Append the new instance in the list. */
1642 int rc = lockConsoleVRDPServer ();
1643
1644 if (RT_SUCCESS (rc))
1645 {
1646 pRemoteUSBBackend->pNext = mUSBBackends.pHead;
1647 if (mUSBBackends.pHead)
1648 {
1649 mUSBBackends.pHead->pPrev = pRemoteUSBBackend;
1650 }
1651 else
1652 {
1653 mUSBBackends.pTail = pRemoteUSBBackend;
1654 }
1655
1656 mUSBBackends.pHead = pRemoteUSBBackend;
1657
1658 unlockConsoleVRDPServer ();
1659
1660 if (ppvIntercept)
1661 {
1662 *ppvIntercept = pRemoteUSBBackend;
1663 }
1664 }
1665
1666 if (RT_FAILURE (rc))
1667 {
1668 pRemoteUSBBackend->Release ();
1669 }
1670 }
1671#endif /* VBOX_WITH_USB */
1672}
1673
1674void ConsoleVRDPServer::USBBackendDelete (uint32_t u32ClientId)
1675{
1676#ifdef VBOX_WITH_USB
1677 LogFlow(("ConsoleVRDPServer::USBBackendDelete: u32ClientId = %d\n", u32ClientId));
1678
1679 RemoteUSBBackend *pRemoteUSBBackend = NULL;
1680
1681 /* Find the instance. */
1682 int rc = lockConsoleVRDPServer ();
1683
1684 if (RT_SUCCESS (rc))
1685 {
1686 pRemoteUSBBackend = usbBackendFind (u32ClientId);
1687
1688 if (pRemoteUSBBackend)
1689 {
1690 /* Notify that it will be deleted. */
1691 pRemoteUSBBackend->NotifyDelete ();
1692 }
1693
1694 unlockConsoleVRDPServer ();
1695 }
1696
1697 if (pRemoteUSBBackend)
1698 {
1699 /* Here the instance has been excluded from the list and can be dereferenced. */
1700 pRemoteUSBBackend->Release ();
1701 }
1702#endif
1703}
1704
1705void *ConsoleVRDPServer::USBBackendRequestPointer (uint32_t u32ClientId, const Guid *pGuid)
1706{
1707#ifdef VBOX_WITH_USB
1708 RemoteUSBBackend *pRemoteUSBBackend = NULL;
1709
1710 /* Find the instance. */
1711 int rc = lockConsoleVRDPServer ();
1712
1713 if (RT_SUCCESS (rc))
1714 {
1715 pRemoteUSBBackend = usbBackendFind (u32ClientId);
1716
1717 if (pRemoteUSBBackend)
1718 {
1719 /* Inform the backend instance that it is referenced by the Guid. */
1720 bool fAdded = pRemoteUSBBackend->addUUID (pGuid);
1721
1722 if (fAdded)
1723 {
1724 /* Reference the instance because its pointer is being taken. */
1725 pRemoteUSBBackend->AddRef (); /* 'Release' is called in USBBackendReleasePointer. */
1726 }
1727 else
1728 {
1729 pRemoteUSBBackend = NULL;
1730 }
1731 }
1732
1733 unlockConsoleVRDPServer ();
1734 }
1735
1736 if (pRemoteUSBBackend)
1737 {
1738 return pRemoteUSBBackend->GetBackendCallbackPointer ();
1739 }
1740
1741#endif
1742 return NULL;
1743}
1744
1745void ConsoleVRDPServer::USBBackendReleasePointer (const Guid *pGuid)
1746{
1747#ifdef VBOX_WITH_USB
1748 RemoteUSBBackend *pRemoteUSBBackend = NULL;
1749
1750 /* Find the instance. */
1751 int rc = lockConsoleVRDPServer ();
1752
1753 if (RT_SUCCESS (rc))
1754 {
1755 pRemoteUSBBackend = usbBackendFindByUUID (pGuid);
1756
1757 if (pRemoteUSBBackend)
1758 {
1759 pRemoteUSBBackend->removeUUID (pGuid);
1760 }
1761
1762 unlockConsoleVRDPServer ();
1763
1764 if (pRemoteUSBBackend)
1765 {
1766 pRemoteUSBBackend->Release ();
1767 }
1768 }
1769#endif
1770}
1771
1772RemoteUSBBackend *ConsoleVRDPServer::usbBackendGetNext (RemoteUSBBackend *pRemoteUSBBackend)
1773{
1774 LogFlow(("ConsoleVRDPServer::usbBackendGetNext: pBackend = %p\n", pRemoteUSBBackend));
1775
1776 RemoteUSBBackend *pNextRemoteUSBBackend = NULL;
1777#ifdef VBOX_WITH_USB
1778
1779 int rc = lockConsoleVRDPServer ();
1780
1781 if (RT_SUCCESS (rc))
1782 {
1783 if (pRemoteUSBBackend == NULL)
1784 {
1785 /* The first backend in the list is requested. */
1786 pNextRemoteUSBBackend = mUSBBackends.pHead;
1787 }
1788 else
1789 {
1790 /* Get pointer to the next backend. */
1791 pNextRemoteUSBBackend = (RemoteUSBBackend *)pRemoteUSBBackend->pNext;
1792 }
1793
1794 if (pNextRemoteUSBBackend)
1795 {
1796 pNextRemoteUSBBackend->AddRef ();
1797 }
1798
1799 unlockConsoleVRDPServer ();
1800
1801 if (pRemoteUSBBackend)
1802 {
1803 pRemoteUSBBackend->Release ();
1804 }
1805 }
1806#endif
1807
1808 return pNextRemoteUSBBackend;
1809}
1810
1811#ifdef VBOX_WITH_USB
1812/* Internal method. Called under the ConsoleVRDPServerLock. */
1813RemoteUSBBackend *ConsoleVRDPServer::usbBackendFind (uint32_t u32ClientId)
1814{
1815 RemoteUSBBackend *pRemoteUSBBackend = mUSBBackends.pHead;
1816
1817 while (pRemoteUSBBackend)
1818 {
1819 if (pRemoteUSBBackend->ClientId () == u32ClientId)
1820 {
1821 break;
1822 }
1823
1824 pRemoteUSBBackend = (RemoteUSBBackend *)pRemoteUSBBackend->pNext;
1825 }
1826
1827 return pRemoteUSBBackend;
1828}
1829
1830/* Internal method. Called under the ConsoleVRDPServerLock. */
1831RemoteUSBBackend *ConsoleVRDPServer::usbBackendFindByUUID (const Guid *pGuid)
1832{
1833 RemoteUSBBackend *pRemoteUSBBackend = mUSBBackends.pHead;
1834
1835 while (pRemoteUSBBackend)
1836 {
1837 if (pRemoteUSBBackend->findUUID (pGuid))
1838 {
1839 break;
1840 }
1841
1842 pRemoteUSBBackend = (RemoteUSBBackend *)pRemoteUSBBackend->pNext;
1843 }
1844
1845 return pRemoteUSBBackend;
1846}
1847#endif
1848
1849/* Internal method. Called by the backend destructor. */
1850void ConsoleVRDPServer::usbBackendRemoveFromList (RemoteUSBBackend *pRemoteUSBBackend)
1851{
1852#ifdef VBOX_WITH_USB
1853 int rc = lockConsoleVRDPServer ();
1854 AssertRC (rc);
1855
1856 /* Exclude the found instance from the list. */
1857 if (pRemoteUSBBackend->pNext)
1858 {
1859 pRemoteUSBBackend->pNext->pPrev = pRemoteUSBBackend->pPrev;
1860 }
1861 else
1862 {
1863 mUSBBackends.pTail = (RemoteUSBBackend *)pRemoteUSBBackend->pPrev;
1864 }
1865
1866 if (pRemoteUSBBackend->pPrev)
1867 {
1868 pRemoteUSBBackend->pPrev->pNext = pRemoteUSBBackend->pNext;
1869 }
1870 else
1871 {
1872 mUSBBackends.pHead = (RemoteUSBBackend *)pRemoteUSBBackend->pNext;
1873 }
1874
1875 pRemoteUSBBackend->pNext = pRemoteUSBBackend->pPrev = NULL;
1876
1877 unlockConsoleVRDPServer ();
1878#endif
1879}
1880
1881
1882void ConsoleVRDPServer::SendUpdate (unsigned uScreenId, void *pvUpdate, uint32_t cbUpdate) const
1883{
1884#ifdef VBOX_WITH_VRDP
1885 if (mpEntryPoints && mhServer)
1886 {
1887 mpEntryPoints->VRDPUpdate (mhServer, uScreenId, pvUpdate, cbUpdate);
1888 }
1889#endif
1890}
1891
1892void ConsoleVRDPServer::SendResize (void) const
1893{
1894#ifdef VBOX_WITH_VRDP
1895 if (mpEntryPoints && mhServer)
1896 {
1897 mpEntryPoints->VRDPResize (mhServer);
1898 }
1899#endif
1900}
1901
1902void ConsoleVRDPServer::SendUpdateBitmap (unsigned uScreenId, uint32_t x, uint32_t y, uint32_t w, uint32_t h) const
1903{
1904#ifdef VBOX_WITH_VRDP
1905 VRDPORDERHDR update;
1906 update.x = x;
1907 update.y = y;
1908 update.w = w;
1909 update.h = h;
1910 if (mpEntryPoints && mhServer)
1911 {
1912 mpEntryPoints->VRDPUpdate (mhServer, uScreenId, &update, sizeof (update));
1913 }
1914#endif
1915}
1916
1917void ConsoleVRDPServer::SendAudioSamples (void *pvSamples, uint32_t cSamples, VRDPAUDIOFORMAT format) const
1918{
1919#ifdef VBOX_WITH_VRDP
1920 if (mpEntryPoints && mhServer)
1921 {
1922 mpEntryPoints->VRDPAudioSamples (mhServer, pvSamples, cSamples, format);
1923 }
1924#endif
1925}
1926
1927void ConsoleVRDPServer::SendAudioVolume (uint16_t left, uint16_t right) const
1928{
1929#ifdef VBOX_WITH_VRDP
1930 if (mpEntryPoints && mhServer)
1931 {
1932 mpEntryPoints->VRDPAudioVolume (mhServer, left, right);
1933 }
1934#endif
1935}
1936
1937void ConsoleVRDPServer::SendUSBRequest (uint32_t u32ClientId, void *pvParms, uint32_t cbParms) const
1938{
1939#ifdef VBOX_WITH_VRDP
1940 if (mpEntryPoints && mhServer)
1941 {
1942 mpEntryPoints->VRDPUSBRequest (mhServer, u32ClientId, pvParms, cbParms);
1943 }
1944#endif
1945}
1946
1947void ConsoleVRDPServer::QueryInfo (uint32_t index, void *pvBuffer, uint32_t cbBuffer, uint32_t *pcbOut) const
1948{
1949#ifdef VBOX_WITH_VRDP
1950 if (mpEntryPoints && mhServer)
1951 {
1952 mpEntryPoints->VRDPQueryInfo (mhServer, index, pvBuffer, cbBuffer, pcbOut);
1953 }
1954#endif
1955}
1956
1957#ifdef VBOX_WITH_VRDP
1958/* note: static function now! */
1959bool ConsoleVRDPServer::loadVRDPLibrary (void)
1960{
1961 int rc = VINF_SUCCESS;
1962
1963 if (!mVRDPLibrary)
1964 {
1965 rc = SUPR3HardenedLdrLoadAppPriv ("VBoxVRDP", &mVRDPLibrary);
1966
1967 if (RT_SUCCESS(rc))
1968 {
1969 LogFlow(("VRDPServer::loadLibrary(): successfully loaded VRDP library.\n"));
1970
1971 struct SymbolEntry
1972 {
1973 const char *name;
1974 void **ppfn;
1975 };
1976
1977 #define DEFSYMENTRY(a) { #a, (void**)&mpfn##a }
1978
1979 static const struct SymbolEntry symbols[] =
1980 {
1981 DEFSYMENTRY(VRDPCreateServer)
1982 };
1983
1984 #undef DEFSYMENTRY
1985
1986 for (unsigned i = 0; i < RT_ELEMENTS(symbols); i++)
1987 {
1988 rc = RTLdrGetSymbol(mVRDPLibrary, symbols[i].name, symbols[i].ppfn);
1989
1990 AssertMsgRC(rc, ("Error resolving VRDP symbol %s\n", symbols[i].name));
1991
1992 if (RT_FAILURE(rc))
1993 {
1994 break;
1995 }
1996 }
1997 }
1998 else
1999 {
2000 LogRel(("VRDPServer::loadLibrary(): failed to load VRDP library! VRDP not available: rc = %Rrc\n", rc));
2001 mVRDPLibrary = NULL;
2002 }
2003 }
2004
2005 // just to be safe
2006 if (RT_FAILURE(rc))
2007 {
2008 if (mVRDPLibrary)
2009 {
2010 RTLdrClose (mVRDPLibrary);
2011 mVRDPLibrary = NULL;
2012 }
2013 }
2014
2015 return (mVRDPLibrary != NULL);
2016}
2017#endif /* VBOX_WITH_VRDP */
2018
2019/*
2020 * IRemoteDisplayInfo implementation.
2021 */
2022// constructor / destructor
2023/////////////////////////////////////////////////////////////////////////////
2024
2025DEFINE_EMPTY_CTOR_DTOR (RemoteDisplayInfo)
2026
2027HRESULT RemoteDisplayInfo::FinalConstruct()
2028{
2029 return S_OK;
2030}
2031
2032void RemoteDisplayInfo::FinalRelease()
2033{
2034 uninit ();
2035}
2036
2037// public methods only for internal purposes
2038/////////////////////////////////////////////////////////////////////////////
2039
2040/**
2041 * Initializes the guest object.
2042 */
2043HRESULT RemoteDisplayInfo::init (Console *aParent)
2044{
2045 LogFlowThisFunc (("aParent=%p\n", aParent));
2046
2047 ComAssertRet (aParent, E_INVALIDARG);
2048
2049 /* Enclose the state transition NotReady->InInit->Ready */
2050 AutoInitSpan autoInitSpan (this);
2051 AssertReturn (autoInitSpan.isOk(), E_FAIL);
2052
2053 unconst (mParent) = aParent;
2054
2055 /* Confirm a successful initialization */
2056 autoInitSpan.setSucceeded();
2057
2058 return S_OK;
2059}
2060
2061/**
2062 * Uninitializes the instance and sets the ready flag to FALSE.
2063 * Called either from FinalRelease() or by the parent when it gets destroyed.
2064 */
2065void RemoteDisplayInfo::uninit()
2066{
2067 LogFlowThisFunc (("\n"));
2068
2069 /* Enclose the state transition Ready->InUninit->NotReady */
2070 AutoUninitSpan autoUninitSpan (this);
2071 if (autoUninitSpan.uninitDone())
2072 return;
2073
2074 unconst (mParent).setNull();
2075}
2076
2077// IRemoteDisplayInfo properties
2078/////////////////////////////////////////////////////////////////////////////
2079
2080#define IMPL_GETTER_BOOL(_aType, _aName, _aIndex) \
2081 STDMETHODIMP RemoteDisplayInfo::COMGETTER(_aName) (_aType *a##_aName) \
2082 { \
2083 if (!a##_aName) \
2084 return E_POINTER; \
2085 \
2086 AutoCaller autoCaller (this); \
2087 CheckComRCReturnRC (autoCaller.rc()); \
2088 \
2089 /* todo: Not sure if a AutoReadLock would be sufficient. */ \
2090 AutoWriteLock alock (this); \
2091 \
2092 uint32_t value; \
2093 uint32_t cbOut = 0; \
2094 \
2095 mParent->consoleVRDPServer ()->QueryInfo \
2096 (_aIndex, &value, sizeof (value), &cbOut); \
2097 \
2098 *a##_aName = cbOut? !!value: FALSE; \
2099 \
2100 return S_OK; \
2101 }
2102
2103#define IMPL_GETTER_SCALAR(_aType, _aName, _aIndex) \
2104 STDMETHODIMP RemoteDisplayInfo::COMGETTER(_aName) (_aType *a##_aName) \
2105 { \
2106 if (!a##_aName) \
2107 return E_POINTER; \
2108 \
2109 AutoCaller autoCaller (this); \
2110 CheckComRCReturnRC (autoCaller.rc()); \
2111 \
2112 /* todo: Not sure if a AutoReadLock would be sufficient. */ \
2113 AutoWriteLock alock (this); \
2114 \
2115 _aType value; \
2116 uint32_t cbOut = 0; \
2117 \
2118 mParent->consoleVRDPServer ()->QueryInfo \
2119 (_aIndex, &value, sizeof (value), &cbOut); \
2120 \
2121 *a##_aName = cbOut? value: 0; \
2122 \
2123 return S_OK; \
2124 }
2125
2126#define IMPL_GETTER_BSTR(_aType, _aName, _aIndex) \
2127 STDMETHODIMP RemoteDisplayInfo::COMGETTER(_aName) (_aType *a##_aName) \
2128 { \
2129 if (!a##_aName) \
2130 return E_POINTER; \
2131 \
2132 AutoCaller autoCaller (this); \
2133 CheckComRCReturnRC (autoCaller.rc()); \
2134 \
2135 /* todo: Not sure if a AutoReadLock would be sufficient. */ \
2136 AutoWriteLock alock (this); \
2137 \
2138 uint32_t cbOut = 0; \
2139 \
2140 mParent->consoleVRDPServer ()->QueryInfo \
2141 (_aIndex, NULL, 0, &cbOut); \
2142 \
2143 if (cbOut == 0) \
2144 { \
2145 Bstr str(""); \
2146 str.cloneTo (a##_aName); \
2147 return S_OK; \
2148 } \
2149 \
2150 char *pchBuffer = (char *)RTMemTmpAlloc (cbOut); \
2151 \
2152 if (!pchBuffer) \
2153 { \
2154 Log(("RemoteDisplayInfo::" \
2155 #_aName \
2156 ": Failed to allocate memory %d bytes\n", cbOut)); \
2157 return E_OUTOFMEMORY; \
2158 } \
2159 \
2160 mParent->consoleVRDPServer ()->QueryInfo \
2161 (_aIndex, pchBuffer, cbOut, &cbOut); \
2162 \
2163 Bstr str(pchBuffer); \
2164 \
2165 str.cloneTo (a##_aName); \
2166 \
2167 RTMemTmpFree (pchBuffer); \
2168 \
2169 return S_OK; \
2170 }
2171
2172IMPL_GETTER_BOOL (BOOL, Active, VRDP_QI_ACTIVE);
2173IMPL_GETTER_SCALAR (ULONG, NumberOfClients, VRDP_QI_NUMBER_OF_CLIENTS);
2174IMPL_GETTER_SCALAR (LONG64, BeginTime, VRDP_QI_BEGIN_TIME);
2175IMPL_GETTER_SCALAR (LONG64, EndTime, VRDP_QI_END_TIME);
2176IMPL_GETTER_SCALAR (ULONG64, BytesSent, VRDP_QI_BYTES_SENT);
2177IMPL_GETTER_SCALAR (ULONG64, BytesSentTotal, VRDP_QI_BYTES_SENT_TOTAL);
2178IMPL_GETTER_SCALAR (ULONG64, BytesReceived, VRDP_QI_BYTES_RECEIVED);
2179IMPL_GETTER_SCALAR (ULONG64, BytesReceivedTotal, VRDP_QI_BYTES_RECEIVED_TOTAL);
2180IMPL_GETTER_BSTR (BSTR, User, VRDP_QI_USER);
2181IMPL_GETTER_BSTR (BSTR, Domain, VRDP_QI_DOMAIN);
2182IMPL_GETTER_BSTR (BSTR, ClientName, VRDP_QI_CLIENT_NAME);
2183IMPL_GETTER_BSTR (BSTR, ClientIP, VRDP_QI_CLIENT_IP);
2184IMPL_GETTER_SCALAR (ULONG, ClientVersion, VRDP_QI_CLIENT_VERSION);
2185IMPL_GETTER_SCALAR (ULONG, EncryptionStyle, VRDP_QI_ENCRYPTION_STYLE);
2186
2187#undef IMPL_GETTER_BSTR
2188#undef IMPL_GETTER_SCALAR
2189/* vi: set tabstop=4 shiftwidth=4 expandtab: */
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