Changeset 9882 in vbox

Timestamp:

Jun 23, 2008 2:58:51 PM (17 years ago)

Author:

vboxsync

Message:

HostServices/SharedInfoServices: deal with empty registry values correctly (both getting and setting)

Location:

trunk

Files:

• include/VBox/HostServices/VBoxInfoSvc.h (modified) (5 diffs)
• src/VBox/HostServices/SharedInfoServices/service.cpp (modified) (3 diffs)

trunk/include/VBox/HostServices/VBoxInfoSvc.h

@@ -37 +37 @@
     /** Pass the address of the console object from Main to the service */
     SET_CFGM_NODE = 1,
-    /** Get the value attached to an extra data key in the machine XML file */
+    /** 
+     * Get the value attached to an extra data key in the machine XML file.
+     * The parameter format matches that of GET_CONFIG_KEY. 
+     */
     GET_CONFIG_KEY_HOST = 2,
-    /** Set the value attached to an extra data key in the machine XML file */
+    /** 
+     * Set the value attached to an extra data key in the machine XML file.
+     * The parameter format matches that of SET_CONFIG_KEY.
+     */
     SET_CONFIG_KEY_HOST = 3
 };
@@ -81 +87 @@
      *  - Less than or equal to VBOX_SHARED_INFO_KEY_MAX_LEN bytes in length
      *  - Zero terminated
-     *  - Starting with the string VBOX_SHARED_INFO_KEY_PREFIX
      */
     HGCMFunctionParameter key;
@@ -92 +97 @@
     /**
      * The size of the value.  If this is greater than the size of the array
-     * supplied by the guest then no data was transferred and the call must
-     * be repeated. (OUT uint32_t)
+     * supplied in the second parameter then no data was transferred and the
+     * call must be repeated.  If it is zero then no value was found.
+     * (OUT uint32_t)
      */
     HGCMFunctionParameter size;
@@ -108 +114 @@
      *  - Less than or equal to VBOX_SHARED_INFO_KEY_MAX_LEN bytes in length
      *  - Zero terminated
-     *  - Starting with the string VBOX_SHARED_INFO_KEY_PREFIX
      */
     HGCMFunctionParameter key;
@@ -115 +120 @@
      * The value of the key (IN pointer)
      * Criteria as for the key parameter, but with length less that or equal to
-     * VBOX_SHARED_INFO_KEY_MAX_VALUE_LEN
+     * VBOX_SHARED_INFO_KEY_MAX_VALUE_LEN.  A null pointer causes the value to
+     * be removed from the database.
      */
     HGCMFunctionParameter value;

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

@@ -202 +202 @@
     if (RT_SUCCESS(rc) && (rc != VINF_BUFFER_OVERFLOW))
         Log2(("Queried string %s, rc=%Rrc, value=%.*s\n", pszKey, rc, cbValue, pcValue));
+    else if (VERR_CFGM_VALUE_NOT_FOUND == rc)
+    {
+        VBoxHGCMParmUInt32Set(&paParms[2], 0);
+        rc = VINF_SUCCESS;
+    }
     LogFlowThisFunc(("rc = %Rrc\n", rc));
     return rc;
@@ -285 +290 @@
     {
         CFGMR3RemoveValue(mpNode, pszKey);
-        rc = CFGMR3InsertString(mpNode, pszKey, pszValue);
+        if (pszValue > 0)
+            rc = CFGMR3InsertString(mpNode, pszKey, pszValue);
     }
     if (RT_SUCCESS(rc))
@@ -327 +333 @@
         rc = VERR_INVALID_PARAMETER;
 
-    /* Validate the format of the value. */
-    /* Only accept values in printable ASCII without spaces */
-    for (count = 0; (count < cbValue) && (pcValue[count] != '\0'); ++count)
-        if ((pcValue[count] < 33) || (pcValue[count] > 126))
+    if (cbValue != 0)
+    {
+        /* Validate the format of the value. */
+        /* Only accept values in printable ASCII without spaces */
+        for (count = 0; (count < cbValue) && (pcValue[count] != '\0'); ++count)
+            if ((pcValue[count] < 33) || (pcValue[count] > 126))
+                rc = VERR_INVALID_PARAMETER;
+        if (RT_SUCCESS(rc) && (count == cbValue))
+            /* This would mean that no null terminator was found */
             rc = VERR_INVALID_PARAMETER;
-    if (RT_SUCCESS(rc) && (count == cbValue))
-        /* This would mean that no null terminator was found */
-        rc = VERR_INVALID_PARAMETER;
-    if (RT_SUCCESS(rc) && (count > KEY_MAX_VALUE_LEN))
-        rc = VERR_INVALID_PARAMETER;
-
-    if (RT_SUCCESS(rc))
-        LogFlow(("    pcKey=%s, pcValue=%s\n", pcKey, pcValue));
+        if (RT_SUCCESS(rc) && (count > KEY_MAX_VALUE_LEN))
+            rc = VERR_INVALID_PARAMETER;
+    }
+
+    if (RT_SUCCESS(rc))
+        LogFlow(("    pcKey=%s, pcValue=%s\n", pcKey, cbValue > 0 ? pcValue : NULL));
     LogFlowFunc(("returning %Rrc\n", rc));
     return rc;