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

Timestamp:

Mar 22, 2023 5:30:14 PM (22 months ago)

Author:

vboxsync

Message:

Guest Control: Added ability of specifying an optional current working directory to started guest processes. This needs Guest Additions which support this. bugref:8053

Location:

trunk/src/VBox/Main

Files:

• idl/VirtualBox.xidl (modified) (4 diffs)
• include/GuestCtrlImplPrivate.h (modified) (1 diff)
• include/GuestSessionImpl.h (modified) (2 diffs)
• src-client/GuestProcessImpl.cpp (modified) (4 diffs)
• src-client/GuestSessionImpl.cpp (modified) (4 diffs)

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

@@ -14814 +14814 @@
   <interface
     name="IGuestSession" extends="$unknown"
-    uuid="234f0627-866d-48c2-91a5-4c9d50f04928"
+    uuid="5591bead-9c1d-4cbd-9669-2d0b04fac0a8"
     wsmap="managed"
     reservedMethods="8" reservedAttributes="12"
@@ -15947 +15947 @@
           If ProcessCreateFlag_WaitForStdOut and/or ProcessCreateFlag_WaitForStdErr
           are set, the guest process will not enter the terminated state until
-          all data from the specified streams have been read read.
+          all data from the specified streams have been read.
         </note>
 
@@ -15961 +15961 @@
         <desc>
           Full path to the file to execute in the guest.  The file has to
-          exists in the guest VM with executable right to the session user in
+          exist in the guest VM with executable right to the session user in
           order to succeed.  If empty/null, the first entry in the
           @a arguments array will be used instead (i.e. argv[0]).
+        </desc>
+      </param>
+      <param name="cwd" type="wstring" dir="in">
+        <desc>
+          Path to the directory in which to execute in the guest.  The
+          directory has to exist in the guest VM with search rights to the
+          session user in order to succeed.  If empty/null, the session
+          user's default (typically 'home') directory is used.  If not a
+          full path, it is interpreted relative to the default directory;
+          e.g. 'work' means '$HOME/work' (according to the guest's '$HOME'-
+          like concept).
         </desc>
       </param>
@@ -16017 +16028 @@
         See <link to="IGuestSession::processCreate"/> for more information.
       </desc>
+      <param name="cwd" type="wstring" dir="in">
+        <desc>
+          Path to the directory in which to execute in the guest.  The
+          directory has to exist in the guest VM with search rights to the
+          session user in order to succeed.  If empty/null, the session
+          user's default (typically 'home') directory is used.  If not a
+          full path, it is interpreted relative to the default directory;
+          e.g. 'work' means '$HOME/work' (according to the guest's '$HOME'-
+          like concept).
+        </desc>
+      </param>
       <param name="executable" type="wstring" dir="in">
         <desc>
           Full path to the file to execute in the guest.  The file has to
-          exists in the guest VM with executable right to the session user in
+          exist in the guest VM with executable right to the session user in
           order to succeed.  If empty/null, the first entry in the
           @a arguments array will be used instead (i.e. argv[0]).

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

@@ -945 +945 @@
     /** The executable. */
     Utf8Str                     mExecutable;
+    /** The working directory. Optional, can be empty if not used. */
+    Utf8Str                     mCwd;
     /** Arguments vector (starting with argument \#0). */
     ProcessArguments            mArguments;

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

@@ -212 +212 @@
                         ULONG aMode);
     HRESULT processCreate(const com::Utf8Str &aCommand,
+                          const com::Utf8Str &aCwd,
                           const std::vector<com::Utf8Str> &aArguments,
                           const std::vector<com::Utf8Str> &aEnvironment,
@@ -218 +219 @@
                           ComPtr<IGuestProcess> &aGuestProcess);
     HRESULT processCreateEx(const com::Utf8Str &aCommand,
+                            const com::Utf8Str &aCwd,
                             const std::vector<com::Utf8Str> &aArguments,
                             const std::vector<com::Utf8Str> &aEnvironment,

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

@@ -1158 +1158 @@
 int GuestProcess::i_startProcess(uint32_t cMsTimeout, int *pvrcGuest)
 {
-    LogFlowThisFunc(("cMsTimeout=%RU32, procExe=%s, procTimeoutMS=%RU32, procFlags=%x, sessionID=%RU32\n",
-                     cMsTimeout, mData.mProcess.mExecutable.c_str(), mData.mProcess.mTimeoutMS, mData.mProcess.mFlags,
-                     mSession->i_getId()));
+    LogFlowThisFunc(("cMsTimeout=%RU32, procExe=%s, cwd=%s, procTimeoutMS=%RU32, procFlags=%x, sessionID=%RU32\n",
+                     cMsTimeout, mData.mProcess.mExecutable.c_str(), mData.mProcess.mCwd.c_str(),
+                     mData.mProcess.mTimeoutMS, mData.mProcess.mFlags, mSession->i_getId()));
 
     /* Wait until the caller function (if kicked off by a thread)
@@ -1215 +1215 @@
         return VERR_BUFFER_OVERFLOW;
 
+    Guest *pGuest = mSession->i_getParent();
+    AssertPtr(pGuest);
+    const uint64_t fGuestControlFeatures0 = pGuest->i_getGuestControlFeatures0();
+
+    /* Check if the Guest Additions support setting the current working directory for the new process
+     * if the caller wants to set one, and bail out early if it doesn't. */
+    if (   !mData.mProcess.mCwd.isEmpty()
+        && (   uProtocol < 2
+            || !(fGuestControlFeatures0 & VBOX_GUESTCTRL_GF_0_PROCESS_CWD)))
+    {
+        LogRel2(("Guest Control: Installed Guest Addtions don't support setting the current working directory to '%s'!\n",
+                 mData.mProcess.mCwd.c_str()));
+        return VERR_NOT_SUPPORTED;
+    }
+
     size_t cbArgs = 0;
     char *pszArgs = NULL;
     int vrc = VINF_SUCCESS;
+
     if (cArgs)
     {
@@ -1229 +1245 @@
         }
         papszArgv[cArgs] = NULL;
-
-        Guest *pGuest = mSession->i_getParent();
-        AssertPtr(pGuest);
-
-        const uint64_t fGuestControlFeatures0 = pGuest->i_getGuestControlFeatures0();
 
         /* If the Guest Additions don't support using argv[0] correctly (< 6.1.x), don't supply it. */
@@ -1299 +1310 @@
             /* The actual CPU affinity blocks. */
             HGCMSvcSetPv(&paParms[i++], (void *)&mData.mProcess.mAffinity, sizeof(mData.mProcess.mAffinity));
+            /* Supply working directory, if guest supports it. */
+            if (fGuestControlFeatures0 & VBOX_GUESTCTRL_GF_0_PROCESS_CWD)
+                HGCMSvcSetRTCStr(&paParms[i++], mData.mProcess.mCwd);
         }
 

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

@@ -4943 +4943 @@
 
 
-HRESULT GuestSession::processCreate(const com::Utf8Str &aExecutable, const std::vector<com::Utf8Str> &aArguments,
+HRESULT GuestSession::processCreate(const com::Utf8Str &aExecutable, const com::Utf8Str &aCwd,
+                                    const std::vector<com::Utf8Str> &aArguments,
                                     const std::vector<com::Utf8Str> &aEnvironment,
                                     const std::vector<ProcessCreateFlag_T> &aFlags,
@@ -4951 +4952 @@
 
     std::vector<LONG> affinityIgnored;
-    return processCreateEx(aExecutable, aArguments, aEnvironment, aFlags, aTimeoutMS, ProcessPriority_Default,
-                           affinityIgnored, aGuestProcess);
-}
-
-HRESULT GuestSession::processCreateEx(const com::Utf8Str &aExecutable, const std::vector<com::Utf8Str> &aArguments,
+    return processCreateEx(aExecutable, aCwd, aArguments, aEnvironment, aFlags, aTimeoutMS,
+                           ProcessPriority_Default, affinityIgnored, aGuestProcess);
+}
+
+HRESULT GuestSession::processCreateEx(const com::Utf8Str &aExecutable, const com::Utf8Str &aCwd,
+                                      const std::vector<com::Utf8Str> &aArguments,
                                       const std::vector<com::Utf8Str> &aEnvironment,
                                       const std::vector<ProcessCreateFlag_T> &aFlags, ULONG aTimeoutMS,
@@ -4978 +4980 @@
     }
 
+    uint32_t const uProtocol              = i_getProtocolVersion();
+    uint64_t const fGuestControlFeatures0 = mParent->i_getGuestControlFeatures0();
+
+    /* If a current working directory (CWD) is set, make sure that the installed Guest Additions actually 
+     * support this before doing anything else. */
+    if (   !aCwd.isEmpty()
+        && (   uProtocol < 2
+            || !(fGuestControlFeatures0 & VBOX_GUESTCTRL_GF_0_PROCESS_CWD)))
+        return setError(VBOX_E_NOT_SUPPORTED,
+                        tr("Setting the current working directory is not supported by the installed Guest Addtions!"));
+
     /* The rest of the input is being validated in i_processCreateEx(). */
 
@@ -4996 +5009 @@
     else /* If no arguments were given, add the executable as argv[0] by default. */
         procInfo.mArguments.push_back(procInfo.mExecutable);
+
+    /* Optional working directory */
+    procInfo.mCwd = aCwd;
 
     /* Combine the environment changes associated with the ones passed in by