From 816bfd180f132a9b07aaa573f5ac0f5948195764 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Wed, 3 Mar 2021 10:37:34 -0800 Subject: Complete MOVE_TO_BACKEND code migration Fixes wixtoolset/issues#6212 --- .../Bind/BindDatabaseCommand.cs | 3 +- .../CreateWindowsInstallerDataFromIRCommand.cs | 296 +++++++++++++- .../Bind/OptimizeFileFacadesOrderCommand.cs | 12 +- .../Bind/ProcessDependencyReferencesCommand.cs | 2 +- src/WixToolset.Core/Compiler.cs | 4 +- src/WixToolset.Core/Compiler_Package.cs | 2 +- src/WixToolset.Core/Linker.cs | 435 ++------------------- .../MsiQueryFixture.cs | 2 +- .../TestData/CustomTable/CustomTable.wxs | 4 +- 9 files changed, 338 insertions(+), 422 deletions(-) diff --git a/src/WixToolset.Core.WindowsInstaller/Bind/BindDatabaseCommand.cs b/src/WixToolset.Core.WindowsInstaller/Bind/BindDatabaseCommand.cs index 7a64b777..292f1572 100644 --- a/src/WixToolset.Core.WindowsInstaller/Bind/BindDatabaseCommand.cs +++ b/src/WixToolset.Core.WindowsInstaller/Bind/BindDatabaseCommand.cs @@ -192,6 +192,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind command.Execute(); } + if (section.Type == SectionType.Product || section.Type == SectionType.Module) { var command = new AddRequiredStandardDirectories(section, platform); command.Execute(); @@ -329,7 +330,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind if (dependencyRefs.Any()) { - var command = new ProcessDependencyReferencesCommand(this.WindowsInstallerBackendHelper, section, dependencyRefs); + var command = new ProcessDependencyReferencesCommand(section, dependencyRefs); command.Execute(); } } diff --git a/src/WixToolset.Core.WindowsInstaller/Bind/CreateWindowsInstallerDataFromIRCommand.cs b/src/WixToolset.Core.WindowsInstaller/Bind/CreateWindowsInstallerDataFromIRCommand.cs index dc60a9ac..9ec26964 100644 --- a/src/WixToolset.Core.WindowsInstaller/Bind/CreateWindowsInstallerDataFromIRCommand.cs +++ b/src/WixToolset.Core.WindowsInstaller/Bind/CreateWindowsInstallerDataFromIRCommand.cs @@ -25,6 +25,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind this.TableDefinitions = tableDefinitions; this.BackendExtensions = backendExtensions; this.BackendHelper = backendHelper; + this.GeneratedShortNames = new Dictionary>(); } private IEnumerable BackendExtensions { get; } @@ -37,6 +38,8 @@ namespace WixToolset.Core.WindowsInstaller.Bind private IntermediateSection Section { get; } + private Dictionary> GeneratedShortNames { get; } + public WindowsInstallerData Data { get; private set; } public WindowsInstallerData Execute() @@ -136,6 +139,11 @@ namespace WixToolset.Core.WindowsInstaller.Bind case SymbolDefinitionType.ModuleConfiguration: this.AddModuleConfigurationSymbol((ModuleConfigurationSymbol)symbol); + this.EnsureModuleIgnoredTable(symbol, "ModuleConfiguration"); + break; + + case SymbolDefinitionType.ModuleSubstitution: + this.EnsureModuleIgnoredTable(symbol, "ModuleSubstitution"); break; case SymbolDefinitionType.MsiEmbeddedUI: @@ -262,6 +270,11 @@ namespace WixToolset.Core.WindowsInstaller.Bind } this.AddIndexedCellSymbols(cellsByTableAndRowId); + this.EnsureRequiredTables(); + this.ReportGeneratedShortFileNameConflicts(); + this.ReportIllegalTables(); + this.ReportMismatchedModularizations(); + this.ReportWindowsInstallerDataInconsistencies(); } private void AddAssemblySymbol(AssemblySymbol symbol) @@ -426,6 +439,15 @@ namespace WixToolset.Core.WindowsInstaller.Bind row[2] = symbol.Source; row[3] = symbol.Target; row[4] = symbol.PatchUninstall ? (int?)WindowsInstallerConstants.MsidbCustomActionTypePatchUninstall : null; + + if (OutputType.Module == this.Data.Type) + { + this.Data.EnsureTable(this.TableDefinitions["AdminExecuteSequence"]); + this.Data.EnsureTable(this.TableDefinitions["AdminUISequence"]); + this.Data.EnsureTable(this.TableDefinitions["AdvtExecuteSequence"]); + this.Data.EnsureTable(this.TableDefinitions["InstallExecuteSequence"]); + this.Data.EnsureTable(this.TableDefinitions["InstallUISequence"]); + } } private void AddDialogSymbol(DialogSymbol symbol) @@ -483,6 +505,38 @@ namespace WixToolset.Core.WindowsInstaller.Bind row[0] = symbol.Id.Id; row[1] = symbol.ParentDirectoryRef; row[2] = defaultDir; + + if (OutputType.Module == this.Data.Type) + { + var directoryId = symbol.Id.Id; + + if (WindowsInstallerStandard.IsStandardDirectory(directoryId)) + { + // If the directory table contains references to standard windows folders + // mergemod.dll will add customactions to set the MSM directory to + // the same directory as the standard windows folder and will add references to + // custom action to all the standard sequence tables. A problem will occur + // if the MSI does not have these tables as mergemod.dll does not add these + // tables to the MSI if absent. This code adds the tables in case mergemod.dll + // needs them. + this.Data.EnsureTable(this.TableDefinitions["CustomAction"]); + this.Data.EnsureTable(this.TableDefinitions["AdminExecuteSequence"]); + this.Data.EnsureTable(this.TableDefinitions["AdminUISequence"]); + this.Data.EnsureTable(this.TableDefinitions["AdvtExecuteSequence"]); + this.Data.EnsureTable(this.TableDefinitions["InstallExecuteSequence"]); + this.Data.EnsureTable(this.TableDefinitions["InstallUISequence"]); + } + else + { + foreach (var standardDirectory in WindowsInstallerStandard.StandardDirectories()) + { + if (directoryId.StartsWith(standardDirectory.Id.Id, StringComparison.Ordinal)) + { + this.Messaging.Write(WarningMessages.StandardDirectoryConflictInMergeModule(symbol.SourceLineNumbers, directoryId, standardDirectory.Id.Id)); + } + } + } + } } private void AddDuplicateFileSymbol(DuplicateFileSymbol symbol) @@ -570,6 +624,14 @@ namespace WixToolset.Core.WindowsInstaller.Bind if (null == symbol.ShortName && null != name && !Common.IsValidShortFilename(name, false)) { symbol.ShortName = CreateShortName(name, true, false, "File", symbol.DirectoryRef); + + if (!this.GeneratedShortNames.TryGetValue(symbol.ShortName, out var potentialConflicts)) + { + potentialConflicts = new List(); + this.GeneratedShortNames.Add(symbol.ShortName, potentialConflicts); + } + + potentialConflicts.Add(symbol); } var row = (FileRow)this.CreateRow(symbol, "File"); @@ -612,7 +674,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind var tableName = (IniFileActionType.AddLine == symbol.Action || IniFileActionType.AddTag == symbol.Action || IniFileActionType.CreateLine == symbol.Action) ? "IniFile" : "RemoveIniFile"; var name = symbol.FileName; - if (null == symbol.ShortFileName && null != name && !Common.IsValidShortFilename(name, false)) + if (null == symbol.ShortFileName && null != name && !Common.IsValidShortFilename(name, false)) { symbol.ShortFileName = CreateShortName(name, true, false, "IniFile", symbol.ComponentRef); } @@ -1168,6 +1230,238 @@ namespace WixToolset.Core.WindowsInstaller.Bind private bool AddSymbolDefaultly(IntermediateSymbol symbol) => this.BackendHelper.TryAddSymbolToMatchingTableDefinitions(this.Section, symbol, this.Data, this.TableDefinitions); + private void EnsureModuleIgnoredTable(IntermediateSymbol symbol, string ignoredTable) + { + var tableDefinition = this.TableDefinitions["ModuleIgnoreTable"]; + var table = this.Data.EnsureTable(tableDefinition); + if (!table.Rows.Any(r => r.FieldAsString(0) == ignoredTable)) + { + var row = this.CreateRow(symbol, tableDefinition); + row[0] = ignoredTable; + } + } + + private void EnsureRequiredTables() + { + // check for missing table and add them or display an error as appropriate + switch (this.Data.Type) + { + case OutputType.Module: + this.Data.EnsureTable(this.TableDefinitions["Component"]); + this.Data.EnsureTable(this.TableDefinitions["Directory"]); + this.Data.EnsureTable(this.TableDefinitions["FeatureComponents"]); + this.Data.EnsureTable(this.TableDefinitions["File"]); + this.Data.EnsureTable(this.TableDefinitions["ModuleComponents"]); + this.Data.EnsureTable(this.TableDefinitions["ModuleSignature"]); + break; + + case OutputType.PatchCreation: + var imageFamiliesCount = this.Data.Tables["ImageFamilies"]?.Rows.Count ?? 0; + var targetImagesCount = this.Data.Tables["TargetImages"]?.Rows.Count ?? 0; + var upgradedImagesCount = this.Data.Tables["UpgradedImages"]?.Rows.Count ?? 0; + + if (imageFamiliesCount < 1) + { + this.Messaging.Write(ErrorMessages.ExpectedRowInPatchCreationPackage("ImageFamilies")); + } + + if (targetImagesCount < 1) + { + this.Messaging.Write(ErrorMessages.ExpectedRowInPatchCreationPackage("TargetImages")); + } + + if (upgradedImagesCount < 1) + { + this.Messaging.Write(ErrorMessages.ExpectedRowInPatchCreationPackage("UpgradedImages")); + } + + this.Data.EnsureTable(this.TableDefinitions["Properties"]); + break; + + case OutputType.Product: + this.Data.EnsureTable(this.TableDefinitions["File"]); + this.Data.EnsureTable(this.TableDefinitions["Media"]); + break; + } + } + + private void ReportGeneratedShortFileNameConflicts() + { + foreach (var conflicts in this.GeneratedShortNames.Values.Where(l => l.Count > 1)) + { + this.Messaging.Write(WarningMessages.GeneratedShortFileNameConflict(conflicts[0].SourceLineNumbers, conflicts[0].ShortName)); + for (var i = 1; i < conflicts.Count; ++i) + { + this.Messaging.Write(WarningMessages.GeneratedShortFileNameConflict2(conflicts[i].SourceLineNumbers)); + } + } + } + + private void ReportIllegalTables() + { + foreach (var table in this.Data.Tables) + { + switch (this.Data.Type) + { + case OutputType.Module: + if ("BBControl" == table.Name || + "Billboard" == table.Name || + "CCPSearch" == table.Name || + "Feature" == table.Name || + "LaunchCondition" == table.Name || + "Media" == table.Name || + "Patch" == table.Name || + "Upgrade" == table.Name || + "WixMerge" == table.Name) + { + foreach (Row row in table.Rows) + { + this.Messaging.Write(ErrorMessages.UnexpectedTableInMergeModule(row.SourceLineNumbers, table.Name)); + } + } + else if ("Error" == table.Name) + { + foreach (var row in table.Rows) + { + this.Messaging.Write(WarningMessages.DangerousTableInMergeModule(row.SourceLineNumbers, table.Name)); + } + } + break; + + case OutputType.PatchCreation: + if (!table.Definition.Unreal && + "_SummaryInformation" != table.Name && + "ExternalFiles" != table.Name && + "FamilyFileRanges" != table.Name && + "ImageFamilies" != table.Name && + "PatchMetadata" != table.Name && + "PatchSequence" != table.Name && + "Properties" != table.Name && + "TargetFiles_OptionalData" != table.Name && + "TargetImages" != table.Name && + "UpgradedFiles_OptionalData" != table.Name && + "UpgradedFilesToIgnore" != table.Name && + "UpgradedImages" != table.Name) + { + foreach (var row in table.Rows) + { + this.Messaging.Write(ErrorMessages.UnexpectedTableInPatchCreationPackage(row.SourceLineNumbers, table.Name)); + } + } + break; + + case OutputType.Patch: + if (!table.Definition.Unreal && + "_SummaryInformation" != table.Name && + "Media" != table.Name && + "MsiFileHash" != table.Name && + "MsiPatchMetadata" != table.Name && + "MsiPatchSequence" != table.Name) + { + foreach (var row in table.Rows) + { + this.Messaging.Write(ErrorMessages.UnexpectedTableInPatch(row.SourceLineNumbers, table.Name)); + } + } + break; + + case OutputType.Product: + if ("ModuleAdminExecuteSequence" == table.Name || + "ModuleAdminUISequence" == table.Name || + "ModuleAdvtExecuteSequence" == table.Name || + "ModuleAdvtUISequence" == table.Name || + "ModuleComponents" == table.Name || + "ModuleConfiguration" == table.Name || + "ModuleDependency" == table.Name || + "ModuleExclusion" == table.Name || + "ModuleIgnoreTable" == table.Name || + "ModuleInstallExecuteSequence" == table.Name || + "ModuleInstallUISequence" == table.Name || + "ModuleSignature" == table.Name || + "ModuleSubstitution" == table.Name) + { + foreach (var row in table.Rows) + { + this.Messaging.Write(WarningMessages.UnexpectedTableInProduct(row.SourceLineNumbers, table.Name)); + } + } + break; + } + } + } + + private void ReportMismatchedModularizations() + { + // verify that modularization types match for foreign key relationships + foreach (var tableDefinition in this.TableDefinitions) + { + foreach (var columnDefinition in tableDefinition.Columns) + { + if (null != columnDefinition.KeyTable && 0 > columnDefinition.KeyTable.IndexOf(';') && columnDefinition.KeyColumn.HasValue) + { + if (this.TableDefinitions.TryGet(columnDefinition.KeyTable, out var keyTableDefinition)) + { + var keyColumnIndex = columnDefinition.KeyColumn ?? -1; + + if (keyColumnIndex <= 0 || keyColumnIndex > keyTableDefinition.Columns.Length) + { + this.Messaging.Write(ErrorMessages.InvalidKeyColumn(tableDefinition.Name, columnDefinition.Name, columnDefinition.KeyTable, keyColumnIndex)); + } + else if (keyTableDefinition.Columns[keyColumnIndex - 1].ModularizeType != columnDefinition.ModularizeType && ColumnModularizeType.CompanionFile != columnDefinition.ModularizeType) + { + this.Messaging.Write(ErrorMessages.CollidingModularizationTypes(tableDefinition.Name, columnDefinition.Name, columnDefinition.KeyTable, keyColumnIndex, columnDefinition.ModularizeType.ToString(), keyTableDefinition.Columns[keyColumnIndex - 1].ModularizeType.ToString())); + } + } + // else - ignore missing table definitions as that error is caught in other places + } + } + } + } + + private void ReportWindowsInstallerDataInconsistencies() + { + // Get the output's minimum installer version + var outputInstallerVersion = Int32.MaxValue; + + if (this.Data.Tables.TryGetTable("_SummaryInformation", out var summaryInformationTable)) + { + outputInstallerVersion = summaryInformationTable.Rows.FirstOrDefault(r => 14 == r.FieldAsInteger(0))?.FieldAsInteger(1) ?? Int32.MaxValue; + } + + // Ensure the Error table exists if output is marked for MSI 1.0 or below (see ICE40). + if (outputInstallerVersion <= 100 && OutputType.Product == this.Data.Type) + { + this.Data.EnsureTable(this.TableDefinitions["Error"]); + } + + // Check for the presence of tables/rows/columns that require MSI 1.1 or later. + if (outputInstallerVersion < 110) + { + if (this.Data.Tables.TryGetTable("IsolatedComponent", out var isolatedComponentTable)) + { + foreach (var row in isolatedComponentTable.Rows) + { + this.Messaging.Write(WarningMessages.TableIncompatibleWithInstallerVersion(row.SourceLineNumbers, "IsolatedComponent", outputInstallerVersion)); + } + } + } + + // Check for the presence of tables/rows/columns that require MSI 4.0 or later + if (outputInstallerVersion < 400) + { + if (this.Data.Tables.TryGetTable("Shortcut", out var shortcutTable)) + { + foreach (var row in shortcutTable.Rows) + { + if (null != row[12] || null != row[13] || null != row[14] || null != row[15]) + { + this.Messaging.Write(WarningMessages.ColumnsIncompatibleWithInstallerVersion(row.SourceLineNumbers, "Shortcut", outputInstallerVersion)); + } + } + } + } + } + private static OutputType SectionTypeToOutputType(SectionType type) { switch (type) diff --git a/src/WixToolset.Core.WindowsInstaller/Bind/OptimizeFileFacadesOrderCommand.cs b/src/WixToolset.Core.WindowsInstaller/Bind/OptimizeFileFacadesOrderCommand.cs index e96dfd91..67515154 100644 --- a/src/WixToolset.Core.WindowsInstaller/Bind/OptimizeFileFacadesOrderCommand.cs +++ b/src/WixToolset.Core.WindowsInstaller/Bind/OptimizeFileFacadesOrderCommand.cs @@ -36,7 +36,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind { var canonicalComponentTargetPaths = this.ComponentTargetPaths(); - this.FileFacades.Sort(new FileFacadeOptimizer(canonicalComponentTargetPaths)); + this.FileFacades.Sort(new FileFacadeOptimizer(canonicalComponentTargetPaths, this.Section.Type == SectionType.Module)); return this.FileFacades; } @@ -71,17 +71,21 @@ namespace WixToolset.Core.WindowsInstaller.Bind private class FileFacadeOptimizer : IComparer { - public FileFacadeOptimizer(Dictionary componentTargetPaths) + public FileFacadeOptimizer(Dictionary componentTargetPaths, bool optimizingMergeModule) { this.ComponentTargetPaths = componentTargetPaths; + this.OptimizingMergeModule = optimizingMergeModule; } private Dictionary ComponentTargetPaths { get; } + private bool OptimizingMergeModule { get; } + public int Compare(FileFacade x, FileFacade y) { - // First group files by DiskId. - var compare = x.DiskId.CompareTo(y.DiskId); + // First group files by DiskId but ignore if processing a Merge Module + // because Merge Modules don't have separate disks. + var compare = this.OptimizingMergeModule ? 0 : x.DiskId.CompareTo(y.DiskId); if (compare != 0) { diff --git a/src/WixToolset.Core.WindowsInstaller/Bind/ProcessDependencyReferencesCommand.cs b/src/WixToolset.Core.WindowsInstaller/Bind/ProcessDependencyReferencesCommand.cs index 0ae7ca73..7a7c2649 100644 --- a/src/WixToolset.Core.WindowsInstaller/Bind/ProcessDependencyReferencesCommand.cs +++ b/src/WixToolset.Core.WindowsInstaller/Bind/ProcessDependencyReferencesCommand.cs @@ -17,7 +17,7 @@ namespace WixToolset.Core.WindowsInstaller.Bind private const string DependencyRegistryRoot = @"Software\Classes\Installer\Dependencies\"; private const string RegistryDependents = "Dependents"; - public ProcessDependencyReferencesCommand(IWindowsInstallerBackendHelper backendHelper, IntermediateSection section, IEnumerable dependencyRefSymbols) + public ProcessDependencyReferencesCommand(IntermediateSection section, IEnumerable dependencyRefSymbols) { this.Section = section; this.DependencyRefSymbols = dependencyRefSymbols; diff --git a/src/WixToolset.Core/Compiler.cs b/src/WixToolset.Core/Compiler.cs index 8aa82d47..f311a5f6 100644 --- a/src/WixToolset.Core/Compiler.cs +++ b/src/WixToolset.Core/Compiler.cs @@ -7178,7 +7178,7 @@ namespace WixToolset.Core cabinet = this.Core.GetAttributeValue(sourceLineNumbers, attrib); break; case "CompressionLevel": - compressionLevel = this.ParseCompressionLevel(sourceLineNumbers, node, attrib); + compressionLevel = this.ParseCompressionLevel(sourceLineNumbers, attrib); break; case "DiskPrompt": diskPrompt = this.Core.GetAttributeValue(sourceLineNumbers, attrib); @@ -7381,7 +7381,7 @@ namespace WixToolset.Core } break; case "CompressionLevel": - compressionLevel = this.ParseCompressionLevel(sourceLineNumbers, node, attrib); + compressionLevel = this.ParseCompressionLevel(sourceLineNumbers, attrib); break; case "DiskPrompt": diskPrompt = this.Core.GetAttributeValue(sourceLineNumbers, attrib); diff --git a/src/WixToolset.Core/Compiler_Package.cs b/src/WixToolset.Core/Compiler_Package.cs index 2cc77a60..03ba1c40 100644 --- a/src/WixToolset.Core/Compiler_Package.cs +++ b/src/WixToolset.Core/Compiler_Package.cs @@ -4950,7 +4950,7 @@ namespace WixToolset.Core } } - private CompressionLevel? ParseCompressionLevel(SourceLineNumber sourceLineNumbers, XElement node, XAttribute attribute) + private CompressionLevel? ParseCompressionLevel(SourceLineNumber sourceLineNumbers, XAttribute attribute) { var compressionLevel = this.Core.GetAttributeValue(sourceLineNumbers, attribute); switch (compressionLevel) diff --git a/src/WixToolset.Core/Linker.cs b/src/WixToolset.Core/Linker.cs index 41e0db7d..3281cbd0 100644 --- a/src/WixToolset.Core/Linker.cs +++ b/src/WixToolset.Core/Linker.cs @@ -93,52 +93,12 @@ namespace WixToolset.Core } } -#if MOVE_TO_BACKEND - bool containsModuleSubstitution = false; - bool containsModuleConfiguration = false; -#endif - //this.activeOutput = null; -#if MOVE_TO_BACKEND - StringCollection generatedShortFileNameIdentifiers = new StringCollection(); - Hashtable generatedShortFileNames = new Hashtable(); -#endif - var multipleFeatureComponents = new Hashtable(); var wixVariables = new Dictionary(); -#if MOVE_TO_BACKEND - // verify that modularization types match for foreign key relationships - foreach (TableDefinition tableDefinition in this.tableDefinitions) - { - foreach (ColumnDefinition columnDefinition in tableDefinition.Columns) - { - if (null != columnDefinition.KeyTable && 0 > columnDefinition.KeyTable.IndexOf(';') && columnDefinition.IsKeyColumnSet) - { - try - { - TableDefinition keyTableDefinition = this.tableDefinitions[columnDefinition.KeyTable]; - - if (0 >= columnDefinition.KeyColumn || keyTableDefinition.Columns.Count < columnDefinition.KeyColumn) - { - this.Messaging.Write(WixErrors.InvalidKeyColumn(tableDefinition.Name, columnDefinition.Name, columnDefinition.KeyTable, columnDefinition.KeyColumn)); - } - else if (keyTableDefinition.Columns[columnDefinition.KeyColumn - 1].ModularizeType != columnDefinition.ModularizeType && ColumnModularizeType.CompanionFile != columnDefinition.ModularizeType) - { - this.Messaging.Write(WixErrors.CollidingModularizationTypes(tableDefinition.Name, columnDefinition.Name, columnDefinition.KeyTable, columnDefinition.KeyColumn, columnDefinition.ModularizeType.ToString(), keyTableDefinition.Columns[columnDefinition.KeyColumn - 1].ModularizeType.ToString())); - } - } - catch (WixMissingTableDefinitionException) - { - // ignore missing table definitions - this error is caught in other places - } - } - } - } -#endif - // First find the entry section and while processing all sections load all the symbols from all of the sections. var find = new FindEntrySectionAndLoadSymbolsCommand(this.Messaging, sections, this.Context.ExpectedOutputType); find.Execute(); @@ -211,7 +171,8 @@ namespace WixToolset.Core // resolve the feature to feature connects this.ResolveFeatureToFeatureConnects(featuresToFeatures, find.SymbolsByName); - // Create the section to hold the linked content. + // 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, find.EntrySection.Codepage); var sectionCount = 0; @@ -245,54 +206,6 @@ namespace WixToolset.Core } break; -#if MOVE_TO_BACKEND - case "CustomAction": - if (OutputType.Module == this.activeOutput.Type) - { - this.activeOutput.EnsureTable(this.tableDefinitions["AdminExecuteSequence"]); - this.activeOutput.EnsureTable(this.tableDefinitions["AdminUISequence"]); - this.activeOutput.EnsureTable(this.tableDefinitions["AdvtExecuteSequence"]); - this.activeOutput.EnsureTable(this.tableDefinitions["InstallExecuteSequence"]); - this.activeOutput.EnsureTable(this.tableDefinitions["InstallUISequence"]); - } - break; - - case "Directory": - foreach (Row row in table.Rows) - { - if (OutputType.Module == this.activeOutput.Type) - { - string directory = row[0].ToString(); - if (WindowsInstallerStandard.IsStandardDirectory(directory)) - { - // if the directory table contains references to standard windows folders - // mergemod.dll will add customactions to set the MSM directory to - // the same directory as the standard windows folder and will add references to - // custom action to all the standard sequence tables. A problem will occur - // if the MSI does not have these tables as mergemod.dll does not add these - // tables to the MSI if absent. This code adds the tables in case mergemod.dll - // needs them. - this.activeOutput.EnsureTable(this.tableDefinitions["CustomAction"]); - this.activeOutput.EnsureTable(this.tableDefinitions["AdminExecuteSequence"]); - this.activeOutput.EnsureTable(this.tableDefinitions["AdminUISequence"]); - this.activeOutput.EnsureTable(this.tableDefinitions["AdvtExecuteSequence"]); - this.activeOutput.EnsureTable(this.tableDefinitions["InstallExecuteSequence"]); - this.activeOutput.EnsureTable(this.tableDefinitions["InstallUISequence"]); - } - else - { - foreach (string standardDirectory in WindowsInstallerStandard.GetStandardDirectories()) - { - if (directory.StartsWith(standardDirectory, StringComparison.Ordinal)) - { - this.Messaging.Write(WixWarnings.StandardDirectoryConflictInMergeModule(row.SourceLineNumbers, directory, standardDirectory)); - } - } - } - } - } - break; -#endif case SymbolDefinitionType.Extension: if (SectionType.Product == resolvedSection.Type) { @@ -300,16 +213,6 @@ namespace WixToolset.Core } break; -#if MOVE_TO_BACKEND - case SymbolDefinitionType.ModuleSubstitution: - containsModuleSubstitution = true; - break; - - case SymbolDefinitionType.ModuleConfiguration: - containsModuleConfiguration = true; - break; -#endif - case SymbolDefinitionType.Assembly: if (SectionType.Product == resolvedSection.Type) { @@ -338,26 +241,6 @@ namespace WixToolset.Core } break; -#if MOVE_TO_BACKEND - case "WixFile": - foreach (Row row in table.Rows) - { - // DiskId is not valid when creating a module, so set it to - // 0 for all files to ensure proper sorting in the binder - if (SectionType.Module == entrySection.Type) - { - row[5] = 0; - } - - // if the short file name was generated, check for collisions - if (0x1 == (int)row[9]) - { - generatedShortFileNameIdentifiers.Add((string)row[0]); - } - } - break; -#endif - case SymbolDefinitionType.WixMerge: if (SectionType.Product == resolvedSection.Type) { @@ -374,30 +257,9 @@ namespace WixToolset.Core break; case SymbolDefinitionType.WixVariable: - // check for colliding values and collect the wix variable rows - { - var wixVariableSymbol = (WixVariableSymbol)symbol; - var id = wixVariableSymbol.Id.Id; - - if (wixVariables.TryGetValue(id, out var collidingSymbol)) - { - if (collidingSymbol.Overridable && !wixVariableSymbol.Overridable) - { - wixVariables[id] = wixVariableSymbol; - } - else if (!wixVariableSymbol.Overridable || (collidingSymbol.Overridable && wixVariableSymbol.Overridable)) - { - this.Messaging.Write(ErrorMessages.WixVariableCollision(wixVariableSymbol.SourceLineNumbers, id)); - } - } - else - { - wixVariables.Add(id, wixVariableSymbol); - } - } - - copySymbol = false; - break; + this.AddWixVariable(wixVariables, (WixVariableSymbol)symbol); + copySymbol = false; // Do not copy the symbol, it will be added later after all overriding has been handled. + break; } if (copySymbol) @@ -407,7 +269,7 @@ namespace WixToolset.Core } } - // copy the module to feature connections into the output + // Copy the module to feature connections into the output. foreach (ConnectToFeature connectToFeature in modulesToFeatures) { foreach (var feature in connectToFeature.ConnectFeatures) @@ -420,136 +282,23 @@ namespace WixToolset.Core } } -#if MOVE_TO_BACKEND - // check for missing table and add them or display an error as appropriate - switch (this.activeOutput.Type) - { - case OutputType.Module: - this.activeOutput.EnsureTable(this.tableDefinitions["Component"]); - this.activeOutput.EnsureTable(this.tableDefinitions["Directory"]); - this.activeOutput.EnsureTable(this.tableDefinitions["FeatureComponents"]); - this.activeOutput.EnsureTable(this.tableDefinitions["File"]); - this.activeOutput.EnsureTable(this.tableDefinitions["ModuleComponents"]); - this.activeOutput.EnsureTable(this.tableDefinitions["ModuleSignature"]); - break; - case OutputType.PatchCreation: - Table imageFamiliesTable = this.activeOutput.Tables["ImageFamilies"]; - Table targetImagesTable = this.activeOutput.Tables["TargetImages"]; - Table upgradedImagesTable = this.activeOutput.Tables["UpgradedImages"]; - - if (null == imageFamiliesTable || 1 > imageFamiliesTable.Rows.Count) - { - this.Messaging.Write(WixErrors.ExpectedRowInPatchCreationPackage("ImageFamilies")); - } - - if (null == targetImagesTable || 1 > targetImagesTable.Rows.Count) - { - this.Messaging.Write(WixErrors.ExpectedRowInPatchCreationPackage("TargetImages")); - } - - if (null == upgradedImagesTable || 1 > upgradedImagesTable.Rows.Count) - { - this.Messaging.Write(WixErrors.ExpectedRowInPatchCreationPackage("UpgradedImages")); - } - - this.activeOutput.EnsureTable(this.tableDefinitions["Properties"]); - break; - case OutputType.Product: - this.activeOutput.EnsureTable(this.tableDefinitions["File"]); - this.activeOutput.EnsureTable(this.tableDefinitions["Media"]); - break; - } - - this.CheckForIllegalTables(this.activeOutput); -#endif - - //correct the section Id in FeatureComponents table + // Correct the section Id in FeatureComponents table. if (this.sectionIdOnRows) { - //var componentSectionIds = new Dictionary(); - - //foreach (var componentSymbol in entrySection.Symbols.OfType()) - //{ - // componentSectionIds.Add(componentSymbol.Id.Id, componentSymbol.SectionId); - //} - - //foreach (var featureComponentSymbol in entrySection.Symbols.OfType()) - //{ - // if (componentSectionIds.TryGetValue(featureComponentSymbol.Component_, out var componentSectionId)) - // { - // featureComponentSymbol.SectionId = componentSectionId; - // } - //} - } - -#if MOVE_TO_BACKEND - // add the ModuleSubstitution table to the ModuleIgnoreTable - if (containsModuleSubstitution) - { - Table moduleIgnoreTableTable = this.activeOutput.EnsureTable(this.tableDefinitions["ModuleIgnoreTable"]); - - Row moduleIgnoreTableRow = moduleIgnoreTableTable.CreateRow(null); - moduleIgnoreTableRow[0] = "ModuleSubstitution"; - } - - // add the ModuleConfiguration table to the ModuleIgnoreTable - if (containsModuleConfiguration) - { - Table moduleIgnoreTableTable = this.activeOutput.EnsureTable(this.tableDefinitions["ModuleIgnoreTable"]); - - Row moduleIgnoreTableRow = moduleIgnoreTableTable.CreateRow(null); - moduleIgnoreTableRow[0] = "ModuleConfiguration"; - } -#endif - -#if MOVE_TO_BACKEND - // index all the file rows - Table fileTable = this.activeOutput.Tables["File"]; - RowDictionary indexedFileRows = (null == fileTable) ? new RowDictionary() : new RowDictionary(fileTable); - - // flag all the generated short file name collisions - foreach (string fileId in generatedShortFileNameIdentifiers) - { - FileRow fileRow = indexedFileRows[fileId]; - - string[] names = fileRow.FileName.Split('|'); - string shortFileName = names[0]; +#if TODO_DO_SYMBOLS_NEED_SECTIONIDS + var componentSectionIds = resolvedSection.Symbols.OfType().ToDictionary(c => c.Id.Id, c => c.SectionId); - // create lists of conflicting generated short file names - if (!generatedShortFileNames.Contains(shortFileName)) + foreach (var featureComponentSymbol in resolvedSection.Symbols.OfType()) { - generatedShortFileNames.Add(shortFileName, new ArrayList()); - } - ((ArrayList)generatedShortFileNames[shortFileName]).Add(fileRow); - } - - // check for generated short file name collisions - foreach (DictionaryEntry entry in generatedShortFileNames) - { - string shortFileName = (string)entry.Key; - ArrayList fileRows = (ArrayList)entry.Value; - - if (1 < fileRows.Count) - { - // sort the rows by DiskId - fileRows.Sort(); - - this.Messaging.Write(WixWarnings.GeneratedShortFileNameConflict(((FileRow)fileRows[0]).SourceLineNumbers, shortFileName)); - - for (int i = 1; i < fileRows.Count; i++) + if (componentSectionIds.TryGetValue(featureComponentSymbol.ComponentRef, out var componentSectionId)) { - FileRow fileRow = (FileRow)fileRows[i]; - - if (null != fileRow.SourceLineNumbers) - { - this.Messaging.Write(WixWarnings.GeneratedShortFileNameConflict2(fileRow.SourceLineNumbers)); - } + featureComponentSymbol.SectionId = componentSectionId; } } - } #endif + } - // copy the wix variable rows to the output after all overriding has been accounted for. + // Copy the wix variable rows to the output now that all overriding has been accounted for. foreach (var symbol in wixVariables.Values) { resolvedSection.AddSymbol(symbol); @@ -567,10 +316,6 @@ namespace WixToolset.Core var localizationsByCulture = collate.Execute(); intermediate = new Intermediate(resolvedSection.Id, Data.IntermediateLevels.Linked, new[] { resolvedSection }, localizationsByCulture); - -#if MOVE_TO_BACKEND - this.CheckOutputConsistency(output); -#endif } finally { @@ -583,159 +328,31 @@ namespace WixToolset.Core return this.Messaging.EncounteredError ? null : intermediate; } -#if MOVE_TO_BACKEND /// - /// Checks for any tables in the output which are not allowed in the output type. + /// Check for colliding values and collect the wix variable rows. /// - /// The output to check. - private void CheckForIllegalTables(Output output) + /// Collection of WixVariableSymbols by id. + /// WixVariableSymbol to add, if not overridden. + private void AddWixVariable(Dictionary wixVariables, WixVariableSymbol symbol) { - foreach (Table table in output.Tables) - { - switch (output.Type) - { - case OutputType.Module: - if ("BBControl" == table.Name || - "Billboard" == table.Name || - "CCPSearch" == table.Name || - "Feature" == table.Name || - "LaunchCondition" == table.Name || - "Media" == table.Name || - "Patch" == table.Name || - "Upgrade" == table.Name || - "WixMerge" == table.Name) - { - foreach (Row row in table.Rows) - { - this.Messaging.Write(WixErrors.UnexpectedTableInMergeModule(row.SourceLineNumbers, table.Name)); - } - } - else if ("Error" == table.Name) - { - foreach (Row row in table.Rows) - { - this.Messaging.Write(WixWarnings.DangerousTableInMergeModule(row.SourceLineNumbers, table.Name)); - } - } - break; - case OutputType.PatchCreation: - if (!table.Definition.Unreal && - "_SummaryInformation" != table.Name && - "ExternalFiles" != table.Name && - "FamilyFileRanges" != table.Name && - "ImageFamilies" != table.Name && - "PatchMetadata" != table.Name && - "PatchSequence" != table.Name && - "Properties" != table.Name && - "TargetFiles_OptionalData" != table.Name && - "TargetImages" != table.Name && - "UpgradedFiles_OptionalData" != table.Name && - "UpgradedFilesToIgnore" != table.Name && - "UpgradedImages" != table.Name) - { - foreach (Row row in table.Rows) - { - this.Messaging.Write(WixErrors.UnexpectedTableInPatchCreationPackage(row.SourceLineNumbers, table.Name)); - } - } - break; - case OutputType.Patch: - if (!table.Definition.Unreal && - "_SummaryInformation" != table.Name && - "Media" != table.Name && - "MsiPatchMetadata" != table.Name && - "MsiPatchSequence" != table.Name) - { - foreach (Row row in table.Rows) - { - this.Messaging.Write(WixErrors.UnexpectedTableInPatch(row.SourceLineNumbers, table.Name)); - } - } - break; - case OutputType.Product: - if ("ModuleAdminExecuteSequence" == table.Name || - "ModuleAdminUISequence" == table.Name || - "ModuleAdvtExecuteSequence" == table.Name || - "ModuleAdvtUISequence" == table.Name || - "ModuleComponents" == table.Name || - "ModuleConfiguration" == table.Name || - "ModuleDependency" == table.Name || - "ModuleExclusion" == table.Name || - "ModuleIgnoreTable" == table.Name || - "ModuleInstallExecuteSequence" == table.Name || - "ModuleInstallUISequence" == table.Name || - "ModuleSignature" == table.Name || - "ModuleSubstitution" == table.Name) - { - foreach (Row row in table.Rows) - { - this.Messaging.Write(WixWarnings.UnexpectedTableInProduct(row.SourceLineNumbers, table.Name)); - } - } - break; - } - } - } -#endif + var id = symbol.Id.Id; -#if MOVE_TO_BACKEND - /// - /// Performs various consistency checks on the output. - /// - /// Output containing instance transform definitions. - private void CheckOutputConsistency(Output output) - { - // Get the output's minimum installer version - int outputInstallerVersion = int.MinValue; - Table summaryInformationTable = output.Tables["_SummaryInformation"]; - if (null != summaryInformationTable) + if (wixVariables.TryGetValue(id, out var collidingSymbol)) { - foreach (Row row in summaryInformationTable.Rows) + if (collidingSymbol.Overridable && !symbol.Overridable) { - if (14 == (int)row[0]) - { - outputInstallerVersion = Convert.ToInt32(row[1], CultureInfo.InvariantCulture); - break; - } + wixVariables[id] = symbol; } - } - - // ensure the Error table exists if output is marked for MSI 1.0 or below (see ICE40) - if (100 >= outputInstallerVersion && OutputType.Product == output.Type) - { - output.EnsureTable(this.tableDefinitions["Error"]); - } - - // check for the presence of tables/rows/columns that require MSI 1.1 or later - if (110 > outputInstallerVersion) - { - Table isolatedComponentTable = output.Tables["IsolatedComponent"]; - if (null != isolatedComponentTable) + else if (!symbol.Overridable || (collidingSymbol.Overridable && symbol.Overridable)) { - foreach (Row row in isolatedComponentTable.Rows) - { - this.Messaging.Write(WixWarnings.TableIncompatibleWithInstallerVersion(row.SourceLineNumbers, "IsolatedComponent", outputInstallerVersion)); - } + this.Messaging.Write(ErrorMessages.WixVariableCollision(symbol.SourceLineNumbers, id)); } } - - // check for the presence of tables/rows/columns that require MSI 4.0 or later - if (400 > outputInstallerVersion) + else { - Table shortcutTable = output.Tables["Shortcut"]; - if (null != shortcutTable) - { - foreach (Row row in shortcutTable.Rows) - { - if (null != row[12] || null != row[13] || null != row[14] || null != row[15]) - { - this.Messaging.Write(WixWarnings.ColumnsIncompatibleWithInstallerVersion(row.SourceLineNumbers, "Shortcut", outputInstallerVersion)); - } - } - } + wixVariables.Add(id, symbol); } } -#endif /// /// Load the standard action and directory symbols. diff --git a/src/test/WixToolsetTest.CoreIntegration/MsiQueryFixture.cs b/src/test/WixToolsetTest.CoreIntegration/MsiQueryFixture.cs index 8c3487f0..2af47034 100644 --- a/src/test/WixToolsetTest.CoreIntegration/MsiQueryFixture.cs +++ b/src/test/WixToolsetTest.CoreIntegration/MsiQueryFixture.cs @@ -1022,7 +1022,7 @@ namespace WixToolsetTest.CoreIntegration Assert.Empty(section.Symbols.OfType()); var data = WindowsInstallerData.Load(Path.Combine(intermediateFolder, @"bin\test.wixpdb")); - Assert.Null(data.Tables["File"]); + Assert.Empty(data.Tables["File"].Rows); var results = Query.QueryDatabase(msiPath, new[] { "File" }); WixAssert.CompareLineByLine(new[] diff --git a/src/test/WixToolsetTest.CoreIntegration/TestData/CustomTable/CustomTable.wxs b/src/test/WixToolsetTest.CoreIntegration/TestData/CustomTable/CustomTable.wxs index 7f4a43e5..d32e808c 100644 --- a/src/test/WixToolsetTest.CoreIntegration/TestData/CustomTable/CustomTable.wxs +++ b/src/test/WixToolsetTest.CoreIntegration/TestData/CustomTable/CustomTable.wxs @@ -7,7 +7,7 @@ - + @@ -20,7 +20,7 @@ - + -- cgit v1.2.3-55-g6feb