Changeset 102654 in vbox

Timestamp:

Dec 20, 2023 4:10:26 PM (13 months ago)

Author:

vboxsync

Message:

Guest Control: Implemented IGuestSession::getMountPoints. bugref:10415

Location:

trunk

Files:

• include/VBox/HostServices/GuestControlSvc.h (modified) (2 diffs)
• include/VBox/VBoxGuestLib.h (modified) (1 diff)
• src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR3LibGuestCtrl.cpp (modified) (4 diffs)
• src/VBox/Additions/common/VBoxService/VBoxServiceControlSession.cpp (modified) (2 diffs)
• src/VBox/HostServices/GuestControl/VBoxGuestControlSvc.cpp (modified) (1 diff)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (2 diffs)
• src/VBox/Main/include/GuestCtrlImplPrivate.h (modified) (1 diff)
• src/VBox/Main/include/GuestSessionImpl.h (modified) (2 diffs)
• src/VBox/Main/src-client/GuestSessionImpl.cpp (modified) (2 diffs)

trunk/include/VBox/HostServices/GuestControlSvc.h

@@ -273 +273 @@
     HOST_MSG_FS_QUERY_INFO = 336,
 #endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
+    /**
+     * Retrieves the currently accessible mount points from the guest.
+     *
+     * @since   7.1
+     */
+    HOST_MSG_MOUNT_POINTS = 337,
     /** Blow the type up to 32-bits. */
     HOST_MSG_32BIT_HACK = 0x7fffffff
@@ -324 +330 @@
         RT_CASE_RET_STR(HOST_MSG_FS_QUERY_INFO);
 #endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
+        RT_CASE_RET_STR(HOST_MSG_MOUNT_POINTS);
         RT_CASE_RET_STR(HOST_MSG_32BIT_HACK);
     }

trunk/include/VBox/VBoxGuestLib.h

@@ -1091 +1091 @@
 VBGLR3DECL(int) VbglR3GuestCtrlPathGetUserDocuments(PVBGLR3GUESTCTRLCMDCTX pCtx);
 VBGLR3DECL(int) VbglR3GuestCtrlPathGetUserHome(PVBGLR3GUESTCTRLCMDCTX pCtx);
+VBGLR3DECL(int) VbglR3GuestCtrlGetMountPoints(PVBGLR3GUESTCTRLCMDCTX pCtx);
 #  ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
 /** @name Guest Control file system functions.

trunk/src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR3LibGuestCtrl.cpp

@@ -1175 +1175 @@
 /**
  * Retrieves a HOST_PATH_RENAME message.
+ *
+ * @returns VBox status code.
+ * @param   pCtx                Guest control command context to use.
+ * @param   pszSource           Where to return the source path.
+ * @param   cbSource            Size (in bytes) of \a pszSource.
+ * @param   pszDest             Where to return the destination path.
+ * @param   cbDest              Size (in bytes) of \a pszDest.
+ * @param   pfFlags             Where to return the rename flags.
  */
 VBGLR3DECL(int) VbglR3GuestCtrlPathGetRename(PVBGLR3GUESTCTRLCMDCTX     pCtx,
@@ -1214 +1222 @@
 /**
  * Retrieves a HOST_PATH_USER_DOCUMENTS message.
+ *
+ * @param   pCtx                Guest control command context to use.
  */
 VBGLR3DECL(int) VbglR3GuestCtrlPathGetUserDocuments(PVBGLR3GUESTCTRLCMDCTX pCtx)
@@ -1237 +1247 @@
 /**
  * Retrieves a HOST_PATH_USER_HOME message.
+ *
+ * @param   pCtx                Guest control command context to use.
  */
 VBGLR3DECL(int) VbglR3GuestCtrlPathGetUserHome(PVBGLR3GUESTCTRLCMDCTX pCtx)
@@ -1249 +1261 @@
         VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
         VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_PATH_USER_HOME);
+
+        rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
+        if (RT_SUCCESS(rc))
+            Msg.context.GetUInt32(&pCtx->uContextID);
+    } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
+    return rc;
+}
+
+
+/**
+ * Retrieves a HOST_MSG_MOUNT_POINTS message.
+ *
+ * @param   pCtx                Guest control command context to use.
+ */
+VBGLR3DECL(int) VbglR3GuestCtrlGetMountPoints(PVBGLR3GUESTCTRLCMDCTX pCtx)
+{
+    AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
+    AssertReturn(pCtx->uNumParms == 1, VERR_INVALID_PARAMETER);
+
+    int rc;
+    do
+    {
+        HGCMMsgPathUserHome Msg;
+        VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
+        VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_MOUNT_POINTS);
 
         rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));

trunk/src/VBox/Additions/common/VBoxService/VBoxServiceControlSession.cpp

@@ -1707 +1707 @@
 
 /**
+ * Structure for keeping a mount point enumeration context.
+ */
+typedef struct VGSVCMOUNTPOINTENUMCTX
+{
+    /** Mount points as strings, delimited with a string terminator ('\0').
+     *  List ends with an additional string terminator. Might get re-allocated, so don't rely on this pointer! */
+    char  *psz;
+    /** Current size of \a psz in bytes. Includes ending terminator. */
+    size_t cb;
+    /** Total allocation Size of \a psz in bytes. */
+    size_t cbAlloc;
+} VGSVCMOUNTPOINTENUMCTX;
+/** Pointer to a structure for keeping a mount point enumeration context. */
+typedef VGSVCMOUNTPOINTENUMCTX *PVGSVCMOUNTPOINTENUMCTX;
+
+/**
+ * Enumeration callback for storing the mount points.
+ *
+ * @returns VBox status code.
+ * @param   pszMountpoint       Mount point to handle.
+ * @param   pvUser              Pointer of type PVGSVCMOUNTPOINTENUMCTX.
+ */
+DECLCALLBACK(int) vgsvcGstCtrlSessionHandleMountPointsEnumCallback(const char *pszMountpoint, void *pvUser)
+{
+    PVGSVCMOUNTPOINTENUMCTX pCtx = (PVGSVCMOUNTPOINTENUMCTX)pvUser;
+    AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
+
+    size_t const cch = strlen(pszMountpoint) + 1 /* Entry terminator */;
+    AssertReturn(cch < RTPATH_MAX, VERR_INVALID_PARAMETER); /* Paranoia. */
+    if (cch > pCtx->cbAlloc - pCtx->cb - 1 /* Ending terminator */)
+    {
+        char *pszNew;
+        int rc2 = RTStrRealloc(&pszNew, pCtx->cbAlloc + RT_MAX(_4K, cch));
+        AssertRCReturn(rc2, rc2);
+        pCtx->psz = pszNew;
+    }
+
+    memcpy(&pCtx->psz[pCtx->cb], pszMountpoint, cch);
+    pCtx->cb += cch;
+    AssertReturn(pCtx->cb <= pCtx->cbAlloc, VERR_BUFFER_OVERFLOW); /* Paranoia. */
+
+    return VINF_SUCCESS;
+}
+
+/**
+ * Handles getting the current mount points.
+ *
+ * @returns VBox status code.
+ * @param   pSession        Guest session.
+ * @param   pHostCtx        Host context.
+ */
+static int vgsvcGstCtrlSessionHandleMountPoints(PVBOXSERVICECTRLSESSION pSession, PVBGLR3GUESTCTRLCMDCTX pHostCtx)
+{
+    AssertPtrReturn(pSession, VERR_INVALID_POINTER);
+    AssertPtrReturn(pHostCtx, VERR_INVALID_POINTER);
+
+    /*
+     * Retrieve the request.
+     */
+    int rc = VbglR3GuestCtrlGetMountPoints(pHostCtx);
+    if (RT_SUCCESS(rc))
+    {
+        VGSVCMOUNTPOINTENUMCTX Ctx;
+        Ctx.cb      = 0;
+        Ctx.cbAlloc = _4K; /* Start with something sensible. */
+        Ctx.psz     = RTStrAlloc(Ctx.cbAlloc);
+        if (!Ctx.psz)
+            rc = VERR_NO_MEMORY;
+
+        if (RT_SUCCESS(rc))
+            rc = RTFsMountpointsEnum(vgsvcGstCtrlSessionHandleMountPointsEnumCallback, &Ctx);
+
+        /* Report back in any case. */
+        int rc2 = VbglR3GuestCtrlMsgReplyEx(pHostCtx, rc, 0 /* Type */, Ctx.psz,
+                                            RT_SUCCESS(rc) ? (uint32_t)Ctx.cb : 0);
+        if (RT_FAILURE(rc2))
+        {
+            VGSvcError("Failed to report mount points, rc=%Rrc\n", rc2);
+            if (RT_SUCCESS(rc))
+                rc = rc2;
+        }
+
+        RTStrFree(Ctx.psz);
+        Ctx.psz = NULL;
+    }
+    else
+    {
+        VGSvcError("Error fetching parameters for getting mount points request: %Rrc\n", rc);
+        VbglR3GuestCtrlMsgSkip(pHostCtx->uClientID, rc, UINT32_MAX);
+    }
+    return rc;
+}
+
+
+/**
  * Handles starting a guest processes.
  *
@@ -2450 +2545 @@
             if (fImpersonated)
                 rc = vgsvcGstCtrlSessionHandlePathUserHome(pSession, pHostCtx);
+            break;
+
+        case HOST_MSG_MOUNT_POINTS:
+            if (fImpersonated)
+                rc = vgsvcGstCtrlSessionHandleMountPoints(pSession, pHostCtx);
             break;
 

trunk/src/VBox/HostServices/GuestControl/VBoxGuestControlSvc.cpp

@@ -1680 +1680 @@
                         RT_FALL_THROUGH();
 #endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
+                    case HOST_MSG_MOUNT_POINTS:
+                        RT_FALL_THROUGH();
                     case HOST_MSG_EXEC_GET_OUTPUT: /** @todo BUGBUG This can't be right/work. */
                     case HOST_MSG_EXEC_TERMINATE:  /** @todo BUGBUG This can't be right/work. */

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -15266 +15266 @@
   <interface
     name="IGuestSession" extends="$unknown"
-    uuid="5e54f60b-6dcd-4594-a6c9-cf968f004341"
+    uuid="8b2b6773-8b5a-4cd2-95f8-38faf73913e1"
     wsmap="managed"
     reservedMethods="8" reservedAttributes="12"
@@ -15402 +15402 @@
       <desc>
         Returns the user's documents directory.  Guest path style.
+      </desc>
+    </attribute>
+    <attribute name="mountPoints" type="wstring" readonly="yes" safearray="yes">
+      <desc>
+        Returns all currently accessible (disk-based) mount points.
+        On Windows guests, this returns the currently mapped the disk drives.
+
+        <result name="VBOX_E_NOT_SUPPORTED">If the Guest Additions does not
+          support this feature.</result>
       </desc>
     </attribute>

trunk/src/VBox/Main/include/GuestCtrlImplPrivate.h

@@ -1211 +1211 @@
     }
 
+    /**
+     * Returns the payload as a vector of strings, validated.
+     *
+     * @returns VBox status code.
+     * @param   vecStrings      Where to return the vector of strings on success.
+     */
+    int ToStringVector(std::vector<Utf8Str> &vecStrings)
+    {
+        int vrc = VINF_SUCCESS;
+
+        vecStrings.clear();
+
+        const char *psz = (const char *)pvData;
+        AssertPtrReturn(psz, vrc = VERR_INVALID_PARAMETER);
+        size_t      cb  = cbData;
+        while (cb)
+        {
+            size_t const cch = strlen(psz);
+            if (!cch)
+                break;
+            size_t const cbStr = cch + 1 /* String terminator */;
+            vrc = RTStrValidateEncodingEx(psz, cbStr,
+                                          RTSTR_VALIDATE_ENCODING_ZERO_TERMINATED | RTSTR_VALIDATE_ENCODING_EXACT_LENGTH);
+            if (RT_FAILURE(vrc))
+                break;
+            AssertBreakStmt(cb >= cbStr, vrc = VERR_INVALID_PARAMETER);
+            cb  -= cbStr;
+            psz += cbStr;
+        }
+
+        if (RT_SUCCESS(vrc))
+            AssertStmt(cb <= 1 /* Ending terminator */, vrc = VERR_INVALID_PARAMETER);
+        return vrc;
+    }
+
 protected:
 

trunk/src/VBox/Main/include/GuestSessionImpl.h

@@ -87 +87 @@
     HRESULT getUserDocuments(com::Utf8Str &aUserDocuments);
     HRESULT getUserHome(com::Utf8Str &aUserHome);
+    HRESULT getMountPoints(std::vector<com::Utf8Str> &aMountPoints);
     HRESULT getDirectories(std::vector<ComPtr<IGuestDirectory> > &aDirectories);
     HRESULT getFiles(std::vector<ComPtr<IGuestFile> > &aFiles);
@@ -345 +346 @@
     int                     i_pathRename(const Utf8Str &strSource, const Utf8Str &strDest, uint32_t uFlags, int *pvrcGuest);
     int                     i_pathUserDocuments(Utf8Str &strPath, int *pvrcGuest);
+    int                     i_getMountPoints(std::vector<com::Utf8Str> &vecMountPoints, int *pvrcGuest);
     int                     i_pathUserHome(Utf8Str &strPath, int *pvrcGuest);
     int                     i_processUnregister(GuestProcess *pProcess);

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

@@ -616 +616 @@
             default:
                 hrc = setErrorBoth(VBOX_E_IPRT_ERROR, vrc, tr("Getting the user's documents path failed: %Rrc"), vrc);
+                break;
+        }
+    }
+
+    return hrc;
+}
+
+HRESULT GuestSession::getMountPoints(std::vector<com::Utf8Str> &aMountPoints)
+{
+    HRESULT hrc = i_isStartedExternal();
+    if (FAILED(hrc))
+        return hrc;
+
+    int vrcGuest = VERR_IPE_UNINITIALIZED_STATUS;
+    int vrc = i_getMountPoints(aMountPoints, &vrcGuest);
+    if (RT_FAILURE(vrc))
+    {
+        switch (vrc)
+        {
+            case VERR_GSTCTL_GUEST_ERROR:
+            {
+                switch (vrcGuest)
+                {
+                    case VERR_NOT_SUPPORTED:
+                        hrc = setErrorBoth(VBOX_E_IPRT_ERROR, vrcGuest,
+                                          tr("Getting the mount points is not supported by installed Guest Additions"));
+                        break;
+
+                    default:
+                        hrc = setErrorBoth(VBOX_E_IPRT_ERROR, vrcGuest,
+                                          tr("Getting the mount points failed on the guest: %Rrc"), vrcGuest);
+                        break;
+                }
+                break;
+            }
+
+            default:
+                hrc = setErrorBoth(VBOX_E_IPRT_ERROR, vrc, tr("Getting the mount points failed: %Rrc"), vrc);
                 break;
         }
@@ -3115 +3153 @@
 
 /**
+ * Returns the currently accessible mount points of the guest.
+ *
+ * @returns VBox status code.
+ * @param   vecMountPoints      Where to return the mount points (guest-style paths).
+ * @param   pvrcGuest           Guest VBox status code, when returning
+ *                              VERR_GSTCTL_GUEST_ERROR. Any other return code indicates
+ *                              some host side error.
+ *
+ * @note    Takes the read lock.
+ */
+int GuestSession::i_getMountPoints(std::vector<com::Utf8Str> &vecMountPoints, int *pvrcGuest)
+{
+    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    GuestWaitEvent *pEvent = NULL;
+    int vrc = registerWaitEvent(mData.mSession.mID, mData.mObjectID, &pEvent);
+    if (RT_FAILURE(vrc))
+        return vrc;
+
+    /* Prepare HGCM call. */
+    VBOXHGCMSVCPARM paParms[2];
+    int i = 0;
+    HGCMSvcSetU32(&paParms[i++], pEvent->ContextID());
+
+    alock.release(); /* Drop lock before sending. */
+
+    vrc = i_sendMessage(HOST_MSG_MOUNT_POINTS, i, paParms);
+    if (RT_SUCCESS(vrc))
+    {
+        vrc = pEvent->Wait(30 * 1000);
+        if (RT_SUCCESS(vrc))
+        {
+            vrc = pEvent->Payload().ToStringVector(vecMountPoints);
+        }
+        else
+        {
+            if (pEvent->HasGuestError() && pvrcGuest)
+                *pvrcGuest = pEvent->GuestResult();
+        }
+    }
+
+    unregisterWaitEvent(pEvent);
+
+    LogFlowFuncLeaveRC(vrc);
+    return vrc;
+}
+
+/**
  * Returns the user's absolute home path, if any.
  *