Changeset 35757 in vbox for trunk/src

Timestamp:

Jan 28, 2011 12:51:37 PM (14 years ago)

Author:

vboxsync

Message:

Main: do not fail loading machine settings if a shared folder path is not absolute (that breaks importing OVF and machine folders from other hosts since the rules about what constitutes an absolute path differ between host OSes). Instead, issue a runtime warning if a shared folder path is not absolute or does not exist on the host when the VM is powered up.

Location:

trunk/src/VBox/Main

Files:

• include/SharedFolderImpl.h (modified) (2 diffs)
• src-all/SharedFolderImpl.cpp (modified) (15 diffs)
• src-client/ConsoleImpl.cpp (modified) (11 diffs)
• src-server/MachineImpl.cpp (modified) (1 diff)

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

@@ -46 +46 @@
 
     // public initializer/uninitializer for internal purposes only
-    HRESULT init(Machine *aMachine, const Utf8Str &aName, const Utf8Str &aHostPath, bool aWritable, bool aAutoMount);
+    HRESULT init(Machine *aMachine, const Utf8Str &aName, const Utf8Str &aHostPath, bool aWritable, bool aAutoMount, bool fFailOnError);
     HRESULT initCopy(Machine *aMachine, SharedFolder *aThat);
-    HRESULT init(Console *aConsole, const Utf8Str &aName, const Utf8Str &aHostPath, bool aWritable, bool aAutoMount);
-    HRESULT init(VirtualBox *aVirtualBox, const Utf8Str &aName, const Utf8Str &aHostPath, bool aWritable, bool aAutoMount);
+    HRESULT init(Console *aConsole, const Utf8Str &aName, const Utf8Str &aHostPath, bool aWritable, bool aAutoMount, bool fFailOnError);
+//     HRESULT init(VirtualBox *aVirtualBox, const Utf8Str &aName, const Utf8Str &aHostPath, bool aWritable, bool aAutoMount, bool fFailOnError);
     void uninit();
 
@@ -89 +89 @@
 protected:
 
-    HRESULT protectedInit(VirtualBoxBase *aParent, const Utf8Str &aName, const Utf8Str &aHostPath, bool aWritable, bool aAutoMount);
+    HRESULT protectedInit(VirtualBoxBase *aParent,
+                          const Utf8Str &aName,
+                          const Utf8Str &aHostPath,
+                          bool aWritable,
+                          bool aAutoMount,
+                          bool fFailOnError);
 private:
 

trunk/src/VBox/Main/src-all/SharedFolderImpl.cpp

@@ -81 +81 @@
  *  Initializes the shared folder object.
  *
+ *  This variant initializes a machine instance that lives in the server address space.
+ *
  *  @param aMachine     parent Machine object
  *  @param aName        logical name of the shared folder
@@ -86 +88 @@
  *  @param aWritable    writable if true, readonly otherwise
  *  @param aAutoMount   if auto mounted by guest true, false otherwise
+ *  @param fFailOnError Whether to fail with an error if the shared folder path is bad.
  *
  *  @return          COM result indicator
@@ -93 +96 @@
                            const Utf8Str &aHostPath,
                            bool aWritable,
-                           bool aAutoMount)
+                           bool aAutoMount,
+                           bool fFailOnError)
 {
     /* Enclose the state transition NotReady->InInit->Ready */
@@ -101 +105 @@
     unconst(mMachine) = aMachine;
 
-    HRESULT rc = protectedInit(aMachine, aName, aHostPath, aWritable, aAutoMount);
+    HRESULT rc = protectedInit(aMachine, aName, aHostPath, aWritable, aAutoMount, fFailOnError);
 
     /* Confirm a successful initialization when it's the case */
@@ -134 +138 @@
                                aThat->m->strHostPath,
                                aThat->m->fWritable,
-                               aThat->m->fAutoMount);
+                               aThat->m->fAutoMount,
+                               false /* fFailOnError */ );
 
     /* Confirm a successful initialization when it's the case */
@@ -144 +149 @@
 
 /**
- *  Initializes the shared folder object. This variant gets called when
- *  the shared folder lives in the Console address space.
+ *  Initializes the shared folder object.
+ *
+ *  This variant initializes an instance that lives in the console address space.
  *
  *  @param aConsole     Console parent object
@@ -151 +157 @@
  *  @param aHostPath    full path to the shared folder on the host
  *  @param aWritable    writable if true, readonly otherwise
+ *  @param fFailOnError Whether to fail with an error if the shared folder path is bad.
  *
  *  @return          COM result indicator
@@ -158 +165 @@
                            const Utf8Str &aHostPath,
                            bool aWritable,
-                           bool aAutoMount)
+                           bool aAutoMount,
+                           bool fFailOnError)
 {
     /* Enclose the state transition NotReady->InInit->Ready */
@@ -166 +174 @@
     unconst(mConsole) = aConsole;
 
-    HRESULT rc = protectedInit(aConsole, aName, aHostPath, aWritable, aAutoMount);
+    HRESULT rc = protectedInit(aConsole, aName, aHostPath, aWritable, aAutoMount, fFailOnError);
 
     /* Confirm a successful initialization when it's the case */
@@ -175 +183 @@
 }
 
-/**
- *  Initializes the shared folder object. This variant gets called when
- *  the shared folder lives in the VirtualBox (server) address space.
+#if 0
+
+/**
+ *  Initializes the shared folder object.
+ *
+ *  This variant initializes a global instance that lives in the server address space. It is not presently used.
  *
  *  @param aVirtualBox  VirtualBox parent object
@@ -183 +194 @@
  *  @param aHostPath    full path to the shared folder on the host
  *  @param aWritable    writable if true, readonly otherwise
+ *  @param fFailOnError Whether to fail with an error if the shared folder path is bad.
  *
  *  @return          COM result indicator
@@ -190 +202 @@
                            const Utf8Str &aHostPath,
                            bool aWritable,
-                           bool aAutoMount)
+                           bool aAutoMount,
+                           bool fFailOnError)
 {
     /* Enclose the state transition NotReady->InInit->Ready */
@@ -206 +219 @@
     return rc;
 }
+
+#endif
 
 /**
@@ -217 +232 @@
                                     const Utf8Str &aHostPath,
                                     bool aWritable,
-                                    bool aAutoMount)
+                                    bool aAutoMount,
+                                    bool fFailOnError)
 {
     LogFlowThisFunc(("aName={%s}, aHostPath={%s}, aWritable={%d}, aAutoMount={%d}\n",
@@ -245 +261 @@
         hostPath.stripTrailingSlash();
 
-    /* Check whether the path is full (absolute) */
-    char hostPathFull[RTPATH_MAX];
-    int vrc = RTPathAbsEx(NULL,
-                          hostPath.c_str(),
-                          hostPathFull,
-                          sizeof (hostPathFull));
-    if (RT_FAILURE(vrc))
-        return setError(E_INVALIDARG,
-                        tr("Invalid shared folder path: '%s' (%Rrc)"),
-                        hostPath.c_str(), vrc);
-
-    if (RTPathCompare(hostPath.c_str(), hostPathFull) != 0)
-        return setError(E_INVALIDARG,
-                        tr("Shared folder path '%s' is not absolute"),
-                        hostPath.c_str());
+    if (fFailOnError)
+    {
+        /* Check whether the path is full (absolute) */
+        char hostPathFull[RTPATH_MAX];
+        int vrc = RTPathAbsEx(NULL,
+                              hostPath.c_str(),
+                              hostPathFull,
+                              sizeof (hostPathFull));
+        if (RT_FAILURE(vrc))
+            return setError(E_INVALIDARG,
+                            tr("Invalid shared folder path: '%s' (%Rrc)"),
+                            hostPath.c_str(), vrc);
+
+        if (RTPathCompare(hostPath.c_str(), hostPathFull) != 0)
+            return setError(E_INVALIDARG,
+                            tr("Shared folder path '%s' is not absolute"),
+                            hostPath.c_str());
+    }
 
     unconst(mParent) = aParent;

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

@@ -1384 +1384 @@
                                          strHostPath,
                                          writable,
-                                         autoMount);
+                                         autoMount,
+                                         false /* fFailOnError */);
         AssertComRCReturn(rc, VERR_INTERNAL_ERROR);
 
@@ -2851 +2852 @@
     CheckComArgStrNotEmptyOrNull(aHostPath);
 
+    LogFlowThisFunc(("Entering for '%ls' -> '%ls'\n", aName, aHostPath));
+
     AutoCaller autoCaller(this);
     if (FAILED(autoCaller.rc())) return autoCaller.rc();
@@ -2877 +2880 @@
     if (SUCCEEDED(rc))
         return setError(VBOX_E_FILE_ERROR,
-            tr("Shared folder named '%s' already exists"),
-            strName.c_str());
+                        tr("Shared folder named '%s' already exists"),
+                        strName.c_str());
 
     pSharedFolder.createObject();
-    rc = pSharedFolder->init(this, strName, strHostPath, aWritable, aAutoMount);
+    rc = pSharedFolder->init(this,
+                             strName,
+                             strHostPath,
+                             aWritable,
+                             aAutoMount,
+                             true /* fFailOnError */);
     if (FAILED(rc)) return rc;
 
@@ -2914 +2922 @@
     fireSharedFolderChangedEvent(mEventSource, Scope_Session);
 
+    LogFlowThisFunc(("Leaving for '%ls' -> '%ls'\n", aName, aHostPath));
+
     return rc;
 }
@@ -2923 +2933 @@
     AutoCaller autoCaller(this);
     if (FAILED(autoCaller.rc())) return autoCaller.rc();
+
+    LogFlowThisFunc(("Entering for '%ls'\n", aName));
 
     Utf8Str strName(aName);
@@ -2976 +2988 @@
     /* notify console callbacks after the folder is removed to the list */
     fireSharedFolderChangedEvent(mEventSource, Scope_Session);
+
+    LogFlowThisFunc(("Leaving for '%ls'\n", aName));
 
     return rc;
@@ -6195 +6209 @@
                  isWriteLockOnCurrentThread(), E_FAIL);
 
+    LogFlowThisFunc(("Entering\n"));
+
     /* protect mpVM (if not NULL) */
     AutoVMCallerQuietWeak autoVMCaller(this);
@@ -6205 +6221 @@
                   && m_pVMMDev->isShFlActive();
 
-    if (aGlobal)
-    {
-        /// @todo grab & process global folders when they are done
-    }
-    else
-    {
-        SharedFolderDataMap oldFolders;
-        if (online)
-            oldFolders = m_mapMachineSharedFolders;
-
-        m_mapMachineSharedFolders.clear();
-
-        SafeIfaceArray<ISharedFolder> folders;
-        rc = mMachine->COMGETTER(SharedFolders)(ComSafeArrayAsOutParam(folders));
-        AssertComRCReturnRC(rc);
-
-        for (size_t i = 0; i < folders.size(); ++i)
-        {
-            ComPtr<ISharedFolder> pSharedFolder = folders[i];
-
-            Bstr bstrName;
-            Bstr bstrHostPath;
-            BOOL writable;
-            BOOL autoMount;
-
-            rc = pSharedFolder->COMGETTER(Name)(bstrName.asOutParam());
-            if (FAILED(rc)) break;
-            Utf8Str strName(bstrName);
-
-            rc = pSharedFolder->COMGETTER(HostPath)(bstrHostPath.asOutParam());
-            if (FAILED(rc)) break;
-            Utf8Str strHostPath(bstrHostPath);
-
-            rc = pSharedFolder->COMGETTER(Writable)(&writable);
-            if (FAILED(rc)) break;
-
-            rc = pSharedFolder->COMGETTER(AutoMount)(&autoMount);
-            if (FAILED(rc)) break;
-
-            m_mapMachineSharedFolders.insert(std::make_pair(strName,
-                                                            SharedFolderData(strHostPath, writable, autoMount)));
-
-            /* send changes to HGCM if the VM is running */
-            /// @todo umoeller report errors as runtime warnings through VMSetError
+    try
+    {
+        if (aGlobal)
+        {
+            /// @todo grab & process global folders when they are done
+        }
+        else
+        {
+            SharedFolderDataMap oldFolders;
+            if (online)
+                oldFolders = m_mapMachineSharedFolders;
+
+            m_mapMachineSharedFolders.clear();
+
+            SafeIfaceArray<ISharedFolder> folders;
+            rc = mMachine->COMGETTER(SharedFolders)(ComSafeArrayAsOutParam(folders));
+            if (FAILED(rc)) throw rc;
+
+            for (size_t i = 0; i < folders.size(); ++i)
+            {
+                ComPtr<ISharedFolder> pSharedFolder = folders[i];
+
+                Bstr bstrName;
+                Bstr bstrHostPath;
+                BOOL writable;
+                BOOL autoMount;
+
+                rc = pSharedFolder->COMGETTER(Name)(bstrName.asOutParam());
+                if (FAILED(rc)) throw rc;
+                Utf8Str strName(bstrName);
+
+                rc = pSharedFolder->COMGETTER(HostPath)(bstrHostPath.asOutParam());
+                if (FAILED(rc)) throw rc;
+                Utf8Str strHostPath(bstrHostPath);
+
+                rc = pSharedFolder->COMGETTER(Writable)(&writable);
+                if (FAILED(rc)) throw rc;
+
+                rc = pSharedFolder->COMGETTER(AutoMount)(&autoMount);
+                if (FAILED(rc)) throw rc;
+
+                m_mapMachineSharedFolders.insert(std::make_pair(strName,
+                                                                SharedFolderData(strHostPath, writable, autoMount)));
+
+                /* send changes to HGCM if the VM is running */
+                /// @todo umoeller report errors as runtime warnings through VMSetError
+                if (online)
+                {
+                    SharedFolderDataMap::iterator it = oldFolders.find(strName);
+                    if (    it == oldFolders.end()
+                         || it->second.m_strHostPath != strHostPath)
+                    {
+                        /* a new machine folder is added or
+                         * the existing machine folder is changed */
+                        if (m_mapSharedFolders.find(strName) != m_mapSharedFolders.end())
+                            ; /* the console folder exists, nothing to do */
+                        else
+                        {
+                            /* remove the old machine folder (when changed)
+                             * or the global folder if any (when new) */
+                            if (    it != oldFolders.end()
+                                 || m_mapGlobalSharedFolders.find(strName) != m_mapGlobalSharedFolders.end()
+                               )
+                            {
+                                rc = removeSharedFolder(strName);
+                                if (FAILED(rc)) throw rc;
+                            }
+
+                            /* create the new machine folder */
+                            rc = createSharedFolder(strName,
+                                                    SharedFolderData(strHostPath,
+                                                                     writable,
+                                                                     autoMount));
+                            if (FAILED(rc)) throw rc;
+                        }
+                    }
+                    /* forget the processed (or identical) folder */
+                    if (it != oldFolders.end())
+                        oldFolders.erase(it);
+                }
+            }
+
+            /* process outdated (removed) folders */
             if (online)
             {
-                SharedFolderDataMap::iterator it = oldFolders.find(strName);
-                if (    it == oldFolders.end()
-                     || it->second.m_strHostPath != strHostPath)
+                for (SharedFolderDataMap::const_iterator it = oldFolders.begin();
+                     it != oldFolders.end(); ++ it)
                 {
-                    /* a new machine folder is added or
-                     * the existing machine folder is changed */
-                    if (m_mapSharedFolders.find(strName) != m_mapSharedFolders.end())
+                    if (m_mapSharedFolders.find(it->first) != m_mapSharedFolders.end())
                         ; /* the console folder exists, nothing to do */
                     else
                     {
-                        /* remove the old machine folder (when changed)
-                         * or the global folder if any (when new) */
-                        if (    it != oldFolders.end()
-                             || m_mapGlobalSharedFolders.find(strName) != m_mapGlobalSharedFolders.end()
-                           )
-                            rc = removeSharedFolder(strName);
-                        /* create the new machine folder */
-                        rc = createSharedFolder(strName,
-                                                SharedFolderData(strHostPath,
-                                                                 writable,
-                                                                 autoMount));
+                        /* remove the outdated machine folder */
+                        rc = removeSharedFolder(it->first);
+                        if (FAILED(rc)) throw rc;
+
+                        /* create the global folder if there is any */
+                        SharedFolderDataMap::const_iterator git =
+                            m_mapGlobalSharedFolders.find(it->first);
+                        if (git != m_mapGlobalSharedFolders.end())
+                        {
+                            rc = createSharedFolder(git->first, git->second);
+                            if (FAILED(rc)) throw rc;
+                        }
                     }
                 }
-                /* forget the processed (or identical) folder */
-                if (it != oldFolders.end())
-                    oldFolders.erase(it);
-
-                rc = S_OK;
             }
         }
-
-        AssertComRCReturnRC(rc);
-
-        /* process outdated (removed) folders */
-        /// @todo report errors as runtime warnings through VMSetError
+    }
+    catch (HRESULT rc2)
+    {
         if (online)
-        {
-            for (SharedFolderDataMap::const_iterator it = oldFolders.begin();
-                 it != oldFolders.end(); ++ it)
-            {
-                if (m_mapSharedFolders.find(it->first) != m_mapSharedFolders.end())
-                    ; /* the console folder exists, nothing to do */
-                else
-                {
-                    /* remove the outdated machine folder */
-                    rc = removeSharedFolder(it->first);
-                    /* create the global folder if there is any */
-                    SharedFolderDataMap::const_iterator git =
-                        m_mapGlobalSharedFolders.find(it->first);
-                    if (git != m_mapGlobalSharedFolders.end())
-                        rc = createSharedFolder(git->first, git->second);
-                }
-            }
-
-            rc = S_OK;
-        }
-    }
+            setVMRuntimeErrorCallbackF(mpVM, this, 0, "BrokenSharedFolder",
+                                       N_("Broken shared folder!"));
+    }
+
+    LogFlowThisFunc(("Leaving\n"));
 
     return rc;
@@ -6364 +6394 @@
 
     Log(("Adding shared folder '%s' -> '%s'\n", strName.c_str(), aData.m_strHostPath.c_str()));
+
+    // check whether the path is valid and exists
+    /* Check whether the path is full (absolute) */
+    char hostPathFull[RTPATH_MAX];
+    int vrc = RTPathAbsEx(NULL,
+                          aData.m_strHostPath.c_str(),
+                          hostPathFull,
+                          sizeof(hostPathFull));
+    if (RT_FAILURE(vrc))
+        return setError(E_INVALIDARG,
+                        tr("Invalid shared folder path: '%s' (%Rrc)"),
+                        aData.m_strHostPath.c_str(), vrc);
+
+    if (RTPathCompare(aData.m_strHostPath.c_str(), hostPathFull) != 0)
+        return setError(E_INVALIDARG,
+                        tr("Shared folder path '%s' is not absolute"),
+                        aData.m_strHostPath.c_str());
+    if (!RTPathExists(hostPathFull))
+        return setError(E_INVALIDARG,
+                        tr("Shared folder path '%s' does not exist on the host"),
+                        aData.m_strHostPath.c_str());
+
+    // now that we know the path is good, give it to HGCM
 
     Bstr bstrName(strName);
@@ -6411 +6464 @@
     parms[3].u.uint32 = aData.m_fAutoMount;
 
-    int vrc = m_pVMMDev->hgcmHostCall("VBoxSharedFolders",
-                                      SHFL_FN_ADD_MAPPING,
-                                      SHFL_CPARMS_ADD_MAPPING2, &parms[0]);
+    vrc = m_pVMMDev->hgcmHostCall("VBoxSharedFolders",
+                                  SHFL_FN_ADD_MAPPING,
+                                  SHFL_CPARMS_ADD_MAPPING2, &parms[0]);
     RTMemFree(pFolderName);
     RTMemFree(pMapName);
@@ -7830 +7883 @@
                     {
                         const SharedFolderData &d = it->second;
-                        rc = pConsole->createSharedFolder(it->first,
-                                                          d);
-                        if (FAILED(rc)) break;
+                        rc = pConsole->createSharedFolder(it->first, d);
+                        if (FAILED(rc))
+                        {
+                            ErrorInfoKeeper eik;
+                            setVMRuntimeErrorCallbackF(pVM, pConsole, 0, "BrokenSharedFolder",
+                                                       N_("The shared folder '%s' could not be set up: %ls.\n"
+                                                          "The shared folder setup will not be complete. It is recommended to power down the virtual machine and "
+                                                          "fix the shared folder settings while the machine is not running."),
+                                                       it->first.c_str(), eik.getText().raw());
+                            break;
+                        }
                     }
-                    if (FAILED(rc)) break;
+                    if (FAILED(rc))
+                        rc = S_OK;          // do not fail with broken shared folders
 
                     /* enter the lock again */

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

@@ -4652 +4652 @@
     if (FAILED(rc)) return rc;
 
+    Utf8Str strName(aName);
+
     ComObjPtr<SharedFolder> sharedFolder;
-    rc = findSharedFolder(aName, sharedFolder, false /* aSetError */);
+    rc = findSharedFolder(strName, sharedFolder, false /* aSetError */);
     if (SUCCEEDED(rc))
         return setError(VBOX_E_OBJECT_IN_USE,
-                        tr("Shared folder named '%ls' already exists"),
-                        aName);
+                        tr("Shared folder named '%s' already exists"),
+                        strName.c_str());
 
     sharedFolder.createObject();
-    rc = sharedFolder->init(getMachine(), aName, aHostPath, aWritable, aAutoMount);
+    rc = sharedFolder->init(getMachine(),
+                            strName,
+                            aHostPath,
+                            !!aWritable,
+                            !!aAutoMount,
+                           true /* fFailOnError */);
     if (FAILED(rc)) return rc;