Changeset 71314 in vbox for trunk

Timestamp:

Mar 13, 2018 3:51:14 PM (7 years ago)

Author:

vboxsync

Message:

GuestControl: Added and implemented IGuestSession::userHome and IGuestSession::userDocuments attributes. Untested.

Location:

trunk

Files:

• include/VBox/HostServices/GuestControlSvc.h (modified) (2 diffs)
• src/VBox/Additions/common/VBoxService/VBoxServiceControlSession.cpp (modified) (3 diffs)
• 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) (4 diffs)

trunk/include/VBox/HostServices/GuestControlSvc.h

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2011-2017 Oracle Corporation
+ * Copyright (C) 2011-2018 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -193 +193 @@
      * Renames a path on the guest.
      */
-    HOST_PATH_RENAME = 330
+    HOST_PATH_RENAME = 330,
+    /**
+     * Retrieves the user's documents directory.
+     */
+    HOST_PATH_USER_DOCUMENTS = 331,
+    /**
+     * Retrieves the user's home directory.
+     */
+    HOST_PATH_USER_HOME = 332
 };
 

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

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2013-2017 Oracle Corporation
+ * Copyright (C) 2013-2018 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -625 +625 @@
 #ifdef DEBUG
     VGSvcVerbose(4, "Renaming '%s' to '%s' returned rc=%Rrc\n", szSource, szDest, rc);
+#endif
+    return rc;
+}
+
+
+static int vgsvcGstCtrlSessionHandlePathUserDocuments(PVBOXSERVICECTRLSESSION pSession, PVBGLR3GUESTCTRLCMDCTX pHostCtx)
+{
+    AssertPtrReturn(pSession, VERR_INVALID_POINTER);
+    AssertPtrReturn(pHostCtx, VERR_INVALID_POINTER);
+
+    char szPath[RTPATH_MAX];
+    int rc = RTPathUserDocuments(szPath, sizeof(szPath));
+
+    /* Report back in any case. */
+    int rc2 = VbglR3GuestCtrlMsgReplyEx(pHostCtx, rc, 0 /* Type */,
+                                        szPath, strlen(szPath) + 1 /* Include terminating zero */);
+    if (RT_FAILURE(rc2))
+        VGSvcError("Failed to report user documents, rc=%Rrc\n", rc2);
+    if (RT_SUCCESS(rc))
+        rc = rc2;
+
+#ifdef DEBUG
+    VGSvcVerbose(4, "User documents is '%s', rc=%Rrc\n", szPath, rc);
+#endif
+    return rc;
+}
+
+
+static int vgsvcGstCtrlSessionHandlePathUserHome(PVBOXSERVICECTRLSESSION pSession, PVBGLR3GUESTCTRLCMDCTX pHostCtx)
+{
+    AssertPtrReturn(pSession, VERR_INVALID_POINTER);
+    AssertPtrReturn(pHostCtx, VERR_INVALID_POINTER);
+
+    char szPath[RTPATH_MAX];
+    int rc = RTPathUserHome(szPath, sizeof(szPath));
+
+    /* Report back in any case. */
+    int rc2 = VbglR3GuestCtrlMsgReplyEx(pHostCtx, rc, 0 /* Type */,
+                                        szPath, strlen(szPath) + 1 /* Include terminating zero */);
+    if (RT_FAILURE(rc2))
+        VGSvcError("Failed to report user home, rc=%Rrc\n", rc2);
+    if (RT_SUCCESS(rc))
+        rc = rc2;
+
+#ifdef DEBUG
+    VGSvcVerbose(4, "User home is '%s', rc=%Rrc\n", szPath, rc);
 #endif
     return rc;
@@ -1026 +1072 @@
             break;
 
+        case HOST_PATH_USER_DOCUMENTS:
+            if (fImpersonated)
+                rc = vgsvcGstCtrlSessionHandlePathUserDocuments(pSession, pHostCtx);
+            else
+                rc = VERR_NOT_SUPPORTED;
+            break;
+
+        case HOST_PATH_USER_HOME:
+            if (fImpersonated)
+                rc = vgsvcGstCtrlSessionHandlePathUserHome(pSession, pHostCtx);
+            else
+                rc = VERR_NOT_SUPPORTED;
+            break;
+
         default:
             rc = VbglR3GuestCtrlMsgSkip(pHostCtx->uClientID);

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

@@ -11858 +11858 @@
   <interface
     name="IGuestSession" extends="$unknown"
-    uuid="049af4e1-9732-4815-b01a-d64d21c064fe"
+    uuid="8d3485b3-64a9-4995-998e-6c602b91abd2"
     wsmap="managed"
     reservedMethods="8" reservedAttributes="8"
@@ -11980 +11980 @@
     <attribute name="currentDirectory" type="wstring">
       <desc>
-        The current directory of the session.  Guest path style.
+        Gets or sets the current directory of the session.  Guest path style.
         <result name="E_NOTIMPL">
           This attribute is not implemented yet.
         </result>
+      </desc>
+    </attribute>
+    <attribute name="userHome" type="wstring" readonly="yes">
+      <desc>
+        Returns the user's home / profile directory.  Guest path style.
+      </desc>
+    </attribute>
+    <attribute name="userDocuments" type="wstring" readonly="yes">
+      <desc>
+        Returns the user's documents directory.  Guest path style.
       </desc>
     </attribute>

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

@@ -984 +984 @@
     void* MutableRaw(void) { return pvData; }
 
+    Utf8Str ToString(void)
+    {
+        const char  *pszStr = (const char *)pvData;
+              size_t cbStr  = cbData;
+
+        if (!RTStrValidateEncodingEx(pszStr, cbStr,
+                                     RTSTR_VALIDATE_ENCODING_ZERO_TERMINATED | RTSTR_VALIDATE_ENCODING_EXACT_LENGTH))
+            return "";
+
+        return Utf8Str(pszStr, cbStr);
+    }
+
 protected:
 

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

@@ -350 +350 @@
     HRESULT getCurrentDirectory(com::Utf8Str &aCurrentDirectory);
     HRESULT setCurrentDirectory(const com::Utf8Str &aCurrentDirectory);
+    HRESULT getUserDocuments(com::Utf8Str &aUserDocuments);
+    HRESULT getUserHome(com::Utf8Str &aUserHome);
     HRESULT getDirectories(std::vector<ComPtr<IGuestDirectory> > &aDirectories);
     HRESULT getFiles(std::vector<ComPtr<IGuestFile> > &aFiles);
@@ -533 +535 @@
     int                     i_pathRenameInternal(const Utf8Str &strSource, const Utf8Str &strDest, uint32_t uFlags,
                                                  int *pGuestRc);
+    int                     i_pathUserDocuments(Utf8Str &strPath, int *prcGuest);
+    int                     i_pathUserHome(Utf8Str &strPath, int *prcGuest);
     int                     i_processRemoveFromList(GuestProcess *pProcess);
     int                     i_processCreateExInternal(GuestProcessStartupInfo &procInfo, ComObjPtr<GuestProcess> &pProgress);

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

@@ -544 +544 @@
 }
 
+HRESULT GuestSession::getUserHome(com::Utf8Str &aUserHome)
+{
+    HRESULT hr = i_isReadyExternal();
+    if (FAILED(hr))
+        return hr;
+
+    int rcGuest;
+    int vrc = i_pathUserHome(aUserHome, &rcGuest);
+    if (RT_FAILURE(vrc))
+    {
+        switch (vrc)
+        {
+            case VERR_NOT_SUPPORTED:
+                hr = setError(VBOX_E_IPRT_ERROR, tr("Getting the user's home path is not supported by installed Guest Additions"));
+                break;
+
+            case VERR_GSTCTL_GUEST_ERROR:
+                hr = setError(VBOX_E_IPRT_ERROR, tr("Getting the user's home path failed: %Rrc"), rcGuest);
+                break;
+
+            default:
+                hr = setError(VBOX_E_IPRT_ERROR, tr("Getting the user's home path failed: %Rrc"), vrc);
+                break;
+        }
+    }
+
+    return hr;
+}
+
+HRESULT GuestSession::getUserDocuments(com::Utf8Str &aUserDocuments)
+{
+    HRESULT hr = i_isReadyExternal();
+    if (FAILED(hr))
+        return hr;
+
+    int rcGuest;
+    int vrc = i_pathUserDocuments(aUserDocuments, &rcGuest);
+    if (RT_FAILURE(vrc))
+    {
+        switch (vrc)
+        {
+            case VERR_NOT_SUPPORTED:
+                hr = setError(VBOX_E_IPRT_ERROR, tr("Getting the user's documents path is not supported by installed Guest Additions"));
+                break;
+
+            case VERR_GSTCTL_GUEST_ERROR:
+                hr = setError(VBOX_E_IPRT_ERROR, tr("Getting the user's documents path failed: %Rrc"), rcGuest);
+                break;
+
+            default:
+                hr = setError(VBOX_E_IPRT_ERROR, tr("Getting the user's documents path failed: %Rrc"), vrc);
+                break;
+        }
+    }
+
+    return hr;
+}
+
 HRESULT GuestSession::getDirectories(std::vector<ComPtr<IGuestDirectory> > &aDirectories)
 {
@@ -650 +708 @@
     if (RT_SUCCESS(vrc))
         vrc = i_waitForStatusChange(pEvent, GuestSessionWaitForFlag_Terminate, uTimeoutMS,
-                                  NULL /* Session status */, prcGuest);
+                                    NULL /* Session status */, prcGuest);
 
     unregisterWaitEvent(pEvent);
@@ -1798 +1856 @@
 }
 
-int GuestSession::i_pathRenameInternal(const Utf8Str &strSource, const Utf8Str &strDest,
-                                     uint32_t uFlags, int *prcGuest)
+int GuestSession::i_pathRenameInternal(const Utf8Str &strSource, const Utf8Str &strDest, uint32_t uFlags, int *prcGuest)
 {
     AssertReturn(!(uFlags & ~PATHRENAME_FLAG_VALID_MASK), VERR_INVALID_PARAMETER);
@@ -1833 +1890 @@
             && prcGuest)
             *prcGuest = pEvent->GuestResult();
+    }
+
+    unregisterWaitEvent(pEvent);
+
+    LogFlowFuncLeaveRC(vrc);
+    return vrc;
+}
+
+/**
+ * Returns the user's absolute documents path, if any.
+ *
+ * @return VBox status code.
+ * @param  strPath              Where to store the user's document path.
+ * @param  prcGuest             Guest rc, when returning VERR_GSTCTL_GUEST_ERROR.
+ *                              Any other return code indicates some host side error.
+ */
+int GuestSession::i_pathUserDocuments(Utf8Str &strPath, int *prcGuest)
+{
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    /** @todo Cache the user's document path? */
+
+    GuestWaitEvent *pEvent = NULL;
+    int vrc = registerWaitEvent(mData.mSession.mID, 0 /* Object ID */, &pEvent);
+    if (RT_FAILURE(vrc))
+        return vrc;
+
+    /* Prepare HGCM call. */
+    VBOXHGCMSVCPARM paParms[2];
+    int i = 0;
+    paParms[i++].setUInt32(pEvent->ContextID());
+
+    alock.release(); /* Drop write lock before sending. */
+
+    vrc = i_sendCommand(HOST_PATH_USER_DOCUMENTS, i, paParms);
+    if (RT_SUCCESS(vrc))
+    {
+        vrc = pEvent->Wait(30 * 1000);
+        if (RT_SUCCESS(vrc))
+        {
+            strPath = pEvent->Payload().ToString();
+        }
+        else
+        {
+            if (vrc == VERR_GSTCTL_GUEST_ERROR)
+            {
+                if (prcGuest)
+                    *prcGuest = pEvent->GuestResult();
+            }
+        }
+    }
+
+    unregisterWaitEvent(pEvent);
+
+    LogFlowFuncLeaveRC(vrc);
+    return vrc;
+}
+
+/**
+ * Returns the user's absolute home path, if any.
+ *
+ * @return VBox status code.
+ * @param  strPath              Where to store the user's home path.
+ * @param  prcGuest             Guest rc, when returning VERR_GSTCTL_GUEST_ERROR.
+ *                              Any other return code indicates some host side error.
+ */
+int GuestSession::i_pathUserHome(Utf8Str &strPath, int *prcGuest)
+{
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    /** @todo Cache the user's home path? */
+
+    GuestWaitEvent *pEvent = NULL;
+    int vrc = registerWaitEvent(mData.mSession.mID, 0 /* Object ID */, &pEvent);
+    if (RT_FAILURE(vrc))
+        return vrc;
+
+    /* Prepare HGCM call. */
+    VBOXHGCMSVCPARM paParms[2];
+    int i = 0;
+    paParms[i++].setUInt32(pEvent->ContextID());
+
+    alock.release(); /* Drop write lock before sending. */
+
+    vrc = i_sendCommand(HOST_PATH_USER_HOME, i, paParms);
+    if (RT_SUCCESS(vrc))
+    {
+        vrc = pEvent->Wait(30 * 1000);
+        if (RT_SUCCESS(vrc))
+        {
+            strPath = pEvent->Payload().ToString();
+        }
+        else
+        {
+            if (vrc == VERR_GSTCTL_GUEST_ERROR)
+            {
+                if (prcGuest)
+                    *prcGuest = pEvent->GuestResult();
+            }
+        }
     }