VirtualBox

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

最後變更 在這個檔案從103450是 103442,由 vboxsync 提交於 13 月 前

Shared Clipboard: Condensed more code by adding a SHCLTRANSFERCALLBACKS::pfnOnInitialize() callback function. bugref:9437
  • 屬性 svn:eol-style 設為 native
  • 屬性 svn:keywords 設為 Author Date Id Revision
檔案大小: 107.9 KB
行 
1/* $Id: clipboard-transfers.cpp 103442 2024-02-19 13:51:37Z 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.alldomusa.eu.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 = VINF_SUCCESS;
1236 if (pTransfer->Callbacks.pfnOnInitialize)
1237 rc = pTransfer->Callbacks.pfnOnInitialize(&pTransfer->CallbackCtx);
1238
1239 if (RT_SUCCESS(rc))
1240 {
1241 /* Sanity: Make sure that the transfer we're gonna report as INITIALIZED
1242 * actually has some root entries set, as the other side can query for those at any time then. */
1243 if (pTransfer->State.enmDir == SHCLTRANSFERDIR_TO_REMOTE)
1244 AssertMsgStmt(ShClTransferRootsCount(pTransfer), ("Transfer has no root entries set\n"), rc = VERR_WRONG_ORDER);
1245
1246 rc = shClTransferSetStatus(pTransfer, SHCLTRANSFERSTATUS_INITIALIZED);
1247
1248 if ( RT_SUCCESS(rc)
1249 && pTransfer->Callbacks.pfnOnInitialized)
1250 pTransfer->Callbacks.pfnOnInitialized(&pTransfer->CallbackCtx);
1251 }
1252
1253 shClTransferUnlock(pTransfer);
1254
1255 if (RT_FAILURE(rc))
1256 LogRel2(("Shared Clipboard: Initialziation of transfer failed with %Rrc\n", rc));
1257
1258 LogFlowFuncLeaveRC(rc);
1259 return rc;
1260}
1261
1262/**
1263 * Returns whether a transfer is in a running state or not.
1264 *
1265 * @returns @c true if in running state, or @c false if not.
1266 * @param pTransfer Clipboard transfer to return status for.
1267 */
1268bool ShClTransferIsRunning(PSHCLTRANSFER pTransfer)
1269{
1270 shClTransferLock(pTransfer);
1271
1272 bool const fRunning = pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_STARTED;
1273
1274 shClTransferUnlock(pTransfer);
1275
1276 return fRunning;
1277}
1278
1279/**
1280 * Returns whether a transfer has been (successfully) completed or not.
1281 *
1282 * @returns @c true if complete, or @c false if not.
1283 * @param pTransfer Clipboard transfer to return status for.
1284 */
1285bool ShClTransferIsComplete(PSHCLTRANSFER pTransfer)
1286{
1287 shClTransferLock(pTransfer);
1288
1289 bool const fCompleted = pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_COMPLETED;
1290
1291 shClTransferUnlock(pTransfer);
1292
1293 return fCompleted;
1294}
1295
1296/**
1297 * Returns whether a transfer has been aborted due to cancelling, killing or an error.
1298 *
1299 * @returns @c true if in aborted state, or @c false if not.
1300 * @param pTransfer Clipboard transfer to return status for.
1301 */
1302bool ShClTransferIsAborted(PSHCLTRANSFER pTransfer)
1303{
1304 shClTransferLock(pTransfer);
1305
1306 bool const fAborted = pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_CANCELED
1307 || pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_KILLED
1308 || pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_ERROR;
1309
1310 shClTransferUnlock(pTransfer);
1311
1312 return fAborted;
1313}
1314
1315/**
1316 * Locks a transfer.
1317 *
1318 * @param pTransfer Transfer to lock.
1319 */
1320DECLINLINE(void) shClTransferLock(PSHCLTRANSFER pTransfer)
1321{
1322 int rc2 = RTCritSectEnter(&pTransfer->CritSect);
1323 AssertRC(rc2);
1324}
1325
1326/**
1327 * Unlocks a transfer.
1328 *
1329 * @param pTransfer Transfer to unlock.
1330 */
1331DECLINLINE(void) shClTransferUnlock(PSHCLTRANSFER pTransfer)
1332{
1333 int rc2 = RTCritSectLeave(&pTransfer->CritSect);
1334 AssertRC(rc2);
1335}
1336
1337/**
1338 * Acquires a reference to this transfer.
1339 *
1340 * @returns New reference count.
1341 * @param pTransfer Transfer to acquire reference for.
1342 */
1343uint32_t ShClTransferAcquire(PSHCLTRANSFER pTransfer)
1344{
1345 return ASMAtomicIncU32(&pTransfer->cRefs);
1346}
1347
1348/**
1349 * Releases a reference to this transfer.
1350 *
1351 * @returns New reference count.
1352 * @param pTransfer Transfer to release reference for.
1353 */
1354uint32_t ShClTransferRelease(PSHCLTRANSFER pTransfer)
1355{
1356 const uint32_t cRefs = ASMAtomicDecU32(&pTransfer->cRefs);
1357 Assert(pTransfer->cRefs <= VBOX_SHCL_MAX_TRANSFERS); /* Not perfect, but better than nothing. */
1358 return cRefs;
1359}
1360
1361/**
1362 * Opens a transfer list.
1363 *
1364 * @returns VBox status code.
1365 * @param pTransfer Clipboard transfer to handle.
1366 * @param pOpenParms List open parameters to use for opening.
1367 * @param phList Where to store the List handle of opened list on success.
1368 */
1369int ShClTransferListOpen(PSHCLTRANSFER pTransfer, PSHCLLISTOPENPARMS pOpenParms,
1370 PSHCLLISTHANDLE phList)
1371{
1372 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
1373 AssertPtrReturn(pOpenParms, VERR_INVALID_POINTER);
1374 AssertPtrReturn(phList, VERR_INVALID_POINTER);
1375
1376 if (pTransfer->cListHandles == pTransfer->cMaxListHandles)
1377 return VERR_SHCLPB_MAX_LISTS_REACHED;
1378
1379 int rc;
1380 if (pTransfer->ProviderIface.pfnListOpen)
1381 rc = pTransfer->ProviderIface.pfnListOpen(&pTransfer->ProviderCtx, pOpenParms, phList);
1382 else
1383 rc = VERR_NOT_SUPPORTED;
1384
1385 if (RT_FAILURE(rc))
1386 LogRel(("Shared Clipboard: Opening list '%s' (fiter '%s', flags %#x) failed with %Rrc\n",
1387 pOpenParms->pszPath, pOpenParms->pszFilter, pOpenParms->fList, rc));
1388
1389 LogFlowFuncLeaveRC(rc);
1390 return rc;
1391}
1392
1393/**
1394 * Closes a transfer list.
1395 *
1396 * @returns VBox status code.
1397 * @param pTransfer Clipboard transfer to handle.
1398 * @param hList Handle of list to close.
1399 */
1400int ShClTransferListClose(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList)
1401{
1402 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
1403
1404 if (hList == NIL_SHCLLISTHANDLE)
1405 return VINF_SUCCESS;
1406
1407 int rc;
1408 if (pTransfer->ProviderIface.pfnListClose)
1409 rc = pTransfer->ProviderIface.pfnListClose(&pTransfer->ProviderCtx, hList);
1410 else
1411 rc = VERR_NOT_SUPPORTED;
1412
1413 if (RT_FAILURE(rc))
1414 LogRel(("Shared Clipboard: Closing list 0x%x entry failed with %Rrc\n", hList, rc));
1415
1416 LogFlowFuncLeaveRC(rc);
1417 return rc;
1418}
1419
1420/**
1421 * Retrieves the header of a transfer list.
1422 *
1423 * @returns VBox status code.
1424 * @param pTransfer Clipboard transfer to handle.
1425 * @param hList Handle of list to get header for.
1426 * @param pHdr Where to store the returned list header information.
1427 */
1428int ShClTransferListGetHeader(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList,
1429 PSHCLLISTHDR pHdr)
1430{
1431 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
1432 AssertPtrReturn(pHdr, VERR_INVALID_POINTER);
1433
1434 LogFlowFunc(("hList=%RU64\n", hList));
1435
1436 int rc;
1437 if (pTransfer->ProviderIface.pfnListHdrRead)
1438 rc = pTransfer->ProviderIface.pfnListHdrRead(&pTransfer->ProviderCtx, hList, pHdr);
1439 else
1440 rc = VERR_NOT_SUPPORTED;
1441
1442 if (RT_FAILURE(rc))
1443 LogRel(("Shared Clipboard: Reading list header list 0x%x entry failed with %Rrc\n", hList, rc));
1444
1445 LogFlowFuncLeaveRC(rc);
1446 return rc;
1447}
1448
1449/**
1450 * Returns a specific list handle info of a clipboard transfer.
1451 *
1452 * @returns Pointer to list handle info if found, or NULL if not found.
1453 * @param pTransfer Clipboard transfer to get list handle info from.
1454 * @param hList List handle of the list to get handle info for.
1455 */
1456PSHCLLISTHANDLEINFO ShClTransferListGetByHandle(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList)
1457{
1458 PSHCLLISTHANDLEINFO pIt;
1459 RTListForEach(&pTransfer->lstHandles, pIt, SHCLLISTHANDLEINFO, Node) /** @todo Sloooow ... improve this. */
1460 {
1461 if (pIt->hList == hList)
1462 return pIt;
1463 }
1464
1465 return NULL;
1466}
1467
1468/**
1469 * Returns the a transfer object of a transfer list.
1470 *
1471 * Currently not implemented and wil return NULL.
1472 *
1473 * @returns Pointer to transfer object, or NULL if not found / invalid.
1474 * @param pTransfer Clipboard transfer to return transfer object for.
1475 * @param hList Handle of clipboard transfer list to get object for.
1476 * @param uIdx Index of object to get.
1477 */
1478PSHCLTRANSFEROBJ ShClTransferListGetObj(PSHCLTRANSFER pTransfer,
1479 SHCLLISTHANDLE hList, uint64_t uIdx)
1480{
1481 AssertPtrReturn(pTransfer, NULL);
1482
1483 RT_NOREF(hList, uIdx);
1484
1485 LogFlowFunc(("hList=%RU64\n", hList));
1486
1487 return NULL;
1488}
1489
1490/**
1491 * Reads a single transfer list entry.
1492 *
1493 * @returns VBox status code or VERR_NO_MORE_FILES if the end of the list has been reached.
1494 * @param pTransfer Clipboard transfer to handle.
1495 * @param hList List handle of list to read from.
1496 * @param pEntry Where to store the read information.
1497 */
1498int ShClTransferListRead(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList,
1499 PSHCLLISTENTRY pEntry)
1500{
1501 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
1502 AssertPtrReturn(pEntry, VERR_INVALID_POINTER);
1503
1504 LogFlowFunc(("hList=%RU64\n", hList));
1505
1506 int rc;
1507 if (pTransfer->ProviderIface.pfnListEntryRead)
1508 rc = pTransfer->ProviderIface.pfnListEntryRead(&pTransfer->ProviderCtx, hList, pEntry);
1509 else
1510 rc = VERR_NOT_SUPPORTED;
1511
1512 if (RT_FAILURE(rc))
1513 LogRel(("Shared Clipboard: Reading list for list 0x%x entry failed with %Rrc\n", hList, rc));
1514
1515 LogFlowFuncLeaveRC(rc);
1516 return rc;
1517}
1518
1519/**
1520 * Writes a single transfer list entry.
1521 *
1522 * @returns VBox status code.
1523 * @param pTransfer Clipboard transfer to handle.
1524 * @param hList List handle of list to write to.
1525 * @param pEntry Entry information to write.
1526 */
1527int ShClTransferListWrite(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList,
1528 PSHCLLISTENTRY pEntry)
1529{
1530 RT_NOREF(pTransfer, hList, pEntry);
1531
1532 int rc = VINF_SUCCESS;
1533
1534#if 0
1535 if (pTransfer->ProviderIface.pfnListEntryWrite)
1536 rc = pTransfer->ProviderIface.pfnListEntryWrite(&pTransfer->ProviderCtx, hList, pEntry);
1537#endif
1538
1539 if (RT_FAILURE(rc))
1540 LogRel(("Shared Clipboard: Writing list entry to list 0x%x failed with %Rrc\n", hList, rc));
1541
1542 LogFlowFuncLeaveRC(rc);
1543 return rc;
1544}
1545
1546/**
1547 * Returns whether a given transfer list handle is valid or not.
1548 *
1549 * @returns \c true if list handle is valid, \c false if not.
1550 * @param pTransfer Clipboard transfer to handle.
1551 * @param hList List handle to check.
1552 */
1553bool ShClTransferListHandleIsValid(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList)
1554{
1555 bool fIsValid = false;
1556
1557 if (pTransfer->State.enmSource == SHCLSOURCE_LOCAL)
1558 {
1559 fIsValid = ShClTransferListGetByHandle(pTransfer, hList) != NULL;
1560 }
1561 else if (pTransfer->State.enmSource == SHCLSOURCE_REMOTE)
1562 {
1563 AssertFailed(); /** @todo Implement. */
1564 }
1565 else
1566 AssertFailedStmt(fIsValid = false);
1567
1568 return fIsValid;
1569}
1570
1571/**
1572 * Copies a transfer callback table from source to destination.
1573 *
1574 * @param pCallbacksDst Callback destination.
1575 * @param pCallbacksSrc Callback source. If set to NULL, the
1576 * destination callback table will be unset.
1577 */
1578static void shClTransferCopyCallbacks(PSHCLTRANSFERCALLBACKS pCallbacksDst, PSHCLTRANSFERCALLBACKS pCallbacksSrc)
1579{
1580 AssertPtrReturnVoid(pCallbacksDst);
1581 /* pCallbacksSrc can be NULL */
1582
1583 if (pCallbacksSrc) /* Set */
1584 {
1585#define SET_CALLBACK(a_pfnCallback) \
1586 if (pCallbacksSrc->a_pfnCallback) \
1587 pCallbacksDst->a_pfnCallback = pCallbacksSrc->a_pfnCallback
1588
1589 SET_CALLBACK(pfnOnCreated);
1590 SET_CALLBACK(pfnOnInitialize);
1591 SET_CALLBACK(pfnOnInitialized);
1592 SET_CALLBACK(pfnOnDestroy);
1593 SET_CALLBACK(pfnOnStarted);
1594 SET_CALLBACK(pfnOnCompleted);
1595 SET_CALLBACK(pfnOnError);
1596 SET_CALLBACK(pfnOnRegistered);
1597 SET_CALLBACK(pfnOnUnregistered);
1598
1599#undef SET_CALLBACK
1600
1601 pCallbacksDst->pvUser = pCallbacksSrc->pvUser;
1602 pCallbacksDst->cbUser = pCallbacksSrc->cbUser;
1603 }
1604 else /* Unset */
1605 RT_BZERO(pCallbacksDst, sizeof(SHCLTRANSFERCALLBACKS));
1606}
1607
1608/**
1609 * Sets or unsets the callback table to be used for a clipboard transfer.
1610 *
1611 * @returns VBox status code.
1612 * @param pTransfer Clipboard transfer to set callbacks for.
1613 * @param pCallbacks Pointer to callback table to set. If set to NULL,
1614 * existing callbacks for this transfer will be unset.
1615 *
1616 * @note Must come before initializing the transfer via ShClTransferInit().
1617 */
1618static void shClTransferSetCallbacks(PSHCLTRANSFER pTransfer, PSHCLTRANSFERCALLBACKS pCallbacks)
1619{
1620 AssertPtrReturnVoid(pTransfer);
1621 /* pCallbacks can be NULL. */
1622
1623 shClTransferCopyCallbacks(&pTransfer->Callbacks, pCallbacks);
1624
1625 /* Make sure that the callback context has all values set according to the callback table.
1626 * This only needs to be done once, so do this here. */
1627 pTransfer->CallbackCtx.pTransfer = pTransfer;
1628 pTransfer->CallbackCtx.pvUser = pTransfer->Callbacks.pvUser;
1629 pTransfer->CallbackCtx.cbUser = pTransfer->Callbacks.cbUser;
1630}
1631
1632/**
1633 * Sets the transfer provider for a given transfer.
1634 *
1635 * @returns VBox status code.
1636 * @param pTransfer Transfer to create transfer provider for.
1637 * @param pProvider Provider to use.
1638 */
1639int ShClTransferSetProvider(PSHCLTRANSFER pTransfer, PSHCLTXPROVIDER pProvider)
1640{
1641 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
1642 AssertPtrReturn(pProvider, VERR_INVALID_POINTER);
1643
1644 LogFlowFuncEnter();
1645
1646 int rc = VINF_SUCCESS;
1647
1648 pTransfer->ProviderIface = pProvider->Interface;
1649 pTransfer->ProviderCtx.pTransfer = pTransfer;
1650 pTransfer->ProviderCtx.pvUser = pProvider->pvUser;
1651 pTransfer->ProviderCtx.cbUser = pProvider->cbUser;
1652
1653 LogFlowFuncLeaveRC(rc);
1654 return rc;
1655}
1656
1657/**
1658 * Sets the current status.
1659 *
1660 * @returns VBox status code.
1661 * @param pTransfer Clipboard transfer to set status for.
1662 * @param enmStatus Status to set.
1663 *
1664 * @note Caller needs to take critical section.
1665 */
1666static int shClTransferSetStatus(PSHCLTRANSFER pTransfer, SHCLTRANSFERSTATUS enmStatus)
1667{
1668 Assert(RTCritSectIsOwner(&pTransfer->CritSect));
1669#if 0
1670 AssertMsgReturn(pTransfer->State.enmStatus != enmStatus,
1671 ("Setting the same status twice in a row (%#x), please report this!\n", enmStatus), VERR_WRONG_ORDER);
1672#endif
1673 pTransfer->State.enmStatus = enmStatus;
1674
1675 LogFlowFunc(("enmStatus=%s\n", ShClTransferStatusToStr(pTransfer->State.enmStatus)));
1676
1677 return RTSemEventSignal(pTransfer->StatusChangeEvent);
1678}
1679
1680/**
1681 * Returns the number of transfer root list entries.
1682 *
1683 * @returns Root list entry count.
1684 * @param pTransfer Clipboard transfer to return root entry count for.
1685 */
1686uint64_t ShClTransferRootsCount(PSHCLTRANSFER pTransfer)
1687{
1688 AssertPtrReturn(pTransfer, 0);
1689
1690 shClTransferLock(pTransfer);
1691
1692 uint32_t const cRoots = pTransfer->lstRoots.Hdr.cEntries;
1693
1694 shClTransferUnlock(pTransfer);
1695
1696 return cRoots;
1697}
1698
1699/**
1700 * Resets the root list of a clipboard transfer.
1701 *
1702 * @param pTransfer Transfer to clear transfer root list for.
1703 *
1704 * @note Caller needs to take critical section.
1705 */
1706static void shClTransferRootsReset(PSHCLTRANSFER pTransfer)
1707{
1708 AssertPtrReturnVoid(pTransfer);
1709 Assert(RTCritSectIsOwner(&pTransfer->CritSect));
1710
1711 if (pTransfer->pszPathRootAbs)
1712 {
1713 RTStrFree(pTransfer->pszPathRootAbs);
1714 pTransfer->pszPathRootAbs = NULL;
1715 }
1716
1717 ShClTransferListDestroy(&pTransfer->lstRoots);
1718}
1719
1720/**
1721 * Resets a clipboard transfer.
1722 *
1723 * @param pTransfer Clipboard transfer to reset.
1724 */
1725void ShClTransferReset(PSHCLTRANSFER pTransfer)
1726{
1727 AssertPtrReturnVoid(pTransfer);
1728
1729 LogFlowFuncEnter();
1730
1731 shClTransferLock(pTransfer);
1732
1733 shClTransferRootsReset(pTransfer);
1734
1735 PSHCLLISTHANDLEINFO pItList, pItListNext;
1736 RTListForEachSafe(&pTransfer->lstHandles, pItList, pItListNext, SHCLLISTHANDLEINFO, Node)
1737 {
1738 ShClTransferListHandleInfoDestroy(pItList);
1739
1740 RTListNodeRemove(&pItList->Node);
1741
1742 RTMemFree(pItList);
1743 }
1744
1745 PSHCLTRANSFEROBJ pItObj, pItObjNext;
1746 RTListForEachSafe(&pTransfer->lstObj, pItObj, pItObjNext, SHCLTRANSFEROBJ, Node)
1747 {
1748 ShClTransferObjDestroy(pItObj);
1749
1750 RTListNodeRemove(&pItObj->Node);
1751
1752 RTMemFree(pItObj);
1753 }
1754
1755 shClTransferUnlock(pTransfer);
1756}
1757
1758/**
1759 * Get a specific root list entry.
1760 *
1761 * @returns Const pointer to root list entry if found, or NULL if not found..
1762 * @param pTransfer Clipboard transfer to get root list entry of.
1763 * @param uIndex Index (zero-based) of entry to get.
1764 */
1765PCSHCLLISTENTRY ShClTransferRootsEntryGet(PSHCLTRANSFER pTransfer, uint64_t uIndex)
1766{
1767 AssertPtrReturn(pTransfer, NULL);
1768
1769 shClTransferLock(pTransfer);
1770
1771 if (uIndex >= pTransfer->lstRoots.Hdr.cEntries)
1772 {
1773 shClTransferUnlock(pTransfer);
1774 return NULL;
1775 }
1776
1777 PCSHCLLISTENTRY pEntry = shClTransferListGetEntryById(&pTransfer->lstRoots, uIndex);
1778
1779 shClTransferUnlock(pTransfer);
1780
1781 return pEntry;
1782}
1783
1784/**
1785 * Reads the root entries of a clipboard transfer.
1786 *
1787 * This gives the provider interface the chance of reading root entries information.
1788 *
1789 * @returns VBox status code.
1790 * @param pTransfer Clipboard transfer to read root list for.
1791 */
1792int ShClTransferRootListRead(PSHCLTRANSFER pTransfer)
1793{
1794 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
1795
1796 LogFlowFuncEnter();
1797
1798 int rc;
1799 if (pTransfer->ProviderIface.pfnRootListRead)
1800 rc = pTransfer->ProviderIface.pfnRootListRead(&pTransfer->ProviderCtx);
1801 else
1802 rc = VERR_NOT_SUPPORTED;
1803
1804 shClTransferLock(pTransfer);
1805
1806 /* Make sure that we have at least an empty root path set. */
1807 if ( RT_SUCCESS(rc)
1808 && !pTransfer->pszPathRootAbs)
1809 {
1810 if (RTStrAPrintf(&pTransfer->pszPathRootAbs, "") < 0)
1811 rc = VERR_NO_MEMORY;
1812 }
1813
1814 shClTransferUnlock(pTransfer);
1815
1816 LogFlowFuncLeaveRC(rc);
1817 return rc;
1818}
1819
1820/**
1821 * Initializes the root list entries for a given clipboard transfer, extended version.
1822 *
1823 * @returns VBox status code.
1824 * @param pTransfer Transfer to set transfer list entries for.
1825 * @param pszRoots String list (separated by \a pszSep) of root entries to set.
1826 * All entries must have the same root path.
1827 * @param cbRoots Size (in bytes) of string list. Includes zero terminator.
1828 * @param pszSep String separator to use for splitting up the root entries.
1829 *
1830 * @note Accepts local paths or URI string lists (absolute only).
1831 */
1832int ShClTransferRootsInitFromStringListEx(PSHCLTRANSFER pTransfer, const char *pszRoots, size_t cbRoots, const char *pszSep)
1833{
1834 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
1835 AssertPtrReturn(pszRoots, VERR_INVALID_POINTER);
1836 AssertReturn(cbRoots, VERR_INVALID_PARAMETER);
1837 AssertPtrReturn(pszSep, VERR_INVALID_POINTER);
1838
1839#ifdef DEBUG_andy
1840 LogFlowFunc(("Data:\n%.*Rhxd\n", cbRoots, pszRoots));
1841#endif
1842
1843 if (!RTStrIsValidEncoding(pszRoots))
1844 return VERR_INVALID_UTF8_ENCODING;
1845
1846 int rc = VINF_SUCCESS;
1847
1848 shClTransferLock(pTransfer);
1849
1850 shClTransferRootsReset(pTransfer);
1851
1852 PSHCLLIST pLstRoots = &pTransfer->lstRoots;
1853 char *pszPathRootAbs = NULL;
1854
1855 RTCList<RTCString> lstRootEntries = RTCString(pszRoots, cbRoots).split(pszSep);
1856 if (!lstRootEntries.size())
1857 {
1858 shClTransferUnlock(pTransfer);
1859 return VINF_SUCCESS;
1860 }
1861
1862 for (size_t i = 0; i < lstRootEntries.size(); ++i)
1863 {
1864 char *pszPathCur = NULL;
1865
1866 char *pszPath = NULL;
1867 rc = RTUriFilePathEx(lstRootEntries.at(i).c_str(),
1868 RTPATH_STR_F_STYLE_UNIX, &pszPath, 0 /*cbPath*/, NULL /*pcchPath*/);
1869 if (RT_SUCCESS(rc))
1870 {
1871 pszPathCur = pszPath;
1872 pszPath = NULL; /* pszPath has ownership now. */
1873 }
1874 else if (rc == VERR_URI_NOT_FILE_SCHEME) /* Local file path? */
1875 {
1876 pszPathCur = RTStrDup(lstRootEntries.at(i).c_str());
1877 rc = VINF_SUCCESS;
1878 }
1879
1880 LogFlowFunc(("pszPathCur=%s\n", pszPathCur));
1881
1882 rc = ShClTransferValidatePath(pszPathCur, false /* fMustExist */);
1883 if (RT_FAILURE(rc))
1884 {
1885 RTStrFree(pszPathCur);
1886 break;
1887 }
1888
1889 /* No root path determined yet? */
1890 if (!pszPathRootAbs)
1891 {
1892 pszPathRootAbs = RTStrDup(pszPathCur);
1893 if (pszPathRootAbs)
1894 {
1895 RTPathStripFilename(pszPathRootAbs);
1896
1897 LogFlowFunc(("pszPathRootAbs=%s\n", pszPathRootAbs));
1898
1899 /* We don't want to have a relative directory here. */
1900 if (RTPathStartsWithRoot(pszPathRootAbs))
1901 {
1902 rc = ShClTransferValidatePath(pszPathRootAbs, true /* Path must exist */);
1903 }
1904 else
1905 rc = VERR_PATH_IS_RELATIVE;
1906 }
1907 else
1908 rc = VERR_NO_MEMORY;
1909 }
1910
1911 if (RT_SUCCESS(rc))
1912 {
1913 PSHCLLISTENTRY pEntry;
1914 rc = ShClTransferListEntryAlloc(&pEntry);
1915 if (RT_SUCCESS(rc))
1916 {
1917 PSHCLFSOBJINFO pFsObjInfo = (PSHCLFSOBJINFO)RTMemAllocZ(sizeof(SHCLFSOBJINFO));
1918 if (pFsObjInfo)
1919 {
1920 if (pTransfer->State.enmDir == SHCLTRANSFERDIR_TO_REMOTE)
1921 rc = ShClFsObjInfoQueryLocal(pszPathCur, pFsObjInfo);
1922 if (RT_SUCCESS(rc))
1923 {
1924 /* Calculate the relative path within the root path. */
1925 const char *pszPathRelToRoot = &pszPathCur[strlen(pszPathRootAbs) + 1 /* Skip terminator or (back)slash. */];
1926 if ( pszPathRelToRoot
1927 && *pszPathRelToRoot != '\0')
1928 {
1929 LogFlowFunc(("pszPathRelToRoot=%s\n", pszPathRelToRoot));
1930
1931 rc = ShClTransferListEntryInitEx(pEntry, VBOX_SHCL_INFO_F_FSOBJINFO, pszPathRelToRoot,
1932 pFsObjInfo, sizeof(SHCLFSOBJINFO));
1933 if (RT_SUCCESS(rc))
1934 {
1935 rc = ShClTransferListAddEntry(pLstRoots, pEntry, true /* fAppend */);
1936 if (RT_SUCCESS(rc))
1937 {
1938 pFsObjInfo = NULL; /* pEntry has ownership now. */
1939 }
1940 }
1941 }
1942 else
1943 LogRel(("Shared Clipboard: Unable to construct relative path for '%s' (root is '%s')\n",
1944 pszPathCur, pszPathRootAbs));
1945 }
1946
1947 if (pFsObjInfo)
1948 {
1949 RTMemFree(pFsObjInfo);
1950 pFsObjInfo = NULL;
1951 }
1952 }
1953 else
1954 rc = VERR_NO_MEMORY;
1955
1956 if (RT_FAILURE(rc))
1957 ShClTransferListEntryFree(pEntry);
1958 }
1959 }
1960
1961 RTStrFree(pszPathCur);
1962 }
1963
1964 /* No (valid) root directory found? Bail out early. */
1965 if (!pszPathRootAbs)
1966 rc = VERR_PATH_DOES_NOT_START_WITH_ROOT;
1967
1968 if (RT_SUCCESS(rc))
1969 {
1970 pTransfer->pszPathRootAbs = pszPathRootAbs;
1971 LogFlowFunc(("pszPathRootAbs=%s, cRoots=%zu\n", pTransfer->pszPathRootAbs, pTransfer->lstRoots.Hdr.cEntries));
1972
1973 LogRel2(("Shared Clipboard: Transfer uses root '%s'\n", pTransfer->pszPathRootAbs));
1974 }
1975 else
1976 {
1977 LogRel(("Shared Clipboard: Unable to set roots for transfer, rc=%Rrc\n", rc));
1978 ShClTransferListDestroy(pLstRoots);
1979 RTStrFree(pszPathRootAbs);
1980 }
1981
1982 shClTransferUnlock(pTransfer);
1983
1984 LogFlowFuncLeaveRC(rc);
1985 return rc;
1986}
1987
1988/**
1989 * Initializes the root list entries for a given clipboard transfer.
1990 *
1991 * @returns VBox status code.
1992 * @param pTransfer Transfer to set transfer list entries for.
1993 * @param pszRoots String list (separated by SHCL_TRANSFER_URI_LIST_SEP_STR) of root entries to set.
1994 * All entries must have the same root path.
1995 * @param cbRoots Size (in bytes) of string list. Includes zero terminator.
1996 *
1997 * @note Accepts local paths or URI string lists (absolute only).
1998 */
1999int ShClTransferRootsInitFromStringList(PSHCLTRANSFER pTransfer, const char *pszRoots, size_t cbRoots)
2000{
2001 return ShClTransferRootsInitFromStringListEx(pTransfer, pszRoots, cbRoots, SHCL_TRANSFER_URI_LIST_SEP_STR);
2002}
2003
2004/**
2005 * Initializes the root list entries for a given clipboard transfer, UTF-16 (Unicode) version.
2006 *
2007 * @returns VBox status code.
2008 * @param pTransfer Transfer to set transfer list entries for.
2009 * @param pwszRoots Unicode string list (separated by CRLF) of root entries to set.
2010 * All entries must have the same root path.
2011 * @param cbRoots Size (in bytes) of string list. Includes zero terminator.
2012 *
2013 * @note Accepts local paths or URI string lists (absolute only).
2014 */
2015int ShClTransferRootsInitFromStringListUnicode(PSHCLTRANSFER pTransfer, PRTUTF16 pwszRoots, size_t cbRoots)
2016{
2017 AssertPtrReturn(pwszRoots, VERR_INVALID_POINTER);
2018 AssertReturn(cbRoots, VERR_INVALID_PARAMETER);
2019 AssertReturn(cbRoots % sizeof(RTUTF16) == 0, VERR_INVALID_PARAMETER);
2020
2021 size_t cwcRoots = cbRoots / sizeof(RTUTF16);
2022
2023 /* This may slightly overestimate the space needed. */
2024 size_t chDst = 0;
2025 int rc = ShClUtf16LenUtf8(pwszRoots, cwcRoots, &chDst);
2026 if (RT_SUCCESS(rc))
2027 {
2028 chDst++; /* Add space for terminator. */
2029
2030 char *pszDst = (char *)RTStrAlloc(chDst);
2031 if (pszDst)
2032 {
2033 size_t cbActual = 0;
2034 rc = ShClConvUtf16CRLFToUtf8LF(pwszRoots, cwcRoots, pszDst, chDst, &cbActual);
2035 if (RT_SUCCESS(rc))
2036 rc = ShClTransferRootsInitFromStringList(pTransfer, pszDst, cbActual + 1 /* Include terminator */);
2037
2038 RTStrFree(pszDst);
2039 }
2040 else
2041 rc = VERR_NO_MEMORY;
2042 }
2043
2044 return rc;
2045}
2046
2047/**
2048 * Initializes a single file as a transfer root.
2049 *
2050 * @returns VBox status code.
2051 * @param pTransfer Transfer to set transfer list entries for.
2052 * @param pszFile File to use as transfer root.
2053 *
2054 * @note Convenience function, uses ShClTransferRootsSet() internally.
2055 */
2056int ShClTransferRootsInitFromFile(PSHCLTRANSFER pTransfer, const char *pszFile)
2057{
2058 char *pszRoots = NULL;
2059
2060 LogFlowFuncEnter();
2061
2062 int rc = RTStrAAppend(&pszRoots, pszFile);
2063 AssertRCReturn(rc, rc);
2064 rc = RTStrAAppend(&pszRoots, "\r\n");
2065 AssertRCReturn(rc, rc);
2066 rc = ShClTransferRootsInitFromStringList(pTransfer, pszRoots, strlen(pszRoots) + 1 /* Include terminator */);
2067 RTStrFree(pszRoots);
2068 return rc;
2069}
2070
2071/**
2072 * Returns the clipboard transfer's ID.
2073 *
2074 * @returns The transfer's ID.
2075 * @param pTransfer Clipboard transfer to return ID for.
2076 */
2077SHCLTRANSFERID ShClTransferGetID(PSHCLTRANSFER pTransfer)
2078{
2079 AssertPtrReturn(pTransfer, 0);
2080
2081 shClTransferLock(pTransfer);
2082
2083 SHCLTRANSFERID const uID = pTransfer->State.uID;
2084
2085 shClTransferUnlock(pTransfer);
2086
2087 return uID;
2088}
2089
2090/**
2091 * Returns the clipboard transfer's direction.
2092 *
2093 * @returns The transfer's direction.
2094 * @param pTransfer Clipboard transfer to return direction for.
2095 */
2096SHCLTRANSFERDIR ShClTransferGetDir(PSHCLTRANSFER pTransfer)
2097{
2098 AssertPtrReturn(pTransfer, SHCLTRANSFERDIR_UNKNOWN);
2099
2100 shClTransferLock(pTransfer);
2101
2102 SHCLTRANSFERDIR const enmDir = pTransfer->State.enmDir;
2103
2104 shClTransferUnlock(pTransfer);
2105
2106 return enmDir;
2107}
2108
2109/**
2110 * Returns the absolute root path of a transfer.
2111 *
2112 * @returns VBox status code.
2113 * @param pTransfer Clipboard transfer to return absolute root path for.
2114 * @param pszPath Where to store the returned path.
2115 * @param cbPath Size (in bytes) of \a pszPath.
2116 */
2117int ShClTransferGetRootPathAbs(PSHCLTRANSFER pTransfer, char *pszPath, size_t cbPath)
2118{
2119 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2120
2121 shClTransferLock(pTransfer);
2122
2123 AssertMsgReturn(pTransfer->pszPathRootAbs, ("Transfer has no root path set (yet)\n"), VERR_WRONG_ORDER);
2124
2125 int const rc = RTStrCopy(pszPath, cbPath, pTransfer->pszPathRootAbs);
2126
2127 shClTransferUnlock(pTransfer);
2128
2129 return rc;
2130}
2131
2132/**
2133 * Returns the transfer's source.
2134 *
2135 * @returns The transfer's source.
2136 * @param pTransfer Clipboard transfer to return source for.
2137 */
2138SHCLSOURCE ShClTransferGetSource(PSHCLTRANSFER pTransfer)
2139{
2140 AssertPtrReturn(pTransfer, SHCLSOURCE_INVALID);
2141
2142 shClTransferLock(pTransfer);
2143
2144 SHCLSOURCE const enmSource = pTransfer->State.enmSource;
2145
2146 shClTransferUnlock(pTransfer);
2147
2148 return enmSource;
2149}
2150
2151/**
2152 * Returns the current transfer status.
2153 *
2154 * @returns Current transfer status.
2155 * @param pTransfer Clipboard transfer to return status for.
2156 *
2157 * @note Caller needs to take critical section.
2158 */
2159DECLINLINE(SHCLTRANSFERSTATUS) shClTransferGetStatusLocked(PSHCLTRANSFER pTransfer)
2160{
2161 Assert(RTCritSectIsOwner(&pTransfer->CritSect));
2162
2163 shClTransferLock(pTransfer);
2164
2165 SHCLTRANSFERSTATUS const enmStatus = pTransfer->State.enmStatus;
2166
2167 shClTransferUnlock(pTransfer);
2168
2169 return enmStatus;
2170}
2171
2172/**
2173 * Returns the current transfer status.
2174 *
2175 * @returns Current transfer status.
2176 * @param pTransfer Clipboard transfer to return status for.
2177 */
2178SHCLTRANSFERSTATUS ShClTransferGetStatus(PSHCLTRANSFER pTransfer)
2179{
2180 AssertPtrReturn(pTransfer, SHCLTRANSFERSTATUS_NONE);
2181
2182 shClTransferLock(pTransfer);
2183
2184 SHCLTRANSFERSTATUS const enmSts = shClTransferGetStatusLocked(pTransfer);
2185
2186 shClTransferUnlock(pTransfer);
2187
2188 return enmSts;
2189}
2190
2191/**
2192 * Runs a started clipboard transfer in a dedicated thread.
2193 *
2194 * @returns VBox status code.
2195 * @param pTransfer Clipboard transfer to run.
2196 * @param pfnThreadFunc Pointer to thread function to use.
2197 * @param pvUser Pointer to user-provided data. Optional.
2198 */
2199int ShClTransferRun(PSHCLTRANSFER pTransfer, PFNSHCLTRANSFERTHREAD pfnThreadFunc, void *pvUser)
2200{
2201 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2202 AssertPtrReturn(pfnThreadFunc, VERR_INVALID_POINTER);
2203 /* pvUser is optional. */
2204
2205 AssertMsgReturn(pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_STARTED,
2206 ("Wrong status (currently is %s)\n", ShClTransferStatusToStr(pTransfer->State.enmStatus)),
2207 VERR_WRONG_ORDER);
2208
2209 int rc = shClTransferThreadCreate(pTransfer, pfnThreadFunc, pvUser);
2210
2211 LogFlowFuncLeaveRC(rc);
2212 return rc;
2213}
2214
2215/**
2216 * Starts an initialized transfer.
2217 *
2218 * @returns VBox status code.
2219 * @param pTransfer Clipboard transfer to start.
2220 */
2221int ShClTransferStart(PSHCLTRANSFER pTransfer)
2222{
2223 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2224
2225 LogFlowFuncEnter();
2226
2227 shClTransferLock(pTransfer);
2228
2229 /* Ready to start? */
2230 AssertMsgReturnStmt(pTransfer->ProviderIface.pfnRootListRead != NULL,
2231 ("No provider interface set (yet)\n"),
2232 shClTransferUnlock(pTransfer), VERR_WRONG_ORDER);
2233 AssertMsgReturnStmt(pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_INITIALIZED,
2234 ("Wrong status (currently is %s)\n", ShClTransferStatusToStr(pTransfer->State.enmStatus)),
2235 shClTransferUnlock(pTransfer), VERR_WRONG_ORDER);
2236
2237 int rc = shClTransferSetStatus(pTransfer, SHCLTRANSFERSTATUS_STARTED);
2238
2239 shClTransferUnlock(pTransfer);
2240
2241 if (pTransfer->Callbacks.pfnOnStarted)
2242 pTransfer->Callbacks.pfnOnStarted(&pTransfer->CallbackCtx);
2243
2244 LogFlowFuncLeaveRC(rc);
2245 return rc;
2246}
2247
2248/**
2249 * Stops a started transfer.
2250 *
2251 * @returns VBox status code.
2252 * @param pTransfer Clipboard transfer to stop.
2253 */
2254int ShClTransferStop(PSHCLTRANSFER pTransfer)
2255{
2256 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2257
2258 LogFlowFuncEnter();
2259
2260 int rc = shClTransferThreadDestroy(pTransfer, SHCL_TIMEOUT_DEFAULT_MS);
2261
2262 LogFlowFuncLeaveRC(rc);
2263 return rc;
2264}
2265
2266/**
2267 * Completes a transfer (as successful).
2268 *
2269 * @returns VBox status code.
2270 * @param pTransfer Clipboard transfer to complete.
2271 */
2272int ShClTransferComplete(PSHCLTRANSFER pTransfer)
2273{
2274 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2275
2276 LogFlowFuncEnter();
2277
2278 shClTransferLock(pTransfer);
2279
2280 AssertMsgReturnStmt( pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_INITIALIZED
2281 || pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_STARTED,
2282 ("Wrong status (currently is %s)\n", ShClTransferStatusToStr(pTransfer->State.enmStatus)),
2283 shClTransferUnlock(pTransfer), VERR_WRONG_ORDER);
2284
2285 int rc = shClTransferSetStatus(pTransfer, SHCLTRANSFERSTATUS_COMPLETED);
2286
2287 shClTransferUnlock(pTransfer);
2288
2289 if (pTransfer->Callbacks.pfnOnCompleted)
2290 pTransfer->Callbacks.pfnOnCompleted(&pTransfer->CallbackCtx, rc);
2291
2292 LogFlowFuncLeaveRC(rc);
2293 return rc;
2294}
2295
2296/**
2297 * Cancels or sets an error for a transfer.
2298 *
2299 * @returns VBox status code.
2300 * @param pTransfer Clipboard transfer to cancel or set error for.
2301 * @param rc Error code to set.
2302 * If set to VERR_CANCELLED, the transfer will be canceled.
2303 */
2304static int shClTransferCancelOrError(PSHCLTRANSFER pTransfer, int rc)
2305{
2306 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2307
2308 LogFlowFunc(("%Rrc\n", rc));
2309
2310 shClTransferLock(pTransfer);
2311
2312 int rc2;
2313
2314 if ( pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_INITIALIZED
2315 || pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_STARTED)
2316 {
2317 if (rc == VERR_CANCELLED)
2318 {
2319 rc2 = shClTransferSetStatus(pTransfer, SHCLTRANSFERSTATUS_CANCELED);
2320
2321 if (pTransfer->Callbacks.pfnOnCompleted)
2322 pTransfer->Callbacks.pfnOnCompleted(&pTransfer->CallbackCtx, VERR_CANCELLED);
2323 }
2324 else
2325 {
2326 rc2 = shClTransferSetStatus(pTransfer, SHCLTRANSFERSTATUS_ERROR);
2327
2328 if (pTransfer->Callbacks.pfnOnError)
2329 pTransfer->Callbacks.pfnOnError(&pTransfer->CallbackCtx, rc);
2330 }
2331 }
2332 else /* Nothing to do. */
2333 rc2 = VINF_SUCCESS;
2334
2335 shClTransferUnlock(pTransfer);
2336
2337 LogFlowFuncLeaveRC(rc2);
2338 return rc2;
2339}
2340
2341/**
2342 * Cancels a transfer.
2343 *
2344 * @returns VBox status code.
2345 * @param pTransfer Clipboard transfer to cancel.
2346 */
2347int ShClTransferCancel(PSHCLTRANSFER pTransfer)
2348{
2349 return shClTransferCancelOrError(pTransfer, VERR_CANCELLED);
2350}
2351
2352/**
2353 * Kills a transfer.
2354 *
2355 * Currently cancels it internally.
2356 *
2357 * @returns VBox status code.
2358 * @param pTransfer Clipboard transfer to kill.
2359 */
2360int ShClTransferKill(PSHCLTRANSFER pTransfer)
2361{
2362 return ShClTransferCancel(pTransfer);
2363}
2364
2365/**
2366 * Sets an error for a transfer.
2367 *
2368 * @returns VBox status code.
2369 * @param pTransfer Clipboard transfer to set error for.
2370 * @param rc Error code to set.
2371 */
2372int ShClTransferError(PSHCLTRANSFER pTransfer, int rc)
2373{
2374 return shClTransferCancelOrError(pTransfer, rc);
2375}
2376
2377/**
2378 * Internal struct for keeping a transfer thread context.
2379 */
2380typedef struct _SHCLTRANSFERTHREADCTX
2381{
2382 /** Pointer to transfer. */
2383 PSHCLTRANSFER pTransfer;
2384 /** User-supplied context data. Can be NULL if not being used. */
2385 void *pvUser;
2386 /** Pointer to thread function to use. */
2387 PFNSHCLTRANSFERTHREAD pfnThread;
2388} SHCLTRANSFERTHREADCTX;
2389/** Pointer to internal struct for keeping a transfer thread context. */
2390typedef SHCLTRANSFERTHREADCTX *PSHCLTRANSFERTHREADCTX;
2391
2392/**
2393 * Worker thread for a transfer.
2394 *
2395 * @returns VBox status code.
2396 * @param ThreadSelf Thread self handle. Not being used.
2397 * @param pvUser Context data of type PSHCLTRANSFERTHREADCTX.
2398 */
2399static DECLCALLBACK(int) shClTransferThreadWorker(RTTHREAD ThreadSelf, void *pvUser)
2400{
2401 RT_NOREF(ThreadSelf);
2402
2403 LogFlowFuncEnter();
2404
2405 SHCLTRANSFERTHREADCTX Ctx;
2406 memcpy(&Ctx, pvUser, sizeof(SHCLTRANSFERTHREADCTX));
2407
2408 LogFlowFunc(("pfnThread=%p, pTransfer=%p, pvUser=%p\n", Ctx.pfnThread, Ctx.pTransfer, Ctx.pvUser));
2409
2410 PSHCLTRANSFER pTransfer = Ctx.pTransfer;
2411
2412 shClTransferLock(pTransfer);
2413
2414 pTransfer->Thread.fStarted = true;
2415 pTransfer->Thread.fStop = false;
2416
2417 shClTransferUnlock(pTransfer);
2418
2419 RTThreadUserSignal(RTThreadSelf());
2420
2421 int rc = Ctx.pfnThread(pTransfer, Ctx.pvUser);
2422
2423 if (pTransfer->Callbacks.pfnOnCompleted)
2424 pTransfer->Callbacks.pfnOnCompleted(&pTransfer->CallbackCtx, rc);
2425
2426 LogFlowFuncLeaveRC(rc);
2427 return rc;
2428}
2429
2430/**
2431 * Creates a thread for a clipboard transfer.
2432 *
2433 * @returns VBox status code.
2434 * @param pTransfer Clipboard transfer to create thread for.
2435 * @param pfnThreadFunc Thread function to use for this transfer.
2436 * @param pvUser Pointer to user-provided data.
2437 */
2438static int shClTransferThreadCreate(PSHCLTRANSFER pTransfer, PFNSHCLTRANSFERTHREAD pfnThreadFunc, void *pvUser)
2439
2440{
2441 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2442
2443 shClTransferLock(pTransfer);
2444
2445 /* Already marked for stopping? */
2446 AssertMsgReturn(pTransfer->Thread.fStop == false,
2447 ("Transfer thread already marked for stopping"), VERR_WRONG_ORDER);
2448 /* Already started? */
2449 AssertMsgReturn(pTransfer->Thread.fStarted == false,
2450 ("Transfer thread already started"), VERR_WRONG_ORDER);
2451
2452 SHCLTRANSFERTHREADCTX Ctx = { pTransfer, pvUser, pfnThreadFunc };
2453
2454 /* Spawn a worker thread, so that we don't block the window thread for too long. */
2455 int rc = RTThreadCreate(&pTransfer->Thread.hThread, shClTransferThreadWorker,
2456 &Ctx, 0, RTTHREADTYPE_DEFAULT, RTTHREADFLAGS_WAITABLE,
2457 "shcltx");
2458 if (RT_SUCCESS(rc))
2459 {
2460 shClTransferUnlock(pTransfer); /* Leave lock while waiting. */
2461
2462 int rc2 = RTThreadUserWait(pTransfer->Thread.hThread, SHCL_TIMEOUT_DEFAULT_MS);
2463 AssertRC(rc2);
2464
2465 shClTransferLock(pTransfer);
2466
2467 if (pTransfer->Thread.fStarted) /* Did the thread indicate that it started correctly? */
2468 {
2469 /* Nothing to do in here. */
2470 }
2471 else
2472 rc = VERR_GENERAL_FAILURE; /** @todo Find a better rc. */
2473 }
2474
2475 shClTransferUnlock(pTransfer);
2476
2477 LogFlowFuncLeaveRC(rc);
2478 return rc;
2479}
2480
2481/**
2482 * Destroys the thread of a clipboard transfer.
2483 *
2484 * @returns VBox status code. Will return thread rc.
2485 * @param pTransfer Clipboard transfer to destroy thread for.
2486 * @param uTimeoutMs Timeout (in ms) to wait for thread destruction.
2487 */
2488static int shClTransferThreadDestroy(PSHCLTRANSFER pTransfer, RTMSINTERVAL uTimeoutMs)
2489{
2490 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2491
2492 shClTransferLock(pTransfer);
2493
2494 if (!pTransfer->Thread.fStarted)
2495 {
2496 shClTransferUnlock(pTransfer);
2497 return VINF_SUCCESS;
2498 }
2499
2500 LogFlowFuncEnter();
2501
2502 /* Set stop indicator. */
2503 pTransfer->Thread.fStop = true;
2504
2505 shClTransferUnlock(pTransfer); /* Leave lock while waiting. */
2506
2507 int rcThread = VERR_IPE_UNINITIALIZED_STATUS;
2508 Assert(pTransfer->Thread.hThread != NIL_RTTHREAD);
2509 int rc = RTThreadWait(pTransfer->Thread.hThread, uTimeoutMs, &rcThread);
2510
2511 LogFlowFunc(("Waiting for thread resulted in %Rrc (thread exited with %Rrc)\n", rc, rcThread));
2512
2513 if (RT_SUCCESS(rc))
2514 {
2515 pTransfer->Thread.fStarted = false;
2516 pTransfer->Thread.hThread = NIL_RTTHREAD;
2517
2518 rc = rcThread; /* Return the thread rc to the caller. */
2519 }
2520 else
2521 LogRel(("Shared Clipboard: Waiting for thread of transfer %RU16 failed with %Rrc\n", pTransfer->State.uID, rc));
2522
2523 LogFlowFuncLeaveRC(rc);
2524 return rc;
2525}
2526
2527/**
2528 * Waits for the transfer status to change, internal version.
2529 *
2530 * @returns VBox status code.
2531 * @param pTransfer Clipboard transfer to wait for.
2532 * @param msTimeout Timeout (in ms) to wait.
2533 * @param penmStatus Where to return the new (current) transfer status on success.
2534 * Optional and can be NULL.
2535 */
2536static int shClTransferWaitForStatusChangeInternal(PSHCLTRANSFER pTransfer, RTMSINTERVAL msTimeout, SHCLTRANSFERSTATUS *penmStatus)
2537{
2538 LogFlowFunc(("Waiting for status change (%RU32 timeout) ...\n", msTimeout));
2539
2540 int rc = RTSemEventWait(pTransfer->StatusChangeEvent, msTimeout);
2541 if (RT_SUCCESS(rc))
2542 {
2543 if (penmStatus)
2544 {
2545 shClTransferLock(pTransfer);
2546
2547 *penmStatus = pTransfer->State.enmStatus;
2548
2549 shClTransferUnlock(pTransfer);
2550 }
2551 }
2552
2553 return rc;
2554}
2555
2556/**
2557 * Waits for the transfer status to change.
2558 *
2559 * @returns VBox status code.
2560 * @param pTransfer Clipboard transfer to wait for.
2561 * @param msTimeout Timeout (in ms) to wait.
2562 * @param penmStatus Where to return the new (current) transfer status on success.
2563 * Optional and can be NULL.
2564 */
2565int ShClTransferWaitForStatusChange(PSHCLTRANSFER pTransfer, RTMSINTERVAL msTimeout, SHCLTRANSFERSTATUS *penmStatus)
2566{
2567 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2568
2569 int rc = shClTransferWaitForStatusChangeInternal(pTransfer, msTimeout, penmStatus);
2570
2571 LogFlowFuncLeaveRC(rc);
2572 return rc;
2573}
2574
2575/**
2576 * Waits for a specific transfer status.
2577 *
2578 * @returns VBox status code.
2579 * @param pTransfer Clipboard transfer to wait for.
2580 * @param msTimeout Timeout (in ms) to wait.
2581 * @param enmStatus Transfer status to wait for.
2582 */
2583int ShClTransferWaitForStatus(PSHCLTRANSFER pTransfer, RTMSINTERVAL msTimeout, SHCLTRANSFERSTATUS enmStatus)
2584{
2585 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2586
2587 int rc = VINF_SUCCESS;
2588
2589 uint64_t const tsStartMs = RTTimeMilliTS();
2590 uint64_t msLeft = msTimeout;
2591 for (;;)
2592 {
2593 SHCLTRANSFERSTATUS enmCurStatus;
2594 rc = shClTransferWaitForStatusChangeInternal(pTransfer, msLeft, &enmCurStatus);
2595 if (RT_FAILURE(rc))
2596 break;
2597
2598 if (enmCurStatus == enmStatus)
2599 break;
2600
2601 msLeft -= RT_MIN(msLeft, RTTimeMilliTS() - tsStartMs);
2602 if (msLeft == 0)
2603 {
2604 rc = VERR_TIMEOUT;
2605 break;
2606 }
2607 }
2608
2609 LogFlowFuncLeaveRC(rc);
2610 return rc;
2611}
2612
2613
2614/*********************************************************************************************************************************
2615 * Transfer Context *
2616 ********************************************************************************************************************************/
2617
2618/**
2619 * Locks a transfer context.
2620 *
2621 * @param pTransferCtx Transfer context to lock.
2622 */
2623DECLINLINE(void) shClTransferCtxLock(PSHCLTRANSFERCTX pTransferCtx)
2624{
2625 int rc2 = RTCritSectEnter(&pTransferCtx->CritSect);
2626 AssertRC(rc2);
2627}
2628
2629/**
2630 * Unlocks a transfer context.
2631 *
2632 * @param pTransferCtx Transfer context to unlock.
2633 */
2634DECLINLINE(void) shClTransferCtxUnlock(PSHCLTRANSFERCTX pTransferCtx)
2635{
2636 int rc2 = RTCritSectLeave(&pTransferCtx->CritSect);
2637 AssertRC(rc2);
2638}
2639
2640/**
2641 * Initializes a clipboard transfer context.
2642 *
2643 * @returns VBox status code.
2644 * @param pTransferCtx Transfer context to initialize.
2645 */
2646int ShClTransferCtxInit(PSHCLTRANSFERCTX pTransferCtx)
2647{
2648 AssertPtrReturn(pTransferCtx, VERR_INVALID_POINTER);
2649
2650 LogFlowFunc(("pTransferCtx=%p\n", pTransferCtx));
2651
2652 int rc = RTCritSectInit(&pTransferCtx->CritSect);
2653 if (RT_SUCCESS(rc))
2654 {
2655 rc = RTSemEventCreate(&pTransferCtx->ChangedEvent);
2656 if (RT_SUCCESS(rc))
2657 {
2658 RT_ZERO(pTransferCtx->ChangedEventData);
2659
2660 RTListInit(&pTransferCtx->List);
2661
2662 pTransferCtx->cTransfers = 0;
2663 pTransferCtx->cRunning = 0;
2664 pTransferCtx->cMaxRunning = 64; /** @todo Make this configurable? */
2665
2666 RT_ZERO(pTransferCtx->bmTransferIds);
2667
2668 ShClTransferCtxReset(pTransferCtx);
2669 }
2670 }
2671
2672 return VINF_SUCCESS;
2673}
2674
2675/**
2676 * Destroys a clipboard transfer context.
2677 *
2678 * @param pTransferCtx Transfer context to destroy.
2679 */
2680void ShClTransferCtxDestroy(PSHCLTRANSFERCTX pTransferCtx)
2681{
2682 if (!pTransferCtx)
2683 return;
2684
2685 LogFlowFunc(("pTransferCtx=%p\n", pTransferCtx));
2686
2687 shClTransferCtxLock(pTransferCtx);
2688
2689 PSHCLTRANSFER pTransfer, pTransferNext;
2690 RTListForEachSafe(&pTransferCtx->List, pTransfer, pTransferNext, SHCLTRANSFER, Node)
2691 {
2692 shclTransferCtxTransferRemoveAndUnregister(pTransferCtx, pTransfer);
2693 ShClTransferDestroy(pTransfer);
2694 }
2695
2696 pTransferCtx->cRunning = 0;
2697 pTransferCtx->cTransfers = 0;
2698
2699 shClTransferCtxUnlock(pTransferCtx);
2700
2701 RTSemEventDestroy(pTransferCtx->ChangedEvent);
2702 pTransferCtx->ChangedEvent = NIL_RTSEMEVENT;
2703
2704 if (RTCritSectIsInitialized(&pTransferCtx->CritSect))
2705 RTCritSectDelete(&pTransferCtx->CritSect);
2706}
2707
2708/**
2709 * Resets a clipboard transfer context.
2710 *
2711 * @param pTransferCtx Transfer context to reset.
2712 */
2713void ShClTransferCtxReset(PSHCLTRANSFERCTX pTransferCtx)
2714{
2715 AssertPtrReturnVoid(pTransferCtx);
2716
2717 shClTransferCtxLock(pTransferCtx);
2718
2719 LogFlowFuncEnter();
2720
2721 PSHCLTRANSFER pTransfer;
2722 RTListForEach(&pTransferCtx->List, pTransfer, SHCLTRANSFER, Node)
2723 ShClTransferReset(pTransfer);
2724
2725#ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS_HTTP
2726 /** @todo Anything to do here? */
2727#endif
2728
2729 shClTransferCtxUnlock(pTransferCtx);
2730}
2731
2732/**
2733 * Signals a change event.
2734 *
2735 * @returns VBox status code.
2736 * @param pTransferCtx Transfer context to return transfer for.
2737 * @param fRegistered Whether a transfer got registered or unregistered.
2738 * @param pTransfer Transfer bound to the event.
2739 */
2740static int shClTransferCtxSignal(PSHCLTRANSFERCTX pTransferCtx, bool fRegistered, PSHCLTRANSFER pTransfer)
2741{
2742 Assert(RTCritSectIsOwner(&pTransferCtx->CritSect));
2743
2744 LogFlowFunc(("fRegistered=%RTbool, pTransfer=%p\n", fRegistered, pTransfer));
2745
2746 pTransferCtx->ChangedEventData.fRegistered = fRegistered;
2747 pTransferCtx->ChangedEventData.pTransfer = pTransfer;
2748
2749 return RTSemEventSignal(pTransferCtx->ChangedEvent);
2750}
2751
2752/**
2753 * Returns a specific clipboard transfer, internal version.
2754 *
2755 * @returns Clipboard transfer found, or NULL if not found.
2756 * @param pTransferCtx Transfer context to return transfer for.
2757 * @param idTransfer ID of the transfer to return.
2758 *
2759 * @note Caller needs to take critical section.
2760 */
2761static PSHCLTRANSFER shClTransferCtxGetTransferByIdInternal(PSHCLTRANSFERCTX pTransferCtx, SHCLTRANSFERID idTransfer)
2762{
2763 Assert(RTCritSectIsOwner(&pTransferCtx->CritSect));
2764
2765 PSHCLTRANSFER pTransfer;
2766 RTListForEach(&pTransferCtx->List, pTransfer, SHCLTRANSFER, Node) /** @todo Slow, but works for now. */
2767 {
2768 if (pTransfer->State.uID == idTransfer)
2769 return pTransfer;
2770 }
2771
2772 return NULL;
2773}
2774
2775/**
2776 * Returns a specific clipboard transfer by index, internal version.
2777 *
2778 * @returns Clipboard transfer found, or NULL if not found.
2779 * @param pTransferCtx Transfer context to return transfer for.
2780 * @param uIdx Index of the transfer to return.
2781 *
2782 * @note Caller needs to take critical section.
2783 */
2784static PSHCLTRANSFER shClTransferCtxGetTransferByIndexInternal(PSHCLTRANSFERCTX pTransferCtx, uint32_t uIdx)
2785{
2786 Assert(RTCritSectIsOwner(&pTransferCtx->CritSect));
2787
2788 uint32_t idx = 0;
2789
2790 PSHCLTRANSFER pTransfer;
2791 RTListForEach(&pTransferCtx->List, pTransfer, SHCLTRANSFER, Node) /** @todo Slow, but works for now. */
2792 {
2793 if (uIdx == idx)
2794 return pTransfer;
2795 idx++;
2796 }
2797
2798 return NULL;
2799}
2800
2801/**
2802 * Returns a clipboard transfer for a specific transfer ID.
2803 *
2804 * @returns Clipboard transfer found, or NULL if not found.
2805 * @param pTransferCtx Transfer context to return transfer for.
2806 * @param uID ID of the transfer to return.
2807 */
2808PSHCLTRANSFER ShClTransferCtxGetTransferById(PSHCLTRANSFERCTX pTransferCtx, uint32_t uID)
2809{
2810 shClTransferCtxLock(pTransferCtx);
2811
2812 PSHCLTRANSFER const pTransfer = shClTransferCtxGetTransferByIdInternal(pTransferCtx, uID);
2813
2814 shClTransferCtxUnlock(pTransferCtx);
2815
2816 return pTransfer;
2817}
2818
2819/**
2820 * Returns a clipboard transfer for a specific list index.
2821 *
2822 * @returns Clipboard transfer found, or NULL if not found.
2823 * @param pTransferCtx Transfer context to return transfer for.
2824 * @param uIdx List index of the transfer to return.
2825 */
2826PSHCLTRANSFER ShClTransferCtxGetTransferByIndex(PSHCLTRANSFERCTX pTransferCtx, uint32_t uIdx)
2827{
2828 shClTransferCtxLock(pTransferCtx);
2829
2830 PSHCLTRANSFER const pTransfer = shClTransferCtxGetTransferByIndexInternal(pTransferCtx, uIdx);
2831
2832 shClTransferCtxUnlock(pTransferCtx);
2833
2834 return pTransfer;
2835}
2836
2837
2838/**
2839 * Returns the last clipboard transfer registered.
2840 *
2841 * @returns Clipboard transfer found, or NULL if not found.
2842 * @param pTransferCtx Transfer context to return transfer for.
2843 */
2844PSHCLTRANSFER ShClTransferCtxGetTransferLast(PSHCLTRANSFERCTX pTransferCtx)
2845{
2846 shClTransferCtxLock(pTransferCtx);
2847
2848 PSHCLTRANSFER const pTransfer = RTListGetLast(&pTransferCtx->List, SHCLTRANSFER, Node);
2849
2850 shClTransferCtxUnlock(pTransferCtx);
2851
2852 return pTransfer;
2853}
2854
2855/**
2856 * Returns the number of running clipboard transfers for a given transfer context.
2857 *
2858 * @returns Number of running transfers.
2859 * @param pTransferCtx Transfer context to return number for.
2860 */
2861uint32_t ShClTransferCtxGetRunningTransfers(PSHCLTRANSFERCTX pTransferCtx)
2862{
2863 AssertPtrReturn(pTransferCtx, 0);
2864
2865 shClTransferCtxLock(pTransferCtx);
2866
2867 uint32_t const cRunning = pTransferCtx->cRunning;
2868
2869 shClTransferCtxUnlock(pTransferCtx);
2870
2871 return cRunning;
2872}
2873
2874/**
2875 * Returns the number of total clipboard transfers for a given transfer context.
2876 *
2877 * @returns Number of total transfers.
2878 * @param pTransferCtx Transfer context to return number for.
2879 */
2880uint32_t ShClTransferCtxGetTotalTransfers(PSHCLTRANSFERCTX pTransferCtx)
2881{
2882 AssertPtrReturn(pTransferCtx, 0);
2883
2884 shClTransferCtxLock(pTransferCtx);
2885
2886 uint32_t const cTransfers = pTransferCtx->cTransfers;
2887
2888 shClTransferCtxUnlock(pTransferCtx);
2889
2890 return cTransfers;
2891}
2892
2893static int shClTransferCreateIDInternal(PSHCLTRANSFERCTX pTransferCtx, SHCLTRANSFERID *pidTransfer)
2894{
2895 /*
2896 * Pick a random bit as starting point. If it's in use, search forward
2897 * for a free one, wrapping around. We've reserved both the zero'th and
2898 * max-1 IDs.
2899 */
2900 SHCLTRANSFERID idTransfer = RTRandU32Ex(1, VBOX_SHCL_MAX_TRANSFERS - 2);
2901
2902 if (!ASMBitTestAndSet(&pTransferCtx->bmTransferIds[0], idTransfer))
2903 { /* likely */ }
2904 else if (pTransferCtx->cTransfers < VBOX_SHCL_MAX_TRANSFERS - 2 /* First and last are not used */)
2905 {
2906 /* Forward search. */
2907 int iHit = ASMBitNextClear(&pTransferCtx->bmTransferIds[0], VBOX_SHCL_MAX_TRANSFERS, idTransfer);
2908 if (iHit < 0)
2909 iHit = ASMBitFirstClear(&pTransferCtx->bmTransferIds[0], VBOX_SHCL_MAX_TRANSFERS);
2910 AssertLogRelMsgReturn(iHit >= 0, ("Transfer count: %RU16\n", pTransferCtx->cTransfers), VERR_SHCLPB_MAX_TRANSFERS_REACHED);
2911 idTransfer = iHit;
2912 AssertLogRelMsgReturn(!ASMBitTestAndSet(&pTransferCtx->bmTransferIds[0], idTransfer), ("idObject=%#x\n", idTransfer), VERR_INTERNAL_ERROR_2);
2913 }
2914 else
2915 {
2916 LogFunc(("Maximum number of transfers reached (%RU16 transfers)\n", pTransferCtx->cTransfers));
2917 return VERR_SHCLPB_MAX_TRANSFERS_REACHED;
2918 }
2919
2920 *pidTransfer = idTransfer;
2921
2922 return VINF_SUCCESS;
2923}
2924
2925/**
2926 * Creates a new transfer ID for a given transfer context.
2927 *
2928 * @returns VBox status code.
2929 * @retval VERR_SHCLPB_MAX_TRANSFERS_REACHED if the maximum of concurrent transfers is reached.
2930 * @param pTransferCtx Transfer context to create transfer ID for.
2931 * @param pidTransfer Where to return the transfer ID on success.
2932 */
2933int ShClTransferCtxCreateId(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFERID pidTransfer)
2934{
2935 AssertPtrReturn(pTransferCtx, VERR_INVALID_POINTER);
2936 AssertPtrReturn(pidTransfer, VERR_INVALID_POINTER);
2937
2938 shClTransferCtxLock(pTransferCtx);
2939
2940 int rc = shClTransferCreateIDInternal(pTransferCtx, pidTransfer);
2941
2942 shClTransferCtxUnlock(pTransferCtx);
2943
2944 return rc;
2945}
2946
2947/**
2948 * Registers a clipboard transfer with a new transfer ID.
2949 *
2950 * @return VBox status code.
2951 * @retval VERR_SHCLPB_MAX_TRANSFERS_REACHED if the maximum of concurrent transfers is reached.
2952 * @param pTransferCtx Transfer context to register transfer to.
2953 * @param pTransfer Transfer to register. The context takes ownership of the transfer on success.
2954 * @param idTransfer Transfer ID to use for registering the given transfer.
2955 */
2956static int shClTransferCtxTransferRegisterExInternal(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFER pTransfer, SHCLTRANSFERID idTransfer)
2957{
2958 AssertPtrReturn(pTransferCtx, VERR_INVALID_POINTER);
2959 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2960 Assert(idTransfer != NIL_SHCLTRANSFERID);
2961
2962 shClTransferCtxLock(pTransferCtx);
2963
2964 pTransfer->State.uID = idTransfer;
2965
2966 RTListAppend(&pTransferCtx->List, &pTransfer->Node);
2967
2968 pTransferCtx->cTransfers++;
2969
2970 Log2Func(("pTransfer=%p, idTransfer=%RU32 -- now %RU16 transfer(s)\n", pTransfer, idTransfer, pTransferCtx->cTransfers));
2971
2972 shClTransferCtxUnlock(pTransferCtx);
2973
2974 if (pTransfer->Callbacks.pfnOnRegistered)
2975 pTransfer->Callbacks.pfnOnRegistered(&pTransfer->CallbackCtx, pTransferCtx);
2976
2977 LogFlowFuncLeaveRC(VINF_SUCCESS);
2978 return VINF_SUCCESS;
2979}
2980
2981/**
2982 * Registers a clipboard transfer with a transfer context, i.e. allocates a transfer ID.
2983 *
2984 * @return VBox status code.
2985 * @retval VERR_SHCLPB_MAX_TRANSFERS_REACHED if the maximum of concurrent transfers for this context has been reached.
2986 * @param pTransferCtx Transfer context to register transfer to.
2987 * @param pTransfer Transfer to register. The context takes ownership of the transfer on success.
2988 * @param pidTransfer Where to return the transfer ID on success. Optional.
2989 */
2990int ShClTransferCtxRegister(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFER pTransfer, PSHCLTRANSFERID pidTransfer)
2991{
2992 AssertPtrReturn(pTransferCtx, VERR_INVALID_POINTER);
2993 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
2994
2995 shClTransferCtxLock(pTransferCtx);
2996
2997 SHCLTRANSFERID idTransfer;
2998 int rc = shClTransferCreateIDInternal(pTransferCtx, &idTransfer);
2999 if (RT_SUCCESS(rc))
3000 {
3001 rc = shClTransferCtxTransferRegisterExInternal(pTransferCtx, pTransfer, idTransfer);
3002 if (RT_SUCCESS(rc))
3003 {
3004 if (pidTransfer)
3005 *pidTransfer = idTransfer;
3006 }
3007 }
3008
3009 shClTransferCtxUnlock(pTransferCtx);
3010
3011 return rc;
3012}
3013
3014/**
3015 * Registers a clipboard transfer with a transfer context by specifying an ID for the transfer.
3016 *
3017 * @return VBox status code.
3018 * @retval VERR_ALREADY_EXISTS if a transfer with the given ID already exists.
3019 * @retval VERR_SHCLPB_MAX_TRANSFERS_REACHED if the maximum of concurrent transfers for this context has been reached.
3020 * @param pTransferCtx Transfer context to register transfer to.
3021 * @param pTransfer Transfer to register.
3022 * @param idTransfer Transfer ID to use for registration.
3023 *
3024 * @note This function ASSUMES you have created \a idTransfer with ShClTransferCtxCreateId().
3025 */
3026int ShClTransferCtxRegisterById(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFER pTransfer, SHCLTRANSFERID idTransfer)
3027{
3028 shClTransferCtxLock(pTransferCtx);
3029
3030 if (pTransferCtx->cTransfers < VBOX_SHCL_MAX_TRANSFERS - 2 /* First and last are not used */)
3031 {
3032 RTListAppend(&pTransferCtx->List, &pTransfer->Node);
3033
3034 shClTransferLock(pTransfer);
3035
3036 pTransfer->State.uID = idTransfer;
3037
3038 shClTransferUnlock(pTransfer);
3039
3040 int rc = shClTransferCtxSignal(pTransferCtx, true /* fRegistered */, pTransfer);
3041
3042 pTransferCtx->cTransfers++;
3043
3044 LogFunc(("Registered transfer ID %RU16 -- now %RU16 transfers total\n", idTransfer, pTransferCtx->cTransfers));
3045
3046 shClTransferCtxUnlock(pTransferCtx);
3047
3048 if (pTransfer->Callbacks.pfnOnRegistered)
3049 pTransfer->Callbacks.pfnOnRegistered(&pTransfer->CallbackCtx, pTransferCtx);
3050
3051 return rc;
3052 }
3053
3054 LogFunc(("Maximum number of transfers reached (%RU16 transfers)\n", pTransferCtx->cTransfers));
3055
3056 shClTransferCtxUnlock(pTransferCtx);
3057
3058 return VERR_SHCLPB_MAX_TRANSFERS_REACHED;
3059}
3060
3061/**
3062 * Removes and unregisters a transfer from a transfer context.
3063 *
3064 * @param pTransferCtx Transfer context to remove transfer from.
3065 * @param pTransfer Transfer to remove.
3066 *
3067 * @note Caller needs to take critical section.
3068 */
3069static void shclTransferCtxTransferRemoveAndUnregister(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFER pTransfer)
3070{
3071 Assert(RTCritSectIsOwner(&pTransferCtx->CritSect));
3072
3073 RTListNodeRemove(&pTransfer->Node);
3074
3075 Assert(pTransferCtx->cTransfers);
3076 pTransferCtx->cTransfers--;
3077
3078 Assert(pTransferCtx->cTransfers >= pTransferCtx->cRunning);
3079
3080 shClTransferCtxUnlock(pTransferCtx);
3081
3082 if (pTransfer->Callbacks.pfnOnUnregistered)
3083 pTransfer->Callbacks.pfnOnUnregistered(&pTransfer->CallbackCtx, pTransferCtx);
3084
3085 shClTransferCtxLock(pTransferCtx);
3086
3087 LogFlowFunc(("Now %RU32 transfers left\n", pTransferCtx->cTransfers));
3088}
3089
3090/**
3091 * Unregisters a transfer from an transfer context, given by its ID.
3092 *
3093 * @retval VINF_SUCCESS on success.
3094 * @retval VERR_NOT_FOUND if the transfer ID was not found.
3095 * @param pTransferCtx Transfer context to unregister transfer from.
3096 * @param idTransfer Transfer ID to unregister.
3097 */
3098int ShClTransferCtxUnregisterById(PSHCLTRANSFERCTX pTransferCtx, SHCLTRANSFERID idTransfer)
3099{
3100 AssertPtrReturn(pTransferCtx, VERR_INVALID_POINTER);
3101 AssertReturn(idTransfer, VERR_INVALID_PARAMETER);
3102
3103 shClTransferCtxLock(pTransferCtx);
3104
3105 int rc = VINF_SUCCESS;
3106
3107 LogFlowFunc(("idTransfer=%RU32\n", idTransfer));
3108
3109 if (ASMBitTestAndClear(&pTransferCtx->bmTransferIds, idTransfer), ("idTransfer=%#x\n", idTransfer))
3110 {
3111 PSHCLTRANSFER pTransfer = shClTransferCtxGetTransferByIdInternal(pTransferCtx, idTransfer);
3112 if (pTransfer)
3113 {
3114 shclTransferCtxTransferRemoveAndUnregister(pTransferCtx, pTransfer);
3115
3116 rc = shClTransferCtxSignal(pTransferCtx, false /* fRegistered */, pTransfer);
3117 }
3118 }
3119 else
3120 rc = VERR_NOT_FOUND;
3121
3122 shClTransferCtxUnlock(pTransferCtx);
3123
3124 LogFlowFuncLeaveRC(rc);
3125 return rc;
3126}
3127
3128/**
3129 * Waits for a transfer context event.
3130 *
3131 * @returns VBox status code.
3132 * @param pTransferCtx Transfer context to wait for.
3133 * @param msTimeout Timeout (in ms) to wait.
3134 * @param pEvent Where to return the event data on success.
3135 */
3136static int shClTransferCtxWaitInternal(PSHCLTRANSFERCTX pTransferCtx, RTMSINTERVAL msTimeout, PSHCLTRANSFERCTXEVENT pEvent)
3137{
3138 LogFlowFunc(("Waiting for transfer context change (%RU32 timeout) ...\n", msTimeout));
3139
3140 int rc = RTSemEventWait(pTransferCtx->ChangedEvent, msTimeout);
3141 if (RT_SUCCESS(rc))
3142 {
3143 shClTransferCtxLock(pTransferCtx);
3144
3145 memcpy(pEvent, &pTransferCtx->ChangedEventData, sizeof(SHCLTRANSFERCTXEVENT));
3146
3147 shClTransferCtxUnlock(pTransferCtx);
3148 }
3149
3150 LogFlowFuncLeaveRC(rc);
3151 return rc;
3152}
3153
3154/**
3155 * Waits for transfer to be (un-)registered.
3156 *
3157 * @returns VBox status code.
3158 * @param pTransferCtx Transfer context to wait for.
3159 * @param msTimeout Timeout (in ms) to wait.
3160 * @param fRegister Pass \c true for registering, or \c false for unregistering a transfer.
3161 * @param idTransfer Transfer ID to wait for.
3162 * Pass NIL_SHCLTRANSFERID for any transfer.
3163 * @param ppTransfer Where to return the transfer being (un-)registered. Optional and can be NULL.
3164 */
3165int ShClTransferCtxWait(PSHCLTRANSFERCTX pTransferCtx, RTMSINTERVAL msTimeout, bool fRegister, SHCLTRANSFERID idTransfer,
3166 PSHCLTRANSFER *ppTransfer)
3167{
3168 AssertPtrReturn(pTransferCtx, VERR_INVALID_POINTER);
3169
3170 int rc = VERR_TIMEOUT;
3171
3172 uint64_t const tsStartMs = RTTimeMilliTS();
3173 uint64_t msLeft = msTimeout;
3174 for (;;)
3175 {
3176 SHCLTRANSFERCTXEVENT Event;
3177 rc = shClTransferCtxWaitInternal(pTransferCtx, msLeft, &Event);
3178 if (RT_FAILURE(rc))
3179 break;
3180
3181 shClTransferCtxLock(pTransferCtx);
3182
3183 if (Event.fRegistered == fRegister)
3184 {
3185 if ( idTransfer != NIL_SHCLTRANSFERID
3186 && Event.pTransfer
3187 && ShClTransferGetID(Event.pTransfer) == idTransfer)
3188 {
3189 if (ppTransfer)
3190 *ppTransfer = Event.pTransfer;
3191 rc = VINF_SUCCESS;
3192 }
3193 }
3194
3195 shClTransferCtxUnlock(pTransferCtx);
3196
3197 if (RT_SUCCESS(rc))
3198 break;
3199
3200 msLeft -= RT_MIN(msLeft, RTTimeMilliTS() - tsStartMs);
3201 if (msLeft == 0)
3202 break;
3203 }
3204
3205 LogFlowFuncLeaveRC(rc);
3206 return rc;
3207}
3208
3209/**
3210 * Cleans up all associated transfers which are not needed (anymore).
3211 * This can be due to transfers which only have been announced but not / never being run.
3212 *
3213 * @param pTransferCtx Transfer context to cleanup transfers for.
3214 */
3215void ShClTransferCtxCleanup(PSHCLTRANSFERCTX pTransferCtx)
3216{
3217 AssertPtrReturnVoid(pTransferCtx);
3218
3219 shClTransferCtxLock(pTransferCtx);
3220
3221 LogFlowFunc(("pTransferCtx=%p, cTransfers=%RU16 cRunning=%RU16\n",
3222 pTransferCtx, pTransferCtx->cTransfers, pTransferCtx->cRunning));
3223
3224 if (pTransferCtx->cTransfers == 0)
3225 {
3226 shClTransferCtxUnlock(pTransferCtx);
3227 return;
3228 }
3229
3230 /* Remove all transfers which are not in a running state (e.g. only announced). */
3231 PSHCLTRANSFER pTransfer, pTransferNext;
3232 RTListForEachSafe(&pTransferCtx->List, pTransfer, pTransferNext, SHCLTRANSFER, Node)
3233 {
3234 shClTransferLock(pTransfer);
3235
3236 SHCLTRANSFERSTATUS const enmStatus = shClTransferGetStatusLocked(pTransfer);
3237 LogFlowFunc(("\tTransfer #%RU16: %s\n", pTransfer->State.uID, ShClTransferStatusToStr(enmStatus)));
3238
3239 if (enmStatus != SHCLTRANSFERSTATUS_STARTED)
3240 {
3241 shClTransferUnlock(pTransfer);
3242
3243 shclTransferCtxTransferRemoveAndUnregister(pTransferCtx, pTransfer);
3244 ShClTransferDestroy(pTransfer);
3245 }
3246 else
3247 shClTransferUnlock(pTransfer);
3248 }
3249
3250 shClTransferCtxUnlock(pTransferCtx);
3251}
3252
3253/**
3254 * Returns whether the maximum of concurrent transfers of a specific transfer contexthas been reached or not.
3255 *
3256 * @returns \c if maximum has been reached, \c false if not.
3257 * @param pTransferCtx Transfer context to determine value for.
3258 */
3259bool ShClTransferCtxIsMaximumReached(PSHCLTRANSFERCTX pTransferCtx)
3260{
3261 AssertPtrReturn(pTransferCtx, true);
3262
3263 shClTransferCtxLock(pTransferCtx);
3264
3265 LogFlowFunc(("cRunning=%RU32, cMaxRunning=%RU32\n", pTransferCtx->cRunning, pTransferCtx->cMaxRunning));
3266
3267 Assert(pTransferCtx->cRunning <= pTransferCtx->cMaxRunning);
3268 bool const fMaximumReached = pTransferCtx->cRunning == pTransferCtx->cMaxRunning;
3269
3270 shClTransferCtxUnlock(pTransferCtx);
3271
3272 return fMaximumReached;
3273}
3274
3275/**
3276 * Copies file system objinfo from IPRT to Shared Clipboard format.
3277 *
3278 * @return VBox status code.
3279 * @param pDst The Shared Clipboard structure to convert data to.
3280 * @param pSrc The IPRT structure to convert data from.
3281 */
3282int ShClFsObjInfoFromIPRT(PSHCLFSOBJINFO pDst, PCRTFSOBJINFO pSrc)
3283{
3284 AssertPtrReturn(pDst, VERR_INVALID_POINTER);
3285 AssertPtrReturn(pSrc, VERR_INVALID_POINTER);
3286
3287 pDst->cbObject = pSrc->cbObject;
3288 pDst->cbAllocated = pSrc->cbAllocated;
3289 pDst->AccessTime = pSrc->AccessTime;
3290 pDst->ModificationTime = pSrc->ModificationTime;
3291 pDst->ChangeTime = pSrc->ChangeTime;
3292 pDst->BirthTime = pSrc->BirthTime;
3293 pDst->Attr.fMode = pSrc->Attr.fMode;
3294 /* Clear bits which we don't pass through for security reasons. */
3295 pDst->Attr.fMode &= ~(RTFS_UNIX_ISUID | RTFS_UNIX_ISGID | RTFS_UNIX_ISTXT);
3296 RT_ZERO(pDst->Attr.u);
3297 switch (pSrc->Attr.enmAdditional)
3298 {
3299 default:
3300 RT_FALL_THROUGH();
3301 case RTFSOBJATTRADD_NOTHING:
3302 pDst->Attr.enmAdditional = SHCLFSOBJATTRADD_NOTHING;
3303 break;
3304
3305 case RTFSOBJATTRADD_UNIX:
3306 pDst->Attr.enmAdditional = SHCLFSOBJATTRADD_UNIX;
3307 pDst->Attr.u.Unix.uid = pSrc->Attr.u.Unix.uid;
3308 pDst->Attr.u.Unix.gid = pSrc->Attr.u.Unix.gid;
3309 pDst->Attr.u.Unix.cHardlinks = pSrc->Attr.u.Unix.cHardlinks;
3310 pDst->Attr.u.Unix.INodeIdDevice = pSrc->Attr.u.Unix.INodeIdDevice;
3311 pDst->Attr.u.Unix.INodeId = pSrc->Attr.u.Unix.INodeId;
3312 pDst->Attr.u.Unix.fFlags = pSrc->Attr.u.Unix.fFlags;
3313 pDst->Attr.u.Unix.GenerationId = pSrc->Attr.u.Unix.GenerationId;
3314 pDst->Attr.u.Unix.Device = pSrc->Attr.u.Unix.Device;
3315 break;
3316
3317 case RTFSOBJATTRADD_EASIZE:
3318 pDst->Attr.enmAdditional = SHCLFSOBJATTRADD_EASIZE;
3319 pDst->Attr.u.EASize.cb = pSrc->Attr.u.EASize.cb;
3320 break;
3321 }
3322
3323 return VINF_SUCCESS;
3324}
3325
3326/**
3327 * Queries local file system information from a given path.
3328 *
3329 * @returns VBox status code.
3330 * @param pszPath Path to query file system information for.
3331 * @param pObjInfo Where to return the queried file system information on success.
3332 */
3333int ShClFsObjInfoQueryLocal(const char *pszPath, PSHCLFSOBJINFO pObjInfo)
3334{
3335 RTFSOBJINFO objInfo;
3336 int rc = RTPathQueryInfo(pszPath, &objInfo,
3337#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
3338 RTFSOBJATTRADD_NOTHING
3339#else
3340 RTFSOBJATTRADD_UNIX
3341#endif
3342 );
3343 if (RT_SUCCESS(rc))
3344 rc = ShClFsObjInfoFromIPRT(pObjInfo, &objInfo);
3345
3346 return rc;
3347}
3348
3349/**
3350 * Translates a clipboard transfer status (SHCLTRANSFERSTATUS_XXX) into a string.
3351 *
3352 * @returns Transfer status string name.
3353 * @param enmStatus The transfer status to translate.
3354 */
3355const char *ShClTransferStatusToStr(SHCLTRANSFERSTATUS enmStatus)
3356{
3357 switch (enmStatus)
3358 {
3359 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_NONE);
3360 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_REQUESTED);
3361 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_INITIALIZED);
3362 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_UNINITIALIZED);
3363 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_STARTED);
3364 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_COMPLETED);
3365 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_CANCELED);
3366 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_KILLED);
3367 RT_CASE_RET_STR(SHCLTRANSFERSTATUS_ERROR);
3368 }
3369 return "Unknown";
3370}
3371
3372/**
3373 * Validates whether a given path matches our set of rules or not.
3374 *
3375 * @returns VBox status code.
3376 * @param pcszPath Path to validate.
3377 * @param fMustExist Whether the path to validate also must exist.
3378 */
3379int ShClTransferValidatePath(const char *pcszPath, bool fMustExist)
3380{
3381 int rc = VINF_SUCCESS;
3382
3383 if (!strlen(pcszPath))
3384 rc = VERR_INVALID_PARAMETER;
3385
3386 if ( RT_SUCCESS(rc)
3387 && !RTStrIsValidEncoding(pcszPath))
3388 {
3389 rc = VERR_INVALID_UTF8_ENCODING;
3390 }
3391
3392 if ( RT_SUCCESS(rc)
3393 && RTStrStr(pcszPath, ".."))
3394 {
3395 rc = VERR_INVALID_PARAMETER;
3396 }
3397
3398 if ( RT_SUCCESS(rc)
3399 && fMustExist)
3400 {
3401 RTFSOBJINFO objInfo;
3402 rc = RTPathQueryInfo(pcszPath, &objInfo, RTFSOBJATTRADD_NOTHING);
3403 if (RT_SUCCESS(rc))
3404 {
3405 if (RTFS_IS_DIRECTORY(objInfo.Attr.fMode))
3406 {
3407 if (!RTDirExists(pcszPath)) /* Path must exist. */
3408 rc = VERR_PATH_NOT_FOUND;
3409 }
3410 else if (RTFS_IS_FILE(objInfo.Attr.fMode))
3411 {
3412 if (!RTFileExists(pcszPath)) /* File must exist. */
3413 rc = VERR_FILE_NOT_FOUND;
3414 }
3415 else /* Everything else (e.g. symbolic links) are not supported. */
3416 {
3417 LogRelMax(64, ("Shared Clipboard: Path '%s' contains a symbolic link or junction, which are not supported\n", pcszPath));
3418 rc = VERR_NOT_SUPPORTED;
3419 }
3420 }
3421 }
3422
3423 if (RT_FAILURE(rc))
3424 LogRelMax(64, ("Shared Clipboard: Validating path '%s' failed: %Rrc\n", pcszPath, rc));
3425
3426 LogFlowFuncLeaveRC(rc);
3427 return rc;
3428}
3429
3430/**
3431 * Resolves a relative path of a specific transfer to its absolute path.
3432 *
3433 * @returns VBox status code.
3434 * @param pTransfer Clipboard transfer to resolve path for.
3435 * @param pszPath Relative path to resolve.
3436 * Paths have to end with a (back-)slash, otherwise this is considered to be a file.
3437 * @param fFlags Resolve flags. Currently not used and must be 0.
3438 * @param ppszResolved Where to store the allocated resolved path. Must be free'd by the called using RTStrFree().
3439 */
3440int ShClTransferResolvePathAbs(PSHCLTRANSFER pTransfer, const char *pszPath, uint32_t fFlags, char **ppszResolved)
3441{
3442 AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
3443 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
3444 AssertReturn (fFlags == 0, VERR_INVALID_PARAMETER);
3445 AssertPtrReturn(ppszResolved, VERR_INVALID_POINTER);
3446
3447 LogFlowFunc(("pszPath=%s, fFlags=%#x (pszPathRootAbs=%s, cRootListEntries=%RU64)\n",
3448 pszPath, fFlags, pTransfer->pszPathRootAbs, pTransfer->lstRoots.Hdr.cEntries));
3449
3450 int rc = ShClTransferValidatePath(pszPath, false /* fMustExist */);
3451 if (RT_SUCCESS(rc))
3452 {
3453 rc = VERR_PATH_NOT_FOUND; /* Play safe by default. */
3454
3455 PSHCLLISTENTRY pEntry;
3456 RTListForEach(&pTransfer->lstRoots.lstEntries, pEntry, SHCLLISTENTRY, Node)
3457 {
3458 LogFlowFunc(("\tpEntry->pszName=%s\n", pEntry->pszName));
3459
3460 if (RTStrStartsWith(pszPath, pEntry->pszName)) /* Case-sensitive! */
3461 {
3462 rc = VINF_SUCCESS;
3463 break;
3464 }
3465 }
3466
3467 if (RT_SUCCESS(rc))
3468 {
3469 char *pszPathAbs = RTPathJoinA(pTransfer->pszPathRootAbs, pszPath);
3470 if (pszPathAbs)
3471 {
3472 char szResolved[RTPATH_MAX];
3473 size_t cbResolved = sizeof(szResolved);
3474 rc = RTPathAbsEx(pTransfer->pszPathRootAbs, pszPathAbs, RTPATH_STR_F_STYLE_HOST, szResolved, &cbResolved);
3475
3476 RTStrFree(pszPathAbs);
3477 pszPathAbs = NULL;
3478
3479 if (RT_SUCCESS(rc))
3480 {
3481 LogRel2(("Shared Clipboard: Resolved: '%s' -> '%s'\n", pszPath, szResolved));
3482
3483 *ppszResolved = RTStrDup(szResolved);
3484 }
3485 }
3486 else
3487 rc = VERR_NO_MEMORY;
3488 }
3489 }
3490
3491 if (RT_FAILURE(rc))
3492 LogRel(("Shared Clipboard: Resolving absolute path for '%s' failed, rc=%Rrc\n", pszPath, rc));
3493
3494 LogFlowFuncLeaveRC(rc);
3495 return rc;
3496}
3497
3498/**
3499 * Converts Shared Clipboard create flags (see SharedClipboard-transfers.h) into IPRT create flags.
3500 *
3501 * @returns IPRT status code.
3502 * @param fShClFlags Shared clipboard create flags.
3503 * @param[out] pfOpen Where to store the RTFILE_O_XXX flags for
3504 * RTFileOpen.
3505 *
3506 * @sa Initially taken from vbsfConvertFileOpenFlags().
3507 */
3508int ShClTransferConvertFileCreateFlags(uint32_t fShClFlags, uint64_t *pfOpen)
3509{
3510 AssertMsgReturnStmt(!(fShClFlags & ~SHCL_OBJ_CF_VALID_MASK), ("%#x4\n", fShClFlags), *pfOpen = 0, VERR_INVALID_FLAGS);
3511
3512 uint64_t fOpen = 0;
3513
3514 switch (fShClFlags & SHCL_OBJ_CF_ACCESS_MASK_RW)
3515 {
3516 case SHCL_OBJ_CF_ACCESS_NONE:
3517 {
3518#ifdef RT_OS_WINDOWS
3519 if ((fShClFlags & SHCL_OBJ_CF_ACCESS_MASK_ATTR) != SHCL_OBJ_CF_ACCESS_ATTR_NONE)
3520 fOpen |= RTFILE_O_OPEN | RTFILE_O_ATTR_ONLY;
3521 else
3522#endif
3523 fOpen |= RTFILE_O_OPEN | RTFILE_O_READ;
3524 LogFlowFunc(("SHCL_OBJ_CF_ACCESS_NONE\n"));
3525 break;
3526 }
3527
3528 case SHCL_OBJ_CF_ACCESS_READ:
3529 {
3530 fOpen |= RTFILE_O_OPEN | RTFILE_O_READ;
3531 LogFlowFunc(("SHCL_OBJ_CF_ACCESS_READ\n"));
3532 break;
3533 }
3534
3535 default:
3536 AssertFailedReturn(VERR_IPE_NOT_REACHED_DEFAULT_CASE);
3537 }
3538
3539 switch (fShClFlags & SHCL_OBJ_CF_ACCESS_MASK_ATTR)
3540 {
3541 case SHCL_OBJ_CF_ACCESS_ATTR_NONE:
3542 {
3543 fOpen |= RTFILE_O_ACCESS_ATTR_DEFAULT;
3544 LogFlowFunc(("SHCL_OBJ_CF_ACCESS_ATTR_NONE\n"));
3545 break;
3546 }
3547
3548 case SHCL_OBJ_CF_ACCESS_ATTR_READ:
3549 {
3550 fOpen |= RTFILE_O_ACCESS_ATTR_READ;
3551 LogFlowFunc(("SHCL_OBJ_CF_ACCESS_ATTR_READ\n"));
3552 break;
3553 }
3554
3555 default:
3556 AssertFailedReturn(VERR_IPE_NOT_REACHED_DEFAULT_CASE);
3557 }
3558
3559 /* Sharing mask */
3560 switch (fShClFlags & SHCL_OBJ_CF_ACCESS_MASK_DENY)
3561 {
3562 case SHCL_OBJ_CF_ACCESS_DENYNONE:
3563 fOpen |= RTFILE_O_DENY_NONE;
3564 LogFlowFunc(("SHCL_OBJ_CF_ACCESS_DENYNONE\n"));
3565 break;
3566
3567 case SHCL_OBJ_CF_ACCESS_DENYWRITE:
3568 fOpen |= RTFILE_O_DENY_WRITE;
3569 LogFlowFunc(("SHCL_OBJ_CF_ACCESS_DENYWRITE\n"));
3570 break;
3571
3572 default:
3573 AssertFailedReturn(VERR_IPE_NOT_REACHED_DEFAULT_CASE);
3574 }
3575
3576 *pfOpen = fOpen;
3577
3578 LogFlowFuncLeaveRC(VINF_SUCCESS);
3579 return VINF_SUCCESS;
3580}
3581
注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

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