Changeset 10003 in vbox for trunk

Timestamp:

Jun 27, 2008 9:26:27 PM (17 years ago)

Author:

vboxsync

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

32460

Message:

HostServices/SharedInfoServices: added a request to remove a guest property

Location:

trunk

Files:

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

trunk/include/VBox/HostServices/VBoxInfoSvc.h

@@ -38 +38 @@
     SET_CFGM_NODE = 1,
     /** 
-     * Get the value attached to an extra data key in the machine XML file.
+     * Get the value attached to a configuration property key
      * 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 a configuration property key
      * The parameter format matches that of SET_CONFIG_KEY.
      */
-    SET_CONFIG_KEY_HOST = 3
+    SET_CONFIG_KEY_HOST = 3,
+    /** 
+     * Remove the value attached to a configuration property key
+     * The parameter format matches that of DEL_CONFIG_KEY.
+     */
+    DEL_CONFIG_KEY_HOST = 4
 };
 
@@ -55 +60 @@
 enum eGuestFn
 {
-    /** Get the value attached to an extra data key in the machine XML file */
+    /** Get the value attached to a configuration property key */
     GET_CONFIG_KEY = 1,
-    /** Set the value attached to an extra data key in the machine XML file */
-    SET_CONFIG_KEY = 2
+    /** Set the value attached to a configuration property key */
+    SET_CONFIG_KEY = 2,
+    /** Remove the value attached to a configuration property key */
+    DEL_CONFIG_KEY = 3
 };
 
@@ -125 +132 @@
     HGCMFunctionParameter value;
 } SetConfigKey;
+
+/** The guest is requesting to remove a configuration key */
+typedef struct _DelConfigKey
+{
+    VBoxGuestHGCMCallInfo hdr;
+
+    /**
+     * The key to change up.  This must fit to a number of criteria, namely
+     *  - Only ASCII characters with no spaces
+     *  - Less than or equal to VBOX_SHARED_INFO_KEY_MAX_LEN bytes in length
+     *  - Zero terminated
+     */
+    HGCMFunctionParameter key;
+} DelConfigKey;
 #pragma pack ()
 

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

@@ -23 +23 @@
 /**
  * An HGCM service for passing requests which do not need any persistant state
- * to handle.  We currently only support two types of request - set guest
- * configuration key (SET_CONFIG_KEY and SET_CONFIG_KEY_HOST) and get
- * configuration key (GET_CONFIG_KEY and GET_CONFIG_KEY_HOST).  These may be
- * used to read and to write configuration information which is available to
+ * to handle.  We currently only support three types of request - set guest
+ * property (SET_CONFIG_KEY and SET_CONFIG_KEY_HOST), get guest property
+ * (GET_CONFIG_KEY and GET_CONFIG_KEY_HOST) and remove guest property
+ * (DEL_CONFIG_KEY and DEL_CONFIG_KEY_HOST).  These may be used to read, to
+ * write and to remove configuration information which is available to
  * both guest and host.  This configuration information is stored in a CFGM
  * node using the CFGM APIs.  It is the responsibility of whoever creates the
@@ -157 +158 @@
     int getKey(uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
     int setKey(uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
+    int delKey(uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
     void call (VBOXHGCMCALLHANDLE callHandle, uint32_t u32ClientID,
                void *pvClient, uint32_t eFunction, uint32_t cParms,
@@ -336 +338 @@
 
 /**
+ * Remove a value in the guest registry by key, checking the validity
+ * of the arguments passed.
+ *
+ * @returns iprt status value
+ * @param   cParms  the number of HGCM parameters supplied
+ * @param   paParms the array of HGCM parameters
+ * @thread  HGCM
+ */
+int Service::delKey(uint32_t cParms, VBOXHGCMSVCPARM paParms[])
+{
+    int rc = VINF_SUCCESS;
+    char *pszKey, *pszValue;
+    uint32_t cbKey, cbValue;
+
+    LogFlowThisFunc(("\n"));
+    if (   (cParms != 1)  /* Hardcoded value as the next lines depend on it. */
+        || (paParms[0].type != VBOX_HGCM_SVC_PARM_PTR)   /* key */
+       )
+        rc = VERR_INVALID_PARAMETER;
+    if (RT_SUCCESS(rc))
+        rc = VBoxHGCMParmPtrGet(&paParms[0], (void **) &pszKey, &cbKey);
+    if (RT_SUCCESS(rc))
+        rc = validateKey(pszKey, cbKey);
+    if (RT_SUCCESS(rc))
+        CFGMR3RemoveValue(mpNode, pszKey);
+    LogFlowThisFunc(("rc = %Rrc\n", rc));
+    return rc;
+}
+
+
+/**
  * Handle an HGCM service call.
  * @copydoc VBOXHGCMSVCFNTABLE::pfnCall
@@ -367 +400 @@
             if (RT_SUCCESS(rc))
                 rc = setKey(cParms, paParms);
+            break;
+
+        /* The guest wishes to remove a configuration value */
+        case DEL_CONFIG_KEY:
+            LogFlowFunc(("DEL_CONFIG_KEY\n"));
+            if (RT_SUCCESS(rc))
+                rc = delKey(cParms, paParms);
             break;
 
@@ -430 +470 @@
             if (RT_SUCCESS(rc))
                 rc = setKey(cParms, paParms);
+            break;
+
+        /* The host wishes to remove a configuration value */
+        case DEL_CONFIG_KEY_HOST:
+            LogFlowFunc(("DEL_CONFIG_KEY_HOST\n"));
+            if (RT_SUCCESS(rc))
+                rc = delKey(cParms, paParms);
             break;