Changeset 108285 in vbox

Timestamp:

Feb 19, 2025 10:53:35 AM (3 weeks ago)

Author:

vboxsync

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

167628

Message:

Host installer/win: Added routines for handling CustomActionData to the common InstallHelper.dll code. Required as a prerequisite for using shared (sessison / system) CustomActionData by the installer, to better support elevated driver installs on modern Windows OSes (>= 10). bugref:10762

Location:

trunk/src/VBox/Installer/win/InstallHelper

Files:

• VBoxCommon.cpp (modified) (2 diffs)
• VBoxCommon.h (modified) (2 diffs)

trunk/src/VBox/Installer/win/InstallHelper/VBoxCommon.cpp

@@ -36 +36 @@
 #include <msiquery.h>
 
+#include <iprt/mem.h>
 #include <iprt/string.h>
 #include <iprt/utf16.h>
@@ -94 +95 @@
 }
 #endif /* !TESTCASE */
+
+/**
+ * Destroys a custom action data entry.
+ *
+ * @param   pEntry              Custom action data entry to destroy.
+ */
+static void vboxMsiCustomActionDataEntryDestroy(PVBOXMSICUSTOMACTIONDATAENTRY pEntry)
+{
+    if (!pEntry)
+        return;
+
+    RTStrFree(pEntry->pszKey);
+    pEntry->pszKey = NULL;
+    RTStrFree(pEntry->pszVal);
+    pEntry->pszVal = NULL;
+}
+
+/**
+ * Queries custom action data entries, extended version.
+ *
+ * @returns VBox status code.
+ * @param   hMsi                MSI handle to use.
+ * @param   pszSep              Separator to use for parsing the key=value pairs.
+ * @param   ppaEntries          Where to return the allocated custom action data entries.
+                                Might be NULL if \a pcEntries returns 0.
+ *                              Must be destroyed using vboxMsiCustomActionDataEntryDestroy().
+ * @param   pcEntries           Where to return the number of allocated custom action data entries of \a ppaEntries.
+ *
+ * @note    The "CustomActionData" property used is fixed by the MSI engine and must not be changed.
+ */
+static int vboxMsiCustomActionDataQueryEx(MSIHANDLE hMsi, const char *pszSep, PVBOXMSICUSTOMACTIONDATAENTRY *ppaEntries, size_t *pcEntries)
+{
+    char *pszData = NULL;
+    int rc = VBoxMsiQueryPropUtf8(hMsi, "CustomActionData", &pszData);
+    if (RT_FAILURE(rc))
+        return rc;
+
+    *ppaEntries = NULL;
+
+    char **ppapszPairs; /* key=value pairs. */
+    size_t cPairs;
+    rc = RTStrSplit(pszData, strlen(pszData) + 1 /* Must include terminator */, pszSep, &ppapszPairs, &cPairs);
+    if (   RT_SUCCESS(rc)
+        && cPairs)
+    {
+        PVBOXMSICUSTOMACTIONDATAENTRY paEntries =
+            (PVBOXMSICUSTOMACTIONDATAENTRY)RTMemAllocZ(cPairs * sizeof(VBOXMSICUSTOMACTIONDATAENTRY));
+        if (paEntries)
+        {
+            size_t i = 0;
+            for (; i < cPairs; i++)
+            {
+                const char *pszPair = ppapszPairs[i];
+
+                char **ppapszKeyVal;
+                size_t cKeyVal;
+                rc = RTStrSplit(pszPair, strlen(pszPair) + 1 /* Must include terminator */, "=", &ppapszKeyVal, &cKeyVal);
+                if (RT_SUCCESS(rc))
+                {
+                    if (cKeyVal == 2) /* Exactly one key=val pair. */
+                    {
+                        /* paEntries[i] will take ownership of ppapszKeyVal. */
+                        paEntries[i].pszKey = ppapszKeyVal[0];
+                        ppapszKeyVal[0] = NULL;
+                        paEntries[i].pszVal = ppapszKeyVal[1];
+                        ppapszKeyVal[1] = NULL;
+                    }
+                    else
+                        rc = VERR_INVALID_PARAMETER;
+
+                    for (size_t a = 0; a < cKeyVal; a++)
+                        RTStrFree(ppapszKeyVal[a]);
+                    RTMemFree(ppapszKeyVal);
+                }
+
+                if (RT_FAILURE(rc))
+                    break;
+            }
+
+            if (RT_FAILURE(rc))
+            {
+                /* Rollback on failure. */
+                while (i)
+                    vboxMsiCustomActionDataEntryDestroy(&paEntries[i--]);
+                RTMemFree(paEntries);
+            }
+            else
+            {
+                *ppaEntries = paEntries;
+                *pcEntries  = cPairs;
+            }
+        }
+        else
+            rc = VERR_NO_MEMORY;
+
+        for (size_t i = 0; i < cPairs; i++)
+            RTStrFree(ppapszPairs[i]);
+        RTMemFree(ppapszPairs);
+    }
+
+    return rc;
+}
+
+/**
+ * Queries custom action data entries.
+ *
+ * @returns VBox status code.
+ * @param   hMsi                MSI handle to use.
+ * @param   ppaEntries          Where to return the allocated custom action data entries.
+ *                              Must be destroyed using vboxMsiCustomActionDataEntryDestroy().
+ * @param   pcEntries           Where to return the number of allocated custom action data entries of \a ppaEntries.
+ */
+static int vboxMsiCustomActionDataQuery(MSIHANDLE hMsi, PVBOXMSICUSTOMACTIONDATAENTRY *ppaEntries, size_t *pcEntries)
+{
+    return vboxMsiCustomActionDataQueryEx(hMsi, VBOX_MSI_CUSTOMACTIONDATA_SEP_STR, ppaEntries, pcEntries);
+}
+
+/**
+ * Frees custom action data.
+ *
+ * @returns VBox status code.
+ * @param   pData               Custom action data to free.
+ *                              The pointer will be invalid on return.
+ */
+void VBoxMsiCustomActionDataFree(PVBOXMSICUSTOMACTIONDATA pData)
+{
+    if (!pData)
+        return;
+
+    for (size_t i = 0; i < pData->cEntries; i++)
+        vboxMsiCustomActionDataEntryDestroy(&pData->paEntries[i]);
+
+    RTMemFree(pData);
+    pData = NULL;
+}
+
+/**
+ * Queries custom action data, extended version.
+ *
+ * @returns VBox status code.
+ * @param   hMsi                MSI handle to use.
+ * @param   pszSep              Separator to use for parsing the key=value pairs.
+ * @param   ppData              Where to return the allocated custom action data.
+ *                              Needs to be free'd using VBoxMsiCustomActionDataFree().
+ */
+int VBoxMsiCustomActionDataQueryEx(MSIHANDLE hMsi, const char *pszSep, PVBOXMSICUSTOMACTIONDATA *ppData)
+{
+    AssertPtrReturn(pszSep, VERR_INVALID_POINTER);
+    AssertPtrReturn(ppData, VERR_INVALID_POINTER);
+
+    PVBOXMSICUSTOMACTIONDATA pData = (PVBOXMSICUSTOMACTIONDATA)RTMemAllocZ(sizeof(VBOXMSICUSTOMACTIONDATA));
+    AssertPtrReturn(pData, VERR_NO_MEMORY);
+
+    int rc = vboxMsiCustomActionDataQueryEx(hMsi, pszSep, &pData->paEntries, &pData->cEntries);
+    if (RT_SUCCESS(rc))
+    {
+        *ppData = pData;
+    }
+    else
+        VBoxMsiCustomActionDataFree(pData);
+
+    return rc;
+}
+
+/**
+ * Queries custom action data.
+ *
+ * @returns VBox status code.
+ * @param   hMsi                MSI handle to use.
+ * @param   ppData              Where to return the allocated custom action data.
+ *                              Needs to be free'd using VBoxMsiCustomActionDataFree().
+ */
+int VBoxMsiCustomActionDataQuery(MSIHANDLE hMsi, PVBOXMSICUSTOMACTIONDATA *ppData)
+{
+    return VBoxMsiCustomActionDataQueryEx(hMsi, VBOX_MSI_CUSTOMACTIONDATA_SEP_STR, ppData);
+}
+
+/**
+ * Finds a key in custom action data and returns its value.
+ *
+ * @returns Value if found, or NULL if not found.
+ * @param   pHaystack           Custom action data to search in.
+ * @param   pszNeedle           Key to search for. Case-sensitive.
+ */
+const char *VBoxMsiCustomActionDataFind(PVBOXMSICUSTOMACTIONDATA pHaystack, const char *pszNeedle)
+{
+    AssertPtrReturn(pHaystack, NULL);
+    AssertPtrReturn(pszNeedle, NULL);
+
+    for (size_t i = 0; i < pHaystack->cEntries; i++)
+    {
+        if (!RTStrICmp(pHaystack->paEntries[i].pszKey, pszNeedle))
+            return pHaystack->paEntries[i].pszVal;
+    }
+
+    return NULL;
+}
 
 /**

trunk/src/VBox/Installer/win/InstallHelper/VBoxCommon.h

@@ -36 +36 @@
 #endif
 
+/** Struct for keeping a single "CustomActionData" key=value item. */
+typedef struct VBOXMSICUSTOMACTIONDATAENTRY
+{
+    /** Key (name) of the item. */
+    char *pszKey;
+    /** Value of the item. Always a string but can represent other stuff. Use with care. */
+    char *pszVal;
+} VBOXMSICUSTOMACTIONDATAENTRY;
+/** Pointer to a struct for keeping a single "CustomActionData" key=value item. */
+typedef VBOXMSICUSTOMACTIONDATAENTRY *PVBOXMSICUSTOMACTIONDATAENTRY;
+
+/** Struct for keeping "CustomActionData" entries. */
+typedef struct VBOXMSICUSTOMACTIONDATA
+{
+    /** Array of CustomActionData entries. */
+    PVBOXMSICUSTOMACTIONDATAENTRY paEntries;
+    /** Number of entries in \a paEntries. */
+    size_t                        cEntries;
+} VBOXMSICUSTOMACTIONDATA;
+/** Pointer to a struct for keeping "CustomActionData" entries. */
+typedef VBOXMSICUSTOMACTIONDATA *PVBOXMSICUSTOMACTIONDATA;
+
+/** Default separator for custom action data key=value pairs. */
+#define VBOX_MSI_CUSTOMACTIONDATA_SEP_STR "##"
+
+void VBoxMsiCustomActionDataFree(PVBOXMSICUSTOMACTIONDATA pData);
+int  VBoxMsiCustomActionDataQueryEx(MSIHANDLE hMsi, const char *pszSep, PVBOXMSICUSTOMACTIONDATA *ppData);
+int  VBoxMsiCustomActionDataQuery(MSIHANDLE hMsi, PVBOXMSICUSTOMACTIONDATA *ppData);
+const char *VBoxMsiCustomActionDataFind(PVBOXMSICUSTOMACTIONDATA pHaystack, const char *pszNeedle);
+
 int  VBoxMsiQueryProp(MSIHANDLE hMsi, const WCHAR *pwszName, WCHAR *pwszVal, DWORD cwVal);
 int  VBoxMsiQueryPropEx(MSIHANDLE hMsi, const WCHAR *pwszName, WCHAR *pwszVal, DWORD *pcwVal);
@@ -41 +71 @@
 int  VBoxMsiQueryPropInt32(MSIHANDLE hMsi, const char *pszName, DWORD *pdwValue);
 UINT VBoxMsiSetProp(MSIHANDLE hMsi, const WCHAR *pwszName, const WCHAR *pwszValue);
-int VBoxMsiSetPropUtf8(MSIHANDLE hMsi, const char *pszName, const char *pszValue);
+int  VBoxMsiSetPropUtf8(MSIHANDLE hMsi, const char *pszName, const char *pszValue);
 UINT VBoxMsiSetPropDWORD(MSIHANDLE hMsi, const WCHAR *pwszName, DWORD dwVal);
-int VBoxMsiRegQueryDWORDW(MSIHANDLE hMsi, HKEY hKey, LPCWSTR pwszName, DWORD *pdwValue);
-int VBoxMsiRegQueryDWORD(MSIHANDLE hMsi, HKEY hKey, const char *pszName, DWORD *pdwValue);
+int  VBoxMsiRegQueryDWORDW(MSIHANDLE hMsi, HKEY hKey, LPCWSTR pwszName, DWORD *pdwValue);
+int  VBoxMsiRegQueryDWORD(MSIHANDLE hMsi, HKEY hKey, const char *pszName, DWORD *pdwValue);
 
 #endif /* !VBOX_INCLUDED_SRC_InstallHelper_VBoxCommon_h */