Changeset 78950 in vbox for trunk/src/VBox/Main

Timestamp:

Jun 4, 2019 7:26:56 AM (6 years ago)

Author:

vboxsync

Message:

Shared Clipboard/URI: Update; more work on clipboard area code, documentation.

Location:

trunk/src/VBox/Main

Files:

• src-client/ConsoleImpl.cpp (modified) (4 diffs)
• src-server/VirtualBoxImpl.cpp (modified) (12 diffs)

trunk/src/VBox/Main/src-client/ConsoleImpl.cpp

@@ -8461 +8461 @@
 
             VBOXCLIPBOARDEXTPARMS *pParms = (VBOXCLIPBOARDEXTPARMS *)pvParms;
+            AssertPtr(pParms);
 
             /* The guest announces clipboard formats. This must be delivered to all clients. */
@@ -8476 +8477 @@
 
             VBOXCLIPBOARDEXTPARMS *pParms = (VBOXCLIPBOARDEXTPARMS *)pvParms;
+            AssertPtr(pParms);
 
             /* The clipboard service expects that the pvData buffer will be filled
@@ -8494 +8496 @@
 
             VBOXCLIPBOARDEXTPARMS *pParms = (VBOXCLIPBOARDEXTPARMS *)pvParms;
+            AssertPtr(pParms);
 
             if (pThis->mConsoleVRDPServer)
@@ -8509 +8512 @@
             ULONG uID;
             hrc = pControl->ClipboardAreaRegister(ComSafeArrayAsInParam(abstrParms), &uID);      H();
+            if (SUCCEEDED(hrc))
+            {
+                 PVBOXCLIPBOARDEXTAREAPARMS pParms = (PVBOXCLIPBOARDEXTAREAPARMS)pvParms;
+                 AssertPtr(pParms);
+
+                 /* Return the registered area ID back to the caller. */
+                 pParms->uID = uID;
+            }
         } break;
 

trunk/src/VBox/Main/src-server/VirtualBoxImpl.cpp

@@ -230 +230 @@
 {
     SharedClipboardAreaData()
-        : uID(0) { }
-
-    /** The area's (unique) ID. */
+        : uID(NIL_SHAREDCLIPBOARDAREAID) { }
+
+    /** The area's (unique) ID.
+     *  Set to NIL_SHAREDCLIPBOARDAREAID if not initialized yet. */
     ULONG               uID;
     /** The actual Shared Clipboard area assigned to this ID. */
@@ -247 +248 @@
 {
     SharedClipboardData()
-        : uNextClipboardAreaID(0)
-        , uMaxClipboardAreas(32)
+        : uMostRecentClipboardAreaID(NIL_SHAREDCLIPBOARDAREAID)
+        , uMaxClipboardAreas(32) /** @todo Make this configurable. */
     {
         int rc2 = RTCritSectInit(&CritSect);
@@ -259 +260 @@
     }
 
+    /**
+     * Generates a new clipboard area ID.
+     * Currently does *not* check for collisions and stuff.
+     *
+     * @returns New clipboard area ID.
+     */
+    ULONG GenerateAreaID(void)
+    {
+        ULONG uID = NIL_SHAREDCLIPBOARDAREAID;
+
+        int rc = RTCritSectEnter(&CritSect);
+        if (RT_SUCCESS(rc))
+        {
+            uID = RTRandU32Ex(1, UINT32_MAX - 1); /** @todo Make this a bit more sophisticated. Later. */
+
+            int rc2 = RTCritSectLeave(&CritSect);
+            AssertRC(rc2);
+        }
+
+        LogFlowFunc(("uID=%RU32\n", uID));
+        return uID;
+    }
+
     /** Critical section to serialize access. */
     RTCRITSECT                          CritSect;
-    /** The next (free) clipboard area ID. */
-    ULONG                               uNextClipboardAreaID;
+    /** The most recent (last created) clipboard area ID.
+     *  NIL_SHAREDCLIPBOARDAREAID if not initialized yet. */
+    ULONG                               uMostRecentClipboardAreaID;
     /** Maximum of concurrent clipboard areas.
      *  @todo Make this configurable. */
@@ -3353 +3378 @@
 
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_URI_LIST
+/**
+ * Generates a new clipboard area on the host by opening (and locking) a new, temporary directory.
+ *
+ * @returns HRESULT
+ * @param   AreaData            Area data to use for clipboard area creation.
+ * @param   fFlags              Additional creation flags; currently unused and ignored.
+ */
 int VirtualBox::i_clipboardAreaCreate(SharedClipboardAreaData &AreaData, uint32_t fFlags)
 {
     RT_NOREF(fFlags);
-    int vrc = AreaData.Area.OpenTemp(AreaData.uID);
-    if (RT_SUCCESS(vrc))
-    {
-    }
+    int vrc = AreaData.Area.OpenTemp(AreaData.uID, SHAREDCLIPBOARDAREA_OPEN_FLAGS_MUST_NOT_EXIST);
     LogFlowFunc(("uID=%RU32, rc=%Rrc\n", AreaData.uID, vrc));
     return vrc;
 }
 
+/**
+ * Destroys a formerly created clipboard area.
+ *
+ * @returns HRESULT
+ * @param   AreaData            Area data to use for clipboard area destruction.
+ */
 int VirtualBox::i_clipboardAreaDestroy(SharedClipboardAreaData &AreaData)
 {
@@ -3373 +3408 @@
 }
 
+/**
+ * Registers and creates a new clipboard area on the host (for all VMs), returned the clipboard area ID for it.
+ *
+ * @returns HRESULT
+ * @param   aParms              Creation parameters. Currently unused.
+ * @param   aID                 Where to return the clipboard area ID on success.
+ */
 HRESULT VirtualBox::i_onClipboardAreaRegister(const std::vector<com::Utf8Str> &aParms, ULONG *aID)
 {
@@ -3386 +3428 @@
             if (m->SharedClipboard.mapClipboardAreas.size() >= m->SharedClipboard.uMaxClipboardAreas)
             {
-                const ULONG uAreaID = m->SharedClipboard.uNextClipboardAreaID;
-
-                SharedClipboardAreaData AreaData;
-                AreaData.uID = uAreaID;
-
-                vrc = i_clipboardAreaCreate(AreaData, 0 /* fFlags */);
-                if (RT_SUCCESS(vrc))
+                for (unsigned uTries = 0; uTries < 32; uTries++) /* Don't try too hard. */
                 {
-                    m->SharedClipboard.mapClipboardAreas[uAreaID] = AreaData;
-                    m->SharedClipboard.uNextClipboardAreaID++;
-
-                    /** @todo Implement collision detection / wrap-around. */
-
-                    if (aID)
-                        *aID = uAreaID;
-
-                    LogThisFunc(("Registered new clipboard area %RU32: '%s'\n",
-                                 uAreaID, AreaData.Area.GetDirAbs()));
+                    const ULONG uAreaID = m->SharedClipboard.GenerateAreaID();
+
+                    /* Area ID already taken? */
+                    if (m->SharedClipboard.mapClipboardAreas.find(uAreaID) != m->SharedClipboard.mapClipboardAreas.end())
+                        continue;
+
+                    SharedClipboardAreaData AreaData;
+                    AreaData.uID = uAreaID;
+
+                    vrc = i_clipboardAreaCreate(AreaData, 0 /* fFlags */);
+                    if (RT_SUCCESS(vrc))
+                    {
+                        m->SharedClipboard.mapClipboardAreas[uAreaID] = AreaData;
+                        m->SharedClipboard.uMostRecentClipboardAreaID = uAreaID;
+
+                        /** @todo Implement collision detection / wrap-around. */
+
+                        if (aID)
+                            *aID = uAreaID;
+
+                        LogThisFunc(("Registered new clipboard area %RU32: '%s'\n",
+                                     uAreaID, AreaData.Area.GetDirAbs()));
+                        break;
+                    }
                 }
-                else
+
+                if (RT_FAILURE(vrc))
                     rc = setError(E_FAIL, /** @todo Find a better rc. */
-                                  tr("Failed to create new clipboard area %RU32 (%Rrc)"), aID, vrc);
+                                  tr("Failed to create new clipboard area (%Rrc)"), vrc);
             }
             else
             {
                 rc = setError(E_FAIL, /** @todo Find a better rc. */
-                              tr("Maximum number of conucurrent clipboard areas reached (%RU32)"),
+                              tr("Maximum number of concurrent clipboard areas reached (%RU32)"),
                               m->SharedClipboard.uMaxClipboardAreas);
             }
@@ -3428 +3479 @@
 }
 
+/**
+ * Unregisters (destroys) a formerly created clipboard area.
+ *
+ * @returns HRESULT
+ * @param   aID                 ID of clipboard area to destroy.
+ */
 HRESULT VirtualBox::i_onClipboardAreaUnregister(ULONG aID)
 {
@@ -3461 +3518 @@
 }
 
+/**
+ * Attaches to an existing clipboard area.
+ *
+ * @returns HRESULT
+ * @param   aID                 ID of clipboard area to attach.
+ */
 HRESULT VirtualBox::i_onClipboardAreaAttach(ULONG aID)
 {
@@ -3486 +3549 @@
 }
 
+/**
+ * Detaches from an existing clipboard area.
+ *
+ * @returns HRESULT
+ * @param   aID                 ID of clipboard area to detach from.
+ */
 HRESULT VirtualBox::i_onClipboardAreaDetach(ULONG aID)
 {
@@ -3511 +3580 @@
 }
 
+/**
+ * Returns the ID of the most recent (last created) clipboard area,
+ * or NIL_SHAREDCLIPBOARDAREAID if no clipboard area has been created yet.
+ *
+ * @returns Most recent clipboard area ID.
+ */
 ULONG VirtualBox::i_onClipboardAreaGetMostRecent(void)
 {
@@ -3517 +3592 @@
     if (RT_SUCCESS(vrc2))
     {
-        aID = m->SharedClipboard.uNextClipboardAreaID
-            ? m->SharedClipboard.uNextClipboardAreaID - 1 : 0;
+        aID = m->SharedClipboard.uMostRecentClipboardAreaID;
 
         vrc2 = RTCritSectLeave(&m->SharedClipboard.CritSect);
@@ -3527 +3601 @@
 }
 
+/**
+ * Returns the current reference count of a clipboard area.
+ *
+ * @returns Reference count of given clipboard area ID.
+ */
 ULONG VirtualBox::i_onClipboardAreaGetRefCount(ULONG aID)
 {