VirtualBox

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

Last change on this file since 23327 was 23223, checked in by vboxsync, 15 years ago

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