Use PerUserProgramFilesFolder for default INSTALLFOLDER in a per-user package

robmen · robmen · commit 6ff0cd577e39 · 2024-12-29T09:46:13.000-08:00
Fixes 8101
diff --git a/src/wix/WixToolset.Core/Link/AddDefaultSymbolsCommand.cs b/src/wix/WixToolset.Core/Link/AddDefaultSymbolsCommand.cs
@@ -11,7 +11,8 @@ namespace WixToolset.Core.Link
     internal class AddDefaultSymbolsCommand
     {
         public static readonly string WixStandardInstallFolder = "INSTALLFOLDER";
-        public static readonly string WixStandardInstallFolderParent = "ProgramFiles6432Folder";
+        public static readonly string WixStandardPerMachineInstallFolderParent = "ProgramFiles6432Folder";
+        public static readonly string WixStandardPerUserInstallFolderParent = "PerUserProgramFilesFolder";
         public static readonly string WixStandardInstallFolderReference = "Directory:INSTALLFOLDER";
 
         public AddDefaultSymbolsCommand(FindEntrySectionAndLoadSymbolsCommand find, IList<IntermediateSection> sections)
@@ -26,28 +27,31 @@ public AddDefaultSymbolsCommand(FindEntrySectionAndLoadSymbolsCommand find, ILis
 
         public void Execute()
         {
-            if (this.Find.EntrySection.Type != SectionType.Package)
+            if (this.Find.EntrySection.Type != SectionType.Package || this.Find.EntrySection.Symbols.Count == 0)
             {
                 // Only packages...for now.
                 return;
             }
 
+            var packageSymbol = this.Find.EntrySection.Symbols.OfType<WixPackageSymbol>().First();
+
             // If a directory with id INSTALLFOLDER hasn't been authored, provide a default one.
             if (!this.Find.SymbolsByName.ContainsKey(WixStandardInstallFolderReference))
             {
                 var sourceLineNumber = new SourceLineNumber("DefaultInstallFolder");
+                var parentDirectoryRef = (packageSymbol.Scope == WixPackageScope.PerUser) ? WixStandardPerUserInstallFolderParent : WixStandardPerMachineInstallFolderParent;
 
                 this.AddSymbolsToNewSection(WixStandardInstallFolder,
                     new DirectorySymbol(sourceLineNumber, new Identifier(AccessModifier.Global, WixStandardInstallFolder))
                     {
-                        ParentDirectoryRef = WixStandardInstallFolderParent,
+                        ParentDirectoryRef = parentDirectoryRef,
                         Name = "!(bind.Property.Manufacturer) !(bind.Property.ProductName)",
                         SourceName = ".",
                     },
                     new WixSimpleReferenceSymbol(sourceLineNumber, new Identifier(AccessModifier.Global, WixStandardInstallFolder))
                     {
                         Table = "Directory",
-                        PrimaryKeys = WixStandardInstallFolderParent,
+                        PrimaryKeys = parentDirectoryRef,
                     }
                 );
             }
@@ -58,10 +62,7 @@ public void Execute()
             var symbols = this.Sections.SelectMany(section => section.Symbols);
             if (!symbols.OfType<UpgradeSymbol>().Any(us => !us.OnlyDetect))
             {
-                var packageSymbol = this.Find.EntrySection.Symbols.OfType<WixPackageSymbol>().FirstOrDefault();
-
-                if (packageSymbol?.UpgradeStrategy == WixPackageUpgradeStrategy.MajorUpgrade
-                    && !String.IsNullOrEmpty(packageSymbol?.UpgradeCode))
+                if (packageSymbol.UpgradeStrategy == WixPackageUpgradeStrategy.MajorUpgrade && !String.IsNullOrEmpty(packageSymbol?.UpgradeCode))
                 {
                     this.AddDefaultMajorUpgrade(packageSymbol);
                 }
diff --git a/src/wix/test/WixToolsetTest.CoreIntegration/DirectoryFixture.cs b/src/wix/test/WixToolsetTest.CoreIntegration/DirectoryFixture.cs
@@ -14,15 +14,15 @@ namespace WixToolsetTest.CoreIntegration
     public class DirectoryFixture
     {
         [Fact]
-        public void CanGetDefaultInstallFolder()
+        public void CanGetDefaultPerMachineInstallFolder()
         {
-            var folder = TestData.Get(@"TestData\SingleFile");
+            var folder = TestData.Get("TestData", "SingleFile");
 
             using (var fs = new DisposableFileSystem())
             {
                 var baseFolder = fs.GetFolder();
                 var intermediateFolder = Path.Combine(baseFolder, "obj");
-                var msiPath = Path.Combine(baseFolder, @"bin\test.msi");
+                var msiPath = Path.Combine(baseFolder, "bin", "test.msi");
 
                 var result = WixRunner.Execute(new[]
                 {
@@ -37,7 +37,7 @@ public void CanGetDefaultInstallFolder()
 
                 result.AssertSuccess();
 
-                var intermediate = Intermediate.Load(Path.Combine(baseFolder, @"bin\test.wixpdb"));
+                var intermediate = Intermediate.Load(Path.Combine(baseFolder, "bin", "test.wixpdb"));
                 var section = intermediate.Sections.Single();
 
                 var dirSymbols = section.Symbols.OfType<WixToolset.Data.Symbols.DirectorySymbol>().ToList();
@@ -51,6 +51,42 @@ public void CanGetDefaultInstallFolder()
             }
         }
 
+        [Fact]
+        public void CanGetDefaultPerUserInstallFolder()
+        {
+            var folder = TestData.Get("TestData", "AllUsers");
+
+            using (var fs = new DisposableFileSystem())
+            {
+                var baseFolder = fs.GetFolder();
+                var intermediateFolder = Path.Combine(baseFolder, "obj");
+                var msiPath = Path.Combine(baseFolder, "bin", "test.msi");
+
+                var result = WixRunner.Execute(new[]
+                {
+                    "build",
+                    Path.Combine(folder, "PerUser.wxs"),
+                    "-bindpath", folder,
+                    "-intermediateFolder", intermediateFolder,
+                    "-o", msiPath
+                });
+
+                result.AssertSuccess();
+
+                var intermediate = Intermediate.Load(Path.Combine(baseFolder, "bin", "test.wixpdb"));
+                var section = intermediate.Sections.Single();
+
+                var dirSymbols = section.Symbols.OfType<WixToolset.Data.Symbols.DirectorySymbol>().ToList();
+                WixAssert.CompareLineByLine(new[]
+                {
+                    "INSTALLFOLDER:PerUserProgramFilesFolder:Example Corporation MsiPackage",
+                    "LocalAppDataFolder:TARGETDIR:LocalApp",
+                    "PerUserProgramFilesFolder:LocalAppDataFolder:Programs",
+                    "TARGETDIR::SourceDir",
+                }, dirSymbols.OrderBy(d => d.Id.Id).Select(d => d.Id.Id + ":" + d.ParentDirectoryRef + ":" + d.Name).ToArray());
+            }
+        }
+
         [Fact]
         public void CanGet32bitProgramFiles6432Folder()
         {
@@ -60,7 +96,7 @@ public void CanGet32bitProgramFiles6432Folder()
             {
                 var baseFolder = fs.GetFolder();
                 var intermediateFolder = Path.Combine(baseFolder, "obj");
-                var msiPath = Path.Combine(baseFolder, @"bin\test.msi");
+                var msiPath = Path.Combine(baseFolder, "bin", "test.msi");
 
                 var result = WixRunner.Execute(new[]
                 {
@@ -74,7 +110,7 @@ public void CanGet32bitProgramFiles6432Folder()
 
                 result.AssertSuccess();
 
-                var intermediate = Intermediate.Load(Path.Combine(baseFolder, @"bin\test.wixpdb"));
+                var intermediate = Intermediate.Load(Path.Combine(baseFolder, "bin", "test.wixpdb"));
                 var section = intermediate.Sections.Single();
 
                 var dirSymbols = section.Symbols.OfType<WixToolset.Data.Symbols.DirectorySymbol>().ToList();
diff --git a/src/wix/test/WixToolsetTest.CoreIntegration/TestData/AllUsers/PerMachine.wxs b/src/wix/test/WixToolsetTest.CoreIntegration/TestData/AllUsers/PerMachine.wxs
@@ -7,7 +7,7 @@
     <MajorUpgrade DowngradeErrorMessage="Downgrade not allowed" />
 
     <Feature Id="ProductFeature" Title="Feature title">
-        <Component Directory="DesktopFolder">
+        <Component>
             <File Source="PerUser.wxs" />
         </Component>
     </Feature>
diff --git a/src/wix/test/WixToolsetTest.CoreIntegration/TestData/AllUsers/PerUser.wxs b/src/wix/test/WixToolsetTest.CoreIntegration/TestData/AllUsers/PerUser.wxs
@@ -7,7 +7,7 @@
     <MajorUpgrade DowngradeErrorMessage="Downgrade not allowed" />
 
     <Feature Id="ProductFeature" Title="Feature title">
-        <Component Directory="DesktopFolder">
+        <Component>
             <File Source="PerUser.wxs" />
         </Component>
     </Feature>
diff --git a/src/wix/test/WixToolsetTest.CoreIntegration/TestData/AllUsers/PerUserOrMachine.wxs b/src/wix/test/WixToolsetTest.CoreIntegration/TestData/AllUsers/PerUserOrMachine.wxs
@@ -7,7 +7,7 @@
     <MajorUpgrade DowngradeErrorMessage="Downgrade not allowed" />
 
     <Feature Id="ProductFeature" Title="Feature title">
-        <Component Directory="DesktopFolder">
+        <Component>
             <File Source="PerUser.wxs" />
         </Component>
     </Feature>

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,8 @@ namespace WixToolset.Core.Link`
`11`	`11`	`internal class AddDefaultSymbolsCommand`
`12`	`12`	`{`
`13`	`13`	`public static readonly string WixStandardInstallFolder = "INSTALLFOLDER";`
`14`		`- public static readonly string WixStandardInstallFolderParent = "ProgramFiles6432Folder";`
	`14`	`+ public static readonly string WixStandardPerMachineInstallFolderParent = "ProgramFiles6432Folder";`
	`15`	`+ public static readonly string WixStandardPerUserInstallFolderParent = "PerUserProgramFilesFolder";`
`15`	`16`	`public static readonly string WixStandardInstallFolderReference = "Directory:INSTALLFOLDER";`
`16`	`17`
`17`	`18`	`public AddDefaultSymbolsCommand(FindEntrySectionAndLoadSymbolsCommand find, IList<IntermediateSection> sections)`
`@@ -26,28 +27,31 @@ public AddDefaultSymbolsCommand(FindEntrySectionAndLoadSymbolsCommand find, ILis`
`26`	`27`
`27`	`28`	`public void Execute()`
`28`	`29`	`{`
`29`		`- if (this.Find.EntrySection.Type != SectionType.Package)`
	`30`	`+ if (this.Find.EntrySection.Type != SectionType.Package \|\| this.Find.EntrySection.Symbols.Count == 0)`
`30`	`31`	`{`
`31`	`32`	`// Only packages...for now.`
`32`	`33`	`return;`
`33`	`34`	`}`
`34`	`35`
	`36`	`+ var packageSymbol = this.Find.EntrySection.Symbols.OfType<WixPackageSymbol>().First();`
	`37`	`+`
`35`	`38`	`// If a directory with id INSTALLFOLDER hasn't been authored, provide a default one.`
`36`	`39`	`if (!this.Find.SymbolsByName.ContainsKey(WixStandardInstallFolderReference))`
`37`	`40`	`{`
`38`	`41`	`var sourceLineNumber = new SourceLineNumber("DefaultInstallFolder");`
	`42`	`+ var parentDirectoryRef = (packageSymbol.Scope == WixPackageScope.PerUser) ? WixStandardPerUserInstallFolderParent : WixStandardPerMachineInstallFolderParent;`
`39`	`43`
`40`	`44`	`this.AddSymbolsToNewSection(WixStandardInstallFolder,`
`41`	`45`	`new DirectorySymbol(sourceLineNumber, new Identifier(AccessModifier.Global, WixStandardInstallFolder))`
`42`	`46`	`{`
`43`		`- ParentDirectoryRef = WixStandardInstallFolderParent,`
	`47`	`+ ParentDirectoryRef = parentDirectoryRef,`
`44`	`48`	`Name = "!(bind.Property.Manufacturer) !(bind.Property.ProductName)",`
`45`	`49`	`SourceName = ".",`
`46`	`50`	`},`
`47`	`51`	`new WixSimpleReferenceSymbol(sourceLineNumber, new Identifier(AccessModifier.Global, WixStandardInstallFolder))`
`48`	`52`	`{`
`49`	`53`	`Table = "Directory",`
`50`		`- PrimaryKeys = WixStandardInstallFolderParent,`
	`54`	`+ PrimaryKeys = parentDirectoryRef,`
`51`	`55`	`}`
`52`	`56`	`);`
`53`	`57`	`}`
`@@ -58,10 +62,7 @@ public void Execute()`
`58`	`62`	`var symbols = this.Sections.SelectMany(section => section.Symbols);`
`59`	`63`	`if (!symbols.OfType<UpgradeSymbol>().Any(us => !us.OnlyDetect))`
`60`	`64`	`{`
`61`		`- var packageSymbol = this.Find.EntrySection.Symbols.OfType<WixPackageSymbol>().FirstOrDefault();`
`62`		`-`
`63`		`- if (packageSymbol?.UpgradeStrategy == WixPackageUpgradeStrategy.MajorUpgrade`
`64`		`- && !String.IsNullOrEmpty(packageSymbol?.UpgradeCode))`
	`65`	`+ if (packageSymbol.UpgradeStrategy == WixPackageUpgradeStrategy.MajorUpgrade && !String.IsNullOrEmpty(packageSymbol?.UpgradeCode))`
`65`	`66`	`{`
`66`	`67`	`this.AddDefaultMajorUpgrade(packageSymbol);`
`67`	`68`	`}`