Changeset 4064 in vbox

Timestamp:

Aug 7, 2007 2:19:46 PM (18 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

23501

Message:

Main/Frontends: Pass the value of the DISPLAY variable of the starting application to the VM process (#2101).

Location:

trunk/src/VBox

Files:

• Frontends/VBoxManage/VBoxManage.cpp (modified) (1 diff)
• Frontends/VirtualBox/src/VBoxSelectorWnd.cpp (modified) (1 diff)
• Main/MachineImpl.cpp (modified) (7 diffs)
• Main/VirtualBoxImpl.cpp (modified) (2 diffs)
• Main/idl/VirtualBox.xidl (modified) (12 diffs)
• Main/include/MachineImpl.h (modified) (1 diff)
• Main/include/VirtualBoxImpl.h (modified) (1 diff)
• Main/testcase/tstAPI.cpp (modified) (1 diff)

trunk/src/VBox/Frontends/VBoxManage/VBoxManage.cpp

@@ -4236 +4236 @@
         }
 
+        Bstr env;
+#ifdef RT_OS_LINUX
+        /* make sure the VM process will start on the same display as VBoxManage */
+        env = Utf8StrFmt ("DISPLAY=%s", getenv ("DISPLAY"));
+#endif
         ComPtr<IProgress> progress;
-        CHECK_ERROR_RET(virtualBox, OpenRemoteSession(session, uuid, sessionType, progress.asOutParam()), rc);
+        CHECK_ERROR_RET(virtualBox, OpenRemoteSession(session, uuid, sessionType,
+                                                      env, progress.asOutParam()), rc);
         RTPrintf("Waiting for the remote session to open...\n");
         CHECK_ERROR_RET(progress, WaitForCompletion (-1), 1);

trunk/src/VBox/Frontends/VirtualBox/src/VBoxSelectorWnd.cpp

@@ -848 +848 @@
 #endif
 
-    CProgress progress = vbox.OpenRemoteSession (session, id, "gui");
+    QString env;
+#if defined (Q_WS_X11)
+    /* make sure the VM process will start on the same display as the Selector */
+    env.sprintf ("DISPLAY=%s", getenv ("DISPLAY"));
+#endif
+
+    CProgress progress = vbox.OpenRemoteSession (session, id, "gui", env);
     if (!vbox.isOk())
     {

trunk/src/VBox/Main/MachineImpl.cpp

@@ -52 +52 @@
 #include <stdio.h>
 #include <stdlib.h>
-#include <VBox/err.h>
-#include <VBox/cfgldr.h>
+
 #include <iprt/path.h>
 #include <iprt/dir.h>
@@ -59 +58 @@
 #include <iprt/process.h>
 #include <iprt/cpputils.h>
+#include <iprt/env.h>
+
+#include <VBox/err.h>
+#include <VBox/cfgldr.h>
 #include <VBox/param.h>
 
@@ -2763 +2766 @@
  */
 HRESULT Machine::openRemoteSession (IInternalSessionControl *aControl,
-                                    INPTR BSTR aType, Progress *aProgress)
+                                    INPTR BSTR aType, INPTR BSTR aEnvironment,
+                                    Progress *aProgress)
 {
     LogFlowThisFuncEnter();
@@ -2804 +2808 @@
     RTPROCESS pid = NIL_RTPROCESS;
 
+    RTENV env = NIL_RTENV;
+
+    if (aEnvironment)
+    {
+        char *newEnvStr = NULL;
+
+        do
+        {
+            /* clone the current environment */
+            int vrc = RTEnvClone(&env, NULL);
+            AssertRCBreak (vrc, vrc = vrc);
+
+            vrc = RTStrUtf8ToCurrentCP (&newEnvStr, Utf8Str (aEnvironment));
+            AssertRCBreak (vrc, vrc = vrc);
+
+            /* put new variables to the environment
+             * (ignore empty variable names here since RTEnv API
+             * intentionally doesn't do that) */
+            char *var = newEnvStr;
+            for (char *p = newEnvStr; *p; ++ p)
+            {
+                if (*p == '\n' && (p == newEnvStr || *(p - 1) != '\\'))
+                {
+                    *p = '\0';
+                    if (*var)
+                        if (VBOX_FAILURE (vrc = RTEnvPutEx(env, var)))
+                            break;
+                    var = p + 1;
+                }
+            }
+            if (VBOX_SUCCESS (vrc) && *var)
+                vrc = RTEnvPutEx(env, var);
+
+            AssertRCBreak (vrc, vrc = vrc);
+        }
+        while (0);
+
+        if (newEnvStr != NULL)
+            RTStrFree(newEnvStr);
+    }
+
     Bstr type (aType);
     if (type == "gui")
@@ -2822 +2867 @@
         const char * args[] = {path, "-comment", name, "-startvm", idStr, 0 };
 #endif
-        vrc = RTProcCreate (path, args, NULL, 0, &pid);
+        vrc = RTProcCreate (path, args, RTEnvGetArray (env), 0, &pid);
     }
     else
@@ -2839 +2884 @@
         const char * args[] = {path, "-comment", name, "-startvm", idStr, 0 };
 #endif
-        vrc = RTProcCreate (path, args, NULL, 0, &pid);
+        vrc = RTProcCreate (path, args, RTEnvGetArray (env), 0, &pid);
     }
     else
@@ -2856 +2901 @@
         const char * args[] = {path, "-comment", name, "-startvm", idStr, "-capture", 0 };
 #endif
-        vrc = RTProcCreate (path, args, NULL, 0, &pid);
+        vrc = RTProcCreate (path, args, RTEnvGetArray (env), 0, &pid);
     }
     else
     {
+        if (env != NIL_RTENV)
+            RTEnvDestroy (env);
         return setError (E_INVALIDARG,
             tr ("Invalid session type: '%ls'"), aType);
     }
+
+    if (env != NIL_RTENV)
+        RTEnvDestroy (env);
 
     if (VBOX_FAILURE (vrc))

trunk/src/VBox/Main/VirtualBoxImpl.cpp

@@ -1914 +1914 @@
                                             INPTR GUIDPARAM aMachineId,
                                             INPTR BSTR aType,
+                                            INPTR BSTR aEnvironment,
                                             IProgress **aProgress)
 {
@@ -1951 +1952 @@
                     FALSE /* aCancelable */);
 
-    rc = machine->openRemoteSession (control, aType, progress);
+    rc = machine->openRemoteSession (control, aType, aEnvironment, progress);
 
     if (SUCCEEDED (rc))

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

@@ -664 +664 @@
   <interface
      name="IVirtualBox" extends="$dispatched"
-     uuid="d1a2295c-d257-4a4c-a9a6-843d87db6f45"
+     uuid="76b25f3c-15d4-4785-a9d3-adc6a462beec"
      wsmap="global"
      >
@@ -1382 +1382 @@
     <method name="createSharedFolder">
       <desc>
-        Creates a new shared folder by associating the given logical name with
-        the given host path, adds it to the collection of shared folders and
-        starts sharing it. Refer to the description of
+        Creates a new global shared folder by associating the given logical
+        name with the given host path, adds it to the collection of shared
+        folders and starts sharing it. Refer to the description of
         <link to="ISharedFolder"/> to read more about logical names.
       </desc>
@@ -1397 +1397 @@
     <method name="removeSharedFolder">
       <desc>
-        Removes a shared folder with the given name previously created
-        by <link to="#createSharedFolder"/> from the collection of
+        Removes the global shared folder with the given name previously
+        created by <link to="#createSharedFolder"/> from the collection of
         shared folders and stops sharing it.
       </desc>
@@ -1462 +1462 @@
     <method name="openSession">
       <desc>
-        <p>Opens a new direct session with the given virtual machine.
-          Within the direct session context, it is possible to change
-          all VM settings, as well as to execute the VM in the process
-          space of the session object. There can be only one direct
-          session open at a time for every virtual machine.</p>
-        <p>Upon successful return, the session object can be used to
-          get access to the machine and to the VM console.
-        </p>
+        Opens a new direct session with the given virtual machine.
+
+        Within the direct session context, it is possible to change
+        all VM settings, as well as to execute the VM in the process
+        space of the session object. There can be only one direct
+        session open at a time for every virtual machine.
+      
+        Upon successful return, the session object can be used to
+        get access to the machine and to the VM console.
       </desc>
       <param name="session" type="ISession" dir="in">
@@ -1489 +1490 @@
     <method name="openRemoteSession">
       <desc>
-        <p>Opens a new remote session with the given virtual
-          machine. Opening the remote session causes the server to start
-          a new process that opens a direct session with the given VM.
-          The remote session provides some level of control over the VM
-          execution (using the IConsole interface) to the caller. Within
-          the remote session context, it is not possible to change any
-          static VM settings (such as name, HDD configuration, etc.).</p>
-        <p>This operation can take some time, so the progress object
-          is returned to let the caller be informed when the session is
-          actually open. Until then, the remote session object remains in
-          the closed state and accessing the machine or its console through
-          it is invalid.
-        </p>
+        Opens a new remote session with the given virtual
+        machine.
+
+        Opening a remote session causes the VirtualBox server to start a new
+        process that opens a direct session with the given VM.  The remote
+        session provides some level of control over the VM execution to the
+        caller (using the IConsole interface); however, within the remote
+        session context, not all VM settings are available for modification.
+        
+        This operation can take some time, so the progress object
+        is returned to let the caller be informed when the session is
+        actually open. Until then, the remote session object remains in
+        the closed state and accessing the machine or its console through
+        it is invalid.
 
         Currently supported session types (values of the @a type
-        parameter) are:
+        argument) are:
         <ul>
           <li><tt>gui</tt>: VirtualBox Qt GUI session</li>
@@ -1510 +1512 @@
         </ul>
 
-        <note>
-          It is impossible to open a remote session with the machine
+        The @a environment argument is a string containing definitions of
+        environment variables in the following format:
+        @code
+          NAME[=VALUE]\n
+          NAME[=VALUE]\n
+          ...
+        @endcode
+        where <tt>\\n</tt> is the new line character. These environment
+        variables will be appended to the environment of the VirtualBox server
+        process. If an environment variable exists both in the server process
+        and in this list, the value from this list takes precedence over the
+        server's variable. If the value of the environment variable is
+        omitted, this variable will be removed from the resulting environment.
+        If the environment string is @c null, the server environment is
+        inherited by the started process as is.
+
+        <note>
+          It is an error to open a remote session with the machine
           that already has an open direct session or waits until the
           previous request to open the remote session is completed
@@ -1539 +1557 @@
         </desc>
       </param>
+      <param name="environment" type="wstring" dir="in">
+        <desc>
+          Environment to pass to the opened session (may be @c null).
+        </desc>
+      </param>
       <param name="progress" type="IProgress" dir="return">
         <desc>Progress object to track the operation completion.</desc>
@@ -1546 +1569 @@
     <method name="openExistingSession">
       <desc>
-        <p>Opens a new remote session with the virtual machine for
-          which a direct session is already open.
-          The remote session provides some level of control over the VM
-          execution (using the IConsole interface) to the caller. Within
-          the remote session context, it is not possible to change any
-          static VM settings (such as name, HDD configuration, etc.).</p>
-        <p>As opposed to <link to="#openRemoteSession()"/>, the number of
-          remote sessions opened this way is not limited by the API.</p>
-        <note>
-          It is impossible to open a remote session with the machine
-          that doesn't have an open direct session.
-        </note>
+        Opens a new remote session with the virtual machine for
+        which a direct session is already open.
+
+        The remote session provides some level of control over the VM
+        execution (using the IConsole interface) to the caller; however,
+        within the remote session context, not all VM settings are available
+        for modification.
+
+        As opposed to <link to="#openRemoteSession()"/>, the number of
+        remote sessions opened this way is not limited by the API
+
+        <note>
+          It is an error to open a remote session with the machine that
+          doesn't have an open direct session.
+        </note>
+
         <see>openRemoteSession</see>
       </desc>
@@ -2600 +2627 @@
     <method name="createSharedFolder">
       <desc>
-        Creates a new shared folder by associating the given logical name with
-        the given host path, adds it to the collection of shared folders and
-        starts sharing it. Refer to the description of
+        Creates a new permanent shared folder by associating the given logical
+        name with the given host path, adds it to the collection of shared
+        folders and starts sharing it. Refer to the description of
         <link to="ISharedFolder"/> to read more about logical names.
       </desc>
@@ -2615 +2642 @@
     <method name="removeSharedFolder">
       <desc>
-        Removes a shared folder with the given name previously created
-        by <link to="#createSharedFolder"/> from the collection of
+        Removes the permanent shared folder with the given name previously
+        created by <link to="#createSharedFolder"/> from the collection of
         shared folders and stops sharing it.
       </desc>
@@ -3317 +3344 @@
     <method name="createSharedFolder">
       <desc>
-        Creates a new shared folder by associating the given logical name with
-        the given host path, adds it to the collection of shared folders and
-        starts sharing it. Refer to the description of
+        Creates a transient new shared folder by associating the given logical
+        name with the given host path, adds it to the collection of shared
+        folders and starts sharing it. Refer to the description of
         <link to="ISharedFolder"/> to read more about logical names.
       </desc>
@@ -3332 +3359 @@
     <method name="removeSharedFolder">
       <desc>
-        Removes a shared folder with the given name previously created
-        by <link to="#createSharedFolder"/> from the collection of
+        Removes a transient shared folder with the given name previously
+        created by <link to="#createSharedFolder"/> from the collection of
         shared folders and stops sharing it.
       </desc>

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

@@ -543 +543 @@
     HRESULT openSession (IInternalSessionControl *aControl);
     HRESULT openRemoteSession (IInternalSessionControl *aControl,
-                               INPTR BSTR aType, Progress *aProgress);
+                               INPTR BSTR aType, INPTR BSTR aEnvironment,
+                               Progress *aProgress);
     HRESULT openExistingSession (IInternalSessionControl *aControl);
 

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

@@ -174 +174 @@
     STDMETHOD(OpenSession) (ISession *aSession, INPTR GUIDPARAM aMachineId);
     STDMETHOD(OpenRemoteSession) (ISession *aSession, INPTR GUIDPARAM aMachineId,
-                                  INPTR BSTR aType, IProgress **aProgress);
+                                  INPTR BSTR aType, INPTR BSTR aEnvironment,
+                                  IProgress **aProgress);
     STDMETHOD(OpenExistingSession) (ISession *aSession, INPTR GUIDPARAM aMachineId);
     STDMETHOD(RegisterCallback) (IVirtualBoxCallback *callback);

trunk/src/VBox/Main/testcase/tstAPI.cpp

@@ -823 +823 @@
         ComPtr <IProgress> progress;
         CHECK_RC_BREAK (virtualBox->OpenRemoteSession (session, guid, Bstr("gui"),
-                                                       progress.asOutParam()));
+                                                       NULL, progress.asOutParam()));
         printf ("Waiting for the session to open...\n");
         CHECK_RC_BREAK (progress->WaitForCompletion (-1));