Changeset 52251 in vbox

Timestamp:

Aug 1, 2014 6:07:28 AM (11 years ago)

Author:

vboxsync

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

95340

Message:

Main: update guest properties API to work with API wrappers, removed unnecesary BSTR conversion.

Location:

trunk/src/VBox/Main

Files:

• idl/VirtualBox.xidl (modified) (2 diffs)
• include/ConsoleImpl.h (modified) (1 diff)
• include/MachineImpl.h (modified) (1 diff)
• include/SessionImpl.h (modified) (1 diff)
• src-client/ConsoleImpl.cpp (modified) (6 diffs)
• src-client/SessionImpl.cpp (modified) (3 diffs)
• src-server/MachineImpl.cpp (modified) (7 diffs)

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

@@ -17744 +17744 @@
   <interface
     name="IInternalSessionControl" extends="$unknown"
-    uuid="2d2124a7-0f62-4907-ae21-eee5a559bdde"
+    uuid="b7c71040-2761-42c4-a44a-4e2c2d7e2820"
     internal="yes"
     wsmap="suppress"
@@ -18151 +18151 @@
       <param name="value" type="wstring" dir="in"/>
       <param name="flags" type="wstring" dir="in"/>
-      <param name="isSetter" type="boolean" dir="in"/>
+      <param name="accessMode" type="unsigned long" dir="in">
+        <desc>0 = get, 1 = set, 2 = delete.</desc>
+      </param>
       <param name="retValue" type="wstring" dir="out"/>
       <param name="retTimestamp" type="long long" dir="out"/>

trunk/src/VBox/Main/include/ConsoleImpl.h ¶

@@ -174 +174 @@
     HRESULT i_onExtraDataChange(IN_BSTR aMachineId, IN_BSTR aKey, IN_BSTR aVal);
 
-    HRESULT i_getGuestProperty(IN_BSTR aKey, BSTR *aValue, LONG64 *aTimestamp, BSTR *aFlags);
-    HRESULT i_setGuestProperty(IN_BSTR aKey, IN_BSTR aValue, IN_BSTR aFlags);
+    HRESULT i_getGuestProperty(const Utf8Str &aName, Utf8Str *aValue, LONG64 *aTimestamp, Utf8Str *aFlags);
+    HRESULT i_setGuestProperty(const Utf8Str &aName, const Utf8Str &aValue, const Utf8Str &aFlags);
+    HRESULT i_deleteGuestProperty(const Utf8Str &aName);
     HRESULT i_enumerateGuestProperties(IN_BSTR aPatterns,
                                        ComSafeArrayOut(BSTR, aNames),

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

@@ -718 +718 @@
                                           LONG64 *aTimestamp, com::Utf8Str &aFlags) const;
     HRESULT i_setGuestPropertyToService(const com::Utf8Str &aName, const com::Utf8Str &aValue,
-                                        const com::Utf8Str &aFlags);
+                                        const com::Utf8Str &aFlags, bool fDelete);
     HRESULT i_getGuestPropertyFromVM(const com::Utf8Str &aName, com::Utf8Str &aValue,
                                      LONG64 *aTimestamp, com::Utf8Str &aFlags) const;
     HRESULT i_setGuestPropertyToVM(const com::Utf8Str &aName, const com::Utf8Str &aValue,
-                                   const com::Utf8Str &aFlags);
+                                   const com::Utf8Str &aFlags, bool fDelete);
     HRESULT i_enumerateGuestPropertiesInService(const com::Utf8Str &aPatterns,
                                                 std::vector<com::Utf8Str> &aNames,

trunk/src/VBox/Main/include/SessionImpl.h ¶

@@ -107 +107 @@
                                 const com::Utf8Str &aValue,
                                 const com::Utf8Str &aFlags,
-                                BOOL aIsSetter,
+                                ULONG aAccessMode,
                                 com::Utf8Str &aRetValue,
                                 LONG64 *aRetTimestamp,

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

@@ -1283 +1283 @@
     {
         /* Provide credentials only if there are no logged in users. */
-        Bstr noLoggedInUsersValue;
+        Utf8Str noLoggedInUsersValue;
         LONG64 ul64Timestamp = 0;
-        Bstr flags;
-
-        hrc = i_getGuestProperty(Bstr("/VirtualBox/GuestInfo/OS/NoLoggedInUsers").raw(),
-                                 noLoggedInUsersValue.asOutParam(), &ul64Timestamp, flags.asOutParam());
-
-        if (SUCCEEDED(hrc) && noLoggedInUsersValue != Bstr("false"))
+        Utf8Str flags;
+
+        hrc = i_getGuestProperty("/VirtualBox/GuestInfo/OS/NoLoggedInUsers",
+                                 &noLoggedInUsersValue, &ul64Timestamp, &flags);
+
+        if (SUCCEEDED(hrc) && noLoggedInUsersValue != "false")
         {
             /* And only if there are no connected clients. */
@@ -5567 +5567 @@
  * @note Temporarily locks this object for writing.
  */
-HRESULT Console::i_getGuestProperty(IN_BSTR aName, BSTR *aValue, LONG64 *aTimestamp, BSTR *aFlags)
+HRESULT Console::i_getGuestProperty(const Utf8Str &aName, Utf8Str *aValue, LONG64 *aTimestamp, Utf8Str *aFlags)
 {
 #ifndef VBOX_WITH_GUEST_PROPS
     ReturnComNotImplemented();
 #else  /* VBOX_WITH_GUEST_PROPS */
-    if (!VALID_PTR(aName))
-        return E_INVALIDARG;
-    if (!VALID_PTR(aValue))
+    if (!RT_VALID_PTR(aValue))
+         return E_POINTER;
+    if (aTimestamp != NULL && !RT_VALID_PTR(aTimestamp))
         return E_POINTER;
-    if ((aTimestamp != NULL) && !VALID_PTR(aTimestamp))
-        return E_POINTER;
-    if ((aFlags != NULL) && !VALID_PTR(aFlags))
+    if (aFlags != NULL && !RT_VALID_PTR(aFlags))
         return E_POINTER;
 
@@ -5598 +5596 @@
     {
         VBOXHGCMSVCPARM parm[4];
-        Utf8Str Utf8Name = aName;
         char szBuffer[MAX_VALUE_LEN + MAX_FLAGS_LEN];
 
         parm[0].type = VBOX_HGCM_SVC_PARM_PTR;
-        parm[0].u.pointer.addr = (void*)Utf8Name.c_str();
-        /* The + 1 is the null terminator */
-        parm[0].u.pointer.size = (uint32_t)Utf8Name.length() + 1;
+        parm[0].u.pointer.addr = (void*)aName.c_str();
+        parm[0].u.pointer.size = (uint32_t)aName.length() + 1; /* The + 1 is the null terminator */
+
         parm[1].type = VBOX_HGCM_SVC_PARM_PTR;
         parm[1].u.pointer.addr = szBuffer;
         parm[1].u.pointer.size = sizeof(szBuffer);
+
+        parm[2].type = VBOX_HGCM_SVC_PARM_64BIT;
+        parm[2].u.uint64 = 0;
+
+        parm[3].type = VBOX_HGCM_SVC_PARM_32BIT;
+        parm[3].u.uint32 = 0;
+
         int vrc = m_pVMMDev->hgcmHostCall("VBoxGuestPropSvc", GET_PROP_HOST,
                                           4, &parm[0]);
         /* The returned string should never be able to be greater than our buffer */
         AssertLogRel(vrc != VERR_BUFFER_OVERFLOW);
-        AssertLogRel(RT_FAILURE(vrc) || VBOX_HGCM_SVC_PARM_64BIT == parm[2].type);
-        if (RT_SUCCESS(vrc) || (VERR_NOT_FOUND == vrc))
-        {
+        AssertLogRel(RT_FAILURE(vrc) || parm[2].type == VBOX_HGCM_SVC_PARM_64BIT);
+        if (RT_SUCCESS(vrc))
+        {
+            *aValue = szBuffer;
+
+            if (aTimestamp)
+                *aTimestamp = parm[2].u.uint64;
+
+            if (aFlags)
+                *aFlags = &szBuffer[strlen(szBuffer) + 1];
+
             rc = S_OK;
-            if (vrc != VERR_NOT_FOUND)
-            {
-                Utf8Str strBuffer(szBuffer);
-                strBuffer.cloneTo(aValue);
-
-                if (aTimestamp)
-                    *aTimestamp = parm[2].u.uint64;
-
-                if (aFlags)
-                {
-                    size_t iFlags = strBuffer.length() + 1;
-                    Utf8Str(szBuffer + iFlags).cloneTo(aFlags);
-                }
-            }
-            else
-                aValue = NULL;
+        }
+        else if (vrc == VERR_NOT_FOUND)
+        {
+            *aValue = "";
+            rc = S_OK;
         }
         else
-            rc = setError(E_UNEXPECTED,
-                tr("The service call failed with the error %Rrc"),
-                vrc);
+            rc = setError(VBOX_E_IPRT_ERROR,
+                          tr("The VBoxGuestPropSvc service call failed with the error %Rrc"),
+                          vrc);
     }
     catch(std::bad_alloc & /*e*/)
@@ -5642 +5643 @@
         rc = E_OUTOFMEMORY;
     }
+
     return rc;
 #endif /* VBOX_WITH_GUEST_PROPS */
@@ -5649 +5651 @@
  * @note Temporarily locks this object for writing.
  */
-HRESULT Console::i_setGuestProperty(IN_BSTR aName, IN_BSTR aValue, IN_BSTR aFlags)
+HRESULT Console::i_setGuestProperty(const Utf8Str &aName, const Utf8Str &aValue, const Utf8Str &aFlags)
 {
 #ifndef VBOX_WITH_GUEST_PROPS
     ReturnComNotImplemented();
 #else /* VBOX_WITH_GUEST_PROPS */
-    if (!RT_VALID_PTR(aName))
-        return setError(E_INVALIDARG, tr("Name cannot be NULL or an invalid pointer"));
-    if (aValue != NULL && !RT_VALID_PTR(aValue))
-        return setError(E_INVALIDARG, tr("Invalid value pointer"));
-    if (aFlags != NULL && !RT_VALID_PTR(aFlags))
-        return setError(E_INVALIDARG, tr("Invalid flags pointer"));
 
     AutoCaller autoCaller(this);
@@ -5676 +5672 @@
     VBOXHGCMSVCPARM parm[3];
 
-    Utf8Str Utf8Name = aName;
     parm[0].type = VBOX_HGCM_SVC_PARM_PTR;
-    parm[0].u.pointer.addr = (void*)Utf8Name.c_str();
-    /* The + 1 is the null terminator */
-    parm[0].u.pointer.size = (uint32_t)Utf8Name.length() + 1;
-
-    Utf8Str Utf8Value;
-    if (aValue != NULL)
-    {
-        Utf8Value = aValue;
-        parm[1].type = VBOX_HGCM_SVC_PARM_PTR;
-        parm[1].u.pointer.addr = (void *)Utf8Value.c_str();
-        /* The + 1 is the null terminator */
-        parm[1].u.pointer.size = (uint32_t)Utf8Value.length() + 1;
-    }
-
-    Utf8Str Utf8Flags;
-    if (aFlags != NULL)
-    {
-        Utf8Flags = aFlags;
+    parm[0].u.pointer.addr = (void*)aName.c_str();
+    parm[0].u.pointer.size = (uint32_t)aName.length() + 1; /* The + 1 is the null terminator */
+
+    parm[1].type = VBOX_HGCM_SVC_PARM_PTR;
+    parm[1].u.pointer.addr = (void *)aValue.c_str();
+    parm[1].u.pointer.size = (uint32_t)aValue.length() + 1; /* The + 1 is the null terminator */
+
+    int vrc;
+    if (aFlags.isEmpty())
+    {
+        vrc = m_pVMMDev->hgcmHostCall("VBoxGuestPropSvc", SET_PROP_VALUE_HOST,
+                                    2, &parm[0]);
+    }
+    else
+    {
         parm[2].type = VBOX_HGCM_SVC_PARM_PTR;
-        parm[2].u.pointer.addr = (void*)Utf8Flags.c_str();
-        /* The + 1 is the null terminator */
-        parm[2].u.pointer.size = (uint32_t)Utf8Flags.length() + 1;
-    }
-
-    int vrc;
-    if (aValue != NULL && aFlags != NULL)
+        parm[2].u.pointer.addr = (void*)aFlags.c_str();
+        parm[2].u.pointer.size = (uint32_t)aFlags.length() + 1; /* The + 1 is the null terminator */
+
         vrc = m_pVMMDev->hgcmHostCall("VBoxGuestPropSvc", SET_PROP_HOST,
                                       3, &parm[0]);
-    else if (aValue != NULL)
-        vrc = m_pVMMDev->hgcmHostCall("VBoxGuestPropSvc", SET_PROP_VALUE_HOST,
-                                    2, &parm[0]);
-    else
-        vrc = m_pVMMDev->hgcmHostCall("VBoxGuestPropSvc", DEL_PROP_HOST,
-                                    1, &parm[0]);
-    HRESULT hrc;
-    if (RT_SUCCESS(vrc))
-        hrc = S_OK;
-    else
-        hrc = setError(E_UNEXPECTED, tr("The service call failed with the error %Rrc"), vrc);
+    }
+
+    HRESULT hrc = S_OK;
+    if (RT_FAILURE(vrc))
+        hrc = setError(VBOX_E_IPRT_ERROR, tr("The VBoxGuestPropSvc service call failed with the error %Rrc"), vrc);
     return hrc;
 #endif /* VBOX_WITH_GUEST_PROPS */
 }
 
+HRESULT Console::i_deleteGuestProperty(const Utf8Str &aName)
+{
+#ifndef VBOX_WITH_GUEST_PROPS
+    ReturnComNotImplemented();
+#else /* VBOX_WITH_GUEST_PROPS */
+
+    AutoCaller autoCaller(this);
+    AssertComRCReturnRC(autoCaller.rc());
+
+    /* protect mpUVM (if not NULL) */
+    SafeVMPtrQuiet ptrVM(this);
+    if (FAILED(ptrVM.rc()))
+        return ptrVM.rc();
+
+    /* Note: validity of mVMMDev which is bound to uninit() is guaranteed by
+     * ptrVM, so there is no need to hold a lock of this */
+
+    using namespace guestProp;
+
+    VBOXHGCMSVCPARM parm[1];
+
+    parm[0].type = VBOX_HGCM_SVC_PARM_PTR;
+    parm[0].u.pointer.addr = (void*)aName.c_str();
+    parm[0].u.pointer.size = (uint32_t)aName.length() + 1; /* The + 1 is the null terminator */
+
+    int vrc = m_pVMMDev->hgcmHostCall("VBoxGuestPropSvc", DEL_PROP_HOST,
+                                      1, &parm[0]);
+
+    HRESULT hrc = S_OK;
+    if (RT_FAILURE(vrc))
+        hrc = setError(VBOX_E_IPRT_ERROR, tr("The VBoxGuestPropSvc service call failed with the error %Rrc"), vrc);
+    return hrc;
+#endif /* VBOX_WITH_GUEST_PROPS */
+}
 
 /**

trunk/src/VBox/Main/src-client/SessionImpl.cpp ¶

@@ -823 +823 @@
 
 HRESULT Session::accessGuestProperty(const com::Utf8Str &aName, const com::Utf8Str &aValue, const com::Utf8Str &aFlags,
-                                     BOOL aIsSetter, com::Utf8Str &aRetValue, LONG64 *aRetTimestamp, com::Utf8Str &aRetFlags)
+                                     ULONG aAccessMode, com::Utf8Str &aRetValue, LONG64 *aRetTimestamp, com::Utf8Str &aRetFlags)
 {
 #ifdef VBOX_WITH_GUEST_PROPS
@@ -834 +834 @@
     if (aName.isEmpty())
         return E_INVALIDARG;
-    if (!aIsSetter && !VALID_PTR(aRetTimestamp))
+    if (aAccessMode == 0 && !RT_VALID_PTR(aRetTimestamp))
         return E_POINTER;
 
@@ -842 +842 @@
         return E_ACCESSDENIED;
 
-    if (!aIsSetter)
-    {
-        Bstr bstrRetValue;
-        Bstr bstrRetFlags;
-        HRESULT hr = mConsole->i_getGuestProperty(Bstr(aName).raw(),
-                                                  bstrRetValue.asOutParam(), aRetTimestamp, bstrRetFlags.asOutParam());
-        if (SUCCEEDED(hr))
-        {
-            aRetValue = bstrRetValue;
-            aRetFlags = bstrRetFlags;
-        }
-        return hr;
-    }
+    HRESULT hr;
+    if (aAccessMode == 2)
+        hr = mConsole->i_deleteGuestProperty(aName);
+    else if (aAccessMode == 1)
+        hr = mConsole->i_setGuestProperty(aName, aValue, aFlags);
+    else if (aAccessMode == 0)
+        hr = mConsole->i_getGuestProperty(aName, &aRetValue, aRetTimestamp, &aRetFlags);
     else
-        return mConsole->i_setGuestProperty(Bstr(aName).raw(), Bstr(aValue).raw(), Bstr(aFlags).raw());
-
+        hr = E_INVALIDARG;
+
+    return hr;
 # else  /* VBOX_COM_INPROC_API_CLIENT */
     /** @todo This is nonsense, non-VM API users shouldn't need to deal with this

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

@@ -5493 +5493 @@
         rc = E_ACCESSDENIED;
     else
-        rc = directControl->AccessGuestProperty(Bstr(aName).raw(), NULL, NULL,
-                                                false /* isSetter */,
+        rc = directControl->AccessGuestProperty(Bstr(aName).raw(), Bstr("").raw(), Bstr("").raw(),
+                                                0 /* accessMode */,
                                                 &bValue, aTimestamp, &bFlags);
 
@@ -5543 +5543 @@
  */
 HRESULT Machine::i_setGuestPropertyToService(const com::Utf8Str &aName, const com::Utf8Str &aValue,
-                                             const com::Utf8Str &aFlags)
+                                             const com::Utf8Str &aFlags, bool fDelete)
 {
     using namespace guestProp;
@@ -5559 +5559 @@
             return setError(E_INVALIDARG, tr("Invalid guest property flag values: '%s'"), aFlags.c_str());
 
-        bool fDelete = aValue.isEmpty();
         HWData::GuestPropertyMap::iterator it = mHWData->mGuestProperties.find(aName);
         if (it == mHWData->mGuestProperties.end())
@@ -5637 +5636 @@
  */
 HRESULT Machine::i_setGuestPropertyToVM(const com::Utf8Str &aName, const com::Utf8Str &aValue,
-                                        const com::Utf8Str &aFlags)
+                                        const com::Utf8Str &aFlags, bool fDelete)
 {
     HRESULT rc;
@@ -5652 +5651 @@
             /** @todo Fix when adding DeleteGuestProperty(), see defect. */
             rc = directControl->AccessGuestProperty(Bstr(aName).raw(), Bstr(aValue).raw(), Bstr(aFlags).raw(),
-                                                    true /* isSetter */,
+                                                    fDelete? 2: 1 /* accessMode */,
                                                     &dummy, &dummy64, &dummy);
     }
@@ -5670 +5669 @@
     ReturnComNotImplemented();
 #else // VBOX_WITH_GUEST_PROPS
-    HRESULT rc = i_setGuestPropertyToVM(aProperty, aValue, aFlags);
+    HRESULT rc = i_setGuestPropertyToVM(aProperty, aValue, aFlags, /* fDelete = */ false);
     if (rc == E_ACCESSDENIED)
         /* The VM is not running or the service is not (yet) accessible */
-        rc = i_setGuestPropertyToService(aProperty, aValue, aFlags);
+        rc = i_setGuestPropertyToService(aProperty, aValue, aFlags, /* fDelete = */ false);
     return rc;
 #endif // VBOX_WITH_GUEST_PROPS
@@ -5685 +5684 @@
 HRESULT Machine::deleteGuestProperty(const com::Utf8Str &aName)
 {
-    return setGuestProperty(aName, "", "");
+#ifndef VBOX_WITH_GUEST_PROPS
+    ReturnComNotImplemented();
+#else // VBOX_WITH_GUEST_PROPS
+    HRESULT rc = i_setGuestPropertyToVM(aName, "", "", /* fDelete = */ true);
+    if (rc == E_ACCESSDENIED)
+        /* The VM is not running or the service is not (yet) accessible */
+        rc = i_setGuestPropertyToService(aName, "", "", /* fDelete = */ true);
+    return rc;
+#endif // VBOX_WITH_GUEST_PROPS
 }