Fix up COM+ to be back in working order under Wix4+

Table names updated for Wix4 prefix.
Custom action names similarly updated.
Table names Wix4ComPlusUserInApplicationRole,
Wix4ComPlusGroupInApplicationRole and Wix4ComPlusApplicationRoleProperty
had to be shortened to fit within MSI 31 character table name limit.
Migrated from fixed GUID for RegistrationHelper to use CLSIDFromProgID in
an attempt to fix behaviour under .NET 4+ DLLs.
Added setting of Partition enable if a Partition is configured in authoring,
new Windows config has Partitions disabled by default, and they don't work
at all under Windows workstation (non-server) versions.

Added a new Runtime condition for `RequireWindowsServer` which will skip
execution of Runtime test on workstation/desktop OSes, since COM+ Partitions
only work correctly under Windows Server.

Quite a lot of basic typos fixed also.

Signed-off-by: Bevan Weiss <bevan.weiss@gmail.com>

Author: bevanweiss

src/ext/ComPlus/ca/cpapproleexec.cpp

@@ -74,7 +74,7 @@ HRESULT CpiConfigureApplicationRoles(
     hr = CpiActionStartMessage(ppwzData, FALSE);
     ExitOnFailure(hr, "Failed to send action start message");
 
-    // ger count
+    // get count
     int iCnt = 0;
     hr = WcaReadIntegerFromCaData(ppwzData, &iCnt);
     ExitOnFailure(hr, "Failed to read count");
@@ -218,7 +218,7 @@ HRESULT CpiConfigureUsersInApplicationRoles(
     hr = CpiActionStartMessage(ppwzData, FALSE);
     ExitOnFailure(hr, "Failed to send action start message");
 
-    // ger count
+    // get count
     int iCnt = 0;
     hr = WcaReadIntegerFromCaData(ppwzData, &iCnt);
     ExitOnFailure(hr, "Failed to read count");

src/ext/ComPlus/ca/cpapprolesched.cpp

@@ -10,13 +10,13 @@ LPCWSTR vcsApplicationRoleQuery =
 enum eApplicationRoleQuery { arqApplicationRole = 1, arqApplication, arqComponent, arqName };
 
 LPCWSTR vcsUserInApplicationRoleQuery =
-    L"SELECT `UserInApplicationRole`, `ApplicationRole_`, `ComPlusUserInApplicationRole`.`Component_`, `Domain`, `Name` FROM `Wix4ComPlusUserInApplicationRole`, `Wix4User` WHERE `User_` = `User`";
+    L"SELECT `UserInApplicationRole`, `ApplicationRole_`, `Wix4ComPlusUserInAppRole`.`Component_`, `Domain`, `Name` FROM `Wix4ComPlusUserInAppRole`, `Wix4User` WHERE `User_` = `User`";
 LPCWSTR vcsGroupInApplicationRoleQuery =
-    L"SELECT `GroupInApplicationRole`, `ApplicationRole_`, `ComPlusGroupInApplicationRole`.`Component_`, `Domain`, `Name` FROM `Wix4ComPlusGroupInApplicationRole`, `Wix4Group` WHERE `Group_` = `Group`";
+    L"SELECT `GroupInApplicationRole`, `ApplicationRole_`, `Wix4ComPlusGroupInAppRole`.`Component_`, `Domain`, `Name` FROM `Wix4ComPlusGroupInAppRole`, `Wix4Group` WHERE `Group_` = `Group`";
 enum eTrusteeInApplicationRoleQuery { tiarqUserInApplicationRole = 1, tiarqApplicationRole, tiarqComponent, tiarqDomain, tiarqName };
 
 LPCWSTR vcsApplicationRolePropertyQuery =
-    L"SELECT `Name`, `Value` FROM `Wix4ComPlusApplicationRoleProperty` WHERE `ApplicationRole_` = ?";
+    L"SELECT `Name`, `Value` FROM `Wix4ComPlusAppRoleProperty` WHERE `ApplicationRole_` = ?";
 
 
 // property definitions
@@ -95,7 +95,7 @@ HRESULT CpiApplicationRolesRead(
 
     // loop through all application roles
     hr = WcaOpenExecuteView(vcsApplicationRoleQuery, &hView);
-    ExitOnFailure(hr, "Failed to execute view on ComPlusApplicationRole table");
+    ExitOnFailure(hr, "Failed to execute view on Wix4ComPlusApplicationRole table");
 
     while (S_OK == (hr = WcaFetchRecord(hView, &hRec)))
     {
@@ -205,7 +205,7 @@ HRESULT CpiApplicationRolesVerifyInstall(
         if (!pItm->fReferencedForInstall && !(pItm->fHasComponent && WcaIsInstalling(pItm->isInstalled, pItm->isAction)))
             continue;
 
-        // if the role is referensed and is not a locater, it must be installed
+        // if the role is referenced and is not a locater, it must be installed
         if (pItm->fReferencedForInstall && pItm->fHasComponent && !CpiWillBeInstalled(pItm->isInstalled, pItm->isAction))
             MessageExitOnFailure(hr = E_FAIL, msierrComPlusApplicationRoleDependency, "An application role is used by another entity being installed, but is not installed itself, key: %S", pItm->wzKey);
 
@@ -235,7 +235,7 @@ HRESULT CpiApplicationRolesVerifyInstall(
                     switch (er)
                     {
                     case IDABORT:
-                        ExitOnFailure(hr = E_FAIL, "An application with a conflictiong name exists, key: %S", pItm->wzKey);
+                        ExitOnFailure(hr = E_FAIL, "An application with a conflicting name exists, key: %S", pItm->wzKey);
                         break;
                     case IDRETRY:
                         break;
@@ -319,7 +319,7 @@ HRESULT CpiApplicationRolesInstall(
     int iActionType;
 
     // add action text
-    hr = CpiAddActionTextToActionData(L"CreateComPlusApplicationRoles", ppwzActionData);
+    hr = CpiAddActionTextToActionData(CUSTOM_ACTION_DECORATION(L"CreateComPlusApplicationRoles"), ppwzActionData);
     ExitOnFailure(hr, "Failed to add action text to custom action data");
 
     // add count to action data
@@ -371,7 +371,7 @@ HRESULT CpiApplicationRolesUninstall(
     int iActionType;
 
     // add action text
-    hr = CpiAddActionTextToActionData(L"RemoveComPlusApplicationRoles", ppwzActionData);
+    hr = CpiAddActionTextToActionData(CUSTOM_ACTION_DECORATION(L"RemoveComPlusApplicationRoles"), ppwzActionData);
     ExitOnFailure(hr, "Failed to add action text to custom action data");
 
     // add count to action data
@@ -477,7 +477,7 @@ HRESULT CpiUsersInApplicationRolesInstall(
     int iActionType;
 
     // add action text
-    hr = CpiAddActionTextToActionData(L"AddUsersToComPlusApplicationRoles", ppwzActionData);
+    hr = CpiAddActionTextToActionData(CUSTOM_ACTION_DECORATION(L"AddUsersToComPlusApplicationRoles"), ppwzActionData);
     ExitOnFailure(hr, "Failed to add action text to custom action data");
 
     // add count to action data
@@ -529,7 +529,7 @@ HRESULT CpiUsersInApplicationRolesUninstall(
     int iActionType;
 
     // add action text
-    hr = CpiAddActionTextToActionData(L"RemoveUsersFromComPlusAppRoles", ppwzActionData);
+    hr = CpiAddActionTextToActionData(CUSTOM_ACTION_DECORATION(L"RemoveUsersFromComPlusAppRoles"), ppwzActionData);
     ExitOnFailure(hr, "Failed to add action text to custom action data");
 
     // add count to action data

src/ext/ComPlus/ca/cpappsched.cpp

@@ -255,7 +255,7 @@ HRESULT CpiApplicationsVerifyInstall(
         if (!pItm->fReferencedForInstall && !(pItm->fHasComponent && WcaIsInstalling(pItm->isInstalled, pItm->isAction)))
             continue;
 
-        // if the application is referensed and is not a locater, it must be installed
+        // if the application is referenced and is not a locater, it must be installed
         if (pItm->fReferencedForInstall && pItm->fHasComponent && !CpiWillBeInstalled(pItm->isInstalled, pItm->isAction))
             MessageExitOnFailure(hr = E_FAIL, msierrComPlusApplicationDependency, "An application is used by another entity being installed, but is not installed itself, key: %S", pItm->wzKey);
 

src/ext/ComPlus/ca/cpasmexec.cpp

@@ -1,7 +1,7 @@
 // Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
 
 #include "precomp.h"
-
+#include <mscoree.h>
 
 // GAC related declarations
 
@@ -61,13 +61,11 @@ IAssemblyCache : public IUnknown
 
 typedef HRESULT (__stdcall *LoadLibraryShimFunc)(LPCWSTR szDllName, LPCWSTR szVersion, LPVOID pvReserved, HMODULE *phModDll);
 typedef HRESULT (__stdcall *CreateAssemblyCacheFunc)(IAssemblyCache **ppAsmCache, DWORD dwReserved);
+typedef HRESULT (__stdcall *GetFileVersionFnPtr)(LPCWSTR szFilename, _Out_writes_to_opt_(cchBuffer, *dwLength) LPWSTR szBuffer, DWORD cchBuffer, DWORD* dwLength);
+typedef HRESULT (__stdcall *CorBindToRuntimeExFnPtr)(LPCWSTR pwszVersion, LPCWSTR pwszBuildFlavor, DWORD startupFlags, REFCLSID rclsid, REFIID riid, LPVOID FAR* ppv);
 
 
 // RegistrationHelper related declarations
-
-static const GUID CLSID_RegistrationHelper =
-    { 0x89a86e7b, 0xc229, 0x4008, { 0x9b, 0xaa, 0x2f, 0x5c, 0x84, 0x11, 0xd7, 0xe0 } };
-
 enum eInstallationFlags {
     ifConfigureComponentsOnly = 16,
     ifFindOrCreateTargetApplication = 4,
@@ -156,7 +154,8 @@ static HRESULT UnregisterAssembly(
 static void InitAssemblyExec();
 static void UninitAssemblyExec();
 static HRESULT GetRegistrationHelper(
-    IDispatch** ppiRegHlp
+    IDispatch** ppiRegHlp,
+    LPCWSTR pwzAssemblyPath
     );
 static HRESULT GetAssemblyCacheObject(
     IAssemblyCache** ppAssemblyCache
@@ -722,15 +721,44 @@ static void UninitAssemblyExec()
 }
 
 static HRESULT GetRegistrationHelper(
-    IDispatch** ppiRegHlp
+    IDispatch** ppiRegHlp,
+    LPCWSTR pwzAssemblyPath
     )
 {
     HRESULT hr = S_OK;
+    wchar_t pwzVersion[MAX_PATH];
+    DWORD pcchVersionLen = MAX_PATH;
+    ICLRRuntimeHost* runtimeHost = NULL;
+
+    if (!ghMscoree)
+    {
+        ghMscoree = ::LoadLibraryW(L"mscoree.dll");
+        ExitOnNull(ghMscoree, hr, E_FAIL, "Failed to load mscoree.dll");
+    }
+    GetFileVersionFnPtr GetFileVersion = (GetFileVersionFnPtr)::GetProcAddress(ghMscoree, "GetFileVersion");
+    ExitOnNull(GetFileVersion, hr, E_FAIL, "Failed to GetProcAddress for 'GetFileVersion' from 'mscoree.dll'");
+    hr = GetFileVersion(pwzAssemblyPath, pwzVersion, pcchVersionLen, &pcchVersionLen);
 
     if (!gpiRegHlp)
     {
+        CLSID CLSID_RegistrationHelper{};
+        hr = ::CLSIDFromProgID(OLESTR("System.EnterpriseServices.RegistrationHelper"), &CLSID_RegistrationHelper);
+        ExitOnFailure(hr, "Failed to identify CLSID for 'System.EnterpriseServices.RegistrationHelper'");
+
+        // NOTE: The 'CoreBindToRuntimeEx' method is DEPRECATED in .NET v4.
+        // HOWEVER, we might be running in an earlier context at this point so we don't want to rely upon stuff that is particularly v4 dependent.
+        // Even if we are about to try to fire up a v4 runtime.
+        // The .NET v4 runtime with STARTUP_LOADER_SAFEMODE flag (to disable version checking of loaded assemblies) is what lets us launch the
+        // RegistrationHelper.  The v4 RegistrationHelper is able to register both v4 and v3 assemblies however, so if we can get it, we most as well
+        // use it.
+        CorBindToRuntimeExFnPtr CorBindToRuntimeEx = (CorBindToRuntimeExFnPtr)::GetProcAddress(ghMscoree, "CorBindToRuntimeEx");
+        hr = CorBindToRuntimeEx(L"v4.0.30319", L"wks", STARTUP_LOADER_SAFEMODE, CLSID_CLRRuntimeHost, IID_ICLRRuntimeHost, (LPVOID*)&runtimeHost);
+        // we ignore the HRESULT here.  If it worked, great, we'll use it moving forward.  If it didn't work, we'll end up trying to resort to legacy .NET FW
+        // when we just try the COM Create below
+
         // create registration helper object
-        hr = ::CoCreateInstance(CLSID_RegistrationHelper, NULL, CLSCTX_ALL, IID_IDispatch, (void**)&gpiRegHlp); 
+        // This will be created in the .NET FW 4 version if we managed to launch it above, or in the .NET FW <4 version based on the COM dispatch otherwise
+        hr = ::CoCreateInstance(CLSID_RegistrationHelper, NULL, CLSCTX_ALL, IID_IDispatch, (void**)&gpiRegHlp);
         ExitOnFailure(hr, "Failed to create registration helper object");
     }
 
@@ -883,7 +911,7 @@ static HRESULT RegisterDotNetAssembly(
     }
 
     // get registration helper object
-    hr = GetRegistrationHelper(&piRegHlp);
+    hr = GetRegistrationHelper(&piRegHlp, pAttrs->pwzDllPath);
     ExitOnFailure(hr, "Failed to get registration helper object");
 
     // get dispatch id of InstallAssembly() method
@@ -979,7 +1007,7 @@ static HRESULT RegisterNativeAssembly(
     ExitOnNull(bstrTlbPath, hr, E_OUTOFMEMORY, "Failed to allocate BSTR for tlb path");
 
     bstrPSDllPath = ::SysAllocString(pAttrs->pwzPSDllPath ? pAttrs->pwzPSDllPath : L"");
-    ExitOnNull(bstrPSDllPath, hr, E_OUTOFMEMORY, "Failed to allocate BSTR for tlb path");
+    ExitOnNull(bstrPSDllPath, hr, E_OUTOFMEMORY, "Failed to allocate BSTR for proxy/stub dll path");
 
     // get catalog
     hr = CpiExecGetAdminCatalog(&piCatalog);
@@ -1089,7 +1117,7 @@ static HRESULT UnregisterDotNetAssembly(
     ExitOnNull(bstrDllPath, hr, E_OUTOFMEMORY, "Failed to allocate BSTR for dll path");
 
     // get registration helper object
-    hr = GetRegistrationHelper(&piRegHlp);
+    hr = GetRegistrationHelper(&piRegHlp, pAttrs->pwzDllPath);
     ExitOnFailure(hr, "Failed to get registration helper object");
 
     // get dispatch id of UninstallAssembly() method

src/ext/ComPlus/ca/cpasmsched.cpp

@@ -408,7 +408,7 @@ HRESULT CpiAssembliesVerifyInstall(
         if (!pItm->fReferencedForInstall && !pItm->iRoleAssignmentsInstallCount && !WcaIsInstalling(pItm->isInstalled, pItm->isAction))
             continue;
 
-        // if the assembly is referensed, it must be installed
+        // if the assembly is referenced, it must be installed
         if ((pItm->fReferencedForInstall || pItm->iRoleAssignmentsInstallCount) && !CpiWillBeInstalled(pItm->isInstalled, pItm->isAction))
             MessageExitOnFailure(hr = E_FAIL, msierrComPlusAssemblyDependency, "An assembly is used by another entity being installed, but is not installed itself, key: %S", pItm->wzKey);
     }

src/ext/ComPlus/ca/cpexec.cpp

@@ -180,7 +180,7 @@ extern "C" UINT __stdcall ComPlusInstallExecute(MSIHANDLE hInstall)
     if (INVALID_HANDLE_VALUE != hRollbackFile)
         ::CloseHandle(hRollbackFile);
 
-    // unitialize
+    // uninitialize
     CpiExecFinalize();
 
     if (fInitializedCom)
@@ -258,7 +258,7 @@ extern "C" UINT __stdcall ComPlusInstallExecuteCommit(MSIHANDLE hInstall)
     if (INVALID_HANDLE_VALUE != hRollbackFile)
         ::CloseHandle(hRollbackFile);
 
-    // unitialize
+    // uninitialize
     CpiExecFinalize();
 
     if (fInitializedCom)
@@ -415,7 +415,7 @@ extern "C" UINT __stdcall ComPlusRollbackInstallExecute(MSIHANDLE hInstall)
     if (prdSubscriptions)
         CpiFreeRollbackDataList(prdSubscriptions);
 
-    // unitialize
+    // uninitialize
     CpiExecFinalize();
 
     if (fInitializedCom)
@@ -521,7 +521,7 @@ extern "C" UINT __stdcall ComPlusUninstallExecute(MSIHANDLE hInstall)
     if (INVALID_HANDLE_VALUE != hRollbackFile)
         ::CloseHandle(hRollbackFile);
 
-    // unitialize
+    // uninitialize
     CpiExecFinalize();
 
     if (fInitializedCom)
@@ -670,7 +670,7 @@ extern "C" UINT __stdcall ComPlusRollbackUninstallExecute(MSIHANDLE hInstall)
     if (prdSubscriptions)
         CpiFreeRollbackDataList(prdSubscriptions);
 
-    // unitialize
+    // uninitialize
     CpiExecFinalize();
 
     if (fInitializedCom)

src/ext/ComPlus/ca/cppartexec.cpp

@@ -34,6 +34,7 @@ static HRESULT ReadPartitionAttributes(
 static void FreePartitionAttributes(
     CPI_PARTITION_ATTRIBUTES* pAttrs
     );
+static HRESULT CpiEnsurePartitionsEnabled();
 static HRESULT CreatePartition(
     CPI_PARTITION_ATTRIBUTES* pAttrs
     );
@@ -71,7 +72,7 @@ HRESULT CpiConfigurePartitions(
     hr = CpiActionStartMessage(ppwzData, FALSE);
     ExitOnFailure(hr, "Failed to send action start message");
 
-    // ger partition count
+    // get partition count
     int iCnt = 0;
     hr = WcaReadIntegerFromCaData(ppwzData, &iCnt);
     ExitOnFailure(hr, "Failed to read count");
@@ -215,7 +216,7 @@ HRESULT CpiConfigurePartitionUsers(
     hr = CpiActionStartMessage(ppwzData, FALSE);
     ExitOnFailure(hr, "Failed to send action start message");
 
-    // ger partition count
+    // get partition count
     int iCnt = 0;
     hr = WcaReadIntegerFromCaData(ppwzData, &iCnt);
     ExitOnFailure(hr, "Failed to read count");
@@ -384,6 +385,69 @@ static void FreePartitionAttributes(
         CpiFreePropertyList(pAttrs->pPropList);
 }
 
+static HRESULT CpiEnsurePartitionsEnabled()
+{
+    HRESULT hr = S_OK;
+
+    ICatalogCollection* piLocalComputerColl = NULL;
+    IDispatch* piDisp = NULL;
+    ICatalogObject* piLocalComputerObj = NULL;
+    VARIANT vtVal;
+    BSTR bsPartitionsEnabledName = ::SysAllocString(L"PartitionsEnabled");
+    long numChanges = 0;
+
+    ::VariantInit(&vtVal);
+
+    // get collection
+    hr = CpiExecGetCatalogCollection(L"LocalComputer", &piLocalComputerColl);
+    ExitOnFailure(hr, "Failed to get catalog collection");
+
+    // find object, there will be only one in the LocalComputer collection
+    hr = piLocalComputerColl->get_Item(0, &piDisp);
+    ExitOnFailure(hr, "Failed to get object from collection");
+
+    hr = piDisp->QueryInterface(IID_ICatalogObject, (void**)&piLocalComputerObj);
+    ExitOnFailure(hr, "Failed to get IID_ICatalogObject interface");
+
+    // and then we get the value of the PartitionsEnabled property
+    hr = piLocalComputerObj->get_Value(bsPartitionsEnabledName, &vtVal);
+    if (!vtVal.boolVal)
+    {
+        vtVal.boolVal = true;
+        hr = piLocalComputerObj->put_Value(bsPartitionsEnabledName, vtVal);
+        ExitOnFailure(hr, "Failed to put value to Enable COM+ PartitionsEnabled property");
+        hr = piLocalComputerColl->SaveChanges(&numChanges);
+        ExitOnFailure(hr, "Failed to save PartitionsEnabled property");
+
+        // we'll read back the hopefully updated values of the PartitionsEnabled property
+        // if it's still False, then we're on a Windows Desktop that doesn't allow Partitions
+        // (as of Windows Server2003 Microsoft limited Partitions to only ServerOS platforms)
+        hr = piLocalComputerObj->get_Value(bsPartitionsEnabledName, &vtVal);
+        ExitOnFailure(hr, "Failed to read PartitionsEnabled property");
+    }
+
+    if (vtVal.boolVal)
+    {
+        // everything went well, we have the Partitioning available
+        hr = S_OK;
+    }
+    else
+    {
+        // we're on a Desktop OS, or couldn't otherwise enable partitioning
+        WcaLog(LOGMSG_STANDARD, "Failed to Enable COM+ PartitionEnabled property. This suggests Partitioning was attempted on a Desktop OS, which is not supported");
+        hr = S_FALSE;
+    }
+
+LExit:
+    // clean up
+    ReleaseObject(piLocalComputerColl);
+    ReleaseObject(piLocalComputerObj);
+    ReleaseBSTR(bsPartitionsEnabledName);
+    ::VariantClear(&vtVal);
+
+    return hr;
+}
+
 static HRESULT CreatePartition(
     CPI_PARTITION_ATTRIBUTES* pAttrs
     )
@@ -408,6 +472,9 @@ static HRESULT CreatePartition(
 
     if (S_FALSE == hr)
     {
+        hr = CpiEnsurePartitionsEnabled();
+        ExitOnFailure(hr, "Failed to enable partitions");
+
         // create partition
         hr = CpiAddCollectionObject(piPartColl, &piPartObj);
         ExitOnFailure(hr, "Failed to add partition to collection");

src/ext/ComPlus/ca/cppartroleexec.cpp

@@ -49,7 +49,7 @@ HRESULT CpiConfigureUsersInPartitionRoles(
     hr = CpiActionStartMessage(ppwzData, FALSE);
     ExitOnFailure(hr, "Failed to send action start message");
 
-    // ger count
+    // get count
     int iCnt = 0;
     hr = WcaReadIntegerFromCaData(ppwzData, &iCnt);
     ExitOnFailure(hr, "Failed to read count");

src/ext/ComPlus/ca/cppartrolesched.cpp

@@ -10,9 +10,9 @@ LPCWSTR vcsPartitionRoleQuery =
 enum ePartitionRoleQuery { prqPartitionRole = 1, prqPartition, prqComponent, prqName };
 
 LPCWSTR vcsUserInPartitionRoleQuery =
-    L"SELECT `UserInPartitionRole`, `PartitionRole_`, `ComPlusUserInPartitionRole`.`Component_`, `Domain`, `Name` FROM `Wix4ComPlusUserInPartitionRole`, `Wix4User` WHERE `User_` = `User`";
+    L"SELECT `UserInPartitionRole`, `PartitionRole_`, `Wix4ComPlusUserInPartitionRole`.`Component_`, `Domain`, `Name` FROM `Wix4ComPlusUserInPartitionRole`, `Wix4User` WHERE `User_` = `User`";
 LPCWSTR vcsGroupInPartitionRoleQuery =
-    L"SELECT `GroupInPartitionRole`, `PartitionRole_`, `ComPlusGroupInPartitionRole`.`Component_`, `Domain`, `Name` FROM `Wix4ComPlusGroupInPartitionRole`, `Wix4Group` WHERE `Group_` = `Group`";
+    L"SELECT `GroupInPartitionRole`, `PartitionRole_`, `Wix4ComPlusGroupInPartitionRole`.`Component_`, `Domain`, `Name` FROM `Wix4ComPlusGroupInPartitionRole`, `Wix4Group` WHERE `Group_` = `Group`";
 enum eTrusteeInPartitionRoleQuery { tiprqUserInPartitionRole = 1, tiprqPartitionRole, tiprqComponent, tiprqDomain, tiprqName };