Move Directory code generation to the linker

Adding all referenced standard directories requires access to the
references. However, references do no survive the linker. Which
means the binder is too late to add standard directories.

Fixes 6977

5 files changed, 63 insertions, 74 deletions

diff --git a/src/wix/WixToolset.Core.WindowsInstaller/Bind/BindDatabaseCommand.cs b/src/wix/WixToolset.Core.WindowsInstaller/Bind/BindDatabaseCommand.cs
index b3008d6e..81be3794 100644
--- a/src/wix/WixToolset.Core.WindowsInstaller/Bind/BindDatabaseCommand.cs
+++ b/src/wix/WixToolset.Core.WindowsInstaller/Bind/BindDatabaseCommand.cs
@@ -171,12 +171,6 @@ namespace WixToolset.Core.WindowsInstaller.Bind
                 command.Execute();
             }
 
-            if (section.Type == SectionType.Product || section.Type == SectionType.Module)
-            {
-                var command = new AddRequiredStandardDirectories(section, platform);
-                command.Execute();
-            }
-
             {
                 var command = new CreateSpecialPropertiesCommand(section);
                 command.Execute();
diff --git a/src/wix/WixToolset.Core/Compiler.cs b/src/wix/WixToolset.Core/Compiler.cs
index b9c42aaf..79bb40e7 100644
--- a/src/wix/WixToolset.Core/Compiler.cs
+++ b/src/wix/WixToolset.Core/Compiler.cs
@@ -7131,6 +7131,11 @@ namespace WixToolset.Core
                     this.Core.ParseExtensionElement(node, child);
                 }
             }
+
+            if (!this.Core.EncounteredError)
+            {
+                this.Core.CreateSimpleReference(sourceLineNumbers, SymbolDefinitions.Directory, id);
+            }
         }
 
         /// <summary>
diff --git a/src/wix/WixToolset.Core.WindowsInstaller/Bind/AddRequiredStandardDirectories.cs b/src/wix/WixToolset.Core/Link/AddRequiredStandardDirectories.cs
index ee3bcc91..49483552 100644
--- a/src/wix/WixToolset.Core.WindowsInstaller/Bind/AddRequiredStandardDirectories.cs
+++ b/src/wix/WixToolset.Core/Link/AddRequiredStandardDirectories.cs
@@ -1,6 +1,6 @@
 // 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.
 
-namespace WixToolset.Core.WindowsInstaller.Bind
+namespace WixToolset.Core.Link
 {
     using System;
     using System.Collections.Generic;
@@ -14,21 +14,29 @@ namespace WixToolset.Core.WindowsInstaller.Bind
     /// </summary>
     internal class AddRequiredStandardDirectories
     {
-        internal AddRequiredStandardDirectories(IntermediateSection section, Platform platform)
+        public AddRequiredStandardDirectories(IntermediateSection section, List<WixSimpleReferenceSymbol> references)
         {
             this.Section = section;
-            this.Platform = platform;
+            this.References = references;
         }
 
         private IntermediateSection Section { get; }
 
-        private Platform Platform { get; }
+        private List<WixSimpleReferenceSymbol> References { get; }
 
         public void Execute()
         {
+            var platform = this.GetPlatformFromSection();
+
             var directories = this.Section.Symbols.OfType<DirectorySymbol>().ToList();
             var directoryIds = new SortedSet<string>(directories.Select(d => d.Id.Id));
 
+            // Ensure any standard directory references symbols are added.
+            foreach (var directoryReference in this.References.Where(r => r.Table == "Directory"))
+            {
+                this.EnsureStandardDirectoryAdded(directoryIds, directoryReference.PrimaryKeys, directoryReference.SourceLineNumbers, platform);
+            }
+
             foreach (var directory in directories)
             {
                 var parentDirectoryId = directory.ParentDirectoryRef;
@@ -42,7 +50,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind
                 }
                 else
                 {
-                    this.EnsureStandardDirectoryAdded(directoryIds, parentDirectoryId, directory.SourceLineNumbers);
+                    this.EnsureStandardDirectoryAdded(directoryIds, parentDirectoryId, directory.SourceLineNumbers, platform);
                 }
             }
 
@@ -53,11 +61,11 @@ namespace WixToolset.Core.WindowsInstaller.Bind
             }
         }
 
-        private void EnsureStandardDirectoryAdded(ISet<string> directoryIds, string directoryId, SourceLineNumber sourceLineNumbers)
+        private void EnsureStandardDirectoryAdded(ISet<string> directoryIds, string directoryId, SourceLineNumber sourceLineNumbers, Platform platform)
         {
             if (!directoryIds.Contains(directoryId) && WindowsInstallerStandard.TryGetStandardDirectory(directoryId, out var standardDirectory))
             {
-                var parentDirectoryId = this.GetStandardDirectoryParent(directoryId);
+                var parentDirectoryId = this.GetStandardDirectoryParent(directoryId, platform);
 
                 var directory = new DirectorySymbol(sourceLineNumbers, standardDirectory.Id)
                 {
@@ -70,12 +78,12 @@ namespace WixToolset.Core.WindowsInstaller.Bind
 
                 if (!String.IsNullOrEmpty(parentDirectoryId))
                 {
-                    this.EnsureStandardDirectoryAdded(directoryIds, parentDirectoryId, sourceLineNumbers);
+                    this.EnsureStandardDirectoryAdded(directoryIds, parentDirectoryId, sourceLineNumbers, platform);
                 }
             }
         }
 
-        private string GetStandardDirectoryParent(string directoryId)
+        private string GetStandardDirectoryParent(string directoryId, Platform platform)
         {
             switch (directoryId)
             {
@@ -85,11 +93,33 @@ namespace WixToolset.Core.WindowsInstaller.Bind
                 case "CommonFiles6432Folder":
                 case "ProgramFiles6432Folder":
                 case "System6432Folder":
-                    return WindowsInstallerStandard.GetPlatformSpecificDirectoryId(directoryId, this.Platform);
+                    return WindowsInstallerStandard.GetPlatformSpecificDirectoryId(directoryId, platform);
 
                 default:
                     return "TARGETDIR";
             }
         }
+
+        private Platform GetPlatformFromSection()
+        {
+            var symbol = this.Section.Symbols.OfType<SummaryInformationSymbol>().First(p => p.PropertyId == SummaryInformationType.PlatformAndLanguage);
+
+            var value = symbol.Value;
+            var separatorIndex = value.IndexOf(';');
+            var platformValue = separatorIndex > 0 ? value.Substring(0, separatorIndex) : value;
+
+            switch (platformValue)
+            {
+                case "x64":
+                    return Platform.X64;
+
+                case "Arm64":
+                    return Platform.ARM64;
+
+                case "Intel":
+                default:
+                    return Platform.X86;
+            }
+        }
     }
 }
diff --git a/src/wix/WixToolset.Core/Linker.cs b/src/wix/WixToolset.Core/Linker.cs
index 1aeb783b..887372f8 100644
--- a/src/wix/WixToolset.Core/Linker.cs
+++ b/src/wix/WixToolset.Core/Linker.cs
@@ -90,8 +90,6 @@ namespace WixToolset.Core
                     }
                 }
 
-                //this.activeOutput = null;
-
                 var multipleFeatureComponents = new Hashtable();
 
                 var wixVariables = new Dictionary<string, WixVariableSymbol>();
@@ -178,6 +176,7 @@ namespace WixToolset.Core
                 // Create a new section to hold the linked content. Start with the entry section's
                 // metadata.
                 var resolvedSection = new IntermediateSection(find.EntrySection.Id, find.EntrySection.Type);
+                var references = new List<WixSimpleReferenceSymbol>();
 
                 foreach (var section in sections)
                 {
@@ -248,6 +247,7 @@ namespace WixToolset.Core
 
                             case SymbolDefinitionType.WixSimpleReference:
                                 copySymbol = false;
+                                references.Add(symbol as WixSimpleReferenceSymbol);
                                 break;
 
                             case SymbolDefinitionType.WixVariable:
@@ -288,6 +288,12 @@ namespace WixToolset.Core
                     var command = new FlattenAndProcessBundleTablesCommand(resolvedSection, this.Messaging);
                     command.Execute();
                 }
+                else if (resolvedSection.Type == SectionType.Product || resolvedSection.Type == SectionType.Module)
+                {
+                    // Packages and modules get standard directories add.
+                    var command = new AddRequiredStandardDirectories(resolvedSection, references);
+                    command.Execute();
+                }
 
                 if (this.Messaging.EncounteredError)
                 {
diff --git a/src/wix/test/WixToolsetTest.CoreIntegration/DirectoryFixture.cs b/src/wix/test/WixToolsetTest.CoreIntegration/DirectoryFixture.cs
index f2ace1d0..429b69ef 100644
--- a/src/wix/test/WixToolsetTest.CoreIntegration/DirectoryFixture.cs
+++ b/src/wix/test/WixToolsetTest.CoreIntegration/DirectoryFixture.cs
@@ -97,54 +97,8 @@ namespace WixToolsetTest.CoreIntegration
             {
                 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, "Directory", "DefaultName.wxs"),
-                    Path.Combine(folder, "ProductWithComponentGroupRef", "Product.wxs"),
-                    "-bindpath", Path.Combine(folder, "SingleFile", "data"),
-                    "-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[]
-                {
-                    "BinFolder\tCompanyFolder\t.",
-                    "CompanyFolder\tProgramFilesFolder\tExample Corporation",
-                    "ProgramFilesFolder\tTARGETDIR\tPFiles",
-                    "TARGETDIR\t\tSourceDir"
-                }, dirSymbols.OrderBy(d => d.Id.Id).Select(d => String.Join('\t', d.Id.Id, d.ParentDirectoryRef, d.Name)).ToArray());
-
-                var data = WindowsInstallerData.Load(Path.Combine(baseFolder, @"bin\test.wixpdb"));
-                var directoryRows = data.Tables["Directory"].Rows;
-                WixAssert.CompareLineByLine(new[]
-                {
-                    "BinFolder\tCompanyFolder\t.",
-                    "CompanyFolder\tProgramFilesFolder\tu7-b4gch|Example Corporation",
-                    "ProgramFilesFolder\tTARGETDIR\tPFiles",
-                    "TARGETDIR\t\tSourceDir"
-                }, directoryRows.Select(r => String.Join('\t', r.FieldAsString(0), r.FieldAsString(1), r.FieldAsString(2))).ToArray());
-            }
-        }
-
-        [Fact(Skip = "https://github.com/wixtoolset/issues/issues/6977")]
-        public void CanGetEmptyStandardDirectory()
-        {
-            var folder = TestData.Get(@"TestData");
-
-            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 wixpdbPath = Path.Combine(baseFolder, "bin", "test.wixpdb");
 
                 var result = WixRunner.Execute(new[]
                 {
@@ -158,7 +112,7 @@ namespace WixToolsetTest.CoreIntegration
 
                 result.AssertSuccess();
 
-                var intermediate = Intermediate.Load(Path.Combine(baseFolder, @"bin\test.wixpdb"));
+                var intermediate = Intermediate.Load(wixpdbPath);
                 var section = intermediate.Sections.Single();
 
                 var dirSymbols = section.Symbols.OfType<WixToolset.Data.Symbols.DirectorySymbol>().ToList();
@@ -166,23 +120,23 @@ namespace WixToolsetTest.CoreIntegration
                 {
                     "BinFolder\tCompanyFolder\t.",
                     "CompanyFolder\tProgramFilesFolder\tExample Corporation",
-                    "DesktopFolder\tTARGETDIR\t.",
+                    "DesktopFolder\tTARGETDIR\tDesktop",
                     "ProgramFilesFolder\tTARGETDIR\tPFiles",
-                    "ProgramMenuFolder\tTARGETDIR\t.",
+                    "ProgramMenuFolder\tTARGETDIR\tPMenu",
                     "TARGETDIR\t\tSourceDir"
-                }, dirSymbols.OrderBy(d => d.Id.Id).Select(d => String.Join('\t', d.Id.Id, d.ParentDirectoryRef, d.Name)).ToArray());
+                }, dirSymbols.Select(d => String.Join('\t', d.Id.Id, d.ParentDirectoryRef, d.Name)).OrderBy(s => s).ToArray());
 
-                var data = WindowsInstallerData.Load(Path.Combine(baseFolder, @"bin\test.wixpdb"));
+                var data = WindowsInstallerData.Load(wixpdbPath);
                 var directoryRows = data.Tables["Directory"].Rows;
                 WixAssert.CompareLineByLine(new[]
                 {
                     "BinFolder\tCompanyFolder\t.",
                     "CompanyFolder\tProgramFilesFolder\tu7-b4gch|Example Corporation",
-                    "DesktopFolder\tTARGETDIR\t.",
+                    "DesktopFolder\tTARGETDIR\tDesktop",
                     "ProgramFilesFolder\tTARGETDIR\tPFiles",
-                    "ProgramMenuFolder\tTARGETDIR\t.",
+                    "ProgramMenuFolder\tTARGETDIR\tPMenu",
                     "TARGETDIR\t\tSourceDir"
-                }, directoryRows.Select(r => String.Join('\t', r.FieldAsString(0), r.FieldAsString(1), r.FieldAsString(2))).ToArray());
+                }, directoryRows.Select(r => String.Join('\t', r.FieldAsString(0), r.FieldAsString(1), r.FieldAsString(2))).OrderBy(s => s).ToArray());
             }
         }