VirtualBox

source: vbox/trunk/src/VBox/GuestHost/SharedClipboard/clipboard-transfers.cpp@ 102955

Last change on this file since 102955 was 102955, checked in by vboxsync, 14 months ago

Shared Clipboard/Transfer: Also free the temporary path when path validation failed in ShClTransferRootsInitFromStringListEx(). bugref:9437
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 107.6 KB
Line 
1/* $Id: clipboard-transfers.cpp 102955 2024-01-18 15:35:48Z vboxsync $ */
2/** @file
3 * Shared Clipboard: Common clipboard transfer handling code.
4 */
5
6/*
7 * Copyright (C) 2019-2023 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, in version 3 of the
15 * License.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <https://www.gnu.org/licenses>.
24 *
25 * SPDX-License-Identifier: GPL-3.0-only
26 */
27
28#define LOG_GROUP LOG_GROUP_SHARED_CLIPBOARD
29#include <VBox/log.h>
30
31#include <iprt/dir.h>
32#include <iprt/file.h>
33#include <iprt/list.h>
34#include <iprt/path.h>
35#include <iprt/rand.h>
36#include <iprt/semaphore.h>
37#include <iprt/uri.h>
38#include <iprt/utf16.h>
39
40#include <VBox/err.h>
41#include <VBox/HostServices/VBoxClipboardSvc.h>
42#include <VBox/GuestHost/clipboard-helper.h>
43#include <VBox/GuestHost/SharedClipboard-transfers.h>
44
45
46
47/*********************************************************************************************************************************
48 * Prototypes *
49 ********************************************************************************************************************************/
50
51static void shClTransferCopyCallbacks(PSHCLTRANSFERCALLBACKS pCallbacksDst, PSHCLTRANSFERCALLBACKS pCallbacksSrc);
52DECLINLINE(void) shClTransferLock(PSHCLTRANSFER pTransfer);
53DECLINLINE(void) shClTransferUnlock(PSHCLTRANSFER pTransfer);
54static void shClTransferSetCallbacks(PSHCLTRANSFER pTransfer, PSHCLTRANSFERCALLBACKS pCallbacks);
55static int shClTransferSetStatus(PSHCLTRANSFER pTransfer, SHCLTRANSFERSTATUS enmStatus);
56static int shClTransferThreadCreate(PSHCLTRANSFER pTransfer, PFNSHCLTRANSFERTHREAD pfnThreadFunc, void *pvUser);
57static int shClTransferThreadDestroy(PSHCLTRANSFER pTransfer, RTMSINTERVAL uTimeoutMs);
58
59static void shclTransferCtxTransferRemoveAndUnregister(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFER pTransfer);
60static PSHCLTRANSFER shClTransferCtxGetTransferByIdInternal(PSHCLTRANSFERCTX pTransferCtx, SHCLTRANSFERID uId);
61static PSHCLTRANSFER shClTransferCtxGetTransferByIndexInternal(PSHCLTRANSFERCTX pTransferCtx, uint32_t uIdx);
62
63
64/*********************************************************************************************************************************
65 * Transfer List *
66 ********************************************************************************************************************************/
67
68/**
69 * Initializes a transfer list.
70 *
71 * @param pList Transfer list to initialize.
72 */
73void ShClTransferListInit(PSHCLLIST pList)
74{
75 RT_ZERO(pList->Hdr);
76 RTListInit(&pList->lstEntries);
77}
78
79/**
80 * Destroys a transfer list.
81 *
82 * @param pList Transfer list to destroy.
83 */
84void ShClTransferListDestroy(PSHCLLIST pList)
85{
86 if (!pList)
87 return;
88
89 PSHCLLISTENTRY pEntry, pEntryNext;
90 RTListForEachSafe(&pList->lstEntries, pEntry, pEntryNext, SHCLLISTENTRY, Node)
91 {
92 RTListNodeRemove(&pEntry->Node);
93 ShClTransferListEntryDestroy(pEntry);
94 RTMemFree(pEntry);
95 }
96
97 RT_ZERO(pList->Hdr);
98}
99
100/**
101 * Adds a list entry to a transfer list.
102 *
103 * @returns VBox status code.
104 * @param pList Transfer list to add entry to.
105 * @param pEntry Entry to add.
106 * @param fAppend \c true to append to a list, or \c false to prepend.
107 */
108int ShClTransferListAddEntry(PSHCLLIST pList, PSHCLLISTENTRY pEntry, bool fAppend)
109{
110 AssertReturn(ShClTransferListEntryIsValid(pEntry), VERR_INVALID_PARAMETER);
111
112 if (fAppend)
113 RTListAppend(&pList->lstEntries, &pEntry->Node);
114 else
115 RTListPrepend(&pList->lstEntries, &pEntry->Node);
116 pList->Hdr.cEntries++;
117
118 LogFlowFunc(("%p: '%s' (%RU32 bytes) + %RU32 bytes info -> now %RU32 entries\n",
119 pList, pEntry->pszName, pEntry->cbName, pEntry->cbInfo, pList->Hdr.cEntries));
120
121 return VINF_SUCCESS;
122}
123
124/**
125 * Allocates a new transfer list.
126 *
127 * @returns Allocated transfer list on success, or NULL on failure.
128 */
129PSHCLLIST ShClTransferListAlloc(void)
130{
131 PSHCLLIST pList = (PSHCLLIST)RTMemAllocZ(sizeof(SHCLLIST));
132 if (pList)
133 {
134 ShClTransferListInit(pList);
135 return pList;
136 }
137
138 return NULL;
139}
140
141/**
142 * Frees a transfer list.
143 *
144 * @param pList Transfer list to free. The pointer will be
145 * invalid after returning from this function.
146 */
147void ShClTransferListFree(PSHCLLIST pList)
148{
149 if (!pList)
150 return;
151
152 ShClTransferListDestroy(pList);
153
154 RTMemFree(pList);
155 pList = NULL;
156}
157
158/**
159 * Returns a specific list entry of a transfer list.
160 *
161 * @returns Pointer to list entry if found, or NULL if not found.
162 * @param pList Clipboard transfer list to get list entry from.
163 * @param uIdx Index of list entry to return.
164 */
165DECLINLINE(PSHCLLISTENTRY) shClTransferListGetEntryById(PSHCLLIST pList, uint32_t uIdx)
166{
167 if (uIdx >= pList->Hdr.cEntries)
168 return NULL;
169
170 Assert(!RTListIsEmpty(&pList->lstEntries));
171
172 PSHCLLISTENTRY pIt = RTListGetFirst(&pList->lstEntries, SHCLLISTENTRY, Node);
173 while (uIdx) /** @todo Slow, but works for now. */
174 {
175 pIt = RTListGetNext(&pList->lstEntries, pIt, SHCLLISTENTRY, Node);
176 uIdx--;
177 }
178
179 return pIt;
180}
181
182/**
183 * Initializes an list handle info structure.
184 *
185 * @returns VBox status code.
186 * @param pInfo List handle info structure to initialize.
187 */
188int ShClTransferListHandleInfoInit(PSHCLLISTHANDLEINFO pInfo)
189{
190 AssertPtrReturn(pInfo, VERR_INVALID_POINTER);
191
192 pInfo->hList = NIL_SHCLLISTHANDLE;
193 pInfo->enmType = SHCLOBJTYPE_INVALID;
194
195 pInfo->pszPathLocalAbs = NULL;
196
197 RT_ZERO(pInfo->u);
198
199 return VINF_SUCCESS;
200}
201
202/**
203 * Destroys a list handle info structure.
204 *
205 * @param pInfo List handle info structure to destroy.
206 */
207void ShClTransferListHandleInfoDestroy(PSHCLLISTHANDLEINFO pInfo)
208{
209 if (!pInfo)
210 return;
211
212 if (pInfo->pszPathLocalAbs)
213 {
214 RTStrFree(pInfo->pszPathLocalAbs);
215 pInfo->pszPathLocalAbs = NULL;
216 }
217}
218
219/**
220 * Allocates a transfer list header structure.
221 *
222 * @returns VBox status code.
223 * @param ppListHdr Where to store the allocated transfer list header structure on success.
224 */
225int ShClTransferListHdrAlloc(PSHCLLISTHDR *ppListHdr)
226{
227 int rc;
228
229 PSHCLLISTHDR pListHdr = (PSHCLLISTHDR)RTMemAllocZ(sizeof(SHCLLISTHDR));
230 if (pListHdr)
231 {
232 *ppListHdr = pListHdr;
233 rc = VINF_SUCCESS;
234 }
235 else
236 rc = VERR_NO_MEMORY;
237
238 LogFlowFuncLeaveRC(rc);
239 return rc;
240}
241
242/**
243 * Frees a transfer list header structure.
244 *
245 * @param pListEntry Transfer list header structure to free.
246 * The pointer will be invalid on return.
247 */
248void ShClTransferListHdrFree(PSHCLLISTHDR pListHdr)
249{
250 if (!pListHdr)
251 return;
252
253 LogFlowFuncEnter();
254
255 ShClTransferListHdrDestroy(pListHdr);
256
257 RTMemFree(pListHdr);
258 pListHdr = NULL;
259}
260
261/**
262 * Duplicates (allocates) a transfer list header structure.
263 *
264 * @returns Duplicated transfer list header structure on success.
265 * @param pListHdr Transfer list header to duplicate.
266 */
267PSHCLLISTHDR ShClTransferListHdrDup(PSHCLLISTHDR pListHdr)
268{
269 AssertPtrReturn(pListHdr, NULL);
270
271 PSHCLLISTHDR pListHdrDup = (PSHCLLISTHDR)RTMemAlloc(sizeof(SHCLLISTHDR));
272 if (pListHdrDup)
273 *pListHdrDup = *pListHdr;
274
275 return pListHdrDup;
276}
277
278/**
279 * Initializes a transfer list header structure.
280 *
281 * @returns VBox status code.
282 * @param pListHdr Transfer list header struct to initialize.
283 */
284int ShClTransferListHdrInit(PSHCLLISTHDR pListHdr)
285{
286 AssertPtrReturn(pListHdr, VERR_INVALID_POINTER);
287
288 LogFlowFuncEnter();
289
290 ShClTransferListHdrReset(pListHdr);
291
292 return VINF_SUCCESS;
293}
294
295/**
296 * Destroys a transfer list header structure.
297 *
298 * @param pListHdr Transfer list header struct to destroy.
299 */
300void ShClTransferListHdrDestroy(PSHCLLISTHDR pListHdr)
301{
302 if (!pListHdr)
303 return;
304
305 LogFlowFuncEnter();
306}
307
308/**
309 * Resets a transfer list header structure.
310 *
311 * @returns VBox status code.
312 * @param pListHdr Transfer list header struct to reset.
313 */
314void ShClTransferListHdrReset(PSHCLLISTHDR pListHdr)
315{
316 AssertPtrReturnVoid(pListHdr);
317
318 LogFlowFuncEnter();
319
320 RT_BZERO(pListHdr, sizeof(SHCLLISTHDR));
321}
322
323/**
324 * Returns whether a given transfer list header is valid or not.
325 *
326 * @returns \c true if valid, \c false if not.
327 * @param pListHdr Transfer list header to validate.
328 */
329bool ShClTransferListHdrIsValid(PSHCLLISTHDR pListHdr)
330{
331 RT_NOREF(pListHdr);
332 return true; /** @todo Implement this. */
333}
334
335/**
336 * (Deep-)Copies a transfer list open parameters structure from one into another.
337 *
338 * @returns VBox status code.
339 * @param pDst Destination parameters to copy to.
340 * @param pSrc Source parameters to copy from.
341 */
342int ShClTransferListOpenParmsCopy(PSHCLLISTOPENPARMS pDst, PSHCLLISTOPENPARMS pSrc)
343{
344 AssertPtrReturn(pDst, VERR_INVALID_POINTER);
345 AssertPtrReturn(pSrc, VERR_INVALID_POINTER);
346
347 int rc = VINF_SUCCESS;
348
349 if (pSrc->pszFilter)
350 {
351 pDst->pszFilter = RTStrDup(pSrc->pszFilter);
352 if (!pDst->pszFilter)
353 rc = VERR_NO_MEMORY;
354 }
355
356 if ( RT_SUCCESS(rc)
357 && pSrc->pszPath)
358 {
359 pDst->pszPath = RTStrDup(pSrc->pszPath);
360 if (!pDst->pszPath)
361 rc = VERR_NO_MEMORY;
362 }
363
364 if (RT_SUCCESS(rc))
365 {
366 pDst->fList = pDst->fList;
367 pDst->cbFilter = pSrc->cbFilter;
368 pDst->cbPath = pSrc->cbPath;
369 }
370
371 return rc;
372}
373
374/**
375 * Duplicates a transfer list open parameters structure.
376 *
377 * @returns Duplicated transfer list open parameters structure on success, or NULL on failure.
378 * @param pParms Transfer list open parameters structure to duplicate.
379 */
380PSHCLLISTOPENPARMS ShClTransferListOpenParmsDup(PSHCLLISTOPENPARMS pParms)
381{
382 AssertPtrReturn(pParms, NULL);
383
384 PSHCLLISTOPENPARMS pParmsDup = (PSHCLLISTOPENPARMS)RTMemAllocZ(sizeof(SHCLLISTOPENPARMS));
385 if (!pParmsDup)
386 return NULL;
387
388 int rc = ShClTransferListOpenParmsCopy(pParmsDup, pParms);
389 if (RT_FAILURE(rc))
390 {
391 ShClTransferListOpenParmsDestroy(pParmsDup);
392
393 RTMemFree(pParmsDup);
394 pParmsDup = NULL;
395 }
396
397 return pParmsDup;
398}
399
400/**
401 * Initializes a transfer list open parameters structure.
402 *
403 * @returns VBox status code.
404 * @param pParms Transfer list open parameters structure to initialize.
405 */
406int ShClTransferListOpenParmsInit(PSHCLLISTOPENPARMS pParms)
407{
408 AssertPtrReturn(pParms, VERR_INVALID_POINTER);
409
410 RT_BZERO(pParms, sizeof(SHCLLISTOPENPARMS));
411
412 pParms->cbFilter = SHCL_TRANSFER_PATH_MAX; /** @todo Make this dynamic. */
413 pParms->pszFilter = RTStrAlloc(pParms->cbFilter);
414
415 pParms->cbPath = SHCL_TRANSFER_PATH_MAX; /** @todo Make this dynamic. */
416 pParms->pszPath = RTStrAlloc(pParms->cbPath);
417
418 LogFlowFuncLeave();
419 return VINF_SUCCESS;
420}
421
422/**
423 * Destroys a transfer list open parameters structure.
424 *
425 * @param pParms Transfer list open parameters structure to destroy.
426 */
427void ShClTransferListOpenParmsDestroy(PSHCLLISTOPENPARMS pParms)
428{
429 if (!pParms)
430 return;
431
432 if (pParms->pszFilter)
433 {
434 RTStrFree(pParms->pszFilter);
435 pParms->pszFilter = NULL;
436 }
437
438 if (pParms->pszPath)
439 {
440 RTStrFree(pParms->pszPath);
441 pParms->pszPath = NULL;
442 }
443}
444
445/**
446 * Creates (allocates) and initializes a clipboard list entry structure.
447 *
448 * @returns VBox status code.
449 * @param ppListEntry Where to return the created clipboard list entry structure on success.
450 * Must be free'd with ShClTransferListEntryFree().
451 */
452int ShClTransferListEntryAlloc(PSHCLLISTENTRY *ppListEntry)
453{
454 AssertPtrReturn(ppListEntry, VERR_INVALID_POINTER);
455
456 PSHCLLISTENTRY pListEntry = (PSHCLLISTENTRY)RTMemAllocZ(sizeof(SHCLLISTENTRY));
457 if (!pListEntry)
458 return VERR_NO_MEMORY;
459
460 *ppListEntry = pListEntry;
461
462 return VINF_SUCCESS;
463}
464
465/**
466 * Frees a clipboard list entry structure.
467 *
468 * @param pEntry Clipboard list entry structure to free.
469 * The pointer will be invalid on return.
470 */
471void ShClTransferListEntryFree(PSHCLLISTENTRY pEntry)
472{
473 if (!pEntry)
474 return;
475
476 /* Make sure to destroy the entry properly, in case the caller forgot this. */
477 ShClTransferListEntryDestroy(pEntry);
478
479 RTMemFree(pEntry);
480 pEntry = NULL;
481}
482
483/**
484 * (Deep-)Copies a clipboard list entry structure.
485 *
486 * @returns VBox status code.
487 * @param pDst Destination list entry to copy to.
488 * @param pSrc Source list entry to copy from.
489 */
490int ShClTransferListEntryCopy(PSHCLLISTENTRY pDst, PSHCLLISTENTRY pSrc)
491{
492 AssertPtrReturn(pDst, VERR_INVALID_POINTER);
493 AssertPtrReturn(pSrc, VERR_INVALID_POINTER);
494
495 int rc = VINF_SUCCESS;
496
497 *pDst = *pSrc;
498
499 if (pSrc->pszName)
500 {
501 pDst->pszName = RTStrDup(pSrc->pszName);
502 if (!pDst->pszName)
503 rc = VERR_NO_MEMORY;
504 }
505
506 if ( RT_SUCCESS(rc)
507 && pSrc->pvInfo)
508 {
509 pDst->pvInfo = RTMemDup(pSrc->pvInfo, pSrc->cbInfo);
510 if (pDst->pvInfo)
511 {
512 pDst->cbInfo = pSrc->cbInfo;
513 }
514 else
515 rc = VERR_NO_MEMORY;
516 }
517
518 if (RT_FAILURE(rc))
519 {
520 if (pDst->pvInfo)
521 {
522 RTMemFree(pDst->pvInfo);
523 pDst->pvInfo = NULL;
524 pDst->cbInfo = 0;
525 }
526 }
527
528 return rc;
529}
530
531/**
532 * Duplicates (allocates) a clipboard list entry structure.
533 *
534 * @returns Duplicated clipboard list entry structure on success.
535 * @param pEntry Clipboard list entry to duplicate.
536 */
537PSHCLLISTENTRY ShClTransferListEntryDup(PSHCLLISTENTRY pEntry)
538{
539 AssertPtrReturn(pEntry, NULL);
540
541 int rc = VINF_SUCCESS;
542
543 PSHCLLISTENTRY pListEntryDup = (PSHCLLISTENTRY)RTMemAllocZ(sizeof(SHCLLISTENTRY));
544 if (pListEntryDup)
545 rc = ShClTransferListEntryCopy(pListEntryDup, pEntry);
546
547 if (RT_FAILURE(rc))
548 {
549 ShClTransferListEntryDestroy(pListEntryDup);
550
551 RTMemFree(pListEntryDup);
552 pListEntryDup = NULL;
553 }
554
555 return pListEntryDup;
556}
557
558/**
559 * Returns whether a given list entry name is valid or not.
560 *
561 * @returns \c true if valid, or \c false if not.
562 * @param pszName Name to check.
563 * @param cbName Size (in bytes) of \a pszName to check.
564 * Includes terminator.
565 */
566static bool shclTransferListEntryNameIsValid(const char *pszName, size_t cbName)
567{
568 if (!pszName)
569 return false;
570
571 size_t const cchLen = strlen(pszName);
572
573 if ( !cbName
574 || cchLen == 0
575 || cchLen > cbName /* Includes zero termination */ - 1
576 || cchLen > SHCLLISTENTRY_MAX_NAME /* Ditto */ - 1)
577 {
578 return false;
579 }
580
581 int rc = ShClTransferValidatePath(pszName, false /* fMustExist */);
582 if (RT_FAILURE(rc))
583 return false;
584
585 return true;
586}
587
588/**
589 * Initializes a clipboard list entry structure, extended version.
590 *
591 * @returns VBox status code.
592 * @param pListEntry Clipboard list entry structure to initialize.
593 * @param fInfo Info flags (of type VBOX_SHCL_INFO_F_XXX).
594 * @param pszName Name (e.g. filename) to use. Can be NULL if not being used.
595 * Up to SHCLLISTENTRY_MAX_NAME characters.
596 * @param pvInfo Pointer to info data to assign. Must match \a fInfo.
597 * The list entry takes the ownership of the data on success.
598 * @param cbInfo Size (in bytes) of \a pvInfo data to assign.
599 */
600int ShClTransferListEntryInitEx(PSHCLLISTENTRY pListEntry, uint32_t fInfo, const char *pszName, void *pvInfo, uint32_t cbInfo)
601{
602 AssertPtrReturn(pListEntry, VERR_INVALID_POINTER);
603 AssertReturn ( pszName == NULL
604 || shclTransferListEntryNameIsValid(pszName, strlen(pszName) + 1), VERR_INVALID_PARAMETER);
605 /* pvInfo + cbInfo depend on fInfo. See below. */
606
607 RT_BZERO(pListEntry, sizeof(SHCLLISTENTRY));
608
609 if (pszName)
610 {
611 pListEntry->pszName = RTStrDupN(pszName, SHCLLISTENTRY_MAX_NAME);
612 AssertPtrReturn(pListEntry->pszName, VERR_NO_MEMORY);
613 pListEntry->cbName = (uint32_t)strlen(pListEntry->pszName) + 1 /* Include terminator */;
614 }
615
616 pListEntry->pvInfo = pvInfo;
617 pListEntry->cbInfo = cbInfo;
618 pListEntry->fInfo = fInfo;
619
620 return VINF_SUCCESS;
621}
622
623/**
624 * Initializes a clipboard list entry structure (as empty / invalid).
625 *
626 * @returns VBox status code.
627 * @param pListEntry Clipboard list entry structure to initialize.
628 */
629int ShClTransferListEntryInit(PSHCLLISTENTRY pListEntry)
630{
631 return ShClTransferListEntryInitEx(pListEntry, VBOX_SHCL_INFO_F_NONE, NULL /* pszName */, NULL /* pvInfo */, 0 /* cbInfo */);
632}
633
634/**
635 * Destroys a clipboard list entry structure.
636 *
637 * @param pListEntry Clipboard list entry structure to destroy.
638 */
639void ShClTransferListEntryDestroy(PSHCLLISTENTRY pListEntry)
640{
641 if (!pListEntry)
642 return;
643
644 if (pListEntry->pszName)
645 {
646 RTStrFree(pListEntry->pszName);
647
648 pListEntry->pszName = NULL;
649 pListEntry->cbName = 0;
650 }
651
652 if (pListEntry->pvInfo)
653 {
654 RTMemFree(pListEntry->pvInfo);
655 pListEntry->pvInfo = NULL;
656 pListEntry->cbInfo = 0;
657 }
658}
659
660/**
661 * Returns whether a given clipboard list entry is valid or not.
662 *
663 * @returns \c true if valid, \c false if not.
664 * @param pListEntry Clipboard list entry to validate.
665 */
666bool ShClTransferListEntryIsValid(PSHCLLISTENTRY pListEntry)
667{
668 AssertPtrReturn(pListEntry, false);
669
670 bool fValid = false;
671
672 if (shclTransferListEntryNameIsValid(pListEntry->pszName, pListEntry->cbName))
673 {
674 fValid = pListEntry->cbInfo == 0 /* cbInfo / pvInfo is optional. */
675 || pListEntry->pvInfo != NULL;
676 }
677
678 if (!fValid)
679 LogRel2(("Shared Clipboard: List entry '%s' is invalid\n", pListEntry->pszName));
680
681 return fValid;
682}
683
684
685/*********************************************************************************************************************************
686 * Transfer Object *
687 ********************************************************************************************************************************/
688
689/**
690 * Initializes a transfer object context.
691 *
692 * @returns VBox status code.
693 * @param pObjCtx Transfer object context to initialize.
694 */
695int ShClTransferObjCtxInit(PSHCLCLIENTTRANSFEROBJCTX pObjCtx)
696{
697 AssertPtrReturn(pObjCtx, VERR_INVALID_POINTER);
698
699 LogFlowFuncEnter();
700
701 pObjCtx->uHandle = NIL_SHCLOBJHANDLE;
702
703 return VINF_SUCCESS;
704}
705
706/**
707 * Destroys a transfer object context.
708 *
709 * @param pObjCtx Transfer object context to destroy.
710 */
711void ShClTransferObjCtxDestroy(PSHCLCLIENTTRANSFEROBJCTX pObjCtx)
712{
713 AssertPtrReturnVoid(pObjCtx);
714
715 LogFlowFuncEnter();
716}
717
718/**
719 * Returns if a transfer object context is valid or not.
720 *
721 * @returns \c true if valid, \c false if not.
722 * @param pObjCtx Transfer object context to check.
723 */
724bool ShClTransferObjCtxIsValid(PSHCLCLIENTTRANSFEROBJCTX pObjCtx)
725{
726 return ( pObjCtx
727 && pObjCtx->uHandle != NIL_SHCLOBJHANDLE);
728}
729
730/**
731 * Initializes a transfer object structure.
732 *
733 * @returns VBox status code.
734 * @param pObj Object structure to initialize.
735 */
736int ShClTransferObjInit(PSHCLTRANSFEROBJ pObj)
737{
738 AssertPtrReturn(pObj, VERR_INVALID_POINTER);
739
740 pObj->hObj = NIL_SHCLOBJHANDLE;
741 pObj->enmType = SHCLOBJTYPE_INVALID;
742
743 pObj->pszPathLocalAbs = NULL;
744
745 RT_ZERO(pObj->u);
746
747 return VINF_SUCCESS;
748}
749
750/**
751 * Destroys a transfer object structure.
752 *
753 * @param pObj Object structure to destroy.
754 */
755void ShClTransferObjDestroy(PSHCLTRANSFEROBJ pObj)
756{
757 if (!pObj)
758 return;
759
760 if (pObj->pszPathLocalAbs)
761 {
762 RTStrFree(pObj->pszPathLocalAbs);
763 pObj->pszPathLocalAbs = NULL;
764 }
765}
766
767/**
768 * Initializes a transfer object open parameters structure.
769 *
770 * @returns VBox status code.
771 * @param pParms Transfer object open parameters structure to initialize.
772 */
773int ShClTransferObjOpenParmsInit(PSHCLOBJOPENCREATEPARMS pParms)
774{
775 AssertPtrReturn(pParms, VERR_INVALID_POINTER);
776
777 int rc;
778
779 RT_BZERO(pParms, sizeof(SHCLOBJOPENCREATEPARMS));
780
781 pParms->cbPath = RTPATH_MAX; /** @todo Make this dynamic. */
782 pParms->pszPath = RTStrAlloc(pParms->cbPath);
783 if (pParms->pszPath)
784 {
785 rc = VINF_SUCCESS;
786 }
787 else
788 rc = VERR_NO_MEMORY;
789
790 LogFlowFuncLeaveRC(rc);
791 return rc;
792}
793
794/**
795 * Copies a transfer object open parameters structure from source to destination.
796 *
797 * @returns VBox status code.
798 * @param pParmsDst Where to copy the source transfer object open parameters to.
799 * @param pParmsSrc Which source transfer object open parameters to copy.
800 */
801int ShClTransferObjOpenParmsCopy(PSHCLOBJOPENCREATEPARMS pParmsDst, PSHCLOBJOPENCREATEPARMS pParmsSrc)
802{
803 int rc;
804
805 *pParmsDst = *pParmsSrc;
806
807 if (pParmsSrc->pszPath)
808 {
809 Assert(pParmsSrc->cbPath);
810 pParmsDst->pszPath = RTStrDup(pParmsSrc->pszPath);
811 if (pParmsDst->pszPath)
812 {
813 rc = VINF_SUCCESS;
814 }
815 else
816 rc = VERR_NO_MEMORY;
817 }
818 else
819 rc = VINF_SUCCESS;
820
821 LogFlowFuncLeaveRC(rc);
822 return rc;
823}
824
825/**
826 * Destroys a transfer object open parameters structure.
827 *
828 * @param pParms Transfer object open parameters structure to destroy.
829 */
830void ShClTransferObjOpenParmsDestroy(PSHCLOBJOPENCREATEPARMS pParms)
831{
832 if (!pParms)
833 return;
834
835 if (pParms->pszPath)
836 {
837 RTStrFree(pParms->pszPath);
838 pParms->pszPath = NULL;
839 }
840}
841
842/**
843 * Returns a specific transfer object of a transfer.
844 *
845 * @returns Pointer to transfer object if found, or NULL if not found.
846 * @param pTransfer Clipboard transfer to get transfer object from.
847 * @param hObj Object handle of the object to get handle info for.
848 */
849PSHCLTRANSFEROBJ ShClTransferObjGet(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj)
850{
851 PSHCLTRANSFEROBJ pIt;
852 RTListForEach(&pTransfer->lstObj, pIt, SHCLTRANSFEROBJ, Node) /** @todo Slooow ...but works for now. */
853 {
854 if (pIt->hObj == hObj)
855 return pIt;
856 }
857
858 return NULL;
859}
860
861/**
862 * Opens a transfer object.
863 *
864 * @returns VBox status code.
865 * @param pTransfer Clipboard transfer to open the object for.
866 * @param pOpenCreateParms Open / create parameters of transfer object to open / create.
867 * @param phObj Where to store the handle of transfer object opened on success.
868 */
869int ShClTransferObjOpen(PSHCLTRANSFER pTransfer, PSHCLOBJOPENCREATEPARMS pOpenCreateParms, PSHCLOBJHANDLE phObj)
870{
871 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
872 AssertPtrReturn(pOpenCreateParms, VERR_INVALID_POINTER);
873 AssertPtrReturn(phObj, VERR_INVALID_POINTER);
874 AssertMsgReturn(pTransfer->pszPathRootAbs, ("Transfer has no root path set\n"), VERR_INVALID_PARAMETER);
875 /** @todo Check pOpenCreateParms->fCreate flags. */
876 AssertMsgReturn(pOpenCreateParms->pszPath, ("No path in open/create params set\n"), VERR_INVALID_PARAMETER);
877
878 if (pTransfer->cObjHandles >= pTransfer->cMaxObjHandles)
879 return VERR_SHCLPB_MAX_OBJECTS_REACHED;
880
881 LogFlowFunc(("pszPath=%s, fCreate=0x%x\n", pOpenCreateParms->pszPath, pOpenCreateParms->fCreate));
882
883 int rc;
884 if (pTransfer->ProviderIface.pfnObjOpen)
885 rc = pTransfer->ProviderIface.pfnObjOpen(&pTransfer->ProviderCtx, pOpenCreateParms, phObj);
886 else
887 rc = VERR_NOT_SUPPORTED;
888
889 if (RT_FAILURE(rc))
890 LogRel(("Shared Clipboard: Opening object '%s' (flags %#x) failed with %Rrc\n",
891 pOpenCreateParms->pszPath, pOpenCreateParms->fCreate, rc));
892
893 LogFlowFuncLeaveRC(rc);
894 return rc;
895}
896
897/**
898 * Closes a transfer object.
899 *
900 * @returns VBox status code.
901 * @param pTransfer Clipboard transfer that contains the object to close.
902 * @param hObj Handle of transfer object to close.
903 */
904int ShClTransferObjClose(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj)
905{
906 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
907
908 int rc;
909 if (pTransfer->ProviderIface.pfnObjClose)
910 rc = pTransfer->ProviderIface.pfnObjClose(&pTransfer->ProviderCtx, hObj);
911 else
912 rc = VERR_NOT_SUPPORTED;
913
914 if (RT_FAILURE(rc))
915 LogRel(("Shared Clipboard: Reading object 0x%x failed with %Rrc\n", hObj, rc));
916
917 LogFlowFuncLeaveRC(rc);
918 return rc;
919}
920
921/**
922 * Reads from a transfer object.
923 *
924 * @returns VBox status code.
925 * @param pTransfer Clipboard transfer that contains the object to read from.
926 * @param hObj Handle of transfer object to read from.
927 * @param pvBuf Buffer for where to store the read data.
928 * @param cbBuf Size (in bytes) of buffer.
929 * @param fFlags Read flags. Optional.
930 * @param pcbRead Where to return how much bytes were read on success. Optional.
931 */
932int ShClTransferObjRead(PSHCLTRANSFER pTransfer,
933 SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf, uint32_t fFlags, uint32_t *pcbRead)
934{
935 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
936 AssertPtrReturn(pvBuf, VERR_INVALID_POINTER);
937 AssertReturn (cbBuf, VERR_INVALID_PARAMETER);
938 /* pcbRead is optional. */
939 /** @todo Validate fFlags. */
940
941 int rc;
942 if (pTransfer->ProviderIface.pfnObjRead)
943 rc = pTransfer->ProviderIface.pfnObjRead(&pTransfer->ProviderCtx, hObj, pvBuf, cbBuf, fFlags, pcbRead);
944 else
945 rc = VERR_NOT_SUPPORTED;
946
947 if (RT_FAILURE(rc))
948 LogRel(("Shared Clipboard: Reading object 0x%x failed with %Rrc\n", hObj, rc));
949
950 LogFlowFuncLeaveRC(rc);
951 return rc;
952}
953
954/**
955 * Writes to a transfer object.
956 *
957 * @returns VBox status code.
958 * @param pTransfer Clipboard transfer that contains the object to write to.
959 * @param hObj Handle of transfer object to write to.
960 * @param pvBuf Buffer of data to write.
961 * @param cbBuf Size (in bytes) of buffer to write.
962 * @param fFlags Write flags. Optional.
963 * @param pcbWritten How much bytes were writtenon success. Optional.
964 */
965int ShClTransferObjWrite(PSHCLTRANSFER pTransfer,
966 SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf, uint32_t fFlags, uint32_t *pcbWritten)
967{
968 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
969 AssertPtrReturn(pvBuf, VERR_INVALID_POINTER);
970 AssertReturn (cbBuf, VERR_INVALID_PARAMETER);
971 /* pcbWritten is optional. */
972
973 int rc;
974 if (pTransfer->ProviderIface.pfnObjWrite)
975 rc = pTransfer->ProviderIface.pfnObjWrite(&pTransfer->ProviderCtx, hObj, pvBuf, cbBuf, fFlags, pcbWritten);
976 else
977 rc = VERR_NOT_SUPPORTED;
978
979 if (RT_FAILURE(rc))
980 LogRel(("Shared Clipboard: Writing object 0x%x failed with %Rrc\n", hObj, rc));
981
982 LogFlowFuncLeaveRC(rc);
983 return rc;
984}
985
986/**
987 * Duplicates a transfer object data chunk.
988 *
989 * @returns Duplicated object data chunk on success, or NULL on failure.
990 * @param pDataChunk Transfer object data chunk to duplicate.
991 */
992PSHCLOBJDATACHUNK ShClTransferObjDataChunkDup(PSHCLOBJDATACHUNK pDataChunk)
993{
994 AssertPtrReturn(pDataChunk, NULL);
995
996 PSHCLOBJDATACHUNK pDataChunkDup = (PSHCLOBJDATACHUNK)RTMemAllocZ(sizeof(SHCLOBJDATACHUNK));
997 if (!pDataChunkDup)
998 return NULL;
999
1000 if (pDataChunk->pvData)
1001 {
1002 Assert(pDataChunk->cbData);
1003
1004 pDataChunkDup->uHandle = pDataChunk->uHandle;
1005 pDataChunkDup->pvData = RTMemDup(pDataChunk->pvData, pDataChunk->cbData);
1006 AssertPtrReturn(pDataChunkDup->pvData, NULL);
1007 pDataChunkDup->cbData = pDataChunk->cbData;
1008 }
1009
1010 return pDataChunkDup;
1011}
1012
1013/**
1014 * Destroys a transfer object data chunk.
1015 *
1016 * @param pDataChunk Transfer object data chunk to destroy.
1017 */
1018void ShClTransferObjDataChunkDestroy(PSHCLOBJDATACHUNK pDataChunk)
1019{
1020 if (!pDataChunk)
1021 return;
1022
1023 if (pDataChunk->pvData)
1024 {
1025 Assert(pDataChunk->cbData);
1026
1027 RTMemFree(pDataChunk->pvData);
1028
1029 pDataChunk->pvData = NULL;
1030 pDataChunk->cbData = 0;
1031 }
1032
1033 pDataChunk->uHandle = 0;
1034}
1035
1036/**
1037 * Frees a transfer object data chunk.
1038 *
1039 * @param pDataChunk Transfer object data chunk to free.
1040 * The pointer will be invalid on return.
1041 */
1042void ShClTransferObjDataChunkFree(PSHCLOBJDATACHUNK pDataChunk)
1043{
1044 if (!pDataChunk)
1045 return;
1046
1047 ShClTransferObjDataChunkDestroy(pDataChunk);
1048
1049 RTMemFree(pDataChunk);
1050 pDataChunk = NULL;
1051}
1052
1053
1054/*********************************************************************************************************************************
1055 * Transfer *
1056 ********************************************************************************************************************************/
1057
1058/**
1059 * Creates a clipboard transfer, extended version.
1060 *
1061 * @returns VBox status code.
1062 * @param enmDir Specifies the transfer direction of this transfer.
1063 * @param enmSource Specifies the data source of the transfer.
1064 * @param pCallbacks Callback table to use. Optional and can be NULL.
1065 * @param cbMaxChunkSize Maximum transfer chunk size (in bytes) to use.
1066 * @param cMaxListHandles Maximum list entries the transfer can have.
1067 * @param cMaxObjHandles Maximum transfer objects the transfer can have.
1068 * @param ppTransfer Where to return the created clipboard transfer struct.
1069 * Must be destroyed by ShClTransferDestroy().
1070 */
1071int ShClTransferCreateEx(SHCLTRANSFERDIR enmDir, SHCLSOURCE enmSource, PSHCLTRANSFERCALLBACKS pCallbacks,
1072 uint32_t cbMaxChunkSize, uint32_t cMaxListHandles, uint32_t cMaxObjHandles, PSHCLTRANSFER *ppTransfer)
1073{
1074 AssertPtrReturn(ppTransfer, VERR_INVALID_POINTER);
1075 /* pCallbacks can be NULL. */
1076
1077 LogFlowFuncEnter();
1078
1079 PSHCLTRANSFER pTransfer = (PSHCLTRANSFER)RTMemAllocZ(sizeof(SHCLTRANSFER));
1080 AssertPtrReturn(pTransfer, VERR_NO_MEMORY);
1081
1082 pTransfer->State.uID = NIL_SHCLTRANSFERID;
1083 pTransfer->State.enmStatus = SHCLTRANSFERSTATUS_NONE;
1084 pTransfer->State.enmDir = enmDir;
1085 pTransfer->State.enmSource = enmSource;
1086
1087 pTransfer->Thread.hThread = NIL_RTTHREAD;
1088 pTransfer->Thread.fCancelled = false;
1089 pTransfer->Thread.fStarted = false;
1090 pTransfer->Thread.fStop = false;
1091
1092 pTransfer->pszPathRootAbs = NULL;
1093
1094 pTransfer->uTimeoutMs = SHCL_TIMEOUT_DEFAULT_MS;
1095 pTransfer->cbMaxChunkSize = cbMaxChunkSize;
1096 pTransfer->cMaxListHandles = cMaxListHandles;
1097 pTransfer->cMaxObjHandles = cMaxObjHandles;
1098
1099 pTransfer->pvUser = NULL;
1100 pTransfer->cbUser = 0;
1101
1102 RTListInit(&pTransfer->lstHandles);
1103 RTListInit(&pTransfer->lstObj);
1104
1105 /* The provider context + interface is NULL by default. */
1106 RT_ZERO(pTransfer->ProviderCtx);
1107 RT_ZERO(pTransfer->ProviderIface);
1108
1109 /* Make sure to set the callbacks before calling pfnOnCreate below. */
1110 shClTransferSetCallbacks(pTransfer, pCallbacks);
1111
1112 ShClTransferListInit(&pTransfer->lstRoots);
1113
1114 int rc = RTCritSectInit(&pTransfer->CritSect);
1115 AssertRCReturn(rc, rc);
1116
1117 rc = RTSemEventCreate(&pTransfer->StatusChangeEvent);
1118 AssertRCReturn(rc, rc);
1119
1120 rc = ShClEventSourceCreate(&pTransfer->Events, 0 /* uID */);
1121 if (RT_SUCCESS(rc))
1122 {
1123 if (pTransfer->Callbacks.pfnOnCreated)
1124 pTransfer->Callbacks.pfnOnCreated(&pTransfer->CallbackCtx);
1125
1126 *ppTransfer = pTransfer;
1127 }
1128 else
1129 {
1130 if (pTransfer)
1131 {
1132 ShClTransferDestroy(pTransfer);
1133 RTMemFree(pTransfer);
1134 }
1135 }
1136
1137 LogFlowFuncLeaveRC(rc);
1138 return rc;
1139}
1140
1141/**
1142 * Creates a clipboard transfer with default settings.
1143 *
1144 * @returns VBox status code.
1145 * @param enmDir Specifies the transfer direction of this transfer.
1146 * @param enmSource Specifies the data source of the transfer.
1147 * @param pCallbacks Callback table to use. Optional and can be NULL.
1148 * @param ppTransfer Where to return the created clipboard transfer struct.
1149 * Must be destroyed by ShClTransferDestroy().
1150 */
1151int ShClTransferCreate(SHCLTRANSFERDIR enmDir, SHCLSOURCE enmSource, PSHCLTRANSFERCALLBACKS pCallbacks, PSHCLTRANSFER *ppTransfer)
1152{
1153 return ShClTransferCreateEx(enmDir, enmSource, pCallbacks,
1154 SHCL_TRANSFER_DEFAULT_MAX_CHUNK_SIZE,
1155 SHCL_TRANSFER_DEFAULT_MAX_LIST_HANDLES,
1156 SHCL_TRANSFER_DEFAULT_MAX_OBJ_HANDLES,
1157 ppTransfer);
1158}
1159
1160/**
1161 * Destroys a clipboard transfer.
1162 *
1163 * @returns VBox status code.
1164 * @param pTransfer Clipboard transfer to destroy.
1165 * The pointer will be invalid after return.
1166 */
1167int ShClTransferDestroy(PSHCLTRANSFER pTransfer)
1168{
1169 if (!pTransfer)
1170 return VINF_SUCCESS;
1171
1172 if (!RTCritSectIsInitialized(&pTransfer->CritSect))
1173 return VINF_SUCCESS;
1174
1175 /* Must come before the refcount check below, as the callback might release a reference. */
1176 if (pTransfer->Callbacks.pfnOnDestroy)
1177 pTransfer->Callbacks.pfnOnDestroy(&pTransfer->CallbackCtx);
1178
1179 AssertMsgReturn(ASMAtomicReadU32(&pTransfer->cRefs) == 0,
1180 ("Number of references > 0 (%RU32)\n", pTransfer->cRefs), VERR_WRONG_ORDER);
1181
1182 LogFlowFuncEnter();
1183
1184 int rc = shClTransferThreadDestroy(pTransfer, SHCL_TIMEOUT_DEFAULT_MS);
1185 if (RT_FAILURE(rc))
1186 return rc;
1187
1188 ShClTransferReset(pTransfer);
1189
1190 if (RTCritSectIsInitialized(&pTransfer->CritSect))
1191 RTCritSectDelete(&pTransfer->CritSect);
1192
1193 rc = RTSemEventDestroy(pTransfer->StatusChangeEvent);
1194 AssertRCReturn(rc, rc);
1195 pTransfer->StatusChangeEvent = NIL_RTSEMEVENT;
1196
1197 ShClEventSourceDestroy(&pTransfer->Events);
1198
1199 RTMemFree(pTransfer);
1200 pTransfer = NULL;
1201
1202 LogFlowFuncLeave();
1203 return VINF_SUCCESS;
1204}
1205
1206/**
1207 * Initializes a clipboard transfer.
1208 *
1209 * @returns VBox status code.
1210 * @param pTransfer Transfer to initialize.
1211 */
1212int ShClTransferInit(PSHCLTRANSFER pTransfer)
1213{
1214 shClTransferLock(pTransfer);
1215
1216 AssertMsgReturnStmt(pTransfer->State.enmStatus < SHCLTRANSFERSTATUS_INITIALIZED,
1217 ("Wrong status (currently is %s)\n", ShClTransferStatusToStr(pTransfer->State.enmStatus)),
1218 shClTransferUnlock(pTransfer), VERR_WRONG_ORDER);
1219
1220 pTransfer->cRefs = 0;
1221
1222 LogFlowFunc(("uID=%RU32, enmDir=%RU32, enmSource=%RU32\n",
1223 pTransfer->State.uID, pTransfer->State.enmDir, pTransfer->State.enmSource));
1224
1225 pTransfer->cListHandles = 0;
1226 pTransfer->uListHandleNext = 1;
1227
1228 pTransfer->cObjHandles = 0;
1229 pTransfer->uObjHandleNext = 1;
1230
1231 pTransfer->Thread.fStarted = false;
1232 pTransfer->Thread.fStop = false;
1233 pTransfer->Thread.fCancelled = false;
1234
1235 int rc = shClTransferSetStatus(pTransfer, SHCLTRANSFERSTATUS_INITIALIZED);
1236
1237 shClTransferUnlock(pTransfer);
1238
1239 if (RT_SUCCESS(rc))
1240 {
1241 if (pTransfer->Callbacks.pfnOnInitialized)
1242 pTransfer->Callbacks.pfnOnInitialized(&pTransfer->CallbackCtx);
1243 }
1244
1245 LogFlowFuncLeaveRC(rc);
1246 return rc;
1247}
1248
1249/**
1250 * Returns whether a transfer is in a running state or not.
1251 *
1252 * @returns @c true if in running state, or @c false if not.
1253 * @param pTransfer Clipboard transfer to return status for.
1254 */
1255bool ShClTransferIsRunning(PSHCLTRANSFER pTransfer)
1256{
1257 shClTransferLock(pTransfer);
1258
1259 bool const fRunning = pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_STARTED;
1260
1261 shClTransferUnlock(pTransfer);
1262
1263 return fRunning;
1264}
1265
1266/**
1267 * Returns whether a transfer has been (successfully) completed or not.
1268 *
1269 * @returns @c true if complete, or @c false if not.
1270 * @param pTransfer Clipboard transfer to return status for.
1271 */
1272bool ShClTransferIsComplete(PSHCLTRANSFER pTransfer)
1273{
1274 shClTransferLock(pTransfer);
1275
1276 bool const fCompleted = pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_COMPLETED;
1277
1278 shClTransferUnlock(pTransfer);
1279
1280 return fCompleted;
1281}
1282
1283/**
1284 * Returns whether a transfer has been aborted due to cancelling, killing or an error.
1285 *
1286 * @returns @c true if in aborted state, or @c false if not.
1287 * @param pTransfer Clipboard transfer to return status for.
1288 */
1289bool ShClTransferIsAborted(PSHCLTRANSFER pTransfer)
1290{
1291 shClTransferLock(pTransfer);
1292
1293 bool const fAborted = pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_CANCELED
1294 || pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_KILLED
1295 || pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_ERROR;
1296
1297 shClTransferUnlock(pTransfer);
1298
1299 return fAborted;
1300}
1301
1302/**
1303 * Locks a transfer.
1304 *
1305 * @param pTransfer Transfer to lock.
1306 */
1307DECLINLINE(void) shClTransferLock(PSHCLTRANSFER pTransfer)
1308{
1309 int rc2 = RTCritSectEnter(&pTransfer->CritSect);
1310 AssertRC(rc2);
1311}
1312
1313/**
1314 * Unlocks a transfer.
1315 *
1316 * @param pTransfer Transfer to unlock.
1317 */
1318DECLINLINE(void) shClTransferUnlock(PSHCLTRANSFER pTransfer)
1319{
1320 int rc2 = RTCritSectLeave(&pTransfer->CritSect);
1321 AssertRC(rc2);
1322}
1323
1324/**
1325 * Acquires a reference to this transfer.
1326 *
1327 * @returns New reference count.
1328 * @param pTransfer Transfer to acquire reference for.
1329 */
1330uint32_t ShClTransferAcquire(PSHCLTRANSFER pTransfer)
1331{
1332 return ASMAtomicIncU32(&pTransfer->cRefs);
1333}
1334
1335/**
1336 * Releases a reference to this transfer.
1337 *
1338 * @returns New reference count.
1339 * @param pTransfer Transfer to release reference for.
1340 */
1341uint32_t ShClTransferRelease(PSHCLTRANSFER pTransfer)
1342{
1343 const uint32_t cRefs = ASMAtomicDecU32(&pTransfer->cRefs);
1344 Assert(pTransfer->cRefs <= VBOX_SHCL_MAX_TRANSFERS); /* Not perfect, but better than nothing. */
1345 return cRefs;
1346}
1347
1348/**
1349 * Opens a transfer list.
1350 *
1351 * @returns VBox status code.
1352 * @param pTransfer Clipboard transfer to handle.
1353 * @param pOpenParms List open parameters to use for opening.
1354 * @param phList Where to store the List handle of opened list on success.
1355 */
1356int ShClTransferListOpen(PSHCLTRANSFER pTransfer, PSHCLLISTOPENPARMS pOpenParms,
1357 PSHCLLISTHANDLE phList)
1358{
1359 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
1360 AssertPtrReturn(pOpenParms, VERR_INVALID_POINTER);
1361 AssertPtrReturn(phList, VERR_INVALID_POINTER);
1362
1363 if (pTransfer->cListHandles == pTransfer->cMaxListHandles)
1364 return VERR_SHCLPB_MAX_LISTS_REACHED;
1365
1366 int rc;
1367 if (pTransfer->ProviderIface.pfnListOpen)
1368 rc = pTransfer->ProviderIface.pfnListOpen(&pTransfer->ProviderCtx, pOpenParms, phList);
1369 else
1370 rc = VERR_NOT_SUPPORTED;
1371
1372 if (RT_FAILURE(rc))
1373 LogRel(("Shared Clipboard: Opening list '%s' (fiter '%s', flags %#x) failed with %Rrc\n",
1374 pOpenParms->pszPath, pOpenParms->pszFilter, pOpenParms->fList, rc));
1375
1376 LogFlowFuncLeaveRC(rc);
1377 return rc;
1378}
1379
1380/**
1381 * Closes a transfer list.
1382 *
1383 * @returns VBox status code.
1384 * @param pTransfer Clipboard transfer to handle.
1385 * @param hList Handle of list to close.
1386 */
1387int ShClTransferListClose(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList)
1388{
1389 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
1390
1391 if (hList == NIL_SHCLLISTHANDLE)
1392 return VINF_SUCCESS;
1393
1394 int rc;
1395 if (pTransfer->ProviderIface.pfnListClose)
1396 rc = pTransfer->ProviderIface.pfnListClose(&pTransfer->ProviderCtx, hList);
1397 else
1398 rc = VERR_NOT_SUPPORTED;
1399
1400 if (RT_FAILURE(rc))
1401 LogRel(("Shared Clipboard: Closing list 0x%x entry failed with %Rrc\n", hList, rc));
1402
1403 LogFlowFuncLeaveRC(rc);
1404 return rc;
1405}
1406
1407/**
1408 * Retrieves the header of a transfer list.
1409 *
1410 * @returns VBox status code.
1411 * @param pTransfer Clipboard transfer to handle.
1412 * @param hList Handle of list to get header for.
1413 * @param pHdr Where to store the returned list header information.
1414 */
1415int ShClTransferListGetHeader(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList,
1416 PSHCLLISTHDR pHdr)
1417{
1418 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
1419 AssertPtrReturn(pHdr, VERR_INVALID_POINTER);
1420
1421 LogFlowFunc(("hList=%RU64\n", hList));
1422
1423 int rc;
1424 if (pTransfer->ProviderIface.pfnListHdrRead)
1425 rc = pTransfer->ProviderIface.pfnListHdrRead(&pTransfer->ProviderCtx, hList, pHdr);
1426 else
1427 rc = VERR_NOT_SUPPORTED;
1428
1429 if (RT_FAILURE(rc))
1430 LogRel(("Shared Clipboard: Reading list header list 0x%x entry failed with %Rrc\n", hList, rc));
1431
1432 LogFlowFuncLeaveRC(rc);
1433 return rc;
1434}
1435
1436/**
1437 * Returns a specific list handle info of a clipboard transfer.
1438 *
1439 * @returns Pointer to list handle info if found, or NULL if not found.
1440 * @param pTransfer Clipboard transfer to get list handle info from.
1441 * @param hList List handle of the list to get handle info for.
1442 */
1443PSHCLLISTHANDLEINFO ShClTransferListGetByHandle(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList)
1444{
1445 PSHCLLISTHANDLEINFO pIt;
1446 RTListForEach(&pTransfer->lstHandles, pIt, SHCLLISTHANDLEINFO, Node) /** @todo Sloooow ... improve this. */
1447 {
1448 if (pIt->hList == hList)
1449 return pIt;
1450 }
1451
1452 return NULL;
1453}
1454
1455/**
1456 * Returns the a transfer object of a transfer list.
1457 *
1458 * Currently not implemented and wil return NULL.
1459 *
1460 * @returns Pointer to transfer object, or NULL if not found / invalid.
1461 * @param pTransfer Clipboard transfer to return transfer object for.
1462 * @param hList Handle of clipboard transfer list to get object for.
1463 * @param uIdx Index of object to get.
1464 */
1465PSHCLTRANSFEROBJ ShClTransferListGetObj(PSHCLTRANSFER pTransfer,
1466 SHCLLISTHANDLE hList, uint64_t uIdx)
1467{
1468 AssertPtrReturn(pTransfer, NULL);
1469
1470 RT_NOREF(hList, uIdx);
1471
1472 LogFlowFunc(("hList=%RU64\n", hList));
1473
1474 return NULL;
1475}
1476
1477/**
1478 * Reads a single transfer list entry.
1479 *
1480 * @returns VBox status code or VERR_NO_MORE_FILES if the end of the list has been reached.
1481 * @param pTransfer Clipboard transfer to handle.
1482 * @param hList List handle of list to read from.
1483 * @param pEntry Where to store the read information.
1484 */
1485int ShClTransferListRead(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList,
1486 PSHCLLISTENTRY pEntry)
1487{
1488 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
1489 AssertPtrReturn(pEntry, VERR_INVALID_POINTER);
1490
1491 LogFlowFunc(("hList=%RU64\n", hList));
1492
1493 int rc;
1494 if (pTransfer->ProviderIface.pfnListEntryRead)
1495 rc = pTransfer->ProviderIface.pfnListEntryRead(&pTransfer->ProviderCtx, hList, pEntry);
1496 else
1497 rc = VERR_NOT_SUPPORTED;
1498
1499 if (RT_FAILURE(rc))
1500 LogRel(("Shared Clipboard: Reading list for list 0x%x entry failed with %Rrc\n", hList, rc));
1501
1502 LogFlowFuncLeaveRC(rc);
1503 return rc;
1504}
1505
1506/**
1507 * Writes a single transfer list entry.
1508 *
1509 * @returns VBox status code.
1510 * @param pTransfer Clipboard transfer to handle.
1511 * @param hList List handle of list to write to.
1512 * @param pEntry Entry information to write.
1513 */
1514int ShClTransferListWrite(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList,
1515 PSHCLLISTENTRY pEntry)
1516{
1517 RT_NOREF(pTransfer, hList, pEntry);
1518
1519 int rc = VINF_SUCCESS;
1520
1521#if 0
1522 if (pTransfer->ProviderIface.pfnListEntryWrite)
1523 rc = pTransfer->ProviderIface.pfnListEntryWrite(&pTransfer->ProviderCtx, hList, pEntry);
1524#endif
1525
1526 if (RT_FAILURE(rc))
1527 LogRel(("Shared Clipboard: Writing list entry to list 0x%x failed with %Rrc\n", hList, rc));
1528
1529 LogFlowFuncLeaveRC(rc);
1530 return rc;
1531}
1532
1533/**
1534 * Returns whether a given transfer list handle is valid or not.
1535 *
1536 * @returns \c true if list handle is valid, \c false if not.
1537 * @param pTransfer Clipboard transfer to handle.
1538 * @param hList List handle to check.
1539 */
1540bool ShClTransferListHandleIsValid(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList)
1541{
1542 bool fIsValid = false;
1543
1544 if (pTransfer->State.enmSource == SHCLSOURCE_LOCAL)
1545 {
1546 fIsValid = ShClTransferListGetByHandle(pTransfer, hList) != NULL;
1547 }
1548 else if (pTransfer->State.enmSource == SHCLSOURCE_REMOTE)
1549 {
1550 AssertFailed(); /** @todo Implement. */
1551 }
1552 else
1553 AssertFailedStmt(fIsValid = false);
1554
1555 return fIsValid;
1556}
1557
1558/**
1559 * Copies a transfer callback table from source to destination.
1560 *
1561 * @param pCallbacksDst Callback destination.
1562 * @param pCallbacksSrc Callback source. If set to NULL, the
1563 * destination callback table will be unset.
1564 */
1565static void shClTransferCopyCallbacks(PSHCLTRANSFERCALLBACKS pCallbacksDst, PSHCLTRANSFERCALLBACKS pCallbacksSrc)
1566{
1567 AssertPtrReturnVoid(pCallbacksDst);
1568 /* pCallbacksSrc can be NULL */
1569
1570 if (pCallbacksSrc) /* Set */
1571 {
1572#define SET_CALLBACK(a_pfnCallback) \
1573 if (pCallbacksSrc->a_pfnCallback) \
1574 pCallbacksDst->a_pfnCallback = pCallbacksSrc->a_pfnCallback
1575
1576 SET_CALLBACK(pfnOnCreated);
1577 SET_CALLBACK(pfnOnInitialized);
1578 SET_CALLBACK(pfnOnDestroy);
1579 SET_CALLBACK(pfnOnStarted);
1580 SET_CALLBACK(pfnOnCompleted);
1581 SET_CALLBACK(pfnOnError);
1582 SET_CALLBACK(pfnOnRegistered);
1583 SET_CALLBACK(pfnOnUnregistered);
1584
1585#undef SET_CALLBACK
1586
1587 pCallbacksDst->pvUser = pCallbacksSrc->pvUser;
1588 pCallbacksDst->cbUser = pCallbacksSrc->cbUser;
1589 }
1590 else /* Unset */
1591 RT_BZERO(pCallbacksDst, sizeof(SHCLTRANSFERCALLBACKS));
1592}
1593
1594/**
1595 * Sets or unsets the callback table to be used for a clipboard transfer.
1596 *
1597 * @returns VBox status code.
1598 * @param pTransfer Clipboard transfer to set callbacks for.
1599 * @param pCallbacks Pointer to callback table to set. If set to NULL,
1600 * existing callbacks for this transfer will be unset.
1601 *
1602 * @note Must come before initializing the transfer via ShClTransferInit().
1603 */
1604static void shClTransferSetCallbacks(PSHCLTRANSFER pTransfer, PSHCLTRANSFERCALLBACKS pCallbacks)
1605{
1606 AssertPtrReturnVoid(pTransfer);
1607 /* pCallbacks can be NULL. */
1608
1609 shClTransferCopyCallbacks(&pTransfer->Callbacks, pCallbacks);
1610
1611 /* Make sure that the callback context has all values set according to the callback table.
1612 * This only needs to be done once, so do this here. */
1613 pTransfer->CallbackCtx.pTransfer = pTransfer;
1614 pTransfer->CallbackCtx.pvUser = pTransfer->Callbacks.pvUser;
1615 pTransfer->CallbackCtx.cbUser = pTransfer->Callbacks.cbUser;
1616}
1617
1618/**
1619 * Sets the transfer provider for a given transfer.
1620 *
1621 * @returns VBox status code.
1622 * @param pTransfer Transfer to create transfer provider for.
1623 * @param pProvider Provider to use.
1624 */
1625int ShClTransferSetProvider(PSHCLTRANSFER pTransfer, PSHCLTXPROVIDER pProvider)
1626{
1627 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
1628 AssertPtrReturn(pProvider, VERR_INVALID_POINTER);
1629
1630 LogFlowFuncEnter();
1631
1632 int rc = VINF_SUCCESS;
1633
1634 pTransfer->ProviderIface = pProvider->Interface;
1635 pTransfer->ProviderCtx.pTransfer = pTransfer;
1636 pTransfer->ProviderCtx.pvUser = pProvider->pvUser;
1637 pTransfer->ProviderCtx.cbUser = pProvider->cbUser;
1638
1639 LogFlowFuncLeaveRC(rc);
1640 return rc;
1641}
1642
1643/**
1644 * Sets the current status.
1645 *
1646 * @returns VBox status code.
1647 * @param pTransfer Clipboard transfer to set status for.
1648 * @param enmStatus Status to set.
1649 *
1650 * @note Caller needs to take critical section.
1651 */
1652static int shClTransferSetStatus(PSHCLTRANSFER pTransfer, SHCLTRANSFERSTATUS enmStatus)
1653{
1654 Assert(RTCritSectIsOwner(&pTransfer->CritSect));
1655#if 0
1656 AssertMsgReturn(pTransfer->State.enmStatus != enmStatus,
1657 ("Setting the same status twice in a row (%#x), please report this!\n", enmStatus), VERR_WRONG_ORDER);
1658#endif
1659 pTransfer->State.enmStatus = enmStatus;
1660
1661 LogFlowFunc(("enmStatus=%s\n", ShClTransferStatusToStr(pTransfer->State.enmStatus)));
1662
1663 return RTSemEventSignal(pTransfer->StatusChangeEvent);
1664}
1665
1666/**
1667 * Returns the number of transfer root list entries.
1668 *
1669 * @returns Root list entry count.
1670 * @param pTransfer Clipboard transfer to return root entry count for.
1671 */
1672uint64_t ShClTransferRootsCount(PSHCLTRANSFER pTransfer)
1673{
1674 AssertPtrReturn(pTransfer, 0);
1675
1676 shClTransferLock(pTransfer);
1677
1678 uint32_t const cRoots = pTransfer->lstRoots.Hdr.cEntries;
1679
1680 shClTransferUnlock(pTransfer);
1681
1682 return cRoots;
1683}
1684
1685/**
1686 * Resets the root list of a clipboard transfer.
1687 *
1688 * @param pTransfer Transfer to clear transfer root list for.
1689 *
1690 * @note Caller needs to take critical section.
1691 */
1692static void shClTransferRootsReset(PSHCLTRANSFER pTransfer)
1693{
1694 AssertPtrReturnVoid(pTransfer);
1695 Assert(RTCritSectIsOwner(&pTransfer->CritSect));
1696
1697 if (pTransfer->pszPathRootAbs)
1698 {
1699 RTStrFree(pTransfer->pszPathRootAbs);
1700 pTransfer->pszPathRootAbs = NULL;
1701 }
1702
1703 ShClTransferListDestroy(&pTransfer->lstRoots);
1704}
1705
1706/**
1707 * Resets a clipboard transfer.
1708 *
1709 * @param pTransfer Clipboard transfer to reset.
1710 */
1711void ShClTransferReset(PSHCLTRANSFER pTransfer)
1712{
1713 AssertPtrReturnVoid(pTransfer);
1714
1715 LogFlowFuncEnter();
1716
1717 shClTransferLock(pTransfer);
1718
1719 shClTransferRootsReset(pTransfer);
1720
1721 PSHCLLISTHANDLEINFO pItList, pItListNext;
1722 RTListForEachSafe(&pTransfer->lstHandles, pItList, pItListNext, SHCLLISTHANDLEINFO, Node)
1723 {
1724 ShClTransferListHandleInfoDestroy(pItList);
1725
1726 RTListNodeRemove(&pItList->Node);
1727
1728 RTMemFree(pItList);
1729 }
1730
1731 PSHCLTRANSFEROBJ pItObj, pItObjNext;
1732 RTListForEachSafe(&pTransfer->lstObj, pItObj, pItObjNext, SHCLTRANSFEROBJ, Node)
1733 {
1734 ShClTransferObjDestroy(pItObj);
1735
1736 RTListNodeRemove(&pItObj->Node);
1737
1738 RTMemFree(pItObj);
1739 }
1740
1741 shClTransferUnlock(pTransfer);
1742}
1743
1744/**
1745 * Get a specific root list entry.
1746 *
1747 * @returns Const pointer to root list entry if found, or NULL if not found..
1748 * @param pTransfer Clipboard transfer to get root list entry of.
1749 * @param uIndex Index (zero-based) of entry to get.
1750 */
1751PCSHCLLISTENTRY ShClTransferRootsEntryGet(PSHCLTRANSFER pTransfer, uint64_t uIndex)
1752{
1753 AssertPtrReturn(pTransfer, NULL);
1754
1755 shClTransferLock(pTransfer);
1756
1757 if (uIndex >= pTransfer->lstRoots.Hdr.cEntries)
1758 {
1759 shClTransferUnlock(pTransfer);
1760 return NULL;
1761 }
1762
1763 PCSHCLLISTENTRY pEntry = shClTransferListGetEntryById(&pTransfer->lstRoots, uIndex);
1764
1765 shClTransferUnlock(pTransfer);
1766
1767 return pEntry;
1768}
1769
1770/**
1771 * Reads the root entries of a clipboard transfer.
1772 *
1773 * This gives the provider interface the chance of reading root entries information.
1774 *
1775 * @returns VBox status code.
1776 * @param pTransfer Clipboard transfer to read root list for.
1777 * Must be in STARTED state.
1778 */
1779int ShClTransferRootListRead(PSHCLTRANSFER pTransfer)
1780{
1781 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
1782
1783 LogFlowFuncEnter();
1784
1785#ifdef DEBUG
1786 shClTransferLock(pTransfer);
1787 AssertMsgReturn( pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_INITIALIZED
1788 || pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_STARTED,
1789 ("Cannot read root list in status %s\n", ShClTransferStatusToStr(pTransfer->State.enmStatus)),
1790 VERR_WRONG_ORDER);
1791 shClTransferUnlock(pTransfer);
1792#endif
1793
1794 int rc;
1795 if (pTransfer->ProviderIface.pfnRootListRead)
1796 rc = pTransfer->ProviderIface.pfnRootListRead(&pTransfer->ProviderCtx);
1797 else
1798 rc = VERR_NOT_SUPPORTED;
1799
1800 shClTransferLock(pTransfer);
1801
1802 /* Make sure that we have at least an empty root path set. */
1803 if ( RT_SUCCESS(rc)
1804 && !pTransfer->pszPathRootAbs)
1805 {
1806 if (RTStrAPrintf(&pTransfer->pszPathRootAbs, "") < 0)
1807 rc = VERR_NO_MEMORY;
1808 }
1809
1810 shClTransferUnlock(pTransfer);
1811
1812 LogFlowFuncLeaveRC(rc);
1813 return rc;
1814}
1815
1816/**
1817 * Initializes the root list entries for a given clipboard transfer, extended version.
1818 *
1819 * @returns VBox status code.
1820 * @param pTransfer Transfer to set transfer list entries for.
1821 * @param pszRoots String list (separated by \a pszSep) of root entries to set.
1822 * All entries must have the same root path.
1823 * @param cbRoots Size (in bytes) of string list. Includes zero terminator.
1824 * @param pszSep String separator to use for splitting up the root entries.
1825 *
1826 * @note Accepts local paths or URI string lists (absolute only).
1827 */
1828int ShClTransferRootsInitFromStringListEx(PSHCLTRANSFER pTransfer, const char *pszRoots, size_t cbRoots, const char *pszSep)
1829{
1830 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
1831 AssertPtrReturn(pszRoots, VERR_INVALID_POINTER);
1832 AssertReturn(cbRoots, VERR_INVALID_PARAMETER);
1833 AssertPtrReturn(pszSep, VERR_INVALID_POINTER);
1834
1835#ifdef DEBUG_andy
1836 LogFlowFunc(("Data:\n%.*Rhxd\n", cbRoots, pszRoots));
1837#endif
1838
1839 if (!RTStrIsValidEncoding(pszRoots))
1840 return VERR_INVALID_UTF8_ENCODING;
1841
1842 int rc = VINF_SUCCESS;
1843
1844 shClTransferLock(pTransfer);
1845
1846 shClTransferRootsReset(pTransfer);
1847
1848 PSHCLLIST pLstRoots = &pTransfer->lstRoots;
1849 char *pszPathRootAbs = NULL;
1850
1851 RTCList<RTCString> lstRootEntries = RTCString(pszRoots, cbRoots).split(pszSep);
1852 if (!lstRootEntries.size())
1853 {
1854 shClTransferUnlock(pTransfer);
1855 return VINF_SUCCESS;
1856 }
1857
1858 for (size_t i = 0; i < lstRootEntries.size(); ++i)
1859 {
1860 char *pszPathCur = NULL;
1861
1862 char *pszPath = NULL;
1863 rc = RTUriFilePathEx(lstRootEntries.at(i).c_str(),
1864 RTPATH_STR_F_STYLE_UNIX, &pszPath, 0 /*cbPath*/, NULL /*pcchPath*/);
1865 if (RT_SUCCESS(rc))
1866 {
1867 pszPathCur = pszPath;
1868 pszPath = NULL; /* pszPath has ownership now. */
1869 }
1870 else if (rc == VERR_URI_NOT_FILE_SCHEME) /* Local file path? */
1871 {
1872 pszPathCur = RTStrDup(lstRootEntries.at(i).c_str());
1873 rc = VINF_SUCCESS;
1874 }
1875
1876 LogFlowFunc(("pszPathCur=%s\n", pszPathCur));
1877
1878 rc = ShClTransferValidatePath(pszPathCur, false /* fMustExist */);
1879 if (RT_FAILURE(rc))
1880 {
1881 RTStrFree(pszPathCur);
1882 break;
1883 }
1884
1885 /* No root path determined yet? */
1886 if (!pszPathRootAbs)
1887 {
1888 pszPathRootAbs = RTStrDup(pszPathCur);
1889 if (pszPathRootAbs)
1890 {
1891 RTPathStripFilename(pszPathRootAbs);
1892
1893 LogFlowFunc(("pszPathRootAbs=%s\n", pszPathRootAbs));
1894
1895 /* We don't want to have a relative directory here. */
1896 if (RTPathStartsWithRoot(pszPathRootAbs))
1897 {
1898 rc = ShClTransferValidatePath(pszPathRootAbs, true /* Path must exist */);
1899 }
1900 else
1901 rc = VERR_PATH_IS_RELATIVE;
1902 }
1903 else
1904 rc = VERR_NO_MEMORY;
1905 }
1906
1907 if (RT_SUCCESS(rc))
1908 {
1909 PSHCLLISTENTRY pEntry;
1910 rc = ShClTransferListEntryAlloc(&pEntry);
1911 if (RT_SUCCESS(rc))
1912 {
1913 PSHCLFSOBJINFO pFsObjInfo = (PSHCLFSOBJINFO)RTMemAllocZ(sizeof(SHCLFSOBJINFO));
1914 if (pFsObjInfo)
1915 {
1916 if (pTransfer->State.enmDir == SHCLTRANSFERDIR_TO_REMOTE)
1917 rc = ShClFsObjInfoQueryLocal(pszPathCur, pFsObjInfo);
1918 if (RT_SUCCESS(rc))
1919 {
1920 /* Calculate the relative path within the root path. */
1921 const char *pszPathRelToRoot = &pszPathCur[strlen(pszPathRootAbs) + 1 /* Skip terminator or (back)slash. */];
1922 if ( pszPathRelToRoot
1923 && *pszPathRelToRoot != '\0')
1924 {
1925 LogFlowFunc(("pszPathRelToRoot=%s\n", pszPathRelToRoot));
1926
1927 rc = ShClTransferListEntryInitEx(pEntry, VBOX_SHCL_INFO_F_FSOBJINFO, pszPathRelToRoot,
1928 pFsObjInfo, sizeof(SHCLFSOBJINFO));
1929 if (RT_SUCCESS(rc))
1930 {
1931 rc = ShClTransferListAddEntry(pLstRoots, pEntry, true /* fAppend */);
1932 if (RT_SUCCESS(rc))
1933 {
1934 pFsObjInfo = NULL; /* pEntry has ownership now. */
1935 }
1936 }
1937 }
1938 else
1939 LogRel(("Shared Clipboard: Unable to construct relative path for '%s' (root is '%s')\n",
1940 pszPathCur, pszPathRootAbs));
1941 }
1942
1943 if (pFsObjInfo)
1944 {
1945 RTMemFree(pFsObjInfo);
1946 pFsObjInfo = NULL;
1947 }
1948 }
1949 else
1950 rc = VERR_NO_MEMORY;
1951
1952 if (RT_FAILURE(rc))
1953 ShClTransferListEntryFree(pEntry);
1954 }
1955 }
1956
1957 RTStrFree(pszPathCur);
1958 }
1959
1960 /* No (valid) root directory found? Bail out early. */
1961 if (!pszPathRootAbs)
1962 rc = VERR_PATH_DOES_NOT_START_WITH_ROOT;
1963
1964 if (RT_SUCCESS(rc))
1965 {
1966 pTransfer->pszPathRootAbs = pszPathRootAbs;
1967 LogFlowFunc(("pszPathRootAbs=%s, cRoots=%zu\n", pTransfer->pszPathRootAbs, pTransfer->lstRoots.Hdr.cEntries));
1968
1969 LogRel2(("Shared Clipboard: Transfer uses root '%s'\n", pTransfer->pszPathRootAbs));
1970 }
1971 else
1972 {
1973 LogRel(("Shared Clipboard: Unable to set roots for transfer, rc=%Rrc\n", rc));
1974 ShClTransferListDestroy(pLstRoots);
1975 RTStrFree(pszPathRootAbs);
1976 }
1977
1978 shClTransferUnlock(pTransfer);
1979
1980 LogFlowFuncLeaveRC(rc);
1981 return rc;
1982}
1983
1984/**
1985 * Initializes the root list entries for a given clipboard transfer.
1986 *
1987 * @returns VBox status code.
1988 * @param pTransfer Transfer to set transfer list entries for.
1989 * @param pszRoots String list (separated by SHCL_TRANSFER_URI_LIST_SEP_STR) of root entries to set.
1990 * All entries must have the same root path.
1991 * @param cbRoots Size (in bytes) of string list. Includes zero terminator.
1992 *
1993 * @note Accepts local paths or URI string lists (absolute only).
1994 */
1995int ShClTransferRootsInitFromStringList(PSHCLTRANSFER pTransfer, const char *pszRoots, size_t cbRoots)
1996{
1997 return ShClTransferRootsInitFromStringListEx(pTransfer, pszRoots, cbRoots, SHCL_TRANSFER_URI_LIST_SEP_STR);
1998}
1999
2000/**
2001 * Initializes the root list entries for a given clipboard transfer, UTF-16 (Unicode) version.
2002 *
2003 * @returns VBox status code.
2004 * @param pTransfer Transfer to set transfer list entries for.
2005 * @param pwszRoots Unicode string list (separated by CRLF) of root entries to set.
2006 * All entries must have the same root path.
2007 * @param cbRoots Size (in bytes) of string list. Includes zero terminator.
2008 *
2009 * @note Accepts local paths or URI string lists (absolute only).
2010 */
2011int ShClTransferRootsInitFromStringListUnicode(PSHCLTRANSFER pTransfer, PRTUTF16 pwszRoots, size_t cbRoots)
2012{
2013 AssertPtrReturn(pwszRoots, VERR_INVALID_POINTER);
2014 AssertReturn(cbRoots, VERR_INVALID_PARAMETER);
2015 AssertReturn(cbRoots % sizeof(RTUTF16) == 0, VERR_INVALID_PARAMETER);
2016
2017 size_t cwcRoots = cbRoots / sizeof(RTUTF16);
2018
2019 /* This may slightly overestimate the space needed. */
2020 size_t chDst = 0;
2021 int rc = ShClUtf16LenUtf8(pwszRoots, cwcRoots, &chDst);
2022 if (RT_SUCCESS(rc))
2023 {
2024 chDst++; /* Add space for terminator. */
2025
2026 char *pszDst = (char *)RTStrAlloc(chDst);
2027 if (pszDst)
2028 {
2029 size_t cbActual = 0;
2030 rc = ShClConvUtf16CRLFToUtf8LF(pwszRoots, cwcRoots, pszDst, chDst, &cbActual);
2031 if (RT_SUCCESS(rc))
2032 rc = ShClTransferRootsInitFromStringList(pTransfer, pszDst, cbActual + 1 /* Include terminator */);
2033
2034 RTStrFree(pszDst);
2035 }
2036 else
2037 rc = VERR_NO_MEMORY;
2038 }
2039
2040 return rc;
2041}
2042
2043/**
2044 * Initializes a single file as a transfer root.
2045 *
2046 * @returns VBox status code.
2047 * @param pTransfer Transfer to set transfer list entries for.
2048 * @param pszFile File to use as transfer root.
2049 *
2050 * @note Convenience function, uses ShClTransferRootsSet() internally.
2051 */
2052int ShClTransferRootsInitFromFile(PSHCLTRANSFER pTransfer, const char *pszFile)
2053{
2054 char *pszRoots = NULL;
2055
2056 LogFlowFuncEnter();
2057
2058 int rc = RTStrAAppend(&pszRoots, pszFile);
2059 AssertRCReturn(rc, rc);
2060 rc = RTStrAAppend(&pszRoots, "\r\n");
2061 AssertRCReturn(rc, rc);
2062 rc = ShClTransferRootsInitFromStringList(pTransfer, pszRoots, strlen(pszRoots) + 1 /* Include terminator */);
2063 RTStrFree(pszRoots);
2064 return rc;
2065}
2066
2067/**
2068 * Returns the clipboard transfer's ID.
2069 *
2070 * @returns The transfer's ID.
2071 * @param pTransfer Clipboard transfer to return ID for.
2072 */
2073SHCLTRANSFERID ShClTransferGetID(PSHCLTRANSFER pTransfer)
2074{
2075 AssertPtrReturn(pTransfer, 0);
2076
2077 shClTransferLock(pTransfer);
2078
2079 SHCLTRANSFERID const uID = pTransfer->State.uID;
2080
2081 shClTransferUnlock(pTransfer);
2082
2083 return uID;
2084}
2085
2086/**
2087 * Returns the clipboard transfer's direction.
2088 *
2089 * @returns The transfer's direction.
2090 * @param pTransfer Clipboard transfer to return direction for.
2091 */
2092SHCLTRANSFERDIR ShClTransferGetDir(PSHCLTRANSFER pTransfer)
2093{
2094 AssertPtrReturn(pTransfer, SHCLTRANSFERDIR_UNKNOWN);
2095
2096 shClTransferLock(pTransfer);
2097
2098 SHCLTRANSFERDIR const enmDir = pTransfer->State.enmDir;
2099
2100 shClTransferUnlock(pTransfer);
2101
2102 return enmDir;
2103}
2104
2105/**
2106 * Returns the absolute root path of a transfer.
2107 *
2108 * @returns VBox status code.
2109 * @param pTransfer Clipboard transfer to return absolute root path for.
2110 * @param pszPath Where to store the returned path.
2111 * @param cbPath Size (in bytes) of \a pszPath.
2112 */
2113int ShClTransferGetRootPathAbs(PSHCLTRANSFER pTransfer, char *pszPath, size_t cbPath)
2114{
2115 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2116
2117 shClTransferLock(pTransfer);
2118
2119 AssertMsgReturn(pTransfer->pszPathRootAbs, ("Transfer has no root path set (yet)\n"), VERR_WRONG_ORDER);
2120
2121 int const rc = RTStrCopy(pszPath, cbPath, pTransfer->pszPathRootAbs);
2122
2123 shClTransferUnlock(pTransfer);
2124
2125 return rc;
2126}
2127
2128/**
2129 * Returns the transfer's source.
2130 *
2131 * @returns The transfer's source.
2132 * @param pTransfer Clipboard transfer to return source for.
2133 */
2134SHCLSOURCE ShClTransferGetSource(PSHCLTRANSFER pTransfer)
2135{
2136 AssertPtrReturn(pTransfer, SHCLSOURCE_INVALID);
2137
2138 shClTransferLock(pTransfer);
2139
2140 SHCLSOURCE const enmSource = pTransfer->State.enmSource;
2141
2142 shClTransferUnlock(pTransfer);
2143
2144 return enmSource;
2145}
2146
2147/**
2148 * Returns the current transfer status.
2149 *
2150 * @returns Current transfer status.
2151 * @param pTransfer Clipboard transfer to return status for.
2152 *
2153 * @note Caller needs to take critical section.
2154 */
2155DECLINLINE(SHCLTRANSFERSTATUS) shClTransferGetStatusLocked(PSHCLTRANSFER pTransfer)
2156{
2157 Assert(RTCritSectIsOwner(&pTransfer->CritSect));
2158
2159 shClTransferLock(pTransfer);
2160
2161 SHCLTRANSFERSTATUS const enmStatus = pTransfer->State.enmStatus;
2162
2163 shClTransferUnlock(pTransfer);
2164
2165 return enmStatus;
2166}
2167
2168/**
2169 * Returns the current transfer status.
2170 *
2171 * @returns Current transfer status.
2172 * @param pTransfer Clipboard transfer to return status for.
2173 */
2174SHCLTRANSFERSTATUS ShClTransferGetStatus(PSHCLTRANSFER pTransfer)
2175{
2176 AssertPtrReturn(pTransfer, SHCLTRANSFERSTATUS_NONE);
2177
2178 shClTransferLock(pTransfer);
2179
2180 SHCLTRANSFERSTATUS const enmSts = shClTransferGetStatusLocked(pTransfer);
2181
2182 shClTransferUnlock(pTransfer);
2183
2184 return enmSts;
2185}
2186
2187/**
2188 * Runs a started clipboard transfer in a dedicated thread.
2189 *
2190 * @returns VBox status code.
2191 * @param pTransfer Clipboard transfer to run.
2192 * @param pfnThreadFunc Pointer to thread function to use.
2193 * @param pvUser Pointer to user-provided data. Optional.
2194 */
2195int ShClTransferRun(PSHCLTRANSFER pTransfer, PFNSHCLTRANSFERTHREAD pfnThreadFunc, void *pvUser)
2196{
2197 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2198 AssertPtrReturn(pfnThreadFunc, VERR_INVALID_POINTER);
2199 /* pvUser is optional. */
2200
2201 AssertMsgReturn(pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_STARTED,
2202 ("Wrong status (currently is %s)\n", ShClTransferStatusToStr(pTransfer->State.enmStatus)),
2203 VERR_WRONG_ORDER);
2204
2205 int rc = shClTransferThreadCreate(pTransfer, pfnThreadFunc, pvUser);
2206
2207 LogFlowFuncLeaveRC(rc);
2208 return rc;
2209}
2210
2211/**
2212 * Starts an initialized transfer.
2213 *
2214 * @returns VBox status code.
2215 * @param pTransfer Clipboard transfer to start.
2216 */
2217int ShClTransferStart(PSHCLTRANSFER pTransfer)
2218{
2219 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2220
2221 LogFlowFuncEnter();
2222
2223 shClTransferLock(pTransfer);
2224
2225 /* Ready to start? */
2226 AssertMsgReturnStmt(pTransfer->ProviderIface.pfnRootListRead != NULL,
2227 ("No provider interface set (yet)\n"),
2228 shClTransferUnlock(pTransfer), VERR_WRONG_ORDER);
2229 AssertMsgReturnStmt(pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_INITIALIZED,
2230 ("Wrong status (currently is %s)\n", ShClTransferStatusToStr(pTransfer->State.enmStatus)),
2231 shClTransferUnlock(pTransfer), VERR_WRONG_ORDER);
2232
2233 int rc = shClTransferSetStatus(pTransfer, SHCLTRANSFERSTATUS_STARTED);
2234
2235 shClTransferUnlock(pTransfer);
2236
2237 if (pTransfer->Callbacks.pfnOnStarted)
2238 pTransfer->Callbacks.pfnOnStarted(&pTransfer->CallbackCtx);
2239
2240 LogFlowFuncLeaveRC(rc);
2241 return rc;
2242}
2243
2244/**
2245 * Stops a started transfer.
2246 *
2247 * @returns VBox status code.
2248 * @param pTransfer Clipboard transfer to stop.
2249 */
2250int ShClTransferStop(PSHCLTRANSFER pTransfer)
2251{
2252 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2253
2254 LogFlowFuncEnter();
2255
2256 int rc = shClTransferThreadDestroy(pTransfer, SHCL_TIMEOUT_DEFAULT_MS);
2257
2258 LogFlowFuncLeaveRC(rc);
2259 return rc;
2260}
2261
2262/**
2263 * Completes a transfer (as successful).
2264 *
2265 * @returns VBox status code.
2266 * @param pTransfer Clipboard transfer to complete.
2267 */
2268int ShClTransferComplete(PSHCLTRANSFER pTransfer)
2269{
2270 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2271
2272 LogFlowFuncEnter();
2273
2274 shClTransferLock(pTransfer);
2275
2276 AssertMsgReturnStmt( pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_INITIALIZED
2277 || pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_STARTED,
2278 ("Wrong status (currently is %s)\n", ShClTransferStatusToStr(pTransfer->State.enmStatus)),
2279 shClTransferUnlock(pTransfer), VERR_WRONG_ORDER);
2280
2281 int rc = shClTransferSetStatus(pTransfer, SHCLTRANSFERSTATUS_COMPLETED);
2282
2283 shClTransferUnlock(pTransfer);
2284
2285 if (pTransfer->Callbacks.pfnOnCompleted)
2286 pTransfer->Callbacks.pfnOnCompleted(&pTransfer->CallbackCtx, rc);
2287
2288 LogFlowFuncLeaveRC(rc);
2289 return rc;
2290}
2291
2292/**
2293 * Cancels or sets an error for a transfer.
2294 *
2295 * @returns VBox status code.
2296 * @param pTransfer Clipboard transfer to cancel or set error for.
2297 * @param rc Error code to set.
2298 * If set to VERR_CANCELLED, the transfer will be canceled.
2299 */
2300static int shClTransferCancelOrError(PSHCLTRANSFER pTransfer, int rc)
2301{
2302 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2303
2304 LogFlowFunc(("%Rrc\n", rc));
2305
2306 shClTransferLock(pTransfer);
2307
2308 int rc2;
2309
2310 if ( pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_INITIALIZED
2311 || pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_STARTED)
2312 {
2313 if (rc == VERR_CANCELLED)
2314 {
2315 rc2 = shClTransferSetStatus(pTransfer, SHCLTRANSFERSTATUS_CANCELED);
2316
2317 if (pTransfer->Callbacks.pfnOnCompleted)
2318 pTransfer->Callbacks.pfnOnCompleted(&pTransfer->CallbackCtx, VERR_CANCELLED);
2319 }
2320 else
2321 {
2322 rc2 = shClTransferSetStatus(pTransfer, SHCLTRANSFERSTATUS_ERROR);
2323
2324 if (pTransfer->Callbacks.pfnOnError)
2325 pTransfer->Callbacks.pfnOnError(&pTransfer->CallbackCtx, rc);
2326 }
2327 }
2328 else /* Nothing to do. */
2329 rc2 = VINF_SUCCESS;
2330
2331 shClTransferUnlock(pTransfer);
2332
2333 LogFlowFuncLeaveRC(rc2);
2334 return rc2;
2335}
2336
2337/**
2338 * Cancels a transfer.
2339 *
2340 * @returns VBox status code.
2341 * @param pTransfer Clipboard transfer to cancel.
2342 */
2343int ShClTransferCancel(PSHCLTRANSFER pTransfer)
2344{
2345 return shClTransferCancelOrError(pTransfer, VERR_CANCELLED);
2346}
2347
2348/**
2349 * Kills a transfer.
2350 *
2351 * Currently cancels it internally.
2352 *
2353 * @returns VBox status code.
2354 * @param pTransfer Clipboard transfer to kill.
2355 */
2356int ShClTransferKill(PSHCLTRANSFER pTransfer)
2357{
2358 return ShClTransferCancel(pTransfer);
2359}
2360
2361/**
2362 * Sets an error for a transfer.
2363 *
2364 * @returns VBox status code.
2365 * @param pTransfer Clipboard transfer to set error for.
2366 * @param rc Error code to set.
2367 */
2368int ShClTransferError(PSHCLTRANSFER pTransfer, int rc)
2369{
2370 return shClTransferCancelOrError(pTransfer, rc);
2371}
2372
2373/**
2374 * Internal struct for keeping a transfer thread context.
2375 */
2376typedef struct _SHCLTRANSFERTHREADCTX
2377{
2378 /** Pointer to transfer. */
2379 PSHCLTRANSFER pTransfer;
2380 /** User-supplied context data. Can be NULL if not being used. */
2381 void *pvUser;
2382 /** Pointer to thread function to use. */
2383 PFNSHCLTRANSFERTHREAD pfnThread;
2384} SHCLTRANSFERTHREADCTX;
2385/** Pointer to internal struct for keeping a transfer thread context. */
2386typedef SHCLTRANSFERTHREADCTX *PSHCLTRANSFERTHREADCTX;
2387
2388/**
2389 * Worker thread for a transfer.
2390 *
2391 * @returns VBox status code.
2392 * @param ThreadSelf Thread self handle. Not being used.
2393 * @param pvUser Context data of type PSHCLTRANSFERTHREADCTX.
2394 */
2395static DECLCALLBACK(int) shClTransferThreadWorker(RTTHREAD ThreadSelf, void *pvUser)
2396{
2397 RT_NOREF(ThreadSelf);
2398
2399 LogFlowFuncEnter();
2400
2401 SHCLTRANSFERTHREADCTX Ctx;
2402 memcpy(&Ctx, pvUser, sizeof(SHCLTRANSFERTHREADCTX));
2403
2404 LogFlowFunc(("pfnThread=%p, pTransfer=%p, pvUser=%p\n", Ctx.pfnThread, Ctx.pTransfer, Ctx.pvUser));
2405
2406 PSHCLTRANSFER pTransfer = Ctx.pTransfer;
2407
2408 shClTransferLock(pTransfer);
2409
2410 pTransfer->Thread.fStarted = true;
2411 pTransfer->Thread.fStop = false;
2412
2413 shClTransferUnlock(pTransfer);
2414
2415 RTThreadUserSignal(RTThreadSelf());
2416
2417 int rc = Ctx.pfnThread(pTransfer, Ctx.pvUser);
2418
2419 if (pTransfer->Callbacks.pfnOnCompleted)
2420 pTransfer->Callbacks.pfnOnCompleted(&pTransfer->CallbackCtx, rc);
2421
2422 LogFlowFuncLeaveRC(rc);
2423 return rc;
2424}
2425
2426/**
2427 * Creates a thread for a clipboard transfer.
2428 *
2429 * @returns VBox status code.
2430 * @param pTransfer Clipboard transfer to create thread for.
2431 * @param pfnThreadFunc Thread function to use for this transfer.
2432 * @param pvUser Pointer to user-provided data.
2433 */
2434static int shClTransferThreadCreate(PSHCLTRANSFER pTransfer, PFNSHCLTRANSFERTHREAD pfnThreadFunc, void *pvUser)
2435
2436{
2437 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2438
2439 shClTransferLock(pTransfer);
2440
2441 /* Already marked for stopping? */
2442 AssertMsgReturn(pTransfer->Thread.fStop == false,
2443 ("Transfer thread already marked for stopping"), VERR_WRONG_ORDER);
2444 /* Already started? */
2445 AssertMsgReturn(pTransfer->Thread.fStarted == false,
2446 ("Transfer thread already started"), VERR_WRONG_ORDER);
2447
2448 SHCLTRANSFERTHREADCTX Ctx = { pTransfer, pvUser, pfnThreadFunc };
2449
2450 /* Spawn a worker thread, so that we don't block the window thread for too long. */
2451 int rc = RTThreadCreate(&pTransfer->Thread.hThread, shClTransferThreadWorker,
2452 &Ctx, 0, RTTHREADTYPE_DEFAULT, RTTHREADFLAGS_WAITABLE,
2453 "shcltx");
2454 if (RT_SUCCESS(rc))
2455 {
2456 shClTransferUnlock(pTransfer); /* Leave lock while waiting. */
2457
2458 int rc2 = RTThreadUserWait(pTransfer->Thread.hThread, SHCL_TIMEOUT_DEFAULT_MS);
2459 AssertRC(rc2);
2460
2461 shClTransferLock(pTransfer);
2462
2463 if (pTransfer->Thread.fStarted) /* Did the thread indicate that it started correctly? */
2464 {
2465 /* Nothing to do in here. */
2466 }
2467 else
2468 rc = VERR_GENERAL_FAILURE; /** @todo Find a better rc. */
2469 }
2470
2471 shClTransferUnlock(pTransfer);
2472
2473 LogFlowFuncLeaveRC(rc);
2474 return rc;
2475}
2476
2477/**
2478 * Destroys the thread of a clipboard transfer.
2479 *
2480 * @returns VBox status code. Will return thread rc.
2481 * @param pTransfer Clipboard transfer to destroy thread for.
2482 * @param uTimeoutMs Timeout (in ms) to wait for thread destruction.
2483 */
2484static int shClTransferThreadDestroy(PSHCLTRANSFER pTransfer, RTMSINTERVAL uTimeoutMs)
2485{
2486 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2487
2488 shClTransferLock(pTransfer);
2489
2490 if (!pTransfer->Thread.fStarted)
2491 {
2492 shClTransferUnlock(pTransfer);
2493 return VINF_SUCCESS;
2494 }
2495
2496 LogFlowFuncEnter();
2497
2498 /* Set stop indicator. */
2499 pTransfer->Thread.fStop = true;
2500
2501 shClTransferUnlock(pTransfer); /* Leave lock while waiting. */
2502
2503 int rcThread = VERR_IPE_UNINITIALIZED_STATUS;
2504 Assert(pTransfer->Thread.hThread != NIL_RTTHREAD);
2505 int rc = RTThreadWait(pTransfer->Thread.hThread, uTimeoutMs, &rcThread);
2506
2507 LogFlowFunc(("Waiting for thread resulted in %Rrc (thread exited with %Rrc)\n", rc, rcThread));
2508
2509 if (RT_SUCCESS(rc))
2510 {
2511 pTransfer->Thread.fStarted = false;
2512 pTransfer->Thread.hThread = NIL_RTTHREAD;
2513
2514 rc = rcThread; /* Return the thread rc to the caller. */
2515 }
2516 else
2517 LogRel(("Shared Clipboard: Waiting for thread of transfer %RU16 failed with %Rrc\n", pTransfer->State.uID, rc));
2518
2519 LogFlowFuncLeaveRC(rc);
2520 return rc;
2521}
2522
2523/**
2524 * Waits for the transfer status to change, internal version.
2525 *
2526 * @returns VBox status code.
2527 * @param pTransfer Clipboard transfer to wait for.
2528 * @param msTimeout Timeout (in ms) to wait.
2529 * @param penmStatus Where to return the new (current) transfer status on success.
2530 * Optional and can be NULL.
2531 */
2532static int shClTransferWaitForStatusChangeInternal(PSHCLTRANSFER pTransfer, RTMSINTERVAL msTimeout, SHCLTRANSFERSTATUS *penmStatus)
2533{
2534 LogFlowFunc(("Waiting for status change (%RU32 timeout) ...\n", msTimeout));
2535
2536 int rc = RTSemEventWait(pTransfer->StatusChangeEvent, msTimeout);
2537 if (RT_SUCCESS(rc))
2538 {
2539 if (penmStatus)
2540 {
2541 shClTransferLock(pTransfer);
2542
2543 *penmStatus = pTransfer->State.enmStatus;
2544
2545 shClTransferUnlock(pTransfer);
2546 }
2547 }
2548
2549 return rc;
2550}
2551
2552/**
2553 * Waits for the transfer status to change.
2554 *
2555 * @returns VBox status code.
2556 * @param pTransfer Clipboard transfer to wait for.
2557 * @param msTimeout Timeout (in ms) to wait.
2558 * @param penmStatus Where to return the new (current) transfer status on success.
2559 * Optional and can be NULL.
2560 */
2561int ShClTransferWaitForStatusChange(PSHCLTRANSFER pTransfer, RTMSINTERVAL msTimeout, SHCLTRANSFERSTATUS *penmStatus)
2562{
2563 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2564
2565 int rc = shClTransferWaitForStatusChangeInternal(pTransfer, msTimeout, penmStatus);
2566
2567 LogFlowFuncLeaveRC(rc);
2568 return rc;
2569}
2570
2571/**
2572 * Waits for a specific transfer status.
2573 *
2574 * @returns VBox status code.
2575 * @param pTransfer Clipboard transfer to wait for.
2576 * @param msTimeout Timeout (in ms) to wait.
2577 * @param enmStatus Transfer status to wait for.
2578 */
2579int ShClTransferWaitForStatus(PSHCLTRANSFER pTransfer, RTMSINTERVAL msTimeout, SHCLTRANSFERSTATUS enmStatus)
2580{
2581 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2582
2583 int rc = VINF_SUCCESS;
2584
2585 uint64_t const tsStartMs = RTTimeMilliTS();
2586 uint64_t msLeft = msTimeout;
2587 for (;;)
2588 {
2589 SHCLTRANSFERSTATUS enmCurStatus;
2590 rc = shClTransferWaitForStatusChangeInternal(pTransfer, msLeft, &enmCurStatus);
2591 if (RT_FAILURE(rc))
2592 break;
2593
2594 if (enmCurStatus == enmStatus)
2595 break;
2596
2597 msLeft -= RT_MIN(msLeft, RTTimeMilliTS() - tsStartMs);
2598 if (msLeft == 0)
2599 {
2600 rc = VERR_TIMEOUT;
2601 break;
2602 }
2603 }
2604
2605 LogFlowFuncLeaveRC(rc);
2606 return rc;
2607}
2608
2609
2610/*********************************************************************************************************************************
2611 * Transfer Context *
2612 ********************************************************************************************************************************/
2613
2614/**
2615 * Locks a transfer context.
2616 *
2617 * @param pTransferCtx Transfer context to lock.
2618 */
2619DECLINLINE(void) shClTransferCtxLock(PSHCLTRANSFERCTX pTransferCtx)
2620{
2621 int rc2 = RTCritSectEnter(&pTransferCtx->CritSect);
2622 AssertRC(rc2);
2623}
2624
2625/**
2626 * Unlocks a transfer context.
2627 *
2628 * @param pTransferCtx Transfer context to unlock.
2629 */
2630DECLINLINE(void) shClTransferCtxUnlock(PSHCLTRANSFERCTX pTransferCtx)
2631{
2632 int rc2 = RTCritSectLeave(&pTransferCtx->CritSect);
2633 AssertRC(rc2);
2634}
2635
2636/**
2637 * Initializes a clipboard transfer context.
2638 *
2639 * @returns VBox status code.
2640 * @param pTransferCtx Transfer context to initialize.
2641 */
2642int ShClTransferCtxInit(PSHCLTRANSFERCTX pTransferCtx)
2643{
2644 AssertPtrReturn(pTransferCtx, VERR_INVALID_POINTER);
2645
2646 LogFlowFunc(("pTransferCtx=%p\n", pTransferCtx));
2647
2648 int rc = RTCritSectInit(&pTransferCtx->CritSect);
2649 if (RT_SUCCESS(rc))
2650 {
2651 rc = RTSemEventCreate(&pTransferCtx->ChangedEvent);
2652 if (RT_SUCCESS(rc))
2653 {
2654 RT_ZERO(pTransferCtx->ChangedEventData);
2655
2656 RTListInit(&pTransferCtx->List);
2657
2658 pTransferCtx->cTransfers = 0;
2659 pTransferCtx->cRunning = 0;
2660 pTransferCtx->cMaxRunning = 64; /** @todo Make this configurable? */
2661
2662 RT_ZERO(pTransferCtx->bmTransferIds);
2663
2664 ShClTransferCtxReset(pTransferCtx);
2665 }
2666 }
2667
2668 return VINF_SUCCESS;
2669}
2670
2671/**
2672 * Destroys a clipboard transfer context.
2673 *
2674 * @param pTransferCtx Transfer context to destroy.
2675 */
2676void ShClTransferCtxDestroy(PSHCLTRANSFERCTX pTransferCtx)
2677{
2678 if (!pTransferCtx)
2679 return;
2680
2681 LogFlowFunc(("pTransferCtx=%p\n", pTransferCtx));
2682
2683 shClTransferCtxLock(pTransferCtx);
2684
2685 PSHCLTRANSFER pTransfer, pTransferNext;
2686 RTListForEachSafe(&pTransferCtx->List, pTransfer, pTransferNext, SHCLTRANSFER, Node)
2687 {
2688 shclTransferCtxTransferRemoveAndUnregister(pTransferCtx, pTransfer);
2689 ShClTransferDestroy(pTransfer);
2690 }
2691
2692 pTransferCtx->cRunning = 0;
2693 pTransferCtx->cTransfers = 0;
2694
2695 shClTransferCtxUnlock(pTransferCtx);
2696
2697 RTSemEventDestroy(pTransferCtx->ChangedEvent);
2698 pTransferCtx->ChangedEvent = NIL_RTSEMEVENT;
2699
2700 if (RTCritSectIsInitialized(&pTransferCtx->CritSect))
2701 RTCritSectDelete(&pTransferCtx->CritSect);
2702}
2703
2704/**
2705 * Resets a clipboard transfer context.
2706 *
2707 * @param pTransferCtx Transfer context to reset.
2708 */
2709void ShClTransferCtxReset(PSHCLTRANSFERCTX pTransferCtx)
2710{
2711 AssertPtrReturnVoid(pTransferCtx);
2712
2713 shClTransferCtxLock(pTransferCtx);
2714
2715 LogFlowFuncEnter();
2716
2717 PSHCLTRANSFER pTransfer;
2718 RTListForEach(&pTransferCtx->List, pTransfer, SHCLTRANSFER, Node)
2719 ShClTransferReset(pTransfer);
2720
2721#ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS_HTTP
2722 /** @todo Anything to do here? */
2723#endif
2724
2725 shClTransferCtxUnlock(pTransferCtx);
2726}
2727
2728/**
2729 * Signals a change event.
2730 *
2731 * @returns VBox status code.
2732 * @param pTransferCtx Transfer context to return transfer for.
2733 * @param fRegistered Whether a transfer got registered or unregistered.
2734 * @param pTransfer Transfer bound to the event.
2735 */
2736static int shClTransferCtxSignal(PSHCLTRANSFERCTX pTransferCtx, bool fRegistered, PSHCLTRANSFER pTransfer)
2737{
2738 Assert(RTCritSectIsOwner(&pTransferCtx->CritSect));
2739
2740 LogFlowFunc(("fRegistered=%RTbool, pTransfer=%p\n", fRegistered, pTransfer));
2741
2742 pTransferCtx->ChangedEventData.fRegistered = fRegistered;
2743 pTransferCtx->ChangedEventData.pTransfer = pTransfer;
2744
2745 return RTSemEventSignal(pTransferCtx->ChangedEvent);
2746}
2747
2748/**
2749 * Returns a specific clipboard transfer, internal version.
2750 *
2751 * @returns Clipboard transfer found, or NULL if not found.
2752 * @param pTransferCtx Transfer context to return transfer for.
2753 * @param idTransfer ID of the transfer to return.
2754 *
2755 * @note Caller needs to take critical section.
2756 */
2757static PSHCLTRANSFER shClTransferCtxGetTransferByIdInternal(PSHCLTRANSFERCTX pTransferCtx, SHCLTRANSFERID idTransfer)
2758{
2759 Assert(RTCritSectIsOwner(&pTransferCtx->CritSect));
2760
2761 PSHCLTRANSFER pTransfer;
2762 RTListForEach(&pTransferCtx->List, pTransfer, SHCLTRANSFER, Node) /** @todo Slow, but works for now. */
2763 {
2764 if (pTransfer->State.uID == idTransfer)
2765 return pTransfer;
2766 }
2767
2768 return NULL;
2769}
2770
2771/**
2772 * Returns a specific clipboard transfer by index, internal version.
2773 *
2774 * @returns Clipboard transfer found, or NULL if not found.
2775 * @param pTransferCtx Transfer context to return transfer for.
2776 * @param uIdx Index of the transfer to return.
2777 *
2778 * @note Caller needs to take critical section.
2779 */
2780static PSHCLTRANSFER shClTransferCtxGetTransferByIndexInternal(PSHCLTRANSFERCTX pTransferCtx, uint32_t uIdx)
2781{
2782 Assert(RTCritSectIsOwner(&pTransferCtx->CritSect));
2783
2784 uint32_t idx = 0;
2785
2786 PSHCLTRANSFER pTransfer;
2787 RTListForEach(&pTransferCtx->List, pTransfer, SHCLTRANSFER, Node) /** @todo Slow, but works for now. */
2788 {
2789 if (uIdx == idx)
2790 return pTransfer;
2791 idx++;
2792 }
2793
2794 return NULL;
2795}
2796
2797/**
2798 * Returns a clipboard transfer for a specific transfer ID.
2799 *
2800 * @returns Clipboard transfer found, or NULL if not found.
2801 * @param pTransferCtx Transfer context to return transfer for.
2802 * @param uID ID of the transfer to return.
2803 */
2804PSHCLTRANSFER ShClTransferCtxGetTransferById(PSHCLTRANSFERCTX pTransferCtx, uint32_t uID)
2805{
2806 shClTransferCtxLock(pTransferCtx);
2807
2808 PSHCLTRANSFER const pTransfer = shClTransferCtxGetTransferByIdInternal(pTransferCtx, uID);
2809
2810 shClTransferCtxUnlock(pTransferCtx);
2811
2812 return pTransfer;
2813}
2814
2815/**
2816 * Returns a clipboard transfer for a specific list index.
2817 *
2818 * @returns Clipboard transfer found, or NULL if not found.
2819 * @param pTransferCtx Transfer context to return transfer for.
2820 * @param uIdx List index of the transfer to return.
2821 */
2822PSHCLTRANSFER ShClTransferCtxGetTransferByIndex(PSHCLTRANSFERCTX pTransferCtx, uint32_t uIdx)
2823{
2824 shClTransferCtxLock(pTransferCtx);
2825
2826 PSHCLTRANSFER const pTransfer = shClTransferCtxGetTransferByIndexInternal(pTransferCtx, uIdx);
2827
2828 shClTransferCtxUnlock(pTransferCtx);
2829
2830 return pTransfer;
2831}
2832
2833
2834/**
2835 * Returns the last clipboard transfer registered.
2836 *
2837 * @returns Clipboard transfer found, or NULL if not found.
2838 * @param pTransferCtx Transfer context to return transfer for.
2839 */
2840PSHCLTRANSFER ShClTransferCtxGetTransferLast(PSHCLTRANSFERCTX pTransferCtx)
2841{
2842 shClTransferCtxLock(pTransferCtx);
2843
2844 PSHCLTRANSFER const pTransfer = RTListGetLast(&pTransferCtx->List, SHCLTRANSFER, Node);
2845
2846 shClTransferCtxUnlock(pTransferCtx);
2847
2848 return pTransfer;
2849}
2850
2851/**
2852 * Returns the number of running clipboard transfers for a given transfer context.
2853 *
2854 * @returns Number of running transfers.
2855 * @param pTransferCtx Transfer context to return number for.
2856 */
2857uint32_t ShClTransferCtxGetRunningTransfers(PSHCLTRANSFERCTX pTransferCtx)
2858{
2859 AssertPtrReturn(pTransferCtx, 0);
2860
2861 shClTransferCtxLock(pTransferCtx);
2862
2863 uint32_t const cRunning = pTransferCtx->cRunning;
2864
2865 shClTransferCtxUnlock(pTransferCtx);
2866
2867 return cRunning;
2868}
2869
2870/**
2871 * Returns the number of total clipboard transfers for a given transfer context.
2872 *
2873 * @returns Number of total transfers.
2874 * @param pTransferCtx Transfer context to return number for.
2875 */
2876uint32_t ShClTransferCtxGetTotalTransfers(PSHCLTRANSFERCTX pTransferCtx)
2877{
2878 AssertPtrReturn(pTransferCtx, 0);
2879
2880 shClTransferCtxLock(pTransferCtx);
2881
2882 uint32_t const cTransfers = pTransferCtx->cTransfers;
2883
2884 shClTransferCtxUnlock(pTransferCtx);
2885
2886 return cTransfers;
2887}
2888
2889static int shClTransferCreateIDInternal(PSHCLTRANSFERCTX pTransferCtx, SHCLTRANSFERID *pidTransfer)
2890{
2891 /*
2892 * Pick a random bit as starting point. If it's in use, search forward
2893 * for a free one, wrapping around. We've reserved both the zero'th and
2894 * max-1 IDs.
2895 */
2896 SHCLTRANSFERID idTransfer = RTRandU32Ex(1, VBOX_SHCL_MAX_TRANSFERS - 2);
2897
2898 if (!ASMBitTestAndSet(&pTransferCtx->bmTransferIds[0], idTransfer))
2899 { /* likely */ }
2900 else if (pTransferCtx->cTransfers < VBOX_SHCL_MAX_TRANSFERS - 2 /* First and last are not used */)
2901 {
2902 /* Forward search. */
2903 int iHit = ASMBitNextClear(&pTransferCtx->bmTransferIds[0], VBOX_SHCL_MAX_TRANSFERS, idTransfer);
2904 if (iHit < 0)
2905 iHit = ASMBitFirstClear(&pTransferCtx->bmTransferIds[0], VBOX_SHCL_MAX_TRANSFERS);
2906 AssertLogRelMsgReturn(iHit >= 0, ("Transfer count: %RU16\n", pTransferCtx->cTransfers), VERR_SHCLPB_MAX_TRANSFERS_REACHED);
2907 idTransfer = iHit;
2908 AssertLogRelMsgReturn(!ASMBitTestAndSet(&pTransferCtx->bmTransferIds[0], idTransfer), ("idObject=%#x\n", idTransfer), VERR_INTERNAL_ERROR_2);
2909 }
2910 else
2911 {
2912 LogFunc(("Maximum number of transfers reached (%RU16 transfers)\n", pTransferCtx->cTransfers));
2913 return VERR_SHCLPB_MAX_TRANSFERS_REACHED;
2914 }
2915
2916 *pidTransfer = idTransfer;
2917
2918 return VINF_SUCCESS;
2919}
2920
2921/**
2922 * Creates a new transfer ID for a given transfer context.
2923 *
2924 * @returns VBox status code.
2925 * @retval VERR_SHCLPB_MAX_TRANSFERS_REACHED if the maximum of concurrent transfers is reached.
2926 * @param pTransferCtx Transfer context to create transfer ID for.
2927 * @param pidTransfer Where to return the transfer ID on success.
2928 */
2929int ShClTransferCtxCreateId(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFERID pidTransfer)
2930{
2931 AssertPtrReturn(pTransferCtx, VERR_INVALID_POINTER);
2932 AssertPtrReturn(pidTransfer, VERR_INVALID_POINTER);
2933
2934 shClTransferCtxLock(pTransferCtx);
2935
2936 int rc = shClTransferCreateIDInternal(pTransferCtx, pidTransfer);
2937
2938 shClTransferCtxUnlock(pTransferCtx);
2939
2940 return rc;
2941}
2942
2943/**
2944 * Registers a clipboard transfer with a new transfer ID.
2945 *
2946 * @return VBox status code.
2947 * @retval VERR_SHCLPB_MAX_TRANSFERS_REACHED if the maximum of concurrent transfers is reached.
2948 * @param pTransferCtx Transfer context to register transfer to.
2949 * @param pTransfer Transfer to register. The context takes ownership of the transfer on success.
2950 * @param idTransfer Transfer ID to use for registering the given transfer.
2951 */
2952static int shClTransferCtxTransferRegisterExInternal(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFER pTransfer, SHCLTRANSFERID idTransfer)
2953{
2954 AssertPtrReturn(pTransferCtx, VERR_INVALID_POINTER);
2955 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2956 Assert(idTransfer != NIL_SHCLTRANSFERID);
2957
2958 shClTransferCtxLock(pTransferCtx);
2959
2960 pTransfer->State.uID = idTransfer;
2961
2962 RTListAppend(&pTransferCtx->List, &pTransfer->Node);
2963
2964 pTransferCtx->cTransfers++;
2965
2966 Log2Func(("pTransfer=%p, idTransfer=%RU32 -- now %RU16 transfer(s)\n", pTransfer, idTransfer, pTransferCtx->cTransfers));
2967
2968 shClTransferCtxUnlock(pTransferCtx);
2969
2970 if (pTransfer->Callbacks.pfnOnRegistered)
2971 pTransfer->Callbacks.pfnOnRegistered(&pTransfer->CallbackCtx, pTransferCtx);
2972
2973 LogFlowFuncLeaveRC(VINF_SUCCESS);
2974 return VINF_SUCCESS;
2975}
2976
2977/**
2978 * Registers a clipboard transfer with a transfer context, i.e. allocates a transfer ID.
2979 *
2980 * @return VBox status code.
2981 * @retval VERR_SHCLPB_MAX_TRANSFERS_REACHED if the maximum of concurrent transfers for this context has been reached.
2982 * @param pTransferCtx Transfer context to register transfer to.
2983 * @param pTransfer Transfer to register. The context takes ownership of the transfer on success.
2984 * @param pidTransfer Where to return the transfer ID on success. Optional.
2985 */
2986int ShClTransferCtxRegister(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFER pTransfer, PSHCLTRANSFERID pidTransfer)
2987{
2988 AssertPtrReturn(pTransferCtx, VERR_INVALID_POINTER);
2989 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2990
2991 shClTransferCtxLock(pTransferCtx);
2992
2993 SHCLTRANSFERID idTransfer;
2994 int rc = shClTransferCreateIDInternal(pTransferCtx, &idTransfer);
2995 if (RT_SUCCESS(rc))
2996 {
2997 rc = shClTransferCtxTransferRegisterExInternal(pTransferCtx, pTransfer, idTransfer);
2998 if (RT_SUCCESS(rc))
2999 {
3000 if (pidTransfer)
3001 *pidTransfer = idTransfer;
3002 }
3003 }
3004
3005 shClTransferCtxUnlock(pTransferCtx);
3006
3007 return rc;
3008}
3009
3010/**
3011 * Registers a clipboard transfer with a transfer context by specifying an ID for the transfer.
3012 *
3013 * @return VBox status code.
3014 * @retval VERR_ALREADY_EXISTS if a transfer with the given ID already exists.
3015 * @retval VERR_SHCLPB_MAX_TRANSFERS_REACHED if the maximum of concurrent transfers for this context has been reached.
3016 * @param pTransferCtx Transfer context to register transfer to.
3017 * @param pTransfer Transfer to register.
3018 * @param idTransfer Transfer ID to use for registration.
3019 *
3020 * @note This function ASSUMES you have created \a idTransfer with ShClTransferCtxCreateId().
3021 */
3022int ShClTransferCtxRegisterById(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFER pTransfer, SHCLTRANSFERID idTransfer)
3023{
3024 shClTransferCtxLock(pTransferCtx);
3025
3026 if (pTransferCtx->cTransfers < VBOX_SHCL_MAX_TRANSFERS - 2 /* First and last are not used */)
3027 {
3028 RTListAppend(&pTransferCtx->List, &pTransfer->Node);
3029
3030 shClTransferLock(pTransfer);
3031
3032 pTransfer->State.uID = idTransfer;
3033
3034 shClTransferUnlock(pTransfer);
3035
3036 int rc = shClTransferCtxSignal(pTransferCtx, true /* fRegistered */, pTransfer);
3037
3038 pTransferCtx->cTransfers++;
3039
3040 LogFunc(("Registered transfer ID %RU16 -- now %RU16 transfers total\n", idTransfer, pTransferCtx->cTransfers));
3041
3042 shClTransferCtxUnlock(pTransferCtx);
3043
3044 if (pTransfer->Callbacks.pfnOnRegistered)
3045 pTransfer->Callbacks.pfnOnRegistered(&pTransfer->CallbackCtx, pTransferCtx);
3046
3047 return rc;
3048 }
3049
3050 LogFunc(("Maximum number of transfers reached (%RU16 transfers)\n", pTransferCtx->cTransfers));
3051
3052 shClTransferCtxUnlock(pTransferCtx);
3053
3054 return VERR_SHCLPB_MAX_TRANSFERS_REACHED;
3055}
3056
3057/**
3058 * Removes and unregisters a transfer from a transfer context.
3059 *
3060 * @param pTransferCtx Transfer context to remove transfer from.
3061 * @param pTransfer Transfer to remove.
3062 *
3063 * @note Caller needs to take critical section.
3064 */
3065static void shclTransferCtxTransferRemoveAndUnregister(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFER pTransfer)
3066{
3067 Assert(RTCritSectIsOwner(&pTransferCtx->CritSect));
3068
3069 RTListNodeRemove(&pTransfer->Node);
3070
3071 Assert(pTransferCtx->cTransfers);
3072 pTransferCtx->cTransfers--;
3073
3074 Assert(pTransferCtx->cTransfers >= pTransferCtx->cRunning);
3075
3076 shClTransferCtxUnlock(pTransferCtx);
3077
3078 if (pTransfer->Callbacks.pfnOnUnregistered)
3079 pTransfer->Callbacks.pfnOnUnregistered(&pTransfer->CallbackCtx, pTransferCtx);
3080
3081 shClTransferCtxLock(pTransferCtx);
3082
3083 LogFlowFunc(("Now %RU32 transfers left\n", pTransferCtx->cTransfers));
3084}
3085
3086/**
3087 * Unregisters a transfer from an transfer context, given by its ID.
3088 *
3089 * @retval VINF_SUCCESS on success.
3090 * @retval VERR_NOT_FOUND if the transfer ID was not found.
3091 * @param pTransferCtx Transfer context to unregister transfer from.
3092 * @param idTransfer Transfer ID to unregister.
3093 */
3094int ShClTransferCtxUnregisterById(PSHCLTRANSFERCTX pTransferCtx, SHCLTRANSFERID idTransfer)
3095{
3096 AssertPtrReturn(pTransferCtx, VERR_INVALID_POINTER);
3097 AssertReturn(idTransfer, VERR_INVALID_PARAMETER);
3098
3099 shClTransferCtxLock(pTransferCtx);
3100
3101 int rc = VINF_SUCCESS;
3102
3103 LogFlowFunc(("idTransfer=%RU32\n", idTransfer));
3104
3105 if (ASMBitTestAndClear(&pTransferCtx->bmTransferIds, idTransfer), ("idTransfer=%#x\n", idTransfer))
3106 {
3107 PSHCLTRANSFER pTransfer = shClTransferCtxGetTransferByIdInternal(pTransferCtx, idTransfer);
3108 if (pTransfer)
3109 {
3110 shclTransferCtxTransferRemoveAndUnregister(pTransferCtx, pTransfer);
3111
3112 rc = shClTransferCtxSignal(pTransferCtx, false /* fRegistered */, pTransfer);
3113 }
3114 }
3115 else
3116 rc = VERR_NOT_FOUND;
3117
3118 shClTransferCtxUnlock(pTransferCtx);
3119
3120 LogFlowFuncLeaveRC(rc);
3121 return rc;
3122}
3123
3124/**
3125 * Waits for a transfer context event.
3126 *
3127 * @returns VBox status code.
3128 * @param pTransferCtx Transfer context to wait for.
3129 * @param msTimeout Timeout (in ms) to wait.
3130 * @param pEvent Where to return the event data on success.
3131 */
3132static int shClTransferCtxWaitInternal(PSHCLTRANSFERCTX pTransferCtx, RTMSINTERVAL msTimeout, PSHCLTRANSFERCTXEVENT pEvent)
3133{
3134 LogFlowFunc(("Waiting for transfer context change (%RU32 timeout) ...\n", msTimeout));
3135
3136 int rc = RTSemEventWait(pTransferCtx->ChangedEvent, msTimeout);
3137 if (RT_SUCCESS(rc))
3138 {
3139 shClTransferCtxLock(pTransferCtx);
3140
3141 memcpy(pEvent, &pTransferCtx->ChangedEventData, sizeof(SHCLTRANSFERCTXEVENT));
3142
3143 shClTransferCtxUnlock(pTransferCtx);
3144 }
3145
3146 LogFlowFuncLeaveRC(rc);
3147 return rc;
3148}
3149
3150/**
3151 * Waits for transfer to be (un-)registered.
3152 *
3153 * @returns VBox status code.
3154 * @param pTransferCtx Transfer context to wait for.
3155 * @param msTimeout Timeout (in ms) to wait.
3156 * @param fRegister Pass \c true for registering, or \c false for unregistering a transfer.
3157 * @param idTransfer Transfer ID to wait for.
3158 * Pass NIL_SHCLTRANSFERID for any transfer.
3159 * @param ppTransfer Where to return the transfer being (un-)registered. Optional and can be NULL.
3160 */
3161int ShClTransferCtxWait(PSHCLTRANSFERCTX pTransferCtx, RTMSINTERVAL msTimeout, bool fRegister, SHCLTRANSFERID idTransfer,
3162 PSHCLTRANSFER *ppTransfer)
3163{
3164 AssertPtrReturn(pTransferCtx, VERR_INVALID_POINTER);
3165
3166 int rc = VERR_TIMEOUT;
3167
3168 uint64_t const tsStartMs = RTTimeMilliTS();
3169 uint64_t msLeft = msTimeout;
3170 for (;;)
3171 {
3172 SHCLTRANSFERCTXEVENT Event;
3173 rc = shClTransferCtxWaitInternal(pTransferCtx, msLeft, &Event);
3174 if (RT_FAILURE(rc))
3175 break;
3176
3177 shClTransferCtxLock(pTransferCtx);
3178
3179 if (Event.fRegistered == fRegister)
3180 {
3181 if ( idTransfer != NIL_SHCLTRANSFERID
3182 && Event.pTransfer
3183 && ShClTransferGetID(Event.pTransfer) == idTransfer)
3184 {
3185 if (ppTransfer)
3186 *ppTransfer = Event.pTransfer;
3187 rc = VINF_SUCCESS;
3188 }
3189 }
3190
3191 shClTransferCtxUnlock(pTransferCtx);
3192
3193 if (RT_SUCCESS(rc))
3194 break;
3195
3196 msLeft -= RT_MIN(msLeft, RTTimeMilliTS() - tsStartMs);
3197 if (msLeft == 0)
3198 break;
3199 }
3200
3201 LogFlowFuncLeaveRC(rc);
3202 return rc;
3203}
3204
3205/**
3206 * Cleans up all associated transfers which are not needed (anymore).
3207 * This can be due to transfers which only have been announced but not / never being run.
3208 *
3209 * @param pTransferCtx Transfer context to cleanup transfers for.
3210 */
3211void ShClTransferCtxCleanup(PSHCLTRANSFERCTX pTransferCtx)
3212{
3213 AssertPtrReturnVoid(pTransferCtx);
3214
3215 shClTransferCtxLock(pTransferCtx);
3216
3217 LogFlowFunc(("pTransferCtx=%p, cTransfers=%RU16 cRunning=%RU16\n",
3218 pTransferCtx, pTransferCtx->cTransfers, pTransferCtx->cRunning));
3219
3220 if (pTransferCtx->cTransfers == 0)
3221 {
3222 shClTransferCtxUnlock(pTransferCtx);
3223 return;
3224 }
3225
3226 /* Remove all transfers which are not in a running state (e.g. only announced). */
3227 PSHCLTRANSFER pTransfer, pTransferNext;
3228 RTListForEachSafe(&pTransferCtx->List, pTransfer, pTransferNext, SHCLTRANSFER, Node)
3229 {
3230 shClTransferLock(pTransfer);
3231
3232 SHCLTRANSFERSTATUS const enmStatus = shClTransferGetStatusLocked(pTransfer);
3233 LogFlowFunc(("\tTransfer #%RU16: %s\n", pTransfer->State.uID, ShClTransferStatusToStr(enmStatus)));
3234
3235 if (enmStatus != SHCLTRANSFERSTATUS_STARTED)
3236 {
3237 shClTransferUnlock(pTransfer);
3238
3239 shclTransferCtxTransferRemoveAndUnregister(pTransferCtx, pTransfer);
3240 ShClTransferDestroy(pTransfer);
3241 }
3242 else
3243 shClTransferUnlock(pTransfer);
3244 }
3245
3246 shClTransferCtxUnlock(pTransferCtx);
3247}
3248
3249/**
3250 * Returns whether the maximum of concurrent transfers of a specific transfer contexthas been reached or not.
3251 *
3252 * @returns \c if maximum has been reached, \c false if not.
3253 * @param pTransferCtx Transfer context to determine value for.
3254 */
3255bool ShClTransferCtxIsMaximumReached(PSHCLTRANSFERCTX pTransferCtx)
3256{
3257 AssertPtrReturn(pTransferCtx, true);
3258
3259 shClTransferCtxLock(pTransferCtx);
3260
3261 LogFlowFunc(("cRunning=%RU32, cMaxRunning=%RU32\n", pTransferCtx->cRunning, pTransferCtx->cMaxRunning));
3262
3263 Assert(pTransferCtx->cRunning <= pTransferCtx->cMaxRunning);
3264 bool const fMaximumReached = pTransferCtx->cRunning == pTransferCtx->cMaxRunning;
3265
3266 shClTransferCtxUnlock(pTransferCtx);
3267
3268 return fMaximumReached;
3269}
3270
3271/**
3272 * Copies file system objinfo from IPRT to Shared Clipboard format.
3273 *
3274 * @return VBox status code.
3275 * @param pDst The Shared Clipboard structure to convert data to.
3276 * @param pSrc The IPRT structure to convert data from.
3277 */
3278int ShClFsObjInfoFromIPRT(PSHCLFSOBJINFO pDst, PCRTFSOBJINFO pSrc)
3279{
3280 AssertPtrReturn(pDst, VERR_INVALID_POINTER);
3281 AssertPtrReturn(pSrc, VERR_INVALID_POINTER);
3282
3283 pDst->cbObject = pSrc->cbObject;
3284 pDst->cbAllocated = pSrc->cbAllocated;
3285 pDst->AccessTime = pSrc->AccessTime;
3286 pDst->ModificationTime = pSrc->ModificationTime;
3287 pDst->ChangeTime = pSrc->ChangeTime;
3288 pDst->BirthTime = pSrc->BirthTime;
3289 pDst->Attr.fMode = pSrc->Attr.fMode;
3290 /* Clear bits which we don't pass through for security reasons. */
3291 pDst->Attr.fMode &= ~(RTFS_UNIX_ISUID | RTFS_UNIX_ISGID | RTFS_UNIX_ISTXT);
3292 RT_ZERO(pDst->Attr.u);
3293 switch (pSrc->Attr.enmAdditional)
3294 {
3295 default:
3296 RT_FALL_THROUGH();
3297 case RTFSOBJATTRADD_NOTHING:
3298 pDst->Attr.enmAdditional = SHCLFSOBJATTRADD_NOTHING;
3299 break;
3300
3301 case RTFSOBJATTRADD_UNIX:
3302 pDst->Attr.enmAdditional = SHCLFSOBJATTRADD_UNIX;
3303 pDst->Attr.u.Unix.uid = pSrc->Attr.u.Unix.uid;
3304 pDst->Attr.u.Unix.gid = pSrc->Attr.u.Unix.gid;
3305 pDst->Attr.u.Unix.cHardlinks = pSrc->Attr.u.Unix.cHardlinks;
3306 pDst->Attr.u.Unix.INodeIdDevice = pSrc->Attr.u.Unix.INodeIdDevice;
3307 pDst->Attr.u.Unix.INodeId = pSrc->Attr.u.Unix.INodeId;
3308 pDst->Attr.u.Unix.fFlags = pSrc->Attr.u.Unix.fFlags;
3309 pDst->Attr.u.Unix.GenerationId = pSrc->Attr.u.Unix.GenerationId;
3310 pDst->Attr.u.Unix.Device = pSrc->Attr.u.Unix.Device;
3311 break;
3312
3313 case RTFSOBJATTRADD_EASIZE:
3314 pDst->Attr.enmAdditional = SHCLFSOBJATTRADD_EASIZE;
3315 pDst->Attr.u.EASize.cb = pSrc->Attr.u.EASize.cb;
3316 break;
3317 }
3318
3319 return VINF_SUCCESS;
3320}
3321
3322/**
3323 * Queries local file system information from a given path.
3324 *
3325 * @returns VBox status code.
3326 * @param pszPath Path to query file system information for.
3327 * @param pObjInfo Where to return the queried file system information on success.
3328 */
3329int ShClFsObjInfoQueryLocal(const char *pszPath, PSHCLFSOBJINFO pObjInfo)
3330{
3331 RTFSOBJINFO objInfo;
3332 int rc = RTPathQueryInfo(pszPath, &objInfo,
3333#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
3334 RTFSOBJATTRADD_NOTHING
3335#else
3336 RTFSOBJATTRADD_UNIX
3337#endif
3338 );
3339 if (RT_SUCCESS(rc))
3340 rc = ShClFsObjInfoFromIPRT(pObjInfo, &objInfo);
3341
3342 return rc;
3343}
3344
3345/**
3346 * Translates a clipboard transfer status (SHCLTRANSFERSTATUS_XXX) into a string.
3347 *
3348 * @returns Transfer status string name.
3349 * @param enmStatus The transfer status to translate.
3350 */
3351const char *ShClTransferStatusToStr(SHCLTRANSFERSTATUS enmStatus)
3352{
3353 switch (enmStatus)
3354 {
3355 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_NONE);
3356 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_REQUESTED);
3357 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_INITIALIZED);
3358 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_UNINITIALIZED);
3359 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_STARTED);
3360 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_COMPLETED);
3361 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_CANCELED);
3362 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_KILLED);
3363 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_ERROR);
3364 }
3365 return "Unknown";
3366}
3367
3368/**
3369 * Validates whether a given path matches our set of rules or not.
3370 *
3371 * @returns VBox status code.
3372 * @param pcszPath Path to validate.
3373 * @param fMustExist Whether the path to validate also must exist.
3374 */
3375int ShClTransferValidatePath(const char *pcszPath, bool fMustExist)
3376{
3377 int rc = VINF_SUCCESS;
3378
3379 if (!strlen(pcszPath))
3380 rc = VERR_INVALID_PARAMETER;
3381
3382 if ( RT_SUCCESS(rc)
3383 && !RTStrIsValidEncoding(pcszPath))
3384 {
3385 rc = VERR_INVALID_UTF8_ENCODING;
3386 }
3387
3388 if ( RT_SUCCESS(rc)
3389 && RTStrStr(pcszPath, ".."))
3390 {
3391 rc = VERR_INVALID_PARAMETER;
3392 }
3393
3394 if ( RT_SUCCESS(rc)
3395 && fMustExist)
3396 {
3397 RTFSOBJINFO objInfo;
3398 rc = RTPathQueryInfo(pcszPath, &objInfo, RTFSOBJATTRADD_NOTHING);
3399 if (RT_SUCCESS(rc))
3400 {
3401 if (RTFS_IS_DIRECTORY(objInfo.Attr.fMode))
3402 {
3403 if (!RTDirExists(pcszPath)) /* Path must exist. */
3404 rc = VERR_PATH_NOT_FOUND;
3405 }
3406 else if (RTFS_IS_FILE(objInfo.Attr.fMode))
3407 {
3408 if (!RTFileExists(pcszPath)) /* File must exist. */
3409 rc = VERR_FILE_NOT_FOUND;
3410 }
3411 else /* Everything else (e.g. symbolic links) are not supported. */
3412 {
3413 LogRelMax(64, ("Shared Clipboard: Path '%s' contains a symbolic link or junction, which are not supported\n", pcszPath));
3414 rc = VERR_NOT_SUPPORTED;
3415 }
3416 }
3417 }
3418
3419 if (RT_FAILURE(rc))
3420 LogRelMax(64, ("Shared Clipboard: Validating path '%s' failed: %Rrc\n", pcszPath, rc));
3421
3422 LogFlowFuncLeaveRC(rc);
3423 return rc;
3424}
3425
3426/**
3427 * Resolves a relative path of a specific transfer to its absolute path.
3428 *
3429 * @returns VBox status code.
3430 * @param pTransfer Clipboard transfer to resolve path for.
3431 * @param pszPath Relative path to resolve.
3432 * Paths have to end with a (back-)slash, otherwise this is considered to be a file.
3433 * @param fFlags Resolve flags. Currently not used and must be 0.
3434 * @param ppszResolved Where to store the allocated resolved path. Must be free'd by the called using RTStrFree().
3435 */
3436int ShClTransferResolvePathAbs(PSHCLTRANSFER pTransfer, const char *pszPath, uint32_t fFlags, char **ppszResolved)
3437{
3438 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
3439 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
3440 AssertReturn (fFlags == 0, VERR_INVALID_PARAMETER);
3441 AssertPtrReturn(ppszResolved, VERR_INVALID_POINTER);
3442
3443 LogFlowFunc(("pszPath=%s, fFlags=%#x (pszPathRootAbs=%s, cRootListEntries=%RU64)\n",
3444 pszPath, fFlags, pTransfer->pszPathRootAbs, pTransfer->lstRoots.Hdr.cEntries));
3445
3446 int rc = ShClTransferValidatePath(pszPath, false /* fMustExist */);
3447 if (RT_SUCCESS(rc))
3448 {
3449 rc = VERR_PATH_NOT_FOUND; /* Play safe by default. */
3450
3451 PSHCLLISTENTRY pEntry;
3452 RTListForEach(&pTransfer->lstRoots.lstEntries, pEntry, SHCLLISTENTRY, Node)
3453 {
3454 LogFlowFunc(("\tpEntry->pszName=%s\n", pEntry->pszName));
3455
3456 if (RTStrStartsWith(pszPath, pEntry->pszName)) /* Case-sensitive! */
3457 {
3458 rc = VINF_SUCCESS;
3459 break;
3460 }
3461 }
3462
3463 if (RT_SUCCESS(rc))
3464 {
3465 char *pszPathAbs = RTPathJoinA(pTransfer->pszPathRootAbs, pszPath);
3466 if (pszPathAbs)
3467 {
3468 char szResolved[RTPATH_MAX];
3469 size_t cbResolved = sizeof(szResolved);
3470 rc = RTPathAbsEx(pTransfer->pszPathRootAbs, pszPathAbs, RTPATH_STR_F_STYLE_HOST, szResolved, &cbResolved);
3471
3472 RTStrFree(pszPathAbs);
3473 pszPathAbs = NULL;
3474
3475 if (RT_SUCCESS(rc))
3476 {
3477 LogRel2(("Shared Clipboard: Resolved: '%s' -> '%s'\n", pszPath, szResolved));
3478
3479 *ppszResolved = RTStrDup(szResolved);
3480 }
3481 }
3482 else
3483 rc = VERR_NO_MEMORY;
3484 }
3485 }
3486
3487 if (RT_FAILURE(rc))
3488 LogRel(("Shared Clipboard: Resolving absolute path for '%s' failed, rc=%Rrc\n", pszPath, rc));
3489
3490 LogFlowFuncLeaveRC(rc);
3491 return rc;
3492}
3493
3494/**
3495 * Converts Shared Clipboard create flags (see SharedClipboard-transfers.h) into IPRT create flags.
3496 *
3497 * @returns IPRT status code.
3498 * @param fShClFlags Shared clipboard create flags.
3499 * @param[out] pfOpen Where to store the RTFILE_O_XXX flags for
3500 * RTFileOpen.
3501 *
3502 * @sa Initially taken from vbsfConvertFileOpenFlags().
3503 */
3504int ShClTransferConvertFileCreateFlags(uint32_t fShClFlags, uint64_t *pfOpen)
3505{
3506 AssertMsgReturnStmt(!(fShClFlags & ~SHCL_OBJ_CF_VALID_MASK), ("%#x4\n", fShClFlags), *pfOpen = 0, VERR_INVALID_FLAGS);
3507
3508 uint64_t fOpen = 0;
3509
3510 switch (fShClFlags & SHCL_OBJ_CF_ACCESS_MASK_RW)
3511 {
3512 case SHCL_OBJ_CF_ACCESS_NONE:
3513 {
3514#ifdef RT_OS_WINDOWS
3515 if ((fShClFlags & SHCL_OBJ_CF_ACCESS_MASK_ATTR) != SHCL_OBJ_CF_ACCESS_ATTR_NONE)
3516 fOpen |= RTFILE_O_OPEN | RTFILE_O_ATTR_ONLY;
3517 else
3518#endif
3519 fOpen |= RTFILE_O_OPEN | RTFILE_O_READ;
3520 LogFlowFunc(("SHCL_OBJ_CF_ACCESS_NONE\n"));
3521 break;
3522 }
3523
3524 case SHCL_OBJ_CF_ACCESS_READ:
3525 {
3526 fOpen |= RTFILE_O_OPEN | RTFILE_O_READ;
3527 LogFlowFunc(("SHCL_OBJ_CF_ACCESS_READ\n"));
3528 break;
3529 }
3530
3531 default:
3532 AssertFailedReturn(VERR_IPE_NOT_REACHED_DEFAULT_CASE);
3533 }
3534
3535 switch (fShClFlags & SHCL_OBJ_CF_ACCESS_MASK_ATTR)
3536 {
3537 case SHCL_OBJ_CF_ACCESS_ATTR_NONE:
3538 {
3539 fOpen |= RTFILE_O_ACCESS_ATTR_DEFAULT;
3540 LogFlowFunc(("SHCL_OBJ_CF_ACCESS_ATTR_NONE\n"));
3541 break;
3542 }
3543
3544 case SHCL_OBJ_CF_ACCESS_ATTR_READ:
3545 {
3546 fOpen |= RTFILE_O_ACCESS_ATTR_READ;
3547 LogFlowFunc(("SHCL_OBJ_CF_ACCESS_ATTR_READ\n"));
3548 break;
3549 }
3550
3551 default:
3552 AssertFailedReturn(VERR_IPE_NOT_REACHED_DEFAULT_CASE);
3553 }
3554
3555 /* Sharing mask */
3556 switch (fShClFlags & SHCL_OBJ_CF_ACCESS_MASK_DENY)
3557 {
3558 case SHCL_OBJ_CF_ACCESS_DENYNONE:
3559 fOpen |= RTFILE_O_DENY_NONE;
3560 LogFlowFunc(("SHCL_OBJ_CF_ACCESS_DENYNONE\n"));
3561 break;
3562
3563 case SHCL_OBJ_CF_ACCESS_DENYWRITE:
3564 fOpen |= RTFILE_O_DENY_WRITE;
3565 LogFlowFunc(("SHCL_OBJ_CF_ACCESS_DENYWRITE\n"));
3566 break;
3567
3568 default:
3569 AssertFailedReturn(VERR_IPE_NOT_REACHED_DEFAULT_CASE);
3570 }
3571
3572 *pfOpen = fOpen;
3573
3574 LogFlowFuncLeaveRC(VINF_SUCCESS);
3575 return VINF_SUCCESS;
3576}
3577
Note: See TracBrowser for help on using the repository browser.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette