Changeset 13328 in vbox for trunk/src

Timestamp:

Oct 16, 2008 10:16:40 AM (16 years ago)

Author:

vboxsync

Message:

HostServices and Main: Guest Properties: use flag settings at runtime

Location:

trunk/src/VBox

Files:

• HostServices/GuestProperties/service.cpp (modified) (12 diffs)
• Main/ConsoleImpl.cpp (modified) (3 diffs)

trunk/src/VBox/HostServices/GuestProperties/service.cpp

@@ -148 +148 @@
         rc = RTThreadCreate(&mReqThread, reqThreadFn, this, 0, RTTHREADTYPE_MSG_PUMP,
                                 RTTHREADFLAGS_WAITABLE, "GuestPropReq");
-        if (!RT_SUCCESS(rc))
+        if (RT_FAILURE(rc))
             throw rc;
     }
@@ -214 +214 @@
     int getPropValue(uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
     int getProperty(uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
-    int setProperty(uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool notify);
-    int delProperty(uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool notify);
+    int setProperty(uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool isGuest);
+    int delProperty(uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool isGuest);
     int enumProps(uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
     void notifyHost(const char *pszProperty);
@@ -451 +451 @@
  * @thread  HGCM
  */
-int Service::setProperty(uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool notify)
+int Service::setProperty(uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool isGuest)
 {
     int rc = VINF_SUCCESS;
@@ -482 +482 @@
         rc = VERR_INVALID_PARAMETER;
     /*
-     * And check the values passed in the parameters for correctness.
+     * Check the values passed in the parameters for correctness.
      */
     if (RT_SUCCESS(rc))
@@ -492 +492 @@
     if (RT_SUCCESS(rc))
         rc = validateValue(pszValue, cchValue);
-    if (RT_SUCCESS(rc))
-    {
-        /* We deal with flags as follows:
-         *  1) if flags are specified by the user, use them.
-         *  2) if no flags are specified, but the property exists, use the
-         *     existing flags.
-         *  3) if no flags are specified and the property does not exist,
-         *     start with empty flags (the default value of fFlags above). */
-        if (3 == cParms)
-        {
-            char *pszFlags;
-            uint32_t cchFlags;
-            rc = VBoxHGCMParmPtrGet(&paParms[2], (void **) &pszFlags, &cchFlags);
-            if (RT_SUCCESS(rc))
-                rc = validateFlags(pszFlags, &fFlags);
-        }
-        else
-            /* If this fails then fFlags will remain at zero, as per our spec. */
-            CFGMR3QueryU32(mpFlagsNode, pszName, &fFlags);
+
+    /*
+     * If the property already exists, check its flags to see if we are allowed
+     * to change it.
+     */
+    if (RT_SUCCESS(rc))
+    {
+        CFGMR3QueryU32(mpFlagsNode, pszName, &fFlags);  /* Failure is no problem here. */
+        if (   (fFlags & READONLY)
+            || (isGuest && (fFlags & HOSTWRITE))
+            || (!isGuest && (fFlags & GUESTWRITE))
+           )
+            rc = VERR_PERMISSION_DENIED;
+    }
+
+    /*
+     * Check whether the user supplied flags (if any) are valid.
+     */
+    if (RT_SUCCESS(rc) && (3 == cParms))
+    {
+        char *pszFlags;
+        uint32_t cchFlags;
+        rc = VBoxHGCMParmPtrGet(&paParms[2], (void **) &pszFlags, &cchFlags);
+        if (RT_SUCCESS(rc))
+            rc = validateFlags(pszFlags, &fFlags);
     }
     /*
@@ -529 +535 @@
         /* If anything goes wrong, make sure that we leave a clean state
          * behind. */
-        if (!RT_SUCCESS(rc))
+        if (RT_FAILURE(rc))
         {
             CFGMR3RemoveValue(mpValueNode, pszName);
@@ -541 +547 @@
     if (RT_SUCCESS(rc))
     {
-        if (notify)
+        if (isGuest)
             notifyHost(pszName);
         Log2(("Set string %s, rc=%Rrc, value=%s\n", pszName, rc, pszValue));
@@ -559 +565 @@
  * @thread  HGCM
  */
-int Service::delProperty(uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool notify)
+int Service::delProperty(uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool isGuest)
 {
     int rc = VINF_SUCCESS;
@@ -567 +573 @@
     LogFlowThisFunc(("\n"));
     AssertReturn(VALID_PTR(mpValueNode), VERR_WRONG_ORDER);  /* a.k.a. VERR_NOT_INITIALIZED */
+
+    /*
+     * Check the user-supplied parameters.
+     */
     if (   (cParms != 1)  /* Hardcoded value as the next lines depend on it. */
         || (paParms[0].type != VBOX_HGCM_SVC_PARM_PTR)   /* name */
@@ -575 +585 @@
     if (RT_SUCCESS(rc))
         rc = validateName(pszName, cbName);
+
+    /*
+     * If the property already exists, check its flags to see if we are allowed
+     * to change it.
+     */
+    if (RT_SUCCESS(rc))
+    {
+        uint32_t fFlags = NILFLAG;
+        CFGMR3QueryU32(mpFlagsNode, pszName, &fFlags);  /* Failure is no problem here. */
+        if (   (fFlags & READONLY)
+            || (isGuest && (fFlags & HOSTWRITE))
+            || (!isGuest && (fFlags & GUESTWRITE))
+           )
+            rc = VERR_PERMISSION_DENIED;
+    }
+
+    /*
+     * And delete the property if all is well.
+     */
     if (RT_SUCCESS(rc))
     {
         CFGMR3RemoveValue(mpValueNode, pszName);
-        if (notify)
+        if (isGuest)
             notifyHost(pszName);
     }
@@ -817 +846 @@
                              (uint32_t) RT_HIDWORD(u64Timestamp),
                              (uint32_t) RT_LODWORD(u64Timestamp), pszFlags);
-        if (!RT_SUCCESS(rc)) /* clean up */
+        if (RT_FAILURE(rc)) /* clean up */
         {
             RTStrFree(pszName);
@@ -836 +865 @@
                              mpvHostData, pszName, NULL, 0, 0, NULL);
     }
-    if (!RT_SUCCESS(rc)) /* clean up if we failed somewhere */
+    if (RT_FAILURE(rc)) /* clean up if we failed somewhere */
     {
         RTStrFree(pszName);

trunk/src/VBox/Main/ConsoleImpl.cpp

@@ -3688 +3688 @@
     /* The returned string should never be able to be greater than our buffer */
     AssertLogRel (vrc != VERR_BUFFER_OVERFLOW);
-    AssertLogRel (!RT_SUCCESS(vrc) || VBOX_HGCM_SVC_PARM_64BIT == parm[2].type);
+    AssertLogRel (RT_FAILURE(vrc) || VBOX_HGCM_SVC_PARM_64BIT == parm[2].type);
     if (RT_SUCCESS (vrc) || (VERR_NOT_FOUND == vrc))
     {
@@ -4477 +4477 @@
     for (pValue = CFGMR3GetFirstValue (pValues); pValue != NULL;
          pValue = CFGMR3GetNextValue (pValue))
-        ++cValues;
+    {
+        char szPropName[guestProp::MAX_NAME_LEN + 1];
+        vrc = CFGMR3GetValueName (pValue, szPropName, sizeof(szPropName));
+        if (RT_SUCCESS(vrc))
+        {
+            /* Do not send transient properties unless we are saving state */
+            uint32_t fFlags = guestProp::NILFLAG;
+            CFGMR3QueryU32 (pFlags, szPropName, &fFlags);
+            if (!(fFlags & guestProp::TRANSIENT) ||
+                (mMachineState == MachineState_Saving))
+                ++cValues;
+        }
+    }
     /* And pack them into safe arrays */
     com::SafeArray <BSTR> names(cValues);
@@ -4499 +4511 @@
         if (RT_SUCCESS(vrc))
         {
-            uint32_t fFlags;
+            uint32_t fFlags = NILFLAG;
             CFGMR3QueryU32 (pFlags, szPropName, &fFlags);
-            writeFlags(fFlags, szPropFlags);
-            CFGMR3QueryU64 (pTimestamps, szPropName, &u64Timestamp);
-            Bstr(szPropName).cloneTo(&names[iProp]);
-            Bstr(szPropValue).cloneTo(&values[iProp]);
-            timestamps[iProp] = u64Timestamp;
-            Bstr(szPropFlags).cloneTo(&flags[iProp]);
+            /* Skip transient properties unless we are saving state */
+            if (!(fFlags & TRANSIENT) ||
+                (mMachineState == MachineState_Saving))
+            {
+                writeFlags(fFlags, szPropFlags);
+                CFGMR3QueryU64 (pTimestamps, szPropName, &u64Timestamp);
+                Bstr(szPropName).cloneTo(&names[iProp]);
+                Bstr(szPropValue).cloneTo(&values[iProp]);
+                timestamps[iProp] = u64Timestamp;
+                Bstr(szPropFlags).cloneTo(&flags[iProp]);
+                ++iProp;
+                if (iProp >= cValues)
+                    vrc = VERR_TOO_MUCH_DATA;
+            }
             pValue = CFGMR3GetNextValue (pValue);
-            ++iProp;
-            if (iProp >= cValues)
-                vrc = VERR_TOO_MUCH_DATA;
         }
     }