Support add, modify and remove comments on user accounts

Fixes 5371

1 files changed, 46 insertions, 16 deletions

diff --git a/src/ext/Util/ca/scauser.cpp b/src/ext/Util/ca/scauser.cpp
index f92ebf1b..dc5bebba 100644
--- a/src/ext/Util/ca/scauser.cpp
+++ b/src/ext/Util/ca/scauser.cpp
@@ -2,8 +2,8 @@
 
 #include "precomp.h"
 
-LPCWSTR vcsUserQuery = L"SELECT `User`, `Component_`, `Name`, `Domain`, `Password` FROM `Wix4User` WHERE `User`=?";
-enum eUserQuery { vuqUser = 1, vuqComponent, vuqName, vuqDomain, vuqPassword };
+LPCWSTR vcsUserQuery = L"SELECT `User`, `Component_`, `Name`, `Domain`, `Comment`, `Password` FROM `Wix4User` WHERE `User`=?";
+enum eUserQuery { vuqUser = 1, vuqComponent, vuqName, vuqDomain, vuqComment, vuqPassword };
 
 LPCWSTR vcsGroupQuery = L"SELECT `Group`, `Component_`, `Name`, `Domain` FROM `Wix4Group` WHERE `Group`=?";
 enum eGroupQuery { vgqGroup = 1, vgqComponent, vgqName, vgqDomain };
@@ -11,8 +11,8 @@ enum eGroupQuery { vgqGroup = 1, vgqComponent, vgqName, vgqDomain };
 LPCWSTR vcsUserGroupQuery = L"SELECT `User_`, `Group_` FROM `Wix4UserGroup` WHERE `User_`=?";
 enum eUserGroupQuery { vugqUser = 1, vugqGroup };
 
-LPCWSTR vActionableQuery = L"SELECT `User`,`Component_`,`Name`,`Domain`,`Password`,`Attributes` FROM `Wix4User` WHERE `Component_` IS NOT NULL";
-enum eActionableQuery { vaqUser = 1, vaqComponent, vaqName, vaqDomain, vaqPassword, vaqAttributes };
+LPCWSTR vActionableQuery = L"SELECT `User`,`Component_`,`Name`,`Domain`,`Password`,`Comment`,`Attributes` FROM `Wix4User` WHERE `Component_` IS NOT NULL";
+enum eActionableQuery { vaqUser = 1, vaqComponent, vaqName, vaqDomain, vaqPassword, vaqComment, vaqAttributes };
 
 
 static HRESULT AddUserToList(
@@ -78,6 +78,11 @@ HRESULT __stdcall ScaGetUser(
         hr = ::StringCchCopyW(pscau->wzDomain, countof(pscau->wzDomain), pwzData);
         ExitOnFailure(hr, "Failed to copy domain string to user object");
 
+        hr = WcaGetRecordFormattedString(hRec, vuqComment, &pwzData);
+        ExitOnFailure(hr, "Failed to get Wix4User.Comment");
+        hr = ::StringCchCopyW(pscau->wzComment, countof(pscau->wzComment), pwzData);
+        ExitOnFailure(hr, "Failed to copy comment string to user object");
+
         hr = WcaGetRecordFormattedString(hRec, vuqPassword, &pwzData);
         ExitOnFailure(hr, "Failed to get Wix4User.Password");
         hr = ::StringCchCopyW(pscau->wzPassword, countof(pscau->wzPassword), pwzData);
@@ -154,6 +159,11 @@ HRESULT __stdcall ScaGetUserDeferred(
         hr = ::StringCchCopyW(pscau->wzDomain, countof(pscau->wzDomain), pwzData);
         ExitOnFailure(hr, "Failed to copy domain string to user object (in deferred CA)");
 
+        hr = WcaGetRecordString(hRec, vuqComment, &pwzData);
+        ExitOnFailure(hr, "Failed to get Wix4User.Comment");
+        hr = ::StringCchCopyW(pscau->wzComment, countof(pscau->wzComment), pwzData);
+        ExitOnFailure(hr, "Failed to copy comment string to user object (in deferred CA)");
+
         hr = WcaGetRecordString(hRec, vuqPassword, &pwzData);
         ExitOnFailure(hr, "Failed to get Wix4User.Password");
         hr = ::StringCchCopyW(pscau->wzPassword, countof(pscau->wzPassword), pwzData);
@@ -316,7 +326,7 @@ HRESULT ScaUserRead(
         ExitOnFailure(hr, "failed to get Component state for Wix4User");
 
         // don't bother if we aren't installing or uninstalling this component
-        if (WcaIsInstalling(isInstalled,  isAction) || WcaIsUninstalling(isInstalled, isAction))
+        if (WcaIsInstalling(isInstalled, isAction) || WcaIsUninstalling(isInstalled, isAction))
         {
             //
             // Add the user to the list and populate it's values
@@ -345,6 +355,10 @@ HRESULT ScaUserRead(
             ExitOnFailure(hr, "failed to get Wix4User.Domain");
             hr = ::StringCchCopyW(psu->wzDomain, countof(psu->wzDomain), pwzData);
             ExitOnFailure(hr, "failed to copy user domain: %ls", pwzData);
+            hr = WcaGetRecordFormattedString(hRec, vaqComment, &pwzData);
+            ExitOnFailure(hr, "failed to get Wix4User.Comment");
+            hr = ::StringCchCopyW(psu->wzComment, countof(psu->wzComment), pwzData);
+            ExitOnFailure(hr, "failed to copy user comment: %ls", pwzData);
 
             hr = WcaGetRecordFormattedString(hRec, vaqPassword, &pwzData);
             ExitOnFailure(hr, "failed to get Wix4User.Password");
@@ -492,15 +506,16 @@ HRESULT ScaUserExecute(
     {
         USER_EXISTS ueUserExists = USER_EXISTS_INDETERMINATE;
 
-        // Always put the User Name and Domain plus Attributes on the front of the CustomAction
-        // data.  Sometimes we'll add more data.
+        // Always put the User Name, Domain, and Comment on the front of the CustomAction data.
+        // The attributes will be added when we have finished adjusting them. Sometimes we'll
+        // add more data.
         Assert(psu->wzName);
         hr = WcaWriteStringToCaData(psu->wzName, &pwzActionData);
         ExitOnFailure(hr, "Failed to add user name to custom action data: %ls", psu->wzName);
         hr = WcaWriteStringToCaData(psu->wzDomain, &pwzActionData);
         ExitOnFailure(hr, "Failed to add user domain to custom action data: %ls", psu->wzDomain);
-        hr = WcaWriteIntegerToCaData(psu->iAttributes, &pwzActionData);
-        ExitOnFailure(hr, "failed to add user attributes to custom action data for user: %ls", psu->wzKey);
+        hr = WcaWriteStringToCaData(psu->wzComment, &pwzActionData);
+        ExitOnFailure(hr, "Failed to add user comment to custom action data: %ls", psu->wzComment);
 
         // Check to see if the user already exists since we have to be very careful when adding
         // and removing users.  Note: MSDN says that it is safe to call these APIs from any
@@ -520,7 +535,12 @@ HRESULT ScaUserExecute(
             }
             if (ERROR_SUCCESS == er)
             {
-                wzDomain = pDomainControllerInfo->DomainControllerName + 2;  //Add 2 so that we don't get the \\ prefix
+                if (2 <= wcslen(pDomainControllerInfo->DomainControllerName))
+                {
+                    wzDomain = pDomainControllerInfo->DomainControllerName + 2; // Add 2 so that we don't get the \\ prefix.
+                                                                                // Pass the entire string if it is too short
+                                                                                // to have a \\ prefix.
+                }
             }
         }
 
@@ -544,23 +564,32 @@ HRESULT ScaUserExecute(
 
         if (WcaIsInstalling(psu->isInstalled, psu->isAction))
         {
-            // If the user exists, check to see if we are supposed to fail if user the exists before
+            // If the user exists, check to see if we are supposed to fail if the user exists before
             // the install.
             if (USER_EXISTS_YES == ueUserExists)
             {
-                // Reinstalls will always fail if we don't remove the check for "fail if exists".
+                // Re-installs will always fail if we don't remove the check for "fail if exists".
                 if (WcaIsReInstalling(psu->isInstalled, psu->isAction))
                 {
                     psu->iAttributes &= ~SCAU_FAIL_IF_EXISTS;
+
+                    // If install would create the user, re-install should be able to update the user.
+                    if (!(psu->iAttributes & SCAU_DONT_CREATE_USER))
+                    {
+                        psu->iAttributes |= SCAU_UPDATE_IF_EXISTS;
+                    }
                 }
 
-                if ((SCAU_FAIL_IF_EXISTS & (psu->iAttributes)) && !(SCAU_UPDATE_IF_EXISTS & (psu->iAttributes)))
+                if (SCAU_FAIL_IF_EXISTS & psu->iAttributes && !(SCAU_UPDATE_IF_EXISTS & psu->iAttributes))
                 {
                     hr = HRESULT_FROM_WIN32(NERR_UserExists);
                     MessageExitOnFailure(hr, msierrUSRFailedUserCreateExists, "Failed to create user: %ls because user already exists.", psu->wzName);
                 }
             }
 
+            hr = WcaWriteIntegerToCaData(psu->iAttributes, &pwzActionData);
+            ExitOnFailure(hr, "failed to add user attributes to custom action data for user: %ls", psu->wzKey);
+
             // Rollback only if the user already exists, we couldn't determine if the user exists, or we are going to create the user
             if ((USER_EXISTS_YES == ueUserExists) || (USER_EXISTS_INDETERMINATE == ueUserExists) || !(psu->iAttributes & SCAU_DONT_CREATE_USER))
             {
@@ -597,7 +626,6 @@ HRESULT ScaUserExecute(
                 ExitOnFailure(hr, "Failed to add user domain to rollback custom action data: %ls", psu->wzDomain);
                 hr = WcaWriteIntegerToCaData(iRollbackUserAttributes, &pwzRollbackData);
                 ExitOnFailure(hr, "failed to add user attributes to rollback custom action data for user: %ls", psu->wzKey);
-
                 // If the user already exists, add relevant group information to rollback data
                 if (USER_EXISTS_YES == ueUserExists || USER_EXISTS_INDETERMINATE == ueUserExists)
                 {
@@ -630,11 +658,13 @@ HRESULT ScaUserExecute(
         }
         else if (((USER_EXISTS_YES == ueUserExists) || (USER_EXISTS_INDETERMINATE == ueUserExists)) && WcaIsUninstalling(psu->isInstalled, psu->isAction) && !(psu->iAttributes & SCAU_DONT_REMOVE_ON_UNINSTALL))
         {
+            hr = WcaWriteIntegerToCaData(psu->iAttributes, &pwzActionData);
+            ExitOnFailure(hr, "failed to add user attributes to custom action data for user: %ls", psu->wzKey);
+
             // Add user's group information - this will ensure the user can be removed from any groups they were added to, if the user isn't be deleted
             hr = WriteGroupInfo(psu->psgGroups, &pwzActionData);
             ExitOnFailure(hr, "failed to add group information to custom action data");
 
-            //
             // Schedule the removal because the user exists and we don't have any flags set
             // that say, don't remove the user on uninstall.
             //
@@ -642,7 +672,7 @@ HRESULT ScaUserExecute(
             // CustomAction.
             hr = WcaDoDeferredAction(CUSTOM_ACTION_DECORATION(L"RemoveUser"), pwzActionData, COST_USER_DELETE);
             ExitOnFailure(hr, "failed to schedule RemoveUser");
-        }
+       }
 
         ReleaseNullStr(pwzScriptKey);
         ReleaseNullStr(pwzActionData);